blib/lib/Paws/DynamoDB/ScanOutput.pm

filter: Statementstmt 100% 10 / 10 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 1 / 1 Podpod n/a totaltotal 100% 11 / 11 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/DynamoDB/Scan.pm ↑ Summary blib/lib/Paws/DynamoDB/SecondaryIndexesCapacityMap.pm »
1  
2 package Paws::DynamoDB::ScanOutput;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has ConsumedCapacity => (is => 'ro', isa => 'Paws::DynamoDB::ConsumedCapacity');
5 1 has Count => (is => 'ro', isa => 'Int');
6 1 has Items => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::AttributeMap]');
7 1 has LastEvaluatedKey => (is => 'ro', isa => 'Paws::DynamoDB::Key');
8 1 has ScannedCount => (is => 'ro', isa => 'Int');
9  
10 1 has _request_id => (is => 'ro', isa => 'Str');
11  
12 ### main pod documentation begin ###
13  
14 =head1 NAME
15  
16 Paws::DynamoDB::ScanOutput
17  
18 =head1 ATTRIBUTES
19  
20  
21 =head2 ConsumedCapacity => L<Paws::DynamoDB::ConsumedCapacity>
22  
23 The capacity units consumed by the C<Scan> operation. The data returned
24 includes the total provisioned throughput consumed, along with
25 statistics for the table and any indexes involved in the operation.
26 C<ConsumedCapacity> is only returned if the C<ReturnConsumedCapacity>
27 parameter was specified. For more information, see Provisioned
28 Throughput
29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
30 in the I<Amazon DynamoDB Developer Guide>.
31  
32  
33 =head2 Count => Int
34  
35 The number of items in the response.
36  
37 If you set C<ScanFilter> in the request, then C<Count> is the number of
38 items returned after the filter was applied, and C<ScannedCount> is the
39 number of matching items before the filter was applied.
40  
41 If you did not use a filter in the request, then C<Count> is the same
42 as C<ScannedCount>.
43  
44  
45 =head2 Items => ArrayRef[L<Paws::DynamoDB::AttributeMap>]
46  
47 An array of item attributes that match the scan criteria. Each element
48 in this array consists of an attribute name and the value for that
49 attribute.
50  
51  
52 =head2 LastEvaluatedKey => L<Paws::DynamoDB::Key>
53  
54 The primary key of the item where the operation stopped, inclusive of
55 the previous result set. Use this value to start a new operation,
56 excluding this value in the new request.
57  
58 If C<LastEvaluatedKey> is empty, then the "last page" of results has
59 been processed and there is no more data to be retrieved.
60  
61 If C<LastEvaluatedKey> is not empty, it does not necessarily mean that
62 there is more data in the result set. The only way to know when you
63 have reached the end of the result set is when C<LastEvaluatedKey> is
64 empty.
65  
66  
67 =head2 ScannedCount => Int
68  
69 The number of items evaluated, before any C<ScanFilter> is applied. A
70 high C<ScannedCount> value with few, or no, C<Count> results indicates
71 an inefficient C<Scan> operation. For more information, see Count and
72 ScannedCount
73 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count)
74 in the I<Amazon DynamoDB Developer Guide>.
75  
76 If you did not use a filter in the request, then C<ScannedCount> is the
77 same as C<Count>.
78  
79  
80 =head2 _request_id => Str
81  
82  
83 =cut
84  
85 1 1;
« blib/lib/Paws/DynamoDB/Scan.pm ↑ Summary blib/lib/Paws/DynamoDB/SecondaryIndexesCapacityMap.pm »