GetItem - AWS AppSync GraphQL
GetItem フィールド例

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

GetItem

GetItem リクエストマッピングドキュメントを使用すると、 AWS AppSync DynamoDB リゾルバーに DynamoDB へのGetItemリクエストを行うように指示し、以下を指定できます。

  • DynamoDB の項目のキー

  • 整合性のある読み込みを使用するかどうか

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

{
    "version" : "2017-02-28",
    "operation" : "GetItem",
    "key" : {
        "foo" : ... typed value,
        "bar" : ... typed value
    },
    "consistentRead" : true,
    "projection" : {
        ...
    }
}

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

GetItem フィールド

version

テンプレート定義バージョン 2017-02-28 と 2018-05-29 は現在サポートされています。この値は必須です。

operation

実行する DynamoDB の処理。GetItem DynamoDB の処理を実行するには、これを GetItem に設定する必要があります。この値は必須です。

key

DynamoDB の項目のキー。DynamoDB の項目には、単一のハッシュキー、またはハッシュキーとソートキーが含まれています。これはテーブルの構造によって変わります。「型付き値」を指定する方法の詳細については、「型システム (リクエストマッピング)」を参照してください。この値は必須です。

consistentRead

DynamoDB で強力な整合性のある読み込みを実行するかどうかを示します。これはオプションであり、デフォルトは false です。

projection

DynamoDB オペレーションから返される属性を指定するために使用されるプロジェクション。プロジェクションの詳細については、「プロジェクション」を参照してください。このフィールドはオプションです。

DynamoDB から返された項目が自動的に GraphQL プリミティブ型と JSON プリミティブ型に変換され、マッピングコンテキスト ($context.result) で参照できます。

DynamoDB の型変換の詳細については、「型システム (リクエストマッピング)」を参照してください。

レスポンスマッピングテンプレートの詳細については、「リゾルバーのマッピングテンプレートの概要」を参照してください。

例

以下の例は、GraphQL クエリ getThing(foo: String!, bar: String!) のマッピングテンプレートです。

{
    "version" : "2017-02-28",
    "operation" : "GetItem",
    "key" : {
        "foo" : $util.dynamodb.toDynamoDBJson($ctx.args.foo),
        "bar" : $util.dynamodb.toDynamoDBJson($ctx.args.bar)
    },
    "consistentRead" : true
}

DynamoDB GetItem API の詳細については、「DynamoDB API のドキュメント」を参照してください。