GetItemCommand

Use a bare-bones client and the command you need to make an API call.

GetItemCommandInput

[GetItemCommandInput](@aws-sdk/client-dynamodb!GetItemCommandInput:Interface)

The <code>GetItem</code> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <code>GetItem</code> does not return any data and there will be no <code>Item</code> element in the response. <code>GetItem</code> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <code>ConsistentRead</code> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

A map of attribute names to <code>AttributeValue</code> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

TableName

The name of the table containing the requested item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

AttributesToGet

This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the Amazon DynamoDB Developer Guide.

ConsistentRead

Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

ExpressionAttributeNames

One or more substitution tokens for attribute names in an expression. The following are some use cases for using <code>ExpressionAttributeNames</code>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul> <li> <code>Percentile</code> </li> </ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for <code>ExpressionAttributeNames</code>: <ul> <li> <code>{"#P":"Percentile"}</code> </li> </ul> You could then use this substitution in an expression, as in this example: <ul> <li> <code>#P = :val</code> </li> </ul> <note> Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. </note> For more information on expression attribute names, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the Amazon DynamoDB Developer Guide.

ProjectionExpression

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Specifying Item Attributes</a> in the Amazon DynamoDB Developer Guide.

ReturnConsumedCapacity

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response: <ul> <li> <code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed. Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s). </li> <li> <code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation. </li> <li> <code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response. </li> </ul>

The input for [GetItemCommand](@aws-sdk/client-dynamodb!GetItemCommand:Class).

$metadata

ConsumedCapacity

The capacity units consumed by the <code>GetItem</code> operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. <code>ConsumedCapacity</code> is only returned if the <code>ReturnConsumedCapacity</code> parameter was specified. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption">Capacity unit consumption for read operations</a> in the Amazon DynamoDB Developer Guide.

Item

A map of attribute names to <code>AttributeValue</code> objects, as specified by <code>ProjectionExpression</code>.

GetItemCommandOutput

The output of [GetItemCommand](@aws-sdk/client-dynamodb!GetItemCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

[Symbol.hasInstance]

instance

Custom instanceof check to support the operator for ServiceException base class

isInstance

value

Checks if a value is an instance of ServiceException (duck typed)

name

InternalServerError

An error occurred on the server side.

Message

InvalidEndpointException

ProvisionedThroughputExceededException

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff">Error Retries and Exponential Backoff</a> in the Amazon DynamoDB Developer Guide.

RequestLimitExceeded

Throughput exceeds the current throughput quota for your account. Please contact <a href="https://aws.amazon.com/support">Amazon Web ServicesSupport</a> to request a quota increase.

ResourceNotFoundException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.

DynamoDBServiceException

Base exception class for all service exceptions from DynamoDB service.