File Coverage

blib/lib/Paws/DynamoDB/ScanOutput.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::DynamoDB::ScanOutput;
3 1     1   568 use Moose;
  1     1   3  
  1         9  
  1         550  
  1         2  
  1         9  
4             has ConsumedCapacity => (is => 'ro', isa => 'Paws::DynamoDB::ConsumedCapacity');
5             has Count => (is => 'ro', isa => 'Int');
6             has Items => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::AttributeMap]');
7             has LastEvaluatedKey => (is => 'ro', isa => 'Paws::DynamoDB::Key');
8             has ScannedCount => (is => 'ro', isa => 'Int');
9              
10             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 in the I<Amazon DynamoDB Developer Guide>.
29              
30              
31             =head2 Count => Int
32              
33             The number of items in the response.
34              
35             If you set C<ScanFilter> in the request, then C<Count> is the number of
36             items returned after the filter was applied, and C<ScannedCount> is the
37             number of matching items before the filter was applied.
38              
39             If you did not use a filter in the request, then C<Count> is the same
40             as C<ScannedCount>.
41              
42              
43             =head2 Items => ArrayRef[L<Paws::DynamoDB::AttributeMap>]
44              
45             An array of item attributes that match the scan criteria. Each element
46             in this array consists of an attribute name and the value for that
47             attribute.
48              
49              
50             =head2 LastEvaluatedKey => L<Paws::DynamoDB::Key>
51              
52             The primary key of the item where the operation stopped, inclusive of
53             the previous result set. Use this value to start a new operation,
54             excluding this value in the new request.
55              
56             If C<LastEvaluatedKey> is empty, then the "last page" of results has
57             been processed and there is no more data to be retrieved.
58              
59             If C<LastEvaluatedKey> is not empty, it does not necessarily mean that
60             there is more data in the result set. The only way to know when you
61             have reached the end of the result set is when C<LastEvaluatedKey> is
62             empty.
63              
64              
65             =head2 ScannedCount => Int
66              
67             The number of items evaluated, before any C<ScanFilter> is applied. A
68             high C<ScannedCount> value with few, or no, C<Count> results indicates
69             an inefficient C<Scan> operation. For more information, see Count and
70             ScannedCount in the I<Amazon DynamoDB Developer Guide>.
71              
72             If you did not use a filter in the request, then C<ScannedCount> is the
73             same as C<Count>.
74              
75              
76             =head2 _request_id => Str
77              
78              
79             =cut
80              
81             1;