blib/lib/Paws/S3/ListObjectsV2.pm

filter: Statementstmt 100% 22 / 22 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 24 / 24 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/S3/ListObjectsOutput.pm ↑ Summary blib/lib/Paws/S3/ListObjectsV2Output.pm »
1  
2 package Paws::S3::ListObjectsV2;
3 3 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 3 has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1);
5 3 has ContinuationToken => (is => 'ro', isa => 'Str', query_name => 'continuation-token', traits => ['ParamInQuery']);
6 3 has Delimiter => (is => 'ro', isa => 'Str', query_name => 'delimiter', traits => ['ParamInQuery']);
7 3 has EncodingType => (is => 'ro', isa => 'Str', query_name => 'encoding-type', traits => ['ParamInQuery']);
8 3 has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']);
9 3 has FetchOwner => (is => 'ro', isa => 'Bool', query_name => 'fetch-owner', traits => ['ParamInQuery']);
10 3 has MaxKeys => (is => 'ro', isa => 'Int', query_name => 'max-keys', traits => ['ParamInQuery']);
11 3 has Prefix => (is => 'ro', isa => 'Str', query_name => 'prefix', traits => ['ParamInQuery']);
12 3 has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']);
13 3 has StartAfter => (is => 'ro', isa => 'Str', query_name => 'start-after', traits => ['ParamInQuery']);
14  
15  
16 3 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
17  
18 3 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListObjectsV2');
19 3 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}?list-type=2');
20 3 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
21 3 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::ListObjectsV2Output');
22 3 class_has _result_key => (isa => 'Str', is => 'ro');
23
24
25 3 1;
26  
27 ### main pod documentation begin ###
28  
29 =head1 NAME
30  
31 Paws::S3::ListObjectsV2 - Arguments for method ListObjectsV2 on L<Paws::S3>
32  
33 =head1 DESCRIPTION
34  
35 This class represents the parameters used for calling the method ListObjectsV2 on the
36 L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class
37 as arguments to method ListObjectsV2.
38  
39 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListObjectsV2.
40  
41 =head1 SYNOPSIS
42  
43 my $s3 = Paws->service('S3');
44 # To get object list
45 # The following example retrieves object list. The request specifies max keys to
46 # limit response to include only 2 object keys.
47 my $ListObjectsV2Output = $s3->ListObjectsV2(
48 'Bucket' => 'examplebucket',
49 'MaxKeys' => 2
50 );
51  
52 # Results:
53 my $Contents = $ListObjectsV2Output->Contents;
54 my $IsTruncated = $ListObjectsV2Output->IsTruncated;
55 my $KeyCount = $ListObjectsV2Output->KeyCount;
56 my $MaxKeys = $ListObjectsV2Output->MaxKeys;
57 my $Name = $ListObjectsV2Output->Name;
58 my $NextContinuationToken = $ListObjectsV2Output->NextContinuationToken;
59 my $Prefix = $ListObjectsV2Output->Prefix;
60  
61 # Returns a L<Paws::S3::ListObjectsV2Output> object.
62  
63 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
64 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/ListObjectsV2>
65  
66 =head1 ATTRIBUTES
67  
68  
69 =head2 B<REQUIRED> Bucket => Str
70  
71 Bucket name to list.
72  
73 When using this action with an access point, you must direct requests
74 to the access point hostname. The access point hostname takes the form
75 I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com.
76 When using this action with an access point through the AWS SDKs, you
77 provide the access point ARN in place of the bucket name. For more
78 information about access point ARNs, see Using access points
79 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
80 in the I<Amazon S3 User Guide>.
81  
82 When using this action with Amazon S3 on Outposts, you must direct
83 requests to the S3 on Outposts hostname. The S3 on Outposts hostname
84 takes the form
85 I<AccessPointName>-I<AccountId>.I<outpostID>.s3-outposts.I<Region>.amazonaws.com.
86 When using this action using S3 on Outposts through the AWS SDKs, you
87 provide the Outposts bucket ARN in place of the bucket name. For more
88 information about S3 on Outposts ARNs, see Using S3 on Outposts
89 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html)
90 in the I<Amazon S3 User Guide>.
91  
92  
93  
94 =head2 ContinuationToken => Str
95  
96 ContinuationToken indicates Amazon S3 that the list is being continued
97 on this bucket with a token. ContinuationToken is obfuscated and is not
98 a real key.
99  
100  
101  
102 =head2 Delimiter => Str
103  
104 A delimiter is a character you use to group keys.
105  
106  
107  
108 =head2 EncodingType => Str
109  
110 Encoding type used by Amazon S3 to encode object keys in the response.
111  
112 Valid values are: C<"url">
113  
114 =head2 ExpectedBucketOwner => Str
115  
116 The account ID of the expected bucket owner. If the bucket is owned by
117 a different account, the request will fail with an HTTP C<403 (Access
118 Denied)> error.
119  
120  
121  
122 =head2 FetchOwner => Bool
123  
124 The owner field is not present in listV2 by default, if you want to
125 return owner field with each key in the result then set the fetch owner
126 field to true.
127  
128  
129  
130 =head2 MaxKeys => Int
131  
132 Sets the maximum number of keys returned in the response. By default
133 the action returns up to 1,000 key names. The response might contain
134 fewer keys but will never contain more.
135  
136  
137  
138 =head2 Prefix => Str
139  
140 Limits the response to keys that begin with the specified prefix.
141  
142  
143  
144 =head2 RequestPayer => Str
145  
146 Confirms that the requester knows that she or he will be charged for
147 the list objects request in V2 style. Bucket owners need not specify
148 this parameter in their requests.
149  
150 Valid values are: C<"requester">
151  
152 =head2 StartAfter => Str
153  
154 StartAfter is where you want Amazon S3 to start listing from. Amazon S3
155 starts listing after this specified key. StartAfter can be any key in
156 the bucket.
157  
158  
159  
160  
161 =head1 SEE ALSO
162  
163 This class forms part of L<Paws>, documenting arguments for method ListObjectsV2 in L<Paws::S3>
164  
165 =head1 BUGS and CONTRIBUTIONS
166  
167 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
168  
169 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
170  
171 =cut
172  
« blib/lib/Paws/S3/ListObjectsOutput.pm ↑ Summary blib/lib/Paws/S3/ListObjectsV2Output.pm »