Skip to content

DirectoryServiceClient

Index > DirectoryService > DirectoryServiceClient

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

DirectoryServiceClient

Type annotations and code completion for boto3.client("ds"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_ds.client import DirectoryServiceClient

def get_ds_client() -> DirectoryServiceClient:
    return Session().client("ds")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("ds").exceptions structure.

Usage example
client = boto3.client("ds")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.AuthenticationFailedException,
    client.CertificateAlreadyExistsException,
    client.CertificateDoesNotExistException,
    client.CertificateInUseException,
    client.CertificateLimitExceededException,
    client.ClientError,
    client.ClientException,
    client.DirectoryAlreadyInRegionException,
    client.DirectoryAlreadySharedException,
    client.DirectoryDoesNotExistException,
    client.DirectoryLimitExceededException,
    client.DirectoryNotSharedException,
    client.DirectoryUnavailableException,
    client.DomainControllerLimitExceededException,
    client.EntityAlreadyExistsException,
    client.EntityDoesNotExistException,
    client.IncompatibleSettingsException,
    client.InsufficientPermissionsException,
    client.InvalidCertificateException,
    client.InvalidClientAuthStatusException,
    client.InvalidLDAPSStatusException,
    client.InvalidNextTokenException,
    client.InvalidParameterException,
    client.InvalidPasswordException,
    client.InvalidTargetException,
    client.IpRouteLimitExceededException,
    client.NoAvailableCertificateException,
    client.OrganizationsException,
    client.RegionLimitExceededException,
    client.ServiceException,
    client.ShareLimitExceededException,
    client.SnapshotLimitExceededException,
    client.TagLimitExceededException,
    client.UnsupportedOperationException,
    client.UnsupportedSettingsException,
    client.UserDoesNotExistException,
) as e:
    print(e)
Type checking example
from mypy_boto3_ds.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

accept_shared_directory

Accepts a directory sharing request that was sent from the directory owner account.

Type annotations and code completion for boto3.client("ds").accept_shared_directory method. boto3 documentation

Method definition
def accept_shared_directory(
    self,
    *,
    SharedDirectoryId: str,
) -> AcceptSharedDirectoryResultTypeDef:  # (1)
    ...
  1. See AcceptSharedDirectoryResultTypeDef
Usage example with kwargs
kwargs: AcceptSharedDirectoryRequestRequestTypeDef = {  # (1)
    "SharedDirectoryId": ...,
}

parent.accept_shared_directory(**kwargs)
  1. See AcceptSharedDirectoryRequestRequestTypeDef

add_ip_routes

If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.

Type annotations and code completion for boto3.client("ds").add_ip_routes method. boto3 documentation

Method definition
def add_ip_routes(
    self,
    *,
    DirectoryId: str,
    IpRoutes: Sequence[IpRouteTypeDef],  # (1)
    UpdateSecurityGroupForDirectoryControllers: bool = ...,
) -> Dict[str, Any]:
    ...
  1. See IpRouteTypeDef
Usage example with kwargs
kwargs: AddIpRoutesRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "IpRoutes": ...,
}

parent.add_ip_routes(**kwargs)
  1. See AddIpRoutesRequestRequestTypeDef

add_region

Adds two domain controllers in the specified Region for the specified directory.

Type annotations and code completion for boto3.client("ds").add_region method. boto3 documentation

Method definition
def add_region(
    self,
    *,
    DirectoryId: str,
    RegionName: str,
    VPCSettings: DirectoryVpcSettingsTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See DirectoryVpcSettingsTypeDef
Usage example with kwargs
kwargs: AddRegionRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RegionName": ...,
    "VPCSettings": ...,
}

parent.add_region(**kwargs)
  1. See AddRegionRequestRequestTypeDef

add_tags_to_resource

Adds or overwrites one or more tags for the specified directory.

Type annotations and code completion for boto3.client("ds").add_tags_to_resource method. boto3 documentation

Method definition
def add_tags_to_resource(
    self,
    *,
    ResourceId: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: AddTagsToResourceRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "Tags": ...,
}

parent.add_tags_to_resource(**kwargs)
  1. See AddTagsToResourceRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("ds").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_schema_extension

Cancels an in-progress schema extension to a Microsoft AD directory.

Type annotations and code completion for boto3.client("ds").cancel_schema_extension method. boto3 documentation

Method definition
def cancel_schema_extension(
    self,
    *,
    DirectoryId: str,
    SchemaExtensionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CancelSchemaExtensionRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SchemaExtensionId": ...,
}

parent.cancel_schema_extension(**kwargs)
  1. See CancelSchemaExtensionRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("ds").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

connect_directory

Creates an AD Connector to connect to a self-managed directory.

Type annotations and code completion for boto3.client("ds").connect_directory method. boto3 documentation

Method definition
def connect_directory(
    self,
    *,
    Name: str,
    Password: str,
    Size: DirectorySizeType,  # (1)
    ConnectSettings: DirectoryConnectSettingsTypeDef,  # (2)
    ShortName: str = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> ConnectDirectoryResultTypeDef:  # (4)
    ...
  1. See DirectorySizeType
  2. See DirectoryConnectSettingsTypeDef
  3. See TagTypeDef
  4. See ConnectDirectoryResultTypeDef
Usage example with kwargs
kwargs: ConnectDirectoryRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Password": ...,
    "Size": ...,
    "ConnectSettings": ...,
}

parent.connect_directory(**kwargs)
  1. See ConnectDirectoryRequestRequestTypeDef

create_alias

Creates an alias for a directory and assigns the alias to the directory.

Type annotations and code completion for boto3.client("ds").create_alias method. boto3 documentation

Method definition
def create_alias(
    self,
    *,
    DirectoryId: str,
    Alias: str,
) -> CreateAliasResultTypeDef:  # (1)
    ...
  1. See CreateAliasResultTypeDef
Usage example with kwargs
kwargs: CreateAliasRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Alias": ...,
}

parent.create_alias(**kwargs)
  1. See CreateAliasRequestRequestTypeDef

create_computer

Creates an Active Directory computer object in the specified directory.

Type annotations and code completion for boto3.client("ds").create_computer method. boto3 documentation

Method definition
def create_computer(
    self,
    *,
    DirectoryId: str,
    ComputerName: str,
    Password: str,
    OrganizationalUnitDistinguishedName: str = ...,
    ComputerAttributes: Sequence[AttributeTypeDef] = ...,  # (1)
) -> CreateComputerResultTypeDef:  # (2)
    ...
  1. See AttributeTypeDef
  2. See CreateComputerResultTypeDef
Usage example with kwargs
kwargs: CreateComputerRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "ComputerName": ...,
    "Password": ...,
}

parent.create_computer(**kwargs)
  1. See CreateComputerRequestRequestTypeDef

create_conditional_forwarder

Creates a conditional forwarder associated with your Amazon Web Services directory.

Type annotations and code completion for boto3.client("ds").create_conditional_forwarder method. boto3 documentation

Method definition
def create_conditional_forwarder(
    self,
    *,
    DirectoryId: str,
    RemoteDomainName: str,
    DnsIpAddrs: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CreateConditionalForwarderRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RemoteDomainName": ...,
    "DnsIpAddrs": ...,
}

parent.create_conditional_forwarder(**kwargs)
  1. See CreateConditionalForwarderRequestRequestTypeDef

create_directory

Creates a Simple AD directory.

Type annotations and code completion for boto3.client("ds").create_directory method. boto3 documentation

Method definition
def create_directory(
    self,
    *,
    Name: str,
    Password: str,
    Size: DirectorySizeType,  # (1)
    ShortName: str = ...,
    Description: str = ...,
    VpcSettings: DirectoryVpcSettingsTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateDirectoryResultTypeDef:  # (4)
    ...
  1. See DirectorySizeType
  2. See DirectoryVpcSettingsTypeDef
  3. See TagTypeDef
  4. See CreateDirectoryResultTypeDef
Usage example with kwargs
kwargs: CreateDirectoryRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Password": ...,
    "Size": ...,
}

parent.create_directory(**kwargs)
  1. See CreateDirectoryRequestRequestTypeDef

create_log_subscription

Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.

Type annotations and code completion for boto3.client("ds").create_log_subscription method. boto3 documentation

Method definition
def create_log_subscription(
    self,
    *,
    DirectoryId: str,
    LogGroupName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CreateLogSubscriptionRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "LogGroupName": ...,
}

parent.create_log_subscription(**kwargs)
  1. See CreateLogSubscriptionRequestRequestTypeDef

create_microsoft_ad

Creates a Microsoft AD directory in the Amazon Web Services Cloud.

Type annotations and code completion for boto3.client("ds").create_microsoft_ad method. boto3 documentation

Method definition
def create_microsoft_ad(
    self,
    *,
    Name: str,
    Password: str,
    VpcSettings: DirectoryVpcSettingsTypeDef,  # (1)
    ShortName: str = ...,
    Description: str = ...,
    Edition: DirectoryEditionType = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateMicrosoftADResultTypeDef:  # (4)
    ...
  1. See DirectoryVpcSettingsTypeDef
  2. See DirectoryEditionType
  3. See TagTypeDef
  4. See CreateMicrosoftADResultTypeDef
Usage example with kwargs
kwargs: CreateMicrosoftADRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Password": ...,
    "VpcSettings": ...,
}

parent.create_microsoft_ad(**kwargs)
  1. See CreateMicrosoftADRequestRequestTypeDef

create_snapshot

Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.

Type annotations and code completion for boto3.client("ds").create_snapshot method. boto3 documentation

Method definition
def create_snapshot(
    self,
    *,
    DirectoryId: str,
    Name: str = ...,
) -> CreateSnapshotResultTypeDef:  # (1)
    ...
  1. See CreateSnapshotResultTypeDef
Usage example with kwargs
kwargs: CreateSnapshotRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.create_snapshot(**kwargs)
  1. See CreateSnapshotRequestRequestTypeDef

create_trust

Directory Service for Microsoft Active Directory allows you to configure trust relationships.

Type annotations and code completion for boto3.client("ds").create_trust method. boto3 documentation

Method definition
def create_trust(
    self,
    *,
    DirectoryId: str,
    RemoteDomainName: str,
    TrustPassword: str,
    TrustDirection: TrustDirectionType,  # (1)
    TrustType: TrustTypeType = ...,  # (2)
    ConditionalForwarderIpAddrs: Sequence[str] = ...,
    SelectiveAuth: SelectiveAuthType = ...,  # (3)
) -> CreateTrustResultTypeDef:  # (4)
    ...
  1. See TrustDirectionType
  2. See TrustTypeType
  3. See SelectiveAuthType
  4. See CreateTrustResultTypeDef
Usage example with kwargs
kwargs: CreateTrustRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RemoteDomainName": ...,
    "TrustPassword": ...,
    "TrustDirection": ...,
}

parent.create_trust(**kwargs)
  1. See CreateTrustRequestRequestTypeDef

delete_conditional_forwarder

Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.

Type annotations and code completion for boto3.client("ds").delete_conditional_forwarder method. boto3 documentation

Method definition
def delete_conditional_forwarder(
    self,
    *,
    DirectoryId: str,
    RemoteDomainName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteConditionalForwarderRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RemoteDomainName": ...,
}

parent.delete_conditional_forwarder(**kwargs)
  1. See DeleteConditionalForwarderRequestRequestTypeDef

delete_directory

Deletes an Directory Service directory.

Type annotations and code completion for boto3.client("ds").delete_directory method. boto3 documentation

Method definition
def delete_directory(
    self,
    *,
    DirectoryId: str,
) -> DeleteDirectoryResultTypeDef:  # (1)
    ...
  1. See DeleteDirectoryResultTypeDef
Usage example with kwargs
kwargs: DeleteDirectoryRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.delete_directory(**kwargs)
  1. See DeleteDirectoryRequestRequestTypeDef

delete_log_subscription

Deletes the specified log subscription.

Type annotations and code completion for boto3.client("ds").delete_log_subscription method. boto3 documentation

Method definition
def delete_log_subscription(
    self,
    *,
    DirectoryId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteLogSubscriptionRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.delete_log_subscription(**kwargs)
  1. See DeleteLogSubscriptionRequestRequestTypeDef

delete_snapshot

Deletes a directory snapshot.

Type annotations and code completion for boto3.client("ds").delete_snapshot method. boto3 documentation

Method definition
def delete_snapshot(
    self,
    *,
    SnapshotId: str,
) -> DeleteSnapshotResultTypeDef:  # (1)
    ...
  1. See DeleteSnapshotResultTypeDef
Usage example with kwargs
kwargs: DeleteSnapshotRequestRequestTypeDef = {  # (1)
    "SnapshotId": ...,
}

parent.delete_snapshot(**kwargs)
  1. See DeleteSnapshotRequestRequestTypeDef

delete_trust

Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.

Type annotations and code completion for boto3.client("ds").delete_trust method. boto3 documentation

Method definition
def delete_trust(
    self,
    *,
    TrustId: str,
    DeleteAssociatedConditionalForwarder: bool = ...,
) -> DeleteTrustResultTypeDef:  # (1)
    ...
  1. See DeleteTrustResultTypeDef
Usage example with kwargs
kwargs: DeleteTrustRequestRequestTypeDef = {  # (1)
    "TrustId": ...,
}

parent.delete_trust(**kwargs)
  1. See DeleteTrustRequestRequestTypeDef

deregister_certificate

Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.

Type annotations and code completion for boto3.client("ds").deregister_certificate method. boto3 documentation

Method definition
def deregister_certificate(
    self,
    *,
    DirectoryId: str,
    CertificateId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeregisterCertificateRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "CertificateId": ...,
}

parent.deregister_certificate(**kwargs)
  1. See DeregisterCertificateRequestRequestTypeDef

deregister_event_topic

Removes the specified directory as a publisher to the specified Amazon SNS topic.

Type annotations and code completion for boto3.client("ds").deregister_event_topic method. boto3 documentation

Method definition
def deregister_event_topic(
    self,
    *,
    DirectoryId: str,
    TopicName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeregisterEventTopicRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "TopicName": ...,
}

parent.deregister_event_topic(**kwargs)
  1. See DeregisterEventTopicRequestRequestTypeDef

describe_certificate

Displays information about the certificate registered for secure LDAP or client certificate authentication.

Type annotations and code completion for boto3.client("ds").describe_certificate method. boto3 documentation

Method definition
def describe_certificate(
    self,
    *,
    DirectoryId: str,
    CertificateId: str,
) -> DescribeCertificateResultTypeDef:  # (1)
    ...
  1. See DescribeCertificateResultTypeDef
Usage example with kwargs
kwargs: DescribeCertificateRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "CertificateId": ...,
}

parent.describe_certificate(**kwargs)
  1. See DescribeCertificateRequestRequestTypeDef

describe_client_authentication_settings

Retrieves information about the type of client authentication for the specified directory, if the type is specified.

Type annotations and code completion for boto3.client("ds").describe_client_authentication_settings method. boto3 documentation

Method definition
def describe_client_authentication_settings(
    self,
    *,
    DirectoryId: str,
    Type: ClientAuthenticationTypeType = ...,  # (1)
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeClientAuthenticationSettingsResultTypeDef:  # (2)
    ...
  1. See ClientAuthenticationTypeType
  2. See DescribeClientAuthenticationSettingsResultTypeDef
Usage example with kwargs
kwargs: DescribeClientAuthenticationSettingsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.describe_client_authentication_settings(**kwargs)
  1. See DescribeClientAuthenticationSettingsRequestRequestTypeDef

describe_conditional_forwarders

Obtains information about the conditional forwarders for this account.

Type annotations and code completion for boto3.client("ds").describe_conditional_forwarders method. boto3 documentation

Method definition
def describe_conditional_forwarders(
    self,
    *,
    DirectoryId: str,
    RemoteDomainNames: Sequence[str] = ...,
) -> DescribeConditionalForwardersResultTypeDef:  # (1)
    ...
  1. See DescribeConditionalForwardersResultTypeDef
Usage example with kwargs
kwargs: DescribeConditionalForwardersRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.describe_conditional_forwarders(**kwargs)
  1. See DescribeConditionalForwardersRequestRequestTypeDef

describe_directories

Obtains information about the directories that belong to this account.

Type annotations and code completion for boto3.client("ds").describe_directories method. boto3 documentation

Method definition
def describe_directories(
    self,
    *,
    DirectoryIds: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeDirectoriesResultTypeDef:  # (1)
    ...
  1. See DescribeDirectoriesResultTypeDef
Usage example with kwargs
kwargs: DescribeDirectoriesRequestRequestTypeDef = {  # (1)
    "DirectoryIds": ...,
}

parent.describe_directories(**kwargs)
  1. See DescribeDirectoriesRequestRequestTypeDef

describe_domain_controllers

Provides information about any domain controllers in your directory.

Type annotations and code completion for boto3.client("ds").describe_domain_controllers method. boto3 documentation

Method definition
def describe_domain_controllers(
    self,
    *,
    DirectoryId: str,
    DomainControllerIds: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeDomainControllersResultTypeDef:  # (1)
    ...
  1. See DescribeDomainControllersResultTypeDef
Usage example with kwargs
kwargs: DescribeDomainControllersRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.describe_domain_controllers(**kwargs)
  1. See DescribeDomainControllersRequestRequestTypeDef

describe_event_topics

Obtains information about which Amazon SNS topics receive status messages from the specified directory.

Type annotations and code completion for boto3.client("ds").describe_event_topics method. boto3 documentation

Method definition
def describe_event_topics(
    self,
    *,
    DirectoryId: str = ...,
    TopicNames: Sequence[str] = ...,
) -> DescribeEventTopicsResultTypeDef:  # (1)
    ...
  1. See DescribeEventTopicsResultTypeDef
Usage example with kwargs
kwargs: DescribeEventTopicsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.describe_event_topics(**kwargs)
  1. See DescribeEventTopicsRequestRequestTypeDef

describe_ldaps_settings

Describes the status of LDAP security for the specified directory.

Type annotations and code completion for boto3.client("ds").describe_ldaps_settings method. boto3 documentation

Method definition
def describe_ldaps_settings(
    self,
    *,
    DirectoryId: str,
    Type: LDAPSTypeType = ...,  # (1)
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeLDAPSSettingsResultTypeDef:  # (2)
    ...
  1. See LDAPSTypeType
  2. See DescribeLDAPSSettingsResultTypeDef
Usage example with kwargs
kwargs: DescribeLDAPSSettingsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.describe_ldaps_settings(**kwargs)
  1. See DescribeLDAPSSettingsRequestRequestTypeDef

describe_regions

Provides information about the Regions that are configured for multi-Region replication.

Type annotations and code completion for boto3.client("ds").describe_regions method. boto3 documentation

Method definition
def describe_regions(
    self,
    *,
    DirectoryId: str,
    RegionName: str = ...,
    NextToken: str = ...,
) -> DescribeRegionsResultTypeDef:  # (1)
    ...
  1. See DescribeRegionsResultTypeDef
Usage example with kwargs
kwargs: DescribeRegionsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.describe_regions(**kwargs)
  1. See DescribeRegionsRequestRequestTypeDef

describe_settings

Retrieves information about the configurable settings for the specified directory.

Type annotations and code completion for boto3.client("ds").describe_settings method. boto3 documentation

Method definition
def describe_settings(
    self,
    *,
    DirectoryId: str,
    Status: DirectoryConfigurationStatusType = ...,  # (1)
    NextToken: str = ...,
) -> DescribeSettingsResultTypeDef:  # (2)
    ...
  1. See DirectoryConfigurationStatusType
  2. See DescribeSettingsResultTypeDef
Usage example with kwargs
kwargs: DescribeSettingsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.describe_settings(**kwargs)
  1. See DescribeSettingsRequestRequestTypeDef

describe_shared_directories

Returns the shared directories in your account.

Type annotations and code completion for boto3.client("ds").describe_shared_directories method. boto3 documentation

Method definition
def describe_shared_directories(
    self,
    *,
    OwnerDirectoryId: str,
    SharedDirectoryIds: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeSharedDirectoriesResultTypeDef:  # (1)
    ...
  1. See DescribeSharedDirectoriesResultTypeDef
Usage example with kwargs
kwargs: DescribeSharedDirectoriesRequestRequestTypeDef = {  # (1)
    "OwnerDirectoryId": ...,
}

parent.describe_shared_directories(**kwargs)
  1. See DescribeSharedDirectoriesRequestRequestTypeDef

describe_snapshots

Obtains information about the directory snapshots that belong to this account.

Type annotations and code completion for boto3.client("ds").describe_snapshots method. boto3 documentation

Method definition
def describe_snapshots(
    self,
    *,
    DirectoryId: str = ...,
    SnapshotIds: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeSnapshotsResultTypeDef:  # (1)
    ...
  1. See DescribeSnapshotsResultTypeDef
Usage example with kwargs
kwargs: DescribeSnapshotsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.describe_snapshots(**kwargs)
  1. See DescribeSnapshotsRequestRequestTypeDef

describe_trusts

Obtains information about the trust relationships for this account.

Type annotations and code completion for boto3.client("ds").describe_trusts method. boto3 documentation

Method definition
def describe_trusts(
    self,
    *,
    DirectoryId: str = ...,
    TrustIds: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeTrustsResultTypeDef:  # (1)
    ...
  1. See DescribeTrustsResultTypeDef
Usage example with kwargs
kwargs: DescribeTrustsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.describe_trusts(**kwargs)
  1. See DescribeTrustsRequestRequestTypeDef

disable_client_authentication

Disables alternative client authentication methods for the specified directory.

Type annotations and code completion for boto3.client("ds").disable_client_authentication method. boto3 documentation

Method definition
def disable_client_authentication(
    self,
    *,
    DirectoryId: str,
    Type: ClientAuthenticationTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ClientAuthenticationTypeType
Usage example with kwargs
kwargs: DisableClientAuthenticationRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Type": ...,
}

parent.disable_client_authentication(**kwargs)
  1. See DisableClientAuthenticationRequestRequestTypeDef

disable_ldaps

Deactivates LDAP secure calls for the specified directory.

Type annotations and code completion for boto3.client("ds").disable_ldaps method. boto3 documentation

Method definition
def disable_ldaps(
    self,
    *,
    DirectoryId: str,
    Type: LDAPSTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See LDAPSTypeType
Usage example with kwargs
kwargs: DisableLDAPSRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Type": ...,
}

parent.disable_ldaps(**kwargs)
  1. See DisableLDAPSRequestRequestTypeDef

disable_radius

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

Type annotations and code completion for boto3.client("ds").disable_radius method. boto3 documentation

Method definition
def disable_radius(
    self,
    *,
    DirectoryId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisableRadiusRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.disable_radius(**kwargs)
  1. See DisableRadiusRequestRequestTypeDef

disable_sso

Disables single-sign on for a directory.

Type annotations and code completion for boto3.client("ds").disable_sso method. boto3 documentation

Method definition
def disable_sso(
    self,
    *,
    DirectoryId: str,
    UserName: str = ...,
    Password: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisableSsoRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.disable_sso(**kwargs)
  1. See DisableSsoRequestRequestTypeDef

enable_client_authentication

Enables alternative client authentication methods for the specified directory.

Type annotations and code completion for boto3.client("ds").enable_client_authentication method. boto3 documentation

Method definition
def enable_client_authentication(
    self,
    *,
    DirectoryId: str,
    Type: ClientAuthenticationTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ClientAuthenticationTypeType
Usage example with kwargs
kwargs: EnableClientAuthenticationRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Type": ...,
}

parent.enable_client_authentication(**kwargs)
  1. See EnableClientAuthenticationRequestRequestTypeDef

enable_ldaps

Activates the switch for the specific directory to always use LDAP secure calls.

Type annotations and code completion for boto3.client("ds").enable_ldaps method. boto3 documentation

Method definition
def enable_ldaps(
    self,
    *,
    DirectoryId: str,
    Type: LDAPSTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See LDAPSTypeType
Usage example with kwargs
kwargs: EnableLDAPSRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Type": ...,
}

parent.enable_ldaps(**kwargs)
  1. See EnableLDAPSRequestRequestTypeDef

enable_radius

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

Type annotations and code completion for boto3.client("ds").enable_radius method. boto3 documentation

Method definition
def enable_radius(
    self,
    *,
    DirectoryId: str,
    RadiusSettings: RadiusSettingsTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See RadiusSettingsTypeDef
Usage example with kwargs
kwargs: EnableRadiusRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RadiusSettings": ...,
}

parent.enable_radius(**kwargs)
  1. See EnableRadiusRequestRequestTypeDef

enable_sso

Enables single sign-on for a directory.

Type annotations and code completion for boto3.client("ds").enable_sso method. boto3 documentation

Method definition
def enable_sso(
    self,
    *,
    DirectoryId: str,
    UserName: str = ...,
    Password: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: EnableSsoRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.enable_sso(**kwargs)
  1. See EnableSsoRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("ds").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_directory_limits

Obtains directory limit information for the current Region.

Type annotations and code completion for boto3.client("ds").get_directory_limits method. boto3 documentation

Method definition
def get_directory_limits(
    self,
) -> GetDirectoryLimitsResultTypeDef:  # (1)
    ...
  1. See GetDirectoryLimitsResultTypeDef

get_snapshot_limits

Obtains the manual snapshot limits for a directory.

Type annotations and code completion for boto3.client("ds").get_snapshot_limits method. boto3 documentation

Method definition
def get_snapshot_limits(
    self,
    *,
    DirectoryId: str,
) -> GetSnapshotLimitsResultTypeDef:  # (1)
    ...
  1. See GetSnapshotLimitsResultTypeDef
Usage example with kwargs
kwargs: GetSnapshotLimitsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.get_snapshot_limits(**kwargs)
  1. See GetSnapshotLimitsRequestRequestTypeDef

list_certificates

For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.

Type annotations and code completion for boto3.client("ds").list_certificates method. boto3 documentation

Method definition
def list_certificates(
    self,
    *,
    DirectoryId: str,
    NextToken: str = ...,
    Limit: int = ...,
) -> ListCertificatesResultTypeDef:  # (1)
    ...
  1. See ListCertificatesResultTypeDef
Usage example with kwargs
kwargs: ListCertificatesRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.list_certificates(**kwargs)
  1. See ListCertificatesRequestRequestTypeDef

list_ip_routes

Lists the address blocks that you have added to a directory.

Type annotations and code completion for boto3.client("ds").list_ip_routes method. boto3 documentation

Method definition
def list_ip_routes(
    self,
    *,
    DirectoryId: str,
    NextToken: str = ...,
    Limit: int = ...,
) -> ListIpRoutesResultTypeDef:  # (1)
    ...
  1. See ListIpRoutesResultTypeDef
Usage example with kwargs
kwargs: ListIpRoutesRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.list_ip_routes(**kwargs)
  1. See ListIpRoutesRequestRequestTypeDef

list_log_subscriptions

Lists the active log subscriptions for the Amazon Web Services account.

Type annotations and code completion for boto3.client("ds").list_log_subscriptions method. boto3 documentation

Method definition
def list_log_subscriptions(
    self,
    *,
    DirectoryId: str = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> ListLogSubscriptionsResultTypeDef:  # (1)
    ...
  1. See ListLogSubscriptionsResultTypeDef
Usage example with kwargs
kwargs: ListLogSubscriptionsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.list_log_subscriptions(**kwargs)
  1. See ListLogSubscriptionsRequestRequestTypeDef

list_schema_extensions

Lists all schema extensions applied to a Microsoft AD Directory.

Type annotations and code completion for boto3.client("ds").list_schema_extensions method. boto3 documentation

Method definition
def list_schema_extensions(
    self,
    *,
    DirectoryId: str,
    NextToken: str = ...,
    Limit: int = ...,
) -> ListSchemaExtensionsResultTypeDef:  # (1)
    ...
  1. See ListSchemaExtensionsResultTypeDef
Usage example with kwargs
kwargs: ListSchemaExtensionsRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.list_schema_extensions(**kwargs)
  1. See ListSchemaExtensionsRequestRequestTypeDef

list_tags_for_resource

Lists all tags on a directory.

Type annotations and code completion for boto3.client("ds").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceId: str,
    NextToken: str = ...,
    Limit: int = ...,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResultTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

register_certificate

Registers a certificate for a secure LDAP or client certificate authentication.

Type annotations and code completion for boto3.client("ds").register_certificate method. boto3 documentation

Method definition
def register_certificate(
    self,
    *,
    DirectoryId: str,
    CertificateData: str,
    Type: CertificateTypeType = ...,  # (1)
    ClientCertAuthSettings: ClientCertAuthSettingsTypeDef = ...,  # (2)
) -> RegisterCertificateResultTypeDef:  # (3)
    ...
  1. See CertificateTypeType
  2. See ClientCertAuthSettingsTypeDef
  3. See RegisterCertificateResultTypeDef
Usage example with kwargs
kwargs: RegisterCertificateRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "CertificateData": ...,
}

parent.register_certificate(**kwargs)
  1. See RegisterCertificateRequestRequestTypeDef

register_event_topic

Associates a directory with an Amazon SNS topic.

Type annotations and code completion for boto3.client("ds").register_event_topic method. boto3 documentation

Method definition
def register_event_topic(
    self,
    *,
    DirectoryId: str,
    TopicName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: RegisterEventTopicRequestRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "TopicName": ...,
}

parent.register_event_topic(**kwargs)
  1. See RegisterEventTopicRequestRequestTypeDef

reject_shared_directory

Rejects a directory sharing request that was sent from the directory owner account.

Type annotations and code completion for boto3.client("ds").reject_shared_directory method. boto3 documentation

Method definition
def reject_shared_directory(
    self,
    *,
    SharedDirectoryId: str,
) -> RejectSharedDirectoryResultTypeDef:  # (1)
    ...
  1. See RejectSharedDirectoryResultTypeDef
Usage example with kwargs
kwargs: RejectSharedDirectoryRequestRequestTypeDef = {  # (1)
    "SharedDirectoryId": ...,
}

parent.reject_shared_directory(**kwargs)
  1. See RejectSharedDirectoryRequestRequestTypeDef

remove_ip_routes

Removes IP address blocks from a directory.

Type annotations and code completion for boto3.client("ds").remove_ip_routes method.