NAME

Paws::DynamoDB::GetItem - Arguments for method GetItem on Paws::DynamoDB

DESCRIPTION

This class represents the parameters used for calling the method GetItem on the Amazon DynamoDB service. Use the attributes of this class as arguments to method GetItem.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetItem.

SYNOPSIS

    my $dynamodb = Paws->service('DynamoDB');
    # To read an item from a table
    # 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.
    my $GetItemOutput = $dynamodb->GetItem(
      'Key' => {
        'Artist' => {
          'S' => 'Acme Band'
        },
        'SongTitle' => {
          'S' => 'Happy Day'
        }
      },
      'TableName' => 'Music'
    );

    # Results:
    my $Item = $GetItemOutput->Item;

    # Returns a L<Paws::DynamoDB::GetItemOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/dynamodb/GetItem

ATTRIBUTES

AttributesToGet => ArrayRef[Str|Undef]

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

ConsistentRead => Bool

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

ExpressionAttributeNames => Paws::DynamoDB::ExpressionAttributeNameMap

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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) 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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the Amazon DynamoDB Developer Guide.

REQUIRED Key => Paws::DynamoDB::Key

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.

ProjectionExpression => Str

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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the Amazon DynamoDB Developer Guide.

ReturnConsumedCapacity => Str

Valid values are: "INDEXES", "TOTAL", "NONE"

REQUIRED TableName => Str

The name of the table containing the requested item.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetItem in Paws::DynamoDB

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues