GetItem - Amazon DynamoDB
DescriçãoSolicitaçõesRespostasErros especiaisExemplos

GetItem

Importante

Esta seção refere-se à versão de API 2011-12-05, que está obsoleta e não deve ser usada para novos aplicativos.

Para obter a documentação da API de baixo nível atual, consulte a Referência da API do Amazon DynamoDB.

Descrição

A operação GetItem retorna um conjunto de Attributes para um item que corresponde à chave primária. Se não houver item correspondente, GetItem não retornará quaisquer dados.

A operação GetItem fornece uma leitura final consistente por padrão. Caso a aplicação não aceite leituras finais consistentes, use ConsistentRead. Embora essa operação possa demorar mais do que uma leitura padrão, ela sempre retorna o último valor atualizado. Para ter mais informações, consulte Consistência de leitura do DynamoDB.

Solicitações

Sintaxe

// This header is abbreviated.
// For a sample of a complete header, see API de baixo nível do 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
}
Nome Descrição Obrigatório
TableName

O nome da tabela que contém o item solicitado.

Tipo: string

 Sim
Key

Os valores de chave primária que definem o item. Para obter mais informações sobre chaves primárias, consulte Chave primária.

Tipo: mapa de HashKeyElement para seu valor e RangeKeyElement para seu valor.

 Sim
AttributesToGet

Matriz de nomes de atributos. Se os nomes de atributos não forem especificados, todos os atributos serão retornados. Se alguns atributos não forem encontrados, eles não serão exibidos no resultado.

Tipo: matriz

 Não
ConsistentRead

Se definido como true, uma leitura consistente será emitida; caso contrário, uma leitura eventualmente consistente será usada.

Tipo: booliano

 Não

Respostas

Sintaxe

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
}
Nome Descrição
Item

Contém os atributos solicitados.

Tipo: mapa de pares de nome-valor de atributo.
ConsumedCapacityUnits

O número de unidades de capacidade de leitura consumidas pela operação. Esse valor mostra o número utilizado no throughput provisionado. As solicitações de itens não existentes consomem o mínimo de unidades de capacidade de leitura, dependendo do tipo de leitura. Para ter mais informações, consulte Modo de capacidade provisionada do DynamoDB.

Tipo: número

Erros especiais

Não há erros específicos para esta operação.

Exemplos

Para obter exemplos sobre o uso do AWS SDK, consulte Trabalhar com itens e atributos no DynamoDB.

Exemplo de solicitação

// This header is abbreviated.
// For a sample of a complete header, see API de baixo nível do 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
}

Exemplo de resposta

Observe que o valor ConsumedCapacityUnits é 1, pois o parâmetro opcional ConsistentRead está definido como true. Se ConsistentRead estiver definido como false (ou não especificado) para a mesma solicitação, a resposta é eventualmente consistente e o valor ConsumedCapacityUnits seria 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
}