OpenSearch のリゾルバーのマッピングテンプレートリファレンス - AWS AppSync

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

OpenSearch のリゾルバーのマッピングテンプレートリファレンス

-AWS AppSyncAmazonのリゾルバーOpenSearchService により、GraphQL を使用して既存のデータを保存または取得することが可能になります。OpenSearchアカウントのサービスドメイン。このリゾルバーにより、受信した GraphQL リクエストをOpenSearchサービスリクエストをマッピングし、OpenSearchGraphQL へのサービスレスポンスを返します。このセクションでは、サポートされるのマッピングテンプレートについて説明します。OpenSearchサービスオペレーション。

リクエストマッピングテンプレート

MostOpenSearchサービスリクエストのマッピングテンプレートは一部の変更はあるが共通の構造になっています。次の例では、に対して検索を実行します。OpenSearchサービスドメイン。ドキュメントのタイプはどこにありますかpostとでインデックスが付けられていますid。検索パラメータは body セクションで定義され、query フィールドで定義されている多くの一般的なクエリの句を使用します。この例では "Nadia"、または "Bailey"、あるいはその両方を、ドキュメントの author フィールドに含むドキュメントを検索します。

{ "version":"2017-02-28", "operation":"GET", "path":"/id/post/_search", "params":{ "headers":{}, "queryString":{}, "body":{ "from":0, "size":50, "query" : { "bool" : { "should" : [ {"match" : { "author" : "Nadia" }}, {"match" : { "author" : "Bailey" }} ] } } } } }

レスポンスマッピングテンプレート

他のデータソースと同様に、OpenSearchサービスは応答をに送信しますAWS AppSyncこれは GraphQL に変換する必要があります。

ほとんどの GraphQL クエリは_sourceのフィールドOpenSearchサービスレスポンス。個別のドキュメントまたはドキュメントのリストを返す検索ができるので、で使用される、2 つの共通レスポンスマッピングテンプレートがあります。OpenSearchサービス:

結果のリスト

[ #foreach($entry in $context.result.hits.hits) #if( $velocityCount > 1 ) , #end $utils.toJson($entry.get("_source")) #end ]

個別項目

$utils.toJson($context.result.get("_source"))

operation field

(リクエストマッピングテンプレートのみ)

HTTP メソッドまたは動作 (GET、POST、PUT、HEAD または DELETE) でAWS AppSyncに送信します。OpenSearchService ドメイン。キーと値の両方が文字列である必要があります。

"operation" : "PUT"

path field

(リクエストマッピングテンプレートのみ)

の検索パスOpenSearchからのサービスリクエストAWS AppSync。これはオペレーションの HTTP 動作に対する URL を作成します。キーと値の両方が文字列である必要があります。

"path" : "/indexname/type" "path" : "/indexname/type/_search"

マッピングテンプレートが評価されると、このパスは、OpenSearchService ドメイン。たとえば、前の例では次のように変換される可能性があります。

GET https://opensearch-domain-name.REGION.es.amazonaws.com/indexname/type/_search

params field

(リクエストマッピングテンプレートのみ)

検索実行時のアクションを指定するために使用され、一般に、query 値を body 内に設定します。ただし、レスポンスのフォーマットなど、他のいくつかの機能を設定できます。

  • ヘッダ

    ヘッダー情報は、キーと値のペアです。キーと値の両方が文字列である必要があります。例:

    "headers" : { "Content-Type" : "application/json" }

    注意:AWS AppSyncではとして JSON のみがサポートされています。Content-Type

  • queryString

    一般的なオプション (JSON レスポンスのコードフォーマットなど) を指定するキーと値のペア。キーと値の両方が文字列である必要があります。たとえば、整形表示の JSON を取得する場合は、次を使用します。

    "queryString" : { "pretty" : "true" }
  • body

    これは、リクエストの主要部で許可されます。AWS AppSyncに整形表示の検索リクエストを作成できます。OpenSearchService ドメイン。キーはオブジェクトで構成される文字列である必要があります。2 つのデモを以下に示します。

例 1

都市が「seattle」に一致するすべてのドキュメントを返します。

"body":{ "from":0, "size":50, "query" : { "match" : { "city" : "seattle" } } }

例 2

都市または州が「washington」に一致するすべてのドキュメントを返します。

"body":{ "from":0, "size":50, "query" : { "multi_match" : { "query" : "washington", "fields" : ["city", "state"] } } }

渡す変数

(リクエストマッピングテンプレートのみ)

VTL ステートメントの評価の一部として変数を渡すこともできます。たとえば、次のような GraphQL クエリがあるとします。

query { searchForState(state: "washington"){ ... } }

マッピングテンプレートは引数として state をとることができます。

"body":{ "from":0, "size":50, "query" : { "multi_match" : { "query" : "$context.arguments.state", "fields" : ["city", "state"] } } }

VTL に含めることができるユーティリティのリストについては、「Access Request Headers」を参照してください。