Skip to content

Type definitions#

Index > DirectoryService > Type definitions

Auto-generated documentation for DirectoryService type annotations stubs module mypy-boto3-ds.

AcceptSharedDirectoryRequestRequestTypeDef#

# AcceptSharedDirectoryRequestRequestTypeDef definition

class AcceptSharedDirectoryRequestRequestTypeDef(TypedDict):
    SharedDirectoryId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

SharedDirectoryTypeDef#

# SharedDirectoryTypeDef definition

class SharedDirectoryTypeDef(TypedDict):
    OwnerAccountId: NotRequired[str],
    OwnerDirectoryId: NotRequired[str],
    ShareMethod: NotRequired[ShareMethodType],  # (1)
    SharedAccountId: NotRequired[str],
    SharedDirectoryId: NotRequired[str],
    ShareStatus: NotRequired[ShareStatusType],  # (2)
    ShareNotes: NotRequired[str],
    CreatedDateTime: NotRequired[datetime],
    LastUpdatedDateTime: NotRequired[datetime],
  1. See ShareMethodType
  2. See ShareStatusType

IpRouteTypeDef#

# IpRouteTypeDef definition

class IpRouteTypeDef(TypedDict):
    CidrIp: NotRequired[str],
    Description: NotRequired[str],

DirectoryVpcSettingsTypeDef#

# DirectoryVpcSettingsTypeDef definition

class DirectoryVpcSettingsTypeDef(TypedDict):
    VpcId: str,
    SubnetIds: Sequence[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

AttributeTypeDef#

# AttributeTypeDef definition

class AttributeTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],

CancelSchemaExtensionRequestRequestTypeDef#

# CancelSchemaExtensionRequestRequestTypeDef definition

class CancelSchemaExtensionRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    SchemaExtensionId: str,

CertificateInfoTypeDef#

# CertificateInfoTypeDef definition

class CertificateInfoTypeDef(TypedDict):
    CertificateId: NotRequired[str],
    CommonName: NotRequired[str],
    State: NotRequired[CertificateStateType],  # (1)
    ExpiryDateTime: NotRequired[datetime],
    Type: NotRequired[CertificateTypeType],  # (2)
  1. See CertificateStateType
  2. See CertificateTypeType

ClientCertAuthSettingsTypeDef#

# ClientCertAuthSettingsTypeDef definition

class ClientCertAuthSettingsTypeDef(TypedDict):
    OCSPUrl: NotRequired[str],

ClientAuthenticationSettingInfoTypeDef#

# ClientAuthenticationSettingInfoTypeDef definition

class ClientAuthenticationSettingInfoTypeDef(TypedDict):
    Type: NotRequired[ClientAuthenticationTypeType],  # (1)
    Status: NotRequired[ClientAuthenticationStatusType],  # (2)
    LastUpdatedDateTime: NotRequired[datetime],
  1. See ClientAuthenticationTypeType
  2. See ClientAuthenticationStatusType

ConditionalForwarderTypeDef#

# ConditionalForwarderTypeDef definition

class ConditionalForwarderTypeDef(TypedDict):
    RemoteDomainName: NotRequired[str],
    DnsIpAddrs: NotRequired[List[str]],
    ReplicationScope: NotRequired[ReplicationScopeType],  # (1)
  1. See ReplicationScopeType

DirectoryConnectSettingsTypeDef#

# DirectoryConnectSettingsTypeDef definition

class DirectoryConnectSettingsTypeDef(TypedDict):
    VpcId: str,
    SubnetIds: Sequence[str],
    CustomerDnsIps: Sequence[str],
    CustomerUserName: str,

CreateAliasRequestRequestTypeDef#

# CreateAliasRequestRequestTypeDef definition

class CreateAliasRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    Alias: str,

CreateConditionalForwarderRequestRequestTypeDef#

# CreateConditionalForwarderRequestRequestTypeDef definition

class CreateConditionalForwarderRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    RemoteDomainName: str,
    DnsIpAddrs: Sequence[str],

CreateLogSubscriptionRequestRequestTypeDef#

# CreateLogSubscriptionRequestRequestTypeDef definition

class CreateLogSubscriptionRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    LogGroupName: str,

CreateSnapshotRequestRequestTypeDef#

# CreateSnapshotRequestRequestTypeDef definition

class CreateSnapshotRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    Name: NotRequired[str],

CreateTrustRequestRequestTypeDef#

# CreateTrustRequestRequestTypeDef definition

class CreateTrustRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    RemoteDomainName: str,
    TrustPassword: str,
    TrustDirection: TrustDirectionType,  # (1)
    TrustType: NotRequired[TrustTypeType],  # (2)
    ConditionalForwarderIpAddrs: NotRequired[Sequence[str]],
    SelectiveAuth: NotRequired[SelectiveAuthType],  # (3)
  1. See TrustDirectionType
  2. See TrustTypeType
  3. See SelectiveAuthType

DeleteConditionalForwarderRequestRequestTypeDef#

# DeleteConditionalForwarderRequestRequestTypeDef definition

class DeleteConditionalForwarderRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    RemoteDomainName: str,

DeleteDirectoryRequestRequestTypeDef#

# DeleteDirectoryRequestRequestTypeDef definition

class DeleteDirectoryRequestRequestTypeDef(TypedDict):
    DirectoryId: str,

DeleteLogSubscriptionRequestRequestTypeDef#

# DeleteLogSubscriptionRequestRequestTypeDef definition

class DeleteLogSubscriptionRequestRequestTypeDef(TypedDict):
    DirectoryId: str,

DeleteSnapshotRequestRequestTypeDef#

# DeleteSnapshotRequestRequestTypeDef definition

class DeleteSnapshotRequestRequestTypeDef(TypedDict):
    SnapshotId: str,

DeleteTrustRequestRequestTypeDef#

# DeleteTrustRequestRequestTypeDef definition

class DeleteTrustRequestRequestTypeDef(TypedDict):
    TrustId: str,
    DeleteAssociatedConditionalForwarder: NotRequired[bool],

DeregisterCertificateRequestRequestTypeDef#

# DeregisterCertificateRequestRequestTypeDef definition

class DeregisterCertificateRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    CertificateId: str,

DeregisterEventTopicRequestRequestTypeDef#

# DeregisterEventTopicRequestRequestTypeDef definition

class DeregisterEventTopicRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    TopicName: str,

DescribeCertificateRequestRequestTypeDef#

# DescribeCertificateRequestRequestTypeDef definition

class DescribeCertificateRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    CertificateId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeClientAuthenticationSettingsRequestRequestTypeDef#

# DescribeClientAuthenticationSettingsRequestRequestTypeDef definition

class DescribeClientAuthenticationSettingsRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    Type: NotRequired[ClientAuthenticationTypeType],  # (1)
    NextToken: NotRequired[str],
    Limit: NotRequired[int],
  1. See ClientAuthenticationTypeType

DescribeConditionalForwardersRequestRequestTypeDef#

# DescribeConditionalForwardersRequestRequestTypeDef definition

class DescribeConditionalForwardersRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    RemoteDomainNames: NotRequired[Sequence[str]],

DescribeDirectoriesRequestRequestTypeDef#

# DescribeDirectoriesRequestRequestTypeDef definition

class DescribeDirectoriesRequestRequestTypeDef(TypedDict):
    DirectoryIds: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    Limit: NotRequired[int],

DescribeDomainControllersRequestRequestTypeDef#

# DescribeDomainControllersRequestRequestTypeDef definition

class DescribeDomainControllersRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    DomainControllerIds: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    Limit: NotRequired[int],

DomainControllerTypeDef#

# DomainControllerTypeDef definition

class DomainControllerTypeDef(TypedDict):
    DirectoryId: NotRequired[str],
    DomainControllerId: NotRequired[str],
    DnsIpAddr: NotRequired[str],
    VpcId: NotRequired[str],
    SubnetId: NotRequired[str],
    AvailabilityZone: NotRequired[str],
    Status: NotRequired[DomainControllerStatusType],  # (1)
    StatusReason: NotRequired[str],
    LaunchTime: NotRequired[datetime],
    StatusLastUpdatedDateTime: NotRequired[datetime],
  1. See DomainControllerStatusType

DescribeEventTopicsRequestRequestTypeDef#

# DescribeEventTopicsRequestRequestTypeDef definition

class DescribeEventTopicsRequestRequestTypeDef(TypedDict):
    DirectoryId: NotRequired[str],
    TopicNames: NotRequired[Sequence[str]],

EventTopicTypeDef#

# EventTopicTypeDef definition

class EventTopicTypeDef(TypedDict):
    DirectoryId: NotRequired[str],
    TopicName: NotRequired[str],
    TopicArn: NotRequired[str],
    CreatedDateTime: NotRequired[datetime],
    Status: NotRequired[TopicStatusType],  # (1)
  1. See TopicStatusType

DescribeLDAPSSettingsRequestRequestTypeDef#

# DescribeLDAPSSettingsRequestRequestTypeDef definition

class DescribeLDAPSSettingsRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    Type: NotRequired[LDAPSTypeType],  # (1)
    NextToken: NotRequired[str],
    Limit: NotRequired[int],
  1. See LDAPSTypeType

LDAPSSettingInfoTypeDef#

# LDAPSSettingInfoTypeDef definition

class LDAPSSettingInfoTypeDef(TypedDict):
    LDAPSStatus: NotRequired[LDAPSStatusType],  # (1)
    LDAPSStatusReason: NotRequired[str],
    LastUpdatedDateTime: NotRequired[datetime],
  1. See LDAPSStatusType

DescribeRegionsRequestRequestTypeDef#

# DescribeRegionsRequestRequestTypeDef definition

class DescribeRegionsRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    RegionName: NotRequired[str],
    NextToken: NotRequired[str],

DescribeSettingsRequestRequestTypeDef#

# DescribeSettingsRequestRequestTypeDef definition

class DescribeSettingsRequestRequestTypeDef(TypedDict):
    DirectoryId: str,
    Status: NotRequired[DirectoryConfigurationStatusType],  # (1)
    NextToken: NotRequired[str],
  1. See DirectoryConfigurationStatusType

SettingEntryTypeDef#

# SettingEntryTypeDef definition

class SettingEntryTypeDef(TypedDict):
    Type: NotRequired[str],
    Name: NotRequired[str],
    AllowedValues: NotRequired[str],
    AppliedValue: NotRequired[str],
    RequestedValue: NotRequired[str],
    RequestStatus: NotRequired[DirectoryConfigurationStatusType],  # (1)
    RequestDetailedStatus: NotRequired[Dict[str, DirectoryConfigurationStatusType]],  # (2)
    RequestStatusMessage: NotRequired[str],
    LastUpdatedDateTime: NotRequired[datetime],
    LastRequestedDateTime: NotRequired[datetime],
    DataType: NotRequired[str],
  1. See DirectoryConfigurationStatusType
  2. See DirectoryConfigurationStatusType

DescribeSharedDirectoriesRequestRequestTypeDef#

# DescribeSharedDirectoriesRequestRequestTypeDef definition

class DescribeSharedDirectoriesRequestRequestTypeDef(TypedDict):
    OwnerDirectoryId: str,
    SharedDirectoryIds: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    Limit: NotRequired[int],

DescribeSnapshotsRequestRequestTypeDef#

# DescribeSnapshotsRequestRequestTypeDef definition

class DescribeSnapshotsRequestRequestTypeDef(TypedDict):
    DirectoryId: NotRequired[str],
    SnapshotIds: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    Limit: NotRequired[int],

SnapshotTypeDef#

# SnapshotTypeDef definition

class SnapshotTypeDef(TypedDict):
    DirectoryId: NotRequired[str],
    SnapshotId: NotRequired[str],
    Type: NotRequired[SnapshotTypeType],  # (1)
    Name: NotRequired[str],
    Status: NotRequired[SnapshotStatusType],  # (2)
    StartTime: NotRequired[datetime],
  1. See SnapshotTypeType
  2. See SnapshotStatusType

DescribeTrustsRequestRequestTypeDef#

# DescribeTrustsRequestRequestTypeDef definition

class DescribeTrustsRequestRequestTypeDef(TypedDict):
    DirectoryId: NotRequired[str],
    TrustIds: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    Limit: NotRequired[int],

TrustTypeDef#

# TrustTypeDef definition

class TrustTypeDef(TypedDi