GetItem - AWS AppSync

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

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-282018-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 文件