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