GetItem

importante

Esta sección se refiere a la versión 2011-12-05 del API, que está obsoleta y no debe utilizarse para nuevas aplicaciones.

Para consultar la documentación sobre la API de bajo nivel actual, consulte la Referencia de la API de Amazon DynamoDB.

Descripción

La operación GetItem devuelve un conjunto de Attributes de un elemento que coincida con la clave principal. Si no hay ningún elemento que coincida, GetItem no devuelve ningún dato.

De forma predeterminada, la operación GetItem proporciona una lectura eventualmente consistente. Si las lecturas coherentes posteriores no son aceptables en su aplicación, use ConsistentRead. Aunque esta operación puede tardar más que una lectura normal, siempre devuelve el último valor actualizado. Para obtener más información, consulte Coherencia de lectura de DynamoDB.

Solicitudes

Sintaxis

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

Nombre	Descripción	Obligatorio
TableName	Nombre de la tabla que contiene el elemento solicitado. Tipo: cadena	Sí
Key	Valores de clave principal que definen el elemento. Para obtener más información sobre claves principales, consulte Clave principal. Tipo: Map, mapa de HashKeyElement a su valor y RangeKeyElement a su valor.	Sí
AttributesToGet	Matriz de nombres de atributo. Si no se especifican sus nombres, se devuelven todos los atributos. Si algún atributo no se encuentra, no aparecerá en los resultados. Tipo: matriz	No
ConsistentRead	Si se establece en true, se emite una lectura consistente; en caso contrario, se utiliza una lectura consistente final. Tipo: Booleano	No

Respuestas

Sintaxis

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
}

Nombre	Descripción
Item	Contiene los atributos solicitados. Tipo: Map, mapa de pares de nombre-valor del atributo.
ConsumedCapacityUnits	Cantidad de unidades de capacidad de lectura consumidas por la operación. Este valor muestra el número aplicado al rendimiento aprovisionado. Las solicitudes de elementos inexistentes consumen las unidades de capacidad de lectura mínimas, según el tipo de lectura. Para obtener más información, consulte Modo de capacidad aprovisionada de DynamoDB. Tipo: Number

Errores especiales

No hay errores específicos de esta operación.

Ejemplos

Para obtener ejemplos sobre cómo usar el SDK de AWS, consulte Uso de elementos y atributos en DynamoDB.

Solicitud de ejemplo

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

Respuesta de ejemplo

Observe que el valor de ConsumedCapacityUnits es 1, ya que el parámetro opcional ConsistentRead se ha establecido en true. Si ConsistentRead se establece en false (o no se especifica) para la misma solicitud, la respuesta presentará consistencia final, en cuyo caso el valor de ConsumedCapacityUnits sería 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
}