AWSDirectoryService (AWS SDK for Java

All Known Subinterfaces:

AWSDirectoryServiceAsync

All Known Implementing Classes:

AbstractAWSDirectoryService, AbstractAWSDirectoryServiceAsync, AWSDirectoryServiceAsyncClient, AWSDirectoryServiceClient
```
public interface AWSDirectoryService
```
Interface for accessing Directory Service.
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ConnectDirectoryResult`	`connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)` Creates an AD Connector to connect to 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.
`CreateConditionalForwarderResult`	`createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)` Creates a conditional forwarder associated with your AWS directory.
`CreateDirectoryResult`	`createDirectory(CreateDirectoryRequest createDirectoryRequest)` Creates a Simple AD directory.
`CreateMicrosoftADResult`	`createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest)` Creates a Microsoft AD in the AWS cloud.
`CreateSnapshotResult`	`createSnapshot(CreateSnapshotRequest createSnapshotRequest)` Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
`CreateTrustResult`	`createTrust(CreateTrustRequest createTrustRequest)` AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.
`DeleteConditionalForwarderResult`	`deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)` Deletes a conditional forwarder that has been set up for your AWS directory.
`DeleteDirectoryResult`	`deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)` Deletes an AWS Directory Service directory.
`DeleteSnapshotResult`	`deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)` Deletes a directory snapshot.
`DeleteTrustResult`	`deleteTrust(DeleteTrustRequest deleteTrustRequest)` Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
`DeregisterEventTopicResult`	`deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)` Removes the specified directory as a publisher to the specified SNS topic.
`DescribeConditionalForwardersResult`	`describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)` Obtains information about the conditional forwarders for this account.
`DescribeDirectoriesResult`	`describeDirectories()` Simplified method form for invoking the DescribeDirectories operation.
`DescribeDirectoriesResult`	`describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)` Obtains information about the directories that belong to this account.
`DescribeEventTopicsResult`	`describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)` Obtains information about which SNS topics receive status messages from the specified directory.
`DescribeSnapshotsResult`	`describeSnapshots()` Simplified method form for invoking the DescribeSnapshots operation.
`DescribeSnapshotsResult`	`describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)` Obtains information about the directory snapshots that belong to this account.
`DescribeTrustsResult`	`describeTrusts(DescribeTrustsRequest describeTrustsRequest)` Obtains information about the trust relationships for this account.
`DisableRadiusResult`	`disableRadius(DisableRadiusRequest disableRadiusRequest)` Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server 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 the Remote Authentication Dial In User Service (RADIUS) server 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()` Simplified method form for invoking the GetDirectoryLimits operation.
`GetDirectoryLimitsResult`	`getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)` Obtains directory limit information for the current region.
`GetSnapshotLimitsResult`	`getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)` Obtains the manual snapshot limits for a directory.
`RegisterEventTopicResult`	`registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)` Associates a directory with an SNS topic.
`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.
`UpdateConditionalForwarderResult`	`updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)` Updates a conditional forwarder that has been set up for your AWS directory.
`UpdateRadiusResult`	`updateRadius(UpdateRadiusRequest updateRadiusRequest)` Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
`VerifyTrustResult`	`verifyTrust(VerifyTrustRequest verifyTrustRequest)` AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

- Method Detail
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    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.
  - setRegion
```
void setRegion(Region region)
```
    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. 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
```
ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)
```
    Creates an AD Connector to connect to an on-premises directory.
    
    Parameters:
    
    connectDirectoryRequest - Contains the inputs for the ConnectDirectory operation.
    
    Returns:
    
    Result of the ConnectDirectory operation returned by the service.
    
    Throws:
    
    DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - createAlias
```
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://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.
    
    Parameters:
    
    createAliasRequest - Contains the inputs for the CreateAlias operation.
    
    Returns:
    
    Result of the CreateAlias operation returned by the service.
    
    Throws:
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - createComputer
```
CreateComputerResult createComputer(CreateComputerRequest createComputerRequest)
```
    Creates a computer account in the specified directory, and joins the computer to the directory.
    
    Parameters:
    
    createComputerRequest - Contains the inputs for the CreateComputer operation.
    
    Returns:
    
    Result of the CreateComputer operation returned by the service.
    
    Throws:
    
    AuthenticationFailedException - An authentication error occurred.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - createConditionalForwarder
```
CreateConditionalForwarderResult createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)
```
    Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
    
    Parameters:
    
    createConditionalForwarderRequest - Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.
    
    Returns:
    
    Result of the CreateConditionalForwarder operation returned by the service.
    
    Throws:
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - createDirectory
```
CreateDirectoryResult createDirectory(CreateDirectoryRequest createDirectoryRequest)
```
    Creates a Simple AD directory.
    
    Parameters:
    
    createDirectoryRequest - Contains the inputs for the CreateDirectory operation.
    
    Returns:
    
    Result of the CreateDirectory operation returned by the service.
    
    Throws:
    
    DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - createMicrosoftAD
```
CreateMicrosoftADResult createMicrosoftAD(CreateMicrosoftADRequest createMicrosoftADRequest)
```
    Creates a Microsoft AD in the AWS cloud.
    
    Parameters:
    
    createMicrosoftADRequest - Creates a Microsoft AD in the AWS cloud.
    
    Returns:
    
    Result of the CreateMicrosoftAD operation returned by the service.
    
    Throws:
    
    DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
  - createSnapshot
```
CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)
```
    Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
    
    You cannot take snapshots of AD Connector directories.
    
    Parameters:
    
    createSnapshotRequest - Contains the inputs for the CreateSnapshot operation.
    
    Returns:
    
    Result of the CreateSnapshot operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    SnapshotLimitExceededException - The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - createTrust
```
CreateTrustResult createTrust(CreateTrustRequest createTrustRequest)
```
    AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
    
    This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.
    
    Parameters:
    
    createTrustRequest - AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
    
    This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.
    
    Returns:
    
    Result of the CreateTrust operation returned by the service.
    
    Throws:
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
  - deleteConditionalForwarder
```
DeleteConditionalForwarderResult deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)
```
    Deletes a conditional forwarder that has been set up for your AWS directory.
    
    Parameters:
    
    deleteConditionalForwarderRequest -
    
    Returns:
    
    Result of the DeleteConditionalForwarder operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - deleteDirectory
```
DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
```
    Deletes an AWS Directory Service directory.
    
    Parameters:
    
    deleteDirectoryRequest - Contains the inputs for the DeleteDirectory operation.
    
    Returns:
    
    Result of the DeleteDirectory operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - deleteSnapshot
```
DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
```
    Deletes a directory snapshot.
    
    Parameters:
    
    deleteSnapshotRequest - Contains the inputs for the DeleteSnapshot operation.
    
    Returns:
    
    Result of the DeleteSnapshot operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - deleteTrust
```
DeleteTrustResult deleteTrust(DeleteTrustRequest deleteTrustRequest)
```
    Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
    
    Parameters:
    
    deleteTrustRequest - Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the external domain.
    
    Returns:
    
    Result of the DeleteTrust operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
  - deregisterEventTopic
```
DeregisterEventTopicResult deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)
```
    Removes the specified directory as a publisher to the specified SNS topic.
    
    Parameters:
    
    deregisterEventTopicRequest - Removes the specified directory as a publisher to the specified SNS topic.
    
    Returns:
    
    Result of the DeregisterEventTopic operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - describeConditionalForwarders
```
DescribeConditionalForwardersResult describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)
```
    Obtains information about the conditional forwarders for this account.
    
    If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
    
    Parameters:
    
    describeConditionalForwardersRequest -
    
    Returns:
    
    Result of the DescribeConditionalForwarders operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - describeDirectories
```
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.
    
    Parameters:
    
    describeDirectoriesRequest - Contains the inputs for the DescribeDirectories operation.
    
    Returns:
    
    Result of the DescribeDirectories operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - describeDirectories
```
DescribeDirectoriesResult describeDirectories()
```
    Simplified method form for invoking the DescribeDirectories operation.
    
    See Also:
    
    describeDirectories(DescribeDirectoriesRequest)
  - describeEventTopics
```
DescribeEventTopicsResult describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)
```
    Obtains information about which SNS topics receive status messages from the specified directory.
    
    If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
    
    Parameters:
    
    describeEventTopicsRequest -
    
    Returns:
    
    Result of the DescribeEventTopics operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - describeSnapshots
```
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.
    
    Parameters:
    
    describeSnapshotsRequest - Contains the inputs for the DescribeSnapshots operation.
    
    Returns:
    
    Result of the DescribeSnapshots operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - describeSnapshots
```
DescribeSnapshotsResult describeSnapshots()
```
    Simplified method form for invoking the DescribeSnapshots operation.
    
    See Also:
    
    describeSnapshots(DescribeSnapshotsRequest)
  - describeTrusts
```
DescribeTrustsResult describeTrusts(DescribeTrustsRequest describeTrustsRequest)
```
    Obtains information about the trust relationships for this account.
    
    If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
    
    Parameters:
    
    describeTrustsRequest - Describes the trust relationships for a particular Microsoft AD in the AWS cloud. If no input parameters are are provided, such as directory ID or trust ID, this request describes all the trust relationships.
    
    Returns:
    
    Result of the DescribeTrusts operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidNextTokenException - The NextToken value is not valid.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
  - disableRadius
```
DisableRadiusResult disableRadius(DisableRadiusRequest disableRadiusRequest)
```
    Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
    
    Parameters:
    
    disableRadiusRequest - Contains the inputs for the DisableRadius operation.
    
    Returns:
    
    Result of the DisableRadius operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - disableSso
```
DisableSsoResult disableSso(DisableSsoRequest disableSsoRequest)
```
    Disables single-sign on for a directory.
    
    Parameters:
    
    disableSsoRequest - Contains the inputs for the DisableSso operation.
    
    Returns:
    
    Result of the DisableSso operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InsufficientPermissionsException - The account does not have sufficient permission to perform the operation.
    
    AuthenticationFailedException - An authentication error occurred.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - enableRadius
```
EnableRadiusResult enableRadius(EnableRadiusRequest enableRadiusRequest)
```
    Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
    
    Parameters:
    
    enableRadiusRequest - Contains the inputs for the EnableRadius operation.
    
    Returns:
    
    Result of the EnableRadius operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters are not valid.
    
    EntityAlreadyExistsException - The specified entity already exists.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - enableSso
```
EnableSsoResult enableSso(EnableSsoRequest enableSsoRequest)
```
    Enables single-sign on for a directory.
    
    Parameters:
    
    enableSsoRequest - Contains the inputs for the EnableSso operation.
    
    Returns:
    
    Result of the EnableSso operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InsufficientPermissionsException - The account does not have sufficient permission to perform the operation.
    
    AuthenticationFailedException - An authentication error occurred.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - getDirectoryLimits
```
GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)
```
    Obtains directory limit information for the current region.
    
    Parameters:
    
    getDirectoryLimitsRequest - Contains the inputs for the GetDirectoryLimits operation.
    
    Returns:
    
    Result of the GetDirectoryLimits operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - getDirectoryLimits
```
GetDirectoryLimitsResult getDirectoryLimits()
```
    Simplified method form for invoking the GetDirectoryLimits operation.
    
    See Also:
    
    getDirectoryLimits(GetDirectoryLimitsRequest)
  - getSnapshotLimits
```
GetSnapshotLimitsResult getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)
```
    Obtains the manual snapshot limits for a directory.
    
    Parameters:
    
    getSnapshotLimitsRequest - Contains the inputs for the GetSnapshotLimits operation.
    
    Returns:
    
    Result of the GetSnapshotLimits operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - registerEventTopic
```
RegisterEventTopicResult registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)
```
    Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
    
    Parameters:
    
    registerEventTopicRequest -
    
    Returns:
    
    Result of the RegisterEventTopic operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - restoreFromSnapshot
```
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.
    
    Parameters:
    
    restoreFromSnapshotRequest - An object representing the inputs for the RestoreFromSnapshot operation.
    
    Returns:
    
    Result of the RestoreFromSnapshot operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - updateConditionalForwarder
```
UpdateConditionalForwarderResult updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)
```
    Updates a conditional forwarder that has been set up for your AWS directory.
    
    Parameters:
    
    updateConditionalForwarderRequest -
    
    Returns:
    
    Result of the UpdateConditionalForwarder operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    DirectoryUnavailableException - The specified directory is unavailable or could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    UnsupportedOperationException - The operation is not supported.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - updateRadius
```
UpdateRadiusResult updateRadius(UpdateRadiusRequest updateRadiusRequest)
```
    Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
    
    Parameters:
    
    updateRadiusRequest - Contains the inputs for the UpdateRadius operation.
    
    Returns:
    
    Result of the UpdateRadius operation returned by the service.
    
    Throws:
    
    InvalidParameterException - One or more parameters are not valid.
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
  - verifyTrust
```
VerifyTrustResult verifyTrust(VerifyTrustRequest verifyTrustRequest)
```
    AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
    
    This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.
    
    Parameters:
    
    verifyTrustRequest - Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud and an external domain.
    
    Returns:
    
    Result of the VerifyTrust operation returned by the service.
    
    Throws:
    
    EntityDoesNotExistException - The specified entity could not be found.
    
    InvalidParameterException - One or more parameters are not valid.
    
    ClientException - A client exception has occurred.
    
    ServiceException - An exception has occurred in AWS Directory Service.
    
    UnsupportedOperationException - The operation is not supported.
  - 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.

Did this page help you?

Interface AWSDirectoryService

Method Summary

Method Detail

setEndpoint

setRegion

connectDirectory

createAlias

createComputer

createConditionalForwarder

createDirectory

createMicrosoftAD

createSnapshot

createTrust

deleteConditionalForwarder

deleteDirectory

deleteSnapshot

deleteTrust

deregisterEventTopic

describeConditionalForwarders

describeDirectories

describeDirectories

describeEventTopics

describeSnapshots

describeSnapshots

describeTrusts

disableRadius

disableSso

enableRadius

enableSso

getDirectoryLimits

getDirectoryLimits

getSnapshotLimits

registerEventTopic

restoreFromSnapshot

updateConditionalForwarder

updateRadius

verifyTrust

shutdown

getCachedResponseMetadata