# 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