Skip to content

DirectoryServiceClient#

Index > DirectoryService > DirectoryServiceClient

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

DirectoryServiceClient#

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

# DirectoryServiceClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("ds")

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

from types_boto3_ds.client import Exceptions

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

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

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

# generate_presigned_url method definition

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

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

# accept_shared_directory method definition

def accept_shared_directory(
    self,
    *,
    SharedDirectoryId: str,
) -> AcceptSharedDirectoryResultTypeDef:  # (1)
    ...
  1. See AcceptSharedDirectoryResultTypeDef 
# accept_shared_directory method usage example with argument unpacking

kwargs: AcceptSharedDirectoryRequestTypeDef = {  # (1)
    "SharedDirectoryId": ...,
}

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

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

# add_ip_routes method definition

def add_ip_routes(
    self,
    *,
    DirectoryId: str,
    IpRoutes: Sequence[IpRouteTypeDef],  # (1)
    UpdateSecurityGroupForDirectoryControllers: bool = ...,
) -> Dict[str, Any]:
    ...
  1. See IpRouteTypeDef 
# add_ip_routes method usage example with argument unpacking

kwargs: AddIpRoutesRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "IpRoutes": ...,
}

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

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

# add_region method definition

def add_region(
    self,
    *,
    DirectoryId: str,
    RegionName: str,
    VPCSettings: DirectoryVpcSettingsUnionTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See DirectoryVpcSettingsTypeDef DirectoryVpcSettingsOutputTypeDef 
# add_region method usage example with argument unpacking

kwargs: AddRegionRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RegionName": ...,
    "VPCSettings": ...,
}

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

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

# add_tags_to_resource method definition

def add_tags_to_resource(
    self,
    *,
    ResourceId: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# add_tags_to_resource method usage example with argument unpacking

kwargs: AddTagsToResourceRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "Tags": ...,
}

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

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

# cancel_schema_extension method definition

def cancel_schema_extension(
    self,
    *,
    DirectoryId: str,
    SchemaExtensionId: str,
) -> Dict[str, Any]:
    ...
# cancel_schema_extension method usage example with argument unpacking

kwargs: CancelSchemaExtensionRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "SchemaExtensionId": ...,
}

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

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

# connect_directory 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 
# connect_directory method usage example with argument unpacking

kwargs: ConnectDirectoryRequestTypeDef = {  # (1)
    "Name": ...,
    "Password": ...,
    "Size": ...,
    "ConnectSettings": ...,
}

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

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

# create_alias method definition

def create_alias(
    self,
    *,
    DirectoryId: str,
    Alias: str,
) -> CreateAliasResultTypeDef:  # (1)
    ...
  1. See CreateAliasResultTypeDef 
# create_alias method usage example with argument unpacking

kwargs: CreateAliasRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Alias": ...,
}

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

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

# create_computer 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 
# create_computer method usage example with argument unpacking

kwargs: CreateComputerRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "ComputerName": ...,
    "Password": ...,
}

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

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

# create_conditional_forwarder method definition

def create_conditional_forwarder(
    self,
    *,
    DirectoryId: str,
    RemoteDomainName: str,
    DnsIpAddrs: Sequence[str],
) -> Dict[str, Any]:
    ...
# create_conditional_forwarder method usage example with argument unpacking

kwargs: CreateConditionalForwarderRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RemoteDomainName": ...,
    "DnsIpAddrs": ...,
}

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

create_directory#

Creates a Simple AD directory.

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

# create_directory method definition

def create_directory(
    self,
    *,
    Name: str,
    Password: str,
    Size: DirectorySizeType,  # (1)
    ShortName: str = ...,
    Description: str = ...,
    VpcSettings: DirectoryVpcSettingsUnionTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateDirectoryResultTypeDef:  # (4)
    ...
  1. See DirectorySizeType
  2. See DirectoryVpcSettingsTypeDef DirectoryVpcSettingsOutputTypeDef
  3. See TagTypeDef
  4. See CreateDirectoryResultTypeDef 
# create_directory method usage example with argument unpacking

kwargs: CreateDirectoryRequestTypeDef = {  # (1)
    "Name": ...,
    "Password": ...,
    "Size": ...,
}

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

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

# create_log_subscription method definition

def create_log_subscription(
    self,
    *,
    DirectoryId: str,
    LogGroupName: str,
) -> Dict[str, Any]:
    ...
# create_log_subscription method usage example with argument unpacking

kwargs: CreateLogSubscriptionRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "LogGroupName": ...,
}

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

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

# create_microsoft_ad method definition

def create_microsoft_ad(
    self,
    *,
    Name: str,
    Password: str,
    VpcSettings: DirectoryVpcSettingsUnionTypeDef,  # (1)
    ShortName: str = ...,
    Description: str = ...,
    Edition: DirectoryEditionType = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateMicrosoftADResultTypeDef:  # (4)
    ...
  1. See DirectoryVpcSettingsTypeDef DirectoryVpcSettingsOutputTypeDef
  2. See DirectoryEditionType
  3. See TagTypeDef
  4. See CreateMicrosoftADResultTypeDef 
# create_microsoft_ad method usage example with argument unpacking

kwargs: CreateMicrosoftADRequestTypeDef = {  # (1)
    "Name": ...,
    "Password": ...,
    "VpcSettings": ...,
}

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

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

# create_snapshot method definition

def create_snapshot(
    self,
    *,
    DirectoryId: str,
    Name: str = ...,
) -> CreateSnapshotResultTypeDef:  # (1)
    ...
  1. See CreateSnapshotResultTypeDef 
# create_snapshot method usage example with argument unpacking

kwargs: CreateSnapshotRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# create_trust 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 
# create_trust method usage example with argument unpacking

kwargs: CreateTrustRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RemoteDomainName": ...,
    "TrustPassword": ...,
    "TrustDirection": ...,
}

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

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

# delete_conditional_forwarder method definition

def delete_conditional_forwarder(
    self,
    *,
    DirectoryId: str,
    RemoteDomainName: str,
) -> Dict[str, Any]:
    ...
# delete_conditional_forwarder method usage example with argument unpacking

kwargs: DeleteConditionalForwarderRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RemoteDomainName": ...,
}

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

delete_directory#

Deletes an Directory Service directory.

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

# delete_directory method definition

def delete_directory(
    self,
    *,
    DirectoryId: str,
) -> DeleteDirectoryResultTypeDef:  # (1)
    ...
  1. See DeleteDirectoryResultTypeDef 
# delete_directory method usage example with argument unpacking

kwargs: DeleteDirectoryRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

delete_log_subscription#

Deletes the specified log subscription.

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

# delete_log_subscription method definition

def delete_log_subscription(
    self,
    *,
    DirectoryId: str,
) -> Dict[str, Any]:
    ...
# delete_log_subscription method usage example with argument unpacking

kwargs: DeleteLogSubscriptionRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

delete_snapshot#

Deletes a directory snapshot.

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

# delete_snapshot method definition

def delete_snapshot(
    self,
    *,
    SnapshotId: str,
) -> DeleteSnapshotResultTypeDef:  # (1)
    ...
  1. See DeleteSnapshotResultTypeDef 
# delete_snapshot method usage example with argument unpacking

kwargs: DeleteSnapshotRequestTypeDef = {  # (1)
    "SnapshotId": ...,
}

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

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

# delete_trust method definition

def delete_trust(
    self,
    *,
    TrustId: str,
    DeleteAssociatedConditionalForwarder: bool = ...,
) -> DeleteTrustResultTypeDef:  # (1)
    ...
  1. See DeleteTrustResultTypeDef 
# delete_trust method usage example with argument unpacking

kwargs: DeleteTrustRequestTypeDef = {  # (1)
    "TrustId": ...,
}

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

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

# deregister_certificate method definition

def deregister_certificate(
    self,
    *,
    DirectoryId: str,
    CertificateId: str,
) -> Dict[str, Any]:
    ...
# deregister_certificate method usage example with argument unpacking

kwargs: DeregisterCertificateRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "CertificateId": ...,
}

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

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

# deregister_event_topic method definition

def deregister_event_topic(
    self,
    *,
    DirectoryId: str,
    TopicName: str,
) -> Dict[str, Any]:
    ...
# deregister_event_topic method usage example with argument unpacking

kwargs: DeregisterEventTopicRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "TopicName": ...,
}

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

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

# describe_certificate method definition

def describe_certificate(
    self,
    *,
    DirectoryId: str,
    CertificateId: str,
) -> DescribeCertificateResultTypeDef:  # (1)
    ...
  1. See DescribeCertificateResultTypeDef 
# describe_certificate method usage example with argument unpacking

kwargs: DescribeCertificateRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "CertificateId": ...,
}

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

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

# describe_client_authentication_settings 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 
# describe_client_authentication_settings method usage example with argument unpacking

kwargs: DescribeClientAuthenticationSettingsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# describe_conditional_forwarders method definition

def describe_conditional_forwarders(
    self,
    *,
    DirectoryId: str,
    RemoteDomainNames: Sequence[str] = ...,
) -> DescribeConditionalForwardersResultTypeDef:  # (1)
    ...
  1. See DescribeConditionalForwardersResultTypeDef 
# describe_conditional_forwarders method usage example with argument unpacking

kwargs: DescribeConditionalForwardersRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# describe_directories method definition

def describe_directories(
    self,
    *,
    DirectoryIds: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeDirectoriesResultTypeDef:  # (1)
    ...
  1. See DescribeDirectoriesResultTypeDef 
# describe_directories method usage example with argument unpacking

kwargs: DescribeDirectoriesRequestTypeDef = {  # (1)
    "DirectoryIds": ...,
}

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

describe_directory_data_access#

Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.

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

# describe_directory_data_access method definition

def describe_directory_data_access(
    self,
    *,
    DirectoryId: str,
) -> DescribeDirectoryDataAccessResultTypeDef:  # (1)
    ...
  1. See DescribeDirectoryDataAccessResultTypeDef 
# describe_directory_data_access method usage example with argument unpacking

kwargs: DescribeDirectoryDataAccessRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.describe_directory_data_access(**kwargs)
  1. See DescribeDirectoryDataAccessRequestTypeDef

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

# describe_domain_controllers method definition

def describe_domain_controllers(
    self,
    *,
    DirectoryId: str,
    DomainControllerIds: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeDomainControllersResultTypeDef:  # (1)
    ...
  1. See DescribeDomainControllersResultTypeDef 
# describe_domain_controllers method usage example with argument unpacking

kwargs: DescribeDomainControllersRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# describe_event_topics method definition

def describe_event_topics(
    self,
    *,
    DirectoryId: str = ...,
    TopicNames: Sequence[str] = ...,
) -> DescribeEventTopicsResultTypeDef:  # (1)
    ...
  1. See DescribeEventTopicsResultTypeDef 
# describe_event_topics method usage example with argument unpacking

kwargs: DescribeEventTopicsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# describe_ldaps_settings method definition

def describe_ldaps_settings(
    self,
    *,
    DirectoryId: str,
    Type: LDAPSTypeType = ...,  # (1)
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeLDAPSSettingsResultTypeDef:  # (2)
    ...
  1. See LDAPSTypeType
  2. See DescribeLDAPSSettingsResultTypeDef 
# describe_ldaps_settings method usage example with argument unpacking

kwargs: DescribeLDAPSSettingsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# describe_regions method definition

def describe_regions(
    self,
    *,
    DirectoryId: str,
    RegionName: str = ...,
    NextToken: str = ...,
) -> DescribeRegionsResultTypeDef:  # (1)
    ...
  1. See DescribeRegionsResultTypeDef 
# describe_regions method usage example with argument unpacking

kwargs: DescribeRegionsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# describe_settings method definition

def describe_settings(
    self,
    *,
    DirectoryId: str,
    Status: DirectoryConfigurationStatusType = ...,  # (1)
    NextToken: str = ...,
) -> DescribeSettingsResultTypeDef:  # (2)
    ...
  1. See DirectoryConfigurationStatusType
  2. See DescribeSettingsResultTypeDef 
# describe_settings method usage example with argument unpacking

kwargs: DescribeSettingsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# describe_shared_directories method definition

def describe_shared_directories(
    self,
    *,
    OwnerDirectoryId: str,
    SharedDirectoryIds: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeSharedDirectoriesResultTypeDef:  # (1)
    ...
  1. See DescribeSharedDirectoriesResultTypeDef 
# describe_shared_directories method usage example with argument unpacking

kwargs: DescribeSharedDirectoriesRequestTypeDef = {  # (1)
    "OwnerDirectoryId": ...,
}

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

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

# describe_snapshots method definition

def describe_snapshots(
    self,
    *,
    DirectoryId: str = ...,
    SnapshotIds: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeSnapshotsResultTypeDef:  # (1)
    ...
  1. See DescribeSnapshotsResultTypeDef 
# describe_snapshots method usage example with argument unpacking

kwargs: DescribeSnapshotsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# describe_trusts method definition

def describe_trusts(
    self,
    *,
    DirectoryId: str = ...,
    TrustIds: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeTrustsResultTypeDef:  # (1)
    ...
  1. See DescribeTrustsResultTypeDef 
# describe_trusts method usage example with argument unpacking

kwargs: DescribeTrustsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

describe_update_directory#

Describes the updates of a directory for a particular update type.

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

# describe_update_directory method definition

def describe_update_directory(
    self,
    *,
    DirectoryId: str,
    UpdateType: UpdateTypeType,  # (1)
    RegionName: str = ...,
    NextToken: str = ...,
) -> DescribeUpdateDirectoryResultTypeDef:  # (2)
    ...
  1. See UpdateTypeType
  2. See DescribeUpdateDirectoryResultTypeDef 
# describe_update_directory method usage example with argument unpacking

kwargs: DescribeUpdateDirectoryRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "UpdateType": ...,
}

parent.describe_update_directory(**kwargs)
  1. See DescribeUpdateDirectoryRequestTypeDef

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

# disable_client_authentication method definition

def disable_client_authentication(
    self,
    *,
    DirectoryId: str,
    Type: ClientAuthenticationTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ClientAuthenticationTypeType 
# disable_client_authentication method usage example with argument unpacking

kwargs: DisableClientAuthenticationRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Type": ...,
}

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

disable_directory_data_access#

Deactivates access to directory data via the Directory Service Data API for the specified directory.

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

# disable_directory_data_access method definition

def disable_directory_data_access(
    self,
    *,
    DirectoryId: str,
) -> Dict[str, Any]:
    ...
# disable_directory_data_access method usage example with argument unpacking

kwargs: DisableDirectoryDataAccessRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.disable_directory_data_access(**kwargs)
  1. See DisableDirectoryDataAccessRequestTypeDef

disable_ldaps#

Deactivates LDAP secure calls for the specified directory.

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

# disable_ldaps method definition

def disable_ldaps(
    self,
    *,
    DirectoryId: str,
    Type: LDAPSTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See LDAPSTypeType 
# disable_ldaps method usage example with argument unpacking

kwargs: DisableLDAPSRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Type": ...,
}

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

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

# disable_radius method definition

def disable_radius(
    self,
    *,
    DirectoryId: str,
) -> Dict[str, Any]:
    ...
# disable_radius method usage example with argument unpacking

kwargs: DisableRadiusRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

disable_sso#

Disables single-sign on for a directory.

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

# disable_sso method definition

def disable_sso(
    self,
    *,
    DirectoryId: str,
    UserName: str = ...,
    Password: str = ...,
) -> Dict[str, Any]:
    ...
# disable_sso method usage example with argument unpacking

kwargs: DisableSsoRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# enable_client_authentication method definition

def enable_client_authentication(
    self,
    *,
    DirectoryId: str,
    Type: ClientAuthenticationTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ClientAuthenticationTypeType 
# enable_client_authentication method usage example with argument unpacking

kwargs: EnableClientAuthenticationRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Type": ...,
}

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

enable_directory_data_access#

Enables access to directory data via the Directory Service Data API for the specified directory.

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

# enable_directory_data_access method definition

def enable_directory_data_access(
    self,
    *,
    DirectoryId: str,
) -> Dict[str, Any]:
    ...
# enable_directory_data_access method usage example with argument unpacking

kwargs: EnableDirectoryDataAccessRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.enable_directory_data_access(**kwargs)
  1. See EnableDirectoryDataAccessRequestTypeDef

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

# enable_ldaps method definition

def enable_ldaps(
    self,
    *,
    DirectoryId: str,
    Type: LDAPSTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See LDAPSTypeType 
# enable_ldaps method usage example with argument unpacking

kwargs: EnableLDAPSRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Type": ...,
}

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

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

# enable_radius method definition

def enable_radius(
    self,
    *,
    DirectoryId: str,
    RadiusSettings: RadiusSettingsUnionTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See RadiusSettingsTypeDef RadiusSettingsOutputTypeDef 
# enable_radius method usage example with argument unpacking

kwargs: EnableRadiusRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RadiusSettings": ...,
}

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

enable_sso#

Enables single sign-on for a directory.

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

# enable_sso method definition

def enable_sso(
    self,
    *,
    DirectoryId: str,
    UserName: str = ...,
    Password: str = ...,
) -> Dict[str, Any]:
    ...
# enable_sso method usage example with argument unpacking

kwargs: EnableSsoRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# get_directory_limits 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

# get_snapshot_limits method definition

def get_snapshot_limits(
    self,
    *,
    DirectoryId: str,
) -> GetSnapshotLimitsResultTypeDef:  # (1)
    ...
  1. See GetSnapshotLimitsResultTypeDef 
# get_snapshot_limits method usage example with argument unpacking

kwargs: GetSnapshotLimitsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# list_certificates method definition

def list_certificates(
    self,
    *,
    DirectoryId: str,
    NextToken: str = ...,
    Limit: int = ...,
) -> ListCertificatesResultTypeDef:  # (1)
    ...
  1. See ListCertificatesResultTypeDef 
# list_certificates method usage example with argument unpacking

kwargs: ListCertificatesRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# list_ip_routes method definition

def list_ip_routes(
    self,
    *,
    DirectoryId: str,
    NextToken: str = ...,
    Limit: int = ...,
) -> ListIpRoutesResultTypeDef:  # (1)
    ...
  1. See ListIpRoutesResultTypeDef 
# list_ip_routes method usage example with argument unpacking

kwargs: ListIpRoutesRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# list_log_subscriptions method definition

def list_log_subscriptions(
    self,
    *,
    DirectoryId: str = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> ListLogSubscriptionsResultTypeDef:  # (1)
    ...
  1. See ListLogSubscriptionsResultTypeDef 
# list_log_subscriptions method usage example with argument unpacking

kwargs: ListLogSubscriptionsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# list_schema_extensions method definition

def list_schema_extensions(
    self,
    *,
    DirectoryId: str,
    NextToken: str = ...,
    Limit: int = ...,
) -> ListSchemaExtensionsResultTypeDef:  # (1)
    ...
  1. See ListSchemaExtensionsResultTypeDef 
# list_schema_extensions method usage example with argument unpacking

kwargs: ListSchemaExtensionsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

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

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceId: str,
    NextToken: str = ...,
    Limit: int = ...,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResultTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

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

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

# register_certificate 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 
# register_certificate method usage example with argument unpacking

kwargs: RegisterCertificateRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "CertificateData": ...,
}

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

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

# register_event_topic method definition

def register_event_topic(
    self,
    *,
    DirectoryId: str,
    TopicName: str,
) -> Dict[str, Any]:
    ...
# register_event_topic method usage example with argument unpacking

kwargs: RegisterEventTopicRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "TopicName": ...,
}

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

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

# reject_shared_directory method definition

def reject_shared_directory(
    self,
    *,
    SharedDirectoryId: str,
) -> RejectSharedDirectoryResultTypeDef:  # (1)
    ...
  1. See RejectSharedDirectoryResultTypeDef 
# reject_shared_directory method usage example with argument unpacking

kwargs: RejectSharedDirectoryRequestTypeDef = {  # (1)
    "SharedDirectoryId": ...,
}

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

remove_ip_routes#

Removes IP address blocks from a directory.

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

# remove_ip_routes method definition

def remove_ip_routes(
    self,
    *,
    DirectoryId: str,
    CidrIps: Sequence[str],
) -> Dict[str, Any]:
    ...
# remove_ip_routes method usage example with argument unpacking

kwargs: RemoveIpRoutesRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "CidrIps": ...,
}

parent.remove_ip_routes(**kwargs)
  1. See RemoveIpRoutesRequestTypeDef

remove_region#

Stops all replication and removes the domain controllers from the specified Region.

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

# remove_region method definition

def remove_region(
    self,
    *,
    DirectoryId: str,
) -> Dict[str, Any]:
    ...
# remove_region method usage example with argument unpacking

kwargs: RemoveRegionRequestTypeDef = {  # (1)
    "DirectoryId": ...,
}

parent.remove_region(**kwargs)
  1. See RemoveRegionRequestTypeDef

remove_tags_from_resource#

Removes tags from a directory.

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

# remove_tags_from_resource method definition

def remove_tags_from_resource(
    self,
    *,
    ResourceId: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# remove_tags_from_resource method usage example with argument unpacking

kwargs: RemoveTagsFromResourceRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "TagKeys": ...,
}

parent.remove_tags_from_resource(**kwargs)
  1. See RemoveTagsFromResourceRequestTypeDef

reset_user_password#

Resets the password for any user in your Managed Microsoft AD or Simple AD directory.

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

# reset_user_password method definition

def reset_user_password(
    self,
    *,
    DirectoryId: str,
    UserName: str,
    NewPassword: str,
) -> Dict[str, Any]:
    ...
# reset_user_password method usage example with argument unpacking

kwargs: ResetUserPasswordRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "UserName": ...,
    "NewPassword": ...,
}

parent.reset_user_password(**kwargs)
  1. See ResetUserPasswordRequestTypeDef

restore_from_snapshot#

Restores a directory using an existing directory snapshot.

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

# restore_from_snapshot method definition

def restore_from_snapshot(
    self,
    *,
    SnapshotId: str,
) -> Dict[str, Any]:
    ...
# restore_from_snapshot method usage example with argument unpacking

kwargs: RestoreFromSnapshotRequestTypeDef = {  # (1)
    "SnapshotId": ...,
}

parent.restore_from_snapshot(**kwargs)
  1. See RestoreFromSnapshotRequestTypeDef

share_directory#

Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer).

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

# share_directory method definition

def share_directory(
    self,
    *,
    DirectoryId: str,
    ShareTarget: ShareTargetTypeDef,  # (1)
    ShareMethod: ShareMethodType,  # (2)
    ShareNotes: str = ...,
) -> ShareDirectoryResultTypeDef:  # (3)
    ...
  1. See ShareTargetTypeDef
  2. See ShareMethodType
  3. See ShareDirectoryResultTypeDef 
# share_directory method usage example with argument unpacking

kwargs: ShareDirectoryRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "ShareTarget": ...,
    "ShareMethod": ...,
}

parent.share_directory(**kwargs)
  1. See ShareDirectoryRequestTypeDef

start_schema_extension#

Applies a schema extension to a Microsoft AD directory.

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

# start_schema_extension method definition

def start_schema_extension(
    self,
    *,
    DirectoryId: str,
    CreateSnapshotBeforeSchemaExtension: bool,
    LdifContent: str,
    Description: str,
) -> StartSchemaExtensionResultTypeDef:  # (1)
    ...
  1. See StartSchemaExtensionResultTypeDef 
# start_schema_extension method usage example with argument unpacking

kwargs: StartSchemaExtensionRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "CreateSnapshotBeforeSchemaExtension": ...,
    "LdifContent": ...,
    "Description": ...,
}

parent.start_schema_extension(**kwargs)
  1. See StartSchemaExtensionRequestTypeDef

unshare_directory#

Stops the directory sharing between the directory owner and consumer accounts.

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

# unshare_directory method definition

def unshare_directory(
    self,
    *,
    DirectoryId: str,
    UnshareTarget: UnshareTargetTypeDef,  # (1)
) -> UnshareDirectoryResultTypeDef:  # (2)
    ...
  1. See UnshareTargetTypeDef
  2. See UnshareDirectoryResultTypeDef 
# unshare_directory method usage example with argument unpacking

kwargs: UnshareDirectoryRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "UnshareTarget": ...,
}

parent.unshare_directory(**kwargs)
  1. See UnshareDirectoryRequestTypeDef

update_conditional_forwarder#

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

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

# update_conditional_forwarder method definition

def update_conditional_forwarder(
    self,
    *,
    DirectoryId: str,
    RemoteDomainName: str,
    DnsIpAddrs: Sequence[str],
) -> Dict[str, Any]:
    ...
# update_conditional_forwarder method usage example with argument unpacking

kwargs: UpdateConditionalForwarderRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RemoteDomainName": ...,
    "DnsIpAddrs": ...,
}

parent.update_conditional_forwarder(**kwargs)
  1. See UpdateConditionalForwarderRequestTypeDef

update_directory_setup#

Updates the directory for a particular update type.

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

# update_directory_setup method definition

def update_directory_setup(
    self,
    *,
    DirectoryId: str,
    UpdateType: UpdateTypeType,  # (1)
    OSUpdateSettings: OSUpdateSettingsTypeDef = ...,  # (2)
    CreateSnapshotBeforeUpdate: bool = ...,
) -> Dict[str, Any]:
    ...
  1. See UpdateTypeType
  2. See OSUpdateSettingsTypeDef 
# update_directory_setup method usage example with argument unpacking

kwargs: UpdateDirectorySetupRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "UpdateType": ...,
}

parent.update_directory_setup(**kwargs)
  1. See UpdateDirectorySetupRequestTypeDef

update_number_of_domain_controllers#

Adds or removes domain controllers to or from the directory.

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

# update_number_of_domain_controllers method definition

def update_number_of_domain_controllers(
    self,
    *,
    DirectoryId: str,
    DesiredNumber: int,
) -> Dict[str, Any]:
    ...
# update_number_of_domain_controllers method usage example with argument unpacking

kwargs: UpdateNumberOfDomainControllersRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "DesiredNumber": ...,
}

parent.update_number_of_domain_controllers(**kwargs)
  1. See UpdateNumberOfDomainControllersRequestTypeDef

update_radius#

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.

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

# update_radius method definition

def update_radius(
    self,
    *,
    DirectoryId: str,
    RadiusSettings: RadiusSettingsUnionTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See RadiusSettingsTypeDef RadiusSettingsOutputTypeDef 
# update_radius method usage example with argument unpacking

kwargs: UpdateRadiusRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "RadiusSettings": ...,
}

parent.update_radius(**kwargs)
  1. See UpdateRadiusRequestTypeDef

update_settings#

Updates the configurable settings for the specified directory.

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

# update_settings method definition

def update_settings(
    self,
    *,
    DirectoryId: str,
    Settings: Sequence[SettingTypeDef],  # (1)
) -> UpdateSettingsResultTypeDef:  # (2)
    ...
  1. See SettingTypeDef
  2. See UpdateSettingsResultTypeDef 
# update_settings method usage example with argument unpacking

kwargs: UpdateSettingsRequestTypeDef = {  # (1)
    "DirectoryId": ...,
    "Settings": ...,
}

parent.update_settings(**kwargs)
  1. See UpdateSettingsRequestTypeDef

update_trust#

Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.

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

# update_trust method definition

def update_trust(
    self,
    *,
    TrustId: str,
    SelectiveAuth: SelectiveAuthType = ...,  # (1)
) -> UpdateTrustResultTypeDef:  # (2)
    ...
  1. See SelectiveAuthType
  2. See UpdateTrustResultTypeDef 
# update_trust method usage example with argument unpacking

kwargs: UpdateTrustRequestTypeDef = {  # (1)
    "TrustId": ...,
}

parent.update_trust(**kwargs)
  1. See UpdateTrustRequestTypeDef

verify_trust#

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

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

# verify_trust method definition

def verify_trust(
    self,
    *,
    TrustId: str,
) -> VerifyTrustResultTypeDef:  # (1)
    ...
  1. See VerifyTrustResultTypeDef 
# verify_trust method usage example with argument unpacking

kwargs: VerifyTrustRequestTypeDef = {  # (1)
    "TrustId": ...,
}

parent.verify_trust(**kwargs)
  1. See VerifyTrustRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("ds").get_paginator method with overloads.