com.amazonaws.services.cloudsearch

Class AmazonCloudSearchClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudsearch.AmazonCloudSearchClient

All Implemented Interfaces:

AmazonCloudSearch

Direct Known Subclasses:

AmazonCloudSearchAsyncClient

public class AmazonCloudSearchClient
extends AmazonWebServiceClient
implements AmazonCloudSearch

Client for accessing AmazonCloudSearch. 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 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 .

Constructor Summary

Constructors

Constructor and Description
AmazonCloudSearchClient() Constructs a new client to invoke service methods on AmazonCloudSearch.
AmazonCloudSearchClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials.
AmazonCloudSearchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials and client configuration options.
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials provider.
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCloudSearch 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 AmazonCloudSearch 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 AmazonCloudSearch.

Method Summary

Methods

Modifier and Type	Method and Description
CreateDomainResult	createDomain(CreateDomainRequest createDomainRequest) Creates a new search domain.
DefineIndexFieldResult	defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest) Configures an IndexField for the search domain.
DefineRankExpressionResult	defineRankExpression(DefineRankExpressionRequest defineRankExpressionRequest) Configures a RankExpression for the search domain.
DeleteDomainResult	deleteDomain(DeleteDomainRequest deleteDomainRequest) Permanently deletes a search domain and all of its data.
DeleteIndexFieldResult	deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest) Removes an IndexField from the search domain.
DeleteRankExpressionResult	deleteRankExpression(DeleteRankExpressionRequest deleteRankExpressionRequest) Removes a RankExpression from the search domain.
DescribeDefaultSearchFieldResult	describeDefaultSearchField(DescribeDefaultSearchFieldRequest describeDefaultSearchFieldRequest) Gets the default search field configured for the search domain.
DescribeDomainsResult	describeDomains() Gets information about the search domains owned by this account.
DescribeDomainsResult	describeDomains(DescribeDomainsRequest describeDomainsRequest) Gets information about the search domains owned by this account.
DescribeIndexFieldsResult	describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest) Gets information about the index fields configured for the search domain.
DescribeRankExpressionsResult	describeRankExpressions(DescribeRankExpressionsRequest describeRankExpressionsRequest) Gets the rank expressions configured for the search domain.
DescribeServiceAccessPoliciesResult	describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) Gets information about the resource-based policies that control access to the domain's document and search services.
DescribeStemmingOptionsResult	describeStemmingOptions(DescribeStemmingOptionsRequest describeStemmingOptionsRequest) Gets the stemming dictionary configured for the search domain.
DescribeStopwordOptionsResult	describeStopwordOptions(DescribeStopwordOptionsRequest describeStopwordOptionsRequest) Gets the stopwords configured for the search domain.
DescribeSynonymOptionsResult	describeSynonymOptions(DescribeSynonymOptionsRequest describeSynonymOptionsRequest) Gets the synonym dictionary configured for the search 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 text processing options and IndexFields .
UpdateDefaultSearchFieldResult	updateDefaultSearchField(UpdateDefaultSearchFieldRequest updateDefaultSearchFieldRequest) Configures the default search field for the search domain.
UpdateServiceAccessPoliciesResult	updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) Configures the policies that control access to the domain's document and search services.
UpdateStemmingOptionsResult	updateStemmingOptions(UpdateStemmingOptionsRequest updateStemmingOptionsRequest) Configures a stemming dictionary for the search domain.
UpdateStopwordOptionsResult	updateStopwordOptions(UpdateStopwordOptionsRequest updateStopwordOptionsRequest) Configures stopwords for the search domain.
UpdateSynonymOptionsResult	updateSynonymOptions(UpdateSynonymOptionsRequest updateSynonymOptionsRequest) Configures a synonym dictionary for the search domain.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getRequestMetricsCollector, getServiceName, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonCloudSearchClient

public AmazonCloudSearchClient()

Constructs a new client to invoke service methods on AmazonCloudSearch. 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

public AmazonCloudSearchClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCloudSearch. 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 AmazonCloudSearch (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudSearchClient

public AmazonCloudSearchClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonCloudSearch 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 AmazonCloudSearch 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 AmazonCloudSearch (ex: proxy settings, retry counts, etc.).

AmazonCloudSearchClient

public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonCloudSearch 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 AmazonCloudSearch 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 AmazonCloudSearch (ex: proxy settings, retry counts, etc.).

AmazonCloudSearchClient

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

Constructs a new client to invoke service methods on AmazonCloudSearch 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 AmazonCloudSearch (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

updateDefaultSearchField

public UpdateDefaultSearchFieldResult updateDefaultSearchField(UpdateDefaultSearchFieldRequest updateDefaultSearchFieldRequest)

Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.

Specified by:

updateDefaultSearchField in interface AmazonCloudSearch

Parameters:

updateDefaultSearchFieldRequest - Container for the necessary parameters to execute the UpdateDefaultSearchField service method on AmazonCloudSearch.

Returns:

The response from the UpdateDefaultSearchField service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

deleteRankExpression

public DeleteRankExpressionResult deleteRankExpression(DeleteRankExpressionRequest deleteRankExpressionRequest)

Removes a RankExpression from the search domain.

Specified by:

deleteRankExpression in interface AmazonCloudSearch

Parameters:

deleteRankExpressionRequest - Container for the necessary parameters to execute the DeleteRankExpression service method on AmazonCloudSearch.

Returns:

The response from the DeleteRankExpression service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeRankExpressions

public DescribeRankExpressionsResult describeRankExpressions(DescribeRankExpressionsRequest describeRankExpressionsRequest)

Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.

Specified by:

describeRankExpressions in interface AmazonCloudSearch

Parameters:

describeRankExpressionsRequest - Container for the necessary parameters to execute the DescribeRankExpressions service method on AmazonCloudSearch.

Returns:

The response from the DescribeRankExpressions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

createDomain

public CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)

Creates a new search domain.

Specified by:

createDomain in interface AmazonCloudSearch

Parameters:

createDomainRequest - Container for the necessary parameters to execute the CreateDomain service method on AmazonCloudSearch.

Returns:

The response from the CreateDomain service method, as returned by AmazonCloudSearch.

Throws:

BaseException

LimitExceededException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

updateServiceAccessPolicies

public UpdateServiceAccessPoliciesResult updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)

Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB.

Specified by:

updateServiceAccessPolicies in interface AmazonCloudSearch

Parameters:

updateServiceAccessPoliciesRequest - Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method on AmazonCloudSearch.

Returns:

The response from the UpdateServiceAccessPolicies service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

defineIndexField

public DefineIndexFieldResult defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest)

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.

Specified by:

defineIndexField in interface AmazonCloudSearch

Parameters:

defineIndexFieldRequest - Container for the necessary parameters to execute the DefineIndexField service method on AmazonCloudSearch.

Returns:

The response from the DefineIndexField service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

defineRankExpression

public DefineRankExpressionResult defineRankExpression(DefineRankExpressionRequest defineRankExpressionRequest)

Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.

Specified by:

defineRankExpression in interface AmazonCloudSearch

Parameters:

defineRankExpressionRequest - Container for the necessary parameters to execute the DefineRankExpression service method on AmazonCloudSearch.

Returns:

The response from the DefineRankExpression service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeSynonymOptions

public DescribeSynonymOptionsResult describeSynonymOptions(DescribeSynonymOptionsRequest describeSynonymOptionsRequest)

Gets the synonym dictionary configured for the search domain.

Specified by:

describeSynonymOptions in interface AmazonCloudSearch

Parameters:

describeSynonymOptionsRequest - Container for the necessary parameters to execute the DescribeSynonymOptions service method on AmazonCloudSearch.

Returns:

The response from the DescribeSynonymOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeStopwordOptions

public DescribeStopwordOptionsResult describeStopwordOptions(DescribeStopwordOptionsRequest describeStopwordOptionsRequest)

Gets the stopwords configured for the search domain.

Specified by:

describeStopwordOptions in interface AmazonCloudSearch

Parameters:

describeStopwordOptionsRequest - Container for the necessary parameters to execute the DescribeStopwordOptions service method on AmazonCloudSearch.

Returns:

The response from the DescribeStopwordOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

deleteDomain

public DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)

Permanently deletes a search domain and all of its data.

Specified by:

deleteDomain in interface AmazonCloudSearch

Parameters:

deleteDomainRequest - Container for the necessary parameters to execute the DeleteDomain service method on AmazonCloudSearch.

Returns:

The response from the DeleteDomain service method, as returned by AmazonCloudSearch.

Throws:

BaseException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeServiceAccessPolicies

public DescribeServiceAccessPoliciesResult describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)

Gets information about the resource-based policies that control access to the domain's document and search services.

Specified by:

describeServiceAccessPolicies in interface AmazonCloudSearch

Parameters:

describeServiceAccessPoliciesRequest - Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method on AmazonCloudSearch.

Returns:

The response from the DescribeServiceAccessPolicies service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeDefaultSearchField

public DescribeDefaultSearchFieldResult describeDefaultSearchField(DescribeDefaultSearchFieldRequest describeDefaultSearchFieldRequest)

Gets the default search field configured for the search domain.

Specified by:

describeDefaultSearchField in interface AmazonCloudSearch

Parameters:

describeDefaultSearchFieldRequest - Container for the necessary parameters to execute the DescribeDefaultSearchField service method on AmazonCloudSearch.

Returns:

The response from the DescribeDefaultSearchField service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

updateStopwordOptions

public UpdateStopwordOptionsResult updateStopwordOptions(UpdateStopwordOptionsRequest updateStopwordOptionsRequest)

Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB.

Specified by:

updateStopwordOptions in interface AmazonCloudSearch

Parameters:

updateStopwordOptionsRequest - Container for the necessary parameters to execute the UpdateStopwordOptions service method on AmazonCloudSearch.

Returns:

The response from the UpdateStopwordOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

updateSynonymOptions

public UpdateSynonymOptionsResult updateSynonymOptions(UpdateSynonymOptionsRequest updateSynonymOptionsRequest)

Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB.

Specified by:

updateSynonymOptions in interface AmazonCloudSearch

Parameters:

updateSynonymOptionsRequest - Container for the necessary parameters to execute the UpdateSynonymOptions service method on AmazonCloudSearch.

Returns:

The response from the UpdateSynonymOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

updateStemmingOptions

public UpdateStemmingOptionsResult updateStemmingOptions(UpdateStemmingOptionsRequest updateStemmingOptionsRequest)

Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB.

Specified by:

updateStemmingOptions in interface AmazonCloudSearch

Parameters:

updateStemmingOptionsRequest - Container for the necessary parameters to execute the UpdateStemmingOptions service method on AmazonCloudSearch.

Returns:

The response from the UpdateStemmingOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeStemmingOptions

public DescribeStemmingOptionsResult describeStemmingOptions(DescribeStemmingOptionsRequest describeStemmingOptionsRequest)

Gets the stemming dictionary configured for the search domain.

Specified by:

describeStemmingOptions in interface AmazonCloudSearch

Parameters:

describeStemmingOptionsRequest - Container for the necessary parameters to execute the DescribeStemmingOptions service method on AmazonCloudSearch.

Returns:

The response from the DescribeStemmingOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeDomains

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.

Specified by:

describeDomains in interface AmazonCloudSearch

Parameters:

describeDomainsRequest - Container for the necessary parameters to execute the DescribeDomains service method on AmazonCloudSearch.

Returns:

The response from the DescribeDomains service method, as returned by AmazonCloudSearch.

Throws:

BaseException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

indexDocuments

public IndexDocumentsResult indexDocuments(IndexDocumentsRequest indexDocumentsRequest)

Tells the search domain to start indexing its documents using the latest text processing options and IndexFields . This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.

Specified by:

indexDocuments in interface AmazonCloudSearch

Parameters:

indexDocumentsRequest - Container for the necessary parameters to execute the IndexDocuments service method on AmazonCloudSearch.

Returns:

The response from the IndexDocuments service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

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. Shows all fields by default.

Specified by:

describeIndexFields in interface AmazonCloudSearch

Parameters:

describeIndexFieldsRequest - Container for the necessary parameters to execute the DescribeIndexFields service method on AmazonCloudSearch.

Returns:

The response from the DescribeIndexFields service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

deleteIndexField

public DeleteIndexFieldResult deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)

Removes an IndexField from the search domain.

Specified by:

deleteIndexField in interface AmazonCloudSearch

Parameters:

deleteIndexFieldRequest - Container for the necessary parameters to execute the DeleteIndexField service method on AmazonCloudSearch.

Returns:

The response from the DeleteIndexField service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeDomains

public DescribeDomainsResult describeDomains()
                                      throws AmazonServiceException,
                                             AmazonClientException

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.

Specified by:

describeDomains in interface AmazonCloudSearch

Returns:

The response from the DescribeDomains service method, as returned by AmazonCloudSearch.

Throws:

BaseException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

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.