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

public class AWSDirectoryServiceClient
extends AmazonWebServiceClient
implements AWSDirectoryService

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

AWS Directory Service

This is the AWS Directory Service API Reference . This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AWSDirectoryService exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSDirectoryServiceClient() Constructs a new client to invoke service methods on AWSDirectoryService.
AWSDirectoryServiceClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSDirectoryService using the specified AWS account credentials.
AWSDirectoryServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSDirectoryService using the specified AWS account credentials and client configuration options.
AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSDirectoryService using the specified AWS account credentials provider.
AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSDirectoryService using the specified AWS account credentials provider and client configuration options.
AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWSDirectoryService using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSDirectoryServiceClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSDirectoryService.

Method Summary

Methods

Modifier and Type	Method and Description
ConnectDirectoryResult	connectDirectory(ConnectDirectoryRequest connectDirectoryRequest) Creates an AD Connector to connect an on-premises directory.
CreateAliasResult	createAlias(CreateAliasRequest createAliasRequest) Creates an alias for a directory and assigns the alias to the directory.
CreateComputerResult	createComputer(CreateComputerRequest createComputerRequest) Creates a computer account in the specified directory, and joins the computer to the directory.
CreateDirectoryResult	createDirectory(CreateDirectoryRequest createDirectoryRequest) Creates a Simple AD directory.
CreateSnapshotResult	createSnapshot(CreateSnapshotRequest createSnapshotRequest) Creates a snapshot of an existing directory.
DeleteDirectoryResult	deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest) Deletes an AWS Directory Service directory.
DeleteSnapshotResult	deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) Deletes a directory snapshot.
DescribeDirectoriesResult	describeDirectories() Obtains information about the directories that belong to this account.
DescribeDirectoriesResult	describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest) Obtains information about the directories that belong to this account.
DescribeSnapshotsResult	describeSnapshots() Obtains information about the directory snapshots that belong to this account.
DescribeSnapshotsResult	describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) Obtains information about the directory snapshots that belong to this account.
DisableRadiusResult	disableRadius(DisableRadiusRequest disableRadiusRequest) Disables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory.
DisableSsoResult	disableSso(DisableSsoRequest disableSsoRequest) Disables single-sign on for a directory.
EnableRadiusResult	enableRadius(EnableRadiusRequest enableRadiusRequest) Enables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory.
EnableSsoResult	enableSso(EnableSsoRequest enableSsoRequest) Enables single-sign on for a directory.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetDirectoryLimitsResult	getDirectoryLimits() Obtains directory limit information for the current region.
GetDirectoryLimitsResult	getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest) Obtains directory limit information for the current region.
GetSnapshotLimitsResult	getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest) Obtains the manual snapshot limits for a directory.
RestoreFromSnapshotResult	restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest) Restores a directory using an existing directory snapshot.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.
UpdateRadiusResult	updateRadius(UpdateRadiusRequest updateRadiusRequest) Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AWSDirectoryService exceptions.

Constructor Detail

AWSDirectoryServiceClient

public AWSDirectoryServiceClient()

Constructs a new client to invoke service methods on AWSDirectoryService. 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

public AWSDirectoryServiceClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSDirectoryService. 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 AWSDirectoryService (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSDirectoryServiceClient

public AWSDirectoryServiceClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSDirectoryService 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

public AWSDirectoryServiceClient(AWSCredentials awsCredentials,
                         ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSDirectoryService 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 AWSDirectoryService (ex: proxy settings, retry counts, etc.).

AWSDirectoryServiceClient

public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSDirectoryService 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

public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider,
                         ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSDirectoryService 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 AWSDirectoryService (ex: proxy settings, retry counts, etc.).

AWSDirectoryServiceClient

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

Constructs a new client to invoke service methods on AWSDirectoryService 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 AWSDirectoryService (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

describeSnapshots

public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Specified by:

describeSnapshots in interface AWSDirectoryService

Parameters:

describeSnapshotsRequest - Container for the necessary parameters to execute the DescribeSnapshots service method on AWSDirectoryService.

Returns:

The response from the DescribeSnapshots service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

InvalidNextTokenException

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

createAlias

public CreateAliasResult createAlias(CreateAliasRequest createAliasRequest)

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://.awsapps.com .

IMPORTANT: 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 - Container for the necessary parameters to execute the CreateAlias service method on AWSDirectoryService.

Returns:

The response from the CreateAlias service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

EntityDoesNotExistException

ServiceException

EntityAlreadyExistsException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

deleteSnapshot

public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)

Deletes a directory snapshot.

Specified by:

deleteSnapshot in interface AWSDirectoryService

Parameters:

deleteSnapshotRequest - Container for the necessary parameters to execute the DeleteSnapshot service method on AWSDirectoryService.

Returns:

The response from the DeleteSnapshot service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

updateRadius

public UpdateRadiusResult updateRadius(UpdateRadiusRequest updateRadiusRequest)

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

Specified by:

updateRadius in interface AWSDirectoryService

Parameters:

updateRadiusRequest - Container for the necessary parameters to execute the UpdateRadius service method on AWSDirectoryService.

Returns:

The response from the UpdateRadius service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

describeDirectories

public DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Specified by:

describeDirectories in interface AWSDirectoryService

Parameters:

describeDirectoriesRequest - Container for the necessary parameters to execute the DescribeDirectories service method on AWSDirectoryService.

Returns:

The response from the DescribeDirectories service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

InvalidNextTokenException

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

connectDirectory

public ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)

Creates an AD Connector to connect an on-premises directory.

Specified by:

connectDirectory in interface AWSDirectoryService

Parameters:

connectDirectoryRequest - Container for the necessary parameters to execute the ConnectDirectory service method on AWSDirectoryService.

Returns:

The response from the ConnectDirectory service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

DirectoryLimitExceededException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

createSnapshot

public CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)

Creates a snapshot of an existing directory.

You cannot take snapshots of extended or connected directories.

Specified by:

createSnapshot in interface AWSDirectoryService

Parameters:

createSnapshotRequest - Container for the necessary parameters to execute the CreateSnapshot service method on AWSDirectoryService.

Returns:

The response from the CreateSnapshot service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

EntityDoesNotExistException

SnapshotLimitExceededException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

deleteDirectory

public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)

Deletes an AWS Directory Service directory.

Specified by:

deleteDirectory in interface AWSDirectoryService

Parameters:

deleteDirectoryRequest - Container for the necessary parameters to execute the DeleteDirectory service method on AWSDirectoryService.

Returns:

The response from the DeleteDirectory service method, as returned by AWSDirectoryService.

Throws:

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

getDirectoryLimits

public GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)

Obtains directory limit information for the current region.

Specified by:

getDirectoryLimits in interface AWSDirectoryService

Parameters:

getDirectoryLimitsRequest - Container for the necessary parameters to execute the GetDirectoryLimits service method on AWSDirectoryService.

Returns:

The response from the GetDirectoryLimits service method, as returned by AWSDirectoryService.

Throws:

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

disableSso

public DisableSsoResult disableSso(DisableSsoRequest disableSsoRequest)

Disables single-sign on for a directory.

Specified by:

disableSso in interface AWSDirectoryService

Parameters:

disableSsoRequest - Container for the necessary parameters to execute the DisableSso service method on AWSDirectoryService.

Returns:

The response from the DisableSso service method, as returned by AWSDirectoryService.

Throws:

InsufficientPermissionsException

EntityDoesNotExistException

ServiceException

AuthenticationFailedException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

enableRadius

public EnableRadiusResult enableRadius(EnableRadiusRequest enableRadiusRequest)

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

Specified by:

enableRadius in interface AWSDirectoryService

Parameters:

enableRadiusRequest - Container for the necessary parameters to execute the EnableRadius service method on AWSDirectoryService.

Returns:

The response from the EnableRadius service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

EntityDoesNotExistException

ServiceException

EntityAlreadyExistsException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

createComputer

public CreateComputerResult createComputer(CreateComputerRequest createComputerRequest)

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

Specified by:

createComputer in interface AWSDirectoryService

Parameters:

createComputerRequest - Container for the necessary parameters to execute the CreateComputer service method on AWSDirectoryService.

Returns:

The response from the CreateComputer service method, as returned by AWSDirectoryService.

Throws:

UnsupportedOperationException

InvalidParameterException

EntityDoesNotExistException

ServiceException

DirectoryUnavailableException

AuthenticationFailedException

EntityAlreadyExistsException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

enableSso

public EnableSsoResult enableSso(EnableSsoRequest enableSsoRequest)

Enables single-sign on for a directory.

Specified by:

enableSso in interface AWSDirectoryService

Parameters:

enableSsoRequest - Container for the necessary parameters to execute the EnableSso service method on AWSDirectoryService.

Returns:

The response from the EnableSso service method, as returned by AWSDirectoryService.

Throws:

InsufficientPermissionsException

EntityDoesNotExistException

ServiceException

AuthenticationFailedException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

createDirectory

public CreateDirectoryResult createDirectory(CreateDirectoryRequest createDirectoryRequest)

Creates a Simple AD directory.

Specified by:

createDirectory in interface AWSDirectoryService

Parameters:

createDirectoryRequest - Container for the necessary parameters to execute the CreateDirectory service method on AWSDirectoryService.

Returns:

The response from the CreateDirectory service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

DirectoryLimitExceededException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

restoreFromSnapshot

public RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)

Restores a directory using an existing directory snapshot.

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active , the restore operation is complete.

Specified by:

restoreFromSnapshot in interface AWSDirectoryService

Parameters:

restoreFromSnapshotRequest - Container for the necessary parameters to execute the RestoreFromSnapshot service method on AWSDirectoryService.

Returns:

The response from the RestoreFromSnapshot service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

disableRadius

public DisableRadiusResult disableRadius(DisableRadiusRequest disableRadiusRequest)

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

Specified by:

disableRadius in interface AWSDirectoryService

Parameters:

disableRadiusRequest - Container for the necessary parameters to execute the DisableRadius service method on AWSDirectoryService.

Returns:

The response from the DisableRadius service method, as returned by AWSDirectoryService.

Throws:

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

getSnapshotLimits

public GetSnapshotLimitsResult getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)

Obtains the manual snapshot limits for a directory.

Specified by:

getSnapshotLimits in interface AWSDirectoryService

Parameters:

getSnapshotLimitsRequest - Container for the necessary parameters to execute the GetSnapshotLimits service method on AWSDirectoryService.

Returns:

The response from the GetSnapshotLimits service method, as returned by AWSDirectoryService.

Throws:

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

describeSnapshots

public DescribeSnapshotsResult describeSnapshots()
                                          throws AmazonServiceException,
                                                 AmazonClientException

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

Returns:

The response from the DescribeSnapshots service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

InvalidNextTokenException

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

describeDirectories

public DescribeDirectoriesResult describeDirectories()
                                              throws AmazonServiceException,
                                                     AmazonClientException

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

Returns:

The response from the DescribeDirectories service method, as returned by AWSDirectoryService.

Throws:

InvalidParameterException

InvalidNextTokenException

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

getDirectoryLimits

public GetDirectoryLimitsResult getDirectoryLimits()
                                            throws AmazonServiceException,
                                                   AmazonClientException

Obtains directory limit information for the current region.

Specified by:

getDirectoryLimits in interface AWSDirectoryService

Returns:

The response from the GetDirectoryLimits service method, as returned by AWSDirectoryService.

Throws:

EntityDoesNotExistException

ServiceException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSDirectoryService indicating either a problem with the data in the request, or a server side issue.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

Specified by:

setEndpoint in interface AWSDirectoryService

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

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.