@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface DirectoryClient extends SdkClient
builder() method.
Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service Administration Guide.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
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 self-managed domain uses a publicly addressable IP address, you must add a CIDR
address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.
|
default AddIpRoutesResponse |
addIpRoutes(Consumer<AddIpRoutesRequest.Builder> addIpRoutesRequest)
If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR
address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.
|
default AddRegionResponse |
addRegion(AddRegionRequest addRegionRequest)
Adds two domain controllers in the specified Region for the specified directory.
|
default AddRegionResponse |
addRegion(Consumer<AddRegionRequest.Builder> addRegionRequest)
Adds two domain controllers in the specified Region for the specified directory.
|
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 a self-managed directory.
|
default ConnectDirectoryResponse |
connectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest)
Creates an AD Connector to connect to a self-managed 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 an Active Directory computer object in the specified directory.
|
default CreateComputerResponse |
createComputer(CreateComputerRequest createComputerRequest)
Creates an Active Directory computer object in the specified directory.
|
default CreateConditionalForwarderResponse |
createConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest)
Creates a conditional forwarder associated with your Amazon Web Services directory.
|
default CreateConditionalForwarderResponse |
createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)
Creates a conditional forwarder associated with your Amazon Web Services 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
Amazon CloudWatch log group in your Amazon Web Services account.
|
default CreateLogSubscriptionResponse |
createLogSubscription(CreateLogSubscriptionRequest createLogSubscriptionRequest)
Creates a subscription to forward real-time Directory Service domain controller security logs to the specified
Amazon CloudWatch log group in your Amazon Web Services account.
|
default CreateMicrosoftAdResponse |
createMicrosoftAD(Consumer<CreateMicrosoftAdRequest.Builder> createMicrosoftAdRequest)
Creates a Microsoft AD directory in the Amazon Web Services Cloud.
|
default CreateMicrosoftAdResponse |
createMicrosoftAD(CreateMicrosoftAdRequest createMicrosoftAdRequest)
Creates a Microsoft AD directory in the Amazon Web Services Cloud.
|
default CreateSnapshotResponse |
createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
|
default CreateSnapshotResponse |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
|
default CreateTrustResponse |
createTrust(Consumer<CreateTrustRequest.Builder> createTrustRequest)
Directory Service for Microsoft Active Directory allows you to configure trust relationships.
|
default CreateTrustResponse |
createTrust(CreateTrustRequest createTrustRequest)
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 Amazon Web Services directory.
|
default DeleteConditionalForwarderResponse |
deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
|
default DeleteDirectoryResponse |
deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest)
Deletes an Directory Service directory.
|
default DeleteDirectoryResponse |
deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)
Deletes an 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 Managed Microsoft AD directory and an external domain.
|
default DeleteTrustResponse |
deleteTrust(DeleteTrustRequest deleteTrustRequest)
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
|
default DeregisterCertificateResponse |
deregisterCertificate(Consumer<DeregisterCertificateRequest.Builder> deregisterCertificateRequest)
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
|
default DeregisterCertificateResponse |
deregisterCertificate(DeregisterCertificateRequest deregisterCertificateRequest)
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
|
default DeregisterEventTopicResponse |
deregisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified Amazon SNS topic.
|
default DeregisterEventTopicResponse |
deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)
Removes the specified directory as a publisher to the specified Amazon SNS topic.
|
default DescribeCertificateResponse |
describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)
Displays information about the certificate registered for secure LDAP or client certificate authentication.
|
default DescribeCertificateResponse |
describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Displays information about the certificate registered for secure LDAP or client certificate authentication.
|
default DescribeClientAuthenticationSettingsResponse |
describeClientAuthenticationSettings(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest)
Retrieves information about the type of client authentication for the specified directory, if the type is
specified.
|
default DescribeClientAuthenticationSettingsResponse |
describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest)
Retrieves information about the type of client authentication for the specified directory, if the type is
specified.
|
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 Amazon SNS topics receive status messages from the specified directory.
|
default DescribeEventTopicsResponse |
describeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest)
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
|
default DescribeEventTopicsResponse |
describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
|
default DescribeLdapsSettingsResponse |
describeLDAPSSettings(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest)
Describes the status of LDAP security for the specified directory.
|
default DescribeLdapsSettingsResponse |
describeLDAPSSettings(DescribeLdapsSettingsRequest describeLdapsSettingsRequest)
Describes the status of LDAP security for the specified directory.
|
default DescribeRegionsResponse |
describeRegions(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest)
Provides information about the Regions that are configured for multi-Region replication.
|
default DescribeRegionsResponse |
describeRegions(DescribeRegionsRequest describeRegionsRequest)
Provides information about the Regions that are configured for multi-Region replication.
|
default DescribeSettingsResponse |
describeSettings(Consumer<DescribeSettingsRequest.Builder> describeSettingsRequest)
Retrieves information about the configurable settings for the specified directory.
|
default DescribeSettingsResponse |
describeSettings(DescribeSettingsRequest describeSettingsRequest)
Retrieves information about the configurable settings for 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 DisableClientAuthenticationResponse |
disableClientAuthentication(Consumer<DisableClientAuthenticationRequest.Builder> disableClientAuthenticationRequest)
Disables alternative client authentication methods for the specified directory.
|
default DisableClientAuthenticationResponse |
disableClientAuthentication(DisableClientAuthenticationRequest disableClientAuthenticationRequest)
Disables alternative client authentication methods for the specified directory.
|
default DisableLdapsResponse |
disableLDAPS(Consumer<DisableLdapsRequest.Builder> disableLdapsRequest)
Deactivates LDAP secure calls for the specified directory.
|
default DisableLdapsResponse |
disableLDAPS(DisableLdapsRequest disableLdapsRequest)
Deactivates LDAP secure calls for the specified directory.
|
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 EnableClientAuthenticationResponse |
enableClientAuthentication(Consumer<EnableClientAuthenticationRequest.Builder> enableClientAuthenticationRequest)
Enables alternative client authentication methods for the specified directory.
|
default EnableClientAuthenticationResponse |
enableClientAuthentication(EnableClientAuthenticationRequest enableClientAuthenticationRequest)
Enables alternative client authentication methods for the specified directory.
|
default EnableLdapsResponse |
enableLDAPS(Consumer<EnableLdapsRequest.Builder> enableLdapsRequest)
Activates the switch for the specific directory to always use LDAP secure calls.
|
default EnableLdapsResponse |
enableLDAPS(EnableLdapsRequest enableLdapsRequest)
Activates the switch for the specific directory to always use LDAP secure calls.
|
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 ListCertificatesResponse |
listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate
authentication.
|
default ListCertificatesResponse |
listCertificates(ListCertificatesRequest listCertificatesRequest)
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate
authentication.
|
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 Amazon Web Services account.
|
default ListLogSubscriptionsResponse |
listLogSubscriptions(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest)
Lists the active log subscriptions for the Amazon Web Services account.
|
default ListLogSubscriptionsResponse |
listLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest)
Lists the active log subscriptions for the Amazon Web Services 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 RegisterCertificateResponse |
registerCertificate(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest)
Registers a certificate for a secure LDAP or client certificate authentication.
|
default RegisterCertificateResponse |
registerCertificate(RegisterCertificateRequest registerCertificateRequest)
Registers a certificate for a secure LDAP or client certificate authentication.
|
default RegisterEventTopicResponse |
registerEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest)
Associates a directory with an Amazon SNS topic.
|
default RegisterEventTopicResponse |
registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)
Associates a directory with an Amazon 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 RemoveRegionResponse |
removeRegion(Consumer<RemoveRegionRequest.Builder> removeRegionRequest)
Stops all replication and removes the domain controllers from the specified Region.
|
default RemoveRegionResponse |
removeRegion(RemoveRegionRequest removeRegionRequest)
Stops all replication and removes the domain controllers from the specified Region.
|
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 Managed Microsoft AD or Simple AD directory.
|
default ResetUserPasswordResponse |
resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest)
Resets the password for any user in your 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 Amazon Web Services account (directory owner)
with another Amazon Web Services account (directory consumer). |
default ShareDirectoryResponse |
shareDirectory(ShareDirectoryRequest shareDirectoryRequest)
Shares a specified directory (
DirectoryId) in your Amazon Web Services account (directory owner)
with another Amazon Web Services 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 Amazon Web Services directory.
|
default UpdateConditionalForwarderResponse |
updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)
Updates a conditional forwarder that has been set up for your Amazon Web Services 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 UpdateSettingsResponse |
updateSettings(Consumer<UpdateSettingsRequest.Builder> updateSettingsRequest)
Updates the configurable settings for the specified directory.
|
default UpdateSettingsResponse |
updateSettings(UpdateSettingsRequest updateSettingsRequest)
Updates the configurable settings for the specified directory.
|
default UpdateTrustResponse |
updateTrust(Consumer<UpdateTrustRequest.Builder> updateTrustRequest)
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active
Directory.
|
default UpdateTrustResponse |
updateTrust(UpdateTrustRequest updateTrustRequest)
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active
Directory.
|
default VerifyTrustResponse |
verifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest)
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
|
default VerifyTrustResponse |
verifyTrust(VerifyTrustRequest verifyTrustRequest)
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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 Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in 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.AwsServiceExceptiondefault 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 Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in 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.AwsServiceExceptiondefault AddIpRoutesResponse addIpRoutes(AddIpRoutesRequest addIpRoutesRequest) throws EntityDoesNotExistException, EntityAlreadyExistsException, InvalidParameterException, DirectoryUnavailableException, IpRouteLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
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 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.AwsServiceExceptiondefault AddIpRoutesResponse addIpRoutes(Consumer<AddIpRoutesRequest.Builder> addIpRoutesRequest) throws EntityDoesNotExistException, EntityAlreadyExistsException, InvalidParameterException, DirectoryUnavailableException, IpRouteLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
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 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.AwsServiceExceptiondefault AddRegionResponse addRegion(AddRegionRequest addRegionRequest) throws DirectoryUnavailableException, InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadyInRegionException, UnsupportedOperationException, DirectoryDoesNotExistException, RegionLimitExceededException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Adds two domain controllers in the specified Region for the specified directory.
addRegionRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.InvalidParameterException - One or more parameters are not valid.EntityDoesNotExistException - The specified entity could not be found.DirectoryAlreadyInRegionException - The Region you specified is the same Region where the Managed Microsoft AD directory was created. Specify
a different Region and try again.UnsupportedOperationException - The operation is not supported.DirectoryDoesNotExistException - The specified directory does not exist in the system.RegionLimitExceededException - You have reached the limit for maximum number of simultaneous Region replications per directory.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault AddRegionResponse addRegion(Consumer<AddRegionRequest.Builder> addRegionRequest) throws DirectoryUnavailableException, InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadyInRegionException, UnsupportedOperationException, DirectoryDoesNotExistException, RegionLimitExceededException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Adds two domain controllers in the specified Region for the specified directory.
This is a convenience which creates an instance of the AddRegionRequest.Builder avoiding the need to
create one manually via AddRegionRequest.builder()
addRegionRequest - A Consumer that will call methods on AddRegionRequest.Builder to create a request.DirectoryUnavailableException - The specified directory is unavailable or could not be found.InvalidParameterException - One or more parameters are not valid.EntityDoesNotExistException - The specified entity could not be found.DirectoryAlreadyInRegionException - The Region you specified is the same Region where the Managed Microsoft AD directory was created. Specify
a different Region and try again.UnsupportedOperationException - The operation is not supported.DirectoryDoesNotExistException - The specified directory does not exist in the system.RegionLimitExceededException - You have reached the limit for maximum number of simultaneous Region replications per directory.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault ConnectDirectoryResponse connectDirectory(ConnectDirectoryRequest connectDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an AD Connector to connect to a self-managed directory.
Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the
ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
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 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.AwsServiceExceptiondefault ConnectDirectoryResponse connectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an AD Connector to connect to a self-managed directory.
Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the
ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault CreateComputerResponse createComputer(CreateComputerRequest createComputerRequest) throws AuthenticationFailedException, DirectoryUnavailableException, EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an Active Directory computer object in the specified 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateComputerResponse createComputer(Consumer<CreateComputerRequest.Builder> createComputerRequest) throws AuthenticationFailedException, DirectoryUnavailableException, EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an Active Directory computer object in the specified 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateConditionalForwarderResponse createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
createConditionalForwarderRequest - Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active
Directory. Conditional forwarders are required in order to set up a trust relationship with another
domain.EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.DirectoryUnavailableException - The specified directory is unavailable or could not be found.InvalidParameterException - One or more parameters are not valid.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateConditionalForwarderResponse createConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
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 Directory Service for Microsoft Active
Directory. Conditional forwarders are required in order to set up a trust relationship with another
domain.EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.DirectoryUnavailableException - The specified directory is unavailable or could not be found.InvalidParameterException - One or more parameters are not valid.UnsupportedOperationException - The operation is not supported.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateDirectoryResponse createDirectory(CreateDirectoryRequest createDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
Before you call CreateDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the CreateDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
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 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.AwsServiceExceptiondefault CreateDirectoryResponse createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
Before you call CreateDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the CreateDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
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 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.AwsServiceExceptiondefault 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 Amazon CloudWatch log group in your Amazon Web Services 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 Amazon CloudWatch log group in your Amazon Web Services 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateMicrosoftAdResponse createMicrosoftAD(CreateMicrosoftAdRequest createMicrosoftAdRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
createMicrosoftAdRequest - Creates an Managed Microsoft AD directory.DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the
GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.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.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateMicrosoftAdResponse createMicrosoftAD(Consumer<CreateMicrosoftAdRequest.Builder> createMicrosoftAdRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
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 Managed Microsoft AD directory.DirectoryLimitExceededException - The maximum number of directories in the region has been reached. You can use the
GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 Amazon Web Services 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 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.AwsServiceExceptiondefault 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 Amazon Web Services 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 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.AwsServiceExceptiondefault CreateTrustResponse createTrust(CreateTrustRequest createTrustRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
createTrustRequest - Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example,
you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed
Microsoft Active Directory. This would allow you to provide users and groups access to resources in either
domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.
EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.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.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateTrustResponse createTrust(Consumer<CreateTrustRequest.Builder> createTrustRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
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.
Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example,
you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed
Microsoft Active Directory. This would allow you to provide users and groups access to resources in either
domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.
EntityAlreadyExistsException - The specified entity already exists.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 Amazon Web Services 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 Amazon Web Services 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault DeleteDirectoryResponse deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes an Directory Service directory.
Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the DeleteDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
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 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.AwsServiceExceptiondefault DeleteDirectoryResponse deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes an Directory Service directory.
Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly
granted through a policy. For details about what permissions are required to run the DeleteDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
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 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.AwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault DeleteTrustResponse deleteTrust(DeleteTrustRequest deleteTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
deleteTrustRequest - Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and
the external domain.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DeleteTrustResponse deleteTrust(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Deletes an existing trust relationship between your 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 Managed Microsoft AD directory and
the external domain.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DeregisterCertificateResponse deregisterCertificate(DeregisterCertificateRequest deregisterCertificateRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, CertificateDoesNotExistException, CertificateInUseException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
deregisterCertificateRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.CertificateDoesNotExistException - The certificate is not present in the system for describe or deregister activities.CertificateInUseException - The certificate is being used for the LDAP security connection and cannot be removed without disabling
LDAP security.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DeregisterCertificateResponse deregisterCertificate(Consumer<DeregisterCertificateRequest.Builder> deregisterCertificateRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, CertificateDoesNotExistException, CertificateInUseException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
This is a convenience which creates an instance of the DeregisterCertificateRequest.Builder avoiding the
need to create one manually via DeregisterCertificateRequest.builder()
deregisterCertificateRequest - A Consumer that will call methods on DeregisterCertificateRequest.Builder to create a
request.DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.CertificateDoesNotExistException - The certificate is not present in the system for describe or deregister activities.CertificateInUseException - The certificate is being used for the LDAP security connection and cannot be removed without disabling
LDAP security.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DeregisterEventTopicResponse deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes the specified directory as a publisher to the specified Amazon SNS topic.
deregisterEventTopicRequest - Removes the specified directory as a publisher to the specified Amazon SNS topic.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.AwsServiceExceptiondefault DeregisterEventTopicResponse deregisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes the specified directory as a publisher to the specified Amazon 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 Amazon SNS topic.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.AwsServiceExceptiondefault DescribeCertificateResponse describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, CertificateDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Displays information about the certificate registered for secure LDAP or client certificate authentication.
describeCertificateRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.CertificateDoesNotExistException - The certificate is not present in the system for describe or deregister activities.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DescribeCertificateResponse describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, CertificateDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Displays information about the certificate registered for secure LDAP or client certificate authentication.
This is a convenience which creates an instance of the DescribeCertificateRequest.Builder avoiding the
need to create one manually via DescribeCertificateRequest.builder()
describeCertificateRequest - A Consumer that will call methods on DescribeCertificateRequest.Builder to create a
request.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.CertificateDoesNotExistException - The certificate is not present in the system for describe or deregister activities.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DescribeClientAuthenticationSettingsResponse describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, AccessDeniedException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Retrieves information about the type of client authentication for the specified directory, if the type is
specified. If no type is specified, information about all client authentication types that are supported for the
specified directory is retrieved. Currently, only SmartCard is supported.
describeClientAuthenticationSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.AccessDeniedException - Client authentication is not available in this region at this time.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DescribeClientAuthenticationSettingsResponse describeClientAuthenticationSettings(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, AccessDeniedException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Retrieves information about the type of client authentication for the specified directory, if the type is
specified. If no type is specified, information about all client authentication types that are supported for the
specified directory is retrieved. Currently, only SmartCard is supported.
This is a convenience which creates an instance of the
DescribeClientAuthenticationSettingsRequest.Builder avoiding the need to create one manually via
DescribeClientAuthenticationSettingsRequest.builder()
describeClientAuthenticationSettingsRequest - A Consumer that will call methods on DescribeClientAuthenticationSettingsRequest.Builder
to create a request.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.AccessDeniedException - Client authentication is not available in this region at this time.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondescribeDirectories(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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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(....);
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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(....);
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault DescribeEventTopicsResponse describeEventTopics() throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.AwsServiceExceptiondescribeEventTopics(DescribeEventTopicsRequest),
AWS API
Documentationdefault DescribeEventTopicsResponse describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
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 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.AwsServiceExceptiondefault DescribeEventTopicsResponse describeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
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 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.AwsServiceExceptiondefault DescribeLdapsSettingsResponse describeLDAPSSettings(DescribeLdapsSettingsRequest describeLdapsSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Describes the status of LDAP security for the specified directory.
describeLdapsSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidNextTokenException - The NextToken value is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DescribeLdapsSettingsResponse describeLDAPSSettings(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Describes the status of LDAP security for the specified directory.
This is a convenience which creates an instance of the DescribeLdapsSettingsRequest.Builder avoiding the
need to create one manually via DescribeLdapsSettingsRequest.builder()
describeLdapsSettingsRequest - A Consumer that will call methods on DescribeLDAPSSettingsRequest.Builder to create a
request.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidNextTokenException - The NextToken value is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DescribeRegionsResponse describeRegions(DescribeRegionsRequest describeRegionsRequest) throws InvalidParameterException, DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Provides information about the Regions that are configured for multi-Region replication.
describeRegionsRequest - InvalidParameterException - One or more parameters are not valid.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidNextTokenException - The NextToken value is not valid.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DescribeRegionsResponse describeRegions(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest) throws InvalidParameterException, DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Provides information about the Regions that are configured for multi-Region replication.
This is a convenience which creates an instance of the DescribeRegionsRequest.Builder avoiding the need
to create one manually via DescribeRegionsRequest.builder()
describeRegionsRequest - A Consumer that will call methods on DescribeRegionsRequest.Builder to create a request.InvalidParameterException - One or more parameters are not valid.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidNextTokenException - The NextToken value is not valid.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DescribeSettingsResponse describeSettings(DescribeSettingsRequest describeSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Retrieves information about the configurable settings for the specified directory.
describeSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.InvalidNextTokenException - The NextToken value is not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DescribeSettingsResponse describeSettings(Consumer<DescribeSettingsRequest.Builder> describeSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Retrieves information about the configurable settings for the specified directory.
This is a convenience which creates an instance of the DescribeSettingsRequest.Builder avoiding the need
to create one manually via DescribeSettingsRequest.builder()
describeSettingsRequest - A Consumer that will call methods on DescribeSettingsRequest.Builder to create a request.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.InvalidNextTokenException - The NextToken value is not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondescribeSnapshots(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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondescribeTrusts(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 Managed Microsoft AD directory. If no input parameters
are provided, such as directory ID or trust ID, this request describes all the trust relationships.EntityDoesNotExistException - The specified entity could not be found.InvalidNextTokenException - The NextToken value is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 Managed Microsoft AD directory. If no input parameters
are provided, such as directory ID or trust ID, this request describes all the trust relationships.EntityDoesNotExistException - The specified entity could not be found.InvalidNextTokenException - The NextToken value is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DisableClientAuthenticationResponse disableClientAuthentication(DisableClientAuthenticationRequest disableClientAuthenticationRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidClientAuthStatusException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables alternative client authentication methods for the specified directory.
disableClientAuthenticationRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidClientAuthStatusException - Client authentication is already enabled.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DisableClientAuthenticationResponse disableClientAuthentication(Consumer<DisableClientAuthenticationRequest.Builder> disableClientAuthenticationRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidClientAuthStatusException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables alternative client authentication methods for the specified directory.
This is a convenience which creates an instance of the DisableClientAuthenticationRequest.Builder
avoiding the need to create one manually via DisableClientAuthenticationRequest.builder()
disableClientAuthenticationRequest - A Consumer that will call methods on DisableClientAuthenticationRequest.Builder to create
a request.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidClientAuthStatusException - Client authentication is already enabled.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DisableLdapsResponse disableLDAPS(DisableLdapsRequest disableLdapsRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, InvalidLdapsStatusException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deactivates LDAP secure calls for the specified directory.
disableLdapsRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.InvalidLdapsStatusException - The LDAP activities could not be performed because they are limited by the LDAPS status.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault DisableLdapsResponse disableLDAPS(Consumer<DisableLdapsRequest.Builder> disableLdapsRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, InvalidLdapsStatusException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deactivates LDAP secure calls for the specified directory.
This is a convenience which creates an instance of the DisableLdapsRequest.Builder avoiding the need to
create one manually via DisableLdapsRequest.builder()
disableLdapsRequest - A Consumer that will call methods on DisableLDAPSRequest.Builder to create a request.DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.InvalidLdapsStatusException - The LDAP activities could not be performed because they are limited by the LDAPS status.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault EnableClientAuthenticationResponse enableClientAuthentication(EnableClientAuthenticationRequest enableClientAuthenticationRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidClientAuthStatusException, AccessDeniedException, NoAvailableCertificateException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables alternative client authentication methods for the specified directory.
enableClientAuthenticationRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidClientAuthStatusException - Client authentication is already enabled.AccessDeniedException - Client authentication is not available in this region at this time.NoAvailableCertificateException - Client authentication setup could not be completed because at least one valid certificate must be
registered in the system.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault EnableClientAuthenticationResponse enableClientAuthentication(Consumer<EnableClientAuthenticationRequest.Builder> enableClientAuthenticationRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidClientAuthStatusException, AccessDeniedException, NoAvailableCertificateException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables alternative client authentication methods for the specified directory.
This is a convenience which creates an instance of the EnableClientAuthenticationRequest.Builder avoiding
the need to create one manually via EnableClientAuthenticationRequest.builder()
enableClientAuthenticationRequest - A Consumer that will call methods on EnableClientAuthenticationRequest.Builder to create a
request.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidClientAuthStatusException - Client authentication is already enabled.AccessDeniedException - Client authentication is not available in this region at this time.NoAvailableCertificateException - Client authentication setup could not be completed because at least one valid certificate must be
registered in the system.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault EnableLdapsResponse enableLDAPS(EnableLdapsRequest enableLdapsRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, NoAvailableCertificateException, InvalidLdapsStatusException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Activates the switch for the specific directory to always use LDAP secure calls.
enableLdapsRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.NoAvailableCertificateException - Client authentication setup could not be completed because at least one valid certificate must be
registered in the system.InvalidLdapsStatusException - The LDAP activities could not be performed because they are limited by the LDAPS status.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault EnableLdapsResponse enableLDAPS(Consumer<EnableLdapsRequest.Builder> enableLdapsRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, NoAvailableCertificateException, InvalidLdapsStatusException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Activates the switch for the specific directory to always use LDAP secure calls.
This is a convenience which creates an instance of the EnableLdapsRequest.Builder avoiding the need to
create one manually via EnableLdapsRequest.builder()
enableLdapsRequest - A Consumer that will call methods on EnableLDAPSRequest.Builder to create a request.DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.NoAvailableCertificateException - Client authentication setup could not be completed because at least one valid certificate must be
registered in the system.InvalidLdapsStatusException - The LDAP activities could not be performed because they are limited by the LDAPS status.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault EnableSsoResponse enableSso(EnableSsoRequest enableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
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 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.AwsServiceExceptiondefault EnableSsoResponse enableSso(Consumer<EnableSsoRequest.Builder> enableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiongetDirectoryLimits(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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault ListCertificatesResponse listCertificates(ListCertificatesRequest listCertificatesRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
listCertificatesRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.InvalidNextTokenException - The NextToken value is not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault ListCertificatesResponse listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
This is a convenience which creates an instance of the ListCertificatesRequest.Builder avoiding the need
to create one manually via ListCertificatesRequest.builder()
listCertificatesRequest - A Consumer that will call methods on ListCertificatesRequest.Builder to create a request.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.InvalidNextTokenException - The NextToken value is not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault ListLogSubscriptionsResponse listLogSubscriptions() throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the active log subscriptions for the Amazon Web Services 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 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.AwsServiceExceptionlistLogSubscriptions(ListLogSubscriptionsRequest),
AWS API
Documentationdefault ListLogSubscriptionsResponse listLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the active log subscriptions for the Amazon Web Services 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 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.AwsServiceExceptiondefault ListLogSubscriptionsResponse listLogSubscriptions(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the active log subscriptions for the Amazon Web Services 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault RegisterCertificateResponse registerCertificate(RegisterCertificateRequest registerCertificateRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, InvalidCertificateException, CertificateLimitExceededException, CertificateAlreadyExistsException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Registers a certificate for a secure LDAP or client certificate authentication.
registerCertificateRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.InvalidCertificateException - The certificate PEM that was provided has incorrect encoding.CertificateLimitExceededException - The certificate could not be added because the certificate limit has been reached.CertificateAlreadyExistsException - The certificate has already been registered into the system.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault RegisterCertificateResponse registerCertificate(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, InvalidCertificateException, CertificateLimitExceededException, CertificateAlreadyExistsException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Registers a certificate for a secure LDAP or client certificate authentication.
This is a convenience which creates an instance of the RegisterCertificateRequest.Builder avoiding the
need to create one manually via RegisterCertificateRequest.builder()
registerCertificateRequest - A Consumer that will call methods on RegisterCertificateRequest.Builder to create a
request.DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.InvalidCertificateException - The certificate PEM that was provided has incorrect encoding.CertificateLimitExceededException - The certificate could not be added because the certificate limit has been reached.CertificateAlreadyExistsException - The certificate has already been registered into the system.UnsupportedOperationException - The operation is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault RegisterEventTopicResponse registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
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 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.AwsServiceExceptiondefault RegisterEventTopicResponse registerEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
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 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.AwsServiceExceptiondefault 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 Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in 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.AwsServiceExceptiondefault 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 Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault RemoveRegionResponse removeRegion(RemoveRegionRequest removeRegionRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, UnsupportedOperationException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary
Region with this operation. Instead, use the DeleteDirectory API.
removeRegionRequest - DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault RemoveRegionResponse removeRegion(Consumer<RemoveRegionRequest.Builder> removeRegionRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, UnsupportedOperationException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary
Region with this operation. Instead, use the DeleteDirectory API.
This is a convenience which creates an instance of the RemoveRegionRequest.Builder avoiding the need to
create one manually via RemoveRegionRequest.builder()
removeRegionRequest - A Consumer that will call methods on RemoveRegionRequest.Builder to create a request.DirectoryUnavailableException - The specified directory is unavailable or could not be found.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.AccessDeniedException - Client authentication is not available in this region at this time.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault ResetUserPasswordResponse resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest) throws DirectoryUnavailableException, UserDoesNotExistException, InvalidPasswordException, UnsupportedOperationException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
You can reset the password for any user in your directory with the following exceptions:
For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.
For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.
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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 Managed Microsoft AD or Simple AD directory.
You can reset the password for any user in your directory with the following exceptions:
For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.
For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.
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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 Amazon Web Services account (directory owner)
with another Amazon Web Services account (directory consumer). With this operation you can use your directory
from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.
The ShareMethod parameter determines whether the specified directory can be shared between Amazon
Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also
determines whether you can share the directory with any other Amazon Web Services account either inside or
outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory
sharing request to the directory consumer.
shareDirectoryRequest - DirectoryAlreadySharedException - The specified directory has already been shared with this Amazon Web Services account.EntityDoesNotExistException - The specified entity could not be found.InvalidTargetException - The specified shared target is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ShareLimitExceededException - The maximum number of Amazon Web Services accounts that you can share with this directory has been
reached.OrganizationsException - Exception encountered while trying to access your Amazon Web Services organization.AccessDeniedException - Client authentication is not available in this region at this time.UnsupportedOperationException - The operation is not supported.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 Amazon Web Services account (directory owner)
with another Amazon Web Services account (directory consumer). With this operation you can use your directory
from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.
The ShareMethod parameter determines whether the specified directory can be shared between Amazon
Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also
determines whether you can share the directory with any other Amazon Web Services account either inside or
outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory
sharing request to the directory consumer.
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 Amazon Web Services account.EntityDoesNotExistException - The specified entity could not be found.InvalidTargetException - The specified shared target is not valid.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ShareLimitExceededException - The maximum number of Amazon Web Services accounts that you can share with this directory has been
reached.OrganizationsException - Exception encountered while trying to access your Amazon Web Services organization.AccessDeniedException - Client authentication is not available in this region at this time.UnsupportedOperationException - The operation is not supported.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in 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.AwsServiceExceptiondefault 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 Amazon Web Services account.ClientException - A client exception has occurred.ServiceException - An exception has occurred in 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.AwsServiceExceptiondefault 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 Amazon Web Services 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 Amazon Web Services 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault UpdateSettingsResponse updateSettings(UpdateSettingsRequest updateSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, DirectoryUnavailableException, IncompatibleSettingsException, UnsupportedSettingsException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the configurable settings for the specified directory.
updateSettingsRequest - DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.DirectoryUnavailableException - The specified directory is unavailable or could not be found.IncompatibleSettingsException - The specified directory setting is not compatible with other settings.UnsupportedSettingsException - The specified directory setting is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateSettingsResponse updateSettings(Consumer<UpdateSettingsRequest.Builder> updateSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, DirectoryUnavailableException, IncompatibleSettingsException, UnsupportedSettingsException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the configurable settings for the specified directory.
This is a convenience which creates an instance of the UpdateSettingsRequest.Builder avoiding the need to
create one manually via UpdateSettingsRequest.builder()
updateSettingsRequest - A Consumer that will call methods on UpdateSettingsRequest.Builder to create a request.DirectoryDoesNotExistException - The specified directory does not exist in the system.UnsupportedOperationException - The operation is not supported.DirectoryUnavailableException - The specified directory is unavailable or could not be found.IncompatibleSettingsException - The specified directory setting is not compatible with other settings.UnsupportedSettingsException - The specified directory setting is not supported.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.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.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateTrustResponse updateTrust(UpdateTrustRequest updateTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed 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 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.AwsServiceExceptiondefault UpdateTrustResponse updateTrust(Consumer<UpdateTrustRequest.Builder> updateTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed 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 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.AwsServiceExceptiondefault VerifyTrustResponse verifyTrust(VerifyTrustRequest verifyTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.
verifyTrustRequest - Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and
an external domain.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.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.UnsupportedOperationExceptionAwsServiceExceptiondefault VerifyTrustResponse verifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.
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 Managed Microsoft AD directory and
an external domain.EntityDoesNotExistException - The specified entity could not be found.InvalidParameterException - One or more parameters are not valid.ClientException - A client exception has occurred.ServiceException - An exception has occurred in Directory Service.UnsupportedOperationException - The operation is not supported.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.UnsupportedOperationExceptionAwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.