DynamoDB / Client / get_item

get_item#

DynamoDB.Client.get_item(**kwargs)#

The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

Request Syntax

response = client.get_item(
    TableName='string',
    Key={
        'string': {
            'S': 'string',
            'N': 'string',
            'B': b'bytes',
            'SS': [
                'string',
            ],
            'NS': [
                'string',
            ],
            'BS': [
                b'bytes',
            ],
            'M': {
                'string': {'... recursive ...'}
            },
            'L': [
                {'... recursive ...'},
            ],
            'NULL': True|False,
            'BOOL': True|False
        }
    },
    AttributesToGet=[
        'string',
    ],
    ConsistentRead=True|False,
    ReturnConsumedCapacity='INDEXES'|'TOTAL'|'NONE',
    ProjectionExpression='string',
    ExpressionAttributeNames={
        'string': 'string'
    }
)

Parameters:

TableName (string) –
[REQUIRED]

The name of the table containing the requested item.
Key (dict) –
[REQUIRED]

A map of attribute names to AttributeValue 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.
- (string) –
  - (dict) –
    
    Represents the data for an attribute.
    
    Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
    
    For more information, see Data Types in the Amazon DynamoDB Developer Guide.
    - S (string) –
      
      An attribute of type String. For example:
      
      "S": "Hello"
    - N (string) –
      
      An attribute of type Number. For example:
      
      "N": "123.45"
      
      Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
    - B (bytes) –
      
      An attribute of type Binary. For example:
      
      "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
    - SS (list) –
      
      An attribute of type String Set. For example:
      
      "SS": ["Giraffe", "Hippo" ,"Zebra"]
      - (string) –
    - NS (list) –
      
      An attribute of type Number Set. For example:
      
      "NS": ["42.2", "-19", "7.5", "3.14"]
      
      Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
      - (string) –
    - BS (list) –
      
      An attribute of type Binary Set. For example:
      
      "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
      - (bytes) –
    - M (dict) –
      
      An attribute of type Map. For example:
      
      "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
      - (string) –
        
        (dict) –
        
        Represents the data for an attribute.
        
        Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
        
        For more information, see Data Types in the Amazon DynamoDB Developer Guide.
    - L (list) –
      
      An attribute of type List. For example:
      
      "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]
      - (dict) –
        
        Represents the data for an attribute.
        
        Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
        
        For more information, see Data Types in the Amazon DynamoDB Developer Guide.
    - NULL (boolean) –
      
      An attribute of type Null. For example:
      
      "NULL": true
    - BOOL (boolean) –
      
      An attribute of type Boolean. For example:
      
      "BOOL": true
AttributesToGet (list) –
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
- (string) –
ConsistentRead (boolean) – Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
ReturnConsumedCapacity (string) –
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
- INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed. Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
- TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
- NONE - No ConsumedCapacity details are included in the response.
ProjectionExpression (string) –
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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
ExpressionAttributeNames (dict) –
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
- To access an attribute whose name conflicts with a DynamoDB reserved word.
- To create a placeholder for repeating occurrences of an attribute name in an expression.
- To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
- Percentile
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 Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
- {"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
- #P = :val
Note
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Item': {
        'string': {
            'S': 'string',
            'N': 'string',
            'B': b'bytes',
            'SS': [
                'string',
            ],
            'NS': [
                'string',
            ],
            'BS': [
                b'bytes',
            ],
            'M': {
                'string': {'... recursive ...'}
            },
            'L': [
                {'... recursive ...'},
            ],
            'NULL': True|False,
            'BOOL': True|False
        }
    },
    'ConsumedCapacity': {
        'TableName': 'string',
        'CapacityUnits': 123.0,
        'ReadCapacityUnits': 123.0,
        'WriteCapacityUnits': 123.0,
        'Table': {
            'ReadCapacityUnits': 123.0,
            'WriteCapacityUnits': 123.0,
            'CapacityUnits': 123.0
        },
        'LocalSecondaryIndexes': {
            'string': {
                'ReadCapacityUnits': 123.0,
                'WriteCapacityUnits': 123.0,
                'CapacityUnits': 123.0
            }
        },
        'GlobalSecondaryIndexes': {
            'string': {
                'ReadCapacityUnits': 123.0,
                'WriteCapacityUnits': 123.0,
                'CapacityUnits': 123.0
            }
        }
    }
}

Response Structure

(dict) –

Represents the output of a GetItem operation.
- Item (dict) –
  
  A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.
  - (string) –
    - (dict) –
      
      Represents the data for an attribute.
      
      Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
      
      For more information, see Data Types in the Amazon DynamoDB Developer Guide.
      - S (string) –
        
        An attribute of type String. For example:
        
        "S": "Hello"
      - N (string) –
        
        An attribute of type Number. For example:
        
        "N": "123.45"
        
        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
      - B (bytes) –
        
        An attribute of type Binary. For example:
        
        "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
      - SS (list) –
        
        An attribute of type String Set. For example:
        
        "SS": ["Giraffe", "Hippo" ,"Zebra"]
        
        (string) –
      - NS (list) –
        
        An attribute of type Number Set. For example:
        
        "NS": ["42.2", "-19", "7.5", "3.14"]
        
        Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
        
        (string) –
      - BS (list) –
        
        An attribute of type Binary Set. For example:
        
        "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
        
        (bytes) –
      - M (dict) –
        
        An attribute of type Map. For example:
        
        "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
        
        (string) –
        
        (dict) –
        
        Represents the data for an attribute.
        
        Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
        
        For more information, see Data Types in the Amazon DynamoDB Developer Guide.
      - L (list) –
        
        An attribute of type List. For example:
        
        "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]
        
        (dict) –
        
        Represents the data for an attribute.
        
        Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
        
        For more information, see Data Types in the Amazon DynamoDB Developer Guide.
      - NULL (boolean) –
        
        An attribute of type Null. For example:
        
        "NULL": true
      - BOOL (boolean) –
        
        An attribute of type Boolean. For example:
        
        "BOOL": true
- ConsumedCapacity (dict) –
  
  The capacity units consumed by the GetItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
  - TableName (string) –
    
    The name of the table that was affected by the operation.
  - CapacityUnits (float) –
    
    The total number of capacity units consumed by the operation.
  - ReadCapacityUnits (float) –
    
    The total number of read capacity units consumed by the operation.
  - WriteCapacityUnits (float) –
    
    The total number of write capacity units consumed by the operation.
  - Table (dict) –
    
    The amount of throughput consumed on the table affected by the operation.
    - ReadCapacityUnits (float) –
      
      The total number of read capacity units consumed on a table or an index.
    - WriteCapacityUnits (float) –
      
      The total number of write capacity units consumed on a table or an index.
    - CapacityUnits (float) –
      
      The total number of capacity units consumed on a table or an index.
  - LocalSecondaryIndexes (dict) –
    
    The amount of throughput consumed on each local index affected by the operation.
    - (string) –
      - (dict) –
        
        Represents the amount of provisioned throughput capacity consumed on a table or an index.
        
        ReadCapacityUnits (float) –
        
        The total number of read capacity units consumed on a table or an index.
        
        WriteCapacityUnits (float) –
        
        The total number of write capacity units consumed on a table or an index.
        
        CapacityUnits (float) –
        
        The total number of capacity units consumed on a table or an index.
  - GlobalSecondaryIndexes (dict) –
    
    The amount of throughput consumed on each global index affected by the operation.
    - (string) –
      - (dict) –
        
        Represents the amount of provisioned throughput capacity consumed on a table or an index.
        
        ReadCapacityUnits (float) –
        
        The total number of read capacity units consumed on a table or an index.
        
        WriteCapacityUnits (float) –
        
        The total number of write capacity units consumed on a table or an index.
        
        CapacityUnits (float) –
        
        The total number of capacity units consumed on a table or an index.

Exceptions

DynamoDB.Client.exceptions.ProvisionedThroughputExceededException
DynamoDB.Client.exceptions.ResourceNotFoundException
DynamoDB.Client.exceptions.RequestLimitExceeded
DynamoDB.Client.exceptions.InternalServerError

Examples

This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes.

response = client.get_item(
    Key={
        'Artist': {
            'S': 'Acme Band',
        },
        'SongTitle': {
            'S': 'Happy Day',
        },
    },
    TableName='Music',
)

print(response)

Expected Output:

{
    'Item': {
        'AlbumTitle': {
            'S': 'Songs About Life',
        },
        'Artist': {
            'S': 'Acme Band',
        },
        'SongTitle': {
            'S': 'Happy Day',
        },
    },
    'ResponseMetadata': {
        '...': '...',
    },
}