| 1 | |||
| 2 | package Paws::S3::ListMultipartUploads; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1); | |
| 5 | 1 | has Delimiter => (is => 'ro', isa => 'Str', query_name => 'delimiter', traits => ['ParamInQuery']); | |
| 6 | 1 | has EncodingType => (is => 'ro', isa => 'Str', query_name => 'encoding-type', traits => ['ParamInQuery']); | |
| 7 | 1 | has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']); | |
| 8 | 1 | has KeyMarker => (is => 'ro', isa => 'Str', query_name => 'key-marker', traits => ['ParamInQuery']); | |
| 9 | 1 | has MaxUploads => (is => 'ro', isa => 'Int', query_name => 'max-uploads', traits => ['ParamInQuery']); | |
| 10 | 1 | has Prefix => (is => 'ro', isa => 'Str', query_name => 'prefix', traits => ['ParamInQuery']); | |
| 11 | 1 | has UploadIdMarker => (is => 'ro', isa => 'Str', query_name => 'upload-id-marker', traits => ['ParamInQuery']); | |
| 12 | |||
| 13 | |||
| 14 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 15 | |||
| 16 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListMultipartUploads'); | |
| 17 | 1 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}?uploads'); | |
| 18 | 1 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | |
| 19 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::ListMultipartUploadsOutput'); | |
| 20 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 21 | |||
| 22 | |||
| 23 | 1 | 1; | |
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::S3::ListMultipartUploads - Arguments for method ListMultipartUploads on L<Paws::S3> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method ListMultipartUploads on the | ||
| 34 | L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class | ||
| 35 | as arguments to method ListMultipartUploads. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListMultipartUploads. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $s3 = Paws->service('S3'); | ||
| 42 | # To list in-progress multipart uploads on a bucket | ||
| 43 | # The following example lists in-progress multipart uploads on a specific | ||
| 44 | # bucket. | ||
| 45 | my $ListMultipartUploadsOutput = | ||
| 46 | $s3->ListMultipartUploads( 'Bucket' => 'examplebucket' ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $Uploads = $ListMultipartUploadsOutput->Uploads; | ||
| 50 | |||
| 51 | # Returns a L<Paws::S3::ListMultipartUploadsOutput> object. | ||
| 52 | # List next set of multipart uploads when previous result is truncated | ||
| 53 | # The following example specifies the upload-id-marker and key-marker from | ||
| 54 | # previous truncated response to retrieve next setup of multipart uploads. | ||
| 55 | my $ListMultipartUploadsOutput = $s3->ListMultipartUploads( | ||
| 56 | 'Bucket' => 'examplebucket', | ||
| 57 | 'KeyMarker' => 'nextkeyfrompreviousresponse', | ||
| 58 | 'MaxUploads' => 2, | ||
| 59 | 'UploadIdMarker' => 'valuefrompreviousresponse' | ||
| 60 | ); | ||
| 61 | |||
| 62 | # Results: | ||
| 63 | my $Bucket = $ListMultipartUploadsOutput->Bucket; | ||
| 64 | my $IsTruncated = $ListMultipartUploadsOutput->IsTruncated; | ||
| 65 | my $KeyMarker = $ListMultipartUploadsOutput->KeyMarker; | ||
| 66 | my $MaxUploads = $ListMultipartUploadsOutput->MaxUploads; | ||
| 67 | my $NextKeyMarker = $ListMultipartUploadsOutput->NextKeyMarker; | ||
| 68 | my $NextUploadIdMarker = $ListMultipartUploadsOutput->NextUploadIdMarker; | ||
| 69 | my $UploadIdMarker = $ListMultipartUploadsOutput->UploadIdMarker; | ||
| 70 | my $Uploads = $ListMultipartUploadsOutput->Uploads; | ||
| 71 | |||
| 72 | # Returns a L<Paws::S3::ListMultipartUploadsOutput> object. | ||
| 73 | |||
| 74 | 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. | ||
| 75 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/ListMultipartUploads> | ||
| 76 | |||
| 77 | =head1 ATTRIBUTES | ||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> Bucket => Str | ||
| 81 | |||
| 82 | The name of the bucket to which the multipart upload was initiated. | ||
| 83 | |||
| 84 | When using this action with an access point, you must direct requests | ||
| 85 | to the access point hostname. The access point hostname takes the form | ||
| 86 | I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com. | ||
| 87 | When using this action with an access point through the AWS SDKs, you | ||
| 88 | provide the access point ARN in place of the bucket name. For more | ||
| 89 | information about access point ARNs, see Using access points | ||
| 90 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) | ||
| 91 | in the I<Amazon S3 User Guide>. | ||
| 92 | |||
| 93 | When using this action with Amazon S3 on Outposts, you must direct | ||
| 94 | requests to the S3 on Outposts hostname. The S3 on Outposts hostname | ||
| 95 | takes the form | ||
| 96 | I<AccessPointName>-I<AccountId>.I<outpostID>.s3-outposts.I<Region>.amazonaws.com. | ||
| 97 | When using this action using S3 on Outposts through the AWS SDKs, you | ||
| 98 | provide the Outposts bucket ARN in place of the bucket name. For more | ||
| 99 | information about S3 on Outposts ARNs, see Using S3 on Outposts | ||
| 100 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) | ||
| 101 | in the I<Amazon S3 User Guide>. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 Delimiter => Str | ||
| 106 | |||
| 107 | Character you use to group keys. | ||
| 108 | |||
| 109 | All keys that contain the same string between the prefix, if specified, | ||
| 110 | and the first occurrence of the delimiter after the prefix are grouped | ||
| 111 | under a single result element, C<CommonPrefixes>. If you don't specify | ||
| 112 | the prefix parameter, then the substring starts at the beginning of the | ||
| 113 | key. The keys that are grouped under C<CommonPrefixes> result element | ||
| 114 | are not returned elsewhere in the response. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 EncodingType => Str | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | Valid values are: C<"url"> | ||
| 123 | |||
| 124 | =head2 ExpectedBucketOwner => Str | ||
| 125 | |||
| 126 | The account ID of the expected bucket owner. If the bucket is owned by | ||
| 127 | a different account, the request will fail with an HTTP C<403 (Access | ||
| 128 | Denied)> error. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head2 KeyMarker => Str | ||
| 133 | |||
| 134 | Together with upload-id-marker, this parameter specifies the multipart | ||
| 135 | upload after which listing should begin. | ||
| 136 | |||
| 137 | If C<upload-id-marker> is not specified, only the keys | ||
| 138 | lexicographically greater than the specified C<key-marker> will be | ||
| 139 | included in the list. | ||
| 140 | |||
| 141 | If C<upload-id-marker> is specified, any multipart uploads for a key | ||
| 142 | equal to the C<key-marker> might also be included, provided those | ||
| 143 | multipart uploads have upload IDs lexicographically greater than the | ||
| 144 | specified C<upload-id-marker>. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 MaxUploads => Int | ||
| 149 | |||
| 150 | Sets the maximum number of multipart uploads, from 1 to 1,000, to | ||
| 151 | return in the response body. 1,000 is the maximum number of uploads | ||
| 152 | that can be returned in a response. | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head2 Prefix => Str | ||
| 157 | |||
| 158 | Lists in-progress uploads only for those keys that begin with the | ||
| 159 | specified prefix. You can use prefixes to separate a bucket into | ||
| 160 | different grouping of keys. (You can think of using prefix to make | ||
| 161 | groups in the same way you'd use a folder in a file system.) | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 UploadIdMarker => Str | ||
| 166 | |||
| 167 | Together with key-marker, specifies the multipart upload after which | ||
| 168 | listing should begin. If key-marker is not specified, the | ||
| 169 | upload-id-marker parameter is ignored. Otherwise, any multipart uploads | ||
| 170 | for a key equal to the key-marker might be included in the list only if | ||
| 171 | they have an upload ID lexicographically greater than the specified | ||
| 172 | C<upload-id-marker>. | ||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head1 SEE ALSO | ||
| 178 | |||
| 179 | This class forms part of L<Paws>, documenting arguments for method ListMultipartUploads in L<Paws::S3> | ||
| 180 | |||
| 181 | =head1 BUGS and CONTRIBUTIONS | ||
| 182 | |||
| 183 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 184 | |||
| 185 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 186 | |||
| 187 | =cut | ||
| 188 | |||