Interface DirectoryAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionacceptSharedDirectory
(Consumer<AcceptSharedDirectoryRequest.Builder> acceptSharedDirectoryRequest) Accepts a directory sharing request that was sent from the directory owner account.acceptSharedDirectory
(AcceptSharedDirectoryRequest acceptSharedDirectoryRequest) Accepts a directory sharing request that was sent from the directory owner account.default CompletableFuture
<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 CompletableFuture
<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 CompletableFuture
<AddRegionResponse> addRegion
(Consumer<AddRegionRequest.Builder> addRegionRequest) Adds two domain controllers in the specified Region for the specified directory.default CompletableFuture
<AddRegionResponse> addRegion
(AddRegionRequest addRegionRequest) Adds two domain controllers in the specified Region for the specified directory.addTagsToResource
(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) Adds or overwrites one or more tags for the specified directory.addTagsToResource
(AddTagsToResourceRequest addTagsToResourceRequest) Adds or overwrites one or more tags for the specified directory.static DirectoryAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aDirectoryAsyncClient
.cancelSchemaExtension
(Consumer<CancelSchemaExtensionRequest.Builder> cancelSchemaExtensionRequest) Cancels an in-progress schema extension to a Microsoft AD directory.cancelSchemaExtension
(CancelSchemaExtensionRequest cancelSchemaExtensionRequest) Cancels an in-progress schema extension to a Microsoft AD directory.connectDirectory
(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest) Creates an AD Connector to connect to a self-managed directory.connectDirectory
(ConnectDirectoryRequest connectDirectoryRequest) Creates an AD Connector to connect to a self-managed directory.static DirectoryAsyncClient
create()
Create aDirectoryAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAliasResponse> createAlias
(Consumer<CreateAliasRequest.Builder> createAliasRequest) Creates an alias for a directory and assigns the alias to the directory.default CompletableFuture
<CreateAliasResponse> createAlias
(CreateAliasRequest createAliasRequest) Creates an alias for a directory and assigns the alias to the directory.default CompletableFuture
<CreateComputerResponse> createComputer
(Consumer<CreateComputerRequest.Builder> createComputerRequest) Creates an Active Directory computer object in the specified directory.default CompletableFuture
<CreateComputerResponse> createComputer
(CreateComputerRequest createComputerRequest) Creates an Active Directory computer object in the specified directory.createConditionalForwarder
(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest) Creates a conditional forwarder associated with your Amazon Web Services directory.createConditionalForwarder
(CreateConditionalForwarderRequest createConditionalForwarderRequest) Creates a conditional forwarder associated with your Amazon Web Services directory.default CompletableFuture
<CreateDirectoryResponse> createDirectory
(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest) Creates a Simple AD directory.default CompletableFuture
<CreateDirectoryResponse> createDirectory
(CreateDirectoryRequest createDirectoryRequest) Creates a Simple AD directory.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.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.createMicrosoftAD
(Consumer<CreateMicrosoftAdRequest.Builder> createMicrosoftAdRequest) Creates a Microsoft AD directory in the Amazon Web Services Cloud.createMicrosoftAD
(CreateMicrosoftAdRequest createMicrosoftAdRequest) Creates a Microsoft AD directory in the Amazon Web Services Cloud.default CompletableFuture
<CreateSnapshotResponse> createSnapshot
(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.default CompletableFuture
<CreateSnapshotResponse> createSnapshot
(CreateSnapshotRequest createSnapshotRequest) Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.default CompletableFuture
<CreateTrustResponse> createTrust
(Consumer<CreateTrustRequest.Builder> createTrustRequest) Directory Service for Microsoft Active Directory allows you to configure trust relationships.default CompletableFuture
<CreateTrustResponse> createTrust
(CreateTrustRequest createTrustRequest) Directory Service for Microsoft Active Directory allows you to configure trust relationships.deleteConditionalForwarder
(Consumer<DeleteConditionalForwarderRequest.Builder> deleteConditionalForwarderRequest) Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.deleteConditionalForwarder
(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest) Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.default CompletableFuture
<DeleteDirectoryResponse> deleteDirectory
(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest) Deletes an Directory Service directory.default CompletableFuture
<DeleteDirectoryResponse> deleteDirectory
(DeleteDirectoryRequest deleteDirectoryRequest) Deletes an Directory Service directory.deleteLogSubscription
(Consumer<DeleteLogSubscriptionRequest.Builder> deleteLogSubscriptionRequest) Deletes the specified log subscription.deleteLogSubscription
(DeleteLogSubscriptionRequest deleteLogSubscriptionRequest) Deletes the specified log subscription.default CompletableFuture
<DeleteSnapshotResponse> deleteSnapshot
(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest) Deletes a directory snapshot.default CompletableFuture
<DeleteSnapshotResponse> deleteSnapshot
(DeleteSnapshotRequest deleteSnapshotRequest) Deletes a directory snapshot.default CompletableFuture
<DeleteTrustResponse> deleteTrust
(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest) Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.default CompletableFuture
<DeleteTrustResponse> deleteTrust
(DeleteTrustRequest deleteTrustRequest) Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.deregisterCertificate
(Consumer<DeregisterCertificateRequest.Builder> deregisterCertificateRequest) Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.deregisterCertificate
(DeregisterCertificateRequest deregisterCertificateRequest) Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.deregisterEventTopic
(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest) Removes the specified directory as a publisher to the specified Amazon SNS topic.deregisterEventTopic
(DeregisterEventTopicRequest deregisterEventTopicRequest) Removes the specified directory as a publisher to the specified Amazon SNS topic.describeCertificate
(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) Displays information about the certificate registered for secure LDAP or client certificate authentication.describeCertificate
(DescribeCertificateRequest describeCertificateRequest) Displays information about the certificate registered for secure LDAP or client certificate authentication.describeClientAuthenticationSettings
(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest) Retrieves information about the type of client authentication for the specified directory, if the type is specified.describeClientAuthenticationSettings
(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest) Retrieves information about the type of client authentication for the specified directory, if the type is specified.describeClientAuthenticationSettingsPaginator
(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest) describeClientAuthenticationSettingsPaginator
(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest) describeConditionalForwarders
(Consumer<DescribeConditionalForwardersRequest.Builder> describeConditionalForwardersRequest) Obtains information about the conditional forwarders for this account.describeConditionalForwarders
(DescribeConditionalForwardersRequest describeConditionalForwardersRequest) Obtains information about the conditional forwarders for this account.Obtains information about the directories that belong to this account.describeDirectories
(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest) Obtains information about the directories that belong to this account.describeDirectories
(DescribeDirectoriesRequest describeDirectoriesRequest) Obtains information about the directories that belong to this account.default DescribeDirectoriesPublisher
This is a variant ofdescribeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)
operation.default DescribeDirectoriesPublisher
describeDirectoriesPaginator
(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest) This is a variant ofdescribeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)
operation.default DescribeDirectoriesPublisher
describeDirectoriesPaginator
(DescribeDirectoriesRequest describeDirectoriesRequest) This is a variant ofdescribeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)
operation.describeDomainControllers
(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest) Provides information about any domain controllers in your directory.describeDomainControllers
(DescribeDomainControllersRequest describeDomainControllersRequest) Provides information about any domain controllers in your directory.describeDomainControllersPaginator
(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest) This is a variant ofdescribeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)
operation.describeDomainControllersPaginator
(DescribeDomainControllersRequest describeDomainControllersRequest) This is a variant ofdescribeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)
operation.Obtains information about which Amazon SNS topics receive status messages from the specified directory.describeEventTopics
(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest) Obtains information about which Amazon SNS topics receive status messages from the specified directory.describeEventTopics
(DescribeEventTopicsRequest describeEventTopicsRequest) Obtains information about which Amazon SNS topics receive status messages from the specified directory.describeLDAPSSettings
(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest) Describes the status of LDAP security for the specified directory.describeLDAPSSettings
(DescribeLdapsSettingsRequest describeLdapsSettingsRequest) Describes the status of LDAP security for the specified directory.default DescribeLDAPSSettingsPublisher
describeLDAPSSettingsPaginator
(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest) This is a variant ofdescribeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)
operation.default DescribeLDAPSSettingsPublisher
describeLDAPSSettingsPaginator
(DescribeLdapsSettingsRequest describeLdapsSettingsRequest) This is a variant ofdescribeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)
operation.default CompletableFuture
<DescribeRegionsResponse> describeRegions
(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest) Provides information about the Regions that are configured for multi-Region replication.default CompletableFuture
<DescribeRegionsResponse> describeRegions
(DescribeRegionsRequest describeRegionsRequest) Provides information about the Regions that are configured for multi-Region replication.default DescribeRegionsPublisher
describeRegionsPaginator
(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest) This is a variant ofdescribeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest)
operation.default DescribeRegionsPublisher
describeRegionsPaginator
(DescribeRegionsRequest describeRegionsRequest) This is a variant ofdescribeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest)
operation.describeSettings
(Consumer<DescribeSettingsRequest.Builder> describeSettingsRequest) Retrieves information about the configurable settings for the specified directory.describeSettings
(DescribeSettingsRequest describeSettingsRequest) Retrieves information about the configurable settings for the specified directory.describeSharedDirectories
(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest) Returns the shared directories in your account.describeSharedDirectories
(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest) Returns the shared directories in your account.describeSharedDirectoriesPaginator
(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest) This is a variant ofdescribeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest)
operation.describeSharedDirectoriesPaginator
(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest) This is a variant ofdescribeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest)
operation.Obtains information about the directory snapshots that belong to this account.describeSnapshots
(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) Obtains information about the directory snapshots that belong to this account.describeSnapshots
(DescribeSnapshotsRequest describeSnapshotsRequest) Obtains information about the directory snapshots that belong to this account.default DescribeSnapshotsPublisher
This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)
operation.default DescribeSnapshotsPublisher
describeSnapshotsPaginator
(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)
operation.default DescribeSnapshotsPublisher
describeSnapshotsPaginator
(DescribeSnapshotsRequest describeSnapshotsRequest) This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)
operation.default CompletableFuture
<DescribeTrustsResponse> Obtains information about the trust relationships for this account.default CompletableFuture
<DescribeTrustsResponse> describeTrusts
(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest) Obtains information about the trust relationships for this account.default CompletableFuture
<DescribeTrustsResponse> describeTrusts
(DescribeTrustsRequest describeTrustsRequest) Obtains information about the trust relationships for this account.default DescribeTrustsPublisher
This is a variant ofdescribeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)
operation.default DescribeTrustsPublisher
describeTrustsPaginator
(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest) This is a variant ofdescribeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)
operation.default DescribeTrustsPublisher
describeTrustsPaginator
(DescribeTrustsRequest describeTrustsRequest) This is a variant ofdescribeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)
operation.describeUpdateDirectory
(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest) Describes the updates of a directory for a particular update type.describeUpdateDirectory
(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest) Describes the updates of a directory for a particular update type.default DescribeUpdateDirectoryPublisher
describeUpdateDirectoryPaginator
(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest) This is a variant ofdescribeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest)
operation.default DescribeUpdateDirectoryPublisher
describeUpdateDirectoryPaginator
(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest) This is a variant ofdescribeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest)
operation.disableClientAuthentication
(Consumer<DisableClientAuthenticationRequest.Builder> disableClientAuthenticationRequest) Disables alternative client authentication methods for the specified directory.disableClientAuthentication
(DisableClientAuthenticationRequest disableClientAuthenticationRequest) Disables alternative client authentication methods for the specified directory.default CompletableFuture
<DisableLdapsResponse> disableLDAPS
(Consumer<DisableLdapsRequest.Builder> disableLdapsRequest) Deactivates LDAP secure calls for the specified directory.default CompletableFuture
<DisableLdapsResponse> disableLDAPS
(DisableLdapsRequest disableLdapsRequest) Deactivates LDAP secure calls for the specified directory.default CompletableFuture
<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 CompletableFuture
<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 CompletableFuture
<DisableSsoResponse> disableSso
(Consumer<DisableSsoRequest.Builder> disableSsoRequest) Disables single-sign on for a directory.default CompletableFuture
<DisableSsoResponse> disableSso
(DisableSsoRequest disableSsoRequest) Disables single-sign on for a directory.enableClientAuthentication
(Consumer<EnableClientAuthenticationRequest.Builder> enableClientAuthenticationRequest) Enables alternative client authentication methods for the specified directory.enableClientAuthentication
(EnableClientAuthenticationRequest enableClientAuthenticationRequest) Enables alternative client authentication methods for the specified directory.default CompletableFuture
<EnableLdapsResponse> enableLDAPS
(Consumer<EnableLdapsRequest.Builder> enableLdapsRequest) Activates the switch for the specific directory to always use LDAP secure calls.default CompletableFuture
<EnableLdapsResponse> enableLDAPS
(EnableLdapsRequest enableLdapsRequest) Activates the switch for the specific directory to always use LDAP secure calls.default CompletableFuture
<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 CompletableFuture
<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 CompletableFuture
<EnableSsoResponse> enableSso
(Consumer<EnableSsoRequest.Builder> enableSsoRequest) Enables single sign-on for a directory.default CompletableFuture
<EnableSsoResponse> enableSso
(EnableSsoRequest enableSsoRequest) Enables single sign-on for a directory.Obtains directory limit information for the current Region.getDirectoryLimits
(Consumer<GetDirectoryLimitsRequest.Builder> getDirectoryLimitsRequest) Obtains directory limit information for the current Region.getDirectoryLimits
(GetDirectoryLimitsRequest getDirectoryLimitsRequest) Obtains directory limit information for the current Region.getSnapshotLimits
(Consumer<GetSnapshotLimitsRequest.Builder> getSnapshotLimitsRequest) Obtains the manual snapshot limits for a directory.getSnapshotLimits
(GetSnapshotLimitsRequest getSnapshotLimitsRequest) Obtains the manual snapshot limits for a directory.listCertificates
(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.listCertificates
(ListCertificatesRequest listCertificatesRequest) For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.default ListCertificatesPublisher
listCertificatesPaginator
(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) This is a variant oflistCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)
operation.default ListCertificatesPublisher
listCertificatesPaginator
(ListCertificatesRequest listCertificatesRequest) This is a variant oflistCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)
operation.default CompletableFuture
<ListIpRoutesResponse> listIpRoutes
(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest) Lists the address blocks that you have added to a directory.default CompletableFuture
<ListIpRoutesResponse> listIpRoutes
(ListIpRoutesRequest listIpRoutesRequest) Lists the address blocks that you have added to a directory.default ListIpRoutesPublisher
listIpRoutesPaginator
(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest) This is a variant oflistIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)
operation.default ListIpRoutesPublisher
listIpRoutesPaginator
(ListIpRoutesRequest listIpRoutesRequest) This is a variant oflistIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)
operation.Lists the active log subscriptions for the Amazon Web Services account.listLogSubscriptions
(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest) Lists the active log subscriptions for the Amazon Web Services account.listLogSubscriptions
(ListLogSubscriptionsRequest listLogSubscriptionsRequest) Lists the active log subscriptions for the Amazon Web Services account.default ListLogSubscriptionsPublisher
This is a variant oflistLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)
operation.default ListLogSubscriptionsPublisher
listLogSubscriptionsPaginator
(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest) This is a variant oflistLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)
operation.default ListLogSubscriptionsPublisher
listLogSubscriptionsPaginator
(ListLogSubscriptionsRequest listLogSubscriptionsRequest) This is a variant oflistLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)
operation.listSchemaExtensions
(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest) Lists all schema extensions applied to a Microsoft AD Directory.listSchemaExtensions
(ListSchemaExtensionsRequest listSchemaExtensionsRequest) Lists all schema extensions applied to a Microsoft AD Directory.default ListSchemaExtensionsPublisher
listSchemaExtensionsPaginator
(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest) This is a variant oflistSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)
operation.default ListSchemaExtensionsPublisher
listSchemaExtensionsPaginator
(ListSchemaExtensionsRequest listSchemaExtensionsRequest) This is a variant oflistSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags on a directory.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on a directory.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)
operation.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)
operation.registerCertificate
(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest) Registers a certificate for a secure LDAP or client certificate authentication.registerCertificate
(RegisterCertificateRequest registerCertificateRequest) Registers a certificate for a secure LDAP or client certificate authentication.registerEventTopic
(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest) Associates a directory with an Amazon SNS topic.registerEventTopic
(RegisterEventTopicRequest registerEventTopicRequest) Associates a directory with an Amazon SNS topic.rejectSharedDirectory
(Consumer<RejectSharedDirectoryRequest.Builder> rejectSharedDirectoryRequest) Rejects a directory sharing request that was sent from the directory owner account.rejectSharedDirectory
(RejectSharedDirectoryRequest rejectSharedDirectoryRequest) Rejects a directory sharing request that was sent from the directory owner account.default CompletableFuture
<RemoveIpRoutesResponse> removeIpRoutes
(Consumer<RemoveIpRoutesRequest.Builder> removeIpRoutesRequest) Removes IP address blocks from a directory.default CompletableFuture
<RemoveIpRoutesResponse> removeIpRoutes
(RemoveIpRoutesRequest removeIpRoutesRequest) Removes IP address blocks from a directory.default CompletableFuture
<RemoveRegionResponse> removeRegion
(Consumer<RemoveRegionRequest.Builder> removeRegionRequest) Stops all replication and removes the domain controllers from the specified Region.default CompletableFuture
<RemoveRegionResponse> removeRegion
(RemoveRegionRequest removeRegionRequest) Stops all replication and removes the domain controllers from the specified Region.removeTagsFromResource
(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) Removes tags from a directory.removeTagsFromResource
(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes tags from a directory.resetUserPassword
(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest) Resets the password for any user in your Managed Microsoft AD or Simple AD directory.resetUserPassword
(ResetUserPasswordRequest resetUserPasswordRequest) Resets the password for any user in your Managed Microsoft AD or Simple AD directory.restoreFromSnapshot
(Consumer<RestoreFromSnapshotRequest.Builder> restoreFromSnapshotRequest) Restores a directory using an existing directory snapshot.restoreFromSnapshot
(RestoreFromSnapshotRequest restoreFromSnapshotRequest) Restores a directory using an existing directory snapshot.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<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 CompletableFuture
<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).startSchemaExtension
(Consumer<StartSchemaExtensionRequest.Builder> startSchemaExtensionRequest) Applies a schema extension to a Microsoft AD directory.startSchemaExtension
(StartSchemaExtensionRequest startSchemaExtensionRequest) Applies a schema extension to a Microsoft AD directory.unshareDirectory
(Consumer<UnshareDirectoryRequest.Builder> unshareDirectoryRequest) Stops the directory sharing between the directory owner and consumer accounts.unshareDirectory
(UnshareDirectoryRequest unshareDirectoryRequest) Stops the directory sharing between the directory owner and consumer accounts.updateConditionalForwarder
(Consumer<UpdateConditionalForwarderRequest.Builder> updateConditionalForwarderRequest) Updates a conditional forwarder that has been set up for your Amazon Web Services directory.updateConditionalForwarder
(UpdateConditionalForwarderRequest updateConditionalForwarderRequest) Updates a conditional forwarder that has been set up for your Amazon Web Services directory.updateDirectorySetup
(Consumer<UpdateDirectorySetupRequest.Builder> updateDirectorySetupRequest) Updates the directory for a particular update type.updateDirectorySetup
(UpdateDirectorySetupRequest updateDirectorySetupRequest) Updates the directory for a particular update type.updateNumberOfDomainControllers
(Consumer<UpdateNumberOfDomainControllersRequest.Builder> updateNumberOfDomainControllersRequest) Adds or removes domain controllers to or from the directory.updateNumberOfDomainControllers
(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest) Adds or removes domain controllers to or from the directory.default CompletableFuture
<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 CompletableFuture
<UpdateRadiusResponse> updateRadius
(UpdateRadiusRequest updateRadiusRequest) Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.default CompletableFuture
<UpdateSettingsResponse> updateSettings
(Consumer<UpdateSettingsRequest.Builder> updateSettingsRequest) Updates the configurable settings for the specified directory.default CompletableFuture
<UpdateSettingsResponse> updateSettings
(UpdateSettingsRequest updateSettingsRequest) Updates the configurable settings for the specified directory.default CompletableFuture
<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 CompletableFuture
<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 CompletableFuture
<VerifyTrustResponse> verifyTrust
(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest) Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.default CompletableFuture
<VerifyTrustResponse> verifyTrust
(VerifyTrustRequest verifyTrustRequest) Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addIpRoutes
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.
- Parameters:
addIpRoutesRequest
-- Returns:
- A Java Future containing the result of the AddIpRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
addIpRoutes
default CompletableFuture<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. 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 viaAddIpRoutesRequest.builder()
- Parameters:
addIpRoutesRequest
- AConsumer
that will call methods onAddIpRoutesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddIpRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
addRegion
Adds two domain controllers in the specified Region for the specified directory.
- Parameters:
addRegionRequest
-- Returns:
- A Java Future containing the result of the AddRegion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
addRegion
default CompletableFuture<AddRegionResponse> addRegion(Consumer<AddRegionRequest.Builder> addRegionRequest) 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 viaAddRegionRequest.builder()
- Parameters:
addRegionRequest
- AConsumer
that will call methods onAddRegionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddRegion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
addTagsToResource
default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) 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.
- Parameters:
addTagsToResourceRequest
-- Returns:
- A Java Future containing the result of the AddTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
addTagsToResource
default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) 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 viaAddTagsToResourceRequest.builder()
- Parameters:
addTagsToResourceRequest
- AConsumer
that will call methods onAddTagsToResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
cancelSchemaExtension
default CompletableFuture<CancelSchemaExtensionResponse> cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest) 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
, andUpdatingSchema
.- Parameters:
cancelSchemaExtensionRequest
-- Returns:
- A Java Future containing the result of the CancelSchemaExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
cancelSchemaExtension
default CompletableFuture<CancelSchemaExtensionResponse> cancelSchemaExtension(Consumer<CancelSchemaExtensionRequest.Builder> cancelSchemaExtensionRequest) 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
, andUpdatingSchema
.
This is a convenience which creates an instance of the
CancelSchemaExtensionRequest.Builder
avoiding the need to create one manually viaCancelSchemaExtensionRequest.builder()
- Parameters:
cancelSchemaExtensionRequest
- AConsumer
that will call methods onCancelSchemaExtensionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelSchemaExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
connectDirectory
default CompletableFuture<ConnectDirectoryResponse> connectDirectory(ConnectDirectoryRequest connectDirectoryRequest) 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 theConnectDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.- Parameters:
connectDirectoryRequest
- Contains the inputs for the ConnectDirectory operation.- Returns:
- A Java Future containing the result of the ConnectDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
connectDirectory
default CompletableFuture<ConnectDirectoryResponse> connectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest) 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 theConnectDirectory
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 viaConnectDirectoryRequest.builder()
- Parameters:
connectDirectoryRequest
- AConsumer
that will call methods onConnectDirectoryRequest.Builder
to create a request. Contains the inputs for the ConnectDirectory operation.- Returns:
- A Java Future containing the result of the ConnectDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createAlias
Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as
http://<alias>.awsapps.com
.After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
- Parameters:
createAliasRequest
- Contains the inputs for the CreateAlias operation.- Returns:
- A Java Future containing the result of the CreateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createAlias
default CompletableFuture<CreateAliasResponse> createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as
http://<alias>.awsapps.com
.After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
This is a convenience which creates an instance of the
CreateAliasRequest.Builder
avoiding the need to create one manually viaCreateAliasRequest.builder()
- Parameters:
createAliasRequest
- AConsumer
that will call methods onCreateAliasRequest.Builder
to create a request. Contains the inputs for the CreateAlias operation.- Returns:
- A Java Future containing the result of the CreateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createComputer
default CompletableFuture<CreateComputerResponse> createComputer(CreateComputerRequest createComputerRequest) Creates an Active Directory computer object in the specified directory.
- Parameters:
createComputerRequest
- Contains the inputs for the CreateComputer operation.- Returns:
- A Java Future containing the result of the CreateComputer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createComputer
default CompletableFuture<CreateComputerResponse> createComputer(Consumer<CreateComputerRequest.Builder> createComputerRequest) 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 viaCreateComputerRequest.builder()
- Parameters:
createComputerRequest
- AConsumer
that will call methods onCreateComputerRequest.Builder
to create a request. Contains the inputs for the CreateComputer operation.- Returns:
- A Java Future containing the result of the CreateComputer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createConditionalForwarder
default CompletableFuture<CreateConditionalForwarderResponse> createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest) 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.
- Parameters:
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.- Returns:
- A Java Future containing the result of the CreateConditionalForwarder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createConditionalForwarder
default CompletableFuture<CreateConditionalForwarderResponse> createConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest) 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 viaCreateConditionalForwarderRequest.builder()
- Parameters:
createConditionalForwarderRequest
- AConsumer
that will call methods onCreateConditionalForwarderRequest.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.- Returns:
- A Java Future containing the result of the CreateConditionalForwarder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createDirectory
default CompletableFuture<CreateDirectoryResponse> createDirectory(CreateDirectoryRequest createDirectoryRequest) 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 theCreateDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.- Parameters:
createDirectoryRequest
- Contains the inputs for the CreateDirectory operation.- Returns:
- A Java Future containing the result of the CreateDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createDirectory
default CompletableFuture<CreateDirectoryResponse> createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest) 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 theCreateDirectory
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 viaCreateDirectoryRequest.builder()
- Parameters:
createDirectoryRequest
- AConsumer
that will call methods onCreateDirectoryRequest.Builder
to create a request. Contains the inputs for the CreateDirectory operation.- Returns:
- A Java Future containing the result of the CreateDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createLogSubscription
default CompletableFuture<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.
- Parameters:
createLogSubscriptionRequest
-- Returns:
- A Java Future containing the result of the CreateLogSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createLogSubscription
default CompletableFuture<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.
This is a convenience which creates an instance of the
CreateLogSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateLogSubscriptionRequest.builder()
- Parameters:
createLogSubscriptionRequest
- AConsumer
that will call methods onCreateLogSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateLogSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createMicrosoftAD
default CompletableFuture<CreateMicrosoftAdResponse> createMicrosoftAD(CreateMicrosoftAdRequest createMicrosoftAdRequest) 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.
- Parameters:
createMicrosoftAdRequest
- Creates an Managed Microsoft AD directory.- Returns:
- A Java Future containing the result of the CreateMicrosoftAD operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createMicrosoftAD
default CompletableFuture<CreateMicrosoftAdResponse> createMicrosoftAD(Consumer<CreateMicrosoftAdRequest.Builder> createMicrosoftAdRequest) 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 viaCreateMicrosoftAdRequest.builder()
- Parameters:
createMicrosoftAdRequest
- AConsumer
that will call methods onCreateMicrosoftAdRequest.Builder
to create a request. Creates an Managed Microsoft AD directory.- Returns:
- A Java Future containing the result of the CreateMicrosoftAD operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createSnapshot
default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest) 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.
- Parameters:
createSnapshotRequest
- Contains the inputs for the CreateSnapshot operation.- Returns:
- A Java Future containing the result of the CreateSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createSnapshot
default CompletableFuture<CreateSnapshotResponse> createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) 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 viaCreateSnapshotRequest.builder()
- Parameters:
createSnapshotRequest
- AConsumer
that will call methods onCreateSnapshotRequest.Builder
to create a request. Contains the inputs for the CreateSnapshot operation.- Returns:
- A Java Future containing the result of the CreateSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createTrust
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.
- Parameters:
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.
- Returns:
- A Java Future containing the result of the CreateTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createTrust
default CompletableFuture<CreateTrustResponse> createTrust(Consumer<CreateTrustRequest.Builder> 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. 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 viaCreateTrustRequest.builder()
- Parameters:
createTrustRequest
- AConsumer
that will call methods onCreateTrustRequest.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.
- Returns:
- A Java Future containing the result of the CreateTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteConditionalForwarder
default CompletableFuture<DeleteConditionalForwarderResponse> deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest) Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
- Parameters:
deleteConditionalForwarderRequest
- Deletes a conditional forwarder.- Returns:
- A Java Future containing the result of the DeleteConditionalForwarder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteConditionalForwarder
default CompletableFuture<DeleteConditionalForwarderResponse> deleteConditionalForwarder(Consumer<DeleteConditionalForwarderRequest.Builder> deleteConditionalForwarderRequest) 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 viaDeleteConditionalForwarderRequest.builder()
- Parameters:
deleteConditionalForwarderRequest
- AConsumer
that will call methods onDeleteConditionalForwarderRequest.Builder
to create a request. Deletes a conditional forwarder.- Returns:
- A Java Future containing the result of the DeleteConditionalForwarder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteDirectory
default CompletableFuture<DeleteDirectoryResponse> deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest) 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 theDeleteDirectory
operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.- Parameters:
deleteDirectoryRequest
- Contains the inputs for the DeleteDirectory operation.- Returns:
- A Java Future containing the result of the DeleteDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteDirectory
default CompletableFuture<DeleteDirectoryResponse> deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest) 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 theDeleteDirectory
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 viaDeleteDirectoryRequest.builder()
- Parameters:
deleteDirectoryRequest
- AConsumer
that will call methods onDeleteDirectoryRequest.Builder
to create a request. Contains the inputs for the DeleteDirectory operation.- Returns:
- A Java Future containing the result of the DeleteDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteLogSubscription
default CompletableFuture<DeleteLogSubscriptionResponse> deleteLogSubscription(DeleteLogSubscriptionRequest deleteLogSubscriptionRequest) Deletes the specified log subscription.
- Parameters:
deleteLogSubscriptionRequest
-- Returns:
- A Java Future containing the result of the DeleteLogSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteLogSubscription
default CompletableFuture<DeleteLogSubscriptionResponse> deleteLogSubscription(Consumer<DeleteLogSubscriptionRequest.Builder> deleteLogSubscriptionRequest) Deletes the specified log subscription.
This is a convenience which creates an instance of the
DeleteLogSubscriptionRequest.Builder
avoiding the need to create one manually viaDeleteLogSubscriptionRequest.builder()
- Parameters:
deleteLogSubscriptionRequest
- AConsumer
that will call methods onDeleteLogSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteLogSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteSnapshot
default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) Deletes a directory snapshot.
- Parameters:
deleteSnapshotRequest
- Contains the inputs for the DeleteSnapshot operation.- Returns:
- A Java Future containing the result of the DeleteSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteSnapshot
default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest) Deletes a directory snapshot.
This is a convenience which creates an instance of the
DeleteSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteSnapshotRequest.builder()
- Parameters:
deleteSnapshotRequest
- AConsumer
that will call methods onDeleteSnapshotRequest.Builder
to create a request. Contains the inputs for the DeleteSnapshot operation.- Returns:
- A Java Future containing the result of the DeleteSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteTrust
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
- Parameters:
deleteTrustRequest
- Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain.- Returns:
- A Java Future containing the result of the DeleteTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteTrust
default CompletableFuture<DeleteTrustResponse> deleteTrust(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest) 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 viaDeleteTrustRequest.builder()
- Parameters:
deleteTrustRequest
- AConsumer
that will call methods onDeleteTrustRequest.Builder
to create a request. Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain.- Returns:
- A Java Future containing the result of the DeleteTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deregisterCertificate
default CompletableFuture<DeregisterCertificateResponse> deregisterCertificate(DeregisterCertificateRequest deregisterCertificateRequest) Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
- Parameters:
deregisterCertificateRequest
-- Returns:
- A Java Future containing the result of the DeregisterCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deregisterCertificate
default CompletableFuture<DeregisterCertificateResponse> deregisterCertificate(Consumer<DeregisterCertificateRequest.Builder> deregisterCertificateRequest) 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 viaDeregisterCertificateRequest.builder()
- Parameters:
deregisterCertificateRequest
- AConsumer
that will call methods onDeregisterCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deregisterEventTopic
default CompletableFuture<DeregisterEventTopicResponse> deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest) Removes the specified directory as a publisher to the specified Amazon SNS topic.
- Parameters:
deregisterEventTopicRequest
- Removes the specified directory as a publisher to the specified Amazon SNS topic.- Returns:
- A Java Future containing the result of the DeregisterEventTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deregisterEventTopic
default CompletableFuture<DeregisterEventTopicResponse> deregisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest) 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 viaDeregisterEventTopicRequest.builder()
- Parameters:
deregisterEventTopicRequest
- AConsumer
that will call methods onDeregisterEventTopicRequest.Builder
to create a request. Removes the specified directory as a publisher to the specified Amazon SNS topic.- Returns:
- A Java Future containing the result of the DeregisterEventTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeCertificate
default CompletableFuture<DescribeCertificateResponse> describeCertificate(DescribeCertificateRequest describeCertificateRequest) Displays information about the certificate registered for secure LDAP or client certificate authentication.
- Parameters:
describeCertificateRequest
-- Returns:
- A Java Future containing the result of the DescribeCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeCertificate
default CompletableFuture<DescribeCertificateResponse> describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) 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 viaDescribeCertificateRequest.builder()
- Parameters:
describeCertificateRequest
- AConsumer
that will call methods onDescribeCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeClientAuthenticationSettings
default CompletableFuture<DescribeClientAuthenticationSettingsResponse> describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest) 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.- Parameters:
describeClientAuthenticationSettingsRequest
-- Returns:
- A Java Future containing the result of the DescribeClientAuthenticationSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeClientAuthenticationSettings
default CompletableFuture<DescribeClientAuthenticationSettingsResponse> describeClientAuthenticationSettings(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest) 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 viaDescribeClientAuthenticationSettingsRequest.builder()
- Parameters:
describeClientAuthenticationSettingsRequest
- AConsumer
that will call methods onDescribeClientAuthenticationSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClientAuthenticationSettings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeClientAuthenticationSettingsPaginator
default DescribeClientAuthenticationSettingsPublisher describeClientAuthenticationSettingsPaginator(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest) This is a variant of
describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsPublisher publisher = client.describeClientAuthenticationSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsPublisher publisher = client.describeClientAuthenticationSettingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsResponse response) { //... }; });
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
describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest)
operation.- Parameters:
describeClientAuthenticationSettingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeClientAuthenticationSettingsPaginator
default DescribeClientAuthenticationSettingsPublisher describeClientAuthenticationSettingsPaginator(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest) This is a variant of
describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsPublisher publisher = client.describeClientAuthenticationSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsPublisher publisher = client.describeClientAuthenticationSettingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsResponse response) { //... }; });
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
describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest)
operation.
This is a convenience which creates an instance of the
DescribeClientAuthenticationSettingsRequest.Builder
avoiding the need to create one manually viaDescribeClientAuthenticationSettingsRequest.builder()
- Parameters:
describeClientAuthenticationSettingsRequest
- AConsumer
that will call methods onDescribeClientAuthenticationSettingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeConditionalForwarders
default CompletableFuture<DescribeConditionalForwardersResponse> describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest) Obtains information about the conditional forwarders for this account.
If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
- Parameters:
describeConditionalForwardersRequest
- Describes a conditional forwarder.- Returns:
- A Java Future containing the result of the DescribeConditionalForwarders operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeConditionalForwarders
default CompletableFuture<DescribeConditionalForwardersResponse> describeConditionalForwarders(Consumer<DescribeConditionalForwardersRequest.Builder> describeConditionalForwardersRequest) Obtains information about the conditional forwarders for this account.
If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
This is a convenience which creates an instance of the
DescribeConditionalForwardersRequest.Builder
avoiding the need to create one manually viaDescribeConditionalForwardersRequest.builder()
- Parameters:
describeConditionalForwardersRequest
- AConsumer
that will call methods onDescribeConditionalForwardersRequest.Builder
to create a request. Describes a conditional forwarder.- Returns:
- A Java Future containing the result of the DescribeConditionalForwarders operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeDirectories
default CompletableFuture<DescribeDirectoriesResponse> describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest) Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the
DirectoryIds
parameter. Otherwise, all directories that belong to the current account are returned.This operation supports pagination with the use of the
NextToken
request and response parameters. If more results are available, theDescribeDirectoriesResult.NextToken
member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.You can also specify a maximum number of return results with the
Limit
parameter.- Parameters:
describeDirectoriesRequest
- Contains the inputs for the DescribeDirectories operation.- Returns:
- A Java Future containing the result of the DescribeDirectories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeDirectories
default CompletableFuture<DescribeDirectoriesResponse> describeDirectories(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest) Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the
DirectoryIds
parameter. Otherwise, all directories that belong to the current account are returned.This operation supports pagination with the use of the
NextToken
request and response parameters. If more results are available, theDescribeDirectoriesResult.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 viaDescribeDirectoriesRequest.builder()
- Parameters:
describeDirectoriesRequest
- AConsumer
that will call methods onDescribeDirectoriesRequest.Builder
to create a request. Contains the inputs for the DescribeDirectories operation.- Returns:
- A Java Future containing the result of the DescribeDirectories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeDirectories
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, theDescribeDirectoriesResult.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.- Returns:
- A Java Future containing the result of the DescribeDirectories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeDirectoriesPaginator
This is a variant of
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse response) { //... }; });
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
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeDirectoriesPaginator
default DescribeDirectoriesPublisher describeDirectoriesPaginator(DescribeDirectoriesRequest describeDirectoriesRequest) This is a variant of
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse response) { //... }; });
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
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)
operation.- Parameters:
describeDirectoriesRequest
- Contains the inputs for the DescribeDirectories operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeDirectoriesPaginator
default DescribeDirectoriesPublisher describeDirectoriesPaginator(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest) This is a variant of
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesPublisher publisher = client.describeDirectoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse response) { //... }; });
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
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)
operation.
This is a convenience which creates an instance of the
DescribeDirectoriesRequest.Builder
avoiding the need to create one manually viaDescribeDirectoriesRequest.builder()
- Parameters:
describeDirectoriesRequest
- AConsumer
that will call methods onDescribeDirectoriesRequest.Builder
to create a request. Contains the inputs for the DescribeDirectories operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeDomainControllers
default CompletableFuture<DescribeDomainControllersResponse> describeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest) Provides information about any domain controllers in your directory.
- Parameters:
describeDomainControllersRequest
-- Returns:
- A Java Future containing the result of the DescribeDomainControllers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeDomainControllers
default CompletableFuture<DescribeDomainControllersResponse> describeDomainControllers(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest) 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 viaDescribeDomainControllersRequest.builder()
- Parameters:
describeDomainControllersRequest
- AConsumer
that will call methods onDescribeDomainControllersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDomainControllers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeDomainControllersPaginator
default DescribeDomainControllersPublisher describeDomainControllersPaginator(DescribeDomainControllersRequest describeDomainControllersRequest) This is a variant of
describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeDomainControllersPublisher publisher = client.describeDomainControllersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersPublisher publisher = client.describeDomainControllersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse response) { //... }; });
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.- Parameters:
describeDomainControllersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeDomainControllersPaginator
default DescribeDomainControllersPublisher describeDomainControllersPaginator(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest) This is a variant of
describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeDomainControllersPublisher publisher = client.describeDomainControllersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersPublisher publisher = client.describeDomainControllersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse response) { //... }; });
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 viaDescribeDomainControllersRequest.builder()
- Parameters:
describeDomainControllersRequest
- AConsumer
that will call methods onDescribeDomainControllersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeEventTopics
default CompletableFuture<DescribeEventTopicsResponse> describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest) 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.
- Parameters:
describeEventTopicsRequest
- Describes event topics.- Returns:
- A Java Future containing the result of the DescribeEventTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeEventTopics
default CompletableFuture<DescribeEventTopicsResponse> describeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest) 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 viaDescribeEventTopicsRequest.builder()
- Parameters:
describeEventTopicsRequest
- AConsumer
that will call methods onDescribeEventTopicsRequest.Builder
to create a request. Describes event topics.- Returns:
- A Java Future containing the result of the DescribeEventTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeEventTopics
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.
- Returns:
- A Java Future containing the result of the DescribeEventTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeLDAPSSettings
default CompletableFuture<DescribeLdapsSettingsResponse> describeLDAPSSettings(DescribeLdapsSettingsRequest describeLdapsSettingsRequest) Describes the status of LDAP security for the specified directory.
- Parameters:
describeLdapsSettingsRequest
-- Returns:
- A Java Future containing the result of the DescribeLDAPSSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeLDAPSSettings
default CompletableFuture<DescribeLdapsSettingsResponse> describeLDAPSSettings(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest) 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 viaDescribeLdapsSettingsRequest.builder()
- Parameters:
describeLdapsSettingsRequest
- AConsumer
that will call methods onDescribeLdapsSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeLDAPSSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeLDAPSSettingsPaginator
default DescribeLDAPSSettingsPublisher describeLDAPSSettingsPaginator(DescribeLdapsSettingsRequest describeLdapsSettingsRequest) This is a variant of
describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsPublisher publisher = client.describeLDAPSSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsPublisher publisher = client.describeLDAPSSettingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsResponse response) { //... }; });
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
describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)
operation.- Parameters:
describeLdapsSettingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeLDAPSSettingsPaginator
default DescribeLDAPSSettingsPublisher describeLDAPSSettingsPaginator(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest) This is a variant of
describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsPublisher publisher = client.describeLDAPSSettingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsPublisher publisher = client.describeLDAPSSettingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsResponse response) { //... }; });
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
describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)
operation.
This is a convenience which creates an instance of the
DescribeLdapsSettingsRequest.Builder
avoiding the need to create one manually viaDescribeLdapsSettingsRequest.builder()
- Parameters:
describeLdapsSettingsRequest
- AConsumer
that will call methods onDescribeLdapsSettingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeRegions
default CompletableFuture<DescribeRegionsResponse> describeRegions(DescribeRegionsRequest describeRegionsRequest) Provides information about the Regions that are configured for multi-Region replication.
- Parameters:
describeRegionsRequest
-- Returns:
- A Java Future containing the result of the DescribeRegions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeRegions
default CompletableFuture<DescribeRegionsResponse> describeRegions(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest) 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 viaDescribeRegionsRequest.builder()
- Parameters:
describeRegionsRequest
- AConsumer
that will call methods onDescribeRegionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRegions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeRegionsPaginator
default DescribeRegionsPublisher describeRegionsPaginator(DescribeRegionsRequest describeRegionsRequest) This is a variant of
describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeRegionsPublisher publisher = client.describeRegionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeRegionsPublisher publisher = client.describeRegionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeRegionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeRegionsResponse response) { //... }; });
Please notice that the configuration of null 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
describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest)
operation.- Parameters:
describeRegionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeRegionsPaginator
default DescribeRegionsPublisher describeRegionsPaginator(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest) This is a variant of
describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeRegionsPublisher publisher = client.describeRegionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeRegionsPublisher publisher = client.describeRegionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeRegionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeRegionsResponse response) { //... }; });
Please notice that the configuration of null 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
describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRegionsRequest.Builder
avoiding the need to create one manually viaDescribeRegionsRequest.builder()
- Parameters:
describeRegionsRequest
- AConsumer
that will call methods onDescribeRegionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeSettings
default CompletableFuture<DescribeSettingsResponse> describeSettings(DescribeSettingsRequest describeSettingsRequest) Retrieves information about the configurable settings for the specified directory.
- Parameters:
describeSettingsRequest
-- Returns:
- A Java Future containing the result of the DescribeSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeSettings
default CompletableFuture<DescribeSettingsResponse> describeSettings(Consumer<DescribeSettingsRequest.Builder> describeSettingsRequest) 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 viaDescribeSettingsRequest.builder()
- Parameters:
describeSettingsRequest
- AConsumer
that will call methods onDescribeSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeSnapshots
default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
- Parameters:
describeSnapshotsRequest
- Contains the inputs for the DescribeSnapshots operation.- Returns:
- A Java Future containing the result of the DescribeSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeSnapshots
default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
This is a convenience which creates an instance of the
DescribeSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeSnapshotsRequest.builder()
- Parameters:
describeSnapshotsRequest
- AConsumer
that will call methods onDescribeSnapshotsRequest.Builder
to create a request. Contains the inputs for the DescribeSnapshots operation.- Returns:
- A Java Future containing the result of the DescribeSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeSnapshots
Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
- Returns:
- A Java Future containing the result of the DescribeSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeSnapshotsPaginator
This is a variant of
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse response) { //... }; });
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
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeSnapshotsPaginator
default DescribeSnapshotsPublisher describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest) This is a variant of
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse response) { //... }; });
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
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)
operation.- Parameters:
describeSnapshotsRequest
- Contains the inputs for the DescribeSnapshots operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeSnapshotsPaginator
default DescribeSnapshotsPublisher describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) This is a variant of
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse response) { //... }; });
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
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)
operation.
This is a convenience which creates an instance of the
DescribeSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeSnapshotsRequest.builder()
- Parameters:
describeSnapshotsRequest
- AConsumer
that will call methods onDescribeSnapshotsRequest.Builder
to create a request. Contains the inputs for the DescribeSnapshots operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeTrusts
default CompletableFuture<DescribeTrustsResponse> describeTrusts(DescribeTrustsRequest describeTrustsRequest) Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
- Parameters:
describeTrustsRequest
- Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters are provided, such as directory ID or trust ID, this request describes all the trust relationships.- Returns:
- A Java Future containing the result of the DescribeTrusts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeTrusts
default CompletableFuture<DescribeTrustsResponse> describeTrusts(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest) Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
This is a convenience which creates an instance of the
DescribeTrustsRequest.Builder
avoiding the need to create one manually viaDescribeTrustsRequest.builder()
- Parameters:
describeTrustsRequest
- AConsumer
that will call methods onDescribeTrustsRequest.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.- Returns:
- A Java Future containing the result of the DescribeTrusts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeTrusts
Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
- Returns:
- A Java Future containing the result of the DescribeTrusts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeTrustsPaginator
This is a variant of
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeTrustsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeTrustsResponse response) { //... }; });
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
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeTrustsPaginator
default DescribeTrustsPublisher describeTrustsPaginator(DescribeTrustsRequest describeTrustsRequest) This is a variant of
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeTrustsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeTrustsResponse response) { //... }; });
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
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)
operation.- Parameters:
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeTrustsPaginator
default DescribeTrustsPublisher describeTrustsPaginator(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest) This is a variant of
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeTrustsPublisher publisher = client.describeTrustsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeTrustsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeTrustsResponse response) { //... }; });
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
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)
operation.
This is a convenience which creates an instance of the
DescribeTrustsRequest.Builder
avoiding the need to create one manually viaDescribeTrustsRequest.builder()
- Parameters:
describeTrustsRequest
- AConsumer
that will call methods onDescribeTrustsRequest.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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeUpdateDirectory
default CompletableFuture<DescribeUpdateDirectoryResponse> describeUpdateDirectory(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest) Describes the updates of a directory for a particular update type.
- Parameters:
describeUpdateDirectoryRequest
-- Returns:
- A Java Future containing the result of the DescribeUpdateDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- DirectoryDoesNotExistException The specified directory does not exist in the system.
- InvalidParameterException One or more parameters are not valid.
- AccessDeniedException Client authentication is not available in this region at this time.
- ClientException A client exception has occurred.
- ServiceException An exception has occurred in Directory Service.
- InvalidNextTokenException The
NextToken
value is not valid. - 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.
- See Also:
-
describeUpdateDirectory
default CompletableFuture<DescribeUpdateDirectoryResponse> describeUpdateDirectory(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest) Describes the updates of a directory for a particular update type.
This is a convenience which creates an instance of the
DescribeUpdateDirectoryRequest.Builder
avoiding the need to create one manually viaDescribeUpdateDirectoryRequest.builder()
- Parameters:
describeUpdateDirectoryRequest
- AConsumer
that will call methods onDescribeUpdateDirectoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUpdateDirectory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- DirectoryDoesNotExistException The specified directory does not exist in the system.
- InvalidParameterException One or more parameters are not valid.
- AccessDeniedException Client authentication is not available in this region at this time.
- ClientException A client exception has occurred.
- ServiceException An exception has occurred in Directory Service.
- InvalidNextTokenException The
NextToken
value is not valid. - 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.
- See Also:
-
describeUpdateDirectoryPaginator
default DescribeUpdateDirectoryPublisher describeUpdateDirectoryPaginator(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest) This is a variant of
describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryPublisher publisher = client.describeUpdateDirectoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryPublisher publisher = client.describeUpdateDirectoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryResponse response) { //... }; });
Please notice that the configuration of null 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
describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest)
operation.- Parameters:
describeUpdateDirectoryRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- DirectoryDoesNotExistException The specified directory does not exist in the system.
- InvalidParameterException One or more parameters are not valid.
- AccessDeniedException Client authentication is not available in this region at this time.
- ClientException A client exception has occurred.
- ServiceException An exception has occurred in Directory Service.
- InvalidNextTokenException The
NextToken
value is not valid. - 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.
- See Also:
-
describeUpdateDirectoryPaginator
default DescribeUpdateDirectoryPublisher describeUpdateDirectoryPaginator(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest) This is a variant of
describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryPublisher publisher = client.describeUpdateDirectoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryPublisher publisher = client.describeUpdateDirectoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryResponse response) { //... }; });
Please notice that the configuration of null 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
describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest)
operation.
This is a convenience which creates an instance of the
DescribeUpdateDirectoryRequest.Builder
avoiding the need to create one manually viaDescribeUpdateDirectoryRequest.builder()
- Parameters:
describeUpdateDirectoryRequest
- AConsumer
that will call methods onDescribeUpdateDirectoryRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- DirectoryDoesNotExistException The specified directory does not exist in the system.
- InvalidParameterException One or more parameters are not valid.
- AccessDeniedException Client authentication is not available in this region at this time.
- ClientException A client exception has occurred.
- ServiceException An exception has occurred in Directory Service.
- InvalidNextTokenException The
NextToken
value is not valid. - 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.
- See Also:
-
disableClientAuthentication
default CompletableFuture<DisableClientAuthenticationResponse> disableClientAuthentication(DisableClientAuthenticationRequest disableClientAuthenticationRequest) Disables alternative client authentication methods for the specified directory.
- Parameters:
disableClientAuthenticationRequest
-- Returns:
- A Java Future containing the result of the DisableClientAuthentication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
disableClientAuthentication
default CompletableFuture<DisableClientAuthenticationResponse> disableClientAuthentication(Consumer<DisableClientAuthenticationRequest.Builder> disableClientAuthenticationRequest) 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 viaDisableClientAuthenticationRequest.builder()
- Parameters:
disableClientAuthenticationRequest
- AConsumer
that will call methods onDisableClientAuthenticationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableClientAuthentication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
disableLDAPS
default CompletableFuture<DisableLdapsResponse> disableLDAPS(DisableLdapsRequest disableLdapsRequest) Deactivates LDAP secure calls for the specified directory.
- Parameters:
disableLdapsRequest
-- Returns:
- A Java Future containing the result of the DisableLDAPS operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
disableLDAPS
default CompletableFuture<DisableLdapsResponse> disableLDAPS(Consumer<DisableLdapsRequest.Builder> disableLdapsRequest) 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 viaDisableLdapsRequest.builder()
- Parameters:
disableLdapsRequest
- AConsumer
that will call methods onDisableLdapsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableLDAPS operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
disableRadius
default CompletableFuture<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.
- Parameters:
disableRadiusRequest
- Contains the inputs for the DisableRadius operation.- Returns:
- A Java Future containing the result of the DisableRadius operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
disableRadius
default CompletableFuture<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.
This is a convenience which creates an instance of the
DisableRadiusRequest.Builder
avoiding the need to create one manually viaDisableRadiusRequest.builder()
- Parameters:
disableRadiusRequest
- AConsumer
that will call methods onDisableRadiusRequest.Builder
to create a request. Contains the inputs for the DisableRadius operation.- Returns:
- A Java Future containing the result of the DisableRadius operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
disableSso
Disables single-sign on for a directory.
- Parameters:
disableSsoRequest
- Contains the inputs for the DisableSso operation.- Returns:
- A Java Future containing the result of the DisableSso operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
disableSso
default CompletableFuture<DisableSsoResponse> disableSso(Consumer<DisableSsoRequest.Builder> disableSsoRequest) 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 viaDisableSsoRequest.builder()
- Parameters:
disableSsoRequest
- AConsumer
that will call methods onDisableSsoRequest.Builder
to create a request. Contains the inputs for the DisableSso operation.- Returns:
- A Java Future containing the result of the DisableSso operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
enableClientAuthentication
default CompletableFuture<EnableClientAuthenticationResponse> enableClientAuthentication(EnableClientAuthenticationRequest enableClientAuthenticationRequest) Enables alternative client authentication methods for the specified directory.
- Parameters:
enableClientAuthenticationRequest
-- Returns:
- A Java Future containing the result of the EnableClientAuthentication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
enableClientAuthentication
default CompletableFuture<EnableClientAuthenticationResponse> enableClientAuthentication(Consumer<EnableClientAuthenticationRequest.Builder> enableClientAuthenticationRequest) 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 viaEnableClientAuthenticationRequest.builder()
- Parameters:
enableClientAuthenticationRequest
- AConsumer
that will call methods onEnableClientAuthenticationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableClientAuthentication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
enableLDAPS
Activates the switch for the specific directory to always use LDAP secure calls.
- Parameters:
enableLdapsRequest
-- Returns:
- A Java Future containing the result of the EnableLDAPS operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
enableLDAPS
default CompletableFuture<EnableLdapsResponse> enableLDAPS(Consumer<EnableLdapsRequest.Builder> enableLdapsRequest) 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 viaEnableLdapsRequest.builder()
- Parameters:
enableLdapsRequest
- AConsumer
that will call methods onEnableLdapsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableLDAPS operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
enableRadius
default CompletableFuture<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.
- Parameters:
enableRadiusRequest
- Contains the inputs for the EnableRadius operation.- Returns:
- A Java Future containing the result of the EnableRadius operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
enableRadius
default CompletableFuture<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.
This is a convenience which creates an instance of the
EnableRadiusRequest.Builder
avoiding the need to create one manually viaEnableRadiusRequest.builder()
- Parameters:
enableRadiusRequest
- AConsumer
that will call methods onEnableRadiusRequest.Builder
to create a request. Contains the inputs for the EnableRadius operation.- Returns:
- A Java Future containing the result of the EnableRadius operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
enableSso
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.
- Parameters:
enableSsoRequest
- Contains the inputs for the EnableSso operation.- Returns:
- A Java Future containing the result of the EnableSso operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
enableSso
default CompletableFuture<EnableSsoResponse> enableSso(Consumer<EnableSsoRequest.Builder> enableSsoRequest) 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 viaEnableSsoRequest.builder()
- Parameters:
enableSsoRequest
- AConsumer
that will call methods onEnableSsoRequest.Builder
to create a request. Contains the inputs for the EnableSso operation.- Returns:
- A Java Future containing the result of the EnableSso operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
getDirectoryLimits
default CompletableFuture<GetDirectoryLimitsResponse> getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest) Obtains directory limit information for the current Region.
- Parameters:
getDirectoryLimitsRequest
- Contains the inputs for the GetDirectoryLimits operation.- Returns:
- A Java Future containing the result of the GetDirectoryLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
getDirectoryLimits
default CompletableFuture<GetDirectoryLimitsResponse> getDirectoryLimits(Consumer<GetDirectoryLimitsRequest.Builder> getDirectoryLimitsRequest) 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 viaGetDirectoryLimitsRequest.builder()
- Parameters:
getDirectoryLimitsRequest
- AConsumer
that will call methods onGetDirectoryLimitsRequest.Builder
to create a request. Contains the inputs for the GetDirectoryLimits operation.- Returns:
- A Java Future containing the result of the GetDirectoryLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
getDirectoryLimits
Obtains directory limit information for the current Region.
- Returns:
- A Java Future containing the result of the GetDirectoryLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
getSnapshotLimits
default CompletableFuture<GetSnapshotLimitsResponse> getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest) Obtains the manual snapshot limits for a directory.
- Parameters:
getSnapshotLimitsRequest
- Contains the inputs for the GetSnapshotLimits operation.- Returns:
- A Java Future containing the result of the GetSnapshotLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
getSnapshotLimits
default CompletableFuture<GetSnapshotLimitsResponse> getSnapshotLimits(Consumer<GetSnapshotLimitsRequest.Builder> getSnapshotLimitsRequest) 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 viaGetSnapshotLimitsRequest.builder()
- Parameters:
getSnapshotLimitsRequest
- AConsumer
that will call methods onGetSnapshotLimitsRequest.Builder
to create a request. Contains the inputs for the GetSnapshotLimits operation.- Returns:
- A Java Future containing the result of the GetSnapshotLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listCertificates
default CompletableFuture<ListCertificatesResponse> listCertificates(ListCertificatesRequest listCertificatesRequest) For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
- Parameters:
listCertificatesRequest
-- Returns:
- A Java Future containing the result of the ListCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listCertificates
default CompletableFuture<ListCertificatesResponse> listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) 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 viaListCertificatesRequest.builder()
- Parameters:
listCertificatesRequest
- AConsumer
that will call methods onListCertificatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listCertificatesPaginator
default ListCertificatesPublisher listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) This is a variant of
listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListCertificatesResponse response) { //... }; });
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
listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)
operation.- Parameters:
listCertificatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listCertificatesPaginator
default ListCertificatesPublisher listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) This is a variant of
listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListCertificatesResponse response) { //... }; });
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
listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)
operation.
This is a convenience which creates an instance of the
ListCertificatesRequest.Builder
avoiding the need to create one manually viaListCertificatesRequest.builder()
- Parameters:
listCertificatesRequest
- AConsumer
that will call methods onListCertificatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listIpRoutes
default CompletableFuture<ListIpRoutesResponse> listIpRoutes(ListIpRoutesRequest listIpRoutesRequest) Lists the address blocks that you have added to a directory.
- Parameters:
listIpRoutesRequest
-- Returns:
- A Java Future containing the result of the ListIpRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listIpRoutes
default CompletableFuture<ListIpRoutesResponse> listIpRoutes(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest) 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 viaListIpRoutesRequest.builder()
- Parameters:
listIpRoutesRequest
- AConsumer
that will call methods onListIpRoutesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListIpRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listIpRoutesPaginator
This is a variant of
listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListIpRoutesPublisher publisher = client.listIpRoutesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListIpRoutesPublisher publisher = client.listIpRoutesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListIpRoutesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListIpRoutesResponse response) { //... }; });
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
listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)
operation.- Parameters:
listIpRoutesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listIpRoutesPaginator
default ListIpRoutesPublisher listIpRoutesPaginator(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest) This is a variant of
listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListIpRoutesPublisher publisher = client.listIpRoutesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListIpRoutesPublisher publisher = client.listIpRoutesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListIpRoutesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListIpRoutesResponse response) { //... }; });
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
listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)
operation.
This is a convenience which creates an instance of the
ListIpRoutesRequest.Builder
avoiding the need to create one manually viaListIpRoutesRequest.builder()
- Parameters:
listIpRoutesRequest
- AConsumer
that will call methods onListIpRoutesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listLogSubscriptions
default CompletableFuture<ListLogSubscriptionsResponse> listLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest) Lists the active log subscriptions for the Amazon Web Services account.
- Parameters:
listLogSubscriptionsRequest
-- Returns:
- A Java Future containing the result of the ListLogSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listLogSubscriptions
default CompletableFuture<ListLogSubscriptionsResponse> listLogSubscriptions(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest) 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 viaListLogSubscriptionsRequest.builder()
- Parameters:
listLogSubscriptionsRequest
- AConsumer
that will call methods onListLogSubscriptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListLogSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listLogSubscriptions
Lists the active log subscriptions for the Amazon Web Services account.
- Returns:
- A Java Future containing the result of the ListLogSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listLogSubscriptionsPaginator
This is a variant of
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse response) { //... }; });
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
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listLogSubscriptionsPaginator
default ListLogSubscriptionsPublisher listLogSubscriptionsPaginator(ListLogSubscriptionsRequest listLogSubscriptionsRequest) This is a variant of
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse response) { //... }; });
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
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)
operation.- Parameters:
listLogSubscriptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listLogSubscriptionsPaginator
default ListLogSubscriptionsPublisher listLogSubscriptionsPaginator(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest) This is a variant of
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsPublisher publisher = client.listLogSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse response) { //... }; });
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
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the
ListLogSubscriptionsRequest.Builder
avoiding the need to create one manually viaListLogSubscriptionsRequest.builder()
- Parameters:
listLogSubscriptionsRequest
- AConsumer
that will call methods onListLogSubscriptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listSchemaExtensions
default CompletableFuture<ListSchemaExtensionsResponse> listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest) Lists all schema extensions applied to a Microsoft AD Directory.
- Parameters:
listSchemaExtensionsRequest
-- Returns:
- A Java Future containing the result of the ListSchemaExtensions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- InvalidNextTokenException The
- See Also:
-
listSchemaExtensions
default CompletableFuture<ListSchemaExtensionsResponse> listSchemaExtensions(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest) 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 viaListSchemaExtensionsRequest.builder()
- Parameters:
listSchemaExtensionsRequest
- AConsumer
that will call methods onListSchemaExtensionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSchemaExtensions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- InvalidNextTokenException The
- See Also:
-
listSchemaExtensionsPaginator
default ListSchemaExtensionsPublisher listSchemaExtensionsPaginator(ListSchemaExtensionsRequest listSchemaExtensionsRequest) This is a variant of
listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsPublisher publisher = client.listSchemaExtensionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsPublisher publisher = client.listSchemaExtensionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListSchemaExtensionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsResponse response) { //... }; });
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
listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)
operation.- Parameters:
listSchemaExtensionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- InvalidNextTokenException The
- See Also:
-
listSchemaExtensionsPaginator
default ListSchemaExtensionsPublisher listSchemaExtensionsPaginator(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest) This is a variant of
listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsPublisher publisher = client.listSchemaExtensionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsPublisher publisher = client.listSchemaExtensionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListSchemaExtensionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsResponse response) { //... }; });
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
listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)
operation.
This is a convenience which creates an instance of the
ListSchemaExtensionsRequest.Builder
avoiding the need to create one manually viaListSchemaExtensionsRequest.builder()
- Parameters:
listSchemaExtensionsRequest
- AConsumer
that will call methods onListSchemaExtensionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- InvalidNextTokenException The
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on a directory.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListTagsForResourceResponse response) { //... }; });
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
listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.directory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.directory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.directory.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.directory.model.ListTagsForResourceResponse response) { //... }; });
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
listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
registerCertificate
default CompletableFuture<RegisterCertificateResponse> registerCertificate(RegisterCertificateRequest registerCertificateRequest) Registers a certificate for a secure LDAP or client certificate authentication.
- Parameters:
registerCertificateRequest
-- Returns:
- A Java Future containing the result of the RegisterCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
registerCertificate
default CompletableFuture<RegisterCertificateResponse> registerCertificate(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest) 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 viaRegisterCertificateRequest.builder()
- Parameters:
registerCertificateRequest
- AConsumer
that will call methods onRegisterCertificateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
registerEventTopic
default CompletableFuture<RegisterEventTopicResponse> registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest) 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.
- Parameters:
registerEventTopicRequest
- Registers a new event topic.- Returns:
- A Java Future containing the result of the RegisterEventTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
registerEventTopic
default CompletableFuture<RegisterEventTopicResponse> registerEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest) 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 viaRegisterEventTopicRequest.builder()
- Parameters:
registerEventTopicRequest
- AConsumer
that will call methods onRegisterEventTopicRequest.Builder
to create a request. Registers a new event topic.- Returns:
- A Java Future containing the result of the RegisterEventTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
removeIpRoutes
default CompletableFuture<RemoveIpRoutesResponse> removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest) Removes IP address blocks from a directory.
- Parameters:
removeIpRoutesRequest
-- Returns:
- A Java Future containing the result of the RemoveIpRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
removeIpRoutes
default CompletableFuture<RemoveIpRoutesResponse> removeIpRoutes(Consumer<RemoveIpRoutesRequest.Builder> removeIpRoutesRequest) 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 viaRemoveIpRoutesRequest.builder()
- Parameters:
removeIpRoutesRequest
- AConsumer
that will call methods onRemoveIpRoutesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveIpRoutes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
removeRegion
default CompletableFuture<RemoveRegionResponse> removeRegion(RemoveRegionRequest removeRegionRequest) 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.- Parameters:
removeRegionRequest
-- Returns:
- A Java Future containing the result of the RemoveRegion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
removeRegion
default CompletableFuture<RemoveRegionResponse> removeRegion(Consumer<RemoveRegionRequest.Builder> removeRegionRequest) 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 viaRemoveRegionRequest.builder()
- Parameters:
removeRegionRequest
- AConsumer
that will call methods onRemoveRegionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveRegion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
removeTagsFromResource
default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes tags from a directory.
- Parameters:
removeTagsFromResourceRequest
-- Returns:
- A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
removeTagsFromResource
default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) Removes tags from a directory.
This is a convenience which creates an instance of the
RemoveTagsFromResourceRequest.Builder
avoiding the need to create one manually viaRemoveTagsFromResourceRequest.builder()
- Parameters:
removeTagsFromResourceRequest
- AConsumer
that will call methods onRemoveTagsFromResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
resetUserPassword
default CompletableFuture<ResetUserPasswordResponse> resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest) 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.
- Parameters:
resetUserPasswordRequest
-- Returns:
- A Java Future containing the result of the ResetUserPassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
resetUserPassword
default CompletableFuture<ResetUserPasswordResponse> resetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest) 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 viaResetUserPasswordRequest.builder()
- Parameters:
resetUserPasswordRequest
- AConsumer
that will call methods onResetUserPasswordRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetUserPassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
restoreFromSnapshot
default CompletableFuture<RestoreFromSnapshotResponse> restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest) Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to
Active
, the restore operation is complete.- Parameters:
restoreFromSnapshotRequest
- An object representing the inputs for the RestoreFromSnapshot operation.- Returns:
- A Java Future containing the result of the RestoreFromSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
restoreFromSnapshot
default CompletableFuture<RestoreFromSnapshotResponse> restoreFromSnapshot(Consumer<RestoreFromSnapshotRequest.Builder> restoreFromSnapshotRequest) Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to
Active
, the restore operation is complete.
This is a convenience which creates an instance of the
RestoreFromSnapshotRequest.Builder
avoiding the need to create one manually viaRestoreFromSnapshotRequest.builder()
- Parameters:
restoreFromSnapshotRequest
- AConsumer
that will call methods onRestoreFromSnapshotRequest.Builder
to create a request. An object representing the inputs for the RestoreFromSnapshot operation.- Returns:
- A Java Future containing the result of the RestoreFromSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
startSchemaExtension
default CompletableFuture<StartSchemaExtensionResponse> startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest) Applies a schema extension to a Microsoft AD directory.
- Parameters:
startSchemaExtensionRequest
-- Returns:
- A Java Future containing the result of the StartSchemaExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
startSchemaExtension
default CompletableFuture<StartSchemaExtensionResponse> startSchemaExtension(Consumer<StartSchemaExtensionRequest.Builder> startSchemaExtensionRequest) 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 viaStartSchemaExtensionRequest.builder()
- Parameters:
startSchemaExtensionRequest
- AConsumer
that will call methods onStartSchemaExtensionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartSchemaExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateConditionalForwarder
default CompletableFuture<UpdateConditionalForwarderResponse> updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest) Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
- Parameters:
updateConditionalForwarderRequest
- Updates a conditional forwarder.- Returns:
- A Java Future containing the result of the UpdateConditionalForwarder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateConditionalForwarder
default CompletableFuture<UpdateConditionalForwarderResponse> updateConditionalForwarder(Consumer<UpdateConditionalForwarderRequest.Builder> updateConditionalForwarderRequest) 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 viaUpdateConditionalForwarderRequest.builder()
- Parameters:
updateConditionalForwarderRequest
- AConsumer
that will call methods onUpdateConditionalForwarderRequest.Builder
to create a request. Updates a conditional forwarder.- Returns:
- A Java Future containing the result of the UpdateConditionalForwarder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateDirectorySetup
default CompletableFuture<UpdateDirectorySetupResponse> updateDirectorySetup(UpdateDirectorySetupRequest updateDirectorySetupRequest) Updates the directory for a particular update type.
- Parameters:
updateDirectorySetupRequest
-- Returns:
- A Java Future containing the result of the UpdateDirectorySetup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- UnsupportedOperationException The operation is not supported.
- DirectoryInDesiredStateException The directory is already updated to desired update type settings.
- DirectoryUnavailableException The specified directory is unavailable or could not be found.
- SnapshotLimitExceededException The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.
- InvalidParameterException One or more parameters are not valid.
- DirectoryDoesNotExistException The specified directory does not exist in the system.
- AccessDeniedException Client authentication is not available in this region at this time.
- ClientException A client exception has occurred.
- ServiceException An exception has occurred in Directory Service.
- 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.
- See Also:
-
updateDirectorySetup
default CompletableFuture<UpdateDirectorySetupResponse> updateDirectorySetup(Consumer<UpdateDirectorySetupRequest.Builder> updateDirectorySetupRequest) Updates the directory for a particular update type.
This is a convenience which creates an instance of the
UpdateDirectorySetupRequest.Builder
avoiding the need to create one manually viaUpdateDirectorySetupRequest.builder()
- Parameters:
updateDirectorySetupRequest
- AConsumer
that will call methods onUpdateDirectorySetupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDirectorySetup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- UnsupportedOperationException The operation is not supported.
- DirectoryInDesiredStateException The directory is already updated to desired update type settings.
- DirectoryUnavailableException The specified directory is unavailable or could not be found.
- SnapshotLimitExceededException The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.
- InvalidParameterException One or more parameters are not valid.
- DirectoryDoesNotExistException The specified directory does not exist in the system.
- AccessDeniedException Client authentication is not available in this region at this time.
- ClientException A client exception has occurred.
- ServiceException An exception has occurred in Directory Service.
- 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.
- See Also:
-
updateNumberOfDomainControllers
default CompletableFuture<UpdateNumberOfDomainControllersResponse> updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest) 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.
- Parameters:
updateNumberOfDomainControllersRequest
-- Returns:
- A Java Future containing the result of the UpdateNumberOfDomainControllers operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateNumberOfDomainControllers
default CompletableFuture<UpdateNumberOfDomainControllersResponse> updateNumberOfDomainControllers(Consumer<UpdateNumberOfDomainControllersRequest.Builder> updateNumberOfDomainControllersRequest) 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 viaUpdateNumberOfDomainControllersRequest.builder()
- Parameters:
updateNumberOfDomainControllersRequest
- AConsumer
that will call methods onUpdateNumberOfDomainControllersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateNumberOfDomainControllers operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateRadius
default CompletableFuture<UpdateRadiusResponse> updateRadius(UpdateRadiusRequest updateRadiusRequest) Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
- Parameters:
updateRadiusRequest
- Contains the inputs for the UpdateRadius operation.- Returns:
- A Java Future containing the result of the UpdateRadius operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateRadius
default CompletableFuture<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.
This is a convenience which creates an instance of the
UpdateRadiusRequest.Builder
avoiding the need to create one manually viaUpdateRadiusRequest.builder()
- Parameters:
updateRadiusRequest
- AConsumer
that will call methods onUpdateRadiusRequest.Builder
to create a request. Contains the inputs for the UpdateRadius operation.- Returns:
- A Java Future containing the result of the UpdateRadius operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateSettings
default CompletableFuture<UpdateSettingsResponse> updateSettings(UpdateSettingsRequest updateSettingsRequest) Updates the configurable settings for the specified directory.
- Parameters:
updateSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdateSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateSettings
default CompletableFuture<UpdateSettingsResponse> updateSettings(Consumer<UpdateSettingsRequest.Builder> updateSettingsRequest) 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 viaUpdateSettingsRequest.builder()
- Parameters:
updateSettingsRequest
- AConsumer
that will call methods onUpdateSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateTrust
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
- Parameters:
updateTrustRequest
-- Returns:
- A Java Future containing the result of the UpdateTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateTrust
default CompletableFuture<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.
This is a convenience which creates an instance of the
UpdateTrustRequest.Builder
avoiding the need to create one manually viaUpdateTrustRequest.builder()
- Parameters:
updateTrustRequest
- AConsumer
that will call methods onUpdateTrustRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
verifyTrust
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.
- Parameters:
verifyTrustRequest
- Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.- Returns:
- A Java Future containing the result of the VerifyTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
verifyTrust
default CompletableFuture<VerifyTrustResponse> verifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest) 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 viaVerifyTrustRequest.builder()
- Parameters:
verifyTrustRequest
- AConsumer
that will call methods onVerifyTrustRequest.Builder
to create a request. Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.- Returns:
- A Java Future containing the result of the VerifyTrust operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aDirectoryAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aDirectoryAsyncClient
.