Package software.amazon.awssdk.services.cloudsearch

Interface CloudSearchAsyncClient

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

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

  • Field Details

  • Method Details

    • buildSuggesters

      default CompletableFuture<BuildSuggestersResponse> buildSuggesters(BuildSuggestersRequest buildSuggestersRequest)

      Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

      Parameters:
      buildSuggestersRequest - Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.
      Returns:
      A Java Future containing the result of the BuildSuggesters operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • buildSuggesters

      default CompletableFuture<BuildSuggestersResponse> buildSuggesters(Consumer<BuildSuggestersRequest.Builder> buildSuggestersRequest)

      Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      buildSuggestersRequest - A Consumer that will call methods on BuildSuggestersRequest.Builder to create a request. Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.
      Returns:
      A Java Future containing the result of the BuildSuggesters operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException 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 a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

      Parameters:
      createDomainRequest - Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.
      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.
      • InternalException An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceAlreadyExistsException The request was rejected because it attempted to create a resource that already exists.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException 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 a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.


      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. Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.
      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.
      • InternalException An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceAlreadyExistsException The request was rejected because it attempted to create a resource that already exists.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • defineAnalysisScheme

      default CompletableFuture<DefineAnalysisSchemeResponse> defineAnalysisScheme(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest)

      Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

      Parameters:
      defineAnalysisSchemeRequest - Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.
      Returns:
      A Java Future containing the result of the DefineAnalysisScheme operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • defineAnalysisScheme

      default CompletableFuture<DefineAnalysisSchemeResponse> defineAnalysisScheme(Consumer<DefineAnalysisSchemeRequest.Builder> defineAnalysisSchemeRequest)

      Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      defineAnalysisSchemeRequest - A Consumer that will call methods on DefineAnalysisSchemeRequest.Builder to create a request. Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.
      Returns:
      A Java Future containing the result of the DefineAnalysisScheme operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • defineExpression

      default CompletableFuture<DefineExpressionResponse> defineExpression(DefineExpressionRequest defineExpressionRequest)

      Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

      Parameters:
      defineExpressionRequest - Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.
      Returns:
      A Java Future containing the result of the DefineExpression operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • defineExpression

      default CompletableFuture<DefineExpressionResponse> defineExpression(Consumer<DefineExpressionRequest.Builder> defineExpressionRequest)

      Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      defineExpressionRequest - A Consumer that will call methods on DefineExpressionRequest.Builder to create a request. Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.
      Returns:
      A Java Future containing the result of the DefineExpression operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • defineIndexField

      default CompletableFuture<DefineIndexFieldResponse> defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest)

      Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

      Parameters:
      defineIndexFieldRequest - Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.
      Returns:
      A Java Future containing the result of the DefineIndexField operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • defineIndexField

      default CompletableFuture<DefineIndexFieldResponse> defineIndexField(Consumer<DefineIndexFieldRequest.Builder> defineIndexFieldRequest)

      Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      defineIndexFieldRequest - A Consumer that will call methods on DefineIndexFieldRequest.Builder to create a request. Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.
      Returns:
      A Java Future containing the result of the DefineIndexField operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • defineSuggester

      default CompletableFuture<DefineSuggesterResponse> defineSuggester(DefineSuggesterRequest defineSuggesterRequest)

      Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

      Parameters:
      defineSuggesterRequest - Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.
      Returns:
      A Java Future containing the result of the DefineSuggester operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • defineSuggester

      default CompletableFuture<DefineSuggesterResponse> defineSuggester(Consumer<DefineSuggesterRequest.Builder> defineSuggesterRequest)

      Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      defineSuggesterRequest - A Consumer that will call methods on DefineSuggesterRequest.Builder to create a request. Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.
      Returns:
      A Java Future containing the result of the DefineSuggester operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteAnalysisScheme

      default CompletableFuture<DeleteAnalysisSchemeResponse> deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest)

      Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

      Parameters:
      deleteAnalysisSchemeRequest - Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.
      Returns:
      A Java Future containing the result of the DeleteAnalysisScheme operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteAnalysisScheme

      default CompletableFuture<DeleteAnalysisSchemeResponse> deleteAnalysisScheme(Consumer<DeleteAnalysisSchemeRequest.Builder> deleteAnalysisSchemeRequest)

      Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      deleteAnalysisSchemeRequest - A Consumer that will call methods on DeleteAnalysisSchemeRequest.Builder to create a request. Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.
      Returns:
      A Java Future containing the result of the DeleteAnalysisScheme operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDomain

      default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest)

      Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.

      Parameters:
      deleteDomainRequest - Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.
      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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException 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)

      Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.


      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. Specifies the name of the domain you want to delete.
      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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteExpression

      default CompletableFuture<DeleteExpressionResponse> deleteExpression(DeleteExpressionRequest deleteExpressionRequest)

      Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

      Parameters:
      deleteExpressionRequest - Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.
      Returns:
      A Java Future containing the result of the DeleteExpression operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteExpression

      default CompletableFuture<DeleteExpressionResponse> deleteExpression(Consumer<DeleteExpressionRequest.Builder> deleteExpressionRequest)

      Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      deleteExpressionRequest - A Consumer that will call methods on DeleteExpressionRequest.Builder to create a request. Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.
      Returns:
      A Java Future containing the result of the DeleteExpression operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteIndexField

      default CompletableFuture<DeleteIndexFieldResponse> deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)

      Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

      Parameters:
      deleteIndexFieldRequest - Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.
      Returns:
      A Java Future containing the result of the DeleteIndexField operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteIndexField

      default CompletableFuture<DeleteIndexFieldResponse> deleteIndexField(Consumer<DeleteIndexFieldRequest.Builder> deleteIndexFieldRequest)

      Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      deleteIndexFieldRequest - A Consumer that will call methods on DeleteIndexFieldRequest.Builder to create a request. Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.
      Returns:
      A Java Future containing the result of the DeleteIndexField operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteSuggester

      default CompletableFuture<DeleteSuggesterResponse> deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest)

      Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

      Parameters:
      deleteSuggesterRequest - Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.
      Returns:
      A Java Future containing the result of the DeleteSuggester operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteSuggester

      default CompletableFuture<DeleteSuggesterResponse> deleteSuggester(Consumer<DeleteSuggesterRequest.Builder> deleteSuggesterRequest)

      Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      deleteSuggesterRequest - A Consumer that will call methods on DeleteSuggesterRequest.Builder to create a request. Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.
      Returns:
      A Java Future containing the result of the DeleteSuggester operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeAnalysisSchemes

      default CompletableFuture<DescribeAnalysisSchemesResponse> describeAnalysisSchemes(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest)

      Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

      Parameters:
      describeAnalysisSchemesRequest - Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeAnalysisSchemes operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeAnalysisSchemes

      default CompletableFuture<DescribeAnalysisSchemesResponse> describeAnalysisSchemes(Consumer<DescribeAnalysisSchemesRequest.Builder> describeAnalysisSchemesRequest)

      Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      describeAnalysisSchemesRequest - A Consumer that will call methods on DescribeAnalysisSchemesRequest.Builder to create a request. Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeAnalysisSchemes operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeAvailabilityOptions

      default CompletableFuture<DescribeAvailabilityOptionsResponse> describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest)

      Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

      Parameters:
      describeAvailabilityOptionsRequest - Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeAvailabilityOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • DisabledOperationException The request was rejected because it attempted an operation which is not enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeAvailabilityOptions

      default CompletableFuture<DescribeAvailabilityOptionsResponse> describeAvailabilityOptions(Consumer<DescribeAvailabilityOptionsRequest.Builder> describeAvailabilityOptionsRequest)

      Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      describeAvailabilityOptionsRequest - A Consumer that will call methods on DescribeAvailabilityOptionsRequest.Builder to create a request. Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeAvailabilityOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • DisabledOperationException The request was rejected because it attempted an operation which is not enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainEndpointOptions

      default CompletableFuture<DescribeDomainEndpointOptionsResponse> describeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest describeDomainEndpointOptionsRequest)

      Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

      Parameters:
      describeDomainEndpointOptionsRequest - Container for the parameters to the DescribeDomainEndpointOptions operation. Specify the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeDomainEndpointOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • DisabledOperationException The request was rejected because it attempted an operation which is not enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomainEndpointOptions

      default CompletableFuture<DescribeDomainEndpointOptionsResponse> describeDomainEndpointOptions(Consumer<DescribeDomainEndpointOptionsRequest.Builder> describeDomainEndpointOptionsRequest)

      Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      describeDomainEndpointOptionsRequest - A Consumer that will call methods on DescribeDomainEndpointOptionsRequest.Builder to create a request. Container for the parameters to the DescribeDomainEndpointOptions operation. Specify the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeDomainEndpointOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • DisabledOperationException The request was rejected because it attempted an operation which is not enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomains

      default CompletableFuture<DescribeDomainsResponse> describeDomains(DescribeDomainsRequest describeDomainsRequest)

      Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

      Parameters:
      describeDomainsRequest - Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.
      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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException 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)

      Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.


      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. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.
      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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeDomains

      default CompletableFuture<DescribeDomainsResponse> describeDomains()

      Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

      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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeExpressions

      default CompletableFuture<DescribeExpressionsResponse> describeExpressions(DescribeExpressionsRequest describeExpressionsRequest)

      Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

      Parameters:
      describeExpressionsRequest - Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeExpressions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeExpressions

      default CompletableFuture<DescribeExpressionsResponse> describeExpressions(Consumer<DescribeExpressionsRequest.Builder> describeExpressionsRequest)

      Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      describeExpressionsRequest - A Consumer that will call methods on DescribeExpressionsRequest.Builder to create a request. Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeExpressions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeIndexFields

      default CompletableFuture<DescribeIndexFieldsResponse> describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest)

      Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

      Parameters:
      describeIndexFieldsRequest - Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeIndexFields operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeIndexFields

      default CompletableFuture<DescribeIndexFieldsResponse> describeIndexFields(Consumer<DescribeIndexFieldsRequest.Builder> describeIndexFieldsRequest)

      Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      describeIndexFieldsRequest - A Consumer that will call methods on DescribeIndexFieldsRequest.Builder to create a request. Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeIndexFields operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeScalingParameters

      default CompletableFuture<DescribeScalingParametersResponse> describeScalingParameters(DescribeScalingParametersRequest describeScalingParametersRequest)

      Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

      Parameters:
      describeScalingParametersRequest - Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.
      Returns:
      A Java Future containing the result of the DescribeScalingParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeScalingParameters

      default CompletableFuture<DescribeScalingParametersResponse> describeScalingParameters(Consumer<DescribeScalingParametersRequest.Builder> describeScalingParametersRequest)

      Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      describeScalingParametersRequest - A Consumer that will call methods on DescribeScalingParametersRequest.Builder to create a request. Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.
      Returns:
      A Java Future containing the result of the DescribeScalingParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeServiceAccessPolicies

      default CompletableFuture<DescribeServiceAccessPoliciesResponse> describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)

      Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.

      Parameters:
      describeServiceAccessPoliciesRequest - Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeServiceAccessPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeServiceAccessPolicies

      default CompletableFuture<DescribeServiceAccessPoliciesResponse> describeServiceAccessPolicies(Consumer<DescribeServiceAccessPoliciesRequest.Builder> describeServiceAccessPoliciesRequest)

      Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      describeServiceAccessPoliciesRequest - A Consumer that will call methods on DescribeServiceAccessPoliciesRequest.Builder to create a request. Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeServiceAccessPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeSuggesters

      default CompletableFuture<DescribeSuggestersResponse> describeSuggesters(DescribeSuggestersRequest describeSuggestersRequest)

      Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

      Parameters:
      describeSuggestersRequest - Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeSuggesters operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • describeSuggesters

      default CompletableFuture<DescribeSuggestersResponse> describeSuggesters(Consumer<DescribeSuggestersRequest.Builder> describeSuggestersRequest)

      Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      describeSuggestersRequest - A Consumer that will call methods on DescribeSuggestersRequest.Builder to create a request. Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.
      Returns:
      A Java Future containing the result of the DescribeSuggesters operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not 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.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • indexDocuments

      default CompletableFuture<IndexDocumentsResponse> indexDocuments(IndexDocumentsRequest indexDocumentsRequest)

      Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

      Parameters:
      indexDocumentsRequest - Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.
      Returns:
      A Java Future containing the result of the IndexDocuments operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • indexDocuments

      default CompletableFuture<IndexDocumentsResponse> indexDocuments(Consumer<IndexDocumentsRequest.Builder> indexDocumentsRequest)

      Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.


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

      Parameters:
      indexDocumentsRequest - A Consumer that will call methods on IndexDocumentsRequest.Builder to create a request. Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.
      Returns:
      A Java Future containing the result of the IndexDocuments operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainNames

      default CompletableFuture<ListDomainNamesResponse> listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

      Lists all search domains owned by an account.

      Parameters:
      listDomainNamesRequest -
      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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException 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)

      Lists all search domains owned by an account.


      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.
      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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • listDomainNames

      default CompletableFuture<ListDomainNamesResponse> listDomainNames()

      Lists all search domains owned by an account.

      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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateAvailabilityOptions

      default CompletableFuture<UpdateAvailabilityOptionsResponse> updateAvailabilityOptions(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest)

      Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

      Parameters:
      updateAvailabilityOptionsRequest - Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.
      Returns:
      A Java Future containing the result of the UpdateAvailabilityOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • DisabledOperationException The request was rejected because it attempted an operation which is not enabled.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateAvailabilityOptions

      default CompletableFuture<UpdateAvailabilityOptionsResponse> updateAvailabilityOptions(Consumer<UpdateAvailabilityOptionsRequest.Builder> updateAvailabilityOptionsRequest)

      Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      updateAvailabilityOptionsRequest - A Consumer that will call methods on UpdateAvailabilityOptionsRequest.Builder to create a request. Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.
      Returns:
      A Java Future containing the result of the UpdateAvailabilityOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • DisabledOperationException The request was rejected because it attempted an operation which is not enabled.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDomainEndpointOptions

      default CompletableFuture<UpdateDomainEndpointOptionsResponse> updateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest updateDomainEndpointOptionsRequest)

      Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

      Parameters:
      updateDomainEndpointOptionsRequest - Container for the parameters to the UpdateDomainEndpointOptions operation. Specifies the name of the domain you want to update and the domain endpoint options.
      Returns:
      A Java Future containing the result of the UpdateDomainEndpointOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • DisabledOperationException The request was rejected because it attempted an operation which is not enabled.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDomainEndpointOptions

      default CompletableFuture<UpdateDomainEndpointOptionsResponse> updateDomainEndpointOptions(Consumer<UpdateDomainEndpointOptionsRequest.Builder> updateDomainEndpointOptionsRequest)

      Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      updateDomainEndpointOptionsRequest - A Consumer that will call methods on UpdateDomainEndpointOptionsRequest.Builder to create a request. Container for the parameters to the UpdateDomainEndpointOptions operation. Specifies the name of the domain you want to update and the domain endpoint options.
      Returns:
      A Java Future containing the result of the UpdateDomainEndpointOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • DisabledOperationException The request was rejected because it attempted an operation which is not enabled.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateScalingParameters

      default CompletableFuture<UpdateScalingParametersResponse> updateScalingParameters(UpdateScalingParametersRequest updateScalingParametersRequest)

      Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

      Parameters:
      updateScalingParametersRequest - Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.
      Returns:
      A Java Future containing the result of the UpdateScalingParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateScalingParameters

      default CompletableFuture<UpdateScalingParametersResponse> updateScalingParameters(Consumer<UpdateScalingParametersRequest.Builder> updateScalingParametersRequest)

      Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.


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

      Parameters:
      updateScalingParametersRequest - A Consumer that will call methods on UpdateScalingParametersRequest.Builder to create a request. Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.
      Returns:
      A Java Future containing the result of the UpdateScalingParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateServiceAccessPolicies

      default CompletableFuture<UpdateServiceAccessPoliciesResponse> updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)

      Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

      Parameters:
      updateServiceAccessPoliciesRequest - Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.
      Returns:
      A Java Future containing the result of the UpdateServiceAccessPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateServiceAccessPolicies

      default CompletableFuture<UpdateServiceAccessPoliciesResponse> updateServiceAccessPolicies(Consumer<UpdateServiceAccessPoliciesRequest.Builder> updateServiceAccessPoliciesRequest)

      Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.


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

      Parameters:
      updateServiceAccessPoliciesRequest - A Consumer that will call methods on UpdateServiceAccessPoliciesRequest.Builder to create a request. Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.
      Returns:
      A Java Future containing the result of the UpdateServiceAccessPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
      • LimitExceededException The request was rejected because a resource limit has already been met.
      • ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
      • InvalidTypeException The request was rejected because it specified an invalid type definition.
      • ValidationException The request was rejected because it has invalid parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • serviceClientConfiguration

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

    • builder

      static CloudSearchAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a CloudSearchAsyncClient.