# Generated by default/object.tt package Paws::DynamoDB::KeysAndAttributes; use Moose; has AttributesToGet => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has ConsistentRead => (is => 'ro', isa => 'Bool'); has ExpressionAttributeNames => (is => 'ro', isa => 'Paws::DynamoDB::ExpressionAttributeNameMap'); has Keys => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::Key]', required => 1); has ProjectionExpression => (is => 'ro', isa => 'Str'); 1; ### main pod documentation begin ### =head1 NAME Paws::DynamoDB::KeysAndAttributes =head1 USAGE This class represents one of two things: =head3 Arguments in a call to a service Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object. As an example, if Att1 is expected to be a Paws::DynamoDB::KeysAndAttributes object: $service_obj->Method(Att1 => { AttributesToGet => $value, ..., ProjectionExpression => $value }); =head3 Results returned from an API call Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::KeysAndAttributes object: $result = $service_obj->Method(...); $result->Att1->AttributesToGet =head1 DESCRIPTION Represents a set of primary keys and, for each key, the attributes to retrieve from the table. For each primary key, you must provide I of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide I the partition key and the sort key. =head1 ATTRIBUTES =head2 AttributesToGet => ArrayRef[Str|Undef] This is a legacy parameter. Use C instead. For more information, see Legacy Conditional Parameters (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html) in the I. =head2 ConsistentRead => Bool The consistency of a read operation. If set to C, then a strongly consistent read is used; otherwise, an eventually consistent read is used. =head2 ExpressionAttributeNames => L One or more substitution tokens for attribute names in an expression. The following are some use cases for using C: =over =item * To access an attribute whose name conflicts with a DynamoDB reserved word. =item * To create a placeholder for repeating occurrences of an attribute name in an expression. =item * To prevent special characters in an attribute name from being misinterpreted in an expression. =back Use the B<#> character in an expression to dereference an attribute name. For example, consider the following attribute name: =over =item * C =back 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 I). To work around this, you could specify the following for C: =over =item * C<{"#P":"Percentile"}> =back You could then use this substitution in an expression, as in this example: =over =item * C<#P = :val> =back Tokens that begin with the B<:> character are I, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the I. =head2 B Keys => ArrayRef[L] The primary key attribute values that define the items and the attributes associated with the items. =head2 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 C 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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the I. =head1 SEE ALSO This class forms part of L, describing an object used in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut