AWS AppSync リゾルバ (VTL) の書き方サンプル No.2 – Amazon DynamoDB BatchGetItem

こんにちは、広野です。

AWS AppSync を使用したアプリケーションを開発する機会があり、リゾルバ、主に VTL の書き方に関してまとまった知識が得られたので紹介します。前回の続きもので、BatchGetItem の書き方を紹介します。

本記事では、VTL の書き方にフォーカスしています。ご了承ください。

AWS AppSync、リゾルバ、VTL の説明については以下の記事をご覧下さい。

AWS AppSync リゾルバ (VTL) の書き方サンプル No.1 - Amazon DynamoDB GetItem

Amazon DynamoDB に VTL で GetItem をかけるときの基本的な書き方を紹介します。

AWS AppSync を使って React アプリからキックした非同期ジョブの結果をプッシュ通知で受け取る

非同期ジョブを実行した後、結果をどう受け取るか？というのは開発者として作り込み甲斐のあるテーマです。今回は React アプリが非同期ジョブを実行した後に、AWS AppSync 経由でジョブ完了のプッシュ通知を受け取る仕組みを紹介します。

Amazon DynamoDB に BatchGetItem する VTL
1. リクエストマッピングテンプレート
2. レスポンスマッピングテンプレート
まとめ

Amazon DynamoDB に BatchGetItem する VTL

例えば、AWS AppSync から以下のリクエストを受けたとします。Amazon DynamoDB には適切なデータがある想定です。テーブル名はリゾルバの別の設定 (Data Source) で行います。

引数となるパラメータ：　パーティションキー pkey、ソートキー skey
必要なレスポンス：　data1, data2 という属性の値、ただし予め決まったルールで2アイテム分のデータが必要

今回は受け取った1つのソートキーパラメータを加工して、2種類のソートキーを VTL で作成します。
もちろん最初から引数として2つのソートキーを渡すこともできますし、パーティションキーを変えてもいいです。いずれにしても、同じテーブルに対して複数の GetItem を 1回のクエリで取得したいときに便利で、かつアプリに結果を戻すときに複数のクエリ結果を融合して返すことが可能です。

マッピングテンプレートは JSON 形式で記述します。その中に VTL が混在する感じです。

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

#set($skey1 = "skey1#"+$context.arguments.skey)
#set($skey2 = "skey2#"+$context.arguments.skey)
{
  "version": "2018-05-29",
  "operation": "BatchGetItem",
  "tables": {
    "DynamoDBTableName": {
      "keys": [
        {
          "pkey": $util.dynamodb.toDynamoDBJson($context.arguments.pkey),
          "skey": $util.dynamodb.toDynamoDBJson($skey1)
        },
        {
          "pkey": $util.dynamodb.toDynamoDBJson($context.arguments.pkey),
          "skey": $util.dynamodb.toDynamoDBJson($skey2)
        }
      ]
    }
  }
}

operation には、BatchGetItem を書きます。これは Amazon DynamoDB に BatchGetItem をするぞ、という意思表示です。

DynamDB テーブル名も入れる必要があります。DynamoDBTableName の部分は、実際にクエリをかけるテーブル名に書き換えます。

アプリから受け取った引数はマッピングテンプレート内では $context.arguments 内に格納されます。keys に受け取った引数を埋め込みたいのですが、ここでは、pkey はそのまま。skey に対してテンプレート冒頭で #set() で値を2種類に加工しています。変数名は $skey1, $skey2 にしています。加工後の変数を BatchGetItem のソートキーの引数として指定していると思って下さい。

これで Amazon DynamoDB に GetItem をかけることができます。

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

2つの GetItem が行われた結果は実行順に配列に格納されます。値を取り出して、任意の JSON データ構造にして返すことになります。

$util.toJson({
  "skey1data1": $context.result.data.DynamoDBTableName[0].data1
  "skey1data2": $context.result.data.DynamoDBTableName[0].data2
  "skey2data1": $context.result.data.DynamoDBTableName[1].data1
  "skey2data2": $context.result.data.DynamoDBTableName[1].data2
})

VTL に関しては以下の AWS 公式ドキュメントも必要に応じてご確認ください。