Interface DirectoryClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface DirectoryClient extends AwsClient
Service client for accessing Directory Service. This can be created using the staticbuilder()method.Directory Service 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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AcceptSharedDirectoryResponseacceptSharedDirectory(Consumer<AcceptSharedDirectoryRequest.Builder> acceptSharedDirectoryRequest)Accepts a directory sharing request that was sent from the directory owner account.default AcceptSharedDirectoryResponseacceptSharedDirectory(AcceptSharedDirectoryRequest acceptSharedDirectoryRequest)Accepts a directory sharing request that was sent from the directory owner account.default AddIpRoutesResponseaddIpRoutes(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 AddIpRoutesResponseaddIpRoutes(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 AddRegionResponseaddRegion(Consumer<AddRegionRequest.Builder> addRegionRequest)Adds two domain controllers in the specified Region for the specified directory.default AddRegionResponseaddRegion(AddRegionRequest addRegionRequest)Adds two domain controllers in the specified Region for the specified directory.default AddTagsToResourceResponseaddTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)Adds or overwrites one or more tags for the specified directory.default AddTagsToResourceResponseaddTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)Adds or overwrites one or more tags for the specified directory.static DirectoryClientBuilderbuilder()Create a builder that can be used to configure and create aDirectoryClient.default CancelSchemaExtensionResponsecancelSchemaExtension(Consumer<CancelSchemaExtensionRequest.Builder> cancelSchemaExtensionRequest)Cancels an in-progress schema extension to a Microsoft AD directory.default CancelSchemaExtensionResponsecancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest)Cancels an in-progress schema extension to a Microsoft AD directory.default ConnectDirectoryResponseconnectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest)Creates an AD Connector to connect to a self-managed directory.default ConnectDirectoryResponseconnectDirectory(ConnectDirectoryRequest connectDirectoryRequest)Creates an AD Connector to connect to a self-managed directory.static DirectoryClientcreate()Create aDirectoryClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAliasResponsecreateAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)Creates an alias for a directory and assigns the alias to the directory.default CreateAliasResponsecreateAlias(CreateAliasRequest createAliasRequest)Creates an alias for a directory and assigns the alias to the directory.default CreateComputerResponsecreateComputer(Consumer<CreateComputerRequest.Builder> createComputerRequest)Creates an Active Directory computer object in the specified directory.default CreateComputerResponsecreateComputer(CreateComputerRequest createComputerRequest)Creates an Active Directory computer object in the specified directory.default CreateConditionalForwarderResponsecreateConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest)Creates a conditional forwarder associated with your Amazon Web Services directory.default CreateConditionalForwarderResponsecreateConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)Creates a conditional forwarder associated with your Amazon Web Services directory.default CreateDirectoryResponsecreateDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest)Creates a Simple AD directory.default CreateDirectoryResponsecreateDirectory(CreateDirectoryRequest createDirectoryRequest)Creates a Simple AD directory.default CreateLogSubscriptionResponsecreateLogSubscription(Consumer<CreateLogSubscriptionRequest.Builder> createLogSubscriptionRequest)Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.default CreateLogSubscriptionResponsecreateLogSubscription(CreateLogSubscriptionRequest createLogSubscriptionRequest)Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.default CreateMicrosoftAdResponsecreateMicrosoftAD(Consumer<CreateMicrosoftAdRequest.Builder> createMicrosoftAdRequest)Creates a Microsoft AD directory in the Amazon Web Services Cloud.default CreateMicrosoftAdResponsecreateMicrosoftAD(CreateMicrosoftAdRequest createMicrosoftAdRequest)Creates a Microsoft AD directory in the Amazon Web Services Cloud.default CreateSnapshotResponsecreateSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.default CreateSnapshotResponsecreateSnapshot(CreateSnapshotRequest createSnapshotRequest)Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.default CreateTrustResponsecreateTrust(Consumer<CreateTrustRequest.Builder> createTrustRequest)Directory Service for Microsoft Active Directory allows you to configure trust relationships.default CreateTrustResponsecreateTrust(CreateTrustRequest createTrustRequest)Directory Service for Microsoft Active Directory allows you to configure trust relationships.default DeleteConditionalForwarderResponsedeleteConditionalForwarder(Consumer<DeleteConditionalForwarderRequest.Builder> deleteConditionalForwarderRequest)Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.default DeleteConditionalForwarderResponsedeleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.default DeleteDirectoryResponsedeleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest)Deletes an Directory Service directory.default DeleteDirectoryResponsedeleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)Deletes an Directory Service directory.default DeleteLogSubscriptionResponsedeleteLogSubscription(Consumer<DeleteLogSubscriptionRequest.Builder> deleteLogSubscriptionRequest)Deletes the specified log subscription.default DeleteLogSubscriptionResponsedeleteLogSubscription(DeleteLogSubscriptionRequest deleteLogSubscriptionRequest)Deletes the specified log subscription.default DeleteSnapshotResponsedeleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)Deletes a directory snapshot.default DeleteSnapshotResponsedeleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)Deletes a directory snapshot.default DeleteTrustResponsedeleteTrust(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest)Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.default DeleteTrustResponsedeleteTrust(DeleteTrustRequest deleteTrustRequest)Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.default DeregisterCertificateResponsederegisterCertificate(Consumer<DeregisterCertificateRequest.Builder> deregisterCertificateRequest)Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.default DeregisterCertificateResponsederegisterCertificate(DeregisterCertificateRequest deregisterCertificateRequest)Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.default DeregisterEventTopicResponsederegisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest)Removes the specified directory as a publisher to the specified Amazon SNS topic.default DeregisterEventTopicResponsederegisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)Removes the specified directory as a publisher to the specified Amazon SNS topic.default DescribeCertificateResponsedescribeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)Displays information about the certificate registered for secure LDAP or client certificate authentication.default DescribeCertificateResponsedescribeCertificate(DescribeCertificateRequest describeCertificateRequest)Displays information about the certificate registered for secure LDAP or client certificate authentication.default DescribeClientAuthenticationSettingsResponsedescribeClientAuthenticationSettings(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest)Retrieves information about the type of client authentication for the specified directory, if the type is specified.default DescribeClientAuthenticationSettingsResponsedescribeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest)Retrieves information about the type of client authentication for the specified directory, if the type is specified.default DescribeClientAuthenticationSettingsIterabledescribeClientAuthenticationSettingsPaginator(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest)default DescribeClientAuthenticationSettingsIterabledescribeClientAuthenticationSettingsPaginator(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest)default DescribeConditionalForwardersResponsedescribeConditionalForwarders(Consumer<DescribeConditionalForwardersRequest.Builder> describeConditionalForwardersRequest)Obtains information about the conditional forwarders for this account.default DescribeConditionalForwardersResponsedescribeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)Obtains information about the conditional forwarders for this account.default DescribeDirectoriesResponsedescribeDirectories()Obtains information about the directories that belong to this account.default DescribeDirectoriesResponsedescribeDirectories(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest)Obtains information about the directories that belong to this account.default DescribeDirectoriesResponsedescribeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)Obtains information about the directories that belong to this account.default DescribeDirectoriesIterabledescribeDirectoriesPaginator()This is a variant ofdescribeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)operation.default DescribeDirectoriesIterabledescribeDirectoriesPaginator(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest)This is a variant ofdescribeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)operation.default DescribeDirectoriesIterabledescribeDirectoriesPaginator(DescribeDirectoriesRequest describeDirectoriesRequest)This is a variant ofdescribeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)operation.default DescribeDomainControllersResponsedescribeDomainControllers(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest)Provides information about any domain controllers in your directory.default DescribeDomainControllersResponsedescribeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest)Provides information about any domain controllers in your directory.default DescribeDomainControllersIterabledescribeDomainControllersPaginator(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest)This is a variant ofdescribeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)operation.default DescribeDomainControllersIterabledescribeDomainControllersPaginator(DescribeDomainControllersRequest describeDomainControllersRequest)This is a variant ofdescribeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)operation.default DescribeEventTopicsResponsedescribeEventTopics()Obtains information about which Amazon SNS topics receive status messages from the specified directory.default DescribeEventTopicsResponsedescribeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest)Obtains information about which Amazon SNS topics receive status messages from the specified directory.default DescribeEventTopicsResponsedescribeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)Obtains information about which Amazon SNS topics receive status messages from the specified directory.default DescribeLdapsSettingsResponsedescribeLDAPSSettings(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest)Describes the status of LDAP security for the specified directory.default DescribeLdapsSettingsResponsedescribeLDAPSSettings(DescribeLdapsSettingsRequest describeLdapsSettingsRequest)Describes the status of LDAP security for the specified directory.default DescribeLDAPSSettingsIterabledescribeLDAPSSettingsPaginator(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest)This is a variant ofdescribeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)operation.default DescribeLDAPSSettingsIterabledescribeLDAPSSettingsPaginator(DescribeLdapsSettingsRequest describeLdapsSettingsRequest)This is a variant ofdescribeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)operation.default DescribeRegionsResponsedescribeRegions(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest)Provides information about the Regions that are configured for multi-Region replication.default DescribeRegionsResponsedescribeRegions(DescribeRegionsRequest describeRegionsRequest)Provides information about the Regions that are configured for multi-Region replication.default DescribeRegionsIterabledescribeRegionsPaginator(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest)This is a variant ofdescribeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest)operation.default DescribeRegionsIterabledescribeRegionsPaginator(DescribeRegionsRequest describeRegionsRequest)This is a variant ofdescribeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest)operation.default DescribeSettingsResponsedescribeSettings(Consumer<DescribeSettingsRequest.Builder> describeSettingsRequest)Retrieves information about the configurable settings for the specified directory.default DescribeSettingsResponsedescribeSettings(DescribeSettingsRequest describeSettingsRequest)Retrieves information about the configurable settings for the specified directory.default DescribeSharedDirectoriesResponsedescribeSharedDirectories(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest)Returns the shared directories in your account.default DescribeSharedDirectoriesResponsedescribeSharedDirectories(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest)Returns the shared directories in your account.default DescribeSharedDirectoriesIterabledescribeSharedDirectoriesPaginator(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest)This is a variant ofdescribeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest)operation.default DescribeSharedDirectoriesIterabledescribeSharedDirectoriesPaginator(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest)This is a variant ofdescribeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest)operation.default DescribeSnapshotsResponsedescribeSnapshots()Obtains information about the directory snapshots that belong to this account.default DescribeSnapshotsResponsedescribeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)Obtains information about the directory snapshots that belong to this account.default DescribeSnapshotsResponsedescribeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)Obtains information about the directory snapshots that belong to this account.default DescribeSnapshotsIterabledescribeSnapshotsPaginator()This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)operation.default DescribeSnapshotsIterabledescribeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)operation.default DescribeSnapshotsIterabledescribeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)operation.default DescribeTrustsResponsedescribeTrusts()Obtains information about the trust relationships for this account.default DescribeTrustsResponsedescribeTrusts(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest)Obtains information about the trust relationships for this account.default DescribeTrustsResponsedescribeTrusts(DescribeTrustsRequest describeTrustsRequest)Obtains information about the trust relationships for this account.default DescribeTrustsIterabledescribeTrustsPaginator()This is a variant ofdescribeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)operation.default DescribeTrustsIterabledescribeTrustsPaginator(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest)This is a variant ofdescribeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)operation.default DescribeTrustsIterabledescribeTrustsPaginator(DescribeTrustsRequest describeTrustsRequest)This is a variant ofdescribeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)operation.default DescribeUpdateDirectoryResponsedescribeUpdateDirectory(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest)Describes the updates of a directory for a particular update type.default DescribeUpdateDirectoryResponsedescribeUpdateDirectory(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest)Describes the updates of a directory for a particular update type.default DescribeUpdateDirectoryIterabledescribeUpdateDirectoryPaginator(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest)This is a variant ofdescribeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest)operation.default DescribeUpdateDirectoryIterabledescribeUpdateDirectoryPaginator(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest)This is a variant ofdescribeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest)operation.default DisableClientAuthenticationResponsedisableClientAuthentication(Consumer<DisableClientAuthenticationRequest.Builder> disableClientAuthenticationRequest)Disables alternative client authentication methods for the specified directory.default DisableClientAuthenticationResponsedisableClientAuthentication(DisableClientAuthenticationRequest disableClientAuthenticationRequest)Disables alternative client authentication methods for the specified directory.default DisableLdapsResponsedisableLDAPS(Consumer<DisableLdapsRequest.Builder> disableLdapsRequest)Deactivates LDAP secure calls for the specified directory.default DisableLdapsResponsedisableLDAPS(DisableLdapsRequest disableLdapsRequest)Deactivates LDAP secure calls for the specified directory.default DisableRadiusResponsedisableRadius(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 DisableRadiusResponsedisableRadius(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 DisableSsoResponsedisableSso(Consumer<DisableSsoRequest.Builder> disableSsoRequest)Disables single-sign on for a directory.default DisableSsoResponsedisableSso(DisableSsoRequest disableSsoRequest)Disables single-sign on for a directory.default EnableClientAuthenticationResponseenableClientAuthentication(Consumer<EnableClientAuthenticationRequest.Builder> enableClientAuthenticationRequest)Enables alternative client authentication methods for the specified directory.default EnableClientAuthenticationResponseenableClientAuthentication(EnableClientAuthenticationRequest enableClientAuthenticationRequest)Enables alternative client authentication methods for the specified directory.default EnableLdapsResponseenableLDAPS(Consumer<EnableLdapsRequest.Builder> enableLdapsRequest)Activates the switch for the specific directory to always use LDAP secure calls.default EnableLdapsResponseenableLDAPS(EnableLdapsRequest enableLdapsRequest)Activates the switch for the specific directory to always use LDAP secure calls.default EnableRadiusResponseenableRadius(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 EnableRadiusResponseenableRadius(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 EnableSsoResponseenableSso(Consumer<EnableSsoRequest.Builder> enableSsoRequest)Enables single sign-on for a directory.default EnableSsoResponseenableSso(EnableSsoRequest enableSsoRequest)Enables single sign-on for a directory.default GetDirectoryLimitsResponsegetDirectoryLimits()Obtains directory limit information for the current Region.default GetDirectoryLimitsResponsegetDirectoryLimits(Consumer<GetDirectoryLimitsRequest.Builder> getDirectoryLimitsRequest)Obtains directory limit information for the current Region.default GetDirectoryLimitsResponsegetDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)Obtains directory limit information for the current Region.default GetSnapshotLimitsResponsegetSnapshotLimits(Consumer<GetSnapshotLimitsRequest.Builder> getSnapshotLimitsRequest)Obtains the manual snapshot limits for a directory.default GetSnapshotLimitsResponsegetSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)Obtains the manual snapshot limits for a directory.default ListCertificatesResponselistCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.default ListCertificatesResponselistCertificates(ListCertificatesRequest listCertificatesRequest)For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.default ListCertificatesIterablelistCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)This is a variant oflistCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)operation.default ListCertificatesIterablelistCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)This is a variant oflistCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)operation.default ListIpRoutesResponselistIpRoutes(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest)Lists the address blocks that you have added to a directory.default ListIpRoutesResponselistIpRoutes(ListIpRoutesRequest listIpRoutesRequest)Lists the address blocks that you have added to a directory.default ListIpRoutesIterablelistIpRoutesPaginator(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest)This is a variant oflistIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)operation.default ListIpRoutesIterablelistIpRoutesPaginator(ListIpRoutesRequest listIpRoutesRequest)This is a variant oflistIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)operation.default ListLogSubscriptionsResponselistLogSubscriptions()Lists the active log subscriptions for the Amazon Web Services account.default ListLogSubscriptionsResponselistLogSubscriptions(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest)Lists the active log subscriptions for the Amazon Web Services account.default ListLogSubscriptionsResponselistLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest)Lists the active log subscriptions for the Amazon Web Services account.default ListLogSubscriptionsIterablelistLogSubscriptionsPaginator()This is a variant oflistLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)operation.default ListLogSubscriptionsIterablelistLogSubscriptionsPaginator(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest)This is a variant oflistLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)operation.default ListLogSubscriptionsIterablelistLogSubscriptionsPaginator(ListLogSubscriptionsRequest listLogSubscriptionsRequest)This is a variant oflistLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)operation.default ListSchemaExtensionsResponselistSchemaExtensions(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest)Lists all schema extensions applied to a Microsoft AD Directory.default ListSchemaExtensionsResponselistSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest)Lists all schema extensions applied to a Microsoft AD Directory.default ListSchemaExtensionsIterablelistSchemaExtensionsPaginator(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest)This is a variant oflistSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)operation.default ListSchemaExtensionsIterablelistSchemaExtensionsPaginator(ListSchemaExtensionsRequest listSchemaExtensionsRequest)This is a variant oflistSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists all tags on a directory.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists all tags on a directory.default ListTagsForResourceIterablelistTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)This is a variant oflistTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)operation.default ListTagsForResourceIterablelistTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)This is a variant oflistTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)operation.default RegisterCertificateResponseregisterCertificate(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest)Registers a certificate for a secure LDAP or client certificate authentication.default RegisterCertificateResponseregisterCertificate(RegisterCertificateRequest registerCertificateRequest)Registers a certificate for a secure LDAP or client certificate authentication.default RegisterEventTopicResponseregisterEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest)Associates a directory with an Amazon SNS topic.default RegisterEventTopicResponseregisterEventTopic(RegisterEventTopicRequest registerEventTopicRequest)Associates a directory with an Amazon SNS topic.default RejectSharedDirectoryResponserejectSharedDirectory(Consumer<RejectSharedDirectoryRequest.Builder> rejectSharedDirectoryRequest)Rejects a directory sharing request that was sent from the directory owner account.default RejectSharedDirectoryResponserejectSharedDirectory(RejectSharedDirectoryRequest rejectSharedDirectoryRequest)Rejects a directory sharing request that was sent from the directory owner account.default RemoveIpRoutesResponseremoveIpRoutes(Consumer<RemoveIpRoutesRequest.Builder> removeIpRoutesRequest)Removes IP address blocks from a directory.default RemoveIpRoutesResponseremoveIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest)Removes IP address blocks from a directory.default RemoveRegionResponseremoveRegion(Consumer<RemoveRegionRequest.Builder> removeRegionRequest)Stops all replication and removes the domain controllers from the specified Region.default RemoveRegionResponseremoveRegion(RemoveRegionRequest removeRegionRequest)Stops all replication and removes the domain controllers from the specified Region.default RemoveTagsFromResourceResponseremoveTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)Removes tags from a directory.default RemoveTagsFromResourceResponseremoveTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)Removes tags from a directory.default ResetUserPasswordResponseresetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest)Resets the password for any user in your Managed Microsoft AD or Simple AD directory.default ResetUserPasswordResponseresetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest)Resets the password for any user in your Managed Microsoft AD or Simple AD directory.default RestoreFromSnapshotResponserestoreFromSnapshot(Consumer<RestoreFromSnapshotRequest.Builder> restoreFromSnapshotRequest)Restores a directory using an existing directory snapshot.default RestoreFromSnapshotResponserestoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)Restores a directory using an existing directory snapshot.default DirectoryServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default ShareDirectoryResponseshareDirectory(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 ShareDirectoryResponseshareDirectory(ShareDirectoryRequest shareDirectoryRequest)Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer).default StartSchemaExtensionResponsestartSchemaExtension(Consumer<StartSchemaExtensionRequest.Builder> startSchemaExtensionRequest)Applies a schema extension to a Microsoft AD directory.default StartSchemaExtensionResponsestartSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest)Applies a schema extension to a Microsoft AD directory.default UnshareDirectoryResponseunshareDirectory(Consumer<UnshareDirectoryRequest.Builder> unshareDirectoryRequest)Stops the directory sharing between the directory owner and consumer accounts.default UnshareDirectoryResponseunshareDirectory(UnshareDirectoryRequest unshareDirectoryRequest)Stops the directory sharing between the directory owner and consumer accounts.default UpdateConditionalForwarderResponseupdateConditionalForwarder(Consumer<UpdateConditionalForwarderRequest.Builder> updateConditionalForwarderRequest)Updates a conditional forwarder that has been set up for your Amazon Web Services directory.default UpdateConditionalForwarderResponseupdateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)Updates a conditional forwarder that has been set up for your Amazon Web Services directory.default UpdateDirectorySetupResponseupdateDirectorySetup(Consumer<UpdateDirectorySetupRequest.Builder> updateDirectorySetupRequest)Updates the directory for a particular update type.default UpdateDirectorySetupResponseupdateDirectorySetup(UpdateDirectorySetupRequest updateDirectorySetupRequest)Updates the directory for a particular update type.default UpdateNumberOfDomainControllersResponseupdateNumberOfDomainControllers(Consumer<UpdateNumberOfDomainControllersRequest.Builder> updateNumberOfDomainControllersRequest)Adds or removes domain controllers to or from the directory.default UpdateNumberOfDomainControllersResponseupdateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest)Adds or removes domain controllers to or from the directory.default UpdateRadiusResponseupdateRadius(Consumer<UpdateRadiusRequest.Builder> updateRadiusRequest)Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.default UpdateRadiusResponseupdateRadius(UpdateRadiusRequest updateRadiusRequest)Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.default UpdateSettingsResponseupdateSettings(Consumer<UpdateSettingsRequest.Builder> updateSettingsRequest)Updates the configurable settings for the specified directory.default UpdateSettingsResponseupdateSettings(UpdateSettingsRequest updateSettingsRequest)Updates the configurable settings for the specified directory.default UpdateTrustResponseupdateTrust(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 UpdateTrustResponseupdateTrust(UpdateTrustRequest updateTrustRequest)Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.default VerifyTrustResponseverifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest)Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.default VerifyTrustResponseverifyTrust(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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptSharedDirectory
default AcceptSharedDirectoryResponse acceptSharedDirectory(AcceptSharedDirectoryRequest acceptSharedDirectoryRequest) throws InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadySharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Accepts a directory sharing request that was sent from the directory owner account.
- Parameters:
acceptSharedDirectoryRequest-- Returns:
- Result of the AcceptSharedDirectory operation returned by the service.
- Throws:
InvalidParameterException- One or more parameters are not valid.EntityDoesNotExistException- The specified entity could not be found.DirectoryAlreadySharedException- The specified directory has already been shared with this Amazon Web Services account.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
acceptSharedDirectory
default AcceptSharedDirectoryResponse acceptSharedDirectory(Consumer<AcceptSharedDirectoryRequest.Builder> acceptSharedDirectoryRequest) throws InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadySharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Accepts a directory sharing request that was sent from the directory owner account.
This is a convenience which creates an instance of the
AcceptSharedDirectoryRequest.Builderavoiding the need to create one manually viaAcceptSharedDirectoryRequest.builder()- Parameters:
acceptSharedDirectoryRequest- AConsumerthat will call methods onAcceptSharedDirectoryRequest.Builderto create a request.- Returns:
- Result of the AcceptSharedDirectory operation returned by the service.
- Throws:
InvalidParameterException- One or more parameters are not valid.EntityDoesNotExistException- The specified entity could not be found.DirectoryAlreadySharedException- The specified directory has already been shared with this Amazon Web Services account.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
addIpRoutes
default AddIpRoutesResponse addIpRoutes(AddIpRoutesRequest addIpRoutesRequest) throws EntityDoesNotExistException, EntityAlreadyExistsException, InvalidParameterException, DirectoryUnavailableException, IpRouteLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
- Parameters:
addIpRoutesRequest-- Returns:
- Result of the AddIpRoutes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
addIpRoutes
default AddIpRoutesResponse addIpRoutes(Consumer<AddIpRoutesRequest.Builder> addIpRoutesRequest) throws EntityDoesNotExistException, EntityAlreadyExistsException, InvalidParameterException, DirectoryUnavailableException, IpRouteLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the
AddIpRoutesRequest.Builderavoiding the need to create one manually viaAddIpRoutesRequest.builder()- Parameters:
addIpRoutesRequest- AConsumerthat will call methods onAddIpRoutesRequest.Builderto create a request.- Returns:
- Result of the AddIpRoutes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
addRegion
default AddRegionResponse addRegion(AddRegionRequest addRegionRequest) throws DirectoryUnavailableException, InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadyInRegionException, UnsupportedOperationException, DirectoryDoesNotExistException, RegionLimitExceededException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Adds two domain controllers in the specified Region for the specified directory.
- Parameters:
addRegionRequest-- Returns:
- Result of the AddRegion operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
addRegion
default AddRegionResponse addRegion(Consumer<AddRegionRequest.Builder> addRegionRequest) throws DirectoryUnavailableException, InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadyInRegionException, UnsupportedOperationException, DirectoryDoesNotExistException, RegionLimitExceededException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Adds two domain controllers in the specified Region for the specified directory.
This is a convenience which creates an instance of the
AddRegionRequest.Builderavoiding the need to create one manually viaAddRegionRequest.builder()- Parameters:
addRegionRequest- AConsumerthat will call methods onAddRegionRequest.Builderto create a request.- Returns:
- Result of the AddRegion operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws EntityDoesNotExistException, InvalidParameterException, TagLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
- Parameters:
addTagsToResourceRequest-- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws EntityDoesNotExistException, InvalidParameterException, TagLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
This is a convenience which creates an instance of the
AddTagsToResourceRequest.Builderavoiding the need to create one manually viaAddTagsToResourceRequest.builder()- Parameters:
addTagsToResourceRequest- AConsumerthat will call methods onAddTagsToResourceRequest.Builderto create a request.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelSchemaExtension
default CancelSchemaExtensionResponse cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states;
Initializing,CreatingSnapshot, andUpdatingSchema.- Parameters:
cancelSchemaExtensionRequest-- Returns:
- Result of the CancelSchemaExtension operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
cancelSchemaExtension
default CancelSchemaExtensionResponse cancelSchemaExtension(Consumer<CancelSchemaExtensionRequest.Builder> cancelSchemaExtensionRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states;
Initializing,CreatingSnapshot, andUpdatingSchema.
This is a convenience which creates an instance of the
CancelSchemaExtensionRequest.Builderavoiding the need to create one manually viaCancelSchemaExtensionRequest.builder()- Parameters:
cancelSchemaExtensionRequest- AConsumerthat will call methods onCancelSchemaExtensionRequest.Builderto create a request.- Returns:
- Result of the CancelSchemaExtension operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
connectDirectory
default ConnectDirectoryResponse connectDirectory(ConnectDirectoryRequest connectDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an AD Connector to connect to a self-managed directory.
Before you call
ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run theConnectDirectoryoperation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.- Parameters:
connectDirectoryRequest- Contains the inputs for the ConnectDirectory operation.- Returns:
- Result of the ConnectDirectory operation returned by the service.
- Throws:
DirectoryLimitExceededException- The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
connectDirectory
default ConnectDirectoryResponse connectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an AD Connector to connect to a self-managed directory.
Before you call
ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run theConnectDirectoryoperation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the
ConnectDirectoryRequest.Builderavoiding the need to create one manually viaConnectDirectoryRequest.builder()- Parameters:
connectDirectoryRequest- AConsumerthat will call methods onConnectDirectoryRequest.Builderto create a request. Contains the inputs for the ConnectDirectory operation.- Returns:
- Result of the ConnectDirectory operation returned by the service.
- Throws:
DirectoryLimitExceededException- The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAlias
default CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as
http://<alias>.awsapps.com.After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
- Parameters:
createAliasRequest- Contains the inputs for the CreateAlias operation.- Returns:
- Result of the CreateAlias operation returned by the service.
- Throws:
EntityAlreadyExistsException- The specified entity already exists.EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAlias
default CreateAliasResponse createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as
http://<alias>.awsapps.com.After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
This is a convenience which creates an instance of the
CreateAliasRequest.Builderavoiding the need to create one manually viaCreateAliasRequest.builder()- Parameters:
createAliasRequest- AConsumerthat will call methods onCreateAliasRequest.Builderto create a request. Contains the inputs for the CreateAlias operation.- Returns:
- Result of the CreateAlias operation returned by the service.
- Throws:
EntityAlreadyExistsException- The specified entity already exists.EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createComputer
default CreateComputerResponse createComputer(CreateComputerRequest createComputerRequest) throws AuthenticationFailedException, DirectoryUnavailableException, EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an Active Directory computer object in the specified directory.
- Parameters:
createComputerRequest- Contains the inputs for the CreateComputer operation.- Returns:
- Result of the CreateComputer operation returned by the service.
- Throws:
AuthenticationFailedException- An authentication error occurred.DirectoryUnavailableException- The specified directory is unavailable or could not be found.EntityAlreadyExistsException- The specified entity already exists.EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
createComputer
default CreateComputerResponse createComputer(Consumer<CreateComputerRequest.Builder> createComputerRequest) throws AuthenticationFailedException, DirectoryUnavailableException, EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates an Active Directory computer object in the specified directory.
This is a convenience which creates an instance of the
CreateComputerRequest.Builderavoiding the need to create one manually viaCreateComputerRequest.builder()- Parameters:
createComputerRequest- AConsumerthat will call methods onCreateComputerRequest.Builderto create a request. Contains the inputs for the CreateComputer operation.- Returns:
- Result of the CreateComputer operation returned by the service.
- Throws:
AuthenticationFailedException- An authentication error occurred.DirectoryUnavailableException- The specified directory is unavailable or could not be found.EntityAlreadyExistsException- The specified entity already exists.EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
createConditionalForwarder
default CreateConditionalForwarderResponse createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
- 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:
- Result of the CreateConditionalForwarder operation returned by the service.
- Throws:
EntityAlreadyExistsException- The specified entity already exists.EntityDoesNotExistException- The specified entity could not be found.DirectoryUnavailableException- The specified directory is unavailable or could not be found.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
createConditionalForwarder
default CreateConditionalForwarderResponse createConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a conditional forwarder associated with your 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.Builderavoiding the need to create one manually viaCreateConditionalForwarderRequest.builder()- Parameters:
createConditionalForwarderRequest- AConsumerthat will call methods onCreateConditionalForwarderRequest.Builderto 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:
- Result of the CreateConditionalForwarder operation returned by the service.
- Throws:
EntityAlreadyExistsException- The specified entity already exists.EntityDoesNotExistException- The specified entity could not be found.DirectoryUnavailableException- The specified directory is unavailable or could not be found.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
createDirectory
default CreateDirectoryResponse createDirectory(CreateDirectoryRequest createDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
Before you call
CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run theCreateDirectoryoperation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.- Parameters:
createDirectoryRequest- Contains the inputs for the CreateDirectory operation.- Returns:
- Result of the CreateDirectory operation returned by the service.
- Throws:
DirectoryLimitExceededException- The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDirectory
default CreateDirectoryResponse createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
Before you call
CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run theCreateDirectoryoperation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the
CreateDirectoryRequest.Builderavoiding the need to create one manually viaCreateDirectoryRequest.builder()- Parameters:
createDirectoryRequest- AConsumerthat will call methods onCreateDirectoryRequest.Builderto create a request. Contains the inputs for the CreateDirectory operation.- Returns:
- Result of the CreateDirectory operation returned by the service.
- Throws:
DirectoryLimitExceededException- The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createLogSubscription
default CreateLogSubscriptionResponse createLogSubscription(CreateLogSubscriptionRequest createLogSubscriptionRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, UnsupportedOperationException, InsufficientPermissionsException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
- Parameters:
createLogSubscriptionRequest-- Returns:
- Result of the CreateLogSubscription operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
createLogSubscription
default CreateLogSubscriptionResponse createLogSubscription(Consumer<CreateLogSubscriptionRequest.Builder> createLogSubscriptionRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, UnsupportedOperationException, InsufficientPermissionsException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
This is a convenience which creates an instance of the
CreateLogSubscriptionRequest.Builderavoiding the need to create one manually viaCreateLogSubscriptionRequest.builder()- Parameters:
createLogSubscriptionRequest- AConsumerthat will call methods onCreateLogSubscriptionRequest.Builderto create a request.- Returns:
- Result of the CreateLogSubscription operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
createMicrosoftAD
default CreateMicrosoftAdResponse createMicrosoftAD(CreateMicrosoftAdRequest createMicrosoftAdRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
- Parameters:
createMicrosoftAdRequest- Creates an Managed Microsoft AD directory.- Returns:
- Result of the CreateMicrosoftAD operation returned by the service.
- Throws:
DirectoryLimitExceededException- The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
createMicrosoftAD
default CreateMicrosoftAdResponse createMicrosoftAD(Consumer<CreateMicrosoftAdRequest.Builder> createMicrosoftAdRequest) throws DirectoryLimitExceededException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the
CreateMicrosoftAdRequest.Builderavoiding the need to create one manually viaCreateMicrosoftAdRequest.builder()- Parameters:
createMicrosoftAdRequest- AConsumerthat will call methods onCreateMicrosoftAdRequest.Builderto create a request. Creates an Managed Microsoft AD directory.- Returns:
- Result of the CreateMicrosoftAD operation returned by the service.
- Throws:
DirectoryLimitExceededException- The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
createSnapshot
default CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, SnapshotLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
You cannot take snapshots of AD Connector directories.
- Parameters:
createSnapshotRequest- Contains the inputs for the CreateSnapshot operation.- Returns:
- Result of the CreateSnapshot operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.SnapshotLimitExceededException- The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createSnapshot
default CreateSnapshotResponse createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, SnapshotLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
You cannot take snapshots of AD Connector directories.
This is a convenience which creates an instance of the
CreateSnapshotRequest.Builderavoiding the need to create one manually viaCreateSnapshotRequest.builder()- Parameters:
createSnapshotRequest- AConsumerthat will call methods onCreateSnapshotRequest.Builderto create a request. Contains the inputs for the CreateSnapshot operation.- Returns:
- Result of the CreateSnapshot operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.SnapshotLimitExceededException- The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createTrust
default CreateTrustResponse createTrust(CreateTrustRequest createTrustRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
- 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:
- Result of the CreateTrust operation returned by the service.
- Throws:
EntityAlreadyExistsException- The specified entity already exists.EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
createTrust
default CreateTrustResponse createTrust(Consumer<CreateTrustRequest.Builder> createTrustRequest) throws EntityAlreadyExistsException, EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
This is a convenience which creates an instance of the
CreateTrustRequest.Builderavoiding the need to create one manually viaCreateTrustRequest.builder()- Parameters:
createTrustRequest- AConsumerthat will call methods onCreateTrustRequest.Builderto 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:
- Result of the CreateTrust operation returned by the service.
- Throws:
EntityAlreadyExistsException- The specified entity already exists.EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
deleteConditionalForwarder
default DeleteConditionalForwarderResponse deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
- Parameters:
deleteConditionalForwarderRequest- Deletes a conditional forwarder.- Returns:
- Result of the DeleteConditionalForwarder operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.DirectoryUnavailableException- The specified directory is unavailable or could not be found.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
deleteConditionalForwarder
default DeleteConditionalForwarderResponse deleteConditionalForwarder(Consumer<DeleteConditionalForwarderRequest.Builder> deleteConditionalForwarderRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
This is a convenience which creates an instance of the
DeleteConditionalForwarderRequest.Builderavoiding the need to create one manually viaDeleteConditionalForwarderRequest.builder()- Parameters:
deleteConditionalForwarderRequest- AConsumerthat will call methods onDeleteConditionalForwarderRequest.Builderto create a request. Deletes a conditional forwarder.- Returns:
- Result of the DeleteConditionalForwarder operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.DirectoryUnavailableException- The specified directory is unavailable or could not be found.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
deleteDirectory
default DeleteDirectoryResponse deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes an Directory Service directory.
Before you call
DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run theDeleteDirectoryoperation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.- Parameters:
deleteDirectoryRequest- Contains the inputs for the DeleteDirectory operation.- Returns:
- Result of the DeleteDirectory operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDirectory
default DeleteDirectoryResponse deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes an Directory Service directory.
Before you call
DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run theDeleteDirectoryoperation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
This is a convenience which creates an instance of the
DeleteDirectoryRequest.Builderavoiding the need to create one manually viaDeleteDirectoryRequest.builder()- Parameters:
deleteDirectoryRequest- AConsumerthat will call methods onDeleteDirectoryRequest.Builderto create a request. Contains the inputs for the DeleteDirectory operation.- Returns:
- Result of the DeleteDirectory operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLogSubscription
default DeleteLogSubscriptionResponse deleteLogSubscription(DeleteLogSubscriptionRequest deleteLogSubscriptionRequest) throws EntityDoesNotExistException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes the specified log subscription.
- Parameters:
deleteLogSubscriptionRequest-- Returns:
- Result of the DeleteLogSubscription operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
deleteLogSubscription
default DeleteLogSubscriptionResponse deleteLogSubscription(Consumer<DeleteLogSubscriptionRequest.Builder> deleteLogSubscriptionRequest) throws EntityDoesNotExistException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes the specified log subscription.
This is a convenience which creates an instance of the
DeleteLogSubscriptionRequest.Builderavoiding the need to create one manually viaDeleteLogSubscriptionRequest.builder()- Parameters:
deleteLogSubscriptionRequest- AConsumerthat will call methods onDeleteLogSubscriptionRequest.Builderto create a request.- Returns:
- Result of the DeleteLogSubscription operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
deleteSnapshot
default DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes a directory snapshot.
- Parameters:
deleteSnapshotRequest- Contains the inputs for the DeleteSnapshot operation.- Returns:
- Result of the DeleteSnapshot operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSnapshot
default DeleteSnapshotResponse deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes a directory snapshot.
This is a convenience which creates an instance of the
DeleteSnapshotRequest.Builderavoiding the need to create one manually viaDeleteSnapshotRequest.builder()- Parameters:
deleteSnapshotRequest- AConsumerthat will call methods onDeleteSnapshotRequest.Builderto create a request. Contains the inputs for the DeleteSnapshot operation.- Returns:
- Result of the DeleteSnapshot operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTrust
default DeleteTrustResponse deleteTrust(DeleteTrustRequest deleteTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
- Parameters:
deleteTrustRequest- Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain.- Returns:
- Result of the DeleteTrust operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
deleteTrust
default DeleteTrustResponse deleteTrust(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
This is a convenience which creates an instance of the
DeleteTrustRequest.Builderavoiding the need to create one manually viaDeleteTrustRequest.builder()- Parameters:
deleteTrustRequest- AConsumerthat will call methods onDeleteTrustRequest.Builderto create a request. Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain.- Returns:
- Result of the DeleteTrust operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
deregisterCertificate
default DeregisterCertificateResponse deregisterCertificate(DeregisterCertificateRequest deregisterCertificateRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, CertificateDoesNotExistException, CertificateInUseException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
- Parameters:
deregisterCertificateRequest-- Returns:
- Result of the DeregisterCertificate operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
deregisterCertificate
default DeregisterCertificateResponse deregisterCertificate(Consumer<DeregisterCertificateRequest.Builder> deregisterCertificateRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, CertificateDoesNotExistException, CertificateInUseException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
This is a convenience which creates an instance of the
DeregisterCertificateRequest.Builderavoiding the need to create one manually viaDeregisterCertificateRequest.builder()- Parameters:
deregisterCertificateRequest- AConsumerthat will call methods onDeregisterCertificateRequest.Builderto create a request.- Returns:
- Result of the DeregisterCertificate operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
deregisterEventTopic
default DeregisterEventTopicResponse deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes the specified directory as a publisher to the specified Amazon SNS topic.
- Parameters:
deregisterEventTopicRequest- Removes the specified directory as a publisher to the specified Amazon SNS topic.- Returns:
- Result of the DeregisterEventTopic operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterEventTopic
default DeregisterEventTopicResponse deregisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes the specified directory as a publisher to the specified Amazon SNS topic.
This is a convenience which creates an instance of the
DeregisterEventTopicRequest.Builderavoiding the need to create one manually viaDeregisterEventTopicRequest.builder()- Parameters:
deregisterEventTopicRequest- AConsumerthat will call methods onDeregisterEventTopicRequest.Builderto create a request. Removes the specified directory as a publisher to the specified Amazon SNS topic.- Returns:
- Result of the DeregisterEventTopic operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCertificate
default DescribeCertificateResponse describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, CertificateDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Displays information about the certificate registered for secure LDAP or client certificate authentication.
- Parameters:
describeCertificateRequest-- Returns:
- Result of the DescribeCertificate operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeCertificate
default DescribeCertificateResponse describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, CertificateDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Displays information about the certificate registered for secure LDAP or client certificate authentication.
This is a convenience which creates an instance of the
DescribeCertificateRequest.Builderavoiding the need to create one manually viaDescribeCertificateRequest.builder()- Parameters:
describeCertificateRequest- AConsumerthat will call methods onDescribeCertificateRequest.Builderto create a request.- Returns:
- Result of the DescribeCertificate operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeClientAuthenticationSettings
default DescribeClientAuthenticationSettingsResponse describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, AccessDeniedException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only
SmartCardis supported.- Parameters:
describeClientAuthenticationSettingsRequest-- Returns:
- Result of the DescribeClientAuthenticationSettings operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeClientAuthenticationSettings
default DescribeClientAuthenticationSettingsResponse describeClientAuthenticationSettings(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, AccessDeniedException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only
SmartCardis supported.
This is a convenience which creates an instance of the
DescribeClientAuthenticationSettingsRequest.Builderavoiding the need to create one manually viaDescribeClientAuthenticationSettingsRequest.builder()- Parameters:
describeClientAuthenticationSettingsRequest- AConsumerthat will call methods onDescribeClientAuthenticationSettingsRequest.Builderto create a request.- Returns:
- Result of the DescribeClientAuthenticationSettings operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeClientAuthenticationSettingsPaginator
default DescribeClientAuthenticationSettingsIterable describeClientAuthenticationSettingsPaginator(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, AccessDeniedException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsIterable responses = client.describeClientAuthenticationSettingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsIterable responses = client .describeClientAuthenticationSettingsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsIterable responses = client.describeClientAuthenticationSettingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest)operation.- Parameters:
describeClientAuthenticationSettingsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeClientAuthenticationSettingsPaginator
default DescribeClientAuthenticationSettingsIterable describeClientAuthenticationSettingsPaginator(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, AccessDeniedException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsIterable responses = client.describeClientAuthenticationSettingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsIterable responses = client .describeClientAuthenticationSettingsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsIterable responses = client.describeClientAuthenticationSettingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest)operation.
This is a convenience which creates an instance of the
DescribeClientAuthenticationSettingsRequest.Builderavoiding the need to create one manually viaDescribeClientAuthenticationSettingsRequest.builder()- Parameters:
describeClientAuthenticationSettingsRequest- AConsumerthat will call methods onDescribeClientAuthenticationSettingsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeConditionalForwarders
default DescribeConditionalForwardersResponse describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the conditional forwarders for this account.
If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
- Parameters:
describeConditionalForwardersRequest- Describes a conditional forwarder.- Returns:
- Result of the DescribeConditionalForwarders operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.DirectoryUnavailableException- The specified directory is unavailable or could not be found.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeConditionalForwarders
default DescribeConditionalForwardersResponse describeConditionalForwarders(Consumer<DescribeConditionalForwardersRequest.Builder> describeConditionalForwardersRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the conditional forwarders for this account.
If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
This is a convenience which creates an instance of the
DescribeConditionalForwardersRequest.Builderavoiding the need to create one manually viaDescribeConditionalForwardersRequest.builder()- Parameters:
describeConditionalForwardersRequest- AConsumerthat will call methods onDescribeConditionalForwardersRequest.Builderto create a request. Describes a conditional forwarder.- Returns:
- Result of the DescribeConditionalForwarders operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.DirectoryUnavailableException- The specified directory is unavailable or could not be found.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeDirectories
default DescribeDirectoriesResponse describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the
DirectoryIdsparameter. Otherwise, all directories that belong to the current account are returned.This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theDescribeDirectoriesResult.NextTokenmember 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
Limitparameter.- Parameters:
describeDirectoriesRequest- Contains the inputs for the DescribeDirectories operation.- Returns:
- Result of the DescribeDirectories operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDirectories
default DescribeDirectoriesResponse describeDirectories(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the
DirectoryIdsparameter. Otherwise, all directories that belong to the current account are returned.This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theDescribeDirectoriesResult.NextTokenmember 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
Limitparameter.
This is a convenience which creates an instance of the
DescribeDirectoriesRequest.Builderavoiding the need to create one manually viaDescribeDirectoriesRequest.builder()- Parameters:
describeDirectoriesRequest- AConsumerthat will call methods onDescribeDirectoriesRequest.Builderto create a request. Contains the inputs for the DescribeDirectories operation.- Returns:
- Result of the DescribeDirectories operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDirectories
default DescribeDirectoriesResponse describeDirectories() throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the
DirectoryIdsparameter. Otherwise, all directories that belong to the current account are returned.This operation supports pagination with the use of the
NextTokenrequest and response parameters. If more results are available, theDescribeDirectoriesResult.NextTokenmember 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
Limitparameter.- Returns:
- Result of the DescribeDirectories operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
describeDirectories(DescribeDirectoriesRequest), AWS API Documentation
-
describeDirectoriesPaginator
default DescribeDirectoriesIterable describeDirectoriesPaginator() throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client.describeDirectoriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client .describeDirectoriesPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client.describeDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
describeDirectoriesPaginator(DescribeDirectoriesRequest), AWS API Documentation
-
describeDirectoriesPaginator
default DescribeDirectoriesIterable describeDirectoriesPaginator(DescribeDirectoriesRequest describeDirectoriesRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client.describeDirectoriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client .describeDirectoriesPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client.describeDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)operation.- Parameters:
describeDirectoriesRequest- Contains the inputs for the DescribeDirectories operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDirectoriesPaginator
default DescribeDirectoriesIterable describeDirectoriesPaginator(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client.describeDirectoriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client .describeDirectoriesPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeDirectoriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client.describeDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest)operation.
This is a convenience which creates an instance of the
DescribeDirectoriesRequest.Builderavoiding the need to create one manually viaDescribeDirectoriesRequest.builder()- Parameters:
describeDirectoriesRequest- AConsumerthat will call methods onDescribeDirectoriesRequest.Builderto create a request. Contains the inputs for the DescribeDirectories operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDomainControllers
default DescribeDomainControllersResponse describeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Provides information about any domain controllers in your directory.
- Parameters:
describeDomainControllersRequest-- Returns:
- Result of the DescribeDomainControllers operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeDomainControllers
default DescribeDomainControllersResponse describeDomainControllers(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Provides information about any domain controllers in your directory.
This is a convenience which creates an instance of the
DescribeDomainControllersRequest.Builderavoiding the need to create one manually viaDescribeDomainControllersRequest.builder()- Parameters:
describeDomainControllersRequest- AConsumerthat will call methods onDescribeDomainControllersRequest.Builderto create a request.- Returns:
- Result of the DescribeDomainControllers operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeDomainControllersPaginator
default DescribeDomainControllersIterable describeDomainControllersPaginator(DescribeDomainControllersRequest describeDomainControllersRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client .describeDomainControllersPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)operation.- Parameters:
describeDomainControllersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeDomainControllersPaginator
default DescribeDomainControllersIterable describeDomainControllersPaginator(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client .describeDomainControllersPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest)operation.
This is a convenience which creates an instance of the
DescribeDomainControllersRequest.Builderavoiding the need to create one manually viaDescribeDomainControllersRequest.builder()- Parameters:
describeDomainControllersRequest- AConsumerthat will call methods onDescribeDomainControllersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeEventTopics
default DescribeEventTopicsResponse describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
- Parameters:
describeEventTopicsRequest- Describes event topics.- Returns:
- Result of the DescribeEventTopics operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventTopics
default DescribeEventTopicsResponse describeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
This is a convenience which creates an instance of the
DescribeEventTopicsRequest.Builderavoiding the need to create one manually viaDescribeEventTopicsRequest.builder()- Parameters:
describeEventTopicsRequest- AConsumerthat will call methods onDescribeEventTopicsRequest.Builderto create a request. Describes event topics.- Returns:
- Result of the DescribeEventTopics operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventTopics
default DescribeEventTopicsResponse describeEventTopics() throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
- Returns:
- Result of the DescribeEventTopics operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEventTopics(DescribeEventTopicsRequest), AWS API Documentation
-
describeLDAPSSettings
default DescribeLdapsSettingsResponse describeLDAPSSettings(DescribeLdapsSettingsRequest describeLdapsSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Describes the status of LDAP security for the specified directory.
- Parameters:
describeLdapsSettingsRequest-- Returns:
- Result of the DescribeLDAPSSettings operation returned by the service.
- Throws:
DirectoryDoesNotExistException- The specified directory does not exist in the system.UnsupportedOperationException- The operation is not supported.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeLDAPSSettings
default DescribeLdapsSettingsResponse describeLDAPSSettings(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Describes the status of LDAP security for the specified directory.
This is a convenience which creates an instance of the
DescribeLdapsSettingsRequest.Builderavoiding the need to create one manually viaDescribeLdapsSettingsRequest.builder()- Parameters:
describeLdapsSettingsRequest- AConsumerthat will call methods onDescribeLdapsSettingsRequest.Builderto create a request.- Returns:
- Result of the DescribeLDAPSSettings operation returned by the service.
- Throws:
DirectoryDoesNotExistException- The specified directory does not exist in the system.UnsupportedOperationException- The operation is not supported.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeLDAPSSettingsPaginator
default DescribeLDAPSSettingsIterable describeLDAPSSettingsPaginator(DescribeLdapsSettingsRequest describeLdapsSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsIterable responses = client.describeLDAPSSettingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsIterable responses = client .describeLDAPSSettingsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsIterable responses = client.describeLDAPSSettingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)operation.- Parameters:
describeLdapsSettingsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DirectoryDoesNotExistException- The specified directory does not exist in the system.UnsupportedOperationException- The operation is not supported.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeLDAPSSettingsPaginator
default DescribeLDAPSSettingsIterable describeLDAPSSettingsPaginator(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsIterable responses = client.describeLDAPSSettingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsIterable responses = client .describeLDAPSSettingsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsIterable responses = client.describeLDAPSSettingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest)operation.
This is a convenience which creates an instance of the
DescribeLdapsSettingsRequest.Builderavoiding the need to create one manually viaDescribeLdapsSettingsRequest.builder()- Parameters:
describeLdapsSettingsRequest- AConsumerthat will call methods onDescribeLdapsSettingsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DirectoryDoesNotExistException- The specified directory does not exist in the system.UnsupportedOperationException- The operation is not supported.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeRegions
default DescribeRegionsResponse describeRegions(DescribeRegionsRequest describeRegionsRequest) throws InvalidParameterException, DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Provides information about the Regions that are configured for multi-Region replication.
- Parameters:
describeRegionsRequest-- Returns:
- Result of the DescribeRegions operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeRegions
default DescribeRegionsResponse describeRegions(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest) throws InvalidParameterException, DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Provides information about the Regions that are configured for multi-Region replication.
This is a convenience which creates an instance of the
DescribeRegionsRequest.Builderavoiding the need to create one manually viaDescribeRegionsRequest.builder()- Parameters:
describeRegionsRequest- AConsumerthat will call methods onDescribeRegionsRequest.Builderto create a request.- Returns:
- Result of the DescribeRegions operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeRegionsPaginator
default DescribeRegionsIterable describeRegionsPaginator(DescribeRegionsRequest describeRegionsRequest) throws InvalidParameterException, DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeRegionsIterable responses = client.describeRegionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeRegionsIterable responses = client .describeRegionsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeRegionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeRegionsIterable responses = client.describeRegionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeRegionsPaginator
default DescribeRegionsIterable describeRegionsPaginator(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest) throws InvalidParameterException, DirectoryDoesNotExistException, UnsupportedOperationException, InvalidNextTokenException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeRegionsIterable responses = client.describeRegionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeRegionsIterable responses = client .describeRegionsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeRegionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeRegionsIterable responses = client.describeRegionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeRegionsRequest.builder()- Parameters:
describeRegionsRequest- AConsumerthat will call methods onDescribeRegionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeSettings
default DescribeSettingsResponse describeSettings(DescribeSettingsRequest describeSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Retrieves information about the configurable settings for the specified directory.
- Parameters:
describeSettingsRequest-- Returns:
- Result of the DescribeSettings operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeSettings
default DescribeSettingsResponse describeSettings(Consumer<DescribeSettingsRequest.Builder> describeSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Retrieves information about the configurable settings for the specified directory.
This is a convenience which creates an instance of the
DescribeSettingsRequest.Builderavoiding the need to create one manually viaDescribeSettingsRequest.builder()- Parameters:
describeSettingsRequest- AConsumerthat will call methods onDescribeSettingsRequest.Builderto create a request.- Returns:
- Result of the DescribeSettings operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeSharedDirectories
default DescribeSharedDirectoriesResponse describeSharedDirectories(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Returns the shared directories in your account.
- Parameters:
describeSharedDirectoriesRequest-- Returns:
- Result of the DescribeSharedDirectories operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue is not valid.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeSharedDirectories
default DescribeSharedDirectoriesResponse describeSharedDirectories(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Returns the shared directories in your account.
This is a convenience which creates an instance of the
DescribeSharedDirectoriesRequest.Builderavoiding the need to create one manually viaDescribeSharedDirectoriesRequest.builder()- Parameters:
describeSharedDirectoriesRequest- AConsumerthat will call methods onDescribeSharedDirectoriesRequest.Builderto create a request.- Returns:
- Result of the DescribeSharedDirectories operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue is not valid.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeSharedDirectoriesPaginator
default DescribeSharedDirectoriesIterable describeSharedDirectoriesPaginator(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesIterable responses = client.describeSharedDirectoriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesIterable responses = client .describeSharedDirectoriesPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesIterable responses = client.describeSharedDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest)operation.- Parameters:
describeSharedDirectoriesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue is not valid.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeSharedDirectoriesPaginator
default DescribeSharedDirectoriesIterable describeSharedDirectoriesPaginator(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesIterable responses = client.describeSharedDirectoriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesIterable responses = client .describeSharedDirectoriesPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesIterable responses = client.describeSharedDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest)operation.
This is a convenience which creates an instance of the
DescribeSharedDirectoriesRequest.Builderavoiding the need to create one manually viaDescribeSharedDirectoriesRequest.builder()- Parameters:
describeSharedDirectoriesRequest- AConsumerthat will call methods onDescribeSharedDirectoriesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue is not valid.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeSnapshots
default DescribeSnapshotsResponse describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
- Parameters:
describeSnapshotsRequest- Contains the inputs for the DescribeSnapshots operation.- Returns:
- Result of the DescribeSnapshots operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSnapshots
default DescribeSnapshotsResponse describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
This is a convenience which creates an instance of the
DescribeSnapshotsRequest.Builderavoiding the need to create one manually viaDescribeSnapshotsRequest.builder()- Parameters:
describeSnapshotsRequest- AConsumerthat will call methods onDescribeSnapshotsRequest.Builderto create a request. Contains the inputs for the DescribeSnapshots operation.- Returns:
- Result of the DescribeSnapshots operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSnapshots
default DescribeSnapshotsResponse describeSnapshots() throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
- Returns:
- Result of the DescribeSnapshots operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
describeSnapshots(DescribeSnapshotsRequest), AWS API Documentation
-
describeSnapshotsPaginator
default DescribeSnapshotsIterable describeSnapshotsPaginator() throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client .describeSnapshotsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
describeSnapshotsPaginator(DescribeSnapshotsRequest), AWS API Documentation
-
describeSnapshotsPaginator
default DescribeSnapshotsIterable describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client .describeSnapshotsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)operation.- Parameters:
describeSnapshotsRequest- Contains the inputs for the DescribeSnapshots operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSnapshotsPaginator
default DescribeSnapshotsIterable describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) throws EntityDoesNotExistException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client .describeSnapshotsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest)operation.
This is a convenience which creates an instance of the
DescribeSnapshotsRequest.Builderavoiding the need to create one manually viaDescribeSnapshotsRequest.builder()- Parameters:
describeSnapshotsRequest- AConsumerthat will call methods onDescribeSnapshotsRequest.Builderto create a request. Contains the inputs for the DescribeSnapshots operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTrusts
default DescribeTrustsResponse describeTrusts(DescribeTrustsRequest describeTrustsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
- 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:
- Result of the DescribeTrusts operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeTrusts
default DescribeTrustsResponse describeTrusts(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
This is a convenience which creates an instance of the
DescribeTrustsRequest.Builderavoiding the need to create one manually viaDescribeTrustsRequest.builder()- Parameters:
describeTrustsRequest- AConsumerthat will call methods onDescribeTrustsRequest.Builderto 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:
- Result of the DescribeTrusts operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeTrusts
default DescribeTrustsResponse describeTrusts() throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
- Returns:
- Result of the DescribeTrusts operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
describeTrusts(DescribeTrustsRequest), AWS API Documentation
-
describeTrustsPaginator
default DescribeTrustsIterable describeTrustsPaginator() throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client.describeTrustsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client .describeTrustsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeTrustsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client.describeTrustsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
describeTrustsPaginator(DescribeTrustsRequest), AWS API Documentation
-
describeTrustsPaginator
default DescribeTrustsIterable describeTrustsPaginator(DescribeTrustsRequest describeTrustsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client.describeTrustsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client .describeTrustsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeTrustsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client.describeTrustsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeTrustsPaginator
default DescribeTrustsIterable describeTrustsPaginator(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client.describeTrustsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client .describeTrustsPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeTrustsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client.describeTrustsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest)operation.
This is a convenience which creates an instance of the
DescribeTrustsRequest.Builderavoiding the need to create one manually viaDescribeTrustsRequest.builder()- Parameters:
describeTrustsRequest- AConsumerthat will call methods onDescribeTrustsRequest.Builderto 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 iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
describeUpdateDirectory
default DescribeUpdateDirectoryResponse describeUpdateDirectory(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest) throws DirectoryDoesNotExistException, InvalidParameterException, AccessDeniedException, ClientException, ServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, DirectoryException
Describes the updates of a directory for a particular update type.
- Parameters:
describeUpdateDirectoryRequest-- Returns:
- Result of the DescribeUpdateDirectory operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUpdateDirectory
default DescribeUpdateDirectoryResponse describeUpdateDirectory(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest) throws DirectoryDoesNotExistException, InvalidParameterException, AccessDeniedException, ClientException, ServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, DirectoryException
Describes the updates of a directory for a particular update type.
This is a convenience which creates an instance of the
DescribeUpdateDirectoryRequest.Builderavoiding the need to create one manually viaDescribeUpdateDirectoryRequest.builder()- Parameters:
describeUpdateDirectoryRequest- AConsumerthat will call methods onDescribeUpdateDirectoryRequest.Builderto create a request.- Returns:
- Result of the DescribeUpdateDirectory operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUpdateDirectoryPaginator
default DescribeUpdateDirectoryIterable describeUpdateDirectoryPaginator(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest) throws DirectoryDoesNotExistException, InvalidParameterException, AccessDeniedException, ClientException, ServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryIterable responses = client.describeUpdateDirectoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryIterable responses = client .describeUpdateDirectoryPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryIterable responses = client.describeUpdateDirectoryPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUpdateDirectoryPaginator
default DescribeUpdateDirectoryIterable describeUpdateDirectoryPaginator(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest) throws DirectoryDoesNotExistException, InvalidParameterException, AccessDeniedException, ClientException, ServiceException, InvalidNextTokenException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryIterable responses = client.describeUpdateDirectoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryIterable responses = client .describeUpdateDirectoryPaginator(request); for (software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryIterable responses = client.describeUpdateDirectoryPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaDescribeUpdateDirectoryRequest.builder()- Parameters:
describeUpdateDirectoryRequest- AConsumerthat will call methods onDescribeUpdateDirectoryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
disableClientAuthentication
default DisableClientAuthenticationResponse disableClientAuthentication(DisableClientAuthenticationRequest disableClientAuthenticationRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidClientAuthStatusException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables alternative client authentication methods for the specified directory.
- Parameters:
disableClientAuthenticationRequest-- Returns:
- Result of the DisableClientAuthentication operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
disableClientAuthentication
default DisableClientAuthenticationResponse disableClientAuthentication(Consumer<DisableClientAuthenticationRequest.Builder> disableClientAuthenticationRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidClientAuthStatusException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables alternative client authentication methods for the specified directory.
This is a convenience which creates an instance of the
DisableClientAuthenticationRequest.Builderavoiding the need to create one manually viaDisableClientAuthenticationRequest.builder()- Parameters:
disableClientAuthenticationRequest- AConsumerthat will call methods onDisableClientAuthenticationRequest.Builderto create a request.- Returns:
- Result of the DisableClientAuthentication operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
disableLDAPS
default DisableLdapsResponse disableLDAPS(DisableLdapsRequest disableLdapsRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, InvalidLdapsStatusException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deactivates LDAP secure calls for the specified directory.
- Parameters:
disableLdapsRequest-- Returns:
- Result of the DisableLDAPS operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
disableLDAPS
default DisableLdapsResponse disableLDAPS(Consumer<DisableLdapsRequest.Builder> disableLdapsRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, InvalidLdapsStatusException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Deactivates LDAP secure calls for the specified directory.
This is a convenience which creates an instance of the
DisableLdapsRequest.Builderavoiding the need to create one manually viaDisableLdapsRequest.builder()- Parameters:
disableLdapsRequest- AConsumerthat will call methods onDisableLdapsRequest.Builderto create a request.- Returns:
- Result of the DisableLDAPS operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
disableRadius
default DisableRadiusResponse disableRadius(DisableRadiusRequest disableRadiusRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
- Parameters:
disableRadiusRequest- Contains the inputs for the DisableRadius operation.- Returns:
- Result of the DisableRadius operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disableRadius
default DisableRadiusResponse disableRadius(Consumer<DisableRadiusRequest.Builder> disableRadiusRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
This is a convenience which creates an instance of the
DisableRadiusRequest.Builderavoiding the need to create one manually viaDisableRadiusRequest.builder()- Parameters:
disableRadiusRequest- AConsumerthat will call methods onDisableRadiusRequest.Builderto create a request. Contains the inputs for the DisableRadius operation.- Returns:
- Result of the DisableRadius operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disableSso
default DisableSsoResponse disableSso(DisableSsoRequest disableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables single-sign on for a directory.
- Parameters:
disableSsoRequest- Contains the inputs for the DisableSso operation.- Returns:
- Result of the DisableSso operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InsufficientPermissionsException- The account does not have sufficient permission to perform the operation.AuthenticationFailedException- An authentication error occurred.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disableSso
default DisableSsoResponse disableSso(Consumer<DisableSsoRequest.Builder> disableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Disables single-sign on for a directory.
This is a convenience which creates an instance of the
DisableSsoRequest.Builderavoiding the need to create one manually viaDisableSsoRequest.builder()- Parameters:
disableSsoRequest- AConsumerthat will call methods onDisableSsoRequest.Builderto create a request. Contains the inputs for the DisableSso operation.- Returns:
- Result of the DisableSso operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InsufficientPermissionsException- The account does not have sufficient permission to perform the operation.AuthenticationFailedException- An authentication error occurred.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
enableClientAuthentication
default EnableClientAuthenticationResponse enableClientAuthentication(EnableClientAuthenticationRequest enableClientAuthenticationRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidClientAuthStatusException, AccessDeniedException, NoAvailableCertificateException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables alternative client authentication methods for the specified directory.
- Parameters:
enableClientAuthenticationRequest-- Returns:
- Result of the EnableClientAuthentication operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
enableClientAuthentication
default EnableClientAuthenticationResponse enableClientAuthentication(Consumer<EnableClientAuthenticationRequest.Builder> enableClientAuthenticationRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidClientAuthStatusException, AccessDeniedException, NoAvailableCertificateException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables alternative client authentication methods for the specified directory.
This is a convenience which creates an instance of the
EnableClientAuthenticationRequest.Builderavoiding the need to create one manually viaEnableClientAuthenticationRequest.builder()- Parameters:
enableClientAuthenticationRequest- AConsumerthat will call methods onEnableClientAuthenticationRequest.Builderto create a request.- Returns:
- Result of the EnableClientAuthentication operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
enableLDAPS
default EnableLdapsResponse enableLDAPS(EnableLdapsRequest enableLdapsRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, NoAvailableCertificateException, InvalidLdapsStatusException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Activates the switch for the specific directory to always use LDAP secure calls.
- Parameters:
enableLdapsRequest-- Returns:
- Result of the EnableLDAPS operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
enableLDAPS
default EnableLdapsResponse enableLDAPS(Consumer<EnableLdapsRequest.Builder> enableLdapsRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, NoAvailableCertificateException, InvalidLdapsStatusException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Activates the switch for the specific directory to always use LDAP secure calls.
This is a convenience which creates an instance of the
EnableLdapsRequest.Builderavoiding the need to create one manually viaEnableLdapsRequest.builder()- Parameters:
enableLdapsRequest- AConsumerthat will call methods onEnableLdapsRequest.Builderto create a request.- Returns:
- Result of the EnableLDAPS operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
enableRadius
default EnableRadiusResponse enableRadius(EnableRadiusRequest enableRadiusRequest) throws InvalidParameterException, EntityAlreadyExistsException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
- Parameters:
enableRadiusRequest- Contains the inputs for the EnableRadius operation.- Returns:
- Result of the EnableRadius operation returned by the service.
- Throws:
InvalidParameterException- One or more parameters are not valid.EntityAlreadyExistsException- The specified entity already exists.EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
enableRadius
default EnableRadiusResponse enableRadius(Consumer<EnableRadiusRequest.Builder> enableRadiusRequest) throws InvalidParameterException, EntityAlreadyExistsException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
This is a convenience which creates an instance of the
EnableRadiusRequest.Builderavoiding the need to create one manually viaEnableRadiusRequest.builder()- Parameters:
enableRadiusRequest- AConsumerthat will call methods onEnableRadiusRequest.Builderto create a request. Contains the inputs for the EnableRadius operation.- Returns:
- Result of the EnableRadius operation returned by the service.
- Throws:
InvalidParameterException- One or more parameters are not valid.EntityAlreadyExistsException- The specified entity already exists.EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
enableSso
default EnableSsoResponse enableSso(EnableSsoRequest enableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
- Parameters:
enableSsoRequest- Contains the inputs for the EnableSso operation.- Returns:
- Result of the EnableSso operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InsufficientPermissionsException- The account does not have sufficient permission to perform the operation.AuthenticationFailedException- An authentication error occurred.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
enableSso
default EnableSsoResponse enableSso(Consumer<EnableSsoRequest.Builder> enableSsoRequest) throws EntityDoesNotExistException, InsufficientPermissionsException, AuthenticationFailedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
This is a convenience which creates an instance of the
EnableSsoRequest.Builderavoiding the need to create one manually viaEnableSsoRequest.builder()- Parameters:
enableSsoRequest- AConsumerthat will call methods onEnableSsoRequest.Builderto create a request. Contains the inputs for the EnableSso operation.- Returns:
- Result of the EnableSso operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InsufficientPermissionsException- The account does not have sufficient permission to perform the operation.AuthenticationFailedException- An authentication error occurred.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDirectoryLimits
default GetDirectoryLimitsResponse getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains directory limit information for the current Region.
- Parameters:
getDirectoryLimitsRequest- Contains the inputs for the GetDirectoryLimits operation.- Returns:
- Result of the GetDirectoryLimits operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDirectoryLimits
default GetDirectoryLimitsResponse getDirectoryLimits(Consumer<GetDirectoryLimitsRequest.Builder> getDirectoryLimitsRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains directory limit information for the current Region.
This is a convenience which creates an instance of the
GetDirectoryLimitsRequest.Builderavoiding the need to create one manually viaGetDirectoryLimitsRequest.builder()- Parameters:
getDirectoryLimitsRequest- AConsumerthat will call methods onGetDirectoryLimitsRequest.Builderto create a request. Contains the inputs for the GetDirectoryLimits operation.- Returns:
- Result of the GetDirectoryLimits operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDirectoryLimits
default GetDirectoryLimitsResponse getDirectoryLimits() throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains directory limit information for the current Region.
- Returns:
- Result of the GetDirectoryLimits operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
getDirectoryLimits(GetDirectoryLimitsRequest), AWS API Documentation
-
getSnapshotLimits
default GetSnapshotLimitsResponse getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains the manual snapshot limits for a directory.
- Parameters:
getSnapshotLimitsRequest- Contains the inputs for the GetSnapshotLimits operation.- Returns:
- Result of the GetSnapshotLimits operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getSnapshotLimits
default GetSnapshotLimitsResponse getSnapshotLimits(Consumer<GetSnapshotLimitsRequest.Builder> getSnapshotLimitsRequest) throws EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Obtains the manual snapshot limits for a directory.
This is a convenience which creates an instance of the
GetSnapshotLimitsRequest.Builderavoiding the need to create one manually viaGetSnapshotLimitsRequest.builder()- Parameters:
getSnapshotLimitsRequest- AConsumerthat will call methods onGetSnapshotLimitsRequest.Builderto create a request. Contains the inputs for the GetSnapshotLimits operation.- Returns:
- Result of the GetSnapshotLimits operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCertificates
default ListCertificatesResponse listCertificates(ListCertificatesRequest listCertificatesRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
- Parameters:
listCertificatesRequest-- Returns:
- Result of the ListCertificates operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
listCertificates
default ListCertificatesResponse listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
This is a convenience which creates an instance of the
ListCertificatesRequest.Builderavoiding the need to create one manually viaListCertificatesRequest.builder()- Parameters:
listCertificatesRequest- AConsumerthat will call methods onListCertificatesRequest.Builderto create a request.- Returns:
- Result of the ListCertificates operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
listCertificatesPaginator
default ListCertificatesIterable listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListCertificatesIterable responses = client .listCertificatesPaginator(request); for (software.amazon.awssdk.services.directory.model.ListCertificatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)operation.- Parameters:
listCertificatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
listCertificatesPaginator
default ListCertificatesIterable listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, InvalidParameterException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListCertificatesIterable responses = client .listCertificatesPaginator(request); for (software.amazon.awssdk.services.directory.model.ListCertificatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest)operation.
This is a convenience which creates an instance of the
ListCertificatesRequest.Builderavoiding the need to create one manually viaListCertificatesRequest.builder()- Parameters:
listCertificatesRequest- AConsumerthat will call methods onListCertificatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
listIpRoutes
default ListIpRoutesResponse listIpRoutes(ListIpRoutesRequest listIpRoutesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the address blocks that you have added to a directory.
- Parameters:
listIpRoutesRequest-- Returns:
- Result of the ListIpRoutes operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIpRoutes
default ListIpRoutesResponse listIpRoutes(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the address blocks that you have added to a directory.
This is a convenience which creates an instance of the
ListIpRoutesRequest.Builderavoiding the need to create one manually viaListIpRoutesRequest.builder()- Parameters:
listIpRoutesRequest- AConsumerthat will call methods onListIpRoutesRequest.Builderto create a request.- Returns:
- Result of the ListIpRoutes operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIpRoutesPaginator
default ListIpRoutesIterable listIpRoutesPaginator(ListIpRoutesRequest listIpRoutesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListIpRoutesIterable responses = client.listIpRoutesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListIpRoutesIterable responses = client.listIpRoutesPaginator(request); for (software.amazon.awssdk.services.directory.model.ListIpRoutesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListIpRoutesIterable responses = client.listIpRoutesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)operation.- Parameters:
listIpRoutesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIpRoutesPaginator
default ListIpRoutesIterable listIpRoutesPaginator(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListIpRoutesIterable responses = client.listIpRoutesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListIpRoutesIterable responses = client.listIpRoutesPaginator(request); for (software.amazon.awssdk.services.directory.model.ListIpRoutesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListIpRoutesIterable responses = client.listIpRoutesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest)operation.
This is a convenience which creates an instance of the
ListIpRoutesRequest.Builderavoiding the need to create one manually viaListIpRoutesRequest.builder()- Parameters:
listIpRoutesRequest- AConsumerthat will call methods onListIpRoutesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLogSubscriptions
default ListLogSubscriptionsResponse listLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the active log subscriptions for the Amazon Web Services account.
- Parameters:
listLogSubscriptionsRequest-- Returns:
- Result of the ListLogSubscriptions operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLogSubscriptions
default ListLogSubscriptionsResponse listLogSubscriptions(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the active log subscriptions for the Amazon Web Services account.
This is a convenience which creates an instance of the
ListLogSubscriptionsRequest.Builderavoiding the need to create one manually viaListLogSubscriptionsRequest.builder()- Parameters:
listLogSubscriptionsRequest- AConsumerthat will call methods onListLogSubscriptionsRequest.Builderto create a request.- Returns:
- Result of the ListLogSubscriptions operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLogSubscriptions
default ListLogSubscriptionsResponse listLogSubscriptions() throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists the active log subscriptions for the Amazon Web Services account.
- Returns:
- Result of the ListLogSubscriptions operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
listLogSubscriptions(ListLogSubscriptionsRequest), AWS API Documentation
-
listLogSubscriptionsPaginator
default ListLogSubscriptionsIterable listLogSubscriptionsPaginator() throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client.listLogSubscriptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client .listLogSubscriptionsPaginator(request); for (software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client.listLogSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
listLogSubscriptionsPaginator(ListLogSubscriptionsRequest), AWS API Documentation
-
listLogSubscriptionsPaginator
default ListLogSubscriptionsIterable listLogSubscriptionsPaginator(ListLogSubscriptionsRequest listLogSubscriptionsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client.listLogSubscriptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client .listLogSubscriptionsPaginator(request); for (software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client.listLogSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)operation.- Parameters:
listLogSubscriptionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listLogSubscriptionsPaginator
default ListLogSubscriptionsIterable listLogSubscriptionsPaginator(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest) throws EntityDoesNotExistException, InvalidNextTokenException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client.listLogSubscriptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client .listLogSubscriptionsPaginator(request); for (software.amazon.awssdk.services.directory.model.ListLogSubscriptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client.listLogSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest)operation.
This is a convenience which creates an instance of the
ListLogSubscriptionsRequest.Builderavoiding the need to create one manually viaListLogSubscriptionsRequest.builder()- Parameters:
listLogSubscriptionsRequest- AConsumerthat will call methods onListLogSubscriptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSchemaExtensions
default ListSchemaExtensionsResponse listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest) throws InvalidNextTokenException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists all schema extensions applied to a Microsoft AD Directory.
- Parameters:
listSchemaExtensionsRequest-- Returns:
- Result of the ListSchemaExtensions operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSchemaExtensions
default ListSchemaExtensionsResponse listSchemaExtensions(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest) throws InvalidNextTokenException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists all schema extensions applied to a Microsoft AD Directory.
This is a convenience which creates an instance of the
ListSchemaExtensionsRequest.Builderavoiding the need to create one manually viaListSchemaExtensionsRequest.builder()- Parameters:
listSchemaExtensionsRequest- AConsumerthat will call methods onListSchemaExtensionsRequest.Builderto create a request.- Returns:
- Result of the ListSchemaExtensions operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSchemaExtensionsPaginator
default ListSchemaExtensionsIterable listSchemaExtensionsPaginator(ListSchemaExtensionsRequest listSchemaExtensionsRequest) throws InvalidNextTokenException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsIterable responses = client.listSchemaExtensionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsIterable responses = client .listSchemaExtensionsPaginator(request); for (software.amazon.awssdk.services.directory.model.ListSchemaExtensionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsIterable responses = client.listSchemaExtensionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)operation.- Parameters:
listSchemaExtensionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSchemaExtensionsPaginator
default ListSchemaExtensionsIterable listSchemaExtensionsPaginator(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest) throws InvalidNextTokenException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsIterable responses = client.listSchemaExtensionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsIterable responses = client .listSchemaExtensionsPaginator(request); for (software.amazon.awssdk.services.directory.model.ListSchemaExtensionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsIterable responses = client.listSchemaExtensionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest)operation.
This is a convenience which creates an instance of the
ListSchemaExtensionsRequest.Builderavoiding the need to create one manually viaListSchemaExtensionsRequest.builder()- Parameters:
listSchemaExtensionsRequest- AConsumerthat will call methods onListSchemaExtensionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists all tags on a directory.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Lists all tags on a directory.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.directory.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)operation.- Parameters:
listTagsForResourceRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws EntityDoesNotExistException, InvalidNextTokenException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
This is a variant of
listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.directory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.directory.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.directory.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.directory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest)operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
registerCertificate
default RegisterCertificateResponse registerCertificate(RegisterCertificateRequest registerCertificateRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, InvalidCertificateException, CertificateLimitExceededException, CertificateAlreadyExistsException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Registers a certificate for a secure LDAP or client certificate authentication.
- Parameters:
registerCertificateRequest-- Returns:
- Result of the RegisterCertificate operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
registerCertificate
default RegisterCertificateResponse registerCertificate(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, InvalidCertificateException, CertificateLimitExceededException, CertificateAlreadyExistsException, UnsupportedOperationException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Registers a certificate for a secure LDAP or client certificate authentication.
This is a convenience which creates an instance of the
RegisterCertificateRequest.Builderavoiding the need to create one manually viaRegisterCertificateRequest.builder()- Parameters:
registerCertificateRequest- AConsumerthat will call methods onRegisterCertificateRequest.Builderto create a request.- Returns:
- Result of the RegisterCertificate operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
registerEventTopic
default RegisterEventTopicResponse registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
- Parameters:
registerEventTopicRequest- Registers a new event topic.- Returns:
- Result of the RegisterEventTopic operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
registerEventTopic
default RegisterEventTopicResponse registerEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
This is a convenience which creates an instance of the
RegisterEventTopicRequest.Builderavoiding the need to create one manually viaRegisterEventTopicRequest.builder()- Parameters:
registerEventTopicRequest- AConsumerthat will call methods onRegisterEventTopicRequest.Builderto create a request. Registers a new event topic.- Returns:
- Result of the RegisterEventTopic operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
rejectSharedDirectory
default RejectSharedDirectoryResponse rejectSharedDirectory(RejectSharedDirectoryRequest rejectSharedDirectoryRequest) throws InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadySharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Rejects a directory sharing request that was sent from the directory owner account.
- Parameters:
rejectSharedDirectoryRequest-- Returns:
- Result of the RejectSharedDirectory operation returned by the service.
- Throws:
InvalidParameterException- One or more parameters are not valid.EntityDoesNotExistException- The specified entity could not be found.DirectoryAlreadySharedException- The specified directory has already been shared with this Amazon Web Services account.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
rejectSharedDirectory
default RejectSharedDirectoryResponse rejectSharedDirectory(Consumer<RejectSharedDirectoryRequest.Builder> rejectSharedDirectoryRequest) throws InvalidParameterException, EntityDoesNotExistException, DirectoryAlreadySharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Rejects a directory sharing request that was sent from the directory owner account.
This is a convenience which creates an instance of the
RejectSharedDirectoryRequest.Builderavoiding the need to create one manually viaRejectSharedDirectoryRequest.builder()- Parameters:
rejectSharedDirectoryRequest- AConsumerthat will call methods onRejectSharedDirectoryRequest.Builderto create a request.- Returns:
- Result of the RejectSharedDirectory operation returned by the service.
- Throws:
InvalidParameterException- One or more parameters are not valid.EntityDoesNotExistException- The specified entity could not be found.DirectoryAlreadySharedException- The specified directory has already been shared with this Amazon Web Services account.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeIpRoutes
default RemoveIpRoutesResponse removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest) throws EntityDoesNotExistException, InvalidParameterException, DirectoryUnavailableException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes IP address blocks from a directory.
- Parameters:
removeIpRoutesRequest-- Returns:
- Result of the RemoveIpRoutes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
removeIpRoutes
default RemoveIpRoutesResponse removeIpRoutes(Consumer<RemoveIpRoutesRequest.Builder> removeIpRoutesRequest) throws EntityDoesNotExistException, InvalidParameterException, DirectoryUnavailableException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes IP address blocks from a directory.
This is a convenience which creates an instance of the
RemoveIpRoutesRequest.Builderavoiding the need to create one manually viaRemoveIpRoutesRequest.builder()- Parameters:
removeIpRoutesRequest- AConsumerthat will call methods onRemoveIpRoutesRequest.Builderto create a request.- Returns:
- Result of the RemoveIpRoutes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
removeRegion
default RemoveRegionResponse removeRegion(RemoveRegionRequest removeRegionRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, UnsupportedOperationException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the
DeleteDirectoryAPI.- Parameters:
removeRegionRequest-- Returns:
- Result of the RemoveRegion operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
removeRegion
default RemoveRegionResponse removeRegion(Consumer<RemoveRegionRequest.Builder> removeRegionRequest) throws DirectoryUnavailableException, DirectoryDoesNotExistException, UnsupportedOperationException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the
DeleteDirectoryAPI.
This is a convenience which creates an instance of the
RemoveRegionRequest.Builderavoiding the need to create one manually viaRemoveRegionRequest.builder()- Parameters:
removeRegionRequest- AConsumerthat will call methods onRemoveRegionRequest.Builderto create a request.- Returns:
- Result of the RemoveRegion operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes tags from a directory.
- Parameters:
removeTagsFromResourceRequest-- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Removes tags from a directory.
This is a convenience which creates an instance of the
RemoveTagsFromResourceRequest.Builderavoiding the need to create one manually viaRemoveTagsFromResourceRequest.builder()- Parameters:
removeTagsFromResourceRequest- AConsumerthat will call methods onRemoveTagsFromResourceRequest.Builderto create a request.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resetUserPassword
default ResetUserPasswordResponse resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest) throws DirectoryUnavailableException, UserDoesNotExistException, InvalidPasswordException, UnsupportedOperationException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
You can reset the password for any user in your directory with the following exceptions:
-
For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.
-
For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.
- Parameters:
resetUserPasswordRequest-- Returns:
- Result of the ResetUserPassword operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
-
resetUserPassword
default ResetUserPasswordResponse resetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest) throws DirectoryUnavailableException, UserDoesNotExistException, InvalidPasswordException, UnsupportedOperationException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Resets the password for any user in your 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.Builderavoiding the need to create one manually viaResetUserPasswordRequest.builder()- Parameters:
resetUserPasswordRequest- AConsumerthat will call methods onResetUserPasswordRequest.Builderto create a request.- Returns:
- Result of the ResetUserPassword operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
-
restoreFromSnapshot
default RestoreFromSnapshotResponse restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to
Active, the restore operation is complete.- Parameters:
restoreFromSnapshotRequest- An object representing the inputs for the RestoreFromSnapshot operation.- Returns:
- Result of the RestoreFromSnapshot operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
restoreFromSnapshot
default RestoreFromSnapshotResponse restoreFromSnapshot(Consumer<RestoreFromSnapshotRequest.Builder> restoreFromSnapshotRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to
Active, the restore operation is complete.
This is a convenience which creates an instance of the
RestoreFromSnapshotRequest.Builderavoiding the need to create one manually viaRestoreFromSnapshotRequest.builder()- Parameters:
restoreFromSnapshotRequest- AConsumerthat will call methods onRestoreFromSnapshotRequest.Builderto create a request. An object representing the inputs for the RestoreFromSnapshot operation.- Returns:
- Result of the RestoreFromSnapshot operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
shareDirectory
default ShareDirectoryResponse shareDirectory(ShareDirectoryRequest shareDirectoryRequest) throws DirectoryAlreadySharedException, EntityDoesNotExistException, InvalidTargetException, InvalidParameterException, ClientException, ShareLimitExceededException, OrganizationsException, AccessDeniedException, UnsupportedOperationException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Shares a specified directory (
DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). With this operation you can use your directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.
The
ShareMethodparameter determines whether the specified directory can be shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also determines whether you can share the directory with any other Amazon Web Services account either inside or outside of the organization (HANDSHAKE).The
ShareNotesparameter is only used whenHANDSHAKEis called, which sends a directory sharing request to the directory consumer.- Parameters:
shareDirectoryRequest-- Returns:
- Result of the ShareDirectory operation returned by the service.
- Throws:
DirectoryAlreadySharedException- The specified directory has already been shared with this Amazon Web Services account.EntityDoesNotExistException- The specified entity could not be found.InvalidTargetException- The specified shared target is not valid.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ShareLimitExceededException- The maximum number of Amazon Web Services accounts that you can share with this directory has been reached.OrganizationsException- Exception encountered while trying to access your Amazon Web Services organization.AccessDeniedException- Client authentication is not available in this region at this time.UnsupportedOperationException- The operation is not supported.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
shareDirectory
default ShareDirectoryResponse shareDirectory(Consumer<ShareDirectoryRequest.Builder> shareDirectoryRequest) throws DirectoryAlreadySharedException, EntityDoesNotExistException, InvalidTargetException, InvalidParameterException, ClientException, ShareLimitExceededException, OrganizationsException, AccessDeniedException, UnsupportedOperationException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Shares a specified directory (
DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). With this operation you can use your directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.
The
ShareMethodparameter determines whether the specified directory can be shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also determines whether you can share the directory with any other Amazon Web Services account either inside or outside of the organization (HANDSHAKE).The
ShareNotesparameter is only used whenHANDSHAKEis called, which sends a directory sharing request to the directory consumer.
This is a convenience which creates an instance of the
ShareDirectoryRequest.Builderavoiding the need to create one manually viaShareDirectoryRequest.builder()- Parameters:
shareDirectoryRequest- AConsumerthat will call methods onShareDirectoryRequest.Builderto create a request.- Returns:
- Result of the ShareDirectory operation returned by the service.
- Throws:
DirectoryAlreadySharedException- The specified directory has already been shared with this Amazon Web Services account.EntityDoesNotExistException- The specified entity could not be found.InvalidTargetException- The specified shared target is not valid.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ShareLimitExceededException- The maximum number of Amazon Web Services accounts that you can share with this directory has been reached.OrganizationsException- Exception encountered while trying to access your Amazon Web Services organization.AccessDeniedException- Client authentication is not available in this region at this time.UnsupportedOperationException- The operation is not supported.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
startSchemaExtension
default StartSchemaExtensionResponse startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest) throws DirectoryUnavailableException, EntityDoesNotExistException, InvalidParameterException, SnapshotLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Applies a schema extension to a Microsoft AD directory.
- Parameters:
startSchemaExtensionRequest-- Returns:
- Result of the StartSchemaExtension operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startSchemaExtension
default StartSchemaExtensionResponse startSchemaExtension(Consumer<StartSchemaExtensionRequest.Builder> startSchemaExtensionRequest) throws DirectoryUnavailableException, EntityDoesNotExistException, InvalidParameterException, SnapshotLimitExceededException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Applies a schema extension to a Microsoft AD directory.
This is a convenience which creates an instance of the
StartSchemaExtensionRequest.Builderavoiding the need to create one manually viaStartSchemaExtensionRequest.builder()- Parameters:
startSchemaExtensionRequest- AConsumerthat will call methods onStartSchemaExtensionRequest.Builderto create a request.- Returns:
- Result of the StartSchemaExtension operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
unshareDirectory
default UnshareDirectoryResponse unshareDirectory(UnshareDirectoryRequest unshareDirectoryRequest) throws EntityDoesNotExistException, InvalidTargetException, DirectoryNotSharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Stops the directory sharing between the directory owner and consumer accounts.
- Parameters:
unshareDirectoryRequest-- Returns:
- Result of the UnshareDirectory operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidTargetException- The specified shared target is not valid.DirectoryNotSharedException- The specified directory has not been shared with this Amazon Web Services account.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
unshareDirectory
default UnshareDirectoryResponse unshareDirectory(Consumer<UnshareDirectoryRequest.Builder> unshareDirectoryRequest) throws EntityDoesNotExistException, InvalidTargetException, DirectoryNotSharedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Stops the directory sharing between the directory owner and consumer accounts.
This is a convenience which creates an instance of the
UnshareDirectoryRequest.Builderavoiding the need to create one manually viaUnshareDirectoryRequest.builder()- Parameters:
unshareDirectoryRequest- AConsumerthat will call methods onUnshareDirectoryRequest.Builderto create a request.- Returns:
- Result of the UnshareDirectory operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidTargetException- The specified shared target is not valid.DirectoryNotSharedException- The specified directory has not been shared with this Amazon Web Services account.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateConditionalForwarder
default UpdateConditionalForwarderResponse updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
- Parameters:
updateConditionalForwarderRequest- Updates a conditional forwarder.- Returns:
- Result of the UpdateConditionalForwarder operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.DirectoryUnavailableException- The specified directory is unavailable or could not be found.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
updateConditionalForwarder
default UpdateConditionalForwarderResponse updateConditionalForwarder(Consumer<UpdateConditionalForwarderRequest.Builder> updateConditionalForwarderRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
This is a convenience which creates an instance of the
UpdateConditionalForwarderRequest.Builderavoiding the need to create one manually viaUpdateConditionalForwarderRequest.builder()- Parameters:
updateConditionalForwarderRequest- AConsumerthat will call methods onUpdateConditionalForwarderRequest.Builderto create a request. Updates a conditional forwarder.- Returns:
- Result of the UpdateConditionalForwarder operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.DirectoryUnavailableException- The specified directory is unavailable or could not be found.InvalidParameterException- One or more parameters are not valid.UnsupportedOperationException- The operation is not supported.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
updateDirectorySetup
default UpdateDirectorySetupResponse updateDirectorySetup(UpdateDirectorySetupRequest updateDirectorySetupRequest) throws UnsupportedOperationException, DirectoryInDesiredStateException, DirectoryUnavailableException, SnapshotLimitExceededException, InvalidParameterException, DirectoryDoesNotExistException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the directory for a particular update type.
- Parameters:
updateDirectorySetupRequest-- Returns:
- Result of the UpdateDirectorySetup operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
updateDirectorySetup
default UpdateDirectorySetupResponse updateDirectorySetup(Consumer<UpdateDirectorySetupRequest.Builder> updateDirectorySetupRequest) throws UnsupportedOperationException, DirectoryInDesiredStateException, DirectoryUnavailableException, SnapshotLimitExceededException, InvalidParameterException, DirectoryDoesNotExistException, AccessDeniedException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the directory for a particular update type.
This is a convenience which creates an instance of the
UpdateDirectorySetupRequest.Builderavoiding the need to create one manually viaUpdateDirectorySetupRequest.builder()- Parameters:
updateDirectorySetupRequest- AConsumerthat will call methods onUpdateDirectorySetupRequest.Builderto create a request.- Returns:
- Result of the UpdateDirectorySetup operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
updateNumberOfDomainControllers
default UpdateNumberOfDomainControllersResponse updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, DomainControllerLimitExceededException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
- Parameters:
updateNumberOfDomainControllersRequest-- Returns:
- Result of the UpdateNumberOfDomainControllers operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.DirectoryUnavailableException- The specified directory is unavailable or could not be found.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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
updateNumberOfDomainControllers
default UpdateNumberOfDomainControllersResponse updateNumberOfDomainControllers(Consumer<UpdateNumberOfDomainControllersRequest.Builder> updateNumberOfDomainControllersRequest) throws EntityDoesNotExistException, DirectoryUnavailableException, DomainControllerLimitExceededException, InvalidParameterException, UnsupportedOperationException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
This is a convenience which creates an instance of the
UpdateNumberOfDomainControllersRequest.Builderavoiding the need to create one manually viaUpdateNumberOfDomainControllersRequest.builder()- Parameters:
updateNumberOfDomainControllersRequest- AConsumerthat will call methods onUpdateNumberOfDomainControllersRequest.Builderto create a request.- Returns:
- Result of the UpdateNumberOfDomainControllers operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.DirectoryUnavailableException- The specified directory is unavailable or could not be found.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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
updateRadius
default UpdateRadiusResponse updateRadius(UpdateRadiusRequest updateRadiusRequest) throws InvalidParameterException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
- Parameters:
updateRadiusRequest- Contains the inputs for the UpdateRadius operation.- Returns:
- Result of the UpdateRadius operation returned by the service.
- Throws:
InvalidParameterException- One or more parameters are not valid.EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateRadius
default UpdateRadiusResponse updateRadius(Consumer<UpdateRadiusRequest.Builder> updateRadiusRequest) throws InvalidParameterException, EntityDoesNotExistException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
This is a convenience which creates an instance of the
UpdateRadiusRequest.Builderavoiding the need to create one manually viaUpdateRadiusRequest.builder()- Parameters:
updateRadiusRequest- AConsumerthat will call methods onUpdateRadiusRequest.Builderto create a request. Contains the inputs for the UpdateRadius operation.- Returns:
- Result of the UpdateRadius operation returned by the service.
- Throws:
InvalidParameterException- One or more parameters are not valid.EntityDoesNotExistException- The specified entity could not be found.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateSettings
default UpdateSettingsResponse updateSettings(UpdateSettingsRequest updateSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, DirectoryUnavailableException, IncompatibleSettingsException, UnsupportedSettingsException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the configurable settings for the specified directory.
- Parameters:
updateSettingsRequest-- Returns:
- Result of the UpdateSettings operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
updateSettings
default UpdateSettingsResponse updateSettings(Consumer<UpdateSettingsRequest.Builder> updateSettingsRequest) throws DirectoryDoesNotExistException, UnsupportedOperationException, DirectoryUnavailableException, IncompatibleSettingsException, UnsupportedSettingsException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the configurable settings for the specified directory.
This is a convenience which creates an instance of the
UpdateSettingsRequest.Builderavoiding the need to create one manually viaUpdateSettingsRequest.builder()- Parameters:
updateSettingsRequest- AConsumerthat will call methods onUpdateSettingsRequest.Builderto create a request.- Returns:
- Result of the UpdateSettings operation returned by the service.
- Throws:
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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
updateTrust
default UpdateTrustResponse updateTrust(UpdateTrustRequest updateTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
- Parameters:
updateTrustRequest-- Returns:
- Result of the UpdateTrust operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateTrust
default UpdateTrustResponse updateTrust(Consumer<UpdateTrustRequest.Builder> updateTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, AwsServiceException, SdkClientException, DirectoryException
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
This is a convenience which creates an instance of the
UpdateTrustRequest.Builderavoiding the need to create one manually viaUpdateTrustRequest.builder()- Parameters:
updateTrustRequest- AConsumerthat will call methods onUpdateTrustRequest.Builderto create a request.- Returns:
- Result of the UpdateTrust operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in Directory Service.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DirectoryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
verifyTrust
default VerifyTrustResponse verifyTrust(VerifyTrustRequest verifyTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.
- Parameters:
verifyTrustRequest- Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.- Returns:
- Result of the VerifyTrust operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
verifyTrust
default VerifyTrustResponse verifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest) throws EntityDoesNotExistException, InvalidParameterException, ClientException, ServiceException, UnsupportedOperationException, AwsServiceException, SdkClientException, DirectoryException
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.
This is a convenience which creates an instance of the
VerifyTrustRequest.Builderavoiding the need to create one manually viaVerifyTrustRequest.builder()- Parameters:
verifyTrustRequest- AConsumerthat will call methods onVerifyTrustRequest.Builderto create a request. Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.- Returns:
- Result of the VerifyTrust operation returned by the service.
- Throws:
EntityDoesNotExistException- The specified entity could not be found.InvalidParameterException- One or more parameters are not valid.ClientException- A client exception has occurred.ServiceException- An exception has occurred in 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.UnsupportedOperationExceptionAwsServiceException- See Also:
- AWS API Documentation
-
create
static DirectoryClient create()
Create aDirectoryClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static DirectoryClientBuilder builder()
Create a builder that can be used to configure and create aDirectoryClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default DirectoryServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-