| 1 | |||
| 2 | package Paws::S3::ListParts; | ||
| 3 | 2 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 2 | has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1); | |
| 5 | 2 | has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']); | |
| 6 | 2 | has Key => (is => 'ro', isa => 'Str', uri_name => 'Key', traits => ['ParamInURI'], required => 1); | |
| 7 | 2 | has MaxParts => (is => 'ro', isa => 'Int', query_name => 'max-parts', traits => ['ParamInQuery']); | |
| 8 | 2 | has PartNumberMarker => (is => 'ro', isa => 'Int', query_name => 'part-number-marker', traits => ['ParamInQuery']); | |
| 9 | 2 | has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']); | |
| 10 | 2 | has UploadId => (is => 'ro', isa => 'Str', query_name => 'uploadId', traits => ['ParamInQuery'], required => 1); | |
| 11 | |||
| 12 | |||
| 13 | 2 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 14 | |||
| 15 | 2 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListParts'); | |
| 16 | 2 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}'); | |
| 17 | 2 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | |
| 18 | 2 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::ListPartsOutput'); | |
| 19 | 2 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 20 | |||
| 21 | |||
| 22 | 2 | 1; | |
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::S3::ListParts - Arguments for method ListParts on L<Paws::S3> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method ListParts on the | ||
| 33 | L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class | ||
| 34 | as arguments to method ListParts. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListParts. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $s3 = Paws->service('S3'); | ||
| 41 | # To list parts of a multipart upload. | ||
| 42 | # The following example lists parts uploaded for a specific multipart upload. | ||
| 43 | my $ListPartsOutput = $s3->ListParts( | ||
| 44 | 'Bucket' => 'examplebucket', | ||
| 45 | 'Key' => 'bigobject', | ||
| 46 | 'UploadId' => | ||
| 47 | 'example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--' | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $Initiator = $ListPartsOutput->Initiator; | ||
| 52 | my $Owner = $ListPartsOutput->Owner; | ||
| 53 | my $Parts = $ListPartsOutput->Parts; | ||
| 54 | my $StorageClass = $ListPartsOutput->StorageClass; | ||
| 55 | |||
| 56 | # Returns a L<Paws::S3::ListPartsOutput> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/ListParts> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Bucket => Str | ||
| 65 | |||
| 66 | The name of the bucket to which the parts are being uploaded. | ||
| 67 | |||
| 68 | When using this action with an access point, you must direct requests | ||
| 69 | to the access point hostname. The access point hostname takes the form | ||
| 70 | I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com. | ||
| 71 | When using this action with an access point through the AWS SDKs, you | ||
| 72 | provide the access point ARN in place of the bucket name. For more | ||
| 73 | information about access point ARNs, see Using access points | ||
| 74 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) | ||
| 75 | in the I<Amazon S3 User Guide>. | ||
| 76 | |||
| 77 | When using this action with Amazon S3 on Outposts, you must direct | ||
| 78 | requests to the S3 on Outposts hostname. The S3 on Outposts hostname | ||
| 79 | takes the form | ||
| 80 | I<AccessPointName>-I<AccountId>.I<outpostID>.s3-outposts.I<Region>.amazonaws.com. | ||
| 81 | When using this action using S3 on Outposts through the AWS SDKs, you | ||
| 82 | provide the Outposts bucket ARN in place of the bucket name. For more | ||
| 83 | information about S3 on Outposts ARNs, see Using S3 on Outposts | ||
| 84 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) | ||
| 85 | in the I<Amazon S3 User Guide>. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 ExpectedBucketOwner => Str | ||
| 90 | |||
| 91 | The account ID of the expected bucket owner. If the bucket is owned by | ||
| 92 | a different account, the request will fail with an HTTP C<403 (Access | ||
| 93 | Denied)> error. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 B<REQUIRED> Key => Str | ||
| 98 | |||
| 99 | Object key for which the multipart upload was initiated. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 MaxParts => Int | ||
| 104 | |||
| 105 | Sets the maximum number of parts to return. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 PartNumberMarker => Int | ||
| 110 | |||
| 111 | Specifies the part after which listing should begin. Only parts with | ||
| 112 | higher part numbers will be listed. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 RequestPayer => Str | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | Valid values are: C<"requester"> | ||
| 121 | |||
| 122 | =head2 B<REQUIRED> UploadId => Str | ||
| 123 | |||
| 124 | Upload ID identifying the multipart upload whose parts are being | ||
| 125 | listed. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method ListParts in L<Paws::S3> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 | |||