BatchGetItem

BatchGetItem リクエストマッピングドキュメントを使用すると、 AWS AppSync DynamoDB リゾルバーに、複数のテーブルにまたがる可能性のある複数の項目を取得するリクエストを DynamoDB BatchGetItemに行うように指示できます。このリクエストテンプレートでは、以下の情報を指定する必要があります。

DynamoDB の BatchGetItem 制限が適用されるため、条件式を指定することはできません。

BatchGetItem マッピングドキュメントの構造は次のとおりです。

{
    "version" : "2018-05-29",
    "operation" : "BatchGetItem",
    "tables" : {
        "table1": {
           "keys": [
              ## Item to retrieve Key
              {
                   "foo" : ... typed value,
                   "bar" : ... typed value
              },
              ## Item2 to retrieve Key
              {
                   "foo" : ... typed value,
                   "bar" : ... typed value
              }
            ],
            "consistentRead": true|false,            
            "projection" : {
                 ...
            }
        },
        "table2": {
           "keys": [
              ## Item3 to retrieve Key
              {
                   "foo" : ... typed value,
                   "bar" : ... typed value
              },
              ## Item4 to retrieve Key
              {
                   "foo" : ... typed value,
                   "bar" : ... typed value
              }
            ],
            "consistentRead": true|false,
            "projection" : {
                 ...
            }
        }
    }
}

各フィールドの定義は以下のようになります。

BatchGetItem フィールド

覚えておくべきポイント:

以下に示しているのは、リクエストマッピングテンプレートの例です。

{
  "version": "2018-05-29",
  "operation": "BatchGetItem",
  "tables": {
    "authors": [
        {
          "author_id": {
            "S": "a1"
          }
        },
    ],
    "posts": [
        {
          "author_id": {
            "S": "a1"
          },
          "post_id": {
            "S": "p2"
          }
        }
    ],
  }
}

$ctx.result で使用可能な呼び出し結果は以下のとおりです。

{
   "data": {
     "authors": [null],
     "posts": [
        # Was retrieved
        {
          "author_id": "a1",
          "post_id": "p2",
          "post_title": "title",
          "post_description": "description",
        }
     ]
   },
   "unprocessedKeys": {
     "authors": [
        # This item was not processed due to an error
        {
          "author_id": "a1"
        }
      ],
     "posts": []
   }
}

$ctx.error にエラーに関する詳細が含まれています。リクエストマッピングテンプレートで提供されたキーデータ 、unprocessedKeys、および各テーブルキーは、呼び出し結果に存在することが保証されます。削除された項目は data ブロックにあります。処理されていない項目は、データブロック内で null としてマークされ、unprocessedKeysブロック内に配置されます。

より完全な例については、 AppSync 「チュートリアル: DynamoDB バッチリゾルバー」の「DynamoDB バッチチュートリアル」を参照してください。 DynamoDB