@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSDirectoryServiceClient extends AmazonWebServiceClient implements AWSDirectoryService
Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service Administration Guide.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSDirectoryServiceClient()
Deprecated.
|
AWSDirectoryServiceClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSDirectoryServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSDirectoryServiceClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSDirectoryServiceClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
AcceptSharedDirectoryResult |
acceptSharedDirectory(AcceptSharedDirectoryRequest request)
Accepts a directory sharing request that was sent from the directory owner account.
|
AddIpRoutesResult |
addIpRoutes(AddIpRoutesRequest request)
If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR
address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.
|
AddRegionResult |
addRegion(AddRegionRequest request)
Adds two domain controllers in the specified Region for the specified directory.
|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest request)
Adds or overwrites one or more tags for the specified directory.
|
static AWSDirectoryServiceClientBuilder |
builder() |
CancelSchemaExtensionResult |
cancelSchemaExtension(CancelSchemaExtensionRequest request)
Cancels an in-progress schema extension to a Microsoft AD directory.
|
ConnectDirectoryResult |
connectDirectory(ConnectDirectoryRequest request)
Creates an AD Connector to connect to a self-managed directory.
|
CreateAliasResult |
createAlias(CreateAliasRequest request)
Creates an alias for a directory and assigns the alias to the directory.
|
CreateComputerResult |
createComputer(CreateComputerRequest request)
Creates an Active Directory computer object in the specified directory.
|
CreateConditionalForwarderResult |
createConditionalForwarder(CreateConditionalForwarderRequest request)
Creates a conditional forwarder associated with your Amazon Web Services directory.
|
CreateDirectoryResult |
createDirectory(CreateDirectoryRequest request)
Creates a Simple AD directory.
|
CreateLogSubscriptionResult |
createLogSubscription(CreateLogSubscriptionRequest request)
Creates a subscription to forward real-time Directory Service domain controller security logs to the specified
Amazon CloudWatch log group in your Amazon Web Services account.
|
CreateMicrosoftADResult |
createMicrosoftAD(CreateMicrosoftADRequest request)
Creates a Microsoft AD directory in the Amazon Web Services Cloud.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest request)
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
|
CreateTrustResult |
createTrust(CreateTrustRequest request)
Directory Service for Microsoft Active Directory allows you to configure trust relationships.
|
DeleteConditionalForwarderResult |
deleteConditionalForwarder(DeleteConditionalForwarderRequest request)
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
|
DeleteDirectoryResult |
deleteDirectory(DeleteDirectoryRequest request)
Deletes an Directory Service directory.
|
DeleteLogSubscriptionResult |
deleteLogSubscription(DeleteLogSubscriptionRequest request)
Deletes the specified log subscription.
|
DeleteSnapshotResult |
deleteSnapshot(DeleteSnapshotRequest request)
Deletes a directory snapshot.
|
DeleteTrustResult |
deleteTrust(DeleteTrustRequest request)
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
|
DeregisterCertificateResult |
deregisterCertificate(DeregisterCertificateRequest request)
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
|
DeregisterEventTopicResult |
deregisterEventTopic(DeregisterEventTopicRequest request)
Removes the specified directory as a publisher to the specified Amazon SNS topic.
|
DescribeCertificateResult |
describeCertificate(DescribeCertificateRequest request)
Displays information about the certificate registered for secure LDAP or client certificate authentication.
|
DescribeClientAuthenticationSettingsResult |
describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest request)
Retrieves information about the type of client authentication for the specified directory, if the type is
specified.
|
DescribeConditionalForwardersResult |
describeConditionalForwarders(DescribeConditionalForwardersRequest request)
Obtains information about the conditional forwarders for this account.
|
DescribeDirectoriesResult |
describeDirectories()
Simplified method form for invoking the DescribeDirectories operation.
|
DescribeDirectoriesResult |
describeDirectories(DescribeDirectoriesRequest request)
Obtains information about the directories that belong to this account.
|
DescribeDomainControllersResult |
describeDomainControllers(DescribeDomainControllersRequest request)
Provides information about any domain controllers in your directory.
|
DescribeEventTopicsResult |
describeEventTopics(DescribeEventTopicsRequest request)
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
|
DescribeLDAPSSettingsResult |
describeLDAPSSettings(DescribeLDAPSSettingsRequest request)
Describes the status of LDAP security for the specified directory.
|
DescribeRegionsResult |
describeRegions(DescribeRegionsRequest request)
Provides information about the Regions that are configured for multi-Region replication.
|
DescribeSettingsResult |
describeSettings(DescribeSettingsRequest request)
Retrieves information about the configurable settings for the specified directory.
|
DescribeSharedDirectoriesResult |
describeSharedDirectories(DescribeSharedDirectoriesRequest request)
Returns the shared directories in your 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.
|
DescribeUpdateDirectoryResult |
describeUpdateDirectory(DescribeUpdateDirectoryRequest request)
Describes the updates of a directory for a particular update type.
|
DisableClientAuthenticationResult |
disableClientAuthentication(DisableClientAuthenticationRequest request)
Disables alternative client authentication methods for the specified directory.
|
DisableLDAPSResult |
disableLDAPS(DisableLDAPSRequest request)
Deactivates LDAP secure calls for the specified directory.
|
DisableRadiusResult |
disableRadius(DisableRadiusRequest request)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server
for an AD Connector or Microsoft AD directory.
|
DisableSsoResult |
disableSso(DisableSsoRequest request)
Disables single-sign on for a directory.
|
EnableClientAuthenticationResult |
enableClientAuthentication(EnableClientAuthenticationRequest request)
Enables alternative client authentication methods for the specified directory.
|
EnableLDAPSResult |
enableLDAPS(EnableLDAPSRequest request)
Activates the switch for the specific directory to always use LDAP secure calls.
|
EnableRadiusResult |
enableRadius(EnableRadiusRequest request)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for
an AD Connector or Microsoft AD 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.
|
ListCertificatesResult |
listCertificates(ListCertificatesRequest request)
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate
authentication.
|
ListIpRoutesResult |
listIpRoutes(ListIpRoutesRequest request)
Lists the address blocks that you have added to a directory.
|
ListLogSubscriptionsResult |
listLogSubscriptions(ListLogSubscriptionsRequest request)
Lists the active log subscriptions for the Amazon Web Services account.
|
ListSchemaExtensionsResult |
listSchemaExtensions(ListSchemaExtensionsRequest request)
Lists all schema extensions applied to a Microsoft AD Directory.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags on a directory.
|
RegisterCertificateResult |
registerCertificate(RegisterCertificateRequest request)
Registers a certificate for a secure LDAP or client certificate authentication.
|
RegisterEventTopicResult |
registerEventTopic(RegisterEventTopicRequest request)
Associates a directory with an Amazon SNS topic.
|
RejectSharedDirectoryResult |
rejectSharedDirectory(RejectSharedDirectoryRequest request)
Rejects a directory sharing request that was sent from the directory owner account.
|
RemoveIpRoutesResult |
removeIpRoutes(RemoveIpRoutesRequest request)
Removes IP address blocks from a directory.
|
RemoveRegionResult |
removeRegion(RemoveRegionRequest request)
Stops all replication and removes the domain controllers from the specified Region.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes tags from a directory.
|
ResetUserPasswordResult |
resetUserPassword(ResetUserPasswordRequest request)
Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
|
RestoreFromSnapshotResult |
restoreFromSnapshot(RestoreFromSnapshotRequest request)
Restores a directory using an existing directory snapshot.
|
ShareDirectoryResult |
shareDirectory(ShareDirectoryRequest request)
Shares a specified directory (
DirectoryId) in your Amazon Web Services account (directory owner)
with another Amazon Web Services account (directory consumer). |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartSchemaExtensionResult |
startSchemaExtension(StartSchemaExtensionRequest request)
Applies a schema extension to a Microsoft AD directory.
|
UnshareDirectoryResult |
unshareDirectory(UnshareDirectoryRequest request)
Stops the directory sharing between the directory owner and consumer accounts.
|
UpdateConditionalForwarderResult |
updateConditionalForwarder(UpdateConditionalForwarderRequest request)
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
|
UpdateDirectorySetupResult |
updateDirectorySetup(UpdateDirectorySetupRequest request)
Updates the directory for a particular update type.
|
UpdateNumberOfDomainControllersResult |
updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest request)
Adds or removes domain controllers to or from the directory.
|
UpdateRadiusResult |
updateRadius(UpdateRadiusRequest request)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or
Microsoft AD directory.
|
UpdateSettingsResult |
updateSettings(UpdateSettingsRequest request)
Updates the configurable settings for the specified directory.
|
UpdateTrustResult |
updateTrust(UpdateTrustRequest request)
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active
Directory.
|
VerifyTrustResult |
verifyTrust(VerifyTrustRequest request)
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AWSDirectoryServiceClient()
AWSDirectoryServiceClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSDirectoryServiceClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Directory Service (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSDirectoryServiceClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSDirectoryServiceClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSDirectoryServiceClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AWSDirectoryServiceClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic static AWSDirectoryServiceClientBuilder builder()
public AcceptSharedDirectoryResult acceptSharedDirectory(AcceptSharedDirectoryRequest request)
Accepts a directory sharing request that was sent from the directory owner account.
acceptSharedDirectory in interface AWSDirectoryServiceacceptSharedDirectoryRequest - InvalidParameterException - One or more parameters are not valid.EntityDoesNotExistException - The specified entity could not be found.DirectoryAlreadySharedException - The specified directory has already been shared with this Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public AddIpRoutesResult addIpRoutes(AddIpRoutesRequest request)
If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
addIpRoutes in interface AWSDirectoryServiceaddIpRoutesRequest - EntityDoesNotExistException - The specified entity could not be found.EntityAlreadyExistsException - The specified entity already exists.InvalidParameterException - One or more parameters are not valid.DirectoryUnavailableException - The specified directory is unavailable or could not be found.IpRouteLimitExceededException - The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public AddRegionResult addRegion(AddRegionRequest request)
Adds two domain controllers in the specified Region for the specified directory.
addRegion in interface AWSDirectoryServiceaddRegionRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.InvalidParameterException - One or more parameters are not valid.EntityDoesNotExistException - The specified entity could not be found.DirectoryAlreadyInRegionException - The Region you specified is the same Region where the Managed Microsoft AD directory was created. Specify
a different Region and try again.UnsupportedOperationException - The operation is not supported.DirectoryDoesNotExistException - The specified directory does not exist in the system.RegionLimitExceededException - You have reached the limit for maximum number of simultaneous Region replications per directory.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
addTagsToResource in interface AWSDirectoryServiceaddTagsToResourceRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.TagLimitExceededException - The maximum allowed number of tags was exceeded.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public CancelSchemaExtensionResult cancelSchemaExtension(CancelSchemaExtensionRequest request)
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started
replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled
during any of the following states; Initializing, CreatingSnapshot, and
UpdatingSchema.
cancelSchemaExtension in interface AWSDirectoryServicecancelSchemaExtensionRequest - EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest request)
Creates an AD Connector to connect to a self-managed directory.
Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the
ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
connectDirectory in interface AWSDirectoryServiceconnectDirectoryRequest - Contains the inputs for the ConnectDirectory operation.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 Directory Service.public CreateAliasResult createAlias(CreateAliasRequest request)
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 AWSDirectoryServicecreateAliasRequest - Contains the inputs for the CreateAlias operation.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 Directory Service.public CreateComputerResult createComputer(CreateComputerRequest request)
Creates an Active Directory computer object in the specified directory.
createComputer in interface AWSDirectoryServicecreateComputerRequest - Contains the inputs for the CreateComputer operation.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 Directory Service.public CreateConditionalForwarderResult createConditionalForwarder(CreateConditionalForwarderRequest request)
Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
createConditionalForwarder in interface AWSDirectoryServicecreateConditionalForwarderRequest - Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active
Directory. Conditional forwarders are required in order to set up a trust relationship with another
domain.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 Directory Service.public CreateDirectoryResult createDirectory(CreateDirectoryRequest request)
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
Before you call CreateDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the CreateDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
createDirectory in interface AWSDirectoryServicecreateDirectoryRequest - Contains the inputs for the CreateDirectory operation.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 Directory Service.public CreateLogSubscriptionResult createLogSubscription(CreateLogSubscriptionRequest request)
Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
createLogSubscription in interface AWSDirectoryServicecreateLogSubscriptionRequest - EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.UnsupportedOperationException - The operation is not supported.InsufficientPermissionsException - The account does not have sufficient permission to perform the operation.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public CreateMicrosoftADResult createMicrosoftAD(CreateMicrosoftADRequest request)
Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
createMicrosoftAD in interface AWSDirectoryServicecreateMicrosoftADRequest - Creates an Managed Microsoft AD directory.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 Directory Service.UnsupportedOperationException - The operation is not supported.public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
You cannot take snapshots of AD Connector directories.
createSnapshot in interface AWSDirectoryServicecreateSnapshotRequest - Contains the inputs for the CreateSnapshot operation.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 Directory Service.public CreateTrustResult createTrust(CreateTrustRequest request)
Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed 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 Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
createTrust in interface AWSDirectoryServicecreateTrustRequest - Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example,
you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed
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 Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.
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 Directory Service.UnsupportedOperationException - The operation is not supported.public DeleteConditionalForwarderResult deleteConditionalForwarder(DeleteConditionalForwarderRequest request)
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
deleteConditionalForwarder in interface AWSDirectoryServicedeleteConditionalForwarderRequest - Deletes a conditional forwarder.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 Directory Service.public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest request)
Deletes an Directory Service directory.
Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the DeleteDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
deleteDirectory in interface AWSDirectoryServicedeleteDirectoryRequest - Contains the inputs for the DeleteDirectory operation.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public DeleteLogSubscriptionResult deleteLogSubscription(DeleteLogSubscriptionRequest request)
Deletes the specified log subscription.
deleteLogSubscription in interface AWSDirectoryServicedeleteLogSubscriptionRequest - EntityDoesNotExistException - The specified entity could not be found.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)
Deletes a directory snapshot.
deleteSnapshot in interface AWSDirectoryServicedeleteSnapshotRequest - Contains the inputs for the DeleteSnapshot operation.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 Directory Service.public DeleteTrustResult deleteTrust(DeleteTrustRequest request)
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
deleteTrust in interface AWSDirectoryServicedeleteTrustRequest - Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and
the external domain.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 Directory Service.UnsupportedOperationException - The operation is not supported.public DeregisterCertificateResult deregisterCertificate(DeregisterCertificateRequest request)
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
deregisterCertificate in interface AWSDirectoryServicederegisterCertificateRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.CertificateDoesNotExistException - The certificate is not present in the system for describe or deregister activities.CertificateInUseException - The certificate is being used for the LDAP security connection and cannot be removed without disabling
LDAP security.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public DeregisterEventTopicResult deregisterEventTopic(DeregisterEventTopicRequest request)
Removes the specified directory as a publisher to the specified Amazon SNS topic.
deregisterEventTopic in interface AWSDirectoryServicederegisterEventTopicRequest - Removes the specified directory as a publisher to the specified Amazon SNS topic.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 Directory Service.public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
Displays information about the certificate registered for secure LDAP or client certificate authentication.
describeCertificate in interface AWSDirectoryServicedescribeCertificateRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.CertificateDoesNotExistException - The certificate is not present in the system for describe or deregister activities.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public DescribeClientAuthenticationSettingsResult describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest request)
Retrieves information about the type of client authentication for the specified directory, if the type is
specified. If no type is specified, information about all client authentication types that are supported for the
specified directory is retrieved. Currently, only SmartCard is supported.
describeClientAuthenticationSettings in interface AWSDirectoryServicedescribeClientAuthenticationSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.AccessDeniedException - Client authentication is not available in this region at this time.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public DescribeConditionalForwardersResult describeConditionalForwarders(DescribeConditionalForwardersRequest request)
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.
describeConditionalForwarders in interface AWSDirectoryServicedescribeConditionalForwardersRequest - Describes a conditional forwarder.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 Directory Service.public DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest request)
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.
describeDirectories in interface AWSDirectoryServicedescribeDirectoriesRequest - Contains the inputs for the DescribeDirectories operation.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 Directory Service.public DescribeDirectoriesResult describeDirectories()
AWSDirectoryServicedescribeDirectories in interface AWSDirectoryServiceAWSDirectoryService.describeDirectories(DescribeDirectoriesRequest)public DescribeDomainControllersResult describeDomainControllers(DescribeDomainControllersRequest request)
Provides information about any domain controllers in your directory.
describeDomainControllers in interface AWSDirectoryServicedescribeDomainControllersRequest - 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 Directory Service.UnsupportedOperationException - The operation is not supported.public DescribeEventTopicsResult describeEventTopics(DescribeEventTopicsRequest request)
Obtains information about which Amazon 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.
describeEventTopics in interface AWSDirectoryServicedescribeEventTopicsRequest - Describes event topics.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 Directory Service.public DescribeLDAPSSettingsResult describeLDAPSSettings(DescribeLDAPSSettingsRequest request)
Describes the status of LDAP security for the specified directory.
describeLDAPSSettings in interface AWSDirectoryServicedescribeLDAPSSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.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 Directory Service.public DescribeRegionsResult describeRegions(DescribeRegionsRequest request)
Provides information about the Regions that are configured for multi-Region replication.
describeRegions in interface AWSDirectoryServicedescribeRegionsRequest - InvalidParameterException - One or more parameters are not valid.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidNextTokenException - The NextToken value is not valid.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public DescribeSettingsResult describeSettings(DescribeSettingsRequest request)
Retrieves information about the configurable settings for the specified directory.
describeSettings in interface AWSDirectoryServicedescribeSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.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 Directory Service.public DescribeSharedDirectoriesResult describeSharedDirectories(DescribeSharedDirectoriesRequest request)
Returns the shared directories in your account.
describeSharedDirectories in interface AWSDirectoryServicedescribeSharedDirectoriesRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidNextTokenException - The NextToken value is not valid.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 Directory Service.public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
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.
describeSnapshots in interface AWSDirectoryServicedescribeSnapshotsRequest - Contains the inputs for the DescribeSnapshots operation.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 Directory Service.public DescribeSnapshotsResult describeSnapshots()
AWSDirectoryServicedescribeSnapshots in interface AWSDirectoryServiceAWSDirectoryService.describeSnapshots(DescribeSnapshotsRequest)public DescribeTrustsResult describeTrusts(DescribeTrustsRequest request)
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.
describeTrusts in interface AWSDirectoryServicedescribeTrustsRequest - Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters
are provided, such as directory ID or trust ID, this request describes all the trust relationships.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 Directory Service.UnsupportedOperationException - The operation is not supported.public DescribeUpdateDirectoryResult describeUpdateDirectory(DescribeUpdateDirectoryRequest request)
Describes the updates of a directory for a particular update type.
describeUpdateDirectory in interface AWSDirectoryServicedescribeUpdateDirectoryRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.InvalidParameterException - One or more parameters are not valid.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.InvalidNextTokenException - The NextToken value is not valid.public DisableClientAuthenticationResult disableClientAuthentication(DisableClientAuthenticationRequest request)
Disables alternative client authentication methods for the specified directory.
disableClientAuthentication in interface AWSDirectoryServicedisableClientAuthenticationRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidClientAuthStatusException - Client authentication is already enabled.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public DisableLDAPSResult disableLDAPS(DisableLDAPSRequest request)
Deactivates LDAP secure calls for the specified directory.
disableLDAPS in interface AWSDirectoryServicedisableLDAPSRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.InvalidLDAPSStatusException - The LDAP activities could not be performed because they are limited by the LDAPS status.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public DisableRadiusResult disableRadius(DisableRadiusRequest request)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
disableRadius in interface AWSDirectoryServicedisableRadiusRequest - Contains the inputs for the DisableRadius operation.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public DisableSsoResult disableSso(DisableSsoRequest request)
Disables single-sign on for a directory.
disableSso in interface AWSDirectoryServicedisableSsoRequest - Contains the inputs for the DisableSso operation.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 Directory Service.public EnableClientAuthenticationResult enableClientAuthentication(EnableClientAuthenticationRequest request)
Enables alternative client authentication methods for the specified directory.
enableClientAuthentication in interface AWSDirectoryServiceenableClientAuthenticationRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidClientAuthStatusException - Client authentication is already enabled.AccessDeniedException - Client authentication is not available in this region at this time.NoAvailableCertificateException - Client authentication setup could not be completed because at least one valid certificate must be
registered in the system.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public EnableLDAPSResult enableLDAPS(EnableLDAPSRequest request)
Activates the switch for the specific directory to always use LDAP secure calls.
enableLDAPS in interface AWSDirectoryServiceenableLDAPSRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.NoAvailableCertificateException - Client authentication setup could not be completed because at least one valid certificate must be
registered in the system.InvalidLDAPSStatusException - The LDAP activities could not be performed because they are limited by the LDAPS status.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public EnableRadiusResult enableRadius(EnableRadiusRequest request)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
enableRadius in interface AWSDirectoryServiceenableRadiusRequest - Contains the inputs for the EnableRadius operation.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 Directory Service.public EnableSsoResult enableSso(EnableSsoRequest request)
Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
enableSso in interface AWSDirectoryServiceenableSsoRequest - Contains the inputs for the EnableSso operation.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 Directory Service.public GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest request)
Obtains directory limit information for the current Region.
getDirectoryLimits in interface AWSDirectoryServicegetDirectoryLimitsRequest - Contains the inputs for the GetDirectoryLimits operation.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public GetDirectoryLimitsResult getDirectoryLimits()
AWSDirectoryServicegetDirectoryLimits in interface AWSDirectoryServiceAWSDirectoryService.getDirectoryLimits(GetDirectoryLimitsRequest)public GetSnapshotLimitsResult getSnapshotLimits(GetSnapshotLimitsRequest request)
Obtains the manual snapshot limits for a directory.
getSnapshotLimits in interface AWSDirectoryServicegetSnapshotLimitsRequest - Contains the inputs for the GetSnapshotLimits operation.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public ListCertificatesResult listCertificates(ListCertificatesRequest request)
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
listCertificates in interface AWSDirectoryServicelistCertificatesRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.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 Directory Service.public ListIpRoutesResult listIpRoutes(ListIpRoutesRequest request)
Lists the address blocks that you have added to a directory.
listIpRoutes in interface AWSDirectoryServicelistIpRoutesRequest - 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 Directory Service.public ListLogSubscriptionsResult listLogSubscriptions(ListLogSubscriptionsRequest request)
Lists the active log subscriptions for the Amazon Web Services account.
listLogSubscriptions in interface AWSDirectoryServicelistLogSubscriptionsRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidNextTokenException - The NextToken value is not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public ListSchemaExtensionsResult listSchemaExtensions(ListSchemaExtensionsRequest request)
Lists all schema extensions applied to a Microsoft AD Directory.
listSchemaExtensions in interface AWSDirectoryServicelistSchemaExtensionsRequest - InvalidNextTokenException - The NextToken value is not valid.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all tags on a directory.
listTagsForResource in interface AWSDirectoryServicelistTagsForResourceRequest - 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 Directory Service.public RegisterCertificateResult registerCertificate(RegisterCertificateRequest request)
Registers a certificate for a secure LDAP or client certificate authentication.
registerCertificate in interface AWSDirectoryServiceregisterCertificateRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.InvalidCertificateException - The certificate PEM that was provided has incorrect encoding.CertificateLimitExceededException - The certificate could not be added because the certificate limit has been reached.CertificateAlreadyExistsException - The certificate has already been registered into the system.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public RegisterEventTopicResult registerEventTopic(RegisterEventTopicRequest request)
Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon 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.
registerEventTopic in interface AWSDirectoryServiceregisterEventTopicRequest - Registers a new event topic.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 Directory Service.public RejectSharedDirectoryResult rejectSharedDirectory(RejectSharedDirectoryRequest request)
Rejects a directory sharing request that was sent from the directory owner account.
rejectSharedDirectory in interface AWSDirectoryServicerejectSharedDirectoryRequest - InvalidParameterException - One or more parameters are not valid.EntityDoesNotExistException - The specified entity could not be found.DirectoryAlreadySharedException - The specified directory has already been shared with this Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public RemoveIpRoutesResult removeIpRoutes(RemoveIpRoutesRequest request)
Removes IP address blocks from a directory.
removeIpRoutes in interface AWSDirectoryServiceremoveIpRoutesRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.DirectoryUnavailableException - The specified directory is unavailable or could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public RemoveRegionResult removeRegion(RemoveRegionRequest request)
Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary
Region with this operation. Instead, use the DeleteDirectory API.
removeRegion in interface AWSDirectoryServiceremoveRegionRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes tags from a directory.
removeTagsFromResource in interface AWSDirectoryServiceremoveTagsFromResourceRequest - 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 Directory Service.public ResetUserPasswordResult resetUserPassword(ResetUserPasswordRequest request)
Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
You can reset the password for any user in your directory with the following exceptions:
For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.
For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.
resetUserPassword in interface AWSDirectoryServiceresetUserPasswordRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.UserDoesNotExistException - The user provided a username that does not exist in your directory.InvalidPasswordException - The new password provided by the user does not meet the password complexity requirements defined in your
directory.UnsupportedOperationException - The operation is not supported.EntityDoesNotExistException - The specified entity could not be found.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest request)
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.
restoreFromSnapshot in interface AWSDirectoryServicerestoreFromSnapshotRequest - An object representing the inputs for the RestoreFromSnapshot operation.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 Directory Service.public ShareDirectoryResult shareDirectory(ShareDirectoryRequest request)
Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner)
with another Amazon Web Services account (directory consumer). With this operation you can use your directory
from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.
The ShareMethod parameter determines whether the specified directory can be shared between Amazon
Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also
determines whether you can share the directory with any other Amazon Web Services account either inside or
outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory
sharing request to the directory consumer.
shareDirectory in interface AWSDirectoryServiceshareDirectoryRequest - DirectoryAlreadySharedException - The specified directory has already been shared with this Amazon Web Services account.EntityDoesNotExistException - The specified entity could not be found.InvalidTargetException - The specified shared target is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ShareLimitExceededException - The maximum number of Amazon Web Services accounts that you can share with this directory has been
reached.OrganizationsException - Exception encountered while trying to access your Amazon Web Services organization.AccessDeniedException - Client authentication is not available in this region at this time.UnsupportedOperationException - The operation is not supported.ServiceException - An exception has occurred in Directory Service.public StartSchemaExtensionResult startSchemaExtension(StartSchemaExtensionRequest request)
Applies a schema extension to a Microsoft AD directory.
startSchemaExtension in interface AWSDirectoryServicestartSchemaExtensionRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.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 Directory Service.public UnshareDirectoryResult unshareDirectory(UnshareDirectoryRequest request)
Stops the directory sharing between the directory owner and consumer accounts.
unshareDirectory in interface AWSDirectoryServiceunshareDirectoryRequest - EntityDoesNotExistException - The specified entity could not be found.InvalidTargetException - The specified shared target is not valid.DirectoryNotSharedException - The specified directory has not been shared with this Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public UpdateConditionalForwarderResult updateConditionalForwarder(UpdateConditionalForwarderRequest request)
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
updateConditionalForwarder in interface AWSDirectoryServiceupdateConditionalForwarderRequest - Updates a conditional forwarder.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 Directory Service.public UpdateDirectorySetupResult updateDirectorySetup(UpdateDirectorySetupRequest request)
Updates the directory for a particular update type.
updateDirectorySetup in interface AWSDirectoryServiceupdateDirectorySetupRequest - UnsupportedOperationException - The operation is not supported.DirectoryInDesiredStateException - The directory is already updated to desired update type settings.DirectoryUnavailableException - The specified directory is unavailable or could not be found.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.InvalidParameterException - One or more parameters are not valid.DirectoryDoesNotExistException - The specified directory does not exist in the system.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public UpdateNumberOfDomainControllersResult updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest request)
Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
updateNumberOfDomainControllers in interface AWSDirectoryServiceupdateNumberOfDomainControllersRequest - EntityDoesNotExistException - The specified entity could not be found.DirectoryUnavailableException - The specified directory is unavailable or could not be found.DomainControllerLimitExceededException - The maximum allowed number of domain controllers per directory was exceeded. The default limit per
directory is 20 domain controllers.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 Directory Service.public UpdateRadiusResult updateRadius(UpdateRadiusRequest request)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
updateRadius in interface AWSDirectoryServiceupdateRadiusRequest - Contains the inputs for the UpdateRadius operation.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 Directory Service.public UpdateSettingsResult updateSettings(UpdateSettingsRequest request)
Updates the configurable settings for the specified directory.
updateSettings in interface AWSDirectoryServiceupdateSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.DirectoryUnavailableException - The specified directory is unavailable or could not be found.IncompatibleSettingsException - The specified directory setting is not compatible with other settings.UnsupportedSettingsException - The specified directory setting is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.public UpdateTrustResult updateTrust(UpdateTrustRequest request)
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
updateTrust in interface AWSDirectoryServiceupdateTrustRequest - 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 Directory Service.public VerifyTrustResult verifyTrust(VerifyTrustRequest request)
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.
verifyTrust in interface AWSDirectoryServiceverifyTrustRequest - Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and
an external domain.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 Directory Service.UnsupportedOperationException - The operation is not supported.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AWSDirectoryServicerequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSDirectoryServiceshutdown in class AmazonWebServiceClient