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