com.amazonaws.services.directory

Class AbstractAWSDirectoryService

java.lang.Object

com.amazonaws.services.directory.AbstractAWSDirectoryService

All Implemented Interfaces:

AWSDirectoryService

Direct Known Subclasses:

AbstractAWSDirectoryServiceAsync

public class AbstractAWSDirectoryService
extends Object
implements AWSDirectoryService

Abstract implementation of AWSDirectoryService. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAWSDirectoryService()

Method Summary

Methods

Modifier and Type	Method and Description
ConnectDirectoryResult	connectDirectory(ConnectDirectoryRequest request) Creates an AD Connector to connect 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.
CreateDirectoryResult	createDirectory(CreateDirectoryRequest request) Creates a Simple AD directory.
CreateSnapshotResult	createSnapshot(CreateSnapshotRequest request) Creates a snapshot of an existing directory.
DeleteDirectoryResult	deleteDirectory(DeleteDirectoryRequest request) Deletes an AWS Directory Service directory.
DeleteSnapshotResult	deleteSnapshot(DeleteSnapshotRequest request) Deletes a directory snapshot.
DescribeDirectoriesResult	describeDirectories() Simplified method form for invoking the DescribeDirectories operation.
DescribeDirectoriesResult	describeDirectories(DescribeDirectoriesRequest request) Obtains information about the directories that belong to this account.
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.
DisableRadiusResult	disableRadius(DisableRadiusRequest request) Disables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) 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 Remote Authentication Dial In User Service (RADIUS) 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.
RestoreFromSnapshotResult	restoreFromSnapshot(RestoreFromSnapshotRequest request) 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 AWSDirectoryService.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 request) Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAWSDirectoryService

protected AbstractAWSDirectoryService()

Method Detail

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AWSDirectoryService

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.

Specified by:

setEndpoint in interface AWSDirectoryService

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.

setRegion

public void setRegion(Region region)

Description copied from interface: AWSDirectoryService

An alternative to AWSDirectoryService.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.

Specified by:

setRegion in interface AWSDirectoryService

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

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

connectDirectory

public ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest request)

Description copied from interface: AWSDirectoryService

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

Specified by:

connectDirectory in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the ConnectDirectory operation.

Returns:

Result of the ConnectDirectory operation returned by the service.

createAlias

public CreateAliasResult createAlias(CreateAliasRequest request)

Description copied from interface: AWSDirectoryService

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:

request - Contains the inputs for the CreateAlias operation.

Returns:

Result of the CreateAlias operation returned by the service.

createComputer

public CreateComputerResult createComputer(CreateComputerRequest request)

Description copied from interface: AWSDirectoryService

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

Specified by:

createComputer in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the CreateComputer operation.

Returns:

Result of the CreateComputer operation returned by the service.

createDirectory

public CreateDirectoryResult createDirectory(CreateDirectoryRequest request)

Description copied from interface: AWSDirectoryService

Creates a Simple AD directory.

Specified by:

createDirectory in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the CreateDirectory operation.

Returns:

Result of the CreateDirectory operation returned by the service.

createSnapshot

public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)

Description copied from interface: AWSDirectoryService

Creates a snapshot of an existing directory.

You cannot take snapshots of extended or connected directories.

Specified by:

createSnapshot in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the CreateSnapshot operation.

Returns:

Result of the CreateSnapshot operation returned by the service.

deleteDirectory

public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest request)

Description copied from interface: AWSDirectoryService

Deletes an AWS Directory Service directory.

Specified by:

deleteDirectory in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the DeleteDirectory operation.

Returns:

Result of the DeleteDirectory operation returned by the service.

deleteSnapshot

public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)

Description copied from interface: AWSDirectoryService

Deletes a directory snapshot.

Specified by:

deleteSnapshot in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the DeleteSnapshot operation.

Returns:

Result of the DeleteSnapshot operation returned by the service.

describeDirectories

public DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest request)

Description copied from interface: AWSDirectoryService

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:

request - Contains the inputs for the DescribeDirectories operation.

Returns:

Result of the DescribeDirectories operation returned by the service.

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)

describeSnapshots

public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)

Description copied from interface: AWSDirectoryService

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:

request - Contains the inputs for the DescribeSnapshots operation.

Returns:

Result of the DescribeSnapshots operation returned by the service.

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)

disableRadius

public DisableRadiusResult disableRadius(DisableRadiusRequest request)

Description copied from interface: AWSDirectoryService

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:

request - Contains the inputs for the DisableRadius operation.

Returns:

Result of the DisableRadius operation returned by the service.

disableSso

public DisableSsoResult disableSso(DisableSsoRequest request)

Description copied from interface: AWSDirectoryService

Disables single-sign on for a directory.

Specified by:

disableSso in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the DisableSso operation.

Returns:

Result of the DisableSso operation returned by the service.

enableRadius

public EnableRadiusResult enableRadius(EnableRadiusRequest request)

Description copied from interface: AWSDirectoryService

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:

request - Contains the inputs for the EnableRadius operation.

Returns:

Result of the EnableRadius operation returned by the service.

enableSso

public EnableSsoResult enableSso(EnableSsoRequest request)

Description copied from interface: AWSDirectoryService

Enables single-sign on for a directory.

Specified by:

enableSso in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the EnableSso operation.

Returns:

Result of the EnableSso operation returned by the service.

getDirectoryLimits

public GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest request)

Description copied from interface: AWSDirectoryService

Obtains directory limit information for the current region.

Specified by:

getDirectoryLimits in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the GetDirectoryLimits operation.

Returns:

Result of the GetDirectoryLimits operation returned by the service.

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)

Description copied from interface: AWSDirectoryService

Obtains the manual snapshot limits for a directory.

Specified by:

getSnapshotLimits in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the GetSnapshotLimits operation.

Returns:

Result of the GetSnapshotLimits operation returned by the service.

restoreFromSnapshot

public RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest request)

Description copied from interface: AWSDirectoryService

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:

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

Returns:

Result of the RestoreFromSnapshot operation returned by the service.

updateRadius

public UpdateRadiusResult updateRadius(UpdateRadiusRequest request)

Description copied from interface: AWSDirectoryService

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

Specified by:

updateRadius in interface AWSDirectoryService

Parameters:

request - Contains the inputs for the UpdateRadius operation.

Returns:

Result of the UpdateRadius operation returned by the service.

shutdown

public void shutdown()

Description copied from interface: AWSDirectoryService

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.

Specified by:

shutdown in interface AWSDirectoryService

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSDirectoryService

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.

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.