DirectoryService#
Client#
- class DirectoryService.Client#
A low-level client representing AWS Directory Service
Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service Administration Guide.
Note
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
client = session.create_client('ds')
These are the available methods:
- accept_shared_directory
- add_ip_routes
- add_region
- add_tags_to_resource
- can_paginate
- cancel_schema_extension
- close
- connect_directory
- create_alias
- create_computer
- create_conditional_forwarder
- create_directory
- create_log_subscription
- create_microsoft_ad
- create_snapshot
- create_trust
- delete_conditional_forwarder
- delete_directory
- delete_log_subscription
- delete_snapshot
- delete_trust
- deregister_certificate
- deregister_event_topic
- describe_certificate
- describe_client_authentication_settings
- describe_conditional_forwarders
- describe_directories
- describe_directory_data_access
- describe_domain_controllers
- describe_event_topics
- describe_ldaps_settings
- describe_regions
- describe_settings
- describe_shared_directories
- describe_snapshots
- describe_trusts
- describe_update_directory
- disable_client_authentication
- disable_directory_data_access
- disable_ldaps
- disable_radius
- disable_sso
- enable_client_authentication
- enable_directory_data_access
- enable_ldaps
- enable_radius
- enable_sso
- get_directory_limits
- get_paginator
- get_snapshot_limits
- get_waiter
- list_certificates
- list_ip_routes
- list_log_subscriptions
- list_schema_extensions
- list_tags_for_resource
- register_certificate
- register_event_topic
- reject_shared_directory
- remove_ip_routes
- remove_region
- remove_tags_from_resource
- reset_user_password
- restore_from_snapshot
- share_directory
- start_schema_extension
- unshare_directory
- update_conditional_forwarder
- update_directory_setup
- update_number_of_domain_controllers
- update_radius
- update_settings
- update_trust
- verify_trust
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- AccessDeniedException
- AuthenticationFailedException
- CertificateAlreadyExistsException
- CertificateDoesNotExistException
- CertificateInUseException
- CertificateLimitExceededException
- ClientException
- DirectoryAlreadyInRegionException
- DirectoryAlreadySharedException
- DirectoryDoesNotExistException
- DirectoryInDesiredStateException
- DirectoryLimitExceededException
- DirectoryNotSharedException
- DirectoryUnavailableException
- DomainControllerLimitExceededException
- EntityAlreadyExistsException
- EntityDoesNotExistException
- IncompatibleSettingsException
- InsufficientPermissionsException
- InvalidCertificateException
- InvalidClientAuthStatusException
- InvalidLDAPSStatusException
- InvalidNextTokenException
- InvalidParameterException
- InvalidPasswordException
- InvalidTargetException
- IpRouteLimitExceededException
- NoAvailableCertificateException
- OrganizationsException
- RegionLimitExceededException
- ServiceException
- ShareLimitExceededException
- SnapshotLimitExceededException
- TagLimitExceededException
- UnsupportedOperationException
- UnsupportedSettingsException
- UserDoesNotExistException
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: