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

# Amazon CloudSearch 的組態 API 參考
<a name="configuration-api"></a>

您可以使用 Amazon CloudSearch Configuration API 來建立、設定和管理搜尋網域。如需如何設定搜尋網域的詳細資訊，請參閱[建立和管理搜尋網域](creating-managing-domains.md)。

 您用來與 Amazon CloudSearch 互動的其他 APIs 包括：
+ [文件服務 API 參考](document-service-api.md) - 提交您要搜尋的資料。
+ [搜尋 API 參考](search-api.md) - 搜尋您的網域。

**Topics**
+ [在 Amazon CloudSearch 中提交組態請求](submitting-configuration-requests.md)
+ [動作](API_Operations.md)
+ [資料類型](API_Types.md)
+ [常見參數](CommonParameters.md)
+ [常見錯誤](CommonErrors.md)

# 在 Amazon CloudSearch 中提交組態請求
<a name="submitting-configuration-requests"></a>

**重要**  
提交組態請求最簡單的方法是使用 Amazon CloudSearch 主控台、Amazon CloudSearch 命令列工具或適用於 Java、JavaScript、.NET、PHP、Ruby 或 Python (Boto) 的 AWS 開發套件。命令列工具和 SDKs 會為您處理簽署程序，並確保 Amazon CloudSearch 組態請求格式正確。如需 AWS 軟體開發套件的詳細資訊，請參閱 [AWS 軟體開發套件](https://aws.amazon.com/code)。

 您可以使用 AWS 查詢通訊協定，將 Amazon CloudSearch 組態請求提交至您區域的 Amazon CloudSearch 端點。如需支援的區域和端點的最新清單，請參閱[區域與端點](https://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region)。

 AWS 查詢請求是使用名為 Action 的查詢參數透過 HTTP GET 或 POST 所提交的 HTTP 或 HTTPS 請求。所有組態請求皆必須指定 API 版本，且該版本必須與網域建立時所指定的 API 版本相符。

您必須在每個請求中包含授權參數和數位簽章。Amazon CloudSearch 支援 AWS Signature 第 4 版。如需詳細的簽署說明，請參閱 AWS 一般參考中的 [Signature 第 4 版簽署程序](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)。

**注意**  
Amazon CloudSearch 會調節對組態服務的過度請求。調節*會透過動作*發生，因此過多的`DescribeDomains`請求不會導致 Amazon CloudSearch 調節`DescribeIndexFields`請求。請求上限會根據服務的需求而變動，但允許每小時多次呼叫各項動作。

## 組態請求的結構
<a name="submitting-configuration-requests-structure"></a>

此參考以 URLs顯示 Amazon CloudSearch 組態請求，可直接在瀏覽器中使用。（雖然 GET 請求顯示為 URLs，但參數值會顯示為未編碼，以便於讀取。 請注意，提交請求時，您必須使用 URL 編碼參數值。) URL 包含三個部分：
+ 端點 - 要對其執行動作的 Web 服務進入點，即 `cloudsearch.us-east-1.amazonaws.com`。
+ 動作：您要執行的 Amazon CloudSearch 組態動作。如需完整的動作清單，請參閱[動作](API_Operations.md)。
+ 參數 - 指定動作所需的任何請求參數。每一次查詢請求還必須附上若干一般參數以供處理身分驗證。如需詳細資訊，請參閱[請求身分驗證](#configuration-request-authentication)。

您必須在每個 Amazon CloudSearch 組態請求中指定 `Version` 參數。目前的 Amazon CloudSearch API 版本為 2013-01-01。

例如，以下 GET 請求會建立一個新的搜尋網域，名為 *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
```

## 請求身分驗證
<a name="configuration-request-authentication"></a>

提交至組態 API 的請求將使用您的 AWS 存取金鑰進行身分驗證。您必須在每個請求中包含授權參數和數位簽章。Amazon CloudSearch 支援 AWS Signature 第 4 版。如需詳細的簽署說明，請參閱 AWS 一般參考中的 [Signature 第 4 版簽署程序](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)。

**注意**  
如果您才剛入門親自簽署 AWS 請求，不妨先了解一下開發套件實作簽署的方式。大多數 AWS 開發套件的原始碼均可從 [https://github.com/aws](https://github.com/aws) 取得。

例如，建構 `CreateDomain` 請求時需要以下資訊：

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

`CreateDomain` 請求的正式查詢字串大致如下：

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

最終已簽署的請求大致如下：

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

# 動作
<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

# 資料類型
<a name="API_Types"></a>

 Amazon CloudSearch 組態服務 API 包含由各種動作所使用的數種資料類型。本節將詳細說明每一種資料類型。

**注意**  
回應中各個元素的先後順序無法保證。應用程式不該認定採取某一特定順序。

目前支援下列資料類型：
+  [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) 
+  [表達式](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) 
+  [限制](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>

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

針對網域的文件端點和搜尋端點所設定的存取規則，以及各項規則目前的狀態。

## 目錄
<a name="API_AccessPoliciesStatus_Contents"></a>

 **選項**   
網域的文件端點或搜尋服務端點的存取規則。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html)》中的*設定存取搜尋網域*。政策文件的大小上限為 100 KB。  
類型：字串  
 必要：是 

 **狀態**   
網域組態選項的狀態。  
類型：[OptionStatus](API_OptionStatus.md)  
 必要：是 

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

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

分析方案的同義詞、停用詞和相關字詞功能選項。包括日文字符化字典。

## 目錄
<a name="API_AnalysisOptions_Contents"></a>

 **AlgorithmicStemming**   
演算法相關字詞功能的執行程度：`none`、`minimal`、`light` 或 `full`。可用程度因語言而異。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings)》中的*特定語言文字處理設定*。  
類型：字串  
 有效值:`none | minimal | light | full`   
 必要：否 

 **JapaneseTokenizationDictionary**   
包含一組日文字符化詞彙、字符、讀音及詞類的 JSON 陣列。日文字符化字典讓您能夠覆寫所選字詞預設的字符化方式。此項目僅適用於日文欄位。  
類型：字串  
 必要：否 

 **StemmingDictionary**   
包含一組「字串:值」配對的 JSON 物件，其中各配對分別對應某一字詞及其詞幹。例如：`{"term1": "stem1", "term2": "stem2", "term3": "stem3"}`。系統會套用任何演算法相關字詞功能外加相關字詞功能字典。這讓您能夠覆寫演算法相關字詞功能的結果，以便修正特定詞幹過多或不足的情況。相關字詞功能字典的大小上限為 500 KB。  
類型：字串  
 必要：否 

 **Stopwords**   
編製索引及搜尋期間要忽略的字詞所構成的 JSON 陣列。例如：`["a", "an", "the", "of"]`。停用詞字典必須明確列出欲忽略的每個單詞。不支援萬用字元和正規運算式。  
類型：字串  
 必要：否 

 **Synonyms**   
定義同義詞群組和別名的 JSON 物件。同義詞群組是由陣列構成的陣列，其中每個子陣列都是一組字詞，而同一組當中的每個字詞均視為該群組中其他每個字詞的同義詞。別名值是包含一組「字串:值」配對的物件，其中的字串指定某個字詞，而值的陣列則指定該字詞的每個別名。別名將視為所指定之字詞的同義詞，但該字詞並非視為其別名的同義詞。如需如何指定同義詞的詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms)》中的*同義詞*。  
類型：字串  
 必要：否 

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

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

分析方案的組態資訊。每個分析方案都具有獨一無二的名稱，並指定其所處理文字的語言。針對分析方案可設定以下選項：`Synonyms`、`Stopwords`、`StemmingDictionary`、`JapaneseTokenizationDictionary` 和 `AlgorithmicStemming`。

## 目錄
<a name="API_AnalysisScheme_Contents"></a>

 **AnalysisOptions**   
分析方案的同義詞、停用詞和相關字詞功能選項。包括日文字符化字典。  
類型：[AnalysisOptions](API_AnalysisOptions.md)  
 必要：否 

 **AnalysisSchemeLanguage**   
[IETF RFC 4646](http://tools.ietf.org/html/rfc4646) 語言代碼或 `mul` 表示多國語言。  
類型：字串  
 有效值:`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`   
 必要：是 

 **AnalysisSchemeName**   
名稱必須以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 \$1 (底線)。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：是 

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

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

`AnalysisScheme` 的狀態與組態。

## 目錄
<a name="API_AnalysisSchemeStatus_Contents"></a>

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

 **狀態**   
網域組態選項的狀態。  
類型：[OptionStatus](API_OptionStatus.md)  
 必要：是 

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

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

網域可用性選項的狀態和組態。

## 目錄
<a name="API_AvailabilityOptionsStatus_Contents"></a>

 **選項**   
針對網域所設定的可用性選項。  
類型：布林值  
 必要：是 

 **狀態**   
網域組態選項的狀態。  
類型：[OptionStatus](API_OptionStatus.md)  
 必要：是 

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

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

`BuildSuggester` 請求的結果。包含用於建議的各個欄位的清單。

## 目錄
<a name="API_BuildSuggestersResult_Contents"></a>

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

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

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

`CreateDomainRequest` 的結果。包含新建立網域的狀態。

## 目錄
<a name="API_CreateDomainResult_Contents"></a>

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

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

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

針對包含日期陣列的欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `date-array` 便會有此項目。預設會啟用所有選項。

## 目錄
<a name="API_DateArrayOptions_Contents"></a>

 **DefaultValue**   
 未對任何文件指定某欄位的情況下將用於該欄位的值。  
類型：字串  
 長度限制： 最小長度為 0。長度上限為 1024。  
 必要：否 

 **FacetEnabled**   
對欄位是否可傳回面向資訊。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SearchEnabled**   
欄位的內容是否可搜尋。  
類型：布林值  
 必要：否 

 **SourceFields**   
對應至此欄位的來源欄位的清單。  
類型：字串  
 必要：否 

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

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

針對日期欄位所指定的選項。日期和時間是依照 IETF RFC3339 的規範，以 UTC (國際標準時間) 指定 yyyy-mm-ddT00:00:00Z 格式。若 `IndexFieldType` 指定欄位的類型為 `date` 便會有此項目。預設會啟用所有選項。

## 目錄
<a name="API_DateOptions_Contents"></a>

 **DefaultValue**   
 未對任何文件指定某欄位的情況下將用於該欄位的值。  
類型：字串  
 長度限制： 最小長度為 0。長度上限為 1024。  
 必要：否 

 **FacetEnabled**   
對欄位是否可傳回面向資訊。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SearchEnabled**   
欄位的內容是否可搜尋。  
類型：布林值  
 必要：否 

 **SortEnabled**   
欄位是否可用於對搜尋結果進行排序。  
類型：布林值  
 必要：否 

 **SourceField**   
代表索引欄位名稱的字串。CloudSearch 支援正規索引欄位以及動態欄位。動態欄位的名稱定義了以萬用字元開頭或結尾的模式。凡未對應到正規索引欄位但符合動態欄位模式的任何文件欄位，都將使用動態欄位的索引選項進行設定。  
正規欄位名稱以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 \$1 (底線)。動態欄位名稱必須以萬用字元 (\$1) 開頭或結尾。萬用字元也可以是動態欄位名稱中唯一的字元。多個萬用字元以及內嵌於字串的萬用字元則不受支援。  
名稱 `score` 是保留項目，不得做為欄位名稱使用。若要參考文件的 ID，您可以使用 `_id` 這個名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：否 

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

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

` DefineAnalysisScheme ` 請求的結果。包含新設定之分析方案的狀態。

## 目錄
<a name="API_DefineAnalysisSchemeResult_Contents"></a>

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

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

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

`DefineExpression` 請求的結果。包含新設定的運算式的狀態。

## 目錄
<a name="API_DefineExpressionResult_Contents"></a>

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

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

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

` DefineIndexField ` 請求的結果。包含新設定的索引欄位的狀態。

## 目錄
<a name="API_DefineIndexFieldResult_Contents"></a>

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

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

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

`DefineSuggester` 請求的結果。包含新設定的建議者的狀態。

## 目錄
<a name="API_DefineSuggesterResult_Contents"></a>

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

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

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

`DeleteAnalysisScheme` 請求的結果。包含所刪除的分析方案的狀態。

## 目錄
<a name="API_DeleteAnalysisSchemeResult_Contents"></a>

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

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

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

`DeleteDomain` 請求的結果。包含新刪除網域的狀態，如果網域已完全刪除則為無狀態。

## 目錄
<a name="API_DeleteDomainResult_Contents"></a>

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

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

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

` DeleteExpression ` 請求的結果。指定要刪除的運算式。

## 目錄
<a name="API_DeleteExpressionResult_Contents"></a>

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

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

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

` DeleteIndexField ` 請求的結果。

## 目錄
<a name="API_DeleteIndexFieldResult_Contents"></a>

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

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

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

`DeleteSuggester` 請求的結果。包含所刪除的建議者的狀態。

## 目錄
<a name="API_DeleteSuggesterResult_Contents"></a>

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

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

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

`DescribeAnalysisSchemes` 請求的結果。包含為請求中指定的網域所設定的分析方案。

## 目錄
<a name="API_DescribeAnalysisSchemesResult_Contents"></a>

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

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

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

`DescribeAvailabilityOptions` 請求的結果。指出請求中指定的網域是否已啟用異地同步備份選項。

## 目錄
<a name="API_DescribeAvailabilityOptionsResult_Contents"></a>

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

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

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

`DescribeDomains` 請求的結果。包含請求中指定的網域或帳戶擁有的所有網域的狀態。

## 目錄
<a name="API_DescribeDomainsResult_Contents"></a>

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

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

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

`DescribeExpressions` 請求的結果。包含為請求中指定的網域所設定的運算式。

## 目錄
<a name="API_DescribeExpressionsResult_Contents"></a>

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

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

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

`DescribeIndexFields` 請求的結果。包含為請求中指定的網域所設定的索引欄位。

## 目錄
<a name="API_DescribeIndexFieldsResult_Contents"></a>

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

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

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

`DescribeScalingParameters` 請求的結果。包含為請求中指定的網域所設定的調整規模參數。

## 目錄
<a name="API_DescribeScalingParametersResult_Contents"></a>

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

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

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

`DescribeServiceAccessPolicies` 請求的結果。

## 目錄
<a name="API_DescribeServiceAccessPoliciesResult_Contents"></a>

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

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

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

`DescribeSuggesters` 請求的結果。

## 目錄
<a name="API_DescribeSuggestersResult_Contents"></a>

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

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

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

搜尋建議者的選項。

## 目錄
<a name="API_DocumentSuggesterOptions_Contents"></a>

 **FuzzyMatching**   
就某字串建議相符項目時所允許的模糊程度：`none`、`low` 或 `high`。設為 none 時，指定的字串將視為確切字首。設為 low 時，建議項目與指定的字串相差不得超過一個字元。設為 high 時，建議項目可相差多達兩個字元。預設為 none。  
類型：字串  
 有效值:`none | low | high`   
 必要：否 

 **SortExpression**   
用於就每項建議計算分數據以控制其排序方式的運算式。分數會捨入到最接近的整數，下限為 0 且上限為 2^31-1。提供建議時對文件的相關性分數不做計算，所以排序運算式不得參考 `_score` 值。若要使用數值欄位或現有運算式對建議進行排序，可直接指定該欄位或運算式的名稱。如果沒有為建議者設定任何運算式，建議項目將從列為第一名的最相近相符者開始排序。  
類型：字串  
 必要：否 

 **SourceField**   
您想要用於建議的索引欄位的名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：是 

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

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

是否要求該網域的所有要求都必須透過 HTTPS 到達。我們建議將 `Policy-Min-TLS-1-2-2019-07` 用於 `TLSSecurityPolicy`。為了與舊型用戶端相容，預設值為 `Policy-Min-TLS-1-0-2019-07`。

## 目錄
<a name="API_DomainEndpointOptions_Contents"></a>

 **EnforceHTTPS**  
啟用或停用該網域的所有要求都必須透過 HTTPS 到達的要求。  
類型：布林值  
有效值:`true | false`  
必要：否

 **TLSSecurityPolicy**  
最低所需的 TLS 版本。  
類型：字串  
有效值:`Policy-Min-TLS-1-2-2019-07 | Policy-Min-TLS-1-0-2019-07`  
必要：否

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

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

網域端點選項的組態和狀態。

## 目錄
<a name="API_DomainEndpointOptionsStatus_Contents"></a>

 **選項**  
目前的組態。  
類型：[DomainEndpointOptions](API_DomainEndpointOptions.md)

 **狀態**  
組態選項的狀態。  
類型：[OptionStatus](API_OptionStatus.md)

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

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

搜尋網域目前的狀態。

## 目錄
<a name="API_DomainStatus_Contents"></a>

 **ARN**   
搜尋網域的 Amazon Resource Name (ARN)。如需詳細資訊，請參閱《[AWS Identity and Access Management 使用者指南](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html)》中的 *IAM 實體識別符*。  
類型：字串  
 必要：否 

 **已建立**   
若搜尋網域已建立即為 true。呼叫 [CreateDomain](API_CreateDomain.md) 將網域初始化需要幾分鐘的時間。新建立的搜尋網域會由 [DescribeDomains](API_DescribeDomains.md) 傳回 Created 為 false 值，直到網域建立完成為止。  
類型：布林值  
 必要：否 

 **Deleted (已刪除)**   
若搜尋網域已刪除即為 true。呼叫 [DeleteDomain](API_DeleteDomain.md) 後，系統必須清理搜尋網域專用的資源。剛刪除的搜尋網域會由 [DescribeDomains](API_DescribeDomains.md) 傳回 IsDeleted 為 true 值，直到數分鐘後資源清理完成為止。  
類型：布林值  
 必要：否 

 **DocService**   
用於更新搜尋網域內各類文件的服務端點。  
類型：[ServiceEndpoint](API_ServiceEndpoint.md)  
 必要：否 

 **DomainId**   
內部產生的網域唯一識別符。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：是 

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

 **限制**   
類型：[限制](API_Limits.md)  
 必要：否 

 **處理**   
啟用目前網域組態若已處理完畢即為 true。  
類型：布林值  
 必要：否 

 **RequiresIndexDocuments**   
若需要呼叫 [IndexDocuments](API_IndexDocuments.md) 以啟用目前網域組態即為 true。  
類型：布林值  
 必要：是 

 **SearchInstanceCount**   
可用於處理搜尋請求的搜尋執行個體數目。  
類型：整數  
 必要：否 

 **SearchInstanceType**   
用以處理搜尋請求的執行個體類型。  
類型：字串  
 必要：否 

 **SearchPartitionCount**   
搜尋索引分佈的分割區數目。  
類型：整數  
 必要：否 

 **SearchService**   
用於向搜尋網域請求搜尋結果的服務端點。  
類型：[ServiceEndpoint](API_ServiceEndpoint.md)  
 必要：否 

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

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

針對包含雙精度 64 位元浮點值陣列的欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `double-array` 便會有此項目。預設會啟用所有選項。

## 目錄
<a name="API_DoubleArrayOptions_Contents"></a>

 **DefaultValue**   
 未對任何文件指定某欄位的情況下將用於該欄位的值。  
類型：Double  
 必要：否 

 **FacetEnabled**   
對欄位是否可傳回面向資訊。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SearchEnabled**   
欄位的內容是否可搜尋。  
類型：布林值  
 必要：否 

 **SourceFields**   
對應至此欄位的來源欄位的清單。  
類型：字串  
 必要：否 

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

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

針對雙精度 64 位元浮點欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `double` 便會有此項目。預設會啟用所有選項。

## 目錄
<a name="API_DoubleOptions_Contents"></a>

 **DefaultValue**   
未對任何文件指定某欄位的情況下將用於該欄位的值。如果您在運算式中使用欄位但每份文件皆未出現該欄位，此值即尤為重要。  
類型：Double  
 必要：否 

 **FacetEnabled**   
對欄位是否可傳回面向資訊。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SearchEnabled**   
欄位的內容是否可搜尋。  
類型：布林值  
 必要：否 

 **SortEnabled**   
欄位是否可用於對搜尋結果進行排序。  
類型：布林值  
 必要：否 

 **SourceField**   
對應至此欄位的來源欄位的名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：否 

# 表達式
<a name="API_Expression"></a>

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

搜尋期間可供評估的具名運算式。可用於對搜尋結果進行排序、定義其他運算式，或由搜尋結果傳回經過計算的資訊。

## 目錄
<a name="API_Expression_Contents"></a>

 **ExpressionName**   
名稱必須以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 \$1 (底線)。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：是 

 **ExpressionValue**   
處理搜尋請求時基於排序而要評估的運算式。`Expression` 語法是以 JavaScript 運算式為準。如需詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html)》中的*設定運算式*。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 10240。  
 必要：是 

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

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

`Expression` 的值及其目前狀態。

## 目錄
<a name="API_ExpressionStatus_Contents"></a>

 **選項**   
處理搜尋請求時基於排序所評估的運算式。  
類型：[表達式](API_Expression.md)  
 必要：是 

 **狀態**   
網域組態選項的狀態。  
類型：[OptionStatus](API_OptionStatus.md)  
 必要：是 

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

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

`IndexDocuments` 請求的結果。包含索引編製操作的狀態，包括要編製索引的欄位。

## 目錄
<a name="API_IndexDocumentsResult_Contents"></a>

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

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

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

索引中某個欄位的組態資訊，包括其名稱、類型和選項。支援的選項視 ` IndexFieldType ` 而定。

## 目錄
<a name="API_IndexField_Contents"></a>

 **DateArrayOptions**   
針對包含日期陣列的欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `date-array` 便會有此項目。預設會啟用所有選項。  
類型：[DateArrayOptions](API_DateArrayOptions.md)  
 必要：否 

 **DateOptions**   
針對日期欄位所指定的選項。日期和時間是依照 IETF RFC3339 的規範，以 UTC (國際標準時間) 指定 yyyy-mm-ddT00:00:00Z 格式。若 `IndexFieldType` 指定欄位的類型為 `date` 便會有此項目。預設會啟用所有選項。  
類型：[DateOptions](API_DateOptions.md)  
 必要：否 

 **DoubleArrayOptions**   
針對包含雙精度 64 位元浮點值陣列的欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `double-array` 便會有此項目。預設會啟用所有選項。  
類型：[DoubleArrayOptions](API_DoubleArrayOptions.md)  
 必要：否 

 **DoubleOptions**   
針對雙精度 64 位元浮點欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `double` 便會有此項目。預設會啟用所有選項。  
類型：[DoubleOptions](API_DoubleOptions.md)  
 必要：否 

 **IndexFieldName**   
代表索引欄位名稱的字串。CloudSearch 支援正規索引欄位以及動態欄位。動態欄位的名稱定義了以萬用字元開頭或結尾的模式。凡未對應到正規索引欄位但符合動態欄位模式的任何文件欄位，都將使用動態欄位的索引選項進行設定。  
正規欄位名稱以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 \$1 (底線)。動態欄位名稱必須以萬用字元 (\$1) 開頭或結尾。萬用字元也可以是動態欄位名稱中唯一的字元。多個萬用字元以及內嵌於字串的萬用字元則不受支援。  
名稱 `score` 是保留項目，不得做為欄位名稱使用。若要參考文件的 ID，您可以使用 `_id` 這個名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：是 

 **IndexFieldType**   
欄位的類型。欄位的有效選項視欄位類型而定。如需支援的欄位類型詳細資訊，請參閱《[Amazon CloudSearch 開發人員指南](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html)》中的*設定索引欄位*。  
類型：字串  
 有效值:`int | double | literal | text | date | latlon | int-array | double-array | literal-array | text-array | date-array`   
 必要：是 

 **IntArrayOptions**   
針對包含 64 位元帶正負號整數陣列的欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `int-array` 便會有此項目。預設會啟用所有選項。  
類型：[IntArrayOptions](API_IntArrayOptions.md)  
 必要：否 

 **IntOptions**   
針對 64 位元帶正負號的整數欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `int` 便會有此項目。預設會啟用所有選項。  
類型：[IntOptions](API_IntOptions.md)  
 必要：否 

 **LatLonOptions**   
針對 Latlon 欄位所指定的選項。Latlon 欄位包含儲存為經緯度值組的位置。若 `IndexFieldType` 指定欄位的類型為 `latlon` 便會有此項目。預設會啟用所有選項。  
類型：[LatLonOptions](API_LatLonOptions.md)  
 必要：否 

 **LiteralArrayOptions**   
針對包含常值字串陣列的欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `literal-array` 便會有此項目。預設會啟用所有選項。  
類型：[LiteralArrayOptions](API_LiteralArrayOptions.md)  
 必要：否 

 **LiteralOptions**   
針對常值欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `literal` 便會有此項目。預設會啟用所有選項。  
類型：[LiteralOptions](API_LiteralOptions.md)  
 必要：否 

 **TextArrayOptions**   
針對包含文字字串陣列的欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `text-array` 便會有此項目。`text-array` 欄位一律可供搜尋。預設會啟用所有選項。  
類型：[TextArrayOptions](API_TextArrayOptions.md)  
 必要：否 

 **TextOptions**   
針對文字欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `text` 便會有此項目。`text` 欄位一律可供搜尋。預設會啟用所有選項。  
類型：[TextOptions](API_TextOptions.md)  
 必要：否 

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

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

`IndexField` 的值及其目前狀態。

## 目錄
<a name="API_IndexFieldStatus_Contents"></a>

 **選項**   
索引中某個欄位的組態資訊，包括其名稱、類型和選項。支援的選項視 ` IndexFieldType ` 而定。  
類型：[IndexField](API_IndexField.md)  
 必要：是 

 **狀態**   
網域組態選項的狀態。  
類型：[OptionStatus](API_OptionStatus.md)  
 必要：是 

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

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

針對包含 64 位元帶正負號整數陣列的欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `int-array` 便會有此項目。預設會啟用所有選項。

## 目錄
<a name="API_IntArrayOptions_Contents"></a>

 **DefaultValue**   
 未對任何文件指定某欄位的情況下將用於該欄位的值。  
類型：Long  
 必要：否 

 **FacetEnabled**   
對欄位是否可傳回面向資訊。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SearchEnabled**   
欄位的內容是否可搜尋。  
類型：布林值  
 必要：否 

 **SourceFields**   
對應至此欄位的來源欄位的清單。  
類型：字串  
 必要：否 

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

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

針對 64 位元帶正負號的整數欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `int` 便會有此項目。預設會啟用所有選項。

## 目錄
<a name="API_IntOptions_Contents"></a>

 **DefaultValue**   
 未對任何文件指定某欄位的情況下將用於該欄位的值。如果您在運算式中使用欄位但每份文件皆未出現該欄位，此值即尤為重要。  
類型：Long  
 必要：否 

 **FacetEnabled**   
對欄位是否可傳回面向資訊。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SearchEnabled**   
欄位的內容是否可搜尋。  
類型：布林值  
 必要：否 

 **SortEnabled**   
欄位是否可用於對搜尋結果進行排序。  
類型：布林值  
 必要：否 

 **SourceField**   
對應至此欄位的來源欄位的名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：否 

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

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

針對 Latlon 欄位所指定的選項。Latlon 欄位包含儲存為經緯度值組的位置。若 `IndexFieldType` 指定欄位的類型為 `latlon` 便會有此項目。預設會啟用所有選項。

## 目錄
<a name="API_LatLonOptions_Contents"></a>

 **DefaultValue**   
 未對任何文件指定某欄位的情況下將用於該欄位的值。  
類型：字串  
 長度限制： 最小長度為 0。長度上限為 1024。  
 必要：否 

 **FacetEnabled**   
對欄位是否可傳回面向資訊。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SearchEnabled**   
欄位的內容是否可搜尋。  
類型：布林值  
 必要：否 

 **SortEnabled**   
欄位是否可用於對搜尋結果進行排序。  
類型：布林值  
 必要：否 

 **SourceField**   
代表索引欄位名稱的字串。CloudSearch 支援正規索引欄位以及動態欄位。動態欄位的名稱定義了以萬用字元開頭或結尾的模式。凡未對應到正規索引欄位但符合動態欄位模式的任何文件欄位，都將使用動態欄位的索引選項進行設定。  
正規欄位名稱以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 \$1 (底線)。動態欄位名稱必須以萬用字元 (\$1) 開頭或結尾。萬用字元也可以是動態欄位名稱中唯一的字元。多個萬用字元以及內嵌於字串的萬用字元則不受支援。  
名稱 `score` 是保留項目，不得做為欄位名稱使用。若要參考文件的 ID，您可以使用 `_id` 這個名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：否 

# 限制
<a name="API_Limits"></a>

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

未提供動作文件。

## 目錄
<a name="API_Limits_Contents"></a>

 **MaximumPartitionCount**   
類型：整數  
 必要：是 

 **MaximumReplicationCount**   
類型：整數  
 必要：是 

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

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

`ListDomainNames` 請求的結果。包含帳戶所擁有的各個網域的清單。

## 目錄
<a name="API_ListDomainNamesResult_Contents"></a>

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

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

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

針對包含常值字串陣列的欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `literal-array` 便會有此項目。預設會啟用所有選項。

## 目錄
<a name="API_LiteralArrayOptions_Contents"></a>

 **DefaultValue**   
 未對任何文件指定某欄位的情況下將用於該欄位的值。  
類型：字串  
 長度限制： 最小長度為 0。長度上限為 1024。  
 必要：否 

 **FacetEnabled**   
對欄位是否可傳回面向資訊。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SearchEnabled**   
欄位的內容是否可搜尋。  
類型：布林值  
 必要：否 

 **SourceFields**   
對應至此欄位的來源欄位的清單。  
類型：字串  
 必要：否 

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

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

針對常值欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `literal` 便會有此項目。預設會啟用所有選項。

## 目錄
<a name="API_LiteralOptions_Contents"></a>

 **DefaultValue**   
 未對任何文件指定某欄位的情況下將用於該欄位的值。  
類型：字串  
 長度限制： 最小長度為 0。長度上限為 1024。  
 必要：否 

 **FacetEnabled**   
對欄位是否可傳回面向資訊。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SearchEnabled**   
欄位的內容是否可搜尋。  
類型：布林值  
 必要：否 

 **SortEnabled**   
欄位是否可用於對搜尋結果進行排序。  
類型：布林值  
 必要：否 

 **SourceField**   
代表索引欄位名稱的字串。CloudSearch 支援正規索引欄位以及動態欄位。動態欄位的名稱定義了以萬用字元開頭或結尾的模式。凡未對應到正規索引欄位但符合動態欄位模式的任何文件欄位，都將使用動態欄位的索引選項進行設定。  
正規欄位名稱以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 \$1 (底線)。動態欄位名稱必須以萬用字元 (\$1) 開頭或結尾。萬用字元也可以是動態欄位名稱中唯一的字元。多個萬用字元以及內嵌於字串的萬用字元則不受支援。  
名稱 `score` 是保留項目，不得做為欄位名稱使用。若要參考文件的 ID，您可以使用 `_id` 這個名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：否 

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

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

網域組態選項的狀態。

## 目錄
<a name="API_OptionStatus_Contents"></a>

 **CreationDate**   
此選項建立時的時間戳記。  
類型：DateTime  
 必要：是 

 **PendingDeletion**   
表示此選項將於處理完成後即刪除。  
類型：布林值  
 必要：否 

 **州**   
處理此選項所做變更的狀態。可能的值如下：  
+ `RequiresIndexDocuments`：待已呼叫 [IndexDocuments](API_IndexDocuments.md) 且索引編製完成後才會部署此選項的最新值。
+ `Processing`：正在啟用此選項的最新值。
+ `Active`：已完全部署此選項的最新值。
+ `FailedToValidate`：選項值與網域的資料不相容，無法用於對資料編製索引。您必須修改選項值，或者更新或移除不相容的文件。
類型：字串  
 有效值:`RequiresIndexDocuments | Processing | Active | FailedToValidate`   
 必要：是 

 **UpdateDate**   
此選項上次更新時的時間戳記。  
類型：DateTime  
 必要：是 

 **UpdateVersion**   
獨一無二的整數，代表此選項上次更新的時間。  
類型：整數  
 必要：否 

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

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

每個索引分割區所需的執行個體類型和所需的複本數。

## 目錄
<a name="API_ScalingParameters_Contents"></a>

 **DesiredInstanceType**   
您希望為網域預先設定的執行個體類型。例如：`search.medium`。  
類型：字串  
有效值:`search.small | search.medium | search.large | search.xlarge | search.2xlarge`   
對於較舊的網域，有效值也可能包括 `search.m1.small`、`search.m1.large`、`search.m2.xlarge`、`search.m2.2xlarge`、`search.m3.medium`、`search.m3.large`、 `search.m3.xlarge`和 `search.m3.2xlarge`。
必要：否 

 **DesiredPartitionCount**   
您希望為網域預先設定的分割區數目。僅限於執行個體類型選取 `search.2xlarge` 時有效。  
類型：整數  
必要：否 

 **DesiredReplicationCount**   
您希望為每個索引分割區預先設定的複本數。  
類型：整數  
必要：否 

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

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

搜尋網域各個調整規模參數的狀態與組態。

## 目錄
<a name="API_ScalingParametersStatus_Contents"></a>

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

 **狀態**   
網域組態選項的狀態。  
類型：[OptionStatus](API_OptionStatus.md)  
 必要：是 

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

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

可向其提交服務求的端點。

## 目錄
<a name="API_ServiceEndpoint_Contents"></a>

 **端點**   
可向其提交服務求的端點。例如，`search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com` 或 `doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com`。  
類型：字串  
 必要：否 

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

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

搜尋建議者的組態資訊。每個建議者都具有獨一無二的名稱，並指定您要用於建議的文字欄位。針對建議者可設定以下選項：`FuzzyMatching`、`SortExpression`。

## 目錄
<a name="API_Suggester_Contents"></a>

 **DocumentSuggesterOptions**   
搜尋建議者的選項。  
類型：[DocumentSuggesterOptions](API_DocumentSuggesterOptions.md)  
 必要：是 

 **SuggesterName**   
名稱必須以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 \$1 (底線)。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：是 

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

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

`Suggester` 的值及其目前狀態。

## 目錄
<a name="API_SuggesterStatus_Contents"></a>

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

 **狀態**   
網域組態選項的狀態。  
類型：[OptionStatus](API_OptionStatus.md)  
 必要：是 

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

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

針對包含文字字串陣列的欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `text-array` 便會有此項目。`text-array` 欄位一律可供搜尋。預設會啟用所有選項。

## 目錄
<a name="API_TextArrayOptions_Contents"></a>

 **AnalysisScheme**   
`text-array` 欄位的分析方案的名稱。  
類型：字串  
 必要：否 

 **DefaultValue**   
 未對任何文件指定某欄位的情況下將用於該欄位的值。  
類型：字串  
 長度限制： 最小長度為 0。長度上限為 1024。  
 必要：否 

 **HighlightEnabled**   
對欄位是否可傳回反白句。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SourceFields**   
對應至此欄位的來源欄位的清單。  
類型：字串  
 必要：否 

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

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

針對文字欄位所指定的選項。若 `IndexFieldType` 指定欄位的類型為 `text` 便會有此項目。`text` 欄位一律可供搜尋。預設會啟用所有選項。

## 目錄
<a name="API_TextOptions_Contents"></a>

 **AnalysisScheme**   
`text` 欄位的分析方案的名稱。  
類型：字串  
 必要：否 

 **DefaultValue**   
 未對任何文件指定某欄位的情況下將用於該欄位的值。  
類型：字串  
 長度限制： 最小長度為 0。長度上限為 1024。  
 必要：否 

 **HighlightEnabled**   
對欄位是否可傳回反白句。  
類型：布林值  
 必要：否 

 **ReturnEnabled**   
欄位的內容是否可隨搜尋結果傳回。  
類型：布林值  
 必要：否 

 **SortEnabled**   
欄位是否可用於對搜尋結果進行排序。  
類型：布林值  
 必要：否 

 **SourceField**   
代表索引欄位名稱的字串。CloudSearch 支援正規索引欄位以及動態欄位。動態欄位的名稱定義了以萬用字元開頭或結尾的模式。凡未對應到正規索引欄位但符合動態欄位模式的任何文件欄位，都將使用動態欄位的索引選項進行設定。  
正規欄位名稱以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 \$1 (底線)。動態欄位名稱必須以萬用字元 (\$1) 開頭或結尾。萬用字元也可以是動態欄位名稱中唯一的字元。多個萬用字元以及內嵌於字串的萬用字元則不受支援。  
名稱 `score` 是保留項目，不得做為欄位名稱使用。若要參考文件的 ID，您可以使用 `_id` 這個名稱。  
類型：字串  
 長度限制：長度下限為 1。長度上限為 64。  
 必要：否 

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

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

`UpdateAvailabilityOptions` 請求的結果。包含網域可用性選項的狀態。

## 目錄
<a name="API_UpdateAvailabilityOptionsResult_Contents"></a>

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

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

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

`UpdateScalingParameters` 請求的結果。包含新設定的調整規模參數的狀態。

## 目錄
<a name="API_UpdateScalingParametersResult_Contents"></a>

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

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

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

`UpdateServiceAccessPolicies` 請求的結果。包含新的存取政策。

## 目錄
<a name="API_UpdateServiceAccessPoliciesResult_Contents"></a>

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

# 常見參數
<a name="CommonParameters"></a>

本節列出所有動作所使用的請求參數。任何專屬於特定動作的參數則列於相應動作的主題中。

 **Action**   
要執行的動作。  
預設：無  
類型：字串  
 必要：是 

 **AuthParams**   
對條件式請求進行驗證所需的參數。包含：  
+ AWSAccessKeyID
+ SignatureVersion
+ 時間戳記
+ 簽章
預設：無  
 必要：有條件 

 **AWSAccessKeyId**   
與您用以簽署請求的私密存取金鑰相對應的存取金鑰 ID。  
預設：無  
類型：字串  
 必要：是 

 **到期**   
請求簽章過期的日期和時間，依照 ISO 8601 標準所指定，以 YYYY-MM-DDThh:mm:ssZ 格式表示。  
條件：請求必須附上 *Timestamp* 或 *Expires* 但不得兩者並存。  
預設：無  
類型：字串  
 必要：有條件 

 **SecurityToken**   
透過呼叫 AWS Security Token Service 所取得的臨時安全權杖。如需支援 AWS Security Token Service 的服務清單，請參閱「[使用臨時安全登入資料](https://docs.aws.amazon.com/IAM/latest/UsingSTS/UsingTokens.html)」一文的**使用臨時安全登入資料存取 AWS**。  
預設：無  
類型：字串  
 必要：否 

 **Signature**   
您為請求所建立的數位簽章。如需如何產生簽章的相關資訊，請參閱相應服務的開發人員文件。  
預設：無  
類型：字串  
 必要：是 

 **SignatureMethod**   
建立請求簽章時所使用的雜湊演算法。  
預設：無  
類型：字串  
 有效值:`HmacSHA256 | HmacSHA1`   
 必要：是 

 **SignatureVersion**   
簽署請求時所使用的簽章版本。將此參數設為建議您的服務使用的值。  
預設：無  
類型：字串  
 必要：是 

 **Timestamp**   
簽署請求的日期和時間，依照 ISO 8601 標準所指定，以 YYYY-MM-DDThh:mm:ssZ 格式表示。  
條件：請求必須附上 *Timestamp* 或 *Expires* 但不得兩者並存。  
預設：無  
類型：字串  
 必要：有條件 

 **版本**   
編寫請求所憑藉的 API 版本，以 YYYY-MM-DD 格式表示。  
預設：無  
類型：字串  
 必要：是 

# 常見錯誤
<a name="CommonErrors"></a>

本節列出所有動作傳回的常見錯誤。任何專屬於特定動作的錯誤則列於相應動作的主題中。

 **IncompleteSignature**   
請求簽章未符合 AWS 標準。  
HTTP 狀態碼：400

 **InternalFailure**   
由於不明的錯誤、例外狀況或故障，處理請求失敗。  
HTTP 狀態碼：500

 **InvalidAction**   
請求的動作或操作無效。確認已正確輸入動作。  
HTTP 狀態碼：400

 **InvalidClientTokenId**   
提供的 X.509 憑證或 AWS 存取金鑰 ID 不存在於我們的記錄中。  
HTTP 狀態碼：403

 **InvalidParameterCombination**   
同時使用了不應搭配使用的參數。  
HTTP 狀態碼：400

 **InvalidParameterValue**   
為輸入參數提供了無效或超出範圍的值。  
HTTP 狀態碼：400

 **InvalidQueryParameter**   
AWS 查詢字串格式不正確或未遵循 AWS 標準。  
HTTP 狀態碼：400

 **MalformedQueryString**   
查詢字串包含語法錯誤。  
HTTP 狀態碼：404

 **MissingAction**   
請求中遺失動作或必要參數。  
HTTP 狀態碼：400

 **MissingAuthenticationToken**   
請求必須包含有效 (已註冊) 的 AWS 存取金鑰 ID 或 X.509 憑證。  
HTTP 狀態碼：403

 **MissingParameter**   
未提供適用於指定動作的必要參數。  
HTTP 狀態碼：400

 **OptInRequired**   
AWS 存取金鑰 ID 需要訂閱服務。  
HTTP 狀態碼：403

 **RequestExpired**   
請求送達服務已超過戳印日期於請求上之後的 15 分鐘，或者已超過請求過期日期之後的 15 分鐘 (例如預先簽章的 URL)，或者請求上的日期戳印在未來將超過 15 分鐘。  
HTTP 狀態碼：400

 **ServiceUnavailable**   
由於伺服器暫時故障，請求失敗。  
HTTP 狀態碼：503

 **調節**   
由於請求調節，因此請求遭到拒絕。  
HTTP 狀態碼：400

 **ValidationError**   
輸入不符合 AWS 服務指定的限制。  
HTTP 狀態碼：400