GetItem - Amazon DynamoDB
DescriptionRequêtesRéponsesErreurs spécialesExemples

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

GetItem

Important

Cette section fait référence à l'API version 2011-12-05 qui est obsolète et ne doit pas être utilisée pour de nouvelles applications.

Pour une documentation sur l'API de bas niveau actuelle, consultez la Référence d'API Amazon DynamoDB.

Description

L'opération GetItem renvoie un ensemble d'Attributes pour un élément correspondant à la clé primaire. Si aucun élément correspondant n'est trouvé, GetItem ne renvoie pas de données.

L'opération GetItem fournit une lecture éventuellement cohérente par défaut. Si les lectures éventuellement cohérentes ne sont pas acceptables pour votre application, utilisez ConsistentRead. Bien que cette opération puisse prendre plus de temps qu'une lecture standard, elle renvoie toujours la dernière valeur mise à jour. Pour de plus amples informations, consultez Cohérence en lecture DynamoDB.

Requêtes

Syntaxe

// This header is abbreviated.
// For a sample of a complete header, see API de bas niveau de DynamoDB.
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
}
Name (Nom) Description Obligatoire
TableName

Nom de la table contenant l'élément demandé.

Type : String

 Oui
Key

Valeurs de clé primaire définissant l'élément. Pour plus d'informations sur les clés primaires, consultez Clé primaire.

Type : mappage de HashKeyElement à sa valeur, et de RangeKeyElement à sa valeur.

 Oui
AttributesToGet

Tableau de noms d'attribut. Si des noms d'attribut ne sont pas spécifiés, tous les attributs sont renvoyés. Si certains attributs ne sont pas trouvés, ils n'apparaissent pas dans le résultat.

Type : Array

 Non
ConsistentRead

Si la valeur est définie sur true, une lecture cohérente est effectuée. Sinon une cohérence éventuelle est utilisée.

Type : booléen

 Non

Réponses

Syntaxe

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
}
Name (Nom) Description
Item

Contient les attributs demandés.

Type : mappage de paires nom-valeur d'attribut.
ConsumedCapacityUnits

Nombre d'unités de capacité de lecture consommées par l'opération. Cette valeur indique le nombre appliqué à votre débit approvisionné. Les demandes d'éléments inexistants consomment les unités de capacité de lecture minimum, selon le type de lecture. Pour plus d’informations, consultez Mode de capacité provisionnée DynamoDB.

Type : nombre

Erreurs spéciales

Aucune erreur spécifique à cette opération.

Exemples

Pour des exemples d'utilisation du kit SDK AWS, consultez Utilisation d’éléments et d’attributs dans DynamoDB.

Exemple de demande

// This header is abbreviated.
// For a sample of a complete header, see API de bas niveau de DynamoDB.
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
}

Exemple de réponse

Notez que la valeur de ConsumedCapacityUnits est 1 parce que le paramètre facultatif ConsistentRead a la valeur true. Si ConsistentRead a la valeur false (ou si la valeur n'est pas spécifiée) pour la même demande, la réponse est éventuellement cohérente et la valeur de ConsumedCapacityUnits est 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
}