Method Detail

setEndpoint

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want
to work with.

Callers can pass in just the endpoint or a full URL, including the protocol. If the protocol is not specified
here, the default protocol from this client's ClientConfiguration will be used, which by default is
HTTPS.

This method is not threadsafe. An endpoint should be configured when the client is created and before any
service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
transit or retrying.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service
requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
or retrying.

The endpoint for submitting Search requests is domain-specific. You submit search requests to a
domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration
service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in
the Amazon CloudSearch console.

suggest

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display
likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a
particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values
in the suggester field start with the specified query string. The beginning of the field must match the query
string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting
Suggestions in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a
domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration
service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in
the Amazon CloudSearch console.

uploadDocuments

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete
operations that represent the documents you want to add, update, or delete from your domain. Batches can be
described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as
a product) is represented as a document. Every document has a unique ID and one or more fields that contain the
data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data.
The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations
in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a
domain's document service.

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document
endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A
domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data
in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the
Amazon CloudSearch Developer Guide.

shutdown

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
has been shutdown, it should not be used to make any more requests.

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 a request.