@Generated(value="software.amazon.awssdk:codegen") public interface DirectoryClient extends SdkClient
builder()
method.
AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
AWS 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 AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AcceptSharedDirectoryResponse |
acceptSharedDirectory(AcceptSharedDirectoryRequest acceptSharedDirectoryRequest)
Accepts a directory sharing request that was sent from the directory owner account.
|
default AcceptSharedDirectoryResponse |
acceptSharedDirectory(Consumer<AcceptSharedDirectoryRequest.Builder> acceptSharedDirectoryRequest)
Accepts a directory sharing request that was sent from the directory owner account.
|
default AddIpRoutesResponse |
addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)
If the DNS server for your on-premises 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.
|
default AddIpRoutesResponse |
addIpRoutes(Consumer<AddIpRoutesRequest.Builder> addIpRoutesRequest)
If the DNS server for your on-premises 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.
|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified directory.
|
default AddTagsToResourceResponse |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified directory.
|
static DirectoryClientBuilder |
builder()
Create a builder that can be used to configure and create a
DirectoryClient . |
default CancelSchemaExtensionResponse |
cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest)
Cancels an in-progress schema extension to a Microsoft AD directory.
|
default CancelSchemaExtensionResponse |
cancelSchemaExtension(Consumer<CancelSchemaExtensionRequest.Builder> cancelSchemaExtensionRequest)
Cancels an in-progress schema extension to a Microsoft AD directory.
|
default ConnectDirectoryResponse |
connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)
Creates an AD Connector to connect to an on-premises directory.
|
default ConnectDirectoryResponse |
connectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest)
Creates an AD Connector to connect to an on-premises directory.
|
static DirectoryClient |
create()
Create a
DirectoryClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateAliasResponse |
createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Creates an alias for a directory and assigns the alias to the directory.
|
default CreateAliasResponse |
createAlias(CreateAliasRequest createAliasRequest)
Creates an alias for a directory and assigns the alias to the directory.
|
default CreateComputerResponse |
createComputer(Consumer<CreateComputerRequest.Builder> createComputerRequest)
Creates a computer account in the specified directory, and joins the computer to the directory.
|
default CreateComputerResponse |
createComputer(CreateComputerRequest createComputerRequest)
Creates a computer account in the specified directory, and joins the computer to the directory.
|
default CreateConditionalForwarderResponse |
createConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest)
Creates a conditional forwarder associated with your AWS directory.
|
default CreateConditionalForwarderResponse |
createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)
Creates a conditional forwarder associated with your AWS directory.
|
default CreateDirectoryResponse |
createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest)
Creates a Simple AD directory.
|
default CreateDirectoryResponse |
createDirectory(CreateDirectoryRequest createDirectoryRequest)
Creates a Simple AD directory.
|
default CreateLogSubscriptionResponse |
createLogSubscription(Consumer<CreateLogSubscriptionRequest.Builder> createLogSubscriptionRequest)
Creates a subscription to forward real time Directory Service domain controller security logs to the specified
CloudWatch log group in your AWS account.
|
default CreateLogSubscriptionResponse |
createLogSubscription(CreateLogSubscriptionRequest createLogSubscriptionRequest)
Creates a subscription to forward real time Directory Service domain controller security logs to the specified
CloudWatch log group in your AWS account.
|
default CreateMicrosoftAdResponse |
createMicrosoftAD(Consumer<CreateMicrosoftAdRequest.Builder> createMicrosoftAdRequest)
Creates an AWS Managed Microsoft AD directory.
|
default CreateMicrosoftAdResponse |
createMicrosoftAD(CreateMicrosoftAdRequest createMicrosoftAdRequest)
Creates an AWS Managed Microsoft AD directory.
|
default CreateSnapshotResponse |
createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
|
default CreateSnapshotResponse |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
|
default CreateTrustResponse |
createTrust(Consumer<CreateTrustRequest.Builder> createTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.
|
default CreateTrustResponse |
createTrust(CreateTrustRequest createTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships.
|
default DeleteConditionalForwarderResponse |
deleteConditionalForwarder(Consumer<DeleteConditionalForwarderRequest.Builder> deleteConditionalForwarderRequest)
Deletes a conditional forwarder that has been set up for your AWS directory.
|
default DeleteConditionalForwarderResponse |
deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)
Deletes a conditional forwarder that has been set up for your AWS directory.
|
default DeleteDirectoryResponse |
deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest)
Deletes an AWS Directory Service directory.
|
default DeleteDirectoryResponse |
deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes an AWS Directory Service directory.
|
default DeleteLogSubscriptionResponse |
deleteLogSubscription(Consumer<DeleteLogSubscriptionRequest.Builder> deleteLogSubscriptionRequest)
Deletes the specified log subscription.
|
default DeleteLogSubscriptionResponse |
deleteLogSubscription(DeleteLogSubscriptionRequest deleteLogSubscriptionRequest)
Deletes the specified log subscription.
|
default DeleteSnapshotResponse |
deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)
Deletes a directory snapshot.
|
default DeleteSnapshotResponse |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes a directory snapshot.
|
default DeleteTrustResponse |
deleteTrust(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest)
Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
|
default DeleteTrustResponse |
deleteTrust(DeleteTrustRequest deleteTrustRequest)
Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
|
default DeregisterEventTopicResponse |
deregisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified SNS topic.
|
default DeregisterEventTopicResponse |
deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified SNS topic.
|
default DescribeConditionalForwardersResponse |
describeConditionalForwarders(Consumer<DescribeConditionalForwardersRequest.Builder> describeConditionalForwardersRequest)
Obtains information about the conditional forwarders for this account.
|
default DescribeConditionalForwardersResponse |
describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)
Obtains information about the conditional forwarders for this account.
|
default DescribeDirectoriesResponse |
describeDirectories()
Obtains information about the directories that belong to this account.
|
default DescribeDirectoriesResponse |
describeDirectories(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest)
Obtains information about the directories that belong to this account.
|
default DescribeDirectoriesResponse |
describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)
Obtains information about the directories that belong to this account.
|
default DescribeDomainControllersResponse |
describeDomainControllers(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest)
Provides information about any domain controllers in your directory.
|
default DescribeDomainControllersResponse |
describeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest)
Provides information about any domain controllers in your directory.
|
default DescribeDomainControllersIterable |
describeDomainControllersPaginator(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest)
Provides information about any domain controllers in your directory.
|
default DescribeDomainControllersIterable |
describeDomainControllersPaginator(DescribeDomainControllersRequest describeDomainControllersRequest)
Provides information about any domain controllers in your directory.
|
default DescribeEventTopicsResponse |
describeEventTopics()
Obtains information about which SNS topics receive status messages from the specified directory.
|
default DescribeEventTopicsResponse |
describeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest)
Obtains information about which SNS topics receive status messages from the specified directory.
|
default DescribeEventTopicsResponse |
describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)
Obtains information about which SNS topics receive status messages from the specified directory.
|
default DescribeSharedDirectoriesResponse |
describeSharedDirectories(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest)
Returns the shared directories in your account.
|
default DescribeSharedDirectoriesResponse |
describeSharedDirectories(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest)
Returns the shared directories in your account.
|
default DescribeSnapshotsResponse |
describeSnapshots()
Obtains information about the directory snapshots that belong to this account.
|
default DescribeSnapshotsResponse |
describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)
Obtains information about the directory snapshots that belong to this account.
|
default DescribeSnapshotsResponse |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
Obtains information about the directory snapshots that belong to this account.
|
default DescribeTrustsResponse |
describeTrusts()
Obtains information about the trust relationships for this account.
|
default DescribeTrustsResponse |
describeTrusts(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest)
Obtains information about the trust relationships for this account.
|
default DescribeTrustsResponse |
describeTrusts(DescribeTrustsRequest describeTrustsRequest)
Obtains information about the trust relationships for this account.
|
default DisableRadiusResponse |
disableRadius(Consumer<DisableRadiusRequest.Builder> disableRadiusRequest)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server
for an AD Connector or Microsoft AD directory.
|
default DisableRadiusResponse |
disableRadius(DisableRadiusRequest disableRadiusRequest)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server
for an AD Connector or Microsoft AD directory.
|
default DisableSsoResponse |
disableSso(Consumer<DisableSsoRequest.Builder> disableSsoRequest)
Disables single-sign on for a directory.
|
default DisableSsoResponse |
disableSso(DisableSsoRequest disableSsoRequest)
Disables single-sign on for a directory.
|
default EnableRadiusResponse |
enableRadius(Consumer<EnableRadiusRequest.Builder> enableRadiusRequest)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for
an AD Connector or Microsoft AD directory.
|
default EnableRadiusResponse |
enableRadius(EnableRadiusRequest enableRadiusRequest)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for
an AD Connector or Microsoft AD directory.
|
default EnableSsoResponse |
enableSso(Consumer<EnableSsoRequest.Builder> enableSsoRequest)
Enables single sign-on for a directory.
|
default EnableSsoResponse |
enableSso(EnableSsoRequest enableSsoRequest)
Enables single sign-on for a directory.
|
default GetDirectoryLimitsResponse |
getDirectoryLimits()
Obtains directory limit information for the current region.
|
default GetDirectoryLimitsResponse |
getDirectoryLimits(Consumer<GetDirectoryLimitsRequest.Builder> getDirectoryLimitsRequest)
Obtains directory limit information for the current region.
|
default GetDirectoryLimitsResponse |
getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)
Obtains directory limit information for the current region.
|
default GetSnapshotLimitsResponse |
getSnapshotLimits(Consumer<GetSnapshotLimitsRequest.Builder> getSnapshotLimitsRequest)
Obtains the manual snapshot limits for a directory.
|
default GetSnapshotLimitsResponse |
getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)
Obtains the manual snapshot limits for a directory.
|
default ListIpRoutesResponse |
listIpRoutes(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest)
Lists the address blocks that you have added to a directory.
|
default ListIpRoutesResponse |
listIpRoutes(ListIpRoutesRequest listIpRoutesRequest)
Lists the address blocks that you have added to a directory.
|
default ListLogSubscriptionsResponse |
listLogSubscriptions()
Lists the active log subscriptions for the AWS account.
|
default ListLogSubscriptionsResponse |
listLogSubscriptions(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest)
Lists the active log subscriptions for the AWS account.
|
default ListLogSubscriptionsResponse |
listLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest)
Lists the active log subscriptions for the AWS account.
|
default ListSchemaExtensionsResponse |
listSchemaExtensions(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest)
Lists all schema extensions applied to a Microsoft AD Directory.
|
default ListSchemaExtensionsResponse |
listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest)
Lists all schema extensions applied to a Microsoft AD Directory.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on a directory.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on a directory.
|
default RegisterEventTopicResponse |
registerEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest)
Associates a directory with an SNS topic.
|
default RegisterEventTopicResponse |
registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)
Associates a directory with an SNS topic.
|
default RejectSharedDirectoryResponse |
rejectSharedDirectory(Consumer<RejectSharedDirectoryRequest.Builder> rejectSharedDirectoryRequest)
Rejects a directory sharing request that was sent from the directory owner account.
|
default RejectSharedDirectoryResponse |
rejectSharedDirectory(RejectSharedDirectoryRequest rejectSharedDirectoryRequest)
Rejects a directory sharing request that was sent from the directory owner account.
|
default RemoveIpRoutesResponse |
removeIpRoutes(Consumer<RemoveIpRoutesRequest.Builder> removeIpRoutesRequest)
Removes IP address blocks from a directory.
|
default RemoveIpRoutesResponse |
removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest)
Removes IP address blocks from a directory.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes tags from a directory.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tags from a directory.
|
default ResetUserPasswordResponse |
resetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest)
Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.
|
default ResetUserPasswordResponse |
resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest)
Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.
|
default RestoreFromSnapshotResponse |
restoreFromSnapshot(Consumer<RestoreFromSnapshotRequest.Builder> restoreFromSnapshotRequest)
Restores a directory using an existing directory snapshot.
|
default RestoreFromSnapshotResponse |
restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)
Restores a directory using an existing directory snapshot.
|
static ServiceMetadata |
serviceMetadata() |
default ShareDirectoryResponse |
shareDirectory(Consumer<ShareDirectoryRequest.Builder> shareDirectoryRequest)
Shares a specified directory (
DirectoryId ) in your AWS account (directory owner) with another AWS
account (directory consumer). |
default ShareDirectoryResponse |
shareDirectory(ShareDirectoryRequest shareDirectoryRequest)
Shares a specified directory (
DirectoryId ) in your AWS account (directory owner) with another AWS
account (directory consumer). |
default StartSchemaExtensionResponse |
startSchemaExtension(Consumer<StartSchemaExtensionRequest.Builder> startSchemaExtensionRequest)
Applies a schema extension to a Microsoft AD directory.
|
default StartSchemaExtensionResponse |
startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest)
Applies a schema extension to a Microsoft AD directory.
|
default UnshareDirectoryResponse |
unshareDirectory(Consumer<UnshareDirectoryRequest.Builder> unshareDirectoryRequest)
Stops the directory sharing between the directory owner and consumer accounts.
|
default UnshareDirectoryResponse |
unshareDirectory(UnshareDirectoryRequest unshareDirectoryRequest)
Stops the directory sharing between the directory owner and consumer accounts.
|
default UpdateConditionalForwarderResponse |
updateConditionalForwarder(Consumer<UpdateConditionalForwarderRequest.Builder> updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your AWS directory.
|
default UpdateConditionalForwarderResponse |
updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your AWS directory.
|
default UpdateNumberOfDomainControllersResponse |
updateNumberOfDomainControllers(Consumer<UpdateNumberOfDomainControllersRequest.Builder> updateNumberOfDomainControllersRequest)
Adds or removes domain controllers to or from the directory.
|
default UpdateNumberOfDomainControllersResponse |
updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest)
Adds or removes domain controllers to or from the directory.
|
default UpdateRadiusResponse |
updateRadius(Consumer<UpdateRadiusRequest.Builder> updateRadiusRequest)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or
Microsoft AD directory.
|
default UpdateRadiusResponse |
updateRadius(UpdateRadiusRequest updateRadiusRequest)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or
Microsoft AD directory.
|
default UpdateTrustResponse |
updateTrust(Consumer<UpdateTrustRequest.Builder> updateTrustRequest)
Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active
Directory.
|
default UpdateTrustResponse |
updateTrust(UpdateTrustRequest updateTrustRequest)
Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active
Directory.
|
default VerifyTrustResponse |
verifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
|
default VerifyTrustResponse |
verifyTrust(VerifyTrustRequest verifyTrustRequest)
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
|
serviceName
close
static final String SERVICE_NAME
static DirectoryClient create()
DirectoryClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static DirectoryClientBuilder builder()
DirectoryClient
.default AcceptSharedDirectoryResponse acceptSharedDirectory(AcceptSharedDirectoryRequest acceptSharedDirectoryRequest) throws InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadySharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Accepts a directory sharing request that was sent from the directory owner account.
acceptSharedDirectoryRequest
- 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 AWS account.ClientException
- A client exception has occurred.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AcceptSharedDirectoryResponse acceptSharedDirectory(Consumer<AcceptSharedDirectoryRequest.Builder> acceptSharedDirectoryRequest) throws InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadySharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Accepts a directory sharing request that was sent from the directory owner account.
This is a convenience which creates an instance of the AcceptSharedDirectoryRequest.Builder
avoiding the
need to create one manually via AcceptSharedDirectoryRequest.builder()
acceptSharedDirectoryRequest
- A Consumer
that will call methods on AcceptSharedDirectoryRequest.Builder
to create a
request.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 AWS account.ClientException
- A client exception has occurred.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddIpRoutesResponse addIpRoutes(AddIpRoutesRequest addIpRoutesRequest) throws EntityDoesNotExistException, EntityAlreadyExistsException, InvalidParameterException, DirectoryUnavailableException, IpRouteLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
If the DNS server for your on-premises 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 AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
addIpRoutesRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddIpRoutesResponse addIpRoutes(Consumer<AddIpRoutesRequest.Builder> addIpRoutesRequest) throws EntityDoesNotExistException, EntityAlreadyExistsException, InvalidParameterException, DirectoryUnavailableException, IpRouteLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
If the DNS server for your on-premises 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 AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the AddIpRoutesRequest.Builder
avoiding the need to
create one manually via AddIpRoutesRequest.builder()
addIpRoutesRequest
- A Consumer
that will call methods on AddIpRoutesRequest.Builder
to create a request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws EntityDoesNotExistException, InvalidParameterException, TagLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
addTagsToResourceRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws EntityDoesNotExistException, InvalidParameterException, TagLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder
avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest
- A Consumer
that will call methods on AddTagsToResourceRequest.Builder
to create a request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CancelSchemaExtensionResponse cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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
.
cancelSchemaExtensionRequest
- EntityDoesNotExistException
- The specified entity could not be found.ClientException
- A client exception has occurred.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CancelSchemaExtensionResponse cancelSchemaExtension(Consumer<CancelSchemaExtensionRequest.Builder> cancelSchemaExtensionRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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
.
This is a convenience which creates an instance of the CancelSchemaExtensionRequest.Builder
avoiding the
need to create one manually via CancelSchemaExtensionRequest.builder()
cancelSchemaExtensionRequest
- A Consumer
that will call methods on CancelSchemaExtensionRequest.Builder
to create a
request.EntityDoesNotExistException
- The specified entity could not be found.ClientException
- A client exception has occurred.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ConnectDirectoryResponse connectDirectory(ConnectDirectoryRequest connectDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an AD Connector to connect to an on-premises 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
connectDirectoryRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ConnectDirectoryResponse connectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an AD Connector to connect to an on-premises 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the ConnectDirectoryRequest.Builder
avoiding the need
to create one manually via ConnectDirectoryRequest.builder()
connectDirectoryRequest
- A Consumer
that will call methods on ConnectDirectoryRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
createAliasRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAliasResponse createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the CreateAliasRequest.Builder
avoiding the need to
create one manually via CreateAliasRequest.builder()
createAliasRequest
- A Consumer
that will call methods on CreateAliasRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateComputerResponse createComputer(CreateComputerRequest createComputerRequest) throws AuthenticationFailedException, DirectoryUnavailableException, EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a computer account in the specified directory, and joins the computer to the directory.
createComputerRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default CreateComputerResponse createComputer(Consumer<CreateComputerRequest.Builder> createComputerRequest) throws AuthenticationFailedException, DirectoryUnavailableException, EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a computer account in the specified directory, and joins the computer to the directory.
This is a convenience which creates an instance of the CreateComputerRequest.Builder
avoiding the need to
create one manually via CreateComputerRequest.builder()
createComputerRequest
- A Consumer
that will call methods on CreateComputerRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default CreateConditionalForwarderResponse createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default CreateConditionalForwarderResponse createConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the CreateConditionalForwarderRequest.Builder
avoiding
the need to create one manually via CreateConditionalForwarderRequest.builder()
createConditionalForwarderRequest
- A Consumer
that will call methods on CreateConditionalForwarderRequest.Builder
to create a
request. 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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default CreateDirectoryResponse createDirectory(CreateDirectoryRequest createDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a Simple AD directory.
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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
createDirectoryRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDirectoryResponse createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a Simple AD directory.
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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the CreateDirectoryRequest.Builder
avoiding the need
to create one manually via CreateDirectoryRequest.builder()
createDirectoryRequest
- A Consumer
that will call methods on CreateDirectoryRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateLogSubscriptionResponse createLogSubscription(CreateLogSubscriptionRequest createLogSubscriptionRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, UnsupportedOperationException, InsufficientPermissionsException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a subscription to forward real time Directory Service domain controller security logs to the specified CloudWatch log group in your AWS account.
createLogSubscriptionRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default CreateLogSubscriptionResponse createLogSubscription(Consumer<CreateLogSubscriptionRequest.Builder> createLogSubscriptionRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, UnsupportedOperationException, InsufficientPermissionsException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a subscription to forward real time Directory Service domain controller security logs to the specified CloudWatch log group in your AWS account.
This is a convenience which creates an instance of the CreateLogSubscriptionRequest.Builder
avoiding the
need to create one manually via CreateLogSubscriptionRequest.builder()
createLogSubscriptionRequest
- A Consumer
that will call methods on CreateLogSubscriptionRequest.Builder
to create a
request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default CreateMicrosoftAdResponse createMicrosoftAD(CreateMicrosoftAdRequest createMicrosoftAdRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Creates an AWS Managed Microsoft AD directory.
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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
createMicrosoftAdRequest
- Creates an AWS 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 AWS Directory Service.UnsupportedOperationException
- The operation is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default CreateMicrosoftAdResponse createMicrosoftAD(Consumer<CreateMicrosoftAdRequest.Builder> createMicrosoftAdRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Creates an AWS Managed Microsoft AD directory.
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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the CreateMicrosoftAdRequest.Builder
avoiding the need
to create one manually via CreateMicrosoftAdRequest.builder()
createMicrosoftAdRequest
- A Consumer
that will call methods on CreateMicrosoftADRequest.Builder
to create a request.
Creates an AWS 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 AWS Directory Service.UnsupportedOperationException
- The operation is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, SnapshotLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
You cannot take snapshots of AD Connector directories.
createSnapshotRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateSnapshotResponse createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, SnapshotLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
You cannot take snapshots of AD Connector directories.
This is a convenience which creates an instance of the CreateSnapshotRequest.Builder
avoiding the need to
create one manually via CreateSnapshotRequest.builder()
createSnapshotRequest
- A Consumer
that will call methods on CreateSnapshotRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateTrustResponse createTrust(CreateTrustRequest createTrustRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, 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 an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
createTrustRequest
- AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For
example, you can establish a trust between your AWS Managed Microsoft AD directory, 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 an AWS 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 AWS Directory Service.UnsupportedOperationException
- The operation is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default CreateTrustResponse createTrust(Consumer<CreateTrustRequest.Builder> createTrustRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, 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 an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
This is a convenience which creates an instance of the CreateTrustRequest.Builder
avoiding the need to
create one manually via CreateTrustRequest.builder()
createTrustRequest
- A Consumer
that will call methods on CreateTrustRequest.Builder
to create a request. AWS
Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example,
you can establish a trust between your AWS Managed Microsoft AD directory, 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 an AWS 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 AWS Directory Service.UnsupportedOperationException
- The operation is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DeleteConditionalForwarderResponse deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes a conditional forwarder that has been set up for your AWS directory.
deleteConditionalForwarderRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DeleteConditionalForwarderResponse deleteConditionalForwarder(Consumer<DeleteConditionalForwarderRequest.Builder> deleteConditionalForwarderRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes a conditional forwarder that has been set up for your AWS directory.
This is a convenience which creates an instance of the DeleteConditionalForwarderRequest.Builder
avoiding
the need to create one manually via DeleteConditionalForwarderRequest.builder()
deleteConditionalForwarderRequest
- A Consumer
that will call methods on DeleteConditionalForwarderRequest.Builder
to create a
request. 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DeleteDirectoryResponse deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes an AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
deleteDirectoryRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDirectoryResponse deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes an AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the DeleteDirectoryRequest.Builder
avoiding the need
to create one manually via DeleteDirectoryRequest.builder()
deleteDirectoryRequest
- A Consumer
that will call methods on DeleteDirectoryRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteLogSubscriptionResponse deleteLogSubscription(DeleteLogSubscriptionRequest deleteLogSubscriptionRequest) throws EntityDoesNotExistException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes the specified log subscription.
deleteLogSubscriptionRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DeleteLogSubscriptionResponse deleteLogSubscription(Consumer<DeleteLogSubscriptionRequest.Builder> deleteLogSubscriptionRequest) throws EntityDoesNotExistException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes the specified log subscription.
This is a convenience which creates an instance of the DeleteLogSubscriptionRequest.Builder
avoiding the
need to create one manually via DeleteLogSubscriptionRequest.builder()
deleteLogSubscriptionRequest
- A Consumer
that will call methods on DeleteLogSubscriptionRequest.Builder
to create a
request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes a directory snapshot.
deleteSnapshotRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSnapshotResponse deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes a directory snapshot.
This is a convenience which creates an instance of the DeleteSnapshotRequest.Builder
avoiding the need to
create one manually via DeleteSnapshotRequest.builder()
deleteSnapshotRequest
- A Consumer
that will call methods on DeleteSnapshotRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTrustResponse deleteTrust(DeleteTrustRequest deleteTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
deleteTrustRequest
- Deletes the local side of an existing trust relationship between the AWS 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 AWS Directory Service.UnsupportedOperationException
- The operation is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DeleteTrustResponse deleteTrust(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
This is a convenience which creates an instance of the DeleteTrustRequest.Builder
avoiding the need to
create one manually via DeleteTrustRequest.builder()
deleteTrustRequest
- A Consumer
that will call methods on DeleteTrustRequest.Builder
to create a request.
Deletes the local side of an existing trust relationship between the AWS 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 AWS Directory Service.UnsupportedOperationException
- The operation is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DeregisterEventTopicResponse deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes the specified directory as a publisher to the specified SNS topic.
deregisterEventTopicRequest
- Removes the specified directory as a publisher to the specified 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterEventTopicResponse deregisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes the specified directory as a publisher to the specified SNS topic.
This is a convenience which creates an instance of the DeregisterEventTopicRequest.Builder
avoiding the
need to create one manually via DeregisterEventTopicRequest.builder()
deregisterEventTopicRequest
- A Consumer
that will call methods on DeregisterEventTopicRequest.Builder
to create a
request. Removes the specified directory as a publisher to the specified 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeConditionalForwardersResponse describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
describeConditionalForwardersRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeConditionalForwardersResponse describeConditionalForwarders(Consumer<DescribeConditionalForwardersRequest.Builder> describeConditionalForwardersRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the DescribeConditionalForwardersRequest.Builder
avoiding the need to create one manually via DescribeConditionalForwardersRequest.builder()
describeConditionalForwardersRequest
- A Consumer
that will call methods on DescribeConditionalForwardersRequest.Builder
to
create a request. 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeDirectoriesResponse describeDirectories() throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDirectories(DescribeDirectoriesRequest)
,
AWS API
Documentationdefault DescribeDirectoriesResponse describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
describeDirectoriesRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDirectoriesResponse describeDirectories(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the DescribeDirectoriesRequest.Builder
avoiding the
need to create one manually via DescribeDirectoriesRequest.builder()
describeDirectoriesRequest
- A Consumer
that will call methods on DescribeDirectoriesRequest.Builder
to create a
request. 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDomainControllersResponse describeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Provides information about any domain controllers in your directory.
describeDomainControllersRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeDomainControllersResponse describeDomainControllers(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Provides information about any domain controllers in your directory.
This is a convenience which creates an instance of the DescribeDomainControllersRequest.Builder
avoiding
the need to create one manually via DescribeDomainControllersRequest.builder()
describeDomainControllersRequest
- A Consumer
that will call methods on DescribeDomainControllersRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeDomainControllersIterable describeDomainControllersPaginator(DescribeDomainControllersRequest describeDomainControllersRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Provides information about any domain controllers in your directory.
This is a variant of
describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client .describeDomainControllersPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)
operation.
describeDomainControllersRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeDomainControllersIterable describeDomainControllersPaginator(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Provides information about any domain controllers in your directory.
This is a variant of
describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client .describeDomainControllersPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)
operation.
This is a convenience which creates an instance of the DescribeDomainControllersRequest.Builder
avoiding
the need to create one manually via DescribeDomainControllersRequest.builder()
describeDomainControllersRequest
- A Consumer
that will call methods on DescribeDomainControllersRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeEventTopicsResponse describeEventTopics() throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeEventTopics(DescribeEventTopicsRequest)
,
AWS API
Documentationdefault DescribeEventTopicsResponse describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
describeEventTopicsRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEventTopicsResponse describeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the DescribeEventTopicsRequest.Builder
avoiding the
need to create one manually via DescribeEventTopicsRequest.builder()
describeEventTopicsRequest
- A Consumer
that will call methods on DescribeEventTopicsRequest.Builder
to create a
request. 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSharedDirectoriesResponse describeSharedDirectories(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Returns the shared directories in your account.
describeSharedDirectoriesRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeSharedDirectoriesResponse describeSharedDirectories(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Returns the shared directories in your account.
This is a convenience which creates an instance of the DescribeSharedDirectoriesRequest.Builder
avoiding
the need to create one manually via DescribeSharedDirectoriesRequest.builder()
describeSharedDirectoriesRequest
- A Consumer
that will call methods on DescribeSharedDirectoriesRequest.Builder
to create a
request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeSnapshotsResponse describeSnapshots() throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeSnapshots(DescribeSnapshotsRequest)
,
AWS API
Documentationdefault DescribeSnapshotsResponse describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
describeSnapshotsRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSnapshotsResponse describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder
avoiding the need
to create one manually via DescribeSnapshotsRequest.builder()
describeSnapshotsRequest
- A Consumer
that will call methods on DescribeSnapshotsRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrustsResponse describeTrusts() throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
describeTrusts(DescribeTrustsRequest)
,
AWS API
Documentationdefault DescribeTrustsResponse describeTrusts(DescribeTrustsRequest describeTrustsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
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.
describeTrustsRequest
- Describes the trust relationships for a particular AWS Managed Microsoft AD directory. If no input
parameters are 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 AWS Directory Service.UnsupportedOperationException
- The operation is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DescribeTrustsResponse describeTrusts(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the DescribeTrustsRequest.Builder
avoiding the need to
create one manually via DescribeTrustsRequest.builder()
describeTrustsRequest
- A Consumer
that will call methods on DescribeTrustsRequest.Builder
to create a request.
Describes the trust relationships for a particular AWS Managed Microsoft AD directory. If no input
parameters are 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 AWS Directory Service.UnsupportedOperationException
- The operation is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default DisableRadiusResponse disableRadius(DisableRadiusRequest disableRadiusRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
disableRadiusRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableRadiusResponse disableRadius(Consumer<DisableRadiusRequest.Builder> disableRadiusRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
This is a convenience which creates an instance of the DisableRadiusRequest.Builder
avoiding the need to
create one manually via DisableRadiusRequest.builder()
disableRadiusRequest
- A Consumer
that will call methods on DisableRadiusRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableSsoResponse disableSso(DisableSsoRequest disableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables single-sign on for a directory.
disableSsoRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableSsoResponse disableSso(Consumer<DisableSsoRequest.Builder> disableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables single-sign on for a directory.
This is a convenience which creates an instance of the DisableSsoRequest.Builder
avoiding the need to
create one manually via DisableSsoRequest.builder()
disableSsoRequest
- A Consumer
that will call methods on DisableSsoRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableRadiusResponse enableRadius(EnableRadiusRequest enableRadiusRequest) throws InvalidParameterException, EntityAlreadyExistsException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
enableRadiusRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableRadiusResponse enableRadius(Consumer<EnableRadiusRequest.Builder> enableRadiusRequest) throws InvalidParameterException, EntityAlreadyExistsException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
This is a convenience which creates an instance of the EnableRadiusRequest.Builder
avoiding the need to
create one manually via EnableRadiusRequest.builder()
enableRadiusRequest
- A Consumer
that will call methods on EnableRadiusRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableSsoResponse enableSso(EnableSsoRequest enableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables single sign-on for a directory.
enableSsoRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableSsoResponse enableSso(Consumer<EnableSsoRequest.Builder> enableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables single sign-on for a directory.
This is a convenience which creates an instance of the EnableSsoRequest.Builder
avoiding the need to
create one manually via EnableSsoRequest.builder()
enableSsoRequest
- A Consumer
that will call methods on EnableSsoRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDirectoryLimitsResponse getDirectoryLimits() throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains directory limit information for the current region.
EntityDoesNotExistException
- The specified entity could not be found.ClientException
- A client exception has occurred.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getDirectoryLimits(GetDirectoryLimitsRequest)
,
AWS API
Documentationdefault GetDirectoryLimitsResponse getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains directory limit information for the current region.
getDirectoryLimitsRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDirectoryLimitsResponse getDirectoryLimits(Consumer<GetDirectoryLimitsRequest.Builder> getDirectoryLimitsRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains directory limit information for the current region.
This is a convenience which creates an instance of the GetDirectoryLimitsRequest.Builder
avoiding the
need to create one manually via GetDirectoryLimitsRequest.builder()
getDirectoryLimitsRequest
- A Consumer
that will call methods on GetDirectoryLimitsRequest.Builder
to create a
request. 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSnapshotLimitsResponse getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains the manual snapshot limits for a directory.
getSnapshotLimitsRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSnapshotLimitsResponse getSnapshotLimits(Consumer<GetSnapshotLimitsRequest.Builder> getSnapshotLimitsRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains the manual snapshot limits for a directory.
This is a convenience which creates an instance of the GetSnapshotLimitsRequest.Builder
avoiding the need
to create one manually via GetSnapshotLimitsRequest.builder()
getSnapshotLimitsRequest
- A Consumer
that will call methods on GetSnapshotLimitsRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListIpRoutesResponse listIpRoutes(ListIpRoutesRequest listIpRoutesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the address blocks that you have added to a directory.
listIpRoutesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListIpRoutesResponse listIpRoutes(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the address blocks that you have added to a directory.
This is a convenience which creates an instance of the ListIpRoutesRequest.Builder
avoiding the need to
create one manually via ListIpRoutesRequest.builder()
listIpRoutesRequest
- A Consumer
that will call methods on ListIpRoutesRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListLogSubscriptionsResponse listLogSubscriptions() throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the active log subscriptions for the AWS account.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listLogSubscriptions(ListLogSubscriptionsRequest)
,
AWS API
Documentationdefault ListLogSubscriptionsResponse listLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the active log subscriptions for the AWS account.
listLogSubscriptionsRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListLogSubscriptionsResponse listLogSubscriptions(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the active log subscriptions for the AWS account.
This is a convenience which creates an instance of the ListLogSubscriptionsRequest.Builder
avoiding the
need to create one manually via ListLogSubscriptionsRequest.builder()
listLogSubscriptionsRequest
- A Consumer
that will call methods on ListLogSubscriptionsRequest.Builder
to create a
request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSchemaExtensionsResponse listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest) throws InvalidNextTokenException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists all schema extensions applied to a Microsoft AD Directory.
listSchemaExtensionsRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSchemaExtensionsResponse listSchemaExtensions(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest) throws InvalidNextTokenException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists all schema extensions applied to a Microsoft AD Directory.
This is a convenience which creates an instance of the ListSchemaExtensionsRequest.Builder
avoiding the
need to create one manually via ListSchemaExtensionsRequest.builder()
listSchemaExtensionsRequest
- A Consumer
that will call methods on ListSchemaExtensionsRequest.Builder
to create a
request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists all tags on a directory.
listTagsForResourceRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists all tags on a directory.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterEventTopicResponse registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
registerEventTopicRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterEventTopicResponse registerEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the RegisterEventTopicRequest.Builder
avoiding the
need to create one manually via RegisterEventTopicRequest.builder()
registerEventTopicRequest
- A Consumer
that will call methods on RegisterEventTopicRequest.Builder
to create a
request. 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RejectSharedDirectoryResponse rejectSharedDirectory(RejectSharedDirectoryRequest rejectSharedDirectoryRequest) throws InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadySharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Rejects a directory sharing request that was sent from the directory owner account.
rejectSharedDirectoryRequest
- 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 AWS account.ClientException
- A client exception has occurred.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RejectSharedDirectoryResponse rejectSharedDirectory(Consumer<RejectSharedDirectoryRequest.Builder> rejectSharedDirectoryRequest) throws InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadySharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Rejects a directory sharing request that was sent from the directory owner account.
This is a convenience which creates an instance of the RejectSharedDirectoryRequest.Builder
avoiding the
need to create one manually via RejectSharedDirectoryRequest.builder()
rejectSharedDirectoryRequest
- A Consumer
that will call methods on RejectSharedDirectoryRequest.Builder
to create a
request.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 AWS account.ClientException
- A client exception has occurred.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveIpRoutesResponse removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest) throws EntityDoesNotExistException, InvalidParameterException, DirectoryUnavailableException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes IP address blocks from a directory.
removeIpRoutesRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveIpRoutesResponse removeIpRoutes(Consumer<RemoveIpRoutesRequest.Builder> removeIpRoutesRequest) throws EntityDoesNotExistException, InvalidParameterException, DirectoryUnavailableException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes IP address blocks from a directory.
This is a convenience which creates an instance of the RemoveIpRoutesRequest.Builder
avoiding the need to
create one manually via RemoveIpRoutesRequest.builder()
removeIpRoutesRequest
- A Consumer
that will call methods on RemoveIpRoutesRequest.Builder
to create a request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes tags from a directory.
removeTagsFromResourceRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes tags from a directory.
This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder
avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest
- A Consumer
that will call methods on RemoveTagsFromResourceRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResetUserPasswordResponse resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest) throws DirectoryUnavailableException, UserDoesNotExistException, InvalidPasswordException, UnsupportedOperationException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.
resetUserPasswordRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default ResetUserPasswordResponse resetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest) throws DirectoryUnavailableException, UserDoesNotExistException, InvalidPasswordException, UnsupportedOperationException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.
This is a convenience which creates an instance of the ResetUserPasswordRequest.Builder
avoiding the need
to create one manually via ResetUserPasswordRequest.builder()
resetUserPasswordRequest
- A Consumer
that will call methods on ResetUserPasswordRequest.Builder
to create a request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default RestoreFromSnapshotResponse restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
restoreFromSnapshotRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RestoreFromSnapshotResponse restoreFromSnapshot(Consumer<RestoreFromSnapshotRequest.Builder> restoreFromSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the RestoreFromSnapshotRequest.Builder
avoiding the
need to create one manually via RestoreFromSnapshotRequest.builder()
restoreFromSnapshotRequest
- A Consumer
that will call methods on RestoreFromSnapshotRequest.Builder
to create a
request. 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ShareDirectoryResponse shareDirectory(ShareDirectoryRequest shareDirectoryRequest) throws DirectoryAlreadySharedException, EntityDoesNotExistException, InvalidTargetException, InvalidParameterException, ClientException, ShareLimitExceededException, OrganizationsException, AccessDeniedException, UnsupportedOperationException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Shares a specified directory (DirectoryId
) in your AWS account (directory owner) with another AWS
account (directory consumer). With this operation you can use your directory from any AWS account and from any
Amazon VPC within an AWS Region.
When you share your AWS Managed Microsoft AD directory, AWS 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 AWS
accounts inside the same AWS organization (ORGANIZATIONS
). It also determines whether you can share
the directory with any other AWS 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.
shareDirectoryRequest
- DirectoryAlreadySharedException
- The specified directory has already been shared with this AWS 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 AWS accounts that you can share with this directory has been reached.OrganizationsException
- Exception encountered while trying to access your AWS organization.AccessDeniedException
- You do not have sufficient access to perform this action.UnsupportedOperationException
- The operation is not supported.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default ShareDirectoryResponse shareDirectory(Consumer<ShareDirectoryRequest.Builder> shareDirectoryRequest) throws DirectoryAlreadySharedException, EntityDoesNotExistException, InvalidTargetException, InvalidParameterException, ClientException, ShareLimitExceededException, OrganizationsException, AccessDeniedException, UnsupportedOperationException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Shares a specified directory (DirectoryId
) in your AWS account (directory owner) with another AWS
account (directory consumer). With this operation you can use your directory from any AWS account and from any
Amazon VPC within an AWS Region.
When you share your AWS Managed Microsoft AD directory, AWS 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 AWS
accounts inside the same AWS organization (ORGANIZATIONS
). It also determines whether you can share
the directory with any other AWS 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.
This is a convenience which creates an instance of the ShareDirectoryRequest.Builder
avoiding the need to
create one manually via ShareDirectoryRequest.builder()
shareDirectoryRequest
- A Consumer
that will call methods on ShareDirectoryRequest.Builder
to create a request.DirectoryAlreadySharedException
- The specified directory has already been shared with this AWS 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 AWS accounts that you can share with this directory has been reached.OrganizationsException
- Exception encountered while trying to access your AWS organization.AccessDeniedException
- You do not have sufficient access to perform this action.UnsupportedOperationException
- The operation is not supported.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default StartSchemaExtensionResponse startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest) throws DirectoryUnavailableException, EntityDoesNotExistException, InvalidParameterException, SnapshotLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Applies a schema extension to a Microsoft AD directory.
startSchemaExtensionRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartSchemaExtensionResponse startSchemaExtension(Consumer<StartSchemaExtensionRequest.Builder> startSchemaExtensionRequest) throws DirectoryUnavailableException, EntityDoesNotExistException, InvalidParameterException, SnapshotLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Applies a schema extension to a Microsoft AD directory.
This is a convenience which creates an instance of the StartSchemaExtensionRequest.Builder
avoiding the
need to create one manually via StartSchemaExtensionRequest.builder()
startSchemaExtensionRequest
- A Consumer
that will call methods on StartSchemaExtensionRequest.Builder
to create a
request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UnshareDirectoryResponse unshareDirectory(UnshareDirectoryRequest unshareDirectoryRequest) throws EntityDoesNotExistException, InvalidTargetException, DirectoryNotSharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Stops the directory sharing between the directory owner and consumer accounts.
unshareDirectoryRequest
- 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 AWS account.ClientException
- A client exception has occurred.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UnshareDirectoryResponse unshareDirectory(Consumer<UnshareDirectoryRequest.Builder> unshareDirectoryRequest) throws EntityDoesNotExistException, InvalidTargetException, DirectoryNotSharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Stops the directory sharing between the directory owner and consumer accounts.
This is a convenience which creates an instance of the UnshareDirectoryRequest.Builder
avoiding the need
to create one manually via UnshareDirectoryRequest.builder()
unshareDirectoryRequest
- A Consumer
that will call methods on UnshareDirectoryRequest.Builder
to create a request.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 AWS account.ClientException
- A client exception has occurred.ServiceException
- An exception has occurred in AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateConditionalForwarderResponse updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates a conditional forwarder that has been set up for your AWS directory.
updateConditionalForwarderRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default UpdateConditionalForwarderResponse updateConditionalForwarder(Consumer<UpdateConditionalForwarderRequest.Builder> updateConditionalForwarderRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates a conditional forwarder that has been set up for your AWS directory.
This is a convenience which creates an instance of the UpdateConditionalForwarderRequest.Builder
avoiding
the need to create one manually via UpdateConditionalForwarderRequest.builder()
updateConditionalForwarderRequest
- A Consumer
that will call methods on UpdateConditionalForwarderRequest.Builder
to create a
request. 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default UpdateNumberOfDomainControllersResponse updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, DomainControllerLimitExceededException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
updateNumberOfDomainControllersRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default UpdateNumberOfDomainControllersResponse updateNumberOfDomainControllers(Consumer<UpdateNumberOfDomainControllersRequest.Builder> updateNumberOfDomainControllersRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, DomainControllerLimitExceededException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
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.
This is a convenience which creates an instance of the UpdateNumberOfDomainControllersRequest.Builder
avoiding the need to create one manually via UpdateNumberOfDomainControllersRequest.builder()
updateNumberOfDomainControllersRequest
- A Consumer
that will call methods on UpdateNumberOfDomainControllersRequest.Builder
to
create a request.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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default UpdateRadiusResponse updateRadius(UpdateRadiusRequest updateRadiusRequest) throws InvalidParameterException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
updateRadiusRequest
- 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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateRadiusResponse updateRadius(Consumer<UpdateRadiusRequest.Builder> updateRadiusRequest) throws InvalidParameterException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
This is a convenience which creates an instance of the UpdateRadiusRequest.Builder
avoiding the need to
create one manually via UpdateRadiusRequest.builder()
updateRadiusRequest
- A Consumer
that will call methods on UpdateRadiusRequest.Builder
to create a request.
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 AWS Directory Service.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateTrustResponse updateTrust(UpdateTrustRequest updateTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
updateTrustRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateTrustResponse updateTrust(Consumer<UpdateTrustRequest.Builder> updateTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
This is a convenience which creates an instance of the UpdateTrustRequest.Builder
avoiding the need to
create one manually via UpdateTrustRequest.builder()
updateTrustRequest
- A Consumer
that will call methods on UpdateTrustRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default VerifyTrustResponse verifyTrust(VerifyTrustRequest verifyTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.
verifyTrustRequest
- Initiates the verification of an existing trust relationship between an AWS 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 AWS Directory Service.UnsupportedOperationException
- The operation is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
default VerifyTrustResponse verifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.
This is a convenience which creates an instance of the VerifyTrustRequest.Builder
avoiding the need to
create one manually via VerifyTrustRequest.builder()
verifyTrustRequest
- A Consumer
that will call methods on VerifyTrustRequest.Builder
to create a request.
Initiates the verification of an existing trust relationship between an AWS 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 AWS Directory Service.UnsupportedOperationException
- The operation is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationException
AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.