Expand description
You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
The endpoints for submitting UploadDocuments
, Search
, and Suggest
requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains
action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.
For more information, see the Amazon CloudSearch Developer Guide.
If you’re using the service, you’re probably looking for CloudSearchDomainClient and CloudSearchDomain.
Structs§
- Bucket
A container for facet information.
- Bucket
Info A container for the calculated facet values and counts.
- Cloud
Search Domain Client - A client for the Amazon CloudSearch Domain API.
- Document
Service Warning A warning returned by the document service when an issue is discovered while processing an upload request.
- Field
Stats The statistics for a field calculated in the request.
- Hit
Information about a document that matches the search request.
- Hits
The collection of documents that match the search request.
- Search
Request Container for the parameters to the
Search
request.- Search
Response The result of a
Search
request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.- Search
Status Contains the resource id (
rid
) and the time it took to process the request (timems
).- Suggest
Model Container for the suggestion information returned in a
SuggestResponse
.- Suggest
Request Container for the parameters to the
Suggest
request.- Suggest
Response Contains the response to a
Suggest
request.- Suggest
Status Contains the resource id (
rid
) and the time it took to process the request (timems
).- Suggestion
Match An autocomplete suggestion that matches the query string specified in a
SuggestRequest
.- Upload
Documents Request Container for the parameters to the
UploadDocuments
request.- Upload
Documents Response Contains the response to an
UploadDocuments
request.
Enums§
- Search
Error - Errors returned by Search
- Suggest
Error - Errors returned by Suggest
- Upload
Documents Error - Errors returned by UploadDocuments
Traits§
- Cloud
Search Domain - Trait representing the capabilities of the Amazon CloudSearch Domain API. Amazon CloudSearch Domain clients implement this trait.