« blib/lib/Paws/MarketplaceMetering/UsageAllocation.pm
↑ Summary
blib/lib/Paws/MarketplaceMetering/UsageRecordResult.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MarketplaceMetering::UsageRecord; | ||
| 3 | use Moose; | ||
| 4 | has CustomerIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Dimension => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Quantity => (is => 'ro', isa => 'Int'); | ||
| 7 | has Timestamp => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has UsageAllocations => (is => 'ro', isa => 'ArrayRef[Paws::MarketplaceMetering::UsageAllocation]'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::MarketplaceMetering::UsageRecord | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::MarketplaceMetering::UsageRecord object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CustomerIdentifier => $value, ..., UsageAllocations => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::MarketplaceMetering::UsageRecord object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CustomerIdentifier | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | A UsageRecord indicates a quantity of usage for a given product, | ||
| 41 | customer, dimension and time. | ||
| 42 | |||
| 43 | Multiple requests with the same UsageRecords as input will be | ||
| 44 | deduplicated to prevent double charges. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> CustomerIdentifier => Str | ||
| 50 | |||
| 51 | The CustomerIdentifier is obtained through the ResolveCustomer | ||
| 52 | operation and represents an individual buyer in your application. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> Dimension => Str | ||
| 56 | |||
| 57 | During the process of registering a product on AWS Marketplace, up to | ||
| 58 | eight dimensions are specified. These represent different units of | ||
| 59 | value in your application. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 Quantity => Int | ||
| 63 | |||
| 64 | The quantity of usage consumed by the customer for the given dimension | ||
| 65 | and time. Defaults to C<0> if not specified. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> Timestamp => Str | ||
| 69 | |||
| 70 | Timestamp, in UTC, for which the usage is being reported. | ||
| 71 | |||
| 72 | Your application can meter usage for up to one hour in the past. Make | ||
| 73 | sure the timestamp value is not before the start of the software usage. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 UsageAllocations => ArrayRef[L<Paws::MarketplaceMetering::UsageAllocation>] | ||
| 77 | |||
| 78 | The set of UsageAllocations to submit. The sum of all UsageAllocation | ||
| 79 | quantities must equal the Quantity of the UsageRecord. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, describing an object used in L<Paws::MarketplaceMetering> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |