@ThreadSafe public class AmazonCloudSearchClient extends AmazonWebServiceClient implements 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.
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to
this client
|
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all modeled exceptions
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonCloudSearchClient()
Constructs a new client to invoke service methods on Amazon CloudSearch.
|
AmazonCloudSearchClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon CloudSearch
using the specified AWS account credentials.
|
AmazonCloudSearchClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon CloudSearch
using the specified AWS account credentials and client configuration
options.
|
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon CloudSearch
using the specified AWS account credentials provider.
|
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon CloudSearch
using the specified AWS account credentials provider and client
configuration options.
|
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon CloudSearch
using the specified AWS account credentials provider, client
configuration options, and request metric collector.
|
AmazonCloudSearchClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon CloudSearch.
|
Modifier and Type | Method and Description |
---|---|
BuildSuggestersResult |
buildSuggesters(BuildSuggestersRequest buildSuggestersRequest)
Indexes the search suggestions.
|
CreateDomainResult |
createDomain(CreateDomainRequest createDomainRequest)
Creates a new search domain.
|
DefineAnalysisSchemeResult |
defineAnalysisScheme(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest)
Configures an analysis scheme that can be applied to a
text
or text-array field to define language-specific text
processing options. |
DefineExpressionResult |
defineExpression(DefineExpressionRequest defineExpressionRequest)
Configures an
Expression for the search domain. |
DefineIndexFieldResult |
defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest)
Configures an
IndexField for the search domain. |
DefineSuggesterResult |
defineSuggester(DefineSuggesterRequest defineSuggesterRequest)
Configures a suggester for a domain.
|
DeleteAnalysisSchemeResult |
deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest)
Deletes an analysis scheme.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest deleteDomainRequest)
Permanently deletes a search domain and all of its data.
|
DeleteExpressionResult |
deleteExpression(DeleteExpressionRequest deleteExpressionRequest)
Removes an
Expression from the search domain. |
DeleteIndexFieldResult |
deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)
Removes an
IndexField from the search domain. |
DeleteSuggesterResult |
deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest)
Deletes a suggester.
|
DescribeAnalysisSchemesResult |
describeAnalysisSchemes(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest)
Gets the analysis schemes configured for a domain.
|
DescribeAvailabilityOptionsResult |
describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest)
Gets the availability options configured for a domain.
|
DescribeDomainsResult |
describeDomains()
Simplified method form for invoking the DescribeDomains operation.
|
DescribeDomainsResult |
describeDomains(DescribeDomainsRequest describeDomainsRequest)
Gets information about the search domains owned by this account.
|
DescribeExpressionsResult |
describeExpressions(DescribeExpressionsRequest describeExpressionsRequest)
Gets the expressions configured for the search domain.
|
DescribeIndexFieldsResult |
describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest)
Gets information about the index fields configured for the search domain.
|
DescribeScalingParametersResult |
describeScalingParameters(DescribeScalingParametersRequest describeScalingParametersRequest)
Gets the scaling parameters configured for a domain.
|
DescribeServiceAccessPoliciesResult |
describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)
Gets information about the access policies that control access to the
domain's document and search endpoints.
|
DescribeSuggestersResult |
describeSuggesters(DescribeSuggestersRequest describeSuggestersRequest)
Gets the suggesters configured for a domain.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful,
request, typically used for debugging issues where a service isn't acting
as expected.
|
IndexDocumentsResult |
indexDocuments(IndexDocumentsRequest indexDocumentsRequest)
Tells the search domain to start indexing its documents using the latest
indexing options.
|
ListDomainNamesResult |
listDomainNames()
Simplified method form for invoking the ListDomainNames operation.
|
ListDomainNamesResult |
listDomainNames(ListDomainNamesRequest listDomainNamesRequest)
Lists all search domains owned by an account.
|
UpdateAvailabilityOptionsResult |
updateAvailabilityOptions(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest)
Configures the availability options for a domain.
|
UpdateScalingParametersResult |
updateScalingParameters(UpdateScalingParametersRequest updateScalingParametersRequest)
Configures scaling parameters for a domain.
|
UpdateServiceAccessPoliciesResult |
updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)
Configures the access rules that control access to the domain's document
and search endpoints.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
public AmazonCloudSearchClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonCloudSearchClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to Amazon CloudSearch (ex: proxy settings, retry counts,
etc.).DefaultAWSCredentialsProviderChain
public AmazonCloudSearchClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonCloudSearchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon CloudSearch (ex: proxy settings, retry counts,
etc.).public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon CloudSearch (ex: proxy settings, retry counts,
etc.).public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon CloudSearch (ex: proxy settings, retry counts,
etc.).requestMetricCollector
- optional request metric collectorpublic BuildSuggestersResult buildSuggesters(BuildSuggestersRequest buildSuggestersRequest)
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
buildSuggesters
in interface AmazonCloudSearch
buildSuggestersRequest
- Container for the parameters to the
BuildSuggester
operation. Specifies the name
of the domain you want to update.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
createDomain
in interface AmazonCloudSearch
createDomainRequest
- Container for the parameters to the
CreateDomain
operation. Specifies a name for
the new search domain.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.LimitExceededException
- The request was rejected because a resource limit has already
been met.public DefineAnalysisSchemeResult defineAnalysisScheme(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest)
Configures an analysis scheme that can be applied to a text
or text-array
field to define language-specific text
processing options. For more information, see Configuring Analysis Schemes in the Amazon
CloudSearch Developer Guide.
defineAnalysisScheme
in interface AmazonCloudSearch
defineAnalysisSchemeRequest
- Container for the parameters to the
DefineAnalysisScheme
operation. Specifies the
name of the domain you want to update and the analysis scheme
configuration.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.LimitExceededException
- The request was rejected because a resource limit has already
been met.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DefineExpressionResult defineExpression(DefineExpressionRequest defineExpressionRequest)
Configures an Expression
for the search domain. Used
to create new expressions and modify existing ones. If the expression
exists, the new configuration replaces the old one. For more information,
see Configuring Expressions in the Amazon CloudSearch
Developer Guide.
defineExpression
in interface AmazonCloudSearch
defineExpressionRequest
- Container for the parameters to the
DefineExpression
operation. Specifies the name
of the domain you want to update and the expression you want to
configure.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.LimitExceededException
- The request was rejected because a resource limit has already
been met.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DefineIndexFieldResult defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest)
Configures an IndexField
for the search domain. Used
to create new fields and modify existing ones. You must specify the name
of the domain you are configuring and an index field configuration. The
index field configuration specifies a unique name, the index field type,
and the options you want to configure for the field. The options you can
specify depend on the IndexFieldType
. If the field
exists, the new configuration replaces the old one. For more information,
see Configuring Index Fields in the Amazon CloudSearch
Developer Guide.
defineIndexField
in interface AmazonCloudSearch
defineIndexFieldRequest
- Container for the parameters to the
DefineIndexField
operation. Specifies the name
of the domain you want to update and the index field
configuration.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.LimitExceededException
- The request was rejected because a resource limit has already
been met.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DefineSuggesterResult defineSuggester(DefineSuggesterRequest defineSuggesterRequest)
Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
defineSuggester
in interface AmazonCloudSearch
defineSuggesterRequest
- Container for the parameters to the
DefineSuggester
operation. Specifies the name
of the domain you want to update and the suggester configuration.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.LimitExceededException
- The request was rejected because a resource limit has already
been met.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DeleteAnalysisSchemeResult deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest)
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
deleteAnalysisScheme
in interface AmazonCloudSearch
deleteAnalysisSchemeRequest
- Container for the parameters to the
DeleteAnalysisScheme
operation. Specifies the
name of the domain you want to update and the analysis scheme you
want to delete.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
deleteDomain
in interface AmazonCloudSearch
deleteDomainRequest
- Container for the parameters to the
DeleteDomain
operation. Specifies the name of
the domain you want to delete.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.public DeleteExpressionResult deleteExpression(DeleteExpressionRequest deleteExpressionRequest)
Removes an Expression
from the search domain. For
more information, see Configuring Expressions in the Amazon CloudSearch
Developer Guide.
deleteExpression
in interface AmazonCloudSearch
deleteExpressionRequest
- Container for the parameters to the
DeleteExpression
operation. Specifies the name
of the domain you want to update and the name of the expression
you want to delete.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DeleteIndexFieldResult deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)
Removes an IndexField
from the search domain. For
more information, see Configuring Index Fields in the Amazon CloudSearch
Developer Guide.
deleteIndexField
in interface AmazonCloudSearch
deleteIndexFieldRequest
- Container for the parameters to the
DeleteIndexField
operation. Specifies the name
of the domain you want to update and the name of the index field
you want to delete.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DeleteSuggesterResult deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest)
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
deleteSuggester
in interface AmazonCloudSearch
deleteSuggesterRequest
- Container for the parameters to the
DeleteSuggester
operation. Specifies the name
of the domain you want to update and name of the suggester you
want to delete.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DescribeAnalysisSchemesResult describeAnalysisSchemes(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest)
Gets the analysis schemes configured for a domain. An analysis scheme
defines language-specific text processing options for a text
field. Can be limited to specific analysis schemes by name. By default,
shows all analysis schemes and includes any pending changes to the
configuration. Set the Deployed
option to true
to show the active configuration and exclude pending changes. For more
information, see Configuring Analysis Schemes in the Amazon
CloudSearch Developer Guide.
describeAnalysisSchemes
in interface AmazonCloudSearch
describeAnalysisSchemesRequest
- Container for the parameters to the
DescribeAnalysisSchemes
operation. Specifies
the name of the domain you want to describe. To limit the response
to particular analysis schemes, specify the names of the analysis
schemes you want to describe. To show the active configuration and
exclude any pending changes, set the Deployed
option
to true
.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DescribeAvailabilityOptionsResult describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest)
Gets the availability options configured for a domain. By default, shows
the configuration with any pending changes. Set the Deployed
option to true
to show the active configuration and exclude
pending changes. For more information, see Configuring Availability Options in the Amazon
CloudSearch Developer Guide.
describeAvailabilityOptions
in interface AmazonCloudSearch
describeAvailabilityOptionsRequest
- Container for the parameters to the
DescribeAvailabilityOptions
operation.
Specifies the name of the domain you want to describe. To show the
active configuration and exclude any pending changes, set the
Deployed option to true
.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.LimitExceededException
- The request was rejected because a resource limit has already
been met.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.DisabledOperationException
- The request was rejected because it attempted an operation which
is not enabled.public DescribeDomainsResult describeDomains(DescribeDomainsRequest describeDomainsRequest)
Gets information about the search domains owned by this account. Can be
limited to specific domains. Shows all domains by default. To get the
number of searchable documents in a domain, use the console or submit a
matchall
request to your domain's search endpoint:
q=matchall&q.parser=structured&size=0
. For
more information, see Getting Information about a Search Domain in the
Amazon CloudSearch Developer Guide.
describeDomains
in interface AmazonCloudSearch
describeDomainsRequest
- Container for the parameters to the
DescribeDomains
operation. By default shows
the status of all domains. To restrict the response to particular
domains, specify the names of the domains you want to describe.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.public DescribeDomainsResult describeDomains()
AmazonCloudSearch
describeDomains
in interface AmazonCloudSearch
AmazonCloudSearch.describeDomains(DescribeDomainsRequest)
public DescribeExpressionsResult describeExpressions(DescribeExpressionsRequest describeExpressionsRequest)
Gets the expressions configured for the search domain. Can be limited to
specific expressions by name. By default, shows all expressions and
includes any pending changes to the configuration. Set the
Deployed
option to true
to show the active
configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch
Developer Guide.
describeExpressions
in interface AmazonCloudSearch
describeExpressionsRequest
- Container for the parameters to the
DescribeDomains
operation. Specifies the name
of the domain you want to describe. To restrict the response to
particular expressions, specify the names of the expressions you
want to describe. To show the active configuration and exclude any
pending changes, set the Deployed
option to
true
.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DescribeIndexFieldsResult describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest)
Gets information about the index fields configured for the search domain.
Can be limited to specific fields by name. By default, shows all fields
and includes any pending changes to the configuration. Set the
Deployed
option to true
to show the active
configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon
CloudSearch Developer Guide.
describeIndexFields
in interface AmazonCloudSearch
describeIndexFieldsRequest
- Container for the parameters to the
DescribeIndexFields
operation. Specifies the
name of the domain you want to describe. To restrict the response
to particular index fields, specify the names of the index fields
you want to describe. To show the active configuration and exclude
any pending changes, set the Deployed
option to
true
.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DescribeScalingParametersResult describeScalingParameters(DescribeScalingParametersRequest describeScalingParametersRequest)
Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
describeScalingParameters
in interface AmazonCloudSearch
describeScalingParametersRequest
- Container for the parameters to the
DescribeScalingParameters
operation. Specifies
the name of the domain you want to describe.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DescribeServiceAccessPoliciesResult describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)
Gets information about the access policies that control access to the
domain's document and search endpoints. By default, shows the
configuration with any pending changes. Set the Deployed
option to true
to show the active configuration and exclude
pending changes. For more information, see Configuring Access for a Search Domain in the
Amazon CloudSearch Developer Guide.
describeServiceAccessPolicies
in interface AmazonCloudSearch
describeServiceAccessPoliciesRequest
- Container for the parameters to the
DescribeServiceAccessPolicies
operation.
Specifies the name of the domain you want to describe. To show the
active configuration and exclude any pending changes, set the
Deployed
option to true
.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public DescribeSuggestersResult describeSuggesters(DescribeSuggestersRequest describeSuggestersRequest)
Gets the suggesters configured for a domain. A suggester enables you to
display possible matches before users finish typing their queries. Can be
limited to specific suggesters by name. By default, shows all suggesters
and includes any pending changes to the configuration. Set the
Deployed
option to true
to show the active
configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon
CloudSearch Developer Guide.
describeSuggesters
in interface AmazonCloudSearch
describeSuggestersRequest
- Container for the parameters to the
DescribeSuggester
operation. Specifies the
name of the domain you want to describe. To restrict the response
to particular suggesters, specify the names of the suggesters you
want to describe. To show the active configuration and exclude any
pending changes, set the Deployed
option to
true
.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public IndexDocumentsResult indexDocuments(IndexDocumentsRequest indexDocumentsRequest)
Tells the search domain to start indexing its documents using the latest
indexing options. This operation must be invoked to activate options
whose OptionStatus is RequiresIndexDocuments
.
indexDocuments
in interface AmazonCloudSearch
indexDocumentsRequest
- Container for the parameters to the
IndexDocuments
operation. Specifies the name
of the domain you want to re-index.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.public ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest)
Lists all search domains owned by an account.
listDomainNames
in interface AmazonCloudSearch
listDomainNamesRequest
- BaseException
- An error occurred while processing the request.public ListDomainNamesResult listDomainNames()
AmazonCloudSearch
listDomainNames
in interface AmazonCloudSearch
AmazonCloudSearch.listDomainNames(ListDomainNamesRequest)
public UpdateAvailabilityOptionsResult updateAvailabilityOptions(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest)
Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
updateAvailabilityOptions
in interface AmazonCloudSearch
updateAvailabilityOptionsRequest
- Container for the parameters to the
UpdateAvailabilityOptions
operation. Specifies
the name of the domain you want to update and the Multi-AZ
availability option.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.LimitExceededException
- The request was rejected because a resource limit has already
been met.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.DisabledOperationException
- The request was rejected because it attempted an operation which
is not enabled.public UpdateScalingParametersResult updateScalingParameters(UpdateScalingParametersRequest updateScalingParametersRequest)
Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
updateScalingParameters
in interface AmazonCloudSearch
updateScalingParametersRequest
- Container for the parameters to the
UpdateScalingParameters
operation. Specifies
the name of the domain you want to update and the scaling
parameters you want to configure.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.LimitExceededException
- The request was rejected because a resource limit has already
been met.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.public UpdateServiceAccessPoliciesResult updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)
Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.
updateServiceAccessPolicies
in interface AmazonCloudSearch
updateServiceAccessPoliciesRequest
- Container for the parameters to the
UpdateServiceAccessPolicies
operation.
Specifies the name of the domain you want to update and the access
rules you want to configure.BaseException
- An error occurred while processing the request.InternalException
- An internal error occurred while processing the request. If this
problem persists, report an issue from the Service
Health Dashboard.LimitExceededException
- The request was rejected because a resource limit has already
been met.ResourceNotFoundException
- The request was rejected because it attempted to reference a
resource that does not exist.InvalidTypeException
- The request was rejected because it specified an invalid type
definition.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonCloudSearch
request
- The originally executed requestCopyright © 2018. All rights reserved.