String options
Example: {"Statement":
[{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }},
{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }
OptionStatus status
Boolean options
OptionStatus status
String code
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String options
IndexField to use as the default search
field. The default is an empty string, which automatically searches
all text fields.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
OptionStatus status
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
IndexField indexField
IndexFieldType indicates which of the
options will be present. It is invalid to specify options for a type
other than the IndexFieldType.IndexFieldStatus indexField
IndexField and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
NamedRankExpression rankExpression
RankExpressionStatus rankExpression
RankExpression and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
IndexFieldStatus indexField
IndexField and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String rankName
RankExpression to delete.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
RankExpressionStatus rankExpression
RankExpression and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AvailabilityOptionsStatus availabilityOptions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DefaultSearchFieldStatus defaultSearchField
IndexField to use for search requests
issued with the q parameter. The default is the empty
string, which automatically searches all text fields.com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainStatusList
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
DescribeIndexFields response to the specified
fields.com.amazonaws.internal.ListWithAutoConstructFlag<T> indexFields
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> rankNames
DescribeRankExpressions response to the
specified fields.com.amazonaws.internal.ListWithAutoConstructFlag<T> rankExpressions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AccessPoliciesStatus accessPolicies
PolicyDocument that specifies access policies for the
search domain's services, and the current status of those policies.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
StemmingOptionsStatus stems
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
StopwordOptionsStatus stopwords
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
SynonymOptionsStatus synonyms
String domainId
Constraints:
Length: 1 - 64
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Boolean created
Boolean deleted
Long numSearchableDocs
Constraints:
Range: 0 -
ServiceEndpoint docService
ServiceEndpoint searchService
Boolean requiresIndexDocuments
Boolean processing
String searchInstanceType
Integer searchPartitionCount
Constraints:
Range: 1 -
Integer searchInstanceCount
Constraints:
Range: 1 -
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
IndexDocuments action.String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String indexFieldType
Constraints:
Allowed Values: uint, literal, text
UIntOptions uIntOptions
IndexFieldType specifies the field is of type unsigned
integer.LiteralOptions literalOptions
IndexFieldType
specifies the field is of type literal.TextOptions textOptions
IndexFieldType
specifies the field is of type text.com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceAttributes
IndexField. When one or more
source attributes are specified, an optional data transformation can
be applied to the source data when populating the index field. You can
configure a maximum of 20 sources for an IndexField.IndexField options
IndexFieldType indicates which of the
options will be present. It is invalid to specify options for a type
other than the IndexFieldType.OptionStatus status
String defaultValue
Constraints:
Length: 0 - 1024
Boolean searchEnabled
Boolean facetEnabled
Boolean resultEnabled
String rankName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String rankExpression
RankExpression syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a, if a is true,
without evaluating b at all+ - * /
%abs ceil erf exp
floor lgamma ln log2 log10 max min sqrt powacosh acos asinh asin atanh
atan cosh cos sinh sin tanh tanrandtimemin max functions
that operate on a variable argument listIntermediate
results are calculated as double precision floating point values. The
final return value of a RankExpression is automatically
converted from floating point to a 32-bit unsigned integer by rounding
to the nearest integer, with a natural floor of 0 and a ceiling of
max(uint32_t), 4294967295. Mathematical errors such as dividing by 0
will fail during evaluation and return a value of 0.
The source
data for a RankExpression can be the name of an
IndexField of type uint, another
RankExpression or the reserved name
text_relevance. The text_relevance source is defined to return
an integer from 0 to 1000 (inclusive) to indicate how relevant a
document is to the search request, taking into account repetition of
search terms in the document and proximity of search terms to each
other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
Constraints:
Length: 1 - 10240
Date creationDate
Date updateDate
Integer updateVersion
Constraints:
Range: 0 -
String state
RequiresIndexDocuments: the option's latest value
will not be visible in searches until IndexDocuments has been
called and indexing is complete.Processing: the
option's latest value is not yet visible in all searches but is in the
process of being activated. Active: the
option's latest value is completely visible. Any warnings or messages
generated during processing are provided in
Diagnostics.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active
Boolean pendingDeletion
NamedRankExpression options
OptionStatus status
String arn
String endpoint
String sourceDataFunction
Constraints:
Allowed Values: Copy, TrimTitle, Map
SourceData sourceDataCopy
IndexField.SourceDataTrimTitle sourceDataTrimTitle
IndexField. This can be used to create an
IndexField you can use for sorting.SourceDataMap sourceDataMap
IndexField.String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String defaultValue
Constraints:
Length: 0 - 1024
String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String defaultValue
Constraints:
Length: 0 - 1024
Map<K,V> cases
String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String defaultValue
Constraints:
Length: 0 - 1024
String separator
String language
Constraints:
Pattern: [a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*
String options
{ "stems": {"people": "person", "walking":
"walk"} }OptionStatus status
String options
{ "stopwords": ["a", "an", "the", "of"] }OptionStatus status
String options
{ "synonyms": {"cat": ["feline",
"kitten"], "puppy": "dog"} }OptionStatus status
String defaultValue
Constraints:
Length: 0 - 1024
Boolean facetEnabled
Boolean resultEnabled
String textProcessor
cs_text_no_stemming: turns off stemming for the
field.Default: none
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Integer defaultValue
Constraints:
Range: 0 -
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Boolean multiAZ
false.AvailabilityOptionsStatus availabilityOptions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String defaultSearchField
q parameter, or if a match
expression specified with the bq parameter does not
constrain the search to a particular field. The default is an empty
string, which automatically searches all text fields.DefaultSearchFieldStatus defaultSearchField
DefaultSearchField configured for this
search domain and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String accessPolicies
Example: {"Statement":
[{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }},
{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }
AccessPoliciesStatus accessPolicies
PolicyDocument that specifies access policies for the
search domain's services, and the current status of those policies.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String stems
{ "stems": {"people": "person", "walking":
"walk"} }StemmingOptionsStatus stems
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String stopwords
{ "stopwords": ["a", "an", "the", "of"] }StopwordOptionsStatus stopwords
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String synonyms
{ "synonyms": {"cat": ["feline",
"kitten"], "puppy": "dog"} }SynonymOptionsStatus synonyms
com.amazonaws.internal.SdkInternalList<T> buckets
A list of the calculated facet values and counts.
String status
The return status of a document upload request, error or
success.
String message
The description for a warning returned by the document service.
String id
The document ID of a document that matches the search request.
com.amazonaws.internal.SdkInternalMap<K,V> fields
The fields returned from a document that matches the search request.
com.amazonaws.internal.SdkInternalMap<K,V> exprs
The expressions returned from a document that matches the search request.
com.amazonaws.internal.SdkInternalMap<K,V> highlights
The highlights returned from a document that matches the search request.
Long found
The total number of documents that match the search request.
Long start
The index of the first matching document.
String cursor
A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.
com.amazonaws.internal.SdkInternalList<T> hit
A document that matches the search request.
String cursor
Retrieves a cursor value you can use to page through large result sets.
Use the size parameter to control the number of hits to
include in each response. You can specify either the cursor
or start parameter in a request; they are mutually
exclusive. To get the first cursor, set the cursor value to
initial. In subsequent requests, specify the cursor value
returned in the hits section of the response.
For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.
String 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
{"EXPRESSIONNAME":"EXPRESSION"}. You can define and use
multiple expressions in a search request. For example:
{"expression1":"_score*rating", "expression2":"(1/rank)*year"}
For information about the variables, operators, and functions you can use in expressions, see Writing Expressions in the Amazon CloudSearch Developer Guide.
String 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
{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}
.
You can specify the following faceting options:
buckets specifies an array of the facet values or ranges to
count. Ranges are specified using the same syntax that you use to search
for a range of values. For more information, see Searching for a Range of Values in the Amazon CloudSearch
Developer Guide. Buckets are returned in the order they are specified
in the request. The sort and size options are
not valid if you specify buckets.
size specifies the maximum number of facets to include in
the results. By default, Amazon CloudSearch returns counts for the top
10. The size parameter is only valid when you specify the
sort option; it cannot be used in conjunction with
buckets.
sort specifies how you want to sort the facets in the
results: bucket or count. Specify
bucket to sort alphabetically or numerically by facet value
(in ascending order). Specify count to sort by the facet
counts computed for each facet value (in descending order). To retrieve
facet counts for particular values or ranges of values, use the
buckets option instead of sort.
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 buckets
option. For example, the following request uses the buckets
option to calculate and return facet counts by decade.
{"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}}
To sort facets by facet count, use the count option. For
example, the following request sets the sort option to
count to sort the facet values by facet count, with the
facet values that have the most matching documents listed first. Setting
the size option to 3 returns only the top three facet
values.
{"year":{"sort":"count","size":3}}
To sort the facets by value, use the bucket option. For
example, the following request sets the sort option to
bucket to sort the facet values numerically by year, with
earliest year listed first.
{"year":{"sort":"bucket"}}
For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide.
String filterQuery
Specifies a structured query that filters the results of a search without
affecting how the results are scored and sorted. You use
filterQuery in conjunction with the query
parameter to filter the documents that match the constraints specified in
the query parameter. Specifying a filter controls only which
matching documents are included in the results, it has no effect on how
they are scored and sorted. The filterQuery parameter
supports the full structured query syntax.
For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide.
String highlight
Retrieves highlights for matches in the specified text or
text-array fields. Each specified field must be highlight
enabled in the domain configuration. The fields and options are specified
in JSON using the form
{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}
.
You can specify the following highlight options:
format: specifies the format of the data in the text
field: text or html. When data is returned as
HTML, all non-alphanumeric characters are encoded. The default is
html.max_phrases: specifies the maximum number of occurrences
of the search term(s) you want to highlight. By default, the first
occurrence is highlighted.pre_tag: specifies the string to prepend to an
occurrence of a search term. The default for HTML highlights is
<em>. The default for text highlights is
*.post_tag: specifies the string to append to an
occurrence of a search term. The default for HTML highlights is
</em>. The default for text highlights is
*.
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: <em>search-term</em>.
For example, the following request retrieves highlights for the
actors and title fields.
{ "actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag": "","post_tag": ""} }
Boolean 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.
String 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 queryOptions parameter. By default,
the simple query parser is used to process requests. To use
the structured, lucene, or dismax
query parser, you must also specify the queryParser
parameter.
For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.
String queryOptions
Configures options for the query parser specified in the
queryParser parameter. You specify the options in JSON using
the following form
{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.
The options you can configure vary according to which parser you use:
defaultOperator: The default operator used to combine
individual terms in the search string. For example:
defaultOperator: 'or'. For the dismax parser,
you specify a percentage that represents the percentage of terms in the
search string (rounded down) that must match, rather than a default
operator. A value of 0% is the equivalent to OR, and a value
of 100% is equivalent to AND. The percentage must be
specified as a value in the range 0-100 followed by the percent (%)
symbol. For example, defaultOperator: 50%. Valid values:
and, or, a percentage in the range 0%-100% (
dismax). Default: and (simple,
structured, lucene) or 100 (
dismax). Valid for: simple,
structured, lucene, and dismax.fields: An array of the fields to search when no fields
are specified in a search. If no fields are specified in a search and
this option is not specified, all text and text-array fields are
searched. You can specify a weight for each field to control the relative
importance of each field when Amazon CloudSearch calculates relevance
scores. To specify a field weight, append a caret (^) symbol
and the weight to the field name. For example, to boost the importance of
the title field over the description field you
could specify: "fields":["title^5","description"]. Valid
values: The name of any configured field and an optional numeric value
greater than zero. Default: All text and
text-array fields. Valid for: simple,
structured, lucene, and dismax.operators: An array of the operators or special
characters you want to disable for the simple query parser. If you
disable the and, or, or not
operators, the corresponding operators (+, |,
-) have no special meaning and are dropped from the search
string. Similarly, disabling prefix disables the wildcard
operator (*) and disabling phrase disables the
ability to search for phrases by enclosing phrases in double quotes.
Disabling precedence disables the ability to control order of precedence
using parentheses. Disabling near disables the ability to
use the ~ operator to perform a sloppy phrase search. Disabling the
fuzzy operator disables the ability to use the ~ operator to
perform a fuzzy search. escape disables the ability to use a
backslash (\) to escape special characters within the search
string. Disabling whitespace is an advanced option that prevents the
parser from tokenizing on whitespace, which can be useful for Vietnamese.
(It prevents Vietnamese words from being split incorrectly.) For example,
you could disable all operators other than the phrase operator to support
just simple term and phrase queries:
"operators":["and","not","or", "prefix"]. Valid values:
and, escape, fuzzy,
near, not, or, phrase, precedence, prefix, whitespace.
Default: All operators and special characters are enabled. Valid for:
simple.phraseFields: An array of the text or
text-array fields you want to use for phrase searches. When
the terms in the search string appear in close proximity within a field,
the field scores higher. You can specify a weight for each field to boost
that score. The phraseSlop option controls how much the
matches can deviate from the search string and still be boosted. To
specify a field weight, append a caret (^) symbol and the
weight to the field name. For example, to boost phrase matches in the
title field over the abstract field, you could
specify: "phraseFields":["title^3", "plot"] Valid values:
The name of any text or text-array field and an
optional numeric value greater than zero. Default: No fields. If you
don't specify any fields with phraseFields, proximity
scoring is disabled even if phraseSlop is specified. Valid
for: dismax.phraseSlop: An integer value that specifies how much
matches can deviate from the search phrase and still be boosted according
to the weights specified in the phraseFields option; for
example, phraseSlop: 2. You must also specify
phraseFields to enable proximity scoring. Valid values:
positive integers. Default: 0. Valid for: dismax.explicitPhraseSlop: An integer value that specifies how
much a match can deviate from the search phrase when the phrase is
enclosed in double quotes in the search string. (Phrases that exceed this
proximity distance are not considered a match.) For example, to specify a
slop of three for dismax phrase queries, you would specify
"explicitPhraseSlop":3. Valid values: positive integers.
Default: 0. Valid for: dismax.tieBreaker: When a term in the search string is found in
a document's field, a score is calculated for that field based on how
common the word is in that field compared to other documents. If the term
occurs in multiple fields within a document, by default only the highest
scoring field contributes to the document's overall score. You can
specify a tieBreaker value to enable the matches in
lower-scoring fields to contribute to the document's score. That way, if
two documents have the same max field score for a particular term, the
score for the document that has matches in more fields will be higher.
The formula for calculating the score with a tieBreaker is
(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)
. Set tieBreaker to 0 to disregard all but the highest
scoring field (pure max): "tieBreaker":0. Set to 1 to sum
the scores from all fields (pure sum): "tieBreaker":1. Valid
values: 0.0 to 1.0. Default: 0.0. Valid for: dismax.String queryParser
Specifies which query parser to use to process the request. If
queryParser is not specified, Amazon CloudSearch uses the
simple query parser.
Amazon CloudSearch supports four query parsers:
simple: perform simple searches of text and
text-array fields. By default, the simple query
parser searches all text and text-array fields.
You can specify which fields to search by with the
queryOptions parameter. If you prefix a search term with a
plus sign (+) documents must contain the term to be considered a match.
(This is the default, unless you configure the default operator with the
queryOptions parameter.) You can use the -
(NOT), | (OR), and * (wildcard) operators to
exclude particular terms, find results that match any of the specified
terms, or search for a prefix. To search for a phrase rather than
individual terms, enclose the phrase in double quotes. For more
information, see Searching for Text in the Amazon CloudSearch Developer Guide.
structured: perform advanced searches by combining
multiple expressions to define the search criteria. You can also search
within particular fields, search for values and ranges of values, and use
advanced options such as term boosting, matchall, and
near. For more information, see Constructing Compound Queries in the Amazon CloudSearch Developer
Guide.lucene: search using the Apache Lucene query parser
syntax. For more information, see Apache Lucene Query Parser Syntax.dismax: search using the simplified subset of the Apache
Lucene query parser syntax defined by the DisMax query parser. For more
information, see DisMax Query Parser Syntax.String returnValue
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 (
_all_fields). To return only the document IDs for the
matching documents, specify _no_fields. To retrieve the
relevance score calculated for each document, specify _score
.
Long size
Specifies the maximum number of search hits to include in the response.
String 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 (
asc or desc) for each field; for example,
year desc,title asc. To use a field to sort results, the
field must be sort-enabled in the domain configuration. Array type fields
cannot be used for sorting. If no sort parameter is
specified, results are sorted by their default relevance scores in
descending order: _score desc. You can also sort by document
ID (_id asc) and version (_version desc).
For more information, see Sorting Results in the Amazon CloudSearch Developer Guide.
Long 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 start or cursor
parameter in a request, they are mutually exclusive.
For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.
SearchStatus status
The status information returned for the search request.
Hits hits
The documents that match the search criteria.
com.amazonaws.internal.SdkInternalMap<K,V> facets
The requested facet information.
String query
The query string specified in the suggest request.
Long found
The number of documents that were found to match the query string.
com.amazonaws.internal.SdkInternalList<T> suggestions
The documents that match the query string.
SuggestStatus status
The status of a SuggestRequest. Contains the resource ID (
rid) and how long it took to process the request (
timems).
SuggestModel suggest
Container for the matching search suggestion information.
InputStream documents
A batch of documents formatted in JSON or HTML.
String contentType
The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:
Long contentLength
String status
The status of an UploadDocumentsRequest.
Long adds
The number of documents that were added to the search domain.
Long deletes
The number of documents that were deleted from the search domain.
com.amazonaws.internal.SdkInternalList<T> warnings
Any warnings returned by the document service about the documents being uploaded.
String options
OptionStatus status
String synonyms
String stopwords
["a", "an", "the", "of"]. The stopwords
dictionary must explicitly list each word you want to ignore.
Wildcards and regular expressions are not supported.String stemmingDictionary
{"term1": "stem1",
"term2": "stem2", "term3": "stem3"}. The stemming dictionary is
applied in addition to any algorithmic stemming. This enables you to
override the results of the algorithmic stemming to correct specific
cases of overstemming or understemming. The maximum size of a stemming
dictionary is 500 KB.String japaneseTokenizationDictionary
String algorithmicStemming
none,
minimal, light, or full. The
available levels vary depending on the language. For more information,
see Language Specific Text Processing Settings in the
Amazon CloudSearch Developer Guide
Constraints:
Allowed Values: none, minimal, light, full
String analysisSchemeName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String analysisSchemeLanguage
mul for multiple languages.
Constraints:
Allowed Values: ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, he, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant
AnalysisOptions analysisOptions
AnalysisScheme options
Synonyms, Stopwords,
StemmingDictionary,
JapaneseTokenizationDictionary and
AlgorithmicStemming.OptionStatus status
Boolean options
OptionStatus status
String code
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String defaultValue
Constraints:
Length: 0 - 1024
String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AnalysisScheme analysisScheme
Synonyms, Stopwords,
StemmingDictionary,
JapaneseTokenizationDictionary and
AlgorithmicStemming.AnalysisSchemeStatus analysisScheme
AnalysisScheme.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Expression expression
ExpressionStatus expression
Expression and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
IndexField indexField
IndexFieldStatus indexField
IndexField and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Suggester suggester
FuzzyMatching, SortExpression.SuggesterStatus suggester
Suggester and its current status.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String analysisSchemeName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
AnalysisSchemeStatus analysisScheme
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String expressionName
Expression to delete.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
ExpressionStatus expression
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String indexFieldName
Constraints:
Length: 1 - 64
Pattern: ([a-z][a-z0-9_]*\*?|\*[a-z0-9_]*)
IndexFieldStatus indexField
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String suggesterName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
SuggesterStatus suggester
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> analysisSchemeNames
Boolean deployed
true) or
include any pending changes (false). Defaults to
false.com.amazonaws.internal.ListWithAutoConstructFlag<T> analysisSchemes
AvailabilityOptionsStatus availabilityOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainStatusList
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> expressionNames
DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.Boolean deployed
true) or
include any pending changes (false). Defaults to
false.com.amazonaws.internal.ListWithAutoConstructFlag<T> expressions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
Boolean deployed
true) or
include any pending changes (false). Defaults to
false.com.amazonaws.internal.ListWithAutoConstructFlag<T> indexFields
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ScalingParametersStatus scalingParameters
AccessPoliciesStatus accessPolicies
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> suggesterNames
Boolean deployed
true) or
include any pending changes (false). Defaults to
false.com.amazonaws.internal.ListWithAutoConstructFlag<T> suggesters
String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String fuzzyMatching
none, low, or high. With none,
the specified string is treated as an exact prefix. With low,
suggestions must differ from the specified string by no more than one
character. With high, suggestions can differ by up to two characters.
The default is none.
Constraints:
Allowed Values: none, low, high
String sortExpression
_score value. To sort suggestions using a numeric field
or existing expression, simply specify the name of the field or
expression. If no expression is configured for the suggester, the
suggestions are sorted with the closest matches listed first.String domainId
Constraints:
Length: 1 - 64
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String aRN
Boolean created
Boolean deleted
ServiceEndpoint docService
ServiceEndpoint searchService
Boolean requiresIndexDocuments
Boolean processing
String searchInstanceType
Integer searchPartitionCount
Constraints:
Range: 1 -
Integer searchInstanceCount
Constraints:
Range: 1 -
Limits limits
Double defaultValue
String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Double defaultValue
String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String expressionName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
String expressionValue
Expression syntax is based on JavaScript
expressions. For more information, see Configuring Expressions in the Amazon
CloudSearch Developer Guide.
Constraints:
Length: 1 - 10240
Expression options
OptionStatus status
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
String indexFieldName
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id.
Constraints:
Length: 1 - 64
Pattern: ([a-z][a-z0-9_]*\*?|\*[a-z0-9_]*)
String indexFieldType
Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
IntOptions intOptions
IndexFieldType specifies the field is of type
int. All options are enabled by default.DoubleOptions doubleOptions
IndexFieldType specifies the field is of type
double. All options are enabled by default.LiteralOptions literalOptions
IndexFieldType
specifies the field is of type literal. All options are
enabled by default.TextOptions textOptions
IndexFieldType
specifies the field is of type text. A text
field is always searchable. All options are enabled by default.DateOptions dateOptions
IndexFieldType specifies
the field is of type date. All options are enabled by
default.LatLonOptions latLonOptions
IndexFieldType specifies the field is of type
latlon. All options are enabled by default.IntArrayOptions intArrayOptions
IndexFieldType specifies the field is of type
int-array. All options are enabled by default.DoubleArrayOptions doubleArrayOptions
IndexFieldType
specifies the field is of type double-array. All options
are enabled by default.LiteralArrayOptions literalArrayOptions
IndexFieldType specifies the field is of type
literal-array. All options are enabled by default.TextArrayOptions textArrayOptions
IndexFieldType specifies the field is of type
text-array. A text-array field is always
searchable. All options are enabled by default.DateArrayOptions dateArrayOptions
IndexFieldType specifies the field is of type
date-array. All options are enabled by default.IndexField options
IndexFieldType.OptionStatus status
Long defaultValue
String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Long defaultValue
String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean facetEnabled
Boolean searchEnabled
Boolean returnEnabled
Boolean sortEnabled
Date creationDate
Date updateDate
Integer updateVersion
Constraints:
Range: 0 -
String state
RequiresIndexDocuments: the option's latest value
will not be deployed until IndexDocuments has been called and
indexing is complete.Processing: the option's
latest value is in the process of being activated. Active: the option's latest value is completely
deployed.FailedToValidate: the option value is
not compatible with the domain's data and cannot be used to index the
data. You must either modify the option value or update or remove the
incompatible documents.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active, FailedToValidate
Boolean pendingDeletion
String desiredInstanceType
search.m1.small.
Constraints:
Allowed Values: search.m1.small, search.m1.large, search.m2.xlarge, search.m2.2xlarge, search.m3.medium, search.m3.large, search.m3.xlarge, search.m3.2xlarge
Integer desiredReplicationCount
Constraints:
Range: 0 -
Integer desiredPartitionCount
m2.2xlarge as the desired
instance type.
Constraints:
Range: 0 -
ScalingParameters options
OptionStatus status
String endpoint
search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
or
doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.String suggesterName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
DocumentSuggesterOptions documentSuggesterOptions
Suggester options
FuzzyMatching, SortExpression.OptionStatus status
String defaultValue
Constraints:
Length: 0 - 1024
String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
Boolean returnEnabled
Boolean highlightEnabled
String analysisScheme
text-array field.
Constraints:
Pattern: [\S]+
String defaultValue
Constraints:
Length: 0 - 1024
String sourceField
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot
be used as a field name. To reference a document's ID, you can use the
name _id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
Boolean returnEnabled
Boolean sortEnabled
Boolean highlightEnabled
String analysisScheme
text field.
Constraints:
Pattern: [\S]+
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Boolean multiAZ
false.AvailabilityOptionsStatus availabilityOptions
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ScalingParameters scalingParameters
ScalingParametersStatus scalingParameters
String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
String accessPolicies
AccessPoliciesStatus accessPolicies
Copyright © 2016. All rights reserved.