Package software.amazon.awssdk.services.opensearch

Interface OpenSearchAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface OpenSearchAsyncClient extends AwsClient
Service client for accessing Amazon OpenSearch Service 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.

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.

  • Field Details

  • Method Details

    • acceptInboundConnection

      default CompletableFuture<AcceptInboundConnectionResponse> acceptInboundConnection(AcceptInboundConnectionRequest acceptInboundConnectionRequest)

      Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

      Parameters:
      acceptInboundConnectionRequest - Container for the parameters to the AcceptInboundConnection operation.
      Returns:
      A Java Future containing the result of the AcceptInboundConnection 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 An exception for accessing or deleting a resource that doesn't exist.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • acceptInboundConnection

      default CompletableFuture<AcceptInboundConnectionResponse> acceptInboundConnection(Consumer<AcceptInboundConnectionRequest.Builder> acceptInboundConnectionRequest)

      Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.


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

      Parameters:
      acceptInboundConnectionRequest - A Consumer that will call methods on AcceptInboundConnectionRequest.Builder to create a request. Container for the parameters to the AcceptInboundConnection operation.
      Returns:
      A Java Future containing the result of the AcceptInboundConnection 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 An exception for accessing or deleting a resource that doesn't exist.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • addDataSource

      default CompletableFuture<AddDataSourceResponse> addDataSource(AddDataSourceRequest addDataSourceRequest)

      Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.

      Parameters:
      addDataSourceRequest - Container for the parameters to the AddDataSource operation.
      Returns:
      A Java Future containing the result of the AddDataSource 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • addDataSource

      default CompletableFuture<AddDataSourceResponse> addDataSource(Consumer<AddDataSourceRequest.Builder> addDataSourceRequest)

      Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.


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

      Parameters:
      addDataSourceRequest - A Consumer that will call methods on AddDataSourceRequest.Builder to create a request. Container for the parameters to the AddDataSource operation.
      Returns:
      A Java Future containing the result of the AddDataSource 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • addTags

      default CompletableFuture<AddTagsResponse> addTags(AddTagsRequest addTagsRequest)

      Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.

      Parameters:
      addTagsRequest - Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.
      Returns:
      A Java Future containing the result of the AddTags 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.
      • BaseException An error occurred while processing the request.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • addTags

      default CompletableFuture<AddTagsResponse> addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)

      Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.


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

      Parameters:
      addTagsRequest - A Consumer that will call methods on AddTagsRequest.Builder to create a request. Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.
      Returns:
      A Java Future containing the result of the AddTags 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.
      • BaseException An error occurred while processing the request.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • associatePackage

      default CompletableFuture<AssociatePackageResponse> associatePackage(AssociatePackageRequest associatePackageRequest)

      Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

      Parameters:
      associatePackageRequest - Container for the request parameters to the AssociatePackage operation.
      Returns:
      A Java Future containing the result of the AssociatePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • associatePackage

      default CompletableFuture<AssociatePackageResponse> associatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest)

      Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.


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

      Parameters:
      associatePackageRequest - A Consumer that will call methods on AssociatePackageRequest.Builder to create a request. Container for the request parameters to the AssociatePackage operation.
      Returns:
      A Java Future containing the result of the AssociatePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • authorizeVpcEndpointAccess

      default CompletableFuture<AuthorizeVpcEndpointAccessResponse> authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest)

      Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

      Parameters:
      authorizeVpcEndpointAccessRequest -
      Returns:
      A Java Future containing the result of the AuthorizeVpcEndpointAccess 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • authorizeVpcEndpointAccess

      default CompletableFuture<AuthorizeVpcEndpointAccessResponse> authorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest)

      Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.


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

      Parameters:
      authorizeVpcEndpointAccessRequest - A Consumer that will call methods on AuthorizeVpcEndpointAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AuthorizeVpcEndpointAccess 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • cancelDomainConfigChange

      default CompletableFuture<CancelDomainConfigChangeResponse> cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest)

      Cancels a pending configuration change on an Amazon OpenSearch Service domain.

      Parameters:
      cancelDomainConfigChangeRequest -
      Returns:
      A Java Future containing the result of the CancelDomainConfigChange 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • cancelDomainConfigChange

      default CompletableFuture<CancelDomainConfigChangeResponse> cancelDomainConfigChange(Consumer<CancelDomainConfigChangeRequest.Builder> cancelDomainConfigChangeRequest)

      Cancels a pending configuration change on an Amazon OpenSearch Service domain.


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

      Parameters:
      cancelDomainConfigChangeRequest - A Consumer that will call methods on CancelDomainConfigChangeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelDomainConfigChange 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • cancelServiceSoftwareUpdate

      default CompletableFuture<CancelServiceSoftwareUpdateResponse> cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest)

      Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

      Parameters:
      cancelServiceSoftwareUpdateRequest - Container for the request parameters to cancel a service software update.
      Returns:
      A Java Future containing the result of the CancelServiceSoftwareUpdate 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • cancelServiceSoftwareUpdate

      default CompletableFuture<CancelServiceSoftwareUpdateResponse> cancelServiceSoftwareUpdate(Consumer<CancelServiceSoftwareUpdateRequest.Builder> cancelServiceSoftwareUpdateRequest)

      Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.


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

      Parameters:
      cancelServiceSoftwareUpdateRequest - A Consumer that will call methods on CancelServiceSoftwareUpdateRequest.Builder to create a request. Container for the request parameters to cancel a service software update.
      Returns:
      A Java Future containing the result of the CancelServiceSoftwareUpdate 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createDomain

      default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest)

      Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

      Parameters:
      createDomainRequest -
      Returns:
      A Java Future containing the result of the CreateDomain 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.
      • BaseException An error occurred while processing the request.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ResourceAlreadyExistsException An exception for creating a resource that already exists.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createDomain

      default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)

      Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.


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

      Parameters:
      createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDomain 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.
      • BaseException An error occurred while processing the request.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ResourceAlreadyExistsException An exception for creating a resource that already exists.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createOutboundConnection

      default CompletableFuture<CreateOutboundConnectionResponse> createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest)

      Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

      Parameters:
      createOutboundConnectionRequest - Container for the parameters to the CreateOutboundConnection operation.
      Returns:
      A Java Future containing the result of the CreateOutboundConnection 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.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceAlreadyExistsException An exception for creating a resource that already exists.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createOutboundConnection

      default CompletableFuture<CreateOutboundConnectionResponse> createOutboundConnection(Consumer<CreateOutboundConnectionRequest.Builder> createOutboundConnectionRequest)

      Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.


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

      Parameters:
      createOutboundConnectionRequest - A Consumer that will call methods on CreateOutboundConnectionRequest.Builder to create a request. Container for the parameters to the CreateOutboundConnection operation.
      Returns:
      A Java Future containing the result of the CreateOutboundConnection 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.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceAlreadyExistsException An exception for creating a resource that already exists.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createPackage

      default CompletableFuture<CreatePackageResponse> createPackage(CreatePackageRequest createPackageRequest)

      Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

      Parameters:
      createPackageRequest - Container for request parameters to the CreatePackage operation.
      Returns:
      A Java Future containing the result of the CreatePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
      • ResourceAlreadyExistsException An exception for creating a resource that already exists.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createPackage

      default CompletableFuture<CreatePackageResponse> createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest)

      Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.


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

      Parameters:
      createPackageRequest - A Consumer that will call methods on CreatePackageRequest.Builder to create a request. Container for request parameters to the CreatePackage operation.
      Returns:
      A Java Future containing the result of the CreatePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
      • ResourceAlreadyExistsException An exception for creating a resource that already exists.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createVpcEndpoint

      default CompletableFuture<CreateVpcEndpointResponse> createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)

      Creates an Amazon OpenSearch Service-managed VPC endpoint.

      Parameters:
      createVpcEndpointRequest -
      Returns:
      A Java Future containing the result of the CreateVpcEndpoint 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.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createVpcEndpoint

      default CompletableFuture<CreateVpcEndpointResponse> createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)

      Creates an Amazon OpenSearch Service-managed VPC endpoint.


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

      Parameters:
      createVpcEndpointRequest - A Consumer that will call methods on CreateVpcEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateVpcEndpoint 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.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDataSource

      default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)

      Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

      Parameters:
      deleteDataSourceRequest - Container for the parameters to the DeleteDataSource operation.
      Returns:
      A Java Future containing the result of the DeleteDataSource 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the 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.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDataSource

      default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)

      Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.


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

      Parameters:
      deleteDataSourceRequest - A Consumer that will call methods on DeleteDataSourceRequest.Builder to create a request. Container for the parameters to the DeleteDataSource operation.
      Returns:
      A Java Future containing the result of the DeleteDataSource 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the 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.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDomain

      default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest)

      Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.

      Parameters:
      deleteDomainRequest - Container for the parameters to the DeleteDomain operation.
      Returns:
      A Java Future containing the result of the DeleteDomain 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDomain

      default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)

      Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.


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

      Parameters:
      deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request. Container for the parameters to the DeleteDomain operation.
      Returns:
      A Java Future containing the result of the DeleteDomain 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteInboundConnection

      default CompletableFuture<DeleteInboundConnectionResponse> deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest)

      Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

      Parameters:
      deleteInboundConnectionRequest - Container for the parameters to the DeleteInboundConnection operation.
      Returns:
      A Java Future containing the result of the DeleteInboundConnection 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteInboundConnection

      default CompletableFuture<DeleteInboundConnectionResponse> deleteInboundConnection(Consumer<DeleteInboundConnectionRequest.Builder> deleteInboundConnectionRequest)

      Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.


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

      Parameters:
      deleteInboundConnectionRequest - A Consumer that will call methods on DeleteInboundConnectionRequest.Builder to create a request. Container for the parameters to the DeleteInboundConnection operation.
      Returns:
      A Java Future containing the result of the DeleteInboundConnection 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteOutboundConnection

      default CompletableFuture<DeleteOutboundConnectionResponse> deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest)

      Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

      Parameters:
      deleteOutboundConnectionRequest - Container for the parameters to the DeleteOutboundConnection operation.
      Returns:
      A Java Future containing the result of the DeleteOutboundConnection 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteOutboundConnection

      default CompletableFuture<DeleteOutboundConnectionResponse> deleteOutboundConnection(Consumer<DeleteOutboundConnectionRequest.Builder> deleteOutboundConnectionRequest)

      Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.


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

      Parameters:
      deleteOutboundConnectionRequest - A Consumer that will call methods on DeleteOutboundConnectionRequest.Builder to create a request. Container for the parameters to the DeleteOutboundConnection operation.
      Returns:
      A Java Future containing the result of the DeleteOutboundConnection 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deletePackage

      default CompletableFuture<DeletePackageResponse> deletePackage(DeletePackageRequest deletePackageRequest)

      Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

      Parameters:
      deletePackageRequest - Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.
      Returns:
      A Java Future containing the result of the DeletePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deletePackage

      default CompletableFuture<DeletePackageResponse> deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest)

      Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.


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

      Parameters:
      deletePackageRequest - A Consumer that will call methods on DeletePackageRequest.Builder to create a request. Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.
      Returns:
      A Java Future containing the result of the DeletePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteVpcEndpoint

      default CompletableFuture<DeleteVpcEndpointResponse> deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)

      Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

      Parameters:
      deleteVpcEndpointRequest -
      Returns:
      A Java Future containing the result of the DeleteVpcEndpoint 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteVpcEndpoint

      default CompletableFuture<DeleteVpcEndpointResponse> deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)

      Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.


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

      Parameters:
      deleteVpcEndpointRequest - A Consumer that will call methods on DeleteVpcEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteVpcEndpoint 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomain

      default CompletableFuture<DescribeDomainResponse> describeDomain(DescribeDomainRequest describeDomainRequest)

      Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

      Parameters:
      describeDomainRequest - Container for the parameters to the DescribeDomain operation.
      Returns:
      A Java Future containing the result of the DescribeDomain 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomain

      default CompletableFuture<DescribeDomainResponse> describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest)

      Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.


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

      Parameters:
      describeDomainRequest - A Consumer that will call methods on DescribeDomainRequest.Builder to create a request. Container for the parameters to the DescribeDomain operation.
      Returns:
      A Java Future containing the result of the DescribeDomain 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainAutoTunes

      default CompletableFuture<DescribeDomainAutoTunesResponse> describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)

      Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

      Parameters:
      describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.
      Returns:
      A Java Future containing the result of the DescribeDomainAutoTunes 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainAutoTunes

      default CompletableFuture<DescribeDomainAutoTunesResponse> describeDomainAutoTunes(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)

      Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.


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

      Parameters:
      describeDomainAutoTunesRequest - A Consumer that will call methods on DescribeDomainAutoTunesRequest.Builder to create a request. Container for the parameters to the DescribeDomainAutoTunes operation.
      Returns:
      A Java Future containing the result of the DescribeDomainAutoTunes 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainAutoTunesPaginator

      default DescribeDomainAutoTunesPublisher describeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)

      This is a variant of describeDomainAutoTunes(software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesRequest) 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.opensearch.paginators.DescribeDomainAutoTunesPublisher publisher = client.describeDomainAutoTunesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribeDomainAutoTunesPublisher publisher = client.describeDomainAutoTunesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesResponse 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 describeDomainAutoTunes(software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesRequest) operation.

      Parameters:
      describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainAutoTunesPaginator

      default DescribeDomainAutoTunesPublisher describeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)

      This is a variant of describeDomainAutoTunes(software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesRequest) 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.opensearch.paginators.DescribeDomainAutoTunesPublisher publisher = client.describeDomainAutoTunesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribeDomainAutoTunesPublisher publisher = client.describeDomainAutoTunesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesResponse 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 describeDomainAutoTunes(software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesRequest) operation.


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

      Parameters:
      describeDomainAutoTunesRequest - A Consumer that will call methods on DescribeDomainAutoTunesRequest.Builder to create a request. Container for the parameters to the DescribeDomainAutoTunes 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainChangeProgress

      default CompletableFuture<DescribeDomainChangeProgressResponse> describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest)

      Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

      Parameters:
      describeDomainChangeProgressRequest - Container for the parameters to the DescribeDomainChangeProgress operation.
      Returns:
      A Java Future containing the result of the DescribeDomainChangeProgress 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainChangeProgress

      default CompletableFuture<DescribeDomainChangeProgressResponse> describeDomainChangeProgress(Consumer<DescribeDomainChangeProgressRequest.Builder> describeDomainChangeProgressRequest)

      Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.


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

      Parameters:
      describeDomainChangeProgressRequest - A Consumer that will call methods on DescribeDomainChangeProgressRequest.Builder to create a request. Container for the parameters to the DescribeDomainChangeProgress operation.
      Returns:
      A Java Future containing the result of the DescribeDomainChangeProgress 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainConfig

      default CompletableFuture<DescribeDomainConfigResponse> describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest)

      Returns the configuration of an Amazon OpenSearch Service domain.

      Parameters:
      describeDomainConfigRequest - Container for the parameters to the DescribeDomainConfig operation.
      Returns:
      A Java Future containing the result of the DescribeDomainConfig 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainConfig

      default CompletableFuture<DescribeDomainConfigResponse> describeDomainConfig(Consumer<DescribeDomainConfigRequest.Builder> describeDomainConfigRequest)

      Returns the configuration of an Amazon OpenSearch Service domain.


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

      Parameters:
      describeDomainConfigRequest - A Consumer that will call methods on DescribeDomainConfigRequest.Builder to create a request. Container for the parameters to the DescribeDomainConfig operation.
      Returns:
      A Java Future containing the result of the DescribeDomainConfig 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainHealth

      default CompletableFuture<DescribeDomainHealthResponse> describeDomainHealth(DescribeDomainHealthRequest describeDomainHealthRequest)

      Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

      Parameters:
      describeDomainHealthRequest - Container for the parameters to the DescribeDomainHealth operation.
      Returns:
      A Java Future containing the result of the DescribeDomainHealth 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainHealth

      default CompletableFuture<DescribeDomainHealthResponse> describeDomainHealth(Consumer<DescribeDomainHealthRequest.Builder> describeDomainHealthRequest)

      Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.


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

      Parameters:
      describeDomainHealthRequest - A Consumer that will call methods on DescribeDomainHealthRequest.Builder to create a request. Container for the parameters to the DescribeDomainHealth operation.
      Returns:
      A Java Future containing the result of the DescribeDomainHealth 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainNodes

      default CompletableFuture<DescribeDomainNodesResponse> describeDomainNodes(DescribeDomainNodesRequest describeDomainNodesRequest)

      Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

      Parameters:
      describeDomainNodesRequest - Container for the parameters to the DescribeDomainNodes operation.
      Returns:
      A Java Future containing the result of the DescribeDomainNodes 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the 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.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainNodes

      default CompletableFuture<DescribeDomainNodesResponse> describeDomainNodes(Consumer<DescribeDomainNodesRequest.Builder> describeDomainNodesRequest)

      Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.


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

      Parameters:
      describeDomainNodesRequest - A Consumer that will call methods on DescribeDomainNodesRequest.Builder to create a request. Container for the parameters to the DescribeDomainNodes operation.
      Returns:
      A Java Future containing the result of the DescribeDomainNodes 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the 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.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomains

      default CompletableFuture<DescribeDomainsResponse> describeDomains(DescribeDomainsRequest describeDomainsRequest)

      Returns domain configuration information about the specified Amazon OpenSearch Service domains.

      Parameters:
      describeDomainsRequest - Container for the parameters to the DescribeDomains operation.
      Returns:
      A Java Future containing the result of the DescribeDomains 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomains

      default CompletableFuture<DescribeDomainsResponse> describeDomains(Consumer<DescribeDomainsRequest.Builder> describeDomainsRequest)

      Returns domain configuration information about the specified Amazon OpenSearch Service domains.


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

      Parameters:
      describeDomainsRequest - A Consumer that will call methods on DescribeDomainsRequest.Builder to create a request. Container for the parameters to the DescribeDomains operation.
      Returns:
      A Java Future containing the result of the DescribeDomains 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDryRunProgress

      default CompletableFuture<DescribeDryRunProgressResponse> describeDryRunProgress(DescribeDryRunProgressRequest describeDryRunProgressRequest)

      Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

      Parameters:
      describeDryRunProgressRequest -
      Returns:
      A Java Future containing the result of the DescribeDryRunProgress 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDryRunProgress

      default CompletableFuture<DescribeDryRunProgressResponse> describeDryRunProgress(Consumer<DescribeDryRunProgressRequest.Builder> describeDryRunProgressRequest)

      Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.


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

      Parameters:
      describeDryRunProgressRequest - A Consumer that will call methods on DescribeDryRunProgressRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDryRunProgress 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeInboundConnections

      default CompletableFuture<DescribeInboundConnectionsResponse> describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest)

      Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

      Parameters:
      describeInboundConnectionsRequest - Container for the parameters to the DescribeInboundConnections operation.
      Returns:
      A Java Future containing the result of the DescribeInboundConnections 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.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeInboundConnections

      default CompletableFuture<DescribeInboundConnectionsResponse> describeInboundConnections(Consumer<DescribeInboundConnectionsRequest.Builder> describeInboundConnectionsRequest)

      Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.


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

      Parameters:
      describeInboundConnectionsRequest - A Consumer that will call methods on DescribeInboundConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeInboundConnections operation.
      Returns:
      A Java Future containing the result of the DescribeInboundConnections 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.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeInboundConnectionsPaginator

      default DescribeInboundConnectionsPublisher describeInboundConnectionsPaginator(DescribeInboundConnectionsRequest describeInboundConnectionsRequest)

      This is a variant of describeInboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsRequest) 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.opensearch.paginators.DescribeInboundConnectionsPublisher publisher = client.describeInboundConnectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribeInboundConnectionsPublisher publisher = client.describeInboundConnectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsResponse 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 describeInboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsRequest) operation.

      Parameters:
      describeInboundConnectionsRequest - Container for the parameters to the DescribeInboundConnections 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.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeInboundConnectionsPaginator

      default DescribeInboundConnectionsPublisher describeInboundConnectionsPaginator(Consumer<DescribeInboundConnectionsRequest.Builder> describeInboundConnectionsRequest)

      This is a variant of describeInboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsRequest) 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.opensearch.paginators.DescribeInboundConnectionsPublisher publisher = client.describeInboundConnectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribeInboundConnectionsPublisher publisher = client.describeInboundConnectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsResponse 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 describeInboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsRequest) operation.


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

      Parameters:
      describeInboundConnectionsRequest - A Consumer that will call methods on DescribeInboundConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeInboundConnections 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.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeInstanceTypeLimits

      default CompletableFuture<DescribeInstanceTypeLimitsResponse> describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest)

      Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

      Parameters:
      describeInstanceTypeLimitsRequest - Container for the parameters to the DescribeInstanceTypeLimits operation.
      Returns:
      A Java Future containing the result of the DescribeInstanceTypeLimits 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeInstanceTypeLimits

      default CompletableFuture<DescribeInstanceTypeLimitsResponse> describeInstanceTypeLimits(Consumer<DescribeInstanceTypeLimitsRequest.Builder> describeInstanceTypeLimitsRequest)

      Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.


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

      Parameters:
      describeInstanceTypeLimitsRequest - A Consumer that will call methods on DescribeInstanceTypeLimitsRequest.Builder to create a request. Container for the parameters to the DescribeInstanceTypeLimits operation.
      Returns:
      A Java Future containing the result of the DescribeInstanceTypeLimits 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeOutboundConnections

      default CompletableFuture<DescribeOutboundConnectionsResponse> describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest)

      Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

      Parameters:
      describeOutboundConnectionsRequest - Container for the parameters to the DescribeOutboundConnections operation.
      Returns:
      A Java Future containing the result of the DescribeOutboundConnections 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.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeOutboundConnections

      default CompletableFuture<DescribeOutboundConnectionsResponse> describeOutboundConnections(Consumer<DescribeOutboundConnectionsRequest.Builder> describeOutboundConnectionsRequest)

      Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.


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

      Parameters:
      describeOutboundConnectionsRequest - A Consumer that will call methods on DescribeOutboundConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeOutboundConnections operation.
      Returns:
      A Java Future containing the result of the DescribeOutboundConnections 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.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeOutboundConnectionsPaginator

      default DescribeOutboundConnectionsPublisher describeOutboundConnectionsPaginator(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest)

      This is a variant of describeOutboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsRequest) 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.opensearch.paginators.DescribeOutboundConnectionsPublisher publisher = client.describeOutboundConnectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribeOutboundConnectionsPublisher publisher = client.describeOutboundConnectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsResponse 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 describeOutboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsRequest) operation.

      Parameters:
      describeOutboundConnectionsRequest - Container for the parameters to the DescribeOutboundConnections 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.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeOutboundConnectionsPaginator

      default DescribeOutboundConnectionsPublisher describeOutboundConnectionsPaginator(Consumer<DescribeOutboundConnectionsRequest.Builder> describeOutboundConnectionsRequest)

      This is a variant of describeOutboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsRequest) 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.opensearch.paginators.DescribeOutboundConnectionsPublisher publisher = client.describeOutboundConnectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribeOutboundConnectionsPublisher publisher = client.describeOutboundConnectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsResponse 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 describeOutboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsRequest) operation.


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

      Parameters:
      describeOutboundConnectionsRequest - A Consumer that will call methods on DescribeOutboundConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeOutboundConnections 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.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describePackages

      default CompletableFuture<DescribePackagesResponse> describePackages(DescribePackagesRequest describePackagesRequest)

      Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

      Parameters:
      describePackagesRequest - Container for the request parameters to the DescribePackage operation.
      Returns:
      A Java Future containing the result of the DescribePackages 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describePackages

      default CompletableFuture<DescribePackagesResponse> describePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)

      Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.


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

      Parameters:
      describePackagesRequest - A Consumer that will call methods on DescribePackagesRequest.Builder to create a request. Container for the request parameters to the DescribePackage operation.
      Returns:
      A Java Future containing the result of the DescribePackages 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describePackagesPaginator

      default DescribePackagesPublisher describePackagesPaginator(DescribePackagesRequest describePackagesRequest)

      This is a variant of describePackages(software.amazon.awssdk.services.opensearch.model.DescribePackagesRequest) 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.opensearch.paginators.DescribePackagesPublisher publisher = client.describePackagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribePackagesPublisher publisher = client.describePackagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribePackagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribePackagesResponse 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 describePackages(software.amazon.awssdk.services.opensearch.model.DescribePackagesRequest) operation.

      Parameters:
      describePackagesRequest - Container for the request parameters to the DescribePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describePackagesPaginator

      default DescribePackagesPublisher describePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)

      This is a variant of describePackages(software.amazon.awssdk.services.opensearch.model.DescribePackagesRequest) 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.opensearch.paginators.DescribePackagesPublisher publisher = client.describePackagesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribePackagesPublisher publisher = client.describePackagesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribePackagesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribePackagesResponse 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 describePackages(software.amazon.awssdk.services.opensearch.model.DescribePackagesRequest) operation.


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

      Parameters:
      describePackagesRequest - A Consumer that will call methods on DescribePackagesRequest.Builder to create a request. Container for the request parameters to the DescribePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeReservedInstanceOfferings

      default CompletableFuture<DescribeReservedInstanceOfferingsResponse> describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest)

      Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

      Parameters:
      describeReservedInstanceOfferingsRequest - Container for the request parameters to a DescribeReservedInstanceOfferings operation.
      Returns:
      A Java Future containing the result of the DescribeReservedInstanceOfferings 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 An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeReservedInstanceOfferings

      default CompletableFuture<DescribeReservedInstanceOfferingsResponse> describeReservedInstanceOfferings(Consumer<DescribeReservedInstanceOfferingsRequest.Builder> describeReservedInstanceOfferingsRequest)

      Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.


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

      Parameters:
      describeReservedInstanceOfferingsRequest - A Consumer that will call methods on DescribeReservedInstanceOfferingsRequest.Builder to create a request. Container for the request parameters to a DescribeReservedInstanceOfferings operation.
      Returns:
      A Java Future containing the result of the DescribeReservedInstanceOfferings 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 An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeReservedInstanceOfferingsPaginator

      default DescribeReservedInstanceOfferingsPublisher describeReservedInstanceOfferingsPaginator(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest)

      This is a variant of describeReservedInstanceOfferings(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsRequest) 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.opensearch.paginators.DescribeReservedInstanceOfferingsPublisher publisher = client.describeReservedInstanceOfferingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstanceOfferingsPublisher publisher = client.describeReservedInstanceOfferingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsResponse 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 describeReservedInstanceOfferings(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsRequest) operation.

      Parameters:
      describeReservedInstanceOfferingsRequest - Container for the request parameters to a DescribeReservedInstanceOfferings 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.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeReservedInstanceOfferingsPaginator

      default DescribeReservedInstanceOfferingsPublisher describeReservedInstanceOfferingsPaginator(Consumer<DescribeReservedInstanceOfferingsRequest.Builder> describeReservedInstanceOfferingsRequest)

      This is a variant of describeReservedInstanceOfferings(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsRequest) 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.opensearch.paginators.DescribeReservedInstanceOfferingsPublisher publisher = client.describeReservedInstanceOfferingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstanceOfferingsPublisher publisher = client.describeReservedInstanceOfferingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsResponse 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 describeReservedInstanceOfferings(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsRequest) operation.


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

      Parameters:
      describeReservedInstanceOfferingsRequest - A Consumer that will call methods on DescribeReservedInstanceOfferingsRequest.Builder to create a request. Container for the request parameters to a DescribeReservedInstanceOfferings 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.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeReservedInstances

      default CompletableFuture<DescribeReservedInstancesResponse> describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest)

      Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

      Parameters:
      describeReservedInstancesRequest - Container for the request parameters to the DescribeReservedInstances operation.
      Returns:
      A Java Future containing the result of the DescribeReservedInstances 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 An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeReservedInstances

      default CompletableFuture<DescribeReservedInstancesResponse> describeReservedInstances(Consumer<DescribeReservedInstancesRequest.Builder> describeReservedInstancesRequest)

      Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.


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

      Parameters:
      describeReservedInstancesRequest - A Consumer that will call methods on DescribeReservedInstancesRequest.Builder to create a request. Container for the request parameters to the DescribeReservedInstances operation.
      Returns:
      A Java Future containing the result of the DescribeReservedInstances 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 An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeReservedInstancesPaginator

      default DescribeReservedInstancesPublisher describeReservedInstancesPaginator(DescribeReservedInstancesRequest describeReservedInstancesRequest)

      This is a variant of describeReservedInstances(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesRequest) 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.opensearch.paginators.DescribeReservedInstancesPublisher publisher = client.describeReservedInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstancesPublisher publisher = client.describeReservedInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesResponse 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 describeReservedInstances(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesRequest) operation.

      Parameters:
      describeReservedInstancesRequest - Container for the request parameters to the DescribeReservedInstances 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.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeReservedInstancesPaginator

      default DescribeReservedInstancesPublisher describeReservedInstancesPaginator(Consumer<DescribeReservedInstancesRequest.Builder> describeReservedInstancesRequest)

      This is a variant of describeReservedInstances(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesRequest) 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.opensearch.paginators.DescribeReservedInstancesPublisher publisher = client.describeReservedInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstancesPublisher publisher = client.describeReservedInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesResponse 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 describeReservedInstances(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesRequest) operation.


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

      Parameters:
      describeReservedInstancesRequest - A Consumer that will call methods on DescribeReservedInstancesRequest.Builder to create a request. Container for the request parameters to the DescribeReservedInstances 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.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeVpcEndpoints

      default CompletableFuture<DescribeVpcEndpointsResponse> describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest)

      Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

      Parameters:
      describeVpcEndpointsRequest -
      Returns:
      A Java Future containing the result of the DescribeVpcEndpoints 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.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeVpcEndpoints

      default CompletableFuture<DescribeVpcEndpointsResponse> describeVpcEndpoints(Consumer<DescribeVpcEndpointsRequest.Builder> describeVpcEndpointsRequest)

      Describes one or more Amazon OpenSearch Service-managed VPC endpoints.


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

      Parameters:
      describeVpcEndpointsRequest - A Consumer that will call methods on DescribeVpcEndpointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeVpcEndpoints 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.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • dissociatePackage

      default CompletableFuture<DissociatePackageResponse> dissociatePackage(DissociatePackageRequest dissociatePackageRequest)

      Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

      Parameters:
      dissociatePackageRequest - Container for the request parameters to the DissociatePackage operation.
      Returns:
      A Java Future containing the result of the DissociatePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • dissociatePackage

      default CompletableFuture<DissociatePackageResponse> dissociatePackage(Consumer<DissociatePackageRequest.Builder> dissociatePackageRequest)

      Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.


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

      Parameters:
      dissociatePackageRequest - A Consumer that will call methods on DissociatePackageRequest.Builder to create a request. Container for the request parameters to the DissociatePackage operation.
      Returns:
      A Java Future containing the result of the DissociatePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getCompatibleVersions

      default CompletableFuture<GetCompatibleVersionsResponse> getCompatibleVersions(GetCompatibleVersionsRequest getCompatibleVersionsRequest)

      Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

      Parameters:
      getCompatibleVersionsRequest - Container for the request parameters to GetCompatibleVersions operation.
      Returns:
      A Java Future containing the result of the GetCompatibleVersions 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getCompatibleVersions

      default CompletableFuture<GetCompatibleVersionsResponse> getCompatibleVersions(Consumer<GetCompatibleVersionsRequest.Builder> getCompatibleVersionsRequest)

      Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.


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

      Parameters:
      getCompatibleVersionsRequest - A Consumer that will call methods on GetCompatibleVersionsRequest.Builder to create a request. Container for the request parameters to GetCompatibleVersions operation.
      Returns:
      A Java Future containing the result of the GetCompatibleVersions 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDataSource

      default CompletableFuture<GetDataSourceResponse> getDataSource(GetDataSourceRequest getDataSourceRequest)

      Retrieves information about a direct query data source.

      Parameters:
      getDataSourceRequest - Container for the parameters to the GetDataSource operation.
      Returns:
      A Java Future containing the result of the GetDataSource 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the 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.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDataSource

      default CompletableFuture<GetDataSourceResponse> getDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest)

      Retrieves information about a direct query data source.


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

      Parameters:
      getDataSourceRequest - A Consumer that will call methods on GetDataSourceRequest.Builder to create a request. Container for the parameters to the GetDataSource operation.
      Returns:
      A Java Future containing the result of the GetDataSource 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the 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.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDomainMaintenanceStatus

      default CompletableFuture<GetDomainMaintenanceStatusResponse> getDomainMaintenanceStatus(GetDomainMaintenanceStatusRequest getDomainMaintenanceStatusRequest)

      The status of the maintenance action.

      Parameters:
      getDomainMaintenanceStatusRequest - Container for the parameters to the GetDomainMaintenanceStatus operation.
      Returns:
      A Java Future containing the result of the GetDomainMaintenanceStatus 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDomainMaintenanceStatus

      default CompletableFuture<GetDomainMaintenanceStatusResponse> getDomainMaintenanceStatus(Consumer<GetDomainMaintenanceStatusRequest.Builder> getDomainMaintenanceStatusRequest)

      The status of the maintenance action.


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

      Parameters:
      getDomainMaintenanceStatusRequest - A Consumer that will call methods on GetDomainMaintenanceStatusRequest.Builder to create a request. Container for the parameters to the GetDomainMaintenanceStatus operation.
      Returns:
      A Java Future containing the result of the GetDomainMaintenanceStatus 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getPackageVersionHistory

      default CompletableFuture<GetPackageVersionHistoryResponse> getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)

      Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.

      Parameters:
      getPackageVersionHistoryRequest - Container for the request parameters to the GetPackageVersionHistory operation.
      Returns:
      A Java Future containing the result of the GetPackageVersionHistory 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getPackageVersionHistory

      default CompletableFuture<GetPackageVersionHistoryResponse> getPackageVersionHistory(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)

      Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.


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

      Parameters:
      getPackageVersionHistoryRequest - A Consumer that will call methods on GetPackageVersionHistoryRequest.Builder to create a request. Container for the request parameters to the GetPackageVersionHistory operation.
      Returns:
      A Java Future containing the result of the GetPackageVersionHistory 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getPackageVersionHistoryPaginator

      default GetPackageVersionHistoryPublisher getPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)

      This is a variant of getPackageVersionHistory(software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryRequest) 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.opensearch.paginators.GetPackageVersionHistoryPublisher publisher = client.getPackageVersionHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.GetPackageVersionHistoryPublisher publisher = client.getPackageVersionHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryResponse 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 getPackageVersionHistory(software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryRequest) operation.

      Parameters:
      getPackageVersionHistoryRequest - Container for the request parameters to the GetPackageVersionHistory 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getPackageVersionHistoryPaginator

      default GetPackageVersionHistoryPublisher getPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)

      This is a variant of getPackageVersionHistory(software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryRequest) 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.opensearch.paginators.GetPackageVersionHistoryPublisher publisher = client.getPackageVersionHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.GetPackageVersionHistoryPublisher publisher = client.getPackageVersionHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryResponse 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 getPackageVersionHistory(software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryRequest) operation.


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

      Parameters:
      getPackageVersionHistoryRequest - A Consumer that will call methods on GetPackageVersionHistoryRequest.Builder to create a request. Container for the request parameters to the GetPackageVersionHistory 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUpgradeHistory

      default CompletableFuture<GetUpgradeHistoryResponse> getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)

      Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

      Parameters:
      getUpgradeHistoryRequest - Container for the request parameters to the GetUpgradeHistory operation.
      Returns:
      A Java Future containing the result of the GetUpgradeHistory 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUpgradeHistory

      default CompletableFuture<GetUpgradeHistoryResponse> getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)

      Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.


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

      Parameters:
      getUpgradeHistoryRequest - A Consumer that will call methods on GetUpgradeHistoryRequest.Builder to create a request. Container for the request parameters to the GetUpgradeHistory operation.
      Returns:
      A Java Future containing the result of the GetUpgradeHistory 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUpgradeHistoryPaginator

      default GetUpgradeHistoryPublisher getUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest)

      This is a variant of getUpgradeHistory(software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryRequest) 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.opensearch.paginators.GetUpgradeHistoryPublisher publisher = client.getUpgradeHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.GetUpgradeHistoryPublisher publisher = client.getUpgradeHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryResponse 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 getUpgradeHistory(software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryRequest) operation.

      Parameters:
      getUpgradeHistoryRequest - Container for the request parameters to the GetUpgradeHistory 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUpgradeHistoryPaginator

      default GetUpgradeHistoryPublisher getUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)

      This is a variant of getUpgradeHistory(software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryRequest) 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.opensearch.paginators.GetUpgradeHistoryPublisher publisher = client.getUpgradeHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.GetUpgradeHistoryPublisher publisher = client.getUpgradeHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryResponse 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 getUpgradeHistory(software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryRequest) operation.


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

      Parameters:
      getUpgradeHistoryRequest - A Consumer that will call methods on GetUpgradeHistoryRequest.Builder to create a request. Container for the request parameters to the GetUpgradeHistory 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUpgradeStatus

      default CompletableFuture<GetUpgradeStatusResponse> getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)

      Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

      Parameters:
      getUpgradeStatusRequest - Container for the request parameters to the GetUpgradeStatus operation.
      Returns:
      A Java Future containing the result of the GetUpgradeStatus 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUpgradeStatus

      default CompletableFuture<GetUpgradeStatusResponse> getUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest)

      Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.


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

      Parameters:
      getUpgradeStatusRequest - A Consumer that will call methods on GetUpgradeStatusRequest.Builder to create a request. Container for the request parameters to the GetUpgradeStatus operation.
      Returns:
      A Java Future containing the result of the GetUpgradeStatus 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDataSources

      default CompletableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest listDataSourcesRequest)

      Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

      Parameters:
      listDataSourcesRequest - Container for the parameters to the ListDataSources operation.
      Returns:
      A Java Future containing the result of the ListDataSources 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the 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.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDataSources

      default CompletableFuture<ListDataSourcesResponse> listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)

      Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.


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

      Parameters:
      listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request. Container for the parameters to the ListDataSources operation.
      Returns:
      A Java Future containing the result of the ListDataSources 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the 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.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainMaintenances

      default CompletableFuture<ListDomainMaintenancesResponse> listDomainMaintenances(ListDomainMaintenancesRequest listDomainMaintenancesRequest)

      A list of maintenance actions for the domain.

      Parameters:
      listDomainMaintenancesRequest - Container for the parameters to the ListDomainMaintenances operation.
      Returns:
      A Java Future containing the result of the ListDomainMaintenances 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainMaintenances

      default CompletableFuture<ListDomainMaintenancesResponse> listDomainMaintenances(Consumer<ListDomainMaintenancesRequest.Builder> listDomainMaintenancesRequest)

      A list of maintenance actions for the domain.


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

      Parameters:
      listDomainMaintenancesRequest - A Consumer that will call methods on ListDomainMaintenancesRequest.Builder to create a request. Container for the parameters to the ListDomainMaintenances operation.
      Returns:
      A Java Future containing the result of the ListDomainMaintenances 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainMaintenancesPaginator

      default ListDomainMaintenancesPublisher listDomainMaintenancesPaginator(ListDomainMaintenancesRequest listDomainMaintenancesRequest)

      This is a variant of listDomainMaintenances(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesRequest) 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.opensearch.paginators.ListDomainMaintenancesPublisher publisher = client.listDomainMaintenancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListDomainMaintenancesPublisher publisher = client.listDomainMaintenancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesResponse 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 listDomainMaintenances(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesRequest) operation.

      Parameters:
      listDomainMaintenancesRequest - Container for the parameters to the ListDomainMaintenances 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainMaintenancesPaginator

      default ListDomainMaintenancesPublisher listDomainMaintenancesPaginator(Consumer<ListDomainMaintenancesRequest.Builder> listDomainMaintenancesRequest)

      This is a variant of listDomainMaintenances(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesRequest) 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.opensearch.paginators.ListDomainMaintenancesPublisher publisher = client.listDomainMaintenancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListDomainMaintenancesPublisher publisher = client.listDomainMaintenancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesResponse 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 listDomainMaintenances(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesRequest) operation.


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

      Parameters:
      listDomainMaintenancesRequest - A Consumer that will call methods on ListDomainMaintenancesRequest.Builder to create a request. Container for the parameters to the ListDomainMaintenances 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainNames

      default CompletableFuture<ListDomainNamesResponse> listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

      Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

      Parameters:
      listDomainNamesRequest - Container for the parameters to the ListDomainNames operation.
      Returns:
      A Java Future containing the result of the ListDomainNames 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.
      • BaseException An error occurred while processing the request.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainNames

      default CompletableFuture<ListDomainNamesResponse> listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest)

      Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.


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

      Parameters:
      listDomainNamesRequest - A Consumer that will call methods on ListDomainNamesRequest.Builder to create a request. Container for the parameters to the ListDomainNames operation.
      Returns:
      A Java Future containing the result of the ListDomainNames 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.
      • BaseException An error occurred while processing the request.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainsForPackage

      default CompletableFuture<ListDomainsForPackageResponse> listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest)

      Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

      Parameters:
      listDomainsForPackageRequest - Container for the request parameters to the ListDomainsForPackage operation.
      Returns:
      A Java Future containing the result of the ListDomainsForPackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainsForPackage

      default CompletableFuture<ListDomainsForPackageResponse> listDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)

      Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.


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

      Parameters:
      listDomainsForPackageRequest - A Consumer that will call methods on ListDomainsForPackageRequest.Builder to create a request. Container for the request parameters to the ListDomainsForPackage operation.
      Returns:
      A Java Future containing the result of the ListDomainsForPackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainsForPackagePaginator

      default ListDomainsForPackagePublisher listDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest)

      This is a variant of listDomainsForPackage(software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageRequest) 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.opensearch.paginators.ListDomainsForPackagePublisher publisher = client.listDomainsForPackagePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListDomainsForPackagePublisher publisher = client.listDomainsForPackagePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageResponse 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 listDomainsForPackage(software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageRequest) operation.

      Parameters:
      listDomainsForPackageRequest - Container for the request parameters to the ListDomainsForPackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainsForPackagePaginator

      default ListDomainsForPackagePublisher listDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)

      This is a variant of listDomainsForPackage(software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageRequest) 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.opensearch.paginators.ListDomainsForPackagePublisher publisher = client.listDomainsForPackagePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListDomainsForPackagePublisher publisher = client.listDomainsForPackagePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageResponse 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 listDomainsForPackage(software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageRequest) operation.


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

      Parameters:
      listDomainsForPackageRequest - A Consumer that will call methods on ListDomainsForPackageRequest.Builder to create a request. Container for the request parameters to the ListDomainsForPackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listInstanceTypeDetails

      default CompletableFuture<ListInstanceTypeDetailsResponse> listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest)

      Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

      Parameters:
      listInstanceTypeDetailsRequest -
      Returns:
      A Java Future containing the result of the ListInstanceTypeDetails 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listInstanceTypeDetails

      default CompletableFuture<ListInstanceTypeDetailsResponse> listInstanceTypeDetails(Consumer<ListInstanceTypeDetailsRequest.Builder> listInstanceTypeDetailsRequest)

      Lists all instance types and available features for a given OpenSearch or Elasticsearch version.


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

      Parameters:
      listInstanceTypeDetailsRequest - A Consumer that will call methods on ListInstanceTypeDetailsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInstanceTypeDetails 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listInstanceTypeDetailsPaginator

      default ListInstanceTypeDetailsPublisher listInstanceTypeDetailsPaginator(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest)

      This is a variant of listInstanceTypeDetails(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsRequest) 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.opensearch.paginators.ListInstanceTypeDetailsPublisher publisher = client.listInstanceTypeDetailsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListInstanceTypeDetailsPublisher publisher = client.listInstanceTypeDetailsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsResponse 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 listInstanceTypeDetails(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsRequest) operation.

      Parameters:
      listInstanceTypeDetailsRequest -
      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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listInstanceTypeDetailsPaginator

      default ListInstanceTypeDetailsPublisher listInstanceTypeDetailsPaginator(Consumer<ListInstanceTypeDetailsRequest.Builder> listInstanceTypeDetailsRequest)

      This is a variant of listInstanceTypeDetails(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsRequest) 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.opensearch.paginators.ListInstanceTypeDetailsPublisher publisher = client.listInstanceTypeDetailsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListInstanceTypeDetailsPublisher publisher = client.listInstanceTypeDetailsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsResponse 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 listInstanceTypeDetails(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsRequest) operation.


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

      Parameters:
      listInstanceTypeDetailsRequest - A Consumer that will call methods on ListInstanceTypeDetailsRequest.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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listPackagesForDomain

      default CompletableFuture<ListPackagesForDomainResponse> listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest)

      Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

      Parameters:
      listPackagesForDomainRequest - Container for the request parameters to the ListPackagesForDomain operation.
      Returns:
      A Java Future containing the result of the ListPackagesForDomain 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listPackagesForDomain

      default CompletableFuture<ListPackagesForDomainResponse> listPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)

      Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.


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

      Parameters:
      listPackagesForDomainRequest - A Consumer that will call methods on ListPackagesForDomainRequest.Builder to create a request. Container for the request parameters to the ListPackagesForDomain operation.
      Returns:
      A Java Future containing the result of the ListPackagesForDomain 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listPackagesForDomainPaginator

      default ListPackagesForDomainPublisher listPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest)

      This is a variant of listPackagesForDomain(software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainRequest) 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.opensearch.paginators.ListPackagesForDomainPublisher publisher = client.listPackagesForDomainPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListPackagesForDomainPublisher publisher = client.listPackagesForDomainPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainResponse 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 listPackagesForDomain(software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainRequest) operation.

      Parameters:
      listPackagesForDomainRequest - Container for the request parameters to the ListPackagesForDomain 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listPackagesForDomainPaginator

      default ListPackagesForDomainPublisher listPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)

      This is a variant of listPackagesForDomain(software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainRequest) 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.opensearch.paginators.ListPackagesForDomainPublisher publisher = client.listPackagesForDomainPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListPackagesForDomainPublisher publisher = client.listPackagesForDomainPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainResponse 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 listPackagesForDomain(software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainRequest) operation.


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

      Parameters:
      listPackagesForDomainRequest - A Consumer that will call methods on ListPackagesForDomainRequest.Builder to create a request. Container for the request parameters to the ListPackagesForDomain 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listScheduledActions

      default CompletableFuture<ListScheduledActionsResponse> listScheduledActions(ListScheduledActionsRequest listScheduledActionsRequest)

      Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

      Parameters:
      listScheduledActionsRequest -
      Returns:
      A Java Future containing the result of the ListScheduledActions 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listScheduledActions

      default CompletableFuture<ListScheduledActionsResponse> listScheduledActions(Consumer<ListScheduledActionsRequest.Builder> listScheduledActionsRequest)

      Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.


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

      Parameters:
      listScheduledActionsRequest - A Consumer that will call methods on ListScheduledActionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListScheduledActions 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listScheduledActionsPaginator

      default ListScheduledActionsPublisher listScheduledActionsPaginator(ListScheduledActionsRequest listScheduledActionsRequest)

      This is a variant of listScheduledActions(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsRequest) 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.opensearch.paginators.ListScheduledActionsPublisher publisher = client.listScheduledActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListScheduledActionsPublisher publisher = client.listScheduledActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListScheduledActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsResponse 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 listScheduledActions(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsRequest) operation.

      Parameters:
      listScheduledActionsRequest -
      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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listScheduledActionsPaginator

      default ListScheduledActionsPublisher listScheduledActionsPaginator(Consumer<ListScheduledActionsRequest.Builder> listScheduledActionsRequest)

      This is a variant of listScheduledActions(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsRequest) 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.opensearch.paginators.ListScheduledActionsPublisher publisher = client.listScheduledActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListScheduledActionsPublisher publisher = client.listScheduledActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListScheduledActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsResponse 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 listScheduledActions(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsRequest) operation.


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

      Parameters:
      listScheduledActionsRequest - A Consumer that will call methods on ListScheduledActionsRequest.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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listTags

      default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)

      Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

      Parameters:
      listTagsRequest - Container for the parameters to the ListTags operation.
      Returns:
      A Java Future containing the result of the ListTags 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listTags

      default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)

      Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.


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

      Parameters:
      listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request. Container for the parameters to the ListTags operation.
      Returns:
      A Java Future containing the result of the ListTags 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listVersions

      default CompletableFuture<ListVersionsResponse> listVersions(ListVersionsRequest listVersionsRequest)

      Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

      Parameters:
      listVersionsRequest - Container for the request parameters to the ListVersions operation.
      Returns:
      A Java Future containing the result of the ListVersions 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listVersions

      default CompletableFuture<ListVersionsResponse> listVersions(Consumer<ListVersionsRequest.Builder> listVersionsRequest)

      Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.


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

      Parameters:
      listVersionsRequest - A Consumer that will call methods on ListVersionsRequest.Builder to create a request. Container for the request parameters to the ListVersions operation.
      Returns:
      A Java Future containing the result of the ListVersions 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listVersionsPaginator

      default ListVersionsPublisher listVersionsPaginator(ListVersionsRequest listVersionsRequest)

      This is a variant of listVersions(software.amazon.awssdk.services.opensearch.model.ListVersionsRequest) 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.opensearch.paginators.ListVersionsPublisher publisher = client.listVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListVersionsPublisher publisher = client.listVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListVersionsResponse 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 listVersions(software.amazon.awssdk.services.opensearch.model.ListVersionsRequest) operation.

      Parameters:
      listVersionsRequest - Container for the request parameters to the ListVersions 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listVersionsPaginator

      default ListVersionsPublisher listVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest)

      This is a variant of listVersions(software.amazon.awssdk.services.opensearch.model.ListVersionsRequest) 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.opensearch.paginators.ListVersionsPublisher publisher = client.listVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearch.paginators.ListVersionsPublisher publisher = client.listVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearch.model.ListVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearch.model.ListVersionsResponse 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 listVersions(software.amazon.awssdk.services.opensearch.model.ListVersionsRequest) operation.


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

      Parameters:
      listVersionsRequest - A Consumer that will call methods on ListVersionsRequest.Builder to create a request. Container for the request parameters to the ListVersions 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listVpcEndpointAccess

      default CompletableFuture<ListVpcEndpointAccessResponse> listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest)

      Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

      Parameters:
      listVpcEndpointAccessRequest -
      Returns:
      A Java Future containing the result of the ListVpcEndpointAccess 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listVpcEndpointAccess

      default CompletableFuture<ListVpcEndpointAccessResponse> listVpcEndpointAccess(Consumer<ListVpcEndpointAccessRequest.Builder> listVpcEndpointAccessRequest)

      Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.


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

      Parameters:
      listVpcEndpointAccessRequest - A Consumer that will call methods on ListVpcEndpointAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListVpcEndpointAccess 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listVpcEndpoints

      default CompletableFuture<ListVpcEndpointsResponse> listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)

      Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

      Parameters:
      listVpcEndpointsRequest -
      Returns:
      A Java Future containing the result of the ListVpcEndpoints 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.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listVpcEndpoints

      default CompletableFuture<ListVpcEndpointsResponse> listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)

      Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.


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

      Parameters:
      listVpcEndpointsRequest - A Consumer that will call methods on ListVpcEndpointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListVpcEndpoints 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.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listVpcEndpointsForDomain

      default CompletableFuture<ListVpcEndpointsForDomainResponse> listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest)

      Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

      Parameters:
      listVpcEndpointsForDomainRequest -
      Returns:
      A Java Future containing the result of the ListVpcEndpointsForDomain 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.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listVpcEndpointsForDomain

      default CompletableFuture<ListVpcEndpointsForDomainResponse> listVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest)

      Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.


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

      Parameters:
      listVpcEndpointsForDomainRequest - A Consumer that will call methods on ListVpcEndpointsForDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListVpcEndpointsForDomain 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.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • purchaseReservedInstanceOffering

      default CompletableFuture<PurchaseReservedInstanceOfferingResponse> purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest)

      Allows you to purchase Amazon OpenSearch Service Reserved Instances.

      Parameters:
      purchaseReservedInstanceOfferingRequest - Container for request parameters to the PurchaseReservedInstanceOffering operation.
      Returns:
      A Java Future containing the result of the PurchaseReservedInstanceOffering 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 An exception for accessing or deleting a resource that doesn't exist.
      • ResourceAlreadyExistsException An exception for creating a resource that already exists.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • purchaseReservedInstanceOffering

      default CompletableFuture<PurchaseReservedInstanceOfferingResponse> purchaseReservedInstanceOffering(Consumer<PurchaseReservedInstanceOfferingRequest.Builder> purchaseReservedInstanceOfferingRequest)

      Allows you to purchase Amazon OpenSearch Service Reserved Instances.


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

      Parameters:
      purchaseReservedInstanceOfferingRequest - A Consumer that will call methods on PurchaseReservedInstanceOfferingRequest.Builder to create a request. Container for request parameters to the PurchaseReservedInstanceOffering operation.
      Returns:
      A Java Future containing the result of the PurchaseReservedInstanceOffering 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 An exception for accessing or deleting a resource that doesn't exist.
      • ResourceAlreadyExistsException An exception for creating a resource that already exists.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • rejectInboundConnection

      default CompletableFuture<RejectInboundConnectionResponse> rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest)

      Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

      Parameters:
      rejectInboundConnectionRequest - Container for the request parameters to the RejectInboundConnection operation.
      Returns:
      A Java Future containing the result of the RejectInboundConnection 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • rejectInboundConnection

      default CompletableFuture<RejectInboundConnectionResponse> rejectInboundConnection(Consumer<RejectInboundConnectionRequest.Builder> rejectInboundConnectionRequest)

      Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.


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

      Parameters:
      rejectInboundConnectionRequest - A Consumer that will call methods on RejectInboundConnectionRequest.Builder to create a request. Container for the request parameters to the RejectInboundConnection operation.
      Returns:
      A Java Future containing the result of the RejectInboundConnection 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • removeTags

      default CompletableFuture<RemoveTagsResponse> removeTags(RemoveTagsRequest removeTagsRequest)

      Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

      Parameters:
      removeTagsRequest - Container for the request parameters to the RemoveTags operation.
      Returns:
      A Java Future containing the result of the RemoveTags 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.
      • BaseException An error occurred while processing the request.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • removeTags

      default CompletableFuture<RemoveTagsResponse> removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)

      Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.


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

      Parameters:
      removeTagsRequest - A Consumer that will call methods on RemoveTagsRequest.Builder to create a request. Container for the request parameters to the RemoveTags operation.
      Returns:
      A Java Future containing the result of the RemoveTags 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.
      • BaseException An error occurred while processing the request.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • revokeVpcEndpointAccess

      default CompletableFuture<RevokeVpcEndpointAccessResponse> revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest)

      Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

      Parameters:
      revokeVpcEndpointAccessRequest -
      Returns:
      A Java Future containing the result of the RevokeVpcEndpointAccess 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 An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • revokeVpcEndpointAccess

      default CompletableFuture<RevokeVpcEndpointAccessResponse> revokeVpcEndpointAccess(Consumer<RevokeVpcEndpointAccessRequest.Builder> revokeVpcEndpointAccessRequest)

      Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.


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

      Parameters:
      revokeVpcEndpointAccessRequest - A Consumer that will call methods on RevokeVpcEndpointAccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RevokeVpcEndpointAccess 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 An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • startDomainMaintenance

      default CompletableFuture<StartDomainMaintenanceResponse> startDomainMaintenance(StartDomainMaintenanceRequest startDomainMaintenanceRequest)

      Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

      Parameters:
      startDomainMaintenanceRequest - Container for the parameters to the StartDomainMaintenance operation.
      Returns:
      A Java Future containing the result of the StartDomainMaintenance 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • startDomainMaintenance

      default CompletableFuture<StartDomainMaintenanceResponse> startDomainMaintenance(Consumer<StartDomainMaintenanceRequest.Builder> startDomainMaintenanceRequest)

      Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.


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

      Parameters:
      startDomainMaintenanceRequest - A Consumer that will call methods on StartDomainMaintenanceRequest.Builder to create a request. Container for the parameters to the StartDomainMaintenance operation.
      Returns:
      A Java Future containing the result of the StartDomainMaintenance 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • startServiceSoftwareUpdate

      default CompletableFuture<StartServiceSoftwareUpdateResponse> startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest startServiceSoftwareUpdateRequest)

      Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

      Parameters:
      startServiceSoftwareUpdateRequest - Container for the request parameters to the StartServiceSoftwareUpdate operation.
      Returns:
      A Java Future containing the result of the StartServiceSoftwareUpdate 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • startServiceSoftwareUpdate

      default CompletableFuture<StartServiceSoftwareUpdateResponse> startServiceSoftwareUpdate(Consumer<StartServiceSoftwareUpdateRequest.Builder> startServiceSoftwareUpdateRequest)

      Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.


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

      Parameters:
      startServiceSoftwareUpdateRequest - A Consumer that will call methods on StartServiceSoftwareUpdateRequest.Builder to create a request. Container for the request parameters to the StartServiceSoftwareUpdate operation.
      Returns:
      A Java Future containing the result of the StartServiceSoftwareUpdate 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDataSource

      default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)

      Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

      Parameters:
      updateDataSourceRequest - Container for the parameters to the UpdateDataSource operation.
      Returns:
      A Java Future containing the result of the UpdateDataSource 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the 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.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDataSource

      default CompletableFuture<UpdateDataSourceResponse> updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)

      Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.


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

      Parameters:
      updateDataSourceRequest - A Consumer that will call methods on UpdateDataSourceRequest.Builder to create a request. Container for the parameters to the UpdateDataSource operation.
      Returns:
      A Java Future containing the result of the UpdateDataSource 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the 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.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDomainConfig

      default CompletableFuture<UpdateDomainConfigResponse> updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest)

      Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

      Parameters:
      updateDomainConfigRequest - Container for the request parameters to the UpdateDomain operation.
      Returns:
      A Java Future containing the result of the UpdateDomainConfig 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDomainConfig

      default CompletableFuture<UpdateDomainConfigResponse> updateDomainConfig(Consumer<UpdateDomainConfigRequest.Builder> updateDomainConfigRequest)

      Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.


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

      Parameters:
      updateDomainConfigRequest - A Consumer that will call methods on UpdateDomainConfigRequest.Builder to create a request. Container for the request parameters to the UpdateDomain operation.
      Returns:
      A Java Future containing the result of the UpdateDomainConfig 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updatePackage

      default CompletableFuture<UpdatePackageResponse> updatePackage(UpdatePackageRequest updatePackageRequest)

      Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

      Parameters:
      updatePackageRequest - Container for request parameters to the UpdatePackage operation.
      Returns:
      A Java Future containing the result of the UpdatePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updatePackage

      default CompletableFuture<UpdatePackageResponse> updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest)

      Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.


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

      Parameters:
      updatePackageRequest - A Consumer that will call methods on UpdatePackageRequest.Builder to create a request. Container for request parameters to the UpdatePackage operation.
      Returns:
      A Java Future containing the result of the UpdatePackage 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • AccessDeniedException An error occurred because you don't have permissions to access the resource.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateScheduledAction

      default CompletableFuture<UpdateScheduledActionResponse> updateScheduledAction(UpdateScheduledActionRequest updateScheduledActionRequest)

      Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

      Parameters:
      updateScheduledActionRequest -
      Returns:
      A Java Future containing the result of the UpdateScheduledAction 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • SlotNotAvailableException An exception for attempting to schedule a domain action during an unavailable time slot.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateScheduledAction

      default CompletableFuture<UpdateScheduledActionResponse> updateScheduledAction(Consumer<UpdateScheduledActionRequest.Builder> updateScheduledActionRequest)

      Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.


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

      Parameters:
      updateScheduledActionRequest - A Consumer that will call methods on UpdateScheduledActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateScheduledAction 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.
      • BaseException An error occurred while processing the request.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • SlotNotAvailableException An exception for attempting to schedule a domain action during an unavailable time slot.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateVpcEndpoint

      default CompletableFuture<UpdateVpcEndpointResponse> updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)

      Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

      Parameters:
      updateVpcEndpointRequest -
      Returns:
      A Java Future containing the result of the UpdateVpcEndpoint 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateVpcEndpoint

      default CompletableFuture<UpdateVpcEndpointResponse> updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)

      Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.


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

      Parameters:
      updateVpcEndpointRequest - A Consumer that will call methods on UpdateVpcEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateVpcEndpoint 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 An exception for accessing or deleting a resource that doesn't exist.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
      • BaseException An error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • upgradeDomain

      default CompletableFuture<UpgradeDomainResponse> upgradeDomain(UpgradeDomainRequest upgradeDomainRequest)

      Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

      Parameters:
      upgradeDomainRequest - Container for the request parameters to the UpgradeDomain operation.
      Returns:
      A Java Future containing the result of the UpgradeDomain 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ResourceAlreadyExistsException An exception for creating a resource that already exists.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • upgradeDomain

      default CompletableFuture<UpgradeDomainResponse> upgradeDomain(Consumer<UpgradeDomainRequest.Builder> upgradeDomainRequest)

      Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.


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

      Parameters:
      upgradeDomainRequest - A Consumer that will call methods on UpgradeDomainRequest.Builder to create a request. Container for the request parameters to the UpgradeDomain operation.
      Returns:
      A Java Future containing the result of the UpgradeDomain 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.
      • BaseException An error occurred while processing the request.
      • ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
      • ResourceAlreadyExistsException An exception for creating a resource that already exists.
      • DisabledOperationException An error occured because the client wanted to access an unsupported operation.
      • ValidationException An exception for accessing or deleting a resource that doesn't exist.
      • InternalException Request processing failed because of an unknown error, exception, or internal failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • serviceClientConfiguration

      default OpenSearchServiceClientConfiguration 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 OpenSearchAsyncClient create()
      Create a OpenSearchAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static OpenSearchAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a OpenSearchAsyncClient.