File Coverage

blib/lib/Paws/DynamoDB/ItemCollectionMetrics.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             package Paws::DynamoDB::ItemCollectionMetrics;
2 1     1   464 use Moose;
  1     1   3  
  1         8  
  1         756  
  1         3  
  1         7  
3             has ItemCollectionKey => (is => 'ro', isa => 'Paws::DynamoDB::ItemCollectionKeyAttributeMap');
4             has SizeEstimateRangeGB => (is => 'ro', isa => 'ArrayRef[Num]');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::DynamoDB::ItemCollectionMetrics
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::DynamoDB::ItemCollectionMetrics object:
23              
24             $service_obj->Method(Att1 => { ItemCollectionKey => $value, ..., SizeEstimateRangeGB => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::ItemCollectionMetrics object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->ItemCollectionKey
32              
33             =head1 DESCRIPTION
34              
35             Information about item collections, if any, that were affected by the
36             operation. C<ItemCollectionMetrics> is only returned if the request
37             asked for it. If the table does not have any local secondary indexes,
38             this information is not returned in the response.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 ItemCollectionKey => L<Paws::DynamoDB::ItemCollectionKeyAttributeMap>
44              
45             The partition key value of the item collection. This value is the same
46             as the partition key value of the item.
47              
48              
49             =head2 SizeEstimateRangeGB => ArrayRef[Num]
50              
51             An estimate of item collection size, in gigabytes. This value is a
52             two-element array containing a lower bound and an upper bound for the
53             estimate. The estimate includes the size of all the items in the table,
54             plus the size of all attributes projected into all of the local
55             secondary indexes on that table. Use this estimate to measure whether a
56             local secondary index is approaching its size limit.
57              
58             The estimate is subject to change over time; therefore, do not rely on
59             the precision or accuracy of the estimate.
60              
61              
62              
63             =head1 SEE ALSO
64              
65             This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB>
66              
67             =head1 BUGS and CONTRIBUTIONS
68              
69             The source code is located here: https://github.com/pplu/aws-sdk-perl
70              
71             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
72              
73             =cut
74