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

# Amazon CloudSearch API 參考
<a name="api-ref"></a>

您可以使用三個 APIs 與 Amazon CloudSearch 互動：
+ [組態 API](configuration-api.md) - 設定和管理您的搜尋網域。
+ [文件服務 API](document-service-api.md) - 提交您要搜尋的資料。
+ [搜尋 API](search-api.md) - 搜尋您的網域。

# 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

# Amazon CloudSearch 的文件服務 API 參考
<a name="document-service-api"></a>

您可以使用 文件服務 API 來新增、取代或刪除 Amazon CloudSearch 網域中的文件。如需如何管理您的搜尋網域內各類文件的詳細資訊，請參閱[將資料上傳至 Amazon CloudSearch 網域](uploading-data.md)。

 您用來與 Amazon CloudSearch 互動的其他 APIs 包括：
+ [Amazon CloudSearch 的組態 API 參考](configuration-api.md) - 設定和管理您的搜尋網域。
+ [搜尋 API 參考](search-api.md) - 搜尋您的網域。

# documents/batch
<a name="documents-batch-resource"></a>

本節說明 `documents/batch` 資源的 HTTP 請求和回應訊息。

您可以建立文件批次來描述要上傳至 Amazon CloudSearch 網域的資料。文件批次是一組新增和刪除操作，各項操作代表了您希望新增、更新或從網域刪除的文件。批次的描述格式可以是 JSON 或 XML。批次提供 Amazon CloudSearch 編製索引所需的所有資訊。您想要以搜尋結果 （例如產品） 傳回的每個項目都會以文件表示，批次只是個別文件的新增和刪除請求集合。每份文件都具有獨一無二的 ID 和一個或多個欄位，其中包含您要搜尋及由結果傳回的資料。

更新文件時，您要指定新增請求並提供您希望更新的該份文件的文件 ID。如需詳細資訊，請參閱[在 Amazon CloudSearch 中新增和更新文件](preparing-data.md#adding-documents)。同樣地，若要刪除文件，您應提交刪除請求並提供您希望刪除的該份文件的文件 ID。如需如何刪除文件的相關資訊，請參閱[在 Amazon CloudSearch 中刪除文件](preparing-data.md#deleting-documents)。

如需如何提交資料以供編製索引的詳細資訊，請參閱[將資料上傳至 Amazon CloudSearch 網域](uploading-data.md)。

## documents/batch JSON API
<a name="documents-batch-json"></a>

### JSON documents/batch 請求
<a name="documents-batch-json-request"></a>

`documents/batch` 請求的內文是使用 JSON 或 XML 指定您要執行的文件操作。批次的 JSON 表示法是一組物件，其定義了個別的新增和刪除操作。`type` 屬性則識別各物件係代表新增還是刪除操作。例如，以下 JSON 批次將新增一份文件並刪除某份文件：

```
[
{ "type": "add",
  "id":   "tt0484562",
  "fields": {
    "title": "The Seeker: The Dark Is Rising",
    "directors": ["Cunningham, David L."],
    "genres": ["Adventure","Drama","Fantasy","Thriller"],
    "actors": ["McShane, Ian","Eccleston, Christopher","Conroy, Frances",
              "Crewson, Wendy","Ludwig, Alexander","Cosmo, James",
              "Warner, Amelia","Hickey, John Benjamin","Piddock, Jim",
              "Lockhart, Emma"]
  }
},
{ "type": "delete",
  "id":   "tt0484575"
}]
```

**注意**  
以 JSON 指定文件批次時，欄位的值不得為 `null`。

批次的 [JSON 結構描述](http://json-schema.org/)表示法如下所示：

```
{
    "type": "array",
    "minItems": 1,
    "items": {
        "type": "object",
        "properties": {
            "type": {
                "type": "string",
                "enum": ["add", "delete"],
                "required": true
            },
            "id": {
                "type": "string",
                "pattern": "[a-z0-9][a-z0-9_]{0,127}",
                "minLength": 1,
                "maxLength": 128,
                "required": true
            },
            "fields": {
                "type": "object",
                "patternProperties": {
                    "[a-zA-Z0-9][a-zA-Z0-9_]{0,63}": {
                        "type": "string",
                    }
                }
            }
        }
    }
}
```

#### documents/batch 請求屬性 (JSON)
<a name="documents-batch-json-properties"></a>


****  

| 屬性 | Description | 必要 | 
| --- | --- | --- | 
| type | 操作類型，add 或 delete。 | 是 | 
| id | 英數字串。允許的字元如下：A-Z (大寫字母)、a-z (小寫字母)、0-9、\$1 (底線)、- (連字號)、/ (正斜線)、\$1 (井字號)、: (冒號)。長度上限為 128 個字元。 | 是 | 
| fields | 一個或多個 field\$1name 屬性的集合，定義了文件所包含的欄位。條件：新增操作的必要項目。需包含至少一個 *field\$1name* 屬性。 | 有條件 | 
| field\$1name | 指定欲新增的文件內某一欄位。欄位名稱必須以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 \$1 (底線)。欄位名稱長度需至少 3 個字元且不得超過 64 個字元。名稱 score 是保留項目，不得做為欄位名稱使用。 若要為某欄位指定多個值，請指定值的陣列而非單一值。例如： `"genre": ["Adventure","Drama","Fantasy","Thriller"]`  條件：fields 物件必須指定至少一個欄位。  | 有條件 | 

### documents/batch 回應 (JSON)
<a name="documents-batch-json-response"></a>

回應內文會列出已執行的新增和刪除數目，以及任何產生的錯誤或警告。

文件服務 API 回應的 JSON 結構描述表示法如下所示：

```
{
    "type": "object",
    "properties": {
        "status": {
            "type": "text",
            "enum": ["success", "error"],
            "required": true
        },
        "adds": {
            "type": "integer",
            "minimum": 0,
            "required": true
        },
        "deletes": {
            "type": "integer",
            "minimum": 0,
            "required": true
        },
        "errors": {
            "type": "array",
            "required": false,
            "items": {
                "type": "object",
                "properties": {
                    "message": {
                        "type": "string",
                        "required": true
                    }
                }
            }
        },
        "warnings": {
            "type": "array",
            "required": false,
            "items": {
                "type": "object",
                "properties": {
                    "message": {
                        "type": "string",
                        "required": true
                    }
                }
            }
        }
    }
}
```

#### documents/batch 回應屬性 (JSON)
<a name="documents-batch-json-response-properties"></a>


****  

| 屬性 | 描述 | 
| --- | --- | 
| status | 結果狀態，可能是 success 或 error。 | 
| adds | 已執行的新增文件操作數目。狀態若是 error 則一律為零。 | 
| deletes | 已執行的刪除文件操作數目。狀態若是 error 則一律為零。如需有關永久刪除文件的資訊，請參閱[在 Amazon CloudSearch 中刪除文件](preparing-data.md#deleting-documents)。 | 
| 錯誤 | 提供有關剖析或驗證錯誤的資訊。若狀態為 error 才會指定。 | 
| warning | 提供有關剖析或驗證期間產生的某項警告的資訊。 | 

# documents/batch XML API
<a name="documents-batch-xml"></a>

## XML documents/batch 請求
<a name="documents-batch-xml-request"></a>

`documents/batch` 請求的內文是以 XML 指定您要執行的文件操作。例如：

```
<batch>
	<add  id="tt0484562">
		<field name="title">The Seeker: The Dark Is Rising</field>
		<field name="director">Cunningham, David L.</field>
		<field name="genre">Adventure</field>
		<field name="genre">Drama</field>
		<field name="genre">Fantasy</field>
		<field name="genre">Thriller</field>
		<field name="actor">McShane, Ian</field>
		<field name="actor">Eccleston, Christopher</field>
		<field name="actor">Conroy, Frances</field>
		<field name="actor">Ludwig, Alexander</field>
		<field name="actor">Crewson, Wendy</field>
		<field name="actor">Warner, Amelia</field>
		<field name="actor">Cosmo, James</field>
		<field name="actor">Hickey, John Benjamin</field>
		<field name="actor">Piddock, Jim</field>
		<field name="actor">Lockhart, Emma</field>
	</add>
	<delete id="tt0301199" />
</batch>
```

### documents/batch 請求元素 (XML)
<a name="documents-batch-xml-request-elements"></a>


****  

| Element | Description | 必要 | 
| --- | --- | --- | 
| 批次 | 您要提交至搜尋網域的一組新增或刪除操作。批次必須包含至少一個 add 或 delete 元素。 | 是 | 
| add | 指定您要新增至搜尋網域的文件。id 屬性是必要項目，且 add 元素必須包含至少一個欄位。屬性： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudsearch/latest/developerguide/documents-batch-xml.html)  | 否 | 
| field | 指定欲新增的文件內某一欄位。name 屬性和欄位值是必要項目。欄位名稱必須以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 \$1 (底線)。名稱 score 是保留項目，不得做為欄位名稱使用。欄位值可以是文字或 CDATA。 若要為某欄位指定多個值，請附上多個同名的 field 元素。例如： <pre><field name="genre">Adventure</field><br /><field name="genre">Drama</field><br /><field name="genre">Fantasy</field><br /><field name="genre">Thriller</field></pre> 限制條件： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudsearch/latest/developerguide/documents-batch-xml.html)  條件：add 元素必須指定至少一個欄位。  | 有條件 | 
| delete | 指定您要從搜尋網域移除的文件。id 屬性是必要項目。delete 元素需為空白。如需有關永久刪除文件的資訊，請參閱[在 Amazon CloudSearch 中刪除文件](preparing-data.md#deleting-documents)。限制條件： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudsearch/latest/developerguide/documents-batch-xml.html)  | 否 | 

## documents/batch 回應 (XML)
<a name="documents-batch-xml-response"></a>

回應內文會列出已執行的新增和刪除數目，以及任何產生的錯誤或警告。

文件服務 API 回應的 RelaxNG 結構描述如下：

```
 start = response

response = element response {
    attribute status { "success" | "error" },
    attribute adds { xsd:integer },
    attribute deletes { xsd:integer },
    element errors {
        element error {
            text
        }+
    }? &
    element warnings {
        element warning {
            text
        }+
    }?
}
```

### documents/batch 回應元素 (XML)
<a name="documents-batch-xml-response-elements"></a>


****  

| Element | Description | 
| --- | --- | 
| result | 包含各元素以列出剖析及驗證請求時產生的錯誤和警告。 屬性： [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/cloudsearch/latest/developerguide/documents-batch-xml.html) 限制：狀態為 `error` 時，results 元素將包含一份錯誤清單。如果狀態是 `success`，results 元素可能包含一份警告清單但無任何錯誤。  | 
| 錯誤 | 包含 error 元素的集合以識別剖析及驗證請求時發生的錯誤。 | 
| error | 提供有關剖析或驗證錯誤的資訊。其值提供該項錯誤的描述。 | 
| warnings | 包含 warning 元素的集合以識別剖析及驗證請求時產生的警告。 | 
| warning | 提供有關剖析或驗證警告的資訊。其值提供該項錯誤的描述。 | 

## documents/batch 狀態碼
<a name="documents-batch-status-codes"></a>

文件服務請求可能傳回以下三類的狀態碼：
+ 5xx 狀態碼表示發生內部伺服器錯誤。建議您截獲並重試所有 5xx 錯誤碼，因為這通常代表暫時性錯誤情況。
+ 4xx 狀態碼表示請求的格式不正確。
+ 2xx 狀態碼表示已成功處理請求。


****  

|  錯誤  |  Description  | HTTP 狀態碼  | 
| --- | --- | --- | 
|  無內容類型  |  遺漏 Content-Type 標頭。 |  400  | 
|  無內容長度  |  遺漏 Content-Length 標頭。 |  411  | 
|  路徑不正確  |  URL 路徑不符合 ''/YYYY-MM-DD/documents/batch''。 |  404  | 
|  HTTP 方法無效  |  HTTP 方法不是 POST。請求必須發佈至 documents/batch。 |  405  | 
|  接受類型無效  |  Accept 標頭指定了 ''application/xml'' 或 ''application/json'' 以外的內容類型。回應只能以 XML 或 JSON 形式傳送。 |  406  | 
|  請求過大  |  請求內文的長度超出允許的上限值。 |  413  | 
|  內容類型無效  |  內容類型並非 "application/json" 或 "application/xml"。 |  415  | 
|  字元集無效  |  字元集並非 ''ASCII''、''ISO-8859-1'' 或 ''UTF-8''。 |  415  | 

## 常見請求標題
<a name="documents-batch-common-request-headers"></a>


****  

| 名稱 | 描述 | 必要 | 
| --- | --- | --- | 
| 內容類型 | 描述物件資料格式的標準 MIME 類型。如需詳細資訊，請參閱 [W3C RFC 2616 第 14 節](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17)。預設：application/json  限制：僅限 application/json 或 application/xml  | 必要 | 
| 內容長度 | 請求內文以位元組為單位的長度。 | 是 | 
| 接受 | 描述回應資料格式的標準 MIME 類型。如需詳細資訊，請參閱 [W3C RFC 2616 第 14 節](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17)。預設：請求的內容類型 限制：僅限 application/json 或 application/xml | 否 | 

## 常見回應標頭
<a name="documents-batch-common-response-headers"></a>


****  

| 名稱 | 描述 | 
| --- | --- | 
| 內容類型 | 描述物件資料格式的標準 MIME 類型。如需詳細資訊，請參閱 [W3C RFC 2616 第 14 節](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17)。預設：請求的 Accept 標頭值，若 Accept 標頭遺漏或未指定 application/xml 或 application/json 則為請求的內容類型。 限制：僅限 application/xml 或 application/json  | 
| 內容長度 | 回應內文以位元組為單位的長度。 | 

# Amazon CloudSearch 的搜尋 API 參考
<a name="search-api"></a>

**Topics**
+ [

## 搜尋
](#search-request)
+ [

## 在 Amazon CloudSearch 中提交建議請求
](#submitting-suggest-requests)
+ [

## 建議
](#suggest)
+ [

## 搜尋服務錯誤
](#search-service-errors)

您可以使用搜尋 API 將搜尋或建議請求提交到您的 Amazon CloudSearch 網域。如需如何進行搜尋的詳細資訊，請參閱[使用 Amazon CloudSearch 搜尋您的資料](searching.md)。如需關於建議的詳細資訊，請參閱[在 Amazon CloudSearch 中取得自動完成建議](getting-suggestions.md)。

您用來與 Amazon CloudSearch 互動的其他 APIs 包括：
+ [組態 API](configuration-api.md) - 設定和管理您的搜尋網域。
+ [文件服務 API](document-service-api.md) - 提交您要搜尋的資料。

## 搜尋
<a name="search-request"></a>

本節說明 search 資源的 HTTP 請求和回應訊息。

### 搜尋語法
<a name="search-syntax"></a>

```
GET /2013-01-01/search
```

### 搜尋請求標頭
<a name="search-request-headers"></a>

HOST  
您所查詢的網域其搜尋請求端點。您可以使用 [DescribeDomains](API_DescribeDomains.md) 擷取網域的搜尋請求端點。  
必要：是

### 搜尋請求參數
<a name="search-request-parameters"></a>

cursor  
擷取可讓您用於翻頁瀏覽大型結果集的游標值。使用 `size` 參數控制您希望納入到每次回應的命中數。請求中可指定 `cursor` 或 `start` 參數，兩者為互斥。如需詳細資訊，請參閱[對結果進行分頁](paginating-results.md)。  
若要取得第一個游標，請於初次請求時指定 `cursor=initial`。在後續的請求中，指定由回應的 hits 區段所傳回的游標值。  
例如，以下請求將游標值設為 `initial` 並將 `size` 參數設為 100 以取得第一組命中項目。回應會隨附下一組命中項目的游標。  

```
search?q=john&cursor=initial&size=100&return=_no_fields
{
   "status": {
      "rid": "+/Xu5s0oHwojC6o=",
      "time-ms": 15
   },
   "hits": {
      "found": 503,
      "start": 0,
      "cursor": "VegKzpYYQW9JSVFFRU1UeWwwZERBd09EUTNPRGM9ZA",
      "hit": [
         {"id": "tt0120601"},
         {"id": "tt1801552"},
         ...
      ]
   }
}
```
若要取得下一組命中項目，則指定游標值以及欲擷取的命中數。  

```
search?q=john&cursor=VegKzpYYQW9JSVFFRU1UeWwwZERBd09EUTNPRGM9ZA&size=100
```
類型：字串  
必要：否

expr.NAME  
定義可用於對結果進行排序的運算式。您也可以指定運算式做為傳回欄位。如需如何定義與使用運算式的詳細資訊，請參閱[設定運算式](configuring-expressions.md)。  
單次搜尋請求可以定義與使用多個運算式。例如，以下請求建立兩個運算式用於對結果進行排序並將其納入搜尋結果：  

```
search?q=(and (term field=genres 'Sci-Fi')(term field=genres 'Comedy'))&q.parser=structured
&expr.expression1=_score*rating
&expr.expression2=(1/rank)*year
&sort=expression1 desc,expression2 desc
&return=title,rating,rank,year,_score,expression1,expression2
```
類型：字串  
必要：否

facet.FIELD   
指定您要取得面向資訊的欄位 -`FIELD` 是欄位的名稱。指定的欄位必須由網域組態啟用面向分類。面向選項是指定成 JSON 物件。如果 JSON 物件是空的 (`facet.FIELD={}`)，則會對所有欄位值計算面向數量，依面向數量將面向排序，並隨結果傳回前 10 名的面向。  
此 JSON 物件可指定三個選項：  
+ `sort` 指定您想要以何種方式將結果中的面向排序：`bucket` 或 `count`。指定 `bucket` 會依面向值按字母順序或數字大小排序 (遞增排序)。指定 `count` 則會依據對每個面向值所計算的面向數量排序 (遞減順序)。若要擷取特定值或特定範圍值的面向數量，請使用 `buckets` 選項代替 `sort`。
+ `buckets` 指定您要計算其數量的面向值或範圍的陣列。各值區將依其在請求中所指定的順序傳回。若要指定值的範圍，請使用逗號 (,) 來區隔上下限，並以括號將範圍括住。方括號 【 或 】 表示邊界包含在範圍中，大括號 \$1 或 \$1 排除邊界。您可以省略上限或下限，以指定開放式範圍。省略邊界時，您必須使用大括弧。如果您指定 ，則 `sort`和 `size`選項無效`buckets`。
+ `size` 指定結果所要包含的面向數量上限。根據預設，Amazon CloudSearch 會傳回前 10 名的計數。`size` 參數僅限於已指定 `sort` 選項時有效；此參數不得搭配 `buckets` 使用。
例如，以下請求取得 `year` 欄位的面向數量、將面向數量依其值排序並傳回前三名的數量：  

```
facet.year={sort:"bucket", size:3}
```
如欲指定您要計算其面向數量的值或值的範圍，請使用 `buckets` 選項。例如，以下請求將計算並傳回每隔十年的面向數量：  

```
facet.year={buckets:["[1970,1979]","[1980,1989]",
             "[1990,1999]","[2000,2009]",
             "[2010,}"]}
```
 您也可以指定個別的值做為值區：  

```
facet.genres={buckets:["Action","Adventure","Sci-Fi"]}
```
請注意，面向值有區分大小寫 - 對於 IMDb 電影範例資料，若您指定 `["action","adventure","sci-fi"]` 而非 `["Action","Adventure","Sci-Fi"]`，則所有面向數量都將為零。  
類型：字串  
必要：否

format  
指定回應的內容類型。  
類型：字串  
有效值：json \$1 xml  
預設：json  
必要：否

fq  
指定結構式查詢以篩選搜尋結果，但不會影響結果的計分和排序方式。您將使用 `fq` 搭配 `q` 參數，根據 `q` 參數所指定的限制條件篩選相符的文件。指定篩選條件只是控制結果將包含哪些相符的文件，並不會影響文件的計分和排序方式。`fq` 參數支援完整的結構式查詢語法。如需如何使用篩選條件的詳細資訊，請參閱[篩選相符文件](filtering-results.md)。如需結構式查詢的詳細資訊，請參閱[結構化搜尋語法](#structured-search-syntax)。  
類型：字串  
必要：否

highlight.FIELD  
擷取指定的 `text` 或 `text-array` 欄位內各個相符項目的反白句。反白選項是指定成 JSON 物件。如果 JSON 物件是空的，傳回的欄位文字即視同 HTML，且第一個相符項目將套用加強語氣標籤以示反白：`<em>search-term</em>`。  
此 JSON 物件可指定四個選項：  
+ `format`- 指定文字欄位中資料的格式： `text`或 `html`。以 HTML 傳回資料時，所有非英數字元都將經過編碼處理。預設值為 `html`。
+ `max_phrases`- 指定您要反白顯示之搜尋詞彙的出現次數上限 (s)。預設會反白第一次出現的位置。
+ `pre_tag`- 指定字串，以在出現搜尋詞彙之前加上。HTML 反白的預設值為 `<em>`。文字反白的預設值為 `*`。
+ `post_tag`- 指定要附加至搜尋詞彙出現的字串。HTML 反白的預設值為 `</em>`。文字反白的預設值為 `*`。
範例: `highlight.plot={}`, `highlight.plot={format:'text',max_phrases:2,pre_tag:'<b>',post_tag:'</b>'}`   
類型：字串  
必要：否

partial  
控制若有一或多個索引分割區無法使用時，是否傳回局部結果。當您的搜尋索引分割到多個搜尋執行個體時，根據預設，Amazon CloudSearch 只會在可查詢每個分割區時傳回結果。這表示任一搜尋執行個體發生故障均有可能導致 5xx (內部伺服器) 錯誤。當您指定 時`partial=true`。Amazon CloudSearch 會傳回任何可用的結果，並包含搜尋結果中搜尋的文件百分比 (`percent-searched`)。這讓您能夠更從容地降解使用者的搜尋體驗。例如，與其顯示沒有任何結果，不如顯示局部結果和一則訊息指出因為系統暫時停機以致結果可能不完整。  
類型：布林值  
預設：False  
必要：否

pretty  
格式化 JSON 輸出以使其更方便閱讀。  
類型：布林值  
預設：False  
必要：否

q   
請求的搜尋條件。您應如何指定搜尋條件，視乎用於請求的查詢剖析器以及 `q.options` 參數所指定的剖析器選項而定。預設情況下將使用 `simple` 查詢剖析器來處理請求。若要使用 `structured`、`lucene` 或 `dismax` 查詢剖析器，您還必須指定 `q.parser` 參數。如需如何指定搜尋條件的詳細資訊，請參閱[使用 Amazon CloudSearch 搜尋您的資料](searching.md)。  
類型：字串  
必要：是

q.options   
針對 `q.parser` 參數所指定的查詢剖析器設定其選項。各選項是指定成 JSON 物件，例如：`q.options={defaultOperator: 'or', fields: ['title^5','description']}`。  
可供設定的選項因您所使用的剖析器類型而異：  
+ `defaultOperator`- 用來合併搜尋字串中個別詞彙的預設運算子。例如：`defaultOperator: 'or'`。對於 `dismax` 剖析器，您應指定百分比而非預設運算子，其代表搜尋字串中必須符合的字詞所佔百分比 (無條件捨去)。值為 `0%` 相當於 OR，值為 `100%` 相當於 AND。百分比指定的值必須在 0-100 的範圍內，後面加上百分比 (%) 符號。例如 `defaultOperator: 50%`。有效值：`and`、`or`、0%-100% 範圍內的百分比 (`dismax`)。預設：`and` (`simple`、`structured`、`lucene`) 或 `100` (`dismax`)。適用於：`simple`、`structured`、`lucene` 和 `dismax`。
+ `fields`- 在搜尋中未指定欄位時要搜尋的欄位陣列。如果搜尋時未指定任何欄位且未指定此選項，則會搜尋所有靜態設定的 `text` 和 `text-array` 欄位。您可以為每個欄位指定權重，以在 Amazon CloudSearch 計算相關性分數時控制每個欄位的相對重要性。若要指定欄位權重，請於欄位名稱後面附加插入號 (`^`) 及其權重。例如，若要提升 `title` 欄位的重要性高過 `description` 欄位，您可以指定：`fields: ['title^5','description']`。有效值：任何設定的欄位其名稱和大於零的選用數值。預設：所有靜態設定的 `text` 和 `text-array` 欄位。預設中，動態欄位和 `literal` 欄位不會進行搜尋。適用於：`simple`、`structured`、`lucene` 和 `dismax`。
+ `operators`- 您想要針對簡單查詢剖析器停用的運算子或特殊字元陣列。若您停用了 `and`、`or` 或 `not` 運算子，其對應的運算子 (`+`、`|`、`-`) 即毫無特殊意義且將從搜尋字串中卸除。同樣地，停用 `prefix` 會停用萬用字元運算子 (`*`)，而停用 `phrase` 將停用由雙引號括住片語的方式進行片語搜尋的能力。停用 precedence 會停用由括號控制優先順序的能力。停用 `near` 會停用由 \$1 運算子進行鬆散片語搜尋的能力。停用 `fuzzy` 運算子將會禁止使用 \$1 運算子來執行模糊搜尋的功能。`escape` 禁止使用反斜線 (`\`) 來運用搜尋字串避開特殊字元。停用 whitespace 屬於進階選項，可防止剖析器將空白字元字符化，對於剖析越南文非常有用 (能避免越南單詞拆解錯誤)。例如，您可以停用 phrase 運算子除外的所有運算子，藉此僅支援簡單的字詞和片語查詢：`operators:['and', 'not', 'or', 'prefix']`。有效值：`and`、`escape`、`fuzzy`、`near`、`not`、`or`、`phrase`、`precedence`、`prefix`、`whitespace`。預設：啟用所有運算子和特殊字元。適用於：`simple`。
+ `phraseFields`- 您要用於片語搜尋的 `text`或 `text-array` 欄位陣列。當搜尋字串中的字詞非常近似於某欄位時，該欄位會得到較高的分數。您可為每個欄位指定權重以提高此分數。`phraseSlop` 選項控制著與搜尋字串的相符度可偏離多少而仍會提高其分數的範圍。若要指定欄位權重，請於欄位名稱後面附加插入號 (`^`) 及其權重。例如，若要提升 `title` 欄位的片語比對份量高過 `abstract` 欄位，您可以指定：`phraseFields:['title^3', 'abstract']`。有效值：任何 `text` 或 `text-array` 欄位的名稱和大於零的選用數值。預設：無任何欄位。如果 `phraseFields` 未指定任何欄位，即使指定了 `phraseSlop` 還是會停用近似性評分。適用於：`dismax`。
+ `phraseSlop`- 整數值，指定多少相符項目可以偏離搜尋片語，但仍會根據 `phraseFields`選項中指定的權重進行提升。例如 `phraseSlop: 2`。您還必須指定 `phraseFields` 以啟用近似性評分。有效值：正整數。預設：0. 適用於：`dismax`。
+ `explicitPhraseSlop`- 整數值，指定當字詞在搜尋字串中以雙引號括住時，相符項目可以偏離搜尋片語的程度。（超過此鄰近距離的片語不視為相符。) `explicitPhraseSlop: 5`。 有效值：正整數。預設：0. 適用於：`dismax`。
+ `tieBreaker`- 在文件的 欄位中找到搜尋字串中的字詞時，會根據該字詞與該文件相比的常見程度，計算該欄位的分數。若該字詞出現於某文件的多個欄位內，預設只會將最高分的欄位計入文件的整體分數。您可以指定 `tieBreaker` 值，使較低分的相符欄位也能計入文件的分數。如此一來，若兩份文件找到特定字詞的欄位最高分數相同，相符欄位愈多的文件其分數就會愈高。tieBreaker 計算分數的公式如下：

  ```
  (max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)
  ```

  例如，以下查詢在 *、* 和 `title` 欄位內搜尋 `description`dog`review` 一詞並將 `tieBreaker` 設為 0.1：

  ```
  q=dog&q.parser=dismax&q.options={fields:['title', 'description', 'review'], tieBreaker: 0.1}
  ```

  如果某文件的上述三個欄位內都有 *dog* 一詞，而各欄位的分數分別是 title=1、description=3 且 review=1，則 dog 的整體分數如下：

  ```
  3 +  0.1 * (1+1) = 3.2
  ```

   `tieBreaker` 設定為 0 將忽略最高分除外的所有欄位 (純最高分)。設定為 1 會加總所有欄位的分數 (純加總)。有效值：0 到 1.0。預設：0.0。適用於：`dismax`。
類型：JSON 物件  
預設：請參閱個別選項的說明。  
必要：否

q.parser   
指定要用於處理請求的查詢剖析器：`simple`、`structured`、`lucene` 和 `dismax`。如果`q.parser`未指定 ，Amazon CloudSearch 會使用`simple`查詢剖析器。  
+ `simple`- 執行 `text`和 `text-array` 欄位的簡單搜尋。預設情況下，`simple` 查詢剖析器會搜尋所有靜態設定的 `text` 和 `text-array` 欄位。您可以使用 `q.options` 參數指定要搜尋哪些欄位。如果您用加號 (\$1) 做為搜尋詞彙的字首，文件即必須包含該詞彙才會視為相符 (預設是如此，除非您透過 `q.options` 參數設定預設運算子)。您可以使用 `-` (NOT)、`|` (OR) 和 `*` (萬用字元) 運算子排除特定字詞、尋找符合任何指定之字詞的結果，或是搜尋字首。若要搜尋片語而非個別字詞，請用雙引號括住整段片語。如需詳細資訊，請參閱[使用 Amazon CloudSearch 搜尋您的資料](searching.md)。
+ `structured`- 透過結合多個表達式來定義搜尋條件來執行進階搜尋。您也可以在特定欄位內搜尋、搜尋值和值的範圍，並使用像是增加詞彙相關度、`matchall` 和 `near` 等進階選項。如需詳細資訊，請參閱[建構複合查詢](searching-compound-queries.md)。
+ `lucene`- 使用 Apache Lucene 查詢剖析器語法進行搜尋。如需詳細資訊，請參閱 [Apache Lucene 查詢剖析器語法](https://cwiki.apache.org/confluence/display/solr/The+Standard+Query+Parser)。
+ `dismax`- 使用 DisMax 查詢剖析器定義的 Apache Lucene 查詢剖析器語法簡化子集進行搜尋。如需詳細資訊，請參閱 [DisMax 查詢剖析器語法](https://cwiki.apache.org/confluence/display/solr/The+DisMax+Query+Parser)。
類型：字串  
預設：`simple`  
必要：否

return   
欲包含在回應中的欄位及運算式值，指定成以逗號分隔的清單。預設情況下，搜尋回應將包含所有啟用傳回的欄位 (`return=_all_fields`)。若只要傳回相符文件的文件 ID，請指定 `return=_no_fields`。若要擷取對每份文件算出的相關性分數，請指定 `return=_score`。您可將多個傳回欄位指定成以逗號分隔的清單。例如，`return=title,_score` 只會傳回片名和每份文件的相關性分數。  
類型：字串  
必要：否

size   
欲傳回的搜尋命中數上限。  
類型：正整數  
預設：10  
必要：否

sort  
用於對搜尋結果進行排序的欄位或自訂運算式以逗號分隔的清單。您必須為每個欄位指定排序方向 (`asc` 或 `desc`)。例如 `sort=year desc,title asc`。最多共可指定 10 個欄位和運算式。若要使用欄位對結果進行排序，該欄位必須由網域組態啟用排序。陣列類型的欄位無法用於排序。若未指定 `sort` 參數，結果將依其預設相關性分數以遞減順序排序：`sort=_score desc`。排序方式也可以依據文件 ID (`sort=_id`) 及版本 (`sort=_version`)。  
類型：字串  
必要：否

start   
欲傳回的第一個搜尋命中項目的位移。請求中可指定 `start` 或 `cursor` 參數，兩者為互斥。如需詳細資訊，請參閱[對結果進行分頁](paginating-results.md)。  
類型：正整數  
預設：0 (第一個命中項目)  
必要：否

#### 結構化搜尋語法
<a name="structured-search-syntax"></a>

您可以使用 Amazon CloudSearch 結構化搜尋語法，在使用`structured`查詢剖析器時定義搜尋條件，並使用 `fq` 參數指定篩選條件。

使用結構式查詢運算子，您將依序指定運算子的名稱和運算子的選項，接著是所要運算的字詞：`(OPERATOR OPTIONS STRING|EXPRESSION)`。務必先指定任何選項再指定字串或運算式。例如 `(and (not field=genres 'Sci-Fi')(or (term field=title boost=2 'star')(term field=plot 'star')))`。

**重要**  
查詢字串中的特殊字元必須以 URL 編碼處理。例如，您必須在結構化查詢中將`=`運算子編碼為 `%3D`：`(term+field%3Dtitle+'star'`)。如果特殊字元不是 URL 編碼，Amazon CloudSearch 會傳回`InvalidQueryString`錯誤。如需 URL 編碼的完整參考內容，請參閱 W3C [HTML URL 編碼參考](http://www.w3schools.com/tags/ref_urlencode.asp)。

使用結構式查詢剖析器時若未指定欲搜尋的欄位，則會搜尋所有靜態設定的 `text` 和 `text-array` 欄位。預設中，動態欄位和 `literal` 欄位*不會*進行搜尋。您可以透過 `q.options` 參數，指定預設將要搜尋哪些欄位。

括號控制著對複合查詢的運算式進行評估的順序。當運算式用括號括住時，會先評估該運算式，接著再使用其結果值評估查詢的剩餘部分。運算式可包含任何結構式查詢運算子。

您也可以使用結構式查詢剖析器搜尋簡單的文字字串，只需用單引號括住您想要搜尋的字串：`q='black swan'&q.parser="structured"`。

如需使用結構式查詢運算子建構複合查詢的詳細資訊，請參閱[建構複合查詢](searching-compound-queries.md)。

FIELD  
語法: `FIELD: 'STRING'|value`  
搜尋指定的欄位以找出字串、數值、日期或是數值或日期的範圍。  
字串必須用單引號括住。字串中的任何單引號或反斜線都必須以反斜線逸出。若要指定值的範圍，請使用逗號 (,) 來區隔上下限，並以括號將範圍括住。方括號 【 或 】 表示邊界包含在範圍中，大括號 \$1 或 \$1 排除邊界。您可以省略上限或下限，以指定開放式範圍。省略邊界時，您必須使用大括弧。  
 日期和時間是根據 [IETF RFC3339](http://tools.ietf.org/html/rfc3339) 以 UTC （國際標準時間） 指定：`yyyy-mm-ddTHH:mm:ss.SSSZ`。例如，在 UTC 中，1970 年 8 月 23 日下午 5：00 是：`1970-08-23T17:00:00Z`。請注意，在 UTC 中指定時間時，您也可以指定小數秒。例如 `1967-01-31T23:20:50.650Z.`   
範例：  

```
title:'star'
year:2000
year:[1998,2000]
year:{,2011]
release_date:['2013-01-01T00:00:00Z',}
```

and  
語法: `(and boost=N EXPRESSION EXPRESSION ... EXPRESSIONn)`  
僅當文件符合所有指定的表達式時才予納入 。 (布林值 `AND` 運算子) 運算式可包含任何結構式查詢運算子，或是簡單的搜尋字串。搜尋字串必須用單引號括住。請注意，若要比對任何搜尋的欄位內包含指定之字詞的文件，則應以個別的運算式指定每個字詞：`(and 'star' 'wars')`。如果您指定 `(and 'star wars')`，*star* 和 *wars* 必須出現於同一個欄位內才會視為相符。  
 提升值是正數值，會增加此部分搜尋查詢相對於其他部分的重要性。  
範例：  

```
(and title:'star' actors:'Harrison Ford' year:{,2000])
```

matchall  
語法: `matchall`   
比對網域內的每一份文件。預設會傳回前 10 項。使用 `size` 和 `start` 參數可翻頁瀏覽結果。

near  
語法: `(near field=FIELD distance=N boost=N 'STRING') `  
搜尋 `text` 或 `text-array` 欄位以找出指定的多字詞字串，並比對其中包含各字詞彼此相隔在指定距離內的文件 （這有時稱為*鬆散*片語搜尋。) 如果您省略 `field`選項，Amazon CloudSearch 預設會搜尋所有靜態設定`text`和`text-array`欄位。預設中，動態欄位和 `literal` 欄位不會進行搜尋。您可以指定 `q.options``fields`選項，以指定預設要搜尋的欄位。  
距離值必須是正整數。例如，若要尋找 * 欄位內 *teenage* 與 *vampire`plot` 相隔 10 個單詞以內的所有文件，則指定距離值為 10：`(near field=plot distance=10 'teenage vampire')`。  
 提升值是正數值，會增加此部分搜尋查詢相對於其他部分的重要性。  
範例：  

```
(near field=plot distance=10 'teenage vampire')
```

not   
語法: `(not boost=N EXPRESSION)`  
若文件符合指定的運算式即予排除 (布林值 `NOT` 運算子)。運算式可包含任何結構式查詢運算子，或是簡單的搜尋字串。搜尋字串必須用單引號括住。  
 提升值是正數值，會增加此部分搜尋查詢相對於其他部分的重要性。  
範例：  

```
(not (or actors:'Harrison Ford' year:{,2010]))
```

or   
語法: `(or boost=N EXPRESSION1 EXPRESSION2 ... EXPRESSIONn)`  
若文件符合任何指定的運算式即予納入 (布林值 `OR` 運算子)。運算式可包含任何結構式查詢運算子，或是簡單的搜尋字串。搜尋字串必須用單引號括住。  
 提升值是正數值，會增加此部分搜尋查詢相對於其他部分的重要性。  
範例：  

```
(or actors:'Alec Guinness' actors:'Harrison Ford' actors:'James Earl Jones')
```

phrase   
語法: `(phrase field=FIELD boost=N 'STRING')`  
搜尋指定片語的 `text`或 `text-array` 欄位。如果您省略 `field`選項，Amazon CloudSearch 預設會搜尋所有靜態設定`text`和`text-array`欄位。預設中，動態欄位和 `literal` 欄位不會進行搜尋。您可以指定 `q.options``fields`選項，以指定預設要搜尋的欄位。  
在結構式查詢中使用 `phrase` 運算子以結合片語搜尋和其他搜尋條件。例如，`q=(and (term field=title 'star') (range field=year {,2000]))` 會比對片名欄位內包含 *star* 且年份值小於或等於 2000 的所有文件。  
 提升值是正數值，會增加此部分搜尋查詢相對於其他部分的重要性。  
範例：  

```
(phrase field=plot 'teenage girl')
```

prefix   
語法: `(prefix field=FIELD boost=N 'STRING')`  
搜尋指定字首的 `text`、`literal`、 `text-array`或 `literal-array` 欄位，後面加上零個或多個字元。如果您省略 `field`選項，Amazon CloudSearch 預設會搜尋所有靜態設定`text`和`text-array`欄位。預設中，動態欄位和 `literal` 欄位不會進行搜尋。您可以指定 `q.options``fields`選項，以指定預設要搜尋的欄位。  
在結構式查詢中使用 `prefix` 運算子以結合字首搜尋和其他搜尋條件。例如，`q=(and (prefix field=title 'sta') (range field=year {,2000]))` 會比對片名欄位內包含字首 *sta* 且年份值小於或等於 2000 的所有文件。  
 提升值是正數值，會增加此部分搜尋查詢相對於其他部分的重要性。  
若要實作搜尋建議，您應設定並查詢建議者，而非進行字首搜尋。如需更多資訊，請參閱[建議請求](#suggest-request)。
範例：  

```
(prefix field=title 'star')
```

range  
語法: `(range field=FIELD boost=N RANGE)`  
搜尋數值欄位 (double、double-array、int、int-array) 或日期欄位 (date、date-array) 以找出落在指定範圍內的值。比對其欄位內至少有一個值落在指定範圍內的文件。務必指定 `field` 選項。  
在結構式查詢中使用 `range` 運算子以結合範圍搜尋和其他搜尋條件。例如，`q=(and (term field=title 'star') (range field=year {,2000]))` 會比對片名欄位內包含 *star* 且年份值小於或等於 2000 的所有文件。  
 若要指定值的範圍，請使用逗號 (,) 來區隔上下限，並以括號將範圍括住。方括號 【 或 】 表示邊界包含在範圍中，大括號 \$1 或 \$1 排除邊界。您可以省略上限或下限，以指定開放式範圍。省略邊界時，您必須使用大括弧。  
 日期和時間是根據 [IETF RFC3339](http://tools.ietf.org/html/rfc3339) 以 UTC （國際標準時間） 指定：`yyyy-mm-ddTHH:mm:ss.SSSZ`。例如，在 UTC 中，1970 年 8 月 23 日下午 5：00 是：`1970-08-23T17:00:00Z`。請注意，在 UTC 中指定時間時，您也可以指定小數秒。例如 `1967-01-31T23:20:50.650Z.`   
 提升值是正數值，會增加此部分搜尋查詢相對於其他部分的重要性。  
範例：  

```
(range field=year [1990,2000])
(range field=year {,2000])
(range field=year [1990,})
```

term  
語法: `(term field=FIELD boost=N 'STRING'|VALUE) `  
搜尋指定的欄位以找出某字串、數值或日期。搜尋值時，必須指定 `field`選項。如果您省略 `field`選項，Amazon CloudSearch 預設會搜尋所有靜態設定`text`和`text-array`欄位。預設中，動態欄位和 `literal` 欄位不會進行搜尋。您可以指定 `q.options``fields`選項，以指定預設要搜尋的欄位。  
在結構式查詢中使用 `term` 運算子以結合字詞搜尋和其他搜尋條件。例如，`q=(and (term field=title 'star') (range field=year {,2000]))` 會比對片名欄位內包含 *star* 且年份值小於或等於 2000 的所有文件。  
字串和日期必須用單引號括住。字串中的任何單引號或反斜線都必須用反斜線逸出。  
 日期和時間是根據 [IETF RFC3339](http://tools.ietf.org/html/rfc3339) 以 UTC （國際標準時間） 指定：`yyyy-mm-ddTHH:mm:ss.SSSZ`。例如，在 UTC 中，1970 年 8 月 23 日下午 5：00 是：`1970-08-23T17:00:00Z`。請注意，在 UTC 中指定時間時，您也可以指定小數秒。例如 `1967-01-31T23:20:50.650Z.`   
 提升值是正數值，會增加此部分搜尋查詢相對於其他部分的重要性。  
範例：  

```
(term field=title 'star')
(term field=year 2000)
```

#### 簡易搜尋語法
<a name="simple-search-syntax"></a>

使用`simple`查詢剖析器時，您可以使用 Amazon CloudSearch 簡單搜尋語法來定義搜尋條件。若您並未指定 `q.parser` 參數，預設即會使用 simple 查詢剖析器。

使用 simple 查詢剖析器可搜尋個別字詞或片語。預設會搜尋所有靜態設定的 `text` 和 `text-array` 欄位。預設中，動態欄位和 `literal` 欄位*不會*進行搜尋。您可以使用 `q.options` 參數指定欲搜尋的欄位、變更用於結合搜尋字串中個別字詞的預設運算子，或是停用任何 simple 剖析器運算子 (`and`、`escape`、`fuzzy`、`near`、`not`、`or`、`phrase`、`precedence`、`prefix`、`whitespace`)。

如需使用 simple 查詢剖析器的詳細資訊，請參閱[在 Amazon CloudSearch 中搜尋文字](searching-text.md)。

\$1 (and)  
語法: `+TERM`  
需要指定的字詞。文件必須包含指定的字詞才算符合條件。  
範例：\$1star

\$1 (escape)  
語法: `\CHAR`  
逸出欲搜尋的特殊字元。若您希望查詢列入以下字元，即必須將其逸出：\$1 - & \$1 \$1 ( ) \$1 \$1 [ ] ^ " \$1 \$1 ? : \$1 /.  
範例：`M\*A\*S\*H`

\$1 (fuzzy)  
語法: `TERM~N`  
進行模糊搜尋。於字詞後面附加 \$1 運算子和一個值，以表示容許各字詞差別到什麼程度下仍會視為相符。  
範例：`stor~1`

\$1 (near)  
語法: `"PHRASE"~N`  
進行鬆散片語搜尋。於片語後面附加 \$1 運算子和一個值，以表示各字詞在相隔多遠的情況下仍會視為與該片語相符。  
範例：`"star wars"~4`

- (not)  
語法: `-TERM`  
禁止指定的字詞。文件必須不含該字詞才算符合條件。  
範例：star -wars

\$1 (or)  
語法: `|TERM`  
將指定的字詞視為選擇性。  
範例：star \$1wars

"..." (phrase)  
語法: `"PHRASE"`  
進行整段片語搜尋。可結合 `~` 運算子以進行鬆散片語搜尋。  
範例："star wars"

(...) (precedence)  
語法: `(...)`  
控制對查詢限制條件進行評估的順序。最內側括號的內容最先評估。  
範例：`+(war|trek)+star`

\$1 (prefix)  
語法: `CHARS*`  
比對其所包含的字詞具有指定之字首的文件。  
範例：`sta*`

### 搜尋回應
<a name="search-response"></a>

成功完成請求後，回應內文將包含搜尋結果。預設會以 JSON 格式傳回搜尋結果。如果 `format` 參數設為 `xml`，則會以 XML 傳回搜尋結果。

除非您明確指定 `return` 參數，否則將附上每份相符文件 (命中項目) 的文件 ID 及所有可傳回的欄位。回應也會顯示找到的命中總數 (`found`) 以及所列第一份文件的索引 (`start`)。預設情況下，回應會包含前 10 個命中項目。您可在請求中指定 `size` 參數，以控制每次回應所要納入的命中數。若要翻頁瀏覽命中項目，您可以使用 `start` 或 `cursor` 參數。如需詳細資訊，請參閱[對結果進行分頁](paginating-results.md)。

典型的 JSON 回應如以下範例所示。

```
{
    "status": {
        "rid": "rtKz7rkoeAojlvk=",
        "time-ms": 10
    },
    "hits": {
        "found": 3,
        "start": 0,
        "hit": [
            {
                "id": "tt1142977",
                "fields": {
                    "rating": "6.9",
                    "genres": [
                        "Animation",
                        "Comedy",
                        "Family",
                        "Horror",
                        "Sci-Fi"
                    ],
                    "plot": "Young Victor conducts a science experiment to  
                             bring his beloved dog Sparky back to life, only
                              to face unintended, sometimes monstrous, 
                              consequences.",
                    "release_date": "2012-09-20T00:00:00Z",
                    "title": "Frankenweenie",
                    "rank": "1462",
                    "running_time_secs": "5220",
                    "directors": [
                        "Tim Burton"
                    ],
                    "image_url": "http://ia.media-imdb.com/images/M/MV5BMjIx
                                  ODY3MjEwNV5BMl5BanBnXkFtZTcwOTMzNjc4Nw@@._
                                  V1_SX400_.jpg",
                    "year": "2012",
                    "actors": [
                        "Winona Ryder",
                        "Catherine O'Hara",
                        "Martin Short"
                    ]
                }
            },
			.
			.
			.
        ]			
    }
}
```

對等的 XML 回應如以下範例所示。

```
<results>
    <status rid="itzL7rkoeQojlvk=" time-ms="34"/>
    <hits found="3" start="0">
        <hit id="tt1142977">
            <field name="rating">6.9</field>
            <field name="genres">Animation</field>
            <field name="genres">Comedy</field>
            <field name="genres">Family</field>
            <field name="genres">Horror</field>
            <field name="genres">Sci-Fi</field>
            <field name="plot">Young Victor conducts a science experiment to
                               bring his beloved dog Sparky back to life, only
                               to face unintended, sometimes monstrous, 
                               consequences.
            </field>
            <field name="release_date">2012-09-20T00:00:00Z</field>
            <field name="title">Frankenweenie</field>
            <field name="rank">1462</field>
            <field name="running_time_secs">5220</field>
            <field name="directors">Tim Burton</field>
            <field name="image_url">http://ia.media-imdb.com/images/M/MV5BMjI
                                    xODY3MjEwNV5BMl5BanBnXkFtZTcwOTMzNjc4Nw@@.
                                    _V1_SX400_.jpg
            </field>
            <field name="year">2012</field>
            <field name="actors">Winona Ryder</field>
            <field name="actors">Catherine O'Hara</field>
            <field name="actors">Martin Short</field>
        </hit>
        .
        .
        .
    </hits>
</results>
```

 回應格式的設定僅會影響到對於成功請求的回應。錯誤回應的格式取決於錯誤的源頭。搜尋服務傳回的錯誤一律會以 JSON 傳回。由於伺服器逾時和其他請求路由問題而導致的 5xx 錯誤會以 XML 傳回。當請求傳回錯誤代碼時，回應的內文會包含所發生錯誤的相關資訊。如果在剖析和驗證請求內文時發生錯誤，錯誤碼會設為 400，回應內文會包含錯誤清單及其發生位置。

#### 搜尋回應標頭
<a name="search-response-headers"></a>

Content-Type  
描述物件資料格式的標準 MIME 類型。如需詳細資訊，請參閱 [W3C RFC 2616 第 14 節](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17)。  
有效值：application/json 或 application/xml   
預設：application/json 

Content-Length  
回應內文以位元組為單位的長度。

#### 搜尋回應屬性 (JSON)
<a name="search-response-elements-json"></a>

status  
包含資源 id (rid) 以及處理請求所花費的時間 (time-ms)。    
rid  
經過加密的資源 ID。  
time-ms  
處理搜尋請求所花費的時間 (毫秒)。

hits  
包含符合的文件份數 (`found`)、回應所附第一份文件的索引 (`start`) 以及列出每個命中項目的文件 ID 和資料的陣列 (`hit`)。    
found  
Amazon CloudSearch 完成處理請求後，符合搜尋請求的命中總數。  
start  
此次回應所傳回第一個命中項目的索引。  
hit  
列出每個命中項目的文件 ID 和資料的陣列。    
id  
文件的唯一識別符。  
fields  
傳回的欄位清單。  
facets  
包含面向資訊和面向數量。  
FACETFIELD  
面向經過計算的欄位。  
buckets  
計算出的面向值與數量的陣列。  
value  
列入計數的面向值。  
count  
`FACETFIELD` 包含面向值的命中數。

#### 搜尋回應元素 (XML)
<a name="search-response-elements-xml"></a>

results  
包含搜尋結果。處理請求時發生的任何錯誤將以訊息的形式由 info 元素傳回。    
status  
包含資源 id (`rid`) 以及處理請求所花費的時間 (`time-ms`)。  
hits  
包含命中統計資料和一組 hit 元素。找到的屬性是 Amazon CloudSearch 完成處理結果後符合搜尋請求的命中總數。包含的 hit 元素將依其相關性分數或搜尋請求所指定的 `sort` 選項進行排序。    
hit  
符合搜尋請求的文件。id 屬性是該份文件獨一無二的 id。包含 `d` (資料) 元素，代表傳回的各個欄位。    
field  
從命中項目傳回的欄位。hit 元素包含 `d` (資料) 元素，代表傳回的各個欄位。  
facets  
包含 facet 元素，代表搜尋請求所請求的各個面向。    
facet  
包含 bucket 元素，代表已計算面向數量的某欄位的各個值。使用 `facet.FIELD` 的 size 選項可指定欲傳回的限制條件數。預設情況下會傳回前 10 項限制條件的面向數量。使用 `facet.FIELD` 的 buckets 選項可明確指定欲列入計數的值。    
bucket  
面向欄位值以及該值在搜尋命中項目內出現的次數 (計數)。

## 在 Amazon CloudSearch 中提交建議請求
<a name="submitting-suggest-requests"></a>

您將透過 HTTP GET 向您網域的搜尋端點 `2013-01-01/suggest` 提交建議請求。如需如何控制建議服務存取權的相關資訊，請參閱[設定 Amazon CloudSearch 的存取](configuring-access.md)。

所有建議請求皆必須指定 API 版本，且該版本必須與網域建立時所指定的 API 版本相符。

例如，以下請求使用名為 `title` 的建議者，向 `search-movies-rr2f34ofg56xneuemujamut52i.us-east-1.cloudsearch.amazonaws.com` 網域取得對查詢字串 `oce` 的建議。

```
http://search-imdb-hd6ebyouhw2lczkueyuqksnuzu.us-west-2.cloudsearch.amazonaws.com/2013-01-01/suggest -d"q=oce&suggester=suggest_title"
```

您可以使用任何您想將 GET 請求傳送至網域搜尋端點的方法，直接在 Web 瀏覽器中輸入請求 URL、使用 cURL 提交請求，或使用您偏好的 HTTP 程式庫產生 HTTP 呼叫。您也可以在 Amazon CloudSearch 主控台中使用 Search Tester 來取得建議。如需詳細資訊，請參閱[使用搜尋測試器進行搜尋](getting-started-search.md#searching-console)。

**重要**  
網域的文件和搜尋端點在網域生命週期當中會保持不變。應當對端點進行快取處理，而非在每次上傳或搜尋請求之前擷取端點。在每次請求可能導致您的請求受到調節`DescribeDomains`之前，透過呼叫 `aws cloudsearch describe-domains`或 查詢 Amazon CloudSearch 組態服務。

根據預設，Amazon CloudSearch 會以 JSON 傳回回應。您可藉由指定 `format` 參數 `format=xml` 取得 XML 格式的結果。回應格式的設定僅會影響到對於成功請求的回應。錯誤回應的格式取決於錯誤的源頭。搜尋服務傳回的錯誤一律會以 JSON 傳回。由於伺服器逾時和其他請求路由問題而導致的 5xx 錯誤會以 XML 傳回。

## 建議
<a name="suggest"></a>

### 建議請求
<a name="suggest-request"></a>

#### 在 Amazon CloudSearch 中建議語法
<a name="suggest-syntax"></a>

```
GET /2013-01-01/suggest
```

#### 建議 Amazon CloudSearch 中的請求標頭
<a name="suggest-request-headers"></a>

HOST  
您所查詢的網域其搜尋請求端點。您可以使用 [DescribeDomains](API_DescribeDomains.md) 擷取網域的搜尋請求端點。  
必要：是

#### 在 Amazon CloudSearch 中建議請求參數
<a name="suggest-request-parameters"></a>

q  
您要取得其建議的字串。  
類型：字串  
必要：是

suggester  
用於尋找所建議相符項目的建議者的名稱。  
類型：字串  
必要：是

size   
欲傳回的建議數目上限。  
類型：正整數  
預設：10  
必要：否

format  
指定回應的內容類型。  
類型：字串  
有效值：json \$1 xml  
預設：json  
必要：否

### 建議回應
<a name="suggest-response"></a>

成功完成請求後，回應內文將包含建議項目。預設會以 JSON 格式傳回建議。將 `format` 參數設為 `xml` 可取得 XML 格式的結果。

 回應格式的設定僅會影響到對於成功請求的回應。錯誤回應的格式取決於錯誤的源頭。搜尋服務傳回的錯誤一律會以 JSON 傳回。由於伺服器逾時和其他請求路由問題而導致的 5xx 錯誤會以 XML 傳回。當請求傳回錯誤代碼時，回應的內文會包含所發生錯誤的相關資訊。如果在剖析和驗證請求內文時發生錯誤，錯誤碼會設為 400，回應內文會包含錯誤清單及其發生位置。

對建議請求發出的 JSON 回應如以下範例所示：

```
{
   "status": {
      "rid": "qOSM5s0oCwr8pVk=",
      "time-ms": 2
   },
   "suggest": {
      "query": "oce",
      "found": 3,
      "suggestions": [
         {
          "suggestion": "Ocean's Eleven",
           "score": 0,
           "id": "tt0054135"
         },
         {
          "suggestion": "Ocean's Thirteen",
          "score": 0,
          "id": "tt0496806"
         },
         {
          "suggestion": "Ocean's Twelve",
          "score": 0,
          "id": "tt0349903"
         }
      ]
   }
}
```

對等的 XML 回應如以下範例所示：

```
<results>
   <status rid="/pSz580oDQr8pVk=" time-ms="2"/>
   <suggest query="oce" found="3">
      <suggestions>
         <item suggestion="Ocean's Eleven" score="0" id="tt0054135"/>
         <item suggestion="Ocean's Thirteen" score="0" id="tt0496806"/>
         <item suggestion="Ocean's Twelve" score="0" id="tt0349903"/>
      </suggestions>
   </suggest>
</results>
```

## 搜尋服務錯誤
<a name="search-service-errors"></a>

搜尋或建議請求可能傳回以下三類的狀態碼：
+ 5xx 狀態碼表示發生內部伺服器錯誤。您應截獲並重試所有 5xx 錯誤碼，因為這通常代表暫時性錯誤情況。如需詳細資訊，請參閱[處理錯誤](error-handling.md)。
+ 4xx 狀態碼表示請求的格式不正確。請更正錯誤後再重新提交您的請求。
+ 2xx 狀態碼表示已成功處理請求。

錯誤回應的格式取決於錯誤的源頭。搜尋服務傳回的錯誤一律會以 JSON 傳回。由於伺服器逾時和其他請求路由問題而導致的 5xx 錯誤會以 XML 傳回。

搜尋服務傳回的錯誤包含以下資訊：

error  
包含由搜尋服務所傳回的錯誤訊息。每項錯誤均附有 `code` 和 `msg` 屬性。

code  
錯誤代碼。

msg  
由搜尋服務所傳回的錯誤的描述。