メニュー
Amazon DynamoDB
開発者ガイド (API Version 2012-08-10)

GetItem

重要

このセクションは、廃止された API バージョン 2011-12-05 についての記述で、新しいアプリケーションで使用することはできません。

現在の低レベル API のドキュメントについては、Amazon DynamoDB API Referenceを参照してください。

説明

GetItem オペレーションは、プライマリキーに一致する項目の Attributes セットを返します。一致する項目がない場合、GetItem はデータを返しません。

GetItem オペレーションは、デフォルトでは、結果整合性のある読み込みを提供します。ご利用のアプリケーションで結果整合性のある読み込みを使用できない場合は、ConsistentRead を使用します。このオペレーションは、標準の読み込みよりも時間がかかる可能性がありますが、常に最後に更新された値を返します。詳細については、「読み込み整合性」を参照してください。

リクエスト

構文

Copy
// This header is abbreviated. // For a sample of a complete header, see DynamoDB 低レベル API. POST / HTTP/1.1 x-amz-target: DynamoDB_20111205.GetItem content-type: application/x-amz-json-1.0 {"TableName":"Table1", "Key": {"HashKeyElement": {"S":"AttributeValue1"}, "RangeKeyElement": {"N":"AttributeValue2"} }, "AttributesToGet":["AttributeName3","AttributeName4"], "ConsistentRead":Boolean }

名前 説明 必須
TableName

リクエストした項目を含んでいるテーブルの名前。

型: 文字列

はい
Key

項目を定義するプライマリキー値。プライマリキーの詳細については、「プライマリキー」を参照してください。

型: HashKeyElement とその値のマップおよび RangeKeyElement とその値のマップ

はい
AttributesToGet

属性名の配列。属性名を省略した場合、すべての属性が返されます。見つからなかった属性は、結果には表示されません。

型: 配列

いいえ
ConsistentRead

true に設定した場合、整合性のある読み込みが実行されます。それ以外の場合は、結果整合性が使用されます。

タイプ: ブール値

いいえ

レスポンス

構文

Copy
HTTP/1.1 200 x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375 content-type: application/x-amz-json-1.0 content-length: 144 {"Item":{ "AttributeName3":{"S":"AttributeValue3"}, "AttributeName4":{"N":"AttributeValue4"}, "AttributeName5":{"B":"dmFsdWU="} }, "ConsumedCapacityUnits": 0.5 }

名前 説明
Item

リクエストした属性が格納されます。

型: 属性名と値のペアのマップ

ConsumedCapacityUnits

オペレーションによって消費された読み込みキャパシティーユニットの数。この値は、プロビジョニングされたスループットに対して適用された数を示します。存在しない項目のリクエストは、読み込みのタイプに応じて最小の読み込みキャパシティーユニットを消費します。詳細については、「読み取りと書き込みのスループット設定」を参照してください。

型: 数値

特殊なエラー

このオペレーションに固有のエラーはありません。

AWS SDK を使用した例については、「DynamoDB での項目の操作」を参照してください。

リクエスト例

Copy
// This header is abbreviated. // For a sample of a complete header, see DynamoDB 低レベル API. POST / HTTP/1.1 x-amz-target: DynamoDB_20111205.GetItem content-type: application/x-amz-json-1.0 {"TableName":"comptable", "Key": {"HashKeyElement":{"S":"Julie"}, "RangeKeyElement":{"N":"1307654345"}}, "AttributesToGet":["status","friends"], "ConsistentRead":true }

レスポンス例

ConsumedCapacityUnits 値が 1 になっています。これは、オプションのパラメータ ConsistentReadtrue に設定されているためです。同じリクエストで、ConsistentReadfalse に設定した場合(または、指定しなかった場合)、結果整合性のあるレスポンスになり、ConsumedCapacityUnits 値は 0.5 になります。

Copy
HTTP/1.1 200 x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375 content-type: application/x-amz-json-1.0 content-length: 72 {"Item": {"friends":{"SS":["Lynda, Aaron"]}, "status":{"S":"online"} }, "ConsumedCapacityUnits": 1 }