Class AmazonCloudSearchClient
- All Implemented Interfaces:
AmazonCloudSearch
- Direct Known Subclasses:
AmazonCloudSearchAsyncClient
You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.
The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final ClientConfigurationFactory
Client configuration factory providing ClientConfigurations tailored to this clientprotected final List
<com.amazonaws.transform.Unmarshaller<AmazonServiceException, Node>> List of exception unmarshallers for all modeled exceptionsFields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs 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
(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
(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
(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon CloudSearch. -
Method Summary
Modifier and TypeMethodDescriptionbuildSuggesters
(BuildSuggestersRequest buildSuggestersRequest) Indexes the search suggestions.createDomain
(CreateDomainRequest createDomainRequest) Creates a new search domain.defineAnalysisScheme
(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest) Configures an analysis scheme that can be applied to atext
ortext-array
field to define language-specific text processing options.defineExpression
(DefineExpressionRequest defineExpressionRequest) Configures anExpression
for the search domain.defineIndexField
(DefineIndexFieldRequest defineIndexFieldRequest) Configures anIndexField
for the search domain.defineSuggester
(DefineSuggesterRequest defineSuggesterRequest) Configures a suggester for a domain.deleteAnalysisScheme
(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest) Deletes an analysis scheme.deleteDomain
(DeleteDomainRequest deleteDomainRequest) Permanently deletes a search domain and all of its data.deleteExpression
(DeleteExpressionRequest deleteExpressionRequest) Removes anExpression
from the search domain.deleteIndexField
(DeleteIndexFieldRequest deleteIndexFieldRequest) Removes anIndexField
from the search domain.deleteSuggester
(DeleteSuggesterRequest deleteSuggesterRequest) Deletes a suggester.describeAnalysisSchemes
(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest) Gets the analysis schemes configured for a domain.describeAvailabilityOptions
(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest) Gets the availability options configured for a domain.Simplified method form for invoking the DescribeDomains operation.describeDomains
(DescribeDomainsRequest describeDomainsRequest) Gets information about the search domains owned by this account.describeExpressions
(DescribeExpressionsRequest describeExpressionsRequest) Gets the expressions configured for the search domain.describeIndexFields
(DescribeIndexFieldsRequest describeIndexFieldsRequest) Gets information about the index fields configured for the search domain.describeScalingParameters
(DescribeScalingParametersRequest describeScalingParametersRequest) Gets the scaling parameters configured for a domain.describeServiceAccessPolicies
(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) Gets information about the access policies that control access to the domain's document and search endpoints.describeSuggesters
(DescribeSuggestersRequest describeSuggestersRequest) Gets the suggesters configured for a domain.Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.indexDocuments
(IndexDocumentsRequest indexDocumentsRequest) Tells the search domain to start indexing its documents using the latest indexing options.Simplified method form for invoking the ListDomainNames operation.listDomainNames
(ListDomainNamesRequest listDomainNamesRequest) Lists all search domains owned by an account.updateAvailabilityOptions
(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest) Configures the availability options for a domain.updateScalingParameters
(UpdateScalingParametersRequest updateScalingParametersRequest) Configures scaling parameters for a domain.updateServiceAccessPolicies
(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) Configures the access rules that control access to the domain's document and search endpoints.Methods inherited from class com.amazonaws.AmazonWebServiceClient
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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.cloudsearchv2.AmazonCloudSearch
setEndpoint, setRegion, shutdown
-
Field Details
-
configFactory
Client configuration factory providing ClientConfigurations tailored to this client -
exceptionUnmarshallers
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallersList of exception unmarshallers for all modeled exceptions
-
-
Constructor Details
-
AmazonCloudSearchClient
public AmazonCloudSearchClient()Constructs a new client to invoke service methods on Amazon CloudSearch. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
-
AmazonCloudSearchClient
Constructs a new client to invoke service methods on Amazon CloudSearch. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to Amazon CloudSearch (ex: proxy settings, retry counts, etc.).- See Also:
-
AmazonCloudSearchClient
Constructs a new client to invoke service methods on Amazon CloudSearch using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AmazonCloudSearchClient
public 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.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
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.).
-
AmazonCloudSearchClient
Constructs a new client to invoke service methods on Amazon CloudSearch using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AmazonCloudSearchClient
public 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.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
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.).
-
AmazonCloudSearchClient
public 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.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
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 collector
-
-
Method Details
-
buildSuggesters
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
- Specified by:
buildSuggesters
in interfaceAmazonCloudSearch
- Parameters:
buildSuggestersRequest
- Container for the parameters to theBuildSuggester
operation. Specifies the name of the domain you want to update.- Returns:
- Result of the BuildSuggesters operation returned by the service.
- Throws:
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.
-
createDomain
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
- Specified by:
createDomain
in interfaceAmazonCloudSearch
- Parameters:
createDomainRequest
- Container for the parameters to theCreateDomain
operation. Specifies a name for the new search domain.- Returns:
- Result of the CreateDomain operation returned by the service.
- Throws:
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.
-
defineAnalysisScheme
public DefineAnalysisSchemeResult defineAnalysisScheme(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest) Configures an analysis scheme that can be applied to a
text
ortext-array
field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.- Specified by:
defineAnalysisScheme
in interfaceAmazonCloudSearch
- Parameters:
defineAnalysisSchemeRequest
- Container for the parameters to theDefineAnalysisScheme
operation. Specifies the name of the domain you want to update and the analysis scheme configuration.- Returns:
- Result of the DefineAnalysisScheme operation returned by the service.
- Throws:
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.
-
defineExpression
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.- Specified by:
defineExpression
in interfaceAmazonCloudSearch
- Parameters:
defineExpressionRequest
- Container for the parameters to theDefineExpression
operation. Specifies the name of the domain you want to update and the expression you want to configure.- Returns:
- Result of the DefineExpression operation returned by the service.
- Throws:
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.
-
defineIndexField
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 theIndexFieldType
. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.- Specified by:
defineIndexField
in interfaceAmazonCloudSearch
- Parameters:
defineIndexFieldRequest
- Container for the parameters to theDefineIndexField
operation. Specifies the name of the domain you want to update and the index field configuration.- Returns:
- Result of the DefineIndexField operation returned by the service.
- Throws:
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.
-
defineSuggester
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.
- Specified by:
defineSuggester
in interfaceAmazonCloudSearch
- Parameters:
defineSuggesterRequest
- Container for the parameters to theDefineSuggester
operation. Specifies the name of the domain you want to update and the suggester configuration.- Returns:
- Result of the DefineSuggester operation returned by the service.
- Throws:
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.
-
deleteAnalysisScheme
public DeleteAnalysisSchemeResult deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest) Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
- Specified by:
deleteAnalysisScheme
in interfaceAmazonCloudSearch
- Parameters:
deleteAnalysisSchemeRequest
- Container for the parameters to theDeleteAnalysisScheme
operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.- Returns:
- Result of the DeleteAnalysisScheme operation returned by the service.
- Throws:
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.
-
deleteDomain
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.
- Specified by:
deleteDomain
in interfaceAmazonCloudSearch
- Parameters:
deleteDomainRequest
- Container for the parameters to theDeleteDomain
operation. Specifies the name of the domain you want to delete.- Returns:
- Result of the DeleteDomain operation returned by the service.
- Throws:
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.
-
deleteExpression
Removes an
Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.- Specified by:
deleteExpression
in interfaceAmazonCloudSearch
- Parameters:
deleteExpressionRequest
- Container for the parameters to theDeleteExpression
operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.- Returns:
- Result of the DeleteExpression operation returned by the service.
- Throws:
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.
-
deleteIndexField
Removes an
IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.- Specified by:
deleteIndexField
in interfaceAmazonCloudSearch
- Parameters:
deleteIndexFieldRequest
- Container for the parameters to theDeleteIndexField
operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.- Returns:
- Result of the DeleteIndexField operation returned by the service.
- Throws:
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.
-
deleteSuggester
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
- Specified by:
deleteSuggester
in interfaceAmazonCloudSearch
- Parameters:
deleteSuggesterRequest
- Container for the parameters to theDeleteSuggester
operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.- Returns:
- Result of the DeleteSuggester operation returned by the service.
- Throws:
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.
-
describeAnalysisSchemes
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 theDeployed
option totrue
to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.- Specified by:
describeAnalysisSchemes
in interfaceAmazonCloudSearch
- Parameters:
describeAnalysisSchemesRequest
- Container for the parameters to theDescribeAnalysisSchemes
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 theDeployed
option totrue
.- Returns:
- Result of the DescribeAnalysisSchemes operation returned by the service.
- Throws:
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.
-
describeAvailabilityOptions
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 totrue
to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.- Specified by:
describeAvailabilityOptions
in interfaceAmazonCloudSearch
- Parameters:
describeAvailabilityOptionsRequest
- Container for the parameters to theDescribeAvailabilityOptions
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 totrue
.- Returns:
- Result of the DescribeAvailabilityOptions operation returned by the service.
- Throws:
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.
-
describeDomains
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.- Specified by:
describeDomains
in interfaceAmazonCloudSearch
- Parameters:
describeDomainsRequest
- Container for the parameters to theDescribeDomains
operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.- Returns:
- Result of the DescribeDomains operation returned by the service.
- Throws:
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.
-
describeDomains
Description copied from interface:AmazonCloudSearch
Simplified method form for invoking the DescribeDomains operation.- Specified by:
describeDomains
in interfaceAmazonCloudSearch
- See Also:
-
describeExpressions
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 totrue
to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.- Specified by:
describeExpressions
in interfaceAmazonCloudSearch
- Parameters:
describeExpressionsRequest
- Container for the parameters to theDescribeDomains
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 theDeployed
option totrue
.- Returns:
- Result of the DescribeExpressions operation returned by the service.
- Throws:
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.
-
describeIndexFields
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 totrue
to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.- Specified by:
describeIndexFields
in interfaceAmazonCloudSearch
- Parameters:
describeIndexFieldsRequest
- Container for the parameters to theDescribeIndexFields
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 theDeployed
option totrue
.- Returns:
- Result of the DescribeIndexFields operation returned by the service.
- Throws:
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.
-
describeScalingParameters
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.
- Specified by:
describeScalingParameters
in interfaceAmazonCloudSearch
- Parameters:
describeScalingParametersRequest
- Container for the parameters to theDescribeScalingParameters
operation. Specifies the name of the domain you want to describe.- Returns:
- Result of the DescribeScalingParameters operation returned by the service.
- Throws:
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.
-
describeServiceAccessPolicies
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 totrue
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.- Specified by:
describeServiceAccessPolicies
in interfaceAmazonCloudSearch
- Parameters:
describeServiceAccessPoliciesRequest
- Container for the parameters to theDescribeServiceAccessPolicies
operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set theDeployed
option totrue
.- Returns:
- Result of the DescribeServiceAccessPolicies operation returned by the service.
- Throws:
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.
-
describeSuggesters
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 totrue
to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.- Specified by:
describeSuggesters
in interfaceAmazonCloudSearch
- Parameters:
describeSuggestersRequest
- Container for the parameters to theDescribeSuggester
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 theDeployed
option totrue
.- Returns:
- Result of the DescribeSuggesters operation returned by the service.
- Throws:
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.
-
indexDocuments
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
.- Specified by:
indexDocuments
in interfaceAmazonCloudSearch
- Parameters:
indexDocumentsRequest
- Container for the parameters to theIndexDocuments
operation. Specifies the name of the domain you want to re-index.- Returns:
- Result of the IndexDocuments operation returned by the service.
- Throws:
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.
-
listDomainNames
Lists all search domains owned by an account.
- Specified by:
listDomainNames
in interfaceAmazonCloudSearch
- Parameters:
listDomainNamesRequest
-- Returns:
- Result of the ListDomainNames operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.
-
listDomainNames
Description copied from interface:AmazonCloudSearch
Simplified method form for invoking the ListDomainNames operation.- Specified by:
listDomainNames
in interfaceAmazonCloudSearch
- See Also:
-
updateAvailabilityOptions
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.
- Specified by:
updateAvailabilityOptions
in interfaceAmazonCloudSearch
- Parameters:
updateAvailabilityOptionsRequest
- Container for the parameters to theUpdateAvailabilityOptions
operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.- Returns:
- Result of the UpdateAvailabilityOptions operation returned by the service.
- Throws:
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.
-
updateScalingParameters
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.
- Specified by:
updateScalingParameters
in interfaceAmazonCloudSearch
- Parameters:
updateScalingParametersRequest
- Container for the parameters to theUpdateScalingParameters
operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.- Returns:
- Result of the UpdateScalingParameters operation returned by the service.
- Throws:
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.
-
updateServiceAccessPolicies
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.
- Specified by:
updateServiceAccessPolicies
in interfaceAmazonCloudSearch
- Parameters:
updateServiceAccessPoliciesRequest
- Container for the parameters to theUpdateServiceAccessPolicies
operation. Specifies the name of the domain you want to update and the access rules you want to configure.- Returns:
- Result of the UpdateServiceAccessPolicies operation returned by the service.
- Throws:
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.
-
getCachedResponseMetadata
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.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.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonCloudSearch
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-