File Coverage

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