com.amazonaws.services.cloudsearchv2

Class AmazonCloudSearchClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudsearchv2.AmazonCloudSearchClient

All Implemented Interfaces:

AmazonCloudSearch

Direct Known Subclasses:

AmazonCloudSearchAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonCloudSearchClient
extends AmazonWebServiceClient
implements AmazonCloudSearch

Client for accessing Amazon CloudSearch. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon CloudSearch Configuration Service

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.cloudsearchv2.AmazonCloudSearch

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonCloudSearchClient() Deprecated. use AmazonCloudSearchClientBuilder.defaultClient()
AmazonCloudSearchClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCloudSearchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonCloudSearchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonCloudSearchClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AmazonCloudSearchClientBuilder	builder()
BuildSuggestersResult	buildSuggesters(BuildSuggestersRequest request) Indexes the search suggestions.
CreateDomainResult	createDomain(CreateDomainRequest request) Creates a new search domain.
DefineAnalysisSchemeResult	defineAnalysisScheme(DefineAnalysisSchemeRequest request) 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 request) Configures an Expression for the search domain.
DefineIndexFieldResult	defineIndexField(DefineIndexFieldRequest request) Configures an IndexField for the search domain.
DefineSuggesterResult	defineSuggester(DefineSuggesterRequest request) Configures a suggester for a domain.
DeleteAnalysisSchemeResult	deleteAnalysisScheme(DeleteAnalysisSchemeRequest request) Deletes an analysis scheme.
DeleteDomainResult	deleteDomain(DeleteDomainRequest request) Permanently deletes a search domain and all of its data.
DeleteExpressionResult	deleteExpression(DeleteExpressionRequest request) Removes an Expression from the search domain.
DeleteIndexFieldResult	deleteIndexField(DeleteIndexFieldRequest request) Removes an IndexField from the search domain.
DeleteSuggesterResult	deleteSuggester(DeleteSuggesterRequest request) Deletes a suggester.
DescribeAnalysisSchemesResult	describeAnalysisSchemes(DescribeAnalysisSchemesRequest request) Gets the analysis schemes configured for a domain.
DescribeAvailabilityOptionsResult	describeAvailabilityOptions(DescribeAvailabilityOptionsRequest request) Gets the availability options configured for a domain.
DescribeDomainEndpointOptionsResult	describeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest request) Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
DescribeDomainsResult	describeDomains() Simplified method form for invoking the DescribeDomains operation.
DescribeDomainsResult	describeDomains(DescribeDomainsRequest request) Gets information about the search domains owned by this account.
DescribeExpressionsResult	describeExpressions(DescribeExpressionsRequest request) Gets the expressions configured for the search domain.
DescribeIndexFieldsResult	describeIndexFields(DescribeIndexFieldsRequest request) Gets information about the index fields configured for the search domain.
DescribeScalingParametersResult	describeScalingParameters(DescribeScalingParametersRequest request) Gets the scaling parameters configured for a domain.
DescribeServiceAccessPoliciesResult	describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest request) Gets information about the access policies that control access to the domain's document and search endpoints.
DescribeSuggestersResult	describeSuggesters(DescribeSuggestersRequest request) 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 request) 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 request) Lists all search domains owned by an account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateAvailabilityOptionsResult	updateAvailabilityOptions(UpdateAvailabilityOptionsRequest request) Configures the availability options for a domain.
UpdateDomainEndpointOptionsResult	updateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest request) Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
UpdateScalingParametersResult	updateScalingParameters(UpdateScalingParametersRequest request) Configures scaling parameters for a domain.
UpdateServiceAccessPoliciesResult	updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest request) Configures the access rules that control access to the domain's document and search endpoints.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cloudsearchv2.AmazonCloudSearch

setEndpoint, setRegion

Constructor Detail

AmazonCloudSearchClient

@Deprecated
public AmazonCloudSearchClient()

Deprecated. use AmazonCloudSearchClientBuilder.defaultClient()

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:

DefaultAWSCredentialsProviderChain

AmazonCloudSearchClient

@Deprecated
public AmazonCloudSearchClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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:

DefaultAWSCredentialsProviderChain

AmazonCloudSearchClient

@Deprecated
public AmazonCloudSearchClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCloudSearchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

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

@Deprecated
public AmazonCloudSearchClient(AWSCredentials awsCredentials,
                                           ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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

@Deprecated
public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

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

@Deprecated
public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider,
                                           ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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

@Deprecated
public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider,
                                           ClientConfiguration clientConfiguration,
                                           RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(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 Detail

builder

public static AmazonCloudSearchClientBuilder builder()

buildSuggesters

public BuildSuggestersResult buildSuggesters(BuildSuggestersRequest request)

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

Specified by:

buildSuggesters in interface AmazonCloudSearch

Parameters:

buildSuggestersRequest - Container for the parameters to the BuildSuggester 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.

ValidationException - The request was rejected because it has invalid parameters.

createDomain

public CreateDomainResult createDomain(CreateDomainRequest request)

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

Specified by:

createDomain in interface AmazonCloudSearch

Parameters:

createDomainRequest - Container for the parameters to the CreateDomain 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.

ResourceAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.

ValidationException - The request was rejected because it has invalid parameters.

defineAnalysisScheme

public DefineAnalysisSchemeResult defineAnalysisScheme(DefineAnalysisSchemeRequest request)

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.

Specified by:

defineAnalysisScheme in interface AmazonCloudSearch

Parameters:

defineAnalysisSchemeRequest - Container for the parameters to the DefineAnalysisScheme 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.

ValidationException - The request was rejected because it has invalid parameters.

defineExpression

public DefineExpressionResult defineExpression(DefineExpressionRequest request)

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 interface AmazonCloudSearch

Parameters:

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.

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.

ValidationException - The request was rejected because it has invalid parameters.

defineIndexField

public DefineIndexFieldResult defineIndexField(DefineIndexFieldRequest request)

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.

Specified by:

defineIndexField in interface AmazonCloudSearch

Parameters:

defineIndexFieldRequest - Container for the parameters to the DefineIndexField 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.

ValidationException - The request was rejected because it has invalid parameters.

defineSuggester

public DefineSuggesterResult defineSuggester(DefineSuggesterRequest request)

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 interface AmazonCloudSearch

Parameters:

defineSuggesterRequest - Container for the parameters to the DefineSuggester 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.

ValidationException - The request was rejected because it has invalid parameters.

deleteAnalysisScheme

public DeleteAnalysisSchemeResult deleteAnalysisScheme(DeleteAnalysisSchemeRequest request)

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Specified by:

deleteAnalysisScheme in interface AmazonCloudSearch

Parameters:

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.

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.

ValidationException - The request was rejected because it has invalid parameters.

deleteDomain

public DeleteDomainResult deleteDomain(DeleteDomainRequest request)

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 interface AmazonCloudSearch

Parameters:

deleteDomainRequest - Container for the parameters to the DeleteDomain 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

public DeleteExpressionResult deleteExpression(DeleteExpressionRequest request)

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Specified by:

deleteExpression in interface AmazonCloudSearch

Parameters:

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.

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.

ValidationException - The request was rejected because it has invalid parameters.

deleteIndexField

public DeleteIndexFieldResult deleteIndexField(DeleteIndexFieldRequest request)

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Specified by:

deleteIndexField in interface AmazonCloudSearch

Parameters:

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.

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.

ValidationException - The request was rejected because it has invalid parameters.

deleteSuggester

public DeleteSuggesterResult deleteSuggester(DeleteSuggesterRequest request)

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Specified by:

deleteSuggester in interface AmazonCloudSearch

Parameters:

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.

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.

ValidationException - The request was rejected because it has invalid parameters.

describeAnalysisSchemes

public DescribeAnalysisSchemesResult describeAnalysisSchemes(DescribeAnalysisSchemesRequest request)

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.

Specified by:

describeAnalysisSchemes in interface AmazonCloudSearch

Parameters:

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.

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 request)

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.

Specified by:

describeAvailabilityOptions in interface AmazonCloudSearch

Parameters:

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.

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.

describeDomainEndpointOptions

public DescribeDomainEndpointOptionsResult describeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest request)

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

Specified by:

describeDomainEndpointOptions in interface AmazonCloudSearch

Parameters:

describeDomainEndpointOptionsRequest - Container for the parameters to the DescribeDomainEndpointOptions operation. Specify 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.

Returns:

Result of the DescribeDomainEndpointOptions 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.

DisabledOperationException - The request was rejected because it attempted an operation which is not enabled.

describeDomains

public DescribeDomainsResult describeDomains(DescribeDomainsRequest request)

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 interface AmazonCloudSearch

Parameters:

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.

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

public DescribeDomainsResult describeDomains()

Description copied from interface: AmazonCloudSearch

Simplified method form for invoking the DescribeDomains operation.

Specified by:

describeDomains in interface AmazonCloudSearch

See Also:

AmazonCloudSearch.describeDomains(DescribeDomainsRequest)

describeExpressions

public DescribeExpressionsResult describeExpressions(DescribeExpressionsRequest request)

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.

Specified by:

describeExpressions in interface AmazonCloudSearch

Parameters:

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.

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 request)

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.

Specified by:

describeIndexFields in interface AmazonCloudSearch

Parameters:

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.

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 request)

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 interface AmazonCloudSearch

Parameters:

describeScalingParametersRequest - Container for the parameters to the DescribeScalingParameters 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 request)

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.

Specified by:

describeServiceAccessPolicies in interface AmazonCloudSearch

Parameters:

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.

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 request)

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.

Specified by:

describeSuggesters in interface AmazonCloudSearch

Parameters:

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.

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

public IndexDocumentsResult indexDocuments(IndexDocumentsRequest request)

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 interface AmazonCloudSearch

Parameters:

indexDocumentsRequest - Container for the parameters to the IndexDocuments 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.

ValidationException - The request was rejected because it has invalid parameters.

listDomainNames

public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)

Lists all search domains owned by an account.

Specified by:

listDomainNames in interface AmazonCloudSearch

Parameters:

listDomainNamesRequest -

Returns:

Result of the ListDomainNames operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

listDomainNames

public ListDomainNamesResult listDomainNames()

Description copied from interface: AmazonCloudSearch

Simplified method form for invoking the ListDomainNames operation.

Specified by:

listDomainNames in interface AmazonCloudSearch

See Also:

AmazonCloudSearch.listDomainNames(ListDomainNamesRequest)

updateAvailabilityOptions

public UpdateAvailabilityOptionsResult updateAvailabilityOptions(UpdateAvailabilityOptionsRequest request)

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 interface AmazonCloudSearch

Parameters:

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.

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.

ValidationException - The request was rejected because it has invalid parameters.

updateDomainEndpointOptions

public UpdateDomainEndpointOptionsResult updateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest request)

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

Specified by:

updateDomainEndpointOptions in interface AmazonCloudSearch

Parameters:

updateDomainEndpointOptionsRequest - Container for the parameters to the UpdateDomainEndpointOptions operation. Specifies the name of the domain you want to update and the domain endpoint options.

Returns:

Result of the UpdateDomainEndpointOptions 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.

ValidationException - The request was rejected because it has invalid parameters.

updateScalingParameters

public UpdateScalingParametersResult updateScalingParameters(UpdateScalingParametersRequest request)

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 interface AmazonCloudSearch

Parameters:

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.

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.

ValidationException - The request was rejected because it has invalid parameters.

updateServiceAccessPolicies

public UpdateServiceAccessPoliciesResult updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest request)

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 interface AmazonCloudSearch

Parameters:

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.

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.

ValidationException - The request was rejected because it has invalid parameters.

getCachedResponseMetadata

public 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. 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 interface AmazonCloudSearch

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonCloudSearch

Overrides:

shutdown in class AmazonWebServiceClient