Amazon CloudSearch
開発者ガイド (API バージョン 2013-01-01)

Amazon CloudSearch ドメインに関する情報の取得

各検索ドメインについて、以下の情報を取得できます。

  • ドメイン名 — ドメインの名前。

  • ARN — ドメインの Amazon リソースネーム (ARN)。

  • ドキュメントエンドポイント — ドキュメントの更新を送信するために使用できるエンドポイント。

  • 検索エンドポイント — 検索リクエストを送信するために使用できるエンドポイント。

  • 検索可能ドキュメント — インデックスが作成されたドキュメントの数。

  • アクセスポリシー — ドメインのドキュメントエンドポイントおよび検索エンドポイントについて設定されたアクセスポリシー。

  • 分析スキーム — ドメインのインデックスフィールドに適用できるテキスト分析スキーム。

  • インデックスフィールド — 設定された各インデックスフィールドの名前と型。

  • — 検索結果をソートするために使用できる式。

  • サジェスタ — 不完全なクエリについて候補を取得するために使用できるサジェスタ。

ドメインが最初に作成されたときには、ドメインのステータスにはドメインが現在アクティブ化中であり、その他の情報は使用できないことが示されます。ドメインのドキュメントエンドポイントと検索エンドポイントが利用可能になると、ドメインのステータスには、データの追加や検索リクエストの送信に使用できるエンドポイントのアドレスが表示されます。インデックス作成のためのデータを送信していない場合、検索可能なドキュメントの数は 0 です。

コンソールによってドメインに関するすべての情報を表示できます。aws cloudsearch describe-domains コマンドまたは AWS SDK を使用する場合、ドメインの ARN は、ドメインのアクセスポリシー内に示されます。

検索可能ドキュメントの数を取得するには、コンソールを使用するか、matchall リクエストをドメインの検索エンドポイントに送信します。

q=matchall&q.parser=structured&size=0

Amazon CloudSearch コンソールを使用したドメイン情報の取得

Amazon CloudSearch コンソールを使用して、お客様のすべてのドメインに関する情報を表示できます。コンソールのダッシュボードには、作成したドキュメントの概要 (ドメイン名、ステータス、検索可能ドキュメントの数など) が表示されます。最新の情報を使ってテーブルを更新するには、ページ上部の [Refresh] ボタンをクリックします。

ドメインは 5 つの状態のいずれかになります。

  • LOADING — ドメインは作成されたばかりであり、初期化中です。ドキュメントのアップロードを開始する前に、ドメインのステータスが PROCESSING、NEEDS INDEXING、または ACTIVE に変わるまで待つ必要があります。

  • ACTIVE — ドメインは実行中であり、設定されたすべてのフィールドについてインデックスが作成されました。

  • NEEDS INDEXING — インデックスの再構築を必要とするドメインの設定に変更を加えました。ドメインを検索する場合、これらの変更は結果に反映されません。変更が完了したら、[Run Indexing] をクリックしてインデックスを再構築します。

  • PROCESSING — 設定の変更をドメインに適用しています。ドメインを検索する場合、最新の設定の変更が結果に反映されない可能性があります。

  • BEING DELETED — ドメインとその内容を削除することを選択した場合、ドメインとそのすべてのリソースは削除中になります。削除が完了すると、そのドメインはドメインのリストから削除されます。

Amazon CloudSearch ダッシュボードから、次の操作を実行できます。

  • 検索ドメインのステータスを表示する

  • 特定のドメイン向けダッシュボードにアクセスする

  • Amazon CloudSearch ドキュメントやその他のリソースにアクセスする

特定のドメインに関する詳細情報を表示するには

  1. AWS マネジメントコンソールにサインインし、Amazon CloudSearch console at https://console.aws.amazon.com/cloudsearch/home を開きます。

  2. [Navigation (ナビゲーション)] ペイン で、ドメインの名前をクリックします。

ドメインダッシュボードには、選択されたドメインのステータスの概要が表示されます。ドメインダッシュボードから、次の操作を実行できます。

  • ドメインのステータスを表示する

  • ドキュメントをドメインにアップロードする

  • ドメインを検索する

  • ドメインの設定ページにアクセスする

  • ドメインの削除

ドメインに設定されたアクセスポリシーを表示するには

  • [Navigation] ペインでドメインの [Access Policies] リンクをクリックします。アクセスポリシーの詳細については、「アクセスポリシーの設定」を参照してください。

ドメインに設定された可用性オプションを表示するには

  • [Navigation] ペインでドメインの [Availability Options] リンクをクリックします。アクセスポリシーの詳細については、「可用性オプションの設定」を参照してください。

ドメインに設定されたインデックスフィールドを表示するには

  • [Navigation] ペインでドメインの [Indexing Options] リンクをクリックします。インデックスフィールドの詳細については、「インデックスオプションの設定」を参照してください。

ドメインに設定されたスケーリングオプションを表示するには

  • [Navigation] ペインでドメインの [Scaling Options] リンクをクリックします。インデックスフィールドの詳細については、「スケーリングオプションの設定」を参照してください。

ドメインに設定されたサジェスタを表示するには

  • [Navigation] ペインでドメインの [Suggesters] リンクをクリックします。インデックスフィールドの詳細については、「Amazon CloudSearch のサジェスタの設定」を参照してください。

ドメインに設定された式を表示するには

  • [Navigation] ペインでドメインの [Expressions] リンクをクリックします。式の詳細については、「式の設定」を参照してください。

ドメインに設定されたテキスト処理オプションを表示するには

  • [Navigation] ペインでドメインの [Analysis Schemes] リンクをクリックします。テキストオプションについては、「分析スキームの設定」を参照してください。

AWS CLI を使用した Amazon CloudSearch ドメイン情報の取得

検索ドメインのステータスを取得するには、aws cloudsearch describe-domains コマンドを使用します。ドメインに設定されたアクセスポリシー、可用性オプション、スケーリングオプションなどの特定の情報を取得するには、オプションごとに個別の describe コマンドを使用します。AWS CLI のインストールおよびセットアップの詳細については、『AWS Command Line Interface ユーザーガイド』を参照してください。

ドメインのステータス情報を取得するには

  • すべてのドメインに関する情報を取得するには、aws cloudsearch describe-domains コマンドを実行します。特定のドメインに関する情報を取得するには、--domain-names オプションを使用して目的のドメインを指定します。たとえば、次のリクエストは、movies ドメインのステータスを取得します。

    aws cloudsearch describe-domains --domain-names movies { "DomainStatusList": [ { "SearchInstanceType": "search.m1.small", "DomainId": "965407640801/movies", "Created": true, "Deleted": false, "SearchInstanceCount": 1, "DomainName": "movies", "SearchService": { "Endpoint": "search-movies-m4fcjhuxgj6i76smhyiz7pfxsu.us-east-1.cloudsearch.amazonaws.com" }, "RequiresIndexDocuments": false, "Processing": true, "DocService": { "Endpoint": "doc-movies-m4fcjhuxgj6i76smhyiz7pfxsu.us-east-1.cloudsearch.amazonaws.com" }, "ARN": "arn:aws:cloudsearch:us-east-1:965407640801:domain/movies", "SearchPartitionCount": 1 } ] }

describe-domains コマンドは、ドメインの検索可能ドキュメント数を返しません。検索可能ドキュメントの数を取得するには、コンソールを使用するか、matchall リクエストをドメインの検索エンドポイントに送信します。

q=matchall&q.parser=structured&size=0

ドメインに設定された分析スキームを取得するには

  • aws cloudsearch describe-analysis-schemes コマンドを実行します。たとえば、次のリクエストは、movies ドメインに設定された分析スキームを取得します。

    aws cloudsearch describe-analysis-schemes --domain-name movies { "AnalysisSchemes": [ { "Status": { "PendingDeletion": false, "State": "Active", "CreationDate": "2014-03-28T19:27:30Z", "UpdateVersion": 31, "UpdateDate": "2014-03-28T19:27:30Z" }, "Options": { "AnalysisSchemeLanguage": "en", "AnalysisSchemeName": "samplescheme", "AnalysisOptions": { "AlgorithmicStemming": "none", "Synonyms": "{\"aliases\":{\"youth\":[\"young adult\"]},\"groups\":[[\"tool box\",\"toolbox\"],[\"band saw\",\"bandsaw\"],[\"drill press\",\"drillpress\"]]}", "StemmingDictionary": "{}", "Stopwords": "[]" } } } ] }

ドメインに設定された可用性オプションを取得するには

  • aws cloudsearch describe-availability-options コマンドを実行します。たとえば、次のリクエストは、movies ドメインに設定された可用性オプションを取得します。ドメインでマルチ AZ が有効になっている場合、Options 値は true に設定されています。

    aws cloudsearch describe-availability-options --domain-name movies { "AvailabilityOptions": { "Status": { "PendingDeletion": false, "State": "Processing", "CreationDate": "2014-04-30T20:42:57Z", "UpdateVersion": 13, "UpdateDate": "2014-05-01T00:17:45Z" }, "Options": true } }

ドメインに設定された式を取得するには

  • aws cloudsearch describe-expressions コマンドを実行します。たとえば、次のリクエストは、movies ドメインに設定された式を取得します。

    aws cloudsearch describe-expressions --domain-name movies { "Expression": { "Status": { "PendingDeletion": false, "State": "Processing", "CreationDate": "2014-05-01T01:15:18Z", "UpdateVersion": 52, "UpdateDate": "2014-05-01T01:15:18Z" }, "Options": { "ExpressionName": "popularhits", "ExpressionValue": "((0.3*popularity)/10.0)+(0.7* _score)" } } }

AWS SDK を使用したドメイン情報の取得

AWS SDK では(Android および iOS SDK を除く)、DescribeDomains も含めて、Amazon CloudSearch 設定 API で定義されたすべての Amazon CloudSearch アクションがサポートされています。AWS SDK のインストールと使用の詳細については、「AWS Software Development Kits」を参照してください。

DescribeDomains アクションは、ドメインの検索可能ドキュメント数を返しません。検索可能ドキュメントの数を取得するには、コンソールを使用するか、matchall リクエストをドメインの検索エンドポイントに送信します。

q=matchall&q.parser=structured&size=0