| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
search
You use the search API to search the documents that you've uploaded to your search domain.
Search requests are submitted via GET with a set of field-value pairs specified directly in the HTTP query string. The maximum size of a search request is 8190 bytes, including the HTTP method, URI, and protocol version. The response format can be either JSON or XML. (Errors are always returned in JSON.)
Note
Requests can be submitted to your search domain's search service only from authorized IP addresses. For information about authorizing IP addresses to submit search requests, see Configuring Access for an Amazon CloudSearch Domain.
Amazon CloudSearch processes search requests in two phases. First, it identifies the complete set of documents that match the terms specified with the q (query) and bq (Boolean query) Search Request Parameters. Amazon CloudSearch then processes the match-set of search hits to:
Filter the hits according to the value of the
t-FIELDparameter (if specified).Rank the filtered hits using the fields specified in the
rankparameter. If the rank parameter is not specified, results are ranked according to their text_relevance scores.Compute facet counts for the fields specified in the
facetparameter and the constraints specified for each field (if any).Return the processed set of hits. The maximum number of hits returned is controlled by the
sizeparameter. By default, the top ten results are returned. You can specify an offset with thestartparameter to retrieve the next set of hits.
For more information about searching with Amazon CloudSearch, see Searching Your Data with Amazon CloudSearch.
