AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
simple
: search all text
and text-array
fields for the specified string. Search for phrases, individual terms, and prefixes.
structured
: search specific fields, construct compound queries
using Boolean operators, and use advanced features such as term boosting and proximity
searching.lucene
: specify search criteria using the Apache
Lucene query parser syntax.dismax
: specify search criteria
using the simplified subset of the Apache Lucene query parser syntax defined by the
DisMax query parser.For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide.
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.
Namespace: Amazon.CloudSearchDomain.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class SearchRequest : AmazonCloudSearchDomainRequest IRequestEvents
The SearchRequest type exposes the following members
Name | Description | |
---|---|---|
SearchRequest() |
Name | Type | Description | |
---|---|---|---|
Cursor | System.String |
Gets and sets the property Cursor.
Retrieves a cursor value you can use to page through large result sets. Use the For more information, see Paginating Results in the Amazon CloudSearch Developer Guide. |
|
Expr | System.String |
Gets and sets the property Expr.
Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields.
You specify the expressions in JSON using the form
For information about the variables, operators, and functions you can use in expressions, see Writing Expressions in the Amazon CloudSearch Developer Guide. |
|
Facet | System.String |
Gets and sets the property Facet.
Specifies one or more fields for which to get facet information, and options that
control how the facet information is returned. Each specified field must be facet-enabled
in the domain configuration. The fields and options are specified in JSON using the
form You can specify the following faceting options:
If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.
To count particular buckets of values, use the {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}}
To sort facets by facet count, use the
To sort the facets by value, use the
For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide. |
|
FilterQuery | System.String |
Gets and sets the property FilterQuery.
Specifies a structured query that filters the results of a search without affecting
how the results are scored and sorted. You use For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide. |
|
Highlight | System.String |
Gets and sets the property Highlight.
Retrieves highlights for matches in the specified You can specify the following highlight options:
If no highlight options are specified for a field, the returned field text is treated
as HTML and the first match is highlighted with emphasis tags:
For example, the following request retrieves highlights for the { "actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag": "","post_tag": ""} } |
|
Partial | System.Boolean |
Gets and sets the property Partial.
Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage. |
|
Query | System.String |
Gets and sets the property Query.
Specifies the search criteria for the request. How you specify the search criteria
depends on the query parser used for the request and the parser options specified
in the For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide. |
|
QueryOptions | System.String |
Gets and sets the property QueryOptions.
Configures options for the query parser specified in the The options you can configure vary according to which parser you use:
|
|
QueryParser | Amazon.CloudSearchDomain.QueryParser |
Gets and sets the property QueryParser.
Specifies which query parser to use to process the request. If Amazon CloudSearch supports four query parsers:
|
|
Return | System.String |
Gets and sets the property Return.
Specifies the field and expression values to include in the response. Multiple fields
or expressions are specified as a comma-separated list. By default, a search response
includes all return enabled fields ( |
|
Size | System.Int64 |
Gets and sets the property Size.
Specifies the maximum number of search hits to include in the response. |
|
Sort | System.String |
Gets and sets the property Sort.
Specifies the fields or custom expressions to use to sort the search results. Multiple
fields or expressions are specified as a comma-separated list. You must specify the
sort direction ( For more information, see Sorting Results in the Amazon CloudSearch Developer Guide. |
|
Start | System.Int64 |
Gets and sets the property Start.
Specifies the offset of the first search hit you want to return. Note that the result
set is zero-based; the first result is at index 0. You can specify either the For more information, see Paginating Results in the Amazon CloudSearch Developer Guide. |
|
Stats | System.String |
Gets and sets the property Stats.
Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form: {"FIELD-A":{},"FIELD-B":{}} There are currently no options supported for statistics. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8