com.amazonaws.services.directory

Interface AWSDirectoryService

All Known Subinterfaces:

AWSDirectoryServiceAsync

All Known Implementing Classes:

AWSDirectoryServiceAsyncClient, AWSDirectoryServiceClient

public interface AWSDirectoryService

Interface for accessing AWSDirectoryService. 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.

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 ("https://ds.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateRadiusResult	updateRadius(UpdateRadiusRequest updateRadiusRequest) Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://ds.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

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

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

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

Parameters:

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

Throws:

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

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

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

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

describeSnapshots

DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
                                          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.

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

CreateAliasResult createAlias(CreateAliasRequest createAliasRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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.

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

DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Deletes a directory snapshot.

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

UpdateRadiusResult updateRadius(UpdateRadiusRequest updateRadiusRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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

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

DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)
                                              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.

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

ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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

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

CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Creates a snapshot of an existing directory.

You cannot take snapshots of extended or connected directories.

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

DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Deletes an AWS Directory Service directory.

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

GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Obtains directory limit information for the current region.

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

DisableSsoResult disableSso(DisableSsoRequest disableSsoRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Disables single-sign on for a directory.

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

EnableRadiusResult enableRadius(EnableRadiusRequest enableRadiusRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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

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

CreateComputerResult createComputer(CreateComputerRequest createComputerRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

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

EnableSsoResult enableSso(EnableSsoRequest enableSsoRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Enables single-sign on for a directory.

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

CreateDirectoryResult createDirectory(CreateDirectoryRequest createDirectoryRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Creates a Simple AD directory.

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

RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

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.

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

DisableRadiusResult disableRadius(DisableRadiusRequest disableRadiusRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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

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

GetSnapshotLimitsResult getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Obtains the manual snapshot limits for a directory.

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

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.

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

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.

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

GetDirectoryLimitsResult getDirectoryLimits()
                                            throws AmazonServiceException,
                                                   AmazonClientException

Obtains directory limit information for the current region.

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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