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
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.
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.DirectoryInDesiredStateException,
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)
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
def accept_shared_directory(
self,
*,
SharedDirectoryId: str,
) -> AcceptSharedDirectoryResultTypeDef: # (1)
...
kwargs: AcceptSharedDirectoryRequestRequestTypeDef = { # (1)
"SharedDirectoryId": ...,
}
parent.accept_shared_directory(**kwargs)
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
def add_ip_routes(
self,
*,
DirectoryId: str,
IpRoutes: Sequence[IpRouteTypeDef], # (1)
UpdateSecurityGroupForDirectoryControllers: bool = ...,
) -> Dict[str, Any]:
...
- See IpRouteTypeDef
kwargs: AddIpRoutesRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"IpRoutes": ...,
}
parent.add_ip_routes(**kwargs)
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
def add_region(
self,
*,
DirectoryId: str,
RegionName: str,
VPCSettings: DirectoryVpcSettingsTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: AddRegionRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"RegionName": ...,
"VPCSettings": ...,
}
parent.add_region(**kwargs)
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
def add_tags_to_resource(
self,
*,
ResourceId: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: AddTagsToResourceRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"Tags": ...,
}
parent.add_tags_to_resource(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("ds").can_paginate
method.
boto3 documentation
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
def cancel_schema_extension(
self,
*,
DirectoryId: str,
SchemaExtensionId: str,
) -> Dict[str, Any]:
...
kwargs: CancelSchemaExtensionRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"SchemaExtensionId": ...,
}
parent.cancel_schema_extension(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("ds").close
method.
boto3 documentation
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
def connect_directory(
self,
*,
Name: str,
Password: str,
Size: DirectorySizeType, # (1)
ConnectSettings: DirectoryConnectSettingsTypeDef, # (2)
ShortName: str = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> ConnectDirectoryResultTypeDef: # (4)
...
- See DirectorySizeType
- See DirectoryConnectSettingsTypeDef
- See TagTypeDef
- See ConnectDirectoryResultTypeDef
kwargs: ConnectDirectoryRequestRequestTypeDef = { # (1)
"Name": ...,
"Password": ...,
"Size": ...,
"ConnectSettings": ...,
}
parent.connect_directory(**kwargs)
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
def create_alias(
self,
*,
DirectoryId: str,
Alias: str,
) -> CreateAliasResultTypeDef: # (1)
...
kwargs: CreateAliasRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"Alias": ...,
}
parent.create_alias(**kwargs)
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
def create_computer(
self,
*,
DirectoryId: str,
ComputerName: str,
Password: str,
OrganizationalUnitDistinguishedName: str = ...,
ComputerAttributes: Sequence[AttributeTypeDef] = ..., # (1)
) -> CreateComputerResultTypeDef: # (2)
...
kwargs: CreateComputerRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"ComputerName": ...,
"Password": ...,
}
parent.create_computer(**kwargs)
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
def create_conditional_forwarder(
self,
*,
DirectoryId: str,
RemoteDomainName: str,
DnsIpAddrs: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: CreateConditionalForwarderRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"RemoteDomainName": ...,
"DnsIpAddrs": ...,
}
parent.create_conditional_forwarder(**kwargs)
create_directory
Creates a Simple AD directory.
Type annotations and code completion for boto3.client("ds").create_directory
method.
boto3 documentation
def create_directory(
self,
*,
Name: str,
Password: str,
Size: DirectorySizeType, # (1)
ShortName: str = ...,
Description: str = ...,
VpcSettings: DirectoryVpcSettingsTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateDirectoryResultTypeDef: # (4)
...
- See DirectorySizeType
- See DirectoryVpcSettingsTypeDef
- See TagTypeDef
- See CreateDirectoryResultTypeDef
kwargs: CreateDirectoryRequestRequestTypeDef = { # (1)
"Name": ...,
"Password": ...,
"Size": ...,
}
parent.create_directory(**kwargs)
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
def create_log_subscription(
self,
*,
DirectoryId: str,
LogGroupName: str,
) -> Dict[str, Any]:
...
kwargs: CreateLogSubscriptionRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"LogGroupName": ...,
}
parent.create_log_subscription(**kwargs)
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
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)
...
- See DirectoryVpcSettingsTypeDef
- See DirectoryEditionType
- See TagTypeDef
- See CreateMicrosoftADResultTypeDef
kwargs: CreateMicrosoftADRequestRequestTypeDef = { # (1)
"Name": ...,
"Password": ...,
"VpcSettings": ...,
}
parent.create_microsoft_ad(**kwargs)
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
def create_snapshot(
self,
*,
DirectoryId: str,
Name: str = ...,
) -> CreateSnapshotResultTypeDef: # (1)
...
kwargs: CreateSnapshotRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.create_snapshot(**kwargs)
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
def create_trust(
self,
*,
DirectoryId: str,
RemoteDomainName: str,
TrustPassword: str,
TrustDirection: TrustDirectionType, # (1)
TrustType: TrustTypeType = ..., # (2)
ConditionalForwarderIpAddrs: Sequence[str] = ...,
SelectiveAuth: SelectiveAuthType = ..., # (3)
) -> CreateTrustResultTypeDef: # (4)
...
- See TrustDirectionType
- See TrustTypeType
- See SelectiveAuthType
- See CreateTrustResultTypeDef
kwargs: CreateTrustRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"RemoteDomainName": ...,
"TrustPassword": ...,
"TrustDirection": ...,
}
parent.create_trust(**kwargs)
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
def delete_conditional_forwarder(
self,
*,
DirectoryId: str,
RemoteDomainName: str,
) -> Dict[str, Any]:
...
kwargs: DeleteConditionalForwarderRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"RemoteDomainName": ...,
}
parent.delete_conditional_forwarder(**kwargs)
delete_directory
Deletes an Directory Service directory.
Type annotations and code completion for boto3.client("ds").delete_directory
method.
boto3 documentation
def delete_directory(
self,
*,
DirectoryId: str,
) -> DeleteDirectoryResultTypeDef: # (1)
...
kwargs: DeleteDirectoryRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.delete_directory(**kwargs)
delete_log_subscription
Deletes the specified log subscription.
Type annotations and code completion for boto3.client("ds").delete_log_subscription
method.
boto3 documentation
kwargs: DeleteLogSubscriptionRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.delete_log_subscription(**kwargs)
delete_snapshot
Deletes a directory snapshot.
Type annotations and code completion for boto3.client("ds").delete_snapshot
method.
boto3 documentation
def delete_snapshot(
self,
*,
SnapshotId: str,
) -> DeleteSnapshotResultTypeDef: # (1)
...
kwargs: DeleteSnapshotRequestRequestTypeDef = { # (1)
"SnapshotId": ...,
}
parent.delete_snapshot(**kwargs)
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
def delete_trust(
self,
*,
TrustId: str,
DeleteAssociatedConditionalForwarder: bool = ...,
) -> DeleteTrustResultTypeDef: # (1)
...
kwargs: DeleteTrustRequestRequestTypeDef = { # (1)
"TrustId": ...,
}
parent.delete_trust(**kwargs)
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
def deregister_certificate(
self,
*,
DirectoryId: str,
CertificateId: str,
) -> Dict[str, Any]:
...
kwargs: DeregisterCertificateRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"CertificateId": ...,
}
parent.deregister_certificate(**kwargs)
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
def deregister_event_topic(
self,
*,
DirectoryId: str,
TopicName: str,
) -> Dict[str, Any]:
...
kwargs: DeregisterEventTopicRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"TopicName": ...,
}
parent.deregister_event_topic(**kwargs)
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
def describe_certificate(
self,
*,
DirectoryId: str,
CertificateId: str,
) -> DescribeCertificateResultTypeDef: # (1)
...
kwargs: DescribeCertificateRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"CertificateId": ...,
}
parent.describe_certificate(**kwargs)
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
def describe_client_authentication_settings(
self,
*,
DirectoryId: str,
Type: ClientAuthenticationTypeType = ..., # (1)
NextToken: str = ...,
Limit: int = ...,
) -> DescribeClientAuthenticationSettingsResultTypeDef: # (2)
...
kwargs: DescribeClientAuthenticationSettingsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.describe_client_authentication_settings(**kwargs)
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
def describe_conditional_forwarders(
self,
*,
DirectoryId: str,
RemoteDomainNames: Sequence[str] = ...,
) -> DescribeConditionalForwardersResultTypeDef: # (1)
...
kwargs: DescribeConditionalForwardersRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.describe_conditional_forwarders(**kwargs)
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
def describe_directories(
self,
*,
DirectoryIds: Sequence[str] = ...,
NextToken: str = ...,
Limit: int = ...,
) -> DescribeDirectoriesResultTypeDef: # (1)
...
kwargs: DescribeDirectoriesRequestRequestTypeDef = { # (1)
"DirectoryIds": ...,
}
parent.describe_directories(**kwargs)
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
def describe_domain_controllers(
self,
*,
DirectoryId: str,
DomainControllerIds: Sequence[str] = ...,
NextToken: str = ...,
Limit: int = ...,
) -> DescribeDomainControllersResultTypeDef: # (1)
...
kwargs: DescribeDomainControllersRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.describe_domain_controllers(**kwargs)
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
def describe_event_topics(
self,
*,
DirectoryId: str = ...,
TopicNames: Sequence[str] = ...,
) -> DescribeEventTopicsResultTypeDef: # (1)
...
kwargs: DescribeEventTopicsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.describe_event_topics(**kwargs)
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
def describe_ldaps_settings(
self,
*,
DirectoryId: str,
Type: LDAPSTypeType = ..., # (1)
NextToken: str = ...,
Limit: int = ...,
) -> DescribeLDAPSSettingsResultTypeDef: # (2)
...
kwargs: DescribeLDAPSSettingsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.describe_ldaps_settings(**kwargs)
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
def describe_regions(
self,
*,
DirectoryId: str,
RegionName: str = ...,
NextToken: str = ...,
) -> DescribeRegionsResultTypeDef: # (1)
...
kwargs: DescribeRegionsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.describe_regions(**kwargs)
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
def describe_settings(
self,
*,
DirectoryId: str,
Status: DirectoryConfigurationStatusType = ..., # (1)
NextToken: str = ...,
) -> DescribeSettingsResultTypeDef: # (2)
...
kwargs: DescribeSettingsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.describe_settings(**kwargs)
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
def describe_shared_directories(
self,
*,
OwnerDirectoryId: str,
SharedDirectoryIds: Sequence[str] = ...,
NextToken: str = ...,
Limit: int = ...,
) -> DescribeSharedDirectoriesResultTypeDef: # (1)
...
kwargs: DescribeSharedDirectoriesRequestRequestTypeDef = { # (1)
"OwnerDirectoryId": ...,
}
parent.describe_shared_directories(**kwargs)
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
def describe_snapshots(
self,
*,
DirectoryId: str = ...,
SnapshotIds: Sequence[str] = ...,
NextToken: str = ...,
Limit: int = ...,
) -> DescribeSnapshotsResultTypeDef: # (1)
...
kwargs: DescribeSnapshotsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.describe_snapshots(**kwargs)
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
def describe_trusts(
self,
*,
DirectoryId: str = ...,
TrustIds: Sequence[str] = ...,
NextToken: str = ...,
Limit: int = ...,
) -> DescribeTrustsResultTypeDef: # (1)
...
kwargs: DescribeTrustsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.describe_trusts(**kwargs)
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
def describe_update_directory(
self,
*,
DirectoryId: str,
UpdateType: UpdateTypeType, # (1)
RegionName: str = ...,
NextToken: str = ...,
) -> DescribeUpdateDirectoryResultTypeDef: # (2)
...
kwargs: DescribeUpdateDirectoryRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"UpdateType": ...,
}
parent.describe_update_directory(**kwargs)
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
def disable_client_authentication(
self,
*,
DirectoryId: str,
Type: ClientAuthenticationTypeType, # (1)
) -> Dict[str, Any]:
...
kwargs: DisableClientAuthenticationRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"Type": ...,
}
parent.disable_client_authentication(**kwargs)
disable_ldaps
Deactivates LDAP secure calls for the specified directory.
Type annotations and code completion for boto3.client("ds").disable_ldaps
method.
boto3 documentation
def disable_ldaps(
self,
*,
DirectoryId: str,
Type: LDAPSTypeType, # (1)
) -> Dict[str, Any]:
...
- See LDAPSTypeType
kwargs: DisableLDAPSRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"Type": ...,
}
parent.disable_ldaps(**kwargs)
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
kwargs: DisableRadiusRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.disable_radius(**kwargs)
disable_sso
Disables single-sign on for a directory.
Type annotations and code completion for boto3.client("ds").disable_sso
method.
boto3 documentation
def disable_sso(
self,
*,
DirectoryId: str,
UserName: str = ...,
Password: str = ...,
) -> Dict[str, Any]:
...
kwargs: DisableSsoRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.disable_sso(**kwargs)
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
def enable_client_authentication(
self,
*,
DirectoryId: str,
Type: ClientAuthenticationTypeType, # (1)
) -> Dict[str, Any]:
...
kwargs: EnableClientAuthenticationRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"Type": ...,
}
parent.enable_client_authentication(**kwargs)
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
def enable_ldaps(
self,
*,
DirectoryId: str,
Type: LDAPSTypeType, # (1)
) -> Dict[str, Any]:
...
- See LDAPSTypeType
kwargs: EnableLDAPSRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"Type": ...,
}
parent.enable_ldaps(**kwargs)
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
def enable_radius(
self,
*,
DirectoryId: str,
RadiusSettings: RadiusSettingsTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: EnableRadiusRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"RadiusSettings": ...,
}
parent.enable_radius(**kwargs)
enable_sso
Enables single sign-on for a directory.
Type annotations and code completion for boto3.client("ds").enable_sso
method.
boto3 documentation
def enable_sso(
self,
*,
DirectoryId: str,
UserName: str = ...,
Password: str = ...,
) -> Dict[str, Any]:
...
kwargs: EnableSsoRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.enable_sso(**kwargs)
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
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
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
def get_snapshot_limits(
self,
*,
DirectoryId: str,
) -> GetSnapshotLimitsResultTypeDef: # (1)
...
kwargs: GetSnapshotLimitsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.get_snapshot_limits(**kwargs)
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
def list_certificates(
self,
*,
DirectoryId: str,
NextToken: str = ...,
Limit: int = ...,
) -> ListCertificatesResultTypeDef: # (1)
...
kwargs: ListCertificatesRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.list_certificates(**kwargs)
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
def list_ip_routes(
self,
*,
DirectoryId: str,
NextToken: str = ...,
Limit: int = ...,
) -> ListIpRoutesResultTypeDef: # (1)
...
kwargs: ListIpRoutesRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.list_ip_routes(**kwargs)
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
def list_log_subscriptions(
self,
*,
DirectoryId: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListLogSubscriptionsResultTypeDef: # (1)
...
kwargs: ListLogSubscriptionsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.list_log_subscriptions(**kwargs)
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
def list_schema_extensions(
self,
*,
DirectoryId: str,
NextToken: str = ...,
Limit: int = ...,
) -> ListSchemaExtensionsResultTypeDef: # (1)
...
kwargs: ListSchemaExtensionsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.list_schema_extensions(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceId: str,
NextToken: str = ...,
Limit: int = ...,
) -> ListTagsForResourceResultTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def register_certificate(
self,
*,
DirectoryId: str,
CertificateData: str,
Type: CertificateTypeType = ..., # (1)
ClientCertAuthSettings: ClientCertAuthSettingsTypeDef = ..., # (2)
) -> RegisterCertificateResultTypeDef: # (3)
...
kwargs: RegisterCertificateRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"CertificateData": ...,
}
parent.register_certificate(**kwargs)
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
def register_event_topic(
self,
*,
DirectoryId: str,
TopicName: str,
) -> Dict[str, Any]:
...
kwargs: RegisterEventTopicRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"TopicName": ...,
}
parent.register_event_topic(**kwargs)
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
def reject_shared_directory(
self,
*,
SharedDirectoryId: str,
) -> RejectSharedDirectoryResultTypeDef: # (1)
...
kwargs: RejectSharedDirectoryRequestRequestTypeDef = { # (1)
"SharedDirectoryId": ...,
}
parent.reject_shared_directory(**kwargs)
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
def remove_ip_routes(
self,
*,
DirectoryId: str,
CidrIps: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: RemoveIpRoutesRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"CidrIps": ...,
}
parent.remove_ip_routes(**kwargs)
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
kwargs: RemoveRegionRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
}
parent.remove_region(**kwargs)
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
def remove_tags_from_resource(
self,
*,
ResourceId: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: RemoveTagsFromResourceRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"TagKeys": ...,
}
parent.remove_tags_from_resource(**kwargs)
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
def reset_user_password(
self,
*,
DirectoryId: str,
UserName: str,
NewPassword: str,
) -> Dict[str, Any]:
...
kwargs: ResetUserPasswordRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"UserName": ...,
"NewPassword": ...,
}
parent.reset_user_password(**kwargs)
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
kwargs: RestoreFromSnapshotRequestRequestTypeDef = { # (1)
"SnapshotId": ...,
}
parent.restore_from_snapshot(**kwargs)
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
def share_directory(
self,
*,
DirectoryId: str,
ShareTarget: ShareTargetTypeDef, # (1)
ShareMethod: ShareMethodType, # (2)
ShareNotes: str = ...,
) -> ShareDirectoryResultTypeDef: # (3)
...
kwargs: ShareDirectoryRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"ShareTarget": ...,
"ShareMethod": ...,
}
parent.share_directory(**kwargs)
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
def start_schema_extension(
self,
*,
DirectoryId: str,
CreateSnapshotBeforeSchemaExtension: bool,
LdifContent: str,
Description: str,
) -> StartSchemaExtensionResultTypeDef: # (1)
...
kwargs: StartSchemaExtensionRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"CreateSnapshotBeforeSchemaExtension": ...,
"LdifContent": ...,
"Description": ...,
}
parent.start_schema_extension(**kwargs)
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
def unshare_directory(
self,
*,
DirectoryId: str,
UnshareTarget: UnshareTargetTypeDef, # (1)
) -> UnshareDirectoryResultTypeDef: # (2)
...
kwargs: UnshareDirectoryRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"UnshareTarget": ...,
}
parent.unshare_directory(**kwargs)
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
def update_conditional_forwarder(
self,
*,
DirectoryId: str,
RemoteDomainName: str,
DnsIpAddrs: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UpdateConditionalForwarderRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"RemoteDomainName": ...,
"DnsIpAddrs": ...,
}
parent.update_conditional_forwarder(**kwargs)
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
def update_directory_setup(
self,
*,
DirectoryId: str,
UpdateType: UpdateTypeType, # (1)
OSUpdateSettings: OSUpdateSettingsTypeDef = ..., # (2)
CreateSnapshotBeforeUpdate: bool = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateDirectorySetupRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"UpdateType": ...,
}
parent.update_directory_setup(**kwargs)
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
def update_number_of_domain_controllers(
self,
*,
DirectoryId: str,
DesiredNumber: int,
) -> Dict[str, Any]:
...
kwargs: UpdateNumberOfDomainControllersRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"DesiredNumber": ...,
}
parent.update_number_of_domain_controllers(**kwargs)
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
def update_radius(
self,
*,
DirectoryId: str,
RadiusSettings: RadiusSettingsTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateRadiusRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"RadiusSettings": ...,
}
parent.update_radius(**kwargs)
update_settings
Updates the configurable settings for the specified directory.
Type annotations and code completion for boto3.client("ds").update_settings
method.
boto3 documentation
def update_settings(
self,
*,
DirectoryId: str,
Settings: Sequence[SettingTypeDef], # (1)
) -> UpdateSettingsResultTypeDef: # (2)
...
kwargs: UpdateSettingsRequestRequestTypeDef = { # (1)
"DirectoryId": ...,
"Settings": ...,
}
parent.update_settings(**kwargs)
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
def update_trust(
self,
*,
TrustId: str,
SelectiveAuth: SelectiveAuthType = ..., # (1)
) -> UpdateTrustResultTypeDef: # (2)
...
kwargs: UpdateTrustRequestRequestTypeDef = { # (1)
"TrustId": ...,
}
parent.update_trust(**kwargs)
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
kwargs: VerifyTrustRequestRequestTypeDef = { # (1)
"TrustId": ...,
}
parent.verify_trust(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("ds").get_paginator
method with overloads.
client.get_paginator("describe_client_authentication_settings")
-> DescribeClientAuthenticationSettingsPaginatorclient.get_paginator("describe_directories")
-> DescribeDirectoriesPaginatorclient.get_paginator("describe_domain_controllers")
-> DescribeDomainControllersPaginatorclient.get_paginator("describe_ldaps_settings")
-> DescribeLDAPSSettingsPaginatorclient.get_paginator("describe_regions")
-> DescribeRegionsPaginatorclient.get_paginator("describe_shared_directories")
-> DescribeSharedDirectoriesPaginatorclient.get_paginator("describe_snapshots")
-> DescribeSnapshotsPaginatorclient.get_paginator("describe_trusts")
-> DescribeTrustsPaginatorclient.get_paginator("describe_update_directory")
-> DescribeUpdateDirectoryPaginatorclient.get_paginator("list_certificates")
-> ListCertificatesPaginatorclient.get_paginator("list_ip_routes")
-> ListIpRoutesPaginatorclient.get_paginator("list_log_subscriptions")
-> ListLogSubscriptionsPaginatorclient.get_paginator("list_schema_extensions")
-> ListSchemaExtensionsPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginator