# Configuration API Reference for Amazon CloudSearch
<a name="configuration-api"></a>

You use the Amazon CloudSearch Configuration API to create, configure, and manage search domains. For more information configuring search domains, see [Creating and Managing Search Domains](creating-managing-domains.md).

 The other APIs you use to interact with Amazon CloudSearch are: 
+ [Document Service API Reference](document-service-api.md)—Submit the data you want to search.
+ [Search API Reference](search-api.md)—Search your domain.

**Topics**
+ [Submitting Configuration Requests in Amazon CloudSearch](submitting-configuration-requests.md)
+ [Actions](API_Operations.md)
+ [Data Types](API_Types.md)
+ [Common Parameters](CommonParameters.md)
+ [Common Errors](CommonErrors.md)

# Submitting Configuration Requests in Amazon CloudSearch
<a name="submitting-configuration-requests"></a>

**Important**  
The easiest way to submit configuration requests is to use the Amazon CloudSearch console, Amazon CloudSearch command line tools, or the AWS SDK for Java, JavaScript, .NET, PHP, Ruby, or Python (Boto). The command line tools and SDKs handle the signing process for you and ensure that Amazon CloudSearch configuration requests are properly formed. For more information about the AWS SDKs, see [AWS Software Development Kits](http://aws.amazon.com/code). 

 You submit Amazon CloudSearch configuration requests to the Amazon CloudSearch endpoint for your region using the AWS Query protocol. For the current list of supported regions and endpoints, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region).

 AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a Query parameter named Action. You must specify the API version in all configuration requests and that version must match the API version specified when the domain was created.

You must include authorization parameters and a digital signature in every request. Amazon CloudSearch supports AWS Signature Version 4. For detailed signing instructions, see [Signature V4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the AWS General Reference.

**Note**  
Amazon CloudSearch throttles excessive requests to the configuration service. Throttling occurs *by action*, so excessive `DescribeDomains` requests don't cause Amazon CloudSearch to throttle `DescribeIndexFields` requests. The request limit changes based on the needs of the service, but allows many calls to each action per hour.

## Structure of a Configuration Request
<a name="submitting-configuration-requests-structure"></a>

This reference shows Amazon CloudSearch configuration requests as URLs, which can be used directly in a browser. (Although the GET requests are shown as URLs, the parameter values are shown unencoded to make them easier to read. Keep in mind that you must URL encode parameter values when submitting requests.) The URL contains three parts:
+ Endpoint—the Web service entry point to act on, `cloudsearch.us-east-1.amazonaws.com`. 
+ Action—the Amazon CloudSearch configuration action you want to perform. For a complete list of actions, see [Actions](API_Operations.md). 
+ Parameters—any request parameters required for the specified action. Each query request must also include some common parameters to handle authentication. For more information, see [Request Authentication](#configuration-request-authentication).

You must specify the `Version` parameter in every Amazon CloudSearch configuration request. The current Amazon CloudSearch API version is 2013-01-01.

For example, the following GET request creates a new search domain called *movies*:

```
https://cloudsearch.us-east-1.amazonaws.com
?Action=CreateDomain
&DomainName=movies
&Version=2013-01-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20120712/us-east-1/cloudsearch/aws4
_request
&X-Amz-Date=2012-07-12T21:41:29.094Z
&X-Amz-SignedHeaders=host
&X-Amz-Signature=c7600a00fea082dac002b247f9d6812f25195fbaf7f0a6fc4ce08a39666c6a10
3c8dcb
```

## Request Authentication
<a name="configuration-request-authentication"></a>

Requests submitted to the Configuration API are authenticated using your AWS access keys. You must include authorization parameters and a digital signature in every request. Amazon CloudSearch supports AWS Signature Version 4. For detailed signing instructions, see [Signature V4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the AWS General Reference.

**Note**  
If you are just getting started signing your own AWS requests, take a look at how the SDKs implement signing. The source for most of the AWS SDKs is available at [https://github.com/aws](https://github.com/aws).

For example, to construct a `CreateDomain` request, you need the following information:

```
Region name: us-east-1
Service name: cloudsearch
API version: 2013-01-01
Date: 2014-03-12T21:41:29.094Z
Access key: AKIAIOSFODNN7EXAMPLE
Secret key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Action: CreateDomain
Action Parameters: DomainName=movies
```

The canonical query string for a `CreateDomain` request looks like this: 

```
Action=CreateDomain
&DomainName=movies
&Version=2013-01-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20120712/us-east-1/cloudsearch/aws4
_request
&X-Amz-Date=2012-07-12T21:41:29.094Z
&X-Amz-SignedHeaders=host
```

The final signed request looks like this: 

```
https://cloudsearch.us-east-1.amazonaws.com
?Action=CreateDomain
&DomainName=movies
&Version=2013-01-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20120712/us-east-1/cloudsearch/aws4
_request
&X-Amz-Date=2014-03-12T21:41:29.094Z
&X-Amz-SignedHeaders=host
&X-Amz-Signature=c7600a00fea082dac002b247f9d6812f25195fbaf7f0a6fc4ce08a39666c6a10
```

# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [BuildSuggesters](API_BuildSuggesters.md) 
+  [CreateDomain](API_CreateDomain.md) 
+  [DefineAnalysisScheme](API_DefineAnalysisScheme.md) 
+  [DefineExpression](API_DefineExpression.md) 
+  [DefineIndexField](API_DefineIndexField.md) 
+  [DefineSuggester](API_DefineSuggester.md) 
+  [DeleteAnalysisScheme](API_DeleteAnalysisScheme.md) 
+  [DeleteDomain](API_DeleteDomain.md) 
+  [DeleteExpression](API_DeleteExpression.md) 
+  [DeleteIndexField](API_DeleteIndexField.md) 
+  [DeleteSuggester](API_DeleteSuggester.md) 
+  [DescribeAnalysisSchemes](API_DescribeAnalysisSchemes.md) 
+  [DescribeAvailabilityOptions](API_DescribeAvailabilityOptions.md) 
+  [DescribeDomains](API_DescribeDomains.md) 
+  [DescribeExpressions](API_DescribeExpressions.md) 
+  [DescribeIndexFields](API_DescribeIndexFields.md) 
+  [DescribeScalingParameters](API_DescribeScalingParameters.md) 
+  [DescribeServiceAccessPolicies](API_DescribeServiceAccessPolicies.md) 
+  [DescribeSuggesters](API_DescribeSuggesters.md) 
+  [IndexDocuments](API_IndexDocuments.md) 
+  [ListDomainNames](API_ListDomainNames.md) 
+  [UpdateAvailabilityOptions](API_UpdateAvailabilityOptions.md) 
+  [UpdateScalingParameters](API_UpdateScalingParameters.md) 
+  [UpdateServiceAccessPolicies](API_UpdateServiceAccessPolicies.md) 

# BuildSuggesters
<a name="API_BuildSuggesters"></a>

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

Indexes the search suggestions. For more information, see [Configuring Suggesters](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_BuildSuggesters_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

## Response Elements
<a name="API_BuildSuggesters_ResponseElements"></a>

 The following element is returned in a structure named `BuildSuggestersResult`. 

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

## Errors
<a name="API_BuildSuggesters_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# CreateDomain
<a name="API_CreateDomain"></a>

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

Creates a new search domain. For more information, see [Creating a Search Domain](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_CreateDomain_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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.  
Type: String  
 Length constraints: Minimum length of 3. Maximum length of 28.   
 Required: Yes 

## Response Elements
<a name="API_CreateDomain_ResponseElements"></a>

 The following element is returned in a structure named `CreateDomainResult`. 

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

## Errors
<a name="API_CreateDomain_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **LimitExceeded**   
The request was rejected because a resource limit has already been met.  
 HTTP Status Code: 409

# DefineAnalysisScheme
<a name="API_DefineAnalysisScheme"></a>

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

Configures an analysis scheme that can be applied to a `text` or `text-array` field to define language-specific text processing options. For more information, see [Configuring Analysis Schemes](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DefineAnalysisScheme_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **AnalysisScheme**   
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 

 **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 

## Response Elements
<a name="API_DefineAnalysisScheme_ResponseElements"></a>

 The following element is returned in a structure named `DefineAnalysisSchemeResult`. 

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

## Errors
<a name="API_DefineAnalysisScheme_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **LimitExceeded**   
The request was rejected because a resource limit has already been met.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DefineExpression
<a name="API_DefineExpression"></a>

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

Configures an ` Expression ` for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see [Configuring Expressions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DefineExpression_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

 **Expression**   
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.   
Type: [Expression](API_Expression.md)   
 Required: Yes 

## Response Elements
<a name="API_DefineExpression_ResponseElements"></a>

 The following element is returned in a structure named `DefineExpressionResult`. 

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

## Errors
<a name="API_DefineExpression_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **LimitExceeded**   
The request was rejected because a resource limit has already been met.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DefineIndexField
<a name="API_DefineIndexField"></a>

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

Configures an ` IndexField ` for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the ` IndexFieldType `. If the field exists, the new configuration replaces the old one. For more information, see [Configuring Index Fields](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) in the *Amazon CloudSearch Developer Guide*. 

## Request Parameters
<a name="API_DefineIndexField_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

 **IndexField**   
The index field and field options you want to configure.   
Type: [IndexField](API_IndexField.md)   
 Required: Yes 

## Response Elements
<a name="API_DefineIndexField_ResponseElements"></a>

 The following element is returned in a structure named `DefineIndexFieldResult`. 

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

## Errors
<a name="API_DefineIndexField_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **LimitExceeded**   
The request was rejected because a resource limit has already been met.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DefineSuggester
<a name="API_DefineSuggester"></a>

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

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see [Getting Search Suggestions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DefineSuggester_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

 **Suggester**   
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 

## Response Elements
<a name="API_DefineSuggester_ResponseElements"></a>

 The following element is returned in a structure named `DefineSuggesterResult`. 

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

## Errors
<a name="API_DefineSuggester_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **LimitExceeded**   
The request was rejected because a resource limit has already been met.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DeleteAnalysisScheme
<a name="API_DeleteAnalysisScheme"></a>

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

Deletes an analysis scheme. For more information, see [Configuring Analysis Schemes](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the *Amazon CloudSearch Developer Guide*. 

## Request Parameters
<a name="API_DeleteAnalysisScheme_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **AnalysisSchemeName**   
The name of the analysis scheme you want to delete.  
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 

## Response Elements
<a name="API_DeleteAnalysisScheme_ResponseElements"></a>

 The following element is returned in a structure named `DeleteAnalysisSchemeResult`. 

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

## Errors
<a name="API_DeleteAnalysisScheme_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DeleteDomain
<a name="API_DeleteDomain"></a>

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

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see [Deleting a Search Domain](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html) in the *Amazon CloudSearch Developer Guide*. 

## Request Parameters
<a name="API_DeleteDomain_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **DomainName**   
The name of the domain you want to permanently delete.  
Type: String  
 Length constraints: Minimum length of 3. Maximum length of 28.   
 Required: Yes 

## Response Elements
<a name="API_DeleteDomain_ResponseElements"></a>

 The following element is returned in a structure named `DeleteDomainResult`. 

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

## Errors
<a name="API_DeleteDomain_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

# DeleteExpression
<a name="API_DeleteExpression"></a>

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

Removes an ` Expression ` from the search domain. For more information, see [Configuring Expressions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DeleteExpression_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

 **ExpressionName**   
The name of the ` Expression ` to delete.  
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: Yes 

## Response Elements
<a name="API_DeleteExpression_ResponseElements"></a>

 The following element is returned in a structure named `DeleteExpressionResult`. 

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

## Errors
<a name="API_DeleteExpression_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DeleteIndexField
<a name="API_DeleteIndexField"></a>

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

Removes an ` IndexField ` from the search domain. For more information, see [Configuring Index Fields](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DeleteIndexField_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

 **IndexFieldName**   
The name of the index field your want to remove from the domain's indexing options.  
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: Yes 

## Response Elements
<a name="API_DeleteIndexField_ResponseElements"></a>

 The following element is returned in a structure named `DeleteIndexFieldResult`. 

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

## Errors
<a name="API_DeleteIndexField_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DeleteSuggester
<a name="API_DeleteSuggester"></a>

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

Deletes a suggester. For more information, see [Getting Search Suggestions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DeleteSuggester_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

 **SuggesterName**   
Specifies the name of the suggester you want to delete.  
Type: String  
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: Yes 

## Response Elements
<a name="API_DeleteSuggester_ResponseElements"></a>

 The following element is returned in a structure named `DeleteSuggesterResult`. 

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

## Errors
<a name="API_DeleteSuggester_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DescribeAnalysisSchemes
<a name="API_DescribeAnalysisSchemes"></a>

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

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a `text` field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see [Configuring Analysis Schemes](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DescribeAnalysisSchemes_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **AnalysisSchemeNames.member.N**   
The analysis schemes you want to describe.  
Type: String list   
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

 **Deployed**   
Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`.  
Type: Boolean  
 Required: No 

 **DomainName**   
The name of the domain you want to describe.  
Type: String  
 Length constraints: Minimum length of 3. Maximum length of 28.   
 Required: Yes 

## Response Elements
<a name="API_DescribeAnalysisSchemes_ResponseElements"></a>

 The following element is returned in a structure named `DescribeAnalysisSchemesResult`. 

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

## Errors
<a name="API_DescribeAnalysisSchemes_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DescribeAvailabilityOptions
<a name="API_DescribeAvailabilityOptions"></a>

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

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see [Configuring Availability Options](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DescribeAvailabilityOptions_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **Deployed**   
Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`.  
Type: Boolean  
 Required: No 

 **DomainName**   
The name of the domain you want to describe.  
Type: String  
 Length constraints: Minimum length of 3. Maximum length of 28.   
 Required: Yes 

## Response Elements
<a name="API_DescribeAvailabilityOptions_ResponseElements"></a>

 The following element is returned in a structure named `DescribeAvailabilityOptionsResult`. 

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

## Errors
<a name="API_DescribeAvailabilityOptions_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **DisabledOperation**   
The request was rejected because it attempted an operation which is not enabled.  
 HTTP Status Code: 409

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **LimitExceeded**   
The request was rejected because a resource limit has already been met.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DescribeDomains
<a name="API_DescribeDomains"></a>

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

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a `matchall` request to your domain's search endpoint: `q=matchall&q.parser=structured&size=0`. For more information, see [Getting Information about a Search Domain](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DescribeDomains_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **DomainNames.member.N**   
The names of the domains you want to include in the response.  
Type: String list   
 Length constraints: Minimum length of 3. Maximum length of 28.   
 Required: No 

## Response Elements
<a name="API_DescribeDomains_ResponseElements"></a>

 The following element is returned in a structure named `DescribeDomainsResult`. 

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

## Errors
<a name="API_DescribeDomains_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

# DescribeExpressions
<a name="API_DescribeExpressions"></a>

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

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see [Configuring Expressions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DescribeExpressions_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **Deployed**   
Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`.  
Type: Boolean  
 Required: No 

 **DomainName**   
The name of the domain you want to describe.  
Type: String  
 Length constraints: Minimum length of 3. Maximum length of 28.   
 Required: Yes 

 **ExpressionNames.member.N**   
Limits the ` DescribeExpressions ` response to the specified expressions. If not specified, all expressions are shown.  
Type: String list   
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

## Response Elements
<a name="API_DescribeExpressions_ResponseElements"></a>

 The following element is returned in a structure named `DescribeExpressionsResult`. 

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

## Errors
<a name="API_DescribeExpressions_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DescribeIndexFields
<a name="API_DescribeIndexFields"></a>

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

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see [Getting Domain Information](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DescribeIndexFields_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **Deployed**   
Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`.  
Type: Boolean  
 Required: No 

 **DomainName**   
The name of the domain you want to describe.  
Type: String  
 Length constraints: Minimum length of 3. Maximum length of 28.   
 Required: Yes 

 **FieldNames.member.N**   
A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.  
Type: String list   
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

## Response Elements
<a name="API_DescribeIndexFields_ResponseElements"></a>

 The following element is returned in a structure named `DescribeIndexFieldsResult`. 

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

## Errors
<a name="API_DescribeIndexFields_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DescribeScalingParameters
<a name="API_DescribeScalingParameters"></a>

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

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see [Configuring Scaling Options](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DescribeScalingParameters_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

## Response Elements
<a name="API_DescribeScalingParameters_ResponseElements"></a>

 The following element is returned in a structure named `DescribeScalingParametersResult`. 

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

## Errors
<a name="API_DescribeScalingParameters_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DescribeDomainEndpointOptions
<a name="API_DescribeDomainEndpointOptions"></a>

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

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see [Configuring Domain Endpoint Options](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DescribeDomainEndpointOptions_RequestParameters"></a>

For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md).

**DomainName**  
A string that represents the name of a domain.  
Type: String  
Required: Yes

**deployed**  
Whether to retrieve the latest configuration (which might be in a `Processing` state) or the current, active configuration (`?deployed=true`).  
Type: Boolean  
Required: No

## Response Elements
<a name="API_DescribeDomainEndpointOptions_ResponseElements"></a>

**DomainEndpointOptions**  
The status and configuration of a search domain's endpoint options.  
Type: [DomainEndpointOptionsStatus](API_DomainEndpointOptionsStatus.md) 

## Errors
<a name="API_DescribeDomainEndpointOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

**Base**  
An error occurred while processing the request.  
HTTP Status Code: 400

**Internal**  
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
HTTP Status Code: 500

**LimitExceeded**  
The request was rejected because a resource limit has already been met.  
HTTP Status Code: 409

**ResourceNotFound**  
The request was rejected because it attempted to reference a resource that does not exist.  
HTTP Status Code: 409

# DescribeServiceAccessPolicies
<a name="API_DescribeServiceAccessPolicies"></a>

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

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. 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*.

## Request Parameters
<a name="API_DescribeServiceAccessPolicies_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **Deployed**   
Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`.  
Type: Boolean  
 Required: No 

 **DomainName**   
The name of the domain you want to describe.  
Type: String  
 Length constraints: Minimum length of 3. Maximum length of 28.   
 Required: Yes 

## Response Elements
<a name="API_DescribeServiceAccessPolicies_ResponseElements"></a>

 The following element is returned in a structure named `DescribeServiceAccessPoliciesResult`. 

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

## Errors
<a name="API_DescribeServiceAccessPolicies_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# DescribeSuggesters
<a name="API_DescribeSuggesters"></a>

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

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the `Deployed` option to `true` to show the active configuration and exclude pending changes. For more information, see [Getting Search Suggestions](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_DescribeSuggesters_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **Deployed**   
Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`.  
Type: Boolean  
 Required: No 

 **DomainName**   
The name of the domain you want to describe.  
Type: String  
 Length constraints: Minimum length of 3. Maximum length of 28.   
 Required: Yes 

 **SuggesterNames.member.N**   
The suggesters you want to describe.  
Type: String list   
 Length constraints: Minimum length of 1. Maximum length of 64.   
 Required: No 

## Response Elements
<a name="API_DescribeSuggesters_ResponseElements"></a>

 The following element is returned in a structure named `DescribeSuggestersResult`. 

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

## Errors
<a name="API_DescribeSuggesters_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# IndexDocuments
<a name="API_IndexDocuments"></a>

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

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose [OptionStatus](API_OptionStatus.md) is `RequiresIndexDocuments`.

## Request Parameters
<a name="API_IndexDocuments_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

## Response Elements
<a name="API_IndexDocuments_ResponseElements"></a>

 The following element is returned in a structure named `IndexDocumentsResult`. 

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

## Errors
<a name="API_IndexDocuments_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# ListDomainNames
<a name="API_ListDomainNames"></a>

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

Lists all search domains owned by an account.

## Response Elements
<a name="API_ListDomainNames_ResponseElements"></a>

 The following element is returned in a structure named `ListDomainNamesResult`. 

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

## Errors
<a name="API_ListDomainNames_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

# UpdateAvailabilityOptions
<a name="API_UpdateAvailabilityOptions"></a>

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

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see [Configuring Availability Options](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_UpdateAvailabilityOptions_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

 **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`.   
Type: Boolean  
 Required: Yes 

## Response Elements
<a name="API_UpdateAvailabilityOptions_ResponseElements"></a>

 The following element is returned in a structure named `UpdateAvailabilityOptionsResult`. 

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

## Errors
<a name="API_UpdateAvailabilityOptions_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **DisabledOperation**   
The request was rejected because it attempted an operation which is not enabled.  
 HTTP Status Code: 409

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **LimitExceeded**   
The request was rejected because a resource limit has already been met.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# UpdateScalingParameters
<a name="API_UpdateScalingParameters"></a>

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

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see [Configuring Scaling Options](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html) in the *Amazon CloudSearch Developer Guide*. 

## Request Parameters
<a name="API_UpdateScalingParameters_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **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 

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

## Response Elements
<a name="API_UpdateScalingParameters_ResponseElements"></a>

 The following element is returned in a structure named `UpdateScalingParametersResult`. 

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

## Errors
<a name="API_UpdateScalingParameters_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **LimitExceeded**   
The request was rejected because a resource limit has already been met.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# UpdateDomainEndpointOptions
<a name="API_UpdateDomainEndpointOptions"></a>

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

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see [Configuring Domain Endpoint Options](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html) in the *Amazon CloudSearch Developer Guide*.

## Request Parameters
<a name="API_UpdateDomainEndpointOptions_RequestParameters"></a>

**DomainName**  
A string that represents the name of a domain.  
Type: String  
Required: Yes 

**DomainEndpointOptions**  
Container for the endpoint options.  
Type: [DomainEndpointOptions](API_DomainEndpointOptions.md)   
Required: Yes

## Response Elements
<a name="API_UpdateDomainEndpointOptions_ResponseElements"></a>

**DomainEndpointOptionsStatus**  
The status and configuration of a domain's endpoint options.  
Type: [DomainEndpointOptionsStatus](API_DomainEndpointOptionsStatus.md) 

## Errors
<a name="API_UpdateDomainEndpointOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

**Base**  
An error occurred while processing the request.  
HTTP Status Code: 400

**Internal**  
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
HTTP Status Code: 500

InvalidType  
The request was rejected because it specified an invalid type definition.  
HTTP Status Code: 409

**LimitExceeded**  
The request was rejected because a resource limit has already been met.  
HTTP Status Code: 409

**ResourceNotFound**  
The request was rejected because it attempted to reference a resource that does not exist.  
HTTP Status Code: 409

**ValidationException**  
The request contains invalid input or is missing required input.  
HTTP status code 400.

 **DisabledOperation**   
The request was rejected because it attempted an operation which is not enabled.  
HTTP Status Code: 409

# UpdateServiceAccessPolicies
<a name="API_UpdateServiceAccessPolicies"></a>

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

Configures the access rules that control access to the domain's document and search endpoints. For more information, see [ Configuring Access for an Amazon CloudSearch Domain](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html).

## Request Parameters
<a name="API_UpdateServiceAccessPolicies_RequestParameters"></a>

 For information about the common parameters that all actions use, see [Common Parameters](CommonParameters.md). 

 **AccessPolicies**   
The access rules you want to configure. These rules replace any existing rules.   
Type: String  
 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 

## Response Elements
<a name="API_UpdateServiceAccessPolicies_ResponseElements"></a>

 The following element is returned in a structure named `UpdateServiceAccessPoliciesResult`. 

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

## Errors
<a name="API_UpdateServiceAccessPolicies_Errors"></a>

 For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md). 

 **Base**   
An error occurred while processing the request.  
 HTTP Status Code: 400

 **Internal**   
An internal error occurred while processing the request. If this problem persists, report an issue from the [Service Health Dashboard](http://status.aws.amazon.com/).  
 HTTP Status Code: 500

 **InvalidType**   
The request was rejected because it specified an invalid type definition.  
 HTTP Status Code: 409

 **LimitExceeded**   
The request was rejected because a resource limit has already been met.  
 HTTP Status Code: 409

 **ResourceNotFound**   
The request was rejected because it attempted to reference a resource that does not exist.  
 HTTP Status Code: 409

# 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 

# Common Parameters
<a name="CommonParameters"></a>

This section lists the request parameters that all actions use. Any action-specific parameters are listed in the topic for the action.

 **Action**   
The action to be performed.  
Default: None  
Type: string  
 Required: Yes 

 **AuthParams**   
The parameters that are required to authenticate a Conditional request. Contains:  
+ AWSAccessKeyID
+ SignatureVersion
+ Timestamp
+ Signature
Default: None  
 Required: Conditional 

 **AWSAccessKeyId**   
The access key ID that corresponds to the secret access key that you used to sign the request.  
Default: None  
Type: string  
 Required: Yes 

 **Expires**   
The date and time when the request signature expires, expressed in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard.  
Condition: Requests must include either *Timestamp* or *Expires*, but not both.  
Default: None  
Type: string  
 Required: Conditional 

 **SecurityToken**   
The temporary security token that was obtained through a call to AWS Security Token Service. For a list of services that support AWS Security Token Service, go to [Using Temporary Security Credentials to Access AWS](http://docs.aws.amazon.com/IAM/latest/UsingSTS/UsingTokens.html) in **Using Temporary Security Credentials**.  
Default: None  
Type: string  
 Required: No 

 **Signature**   
The digital signature that you created for the request. For information about generating a signature, go to the service's developer documentation.  
Default: None  
Type: string  
 Required: Yes 

 **SignatureMethod**   
The hash algorithm that you used to create the request signature.  
Default: None  
Type: string  
 Valid Values: `HmacSHA256 | HmacSHA1`   
 Required: Yes 

 **SignatureVersion**   
The signature version you use to sign the request. Set this to the value that is recommended for your service.  
Default: None  
Type: string  
 Required: Yes 

 **Timestamp**   
The date and time when the request was signed, expressed in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard.  
Condition: Requests must include either *Timestamp* or *Expires*, but not both.  
Default: None  
Type: string  
 Required: Conditional 

 **Version**   
The API version that the request is written for, expressed in the format YYYY-MM-DD.  
Default: None  
Type: string  
 Required: Yes 

# Common Errors
<a name="CommonErrors"></a>

This section lists the common errors that all actions return. Any action-specific errors are listed in the topic for the action.

 **IncompleteSignature**   
The request signature does not conform to AWS standards.  
HTTP Status Code: 400

 **InternalFailure**   
The request processing has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 **InvalidAction**   
The action or operation requested is invalid. Verify that the action is typed correctly.  
HTTP Status Code: 400

 **InvalidClientTokenId**   
The X.509 certificate or AWS access key ID provided does not exist in our records.  
HTTP Status Code: 403

 **InvalidParameterCombination**   
Parameters that must not be used together were used together.  
HTTP Status Code: 400

 **InvalidParameterValue**   
An invalid or out-of-range value was supplied for the input parameter.  
HTTP Status Code: 400

 **InvalidQueryParameter**   
The AWS query string is malformed or does not adhere to AWS standards.  
HTTP Status Code: 400

 **MalformedQueryString**   
The query string contains a syntax error.  
HTTP Status Code: 404

 **MissingAction**   
The request is missing an action or a required parameter.  
HTTP Status Code: 400

 **MissingAuthenticationToken**   
The request must contain either a valid (registered) AWS access key ID or X.509 certificate.  
HTTP Status Code: 403

 **MissingParameter**   
A required parameter for the specified action is not supplied.  
HTTP Status Code: 400

 **OptInRequired**   
The AWS access key ID needs a subscription for the service.  
HTTP Status Code: 403

 **RequestExpired**   
The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.  
HTTP Status Code: 400

 **ServiceUnavailable**   
The request has failed due to a temporary failure of the server.  
HTTP Status Code: 503

 **Throttling**   
The request was denied due to request throttling.  
HTTP Status Code: 400

 **ValidationError**   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400