Class AWSDirectoryServiceClient
- All Implemented Interfaces:
AWSDirectoryService
- Direct Known Subclasses:
AWSDirectoryServiceAsyncClient
This is the AWS Directory Service API Reference. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final ClientConfigurationFactory
Client configuration factory providing ClientConfigurations tailored to this clientFields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new client to invoke service methods on Directory Service.AWSDirectoryServiceClient
(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials.AWSDirectoryServiceClient
(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider.AWSDirectoryServiceClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider and client configuration options.AWSDirectoryServiceClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider, client configuration options, and request metric collector.AWSDirectoryServiceClient
(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials and client configuration options.AWSDirectoryServiceClient
(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Directory Service. -
Method Summary
Modifier and TypeMethodDescriptionconnectDirectory
(ConnectDirectoryRequest connectDirectoryRequest) Creates an AD Connector to connect to an on-premises directory.createAlias
(CreateAliasRequest createAliasRequest) Creates an alias for a directory and assigns the alias to the directory.createComputer
(CreateComputerRequest createComputerRequest) Creates a computer account in the specified directory, and joins the computer to the directory.createConditionalForwarder
(CreateConditionalForwarderRequest createConditionalForwarderRequest) Creates a conditional forwarder associated with your AWS directory.createDirectory
(CreateDirectoryRequest createDirectoryRequest) Creates a Simple AD directory.createMicrosoftAD
(CreateMicrosoftADRequest createMicrosoftADRequest) Creates a Microsoft AD in the AWS cloud.createSnapshot
(CreateSnapshotRequest createSnapshotRequest) Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.createTrust
(CreateTrustRequest createTrustRequest) AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.deleteConditionalForwarder
(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest) Deletes a conditional forwarder that has been set up for your AWS directory.deleteDirectory
(DeleteDirectoryRequest deleteDirectoryRequest) Deletes an AWS Directory Service directory.deleteSnapshot
(DeleteSnapshotRequest deleteSnapshotRequest) Deletes a directory snapshot.deleteTrust
(DeleteTrustRequest deleteTrustRequest) Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.deregisterEventTopic
(DeregisterEventTopicRequest deregisterEventTopicRequest) Removes the specified directory as a publisher to the specified SNS topic.describeConditionalForwarders
(DescribeConditionalForwardersRequest describeConditionalForwardersRequest) Obtains information about the conditional forwarders for this account.Simplified method form for invoking the DescribeDirectories operation.describeDirectories
(DescribeDirectoriesRequest describeDirectoriesRequest) Obtains information about the directories that belong to this account.describeEventTopics
(DescribeEventTopicsRequest describeEventTopicsRequest) Obtains information about which SNS topics receive status messages from the specified directory.Simplified method form for invoking the DescribeSnapshots operation.describeSnapshots
(DescribeSnapshotsRequest describeSnapshotsRequest) Obtains information about the directory snapshots that belong to this account.describeTrusts
(DescribeTrustsRequest describeTrustsRequest) Obtains information about the trust relationships for this account.disableRadius
(DisableRadiusRequest disableRadiusRequest) Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.disableSso
(DisableSsoRequest disableSsoRequest) Disables single-sign on for a directory.enableRadius
(EnableRadiusRequest enableRadiusRequest) Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.enableSso
(EnableSsoRequest enableSsoRequest) Enables single-sign on for a directory.Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.Simplified method form for invoking the GetDirectoryLimits operation.getDirectoryLimits
(GetDirectoryLimitsRequest getDirectoryLimitsRequest) Obtains directory limit information for the current region.getSnapshotLimits
(GetSnapshotLimitsRequest getSnapshotLimitsRequest) Obtains the manual snapshot limits for a directory.registerEventTopic
(RegisterEventTopicRequest registerEventTopicRequest) Associates a directory with an SNS topic.restoreFromSnapshot
(RestoreFromSnapshotRequest restoreFromSnapshotRequest) Restores a directory using an existing directory snapshot.updateConditionalForwarder
(UpdateConditionalForwarderRequest updateConditionalForwarderRequest) Updates a conditional forwarder that has been set up for your AWS directory.updateRadius
(UpdateRadiusRequest updateRadiusRequest) Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.verifyTrust
(VerifyTrustRequest verifyTrustRequest) AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.directory.AWSDirectoryService
setEndpoint, setRegion, shutdown
-
Field Details
-
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
-
-
Constructor Details
-
AWSDirectoryServiceClient
public AWSDirectoryServiceClient()Constructs a new client to invoke service methods on Directory Service. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
-
AWSDirectoryServiceClient
Constructs a new client to invoke service methods on Directory Service. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).- See Also:
-
AWSDirectoryServiceClient
Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AWSDirectoryServiceClient
public AWSDirectoryServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).
-
AWSDirectoryServiceClient
Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AWSDirectoryServiceClient
public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).
-
AWSDirectoryServiceClient
public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Directory Service using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Directory Service (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collector
-
-
Method Details
-
connectDirectory
Creates an AD Connector to connect to an on-premises directory.
- Specified by:
connectDirectory
in interfaceAWSDirectoryService
- 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
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://<![CDATA[<]]>alias<![CDATA[>]]>.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 interfaceAWSDirectoryService
- 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
Creates a computer account in the specified directory, and joins the computer to the directory.
- Specified by:
createComputer
in interfaceAWSDirectoryService
- 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
public 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.
- Specified by:
createConditionalForwarder
in interfaceAWSDirectoryService
- 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
Creates a Simple AD directory.
- Specified by:
createDirectory
in interfaceAWSDirectoryService
- 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
Creates a Microsoft AD in the AWS cloud.- Specified by:
createMicrosoftAD
in interfaceAWSDirectoryService
- 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
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
You cannot take snapshots of AD Connector directories.
- Specified by:
createSnapshot
in interfaceAWSDirectoryService
- 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
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.
- Specified by:
createTrust
in interfaceAWSDirectoryService
- 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
public DeleteConditionalForwarderResult deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest) Deletes a conditional forwarder that has been set up for your AWS directory.
- Specified by:
deleteConditionalForwarder
in interfaceAWSDirectoryService
- 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
Deletes an AWS Directory Service directory.
- Specified by:
deleteDirectory
in interfaceAWSDirectoryService
- 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
Deletes a directory snapshot.
- Specified by:
deleteSnapshot
in interfaceAWSDirectoryService
- 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
Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.- Specified by:
deleteTrust
in interfaceAWSDirectoryService
- 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
public DeregisterEventTopicResult deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest) Removes the specified directory as a publisher to the specified SNS topic.
- Specified by:
deregisterEventTopic
in interfaceAWSDirectoryService
- 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
public 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.
- Specified by:
describeConditionalForwarders
in interfaceAWSDirectoryService
- 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
public DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest) Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
- Specified by:
describeDirectories
in interfaceAWSDirectoryService
- 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
Description copied from interface:AWSDirectoryService
Simplified method form for invoking the DescribeDirectories operation.- Specified by:
describeDirectories
in interfaceAWSDirectoryService
- See Also:
-
describeEventTopics
public 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.
- Specified by:
describeEventTopics
in interfaceAWSDirectoryService
- 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
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 interfaceAWSDirectoryService
- 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
Description copied from interface:AWSDirectoryService
Simplified method form for invoking the DescribeSnapshots operation.- Specified by:
describeSnapshots
in interfaceAWSDirectoryService
- See Also:
-
describeTrusts
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.
- Specified by:
describeTrusts
in interfaceAWSDirectoryService
- 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
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
- Specified by:
disableRadius
in interfaceAWSDirectoryService
- 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
Disables single-sign on for a directory.
- Specified by:
disableSso
in interfaceAWSDirectoryService
- 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
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
- Specified by:
enableRadius
in interfaceAWSDirectoryService
- 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
Enables single-sign on for a directory.
- Specified by:
enableSso
in interfaceAWSDirectoryService
- 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
public GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest) Obtains directory limit information for the current region.
- Specified by:
getDirectoryLimits
in interfaceAWSDirectoryService
- 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
Description copied from interface:AWSDirectoryService
Simplified method form for invoking the GetDirectoryLimits operation.- Specified by:
getDirectoryLimits
in interfaceAWSDirectoryService
- See Also:
-
getSnapshotLimits
Obtains the manual snapshot limits for a directory.
- Specified by:
getSnapshotLimits
in interfaceAWSDirectoryService
- 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
public 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.
- Specified by:
registerEventTopic
in interfaceAWSDirectoryService
- 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
public RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest) Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to
Active
, the restore operation is complete.- Specified by:
restoreFromSnapshot
in interfaceAWSDirectoryService
- 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
public UpdateConditionalForwarderResult updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest) Updates a conditional forwarder that has been set up for your AWS directory.
- Specified by:
updateConditionalForwarder
in interfaceAWSDirectoryService
- 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
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
- Specified by:
updateRadius
in interfaceAWSDirectoryService
- 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
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.
- Specified by:
verifyTrust
in interfaceAWSDirectoryService
- 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.
-
getCachedResponseMetadata
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSDirectoryService
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-