public interface AmazonCloudSearchAsync extends AmazonCloudSearch
AsyncHandler
can be used to
receive notification when an asynchronous operation completes.
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.
ENDPOINT_PREFIX
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<BuildSuggestersResult> buildSuggestersAsync(BuildSuggestersRequest buildSuggestersRequest)
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.Future<BuildSuggestersResult> buildSuggestersAsync(BuildSuggestersRequest buildSuggestersRequest, AsyncHandler<BuildSuggestersRequest,BuildSuggestersResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest)
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.Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DefineAnalysisSchemeResult> defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest)
Configures an analysis scheme that can be applied to a text
or text-array
field to define language-specific text
processing options. For more information, see Configuring Analysis Schemes in the Amazon
CloudSearch Developer Guide.
defineAnalysisSchemeRequest
- Container for the parameters to the
DefineAnalysisScheme
operation. Specifies the
name of the domain you want to update and the analysis scheme
configuration.Future<DefineAnalysisSchemeResult> defineAnalysisSchemeAsync(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest, AsyncHandler<DefineAnalysisSchemeRequest,DefineAnalysisSchemeResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DefineExpressionResult> defineExpressionAsync(DefineExpressionRequest defineExpressionRequest)
Configures an Expression
for the search domain. Used
to create new expressions and modify existing ones. If the expression
exists, the new configuration replaces the old one. For more information,
see Configuring Expressions in the Amazon CloudSearch
Developer Guide.
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.Future<DefineExpressionResult> defineExpressionAsync(DefineExpressionRequest defineExpressionRequest, AsyncHandler<DefineExpressionRequest,DefineExpressionResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest defineIndexFieldRequest)
Configures an IndexField
for the search domain. Used
to create new fields and modify existing ones. You must specify the name
of the domain you are configuring and an index field configuration. The
index field configuration specifies a unique name, the index field type,
and the options you want to configure for the field. The options you can
specify depend on the IndexFieldType
. If the field
exists, the new configuration replaces the old one. For more information,
see Configuring Index Fields in the Amazon CloudSearch
Developer Guide.
defineIndexFieldRequest
- Container for the parameters to the
DefineIndexField
operation. Specifies the name
of the domain you want to update and the index field
configuration.Future<DefineIndexFieldResult> defineIndexFieldAsync(DefineIndexFieldRequest defineIndexFieldRequest, AsyncHandler<DefineIndexFieldRequest,DefineIndexFieldResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DefineSuggesterResult> defineSuggesterAsync(DefineSuggesterRequest defineSuggesterRequest)
Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
defineSuggesterRequest
- Container for the parameters to the
DefineSuggester
operation. Specifies the name
of the domain you want to update and the suggester configuration.Future<DefineSuggesterResult> defineSuggesterAsync(DefineSuggesterRequest defineSuggesterRequest, AsyncHandler<DefineSuggesterRequest,DefineSuggesterResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAnalysisSchemeResult> deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest)
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.Future<DeleteAnalysisSchemeResult> deleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest, AsyncHandler<DeleteAnalysisSchemeRequest,DeleteAnalysisSchemeResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest)
Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
deleteDomainRequest
- Container for the parameters to the
DeleteDomain
operation. Specifies the name of
the domain you want to delete.Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteExpressionResult> deleteExpressionAsync(DeleteExpressionRequest deleteExpressionRequest)
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.Future<DeleteExpressionResult> deleteExpressionAsync(DeleteExpressionRequest deleteExpressionRequest, AsyncHandler<DeleteExpressionRequest,DeleteExpressionResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest deleteIndexFieldRequest)
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.Future<DeleteIndexFieldResult> deleteIndexFieldAsync(DeleteIndexFieldRequest deleteIndexFieldRequest, AsyncHandler<DeleteIndexFieldRequest,DeleteIndexFieldResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteSuggesterResult> deleteSuggesterAsync(DeleteSuggesterRequest deleteSuggesterRequest)
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.Future<DeleteSuggesterResult> deleteSuggesterAsync(DeleteSuggesterRequest deleteSuggesterRequest, AsyncHandler<DeleteSuggesterRequest,DeleteSuggesterResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAnalysisSchemesResult> describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest)
Gets the analysis schemes configured for a domain. An analysis scheme
defines language-specific text processing options for a text
field. Can be limited to specific analysis schemes by name. By default,
shows all analysis schemes and includes any pending changes to the
configuration. Set the Deployed
option to true
to show the active configuration and exclude pending changes. For more
information, see Configuring Analysis Schemes in the Amazon
CloudSearch Developer Guide.
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
.Future<DescribeAnalysisSchemesResult> describeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest, AsyncHandler<DescribeAnalysisSchemesRequest,DescribeAnalysisSchemesResult> asyncHandler)
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
.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAvailabilityOptionsResult> describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest)
Gets the availability options configured for a domain. By default, shows
the configuration with any pending changes. Set the Deployed
option to true
to show the active configuration and exclude
pending changes. For more information, see Configuring Availability Options in the Amazon
CloudSearch Developer Guide.
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
.Future<DescribeAvailabilityOptionsResult> describeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest, AsyncHandler<DescribeAvailabilityOptionsRequest,DescribeAvailabilityOptionsResult> asyncHandler)
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
.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDomainsResult> describeDomainsAsync(DescribeDomainsRequest describeDomainsRequest)
Gets information about the search domains owned by this account. Can be
limited to specific domains. Shows all domains by default. To get the
number of searchable documents in a domain, use the console or submit a
matchall
request to your domain's search endpoint:
q=matchall&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.Future<DescribeDomainsResult> describeDomainsAsync(DescribeDomainsRequest describeDomainsRequest, AsyncHandler<DescribeDomainsRequest,DescribeDomainsResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDomainsResult> describeDomainsAsync()
Future<DescribeDomainsResult> describeDomainsAsync(AsyncHandler<DescribeDomainsRequest,DescribeDomainsResult> asyncHandler)
Future<DescribeExpressionsResult> describeExpressionsAsync(DescribeExpressionsRequest describeExpressionsRequest)
Gets the expressions configured for the search domain. Can be limited to
specific expressions by name. By default, shows all expressions and
includes any pending changes to the configuration. Set the
Deployed
option to true
to show the active
configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch
Developer Guide.
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
.Future<DescribeExpressionsResult> describeExpressionsAsync(DescribeExpressionsRequest describeExpressionsRequest, AsyncHandler<DescribeExpressionsRequest,DescribeExpressionsResult> asyncHandler)
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
.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest describeIndexFieldsRequest)
Gets information about the index fields configured for the search domain.
Can be limited to specific fields by name. By default, shows all fields
and includes any pending changes to the configuration. Set the
Deployed
option to true
to show the active
configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon
CloudSearch Developer Guide.
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
.Future<DescribeIndexFieldsResult> describeIndexFieldsAsync(DescribeIndexFieldsRequest describeIndexFieldsRequest, AsyncHandler<DescribeIndexFieldsRequest,DescribeIndexFieldsResult> asyncHandler)
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
.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeScalingParametersResult> describeScalingParametersAsync(DescribeScalingParametersRequest describeScalingParametersRequest)
Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
describeScalingParametersRequest
- Container for the parameters to the
DescribeScalingParameters
operation. Specifies
the name of the domain you want to describe.Future<DescribeScalingParametersResult> describeScalingParametersAsync(DescribeScalingParametersRequest describeScalingParametersRequest, AsyncHandler<DescribeScalingParametersRequest,DescribeScalingParametersResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)
Gets information about the access policies that control access to the
domain's document and search endpoints. By default, shows the
configuration with any pending changes. Set the Deployed
option to true
to show the active configuration and exclude
pending changes. For more information, see Configuring Access for a Search Domain in the
Amazon CloudSearch Developer Guide.
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
.Future<DescribeServiceAccessPoliciesResult> describeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest, AsyncHandler<DescribeServiceAccessPoliciesRequest,DescribeServiceAccessPoliciesResult> asyncHandler)
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
.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeSuggestersResult> describeSuggestersAsync(DescribeSuggestersRequest describeSuggestersRequest)
Gets the suggesters configured for a domain. A suggester enables you to
display possible matches before users finish typing their queries. Can be
limited to specific suggesters by name. By default, shows all suggesters
and includes any pending changes to the configuration. Set the
Deployed
option to true
to show the active
configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon
CloudSearch Developer Guide.
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
.Future<DescribeSuggestersResult> describeSuggestersAsync(DescribeSuggestersRequest describeSuggestersRequest, AsyncHandler<DescribeSuggestersRequest,DescribeSuggestersResult> asyncHandler)
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
.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<IndexDocumentsResult> indexDocumentsAsync(IndexDocumentsRequest indexDocumentsRequest)
Tells the search domain to start indexing its documents using the latest
indexing options. This operation must be invoked to activate options
whose OptionStatus is RequiresIndexDocuments
.
indexDocumentsRequest
- Container for the parameters to the
IndexDocuments
operation. Specifies the name
of the domain you want to re-index.Future<IndexDocumentsResult> indexDocumentsAsync(IndexDocumentsRequest indexDocumentsRequest, AsyncHandler<IndexDocumentsRequest,IndexDocumentsResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest listDomainNamesRequest)
Lists all search domains owned by an account.
listDomainNamesRequest
- Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest listDomainNamesRequest, AsyncHandler<ListDomainNamesRequest,ListDomainNamesResult> asyncHandler)
Lists all search domains owned by an account.
listDomainNamesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDomainNamesResult> listDomainNamesAsync()
Future<ListDomainNamesResult> listDomainNamesAsync(AsyncHandler<ListDomainNamesRequest,ListDomainNamesResult> asyncHandler)
Future<UpdateAvailabilityOptionsResult> updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest)
Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
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.Future<UpdateAvailabilityOptionsResult> updateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest, AsyncHandler<UpdateAvailabilityOptionsRequest,UpdateAvailabilityOptionsResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateScalingParametersResult> updateScalingParametersAsync(UpdateScalingParametersRequest updateScalingParametersRequest)
Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
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.Future<UpdateScalingParametersResult> updateScalingParametersAsync(UpdateScalingParametersRequest updateScalingParametersRequest, AsyncHandler<UpdateScalingParametersRequest,UpdateScalingParametersResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)
Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.
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.Future<UpdateServiceAccessPoliciesResult> updateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest, AsyncHandler<UpdateServiceAccessPoliciesRequest,UpdateServiceAccessPoliciesResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.