@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSDirectoryService
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSDirectoryService instead.
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.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AcceptSharedDirectoryResult |
acceptSharedDirectory(AcceptSharedDirectoryRequest acceptSharedDirectoryRequest)
Accepts a directory sharing request that was sent from the directory owner account.
|
AddIpRoutesResult |
addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)
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.
|
AddRegionResult |
addRegion(AddRegionRequest addRegionRequest)
Adds two domain controllers in the specified Region for the specified directory.
|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified directory.
|
CancelSchemaExtensionResult |
cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest)
Cancels an in-progress schema extension to a Microsoft AD directory.
|
ConnectDirectoryResult |
connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)
Creates an AD Connector to connect to a self-managed directory.
|
CreateAliasResult |
createAlias(CreateAliasRequest createAliasRequest)
Creates an alias for a directory and assigns the alias to the directory.
|
CreateComputerResult |
createComputer(CreateComputerRequest createComputerRequest)
Creates an Active Directory computer object in the specified directory.
|
CreateConditionalForwarderResult |
createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)
Creates a conditional forwarder associated with your Amazon Web Services directory.
|
CreateDirectoryResult |
createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Simple AD directory.
|
CreateLogSubscriptionResult |
createLogSubscription(CreateLogSubscriptionRequest createLogSubscriptionRequest)
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.
|
CreateMicrosoftADResult |
createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest)
Creates a Microsoft AD directory in the Amazon Web Services Cloud.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
|
CreateTrustResult |
createTrust(CreateTrustRequest createTrustRequest)
Directory Service for Microsoft Active Directory allows you to configure trust relationships.
|
DeleteConditionalForwarderResult |
deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
|
DeleteDirectoryResult |
deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes an Directory Service directory.
|
DeleteLogSubscriptionResult |
deleteLogSubscription(DeleteLogSubscriptionRequest deleteLogSubscriptionRequest)
Deletes the specified log subscription.
|
DeleteSnapshotResult |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes a directory snapshot.
|
DeleteTrustResult |
deleteTrust(DeleteTrustRequest deleteTrustRequest)
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
|
DeregisterCertificateResult |
deregisterCertificate(DeregisterCertificateRequest deregisterCertificateRequest)
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
|
DeregisterEventTopicResult |
deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified Amazon SNS topic.
|
DescribeCertificateResult |
describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Displays information about the certificate registered for secure LDAP or client certificate authentication.
|
DescribeClientAuthenticationSettingsResult |
describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest)
Retrieves information about the type of client authentication for the specified directory, if the type is
specified.
|
DescribeConditionalForwardersResult |
describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)
Obtains information about the conditional forwarders for this account.
|
DescribeDirectoriesResult |
describeDirectories()
Simplified method form for invoking the DescribeDirectories operation.
|
DescribeDirectoriesResult |
describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)
Obtains information about the directories that belong to this account.
|
DescribeDomainControllersResult |
describeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest)
Provides information about any domain controllers in your directory.
|
DescribeEventTopicsResult |
describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
|
DescribeLDAPSSettingsResult |
describeLDAPSSettings(DescribeLDAPSSettingsRequest describeLDAPSSettingsRequest)
Describes the status of LDAP security for the specified directory.
|
DescribeRegionsResult |
describeRegions(DescribeRegionsRequest describeRegionsRequest)
Provides information about the Regions that are configured for multi-Region replication.
|
DescribeSettingsResult |
describeSettings(DescribeSettingsRequest describeSettingsRequest)
Retrieves information about the configurable settings for the specified directory.
|
DescribeSharedDirectoriesResult |
describeSharedDirectories(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest)
Returns the shared directories in your account.
|
DescribeSnapshotsResult |
describeSnapshots()
Simplified method form for invoking the DescribeSnapshots operation.
|
DescribeSnapshotsResult |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
Obtains information about the directory snapshots that belong to this account.
|
DescribeTrustsResult |
describeTrusts(DescribeTrustsRequest describeTrustsRequest)
Obtains information about the trust relationships for this account.
|
DescribeUpdateDirectoryResult |
describeUpdateDirectory(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest)
Describes the updates of a directory for a particular update type.
|
DisableClientAuthenticationResult |
disableClientAuthentication(DisableClientAuthenticationRequest disableClientAuthenticationRequest)
Disables alternative client authentication methods for the specified directory.
|
DisableLDAPSResult |
disableLDAPS(DisableLDAPSRequest disableLDAPSRequest)
Deactivates LDAP secure calls for the specified directory.
|
DisableRadiusResult |
disableRadius(DisableRadiusRequest disableRadiusRequest)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server
for an AD Connector or Microsoft AD directory.
|
DisableSsoResult |
disableSso(DisableSsoRequest disableSsoRequest)
Disables single-sign on for a directory.
|
EnableClientAuthenticationResult |
enableClientAuthentication(EnableClientAuthenticationRequest enableClientAuthenticationRequest)
Enables alternative client authentication methods for the specified directory.
|
EnableLDAPSResult |
enableLDAPS(EnableLDAPSRequest enableLDAPSRequest)
Activates the switch for the specific directory to always use LDAP secure calls.
|
EnableRadiusResult |
enableRadius(EnableRadiusRequest enableRadiusRequest)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for
an AD Connector or Microsoft AD directory.
|
EnableSsoResult |
enableSso(EnableSsoRequest enableSsoRequest)
Enables single sign-on for a directory.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDirectoryLimitsResult |
getDirectoryLimits()
Simplified method form for invoking the GetDirectoryLimits operation.
|
GetDirectoryLimitsResult |
getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)
Obtains directory limit information for the current Region.
|
GetSnapshotLimitsResult |
getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)
Obtains the manual snapshot limits for a directory.
|
ListCertificatesResult |
listCertificates(ListCertificatesRequest listCertificatesRequest)
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate
authentication.
|
ListIpRoutesResult |
listIpRoutes(ListIpRoutesRequest listIpRoutesRequest)
Lists the address blocks that you have added to a directory.
|
ListLogSubscriptionsResult |
listLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest)
Lists the active log subscriptions for the Amazon Web Services account.
|
ListSchemaExtensionsResult |
listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest)
Lists all schema extensions applied to a Microsoft AD Directory.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a directory.
|
RegisterCertificateResult |
registerCertificate(RegisterCertificateRequest registerCertificateRequest)
Registers a certificate for a secure LDAP or client certificate authentication.
|
RegisterEventTopicResult |
registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)
Associates a directory with an Amazon SNS topic.
|
RejectSharedDirectoryResult |
rejectSharedDirectory(RejectSharedDirectoryRequest rejectSharedDirectoryRequest)
Rejects a directory sharing request that was sent from the directory owner account.
|
RemoveIpRoutesResult |
removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest)
Removes IP address blocks from a directory.
|
RemoveRegionResult |
removeRegion(RemoveRegionRequest removeRegionRequest)
Stops all replication and removes the domain controllers from the specified Region.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tags from a directory.
|
ResetUserPasswordResult |
resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest)
Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
|
RestoreFromSnapshotResult |
restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)
Restores a directory using an existing directory snapshot.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
ShareDirectoryResult |
shareDirectory(ShareDirectoryRequest shareDirectoryRequest)
Shares a specified directory (
DirectoryId) in your Amazon Web Services account (directory owner)
with another Amazon Web Services account (directory consumer). |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartSchemaExtensionResult |
startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest)
Applies a schema extension to a Microsoft AD directory.
|
UnshareDirectoryResult |
unshareDirectory(UnshareDirectoryRequest unshareDirectoryRequest)
Stops the directory sharing between the directory owner and consumer accounts.
|
UpdateConditionalForwarderResult |
updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
|
UpdateDirectorySetupResult |
updateDirectorySetup(UpdateDirectorySetupRequest updateDirectorySetupRequest)
Updates the directory for a particular update type.
|
UpdateNumberOfDomainControllersResult |
updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest)
Adds or removes domain controllers to or from the directory.
|
UpdateRadiusResult |
updateRadius(UpdateRadiusRequest updateRadiusRequest)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or
Microsoft AD directory.
|
UpdateSettingsResult |
updateSettings(UpdateSettingsRequest updateSettingsRequest)
Updates the configurable settings for the specified directory.
|
UpdateTrustResult |
updateTrust(UpdateTrustRequest updateTrustRequest)
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active
Directory.
|
VerifyTrustResult |
verifyTrust(VerifyTrustRequest verifyTrustRequest)
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "ds.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://ds.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "ds.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://ds.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AcceptSharedDirectoryResult acceptSharedDirectory(AcceptSharedDirectoryRequest acceptSharedDirectoryRequest)
Accepts a directory sharing request that was sent from the directory owner account.
acceptSharedDirectoryRequest - InvalidParameterException - One or more parameters are not valid.EntityDoesNotExistException - The specified entity could not be found.DirectoryAlreadySharedException - The specified directory has already been shared with this Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.AddIpRoutesResult addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)
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. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
addIpRoutesRequest - EntityDoesNotExistException - The specified entity could not be found.EntityAlreadyExistsException - The specified entity already exists.InvalidParameterException - One or more parameters are not valid.DirectoryUnavailableException - The specified directory is unavailable or could not be found.IpRouteLimitExceededException - The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.AddRegionResult addRegion(AddRegionRequest addRegionRequest)
Adds two domain controllers in the specified Region for the specified directory.
addRegionRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.InvalidParameterException - One or more parameters are not valid.EntityDoesNotExistException - The specified entity could not be found.DirectoryAlreadyInRegionException - The Region you specified is the same Region where the Managed Microsoft AD directory was created. Specify
a different Region and try again.UnsupportedOperationException - The operation is not supported.DirectoryDoesNotExistException - The specified directory does not exist in the system.RegionLimitExceededException - You have reached the limit for maximum number of simultaneous Region replications per directory.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
addTagsToResourceRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.TagLimitExceededException - The maximum allowed number of tags was exceeded.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.CancelSchemaExtensionResult cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest)
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started
replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled
during any of the following states; Initializing, CreatingSnapshot, and
UpdatingSchema.
cancelSchemaExtensionRequest - EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)
Creates an AD Connector to connect to a self-managed directory.
Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the
ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
connectDirectoryRequest - Contains the inputs for the ConnectDirectory operation.DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the
GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.CreateAliasResult createAlias(CreateAliasRequest createAliasRequest)
Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the
access URL for the directory, such as http://<alias>.awsapps.com.
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
createAliasRequest - Contains the inputs for the CreateAlias operation.EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.CreateComputerResult createComputer(CreateComputerRequest createComputerRequest)
Creates an Active Directory computer object in the specified directory.
createComputerRequest - Contains the inputs for the CreateComputer operation.AuthenticationFailedException - An authentication error occurred.DirectoryUnavailableException - The specified directory is unavailable or could not be found.EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.CreateConditionalForwarderResult createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)
Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
createConditionalForwarderRequest - Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active
Directory. Conditional forwarders are required in order to set up a trust relationship with another
domain.EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.DirectoryUnavailableException - The specified directory is unavailable or could not be found.InvalidParameterException - One or more parameters are not valid.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.CreateDirectoryResult createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
Before you call CreateDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the CreateDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
createDirectoryRequest - Contains the inputs for the CreateDirectory operation.DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the
GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.CreateLogSubscriptionResult createLogSubscription(CreateLogSubscriptionRequest createLogSubscriptionRequest)
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.
createLogSubscriptionRequest - EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.UnsupportedOperationException - The operation is not supported.InsufficientPermissionsException - The account does not have sufficient permission to perform the operation.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.CreateMicrosoftADResult createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest)
Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
createMicrosoftADRequest - Creates an Managed Microsoft AD directory.DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the
GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
You cannot take snapshots of AD Connector directories.
createSnapshotRequest - Contains the inputs for the CreateSnapshot operation.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.SnapshotLimitExceededException - The maximum number of manual snapshots for the directory has been reached. You can use the
GetSnapshotLimits operation to determine the snapshot limits for a directory.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.CreateTrustResult createTrust(CreateTrustRequest createTrustRequest)
Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
createTrustRequest - Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example,
you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed
Microsoft Active Directory. This would allow you to provide users and groups access to resources in either
domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.
EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.DeleteConditionalForwarderResult deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
deleteConditionalForwarderRequest - Deletes a conditional forwarder.EntityDoesNotExistException - The specified entity could not be found.DirectoryUnavailableException - The specified directory is unavailable or could not be found.InvalidParameterException - One or more parameters are not valid.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes an Directory Service directory.
Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the DeleteDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
deleteDirectoryRequest - Contains the inputs for the DeleteDirectory operation.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DeleteLogSubscriptionResult deleteLogSubscription(DeleteLogSubscriptionRequest deleteLogSubscriptionRequest)
Deletes the specified log subscription.
deleteLogSubscriptionRequest - EntityDoesNotExistException - The specified entity could not be found.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes a directory snapshot.
deleteSnapshotRequest - Contains the inputs for the DeleteSnapshot operation.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DeleteTrustResult deleteTrust(DeleteTrustRequest deleteTrustRequest)
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
deleteTrustRequest - Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and
the external domain.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.DeregisterCertificateResult deregisterCertificate(DeregisterCertificateRequest deregisterCertificateRequest)
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
deregisterCertificateRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.CertificateDoesNotExistException - The certificate is not present in the system for describe or deregister activities.CertificateInUseException - The certificate is being used for the LDAP security connection and cannot be removed without disabling
LDAP security.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DeregisterEventTopicResult deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified Amazon SNS topic.
deregisterEventTopicRequest - Removes the specified directory as a publisher to the specified Amazon SNS topic.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Displays information about the certificate registered for secure LDAP or client certificate authentication.
describeCertificateRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.CertificateDoesNotExistException - The certificate is not present in the system for describe or deregister activities.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeClientAuthenticationSettingsResult describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest)
Retrieves information about the type of client authentication for the specified directory, if the type is
specified. If no type is specified, information about all client authentication types that are supported for the
specified directory is retrieved. Currently, only SmartCard is supported.
describeClientAuthenticationSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.AccessDeniedException - Client authentication is not available in this region at this time.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeConditionalForwardersResult describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)
Obtains information about the conditional forwarders for this account.
If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
describeConditionalForwardersRequest - Describes a conditional forwarder.EntityDoesNotExistException - The specified entity could not be found.DirectoryUnavailableException - The specified directory is unavailable or could not be found.InvalidParameterException - One or more parameters are not valid.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)
Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the
DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.
This operation supports pagination with the use of the NextToken request and response parameters. If
more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you
pass in the next call to DescribeDirectories to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
describeDirectoriesRequest - Contains the inputs for the DescribeDirectories operation.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.InvalidNextTokenException - The NextToken value is not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeDirectoriesResult describeDirectories()
DescribeDomainControllersResult describeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest)
Provides information about any domain controllers in your directory.
describeDomainControllersRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidNextTokenException - The NextToken value is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.DescribeEventTopicsResult describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
describeEventTopicsRequest - Describes event topics.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeLDAPSSettingsResult describeLDAPSSettings(DescribeLDAPSSettingsRequest describeLDAPSSettingsRequest)
Describes the status of LDAP security for the specified directory.
describeLDAPSSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidNextTokenException - The NextToken value is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeRegionsResult describeRegions(DescribeRegionsRequest describeRegionsRequest)
Provides information about the Regions that are configured for multi-Region replication.
describeRegionsRequest - InvalidParameterException - One or more parameters are not valid.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidNextTokenException - The NextToken value is not valid.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeSettingsResult describeSettings(DescribeSettingsRequest describeSettingsRequest)
Retrieves information about the configurable settings for the specified directory.
describeSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.InvalidNextTokenException - The NextToken value is not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeSharedDirectoriesResult describeSharedDirectories(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest)
Returns the shared directories in your account.
describeSharedDirectoriesRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidNextTokenException - The NextToken value is not valid.InvalidParameterException - One or more parameters are not valid.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
describeSnapshotsRequest - Contains the inputs for the DescribeSnapshots operation.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.InvalidNextTokenException - The NextToken value is not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DescribeSnapshotsResult describeSnapshots()
DescribeTrustsResult describeTrusts(DescribeTrustsRequest describeTrustsRequest)
Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
describeTrustsRequest - Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters
are provided, such as directory ID or trust ID, this request describes all the trust relationships.EntityDoesNotExistException - The specified entity could not be found.InvalidNextTokenException - The NextToken value is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.DescribeUpdateDirectoryResult describeUpdateDirectory(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest)
Describes the updates of a directory for a particular update type.
describeUpdateDirectoryRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.InvalidParameterException - One or more parameters are not valid.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.InvalidNextTokenException - The NextToken value is not valid.DisableClientAuthenticationResult disableClientAuthentication(DisableClientAuthenticationRequest disableClientAuthenticationRequest)
Disables alternative client authentication methods for the specified directory.
disableClientAuthenticationRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidClientAuthStatusException - Client authentication is already enabled.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DisableLDAPSResult disableLDAPS(DisableLDAPSRequest disableLDAPSRequest)
Deactivates LDAP secure calls for the specified directory.
disableLDAPSRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.InvalidLDAPSStatusException - The LDAP activities could not be performed because they are limited by the LDAPS status.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DisableRadiusResult disableRadius(DisableRadiusRequest disableRadiusRequest)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
disableRadiusRequest - Contains the inputs for the DisableRadius operation.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.DisableSsoResult disableSso(DisableSsoRequest disableSsoRequest)
Disables single-sign on for a directory.
disableSsoRequest - Contains the inputs for the DisableSso operation.EntityDoesNotExistException - The specified entity could not be found.InsufficientPermissionsException - The account does not have sufficient permission to perform the operation.AuthenticationFailedException - An authentication error occurred.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.EnableClientAuthenticationResult enableClientAuthentication(EnableClientAuthenticationRequest enableClientAuthenticationRequest)
Enables alternative client authentication methods for the specified directory.
enableClientAuthenticationRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidClientAuthStatusException - Client authentication is already enabled.AccessDeniedException - Client authentication is not available in this region at this time.NoAvailableCertificateException - Client authentication setup could not be completed because at least one valid certificate must be
registered in the system.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.EnableLDAPSResult enableLDAPS(EnableLDAPSRequest enableLDAPSRequest)
Activates the switch for the specific directory to always use LDAP secure calls.
enableLDAPSRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.NoAvailableCertificateException - Client authentication setup could not be completed because at least one valid certificate must be
registered in the system.InvalidLDAPSStatusException - The LDAP activities could not be performed because they are limited by the LDAPS status.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.EnableRadiusResult enableRadius(EnableRadiusRequest enableRadiusRequest)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
enableRadiusRequest - Contains the inputs for the EnableRadius operation.InvalidParameterException - One or more parameters are not valid.EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.EnableSsoResult enableSso(EnableSsoRequest enableSsoRequest)
Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
enableSsoRequest - Contains the inputs for the EnableSso operation.EntityDoesNotExistException - The specified entity could not be found.InsufficientPermissionsException - The account does not have sufficient permission to perform the operation.AuthenticationFailedException - An authentication error occurred.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)
Obtains directory limit information for the current Region.
getDirectoryLimitsRequest - Contains the inputs for the GetDirectoryLimits operation.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.GetDirectoryLimitsResult getDirectoryLimits()
GetSnapshotLimitsResult getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)
Obtains the manual snapshot limits for a directory.
getSnapshotLimitsRequest - Contains the inputs for the GetSnapshotLimits operation.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest)
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
listCertificatesRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.InvalidNextTokenException - The NextToken value is not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.ListIpRoutesResult listIpRoutes(ListIpRoutesRequest listIpRoutesRequest)
Lists the address blocks that you have added to a directory.
listIpRoutesRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidNextTokenException - The NextToken value is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.ListLogSubscriptionsResult listLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest)
Lists the active log subscriptions for the Amazon Web Services account.
listLogSubscriptionsRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidNextTokenException - The NextToken value is not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.ListSchemaExtensionsResult listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest)
Lists all schema extensions applied to a Microsoft AD Directory.
listSchemaExtensionsRequest - InvalidNextTokenException - The NextToken value is not valid.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a directory.
listTagsForResourceRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidNextTokenException - The NextToken value is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.RegisterCertificateResult registerCertificate(RegisterCertificateRequest registerCertificateRequest)
Registers a certificate for a secure LDAP or client certificate authentication.
registerCertificateRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.InvalidCertificateException - The certificate PEM that was provided has incorrect encoding.CertificateLimitExceededException - The certificate could not be added because the certificate limit has been reached.CertificateAlreadyExistsException - The certificate has already been registered into the system.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.RegisterEventTopicResult registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)
Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
registerEventTopicRequest - Registers a new event topic.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.RejectSharedDirectoryResult rejectSharedDirectory(RejectSharedDirectoryRequest rejectSharedDirectoryRequest)
Rejects a directory sharing request that was sent from the directory owner account.
rejectSharedDirectoryRequest - InvalidParameterException - One or more parameters are not valid.EntityDoesNotExistException - The specified entity could not be found.DirectoryAlreadySharedException - The specified directory has already been shared with this Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.RemoveIpRoutesResult removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest)
Removes IP address blocks from a directory.
removeIpRoutesRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.DirectoryUnavailableException - The specified directory is unavailable or could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.RemoveRegionResult removeRegion(RemoveRegionRequest removeRegionRequest)
Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary
Region with this operation. Instead, use the DeleteDirectory API.
removeRegionRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tags from a directory.
removeTagsFromResourceRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.ResetUserPasswordResult resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest)
Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
You can reset the password for any user in your directory with the following exceptions:
For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.
For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.
resetUserPasswordRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.UserDoesNotExistException - The user provided a username that does not exist in your directory.InvalidPasswordException - The new password provided by the user does not meet the password complexity requirements defined in your
directory.UnsupportedOperationException - The operation is not supported.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)
Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore
operation by calling the DescribeDirectories operation with the directory identifier. When the
DirectoryDescription.Stage value changes to Active, the restore operation is complete.
restoreFromSnapshotRequest - An object representing the inputs for the RestoreFromSnapshot operation.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.ShareDirectoryResult shareDirectory(ShareDirectoryRequest shareDirectoryRequest)
Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner)
with another Amazon Web Services account (directory consumer). With this operation you can use your directory
from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.
The ShareMethod parameter determines whether the specified directory can be shared between Amazon
Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also
determines whether you can share the directory with any other Amazon Web Services account either inside or
outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory
sharing request to the directory consumer.
shareDirectoryRequest - DirectoryAlreadySharedException - The specified directory has already been shared with this Amazon Web Services account.EntityDoesNotExistException - The specified entity could not be found.InvalidTargetException - The specified shared target is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ShareLimitExceededException - The maximum number of Amazon Web Services accounts that you can share with this directory has been
reached.OrganizationsException - Exception encountered while trying to access your Amazon Web Services organization.AccessDeniedException - Client authentication is not available in this region at this time.UnsupportedOperationException - The operation is not supported.ServiceException - An exception has occurred in Directory Service.StartSchemaExtensionResult startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest)
Applies a schema extension to a Microsoft AD directory.
startSchemaExtensionRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.SnapshotLimitExceededException - The maximum number of manual snapshots for the directory has been reached. You can use the
GetSnapshotLimits operation to determine the snapshot limits for a directory.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnshareDirectoryResult unshareDirectory(UnshareDirectoryRequest unshareDirectoryRequest)
Stops the directory sharing between the directory owner and consumer accounts.
unshareDirectoryRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidTargetException - The specified shared target is not valid.DirectoryNotSharedException - The specified directory has not been shared with this Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UpdateConditionalForwarderResult updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
updateConditionalForwarderRequest - Updates a conditional forwarder.EntityDoesNotExistException - The specified entity could not be found.DirectoryUnavailableException - The specified directory is unavailable or could not be found.InvalidParameterException - One or more parameters are not valid.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UpdateDirectorySetupResult updateDirectorySetup(UpdateDirectorySetupRequest updateDirectorySetupRequest)
Updates the directory for a particular update type.
updateDirectorySetupRequest - UnsupportedOperationException - The operation is not supported.DirectoryInDesiredStateException - The directory is already updated to desired update type settings.DirectoryUnavailableException - The specified directory is unavailable or could not be found.SnapshotLimitExceededException - The maximum number of manual snapshots for the directory has been reached. You can use the
GetSnapshotLimits operation to determine the snapshot limits for a directory.InvalidParameterException - One or more parameters are not valid.DirectoryDoesNotExistException - The specified directory does not exist in the system.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UpdateNumberOfDomainControllersResult updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest)
Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
updateNumberOfDomainControllersRequest - EntityDoesNotExistException - The specified entity could not be found.DirectoryUnavailableException - The specified directory is unavailable or could not be found.DomainControllerLimitExceededException - The maximum allowed number of domain controllers per directory was exceeded. The default limit per
directory is 20 domain controllers.InvalidParameterException - One or more parameters are not valid.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UpdateRadiusResult updateRadius(UpdateRadiusRequest updateRadiusRequest)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
updateRadiusRequest - Contains the inputs for the UpdateRadius operation.InvalidParameterException - One or more parameters are not valid.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UpdateSettingsResult updateSettings(UpdateSettingsRequest updateSettingsRequest)
Updates the configurable settings for the specified directory.
updateSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.DirectoryUnavailableException - The specified directory is unavailable or could not be found.IncompatibleSettingsException - The specified directory setting is not compatible with other settings.UnsupportedSettingsException - The specified directory setting is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UpdateTrustResult updateTrust(UpdateTrustRequest updateTrustRequest)
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
updateTrustRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.VerifyTrustResult verifyTrust(VerifyTrustRequest verifyTrustRequest)
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.
verifyTrustRequest - Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and
an external domain.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.