public interface AmazonCloudSearchAsync extends AmazonCloudSearch
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 .
buildSuggesters, createDomain, defineAnalysisScheme, defineExpression, defineIndexField, defineSuggester, deleteAnalysisScheme, deleteDomain, deleteExpression, deleteIndexField, deleteSuggester, describeAnalysisSchemes, describeAvailabilityOptions, describeDomains, describeDomains, describeExpressions, describeIndexFields, describeScalingParameters, describeServiceAccessPolicies, describeSuggesters, getCachedResponseMetadata, indexDocuments, listDomainNames, listDomainNames, setEndpoint, setRegion, shutdown, updateAvailabilityOptions, updateScalingParameters, updateServiceAccessPolicies
Future<DescribeAnalysisSchemesResult> describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeAnalysisSchemes operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeAnalysisSchemesResult> describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest, AsyncHandler<DescribeAnalysisSchemesRequest,DescribeAnalysisSchemesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeAnalysisSchemes operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest deleteIndexFieldRequest) throws AmazonServiceException, AmazonClientException
Removes an IndexField
from the search domain. For more
information, see
Configuring Index Fields
in the Amazon CloudSearch Developer Guide .
deleteIndexFieldRequest
- Container for the necessary parameters
to execute the DeleteIndexField operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest deleteIndexFieldRequest, AsyncHandler<DeleteIndexFieldRequest,DeleteIndexFieldResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Removes an IndexField
from the search domain. For more
information, see
Configuring Index Fields
in the Amazon CloudSearch Developer Guide .
deleteIndexFieldRequest
- Container for the necessary parameters
to execute the DeleteIndexField operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<UpdateAvailabilityOptionsResult> updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the UpdateAvailabilityOptions operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<UpdateAvailabilityOptionsResult> updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest, AsyncHandler<UpdateAvailabilityOptionsRequest,UpdateAvailabilityOptionsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the UpdateAvailabilityOptions operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest describeIndexFieldsRequest) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeIndexFields operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest describeIndexFieldsRequest, AsyncHandler<DescribeIndexFieldsRequest,DescribeIndexFieldsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeIndexFields operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DefineExpressionResult> defineExpressionAsync(DefineExpressionRequest defineExpressionRequest) throws AmazonServiceException, AmazonClientException
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 necessary parameters
to execute the DefineExpression operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DefineExpressionResult> defineExpressionAsync(DefineExpressionRequest defineExpressionRequest, AsyncHandler<DefineExpressionRequest,DefineExpressionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary parameters
to execute the DefineExpression operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DefineSuggesterResult> defineSuggesterAsync(DefineSuggesterRequest defineSuggesterRequest) throws AmazonServiceException, AmazonClientException
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 necessary parameters
to execute the DefineSuggester operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DefineSuggesterResult> defineSuggesterAsync(DefineSuggesterRequest defineSuggesterRequest, AsyncHandler<DefineSuggesterRequest,DefineSuggesterResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary parameters
to execute the DefineSuggester operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the UpdateServiceAccessPolicies operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest, AsyncHandler<UpdateServiceAccessPoliciesRequest,UpdateServiceAccessPoliciesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the UpdateServiceAccessPolicies operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DeleteAnalysisSchemeResult> deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest) throws AmazonServiceException, AmazonClientException
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .
deleteAnalysisSchemeRequest
- Container for the necessary
parameters to execute the DeleteAnalysisScheme operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DeleteAnalysisSchemeResult> deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest, AsyncHandler<DeleteAnalysisSchemeRequest,DeleteAnalysisSchemeResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .
deleteAnalysisSchemeRequest
- Container for the necessary
parameters to execute the DeleteAnalysisScheme operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<IndexDocumentsResult> indexDocumentsAsync(IndexDocumentsRequest indexDocumentsRequest) throws AmazonServiceException, AmazonClientException
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 necessary parameters to
execute the IndexDocuments operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<IndexDocumentsResult> indexDocumentsAsync(IndexDocumentsRequest indexDocumentsRequest, AsyncHandler<IndexDocumentsRequest,IndexDocumentsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary parameters to
execute the IndexDocuments operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeSuggestersResult> describeSuggestersAsync(DescribeSuggestersRequest describeSuggestersRequest) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeSuggesters operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeSuggestersResult> describeSuggestersAsync(DescribeSuggestersRequest describeSuggestersRequest, AsyncHandler<DescribeSuggestersRequest,DescribeSuggestersResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeSuggesters operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<UpdateScalingParametersResult> updateScalingParametersAsync(UpdateScalingParametersRequest updateScalingParametersRequest) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the UpdateScalingParameters operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<UpdateScalingParametersResult> updateScalingParametersAsync(UpdateScalingParametersRequest updateScalingParametersRequest, AsyncHandler<UpdateScalingParametersRequest,UpdateScalingParametersResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the UpdateScalingParameters operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest listDomainNamesRequest) throws AmazonServiceException, AmazonClientException
Lists all search domains owned by an account.
listDomainNamesRequest
- Container for the necessary parameters
to execute the ListDomainNames operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest listDomainNamesRequest, AsyncHandler<ListDomainNamesRequest,ListDomainNamesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists all search domains owned by an account.
listDomainNamesRequest
- Container for the necessary parameters
to execute the ListDomainNames operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest defineIndexFieldRequest) throws AmazonServiceException, AmazonClientException
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 necessary parameters
to execute the DefineIndexField operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest defineIndexFieldRequest, AsyncHandler<DefineIndexFieldRequest,DefineIndexFieldResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary parameters
to execute the DefineIndexField operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest) throws AmazonServiceException, AmazonClientException
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide .
createDomainRequest
- Container for the necessary parameters to
execute the CreateDomain operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide .
createDomainRequest
- Container for the necessary parameters to
execute the CreateDomain operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DeleteSuggesterResult> deleteSuggesterAsync(DeleteSuggesterRequest deleteSuggesterRequest) throws AmazonServiceException, AmazonClientException
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide .
deleteSuggesterRequest
- Container for the necessary parameters
to execute the DeleteSuggester operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DeleteSuggesterResult> deleteSuggesterAsync(DeleteSuggesterRequest deleteSuggesterRequest, AsyncHandler<DeleteSuggesterRequest,DeleteSuggesterResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide .
deleteSuggesterRequest
- Container for the necessary parameters
to execute the DeleteSuggester operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DeleteExpressionResult> deleteExpressionAsync(DeleteExpressionRequest deleteExpressionRequest) throws AmazonServiceException, AmazonClientException
Removes an Expression
from the search domain. For more
information, see
Configuring Expressions
in the Amazon CloudSearch Developer Guide .
deleteExpressionRequest
- Container for the necessary parameters
to execute the DeleteExpression operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DeleteExpressionResult> deleteExpressionAsync(DeleteExpressionRequest deleteExpressionRequest, AsyncHandler<DeleteExpressionRequest,DeleteExpressionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Removes an Expression
from the search domain. For more
information, see
Configuring Expressions
in the Amazon CloudSearch Developer Guide .
deleteExpressionRequest
- Container for the necessary parameters
to execute the DeleteExpression operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeAvailabilityOptionsResult> describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeAvailabilityOptions operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeAvailabilityOptionsResult> describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest, AsyncHandler<DescribeAvailabilityOptionsRequest,DescribeAvailabilityOptionsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeAvailabilityOptions operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DefineAnalysisSchemeResult> defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DefineAnalysisScheme operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DefineAnalysisSchemeResult> defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest, AsyncHandler<DefineAnalysisSchemeRequest,DefineAnalysisSchemeResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DefineAnalysisScheme operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<BuildSuggestersResult> buildSuggestersAsync(BuildSuggestersRequest buildSuggestersRequest) throws AmazonServiceException, AmazonClientException
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide .
buildSuggestersRequest
- Container for the necessary parameters
to execute the BuildSuggesters operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<BuildSuggestersResult> buildSuggestersAsync(BuildSuggestersRequest buildSuggestersRequest, AsyncHandler<BuildSuggestersRequest,BuildSuggestersResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide .
buildSuggestersRequest
- Container for the necessary parameters
to execute the BuildSuggesters operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) throws AmazonServiceException, AmazonClientException
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
necessary parameters to execute the DescribeServiceAccessPolicies
operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest, AsyncHandler<DescribeServiceAccessPoliciesRequest,DescribeServiceAccessPoliciesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
necessary parameters to execute the DescribeServiceAccessPolicies
operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest) throws AmazonServiceException, AmazonClientException
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 necessary parameters to
execute the DeleteDomain operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary parameters to
execute the DeleteDomain operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeExpressionsResult> describeExpressionsAsync(DescribeExpressionsRequest describeExpressionsRequest) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeExpressions operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeExpressionsResult> describeExpressionsAsync(DescribeExpressionsRequest describeExpressionsRequest, AsyncHandler<DescribeExpressionsRequest,DescribeExpressionsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeExpressions operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeDomainsResult> describeDomainsAsync(DescribeDomainsRequest describeDomainsRequest) throws AmazonServiceException, AmazonClientException
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 necessary parameters
to execute the DescribeDomains operation on AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeDomainsResult> describeDomainsAsync(DescribeDomainsRequest describeDomainsRequest, AsyncHandler<DescribeDomainsRequest,DescribeDomainsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary parameters
to execute the DescribeDomains operation on AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeScalingParametersResult> describeScalingParametersAsync(DescribeScalingParametersRequest describeScalingParametersRequest) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeScalingParameters operation on
AmazonCloudSearchv2.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Future<DescribeScalingParametersResult> describeScalingParametersAsync(DescribeScalingParametersRequest describeScalingParametersRequest, AsyncHandler<DescribeScalingParametersRequest,DescribeScalingParametersResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 necessary
parameters to execute the DescribeScalingParameters operation on
AmazonCloudSearchv2.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonCloudSearchv2 indicating
either a problem with the data in the request, or a server side issue.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.