Interface DirectoryClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface DirectoryClient
extends AwsClient

Service client for accessing Directory Service. This can be created using the static builder() 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 final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AcceptSharedDirectoryResponse	acceptSharedDirectory(Consumer<AcceptSharedDirectoryRequest.Builder> acceptSharedDirectoryRequest)	Accepts a directory sharing request that was sent from the directory owner account.
default AcceptSharedDirectoryResponse	acceptSharedDirectory(AcceptSharedDirectoryRequest acceptSharedDirectoryRequest)	Accepts a directory sharing request that was sent from the directory owner account.
default AddIpRoutesResponse	addIpRoutes(Consumer<AddIpRoutesRequest.Builder> addIpRoutesRequest)	If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.
default AddIpRoutesResponse	addIpRoutes(AddIpRoutesRequest addIpRoutesRequest)	If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.
default AddRegionResponse	addRegion(Consumer<AddRegionRequest.Builder> addRegionRequest)	Adds two domain controllers in the specified Region for the specified directory.
default AddRegionResponse	addRegion(AddRegionRequest addRegionRequest)	Adds two domain controllers in the specified Region for the specified directory.
default AddTagsToResourceResponse	addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)	Adds or overwrites one or more tags for the specified directory.
default AddTagsToResourceResponse	addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)	Adds or overwrites one or more tags for the specified directory.
static DirectoryClientBuilder	builder()	Create a builder that can be used to configure and create a DirectoryClient.
default CancelSchemaExtensionResponse	cancelSchemaExtension(Consumer<CancelSchemaExtensionRequest.Builder> cancelSchemaExtensionRequest)	Cancels an in-progress schema extension to a Microsoft AD directory.
default CancelSchemaExtensionResponse	cancelSchemaExtension(CancelSchemaExtensionRequest cancelSchemaExtensionRequest)	Cancels an in-progress schema extension to a Microsoft AD directory.
default ConnectDirectoryResponse	connectDirectory(Consumer<ConnectDirectoryRequest.Builder> connectDirectoryRequest)	Creates an AD Connector to connect to a self-managed directory.
default ConnectDirectoryResponse	connectDirectory(ConnectDirectoryRequest connectDirectoryRequest)	Creates an AD Connector to connect to a self-managed directory.
static DirectoryClient	create()	Create a DirectoryClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAliasResponse	createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)	Creates an alias for a directory and assigns the alias to the directory.
default CreateAliasResponse	createAlias(CreateAliasRequest createAliasRequest)	Creates an alias for a directory and assigns the alias to the directory.
default CreateComputerResponse	createComputer(Consumer<CreateComputerRequest.Builder> createComputerRequest)	Creates an Active Directory computer object in the specified directory.
default CreateComputerResponse	createComputer(CreateComputerRequest createComputerRequest)	Creates an Active Directory computer object in the specified directory.
default CreateConditionalForwarderResponse	createConditionalForwarder(Consumer<CreateConditionalForwarderRequest.Builder> createConditionalForwarderRequest)	Creates a conditional forwarder associated with your Amazon Web Services directory.
default CreateConditionalForwarderResponse	createConditionalForwarder(CreateConditionalForwarderRequest createConditionalForwarderRequest)	Creates a conditional forwarder associated with your Amazon Web Services directory.
default CreateDirectoryResponse	createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest)	Creates a Simple AD directory.
default CreateDirectoryResponse	createDirectory(CreateDirectoryRequest createDirectoryRequest)	Creates a Simple AD directory.
default CreateHybridAdResponse	createHybridAD(Consumer<CreateHybridAdRequest.Builder> createHybridAdRequest)	Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services.
default CreateHybridAdResponse	createHybridAD(CreateHybridAdRequest createHybridAdRequest)	Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services.
default CreateLogSubscriptionResponse	createLogSubscription(Consumer<CreateLogSubscriptionRequest.Builder> createLogSubscriptionRequest)	Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
default CreateLogSubscriptionResponse	createLogSubscription(CreateLogSubscriptionRequest createLogSubscriptionRequest)	Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
default CreateMicrosoftAdResponse	createMicrosoftAD(Consumer<CreateMicrosoftAdRequest.Builder> createMicrosoftAdRequest)	Creates a Microsoft AD directory in the Amazon Web Services Cloud.
default CreateMicrosoftAdResponse	createMicrosoftAD(CreateMicrosoftAdRequest createMicrosoftAdRequest)	Creates a Microsoft AD directory in the Amazon Web Services Cloud.
default CreateSnapshotResponse	createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)	Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
default CreateSnapshotResponse	createSnapshot(CreateSnapshotRequest createSnapshotRequest)	Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
default CreateTrustResponse	createTrust(Consumer<CreateTrustRequest.Builder> createTrustRequest)	Directory Service for Microsoft Active Directory allows you to configure trust relationships.
default CreateTrustResponse	createTrust(CreateTrustRequest createTrustRequest)	Directory Service for Microsoft Active Directory allows you to configure trust relationships.
default DeleteAdAssessmentResponse	deleteADAssessment(Consumer<DeleteAdAssessmentRequest.Builder> deleteAdAssessmentRequest)	Deletes a directory assessment and all associated data.
default DeleteAdAssessmentResponse	deleteADAssessment(DeleteAdAssessmentRequest deleteAdAssessmentRequest)	Deletes a directory assessment and all associated data.
default DeleteConditionalForwarderResponse	deleteConditionalForwarder(Consumer<DeleteConditionalForwarderRequest.Builder> deleteConditionalForwarderRequest)	Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
default DeleteConditionalForwarderResponse	deleteConditionalForwarder(DeleteConditionalForwarderRequest deleteConditionalForwarderRequest)	Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
default DeleteDirectoryResponse	deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest)	Deletes an Directory Service directory.
default DeleteDirectoryResponse	deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)	Deletes an Directory Service directory.
default DeleteLogSubscriptionResponse	deleteLogSubscription(Consumer<DeleteLogSubscriptionRequest.Builder> deleteLogSubscriptionRequest)	Deletes the specified log subscription.
default DeleteLogSubscriptionResponse	deleteLogSubscription(DeleteLogSubscriptionRequest deleteLogSubscriptionRequest)	Deletes the specified log subscription.
default DeleteSnapshotResponse	deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)	Deletes a directory snapshot.
default DeleteSnapshotResponse	deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)	Deletes a directory snapshot.
default DeleteTrustResponse	deleteTrust(Consumer<DeleteTrustRequest.Builder> deleteTrustRequest)	Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
default DeleteTrustResponse	deleteTrust(DeleteTrustRequest deleteTrustRequest)	Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
default DeregisterCertificateResponse	deregisterCertificate(Consumer<DeregisterCertificateRequest.Builder> deregisterCertificateRequest)	Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
default DeregisterCertificateResponse	deregisterCertificate(DeregisterCertificateRequest deregisterCertificateRequest)	Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
default DeregisterEventTopicResponse	deregisterEventTopic(Consumer<DeregisterEventTopicRequest.Builder> deregisterEventTopicRequest)	Removes the specified directory as a publisher to the specified Amazon SNS topic.
default DeregisterEventTopicResponse	deregisterEventTopic(DeregisterEventTopicRequest deregisterEventTopicRequest)	Removes the specified directory as a publisher to the specified Amazon SNS topic.
default DescribeAdAssessmentResponse	describeADAssessment(Consumer<DescribeAdAssessmentRequest.Builder> describeAdAssessmentRequest)	Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details.
default DescribeAdAssessmentResponse	describeADAssessment(DescribeAdAssessmentRequest describeAdAssessmentRequest)	Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details.
default DescribeCaEnrollmentPolicyResponse	describeCAEnrollmentPolicy(Consumer<DescribeCaEnrollmentPolicyRequest.Builder> describeCaEnrollmentPolicyRequest)	Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory.
default DescribeCaEnrollmentPolicyResponse	describeCAEnrollmentPolicy(DescribeCaEnrollmentPolicyRequest describeCaEnrollmentPolicyRequest)	Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory.
default DescribeCertificateResponse	describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)	Displays information about the certificate registered for secure LDAP or client certificate authentication.
default DescribeCertificateResponse	describeCertificate(DescribeCertificateRequest describeCertificateRequest)	Displays information about the certificate registered for secure LDAP or client certificate authentication.
default DescribeClientAuthenticationSettingsResponse	describeClientAuthenticationSettings(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest)	Retrieves information about the type of client authentication for the specified directory, if the type is specified.
default DescribeClientAuthenticationSettingsResponse	describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest)	Retrieves information about the type of client authentication for the specified directory, if the type is specified.
default DescribeClientAuthenticationSettingsIterable	describeClientAuthenticationSettingsPaginator(Consumer<DescribeClientAuthenticationSettingsRequest.Builder> describeClientAuthenticationSettingsRequest)	This is a variant of describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest) operation.
default DescribeClientAuthenticationSettingsIterable	describeClientAuthenticationSettingsPaginator(DescribeClientAuthenticationSettingsRequest describeClientAuthenticationSettingsRequest)	This is a variant of describeClientAuthenticationSettings(software.amazon.awssdk.services.directory.model.DescribeClientAuthenticationSettingsRequest) operation.
default DescribeConditionalForwardersResponse	describeConditionalForwarders(Consumer<DescribeConditionalForwardersRequest.Builder> describeConditionalForwardersRequest)	Obtains information about the conditional forwarders for this account.
default DescribeConditionalForwardersResponse	describeConditionalForwarders(DescribeConditionalForwardersRequest describeConditionalForwardersRequest)	Obtains information about the conditional forwarders for this account.
default DescribeDirectoriesResponse	describeDirectories()	Obtains information about the directories that belong to this account.
default DescribeDirectoriesResponse	describeDirectories(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest)	Obtains information about the directories that belong to this account.
default DescribeDirectoriesResponse	describeDirectories(DescribeDirectoriesRequest describeDirectoriesRequest)	Obtains information about the directories that belong to this account.
default DescribeDirectoriesIterable	describeDirectoriesPaginator()	This is a variant of describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest) operation.
default DescribeDirectoriesIterable	describeDirectoriesPaginator(Consumer<DescribeDirectoriesRequest.Builder> describeDirectoriesRequest)	This is a variant of describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest) operation.
default DescribeDirectoriesIterable	describeDirectoriesPaginator(DescribeDirectoriesRequest describeDirectoriesRequest)	This is a variant of describeDirectories(software.amazon.awssdk.services.directory.model.DescribeDirectoriesRequest) operation.
default DescribeDirectoryDataAccessResponse	describeDirectoryDataAccess(Consumer<DescribeDirectoryDataAccessRequest.Builder> describeDirectoryDataAccessRequest)	Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.
default DescribeDirectoryDataAccessResponse	describeDirectoryDataAccess(DescribeDirectoryDataAccessRequest describeDirectoryDataAccessRequest)	Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.
default DescribeDomainControllersResponse	describeDomainControllers(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest)	Provides information about any domain controllers in your directory.
default DescribeDomainControllersResponse	describeDomainControllers(DescribeDomainControllersRequest describeDomainControllersRequest)	Provides information about any domain controllers in your directory.
default DescribeDomainControllersIterable	describeDomainControllersPaginator(Consumer<DescribeDomainControllersRequest.Builder> describeDomainControllersRequest)	This is a variant of describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest) operation.
default DescribeDomainControllersIterable	describeDomainControllersPaginator(DescribeDomainControllersRequest describeDomainControllersRequest)	This is a variant of describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest) operation.
default DescribeEventTopicsResponse	describeEventTopics()	Obtains information about which Amazon SNS topics receive status messages from the specified directory.
default DescribeEventTopicsResponse	describeEventTopics(Consumer<DescribeEventTopicsRequest.Builder> describeEventTopicsRequest)	Obtains information about which Amazon SNS topics receive status messages from the specified directory.
default DescribeEventTopicsResponse	describeEventTopics(DescribeEventTopicsRequest describeEventTopicsRequest)	Obtains information about which Amazon SNS topics receive status messages from the specified directory.
default DescribeHybridAdUpdateResponse	describeHybridADUpdate(Consumer<DescribeHybridAdUpdateRequest.Builder> describeHybridAdUpdateRequest)	Retrieves information about update activities for a hybrid directory.
default DescribeHybridAdUpdateResponse	describeHybridADUpdate(DescribeHybridAdUpdateRequest describeHybridAdUpdateRequest)	Retrieves information about update activities for a hybrid directory.
default DescribeLdapsSettingsResponse	describeLDAPSSettings(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest)	Describes the status of LDAP security for the specified directory.
default DescribeLdapsSettingsResponse	describeLDAPSSettings(DescribeLdapsSettingsRequest describeLdapsSettingsRequest)	Describes the status of LDAP security for the specified directory.
default DescribeLDAPSSettingsIterable	describeLDAPSSettingsPaginator(Consumer<DescribeLdapsSettingsRequest.Builder> describeLdapsSettingsRequest)	This is a variant of describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest) operation.
default DescribeLDAPSSettingsIterable	describeLDAPSSettingsPaginator(DescribeLdapsSettingsRequest describeLdapsSettingsRequest)	This is a variant of describeLDAPSSettings(software.amazon.awssdk.services.directory.model.DescribeLdapsSettingsRequest) operation.
default DescribeRegionsResponse	describeRegions(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest)	Provides information about the Regions that are configured for multi-Region replication.
default DescribeRegionsResponse	describeRegions(DescribeRegionsRequest describeRegionsRequest)	Provides information about the Regions that are configured for multi-Region replication.
default DescribeRegionsIterable	describeRegionsPaginator(Consumer<DescribeRegionsRequest.Builder> describeRegionsRequest)	This is a variant of describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest) operation.
default DescribeRegionsIterable	describeRegionsPaginator(DescribeRegionsRequest describeRegionsRequest)	This is a variant of describeRegions(software.amazon.awssdk.services.directory.model.DescribeRegionsRequest) operation.
default DescribeSettingsResponse	describeSettings(Consumer<DescribeSettingsRequest.Builder> describeSettingsRequest)	Retrieves information about the configurable settings for the specified directory.
default DescribeSettingsResponse	describeSettings(DescribeSettingsRequest describeSettingsRequest)	Retrieves information about the configurable settings for the specified directory.
default DescribeSharedDirectoriesResponse	describeSharedDirectories(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest)	Returns the shared directories in your account.
default DescribeSharedDirectoriesResponse	describeSharedDirectories(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest)	Returns the shared directories in your account.
default DescribeSharedDirectoriesIterable	describeSharedDirectoriesPaginator(Consumer<DescribeSharedDirectoriesRequest.Builder> describeSharedDirectoriesRequest)	This is a variant of describeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest) operation.
default DescribeSharedDirectoriesIterable	describeSharedDirectoriesPaginator(DescribeSharedDirectoriesRequest describeSharedDirectoriesRequest)	This is a variant of describeSharedDirectories(software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest) operation.
default DescribeSnapshotsResponse	describeSnapshots()	Obtains information about the directory snapshots that belong to this account.
default DescribeSnapshotsResponse	describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)	Obtains information about the directory snapshots that belong to this account.
default DescribeSnapshotsResponse	describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)	Obtains information about the directory snapshots that belong to this account.
default DescribeSnapshotsIterable	describeSnapshotsPaginator()	This is a variant of describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest) operation.
default DescribeSnapshotsIterable	describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)	This is a variant of describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest) operation.
default DescribeSnapshotsIterable	describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)	This is a variant of describeSnapshots(software.amazon.awssdk.services.directory.model.DescribeSnapshotsRequest) operation.
default DescribeTrustsResponse	describeTrusts()	Obtains information about the trust relationships for this account.
default DescribeTrustsResponse	describeTrusts(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest)	Obtains information about the trust relationships for this account.
default DescribeTrustsResponse	describeTrusts(DescribeTrustsRequest describeTrustsRequest)	Obtains information about the trust relationships for this account.
default DescribeTrustsIterable	describeTrustsPaginator()	This is a variant of describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest) operation.
default DescribeTrustsIterable	describeTrustsPaginator(Consumer<DescribeTrustsRequest.Builder> describeTrustsRequest)	This is a variant of describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest) operation.
default DescribeTrustsIterable	describeTrustsPaginator(DescribeTrustsRequest describeTrustsRequest)	This is a variant of describeTrusts(software.amazon.awssdk.services.directory.model.DescribeTrustsRequest) operation.
default DescribeUpdateDirectoryResponse	describeUpdateDirectory(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest)	Describes the updates of a directory for a particular update type.
default DescribeUpdateDirectoryResponse	describeUpdateDirectory(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest)	Describes the updates of a directory for a particular update type.
default DescribeUpdateDirectoryIterable	describeUpdateDirectoryPaginator(Consumer<DescribeUpdateDirectoryRequest.Builder> describeUpdateDirectoryRequest)	This is a variant of describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest) operation.
default DescribeUpdateDirectoryIterable	describeUpdateDirectoryPaginator(DescribeUpdateDirectoryRequest describeUpdateDirectoryRequest)	This is a variant of describeUpdateDirectory(software.amazon.awssdk.services.directory.model.DescribeUpdateDirectoryRequest) operation.
default DisableCaEnrollmentPolicyResponse	disableCAEnrollmentPolicy(Consumer<DisableCaEnrollmentPolicyRequest.Builder> disableCaEnrollmentPolicyRequest)	Disables the certificate authority (CA) enrollment policy for the specified directory.
default DisableCaEnrollmentPolicyResponse	disableCAEnrollmentPolicy(DisableCaEnrollmentPolicyRequest disableCaEnrollmentPolicyRequest)	Disables the certificate authority (CA) enrollment policy for the specified directory.
default DisableClientAuthenticationResponse	disableClientAuthentication(Consumer<DisableClientAuthenticationRequest.Builder> disableClientAuthenticationRequest)	Disables alternative client authentication methods for the specified directory.
default DisableClientAuthenticationResponse	disableClientAuthentication(DisableClientAuthenticationRequest disableClientAuthenticationRequest)	Disables alternative client authentication methods for the specified directory.
default DisableDirectoryDataAccessResponse	disableDirectoryDataAccess(Consumer<DisableDirectoryDataAccessRequest.Builder> disableDirectoryDataAccessRequest)	Deactivates access to directory data via the Directory Service Data API for the specified directory.
default DisableDirectoryDataAccessResponse	disableDirectoryDataAccess(DisableDirectoryDataAccessRequest disableDirectoryDataAccessRequest)	Deactivates access to directory data via the Directory Service Data API for the specified directory.
default DisableLdapsResponse	disableLDAPS(Consumer<DisableLdapsRequest.Builder> disableLdapsRequest)	Deactivates LDAP secure calls for the specified directory.
default DisableLdapsResponse	disableLDAPS(DisableLdapsRequest disableLdapsRequest)	Deactivates LDAP secure calls for the specified directory.
default DisableRadiusResponse	disableRadius(Consumer<DisableRadiusRequest.Builder> disableRadiusRequest)	Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
default DisableRadiusResponse	disableRadius(DisableRadiusRequest disableRadiusRequest)	Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
default DisableSsoResponse	disableSso(Consumer<DisableSsoRequest.Builder> disableSsoRequest)	Disables single-sign on for a directory.
default DisableSsoResponse	disableSso(DisableSsoRequest disableSsoRequest)	Disables single-sign on for a directory.
default EnableCaEnrollmentPolicyResponse	enableCAEnrollmentPolicy(Consumer<EnableCaEnrollmentPolicyRequest.Builder> enableCaEnrollmentPolicyRequest)	Enables certificate authority (CA) enrollment policy for the specified directory.
default EnableCaEnrollmentPolicyResponse	enableCAEnrollmentPolicy(EnableCaEnrollmentPolicyRequest enableCaEnrollmentPolicyRequest)	Enables certificate authority (CA) enrollment policy for the specified directory.
default EnableClientAuthenticationResponse	enableClientAuthentication(Consumer<EnableClientAuthenticationRequest.Builder> enableClientAuthenticationRequest)	Enables alternative client authentication methods for the specified directory.
default EnableClientAuthenticationResponse	enableClientAuthentication(EnableClientAuthenticationRequest enableClientAuthenticationRequest)	Enables alternative client authentication methods for the specified directory.
default EnableDirectoryDataAccessResponse	enableDirectoryDataAccess(Consumer<EnableDirectoryDataAccessRequest.Builder> enableDirectoryDataAccessRequest)	Enables access to directory data via the Directory Service Data API for the specified directory.
default EnableDirectoryDataAccessResponse	enableDirectoryDataAccess(EnableDirectoryDataAccessRequest enableDirectoryDataAccessRequest)	Enables access to directory data via the Directory Service Data API for the specified directory.
default EnableLdapsResponse	enableLDAPS(Consumer<EnableLdapsRequest.Builder> enableLdapsRequest)	Activates the switch for the specific directory to always use LDAP secure calls.
default EnableLdapsResponse	enableLDAPS(EnableLdapsRequest enableLdapsRequest)	Activates the switch for the specific directory to always use LDAP secure calls.
default EnableRadiusResponse	enableRadius(Consumer<EnableRadiusRequest.Builder> enableRadiusRequest)	Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
default EnableRadiusResponse	enableRadius(EnableRadiusRequest enableRadiusRequest)	Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
default EnableSsoResponse	enableSso(Consumer<EnableSsoRequest.Builder> enableSsoRequest)	Enables single sign-on for a directory.
default EnableSsoResponse	enableSso(EnableSsoRequest enableSsoRequest)	Enables single sign-on for a directory.
default GetDirectoryLimitsResponse	getDirectoryLimits()	Obtains directory limit information for the current Region.
default GetDirectoryLimitsResponse	getDirectoryLimits(Consumer<GetDirectoryLimitsRequest.Builder> getDirectoryLimitsRequest)	Obtains directory limit information for the current Region.
default GetDirectoryLimitsResponse	getDirectoryLimits(GetDirectoryLimitsRequest getDirectoryLimitsRequest)	Obtains directory limit information for the current Region.
default GetSnapshotLimitsResponse	getSnapshotLimits(Consumer<GetSnapshotLimitsRequest.Builder> getSnapshotLimitsRequest)	Obtains the manual snapshot limits for a directory.
default GetSnapshotLimitsResponse	getSnapshotLimits(GetSnapshotLimitsRequest getSnapshotLimitsRequest)	Obtains the manual snapshot limits for a directory.
default ListAdAssessmentsResponse	listADAssessments(Consumer<ListAdAssessmentsRequest.Builder> listAdAssessmentsRequest)	Retrieves a list of directory assessments for the specified directory or all assessments in your account.
default ListAdAssessmentsResponse	listADAssessments(ListAdAssessmentsRequest listAdAssessmentsRequest)	Retrieves a list of directory assessments for the specified directory or all assessments in your account.
default ListADAssessmentsIterable	listADAssessmentsPaginator(Consumer<ListAdAssessmentsRequest.Builder> listAdAssessmentsRequest)	This is a variant of listADAssessments(software.amazon.awssdk.services.directory.model.ListAdAssessmentsRequest) operation.
default ListADAssessmentsIterable	listADAssessmentsPaginator(ListAdAssessmentsRequest listAdAssessmentsRequest)	This is a variant of listADAssessments(software.amazon.awssdk.services.directory.model.ListAdAssessmentsRequest) operation.
default ListCertificatesResponse	listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)	For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
default ListCertificatesResponse	listCertificates(ListCertificatesRequest listCertificatesRequest)	For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
default ListCertificatesIterable	listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)	This is a variant of listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest) operation.
default ListCertificatesIterable	listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)	This is a variant of listCertificates(software.amazon.awssdk.services.directory.model.ListCertificatesRequest) operation.
default ListIpRoutesResponse	listIpRoutes(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest)	Lists the address blocks that you have added to a directory.
default ListIpRoutesResponse	listIpRoutes(ListIpRoutesRequest listIpRoutesRequest)	Lists the address blocks that you have added to a directory.
default ListIpRoutesIterable	listIpRoutesPaginator(Consumer<ListIpRoutesRequest.Builder> listIpRoutesRequest)	This is a variant of listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest) operation.
default ListIpRoutesIterable	listIpRoutesPaginator(ListIpRoutesRequest listIpRoutesRequest)	This is a variant of listIpRoutes(software.amazon.awssdk.services.directory.model.ListIpRoutesRequest) operation.
default ListLogSubscriptionsResponse	listLogSubscriptions()	Lists the active log subscriptions for the Amazon Web Services account.
default ListLogSubscriptionsResponse	listLogSubscriptions(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest)	Lists the active log subscriptions for the Amazon Web Services account.
default ListLogSubscriptionsResponse	listLogSubscriptions(ListLogSubscriptionsRequest listLogSubscriptionsRequest)	Lists the active log subscriptions for the Amazon Web Services account.
default ListLogSubscriptionsIterable	listLogSubscriptionsPaginator()	This is a variant of listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest) operation.
default ListLogSubscriptionsIterable	listLogSubscriptionsPaginator(Consumer<ListLogSubscriptionsRequest.Builder> listLogSubscriptionsRequest)	This is a variant of listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest) operation.
default ListLogSubscriptionsIterable	listLogSubscriptionsPaginator(ListLogSubscriptionsRequest listLogSubscriptionsRequest)	This is a variant of listLogSubscriptions(software.amazon.awssdk.services.directory.model.ListLogSubscriptionsRequest) operation.
default ListSchemaExtensionsResponse	listSchemaExtensions(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest)	Lists all schema extensions applied to a Microsoft AD Directory.
default ListSchemaExtensionsResponse	listSchemaExtensions(ListSchemaExtensionsRequest listSchemaExtensionsRequest)	Lists all schema extensions applied to a Microsoft AD Directory.
default ListSchemaExtensionsIterable	listSchemaExtensionsPaginator(Consumer<ListSchemaExtensionsRequest.Builder> listSchemaExtensionsRequest)	This is a variant of listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest) operation.
default ListSchemaExtensionsIterable	listSchemaExtensionsPaginator(ListSchemaExtensionsRequest listSchemaExtensionsRequest)	This is a variant of listSchemaExtensions(software.amazon.awssdk.services.directory.model.ListSchemaExtensionsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all tags on a directory.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags on a directory.
default ListTagsForResourceIterable	listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	This is a variant of listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest) operation.
default ListTagsForResourceIterable	listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)	This is a variant of listTagsForResource(software.amazon.awssdk.services.directory.model.ListTagsForResourceRequest) operation.
default RegisterCertificateResponse	registerCertificate(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest)	Registers a certificate for a secure LDAP or client certificate authentication.
default RegisterCertificateResponse	registerCertificate(RegisterCertificateRequest registerCertificateRequest)	Registers a certificate for a secure LDAP or client certificate authentication.
default RegisterEventTopicResponse	registerEventTopic(Consumer<RegisterEventTopicRequest.Builder> registerEventTopicRequest)	Associates a directory with an Amazon SNS topic.
default RegisterEventTopicResponse	registerEventTopic(RegisterEventTopicRequest registerEventTopicRequest)	Associates a directory with an Amazon SNS topic.
default RejectSharedDirectoryResponse	rejectSharedDirectory(Consumer<RejectSharedDirectoryRequest.Builder> rejectSharedDirectoryRequest)	Rejects a directory sharing request that was sent from the directory owner account.
default RejectSharedDirectoryResponse	rejectSharedDirectory(RejectSharedDirectoryRequest rejectSharedDirectoryRequest)	Rejects a directory sharing request that was sent from the directory owner account.
default RemoveIpRoutesResponse	removeIpRoutes(Consumer<RemoveIpRoutesRequest.Builder> removeIpRoutesRequest)	Removes IP address blocks from a directory.
default RemoveIpRoutesResponse	removeIpRoutes(RemoveIpRoutesRequest removeIpRoutesRequest)	Removes IP address blocks from a directory.
default RemoveRegionResponse	removeRegion(Consumer<RemoveRegionRequest.Builder> removeRegionRequest)	Stops all replication and removes the domain controllers from the specified Region.
default RemoveRegionResponse	removeRegion(RemoveRegionRequest removeRegionRequest)	Stops all replication and removes the domain controllers from the specified Region.
default RemoveTagsFromResourceResponse	removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)	Removes tags from a directory.
default RemoveTagsFromResourceResponse	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)	Removes tags from a directory.
default ResetUserPasswordResponse	resetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest)	Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
default ResetUserPasswordResponse	resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest)	Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
default RestoreFromSnapshotResponse	restoreFromSnapshot(Consumer<RestoreFromSnapshotRequest.Builder> restoreFromSnapshotRequest)	Restores a directory using an existing directory snapshot.
default RestoreFromSnapshotResponse	restoreFromSnapshot(RestoreFromSnapshotRequest restoreFromSnapshotRequest)	Restores a directory using an existing directory snapshot.
default DirectoryServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default ShareDirectoryResponse	shareDirectory(Consumer<ShareDirectoryRequest.Builder> shareDirectoryRequest)	Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer).
default ShareDirectoryResponse	shareDirectory(ShareDirectoryRequest shareDirectoryRequest)	Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer).
default StartAdAssessmentResponse	startADAssessment(Consumer<StartAdAssessmentRequest.Builder> startAdAssessmentRequest)	Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join.
default StartAdAssessmentResponse	startADAssessment(StartAdAssessmentRequest startAdAssessmentRequest)	Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join.
default StartSchemaExtensionResponse	startSchemaExtension(Consumer<StartSchemaExtensionRequest.Builder> startSchemaExtensionRequest)	Applies a schema extension to a Microsoft AD directory.
default StartSchemaExtensionResponse	startSchemaExtension(StartSchemaExtensionRequest startSchemaExtensionRequest)	Applies a schema extension to a Microsoft AD directory.
default UnshareDirectoryResponse	unshareDirectory(Consumer<UnshareDirectoryRequest.Builder> unshareDirectoryRequest)	Stops the directory sharing between the directory owner and consumer accounts.
default UnshareDirectoryResponse	unshareDirectory(UnshareDirectoryRequest unshareDirectoryRequest)	Stops the directory sharing between the directory owner and consumer accounts.
default UpdateConditionalForwarderResponse	updateConditionalForwarder(Consumer<UpdateConditionalForwarderRequest.Builder> updateConditionalForwarderRequest)	Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
default UpdateConditionalForwarderResponse	updateConditionalForwarder(UpdateConditionalForwarderRequest updateConditionalForwarderRequest)	Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
default UpdateDirectorySetupResponse	updateDirectorySetup(Consumer<UpdateDirectorySetupRequest.Builder> updateDirectorySetupRequest)	Updates directory configuration for the specified update type.
default UpdateDirectorySetupResponse	updateDirectorySetup(UpdateDirectorySetupRequest updateDirectorySetupRequest)	Updates directory configuration for the specified update type.
default UpdateHybridAdResponse	updateHybridAD(Consumer<UpdateHybridAdRequest.Builder> updateHybridAdRequest)	Updates the configuration of an existing hybrid directory.
default UpdateHybridAdResponse	updateHybridAD(UpdateHybridAdRequest updateHybridAdRequest)	Updates the configuration of an existing hybrid directory.
default UpdateNumberOfDomainControllersResponse	updateNumberOfDomainControllers(Consumer<UpdateNumberOfDomainControllersRequest.Builder> updateNumberOfDomainControllersRequest)	Adds or removes domain controllers to or from the directory.
default UpdateNumberOfDomainControllersResponse	updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest updateNumberOfDomainControllersRequest)	Adds or removes domain controllers to or from the directory.
default UpdateRadiusResponse	updateRadius(Consumer<UpdateRadiusRequest.Builder> updateRadiusRequest)	Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
default UpdateRadiusResponse	updateRadius(UpdateRadiusRequest updateRadiusRequest)	Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
default UpdateSettingsResponse	updateSettings(Consumer<UpdateSettingsRequest.Builder> updateSettingsRequest)	Updates the configurable settings for the specified directory.
default UpdateSettingsResponse	updateSettings(UpdateSettingsRequest updateSettingsRequest)	Updates the configurable settings for the specified directory.
default UpdateTrustResponse	updateTrust(Consumer<UpdateTrustRequest.Builder> updateTrustRequest)	Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
default UpdateTrustResponse	updateTrust(UpdateTrustRequest updateTrustRequest)	Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
default VerifyTrustResponse	verifyTrust(Consumer<VerifyTrustRequest.Builder> verifyTrustRequest)	Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
default VerifyTrustResponse	verifyTrust(VerifyTrustRequest verifyTrustRequest)	Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
default DirectoryWaiter	waiter()	Create an instance of DirectoryWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

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 the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

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.

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.Builder avoiding the need to create one manually via AcceptSharedDirectoryRequest.builder()

Parameters:

acceptSharedDirectoryRequest - A Consumer that will call methods on AcceptSharedDirectoryRequest.Builder to create a request.

Returns:

Result of the AcceptSharedDirectory operation returned by the service.

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.

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.Builder avoiding the need to create one manually via AddIpRoutesRequest.builder()

Parameters:

addIpRoutesRequest - A Consumer that will call methods on AddIpRoutesRequest.Builder to create a request.

Returns:

Result of the AddIpRoutes operation returned by the service.

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.

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.Builder avoiding the need to create one manually via AddRegionRequest.builder()

Parameters:

addRegionRequest - A Consumer that will call methods on AddRegionRequest.Builder to create a request.

Returns:

Result of the AddRegion operation returned by the service.

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.

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.Builder avoiding the need to create one manually via AddTagsToResourceRequest.builder()

Parameters:

addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceRequest.Builder to create a request.

Returns:

Result of the AddTagsToResource operation returned by the service.

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, and UpdatingSchema.

Parameters:

cancelSchemaExtensionRequest -

Returns:

Result of the CancelSchemaExtension operation returned by the service.

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, and UpdatingSchema.

This is a convenience which creates an instance of the CancelSchemaExtensionRequest.Builder avoiding the need to create one manually via CancelSchemaExtensionRequest.builder()

Parameters:

cancelSchemaExtensionRequest - A Consumer that will call methods on CancelSchemaExtensionRequest.Builder to create a request.

Returns:

Result of the CancelSchemaExtension operation returned by the service.

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 the ConnectDirectory operation, 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.

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 the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

This is a convenience which creates an instance of the ConnectDirectoryRequest.Builder avoiding the need to create one manually via ConnectDirectoryRequest.builder()

Parameters:

connectDirectoryRequest - A Consumer that will call methods on ConnectDirectoryRequest.Builder to create a request. Contains the inputs for the ConnectDirectory operation.

Returns:

Result of the ConnectDirectory operation returned by the service.

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.

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.Builder avoiding the need to create one manually via CreateAliasRequest.builder()

Parameters:

createAliasRequest - A Consumer that will call methods on CreateAliasRequest.Builder to create a request. Contains the inputs for the CreateAlias operation.

Returns:

Result of the CreateAlias operation returned by the service.

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.

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.Builder avoiding the need to create one manually via CreateComputerRequest.builder()

Parameters:

createComputerRequest - A Consumer that will call methods on CreateComputerRequest.Builder to create a request. Contains the inputs for the CreateComputer operation.

Returns:

Result of the CreateComputer operation returned by the service.

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.

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.Builder avoiding the need to create one manually via CreateConditionalForwarderRequest.builder()

Parameters:

createConditionalForwarderRequest - A Consumer that will call methods on CreateConditionalForwarderRequest.Builder to create a request. Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.

Returns:

Result of the CreateConditionalForwarder operation returned by the service.

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 the CreateDirectory operation, 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.

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 the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

This is a convenience which creates an instance of the CreateDirectoryRequest.Builder avoiding the need to create one manually via CreateDirectoryRequest.builder()

Parameters:

createDirectoryRequest - A Consumer that will call methods on CreateDirectoryRequest.Builder to create a request. Contains the inputs for the CreateDirectory operation.

Returns:

Result of the CreateDirectory operation returned by the service.

See Also:

• AWS API Documentation

createHybridAD

default CreateHybridAdResponse createHybridAD(CreateHybridAdRequest createHybridAdRequest)
                                       throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
DirectoryLimitExceededException,
AdAssessmentLimitExceededException,
EntityDoesNotExistException,
AwsServiceException,
SdkClientException,
DirectoryException

Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services.

You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you use this operation.

Updates are applied asynchronously. Use DescribeDirectories to monitor the progress of directory creation.

Parameters:

createHybridAdRequest -

Returns:

Result of the CreateHybridAD operation returned by the service.

See Also:

• AWS API Documentation

createHybridAD

default CreateHybridAdResponse createHybridAD(Consumer<CreateHybridAdRequest.Builder> createHybridAdRequest)
                                       throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
DirectoryLimitExceededException,
AdAssessmentLimitExceededException,
EntityDoesNotExistException,
AwsServiceException,
SdkClientException,
DirectoryException

Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services.

You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you use this operation.

Updates are applied asynchronously. Use DescribeDirectories to monitor the progress of directory creation.

This is a convenience which creates an instance of the CreateHybridAdRequest.Builder avoiding the need to create one manually via CreateHybridAdRequest.builder()

Parameters:

createHybridAdRequest - A Consumer that will call methods on CreateHybridAdRequest.Builder to create a request.

Returns:

Result of the CreateHybridAD operation returned by the service.

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.

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.Builder avoiding the need to create one manually via CreateLogSubscriptionRequest.builder()

Parameters:

createLogSubscriptionRequest - A Consumer that will call methods on CreateLogSubscriptionRequest.Builder to create a request.

Returns:

Result of the CreateLogSubscription operation returned by the service.

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.

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.Builder avoiding the need to create one manually via CreateMicrosoftAdRequest.builder()

Parameters:

createMicrosoftAdRequest - A Consumer that will call methods on CreateMicrosoftAdRequest.Builder to create a request. Creates an Managed Microsoft AD directory.

Returns:

Result of the CreateMicrosoftAD operation returned by the service.

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.

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.Builder avoiding the need to create one manually via CreateSnapshotRequest.builder()

Parameters:

createSnapshotRequest - A Consumer that will call methods on CreateSnapshotRequest.Builder to create a request. Contains the inputs for the CreateSnapshot operation.

Returns:

Result of the CreateSnapshot operation returned by the service.

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.

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.Builder avoiding the need to create one manually via CreateTrustRequest.builder()

Parameters:

createTrustRequest - A Consumer that will call methods on CreateTrustRequest.Builder to create a request. Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.

Returns:

Result of the CreateTrust operation returned by the service.

See Also:

• AWS API Documentation

deleteADAssessment

default DeleteAdAssessmentResponse deleteADAssessment(DeleteAdAssessmentRequest deleteAdAssessmentRequest)
                                               throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
EntityDoesNotExistException,
AwsServiceException,
SdkClientException,
DirectoryException

Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information.

You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.

Parameters:

deleteAdAssessmentRequest -

Returns:

Result of the DeleteADAssessment operation returned by the service.

See Also:

• AWS API Documentation

deleteADAssessment

default DeleteAdAssessmentResponse deleteADAssessment(Consumer<DeleteAdAssessmentRequest.Builder> deleteAdAssessmentRequest)
                                               throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
EntityDoesNotExistException,
AwsServiceException,
SdkClientException,
DirectoryException

Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information.

You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.

This is a convenience which creates an instance of the DeleteAdAssessmentRequest.Builder avoiding the need to create one manually via DeleteAdAssessmentRequest.builder()

Parameters:

deleteAdAssessmentRequest - A Consumer that will call methods on DeleteAdAssessmentRequest.Builder to create a request.

Returns:

Result of the DeleteADAssessment operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DeleteConditionalForwarderRequest.builder()

Parameters:

deleteConditionalForwarderRequest - A Consumer that will call methods on DeleteConditionalForwarderRequest.Builder to create a request. Deletes a conditional forwarder.

Returns:

Result of the DeleteConditionalForwarder operation returned by the service.

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 the DeleteDirectory operation, 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.

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 the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

This is a convenience which creates an instance of the DeleteDirectoryRequest.Builder avoiding the need to create one manually via DeleteDirectoryRequest.builder()

Parameters:

deleteDirectoryRequest - A Consumer that will call methods on DeleteDirectoryRequest.Builder to create a request. Contains the inputs for the DeleteDirectory operation.

Returns:

Result of the DeleteDirectory operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DeleteLogSubscriptionRequest.builder()

Parameters:

deleteLogSubscriptionRequest - A Consumer that will call methods on DeleteLogSubscriptionRequest.Builder to create a request.

Returns:

Result of the DeleteLogSubscription operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DeleteSnapshotRequest.builder()

Parameters:

deleteSnapshotRequest - A Consumer that will call methods on DeleteSnapshotRequest.Builder to create a request. Contains the inputs for the DeleteSnapshot operation.

Returns:

Result of the DeleteSnapshot operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DeleteTrustRequest.builder()

Parameters:

deleteTrustRequest - A Consumer that will call methods on DeleteTrustRequest.Builder to create a request. Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain.

Returns:

Result of the DeleteTrust operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DeregisterCertificateRequest.builder()

Parameters:

deregisterCertificateRequest - A Consumer that will call methods on DeregisterCertificateRequest.Builder to create a request.

Returns:

Result of the DeregisterCertificate operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DeregisterEventTopicRequest.builder()

Parameters:

deregisterEventTopicRequest - A Consumer that will call methods on DeregisterEventTopicRequest.Builder to create a request. Removes the specified directory as a publisher to the specified Amazon SNS topic.

Returns:

Result of the DeregisterEventTopic operation returned by the service.

See Also:

• AWS API Documentation

describeADAssessment

default DescribeAdAssessmentResponse describeADAssessment(DescribeAdAssessmentRequest describeAdAssessmentRequest)
                                                   throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
EntityDoesNotExistException,
AwsServiceException,
SdkClientException,
DirectoryException

Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results.

Parameters:

describeAdAssessmentRequest -

Returns:

Result of the DescribeADAssessment operation returned by the service.

See Also:

• AWS API Documentation

describeADAssessment

default DescribeAdAssessmentResponse describeADAssessment(Consumer<DescribeAdAssessmentRequest.Builder> describeAdAssessmentRequest)
                                                   throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
EntityDoesNotExistException,
AwsServiceException,
SdkClientException,
DirectoryException

Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results.

This is a convenience which creates an instance of the DescribeAdAssessmentRequest.Builder avoiding the need to create one manually via DescribeAdAssessmentRequest.builder()

Parameters:

describeAdAssessmentRequest - A Consumer that will call methods on DescribeAdAssessmentRequest.Builder to create a request.

Returns:

Result of the DescribeADAssessment operation returned by the service.

See Also:

• AWS API Documentation

describeCAEnrollmentPolicy

default DescribeCaEnrollmentPolicyResponse describeCAEnrollmentPolicy(DescribeCaEnrollmentPolicyRequest describeCaEnrollmentPolicyRequest)
                                                               throws DirectoryDoesNotExistException,
UnsupportedOperationException,
ClientException,
ServiceException,
AwsServiceException,
SdkClientException,
DirectoryException

Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through Amazon Web Services Private Certificate Authority.

Parameters:

describeCaEnrollmentPolicyRequest - Contains the inputs for the DescribeCAEnrollmentPolicy operation.

Returns:

Result of the DescribeCAEnrollmentPolicy operation returned by the service.

See Also:

• AWS API Documentation

describeCAEnrollmentPolicy

default DescribeCaEnrollmentPolicyResponse describeCAEnrollmentPolicy(Consumer<DescribeCaEnrollmentPolicyRequest.Builder> describeCaEnrollmentPolicyRequest)
                                                               throws DirectoryDoesNotExistException,
UnsupportedOperationException,
ClientException,
ServiceException,
AwsServiceException,
SdkClientException,
DirectoryException

Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through Amazon Web Services Private Certificate Authority.

This is a convenience which creates an instance of the DescribeCaEnrollmentPolicyRequest.Builder avoiding the need to create one manually via DescribeCaEnrollmentPolicyRequest.builder()

Parameters:

describeCaEnrollmentPolicyRequest - A Consumer that will call methods on DescribeCaEnrollmentPolicyRequest.Builder to create a request. Contains the inputs for the DescribeCAEnrollmentPolicy operation.

Returns:

Result of the DescribeCAEnrollmentPolicy operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DescribeCertificateRequest.builder()

Parameters:

describeCertificateRequest - A Consumer that will call methods on DescribeCertificateRequest.Builder to create a request.

Returns:

Result of the DescribeCertificate operation returned by the service.

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 SmartCard is supported.

Parameters:

describeClientAuthenticationSettingsRequest -

Returns:

Result of the DescribeClientAuthenticationSettings operation returned by the service.

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 SmartCard is supported.

This is a convenience which creates an instance of the DescribeClientAuthenticationSettingsRequest.Builder avoiding the need to create one manually via DescribeClientAuthenticationSettingsRequest.builder()

Parameters:

describeClientAuthenticationSettingsRequest - A Consumer that will call methods on DescribeClientAuthenticationSettingsRequest.Builder to create a request.

Returns:

Result of the DescribeClientAuthenticationSettings operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsIterable responses = client.describeClientAuthenticationSettingsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeClientAuthenticationSettingsIterable responses = client.describeClientAuthenticationSettingsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via DescribeClientAuthenticationSettingsRequest.builder()

Parameters:

describeClientAuthenticationSettingsRequest - A Consumer that will call methods on DescribeClientAuthenticationSettingsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via DescribeConditionalForwardersRequest.builder()

Parameters:

describeConditionalForwardersRequest - A Consumer that will call methods on DescribeConditionalForwardersRequest.Builder to create a request. Describes a conditional forwarder.

Returns:

Result of the DescribeConditionalForwarders operation returned by the service.

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 DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Parameters:

describeDirectoriesRequest - Contains the inputs for the DescribeDirectories operation.

Returns:

Result of the DescribeDirectories operation returned by the service.

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 DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

This is a convenience which creates an instance of the DescribeDirectoriesRequest.Builder avoiding the need to create one manually via DescribeDirectoriesRequest.builder()

Parameters:

describeDirectoriesRequest - A Consumer that will call methods on DescribeDirectoriesRequest.Builder to create a request. Contains the inputs for the DescribeDirectories operation.

Returns:

Result of the DescribeDirectories operation returned by the service.

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 DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

Returns:

Result of the DescribeDirectories operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client.describeDirectoriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client.describeDirectoriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeDirectoriesIterable responses = client.describeDirectoriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via DescribeDirectoriesRequest.builder()

Parameters:

describeDirectoriesRequest - A Consumer that will call methods on DescribeDirectoriesRequest.Builder to 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.

See Also:

• AWS API Documentation

describeDirectoryDataAccess

default DescribeDirectoryDataAccessResponse describeDirectoryDataAccess(DescribeDirectoryDataAccessRequest describeDirectoryDataAccessRequest)
                                                                 throws DirectoryDoesNotExistException,
UnsupportedOperationException,
AccessDeniedException,
ClientException,
ServiceException,
AwsServiceException,
SdkClientException,
DirectoryException

Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.

Parameters:

describeDirectoryDataAccessRequest -

Returns:

Result of the DescribeDirectoryDataAccess operation returned by the service.

See Also:

• AWS API Documentation

describeDirectoryDataAccess

default DescribeDirectoryDataAccessResponse describeDirectoryDataAccess(Consumer<DescribeDirectoryDataAccessRequest.Builder> describeDirectoryDataAccessRequest)
                                                                 throws DirectoryDoesNotExistException,
UnsupportedOperationException,
AccessDeniedException,
ClientException,
ServiceException,
AwsServiceException,
SdkClientException,
DirectoryException

Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.

This is a convenience which creates an instance of the DescribeDirectoryDataAccessRequest.Builder avoiding the need to create one manually via DescribeDirectoryDataAccessRequest.builder()

Parameters:

describeDirectoryDataAccessRequest - A Consumer that will call methods on DescribeDirectoryDataAccessRequest.Builder to create a request.

Returns:

Result of the DescribeDirectoryDataAccess operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DescribeDomainControllersRequest.builder()

Parameters:

describeDomainControllersRequest - A Consumer that will call methods on DescribeDomainControllersRequest.Builder to create a request.

Returns:

Result of the DescribeDomainControllers operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client
             .describeDomainControllersPaginator(request);
     for (software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest) operation.

Parameters:

describeDomainControllersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client
             .describeDomainControllersPaginator(request);
     for (software.amazon.awssdk.services.directory.model.DescribeDomainControllersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.directory.paginators.DescribeDomainControllersIterable responses = client.describeDomainControllersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeDomainControllers(software.amazon.awssdk.services.directory.model.DescribeDomainControllersRequest) operation.

This is a convenience which creates an instance of the DescribeDomainControllersRequest.Builder avoiding the need to create one manually via DescribeDomainControllersRequest.builder()

Parameters:

describeDomainControllersRequest - A Consumer that will call methods on DescribeDomainControllersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via DescribeEventTopicsRequest.builder()

Parameters:

describeEventTopicsRequest - A Consumer that will call methods on DescribeEventTopicsRequest.Builder to create a request. Describes event topics.

Returns:

Result of the DescribeEventTopics operation returned by the service.

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.

See Also:

• describeEventTopics(DescribeEventTopicsRequest)
• AWS API Documentation

describeHybridADUpdate

default DescribeHybridAdUpdateResponse describeHybridADUpdate(DescribeHybridAdUpdateRequest describeHybridAdUpdateRequest)
                                                       throws ClientException,
ServiceException,
UnsupportedOperationException,
DirectoryDoesNotExistException,
InvalidParameterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
DirectoryException

Retrieves information about update activities for a hybrid directory. This operation provides details about configuration changes, administrator account updates, and self-managed instance settings (IDs and DNS IPs).

Parameters:

describeHybridAdUpdateRequest -

Returns:

Result of the DescribeHybridADUpdate operation returned by the service.

See Also:

• AWS API Documentation

describeHybridADUpdate

default DescribeHybridAdUpdateResponse describeHybridADUpdate(Consumer<DescribeHybridAdUpdateRequest.Builder> describeHybridAdUpdateRequest)
                                                       throws ClientException,
ServiceException,
UnsupportedOperationException,
DirectoryDoesNotExistException,
InvalidParameterException,
InvalidNextTokenException,
AwsServiceException,
SdkClientException,
DirectoryException

Retrieves information about update activities for a hybrid directory. This operation provides details about configuration changes, administrator account updates, and self-managed instance settings (IDs and DNS IPs).

This is a convenience which creates an instance of the DescribeHybridAdUpdateRequest.Builder avoiding the need to create one manually via DescribeHybridAdUpdateRequest.builder()

Parameters:

describeHybridAdUpdateRequest - A Consumer that will call methods on DescribeHybridAdUpdateRequest.Builder to create a request.

Returns:

Result of the DescribeHybridADUpdate operation returned by the service.

See Also:

• 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.

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.Builder avoiding the need to create one manually via DescribeLdapsSettingsRequest.builder()

Parameters:

describeLdapsSettingsRequest - A Consumer that will call methods on DescribeLdapsSettingsRequest.Builder to create a request.

Returns:

Result of the DescribeLDAPSSettings operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsIterable responses = client.describeLDAPSSettingsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeLDAPSSettingsIterable responses = client.describeLDAPSSettingsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via DescribeLdapsSettingsRequest.builder()

Parameters:

describeLdapsSettingsRequest - A Consumer that will call methods on DescribeLdapsSettingsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via DescribeRegionsRequest.builder()

Parameters:

describeRegionsRequest - A Consumer that will call methods on DescribeRegionsRequest.Builder to create a request.

Returns:

Result of the DescribeRegions operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeRegionsIterable responses = client.describeRegionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeRegionsIterable responses = client.describeRegionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via DescribeRegionsRequest.builder()

Parameters:

describeRegionsRequest - A Consumer that will call methods on DescribeRegionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via DescribeSettingsRequest.builder()

Parameters:

describeSettingsRequest - A Consumer that will call methods on DescribeSettingsRequest.Builder to create a request.

Returns:

Result of the DescribeSettings operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DescribeSharedDirectoriesRequest.builder()

Parameters:

describeSharedDirectoriesRequest - A Consumer that will call methods on DescribeSharedDirectoriesRequest.Builder to create a request.

Returns:

Result of the DescribeSharedDirectories operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesIterable responses = client.describeSharedDirectoriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeSharedDirectoriesIterable responses = client.describeSharedDirectoriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via DescribeSharedDirectoriesRequest.builder()

Parameters:

describeSharedDirectoriesRequest - A Consumer that will call methods on DescribeSharedDirectoriesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via DescribeSnapshotsRequest.builder()

Parameters:

describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsRequest.Builder to create a request. Contains the inputs for the DescribeSnapshots operation.

Returns:

Result of the DescribeSnapshots operation returned by the service.

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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via DescribeSnapshotsRequest.builder()

Parameters:

describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsRequest.Builder to 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.

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.

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.Builder avoiding the need to create one manually via DescribeTrustsRequest.builder()

Parameters:

describeTrustsRequest - A Consumer that will call methods on DescribeTrustsRequest.Builder to create a request. Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters are provided, such as directory ID or trust ID, this request describes all the trust relationships.

Returns:

Result of the DescribeTrusts operation returned by the service.

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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client.describeTrustsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client.describeTrustsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeTrustsIterable responses = client.describeTrustsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via DescribeTrustsRequest.builder()

Parameters:

describeTrustsRequest - A Consumer that will call methods on DescribeTrustsRequest.Builder to create a request. Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters are provided, such as directory ID or trust ID, this request describes all the trust relationships.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via DescribeUpdateDirectoryRequest.builder()

Parameters:

describeUpdateDirectoryRequest - A Consumer that will call methods on DescribeUpdateDirectoryRequest.Builder to create a request.

Returns:

Result of the DescribeUpdateDirectory operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryIterable responses = client.describeUpdateDirectoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.DescribeUpdateDirectoryIterable responses = client.describeUpdateDirectoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via DescribeUpdateDirectoryRequest.builder()

Parameters:

describeUpdateDirectoryRequest - A Consumer that will call methods on DescribeUpdateDirectoryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

disableCAEnrollmentPolicy

default DisableCaEnrollmentPolicyResponse disableCAEnrollmentPolicy(DisableCaEnrollmentPolicyRequest disableCaEnrollmentPolicyRequest)
                                                             throws DirectoryDoesNotExistException,
DirectoryUnavailableException,
InvalidParameterException,
DisableAlreadyInProgressException,
EntityDoesNotExistException,
AccessDeniedException,
ClientException,
ServiceException,
AwsServiceException,
SdkClientException,
DirectoryException

Disables the certificate authority (CA) enrollment policy for the specified directory. This stops automatic certificate enrollment and management for domain-joined clients, but does not affect existing certificates.

Disabling the CA enrollment policy prevents new certificates from being automatically enrolled, but existing certificates remain valid and functional until they expire.

Parameters:

disableCaEnrollmentPolicyRequest - Contains the inputs for the DisableCAEnrollmentPolicy operation.

Returns:

Result of the DisableCAEnrollmentPolicy operation returned by the service.

See Also:

• AWS API Documentation

disableCAEnrollmentPolicy

default DisableCaEnrollmentPolicyResponse disableCAEnrollmentPolicy(Consumer<DisableCaEnrollmentPolicyRequest.Builder> disableCaEnrollmentPolicyRequest)
                                                             throws DirectoryDoesNotExistException,
DirectoryUnavailableException,
InvalidParameterException,
DisableAlreadyInProgressException,
EntityDoesNotExistException,
AccessDeniedException,
ClientException,
ServiceException,
AwsServiceException,
SdkClientException,
DirectoryException

Disables the certificate authority (CA) enrollment policy for the specified directory. This stops automatic certificate enrollment and management for domain-joined clients, but does not affect existing certificates.

Disabling the CA enrollment policy prevents new certificates from being automatically enrolled, but existing certificates remain valid and functional until they expire.

This is a convenience which creates an instance of the DisableCaEnrollmentPolicyRequest.Builder avoiding the need to create one manually via DisableCaEnrollmentPolicyRequest.builder()

Parameters:

disableCaEnrollmentPolicyRequest - A Consumer that will call methods on DisableCaEnrollmentPolicyRequest.Builder to create a request. Contains the inputs for the DisableCAEnrollmentPolicy operation.

Returns:

Result of the DisableCAEnrollmentPolicy operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DisableClientAuthenticationRequest.builder()

Parameters:

disableClientAuthenticationRequest - A Consumer that will call methods on DisableClientAuthenticationRequest.Builder to create a request.

Returns:

Result of the DisableClientAuthentication operation returned by the service.

See Also:

• AWS API Documentation

disableDirectoryDataAccess

default DisableDirectoryDataAccessResponse disableDirectoryDataAccess(DisableDirectoryDataAccessRequest disableDirectoryDataAccessRequest)
                                                               throws DirectoryDoesNotExistException,
DirectoryUnavailableException,
UnsupportedOperationException,
DirectoryInDesiredStateException,
AccessDeniedException,
ClientException,
ServiceException,
AwsServiceException,
SdkClientException,
DirectoryException

Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.

Parameters:

disableDirectoryDataAccessRequest -

Returns:

Result of the DisableDirectoryDataAccess operation returned by the service.

See Also:

• AWS API Documentation

disableDirectoryDataAccess

default DisableDirectoryDataAccessResponse disableDirectoryDataAccess(Consumer<DisableDirectoryDataAccessRequest.Builder> disableDirectoryDataAccessRequest)
                                                               throws DirectoryDoesNotExistException,
DirectoryUnavailableException,
UnsupportedOperationException,
DirectoryInDesiredStateException,
AccessDeniedException,
ClientException,
ServiceException,
AwsServiceException,
SdkClientException,
DirectoryException

Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.

This is a convenience which creates an instance of the DisableDirectoryDataAccessRequest.Builder avoiding the need to create one manually via DisableDirectoryDataAccessRequest.builder()

Parameters:

disableDirectoryDataAccessRequest - A Consumer that will call methods on DisableDirectoryDataAccessRequest.Builder to create a request.

Returns:

Result of the DisableDirectoryDataAccess operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DisableLdapsRequest.builder()

Parameters:

disableLdapsRequest - A Consumer that will call methods on DisableLdapsRequest.Builder to create a request.

Returns:

Result of the DisableLDAPS operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DisableRadiusRequest.builder()

Parameters:

disableRadiusRequest - A Consumer that will call methods on DisableRadiusRequest.Builder to create a request. Contains the inputs for the DisableRadius operation.

Returns:

Result of the DisableRadius operation returned by the service.

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.

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.Builder avoiding the need to create one manually via DisableSsoRequest.builder()

Parameters:

disableSsoRequest - A Consumer that will call methods on DisableSsoRequest.Builder to create a request. Contains the inputs for the DisableSso operation.

Returns:

Result of the DisableSso operation returned by the service.

See Also:

• AWS API Documentation

enableCAEnrollmentPolicy

default EnableCaEnrollmentPolicyResponse enableCAEnrollmentPolicy(EnableCaEnrollmentPolicyRequest enableCaEnrollmentPolicyRequest)
                                                           throws DirectoryDoesNotExistException,
DirectoryUnavailableException,
InvalidParameterException,
EntityAlreadyExistsException,
EntityDoesNotExistException,
EnableAlreadyInProgressException,
ClientException,
ServiceException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DirectoryException

Enables certificate authority (CA) enrollment policy for the specified directory. This allows domain-joined clients to automatically request and receive certificates from the specified Amazon Web Services Private Certificate Authority.

Before enabling CA enrollment, ensure that the PCA connector is properly configured and accessible from the directory. The connector must be in an active state and have the necessary permissions.

Parameters:

enableCaEnrollmentPolicyRequest - Contains the inputs for the EnableCAEnrollmentPolicy operation.

Returns:

Result of the EnableCAEnrollmentPolicy operation returned by the service.

See Also:

• AWS API Documentation

enableCAEnrollmentPolicy

default EnableCaEnrollmentPolicyResponse enableCAEnrollmentPolicy(Consumer<EnableCaEnrollmentPolicyRequest.Builder> enableCaEnrollmentPolicyRequest)
                                                           throws DirectoryDoesNotExistException,
DirectoryUnavailableException,
InvalidParameterException,
EntityAlreadyExistsException,
EntityDoesNotExistException,
EnableAlreadyInProgressException,
ClientException,
ServiceException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DirectoryException

Enables certificate authority (CA) enrollment policy for the specified directory. This allows domain-joined clients to automatically request and receive certificates from the specified Amazon Web Services Private Certificate Authority.

Before enabling CA enrollment, ensure that the PCA connector is properly configured and accessible from the directory. The connector must be in an active state and have the necessary permissions.

This is a convenience which creates an instance of the EnableCaEnrollmentPolicyRequest.Builder avoiding the need to create one manually via EnableCaEnrollmentPolicyRequest.builder()

Parameters:

enableCaEnrollmentPolicyRequest - A Consumer that will call methods on EnableCaEnrollmentPolicyRequest.Builder to create a request. Contains the inputs for the EnableCAEnrollmentPolicy operation.

Returns:

Result of the EnableCAEnrollmentPolicy operation returned by the service.

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.

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.Builder avoiding the need to create one manually via EnableClientAuthenticationRequest.builder()

Parameters:

enableClientAuthenticationRequest - A Consumer that will call methods on EnableClientAuthenticationRequest.Builder to create a request.

Returns:

Result of the EnableClientAuthentication operation returned by the service.

See Also:

• AWS API Documentation

enableDirectoryDataAccess

default EnableDirectoryDataAccessResponse enableDirectoryDataAccess(EnableDirectoryDataAccessRequest enableDirectoryDataAccessRequest)
                                                             throws DirectoryDoesNotExistException,
DirectoryUnavailableException,
UnsupportedOperationException,
DirectoryInDesiredStateException,
AccessDeniedException,
ClientException,
ServiceException,
AwsServiceException,
SdkClientException,
DirectoryException

Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.

Parameters:

enableDirectoryDataAccessRequest -

Returns:

Result of the EnableDirectoryDataAccess operation returned by the service.

See Also:

• AWS API Documentation

enableDirectoryDataAccess

default EnableDirectoryDataAccessResponse enableDirectoryDataAccess(Consumer<EnableDirectoryDataAccessRequest.Builder> enableDirectoryDataAccessRequest)
                                                             throws DirectoryDoesNotExistException,
DirectoryUnavailableException,
UnsupportedOperationException,
DirectoryInDesiredStateException,
AccessDeniedException,
ClientException,
ServiceException,
AwsServiceException,
SdkClientException,
DirectoryException

Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.

This is a convenience which creates an instance of the EnableDirectoryDataAccessRequest.Builder avoiding the need to create one manually via EnableDirectoryDataAccessRequest.builder()

Parameters:

enableDirectoryDataAccessRequest - A Consumer that will call methods on EnableDirectoryDataAccessRequest.Builder to create a request.

Returns:

Result of the EnableDirectoryDataAccess operation returned by the service.

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.

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.Builder avoiding the need to create one manually via EnableLdapsRequest.builder()

Parameters:

enableLdapsRequest - A Consumer that will call methods on EnableLdapsRequest.Builder to create a request.

Returns:

Result of the EnableLDAPS operation returned by the service.

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.

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.Builder avoiding the need to create one manually via EnableRadiusRequest.builder()

Parameters:

enableRadiusRequest - A Consumer that will call methods on EnableRadiusRequest.Builder to create a request. Contains the inputs for the EnableRadius operation.

Returns:

Result of the EnableRadius operation returned by the service.

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.

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.Builder avoiding the need to create one manually via EnableSsoRequest.builder()

Parameters:

enableSsoRequest - A Consumer that will call methods on EnableSsoRequest.Builder to create a request. Contains the inputs for the EnableSso operation.

Returns:

Result of the EnableSso operation returned by the service.

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.

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.Builder avoiding the need to create one manually via GetDirectoryLimitsRequest.builder()

Parameters:

getDirectoryLimitsRequest - A Consumer that will call methods on GetDirectoryLimitsRequest.Builder to create a request. Contains the inputs for the GetDirectoryLimits operation.

Returns:

Result of the GetDirectoryLimits operation returned by the service.

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.

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.

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.Builder avoiding the need to create one manually via GetSnapshotLimitsRequest.builder()

Parameters:

getSnapshotLimitsRequest - A Consumer that will call methods on GetSnapshotLimitsRequest.Builder to create a request. Contains the inputs for the GetSnapshotLimits operation.

Returns:

Result of the GetSnapshotLimits operation returned by the service.

See Also:

• AWS API Documentation

listADAssessments

default ListAdAssessmentsResponse listADAssessments(ListAdAssessmentsRequest listAdAssessmentsRequest)
                                             throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
DirectoryDoesNotExistException,
AwsServiceException,
SdkClientException,
DirectoryException

Retrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and manage multiple assessments.

Parameters:

listAdAssessmentsRequest -

Returns:

Result of the ListADAssessments operation returned by the service.

See Also:

• AWS API Documentation

listADAssessments

default ListAdAssessmentsResponse listADAssessments(Consumer<ListAdAssessmentsRequest.Builder> listAdAssessmentsRequest)
                                             throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
DirectoryDoesNotExistException,
AwsServiceException,
SdkClientException,
DirectoryException

Retrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and manage multiple assessments.

This is a convenience which creates an instance of the ListAdAssessmentsRequest.Builder avoiding the need to create one manually via ListAdAssessmentsRequest.builder()

Parameters:

listAdAssessmentsRequest - A Consumer that will call methods on ListAdAssessmentsRequest.Builder to create a request.

Returns:

Result of the ListADAssessments operation returned by the service.

See Also:

• AWS API Documentation

listADAssessmentsPaginator

default ListADAssessmentsIterable listADAssessmentsPaginator(ListAdAssessmentsRequest listAdAssessmentsRequest)
                                                      throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
DirectoryDoesNotExistException,
AwsServiceException,
SdkClientException,
DirectoryException

This is a variant of listADAssessments(software.amazon.awssdk.services.directory.model.ListAdAssessmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.directory.paginators.ListADAssessmentsIterable responses = client.listADAssessmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.directory.paginators.ListADAssessmentsIterable responses = client
             .listADAssessmentsPaginator(request);
     for (software.amazon.awssdk.services.directory.model.ListAdAssessmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.directory.paginators.ListADAssessmentsIterable responses = client.listADAssessmentsPaginator(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 listADAssessments(software.amazon.awssdk.services.directory.model.ListAdAssessmentsRequest) operation.

Parameters:

listAdAssessmentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listADAssessmentsPaginator

default ListADAssessmentsIterable listADAssessmentsPaginator(Consumer<ListAdAssessmentsRequest.Builder> listAdAssessmentsRequest)
                                                      throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
DirectoryDoesNotExistException,
AwsServiceException,
SdkClientException,
DirectoryException

This is a variant of listADAssessments(software.amazon.awssdk.services.directory.model.ListAdAssessmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.directory.paginators.ListADAssessmentsIterable responses = client.listADAssessmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.directory.paginators.ListADAssessmentsIterable responses = client
             .listADAssessmentsPaginator(request);
     for (software.amazon.awssdk.services.directory.model.ListAdAssessmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.directory.paginators.ListADAssessmentsIterable responses = client.listADAssessmentsPaginator(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 listADAssessments(software.amazon.awssdk.services.directory.model.ListAdAssessmentsRequest) operation.

This is a convenience which creates an instance of the ListAdAssessmentsRequest.Builder avoiding the need to create one manually via ListAdAssessmentsRequest.builder()

Parameters:

listAdAssessmentsRequest - A Consumer that will call methods on ListAdAssessmentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via ListCertificatesRequest.builder()

Parameters:

listCertificatesRequest - A Consumer that will call methods on ListCertificatesRequest.Builder to create a request.

Returns:

Result of the ListCertificates operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via ListCertificatesRequest.builder()

Parameters:

listCertificatesRequest - A Consumer that will call methods on ListCertificatesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via ListIpRoutesRequest.builder()

Parameters:

listIpRoutesRequest - A Consumer that will call methods on ListIpRoutesRequest.Builder to create a request.

Returns:

Result of the ListIpRoutes operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.ListIpRoutesIterable responses = client.listIpRoutesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.ListIpRoutesIterable responses = client.listIpRoutesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via ListIpRoutesRequest.builder()

Parameters:

listIpRoutesRequest - A Consumer that will call methods on ListIpRoutesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via ListLogSubscriptionsRequest.builder()

Parameters:

listLogSubscriptionsRequest - A Consumer that will call methods on ListLogSubscriptionsRequest.Builder to create a request.

Returns:

Result of the ListLogSubscriptions operation returned by the service.

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.

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

 
 software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client.listLogSubscriptionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client.listLogSubscriptionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.ListLogSubscriptionsIterable responses = client.listLogSubscriptionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via ListLogSubscriptionsRequest.builder()

Parameters:

listLogSubscriptionsRequest - A Consumer that will call methods on ListLogSubscriptionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via ListSchemaExtensionsRequest.builder()

Parameters:

listSchemaExtensionsRequest - A Consumer that will call methods on ListSchemaExtensionsRequest.Builder to create a request.

Returns:

Result of the ListSchemaExtensions operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsIterable responses = client.listSchemaExtensionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.ListSchemaExtensionsIterable responses = client.listSchemaExtensionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via ListSchemaExtensionsRequest.builder()

Parameters:

listSchemaExtensionsRequest - A Consumer that will call methods on ListSchemaExtensionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

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

 
 software.amazon.awssdk.services.directory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.

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

 
 software.amazon.awssdk.services.directory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.Builder avoiding the need to create one manually via RegisterCertificateRequest.builder()

Parameters:

registerCertificateRequest - A Consumer that will call methods on RegisterCertificateRequest.Builder to create a request.

Returns:

Result of the RegisterCertificate operation returned by the service.

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.

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.Builder avoiding the need to create one manually via RegisterEventTopicRequest.builder()

Parameters:

registerEventTopicRequest - A Consumer that will call methods on RegisterEventTopicRequest.Builder to create a request. Registers a new event topic.

Returns:

Result of the RegisterEventTopic operation returned by the service.

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.

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.Builder avoiding the need to create one manually via RejectSharedDirectoryRequest.builder()

Parameters:

rejectSharedDirectoryRequest - A Consumer that will call methods on RejectSharedDirectoryRequest.Builder to create a request.

Returns:

Result of the RejectSharedDirectory operation returned by the service.

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.

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.Builder avoiding the need to create one manually via RemoveIpRoutesRequest.builder()

Parameters:

removeIpRoutesRequest - A Consumer that will call methods on RemoveIpRoutesRequest.Builder to create a request.

Returns:

Result of the RemoveIpRoutes operation returned by the service.

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 DeleteDirectory API.

Parameters:

removeRegionRequest -

Returns:

Result of the RemoveRegion operation returned by the service.

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 DeleteDirectory API.

This is a convenience which creates an instance of the RemoveRegionRequest.Builder avoiding the need to create one manually via RemoveRegionRequest.builder()

Parameters:

removeRegionRequest - A Consumer that will call methods on RemoveRegionRequest.Builder to create a request.

Returns:

Result of the RemoveRegion operation returned by the service.

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.

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.Builder avoiding the need to create one manually via RemoveTagsFromResourceRequest.builder()

Parameters:

removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceRequest.Builder to create a request.

Returns:

Result of the RemoveTagsFromResource operation returned by the service.

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. Disabled users will become enabled and can be authenticated following the API call.

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.

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. Disabled users will become enabled and can be authenticated following the API call.

You can reset the password for any user in your directory with the following exceptions:

• For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.

• For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.

This is a convenience which creates an instance of the ResetUserPasswordRequest.Builder avoiding the need to create one manually via ResetUserPasswordRequest.builder()

Parameters:

resetUserPasswordRequest - A Consumer that will call methods on ResetUserPasswordRequest.Builder to create a request.

Returns:

Result of the ResetUserPassword operation returned by the service.

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.

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.Builder avoiding the need to create one manually via RestoreFromSnapshotRequest.builder()

Parameters:

restoreFromSnapshotRequest - A Consumer that will call methods on RestoreFromSnapshotRequest.Builder to create a request. An object representing the inputs for the RestoreFromSnapshot operation.

Returns:

Result of the RestoreFromSnapshot operation returned by the service.

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 ShareMethod parameter determines whether the specified directory can be shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also determines whether you can share the directory with any other Amazon Web Services account either inside or outside of the organization (HANDSHAKE).

The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.

Parameters:

shareDirectoryRequest -

Returns:

Result of the ShareDirectory operation returned by the service.

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 ShareMethod parameter determines whether the specified directory can be shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also determines whether you can share the directory with any other Amazon Web Services account either inside or outside of the organization (HANDSHAKE).

The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.

This is a convenience which creates an instance of the ShareDirectoryRequest.Builder avoiding the need to create one manually via ShareDirectoryRequest.builder()

Parameters:

shareDirectoryRequest - A Consumer that will call methods on ShareDirectoryRequest.Builder to create a request.

Returns:

Result of the ShareDirectory operation returned by the service.

See Also:

• AWS API Documentation

startADAssessment

default StartAdAssessmentResponse startADAssessment(StartAdAssessmentRequest startAdAssessmentRequest)
                                             throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
DirectoryDoesNotExistException,
AdAssessmentLimitExceededException,
AwsServiceException,
SdkClientException,
DirectoryException

Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join. The assessment checks compatibility and connectivity of the self-managed AD environment.

A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

The assessment process typically takes 30 minutes or more to complete. The assessment process is asynchronous and you can monitor it with DescribeADAssessment.

The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

Note: You must provide exactly one DirectoryId or AssessmentConfiguration.

Parameters:

startAdAssessmentRequest -

Returns:

Result of the StartADAssessment operation returned by the service.

See Also:

• AWS API Documentation

startADAssessment

default StartAdAssessmentResponse startADAssessment(Consumer<StartAdAssessmentRequest.Builder> startAdAssessmentRequest)
                                             throws ClientException,
ServiceException,
InvalidParameterException,
UnsupportedOperationException,
DirectoryDoesNotExistException,
AdAssessmentLimitExceededException,
AwsServiceException,
SdkClientException,
DirectoryException

Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join. The assessment checks compatibility and connectivity of the self-managed AD environment.

A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

The assessment process typically takes 30 minutes or more to complete. The assessment process is asynchronous and you can monitor it with DescribeADAssessment.

The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

Note: You must provide exactly one DirectoryId or AssessmentConfiguration.

This is a convenience which creates an instance of the StartAdAssessmentRequest.Builder avoiding the need to create one manually via StartAdAssessmentRequest.builder()

Parameters:

startAdAssessmentRequest - A Consumer that will call methods on StartAdAssessmentRequest.Builder to create a request.

Returns:

Result of the StartADAssessment operation returned by the service.

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.

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.Builder avoiding the need to create one manually via StartSchemaExtensionRequest.builder()

Parameters:

startSchemaExtensionRequest - A Consumer that will call methods on StartSchemaExtensionRequest.Builder to create a request.

Returns:

Result of the StartSchemaExtension operation returned by the service.

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.

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.Builder avoiding the need to create one manually via UnshareDirectoryRequest.builder()

Parameters:

unshareDirectoryRequest - A Consumer that will call methods on UnshareDirectoryRequest.Builder to create a request.

Returns:

Result of the UnshareDirectory operation returned by the service.

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.

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.Builder avoiding the need to create one manually via UpdateConditionalForwarderRequest.builder()

Parameters:

updateConditionalForwarderRequest - A Consumer that will call methods on UpdateConditionalForwarderRequest.Builder to create a request. Updates a conditional forwarder.

Returns:

Result of the UpdateConditionalForwarder operation returned by the service.

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 directory configuration for the specified update type.

Parameters:

updateDirectorySetupRequest -

Returns:

Result of the UpdateDirectorySetup operation returned by the service.

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 directory configuration for the specified update type.

This is a convenience which creates an instance of the UpdateDirectorySetupRequest.Builder avoiding the need to create one manually via UpdateDirectorySetupRequest.builder()

Parameters:

updateDirectorySetupRequest - A Consumer that will call methods on UpdateDirectorySetupRequest.Builder to create a request.

Returns:

Result of the UpdateDirectorySetup operation returned by the service.

See Also:

• AWS API Documentation

updateHybridAD

default UpdateHybridAdResponse updateHybridAD(UpdateHybridAdRequest updateHybridAdRequest)
                                       throws ClientException,
ServiceException,
UnsupportedOperationException,
InvalidParameterException,
DirectoryDoesNotExistException,
AdAssessmentLimitExceededException,
AwsServiceException,
SdkClientException,
DirectoryException

Updates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings.

Updates are applied asynchronously. Use DescribeHybridADUpdate to monitor the progress of configuration changes.

The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

You must provide at least one update to UpdateHybridADRequestinvalid input: '&#36'HybridAdministratorAccountUpdate or UpdateHybridADRequestinvalid input: '&#36'SelfManagedInstancesSettings.

Parameters:

updateHybridAdRequest -

Returns:

Result of the UpdateHybridAD operation returned by the service.

See Also:

• AWS API Documentation

updateHybridAD

default UpdateHybridAdResponse updateHybridAD(Consumer<UpdateHybridAdRequest.Builder> updateHybridAdRequest)
                                       throws ClientException,
ServiceException,
UnsupportedOperationException,
InvalidParameterException,
DirectoryDoesNotExistException,
AdAssessmentLimitExceededException,
AwsServiceException,
SdkClientException,
DirectoryException

Updates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings.

Updates are applied asynchronously. Use DescribeHybridADUpdate to monitor the progress of configuration changes.

The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

You must provide at least one update to UpdateHybridADRequestinvalid input: '&#36'HybridAdministratorAccountUpdate or UpdateHybridADRequestinvalid input: '&#36'SelfManagedInstancesSettings.

This is a convenience which creates an instance of the UpdateHybridAdRequest.Builder avoiding the need to create one manually via UpdateHybridAdRequest.builder()

Parameters:

updateHybridAdRequest - A Consumer that will call methods on UpdateHybridAdRequest.Builder to create a request.

Returns:

Result of the UpdateHybridAD operation returned by the service.

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.

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.Builder avoiding the need to create one manually via UpdateNumberOfDomainControllersRequest.builder()

Parameters:

updateNumberOfDomainControllersRequest - A Consumer that will call methods on UpdateNumberOfDomainControllersRequest.Builder to create a request.

Returns:

Result of the UpdateNumberOfDomainControllers operation returned by the service.

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.

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.Builder avoiding the need to create one manually via UpdateRadiusRequest.builder()

Parameters:

updateRadiusRequest - A Consumer that will call methods on UpdateRadiusRequest.Builder to create a request. Contains the inputs for the UpdateRadius operation.

Returns:

Result of the UpdateRadius operation returned by the service.

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.

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.Builder avoiding the need to create one manually via UpdateSettingsRequest.builder()

Parameters:

updateSettingsRequest - A Consumer that will call methods on UpdateSettingsRequest.Builder to create a request.

Returns:

Result of the UpdateSettings operation returned by the service.

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.

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.Builder avoiding the need to create one manually via UpdateTrustRequest.builder()

Parameters:

updateTrustRequest - A Consumer that will call methods on UpdateTrustRequest.Builder to create a request.

Returns:

Result of the UpdateTrust operation returned by the service.

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.

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.Builder avoiding the need to create one manually via VerifyTrustRequest.builder()

Parameters:

verifyTrustRequest - A Consumer that will call methods on VerifyTrustRequest.Builder to create a request. Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.

Returns:

Result of the VerifyTrust operation returned by the service.

See Also:

• AWS API Documentation

waiter

default DirectoryWaiter waiter()

Create an instance of DirectoryWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of DirectoryWaiter

create

static DirectoryClient create()

Create a DirectoryClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static DirectoryClientBuilder builder()

Create a builder that can be used to configure and create a DirectoryClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default DirectoryServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration