com.amazonaws.services.directory

Class AWSDirectoryServiceClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.directory.AWSDirectoryServiceClient

All Implemented Interfaces:

AWSDirectoryService

Direct Known Subclasses:

AWSDirectoryServiceAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSDirectoryServiceClient
extends AmazonWebServiceClient
implements AWSDirectoryService

Client for accessing Directory Service. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Directory Service

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.directory.AWSDirectoryService

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSDirectoryServiceClient() Deprecated. use AWSDirectoryServiceClientBuilder.defaultClient()
AWSDirectoryServiceClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSDirectoryServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSDirectoryServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSDirectoryServiceClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AddIpRoutesResult	addIpRoutes(AddIpRoutesRequest request) 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 request) Adds or overwrites one or more tags for the specified directory.
static AWSDirectoryServiceClientBuilder	builder()
CancelSchemaExtensionResult	cancelSchemaExtension(CancelSchemaExtensionRequest request) Cancels an in-progress schema extension to a Microsoft AD directory.
ConnectDirectoryResult	connectDirectory(ConnectDirectoryRequest request) Creates an AD Connector to connect to an on-premises directory.
CreateAliasResult	createAlias(CreateAliasRequest request) Creates an alias for a directory and assigns the alias to the directory.
CreateComputerResult	createComputer(CreateComputerRequest request) Creates a computer account in the specified directory, and joins the computer to the directory.
CreateConditionalForwarderResult	createConditionalForwarder(CreateConditionalForwarderRequest request) Creates a conditional forwarder associated with your AWS directory.
CreateDirectoryResult	createDirectory(CreateDirectoryRequest request) Creates a Simple AD directory.
CreateMicrosoftADResult	createMicrosoftAD(CreateMicrosoftADRequest request) Creates a Microsoft AD in the AWS cloud.
CreateSnapshotResult	createSnapshot(CreateSnapshotRequest request) Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
CreateTrustResult	createTrust(CreateTrustRequest request) AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.
DeleteConditionalForwarderResult	deleteConditionalForwarder(DeleteConditionalForwarderRequest request) Deletes a conditional forwarder that has been set up for your AWS directory.
DeleteDirectoryResult	deleteDirectory(DeleteDirectoryRequest request) Deletes an AWS Directory Service directory.
DeleteSnapshotResult	deleteSnapshot(DeleteSnapshotRequest request) Deletes a directory snapshot.
DeleteTrustResult	deleteTrust(DeleteTrustRequest request) Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
DeregisterEventTopicResult	deregisterEventTopic(DeregisterEventTopicRequest request) Removes the specified directory as a publisher to the specified SNS topic.
DescribeConditionalForwardersResult	describeConditionalForwarders(DescribeConditionalForwardersRequest request) Obtains information about the conditional forwarders for this account.
DescribeDirectoriesResult	describeDirectories() Simplified method form for invoking the DescribeDirectories operation.
DescribeDirectoriesResult	describeDirectories(DescribeDirectoriesRequest request) Obtains information about the directories that belong to this account.
DescribeDomainControllersResult	describeDomainControllers(DescribeDomainControllersRequest request) Provides information about any domain controllers in your directory.
DescribeEventTopicsResult	describeEventTopics(DescribeEventTopicsRequest request) 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 request) Obtains information about the directory snapshots that belong to this account.
DescribeTrustsResult	describeTrusts(DescribeTrustsRequest request) Obtains information about the trust relationships for this account.
DisableRadiusResult	disableRadius(DisableRadiusRequest request) Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
DisableSsoResult	disableSso(DisableSsoRequest request) Disables single-sign on for a directory.
EnableRadiusResult	enableRadius(EnableRadiusRequest request) Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
EnableSsoResult	enableSso(EnableSsoRequest request) 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 request) Obtains directory limit information for the current region.
GetSnapshotLimitsResult	getSnapshotLimits(GetSnapshotLimitsRequest request) Obtains the manual snapshot limits for a directory.
ListIpRoutesResult	listIpRoutes(ListIpRoutesRequest request) Lists the address blocks that you have added to a directory.
ListSchemaExtensionsResult	listSchemaExtensions(ListSchemaExtensionsRequest request) Lists all schema extensions applied to a Microsoft AD Directory.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags on a directory.
RegisterEventTopicResult	registerEventTopic(RegisterEventTopicRequest request) Associates a directory with an SNS topic.
RemoveIpRoutesResult	removeIpRoutes(RemoveIpRoutesRequest request) Removes IP address blocks from a directory.
RemoveTagsFromResourceResult	removeTagsFromResource(RemoveTagsFromResourceRequest request) Removes tags from a directory.
RestoreFromSnapshotResult	restoreFromSnapshot(RestoreFromSnapshotRequest request) Restores a directory using an existing directory snapshot.
StartSchemaExtensionResult	startSchemaExtension(StartSchemaExtensionRequest request) Applies a schema extension to a Microsoft AD directory.
UpdateConditionalForwarderResult	updateConditionalForwarder(UpdateConditionalForwarderRequest request) Updates a conditional forwarder that has been set up for your AWS directory.
UpdateNumberOfDomainControllersResult	updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest request) Adds or removes domain controllers to or from the directory.
UpdateRadiusResult	updateRadius(UpdateRadiusRequest request) Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
VerifyTrustResult	verifyTrust(VerifyTrustRequest request) AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.directory.AWSDirectoryService

setEndpoint, setRegion, shutdown

Constructor Detail

AWSDirectoryServiceClient

@Deprecated
public AWSDirectoryServiceClient()

Deprecated. use AWSDirectoryServiceClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Directory Service. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSDirectoryServiceClient

@Deprecated
public AWSDirectoryServiceClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Directory Service. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSDirectoryServiceClient

@Deprecated
public AWSDirectoryServiceClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSDirectoryServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSDirectoryServiceClient

@Deprecated
public AWSDirectoryServiceClient(AWSCredentials awsCredentials,
                                             ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).

AWSDirectoryServiceClient

@Deprecated
public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSDirectoryServiceClient

@Deprecated
public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider,
                                             ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).

AWSDirectoryServiceClient

@Deprecated
public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider,
                                             ClientConfiguration clientConfiguration,
                                             RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AWSDirectoryServiceClientBuilder builder()

addIpRoutes

public AddIpRoutesResult addIpRoutes(AddIpRoutesRequest request)

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.

Specified by:

addIpRoutes in interface AWSDirectoryService

Parameters:

addIpRoutesRequest -

Returns:

Result of the AddIpRoutes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

addTagsToResource

public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)

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.

Specified by:

addTagsToResource in interface AWSDirectoryService

Parameters:

addTagsToResourceRequest -

Returns:

Result of the AddTagsToResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

cancelSchemaExtension

public CancelSchemaExtensionResult cancelSchemaExtension(CancelSchemaExtensionRequest request)

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.

Specified by:

cancelSchemaExtension in interface AWSDirectoryService

Parameters:

cancelSchemaExtensionRequest -

Returns:

Result of the CancelSchemaExtension operation returned by the service.

Throws:

EntityDoesNotExistException - The specified entity could not be found.

ClientException - A client exception has occurred.

ServiceException - An exception has occurred in AWS Directory Service.

See Also:

AWS API Documentation

connectDirectory

public ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest request)

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.

Specified by:

connectDirectory in interface AWSDirectoryService

Parameters:

connectDirectoryRequest - Contains the inputs for the ConnectDirectory operation.

Returns:

Result of the ConnectDirectory operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createAlias

public CreateAliasResult createAlias(CreateAliasRequest request)

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.

Specified by:

createAlias in interface AWSDirectoryService

Parameters:

createAliasRequest - Contains the inputs for the CreateAlias operation.

Returns:

Result of the CreateAlias operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createComputer

public CreateComputerResult createComputer(CreateComputerRequest request)

Creates a computer account in the specified directory, and joins the computer to the directory.

Specified by:

createComputer in interface AWSDirectoryService

Parameters:

createComputerRequest - Contains the inputs for the CreateComputer operation.

Returns:

Result of the CreateComputer operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createConditionalForwarder

public CreateConditionalForwarderResult createConditionalForwarder(CreateConditionalForwarderRequest request)

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.

Specified by:

createConditionalForwarder in interface AWSDirectoryService

Parameters:

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.

Returns:

Result of the CreateConditionalForwarder operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDirectory

public CreateDirectoryResult createDirectory(CreateDirectoryRequest request)

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.

Specified by:

createDirectory in interface AWSDirectoryService

Parameters:

createDirectoryRequest - Contains the inputs for the CreateDirectory operation.

Returns:

Result of the CreateDirectory operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createMicrosoftAD

public CreateMicrosoftADResult createMicrosoftAD(CreateMicrosoftADRequest request)

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.

Specified by:

createMicrosoftAD in interface AWSDirectoryService

Parameters:

createMicrosoftADRequest - Creates a Microsoft AD in the AWS cloud.

Returns:

Result of the CreateMicrosoftAD operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createSnapshot

public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

You cannot take snapshots of AD Connector directories.

Specified by:

createSnapshot in interface AWSDirectoryService

Parameters:

createSnapshotRequest - Contains the inputs for the CreateSnapshot operation.

Returns:

Result of the CreateSnapshot operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createTrust

public CreateTrustResult createTrust(CreateTrustRequest request)

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.

Specified by:

createTrust in interface AWSDirectoryService

Parameters:

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.

Returns:

Result of the CreateTrust operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteConditionalForwarder

public DeleteConditionalForwarderResult deleteConditionalForwarder(DeleteConditionalForwarderRequest request)

Deletes a conditional forwarder that has been set up for your AWS directory.

Specified by:

deleteConditionalForwarder in interface AWSDirectoryService

Parameters:

deleteConditionalForwarderRequest - Deletes a conditional forwarder.

Returns:

Result of the DeleteConditionalForwarder operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDirectory

public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest request)

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.

Specified by:

deleteDirectory in interface AWSDirectoryService

Parameters:

deleteDirectoryRequest - Contains the inputs for the DeleteDirectory operation.

Returns:

Result of the DeleteDirectory operation returned by the service.

Throws:

EntityDoesNotExistException - The specified entity could not be found.

ClientException - A client exception has occurred.

ServiceException - An exception has occurred in AWS Directory Service.

See Also:

AWS API Documentation

deleteSnapshot

public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)

Deletes a directory snapshot.

Specified by:

deleteSnapshot in interface AWSDirectoryService

Parameters:

deleteSnapshotRequest - Contains the inputs for the DeleteSnapshot operation.

Returns:

Result of the DeleteSnapshot operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteTrust

public DeleteTrustResult deleteTrust(DeleteTrustRequest request)

Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.

Specified by:

deleteTrust in interface AWSDirectoryService

Parameters:

deleteTrustRequest - Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the external domain.

Returns:

Result of the DeleteTrust operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deregisterEventTopic

public DeregisterEventTopicResult deregisterEventTopic(DeregisterEventTopicRequest request)

Removes the specified directory as a publisher to the specified SNS topic.

Specified by:

deregisterEventTopic in interface AWSDirectoryService

Parameters:

deregisterEventTopicRequest - Removes the specified directory as a publisher to the specified SNS topic.

Returns:

Result of the DeregisterEventTopic operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeConditionalForwarders

public DescribeConditionalForwardersResult describeConditionalForwarders(DescribeConditionalForwardersRequest request)

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.

Specified by:

describeConditionalForwarders in interface AWSDirectoryService

Parameters:

describeConditionalForwardersRequest - Describes a conditional forwarder.

Returns:

Result of the DescribeConditionalForwarders operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeDirectories

public DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest request)

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.

Specified by:

describeDirectories in interface AWSDirectoryService

Parameters:

describeDirectoriesRequest - Contains the inputs for the DescribeDirectories operation.

Returns:

Result of the DescribeDirectories operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeDirectories

public DescribeDirectoriesResult describeDirectories()

Description copied from interface: AWSDirectoryService

Simplified method form for invoking the DescribeDirectories operation.

Specified by:

describeDirectories in interface AWSDirectoryService

See Also:

AWSDirectoryService.describeDirectories(DescribeDirectoriesRequest)

describeDomainControllers

public DescribeDomainControllersResult describeDomainControllers(DescribeDomainControllersRequest request)

Provides information about any domain controllers in your directory.

Specified by:

describeDomainControllers in interface AWSDirectoryService

Parameters:

describeDomainControllersRequest -

Returns:

Result of the DescribeDomainControllers operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeEventTopics

public DescribeEventTopicsResult describeEventTopics(DescribeEventTopicsRequest request)

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.

Specified by:

describeEventTopics in interface AWSDirectoryService

Parameters:

describeEventTopicsRequest - Describes event topics.

Returns:

Result of the DescribeEventTopics operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeSnapshots

public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)

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.

Specified by:

describeSnapshots in interface AWSDirectoryService

Parameters:

describeSnapshotsRequest - Contains the inputs for the DescribeSnapshots operation.

Returns:

Result of the DescribeSnapshots operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeSnapshots

public DescribeSnapshotsResult describeSnapshots()

Description copied from interface: AWSDirectoryService

Simplified method form for invoking the DescribeSnapshots operation.

Specified by:

describeSnapshots in interface AWSDirectoryService

See Also:

AWSDirectoryService.describeSnapshots(DescribeSnapshotsRequest)

describeTrusts

public DescribeTrustsResult describeTrusts(DescribeTrustsRequest request)

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.

Specified by:

describeTrusts in interface AWSDirectoryService

Parameters:

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.

Returns:

Result of the DescribeTrusts operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disableRadius

public DisableRadiusResult disableRadius(DisableRadiusRequest request)

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

Specified by:

disableRadius in interface AWSDirectoryService

Parameters:

disableRadiusRequest - Contains the inputs for the DisableRadius operation.

Returns:

Result of the DisableRadius operation returned by the service.

Throws:

EntityDoesNotExistException - The specified entity could not be found.

ClientException - A client exception has occurred.

ServiceException - An exception has occurred in AWS Directory Service.

See Also:

AWS API Documentation

disableSso

public DisableSsoResult disableSso(DisableSsoRequest request)

Disables single-sign on for a directory.

Specified by:

disableSso in interface AWSDirectoryService

Parameters:

disableSsoRequest - Contains the inputs for the DisableSso operation.

Returns:

Result of the DisableSso operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

enableRadius

public EnableRadiusResult enableRadius(EnableRadiusRequest request)

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

Specified by:

enableRadius in interface AWSDirectoryService

Parameters:

enableRadiusRequest - Contains the inputs for the EnableRadius operation.

Returns:

Result of the EnableRadius operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

enableSso

public EnableSsoResult enableSso(EnableSsoRequest request)

Enables single sign-on for a directory.

Specified by:

enableSso in interface AWSDirectoryService

Parameters:

enableSsoRequest - Contains the inputs for the EnableSso operation.

Returns:

Result of the EnableSso operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDirectoryLimits

public GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest request)

Obtains directory limit information for the current region.

Specified by:

getDirectoryLimits in interface AWSDirectoryService

Parameters:

getDirectoryLimitsRequest - Contains the inputs for the GetDirectoryLimits operation.

Returns:

Result of the GetDirectoryLimits operation returned by the service.

Throws:

EntityDoesNotExistException - The specified entity could not be found.

ClientException - A client exception has occurred.

ServiceException - An exception has occurred in AWS Directory Service.

See Also:

AWS API Documentation

getDirectoryLimits

public GetDirectoryLimitsResult getDirectoryLimits()

Description copied from interface: AWSDirectoryService

Simplified method form for invoking the GetDirectoryLimits operation.

Specified by:

getDirectoryLimits in interface AWSDirectoryService

See Also:

AWSDirectoryService.getDirectoryLimits(GetDirectoryLimitsRequest)

getSnapshotLimits

public GetSnapshotLimitsResult getSnapshotLimits(GetSnapshotLimitsRequest request)

Obtains the manual snapshot limits for a directory.

Specified by:

getSnapshotLimits in interface AWSDirectoryService

Parameters:

getSnapshotLimitsRequest - Contains the inputs for the GetSnapshotLimits operation.

Returns:

Result of the GetSnapshotLimits operation returned by the service.

Throws:

EntityDoesNotExistException - The specified entity could not be found.

ClientException - A client exception has occurred.

ServiceException - An exception has occurred in AWS Directory Service.

See Also:

AWS API Documentation

listIpRoutes

public ListIpRoutesResult listIpRoutes(ListIpRoutesRequest request)

Lists the address blocks that you have added to a directory.

Specified by:

listIpRoutes in interface AWSDirectoryService

Parameters:

listIpRoutesRequest -

Returns:

Result of the ListIpRoutes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSchemaExtensions

public ListSchemaExtensionsResult listSchemaExtensions(ListSchemaExtensionsRequest request)

Lists all schema extensions applied to a Microsoft AD Directory.

Specified by:

listSchemaExtensions in interface AWSDirectoryService

Parameters:

listSchemaExtensionsRequest -

Returns:

Result of the ListSchemaExtensions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists all tags on a directory.

Specified by:

listTagsForResource in interface AWSDirectoryService

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

registerEventTopic

public RegisterEventTopicResult registerEventTopic(RegisterEventTopicRequest request)

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.

Specified by:

registerEventTopic in interface AWSDirectoryService

Parameters:

registerEventTopicRequest - Registers a new event topic.

Returns:

Result of the RegisterEventTopic operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

removeIpRoutes

public RemoveIpRoutesResult removeIpRoutes(RemoveIpRoutesRequest request)

Removes IP address blocks from a directory.

Specified by:

removeIpRoutes in interface AWSDirectoryService

Parameters:

removeIpRoutesRequest -

Returns:

Result of the RemoveIpRoutes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

removeTagsFromResource

public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)

Removes tags from a directory.

Specified by:

removeTagsFromResource in interface AWSDirectoryService

Parameters:

removeTagsFromResourceRequest -

Returns:

Result of the RemoveTagsFromResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

restoreFromSnapshot

public RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest request)

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.

Specified by:

restoreFromSnapshot in interface AWSDirectoryService

Parameters:

restoreFromSnapshotRequest - An object representing the inputs for the RestoreFromSnapshot operation.

Returns:

Result of the RestoreFromSnapshot operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startSchemaExtension

public StartSchemaExtensionResult startSchemaExtension(StartSchemaExtensionRequest request)

Applies a schema extension to a Microsoft AD directory.

Specified by:

startSchemaExtension in interface AWSDirectoryService

Parameters:

startSchemaExtensionRequest -

Returns:

Result of the StartSchemaExtension operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateConditionalForwarder

public UpdateConditionalForwarderResult updateConditionalForwarder(UpdateConditionalForwarderRequest request)

Updates a conditional forwarder that has been set up for your AWS directory.

Specified by:

updateConditionalForwarder in interface AWSDirectoryService

Parameters:

updateConditionalForwarderRequest - Updates a conditional forwarder.

Returns:

Result of the UpdateConditionalForwarder operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateNumberOfDomainControllers

public UpdateNumberOfDomainControllersResult updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest request)

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.

Specified by:

updateNumberOfDomainControllers in interface AWSDirectoryService

Parameters:

updateNumberOfDomainControllersRequest -

Returns:

Result of the UpdateNumberOfDomainControllers operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateRadius

public UpdateRadiusResult updateRadius(UpdateRadiusRequest request)

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.

Specified by:

updateRadius in interface AWSDirectoryService

Parameters:

updateRadiusRequest - Contains the inputs for the UpdateRadius operation.

Returns:

Result of the UpdateRadius operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

verifyTrust

public VerifyTrustResult verifyTrust(VerifyTrustRequest request)

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.

Specified by:

verifyTrust in interface AWSDirectoryService

Parameters:

verifyTrustRequest - Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud and an external domain.

Returns:

Result of the VerifyTrust operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 the request.

Specified by:

getCachedResponseMetadata in interface AWSDirectoryService

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.