本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 動作
<a name="API_Operations"></a>

支援以下動作：
+  [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>

## 描述
<a name="API_BuildSuggesters_Description"></a>

對搜尋建議編製索引。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters)》中的*設定建議者*。

## 請求參數
<a name="API_BuildSuggesters_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_BuildSuggesters_ResponseElements"></a>

 名為 `BuildSuggestersResult` 的結構中會傳回以下元素。

 **FieldNames**   
欄位名稱的清單。  
類型：字串清單   
 長度限制：長度下限為 1。長度上限為 64。

## 錯誤
<a name="API_BuildSuggesters_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_CreateDomain_Description"></a>

建立新的搜尋網域。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html)》中的*建立搜尋網域*。

## 請求參數
<a name="API_CreateDomain_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
您所建立網域的名稱。允許的字元為 a-z (小寫字母)、0-9 和連字號 (-)。網域名稱必須以字母或數字開頭，長度至少 3 個字元且不超過 28 個字元。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_CreateDomain_ResponseElements"></a>

 名為 `CreateDomainResult` 的結構中會傳回以下元素。

 **DomainStatus**   
搜尋網域目前的狀態。  
類型：[DomainStatus](API_DomainStatus.md)

## 錯誤
<a name="API_CreateDomain_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **LimitExceeded**   
請求已達到資源限制，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DefineAnalysisScheme_Description"></a>

設定可套用到 `text` 或 `text-array` 欄位的分析方案，來定義語言特定的文字處理選項。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html)》中的*設定分析方案*。

## 請求參數
<a name="API_DefineAnalysisScheme_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **AnalysisScheme**   
分析方案的組態資訊。每個分析方案都具有獨一無二的名稱，並指定其所處理文字的語言。針對分析方案可設定以下選項：`Synonyms`、`Stopwords`、`StemmingDictionary`、`JapaneseTokenizationDictionary` 和 `AlgorithmicStemming`。  
類型：[AnalysisScheme](API_AnalysisScheme.md)  
 必要：是 

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_DefineAnalysisScheme_ResponseElements"></a>

 名為 `DefineAnalysisSchemeResult` 的結構中會傳回以下元素。

 **AnalysisScheme**   
`AnalysisScheme` 的狀態與組態。  
類型：[AnalysisSchemeStatus](API_AnalysisSchemeStatus.md)

## 錯誤
<a name="API_DefineAnalysisScheme_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **LimitExceeded**   
請求已達到資源限制，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DefineExpression_Description"></a>

為搜尋網域設定 ` Expression `。用於建立新的運算式和修改現有的運算式。若有運算式存在，新組態將取代舊組態。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html)》中的*設定運算式*。

## 請求參數
<a name="API_DefineExpression_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **運算式**   
搜尋期間可供評估的具名運算式。可用於對搜尋結果進行排序、定義其他運算式，或由搜尋結果傳回經過計算的資訊。  
類型：[表達式](API_Expression.md)  
 必要：是 

## 回應元素
<a name="API_DefineExpression_ResponseElements"></a>

 名為 `DefineExpressionResult` 的結構中會傳回以下元素。

 **運算式**   
`Expression` 的值及其目前狀態。  
類型：[ExpressionStatus](API_ExpressionStatus.md)

## 錯誤
<a name="API_DefineExpression_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **LimitExceeded**   
請求已達到資源限制，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DefineIndexField_Description"></a>

為搜尋網域設定 ` IndexField `。用於建立新欄位和修改現有的欄位。您必須指定所要設定網域的名稱以及索引欄位組態。索引欄位組態指定了您要為該欄位設定的唯一名稱、索引欄位類型與選項。可供指定的選項視 ` IndexFieldType ` 而定。若該欄位已存在，新組態將取代舊組態。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html)》中的*設定索引欄位*。

## 請求參數
<a name="API_DefineIndexField_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **IndexField**   
您要設定的索引欄位以及欄位選項。  
類型：[IndexField](API_IndexField.md)  
 必要：是 

## 回應元素
<a name="API_DefineIndexField_ResponseElements"></a>

 名為 `DefineIndexFieldResult` 的結構中會傳回以下元素。

 **IndexField**   
`IndexField` 的值及其目前狀態。  
類型：[IndexFieldStatus](API_IndexFieldStatus.md)

## 錯誤
<a name="API_DefineIndexField_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **LimitExceeded**   
請求已達到資源限制，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DefineSuggester_Description"></a>

設定網域的建議者。建議者讓您能在使用者完成其查詢輸入之前顯示可能的相符項目。設定建議者時，您必須為可能相符項目指定您要搜尋的文字欄位名稱，以及建議者的唯一名稱。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html)》中的*取得搜尋建議*。

## 請求參數
<a name="API_DefineSuggester_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **Suggester**   
搜尋建議者的組態資訊。每個建議者都具有獨一無二的名稱，並指定您要用於建議的文字欄位。針對建議者可設定以下選項：`FuzzyMatching`、`SortExpression`。  
類型：[Suggester](API_Suggester.md)  
 必要：是 

## 回應元素
<a name="API_DefineSuggester_ResponseElements"></a>

 名為 `DefineSuggesterResult` 的結構中會傳回以下元素。

 **Suggester**   
`Suggester` 的值及其目前狀態。  
類型：[SuggesterStatus](API_SuggesterStatus.md)

## 錯誤
<a name="API_DefineSuggester_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **LimitExceeded**   
請求已達到資源限制，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DeleteAnalysisScheme_Description"></a>

刪除分析方案。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html)》中的*設定分析方案*。

## 請求參數
<a name="API_DeleteAnalysisScheme_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **AnalysisSchemeName**   
欲刪除的分析方案的名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：是 

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_DeleteAnalysisScheme_ResponseElements"></a>

 名為 `DeleteAnalysisSchemeResult` 的結構中會傳回以下元素。

 **AnalysisScheme**   
所刪除分析方案的狀態。  
類型：[AnalysisSchemeStatus](API_AnalysisSchemeStatus.md)

## 錯誤
<a name="API_DeleteAnalysisScheme_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DeleteDomain_Description"></a>

永久刪除搜尋網域及其所有資料。網域刪除後，便無法復原。如需詳細資訊，請參閱 [Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html)中的*刪除搜尋網域*。

## 請求參數
<a name="API_DeleteDomain_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
您要永久刪除的網域名稱。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_DeleteDomain_ResponseElements"></a>

 名為 `DeleteDomainResult` 的結構中會傳回以下元素。

 **DomainStatus**   
搜尋網域目前的狀態。  
類型：[DomainStatus](API_DomainStatus.md)

## 錯誤
<a name="API_DeleteDomain_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

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

## 描述
<a name="API_DeleteExpression_Description"></a>

從搜尋網域移除 ` Expression `。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html)》中的*設定運算式*。

## 請求參數
<a name="API_DeleteExpression_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **ExpressionName**   
欲刪除的 ` Expression ` 的名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：是 

## 回應元素
<a name="API_DeleteExpression_ResponseElements"></a>

 名為 `DeleteExpressionResult` 的結構中會傳回以下元素。

 **運算式**   
所刪除運算式的狀態。  
類型：[ExpressionStatus](API_ExpressionStatus.md)

## 錯誤
<a name="API_DeleteExpression_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DeleteIndexField_Description"></a>

從搜尋網域移除 ` IndexField `。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html)》中的*設定索引欄位*。

## 請求參數
<a name="API_DeleteIndexField_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **IndexFieldName**   
您希望從網域的索引選項中移除的索引欄位名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：是 

## 回應元素
<a name="API_DeleteIndexField_ResponseElements"></a>

 名為 `DeleteIndexFieldResult` 的結構中會傳回以下元素。

 **IndexField**   
所刪除索引欄位的狀態。  
類型：[IndexFieldStatus](API_IndexFieldStatus.md)

## 錯誤
<a name="API_DeleteIndexField_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DeleteSuggester_Description"></a>

刪除建議者。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html)》中的*取得搜尋建議*。

## 請求參數
<a name="API_DeleteSuggester_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **SuggesterName**   
指定欲刪除的建議者的名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：是 

## 回應元素
<a name="API_DeleteSuggester_ResponseElements"></a>

 名為 `DeleteSuggesterResult` 的結構中會傳回以下元素。

 **Suggester**   
所刪除建議者的狀態。  
類型：[SuggesterStatus](API_SuggesterStatus.md)

## 錯誤
<a name="API_DeleteSuggester_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DescribeAnalysisSchemes_Description"></a>

取得針對網域所設定的分析方案。分析方案定義 `text` 欄位的語言特殊性文字處理選項。可依名稱將其侷限於特定的分析方案。預設會顯示所有分析方案且包括對組態的任何待定變更。將 `Deployed` 選項設為 `true` 以顯示作用中組態並排除待定變更。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html)》中的*設定分析方案*。

## 請求參數
<a name="API_DescribeAnalysisSchemes_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **AnalysisSchemeNames.member.N**   
您要描述的分析方案。  
類型：字串清單   
 長度限制：長度下限為 1。長度上限為 64。  
 必要：否 

 **已部署**   
要顯示已部署的組態 (`true`) 還是包括任何待定變更 (`false`)。預設為 `false`。  
類型：布林值  
 必要：否 

 **DomainName**   
您要描述的該網域的名稱。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_DescribeAnalysisSchemes_ResponseElements"></a>

 名為 `DescribeAnalysisSchemesResult` 的結構中會傳回以下元素。

 **AnalysisSchemes**   
分析方案描述。  
類型：[AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) 清單 

## 錯誤
<a name="API_DescribeAnalysisSchemes_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DescribeAvailabilityOptions_Description"></a>

取得針對網域所設定的可用性選項。預設會顯示具有任何待定變更的組態。將 `Deployed` 選項設為 `true` 以顯示作用中組態並排除待定變更。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html)》中的*設定可用性選項*。

## 請求參數
<a name="API_DescribeAvailabilityOptions_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **已部署**   
要顯示已部署的組態 (`true`) 還是包括任何待定變更 (`false`)。預設為 `false`。  
類型：布林值  
 必要：否 

 **DomainName**   
您要描述的該網域的名稱。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_DescribeAvailabilityOptions_ResponseElements"></a>

 名為 `DescribeAvailabilityOptionsResult` 的結構中會傳回以下元素。

 **AvailabilityOptions**   
針對網域所設定的可用性選項。指出網域是否已啟用異地同步備份。  
類型：[AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md)

## 錯誤
<a name="API_DescribeAvailabilityOptions_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **DisabledOperation**   
請求遭到拒絕，因為它嘗試的操作尚未啟用。  
 HTTP 狀態碼：409

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **LimitExceeded**   
請求已達到資源限制，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DescribeDomains_Description"></a>

取得此帳戶擁有之搜尋網域的相關資訊。可以限制為特定的網域。預設會顯示所有網域。若要取得網域中可搜尋的文件數，請使用主控台或向您網域的搜尋端點提交 `matchall` 請求：`q=matchall&q.parser=structured&size=0`。如需詳細資訊，請參閱 [Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html)中的*取得搜尋網域的相關資訊*。

## 請求參數
<a name="API_DescribeDomains_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainNames.member.N**   
您想包含在回應中的網域名稱。  
類型：字串清單   
 長度限制：長度下限為 3。長度上限為 28。  
 必要：否 

## 回應元素
<a name="API_DescribeDomains_ResponseElements"></a>

 名為 `DescribeDomainsResult` 的結構中會傳回以下元素。

 **DomainStatusList**   
包含每個所請求網域之狀態的清單。  
類型：[DomainStatus](API_DomainStatus.md) 清單 

## 錯誤
<a name="API_DescribeDomains_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

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

## 描述
<a name="API_DescribeExpressions_Description"></a>

取得針對搜尋網域所設定的運算式。可依名稱將其侷限於特定的運算式。預設會顯示所有運算式且包括對組態的任何待定變更。將 `Deployed` 選項設為 `true` 以顯示作用中組態並排除待定變更。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html)》中的*設定運算式*。

## 請求參數
<a name="API_DescribeExpressions_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **已部署**   
要顯示已部署的組態 (`true`) 還是包括任何待定變更 (`false`)。預設為 `false`。  
類型：布林值  
 必要：否 

 **DomainName**   
您要描述的該網域的名稱。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **ExpressionNames.member.N**   
將 ` DescribeExpressions ` 回應侷限於指定的運算式。如果未指定，則會顯示所有運算式。  
類型：字串清單   
 長度限制：長度下限為 1。長度上限為 64。  
 必要：否 

## 回應元素
<a name="API_DescribeExpressions_ResponseElements"></a>

 名為 `DescribeExpressionsResult` 的結構中會傳回以下元素。

 **Expressions**   
針對網域所設定的運算式。  
類型：[ExpressionStatus](API_ExpressionStatus.md) 清單 

## 錯誤
<a name="API_DescribeExpressions_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DescribeIndexFields_Description"></a>

取得針對搜尋網域所設定的索引欄位相關資訊。可依名稱將其侷限於特定的欄位。預設會顯示所有欄位且包括對組態的任何待定變更。將 `Deployed` 選項設為 `true` 以顯示作用中組態並排除待定變更。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html)》中的*取得網域資訊*。

## 請求參數
<a name="API_DescribeIndexFields_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **已部署**   
要顯示已部署的組態 (`true`) 還是包括任何待定變更 (`false`)。預設為 `false`。  
類型：布林值  
 必要：否 

 **DomainName**   
您要描述的該網域的名稱。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **FieldNames.member.N**   
您想要描述的索引欄位的清單。如果未指定，則將傳回所有設定的索引欄位的資訊。  
類型：字串清單   
 長度限制：長度下限為 1。長度上限為 64。  
 必要：否 

## 回應元素
<a name="API_DescribeIndexFields_ResponseElements"></a>

 名為 `DescribeIndexFieldsResult` 的結構中會傳回以下元素。

 **IndexFields**   
針對網域所設定的索引欄位。  
類型：[IndexFieldStatus](API_IndexFieldStatus.md) 清單 

## 錯誤
<a name="API_DescribeIndexFields_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DescribeScalingParameters_Description"></a>

取得針對網域所設定的調整規模參數。網域的調整規模參數指定了所需的搜尋執行個體類型和複寫計數。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html)》中的*設定調整規模選項*。

## 請求參數
<a name="API_DescribeScalingParameters_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_DescribeScalingParameters_ResponseElements"></a>

 名為 `DescribeScalingParametersResult` 的結構中會傳回以下元素。

 **ScalingParameters**   
搜尋網域各個調整規模參數的狀態與組態。  
類型：[ScalingParametersStatus](API_ScalingParametersStatus.md)

## 錯誤
<a name="API_DescribeScalingParameters_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

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

傳回網域的端點選項，特別是所該網域的所有要求是否都必須透過 HTTPS 到達。如需詳細資訊，請參閱《*Amazon CloudSearch 開發人員指南*》中的[設定網域端點選項](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html)。

## 請求參數
<a name="API_DescribeDomainEndpointOptions_RequestParameters"></a>

如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

**DomainName**  
代表網域名稱的字串。  
類型：字串  
必要：是

**已部署**  
是否擷取最新的組態 (可能處於 `Processing` 狀態) 或目前作用中的組態 (`?deployed=true`)。  
類型：布林值  
必要：否

## 回應元素
<a name="API_DescribeDomainEndpointOptions_ResponseElements"></a>

**DomainEndpointOptions**  
搜尋網域端點選項的狀態和組態。  
類型：[DomainEndpointOptionsStatus](API_DomainEndpointOptionsStatus.md)

## 錯誤
<a name="API_DescribeDomainEndpointOptions_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

**Base**  
處理請求時發生錯誤。  
HTTP 狀態碼：400

**內部 (Internal)**  
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
HTTP 狀態碼：500

**LimitExceeded**  
請求已達到資源限制，因而遭到拒絕。  
HTTP 狀態碼：409

**ResourceNotFound**  
請求嘗試參考不存在的資源，因而遭到拒絕。  
HTTP 狀態碼：409

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

## 描述
<a name="API_DescribeServiceAccessPolicies_Description"></a>

取得有關存取政策的資訊，其控制著對網域文件端點和搜尋端點的存取權。預設會顯示具有任何待定變更的組態。將 `Deployed` 選項設為 `true` 以顯示作用中組態並排除待定變更。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html)》中的*設定存取搜尋網域*。

## 請求參數
<a name="API_DescribeServiceAccessPolicies_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **已部署**   
要顯示已部署的組態 (`true`) 還是包括任何待定變更 (`false`)。預設為 `false`。  
類型：布林值  
 必要：否 

 **DomainName**   
您要描述的該網域的名稱。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_DescribeServiceAccessPolicies_ResponseElements"></a>

 名為 `DescribeServiceAccessPoliciesResult` 的結構中會傳回以下元素。

 **AccessPolicies**   
為請求中指定的網域所設定的存取規則。  
類型：[AccessPoliciesStatus](API_AccessPoliciesStatus.md)

## 錯誤
<a name="API_DescribeServiceAccessPolicies_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_DescribeSuggesters_Description"></a>

取得針對網域所設定的建議者。建議者讓您能在使用者完成其查詢輸入之前顯示可能的相符項目。可依名稱將其侷限於特定的建議者。預設會顯示所有建議者且包括對組態的任何待定變更。將 `Deployed` 選項設為 `true` 以顯示作用中組態並排除待定變更。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html)》中的*取得搜尋建議*。

## 請求參數
<a name="API_DescribeSuggesters_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **已部署**   
要顯示已部署的組態 (`true`) 還是包括任何待定變更 (`false`)。預設為 `false`。  
類型：布林值  
 必要：否 

 **DomainName**   
您要描述的該網域的名稱。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **SuggesterNames.member.N**   
您要描述的建議者。  
類型：字串清單   
 長度限制：長度下限為 1。長度上限為 64。  
 必要：否 

## 回應元素
<a name="API_DescribeSuggesters_ResponseElements"></a>

 名為 `DescribeSuggestersResult` 的結構中會傳回以下元素。

 **Suggesters**   
為請求中指定的網域所設定的建議者。  
類型：[SuggesterStatus](API_SuggesterStatus.md) 清單 

## 錯誤
<a name="API_DescribeSuggesters_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_IndexDocuments_Description"></a>

指示搜尋網域使用最新的索引選項，開始對其文件編製索引。必須叫用此操作以啟用 [OptionStatus](API_OptionStatus.md) 為 `RequiresIndexDocuments` 的選項。

## 請求參數
<a name="API_IndexDocuments_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_IndexDocuments_ResponseElements"></a>

 名為 `IndexDocumentsResult` 的結構中會傳回以下元素。

 **FieldNames**   
目前正在編製索引的各個欄位的名稱。  
類型：字串清單   
 長度限制：長度下限為 1。長度上限為 64。

## 錯誤
<a name="API_IndexDocuments_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_ListDomainNames_Description"></a>

列出帳戶擁有的所有搜尋網域。

## 回應元素
<a name="API_ListDomainNames_ResponseElements"></a>

 名為 `ListDomainNamesResult` 的結構中會傳回以下元素。

 **DomainNames**   
帳戶擁有的搜尋網域名稱。  
類型：字串到字串對應 

## 錯誤
<a name="API_ListDomainNames_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

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

## 描述
<a name="API_UpdateAvailabilityOptions_Description"></a>

設定網域的可用性選項。啟用異地同步備份選項可將 Amazon CloudSearch 網域擴展到相同區域內的另一個可用區域，藉此提升容錯能力以因應發生服務中斷的情況。對異地同步備份選項進行變更，可能需要半小時後才能開始使用。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html)》中的*設定可用性選項*。

## 請求參數
<a name="API_UpdateAvailabilityOptions_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **MultiAZ**   
將異地同步備份選項設為 true，可將現有的搜尋網域擴展到第二個可用區域。同樣地，透過將異地同步備份選項設為 `false`，可關閉異地同步備份選項以將網域降級為單一可用區域。  
類型：布林值  
 必要：是 

## 回應元素
<a name="API_UpdateAvailabilityOptions_ResponseElements"></a>

 名為 `UpdateAvailabilityOptionsResult` 的結構中會傳回以下元素。

 **AvailabilityOptions**   
新設定的可用性選項。指出網域是否已啟用異地同步備份。  
類型：[AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md)

## 錯誤
<a name="API_UpdateAvailabilityOptions_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **DisabledOperation**   
請求遭到拒絕，因為它嘗試的操作尚未啟用。  
 HTTP 狀態碼：409

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **LimitExceeded**   
請求已達到資源限制，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

## 描述
<a name="API_UpdateScalingParameters_Description"></a>

為網域設定調整規模參數。網域的調整規模參數指定了所需的搜尋執行個體類型和複寫計數。Amazon CloudSearch 仍將根據資料量和流量自動調整您的網域規模，但絕不會小於所需的執行個體類型和複寫計數。若已啟用異地同步備份選項，這些值將控制每一可用區域所使用的資源。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html)》中的*設定調整規模選項*。

## 請求參數
<a name="API_UpdateScalingParameters_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

 **ScalingParameters**   
每個索引分割區所需的執行個體類型和所需的複本數。  
類型：[ScalingParameters](API_ScalingParameters.md)  
 必要：是 

## 回應元素
<a name="API_UpdateScalingParameters_ResponseElements"></a>

 名為 `UpdateScalingParametersResult` 的結構中會傳回以下元素。

 **ScalingParameters**   
搜尋網域各個調整規模參數的狀態與組態。  
類型：[ScalingParametersStatus](API_ScalingParametersStatus.md)

## 錯誤
<a name="API_UpdateScalingParameters_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **LimitExceeded**   
請求已達到資源限制，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409

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

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

更新網域的端點選項，特別是所該網域的所有要求是否都必須透過 HTTPS 到達。如需詳細資訊，請參閱《*Amazon CloudSearch 開發人員指南*》中的[設定網域端點選項](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html)。

## 請求參數
<a name="API_UpdateDomainEndpointOptions_RequestParameters"></a>

**DomainName**  
代表網域名稱的字串。  
類型：字串  
必要：是 

**DomainEndpointOptions**  
端點選項的容器。  
類型：[DomainEndpointOptions](API_DomainEndpointOptions.md)  
必要：是

## 回應元素
<a name="API_UpdateDomainEndpointOptions_ResponseElements"></a>

**DomainEndpointOptionsStatus**  
網域端點選項的狀態和組態。  
類型：[DomainEndpointOptionsStatus](API_DomainEndpointOptionsStatus.md)

## 錯誤
<a name="API_UpdateDomainEndpointOptions_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

**Base**  
處理請求時發生錯誤。  
HTTP 狀態碼：400

**內部 (Internal)**  
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
HTTP 狀態碼：500

InvalidType  
請求所指定的類型定義無效，因而遭到拒絕。  
HTTP 狀態碼：409

**LimitExceeded**  
請求已達到資源限制，因而遭到拒絕。  
HTTP 狀態碼：409

**ResourceNotFound**  
請求嘗試參考不存在的資源，因而遭到拒絕。  
HTTP 狀態碼：409

**ValidationException**  
請求包含無效的輸入或遺漏必要的輸入。  
HTTP 狀態碼 400。

 **DisabledOperation**   
請求遭到拒絕，因為它嘗試的操作尚未啟用。  
HTTP 狀態碼：409

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

## 描述
<a name="API_UpdateServiceAccessPolicies_Description"></a>

設定存取規則，用來控制網域的文件和搜尋端點的存取權。如需詳細資訊，請參閱[設定 Amazon CloudSearch 網域的存取權](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html)。

## 請求參數
<a name="API_UpdateServiceAccessPolicies_RequestParameters"></a>

 如需所有動作所使用的一般參數相關資訊，請參閱[常見參數](CommonParameters.md)。

 **AccessPolicies**   
您要設定的存取規則。這些規則會取代任何現有的規則。  
類型：字串  
 必要：是 

 **DomainName**   
代表網域名稱的字串。AWS 區域內任一帳戶所擁有的各網域，其網域名稱皆為獨一無二。網域名稱以字母或數字開頭，並可包含以下字元：a-z (小寫)、0-9 和 - (連字號)。  
類型：字串  
 長度限制：長度下限為 3。長度上限為 28。  
 必要：是 

## 回應元素
<a name="API_UpdateServiceAccessPolicies_ResponseElements"></a>

 名為 `UpdateServiceAccessPoliciesResult` 的結構中會傳回以下元素。

 **AccessPolicies**   
為網域設定的存取規則。  
類型：[AccessPoliciesStatus](API_AccessPoliciesStatus.md)

## 錯誤
<a name="API_UpdateServiceAccessPolicies_Errors"></a>

 如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 **Base**   
處理請求時發生錯誤。  
 HTTP 狀態碼：400

 **內部 (Internal)**   
處理請求時發生內部錯誤。如果此問題持續存在，請從[服務運作狀態儀表板](https://status.aws.amazon.com/)提報問題。  
 HTTP 狀態碼：500

 **InvalidType**   
請求所指定的類型定義無效，因而遭到拒絕。  
 HTTP 狀態碼：409

 **LimitExceeded**   
請求已達到資源限制，因而遭到拒絕。  
 HTTP 狀態碼：409

 **ResourceNotFound**   
請求嘗試參考不存在的資源，因而遭到拒絕。  
 HTTP 狀態碼：409