@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.
AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
AWS 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 AWS Directory Service and other AWS services. For more information about the AWS 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 |
|---|---|
AddIpRoutesResult |
addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)
If the DNS server for your on-premises 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.
|
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 an on-premises directory.
|
CreateAliasResult |
createAlias(CreateAliasRequest createAliasRequest)
Creates an alias for a directory and assigns the alias to the directory.
|
CreateComputerResult |
createComputer(CreateComputerRequest createComputerRequest)
Creates a computer account in the specified directory, and joins the computer to the directory.
|
CreateConditionalForwarderResult |
createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)
Creates a conditional forwarder associated with your AWS directory.
|
CreateDirectoryResult |
createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Simple AD directory.
|
CreateMicrosoftADResult |
createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest)
Creates a Microsoft AD in the AWS cloud.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
|
CreateTrustResult |
createTrust(CreateTrustRequest createTrustRequest)
AWS 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 AWS directory.
|
DeleteDirectoryResult |
deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes an AWS Directory Service directory.
|
DeleteSnapshotResult |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes a directory snapshot.
|
DeleteTrustResult |
deleteTrust(DeleteTrustRequest deleteTrustRequest)
Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
|
DeregisterEventTopicResult |
deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified SNS topic.
|
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 SNS topics receive status messages from the specified directory.
|
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.
|
DisableRadiusResult |
disableRadius(DisableRadiusRequest disableRadiusRequest)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server
for an AD Connector directory.
|
DisableSsoResult |
disableSso(DisableSsoRequest disableSsoRequest)
Disables single-sign on for a directory.
|
EnableRadiusResult |
enableRadius(EnableRadiusRequest enableRadiusRequest)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for
an AD Connector 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.
|
ListIpRoutesResult |
listIpRoutes(ListIpRoutesRequest listIpRoutesRequest)
Lists the address blocks that you have added to a directory.
|
ListSchemaExtensionsResult |
listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest)
Lists all schema extensions applied to a Microsoft AD Directory.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a directory.
|
RegisterEventTopicResult |
registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)
Associates a directory with an SNS topic.
|
RemoveIpRoutesResult |
removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest)
Removes IP address blocks from a directory.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tags from a 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) |
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.
|
UpdateConditionalForwarderResult |
updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your AWS directory.
|
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 directory.
|
VerifyTrustResult |
verifyTrust(VerifyTrustRequest verifyTrustRequest)
AWS 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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
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)AddIpRoutesResult addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)
If the DNS server for your on-premises 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS Directory Service.ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)
Creates an AD Connector to connect to an on-premises 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 AWS 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 AWS 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 AWS Directory Service.CreateComputerResult createComputer(CreateComputerRequest createComputerRequest)
Creates a computer account in the specified directory, and joins the computer to the 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 AWS Directory Service.CreateConditionalForwarderResult createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)
Creates a conditional forwarder associated with your AWS 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 AWS 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 AWS Directory Service.CreateDirectoryResult createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Simple AD directory.
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 AWS 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 AWS Directory Service.CreateMicrosoftADResult createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest)
Creates a Microsoft AD in the AWS cloud.
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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
createMicrosoftADRequest - Creates a Microsoft AD in the AWS cloud.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 AWS 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 AWS 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 AWS Directory Service.CreateTrustResult createTrust(CreateTrustRequest createTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises 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 AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.
createTrustRequest - AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For
example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing
on-premises 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 AWS side of a trust relationship between a Microsoft AD in the AWS cloud 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 AWS Directory Service.UnsupportedOperationException - The operation is not supported.DeleteConditionalForwarderResult deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)
Deletes a conditional forwarder that has been set up for your AWS 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 AWS Directory Service.DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes an AWS 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 AWS 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 AWS 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 AWS Directory Service.DeleteTrustResult deleteTrust(DeleteTrustRequest deleteTrustRequest)
Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
deleteTrustRequest - Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud 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 AWS Directory Service.UnsupportedOperationException - The operation is not supported.DeregisterEventTopicResult deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified SNS topic.
deregisterEventTopicRequest - Removes the specified directory as a publisher to the specified 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 AWS 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 AWS 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 AWS 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 AWS Directory Service.UnsupportedOperationException - The operation is not supported.DescribeEventTopicsResult describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)
Obtains information about which 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 AWS 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 AWS 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 Microsoft AD in the AWS cloud. If no input parameters
are 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 AWS Directory Service.UnsupportedOperationException - The operation is not supported.DisableRadiusResult disableRadius(DisableRadiusRequest disableRadiusRequest)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector 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 AWS 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 AWS 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 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 AWS Directory Service.EnableSsoResult enableSso(EnableSsoRequest enableSsoRequest)
Enables single sign-on for a directory.
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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS Directory Service.RegisterEventTopicResult registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)
Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS Directory Service.UpdateConditionalForwarderResult updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your AWS 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 AWS 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 AWS Directory Service.UpdateRadiusResult updateRadius(UpdateRadiusRequest updateRadiusRequest)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector 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 AWS Directory Service.VerifyTrustResult verifyTrust(VerifyTrustRequest verifyTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.
verifyTrustRequest - Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud 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 AWS 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.