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 min
The minimum value found in the specified field in the result set.
If the field is numeric (int, int-array, double, or
double-array), min is the string representation of a double-precision 64-bit floating
point value. If the field is date or date-array, min is the string
representation of a date with the format specified in IETF
RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
String max
The maximum value found in the specified field in the result set.
If the field is numeric (int, int-array, double, or
double-array), max is the string representation of a double-precision 64-bit floating
point value. If the field is date or date-array, max is the string
representation of a date with the format specified in IETF
RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
Long count
The number of documents that contain a value in the specified field in the result set.
Long missing
The number of documents that do not contain a value in the specified field in the result set.
Double sum
The sum of the field values across the documents in the result set. null for date fields.
Double sumOfSquares
The sum of all field values in the result set squared.
String mean
The average of the values found in the specified field in the result set.
If the field is numeric (int, int-array, double, or
double-array), mean is the string representation of a double-precision 64-bit floating
point value. If the field is date or date-array, mean is the string
representation of a date with the format specified in IETF
RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
Double stddev
The standard deviation of the values in the specified field in the result set.
String id
The document ID of a document that matches the search request.
SdkInternalMap<K,V> fields
The fields returned from a document that matches the search request.
SdkInternalMap<K,V> exprs
The expressions returned from a document that matches the search request.
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.
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.
String 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.
SearchStatus status
The status information returned for the search request.
Hits hits
The documents that match the search criteria.
SdkInternalMap<K,V> facets
The requested facet information.
SdkInternalMap<K,V> stats
The requested field statistics 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.
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.
SdkInternalList<T> warnings
Any warnings returned by the document service about the documents being uploaded.
String options
OptionStatus status
String synonyms
A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
String stopwords
A JSON array of terms to ignore during indexing and searching. For example, ["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
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example,
{"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
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
String algorithmicStemming
The level of algorithmic stemming to perform: 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
String analysisSchemeName
String analysisSchemeLanguage
AnalysisOptions analysisOptions
AnalysisScheme options
OptionStatus status
Boolean options
The availability options configured for the domain.
OptionStatus status
String code
String domainName
SdkInternalList<T> fieldNames
String domainName
A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.
DomainStatus domainStatus
String defaultValue
String sourceFields
A list of source fields to map to the field.
Boolean facetEnabled
Whether facet information can be returned for the field.
Boolean searchEnabled
Whether the contents of the field are searchable.
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
String defaultValue
String sourceField
Boolean facetEnabled
Whether facet information can be returned for the field.
Boolean searchEnabled
Whether the contents of the field are searchable.
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
Boolean sortEnabled
Whether the field can be used to sort the search results.
String domainName
AnalysisScheme analysisScheme
AnalysisSchemeStatus analysisScheme
String domainName
Expression expression
ExpressionStatus expression
String domainName
IndexField indexField
The index field and field options you want to configure.
IndexFieldStatus indexField
SuggesterStatus suggester
AnalysisSchemeStatus analysisScheme
The status of the analysis scheme being deleted.
String domainName
The name of the domain you want to permanently delete.
DomainStatus domainStatus
String domainName
String expressionName
The name of the Expression to delete.
ExpressionStatus expression
The status of the expression being deleted.
IndexFieldStatus indexField
The status of the index field being deleted.
SuggesterStatus suggester
The status of the suggester being deleted.
String domainName
The name of the domain you want to describe.
SdkInternalList<T> analysisSchemeNames
The analysis schemes you want to describe.
Boolean deployed
Whether to display the deployed configuration (true) or include any pending changes (
false). Defaults to false.
SdkInternalList<T> analysisSchemes
The analysis scheme descriptions.
AvailabilityOptionsStatus availabilityOptions
The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
DomainEndpointOptionsStatus domainEndpointOptions
The status and configuration of a search domain's endpoint options.
SdkInternalList<T> domainNames
The names of the domains you want to include in the response.
SdkInternalList<T> domainStatusList
String domainName
The name of the domain you want to describe.
SdkInternalList<T> expressionNames
Limits the DescribeExpressions response to the specified expressions. If not specified, all
expressions are shown.
Boolean deployed
Whether to display the deployed configuration (true) or include any pending changes (
false). Defaults to false.
SdkInternalList<T> expressions
The expressions configured for the domain.
String domainName
The name of the domain you want to describe.
SdkInternalList<T> fieldNames
A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
Boolean deployed
Whether to display the deployed configuration (true) or include any pending changes (
false). Defaults to false.
SdkInternalList<T> indexFields
The index fields configured for the domain.
String domainName
ScalingParametersStatus scalingParameters
AccessPoliciesStatus accessPolicies
The access rules configured for the domain specified in the request.
String domainName
The name of the domain you want to describe.
SdkInternalList<T> suggesterNames
The suggesters you want to describe.
Boolean deployed
Whether to display the deployed configuration (true) or include any pending changes (
false). Defaults to false.
SdkInternalList<T> suggesters
The suggesters configured for the domain specified in the request.
String sourceField
The name of the index field you want to use for suggestions.
String fuzzyMatching
The level of fuzziness allowed when suggesting matches for a string: 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.
String sortExpression
An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to
the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for
suggestions, so sort expressions cannot reference the _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.
DomainEndpointOptions options
The domain endpoint options configured for the domain.
OptionStatus status
The status of the configured domain endpoint options.
String domainId
String domainName
String aRN
Boolean created
True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
Boolean deleted
True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
ServiceEndpoint docService
The service endpoint for updating documents in a search domain.
ServiceEndpoint searchService
The service endpoint for requesting search results from a search domain.
Boolean requiresIndexDocuments
True if IndexDocuments needs to be called to activate the current domain configuration.
Boolean processing
True if processing is being done to activate the current domain configuration.
String searchInstanceType
The instance type that is being used to process search requests.
Integer searchPartitionCount
The number of partitions across which the search index is spread.
Integer searchInstanceCount
The number of search instances that are available to process search requests.
Limits limits
Double defaultValue
String sourceFields
A list of source fields to map to the field.
Boolean facetEnabled
Whether facet information can be returned for the field.
Boolean searchEnabled
Whether the contents of the field are searchable.
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
Double defaultValue
A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
String sourceField
The name of the source field to map to the field.
Boolean facetEnabled
Whether facet information can be returned for the field.
Boolean searchEnabled
Whether the contents of the field are searchable.
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
Boolean sortEnabled
Whether the field can be used to sort the search results.
Expression options
The expression that is evaluated for sorting while processing a search request.
OptionStatus status
String domainName
SdkInternalList<T> fieldNames
The names of the fields that are currently being indexed.
String indexFieldName
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
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.
String indexFieldType
IntOptions intOptions
DoubleOptions doubleOptions
LiteralOptions literalOptions
TextOptions textOptions
DateOptions dateOptions
LatLonOptions latLonOptions
IntArrayOptions intArrayOptions
DoubleArrayOptions doubleArrayOptions
LiteralArrayOptions literalArrayOptions
TextArrayOptions textArrayOptions
DateArrayOptions dateArrayOptions
IndexField options
OptionStatus status
Long defaultValue
String sourceFields
A list of source fields to map to the field.
Boolean facetEnabled
Whether facet information can be returned for the field.
Boolean searchEnabled
Whether the contents of the field are searchable.
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
Long defaultValue
String sourceField
The name of the source field to map to the field.
Boolean facetEnabled
Whether facet information can be returned for the field.
Boolean searchEnabled
Whether the contents of the field are searchable.
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
Boolean sortEnabled
Whether the field can be used to sort the search results.
String defaultValue
String sourceField
Boolean facetEnabled
Whether facet information can be returned for the field.
Boolean searchEnabled
Whether the contents of the field are searchable.
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
Boolean sortEnabled
Whether the field can be used to sort the search results.
SdkInternalMap<K,V> domainNames
The names of the search domains owned by an account.
String defaultValue
String sourceFields
A list of source fields to map to the field.
Boolean facetEnabled
Whether facet information can be returned for the field.
Boolean searchEnabled
Whether the contents of the field are searchable.
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
String defaultValue
String sourceField
Boolean facetEnabled
Whether facet information can be returned for the field.
Boolean searchEnabled
Whether the contents of the field are searchable.
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
Boolean sortEnabled
Whether the field can be used to sort the search results.
Date creationDate
A timestamp for when this option was created.
Date updateDate
A timestamp for when this option was last updated.
Integer updateVersion
A unique integer that indicates when this option was last updated.
String state
The state of processing a change to an option. Possible values:
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.Boolean pendingDeletion
Indicates that the option will be deleted once processing is complete.
String desiredInstanceType
The instance type that you want to preconfigure for your domain. For example, search.m1.small.
Integer desiredReplicationCount
The number of replicas you want to preconfigure for each index partition.
Integer desiredPartitionCount
The number of partitions you want to preconfigure for your domain. Only valid when you select
m2.2xlarge as the desired instance type.
ScalingParameters options
OptionStatus status
String endpoint
String suggesterName
DocumentSuggesterOptions documentSuggesterOptions
Suggester options
OptionStatus status
String defaultValue
String sourceFields
A list of source fields to map to the field.
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
Boolean highlightEnabled
Whether highlights can be returned for the field.
String analysisScheme
The name of an analysis scheme for a text-array field.
String defaultValue
String sourceField
Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
Boolean sortEnabled
Whether the field can be used to sort the search results.
Boolean highlightEnabled
Whether highlights can be returned for the field.
String analysisScheme
The name of an analysis scheme for a text field.
String domainName
Boolean multiAZ
You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true.
Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting
the Multi-AZ option to false.
AvailabilityOptionsStatus availabilityOptions
The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.
String domainName
A string that represents the name of a domain.
DomainEndpointOptions domainEndpointOptions
Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.
DomainEndpointOptionsStatus domainEndpointOptions
The newly-configured domain endpoint options.
String domainName
ScalingParameters scalingParameters
ScalingParametersStatus scalingParameters
AccessPoliciesStatus accessPolicies
The access rules configured for the domain.
Copyright © 2022. All rights reserved.