

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# アクション
<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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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 です。  
 必須: はい 

 **Expression**   
検索時に評価できる名前付きの式。検索結果をソートしたり、他の式を定義したり、検索結果内に計算後の情報を返したりするために使用できます。  
型: [式](API_Expression.md)   
 必須: はい 

## レスポンス要素
<a name="API_DefineExpression_ResponseElements"></a>

 以下の要素が `DefineExpressionResult` という名前の構造体で返されます。

 **Expression**   
`Expression` の値および現在のステータス。  
型: [ExpressionStatus](API_ExpressionStatus.md) 

## エラー
<a name="API_DefineExpression_Errors"></a>

 すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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 です。  
 必須: はい 

 **サジェスタ**   
検索サジェスタの設定情報。各サジェスタは一意の名前を持ち、候補として使用するテキストフィールドを指定します。サジェスタには、`FuzzyMatching` オプションと `SortExpression` オプションを設定できます。  
型: [サジェスタ](API_Suggester.md)   
 必須: はい 

## レスポンス要素
<a name="API_DefineSuggester_ResponseElements"></a>

 以下の要素が `DefineSuggesterResult` という名前の構造体で返されます。

 **サジェスタ**   
`Suggester` の値および現在のステータス。  
型: [SuggesterStatus](API_SuggesterStatus.md) 

## エラー
<a name="API_DefineSuggester_Errors"></a>

 すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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` という名前の構造体で返されます。

 **Expression**   
削除中の式のステータス。  
型: [ExpressionStatus](API_ExpressionStatus.md) 

## エラー
<a name="API_DeleteExpression_Errors"></a>

 すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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` という名前の構造体で返されます。

 **サジェスタ**   
削除中のサジェスタのステータス。  
型: [SuggesterStatus](API_SuggesterStatus.md) 

## エラー
<a name="API_DeleteSuggester_Errors"></a>

 すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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   
 必須: いいえ 

 **Deployed**   
デプロイされた設定を表示するか (`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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **Deployed**   
デプロイされた設定を表示するか (`true`)、または任意の保留中の変更を含めるか (`false`)。デフォルトは `false` です。  
タイプ: ブール値  
 必須: いいえ 

 **DomainName**   
説明するドメインの名前。  
タイプ: 文字列  
 長さの制限: 最小長は 3 です。最大長は 28 です。  
 必須: はい 

## レスポンス要素
<a name="API_DescribeAvailabilityOptions_ResponseElements"></a>

 以下の要素が `DescribeAvailabilityOptionsResult` という名前の構造体で返されます。

 **AvailabilityOptions**   
ドメインに設定された可用性オプション。ドメインでマルチ AZ が有効であるかどうかを示します。  
型: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md) 

## エラー
<a name="API_DescribeAvailabilityOptions_Errors"></a>

 すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **DisabledOperation**   
有効になっていないオペレーションを試行したため、リクエストは却下されました。  
 HTTP ステータスコード: 409

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **Deployed**   
デプロイされた設定を表示するか (`true`)、または任意の保留中の変更を含めるか (`false`)。デフォルトは `false` です。  
タイプ: ブール値  
 必須: いいえ 

 **DomainName**   
説明するドメインの名前。  
タイプ: 文字列  
 長さの制限: 最小長は 3 です。最大長は 28 です。  
 必須: はい 

 **ExpressionNames.member.N**   
` DescribeExpressions ` のレスポンスを指定された式に制限します。指定しない場合、すべての式が表示されます。  
型: 文字列のリスト   
 長さの制限: 最小長は 1 です。最大長 64   
 必須: いいえ 

## レスポンス要素
<a name="API_DescribeExpressions_ResponseElements"></a>

 以下の要素が `DescribeExpressionsResult` という名前の構造体で返されます。

 **式**   
ドメインに設定された式。  
タイプ: [ExpressionStatus](API_ExpressionStatus.md) リスト 

## エラー
<a name="API_DescribeExpressions_Errors"></a>

 すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **Deployed**   
デプロイされた設定を表示するか (`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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。  
 HTTP ステータスコード: 500

 **ResourceNotFound**   
リクエストは、存在しないリソースを参照しようとしたため拒否されました。  
 HTTP ステータスコード: 409

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

## 説明
<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**  
ドメイン名を表す文字列。  
タイプ: 文字列  
必須: はい

**deployed**  
最新の設定 (`Processing` 状態にある可能性があります) を取得するか、現在のアクティブな設定 (`?deployed=true`) を取得するか。  
タイプ: ブール値  
必須: いいえ

## レスポンス要素
<a name="API_DescribeDomainEndpointOptions_ResponseElements"></a>

**DomainEndpointOptions**  
検索ドメインのエンドポイントオプションのステータスと設定。  
型: [DomainEndpointOptionsStatus](API_DomainEndpointOptionsStatus.md) 

## エラー
<a name="API_DescribeDomainEndpointOptions_Errors"></a>

すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

**基本**  
リクエストの処理中にエラーが発生しました。  
HTTP ステータスコード: 400

**内部**  
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **Deployed**   
デプロイされた設定を表示するか (`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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **Deployed**   
デプロイされた設定を表示するか (`true`)、または任意の保留中の変更を含めるか (`false`)。デフォルトは `false` です。  
タイプ: ブール値  
 必須: いいえ 

 **DomainName**   
説明するドメインの名前。  
タイプ: 文字列  
 長さの制限: 最小長は 3 です。最大長は 28 です。  
 必須: はい 

 **SuggesterNames.member.N**   
説明する必要があるサジェスタ。  
型: 文字列のリスト   
 長さの制限: 最小長は 1 です。最大長 64   
 必須: いいえ 

## レスポンス要素
<a name="API_DescribeSuggesters_ResponseElements"></a>

 以下の要素が `DescribeSuggestersResult` という名前の構造体で返されます。

 **サジェスタ**   
リクエストで指定されたドメインに設定されているサジェスタ。  
タイプ: [SuggesterStatus](API_SuggesterStatus.md) リスト 

## エラー
<a name="API_DescribeSuggesters_Errors"></a>

 すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

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

## 説明
<a name="API_UpdateAvailabilityOptions_Description"></a>

ドメインの可用性オプションを設定します。マルチ AZ オプションを有効にすると、Amazon CloudSearch ドメインが同じリージョンの追加のアベイラビリティーゾーンに展開され、サービス障害時の耐障害性が強化されます。マルチ AZ オプションの変更が反映されるまで、約 30 分かかります。詳細については、*「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 です。  
 必須: はい 

 **マルチ AZ**   
既存の検索ドメインを 2 番目のアベイラビリティゾーンに展開するには、マルチ AZ オプションを true に設定します。同様に、マルチ AZ オプションを `false` に設定することにより、マルチ AZ 機能をオフにして、単一のアベイラビリティーゾーンにドメインをダウングレードすることができます。  
型: ブール値  
 必須: はい 

## レスポンス要素
<a name="API_UpdateAvailabilityOptions_ResponseElements"></a>

 以下の要素が `UpdateAvailabilityOptionsResult` という名前の構造体で返されます。

 **AvailabilityOptions**   
新しく設定した可用性オプション。ドメインでマルチ AZ が有効であるかどうかを示します。  
型: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md) 

## エラー
<a name="API_UpdateAvailabilityOptions_Errors"></a>

 すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **DisabledOperation**   
有効になっていないオペレーションを試行したため、リクエストは却下されました。  
 HTTP ステータスコード: 409

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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 ではただし、必要なインスタンスタイプとレプリケーションの数ではなく、データとトラフィックのボリュームに基づいて、ドメインが自動的にスケーリングされます。マルチ AZ オプションを有効にした場合、これらの値によりアベイラビリティーゾーンごとに使用されるリソースが決まります。詳細については、*「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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。  
 HTTP ステータスコード: 500

 **InvalidType**   
リクエストは、無効な型定義を指定したため拒否されました。  
 HTTP ステータスコード: 409

 **LimitExceeded**   
リクエストは、既にリソースの制限に到達したため拒否されました。  
 HTTP ステータスコード: 409

 **ResourceNotFound**   
リクエストは、存在しないリソースを参照しようとしたため拒否されました。  
 HTTP ステータスコード: 409

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

## 説明
<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)」を参照してください。

**基本**  
リクエストの処理中にエラーが発生しました。  
HTTP ステータスコード: 400

**内部**  
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](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)」を参照してください。

 **基本**   
リクエストの処理中にエラーが発生しました。  
 HTTP ステータスコード: 400

 **内部**   
リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。  
 HTTP ステータスコード: 500

 **InvalidType**   
リクエストは、無効な型定義を指定したため拒否されました。  
 HTTP ステータスコード: 409

 **LimitExceeded**   
リクエストは、既にリソースの制限に到達したため拒否されました。  
 HTTP ステータスコード: 409

 **ResourceNotFound**   
リクエストは、存在しないリソースを参照しようとしたため拒否されました。  
 HTTP ステータスコード: 409