File Coverage

blib/lib/Paws/DynamoDB/ConsumedCapacity.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::ConsumedCapacity;
2 1     1   542 use Moose;
  1     1   4  
  1         9  
  1         630  
  1         3  
  1         9  
3             has CapacityUnits => (is => 'ro', isa => 'Num');
4             has GlobalSecondaryIndexes => (is => 'ro', isa => 'Paws::DynamoDB::SecondaryIndexesCapacityMap');
5             has LocalSecondaryIndexes => (is => 'ro', isa => 'Paws::DynamoDB::SecondaryIndexesCapacityMap');
6             has Table => (is => 'ro', isa => 'Paws::DynamoDB::Capacity');
7             has TableName => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::DynamoDB::ConsumedCapacity
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::DynamoDB::ConsumedCapacity object:
26              
27             $service_obj->Method(Att1 => { CapacityUnits => $value, ..., TableName => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::ConsumedCapacity object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->CapacityUnits
35              
36             =head1 DESCRIPTION
37              
38             The capacity units consumed by an operation. The data returned includes
39             the total provisioned throughput consumed, along with statistics for
40             the table and any indexes involved in the operation.
41             C<ConsumedCapacity> is only returned if the request asked for it. For
42             more information, see Provisioned Throughput in the I<Amazon DynamoDB
43             Developer Guide>.
44              
45             =head1 ATTRIBUTES
46              
47              
48             =head2 CapacityUnits => Num
49              
50             The total number of capacity units consumed by the operation.
51              
52              
53             =head2 GlobalSecondaryIndexes => L<Paws::DynamoDB::SecondaryIndexesCapacityMap>
54              
55             The amount of throughput consumed on each global index affected by the
56             operation.
57              
58              
59             =head2 LocalSecondaryIndexes => L<Paws::DynamoDB::SecondaryIndexesCapacityMap>
60              
61             The amount of throughput consumed on each local index affected by the
62             operation.
63              
64              
65             =head2 Table => L<Paws::DynamoDB::Capacity>
66              
67             The amount of throughput consumed on the table affected by the
68             operation.
69              
70              
71             =head2 TableName => Str
72              
73             The name of the table that was affected by the operation.
74              
75              
76              
77             =head1 SEE ALSO
78              
79             This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB>
80              
81             =head1 BUGS and CONTRIBUTIONS
82              
83             The source code is located here: https://github.com/pplu/aws-sdk-perl
84              
85             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
86              
87             =cut
88