File Coverage

blib/lib/Paws/DynamoDB/BatchGetItem.pm

Criterion	Covered	Total	%
statement	12	12	100.0
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	16	16	100.0

line	stmt	sub	time	code
1
2				package Paws::DynamoDB::BatchGetItem;
3	1	1	432	use Moose;
	1	2	4
	1		7
	2		1039
	2		6
	2		14
4				has RequestItems => (is => 'ro', isa => 'Paws::DynamoDB::BatchGetRequestMap', required => 1);
5				has ReturnConsumedCapacity => (is => 'ro', isa => 'Str');
6
7	1	1	7024	use MooseX::ClassAttribute;
	1	2	3
	1		10
	2		11751
	2		4
	2		15
8
9				class_has _api_call => (isa => 'Str', is => 'ro', default => 'BatchGetItem');
10				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDB::BatchGetItemOutput');
11				class_has _result_key => (isa => 'Str', is => 'ro');
12				1;
13
14				### main pod documentation begin ###
15
16				=head1 NAME
17
18				Paws::DynamoDB::BatchGetItem - Arguments for method BatchGetItem on Paws::DynamoDB
19
20				=head1 DESCRIPTION
21
22				This class represents the parameters used for calling the method BatchGetItem on the
23				Amazon DynamoDB service. Use the attributes of this class
24				as arguments to method BatchGetItem.
25
26				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchGetItem.
27
28				As an example:
29
30				$service_obj->BatchGetItem(Att1 => $value1, Att2 => $value2, ...);
31
32				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.
33
34				=head1 ATTRIBUTES
35
36
37				=head2 B<REQUIRED> RequestItems => L<Paws::DynamoDB::BatchGetRequestMap>
38
39				A map of one or more table names and, for each table, a map that
40				describes one or more items to retrieve from that table. Each table
41				name can be used only once per C<BatchGetItem> request.
42
43				Each element in the map of items to retrieve consists of the following:
44
45				=over
46
47				=item *
48
49				C<ConsistentRead> - If C<true>, a strongly consistent read is used; if
50				C<false> (the default), an eventually consistent read is used.
51
52				=item *
53
54				C<ExpressionAttributeNames> - One or more substitution tokens for
55				attribute names in the C<ProjectionExpression> parameter. The following
56				are some use cases for using C<ExpressionAttributeNames>:
57
58				=over
59
60				=item *
61
62				To access an attribute whose name conflicts with a DynamoDB reserved
63				word.
64
65				=item *
66
67				To create a placeholder for repeating occurrences of an attribute name
68				in an expression.
69
70				=item *
71
72				To prevent special characters in an attribute name from being
73				misinterpreted in an expression.
74
75				=back
76
77				Use the B<#> character in an expression to dereference an attribute
78				name. For example, consider the following attribute name:
79
80				=over
81
82				=item *
83
84				C<Percentile>
85
86				=back
87
88				The name of this attribute conflicts with a reserved word, so it cannot
89				be used directly in an expression. (For the complete list of reserved
90				words, see Reserved Words in the I<Amazon DynamoDB Developer Guide>).
91				To work around this, you could specify the following for
92				C<ExpressionAttributeNames>:
93
94				=over
95
96				=item *
97
98				C<{"#P":"Percentile"}>
99
100				=back
101
102				You could then use this substitution in an expression, as in this
103				example:
104
105				=over
106
107				=item *
108
109				C<#P = :val>
110
111				=back
112
113				Tokens that begin with the B<:> character are I<expression attribute
114				values>, which are placeholders for the actual value at runtime.
115
116				For more information on expression attribute names, see Accessing Item
117				Attributes in the I<Amazon DynamoDB Developer Guide>.
118
119				=item *
120
121				C<Keys> - An array of primary key attribute values that define specific
122				items in the table. For each primary key, you must provide I<all> of
123				the key attributes. For example, with a simple primary key, you only
124				need to provide the partition key value. For a composite key, you must
125				provide I<both> the partition key value and the sort key value.
126
127				=item *
128
129				C<ProjectionExpression> - A string that identifies one or more
130				attributes to retrieve from the table. These attributes can include
131				scalars, sets, or elements of a JSON document. The attributes in the
132				expression must be separated by commas.
133
134				If no attribute names are specified, then all attributes will be
135				returned. If any of the requested attributes are not found, they will
136				not appear in the result.
137
138				For more information, see Accessing Item Attributes in the I<Amazon
139				DynamoDB Developer Guide>.
140
141				=item *
142
143				C<AttributesToGet> - This is a legacy parameter. Use
144				C<ProjectionExpression> instead. For more information, see
145				AttributesToGet in the I<Amazon DynamoDB Developer Guide>.
146
147				=back
148
149
150
151
152				=head2 ReturnConsumedCapacity => Str
153
154
155
156				Valid values are: C<"INDEXES">, C<"TOTAL">, C<"NONE">
157
158
159				=head1 SEE ALSO
160
161				This class forms part of L<Paws>, documenting arguments for method BatchGetItem in L<Paws::DynamoDB>
162
163				=head1 BUGS and CONTRIBUTIONS
164
165				The source code is located here: https://github.com/pplu/aws-sdk-perl
166
167				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
168
169				=cut
170