Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  PAWS::DYNAMODB::GETITEM (3)

.ds Aq ’


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



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 shouln’t make instances of this class. Each attribute should be used as a named argument in the call to GetItem.

As an example:

  $service_obj->GetItem(Att1 => $value1, Att2 => $value2, ...);

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.


    AttributesToGet => ArrayRef[Str]

This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

    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:
o To access an attribute whose name conflicts with a DynamoDB reserved word.
o To create a placeholder for repeating occurrences of an attribute name in an expression.
o To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the <B> name. For example, consider the following attribute name:B>
o 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:
o {"
You could then use this substitution in an expression, as in this example:
Tokens that begin with the <B>:B> character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

    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 will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

ProjectionExpression replaces the legacy AttributesToGet parameter.

    ReturnConsumedCapacity => Str

REQUIRED TableName => Str

The name of the table containing the requested item.


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


The source code is located here:

Please report bugs to:


Hey! <B>The above document had some coding errors, which are explained below:B>
Around line 114: Unterminated B<...> sequence
Around line 133: Unterminated C<...> sequence
Around line 144: Unterminated C<...> sequence
Search for    or go to Top of page |  Section 3 |  Main Index

perl v5.20.3 PAWS::DYNAMODB::GETITEM (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.