GetItem - Amazon DynamoDB
説明リクエストレスポンス特殊なエラー例

GetItem

重要

このセクションでは、API バージョン 2011-12-05 について言及しています。これは非推奨なので、新しいアプリケーションに使用しないでください。

現在の低レベルの API に関するドキュメントについては、Amazon DynamoDB API リファレンスを参照してください。

説明

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

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

リクエスト

構文

// 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 に設定されている場合、整合性のある読み込みが発行されます。それ以外の場合、結果整合性が使用されます。

型: ブール値

 いいえ

レスポンス

構文

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

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

型: 数値

特殊なエラー

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

例

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

リクエスト例

// 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 であることに注意してください。これは、オプションのパラメータ ConsistentRead が true に設定されているからです。同じリクエストで ConsistentRead が false に設定されている場合 (または指定されていない場合)、レスポンスは結果整合性で、ConsumedCapacityUnits の値は 0.5 になります。

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
}