Skip to content
AWS for Query.Farm

aws.dynamodb.get_item

Example SQL Queries

SELECT * FROM
aws.dynamodb.get_item
WHERE
"table_name" = 'VALUE'
AND "key" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
key Required Input Column

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.

MAP(VARCHAR, STRUCT(
        "s" VARCHAR,
        "n" VARCHAR,
        "b" BLOB,
        "ss" VARCHAR[],
        "ns" VARCHAR[],
        "bs" BLOB[],
        "null" BOOLEAN,
        "bool" BOOLEAN
    ))
table_name Required Input Column

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

VARCHAR
attributes_to_get Input Column

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

VARCHAR[]
Show child fields
attributes_to_get[]
consistent_read Input Column

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

BOOLEAN
expression_attribute_names Input Column

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

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.

MAP(VARCHAR, VARCHAR)
projection_expression Input Column

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.

VARCHAR
return_consumed_capacity Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
consumed_capacity

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 Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

STRUCT(
    "table_name" VARCHAR,
    "capacity_units" DOUBLE,
    "read_capacity_units" DOUBLE,
    "write_capacity_units" DOUBLE,
    "table" STRUCT(
        "read_capacity_units" DOUBLE,
        "write_capacity_units" DOUBLE,
        "capacity_units" DOUBLE
    ),
    "local_secondary_indexes" MAP(VARCHAR, STRUCT(
            "read_capacity_units" DOUBLE,
            "write_capacity_units" DOUBLE,
            "capacity_units" DOUBLE
        )),
    "global_secondary_indexes" MAP(VARCHAR, STRUCT(
            "read_capacity_units" DOUBLE,
            "write_capacity_units" DOUBLE,
            "capacity_units" DOUBLE
        ))
)
Show child fields
consumed_capacity.capacity_units

The total number of capacity units consumed by the operation.

consumed_capacity.global_secondary_indexes

The amount of throughput consumed on each global index affected by the operation.

consumed_capacity.local_secondary_indexes

The amount of throughput consumed on each local index affected by the operation.

consumed_capacity.read_capacity_units

The total number of read capacity units consumed by the operation.

consumed_capacity.table

The amount of throughput consumed on the table affected by the operation.

Show child fields
consumed_capacity.table.capacity_units

The total number of capacity units consumed on a table or an index.

consumed_capacity.table.read_capacity_units

The total number of read capacity units consumed on a table or an index.

consumed_capacity.table.write_capacity_units

The total number of write capacity units consumed on a table or an index.

consumed_capacity.table_name

The name of the table that was affected by the operation. If you had specified the Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response.

consumed_capacity.write_capacity_units

The total number of write capacity units consumed by the operation.

item

A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.

MAP(VARCHAR, STRUCT(
        "s" VARCHAR,
        "n" VARCHAR,
        "b" BLOB,
        "ss" VARCHAR[],
        "ns" VARCHAR[],
        "bs" BLOB[],
        "null" BOOLEAN,
        "bool" BOOLEAN
    ))