File Coverage

blib/lib/Paws/CloudFront/CloudFrontOriginAccessIdentityList.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CloudFront::CloudFrontOriginAccessIdentityList;
2 1     1   618 use Moose;
  1         4  
  1         9  
3             has IsTruncated => (is => 'ro', isa => 'Bool', required => 1);
4             has Items => (is => 'ro', isa => 'ArrayRef[Paws::CloudFront::CloudFrontOriginAccessIdentitySummary]', request_name => 'CloudFrontOriginAccessIdentitySummary', traits => ['NameInRequest']);
5             has Marker => (is => 'ro', isa => 'Str', required => 1);
6             has MaxItems => (is => 'ro', isa => 'Int', required => 1);
7             has NextMarker => (is => 'ro', isa => 'Str');
8             has Quantity => (is => 'ro', isa => 'Int', required => 1);
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::CloudFront::CloudFrontOriginAccessIdentityList
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::CloudFront::CloudFrontOriginAccessIdentityList object:
27              
28             $service_obj->Method(Att1 => { IsTruncated => $value, ..., Quantity => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::CloudFrontOriginAccessIdentityList object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->IsTruncated
36              
37             =head1 DESCRIPTION
38              
39             Lists the origin access identities for CloudFront.Send a C<GET> request
40             to the C</I<CloudFront API version>/origin-access-identity/cloudfront>
41             resource. The response includes a C<CloudFrontOriginAccessIdentityList>
42             element with zero or more C<CloudFrontOriginAccessIdentitySummary>
43             child elements. By default, your entire list of origin access
44             identities is returned in one single page. If the list is long, you can
45             paginate it using the C<MaxItems> and C<Marker> parameters.
46              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 B<REQUIRED> IsTruncated => Bool
51              
52             A flag that indicates whether more origin access identities remain to
53             be listed. If your results were truncated, you can make a follow-up
54             pagination request using the C<Marker> request parameter to retrieve
55             more items in the list.
56              
57              
58             =head2 Items => ArrayRef[L<Paws::CloudFront::CloudFrontOriginAccessIdentitySummary>]
59              
60             A complex type that contains one
61             C<CloudFrontOriginAccessIdentitySummary> element for each origin access
62             identity that was created by the current AWS account.
63              
64              
65             =head2 B<REQUIRED> Marker => Str
66              
67             Use this when paginating results to indicate where to begin in your
68             list of origin access identities. The results include identities in the
69             list that occur after the marker. To get the next page of results, set
70             the C<Marker> to the value of the C<NextMarker> from the current page's
71             response (which is also the ID of the last identity on that page).
72              
73              
74             =head2 B<REQUIRED> MaxItems => Int
75              
76             The maximum number of origin access identities you want in the response
77             body.
78              
79              
80             =head2 NextMarker => Str
81              
82             If C<IsTruncated> is C<true>, this element is present and contains the
83             value you can use for the C<Marker> request parameter to continue
84             listing your origin access identities where they left off.
85              
86              
87             =head2 B<REQUIRED> Quantity => Int
88              
89             The number of CloudFront origin access identities that were created by
90             the current AWS account.
91              
92              
93              
94             =head1 SEE ALSO
95              
96             This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront>
97              
98             =head1 BUGS and CONTRIBUTIONS
99              
100             The source code is located here: https://github.com/pplu/aws-sdk-perl
101              
102             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
103              
104             =cut
105