翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # Amazon CloudSearch の設定 API リファレンス Amazon CloudSearch 設定 API を使用して、検索ドメインを作成、設定、管理します。検索ドメインの設定方法の詳細については、「[検索ドメインの作成と管理](creating-managing-domains.md)」を参照してください。 Amazon CloudSearch を操作するために使用するその他の API は次のとおりです。 + [ドキュメントサービス 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 で設定リクエストを送信 **重要** 設定リクエストを送信する最も簡単な方法は、Amazon CloudSearch コンソール、Amazon CloudSearch コマンドラインツール、または AWS SDK for Java、JavaScript、.NET、PHP、Ruby、Python (Boto) を使用することです。コマンドラインツールおよび SDK は、ユーザーの代わりに署名プロセスを処理し、Amazon CloudSearch 設定リクエストが適切な形式で作成されるようにします。AWS SDK の詳細については、「[AWS Software Development Kits (SDK)](https://aws.amazon.com/code)」を参照してください。 ユーザーは、AWS クエリプロトコルを使用して Amazon CloudSearch 設定リクエストを リージョンの Amazon CloudSearch エンドポイントに送信します。現在サポートされているリージョンとエンドポイントのリストについては、「[リージョンとエンドポイント](https://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region)」を参照してください。 AWS クエリリクエストは、HTTP GET または POST 経由でアクションというクエリパラメータを使って送信される HTTP または HTTPS リクエストです。すべての設定リクエストで API バージョンを指定する必要があり、そのバージョンはドメインを作成したときに指定されたバージョンと一致している必要があります。 すべてのリクエストに認可パラメータとデジタル署名を含める必要があります。​ Amazon CloudSearch は、AWS 署名バージョン 4 をサポートします。署名の詳細な手順については、AWS 全般リファレンスの「[署名 V4 の署名処理](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)」を参照してください。 **注記** Amazon CloudSearch は構成サービスに対する過剰なリクエストを調整します。スロットリングは*アクションによって*発生するため、過剰な `DescribeDomains` リクエストによって Amazon CloudSearch が`DescribeIndexFields`リクエストを調整することはありません。リクエストの制限はサービスのニーズによって変わりますが、1 時間当たりの各アクションに対する多数の呼び出しを許可します。 ## 設定リクエストの構造 このリファレンスはブラウザで直接使用できる URL として Amazon CloudSearch 設定リクエストを示しています。(GET リクエストは URL として示されますが、パラメータ値は読みやすくするためにエンコードされていない状態で表示されています。 リクエストを送信するときは、パラメータ値を URL エンコードする必要があることに注意してください)。URL は次の 3 つの部分を含みます: + エンドポイント — 処理対象のウェブサービスエントリポイント、`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 ``` ## リクエストの署名認証について 設定 API に送信されたリクエストは、AWS アクセスキーを使用して認証されます。すべてのリクエストに認可パラメータとデジタル署名を含める必要があります。​ Amazon CloudSearch は、AWS 署名バージョン 4 をサポートします。署名の詳細な手順については、AWS 全般リファレンスの「[署名 V4 の署名処理](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)」を参照してください。 **注記** 独自の AWS リクエストに対する署名を始めたばかりの場合は、SDK がどのように署名機能を実装しているか確認してみてください。AWS SDK のほとんどのソースは [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 ``` # アクション 以下のアクションがサポートされています: + [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 ## 説明 検索候補インデックスを作成します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[サジェスタの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `BuildSuggestersResult` という名前の構造体で返されます。 **FieldNames** フィールド名のリストです。 型: 文字列のリスト 長さの制限: 最小長は 1 です。最大長 64 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # CreateDomain ## 説明 新しい検索ドメインを作成します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[検索ドメインのアクセスの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** 作成しているドメインの名前。使用できる文字は、a～z (小文字)、0～9、ハイフン (-) です。ドメイン名は、3 文字以上、28 文字以内で、先頭は英字または数字にする必要があります。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `CreateDomainResult` という名前の構造体で返されます。 **DomainStatus** 検索ドメインの現在のステータス。 型: [DomainStatus](API_DomainStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **LimitExceeded** リクエストは、既にリソースの制限に到達したため拒否されました。 HTTP ステータスコード: 409 # DefineAnalysisScheme ## 説明 `text` または `text-array` のフィールドに適用可能な分析スキームを設定し、言語固有のテキスト処理オプションを定義します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[分析スキームの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **AnalysisScheme** 分析スキームの設定情報。各分析スキームに一意の名前があり、処理するテキストの言語を指定します。分析スキームには、`Synonyms`、`Stopwords`、`StemmingDictionary`、`JapaneseTokenizationDictionary` および `AlgorithmicStemming` の各オプションを設定できます。 型: [AnalysisScheme](API_AnalysisScheme.md) 必須: はい **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `DefineAnalysisSchemeResult` という名前の構造体で返されます。 **AnalysisScheme** `AnalysisScheme` のステータスと設定。 型: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **InvalidType** リクエストは、無効な型定義を指定したため拒否されました。 HTTP ステータスコード: 409 **LimitExceeded** リクエストは、既にリソースの制限に到達したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DefineExpression ## 説明 検索ドメインの ` Expression ` を設定します。新しい式を作成したり、既存の式を変更するために使用されます。式が存在する場合は、新しい設定によって古い設定が置き換えられます。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[式の設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **Expression** 検索時に評価できる名前付きの式。検索結果をソートしたり、他の式を定義したり、検索結果内に計算後の情報を返したりするために使用できます。 型: [式](API_Expression.md) 必須: はい ## レスポンス要素 以下の要素が `DefineExpressionResult` という名前の構造体で返されます。 **Expression** `Expression` の値および現在のステータス。 型: [ExpressionStatus](API_ExpressionStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **InvalidType** リクエストは、無効な型定義を指定したため拒否されました。 HTTP ステータスコード: 409 **LimitExceeded** リクエストは、既にリソースの制限に到達したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DefineIndexField ## 説明 検索ドメインの ` IndexField ` を設定します。新しいフィールドを作成したり、既存の式を変更するために使用されます。設定するドメインの名前とインデックスフィールド設定を指定する必要があります。インデックスフィールド設定は、フィールドに対して設定する一意の名前、インデックスフィールドタイプ、およびオプションを指定します。指定できるオプションは ` IndexFieldType ` によって異なります。フィールドが存在する場合は、新しい設定によって古い設定が置き換えられます。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[インデックスフィールドの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **IndexField** 設定するインデックスフィールドとフィールドオプション。 型: [IndexField](API_IndexField.md) 必須: はい ## レスポンス要素 以下の要素が `DefineIndexFieldResult` という名前の構造体で返されます。 **IndexField** `IndexField` の値および現在のステータス。 型: [IndexFieldStatus](API_IndexFieldStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **InvalidType** リクエストは、無効な型定義を指定したため拒否されました。 HTTP ステータスコード: 409 **LimitExceeded** リクエストは、既にリソースの制限に到達したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DefineSuggester ## 説明 ドメインのサジェスタを設定します。サジェスタによって、ユーザーがクエリの入力を完了する前に、一致する可能性のある候補を表示できます。サジェスタを設定するには、一致候補を検索するテキストフィールドの名前と、サジェスタの一意の名前を指定する必要があります。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[検索候補の入手](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **サジェスタ** 検索サジェスタの設定情報。各サジェスタは一意の名前を持ち、候補として使用するテキストフィールドを指定します。サジェスタには、`FuzzyMatching` オプションと `SortExpression` オプションを設定できます。 型: [サジェスタ](API_Suggester.md) 必須: はい ## レスポンス要素 以下の要素が `DefineSuggesterResult` という名前の構造体で返されます。 **サジェスタ** `Suggester` の値および現在のステータス。 型: [SuggesterStatus](API_SuggesterStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **InvalidType** リクエストは、無効な型定義を指定したため拒否されました。 HTTP ステータスコード: 409 **LimitExceeded** リクエストは、既にリソースの制限に到達したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DeleteAnalysisScheme ## 説明 分析スキームを削除します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[分析スキームの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **AnalysisSchemeName** 削除する分析スキームの名前。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: はい **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `DeleteAnalysisSchemeResult` という名前の構造体で返されます。 **AnalysisScheme** 削除中の分析スキームのステータス。 型: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **InvalidType** リクエストは、無効な型定義を指定したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DeleteDomain ## 説明 検索ドメインとそのすべてのデータを完全に削除します。ドメインを完全に削除すると、復元できなくなります。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[検索ドメインの削除](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** 完全に削除するドメインの名前。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `DeleteDomainResult` という名前の構造体で返されます。 **DomainStatus** 検索ドメインの現在のステータス。 型: [DomainStatus](API_DomainStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 # DeleteExpression ## 説明 検索ドメインから ` Expression ` を削除します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[式の設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **ExpressionName** 削除する ` Expression ` の名前。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: はい ## レスポンス要素 以下の要素が `DeleteExpressionResult` という名前の構造体で返されます。 **Expression** 削除中の式のステータス。 型: [ExpressionStatus](API_ExpressionStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **InvalidType** リクエストは、無効な型定義を指定したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DeleteIndexField ## 説明 検索ドメインから ` IndexField ` を削除します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[インデックスフィールドの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **IndexFieldName** ドメインのインデックス作成オプションから削除するインデックスフィールドの名前。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: はい ## レスポンス要素 以下の要素が `DeleteIndexFieldResult` という名前の構造体で返されます。 **IndexField** 削除されるインデックスフィールドのステータス。 型: [IndexFieldStatus](API_IndexFieldStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **InvalidType** リクエストは、無効な型定義を指定したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DeleteSuggester ## 説明 サジェスタを削除します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[検索提案の入手](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **SuggesterName** 削除するサジェスタの名前を指定します。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: はい ## レスポンス要素 以下の要素が `DeleteSuggesterResult` という名前の構造体で返されます。 **サジェスタ** 削除中のサジェスタのステータス。 型: [SuggesterStatus](API_SuggesterStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **InvalidType** リクエストは、無効な型定義を指定したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DescribeAnalysisSchemes ## 説明 ドメインに対して設定された分析スキームを取得します。分析スキームは、`text` フィールドの言語固有のテキスト処理オプションを定義します。名前によって特定の分析スキームに制限できます。デフォルトでは、すべての分析スキームが表示され、設定の保留中の変更がすべて含まれます。アクティブな設定を表示し、保留中の変更を除外するには、`Deployed` オプションを `true` に設定します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[分析スキームの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **AnalysisSchemeNames.member.N** 説明する分析スキーム。 型: 文字列のリスト 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ **Deployed** デプロイされた設定を表示するか (`true`)、または任意の保留中の変更を含めるか (`false`)。デフォルトは `false` です。 タイプ: ブール値 必須: いいえ **DomainName** 説明するドメインの名前。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `DescribeAnalysisSchemesResult` という名前の構造体で返されます。 **AnalysisSchemes** 分析スキームの説明。 タイプ: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) リスト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DescribeAvailabilityOptions ## 説明 ドメインに設定された可用性オプションを取得します。デフォルトでは、保留中の変更を含む設定を表示します。アクティブな設定を表示し、保留中の変更を除外するには、`Deployed` オプションを `true` に設定します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[可用性オプションの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **Deployed** デプロイされた設定を表示するか (`true`)、または任意の保留中の変更を含めるか (`false`)。デフォルトは `false` です。 タイプ: ブール値 必須: いいえ **DomainName** 説明するドメインの名前。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `DescribeAvailabilityOptionsResult` という名前の構造体で返されます。 **AvailabilityOptions** ドメインに設定された可用性オプション。ドメインでマルチ AZ が有効であるかどうかを示します。 型: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](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 ## 説明 このアカウントによって所有される検索ドメインに関する情報を取得します。特定のドメインに制限できます。デフォルトではすべてのドメインを表示します。ドメイン内の検索可能なドキュメント数を取得するには、コンソールを使用するか、ドメインの検索エンドポイントに対して次のような `matchall` リクエストを送信します。`q=matchall&q.parser=structured&size=0`詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[検索ドメインに関する情報の取得](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainNames.member.N** レスポンスに含めるドメインの名前。 型: 文字列のリスト 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: いいえ ## レスポンス要素 以下の要素が `DescribeDomainsResult` という名前の構造体で返されます。 **DomainStatusList** リクエストされた各ドメインのステータスを格納するリスト。 タイプ: [DomainStatus](API_DomainStatus.md) リスト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 # DescribeExpressions ## 説明 検索ドメインに設定された式を取得します。名前により特定の式に制限できます。デフォルトでは、すべての式が表示され、設定の保留中の変更がすべて含まれます。アクティブな設定を表示し、保留中の変更を除外するには、`Deployed` オプションを `true` に設定します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[式の設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **Deployed** デプロイされた設定を表示するか (`true`)、または任意の保留中の変更を含めるか (`false`)。デフォルトは `false` です。 タイプ: ブール値 必須: いいえ **DomainName** 説明するドメインの名前。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **ExpressionNames.member.N** ` DescribeExpressions ` のレスポンスを指定された式に制限します。指定しない場合、すべての式が表示されます。 型: 文字列のリスト 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ ## レスポンス要素 以下の要素が `DescribeExpressionsResult` という名前の構造体で返されます。 **式** ドメインに設定された式。 タイプ: [ExpressionStatus](API_ExpressionStatus.md) リスト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DescribeIndexFields ## 説明 検索ドメイン用に設定されたインデックスフィールドに関する情報を取得します。名前により特定のフィールドに制限できます。デフォルトでは、すべてのフィールドが表示され、設定の保留中の変更がすべて含まれます。アクティブな設定を表示し、保留中の変更を除外するには、`Deployed` オプションを `true` に設定します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[ドメイン情報の取得](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **Deployed** デプロイされた設定を表示するか (`true`)、または任意の保留中の変更を含めるか (`false`)。デフォルトは `false` です。 タイプ: ブール値 必須: いいえ **DomainName** 説明するドメインの名前。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **FieldNames.member.N** 説明するインデックスフィールドのリスト。指定しない場合、設定されたすべてのインデックスフィールドの情報が返されます。 型: 文字列のリスト 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ ## レスポンス要素 以下の要素が `DescribeIndexFieldsResult` という名前の構造体で返されます。 **IndexFields** ドメインに設定されたインデックスフィールド。 タイプ: [IndexFieldStatus](API_IndexFieldStatus.md) リスト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DescribeScalingParameters ## 説明 ドメインに設定されているスケーリングパラメータを取得します。ドメインのスケーリングパラメータは、目的の検索インスタンスタイプとレプリケーションの数を指定します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[スケーリングオプションの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `DescribeScalingParametersResult` という名前の構造体で返されます。 **ScalingParameters** 検索ドメインのスケーリングパラメータのステータスと設定。 型: [ScalingParametersStatus](API_ScalingParametersStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DescribeDomainEndpointOptions ## 説明 ドメインのエンドポイントオプションを返します。具体的には、ドメインへのすべてのリクエストが HTTPS 経由で到着する必要があるかどうかを示します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[ドメインエンドポイントオプションの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html)」を参照してください。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。 タイプ: 文字列 必須: はい **deployed** 最新の設定 (`Processing` 状態にある可能性があります) を取得するか、現在のアクティブな設定 (`?deployed=true`) を取得するか。 タイプ: ブール値 必須: いいえ ## レスポンス要素 **DomainEndpointOptions** 検索ドメインのエンドポイントオプションのステータスと設定。 型: [DomainEndpointOptionsStatus](API_DomainEndpointOptionsStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **LimitExceeded** リクエストは、既にリソースの制限に到達したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DescribeServiceAccessPolicies ## 説明 ドメインのドキュメントと検索エンドポイントへのアクセスを制御するアクセスポリシーに関する情報を取得します。デフォルトでは、保留中の変更を含む設定を表示します。アクティブな設定を表示し、保留中の変更を除外するには、`Deployed` オプションを `true` に設定します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[検索ドメインのアクセスの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **Deployed** デプロイされた設定を表示するか (`true`)、または任意の保留中の変更を含めるか (`false`)。デフォルトは `false` です。 タイプ: ブール値 必須: いいえ **DomainName** 説明するドメインの名前。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `DescribeServiceAccessPoliciesResult` という名前の構造体で返されます。 **AccessPolicies** リクエストで指定されたドメインに設定されているアクセスルール。 型: [AccessPoliciesStatus](API_AccessPoliciesStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # DescribeSuggesters ## 説明 ドメインに設定されたサジェスタを取得します。サジェスタによって、ユーザーがクエリの入力を完了する前に、一致する可能性のある候補を表示できます。名前により特定のサジェストに制限できます。デフォルトでは、すべてのサジェスタが表示され、設定の保留中の変更がすべて含まれます。アクティブな設定を表示し、保留中の変更を除外するには、`Deployed` オプションを `true` に設定します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[検索提案の入手](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **Deployed** デプロイされた設定を表示するか (`true`)、または任意の保留中の変更を含めるか (`false`)。デフォルトは `false` です。 タイプ: ブール値 必須: いいえ **DomainName** 説明するドメインの名前。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **SuggesterNames.member.N** 説明する必要があるサジェスタ。 型: 文字列のリスト 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ ## レスポンス要素 以下の要素が `DescribeSuggestersResult` という名前の構造体で返されます。 **サジェスタ** リクエストで指定されたドメインに設定されているサジェスタ。 タイプ: [SuggesterStatus](API_SuggesterStatus.md) リスト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # IndexDocuments ## 説明 検索ドメインに、最新のインデックス作成オプションを使用してドキュメントのインデックス作成を開始するように指示します。[OptionStatus](API_OptionStatus.md) が `RequiresIndexDocuments` のオプションをアクティブ化するには、このオペレーションを呼び出す必要があります。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `IndexDocumentsResult` という名前の構造体で返されます。 **FieldNames** 現在インデックスが作成されているフィールドの名前。 型: 文字列のリスト 長さの制限: 最小長は 1 です。最大長 64 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # ListDomainNames ## 説明 アカウントが所有するすべての検索ドメインをリストします。 ## レスポンス要素 以下の要素が `ListDomainNamesResult` という名前の構造体で返されます。 **DomainNames** アカウントが所有する検索ドメインの名前。 タイプ: 文字列から文字列へのマッピング ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 # UpdateAvailabilityOptions ## 説明 ドメインの可用性オプションを設定します。マルチ AZ オプションを有効にすると、Amazon CloudSearch ドメインが同じリージョンの追加のアベイラビリティーゾーンに展開され、サービス障害時の耐障害性が強化されます。マルチ AZ オプションの変更が反映されるまで、約 30 分かかります。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[可用性オプションの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **マルチ AZ** 既存の検索ドメインを 2 番目のアベイラビリティゾーンに展開するには、マルチ AZ オプションを true に設定します。同様に、マルチ AZ オプションを `false` に設定することにより、マルチ AZ 機能をオフにして、単一のアベイラビリティーゾーンにドメインをダウングレードすることができます。 型: ブール値 必須: はい ## レスポンス要素 以下の要素が `UpdateAvailabilityOptionsResult` という名前の構造体で返されます。 **AvailabilityOptions** 新しく設定した可用性オプション。ドメインでマルチ AZ が有効であるかどうかを示します。 型: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](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 ## 説明 ドメインのスケーリングパラメータを設定します。ドメインのスケーリングパラメータは、目的の検索インスタンスタイプとレプリケーションの数を指定します。Amazon CloudSearch ではただし、必要なインスタンスタイプとレプリケーションの数ではなく、データとトラフィックのボリュームに基づいて、ドメインが自動的にスケーリングされます。マルチ AZ オプションを有効にした場合、これらの値によりアベイラビリティーゾーンごとに使用されるリソースが決まります。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[スケーリングオプションの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html)」を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい **ScalingParameters** 各インデックスパーティションの必要なインスタンスタイプと必要なレプリカ数。 型: [ScalingParameters](API_ScalingParameters.md) 必須: はい ## レスポンス要素 以下の要素が `UpdateScalingParametersResult` という名前の構造体で返されます。 **ScalingParameters** 検索ドメインのスケーリングパラメータのステータスと設定。 型: [ScalingParametersStatus](API_ScalingParametersStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **InvalidType** リクエストは、無効な型定義を指定したため拒否されました。 HTTP ステータスコード: 409 **LimitExceeded** リクエストは、既にリソースの制限に到達したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # UpdateDomainEndpointOptions ## 説明 ドメインのエンドポイントオプションを更新します。具体的には、ドメインへのすべてのリクエストが HTTPS 経由で到着する必要があるかどうかを示します。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[ドメインエンドポイントオプションの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html)」を参照してください。 ## リクエストパラメーター **DomainName** ドメイン名を表す文字列。 タイプ: 文字列 必須: はい **DomainEndpointOptions** エンドポイントオプションのコンテナ。 型: [DomainEndpointOptions](API_DomainEndpointOptions.md) 必須: はい ## レスポンス要素 **DomainEndpointOptionsStatus** ドメインのエンドポイントオプションのステータスと設定。 型: [DomainEndpointOptionsStatus](API_DomainEndpointOptionsStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](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 ## 説明 ドメインのドキュメントおよび検索エンドポイントに対するアクセスを制御するアクセスルールを設定します。詳細については、[Amazon CloudSearch ドメインのアクセスの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html)を参照してください。 ## リクエストパラメータ すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **AccessPolicies** 設定するアクセスルール。このルールは、既存のルールを置き換えます。 タイプ: 文字列 必須: はい **DomainName** ドメイン名を表す文字列。ドメイン名は、AWS リージョン内のアカウントによって所有されるドメイン間で一意です。ドメイン名は英数字で始まり、次の文字を含めることができます。a​～​z (小文字)、0​～​9、- (ハイフン)。 タイプ: 文字列 長さの制限: 最小長は 3 です。最大長は 28 です。 必須: はい ## レスポンス要素 以下の要素が `UpdateServiceAccessPoliciesResult` という名前の構造体で返されます。 **AccessPolicies** ドメイン用に設定されたアクセスルール。 型: [AccessPoliciesStatus](API_AccessPoliciesStatus.md) ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 **基本** リクエストの処理中にエラーが発生しました。 HTTP ステータスコード: 400 **内部** リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、[Service Health Dashboard](https://status.aws.amazon.com/) から問題を報告します。 HTTP ステータスコード: 500 **InvalidType** リクエストは、無効な型定義を指定したため拒否されました。 HTTP ステータスコード: 409 **LimitExceeded** リクエストは、既にリソースの制限に到達したため拒否されました。 HTTP ステータスコード: 409 **ResourceNotFound** リクエストは、存在しないリソースを参照しようとしたため拒否されました。 HTTP ステータスコード: 409 # データ型 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) + [サジェスタ](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 ## 説明 ドメインのドキュメントエンドポイントおよび検索エンドポイントについて設定されているアクセスルール、およびそれらのルールの現在のステータス。 ## 内容 **オプション** ドメインのドキュメントエンドポイントまたは検索サービスエンドポイントのアクセスルール。詳細については、*「Amazon CloudSearch デベロッパーガイド」*の「[検索ドメインのアクセスの設定](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html)」を参照してください。ポリシードキュメントの最大サイズは 100 KB です。 タイプ: 文字列 必須: はい **ステータス** ドメイン設定オプションのステータス。 型: [OptionStatus](API_OptionStatus.md) 必須: はい # AnalysisOptions ## 説明 分析スキームのシノニム、ストップワード、ステミングオプション。日本語のトークン分割ディクショナリを含みます。 ## 内容 **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 ## 説明 分析スキームの設定情報。各分析スキームに一意の名前があり、処理するテキストの言語を指定します。分析スキームには、`Synonyms`、`Stopwords`、`StemmingDictionary`、`JapaneseTokenizationDictionary` および `AlgorithmicStemming` の各オプションを設定できます。 ## 内容 **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 ## 説明 `AnalysisScheme` のステータスと設定。 ## 内容 **オプション** 分析スキームの設定情報。各分析スキームに一意の名前があり、処理するテキストの言語を指定します。分析スキームには、`Synonyms`、`Stopwords`、`StemmingDictionary`、`JapaneseTokenizationDictionary` および `AlgorithmicStemming` の各オプションを設定できます。 型: [AnalysisScheme](API_AnalysisScheme.md) 必須: はい **ステータス** ドメイン設定オプションのステータス。 型: [OptionStatus](API_OptionStatus.md) 必須: はい # AvailabilityOptionsStatus ## 説明 ドメインの可用性オプションのステータスと設定。 ## 内容 **オプション** ドメインに設定された可用性オプション。 型: ブール値 必須: はい **ステータス** ドメイン設定オプションのステータス。 型: [OptionStatus](API_OptionStatus.md) 必須: はい # BuildSuggestersResult ## 説明 `BuildSuggester` リクエストの結果。候補に使用されるフィールドのリストが含まれます。 ## 内容 **FieldNames** フィールド名のリストです。 型: 文字列のリスト 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ # CreateDomainResult ## 説明 `CreateDomainRequest` の結果。新しく作成されたドメインのステータスが含まれます。 ## 内容 **DomainStatus** 検索ドメインの現在のステータス。 型: [DomainStatus](API_DomainStatus.md) 必須: いいえ # DateArrayOptions ## 説明 日付の配列を格納するフィールドのオプション。`IndexFieldType` が `date-array` 型のフィールドを指定している場合に使用されます。すべてのオプションはデフォルトで有効になっています。 ## 内容 **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。 タイプ: 文字列 長さの制限: 最小長は 0 です。最大長は 1,024 です。 必須: いいえ **FacetEnabled** フィールドのファセット情報を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SearchEnabled** フィールドの内容が検索可能かどうか。 タイプ: ブール値 必須: いいえ **SourceFields** フィールドにマッピングするソースフィールドのリスト。 タイプ: 文字列 必須: いいえ # DateOptions ## 説明 日付フィールドのオプション。日付と時刻は、IETF RFC3339: yyyy-mm-ddT00:00:00Z に従って、UTC (協定世界時) で指定されます。`IndexFieldType` が `date` 型のフィールドを指定している場合に使用されます。すべてのオプションはデフォルトで有効になっています。 ## 内容 **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。 タイプ: 文字列 長さの制限: 最小長は 0 です。最大長は 1,024 です。 必須: いいえ **FacetEnabled** フィールドのファセット情報を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SearchEnabled** フィールドの内容が検索可能かどうか。 タイプ: ブール値 必須: いいえ **SortEnabled** フィールドを使用して検索結果をソートできるかどうか。 タイプ: ブール値 必須: いいえ **SourceField** インデックス​フィールドの名前を表す文字列。CloudSearch は、動的フィールドと同様に通常のインデックスフィールドをサポートします。動的フィールドの名前は、ワイルドカードで始まるか、それで終了するパターンを定義します。通常のインデックスフィールドにもマッピングされないが動的フィールドのパターンに一致するドキュメントフィールドは、動的フィールドのインデックスオプションで設定されます。 通常のフィールド名は英数字で始まり、次の文字を含めることができます。a～z (小文字)、0～9、\$1 (下線)。動的フィールド名はワイルドカード (\$1) で始まるか終わる必要があります。ワイルドカードはまた、動的フィールド名の唯一の文字になることがあります。複数のワイルドカードおよび文字列内に組み込まれたワイルドカードはサポートされていません。 `score` という名前は予約済みのため、フィールド名として使用できません。ドキュメントの ID を参照するには、`_id` という名前を使用できます。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ # DefineAnalysisSchemeResult ## 説明 ` DefineAnalysisScheme ` リクエストの結果。新しく設定された分析スキームのステータスが含まれます。 ## 内容 **AnalysisScheme** `AnalysisScheme` のステータスと設定。 型: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) 必須: はい # DefineExpressionResult ## 説明 `DefineExpression` リクエストの結果。新しく設定された式のステータスが含まれます。 ## 内容 **Expression** `Expression` の値および現在のステータス。 型: [ExpressionStatus](API_ExpressionStatus.md) 必須: はい # DefineIndexFieldResult ## 説明 ` DefineIndexField ` リクエストの結果。新しく設定されたインデックスフィールドのステータスが含まれます。 ## 内容 **IndexField** `IndexField` の値および現在のステータス。 型: [IndexFieldStatus](API_IndexFieldStatus.md) 必須: はい # DefineSuggesterResult ## 説明 `DefineSuggester` リクエストの結果。新しく設定されたサジェスタのステータスが含まれます。 ## 内容 **サジェスタ** `Suggester` の値および現在のステータス。 型: [SuggesterStatus](API_SuggesterStatus.md) 必須: はい # DeleteAnalysisSchemeResult ## 説明 `DeleteAnalysisScheme` リクエストの結果。削除された分析スキームのステータスが含まれます。 ## 内容 **AnalysisScheme** 削除中の分析スキームのステータス。 型: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) 必須: はい # DeleteDomainResult ## 説明 `DeleteDomain` リクエストの結果。新たに削除されたドメインのステータスが含まれます。ドメインがすでに完全に削除されている場合はステータスはありません。 ## 内容 **DomainStatus** 検索ドメインの現在のステータス。 型: [DomainStatus](API_DomainStatus.md) 必須: いいえ # DeleteExpressionResult ## 説明 ` DeleteExpression ` リクエストの結果。削除される式を指定します。 ## 内容 **Expression** 削除中の式のステータス。 型: [ExpressionStatus](API_ExpressionStatus.md) 必須: はい # DeleteIndexFieldResult ## 説明 ` DeleteIndexField ` リクエストの結果。 ## 内容 **IndexField** 削除されるインデックスフィールドのステータス。 型: [IndexFieldStatus](API_IndexFieldStatus.md) 必須: はい # DeleteSuggesterResult ## 説明 `DeleteSuggester` リクエストの結果。削除されたサジェスタのステータスが含まれます。 ## 内容 **サジェスタ** 削除中のサジェスタのステータス。 型: [SuggesterStatus](API_SuggesterStatus.md) 必須: はい # DescribeAnalysisSchemesResult ## 説明 `DescribeAnalysisSchemes` リクエストの結果。リクエストで指定されたドメインに対して設定された分析スキームが含まれます。 ## 内容 **AnalysisSchemes** 分析スキームの説明。 タイプ: [AnalysisSchemeStatus](API_AnalysisSchemeStatus.md) リスト 必須: はい # DescribeAvailabilityOptionsResult ## 説明 `DescribeAvailabilityOptions` リクエストの結果。リクエストで指定されたドメインに対してマルチ AZ オプションが有効になっているかどうかを示します。 ## 内容 **AvailabilityOptions** ドメインに設定された可用性オプション。ドメインでマルチ AZ が有効であるかどうかを示します。 型: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md) 必須: いいえ # DescribeDomainsResult ## 説明 `DescribeDomains` リクエストの結果。リクエストで指定されたドメインまたはアカウントが所有するすべてのドメインのステータスが含まれます。 ## 内容 **DomainStatusList** リクエストされた各ドメインのステータスを格納するリスト。 タイプ: [DomainStatus](API_DomainStatus.md) リスト 必須: はい # DescribeExpressionsResult ## 説明 `DescribeExpressions` リクエストの結果。リクエストで指定されたドメインに対して設定された式が含まれます。 ## 内容 **式** ドメインに設定された式。 タイプ: [ExpressionStatus](API_ExpressionStatus.md) リスト 必須: はい # DescribeIndexFieldsResult ## 説明 `DescribeIndexFields` リクエストの結果。リクエストで指定されたドメインに対して設定されたインデックスフィールドを含みます。 ## 内容 **IndexFields** ドメインに設定されたインデックスフィールド。 タイプ: [IndexFieldStatus](API_IndexFieldStatus.md) リスト 必須: はい # DescribeScalingParametersResult ## 説明 `DescribeScalingParameters` リクエストの結果。リクエストで指定されたドメインに設定されているスケーリングパラメータが含まれます。 ## 内容 **ScalingParameters** 検索ドメインのスケーリングパラメータのステータスと設定。 型: [ScalingParametersStatus](API_ScalingParametersStatus.md) 必須: はい # DescribeServiceAccessPoliciesResult ## 説明 `DescribeServiceAccessPolicies` リクエストの結果。 ## 内容 **AccessPolicies** リクエストで指定されたドメインに設定されているアクセスルール。 型: [AccessPoliciesStatus](API_AccessPoliciesStatus.md) 必須: はい # DescribeSuggestersResult ## 説明 `DescribeSuggesters` リクエストの結果。 ## 内容 **サジェスタ** リクエストで指定されたドメインに設定されているサジェスタ。 タイプ: [SuggesterStatus](API_SuggesterStatus.md) リスト 必須: はい # DocumentSuggesterOptions ## 説明 検索サジェスタのオプション。 ## 内容 **FuzzyMatching** 文字列の一致候補を示すときに使用する曖昧さのレベル。`none`、`low`、または `high`。none の場合、指定された文字列は正確なプレフィックスとして処理されます。low の場合、候補は指定された文字列との異なる箇所が 1 文字以内である必要があります。high の場合、候補は 2 文字まで異なることができます。デフォルトは none です。 タイプ: 文字列 有効な値: `none | low | high` 必須: いいえ **SortExpression** ソート方法を制御するために各候補のスコアを計算する式。スコアは最も近い整数に丸められ、下限が 0 で上限が 2^31-1 です。ドキュメントの関連性スコアは提案には計算されていないため、ソート式は `_score` 値を参照することはできません。数値フィールドまたは既存の式を使用して候補をソートするには、フィールドまたは式の名前を指定します。サジェスタ用の式が設定されていない場合、最も一致している候補から順に並べられます。 タイプ: 文字列 必須: いいえ **SourceField** 候補として使用するインデックスフィールドの名前。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: はい # DomainEndpointOptions ## 説明 ドメインへのすべてのリクエストが HTTPS 経由で到着するように要求するかどうか。`TLSSecurityPolicy` には `Policy-Min-TLS-1-2-2019-07` を使用することをお勧めします。古いクライアントとの互換性を保つため、デフォルトは `Policy-Min-TLS-1-0-2019-07` です。 ## 内容 **EnforceHTTPS** ドメインへのすべてのリクエストが HTTPS 経由で到着するという要件を有効または無効にします。 型: ブール値 有効な値: `true | false` 必須: いいえ **TLSSecurityPolicy** 最低限必要な TLS バージョン。 タイプ: 文字列 有効な値: `Policy-Min-TLS-1-2-2019-07 | Policy-Min-TLS-1-0-2019-07` 必須: いいえ # DomainEndpointOptionsStatus ## 説明 ドメインのエンドポイントオプションの設定とステータス。 ## 内容 **オプション** 現行の設定。 型: [DomainEndpointOptions](API_DomainEndpointOptions.md) **ステータス** 設定オプションのステータス。 型: [OptionStatus](API_OptionStatus.md) # DomainStatus ## 説明 検索ドメインの現在のステータス。 ## 内容 **ARN** 検索ドメインの Amazon リソースネーム (ARN) を返します。詳細については、「*AWS Identity and Access Management の使用*」の「[Identifiers for IAM Entities](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) 必須: いいえ **Processing** 現在のドメインの設定をアクティブ化する処理を実行中である場合は true です。 タイプ: ブール値 必須: いいえ **RequiresIndexDocuments** 現在のドメインの設定をアクティブ化するために [IndexDocuments](API_IndexDocuments.md) を呼び出す必要がある場合は true です。 型: ブール値 必須: はい **SearchInstanceCount** 検索リクエストを処理するために使用できる検索インスタンスの数。 タイプ: 整数 必須: いいえ **SearchInstanceType** 検索リクエストを処理するために使用されるインスタンスタイプ。 タイプ: 文字列 必須: いいえ **SearchPartitionCount** 検索インデックスが分散されるパーティションの数。 タイプ: 整数 必須: いいえ **SearchService** 検索ドメインからの検索結果をリクエストするためのサービス エンドポイント。 型: [ServiceEndpoint](API_ServiceEndpoint.md) 必須: いいえ # DoubleArrayOptions ## 説明 倍精度 64 ビット浮動小数点値の配列を格納するフィールドのオプション。`IndexFieldType` が `double-array` 型のフィールドを指定している場合に使用されます。すべてのオプションはデフォルトで有効になっています。 ## 内容 **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。 型: 倍精度浮動小数点数 必須: いいえ **FacetEnabled** フィールドのファセット情報を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SearchEnabled** フィールドの内容が検索可能かどうか。 タイプ: ブール値 必須: いいえ **SourceFields** フィールドにマッピングするソースフィールドのリスト。 タイプ: 文字列 必須: いいえ # DoubleOptions ## 説明 倍精度 64 ビット浮動小数点フィールドのオプション。`IndexFieldType` が `double` 型のフィールドを指定している場合に使用されます。すべてのオプションはデフォルトで有効になっています。 ## 内容 **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。このフィールドを式に使用していて、しかもそのフィールドがすべてのドキュメントに存在するとは限らない場合には重要です。 型: 倍精度浮動小数点数 必須: いいえ **FacetEnabled** フィールドのファセット情報を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SearchEnabled** フィールドの内容が検索可能かどうか。 タイプ: ブール値 必須: いいえ **SortEnabled** フィールドを使用して検索結果をソートできるかどうか。 タイプ: ブール値 必須: いいえ **SourceField** そのフィールドにマッピングするソースフィールドの名前。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ # 式 ## 説明 検索時に評価できる名前付きの式。検索結果をソートしたり、他の式を定義したり、検索結果内に計算後の情報を返したりするために使用できます。 ## 内容 **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 ## 説明 `Expression` の値および現在のステータス。 ## 内容 **オプション** 検索リクエストの処理中にソートするために評価される式。 型: [式](API_Expression.md) 必須: はい **ステータス** ドメイン設定オプションのステータス。 型: [OptionStatus](API_OptionStatus.md) 必須: はい # IndexDocumentsResult ## 説明 `IndexDocuments` リクエストの結果。インデックスを作成するフィールドなど、インデックス作成オペレーションのステータスが含まれます。 ## 内容 **FieldNames** 現在インデックスが作成されているフィールドの名前。 型: 文字列のリスト 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ # IndexField ## 説明 名前、タイプ、オプションなど、インデックスのフィールドの設定情報。サポートされるオプションは、` IndexFieldType ` によって異なります。 ## 内容 **DateArrayOptions** 日付の配列を格納するフィールドのオプション。`IndexFieldType` が `date-array` 型のフィールドを指定している場合に使用されます。すべてのオプションはデフォルトで有効になっています。 型: [DateArrayOptions](API_DateArrayOptions.md) 必須: いいえ **DateOptions** 日付フィールドのオプション。日付と時刻は、IETF RFC3339: yyyy-mm-ddT00:00:00Z に従って、UTC (協定世界時) で指定されます。`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 ## 説明 `IndexField` の値および現在のステータス。 ## 内容 **オプション** 名前、タイプ、オプションなど、インデックスのフィールドの設定情報。サポートされるオプションは、` IndexFieldType ` によって異なります。 型: [IndexField](API_IndexField.md) 必須: はい **ステータス** ドメイン設定オプションのステータス。 型: [OptionStatus](API_OptionStatus.md) 必須: はい # IntArrayOptions ## 説明 64 ビット符号付き整数の配列を格納するフィールドのオプション。`IndexFieldType` が `int-array` 型のフィールドを指定している場合に使用されます。すべてのオプションはデフォルトで有効になっています。 ## 内容 **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。 型: Long 必須: いいえ **FacetEnabled** フィールドのファセット情報を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SearchEnabled** フィールドの内容が検索可能かどうか。 タイプ: ブール値 必須: いいえ **SourceFields** フィールドにマッピングするソースフィールドのリスト。 タイプ: 文字列 必須: いいえ # IntOptions ## 説明 64 ビット符号付き整数フィールドのオプション。`IndexFieldType` が `int` 型のフィールドを指定している場合に使用されます。すべてのオプションはデフォルトで有効になっています。 ## 内容 **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。このフィールドを式に使用していて、しかもそのフィールドがすべてのドキュメントに存在するとは限らない場合には重要です。 型: Long 必須: いいえ **FacetEnabled** フィールドのファセット情報を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SearchEnabled** フィールドの内容が検索可能かどうか。 タイプ: ブール値 必須: いいえ **SortEnabled** フィールドを使用して検索結果をソートできるかどうか。 タイプ: ブール値 必須: いいえ **SourceField** そのフィールドにマッピングするソースフィールドの名前。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ # LatLonOptions ## 説明 latlon 型フィールドのオプション。latlon 型フィールドには緯度と経度の値のペアで位置が格納されます。`IndexFieldType` が `latlon` 型のフィールドを指定している場合に使用されます。すべてのオプションはデフォルトで有効になっています。 ## 内容 **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。 タイプ: 文字列 長さの制限: 最小長は 0 です。最大長は 1,024 です。 必須: いいえ **FacetEnabled** フィールドのファセット情報を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SearchEnabled** フィールドの内容が検索可能かどうか。 タイプ: ブール値 必須: いいえ **SortEnabled** フィールドを使用して検索結果をソートできるかどうか。 タイプ: ブール値 必須: いいえ **SourceField** インデックス​フィールドの名前を表す文字列。CloudSearch は、動的フィールドと同様に通常のインデックスフィールドをサポートします。動的フィールドの名前は、ワイルドカードで始まるか、それで終了するパターンを定義します。通常のインデックスフィールドにもマッピングされないが動的フィールドのパターンに一致するドキュメントフィールドは、動的フィールドのインデックスオプションで設定されます。 通常のフィールド名は英数字で始まり、次の文字を含めることができます。a～z (小文字)、0～9、\$1 (下線)。動的フィールド名はワイルドカード (\$1) で始まるか終わる必要があります。ワイルドカードはまた、動的フィールド名の唯一の文字になることがあります。複数のワイルドカードおよび文字列内に組み込まれたワイルドカードはサポートされていません。 `score` という名前は予約済みのため、フィールド名として使用できません。ドキュメントの ID を参照するには、`_id` という名前を使用できます。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ # 制限 ## 説明 使用できるアクションドキュメントがありません。 ## 内容 **MaximumPartitionCount** タイプ: 整数 必須: はい **MaximumReplicationCount** タイプ: 整数 必須: はい # ListDomainNamesResult ## 説明 `ListDomainNames` リクエストの結果。アカウントが所有するドメインのリストを含みます。 ## 内容 **DomainNames** アカウントが所有する検索ドメインの名前。 タイプ: 文字列から文字列へのマッピング 必須: いいえ # LiteralArrayOptions ## 説明 リテラル文字列の配列を格納するフィールドのオプション。`IndexFieldType` が `literal-array` 型のフィールドを指定している場合に使用されます。すべてのオプションはデフォルトで有効になっています。 ## 内容 **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。 タイプ: 文字列 長さの制限: 最小長は 0 です。最大長は 1,024 です。 必須: いいえ **FacetEnabled** フィールドのファセット情報を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SearchEnabled** フィールドの内容が検索可能かどうか。 タイプ: ブール値 必須: いいえ **SourceFields** フィールドにマッピングするソースフィールドのリスト。 タイプ: 文字列 必須: いいえ # LiteralOptions ## 説明 リテラルフィールドのオプション。`IndexFieldType` が `literal` 型のフィールドを指定している場合に使用されます。すべてのオプションはデフォルトで有効になっています。 ## 内容 **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。 タイプ: 文字列 長さの制限: 最小長は 0 です。最大長は 1,024 です。 必須: いいえ **FacetEnabled** フィールドのファセット情報を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SearchEnabled** フィールドの内容が検索可能かどうか。 タイプ: ブール値 必須: いいえ **SortEnabled** フィールドを使用して検索結果をソートできるかどうか。 タイプ: ブール値 必須: いいえ **SourceField** インデックス​フィールドの名前を表す文字列。CloudSearch は、動的フィールドと同様に通常のインデックスフィールドをサポートします。動的フィールドの名前は、ワイルドカードで始まるか、それで終了するパターンを定義します。通常のインデックスフィールドにもマッピングされないが動的フィールドのパターンに一致するドキュメントフィールドは、動的フィールドのインデックスオプションで設定されます。 通常のフィールド名は英数字で始まり、次の文字を含めることができます。a～z (小文字)、0～9、\$1 (下線)。動的フィールド名はワイルドカード (\$1) で始まるか終わる必要があります。ワイルドカードはまた、動的フィールド名の唯一の文字になることがあります。複数のワイルドカードおよび文字列内に組み込まれたワイルドカードはサポートされていません。 `score` という名前は予約済みのため、フィールド名として使用できません。ドキュメントの ID を参照するには、`_id` という名前を使用できます。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ # OptionStatus ## 説明 ドメイン設定オプションのステータス。 ## 内容 **CreationDate** このオプションが作成された時刻のタイムスタンプ。 型: DateTime 必須: はい **PendingDeletion** 処理が完了したらオプションが削除されることを示します。 タイプ: ブール値 必須: いいえ **状態** オプションに対する変更処理の状態。使用できる値: + `RequiresIndexDocuments`: オプションの最新の値は、[IndexDocuments](API_IndexDocuments.md) が呼び出され、インデックス作成が完了するまでデプロイされません。 + `Processing`: オプションの最新の値はアクティブ化の処理中です。 + `Active`: オプションの最新の値が完全にデプロイされています。 + `FailedToValidate`: オプション値は、ドメインのデータと互換性がないため、データのインデックスを作成するために使用できません。オプション値を変更するか、互換性がないドキュメントを更新または削除する必要があります。 タイプ: 文字列 有効な値: `RequiresIndexDocuments | Processing | Active | FailedToValidate` 必須: はい **UpdateDate** このオプションが最後に更新されたときのタイムスタンプ。 型: DateTime 必須: はい **UpdateVersion** このオプションが最後に更新されたときを示す一意の整数。 タイプ: 整数 必須: いいえ # ScalingParameters ## 説明 各インデックスパーティションの必要なインスタンスタイプと必要なレプリカ数。 ## 内容 **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 ## 説明 検索ドメインのスケーリングパラメータのステータスと設定。 ## 内容 **オプション** 各インデックスパーティションの必要なインスタンスタイプと必要なレプリカ数。 型: [ScalingParameters](API_ScalingParameters.md) 必須: はい **ステータス** ドメイン設定オプションのステータス。 型: [OptionStatus](API_OptionStatus.md) 必須: はい # ServiceEndpoint ## 説明 サービスリクエストの送信先となるエンドポイント。 ## 内容 **エンドポイント** サービスリクエストの送信先となるエンドポイント。例えば、`search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com`、`doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com` などです。 タイプ: 文字列 必須: いいえ # サジェスタ ## 説明 検索サジェスタの設定情報。各サジェスタは一意の名前を持ち、候補として使用するテキストフィールドを指定します。サジェスタには、`FuzzyMatching` オプションと `SortExpression` オプションを設定できます。 ## 内容 **DocumentSuggesterOptions** 検索サジェスタのオプション。 型: [DocumentSuggesterOptions](API_DocumentSuggesterOptions.md) 必須: はい **SuggesterName** 名前は英数字で始まっている必要があり、次の文字を含めることができます。a～z (小文字)、0～9、\$1 (下線)。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: はい # SuggesterStatus ## 説明 `Suggester` の値および現在のステータス。 ## 内容 **オプション** 検索サジェスタの設定情報。各サジェスタは一意の名前を持ち、候補として使用するテキストフィールドを指定します。サジェスタには、`FuzzyMatching` オプションと `SortExpression` オプションを設定できます。 型: [サジェスタ](API_Suggester.md) 必須: はい **ステータス** ドメイン設定オプションのステータス。 型: [OptionStatus](API_OptionStatus.md) 必須: はい # TextArrayOptions ## 説明 テキスト文字列の配列を格納するフィールドのオプション。`IndexFieldType` が `text-array` 型のフィールドを指定している場合に使用されます。`text-array` フィールドは常に検索可能です。すべてのオプションはデフォルトで有効になっています。 ## 内容 **AnalysisScheme** `text-array` フィールドの分析スキームの名前。 タイプ: 文字列 必須: いいえ **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。 タイプ: 文字列 長さの制限: 最小長は 0 です。最大長は 1,024 です。 必須: いいえ **HighlightEnabled** そのフィールドにハイライトが返されるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SourceFields** フィールドにマッピングするソースフィールドのリスト。 タイプ: 文字列 必須: いいえ # TextOptions ## 説明 テキストフィールドのオプション。`IndexFieldType` が `text` 型のフィールドを指定している場合に使用されます。`text` フィールドは常に検索可能です。すべてのオプションはデフォルトで有効になっています。 ## 内容 **AnalysisScheme** `text` フィールドの分析スキームの名前。 タイプ: 文字列 必須: いいえ **DefaultValue** ドキュメントでこのフィールドが指定されていない場合に、フィールドに使用される値。 タイプ: 文字列 長さの制限: 最小長は 0 です。最大長は 1,024 です。 必須: いいえ **HighlightEnabled** そのフィールドにハイライトが返されるかどうか。 タイプ: ブール値 必須: いいえ **ReturnEnabled** 検索結果でフィールドの内容を返すことができるかどうか。 タイプ: ブール値 必須: いいえ **SortEnabled** フィールドを使用して検索結果をソートできるかどうか。 タイプ: ブール値 必須: いいえ **SourceField** インデックス​フィールドの名前を表す文字列。CloudSearch は、動的フィールドと同様に通常のインデックスフィールドをサポートします。動的フィールドの名前は、ワイルドカードで始まるか、それで終了するパターンを定義します。通常のインデックスフィールドにもマッピングされないが動的フィールドのパターンに一致するドキュメントフィールドは、動的フィールドのインデックスオプションで設定されます。 通常のフィールド名は英数字で始まり、次の文字を含めることができます。a～z (小文字)、0～9、\$1 (下線)。動的フィールド名はワイルドカード (\$1) で始まるか終わる必要があります。ワイルドカードはまた、動的フィールド名の唯一の文字になることがあります。複数のワイルドカードおよび文字列内に組み込まれたワイルドカードはサポートされていません。 `score` という名前は予約済みのため、フィールド名として使用できません。ドキュメントの ID を参照するには、`_id` という名前を使用できます。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長 64 必須: いいえ # UpdateAvailabilityOptionsResult ## 説明 `UpdateAvailabilityOptions` リクエストの結果。ドメインの可用性オプションのステータスを含みます。 ## 内容 **AvailabilityOptions** 新しく設定した可用性オプション。ドメインでマルチ AZ が有効であるかどうかを示します。 型: [AvailabilityOptionsStatus](API_AvailabilityOptionsStatus.md) 必須: いいえ # UpdateScalingParametersResult ## 説明 `UpdateScalingParameters` リクエストの結果。新しく設定されたスケーリングパラメータのステータスが含まれます。 ## 内容 **ScalingParameters** 検索ドメインのスケーリングパラメータのステータスと設定。 型: [ScalingParametersStatus](API_ScalingParametersStatus.md) 必須: はい # UpdateServiceAccessPoliciesResult ## 説明 `UpdateServiceAccessPolicies` リクエストの結果。新しいアクセスポリシーが含まれます。 ## 内容 **AccessPolicies** ドメイン用に設定されたアクセスルール。 型: [AccessPoliciesStatus](API_AccessPoliciesStatus.md) 必須: はい # 共通パラメータ このセクションでは、すべてのアクションが使用するリクエストパラメータを列挙します。アクション固有のパラメータは、そのアクションのトピックで示されています。 **アクション** 実行するアクション。 デフォルト: なし タイプ: 文字列 必須: はい **AuthParams** 条件付きリクエストを認証するために必要なパラメータ。次を含みます。 + AWSAccessKeyID + SignatureVersion + タイムスタンプ + Signature デフォルト: なし 必須: 条件による **AWSAccessKeyId** リクエストの署名に使用したシークレットアクセスキーに相当するアクセスキー ID。 デフォルト: なし タイプ: 文字列 必須: はい **有効期限** リクエストの署名が失効する日付と時刻。ISO 8601 標準で規定された YYYY-MM-DDThh:mm:ssZ 形式で表現されます。 条件: リクエストは *タイムスタンプ* または *有効期限* のどちらかを含む必要がありますが、両方を含むことはできません。 デフォルト: なし タイプ: 文字列 必須: 条件による **SecurityToken** AWS Security Token Service を呼び出して取得された一時的セキュリティトークン。AWS Security Token Service をサポートするサービスのリストについては、**一時的なセキュリティ認証情報の使用**の[一時的なセキュリティ認証情報を使用して AWS にアクセスする](https://docs.aws.amazon.com/IAM/latest/UsingSTS/UsingTokens.html)を参照してください。 デフォルト: なし 型: 文字列 必須: いいえ **署名** リクエストのために作成したデジタル署名。署名の生成については、サービスのデベロッパー用ドキュメントを参照してください。 デフォルト: なし タイプ: 文字列 必須: はい **SignatureMethod** リクエストの署名を作成するのに使用したハッシュアルゴリズム。 デフォルト: なし タイプ: 文字列 有効な値：`HmacSHA256 | HmacSHA1` 必須: はい **SignatureVersion** リクエストに署名するときに使用する署名バージョン。サービスで推奨されている値に設定します。 デフォルト: なし タイプ: 文字列 必須: はい **タイムスタンプ** リクエストが署名された日付と時刻。ISO 8601 標準で規定された YYYY-MM-DDThh:mm:ssZ 形式で表現します。 条件: リクエストは *タイムスタンプ* または *有効期限* のどちらかを含む必要がありますが、両方を含むことはできません。 デフォルト: なし タイプ: 文字列 必須: 条件による **バージョン** リクエストが想定している API バージョンである、YYYY-MM-DD 形式で表示されます。 デフォルト: なし タイプ: 文字列 必須: はい # 共通エラー このセクションでは、すべてのアクションが返す共通エラーを列挙します。アクション固有のエラーは、そのアクションのトピックで示されています。 **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 分を経過した後またはリクエストの有効期限 (署名付き URL の場合など) から 15 分を経過した後に、リクエストが到着しました。または、リクエストの日付スタンプが現在より 15 分以上先です。 HTTP ステータスコード: 400 **ServiceUnavailable** サーバーの一時的な障害により、リクエストは失敗しました。 HTTP ステータスコード: 503 **Throttling** リクエストのスロットリングにより、リクエストが拒否されました。 HTTP ステータスコード: 400 **ValidationError** 入力が、AWS のサービスで指定された制約を満たしていません。 HTTP ステータスコード: 400