public class AbstractAWSDirectoryService extends Object implements AWSDirectoryService
AWSDirectoryService. Convenient method
forms pass through to the corresponding overload that takes a request object,
which throws an UnsupportedOperationException.| Modifier and Type | Method and Description |
|---|---|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
VerifyTrustResult |
verifyTrust(VerifyTrustRequest request)
AWS Directory Service for Microsoft Active Directory allows you to
configure and verify trust relationships.
|
public void setEndpoint(String endpoint)
AWSDirectoryService
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.
setEndpoint in interface AWSDirectoryServiceendpoint - 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.public void setRegion(Region region)
AWSDirectoryServiceAWSDirectoryService.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.
setRegion in interface AWSDirectoryServiceregion - 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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest request)
AWSDirectoryServiceCreates an AD Connector to connect to an on-premises directory.
connectDirectory in interface AWSDirectoryServicerequest - Contains the inputs for the ConnectDirectory operation.public CreateAliasResult createAlias(CreateAliasRequest request)
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.
createAlias in interface AWSDirectoryServicerequest - Contains the inputs for the CreateAlias operation.public CreateComputerResult createComputer(CreateComputerRequest request)
AWSDirectoryServiceCreates a computer account in the specified directory, and joins the computer to the directory.
createComputer in interface AWSDirectoryServicerequest - Contains the inputs for the CreateComputer operation.public CreateDirectoryResult createDirectory(CreateDirectoryRequest request)
AWSDirectoryServiceCreates a Simple AD directory.
createDirectory in interface AWSDirectoryServicerequest - Contains the inputs for the CreateDirectory operation.public CreateMicrosoftADResult createMicrosoftAD(CreateMicrosoftADRequest request)
AWSDirectoryServicecreateMicrosoftAD in interface AWSDirectoryServicerequest - Creates a Microsoft AD in the AWS cloud.public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
AWSDirectoryServiceCreates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
You cannot take snapshots of AD Connector directories.
createSnapshot in interface AWSDirectoryServicerequest - Contains the inputs for the CreateSnapshot operation.public CreateTrustResult createTrust(CreateTrustRequest request)
AWSDirectoryServiceAWS 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.
createTrust in interface AWSDirectoryServicerequest - 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.
public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest request)
AWSDirectoryServiceDeletes an AWS Directory Service directory.
deleteDirectory in interface AWSDirectoryServicerequest - Contains the inputs for the DeleteDirectory operation.public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)
AWSDirectoryServiceDeletes a directory snapshot.
deleteSnapshot in interface AWSDirectoryServicerequest - Contains the inputs for the DeleteSnapshot operation.public DeleteTrustResult deleteTrust(DeleteTrustRequest request)
AWSDirectoryServicedeleteTrust in interface AWSDirectoryServicerequest - Deletes the local side of an existing trust relationship between
the Microsoft AD in the AWS cloud and the external domain.public DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest request)
AWSDirectoryServiceObtains 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.
describeDirectories in interface AWSDirectoryServicerequest - Contains the inputs for the DescribeDirectories operation.public DescribeDirectoriesResult describeDirectories()
AWSDirectoryServicedescribeDirectories in interface AWSDirectoryServiceAWSDirectoryService.describeDirectories(DescribeDirectoriesRequest)public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
AWSDirectoryServiceObtains 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.
describeSnapshots in interface AWSDirectoryServicerequest - Contains the inputs for the DescribeSnapshots operation.public DescribeSnapshotsResult describeSnapshots()
AWSDirectoryServicedescribeSnapshots in interface AWSDirectoryServiceAWSDirectoryService.describeSnapshots(DescribeSnapshotsRequest)public DescribeTrustsResult describeTrusts(DescribeTrustsRequest request)
AWSDirectoryServiceObtains 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.
describeTrusts in interface AWSDirectoryServicerequest - 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.public DisableRadiusResult disableRadius(DisableRadiusRequest request)
AWSDirectoryServiceDisables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
disableRadius in interface AWSDirectoryServicerequest - Contains the inputs for the DisableRadius operation.public DisableSsoResult disableSso(DisableSsoRequest request)
AWSDirectoryServiceDisables single-sign on for a directory.
disableSso in interface AWSDirectoryServicerequest - Contains the inputs for the DisableSso operation.public EnableRadiusResult enableRadius(EnableRadiusRequest request)
AWSDirectoryServiceEnables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
enableRadius in interface AWSDirectoryServicerequest - Contains the inputs for the EnableRadius operation.public EnableSsoResult enableSso(EnableSsoRequest request)
AWSDirectoryServiceEnables single-sign on for a directory.
enableSso in interface AWSDirectoryServicerequest - Contains the inputs for the EnableSso operation.public GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest request)
AWSDirectoryServiceObtains directory limit information for the current region.
getDirectoryLimits in interface AWSDirectoryServicerequest - Contains the inputs for the GetDirectoryLimits operation.public GetDirectoryLimitsResult getDirectoryLimits()
AWSDirectoryServicegetDirectoryLimits in interface AWSDirectoryServiceAWSDirectoryService.getDirectoryLimits(GetDirectoryLimitsRequest)public GetSnapshotLimitsResult getSnapshotLimits(GetSnapshotLimitsRequest request)
AWSDirectoryServiceObtains the manual snapshot limits for a directory.
getSnapshotLimits in interface AWSDirectoryServicerequest - Contains the inputs for the GetSnapshotLimits operation.public RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest request)
AWSDirectoryServiceRestores 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.
restoreFromSnapshot in interface AWSDirectoryServicerequest - An object representing the inputs for the
RestoreFromSnapshot operation.public UpdateRadiusResult updateRadius(UpdateRadiusRequest request)
AWSDirectoryServiceUpdates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
updateRadius in interface AWSDirectoryServicerequest - Contains the inputs for the UpdateRadius operation.public VerifyTrustResult verifyTrust(VerifyTrustRequest request)
AWSDirectoryServiceAWS 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.
verifyTrust in interface AWSDirectoryServicerequest - Initiates the verification of an existing trust relationship
between a Microsoft AD in the AWS cloud and an external domain.public void shutdown()
AWSDirectoryServiceshutdown in interface AWSDirectoryServicepublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSDirectoryServiceResponse 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.
getCachedResponseMetadata in interface AWSDirectoryServicerequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.