@Generated(value="software.amazon.awssdk:codegen") public interface CloudSearchClient extends SdkClient, SdkAutoCloseable
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static CloudSearchClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudSearchClient . |
default BuildSuggestersResponse |
buildSuggesters(BuildSuggestersRequest buildSuggestersRequest)
Indexes the search suggestions.
|
default BuildSuggestersResponse |
buildSuggesters(Consumer<BuildSuggestersRequest.Builder> 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 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.
|
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 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.
|
serviceName
close
static final String SERVICE_NAME
static CloudSearchClient create()
CloudSearchClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static CloudSearchClientBuilder builder()
CloudSearchClient
.default BuildSuggestersResponse buildSuggesters(BuildSuggestersRequest buildSuggestersRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, SdkClientException, CloudSearchException
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
buildSuggestersRequest
- Container for the parameters to the BuildSuggester
operation. Specifies the name of
the domain you want to update.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.SdkServiceException
default BuildSuggestersResponse buildSuggesters(Consumer<BuildSuggestersRequest.Builder> buildSuggestersRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, SdkClientException, CloudSearchException
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
buildSuggestersRequest
- Container for the parameters to the BuildSuggester
operation. Specifies the name of
the domain you want to update.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.SdkServiceException
default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws BaseException, InternalException, LimitExceededException, SdkServiceException, SdkClientException, CloudSearchException
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
createDomainRequest
- Container for the parameters to the CreateDomain
operation. Specifies a name for the
new search domain.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) throws BaseException, InternalException, LimitExceededException, SdkServiceException, SdkClientException, CloudSearchException
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
createDomainRequest
- Container for the parameters to the CreateDomain
operation. Specifies a name for the
new search domain.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DefineAnalysisSchemeResponse defineAnalysisScheme(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, 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.
defineAnalysisSchemeRequest
- Container for the parameters to the DefineAnalysisScheme
operation. Specifies the name
of the domain you want to update and the analysis scheme configuration.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DefineAnalysisSchemeResponse defineAnalysisScheme(Consumer<DefineAnalysisSchemeRequest.Builder> defineAnalysisSchemeRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, 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.
defineAnalysisSchemeRequest
- Container for the parameters to the DefineAnalysisScheme
operation. Specifies the name
of the domain you want to update and the analysis scheme configuration.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DefineExpressionResponse defineExpression(DefineExpressionRequest defineExpressionRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, 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.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DefineExpressionResponse defineExpression(Consumer<DefineExpressionRequest.Builder> defineExpressionRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, 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.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DefineIndexFieldResponse defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, 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.
defineIndexFieldRequest
- Container for the parameters to the DefineIndexField
operation. Specifies the name of
the domain you want to update and the index field configuration.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DefineIndexFieldResponse defineIndexField(Consumer<DefineIndexFieldRequest.Builder> defineIndexFieldRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, 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.
defineIndexFieldRequest
- Container for the parameters to the DefineIndexField
operation. Specifies the name of
the domain you want to update and the index field configuration.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DefineSuggesterResponse defineSuggester(DefineSuggesterRequest defineSuggesterRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, 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.
defineSuggesterRequest
- Container for the parameters to the DefineSuggester
operation. Specifies the name of
the domain you want to update and the suggester configuration.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DefineSuggesterResponse defineSuggester(Consumer<DefineSuggesterRequest.Builder> defineSuggesterRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, 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.
defineSuggesterRequest
- Container for the parameters to the DefineSuggester
operation. Specifies the name of
the domain you want to update and the suggester configuration.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DeleteAnalysisSchemeResponse deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, SdkClientException, CloudSearchException
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DeleteAnalysisSchemeResponse deleteAnalysisScheme(Consumer<DeleteAnalysisSchemeRequest.Builder> deleteAnalysisSchemeRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, SdkClientException, CloudSearchException
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws BaseException, InternalException, SdkServiceException, 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.
deleteDomainRequest
- Container for the parameters to the DeleteDomain
operation. Specifies the name of the
domain you want to delete.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.SdkServiceException
default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) throws BaseException, InternalException, SdkServiceException, 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.
deleteDomainRequest
- Container for the parameters to the DeleteDomain
operation. Specifies the name of the
domain you want to delete.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.SdkServiceException
default DeleteExpressionResponse deleteExpression(DeleteExpressionRequest deleteExpressionRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, SdkClientException, CloudSearchException
Removes an Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DeleteExpressionResponse deleteExpression(Consumer<DeleteExpressionRequest.Builder> deleteExpressionRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, SdkClientException, CloudSearchException
Removes an Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DeleteIndexFieldResponse deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, SdkClientException, CloudSearchException
Removes an IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DeleteIndexFieldResponse deleteIndexField(Consumer<DeleteIndexFieldRequest.Builder> deleteIndexFieldRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, SdkClientException, CloudSearchException
Removes an IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DeleteSuggesterResponse deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, SdkClientException, CloudSearchException
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DeleteSuggesterResponse deleteSuggester(Consumer<DeleteSuggesterRequest.Builder> deleteSuggesterRequest) throws BaseException, InternalException, InvalidTypeException, ResourceNotFoundException, SdkServiceException, SdkClientException, CloudSearchException
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default DescribeAnalysisSchemesResponse describeAnalysisSchemes(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeAnalysisSchemesResponse describeAnalysisSchemes(Consumer<DescribeAnalysisSchemesRequest.Builder> describeAnalysisSchemesRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeAvailabilityOptionsResponse describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeAvailabilityOptionsResponse describeAvailabilityOptions(Consumer<DescribeAvailabilityOptionsRequest.Builder> describeAvailabilityOptionsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeDomainsResponse describeDomains() throws BaseException, InternalException, SdkServiceException, 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.
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.SdkServiceException
describeDomains(DescribeDomainsRequest)
default DescribeDomainsResponse describeDomains(DescribeDomainsRequest describeDomainsRequest) throws BaseException, InternalException, SdkServiceException, 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.
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.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.SdkServiceException
default DescribeDomainsResponse describeDomains(Consumer<DescribeDomainsRequest.Builder> describeDomainsRequest) throws BaseException, InternalException, SdkServiceException, 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.
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.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.SdkServiceException
default DescribeExpressionsResponse describeExpressions(DescribeExpressionsRequest describeExpressionsRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeExpressionsResponse describeExpressions(Consumer<DescribeExpressionsRequest.Builder> describeExpressionsRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeIndexFieldsResponse describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeIndexFieldsResponse describeIndexFields(Consumer<DescribeIndexFieldsRequest.Builder> describeIndexFieldsRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeScalingParametersResponse describeScalingParameters(DescribeScalingParametersRequest describeScalingParametersRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
describeScalingParametersRequest
- Container for the parameters to the DescribeScalingParameters
operation. Specifies the
name of the domain you want to describe.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.SdkServiceException
default DescribeScalingParametersResponse describeScalingParameters(Consumer<DescribeScalingParametersRequest.Builder> describeScalingParametersRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
describeScalingParametersRequest
- Container for the parameters to the DescribeScalingParameters
operation. Specifies the
name of the domain you want to describe.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.SdkServiceException
default DescribeServiceAccessPoliciesResponse describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeServiceAccessPoliciesResponse describeServiceAccessPolicies(Consumer<DescribeServiceAccessPoliciesRequest.Builder> describeServiceAccessPoliciesRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeSuggestersResponse describeSuggesters(DescribeSuggestersRequest describeSuggestersRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
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
.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.SdkServiceException
default DescribeSuggestersResponse describeSuggesters(Consumer<DescribeSuggestersRequest.Builder> describeSuggestersRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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.
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
.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.SdkServiceException
default IndexDocumentsResponse indexDocuments(IndexDocumentsRequest indexDocumentsRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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
.
indexDocumentsRequest
- Container for the parameters to the IndexDocuments
operation. Specifies the name of
the domain you want to re-index.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.SdkServiceException
default IndexDocumentsResponse indexDocuments(Consumer<IndexDocumentsRequest.Builder> indexDocumentsRequest) throws BaseException, InternalException, ResourceNotFoundException, SdkServiceException, 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
.
indexDocumentsRequest
- Container for the parameters to the IndexDocuments
operation. Specifies the name of
the domain you want to re-index.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.SdkServiceException
default ListDomainNamesResponse listDomainNames() throws BaseException, SdkServiceException, SdkClientException, CloudSearchException
Lists all search domains owned by an account.
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.SdkServiceException
listDomainNames(ListDomainNamesRequest)
default ListDomainNamesResponse listDomainNames(ListDomainNamesRequest listDomainNamesRequest) throws BaseException, SdkServiceException, SdkClientException, CloudSearchException
Lists all search domains owned by an account.
listDomainNamesRequest
- 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.SdkServiceException
default ListDomainNamesResponse listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest) throws BaseException, SdkServiceException, SdkClientException, CloudSearchException
Lists all search domains owned by an account.
listDomainNamesRequest
- 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.SdkServiceException
default UpdateAvailabilityOptionsResponse updateAvailabilityOptions(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, SdkServiceException, 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.
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.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.SdkServiceException
default UpdateAvailabilityOptionsResponse updateAvailabilityOptions(Consumer<UpdateAvailabilityOptionsRequest.Builder> updateAvailabilityOptionsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, DisabledOperationException, SdkServiceException, 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.
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.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.SdkServiceException
default UpdateScalingParametersResponse updateScalingParameters(UpdateScalingParametersRequest updateScalingParametersRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, InvalidTypeException, SdkServiceException, 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.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default UpdateScalingParametersResponse updateScalingParameters(Consumer<UpdateScalingParametersRequest.Builder> updateScalingParametersRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, InvalidTypeException, SdkServiceException, 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.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default UpdateServiceAccessPoliciesResponse updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, InvalidTypeException, SdkServiceException, 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.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
default UpdateServiceAccessPoliciesResponse updateServiceAccessPolicies(Consumer<UpdateServiceAccessPoliciesRequest.Builder> updateServiceAccessPoliciesRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, InvalidTypeException, SdkServiceException, 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.
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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.