DescribeSuggesters

説明

ドメインに設定されたサジェスタを取得します。サジェスタによって、ユーザーがクエリの入力を完了する前に、一致する可能性のある候補を表示できます。名前により特定のサジェストに制限できます。デフォルトでは、すべてのサジェスタが表示され、設定の保留中の変更がすべて含まれます。アクティブな設定を表示し、保留中の変更を除外するには、Deployed オプションを true に設定します。詳細については、「Amazon CloudSearch デベロッパーガイド」の「検索候補の取得」を参照してください。

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

Deployed

デプロイされた設定を表示するか (true)、または任意の保留中の変更を含めるか (false)。デフォルトは false です。

タイプ: ブール値

必須: いいえ

DomainName

説明するドメインの名前。

型: 文字列

長さの制限: 最小長は 3 です。最大長は 28 です。

必須: はい

SuggesterNames.member.N

説明する必要があるサジェスタ。

型: 文字列のリスト

長さの制限: 最小長は 1 です。最大長は 64 文字です。

必須: いいえ

レスポンス要素

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

サジェスタ

リクエストで指定されたドメインに設定されているサジェスタ。

タイプ: SuggesterStatus リスト

エラー

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

基本

リクエストの処理中にエラーが発生しました。

HTTP ステータスコード：400

内部

リクエストの処理中に内部エラーが発生しました。この問題が解決しない場合は、Service Health Dashboard から問題を報告します。

HTTP ステータスコード：500

ResourceNotFound

リクエストは、存在しないリソースを参照しようとしたため拒否されました。

HTTP ステータスコード: 409