AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface DirectoryClient extends AutoCloseable
builder() method.
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 | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
default AddIpRoutesResponse |
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.
|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) |
Adds or overwrites one or more tags for the specified directory.
|
static DirectoryClientBuilder |
builder() |
Create a builder that can be used to configure and create a
DirectoryClient. |
default CancelSchemaExtensionResponse |
cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest) |
Cancels an in-progress schema extension to a Microsoft AD directory.
|
default ConnectDirectoryResponse |
connectDirectory(ConnectDirectoryRequest connectDirectoryRequest) |
Creates an AD Connector to connect to an on-premises directory.
|
static DirectoryClient |
create() |
Create a
DirectoryClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAliasResponse |
createAlias(CreateAliasRequest createAliasRequest) |
Creates an alias for a directory and assigns the alias to the directory.
|
default CreateComputerResponse |
createComputer(CreateComputerRequest createComputerRequest) |
Creates a computer account in the specified directory, and joins the computer to the directory.
|
default CreateConditionalForwarderResponse |
createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest) |
Creates a conditional forwarder associated with your AWS directory.
|
default CreateDirectoryResponse |
createDirectory(CreateDirectoryRequest createDirectoryRequest) |
Creates a Simple AD directory.
|
default CreateMicrosoftADResponse |
createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest) |
Creates a Microsoft AD in the AWS cloud.
|
default CreateSnapshotResponse |
createSnapshot(CreateSnapshotRequest createSnapshotRequest) |
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
|
default CreateTrustResponse |
createTrust(CreateTrustRequest createTrustRequest) |
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.
|
default DeleteConditionalForwarderResponse |
deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest) |
Deletes a conditional forwarder that has been set up for your AWS directory.
|
default DeleteDirectoryResponse |
deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest) |
Deletes an AWS Directory Service directory.
|
default DeleteSnapshotResponse |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) |
Deletes a directory snapshot.
|
default DeleteTrustResponse |
deleteTrust(DeleteTrustRequest deleteTrustRequest) |
Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
|
default DeregisterEventTopicResponse |
deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest) |
Removes the specified directory as a publisher to the specified SNS topic.
|
default DescribeConditionalForwardersResponse |
describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest) |
Obtains information about the conditional forwarders for this account.
|
default DescribeDirectoriesResponse |
describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest) |
Obtains information about the directories that belong to this account.
|
default DescribeEventTopicsResponse |
describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest) |
Obtains information about which SNS topics receive status messages from the specified directory.
|
default DescribeSnapshotsResponse |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) |
Obtains information about the directory snapshots that belong to this account.
|
default DescribeTrustsResponse |
describeTrusts(DescribeTrustsRequest describeTrustsRequest) |
Obtains information about the trust relationships for this account.
|
default DisableRadiusResponse |
disableRadius(DisableRadiusRequest disableRadiusRequest) |
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server
for an AD Connector directory.
|
default DisableSsoResponse |
disableSso(DisableSsoRequest disableSsoRequest) |
Disables single-sign on for a directory.
|
default EnableRadiusResponse |
enableRadius(EnableRadiusRequest enableRadiusRequest) |
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for
an AD Connector directory.
|
default EnableSsoResponse |
enableSso(EnableSsoRequest enableSsoRequest) |
Enables single sign-on for a directory.
|
default GetDirectoryLimitsResponse |
getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest) |
Obtains directory limit information for the current region.
|
default GetSnapshotLimitsResponse |
getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest) |
Obtains the manual snapshot limits for a directory.
|
default ListIpRoutesResponse |
listIpRoutes(ListIpRoutesRequest listIpRoutesRequest) |
Lists the address blocks that you have added to a directory.
|
default ListSchemaExtensionsResponse |
listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest) |
Lists all schema extensions applied to a Microsoft AD Directory.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) |
Lists all tags on a directory.
|
default RegisterEventTopicResponse |
registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest) |
Associates a directory with an SNS topic.
|
default RemoveIpRoutesResponse |
removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest) |
Removes IP address blocks from a directory.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) |
Removes tags from a directory.
|
default RestoreFromSnapshotResponse |
restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest) |
Restores a directory using an existing directory snapshot.
|
static ServiceMetadata |
serviceMetadata() |
|
default StartSchemaExtensionResponse |
startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest) |
Applies a schema extension to a Microsoft AD directory.
|
default UpdateConditionalForwarderResponse |
updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest) |
Updates a conditional forwarder that has been set up for your AWS directory.
|
default UpdateRadiusResponse |
updateRadius(UpdateRadiusRequest updateRadiusRequest) |
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
|
default VerifyTrustResponse |
verifyTrust(VerifyTrustRequest verifyTrustRequest) |
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
|
closestatic final String SERVICE_NAME
static DirectoryClient create()
DirectoryClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DirectoryClientBuilder builder()
DirectoryClient.default AddIpRoutesResponse addIpRoutes(AddIpRoutesRequest addIpRoutesRequest) throws EntityDoesNotExistException, EntityAlreadyExistsException, InvalidParameterException, DirectoryUnavailableException, IpRouteLimitExceededException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws EntityDoesNotExistException, InvalidParameterException, TagLimitExceededException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CancelSchemaExtensionResponse cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest) throws EntityDoesNotExistException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ConnectDirectoryResponse connectDirectory(ConnectDirectoryRequest connectDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateComputerResponse createComputer(CreateComputerRequest createComputerRequest) throws AuthenticationFailedException, DirectoryUnavailableException, EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault CreateConditionalForwarderResponse createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault CreateDirectoryResponse createDirectory(CreateDirectoryRequest createDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateMicrosoftADResponse createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, SnapshotLimitExceededException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateTrustResponse createTrust(CreateTrustRequest createTrustRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault DeleteConditionalForwarderResponse deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault DeleteDirectoryResponse deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest) throws EntityDoesNotExistException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteTrustResponse deleteTrust(DeleteTrustRequest deleteTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault DeregisterEventTopicResponse deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeConditionalForwardersResponse describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault DescribeDirectoriesResponse describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEventTopicsResponse describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeSnapshotsResponse describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeTrustsResponse describeTrusts(DescribeTrustsRequest describeTrustsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault DisableRadiusResponse disableRadius(DisableRadiusRequest disableRadiusRequest) throws EntityDoesNotExistException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DisableSsoResponse disableSso(DisableSsoRequest disableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EnableRadiusResponse enableRadius(EnableRadiusRequest enableRadiusRequest) throws InvalidParameterException, EntityAlreadyExistsException, EntityDoesNotExistException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EnableSsoResponse enableSso(EnableSsoRequest enableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDirectoryLimitsResponse getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest) throws EntityDoesNotExistException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetSnapshotLimitsResponse getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest) throws EntityDoesNotExistException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListIpRoutesResponse listIpRoutes(ListIpRoutesRequest listIpRoutesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListSchemaExtensionsResponse listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest) throws InvalidNextTokenException, EntityDoesNotExistException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterEventTopicResponse registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveIpRoutesResponse removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest) throws EntityDoesNotExistException, InvalidParameterException, DirectoryUnavailableException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RestoreFromSnapshotResponse restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StartSchemaExtensionResponse startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest) throws DirectoryUnavailableException, EntityDoesNotExistException, InvalidParameterException, SnapshotLimitExceededException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateConditionalForwarderResponse updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptiondefault UpdateRadiusResponse updateRadius(UpdateRadiusRequest updateRadiusRequest) throws InvalidParameterException, EntityDoesNotExistException, ClientException, ServiceException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault VerifyTrustResponse verifyTrust(VerifyTrustRequest verifyTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, SdkBaseException, SdkClientException, DirectoryException
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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)DirectoryException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typeUnsupportedOperationExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.