# Data Types
<a name="API_Types"></a>

 The Amazon CloudSearch Configuration Service API contains several data types that various actions use. This section describes each data type in detail. 

**Note**  
The order of each element in the response is not guaranteed. Applications should not assume a particular order. 

The following data types are supported:
+  [AccessPoliciesStatus](API_AccessPoliciesStatus.md) 
+  [AnalysisOptions](API_AnalysisOptions.md) 
+  [AnalysisScheme](API_AnalysisScheme.md) 
+  [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) 
+  [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md) 
+  [BuildSuggestersResult](API_BuildSuggestersResult.md) 
+  [CreateDomainResult](API_CreateDomainResult.md) 
+  [DateArrayOptions](API_DateArrayOptions.md) 
+  [DateOptions](API_DateOptions.md) 
+  [DefineAnalysisSchemeResult](API_DefineAnalysisSchemeResult.md) 
+  [DefineExpressionResult](API_DefineExpressionResult.md) 
+  [DefineIndexFieldResult](API_DefineIndexFieldResult.md) 
+  [DefineSuggesterResult](API_DefineSuggesterResult.md) 
+  [DeleteAnalysisSchemeResult](API_DeleteAnalysisSchemeResult.md) 
+  [DeleteDomainResult](API_DeleteDomainResult.md) 
+  [DeleteExpressionResult](API_DeleteExpressionResult.md) 
+  [DeleteIndexFieldResult](API_DeleteIndexFieldResult.md) 
+  [DeleteSuggesterResult](API_DeleteSuggesterResult.md) 
+  [DescribeAnalysisSchemesResult](API_DescribeAnalysisSchemesResult.md) 
+  [DescribeAvailabilityOptionsResult](API_DescribeAvailabilityOptionsResult.md) 
+  [DescribeDomainsResult](API_DescribeDomainsResult.md) 
+  [DescribeExpressionsResult](API_DescribeExpressionsResult.md) 
+  [DescribeIndexFieldsResult](API_DescribeIndexFieldsResult.md) 
+  [DescribeScalingParametersResult](API_DescribeScalingParametersResult.md) 
+  [DescribeServiceAccessPoliciesResult](API_DescribeServiceAccessPoliciesResult.md) 
+  [DescribeSuggestersResult](API_DescribeSuggestersResult.md) 
+  [DocumentSuggesterOptions](API_DocumentSuggesterOptions.md) 
+  [DomainStatus](API_DomainStatus.md) 
+  [DoubleArrayOptions](API_DoubleArrayOptions.md) 
+  [DoubleOptions](API_DoubleOptions.md) 
+  [Expression](API_Expression.md) 
+  [ExpressionStatus](API_ExpressionStatus.md) 
+  [IndexDocumentsResult](API_IndexDocumentsResult.md) 
+  [IndexField](API_IndexField.md) 
+  [IndexFieldStatus](API_IndexFieldStatus.md) 
+  [IntArrayOptions](API_IntArrayOptions.md) 
+  [IntOptions](API_IntOptions.md) 
+  [LatLonOptions](API_LatLonOptions.md) 
+  [Limits](API_Limits.md) 
+  [ListDomainNamesResult](API_ListDomainNamesResult.md) 
+  [LiteralArrayOptions](API_LiteralArrayOptions.md) 
+  [LiteralOptions](API_LiteralOptions.md) 
+  [BuildSuggestersResult](API_BuildSuggestersResult.md) 
+  [OptionStatus](API_OptionStatus.md) 
+  [ScalingParameters](API_ScalingParameters.md) 
+  [ScalingParametersStatus](API_ScalingParametersStatus.md) 
+  [ServiceEndpoint](API_ServiceEndpoint.md) 
+  [Suggester](API_Suggester.md) 
+  [SuggesterStatus](API_SuggesterStatus.md) 
+  [TextArrayOptions](API_TextArrayOptions.md) 
+  [TextOptions](API_TextOptions.md) 
+  [UpdateAvailabilityOptionsResult](API_UpdateAvailabilityOptionsResult.md) 
+  [UpdateScalingParametersResult](API_UpdateScalingParametersResult.md) 
+  [UpdateServiceAccessPoliciesResult](API_UpdateServiceAccessPoliciesResult.md) 

# AccessPoliciesStatus
<a name="API_AccessPoliciesStatus"></a>

## Description
<a name="API_AccessPoliciesStatus_Description"></a>

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

## Contents
<a name="API_AccessPoliciesStatus_Contents"></a>

 **Options**   
Access rules for a domain's document or search service endpoints. For more information, see [Configuring Access for a Search Domain](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) in the *Amazon CloudSearch Developer Guide*. The maximum size of a policy document is 100 KB.  
Type: String  
 Required: Yes 

 **Status**   
The status of domain configuration option.  
Type: [OptionStatus](API_OptionStatus.md)   
 Required: Yes 

# AnalysisOptions
<a name="API_AnalysisOptions"></a>

## Description
<a name="API_AnalysisOptions_Description"></a>

Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

## Contents
<a name="API_AnalysisOptions_Contents"></a>

 **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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings) in the *Amazon CloudSearch Developer Guide*   
Type: String  
 Valid Values: `none | minimal | light | full`   
 Required: No 

 **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.  
Type: String  
 Required: No 

 **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.  
Type: String  
 Required: No 

 **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.   
Type: String  
 Required: No 

 **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](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms) in the *Amazon CloudSearch Developer Guide*.  
Type: String  
 Required: No 

# AnalysisScheme
<a name="API_AnalysisScheme"></a>

## Description
<a name="API_AnalysisScheme_Description"></a>

Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: `Synonyms`, `Stopwords`, `StemmingDictionary`, `JapaneseTokenizationDictionary` and `AlgorithmicStemming`.

## Contents
<a name="API_AnalysisScheme_Contents"></a>

 **AnalysisOptions**   
Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.  
Type: [AnalysisOptions](API_AnalysisOptions.md)   
 Required: No 

 **AnalysisSchemeLanguage**   
An [IETF RFC 4646](http://tools.ietf.org/html/rfc4646) language code or `mul` for multiple languages.  
Type: String  
 Valid 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`   
 Required: Yes 

 **AnalysisSchemeName**   
Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and \$1 (underscore).  
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: Yes 

# AnalysisSchemeStatus
<a name="API_AnalysisSchemeStatus"></a>

## Description
<a name="API_AnalysisSchemeStatus_Description"></a>

The status and configuration of an `AnalysisScheme`.

## Contents
<a name="API_AnalysisSchemeStatus_Contents"></a>

 **Options**   
Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: `Synonyms`, `Stopwords`, `StemmingDictionary`, `JapaneseTokenizationDictionary` and `AlgorithmicStemming`.  
Type: [AnalysisScheme](API_AnalysisScheme.md)   
 Required: Yes 

 **Status**   
The status of domain configuration option.  
Type: [OptionStatus](API_OptionStatus.md)   
 Required: Yes 

# AvailabilityOptionsStatus
<a name="API_AvailabilityOptionsStatus"></a>

## Description
<a name="API_AvailabilityOptionsStatus_Description"></a>

The status and configuration of the domain's availability options.

## Contents
<a name="API_AvailabilityOptionsStatus_Contents"></a>

 **Options**   
The availability options configured for the domain.  
Type: Boolean  
 Required: Yes 

 **Status**   
The status of domain configuration option.  
Type: [OptionStatus](API_OptionStatus.md)   
 Required: Yes 

# BuildSuggestersResult
<a name="API_BuildSuggestersResult"></a>

## Description
<a name="API_BuildSuggestersResult_Description"></a>

The result of a `BuildSuggester` request. Contains a list of the fields used for suggestions.

## Contents
<a name="API_BuildSuggestersResult_Contents"></a>

 **FieldNames**   
A list of field names.  
Type: String list   
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

# CreateDomainResult
<a name="API_CreateDomainResult"></a>

## Description
<a name="API_CreateDomainResult_Description"></a>

The result of a `CreateDomainRequest`. Contains the status of a newly created domain.

## Contents
<a name="API_CreateDomainResult_Contents"></a>

 **DomainStatus**   
The current status of the search domain.  
Type: [DomainStatus](API_DomainStatus.md)   
 Required: No 

# DateArrayOptions
<a name="API_DateArrayOptions"></a>

## Description
<a name="API_DateArrayOptions_Description"></a>

Options for a field that contains an array of dates. Present if `IndexFieldType` specifies the field is of type `date-array`. All options are enabled by default.

## Contents
<a name="API_DateArrayOptions_Contents"></a>

 **DefaultValue**   
 A value to use for the field if the field isn't specified for a document.   
Type: String  
 Length constraints: Minimum length of 0. Maximum length of 1024.   
 Required: No 

 **FacetEnabled**   
Whether facet information can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SearchEnabled**   
Whether the contents of the field are searchable.  
Type: Boolean  
 Required: No 

 **SourceFields**   
A list of source fields to map to the field.   
Type: String  
 Required: No 

# DateOptions
<a name="API_DateOptions"></a>

## Description
<a name="API_DateOptions_Description"></a>

Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if `IndexFieldType` specifies the field is of type `date`. All options are enabled by default.

## Contents
<a name="API_DateOptions_Contents"></a>

 **DefaultValue**   
 A value to use for the field if the field isn't specified for a document.   
Type: String  
 Length constraints: Minimum length of 0. Maximum length of 1024.   
 Required: No 

 **FacetEnabled**   
Whether facet information can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SearchEnabled**   
Whether the contents of the field are searchable.  
Type: Boolean  
 Required: No 

 **SortEnabled**   
Whether the field can be used to sort the search results.  
Type: Boolean  
 Required: No 

 **SourceField**   
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 \$1 (underscore). Dynamic field names must begin or end with a wildcard (\$1). 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`.   
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

# DefineAnalysisSchemeResult
<a name="API_DefineAnalysisSchemeResult"></a>

## Description
<a name="API_DefineAnalysisSchemeResult_Description"></a>

The result of a ` DefineAnalysisScheme ` request. Contains the status of the newly-configured analysis scheme.

## Contents
<a name="API_DefineAnalysisSchemeResult_Contents"></a>

 **AnalysisScheme**   
The status and configuration of an `AnalysisScheme`.  
Type: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md)   
 Required: Yes 

# DefineExpressionResult
<a name="API_DefineExpressionResult"></a>

## Description
<a name="API_DefineExpressionResult_Description"></a>

The result of a `DefineExpression` request. Contains the status of the newly-configured expression.

## Contents
<a name="API_DefineExpressionResult_Contents"></a>

 **Expression**   
The value of an `Expression` and its current status.  
Type: [ExpressionStatus](API_ExpressionStatus.md)   
 Required: Yes 

# DefineIndexFieldResult
<a name="API_DefineIndexFieldResult"></a>

## Description
<a name="API_DefineIndexFieldResult_Description"></a>

The result of a ` DefineIndexField ` request. Contains the status of the newly-configured index field.

## Contents
<a name="API_DefineIndexFieldResult_Contents"></a>

 **IndexField**   
The value of an `IndexField` and its current status.  
Type: [IndexFieldStatus](API_IndexFieldStatus.md)   
 Required: Yes 

# DefineSuggesterResult
<a name="API_DefineSuggesterResult"></a>

## Description
<a name="API_DefineSuggesterResult_Description"></a>

The result of a `DefineSuggester` request. Contains the status of the newly-configured suggester.

## Contents
<a name="API_DefineSuggesterResult_Contents"></a>

 **Suggester**   
The value of a `Suggester` and its current status.  
Type: [SuggesterStatus](API_SuggesterStatus.md)   
 Required: Yes 

# DeleteAnalysisSchemeResult
<a name="API_DeleteAnalysisSchemeResult"></a>

## Description
<a name="API_DeleteAnalysisSchemeResult_Description"></a>

The result of a `DeleteAnalysisScheme` request. Contains the status of the deleted analysis scheme.

## Contents
<a name="API_DeleteAnalysisSchemeResult_Contents"></a>

 **AnalysisScheme**   
The status of the analysis scheme being deleted.  
Type: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md)   
 Required: Yes 

# DeleteDomainResult
<a name="API_DeleteDomainResult"></a>

## Description
<a name="API_DeleteDomainResult_Description"></a>

The result of a `DeleteDomain` request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

## Contents
<a name="API_DeleteDomainResult_Contents"></a>

 **DomainStatus**   
The current status of the search domain.  
Type: [DomainStatus](API_DomainStatus.md)   
 Required: No 

# DeleteExpressionResult
<a name="API_DeleteExpressionResult"></a>

## Description
<a name="API_DeleteExpressionResult_Description"></a>

The result of a ` DeleteExpression ` request. Specifies the expression being deleted.

## Contents
<a name="API_DeleteExpressionResult_Contents"></a>

 **Expression**   
The status of the expression being deleted.  
Type: [ExpressionStatus](API_ExpressionStatus.md)   
 Required: Yes 

# DeleteIndexFieldResult
<a name="API_DeleteIndexFieldResult"></a>

## Description
<a name="API_DeleteIndexFieldResult_Description"></a>

The result of a ` DeleteIndexField ` request.

## Contents
<a name="API_DeleteIndexFieldResult_Contents"></a>

 **IndexField**   
The status of the index field being deleted.  
Type: [IndexFieldStatus](API_IndexFieldStatus.md)   
 Required: Yes 

# DeleteSuggesterResult
<a name="API_DeleteSuggesterResult"></a>

## Description
<a name="API_DeleteSuggesterResult_Description"></a>

The result of a `DeleteSuggester` request. Contains the status of the deleted suggester.

## Contents
<a name="API_DeleteSuggesterResult_Contents"></a>

 **Suggester**   
The status of the suggester being deleted.  
Type: [SuggesterStatus](API_SuggesterStatus.md)   
 Required: Yes 

# DescribeAnalysisSchemesResult
<a name="API_DescribeAnalysisSchemesResult"></a>

## Description
<a name="API_DescribeAnalysisSchemesResult_Description"></a>

The result of a `DescribeAnalysisSchemes` request. Contains the analysis schemes configured for the domain specified in the request.

## Contents
<a name="API_DescribeAnalysisSchemesResult_Contents"></a>

 **AnalysisSchemes**   
The analysis scheme descriptions.  
Type: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) list   
 Required: Yes 

# DescribeAvailabilityOptionsResult
<a name="API_DescribeAvailabilityOptionsResult"></a>

## Description
<a name="API_DescribeAvailabilityOptionsResult_Description"></a>

The result of a `DescribeAvailabilityOptions` request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request. 

## Contents
<a name="API_DescribeAvailabilityOptionsResult_Contents"></a>

 **AvailabilityOptions**   
The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.   
Type: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md)   
 Required: No 

# DescribeDomainsResult
<a name="API_DescribeDomainsResult"></a>

## Description
<a name="API_DescribeDomainsResult_Description"></a>

The result of a `DescribeDomains` request. Contains the status of the domains specified in the request or all domains owned by the account.

## Contents
<a name="API_DescribeDomainsResult_Contents"></a>

 **DomainStatusList**   
A list that contains the status of each requested domain.  
Type: [DomainStatus](API_DomainStatus.md) list   
 Required: Yes 

# DescribeExpressionsResult
<a name="API_DescribeExpressionsResult"></a>

## Description
<a name="API_DescribeExpressionsResult_Description"></a>

The result of a `DescribeExpressions` request. Contains the expressions configured for the domain specified in the request.

## Contents
<a name="API_DescribeExpressionsResult_Contents"></a>

 **Expressions**   
The expressions configured for the domain.  
Type: [ExpressionStatus](API_ExpressionStatus.md) list   
 Required: Yes 

# DescribeIndexFieldsResult
<a name="API_DescribeIndexFieldsResult"></a>

## Description
<a name="API_DescribeIndexFieldsResult_Description"></a>

The result of a `DescribeIndexFields` request. Contains the index fields configured for the domain specified in the request.

## Contents
<a name="API_DescribeIndexFieldsResult_Contents"></a>

 **IndexFields**   
The index fields configured for the domain.  
Type: [IndexFieldStatus](API_IndexFieldStatus.md) list   
 Required: Yes 

# DescribeScalingParametersResult
<a name="API_DescribeScalingParametersResult"></a>

## Description
<a name="API_DescribeScalingParametersResult_Description"></a>

The result of a `DescribeScalingParameters` request. Contains the scaling parameters configured for the domain specified in the request.

## Contents
<a name="API_DescribeScalingParametersResult_Contents"></a>

 **ScalingParameters**   
The status and configuration of a search domain's scaling parameters.   
Type: [ScalingParametersStatus](API_ScalingParametersStatus.md)   
 Required: Yes 

# DescribeServiceAccessPoliciesResult
<a name="API_DescribeServiceAccessPoliciesResult"></a>

## Description
<a name="API_DescribeServiceAccessPoliciesResult_Description"></a>

The result of a `DescribeServiceAccessPolicies` request.

## Contents
<a name="API_DescribeServiceAccessPoliciesResult_Contents"></a>

 **AccessPolicies**   
The access rules configured for the domain specified in the request.  
Type: [AccessPoliciesStatus](API_AccessPoliciesStatus.md)   
 Required: Yes 

# DescribeSuggestersResult
<a name="API_DescribeSuggestersResult"></a>

## Description
<a name="API_DescribeSuggestersResult_Description"></a>

The result of a `DescribeSuggesters` request.

## Contents
<a name="API_DescribeSuggestersResult_Contents"></a>

 **Suggesters**   
The suggesters configured for the domain specified in the request.  
Type: [SuggesterStatus](API_SuggesterStatus.md) list   
 Required: Yes 

# DocumentSuggesterOptions
<a name="API_DocumentSuggesterOptions"></a>

## Description
<a name="API_DocumentSuggesterOptions_Description"></a>

Options for a search suggester.

## Contents
<a name="API_DocumentSuggesterOptions_Contents"></a>

 **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.   
Type: String  
 Valid Values: `none | low | high`   
 Required: No 

 **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.  
Type: String  
 Required: No 

 **SourceField**   
The name of the index field you want to use for suggestions.   
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: Yes 

# DomainEndpointOptions
<a name="API_DomainEndpointOptions"></a>

## Description
<a name="API_DomainEndpointOptions_Description"></a>

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`.

## Contents
<a name="API_DomainEndpointOptions_Contents"></a>

 **EnforceHTTPS**  
Enables or disables the requirement that all requests to the domain arrive over HTTPS.  
Type: Boolean  
Valid Values: `true | false`  
Required: No

 **TLSSecurityPolicy**  
The minimum required TLS version.  
Type: String  
Valid Values: `Policy-Min-TLS-1-2-2019-07 | Policy-Min-TLS-1-0-2019-07`  
Required: No

# DomainEndpointOptionsStatus
<a name="API_DomainEndpointOptionsStatus"></a>

## Description
<a name="API_DomainEndpointOptionsStatus_Description"></a>

The configuration and status of the domain's endpoint options.

## Contents
<a name="API_DomainEndpointOptionsStatus_Contents"></a>

 **Options**  
The current configuration.  
Type: [DomainEndpointOptions](API_DomainEndpointOptions.md)

 **Status**  
The status of the configuration option.  
Type: [OptionStatus](API_OptionStatus.md)

# DomainStatus
<a name="API_DomainStatus"></a>

## Description
<a name="API_DomainStatus_Description"></a>

The current status of the search domain.

## Contents
<a name="API_DomainStatus_Contents"></a>

 **ARN**   
The Amazon Resource Name (ARN) of the search domain. See [Identifiers for IAM Entities](http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html) in *Using AWS Identity and Access Management* for more information.  
Type: String  
 Required: No 

 **Created**   
True if the search domain is created. It can take several minutes to initialize a domain when [CreateDomain](API_CreateDomain.md) is called. Newly created search domains are returned from [DescribeDomains](API_DescribeDomains.md) with a false value for Created until domain creation is complete.  
Type: Boolean  
 Required: No 

 **Deleted**   
True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when [DeleteDomain](API_DeleteDomain.md) is called. Newly deleted search domains are returned from [DescribeDomains](API_DescribeDomains.md) with a true value for IsDeleted for several minutes until resource cleanup is complete.  
Type: Boolean  
 Required: No 

 **DocService**   
The service endpoint for updating documents in a search domain.  
Type: [ServiceEndpoint](API_ServiceEndpoint.md)   
 Required: No 

 **DomainId**   
An internally generated unique identifier for a domain.  
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: Yes 

 **DomainName**   
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).  
Type: String  
 Length constraints: Minimum length of 3. Maximum length of 28.   
 Required: Yes 

 **Limits**   
Type: [Limits](API_Limits.md)   
 Required: No 

 **Processing**   
True if processing is being done to activate the current domain configuration.  
Type: Boolean  
 Required: No 

 **RequiresIndexDocuments**   
True if [IndexDocuments](API_IndexDocuments.md) needs to be called to activate the current domain configuration.  
Type: Boolean  
 Required: Yes 

 **SearchInstanceCount**   
The number of search instances that are available to process search requests.  
Type: Integer  
 Required: No 

 **SearchInstanceType**   
The instance type that is being used to process search requests.  
Type: String  
 Required: No 

 **SearchPartitionCount**   
The number of partitions across which the search index is spread.  
Type: Integer  
 Required: No 

 **SearchService**   
The service endpoint for requesting search results from a search domain.  
Type: [ServiceEndpoint](API_ServiceEndpoint.md)   
 Required: No 

# DoubleArrayOptions
<a name="API_DoubleArrayOptions"></a>

## Description
<a name="API_DoubleArrayOptions_Description"></a>

Options for a field that contains an array of double-precision 64-bit floating point values. Present if `IndexFieldType` specifies the field is of type `double-array`. All options are enabled by default.

## Contents
<a name="API_DoubleArrayOptions_Contents"></a>

 **DefaultValue**   
 A value to use for the field if the field isn't specified for a document.   
Type: Double  
 Required: No 

 **FacetEnabled**   
Whether facet information can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SearchEnabled**   
Whether the contents of the field are searchable.  
Type: Boolean  
 Required: No 

 **SourceFields**   
A list of source fields to map to the field.   
Type: String  
 Required: No 

# DoubleOptions
<a name="API_DoubleOptions"></a>

## Description
<a name="API_DoubleOptions_Description"></a>

Options for a double-precision 64-bit floating point field. Present if `IndexFieldType` specifies the field is of type `double`. All options are enabled by default.

## Contents
<a name="API_DoubleOptions_Contents"></a>

 **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.  
Type: Double  
 Required: No 

 **FacetEnabled**   
Whether facet information can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SearchEnabled**   
Whether the contents of the field are searchable.  
Type: Boolean  
 Required: No 

 **SortEnabled**   
Whether the field can be used to sort the search results.  
Type: Boolean  
 Required: No 

 **SourceField**   
The name of the source field to map to the field.   
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

# Expression
<a name="API_Expression"></a>

## Description
<a name="API_Expression_Description"></a>

A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results. 

## Contents
<a name="API_Expression_Contents"></a>

 **ExpressionName**   
Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and \$1 (underscore).  
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: Yes 

 **ExpressionValue**   
The expression to evaluate for sorting while processing a search request. The `Expression` syntax is based on JavaScript expressions. For more information, see [Configuring Expressions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the *Amazon CloudSearch Developer Guide*.  
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 10240.   
 Required: Yes 

# ExpressionStatus
<a name="API_ExpressionStatus"></a>

## Description
<a name="API_ExpressionStatus_Description"></a>

The value of an `Expression` and its current status.

## Contents
<a name="API_ExpressionStatus_Contents"></a>

 **Options**   
The expression that is evaluated for sorting while processing a search request.  
Type: [Expression](API_Expression.md)   
 Required: Yes 

 **Status**   
The status of domain configuration option.  
Type: [OptionStatus](API_OptionStatus.md)   
 Required: Yes 

# IndexDocumentsResult
<a name="API_IndexDocumentsResult"></a>

## Description
<a name="API_IndexDocumentsResult_Description"></a>

The result of an `IndexDocuments` request. Contains the status of the indexing operation, including the fields being indexed.

## Contents
<a name="API_IndexDocumentsResult_Contents"></a>

 **FieldNames**   
The names of the fields that are currently being indexed.  
Type: String list   
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

# IndexField
<a name="API_IndexField"></a>

## Description
<a name="API_IndexField_Description"></a>

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the ` IndexFieldType `.

## Contents
<a name="API_IndexField_Contents"></a>

 **DateArrayOptions**   
Options for a field that contains an array of dates. Present if `IndexFieldType` specifies the field is of type `date-array`. All options are enabled by default.  
Type: [DateArrayOptions](API_DateArrayOptions.md)   
 Required: No 

 **DateOptions**   
Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if `IndexFieldType` specifies the field is of type `date`. All options are enabled by default.  
Type: [DateOptions](API_DateOptions.md)   
 Required: No 

 **DoubleArrayOptions**   
Options for a field that contains an array of double-precision 64-bit floating point values. Present if `IndexFieldType` specifies the field is of type `double-array`. All options are enabled by default.  
Type: [DoubleArrayOptions](API_DoubleArrayOptions.md)   
 Required: No 

 **DoubleOptions**   
Options for a double-precision 64-bit floating point field. Present if `IndexFieldType` specifies the field is of type `double`. All options are enabled by default.  
Type: [DoubleOptions](API_DoubleOptions.md)   
 Required: No 

 **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 \$1 (underscore). Dynamic field names must begin or end with a wildcard (\$1). 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`.   
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: Yes 

 **IndexFieldType**   
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see [Configuring Index Fields](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) in the *Amazon CloudSearch Developer Guide*.  
Type: String  
 Valid Values: `int | double | literal | text | date | latlon | int-array | double-array | literal-array | text-array | date-array`   
 Required: Yes 

 **IntArrayOptions**   
Options for a field that contains an array of 64-bit signed integers. Present if `IndexFieldType` specifies the field is of type `int-array`. All options are enabled by default.  
Type: [IntArrayOptions](API_IntArrayOptions.md)   
 Required: No 

 **IntOptions**   
Options for a 64-bit signed integer field. Present if `IndexFieldType` specifies the field is of type `int`. All options are enabled by default.  
Type: [IntOptions](API_IntOptions.md)   
 Required: No 

 **LatLonOptions**   
Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if `IndexFieldType` specifies the field is of type `latlon`. All options are enabled by default.  
Type: [LatLonOptions](API_LatLonOptions.md)   
 Required: No 

 **LiteralArrayOptions**   
Options for a field that contains an array of literal strings. Present if `IndexFieldType` specifies the field is of type `literal-array`. All options are enabled by default.  
Type: [LiteralArrayOptions](API_LiteralArrayOptions.md)   
 Required: No 

 **LiteralOptions**   
Options for literal field. Present if `IndexFieldType` specifies the field is of type `literal`. All options are enabled by default.  
Type: [LiteralOptions](API_LiteralOptions.md)   
 Required: No 

 **TextArrayOptions**   
Options for a field that contains an array of text strings. Present if `IndexFieldType` specifies the field is of type `text-array`. A `text-array` field is always searchable. All options are enabled by default.  
Type: [TextArrayOptions](API_TextArrayOptions.md)   
 Required: No 

 **TextOptions**   
Options for text field. Present if `IndexFieldType` specifies the field is of type `text`. A `text` field is always searchable. All options are enabled by default.  
Type: [TextOptions](API_TextOptions.md)   
 Required: No 

# IndexFieldStatus
<a name="API_IndexFieldStatus"></a>

## Description
<a name="API_IndexFieldStatus_Description"></a>

The value of an `IndexField` and its current status.

## Contents
<a name="API_IndexFieldStatus_Contents"></a>

 **Options**   
Configuration information for a field in the index, including its name, type, and options. The supported options depend on the ` IndexFieldType `.  
Type: [IndexField](API_IndexField.md)   
 Required: Yes 

 **Status**   
The status of domain configuration option.  
Type: [OptionStatus](API_OptionStatus.md)   
 Required: Yes 

# IntArrayOptions
<a name="API_IntArrayOptions"></a>

## Description
<a name="API_IntArrayOptions_Description"></a>

Options for a field that contains an array of 64-bit signed integers. Present if `IndexFieldType` specifies the field is of type `int-array`. All options are enabled by default.

## Contents
<a name="API_IntArrayOptions_Contents"></a>

 **DefaultValue**   
 A value to use for the field if the field isn't specified for a document.   
Type: Long  
 Required: No 

 **FacetEnabled**   
Whether facet information can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SearchEnabled**   
Whether the contents of the field are searchable.  
Type: Boolean  
 Required: No 

 **SourceFields**   
A list of source fields to map to the field.   
Type: String  
 Required: No 

# IntOptions
<a name="API_IntOptions"></a>

## Description
<a name="API_IntOptions_Description"></a>

Options for a 64-bit signed integer field. Present if `IndexFieldType` specifies the field is of type `int`. All options are enabled by default.

## Contents
<a name="API_IntOptions_Contents"></a>

 **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.   
Type: Long  
 Required: No 

 **FacetEnabled**   
Whether facet information can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SearchEnabled**   
Whether the contents of the field are searchable.  
Type: Boolean  
 Required: No 

 **SortEnabled**   
Whether the field can be used to sort the search results.  
Type: Boolean  
 Required: No 

 **SourceField**   
The name of the source field to map to the field.   
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

# LatLonOptions
<a name="API_LatLonOptions"></a>

## Description
<a name="API_LatLonOptions_Description"></a>

Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if `IndexFieldType` specifies the field is of type `latlon`. All options are enabled by default.

## Contents
<a name="API_LatLonOptions_Contents"></a>

 **DefaultValue**   
 A value to use for the field if the field isn't specified for a document.   
Type: String  
 Length constraints: Minimum length of 0. Maximum length of 1024.   
 Required: No 

 **FacetEnabled**   
Whether facet information can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SearchEnabled**   
Whether the contents of the field are searchable.  
Type: Boolean  
 Required: No 

 **SortEnabled**   
Whether the field can be used to sort the search results.  
Type: Boolean  
 Required: No 

 **SourceField**   
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 \$1 (underscore). Dynamic field names must begin or end with a wildcard (\$1). 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`.   
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

# Limits
<a name="API_Limits"></a>

## Description
<a name="API_Limits_Description"></a>

No action documentation available.

## Contents
<a name="API_Limits_Contents"></a>

 **MaximumPartitionCount**   
Type: Integer  
 Required: Yes 

 **MaximumReplicationCount**   
Type: Integer  
 Required: Yes 

# ListDomainNamesResult
<a name="API_ListDomainNamesResult"></a>

## Description
<a name="API_ListDomainNamesResult_Description"></a>

The result of a `ListDomainNames` request. Contains a list of the domains owned by an account.

## Contents
<a name="API_ListDomainNamesResult_Contents"></a>

 **DomainNames**   
The names of the search domains owned by an account.  
Type: String to String map   
 Required: No 

# LiteralArrayOptions
<a name="API_LiteralArrayOptions"></a>

## Description
<a name="API_LiteralArrayOptions_Description"></a>

Options for a field that contains an array of literal strings. Present if `IndexFieldType` specifies the field is of type `literal-array`. All options are enabled by default.

## Contents
<a name="API_LiteralArrayOptions_Contents"></a>

 **DefaultValue**   
 A value to use for the field if the field isn't specified for a document.   
Type: String  
 Length constraints: Minimum length of 0. Maximum length of 1024.   
 Required: No 

 **FacetEnabled**   
Whether facet information can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SearchEnabled**   
Whether the contents of the field are searchable.  
Type: Boolean  
 Required: No 

 **SourceFields**   
A list of source fields to map to the field.   
Type: String  
 Required: No 

# LiteralOptions
<a name="API_LiteralOptions"></a>

## Description
<a name="API_LiteralOptions_Description"></a>

Options for literal field. Present if `IndexFieldType` specifies the field is of type `literal`. All options are enabled by default.

## Contents
<a name="API_LiteralOptions_Contents"></a>

 **DefaultValue**   
 A value to use for the field if the field isn't specified for a document.   
Type: String  
 Length constraints: Minimum length of 0. Maximum length of 1024.   
 Required: No 

 **FacetEnabled**   
Whether facet information can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SearchEnabled**   
Whether the contents of the field are searchable.  
Type: Boolean  
 Required: No 

 **SortEnabled**   
Whether the field can be used to sort the search results.  
Type: Boolean  
 Required: No 

 **SourceField**   
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 \$1 (underscore). Dynamic field names must begin or end with a wildcard (\$1). 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`.   
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

# OptionStatus
<a name="API_OptionStatus"></a>

## Description
<a name="API_OptionStatus_Description"></a>

The status of domain configuration option.

## Contents
<a name="API_OptionStatus_Contents"></a>

 **CreationDate**   
A timestamp for when this option was created.  
Type: DateTime  
 Required: Yes 

 **PendingDeletion**   
Indicates that the option will be deleted once processing is complete.  
Type: Boolean  
 Required: No 

 **State**   
The state of processing a change to an option. Possible values:  
+ `RequiresIndexDocuments`: the option's latest value will not be deployed until [IndexDocuments](API_IndexDocuments.md) 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.
Type: String  
 Valid Values: `RequiresIndexDocuments | Processing | Active | FailedToValidate`   
 Required: Yes 

 **UpdateDate**   
A timestamp for when this option was last updated.  
Type: DateTime  
 Required: Yes 

 **UpdateVersion**   
A unique integer that indicates when this option was last updated.  
Type: Integer  
 Required: No 

# ScalingParameters
<a name="API_ScalingParameters"></a>

## Description
<a name="API_ScalingParameters_Description"></a>

The desired instance type and desired number of replicas of each index partition.

## Contents
<a name="API_ScalingParameters_Contents"></a>

 **DesiredInstanceType**   
The instance type that you want to preconfigure for your domain. For example, `search.medium`.  
Type: String  
Valid Values: `search.small | search.medium | search.large | search.xlarge | search.2xlarge`   
For older domains, valid values might also include `search.m1.small`, `search.m1.large`, `search.m2.xlarge`, `search.m2.2xlarge`, `search.m3.medium`, `search.m3.large`, `search.m3.xlarge`, and `search.m3.2xlarge`.
Required: No 

 **DesiredPartitionCount**   
The number of partitions you want to preconfigure for your domain. Only valid when you select `search.2xlarge` as the instance type.  
Type: Integer  
Required: No 

 **DesiredReplicationCount**   
The number of replicas you want to preconfigure for each index partition.  
Type: Integer  
Required: No 

# ScalingParametersStatus
<a name="API_ScalingParametersStatus"></a>

## Description
<a name="API_ScalingParametersStatus_Description"></a>

The status and configuration of a search domain's scaling parameters. 

## Contents
<a name="API_ScalingParametersStatus_Contents"></a>

 **Options**   
The desired instance type and desired number of replicas of each index partition.  
Type: [ScalingParameters](API_ScalingParameters.md)   
 Required: Yes 

 **Status**   
The status of domain configuration option.  
Type: [OptionStatus](API_OptionStatus.md)   
 Required: Yes 

# ServiceEndpoint
<a name="API_ServiceEndpoint"></a>

## Description
<a name="API_ServiceEndpoint_Description"></a>

The endpoint to which service requests can be submitted.

## Contents
<a name="API_ServiceEndpoint_Contents"></a>

 **Endpoint**   
The endpoint to which service requests can be submitted. For example, `search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com` or `doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com`.  
Type: String  
 Required: No 

# Suggester
<a name="API_Suggester"></a>

## Description
<a name="API_Suggester_Description"></a>

Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: `FuzzyMatching`, `SortExpression`. 

## Contents
<a name="API_Suggester_Contents"></a>

 **DocumentSuggesterOptions**   
Options for a search suggester.  
Type: [DocumentSuggesterOptions](API_DocumentSuggesterOptions.md)   
 Required: Yes 

 **SuggesterName**   
Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and \$1 (underscore).  
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: Yes 

# SuggesterStatus
<a name="API_SuggesterStatus"></a>

## Description
<a name="API_SuggesterStatus_Description"></a>

The value of a `Suggester` and its current status.

## Contents
<a name="API_SuggesterStatus_Contents"></a>

 **Options**   
Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: `FuzzyMatching`, `SortExpression`.   
Type: [Suggester](API_Suggester.md)   
 Required: Yes 

 **Status**   
The status of domain configuration option.  
Type: [OptionStatus](API_OptionStatus.md)   
 Required: Yes 

# TextArrayOptions
<a name="API_TextArrayOptions"></a>

## Description
<a name="API_TextArrayOptions_Description"></a>

Options for a field that contains an array of text strings. Present if `IndexFieldType` specifies the field is of type `text-array`. A `text-array` field is always searchable. All options are enabled by default.

## Contents
<a name="API_TextArrayOptions_Contents"></a>

 **AnalysisScheme**   
The name of an analysis scheme for a `text-array` field.  
Type: String  
 Required: No 

 **DefaultValue**   
 A value to use for the field if the field isn't specified for a document.   
Type: String  
 Length constraints: Minimum length of 0. Maximum length of 1024.   
 Required: No 

 **HighlightEnabled**   
Whether highlights can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SourceFields**   
A list of source fields to map to the field.   
Type: String  
 Required: No 

# TextOptions
<a name="API_TextOptions"></a>

## Description
<a name="API_TextOptions_Description"></a>

Options for text field. Present if `IndexFieldType` specifies the field is of type `text`. A `text` field is always searchable. All options are enabled by default.

## Contents
<a name="API_TextOptions_Contents"></a>

 **AnalysisScheme**   
The name of an analysis scheme for a `text` field.  
Type: String  
 Required: No 

 **DefaultValue**   
 A value to use for the field if the field isn't specified for a document.   
Type: String  
 Length constraints: Minimum length of 0. Maximum length of 1024.   
 Required: No 

 **HighlightEnabled**   
Whether highlights can be returned for the field.  
Type: Boolean  
 Required: No 

 **ReturnEnabled**   
Whether the contents of the field can be returned in the search results.  
Type: Boolean  
 Required: No 

 **SortEnabled**   
Whether the field can be used to sort the search results.  
Type: Boolean  
 Required: No 

 **SourceField**   
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 \$1 (underscore). Dynamic field names must begin or end with a wildcard (\$1). 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`.   
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

# UpdateAvailabilityOptionsResult
<a name="API_UpdateAvailabilityOptionsResult"></a>

## Description
<a name="API_UpdateAvailabilityOptionsResult_Description"></a>

The result of a `UpdateAvailabilityOptions` request. Contains the status of the domain's availability options. 

## Contents
<a name="API_UpdateAvailabilityOptionsResult_Contents"></a>

 **AvailabilityOptions**   
The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.   
Type: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md)   
 Required: No 

# UpdateScalingParametersResult
<a name="API_UpdateScalingParametersResult"></a>

## Description
<a name="API_UpdateScalingParametersResult_Description"></a>

The result of a `UpdateScalingParameters` request. Contains the status of the newly-configured scaling parameters.

## Contents
<a name="API_UpdateScalingParametersResult_Contents"></a>

 **ScalingParameters**   
The status and configuration of a search domain's scaling parameters.   
Type: [ScalingParametersStatus](API_ScalingParametersStatus.md)   
 Required: Yes 

# UpdateServiceAccessPoliciesResult
<a name="API_UpdateServiceAccessPoliciesResult"></a>

## Description
<a name="API_UpdateServiceAccessPoliciesResult_Description"></a>

The result of an `UpdateServiceAccessPolicies` request. Contains the new access policies.

## Contents
<a name="API_UpdateServiceAccessPoliciesResult_Contents"></a>

 **AccessPolicies**   
The access rules configured for the domain.  
Type: [AccessPoliciesStatus](API_AccessPoliciesStatus.md)   
 Required: Yes