Package software.amazon.awssdk.services.clouddirectory

Interface CloudDirectoryAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CloudDirectoryAsyncClient extends AwsClient
Service client for accessing Amazon CloudDirectory asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference 
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. Amazon Cloud Directory

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see AWS Directory Service and the Amazon Cloud Directory Developer Guide.

  • Field Details

  • Method Details

    • addFacetToObject

      default CompletableFuture<AddFacetToObjectResponse> addFacetToObject(AddFacetToObjectRequest addFacetToObjectRequest)

      Adds a new Facet to an object. An object can have more than one facet applied on it.

      Parameters:
      addFacetToObjectRequest -
      Returns:
      A Java Future containing the result of the AddFacetToObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addFacetToObject

      default CompletableFuture<AddFacetToObjectResponse> addFacetToObject(Consumer<AddFacetToObjectRequest.Builder> addFacetToObjectRequest)

      Adds a new Facet to an object. An object can have more than one facet applied on it.


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

      Parameters:
      addFacetToObjectRequest - A Consumer that will call methods on AddFacetToObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddFacetToObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • applySchema

      default CompletableFuture<ApplySchemaResponse> applySchema(ApplySchemaRequest applySchemaRequest)

      Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.

      Parameters:
      applySchemaRequest -
      Returns:
      A Java Future containing the result of the ApplySchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • SchemaAlreadyExistsException Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • applySchema

      default CompletableFuture<ApplySchemaResponse> applySchema(Consumer<ApplySchemaRequest.Builder> applySchemaRequest)

      Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.


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

      Parameters:
      applySchemaRequest - A Consumer that will call methods on ApplySchemaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ApplySchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • SchemaAlreadyExistsException Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachObject

      default CompletableFuture<AttachObjectResponse> attachObject(AttachObjectRequest attachObjectRequest)

      Attaches an existing object to another object. An object can be accessed in two ways:

      1. Using the path

      2. Using ObjectIdentifier

      Parameters:
      attachObjectRequest -
      Returns:
      A Java Future containing the result of the AttachObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • LinkNameAlreadyInUseException Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachObject

      default CompletableFuture<AttachObjectResponse> attachObject(Consumer<AttachObjectRequest.Builder> attachObjectRequest)

      Attaches an existing object to another object. An object can be accessed in two ways:

      1. Using the path

      2. Using ObjectIdentifier


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

      Parameters:
      attachObjectRequest - A Consumer that will call methods on AttachObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AttachObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • LinkNameAlreadyInUseException Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachPolicy

      default CompletableFuture<AttachPolicyResponse> attachPolicy(AttachPolicyRequest attachPolicyRequest)

      Attaches a policy object to a regular object. An object can have a limited number of attached policies.

      Parameters:
      attachPolicyRequest -
      Returns:
      A Java Future containing the result of the AttachPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • NotPolicyException Indicates that the requested operation can only operate on policy objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachPolicy

      default CompletableFuture<AttachPolicyResponse> attachPolicy(Consumer<AttachPolicyRequest.Builder> attachPolicyRequest)

      Attaches a policy object to a regular object. An object can have a limited number of attached policies.


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

      Parameters:
      attachPolicyRequest - A Consumer that will call methods on AttachPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AttachPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • NotPolicyException Indicates that the requested operation can only operate on policy objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachToIndex

      default CompletableFuture<AttachToIndexResponse> attachToIndex(AttachToIndexRequest attachToIndexRequest)

      Attaches the specified object to the specified index.

      Parameters:
      attachToIndexRequest -
      Returns:
      A Java Future containing the result of the AttachToIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • ResourceNotFoundException The specified resource could not be found.
      • LinkNameAlreadyInUseException Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
      • IndexedAttributeMissingException An object has been attempted to be attached to an object that does not have the appropriate attribute value.
      • NotIndexException Indicates that the requested operation can only operate on index objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachToIndex

      default CompletableFuture<AttachToIndexResponse> attachToIndex(Consumer<AttachToIndexRequest.Builder> attachToIndexRequest)

      Attaches the specified object to the specified index.


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

      Parameters:
      attachToIndexRequest - A Consumer that will call methods on AttachToIndexRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AttachToIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • ResourceNotFoundException The specified resource could not be found.
      • LinkNameAlreadyInUseException Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
      • IndexedAttributeMissingException An object has been attempted to be attached to an object that does not have the appropriate attribute value.
      • NotIndexException Indicates that the requested operation can only operate on index objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachTypedLink

      default CompletableFuture<AttachTypedLinkResponse> attachTypedLink(AttachTypedLinkRequest attachTypedLinkRequest)

      Attaches a typed link to a specified source and target object. For more information, see Typed Links.

      Parameters:
      attachTypedLinkRequest -
      Returns:
      A Java Future containing the result of the AttachTypedLink operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachTypedLink

      default CompletableFuture<AttachTypedLinkResponse> attachTypedLink(Consumer<AttachTypedLinkRequest.Builder> attachTypedLinkRequest)

      Attaches a typed link to a specified source and target object. For more information, see Typed Links.


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

      Parameters:
      attachTypedLinkRequest - A Consumer that will call methods on AttachTypedLinkRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AttachTypedLink operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchRead

      default CompletableFuture<BatchReadResponse> batchRead(BatchReadRequest batchReadRequest)

      Performs all the read operations in a batch.

      Parameters:
      batchReadRequest -
      Returns:
      A Java Future containing the result of the BatchRead operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchRead

      default CompletableFuture<BatchReadResponse> batchRead(Consumer<BatchReadRequest.Builder> batchReadRequest)

      Performs all the read operations in a batch.


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

      Parameters:
      batchReadRequest - A Consumer that will call methods on BatchReadRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchRead operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchWrite

      default CompletableFuture<BatchWriteResponse> batchWrite(BatchWriteRequest batchWriteRequest)

      Performs all the write operations in a batch. Either all the operations succeed or none.

      Parameters:
      batchWriteRequest -
      Returns:
      A Java Future containing the result of the BatchWrite operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • BatchWriteException A BatchWrite exception has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchWrite

      default CompletableFuture<BatchWriteResponse> batchWrite(Consumer<BatchWriteRequest.Builder> batchWriteRequest)

      Performs all the write operations in a batch. Either all the operations succeed or none.


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

      Parameters:
      batchWriteRequest - A Consumer that will call methods on BatchWriteRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchWrite operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • BatchWriteException A BatchWrite exception has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDirectory

      default CompletableFuture<CreateDirectoryResponse> createDirectory(CreateDirectoryRequest createDirectoryRequest)

      Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

      You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

      Parameters:
      createDirectoryRequest -
      Returns:
      A Java Future containing the result of the CreateDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryAlreadyExistsException Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDirectory

      default CompletableFuture<CreateDirectoryResponse> createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest)

      Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

      You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.


      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.
      Returns:
      A Java Future containing the result of the CreateDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryAlreadyExistsException Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFacet

      default CompletableFuture<CreateFacetResponse> createFacet(CreateFacetRequest createFacetRequest)

      Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

      Parameters:
      createFacetRequest -
      Returns:
      A Java Future containing the result of the CreateFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetAlreadyExistsException A facet with the same name already exists.
      • InvalidRuleException Occurs when any of the rule parameter keys or values are invalid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFacet

      default CompletableFuture<CreateFacetResponse> createFacet(Consumer<CreateFacetRequest.Builder> createFacetRequest)

      Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.


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

      Parameters:
      createFacetRequest - A Consumer that will call methods on CreateFacetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetAlreadyExistsException A facet with the same name already exists.
      • InvalidRuleException Occurs when any of the rule parameter keys or values are invalid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIndex

      default CompletableFuture<CreateIndexResponse> createIndex(CreateIndexRequest createIndexRequest)

      Creates an index object. See Indexing and search for more information.

      Parameters:
      createIndexRequest -
      Returns:
      A Java Future containing the result of the CreateIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • LinkNameAlreadyInUseException Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
      • UnsupportedIndexTypeException Indicates that the requested index type is not supported.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIndex

      default CompletableFuture<CreateIndexResponse> createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)

      Creates an index object. See Indexing and search for more information.


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

      Parameters:
      createIndexRequest - A Consumer that will call methods on CreateIndexRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • LinkNameAlreadyInUseException Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
      • UnsupportedIndexTypeException Indicates that the requested index type is not supported.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createObject

      default CompletableFuture<CreateObjectResponse> createObject(CreateObjectRequest createObjectRequest)

      Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.

      Parameters:
      createObjectRequest -
      Returns:
      A Java Future containing the result of the CreateObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • LinkNameAlreadyInUseException Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
      • UnsupportedIndexTypeException Indicates that the requested index type is not supported.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createObject

      default CompletableFuture<CreateObjectResponse> createObject(Consumer<CreateObjectRequest.Builder> createObjectRequest)

      Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.


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

      Parameters:
      createObjectRequest - A Consumer that will call methods on CreateObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • LinkNameAlreadyInUseException Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
      • UnsupportedIndexTypeException Indicates that the requested index type is not supported.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSchema

      default CompletableFuture<CreateSchemaResponse> createSchema(CreateSchemaRequest createSchemaRequest)

      Creates a new schema in a development state. A schema can exist in three phases:

      • Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.

      • Published: Published schemas are immutable and have a version associated with them.

      • Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.

      Parameters:
      createSchemaRequest -
      Returns:
      A Java Future containing the result of the CreateSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • SchemaAlreadyExistsException Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSchema

      default CompletableFuture<CreateSchemaResponse> createSchema(Consumer<CreateSchemaRequest.Builder> createSchemaRequest)

      Creates a new schema in a development state. A schema can exist in three phases:

      • Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.

      • Published: Published schemas are immutable and have a version associated with them.

      • Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.


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

      Parameters:
      createSchemaRequest - A Consumer that will call methods on CreateSchemaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • SchemaAlreadyExistsException Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTypedLinkFacet

      default CompletableFuture<CreateTypedLinkFacetResponse> createTypedLinkFacet(CreateTypedLinkFacetRequest createTypedLinkFacetRequest)

      Creates a TypedLinkFacet. For more information, see Typed Links.

      Parameters:
      createTypedLinkFacetRequest -
      Returns:
      A Java Future containing the result of the CreateTypedLinkFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetAlreadyExistsException A facet with the same name already exists.
      • InvalidRuleException Occurs when any of the rule parameter keys or values are invalid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTypedLinkFacet

      default CompletableFuture<CreateTypedLinkFacetResponse> createTypedLinkFacet(Consumer<CreateTypedLinkFacetRequest.Builder> createTypedLinkFacetRequest)

      Creates a TypedLinkFacet. For more information, see Typed Links.


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

      Parameters:
      createTypedLinkFacetRequest - A Consumer that will call methods on CreateTypedLinkFacetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTypedLinkFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetAlreadyExistsException A facet with the same name already exists.
      • InvalidRuleException Occurs when any of the rule parameter keys or values are invalid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDirectory

      default CompletableFuture<DeleteDirectoryResponse> deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest)

      Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

      Parameters:
      deleteDirectoryRequest -
      Returns:
      A Java Future containing the result of the DeleteDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource could not be found.
      • DirectoryNotDisabledException An operation can only operate on a disabled directory.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryDeletedException A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDirectory

      default CompletableFuture<DeleteDirectoryResponse> deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest)

      Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.


      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.
      Returns:
      A Java Future containing the result of the DeleteDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource could not be found.
      • DirectoryNotDisabledException An operation can only operate on a disabled directory.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryDeletedException A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFacet

      default CompletableFuture<DeleteFacetResponse> deleteFacet(DeleteFacetRequest deleteFacetRequest)

      Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.

      Parameters:
      deleteFacetRequest -
      Returns:
      A Java Future containing the result of the DeleteFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • FacetInUseException Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFacet

      default CompletableFuture<DeleteFacetResponse> deleteFacet(Consumer<DeleteFacetRequest.Builder> deleteFacetRequest)

      Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.


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

      Parameters:
      deleteFacetRequest - A Consumer that will call methods on DeleteFacetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • FacetInUseException Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteObject

      default CompletableFuture<DeleteObjectResponse> deleteObject(DeleteObjectRequest deleteObjectRequest)

      Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.

      Parameters:
      deleteObjectRequest -
      Returns:
      A Java Future containing the result of the DeleteObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • ObjectNotDetachedException Indicates that the requested operation cannot be completed because the object has not been detached from the tree.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteObject

      default CompletableFuture<DeleteObjectResponse> deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)

      Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.


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

      Parameters:
      deleteObjectRequest - A Consumer that will call methods on DeleteObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • ObjectNotDetachedException Indicates that the requested operation cannot be completed because the object has not been detached from the tree.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSchema

      default CompletableFuture<DeleteSchemaResponse> deleteSchema(DeleteSchemaRequest deleteSchemaRequest)

      Deletes a given schema. Schemas in a development and published state can only be deleted.

      Parameters:
      deleteSchemaRequest -
      Returns:
      A Java Future containing the result of the DeleteSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • StillContainsLinksException The object could not be deleted because links still exist. Remove the links and then try the operation again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSchema

      default CompletableFuture<DeleteSchemaResponse> deleteSchema(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest)

      Deletes a given schema. Schemas in a development and published state can only be deleted.


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

      Parameters:
      deleteSchemaRequest - A Consumer that will call methods on DeleteSchemaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • StillContainsLinksException The object could not be deleted because links still exist. Remove the links and then try the operation again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTypedLinkFacet

      default CompletableFuture<DeleteTypedLinkFacetResponse> deleteTypedLinkFacet(DeleteTypedLinkFacetRequest deleteTypedLinkFacetRequest)

      Deletes a TypedLinkFacet. For more information, see Typed Links.

      Parameters:
      deleteTypedLinkFacetRequest -
      Returns:
      A Java Future containing the result of the DeleteTypedLinkFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTypedLinkFacet

      default CompletableFuture<DeleteTypedLinkFacetResponse> deleteTypedLinkFacet(Consumer<DeleteTypedLinkFacetRequest.Builder> deleteTypedLinkFacetRequest)

      Deletes a TypedLinkFacet. For more information, see Typed Links.


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

      Parameters:
      deleteTypedLinkFacetRequest - A Consumer that will call methods on DeleteTypedLinkFacetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTypedLinkFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachFromIndex

      default CompletableFuture<DetachFromIndexResponse> detachFromIndex(DetachFromIndexRequest detachFromIndexRequest)

      Detaches the specified object from the specified index.

      Parameters:
      detachFromIndexRequest -
      Returns:
      A Java Future containing the result of the DetachFromIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • ObjectAlreadyDetachedException Indicates that the object is not attached to the index.
      • NotIndexException Indicates that the requested operation can only operate on index objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachFromIndex

      default CompletableFuture<DetachFromIndexResponse> detachFromIndex(Consumer<DetachFromIndexRequest.Builder> detachFromIndexRequest)

      Detaches the specified object from the specified index.


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

      Parameters:
      detachFromIndexRequest - A Consumer that will call methods on DetachFromIndexRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetachFromIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • ObjectAlreadyDetachedException Indicates that the object is not attached to the index.
      • NotIndexException Indicates that the requested operation can only operate on index objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachObject

      default CompletableFuture<DetachObjectResponse> detachObject(DetachObjectRequest detachObjectRequest)

      Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

      Parameters:
      detachObjectRequest -
      Returns:
      A Java Future containing the result of the DetachObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • NotNodeException Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachObject

      default CompletableFuture<DetachObjectResponse> detachObject(Consumer<DetachObjectRequest.Builder> detachObjectRequest)

      Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.


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

      Parameters:
      detachObjectRequest - A Consumer that will call methods on DetachObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetachObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • NotNodeException Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachPolicy

      default CompletableFuture<DetachPolicyResponse> detachPolicy(DetachPolicyRequest detachPolicyRequest)

      Detaches a policy from an object.

      Parameters:
      detachPolicyRequest -
      Returns:
      A Java Future containing the result of the DetachPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • NotPolicyException Indicates that the requested operation can only operate on policy objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachPolicy

      default CompletableFuture<DetachPolicyResponse> detachPolicy(Consumer<DetachPolicyRequest.Builder> detachPolicyRequest)

      Detaches a policy from an object.


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

      Parameters:
      detachPolicyRequest - A Consumer that will call methods on DetachPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetachPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • NotPolicyException Indicates that the requested operation can only operate on policy objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachTypedLink

      default CompletableFuture<DetachTypedLinkResponse> detachTypedLink(DetachTypedLinkRequest detachTypedLinkRequest)

      Detaches a typed link from a specified source and target object. For more information, see Typed Links.

      Parameters:
      detachTypedLinkRequest -
      Returns:
      A Java Future containing the result of the DetachTypedLink operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachTypedLink

      default CompletableFuture<DetachTypedLinkResponse> detachTypedLink(Consumer<DetachTypedLinkRequest.Builder> detachTypedLinkRequest)

      Detaches a typed link from a specified source and target object. For more information, see Typed Links.


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

      Parameters:
      detachTypedLinkRequest - A Consumer that will call methods on DetachTypedLinkRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetachTypedLink operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableDirectory

      default CompletableFuture<DisableDirectoryResponse> disableDirectory(DisableDirectoryRequest disableDirectoryRequest)

      Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

      Parameters:
      disableDirectoryRequest -
      Returns:
      A Java Future containing the result of the DisableDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource could not be found.
      • DirectoryDeletedException A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableDirectory

      default CompletableFuture<DisableDirectoryResponse> disableDirectory(Consumer<DisableDirectoryRequest.Builder> disableDirectoryRequest)

      Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.


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

      Parameters:
      disableDirectoryRequest - A Consumer that will call methods on DisableDirectoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisableDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource could not be found.
      • DirectoryDeletedException A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • enableDirectory

      default CompletableFuture<EnableDirectoryResponse> enableDirectory(EnableDirectoryRequest enableDirectoryRequest)

      Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

      Parameters:
      enableDirectoryRequest -
      Returns:
      A Java Future containing the result of the EnableDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource could not be found.
      • DirectoryDeletedException A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • enableDirectory

      default CompletableFuture<EnableDirectoryResponse> enableDirectory(Consumer<EnableDirectoryRequest.Builder> enableDirectoryRequest)

      Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.


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

      Parameters:
      enableDirectoryRequest - A Consumer that will call methods on EnableDirectoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the EnableDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource could not be found.
      • DirectoryDeletedException A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAppliedSchemaVersion

      default CompletableFuture<GetAppliedSchemaVersionResponse> getAppliedSchemaVersion(GetAppliedSchemaVersionRequest getAppliedSchemaVersionRequest)

      Returns current applied schema version ARN, including the minor version in use.

      Parameters:
      getAppliedSchemaVersionRequest -
      Returns:
      A Java Future containing the result of the GetAppliedSchemaVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAppliedSchemaVersion

      default CompletableFuture<GetAppliedSchemaVersionResponse> getAppliedSchemaVersion(Consumer<GetAppliedSchemaVersionRequest.Builder> getAppliedSchemaVersionRequest)

      Returns current applied schema version ARN, including the minor version in use.


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

      Parameters:
      getAppliedSchemaVersionRequest - A Consumer that will call methods on GetAppliedSchemaVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAppliedSchemaVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDirectory

      default CompletableFuture<GetDirectoryResponse> getDirectory(GetDirectoryRequest getDirectoryRequest)

      Retrieves metadata about a directory.

      Parameters:
      getDirectoryRequest -
      Returns:
      A Java Future containing the result of the GetDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDirectory

      default CompletableFuture<GetDirectoryResponse> getDirectory(Consumer<GetDirectoryRequest.Builder> getDirectoryRequest)

      Retrieves metadata about a directory.


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

      Parameters:
      getDirectoryRequest - A Consumer that will call methods on GetDirectoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDirectory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFacet

      default CompletableFuture<GetFacetResponse> getFacet(GetFacetRequest getFacetRequest)

      Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.

      Parameters:
      getFacetRequest -
      Returns:
      A Java Future containing the result of the GetFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFacet

      default CompletableFuture<GetFacetResponse> getFacet(Consumer<GetFacetRequest.Builder> getFacetRequest)

      Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.


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

      Parameters:
      getFacetRequest - A Consumer that will call methods on GetFacetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLinkAttributes

      default CompletableFuture<GetLinkAttributesResponse> getLinkAttributes(GetLinkAttributesRequest getLinkAttributesRequest)

      Retrieves attributes that are associated with a typed link.

      Parameters:
      getLinkAttributesRequest -
      Returns:
      A Java Future containing the result of the GetLinkAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLinkAttributes

      default CompletableFuture<GetLinkAttributesResponse> getLinkAttributes(Consumer<GetLinkAttributesRequest.Builder> getLinkAttributesRequest)

      Retrieves attributes that are associated with a typed link.


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

      Parameters:
      getLinkAttributesRequest - A Consumer that will call methods on GetLinkAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLinkAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getObjectAttributes

      default CompletableFuture<GetObjectAttributesResponse> getObjectAttributes(GetObjectAttributesRequest getObjectAttributesRequest)

      Retrieves attributes within a facet that are associated with an object.

      Parameters:
      getObjectAttributesRequest -
      Returns:
      A Java Future containing the result of the GetObjectAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getObjectAttributes

      default CompletableFuture<GetObjectAttributesResponse> getObjectAttributes(Consumer<GetObjectAttributesRequest.Builder> getObjectAttributesRequest)

      Retrieves attributes within a facet that are associated with an object.


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

      Parameters:
      getObjectAttributesRequest - A Consumer that will call methods on GetObjectAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetObjectAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getObjectInformation

      default CompletableFuture<GetObjectInformationResponse> getObjectInformation(GetObjectInformationRequest getObjectInformationRequest)

      Retrieves metadata about an object.

      Parameters:
      getObjectInformationRequest -
      Returns:
      A Java Future containing the result of the GetObjectInformation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getObjectInformation

      default CompletableFuture<GetObjectInformationResponse> getObjectInformation(Consumer<GetObjectInformationRequest.Builder> getObjectInformationRequest)

      Retrieves metadata about an object.


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

      Parameters:
      getObjectInformationRequest - A Consumer that will call methods on GetObjectInformationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetObjectInformation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSchemaAsJson

      default CompletableFuture<GetSchemaAsJsonResponse> getSchemaAsJson(GetSchemaAsJsonRequest getSchemaAsJsonRequest)

      Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

      Parameters:
      getSchemaAsJsonRequest -
      Returns:
      A Java Future containing the result of the GetSchemaAsJson operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSchemaAsJson

      default CompletableFuture<GetSchemaAsJsonResponse> getSchemaAsJson(Consumer<GetSchemaAsJsonRequest.Builder> getSchemaAsJsonRequest)

      Retrieves a JSON representation of the schema. See JSON Schema Format for more information.


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

      Parameters:
      getSchemaAsJsonRequest - A Consumer that will call methods on GetSchemaAsJsonRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSchemaAsJson operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTypedLinkFacetInformation

      default CompletableFuture<GetTypedLinkFacetInformationResponse> getTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest getTypedLinkFacetInformationRequest)

      Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.

      Parameters:
      getTypedLinkFacetInformationRequest -
      Returns:
      A Java Future containing the result of the GetTypedLinkFacetInformation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • FacetNotFoundException The specified Facet could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTypedLinkFacetInformation

      default CompletableFuture<GetTypedLinkFacetInformationResponse> getTypedLinkFacetInformation(Consumer<GetTypedLinkFacetInformationRequest.Builder> getTypedLinkFacetInformationRequest)

      Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.


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

      Parameters:
      getTypedLinkFacetInformationRequest - A Consumer that will call methods on GetTypedLinkFacetInformationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTypedLinkFacetInformation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • FacetNotFoundException The specified Facet could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppliedSchemaArns

      default CompletableFuture<ListAppliedSchemaArnsResponse> listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest)

      Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

      Parameters:
      listAppliedSchemaArnsRequest -
      Returns:
      A Java Future containing the result of the ListAppliedSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppliedSchemaArns

      default CompletableFuture<ListAppliedSchemaArnsResponse> listAppliedSchemaArns(Consumer<ListAppliedSchemaArnsRequest.Builder> listAppliedSchemaArnsRequest)

      Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.


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

      Parameters:
      listAppliedSchemaArnsRequest - A Consumer that will call methods on ListAppliedSchemaArnsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAppliedSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppliedSchemaArnsPaginator

      default ListAppliedSchemaArnsPublisher listAppliedSchemaArnsPaginator(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest)

      This is a variant of listAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsPublisher publisher = client.listAppliedSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsPublisher publisher = client.listAppliedSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest) operation.

      Parameters:
      listAppliedSchemaArnsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAppliedSchemaArnsPaginator

      default ListAppliedSchemaArnsPublisher listAppliedSchemaArnsPaginator(Consumer<ListAppliedSchemaArnsRequest.Builder> listAppliedSchemaArnsRequest)

      This is a variant of listAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsPublisher publisher = client.listAppliedSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsPublisher publisher = client.listAppliedSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest) operation.


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

      Parameters:
      listAppliedSchemaArnsRequest - A Consumer that will call methods on ListAppliedSchemaArnsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachedIndices

      default CompletableFuture<ListAttachedIndicesResponse> listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest)

      Lists indices attached to the specified object.

      Parameters:
      listAttachedIndicesRequest -
      Returns:
      A Java Future containing the result of the ListAttachedIndices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachedIndices

      default CompletableFuture<ListAttachedIndicesResponse> listAttachedIndices(Consumer<ListAttachedIndicesRequest.Builder> listAttachedIndicesRequest)

      Lists indices attached to the specified object.


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

      Parameters:
      listAttachedIndicesRequest - A Consumer that will call methods on ListAttachedIndicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAttachedIndices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachedIndicesPaginator

      default ListAttachedIndicesPublisher listAttachedIndicesPaginator(ListAttachedIndicesRequest listAttachedIndicesRequest)

      This is a variant of listAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesPublisher publisher = client.listAttachedIndicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesPublisher publisher = client.listAttachedIndicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest) operation.

      Parameters:
      listAttachedIndicesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachedIndicesPaginator

      default ListAttachedIndicesPublisher listAttachedIndicesPaginator(Consumer<ListAttachedIndicesRequest.Builder> listAttachedIndicesRequest)

      This is a variant of listAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesPublisher publisher = client.listAttachedIndicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesPublisher publisher = client.listAttachedIndicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest) operation.


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

      Parameters:
      listAttachedIndicesRequest - A Consumer that will call methods on ListAttachedIndicesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevelopmentSchemaArns

      default CompletableFuture<ListDevelopmentSchemaArnsResponse> listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest)

      Retrieves each Amazon Resource Name (ARN) of schemas in the development state.

      Parameters:
      listDevelopmentSchemaArnsRequest -
      Returns:
      A Java Future containing the result of the ListDevelopmentSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevelopmentSchemaArns

      default CompletableFuture<ListDevelopmentSchemaArnsResponse> listDevelopmentSchemaArns(Consumer<ListDevelopmentSchemaArnsRequest.Builder> listDevelopmentSchemaArnsRequest)

      Retrieves each Amazon Resource Name (ARN) of schemas in the development state.


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

      Parameters:
      listDevelopmentSchemaArnsRequest - A Consumer that will call methods on ListDevelopmentSchemaArnsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDevelopmentSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevelopmentSchemaArns

      default CompletableFuture<ListDevelopmentSchemaArnsResponse> listDevelopmentSchemaArns()

      Retrieves each Amazon Resource Name (ARN) of schemas in the development state.

      Returns:
      A Java Future containing the result of the ListDevelopmentSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevelopmentSchemaArnsPaginator

      default ListDevelopmentSchemaArnsPublisher listDevelopmentSchemaArnsPaginator()

      This is a variant of listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsPublisher publisher = client.listDevelopmentSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsPublisher publisher = client.listDevelopmentSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevelopmentSchemaArnsPaginator

      default ListDevelopmentSchemaArnsPublisher listDevelopmentSchemaArnsPaginator(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest)

      This is a variant of listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsPublisher publisher = client.listDevelopmentSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsPublisher publisher = client.listDevelopmentSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest) operation.

      Parameters:
      listDevelopmentSchemaArnsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevelopmentSchemaArnsPaginator

      default ListDevelopmentSchemaArnsPublisher listDevelopmentSchemaArnsPaginator(Consumer<ListDevelopmentSchemaArnsRequest.Builder> listDevelopmentSchemaArnsRequest)

      This is a variant of listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsPublisher publisher = client.listDevelopmentSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsPublisher publisher = client.listDevelopmentSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest) operation.


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

      Parameters:
      listDevelopmentSchemaArnsRequest - A Consumer that will call methods on ListDevelopmentSchemaArnsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDirectories

      default CompletableFuture<ListDirectoriesResponse> listDirectories(ListDirectoriesRequest listDirectoriesRequest)

      Lists directories created within an account.

      Parameters:
      listDirectoriesRequest -
      Returns:
      A Java Future containing the result of the ListDirectories operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDirectories

      default CompletableFuture<ListDirectoriesResponse> listDirectories(Consumer<ListDirectoriesRequest.Builder> listDirectoriesRequest)

      Lists directories created within an account.


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

      Parameters:
      listDirectoriesRequest - A Consumer that will call methods on ListDirectoriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDirectories operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDirectories

      default CompletableFuture<ListDirectoriesResponse> listDirectories()

      Lists directories created within an account.

      Returns:
      A Java Future containing the result of the ListDirectories operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDirectoriesPaginator

      default ListDirectoriesPublisher listDirectoriesPaginator()

      This is a variant of listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesPublisher publisher = client.listDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesPublisher publisher = client.listDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDirectoriesPaginator

      default ListDirectoriesPublisher listDirectoriesPaginator(ListDirectoriesRequest listDirectoriesRequest)

      This is a variant of listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesPublisher publisher = client.listDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesPublisher publisher = client.listDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest) operation.

      Parameters:
      listDirectoriesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDirectoriesPaginator

      default ListDirectoriesPublisher listDirectoriesPaginator(Consumer<ListDirectoriesRequest.Builder> listDirectoriesRequest)

      This is a variant of listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesPublisher publisher = client.listDirectoriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesPublisher publisher = client.listDirectoriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest) operation.


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

      Parameters:
      listDirectoriesRequest - A Consumer that will call methods on ListDirectoriesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFacetAttributes

      default CompletableFuture<ListFacetAttributesResponse> listFacetAttributes(ListFacetAttributesRequest listFacetAttributesRequest)

      Retrieves attributes attached to the facet.

      Parameters:
      listFacetAttributesRequest -
      Returns:
      A Java Future containing the result of the ListFacetAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFacetAttributes

      default CompletableFuture<ListFacetAttributesResponse> listFacetAttributes(Consumer<ListFacetAttributesRequest.Builder> listFacetAttributesRequest)

      Retrieves attributes attached to the facet.


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

      Parameters:
      listFacetAttributesRequest - A Consumer that will call methods on ListFacetAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFacetAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFacetAttributesPaginator

      default ListFacetAttributesPublisher listFacetAttributesPaginator(ListFacetAttributesRequest listFacetAttributesRequest)

      This is a variant of listFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesPublisher publisher = client.listFacetAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesPublisher publisher = client.listFacetAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest) operation.

      Parameters:
      listFacetAttributesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFacetAttributesPaginator

      default ListFacetAttributesPublisher listFacetAttributesPaginator(Consumer<ListFacetAttributesRequest.Builder> listFacetAttributesRequest)

      This is a variant of listFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesPublisher publisher = client.listFacetAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesPublisher publisher = client.listFacetAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest) operation.


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

      Parameters:
      listFacetAttributesRequest - A Consumer that will call methods on ListFacetAttributesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFacetNames

      default CompletableFuture<ListFacetNamesResponse> listFacetNames(ListFacetNamesRequest listFacetNamesRequest)

      Retrieves the names of facets that exist in a schema.

      Parameters:
      listFacetNamesRequest -
      Returns:
      A Java Future containing the result of the ListFacetNames operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFacetNames

      default CompletableFuture<ListFacetNamesResponse> listFacetNames(Consumer<ListFacetNamesRequest.Builder> listFacetNamesRequest)

      Retrieves the names of facets that exist in a schema.


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

      Parameters:
      listFacetNamesRequest - A Consumer that will call methods on ListFacetNamesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFacetNames operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFacetNamesPaginator

      default ListFacetNamesPublisher listFacetNamesPaginator(ListFacetNamesRequest listFacetNamesRequest)

      This is a variant of listFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesPublisher publisher = client.listFacetNamesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesPublisher publisher = client.listFacetNamesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest) operation.

      Parameters:
      listFacetNamesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFacetNamesPaginator

      default ListFacetNamesPublisher listFacetNamesPaginator(Consumer<ListFacetNamesRequest.Builder> listFacetNamesRequest)

      This is a variant of listFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesPublisher publisher = client.listFacetNamesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesPublisher publisher = client.listFacetNamesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest) operation.


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

      Parameters:
      listFacetNamesRequest - A Consumer that will call methods on ListFacetNamesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIncomingTypedLinks

      default CompletableFuture<ListIncomingTypedLinksResponse> listIncomingTypedLinks(ListIncomingTypedLinksRequest listIncomingTypedLinksRequest)

      Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

      Parameters:
      listIncomingTypedLinksRequest -
      Returns:
      A Java Future containing the result of the ListIncomingTypedLinks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIncomingTypedLinks

      default CompletableFuture<ListIncomingTypedLinksResponse> listIncomingTypedLinks(Consumer<ListIncomingTypedLinksRequest.Builder> listIncomingTypedLinksRequest)

      Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.


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

      Parameters:
      listIncomingTypedLinksRequest - A Consumer that will call methods on ListIncomingTypedLinksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIncomingTypedLinks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndex

      default CompletableFuture<ListIndexResponse> listIndex(ListIndexRequest listIndexRequest)

      Lists objects attached to the specified index.

      Parameters:
      listIndexRequest -
      Returns:
      A Java Future containing the result of the ListIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • NotIndexException Indicates that the requested operation can only operate on index objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndex

      default CompletableFuture<ListIndexResponse> listIndex(Consumer<ListIndexRequest.Builder> listIndexRequest)

      Lists objects attached to the specified index.


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

      Parameters:
      listIndexRequest - A Consumer that will call methods on ListIndexRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • NotIndexException Indicates that the requested operation can only operate on index objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndexPaginator

      default ListIndexPublisher listIndexPaginator(ListIndexRequest listIndexRequest)

      This is a variant of listIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListIndexPublisher publisher = client.listIndexPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListIndexPublisher publisher = client.listIndexPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListIndexResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListIndexResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest) operation.

      Parameters:
      listIndexRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • NotIndexException Indicates that the requested operation can only operate on index objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndexPaginator

      default ListIndexPublisher listIndexPaginator(Consumer<ListIndexRequest.Builder> listIndexRequest)

      This is a variant of listIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListIndexPublisher publisher = client.listIndexPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListIndexPublisher publisher = client.listIndexPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListIndexResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListIndexResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest) operation.


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

      Parameters:
      listIndexRequest - A Consumer that will call methods on ListIndexRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • NotIndexException Indicates that the requested operation can only operate on index objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedSchemaArns

      default CompletableFuture<ListManagedSchemaArnsResponse> listManagedSchemaArns(ListManagedSchemaArnsRequest listManagedSchemaArnsRequest)

      Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

      Parameters:
      listManagedSchemaArnsRequest -
      Returns:
      A Java Future containing the result of the ListManagedSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedSchemaArns

      default CompletableFuture<ListManagedSchemaArnsResponse> listManagedSchemaArns(Consumer<ListManagedSchemaArnsRequest.Builder> listManagedSchemaArnsRequest)

      Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.


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

      Parameters:
      listManagedSchemaArnsRequest - A Consumer that will call methods on ListManagedSchemaArnsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListManagedSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedSchemaArns

      default CompletableFuture<ListManagedSchemaArnsResponse> listManagedSchemaArns()

      Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

      Returns:
      A Java Future containing the result of the ListManagedSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedSchemaArnsPaginator

      default ListManagedSchemaArnsPublisher listManagedSchemaArnsPaginator()

      This is a variant of listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsPublisher publisher = client.listManagedSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsPublisher publisher = client.listManagedSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedSchemaArnsPaginator

      default ListManagedSchemaArnsPublisher listManagedSchemaArnsPaginator(ListManagedSchemaArnsRequest listManagedSchemaArnsRequest)

      This is a variant of listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsPublisher publisher = client.listManagedSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsPublisher publisher = client.listManagedSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest) operation.

      Parameters:
      listManagedSchemaArnsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedSchemaArnsPaginator

      default ListManagedSchemaArnsPublisher listManagedSchemaArnsPaginator(Consumer<ListManagedSchemaArnsRequest.Builder> listManagedSchemaArnsRequest)

      This is a variant of listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsPublisher publisher = client.listManagedSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsPublisher publisher = client.listManagedSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest) operation.


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

      Parameters:
      listManagedSchemaArnsRequest - A Consumer that will call methods on ListManagedSchemaArnsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectAttributes

      default CompletableFuture<ListObjectAttributesResponse> listObjectAttributes(ListObjectAttributesRequest listObjectAttributesRequest)

      Lists all attributes that are associated with an object.

      Parameters:
      listObjectAttributesRequest -
      Returns:
      A Java Future containing the result of the ListObjectAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectAttributes

      default CompletableFuture<ListObjectAttributesResponse> listObjectAttributes(Consumer<ListObjectAttributesRequest.Builder> listObjectAttributesRequest)

      Lists all attributes that are associated with an object.


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

      Parameters:
      listObjectAttributesRequest - A Consumer that will call methods on ListObjectAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListObjectAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectAttributesPaginator

      default ListObjectAttributesPublisher listObjectAttributesPaginator(ListObjectAttributesRequest listObjectAttributesRequest)

      This is a variant of listObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesPublisher publisher = client.listObjectAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesPublisher publisher = client.listObjectAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest) operation.

      Parameters:
      listObjectAttributesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectAttributesPaginator

      default ListObjectAttributesPublisher listObjectAttributesPaginator(Consumer<ListObjectAttributesRequest.Builder> listObjectAttributesRequest)

      This is a variant of listObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesPublisher publisher = client.listObjectAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesPublisher publisher = client.listObjectAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest) operation.


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

      Parameters:
      listObjectAttributesRequest - A Consumer that will call methods on ListObjectAttributesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectChildren

      default CompletableFuture<ListObjectChildrenResponse> listObjectChildren(ListObjectChildrenRequest listObjectChildrenRequest)

      Returns a paginated list of child objects that are associated with a given object.

      Parameters:
      listObjectChildrenRequest -
      Returns:
      A Java Future containing the result of the ListObjectChildren operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • NotNodeException Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectChildren

      default CompletableFuture<ListObjectChildrenResponse> listObjectChildren(Consumer<ListObjectChildrenRequest.Builder> listObjectChildrenRequest)

      Returns a paginated list of child objects that are associated with a given object.


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

      Parameters:
      listObjectChildrenRequest - A Consumer that will call methods on ListObjectChildrenRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListObjectChildren operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • NotNodeException Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectChildrenPaginator

      default ListObjectChildrenPublisher listObjectChildrenPaginator(ListObjectChildrenRequest listObjectChildrenRequest)

      This is a variant of listObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenPublisher publisher = client.listObjectChildrenPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenPublisher publisher = client.listObjectChildrenPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest) operation.

      Parameters:
      listObjectChildrenRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • NotNodeException Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectChildrenPaginator

      default ListObjectChildrenPublisher listObjectChildrenPaginator(Consumer<ListObjectChildrenRequest.Builder> listObjectChildrenRequest)

      This is a variant of listObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenPublisher publisher = client.listObjectChildrenPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenPublisher publisher = client.listObjectChildrenPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest) operation.


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

      Parameters:
      listObjectChildrenRequest - A Consumer that will call methods on ListObjectChildrenRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • NotNodeException Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectParentPaths

      default CompletableFuture<ListObjectParentPathsResponse> listObjectParentPaths(ListObjectParentPathsRequest listObjectParentPathsRequest)

      Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

      Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.

      Parameters:
      listObjectParentPathsRequest -
      Returns:
      A Java Future containing the result of the ListObjectParentPaths operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectParentPaths

      default CompletableFuture<ListObjectParentPathsResponse> listObjectParentPaths(Consumer<ListObjectParentPathsRequest.Builder> listObjectParentPathsRequest)

      Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

      Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.


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

      Parameters:
      listObjectParentPathsRequest - A Consumer that will call methods on ListObjectParentPathsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListObjectParentPaths operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectParentPathsPaginator

      default ListObjectParentPathsPublisher listObjectParentPathsPaginator(ListObjectParentPathsRequest listObjectParentPathsRequest)

      This is a variant of listObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsPublisher publisher = client.listObjectParentPathsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsPublisher publisher = client.listObjectParentPathsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest) operation.

      Parameters:
      listObjectParentPathsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectParentPathsPaginator

      default ListObjectParentPathsPublisher listObjectParentPathsPaginator(Consumer<ListObjectParentPathsRequest.Builder> listObjectParentPathsRequest)

      This is a variant of listObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsPublisher publisher = client.listObjectParentPathsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsPublisher publisher = client.listObjectParentPathsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest) operation.


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

      Parameters:
      listObjectParentPathsRequest - A Consumer that will call methods on ListObjectParentPathsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectParents

      default CompletableFuture<ListObjectParentsResponse> listObjectParents(ListObjectParentsRequest listObjectParentsRequest)

      Lists parent objects that are associated with a given object in pagination fashion.

      Parameters:
      listObjectParentsRequest -
      Returns:
      A Java Future containing the result of the ListObjectParents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • CannotListParentOfRootException Cannot list the parents of a Directory root.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectParents

      default CompletableFuture<ListObjectParentsResponse> listObjectParents(Consumer<ListObjectParentsRequest.Builder> listObjectParentsRequest)

      Lists parent objects that are associated with a given object in pagination fashion.


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

      Parameters:
      listObjectParentsRequest - A Consumer that will call methods on ListObjectParentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListObjectParents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • CannotListParentOfRootException Cannot list the parents of a Directory root.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectParentsPaginator

      default ListObjectParentsPublisher listObjectParentsPaginator(ListObjectParentsRequest listObjectParentsRequest)

      This is a variant of listObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsPublisher publisher = client.listObjectParentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsPublisher publisher = client.listObjectParentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest) operation.

      Parameters:
      listObjectParentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • CannotListParentOfRootException Cannot list the parents of a Directory root.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectParentsPaginator

      default ListObjectParentsPublisher listObjectParentsPaginator(Consumer<ListObjectParentsRequest.Builder> listObjectParentsRequest)

      This is a variant of listObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsPublisher publisher = client.listObjectParentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsPublisher publisher = client.listObjectParentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest) operation.


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

      Parameters:
      listObjectParentsRequest - A Consumer that will call methods on ListObjectParentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • CannotListParentOfRootException Cannot list the parents of a Directory root.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectPolicies

      default CompletableFuture<ListObjectPoliciesResponse> listObjectPolicies(ListObjectPoliciesRequest listObjectPoliciesRequest)

      Returns policies attached to an object in pagination fashion.

      Parameters:
      listObjectPoliciesRequest -
      Returns:
      A Java Future containing the result of the ListObjectPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectPolicies

      default CompletableFuture<ListObjectPoliciesResponse> listObjectPolicies(Consumer<ListObjectPoliciesRequest.Builder> listObjectPoliciesRequest)

      Returns policies attached to an object in pagination fashion.


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

      Parameters:
      listObjectPoliciesRequest - A Consumer that will call methods on ListObjectPoliciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListObjectPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectPoliciesPaginator

      default ListObjectPoliciesPublisher listObjectPoliciesPaginator(ListObjectPoliciesRequest listObjectPoliciesRequest)

      This is a variant of listObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesPublisher publisher = client.listObjectPoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesPublisher publisher = client.listObjectPoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest) operation.

      Parameters:
      listObjectPoliciesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectPoliciesPaginator

      default ListObjectPoliciesPublisher listObjectPoliciesPaginator(Consumer<ListObjectPoliciesRequest.Builder> listObjectPoliciesRequest)

      This is a variant of listObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesPublisher publisher = client.listObjectPoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesPublisher publisher = client.listObjectPoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest) operation.


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

      Parameters:
      listObjectPoliciesRequest - A Consumer that will call methods on ListObjectPoliciesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOutgoingTypedLinks

      default CompletableFuture<ListOutgoingTypedLinksResponse> listOutgoingTypedLinks(ListOutgoingTypedLinksRequest listOutgoingTypedLinksRequest)

      Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

      Parameters:
      listOutgoingTypedLinksRequest -
      Returns:
      A Java Future containing the result of the ListOutgoingTypedLinks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOutgoingTypedLinks

      default CompletableFuture<ListOutgoingTypedLinksResponse> listOutgoingTypedLinks(Consumer<ListOutgoingTypedLinksRequest.Builder> listOutgoingTypedLinksRequest)

      Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.


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

      Parameters:
      listOutgoingTypedLinksRequest - A Consumer that will call methods on ListOutgoingTypedLinksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListOutgoingTypedLinks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPolicyAttachments

      default CompletableFuture<ListPolicyAttachmentsResponse> listPolicyAttachments(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest)

      Returns all of the ObjectIdentifiers to which a given policy is attached.

      Parameters:
      listPolicyAttachmentsRequest -
      Returns:
      A Java Future containing the result of the ListPolicyAttachments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • NotPolicyException Indicates that the requested operation can only operate on policy objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPolicyAttachments

      default CompletableFuture<ListPolicyAttachmentsResponse> listPolicyAttachments(Consumer<ListPolicyAttachmentsRequest.Builder> listPolicyAttachmentsRequest)

      Returns all of the ObjectIdentifiers to which a given policy is attached.


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

      Parameters:
      listPolicyAttachmentsRequest - A Consumer that will call methods on ListPolicyAttachmentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPolicyAttachments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • NotPolicyException Indicates that the requested operation can only operate on policy objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPolicyAttachmentsPaginator

      default ListPolicyAttachmentsPublisher listPolicyAttachmentsPaginator(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest)

      This is a variant of listPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsPublisher publisher = client.listPolicyAttachmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsPublisher publisher = client.listPolicyAttachmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest) operation.

      Parameters:
      listPolicyAttachmentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • NotPolicyException Indicates that the requested operation can only operate on policy objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPolicyAttachmentsPaginator

      default ListPolicyAttachmentsPublisher listPolicyAttachmentsPaginator(Consumer<ListPolicyAttachmentsRequest.Builder> listPolicyAttachmentsRequest)

      This is a variant of listPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsPublisher publisher = client.listPolicyAttachmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsPublisher publisher = client.listPolicyAttachmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest) operation.


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

      Parameters:
      listPolicyAttachmentsRequest - A Consumer that will call methods on ListPolicyAttachmentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • NotPolicyException Indicates that the requested operation can only operate on policy objects.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPublishedSchemaArns

      default CompletableFuture<ListPublishedSchemaArnsResponse> listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest)

      Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

      Parameters:
      listPublishedSchemaArnsRequest -
      Returns:
      A Java Future containing the result of the ListPublishedSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPublishedSchemaArns

      default CompletableFuture<ListPublishedSchemaArnsResponse> listPublishedSchemaArns(Consumer<ListPublishedSchemaArnsRequest.Builder> listPublishedSchemaArnsRequest)

      Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.


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

      Parameters:
      listPublishedSchemaArnsRequest - A Consumer that will call methods on ListPublishedSchemaArnsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPublishedSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPublishedSchemaArns

      default CompletableFuture<ListPublishedSchemaArnsResponse> listPublishedSchemaArns()

      Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

      Returns:
      A Java Future containing the result of the ListPublishedSchemaArns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPublishedSchemaArnsPaginator

      default ListPublishedSchemaArnsPublisher listPublishedSchemaArnsPaginator()

      This is a variant of listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsPublisher publisher = client.listPublishedSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsPublisher publisher = client.listPublishedSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPublishedSchemaArnsPaginator

      default ListPublishedSchemaArnsPublisher listPublishedSchemaArnsPaginator(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest)

      This is a variant of listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsPublisher publisher = client.listPublishedSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsPublisher publisher = client.listPublishedSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest) operation.

      Parameters:
      listPublishedSchemaArnsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPublishedSchemaArnsPaginator

      default ListPublishedSchemaArnsPublisher listPublishedSchemaArnsPaginator(Consumer<ListPublishedSchemaArnsRequest.Builder> listPublishedSchemaArnsRequest)

      This is a variant of listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsPublisher publisher = client.listPublishedSchemaArnsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsPublisher publisher = client.listPublishedSchemaArnsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest) operation.


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

      Parameters:
      listPublishedSchemaArnsRequest - A Consumer that will call methods on ListPublishedSchemaArnsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidTaggingRequestException Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.


      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 Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidTaggingRequestException Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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.clouddirectory.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidTaggingRequestException Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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.clouddirectory.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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidTaggingRequestException Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTypedLinkFacetAttributes

      default CompletableFuture<ListTypedLinkFacetAttributesResponse> listTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest)

      Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.

      Parameters:
      listTypedLinkFacetAttributesRequest -
      Returns:
      A Java Future containing the result of the ListTypedLinkFacetAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTypedLinkFacetAttributes

      default CompletableFuture<ListTypedLinkFacetAttributesResponse> listTypedLinkFacetAttributes(Consumer<ListTypedLinkFacetAttributesRequest.Builder> listTypedLinkFacetAttributesRequest)

      Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.


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

      Parameters:
      listTypedLinkFacetAttributesRequest - A Consumer that will call methods on ListTypedLinkFacetAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTypedLinkFacetAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTypedLinkFacetAttributesPaginator

      default ListTypedLinkFacetAttributesPublisher listTypedLinkFacetAttributesPaginator(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest)

      This is a variant of listTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesPublisher publisher = client.listTypedLinkFacetAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesPublisher publisher = client.listTypedLinkFacetAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest) operation.

      Parameters:
      listTypedLinkFacetAttributesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTypedLinkFacetAttributesPaginator

      default ListTypedLinkFacetAttributesPublisher listTypedLinkFacetAttributesPaginator(Consumer<ListTypedLinkFacetAttributesRequest.Builder> listTypedLinkFacetAttributesRequest)

      This is a variant of listTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesPublisher publisher = client.listTypedLinkFacetAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesPublisher publisher = client.listTypedLinkFacetAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest) operation.


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

      Parameters:
      listTypedLinkFacetAttributesRequest - A Consumer that will call methods on ListTypedLinkFacetAttributesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTypedLinkFacetNames

      default CompletableFuture<ListTypedLinkFacetNamesResponse> listTypedLinkFacetNames(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest)

      Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links.

      Parameters:
      listTypedLinkFacetNamesRequest -
      Returns:
      A Java Future containing the result of the ListTypedLinkFacetNames operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTypedLinkFacetNames

      default CompletableFuture<ListTypedLinkFacetNamesResponse> listTypedLinkFacetNames(Consumer<ListTypedLinkFacetNamesRequest.Builder> listTypedLinkFacetNamesRequest)

      Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links.


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

      Parameters:
      listTypedLinkFacetNamesRequest - A Consumer that will call methods on ListTypedLinkFacetNamesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTypedLinkFacetNames operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTypedLinkFacetNamesPaginator

      default ListTypedLinkFacetNamesPublisher listTypedLinkFacetNamesPaginator(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest)

      This is a variant of listTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesPublisher publisher = client.listTypedLinkFacetNamesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesPublisher publisher = client.listTypedLinkFacetNamesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest) operation.

      Parameters:
      listTypedLinkFacetNamesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTypedLinkFacetNamesPaginator

      default ListTypedLinkFacetNamesPublisher listTypedLinkFacetNamesPaginator(Consumer<ListTypedLinkFacetNamesRequest.Builder> listTypedLinkFacetNamesRequest)

      This is a variant of listTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesPublisher publisher = client.listTypedLinkFacetNamesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesPublisher publisher = client.listTypedLinkFacetNamesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 listTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest) operation.


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

      Parameters:
      listTypedLinkFacetNamesRequest - A Consumer that will call methods on ListTypedLinkFacetNamesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • lookupPolicy

      default CompletableFuture<LookupPolicyResponse> lookupPolicy(LookupPolicyRequest lookupPolicyRequest)

      Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

      Parameters:
      lookupPolicyRequest -
      Returns:
      A Java Future containing the result of the LookupPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • lookupPolicy

      default CompletableFuture<LookupPolicyResponse> lookupPolicy(Consumer<LookupPolicyRequest.Builder> lookupPolicyRequest)

      Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.


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

      Parameters:
      lookupPolicyRequest - A Consumer that will call methods on LookupPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the LookupPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • lookupPolicyPaginator

      default LookupPolicyPublisher lookupPolicyPaginator(LookupPolicyRequest lookupPolicyRequest)

      This is a variant of lookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyPublisher publisher = client.lookupPolicyPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyPublisher publisher = client.lookupPolicyPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.LookupPolicyResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 lookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest) operation.

      Parameters:
      lookupPolicyRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • lookupPolicyPaginator

      default LookupPolicyPublisher lookupPolicyPaginator(Consumer<LookupPolicyRequest.Builder> lookupPolicyRequest)

      This is a variant of lookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyPublisher publisher = client.lookupPolicyPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyPublisher publisher = client.lookupPolicyPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.clouddirectory.model.LookupPolicyResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults 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 lookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest) operation.


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

      Parameters:
      lookupPolicyRequest - A Consumer that will call methods on LookupPolicyRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • InvalidNextTokenException Indicates that the NextToken value is not valid.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • publishSchema

      default CompletableFuture<PublishSchemaResponse> publishSchema(PublishSchemaRequest publishSchemaRequest)

      Publishes a development schema with a major version and a recommended minor version.

      Parameters:
      publishSchemaRequest -
      Returns:
      A Java Future containing the result of the PublishSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • SchemaAlreadyPublishedException Indicates that a schema is already published.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • publishSchema

      default CompletableFuture<PublishSchemaResponse> publishSchema(Consumer<PublishSchemaRequest.Builder> publishSchemaRequest)

      Publishes a development schema with a major version and a recommended minor version.


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

      Parameters:
      publishSchemaRequest - A Consumer that will call methods on PublishSchemaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PublishSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • SchemaAlreadyPublishedException Indicates that a schema is already published.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putSchemaFromJson

      default CompletableFuture<PutSchemaFromJsonResponse> putSchemaFromJson(PutSchemaFromJsonRequest putSchemaFromJsonRequest)

      Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

      Parameters:
      putSchemaFromJsonRequest -
      Returns:
      A Java Future containing the result of the PutSchemaFromJson operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • InvalidSchemaDocException Indicates that the provided SchemaDoc value is not valid.
      • InvalidRuleException Occurs when any of the rule parameter keys or values are invalid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putSchemaFromJson

      default CompletableFuture<PutSchemaFromJsonResponse> putSchemaFromJson(Consumer<PutSchemaFromJsonRequest.Builder> putSchemaFromJsonRequest)

      Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.


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

      Parameters:
      putSchemaFromJsonRequest - A Consumer that will call methods on PutSchemaFromJsonRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutSchemaFromJson operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • InvalidSchemaDocException Indicates that the provided SchemaDoc value is not valid.
      • InvalidRuleException Occurs when any of the rule parameter keys or values are invalid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeFacetFromObject

      default CompletableFuture<RemoveFacetFromObjectResponse> removeFacetFromObject(RemoveFacetFromObjectRequest removeFacetFromObjectRequest)

      Removes the specified facet from the specified object.

      Parameters:
      removeFacetFromObjectRequest -
      Returns:
      A Java Future containing the result of the RemoveFacetFromObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeFacetFromObject

      default CompletableFuture<RemoveFacetFromObjectResponse> removeFacetFromObject(Consumer<RemoveFacetFromObjectRequest.Builder> removeFacetFromObjectRequest)

      Removes the specified facet from the specified object.


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

      Parameters:
      removeFacetFromObjectRequest - A Consumer that will call methods on RemoveFacetFromObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveFacetFromObject operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      An API operation for adding tags to a resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidTaggingRequestException Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      An API operation for adding tags to a resource.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidTaggingRequestException Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      An API operation for removing tags from a resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidTaggingRequestException Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      An API operation for removing tags from a resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidTaggingRequestException Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFacet

      default CompletableFuture<UpdateFacetResponse> updateFacet(UpdateFacetRequest updateFacetRequest)

      Does the following:

      1. Adds new Attributes, Rules, or ObjectTypes.

      2. Updates existing Attributes, Rules, or ObjectTypes.

      3. Deletes existing Attributes, Rules, or ObjectTypes.

      Parameters:
      updateFacetRequest -
      Returns:
      A Java Future containing the result of the UpdateFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • InvalidFacetUpdateException An attempt to modify a Facet resulted in an invalid schema exception.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidRuleException Occurs when any of the rule parameter keys or values are invalid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFacet

      default CompletableFuture<UpdateFacetResponse> updateFacet(Consumer<UpdateFacetRequest.Builder> updateFacetRequest)

      Does the following:

      1. Adds new Attributes, Rules, or ObjectTypes.

      2. Updates existing Attributes, Rules, or ObjectTypes.

      3. Deletes existing Attributes, Rules, or ObjectTypes.


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

      Parameters:
      updateFacetRequest - A Consumer that will call methods on UpdateFacetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • InvalidFacetUpdateException An attempt to modify a Facet resulted in an invalid schema exception.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidRuleException Occurs when any of the rule parameter keys or values are invalid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLinkAttributes

      default CompletableFuture<UpdateLinkAttributesResponse> updateLinkAttributes(UpdateLinkAttributesRequest updateLinkAttributesRequest)

      Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.

      Parameters:
      updateLinkAttributesRequest -
      Returns:
      A Java Future containing the result of the UpdateLinkAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLinkAttributes

      default CompletableFuture<UpdateLinkAttributesResponse> updateLinkAttributes(Consumer<UpdateLinkAttributesRequest.Builder> updateLinkAttributesRequest)

      Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.


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

      Parameters:
      updateLinkAttributesRequest - A Consumer that will call methods on UpdateLinkAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLinkAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateObjectAttributes

      default CompletableFuture<UpdateObjectAttributesResponse> updateObjectAttributes(UpdateObjectAttributesRequest updateObjectAttributesRequest)

      Updates a given object's attributes.

      Parameters:
      updateObjectAttributesRequest -
      Returns:
      A Java Future containing the result of the UpdateObjectAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • LinkNameAlreadyInUseException Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateObjectAttributes

      default CompletableFuture<UpdateObjectAttributesResponse> updateObjectAttributes(Consumer<UpdateObjectAttributesRequest.Builder> updateObjectAttributesRequest)

      Updates a given object's attributes.


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

      Parameters:
      updateObjectAttributesRequest - A Consumer that will call methods on UpdateObjectAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateObjectAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • DirectoryNotEnabledException Operations are only permitted on enabled directories.
      • ResourceNotFoundException The specified resource could not be found.
      • LinkNameAlreadyInUseException Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSchema

      default CompletableFuture<UpdateSchemaResponse> updateSchema(UpdateSchemaRequest updateSchemaRequest)

      Updates the schema name with a new name. Only development schema names can be updated.

      Parameters:
      updateSchemaRequest -
      Returns:
      A Java Future containing the result of the UpdateSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSchema

      default CompletableFuture<UpdateSchemaResponse> updateSchema(Consumer<UpdateSchemaRequest.Builder> updateSchemaRequest)

      Updates the schema name with a new name. Only development schema names can be updated.


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

      Parameters:
      updateSchemaRequest - A Consumer that will call methods on UpdateSchemaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTypedLinkFacet

      default CompletableFuture<UpdateTypedLinkFacetResponse> updateTypedLinkFacet(UpdateTypedLinkFacetRequest updateTypedLinkFacetRequest)

      Updates a TypedLinkFacet. For more information, see Typed Links.

      Parameters:
      updateTypedLinkFacetRequest -
      Returns:
      A Java Future containing the result of the UpdateTypedLinkFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • InvalidFacetUpdateException An attempt to modify a Facet resulted in an invalid schema exception.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidRuleException Occurs when any of the rule parameter keys or values are invalid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTypedLinkFacet

      default CompletableFuture<UpdateTypedLinkFacetResponse> updateTypedLinkFacet(Consumer<UpdateTypedLinkFacetRequest.Builder> updateTypedLinkFacetRequest)

      Updates a TypedLinkFacet. For more information, see Typed Links.


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

      Parameters:
      updateTypedLinkFacetRequest - A Consumer that will call methods on UpdateTypedLinkFacetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTypedLinkFacet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • FacetValidationException The Facet that you provided was not well formed or could not be validated with the schema.
      • InvalidFacetUpdateException An attempt to modify a Facet resulted in an invalid schema exception.
      • ResourceNotFoundException The specified resource could not be found.
      • FacetNotFoundException The specified Facet could not be found.
      • InvalidRuleException Occurs when any of the rule parameter keys or values are invalid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • upgradeAppliedSchema

      default CompletableFuture<UpgradeAppliedSchemaResponse> upgradeAppliedSchema(UpgradeAppliedSchemaRequest upgradeAppliedSchemaRequest)

      Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

      Parameters:
      upgradeAppliedSchemaRequest -
      Returns:
      A Java Future containing the result of the UpgradeAppliedSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • IncompatibleSchemaException Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • SchemaAlreadyExistsException Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • upgradeAppliedSchema

      default CompletableFuture<UpgradeAppliedSchemaResponse> upgradeAppliedSchema(Consumer<UpgradeAppliedSchemaRequest.Builder> upgradeAppliedSchemaRequest)

      Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.


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

      Parameters:
      upgradeAppliedSchemaRequest - A Consumer that will call methods on UpgradeAppliedSchemaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpgradeAppliedSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • IncompatibleSchemaException Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • SchemaAlreadyExistsException Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • upgradePublishedSchema

      default CompletableFuture<UpgradePublishedSchemaResponse> upgradePublishedSchema(UpgradePublishedSchemaRequest upgradePublishedSchemaRequest)

      Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

      Parameters:
      upgradePublishedSchemaRequest -
      Returns:
      A Java Future containing the result of the UpgradePublishedSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • IncompatibleSchemaException Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • upgradePublishedSchema

      default CompletableFuture<UpgradePublishedSchemaResponse> upgradePublishedSchema(Consumer<UpgradePublishedSchemaRequest.Builder> upgradePublishedSchemaRequest)

      Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.


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

      Parameters:
      upgradePublishedSchemaRequest - A Consumer that will call methods on UpgradePublishedSchemaRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpgradePublishedSchema operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServiceException Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
      • InvalidArnException Indicates that the provided ARN value is not valid.
      • RetryableConflictException Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
      • ValidationException Indicates that your request is malformed in some manner. See the exception message.
      • IncompatibleSchemaException Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.
      • AccessDeniedException Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
      • ResourceNotFoundException The specified resource could not be found.
      • InvalidAttachmentException Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.
      • LimitExceededException Indicates that limits are exceeded. See Limits for more information.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudDirectoryException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default CloudDirectoryServiceClientConfiguration 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

    • create

      static CloudDirectoryAsyncClient create()
      Create a CloudDirectoryAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static CloudDirectoryAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a CloudDirectoryAsyncClient.