All Superinterfaces:: AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing Amazon CloudSearch. This can be created using the static builder() method. 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 Summary

Fields

Modifier and Type

Field

Description

static final String

SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

static final String

SERVICE_NAME
Method Summary

Modifier and Type

Method

Description

static CloudSearchClientBuilder

builder()

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

default BuildSuggestersResponse

buildSuggesters(Consumer<BuildSuggestersRequest.Builder> buildSuggestersRequest)

Indexes the search suggestions.

default BuildSuggestersResponse

buildSuggesters(BuildSuggestersRequest buildSuggestersRequest)

Indexes the search suggestions.

static CloudSearchClient

create()

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

default CreateDomainResponse

createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)

Creates a new search domain.

default CreateDomainResponse

createDomain(CreateDomainRequest createDomainRequest)

Creates a new search domain.

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

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

default DefineExpressionResponse

defineExpression(Consumer<DefineExpressionRequest.Builder> defineExpressionRequest)

Configures an Expression for the search domain.

default DefineExpressionResponse

defineExpression(DefineExpressionRequest defineExpressionRequest)

Configures an Expression for the search domain.

default DefineIndexFieldResponse

defineIndexField(Consumer<DefineIndexFieldRequest.Builder> defineIndexFieldRequest)

Configures an IndexField for the search domain.

default DefineIndexFieldResponse

defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest)

Configures an IndexField for the search domain.

default DefineSuggesterResponse

defineSuggester(Consumer<DefineSuggesterRequest.Builder> defineSuggesterRequest)

Configures a suggester for a domain.

default DefineSuggesterResponse

defineSuggester(DefineSuggesterRequest defineSuggesterRequest)

Configures a suggester for a domain.

default DeleteAnalysisSchemeResponse

deleteAnalysisScheme(Consumer<DeleteAnalysisSchemeRequest.Builder> deleteAnalysisSchemeRequest)

Deletes an analysis scheme.

default DeleteAnalysisSchemeResponse

deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest)

Deletes an analysis scheme.

default DeleteDomainResponse

deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)

Permanently deletes a search domain and all of its data.

default DeleteDomainResponse

deleteDomain(DeleteDomainRequest deleteDomainRequest)

Permanently deletes a search domain and all of its data.

default DeleteExpressionResponse

deleteExpression(Consumer<DeleteExpressionRequest.Builder> deleteExpressionRequest)

Removes an Expression from the search domain.

default DeleteExpressionResponse

deleteExpression(DeleteExpressionRequest deleteExpressionRequest)

Removes an Expression from the search domain.

default DeleteIndexFieldResponse

deleteIndexField(Consumer<DeleteIndexFieldRequest.Builder> deleteIndexFieldRequest)

Removes an IndexField from the search domain.

default DeleteIndexFieldResponse

deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)

Removes an IndexField from the search domain.

default DeleteSuggesterResponse

deleteSuggester(Consumer<DeleteSuggesterRequest.Builder> deleteSuggesterRequest)

Deletes a suggester.

default DeleteSuggesterResponse

deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest)

Deletes a suggester.

default DescribeAnalysisSchemesResponse

describeAnalysisSchemes(Consumer<DescribeAnalysisSchemesRequest.Builder> describeAnalysisSchemesRequest)

Gets the analysis schemes configured for a domain.

default DescribeAnalysisSchemesResponse

describeAnalysisSchemes(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest)

Gets the analysis schemes configured for a domain.

default DescribeAvailabilityOptionsResponse

describeAvailabilityOptions(Consumer<DescribeAvailabilityOptionsRequest.Builder> describeAvailabilityOptionsRequest)

Gets the availability options configured for a domain.

default DescribeAvailabilityOptionsResponse

describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest)

Gets the availability options configured for a domain.

default DescribeDomainEndpointOptionsResponse

describeDomainEndpointOptions(Consumer<DescribeDomainEndpointOptionsRequest.Builder> describeDomainEndpointOptionsRequest)

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.

default DescribeDomainEndpointOptionsResponse

describeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest describeDomainEndpointOptionsRequest)

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.

default DescribeDomainsResponse

describeDomains()

Gets information about the search domains owned by this account.

default DescribeDomainsResponse

describeDomains(Consumer<DescribeDomainsRequest.Builder> describeDomainsRequest)

Gets information about the search domains owned by this account.

default DescribeDomainsResponse

describeDomains(DescribeDomainsRequest describeDomainsRequest)

Gets information about the search domains owned by this account.

default DescribeExpressionsResponse

describeExpressions(Consumer<DescribeExpressionsRequest.Builder> describeExpressionsRequest)

Gets the expressions configured for the search domain.

default DescribeExpressionsResponse

describeExpressions(DescribeExpressionsRequest describeExpressionsRequest)

Gets the expressions configured for the search domain.

default DescribeIndexFieldsResponse

describeIndexFields(Consumer<DescribeIndexFieldsRequest.Builder> describeIndexFieldsRequest)

Gets information about the index fields configured for the search domain.

default DescribeIndexFieldsResponse

describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest)

Gets information about the index fields configured for the search domain.

default DescribeScalingParametersResponse

describeScalingParameters(Consumer<DescribeScalingParametersRequest.Builder> describeScalingParametersRequest)

Gets the scaling parameters configured for a domain.

default DescribeScalingParametersResponse

describeScalingParameters(DescribeScalingParametersRequest describeScalingParametersRequest)

Gets the scaling parameters configured for a domain.

default DescribeServiceAccessPoliciesResponse

describeServiceAccessPolicies(Consumer<DescribeServiceAccessPoliciesRequest.Builder> describeServiceAccessPoliciesRequest)

Gets information about the access policies that control access to the domain's document and search endpoints.

default DescribeServiceAccessPoliciesResponse

describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)

Gets information about the access policies that control access to the domain's document and search endpoints.

default DescribeSuggestersResponse

describeSuggesters(Consumer<DescribeSuggestersRequest.Builder> describeSuggestersRequest)

Gets the suggesters configured for a domain.

default DescribeSuggestersResponse

describeSuggesters(DescribeSuggestersRequest describeSuggestersRequest)

Gets the suggesters configured for a domain.

default IndexDocumentsResponse

indexDocuments(Consumer<IndexDocumentsRequest.Builder> indexDocumentsRequest)

Tells the search domain to start indexing its documents using the latest indexing options.

default IndexDocumentsResponse

indexDocuments(IndexDocumentsRequest indexDocumentsRequest)

Tells the search domain to start indexing its documents using the latest indexing options.

default ListDomainNamesResponse

listDomainNames()

Lists all search domains owned by an account.

default ListDomainNamesResponse

listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest)

Lists all search domains owned by an account.

default ListDomainNamesResponse

listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

Lists all search domains owned by an account.

default CloudSearchServiceClientConfiguration

serviceClientConfiguration()

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

static ServiceMetadata

serviceMetadata()

default UpdateAvailabilityOptionsResponse

updateAvailabilityOptions(Consumer<UpdateAvailabilityOptionsRequest.Builder> updateAvailabilityOptionsRequest)

Configures the availability options for a domain.

default UpdateAvailabilityOptionsResponse

updateAvailabilityOptions(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest)

Configures the availability options for a domain.

default UpdateDomainEndpointOptionsResponse

updateDomainEndpointOptions(Consumer<UpdateDomainEndpointOptionsRequest.Builder> updateDomainEndpointOptionsRequest)

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.

default UpdateDomainEndpointOptionsResponse

updateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest updateDomainEndpointOptionsRequest)

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.

default UpdateScalingParametersResponse

updateScalingParameters(Consumer<UpdateScalingParametersRequest.Builder> updateScalingParametersRequest)

Configures scaling parameters for a domain.

default UpdateScalingParametersResponse

updateScalingParameters(UpdateScalingParametersRequest updateScalingParametersRequest)

Configures scaling parameters for a domain.

default UpdateServiceAccessPoliciesResponse

updateServiceAccessPolicies(Consumer<UpdateServiceAccessPoliciesRequest.Builder> updateServiceAccessPoliciesRequest)

Configures the access rules that control access to the domain's document and search endpoints.

default UpdateServiceAccessPoliciesResponse

updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)

Configures the access rules that control access to the domain's document and search endpoints.

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

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

Field Details
- SERVICE_NAME
  static final String SERVICE_NAME
  
  See Also:
  
  Constant Field Values
- SERVICE_METADATA_ID
  static final String SERVICE_METADATA_ID
  
  Value for looking up the service's metadata from the ServiceMetadataProvider.
  
  See Also:
  
  Constant Field Values
Method Details
- buildSuggesters
  
  default BuildSuggestersResponse buildSuggesters(BuildSuggestersRequest buildSuggestersRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the BuildSuggesters operation returned by the service.
- buildSuggesters
  
  default BuildSuggestersResponse buildSuggesters(Consumer<BuildSuggestersRequest.Builder> buildSuggestersRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the BuildSuggesters operation returned by the service.
- createDomain
  
  default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws BaseException, InternalException, LimitExceededException, ResourceAlreadyExistsException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the CreateDomain operation returned by the service.
- createDomain
  
  default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) throws BaseException, InternalException, LimitExceededException, ResourceAlreadyExistsException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the CreateDomain operation returned by the service.
- defineAnalysisScheme
  
  default DefineAnalysisSchemeResponse defineAnalysisScheme(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DefineAnalysisScheme operation returned by the service.
- defineAnalysisScheme
  
  default DefineAnalysisSchemeResponse defineAnalysisScheme(Consumer<DefineAnalysisSchemeRequest.Builder> defineAnalysisSchemeRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DefineAnalysisScheme operation returned by the service.
- defineExpression
  
  default DefineExpressionResponse defineExpression(DefineExpressionRequest defineExpressionRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DefineExpression operation returned by the service.
- defineExpression
  
  default DefineExpressionResponse defineExpression(Consumer<DefineExpressionRequest.Builder> defineExpressionRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DefineExpression operation returned by the service.
- defineIndexField
  
  default DefineIndexFieldResponse defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DefineIndexField operation returned by the service.
- defineIndexField
  
  default DefineIndexFieldResponse defineIndexField(Consumer<DefineIndexFieldRequest.Builder> defineIndexFieldRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DefineIndexField operation returned by the service.
- defineSuggester
  
  default DefineSuggesterResponse defineSuggester(DefineSuggesterRequest defineSuggesterRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DefineSuggester operation returned by the service.
- defineSuggester
  
  default DefineSuggesterResponse defineSuggester(Consumer<DefineSuggesterRequest.Builder> defineSuggesterRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DefineSuggester operation returned by the service.
- deleteAnalysisScheme
  
  default DeleteAnalysisSchemeResponse deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DeleteAnalysisScheme operation returned by the service.
- deleteAnalysisScheme
  
  default DeleteAnalysisSchemeResponse deleteAnalysisScheme(Consumer<DeleteAnalysisSchemeRequest.Builder> deleteAnalysisSchemeRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DeleteAnalysisScheme operation returned by the service.
- deleteDomain
  
  default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws BaseException, InternalException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DeleteDomain operation returned by the service.
- deleteDomain
  
  default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) throws BaseException, InternalException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DeleteDomain operation returned by the service.
- deleteExpression
  
  default DeleteExpressionResponse deleteExpression(DeleteExpressionRequest deleteExpressionRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DeleteExpression operation returned by the service.
- deleteExpression
  
  default DeleteExpressionResponse deleteExpression(Consumer<DeleteExpressionRequest.Builder> deleteExpressionRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DeleteExpression operation returned by the service.
- deleteIndexField
  
  default DeleteIndexFieldResponse deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DeleteIndexField operation returned by the service.
- deleteIndexField
  
  default DeleteIndexFieldResponse deleteIndexField(Consumer<DeleteIndexFieldRequest.Builder> deleteIndexFieldRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DeleteIndexField operation returned by the service.
- deleteSuggester
  
  default DeleteSuggesterResponse deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DeleteSuggester operation returned by the service.
- deleteSuggester
  
  default DeleteSuggesterResponse deleteSuggester(Consumer<DeleteSuggesterRequest.Builder> deleteSuggesterRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DeleteSuggester operation returned by the service.
- describeAnalysisSchemes
  
  default DescribeAnalysisSchemesResponse describeAnalysisSchemes(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeAnalysisSchemes operation returned by the service.
- describeAnalysisSchemes
  
  default DescribeAnalysisSchemesResponse describeAnalysisSchemes(Consumer<DescribeAnalysisSchemesRequest.Builder> describeAnalysisSchemesRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeAnalysisSchemes operation returned by the service.
- describeAvailabilityOptions
  
  default DescribeAvailabilityOptionsResponse describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeAvailabilityOptions operation returned by the service.
- describeAvailabilityOptions
  
  default DescribeAvailabilityOptionsResponse describeAvailabilityOptions(Consumer<DescribeAvailabilityOptionsRequest.Builder> describeAvailabilityOptionsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeAvailabilityOptions operation returned by the service.
- describeDomainEndpointOptions
  
  default DescribeDomainEndpointOptionsResponse describeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest describeDomainEndpointOptionsRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeDomainEndpointOptions operation returned by the service.
- describeDomainEndpointOptions
  
  default DescribeDomainEndpointOptionsResponse describeDomainEndpointOptions(Consumer<DescribeDomainEndpointOptionsRequest.Builder> describeDomainEndpointOptionsRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeDomainEndpointOptions operation returned by the service.
- describeDomains
  
  default DescribeDomainsResponse describeDomains(DescribeDomainsRequest describeDomainsRequest) throws BaseException, InternalException, AwsServiceException, SdkClientException, CloudSearchException
  
  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&q.parser=structured&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:
  
  Result of the DescribeDomains operation returned by the service.
- describeDomains
  
  default DescribeDomainsResponse describeDomains(Consumer<DescribeDomainsRequest.Builder> describeDomainsRequest) throws BaseException, InternalException, AwsServiceException, SdkClientException, CloudSearchException
  
  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&q.parser=structured&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:
  
  Result of the DescribeDomains operation returned by the service.
- describeDomains
  default DescribeDomainsResponse describeDomains() throws BaseException, InternalException, AwsServiceException, SdkClientException, CloudSearchException
  
  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&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.
  
  Returns:
  
  Result of the DescribeDomains operation returned by the service.
  
  See Also:
  
  describeDomains(DescribeDomainsRequest)
- describeExpressions
  
  default DescribeExpressionsResponse describeExpressions(DescribeExpressionsRequest describeExpressionsRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeExpressions operation returned by the service.
- describeExpressions
  
  default DescribeExpressionsResponse describeExpressions(Consumer<DescribeExpressionsRequest.Builder> describeExpressionsRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeExpressions operation returned by the service.
- describeIndexFields
  
  default DescribeIndexFieldsResponse describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeIndexFields operation returned by the service.
- describeIndexFields
  
  default DescribeIndexFieldsResponse describeIndexFields(Consumer<DescribeIndexFieldsRequest.Builder> describeIndexFieldsRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeIndexFields operation returned by the service.
- describeScalingParameters
  
  default DescribeScalingParametersResponse describeScalingParameters(DescribeScalingParametersRequest describeScalingParametersRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeScalingParameters operation returned by the service.
- describeScalingParameters
  
  default DescribeScalingParametersResponse describeScalingParameters(Consumer<DescribeScalingParametersRequest.Builder> describeScalingParametersRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeScalingParameters operation returned by the service.
- describeServiceAccessPolicies
  
  default DescribeServiceAccessPoliciesResponse describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeServiceAccessPolicies operation returned by the service.
- describeServiceAccessPolicies
  
  default DescribeServiceAccessPoliciesResponse describeServiceAccessPolicies(Consumer<DescribeServiceAccessPoliciesRequest.Builder> describeServiceAccessPoliciesRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeServiceAccessPolicies operation returned by the service.
- describeSuggesters
  
  default DescribeSuggestersResponse describeSuggesters(DescribeSuggestersRequest describeSuggestersRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeSuggesters operation returned by the service.
- describeSuggesters
  
  default DescribeSuggestersResponse describeSuggesters(Consumer<DescribeSuggestersRequest.Builder> describeSuggestersRequest) throws BaseException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the DescribeSuggesters operation returned by the service.
- indexDocuments
  
  default IndexDocumentsResponse indexDocuments(IndexDocumentsRequest indexDocumentsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the IndexDocuments operation returned by the service.
- indexDocuments
  
  default IndexDocumentsResponse indexDocuments(Consumer<IndexDocumentsRequest.Builder> indexDocumentsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the IndexDocuments operation returned by the service.
- listDomainNames
  
  default ListDomainNamesResponse listDomainNames(ListDomainNamesRequest listDomainNamesRequest) throws BaseException, AwsServiceException, SdkClientException, CloudSearchException
  
  Lists all search domains owned by an account.
  
  Parameters:
  
  listDomainNamesRequest -
  
  Returns:
  
  Result of the ListDomainNames operation returned by the service.
- listDomainNames
  
  default ListDomainNamesResponse listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest) throws BaseException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the ListDomainNames operation returned by the service.
- listDomainNames
  default ListDomainNamesResponse listDomainNames() throws BaseException, AwsServiceException, SdkClientException, CloudSearchException
  
  Lists all search domains owned by an account.
  
  Returns:
  
  Result of the ListDomainNames operation returned by the service.
  
  See Also:
  
  listDomainNames(ListDomainNamesRequest)
- updateAvailabilityOptions
  
  default UpdateAvailabilityOptionsResponse updateAvailabilityOptions(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the UpdateAvailabilityOptions operation returned by the service.
- updateAvailabilityOptions
  
  default UpdateAvailabilityOptionsResponse updateAvailabilityOptions(Consumer<UpdateAvailabilityOptionsRequest.Builder> updateAvailabilityOptionsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the UpdateAvailabilityOptions operation returned by the service.
- updateDomainEndpointOptions
  
  default UpdateDomainEndpointOptionsResponse updateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest updateDomainEndpointOptionsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the UpdateDomainEndpointOptions operation returned by the service.
- updateDomainEndpointOptions
  
  default UpdateDomainEndpointOptionsResponse updateDomainEndpointOptions(Consumer<UpdateDomainEndpointOptionsRequest.Builder> updateDomainEndpointOptionsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the UpdateDomainEndpointOptions operation returned by the service.
- updateScalingParameters
  
  default UpdateScalingParametersResponse updateScalingParameters(UpdateScalingParametersRequest updateScalingParametersRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, InvalidTypeException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the UpdateScalingParameters operation returned by the service.
- updateScalingParameters
  
  default UpdateScalingParametersResponse updateScalingParameters(Consumer<UpdateScalingParametersRequest.Builder> updateScalingParametersRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, InvalidTypeException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the UpdateScalingParameters operation returned by the service.
- updateServiceAccessPolicies
  
  default UpdateServiceAccessPoliciesResponse updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, InvalidTypeException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the UpdateServiceAccessPolicies operation returned by the service.
- updateServiceAccessPolicies
  
  default UpdateServiceAccessPoliciesResponse updateServiceAccessPolicies(Consumer<UpdateServiceAccessPoliciesRequest.Builder> updateServiceAccessPoliciesRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, InvalidTypeException, ValidationException, AwsServiceException, SdkClientException, CloudSearchException
  
  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:
  
  Result of the UpdateServiceAccessPolicies operation returned by the service.
- create
  
  static CloudSearchClient create()
  
  Create a CloudSearchClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
- builder
  
  static CloudSearchClientBuilder builder()
  
  Create a builder that can be used to configure and create a CloudSearchClient.
- serviceMetadata
  
  static ServiceMetadata serviceMetadata()
- 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

Interface CloudSearchClient

Field Summary

Method Summary

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

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

Field Details

SERVICE_NAME

SERVICE_METADATA_ID

Method Details

buildSuggesters

buildSuggesters

createDomain

createDomain

defineAnalysisScheme

defineAnalysisScheme

defineExpression

defineExpression

defineIndexField

defineIndexField

defineSuggester

defineSuggester

deleteAnalysisScheme

deleteAnalysisScheme

deleteDomain

deleteDomain

deleteExpression

deleteExpression

deleteIndexField

deleteIndexField

deleteSuggester

deleteSuggester

describeAnalysisSchemes

describeAnalysisSchemes

describeAvailabilityOptions

describeAvailabilityOptions

describeDomainEndpointOptions

describeDomainEndpointOptions

describeDomains

describeDomains

describeDomains

describeExpressions

describeExpressions

describeIndexFields

describeIndexFields

describeScalingParameters

describeScalingParameters

describeServiceAccessPolicies

describeServiceAccessPolicies

describeSuggesters

describeSuggesters

indexDocuments

indexDocuments

listDomainNames

listDomainNames

listDomainNames

updateAvailabilityOptions

updateAvailabilityOptions

updateDomainEndpointOptions

updateDomainEndpointOptions

updateScalingParameters

updateScalingParameters

updateServiceAccessPolicies

updateServiceAccessPolicies

create

builder

serviceMetadata

serviceClientConfiguration