blib/lib/Paws/S3/ListObjects.pm

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