« blib/lib/Paws/S3/ListMultipartUploadsOutput.pm
↑ Summary
blib/lib/Paws/S3/ListObjectVersionsOutput.pm »
| 1 | |||
| 2 | package Paws::S3::ListObjectVersions; | ||
| 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 Delimiter => (is => 'ro', isa => 'Str', query_name => 'delimiter', traits => ['ParamInQuery']); | |
| 6 | 2 | has EncodingType => (is => 'ro', isa => 'Str', query_name => 'encoding-type', traits => ['ParamInQuery']); | |
| 7 | 2 | has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']); | |
| 8 | 2 | has KeyMarker => (is => 'ro', isa => 'Str', query_name => 'key-marker', traits => ['ParamInQuery']); | |
| 9 | 2 | has MaxKeys => (is => 'ro', isa => 'Int', query_name => 'max-keys', traits => ['ParamInQuery']); | |
| 10 | 2 | has Prefix => (is => 'ro', isa => 'Str', query_name => 'prefix', traits => ['ParamInQuery']); | |
| 11 | 2 | has VersionIdMarker => (is => 'ro', isa => 'Str', query_name => 'version-id-marker', traits => ['ParamInQuery']); | |
| 12 | |||
| 13 | |||
| 14 | 2 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 15 | |||
| 16 | 2 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListObjectVersions'); | |
| 17 | 2 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}?versions'); | |
| 18 | 2 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | |
| 19 | 2 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::ListObjectVersionsOutput'); | |
| 20 | 2 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 21 | |||
| 22 | |||
| 23 | 2 | 1; | |
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::S3::ListObjectVersions - Arguments for method ListObjectVersions on L<Paws::S3> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method ListObjectVersions on the | ||
| 34 | L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class | ||
| 35 | as arguments to method ListObjectVersions. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListObjectVersions. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $s3 = Paws->service('S3'); | ||
| 42 | # To list object versions | ||
| 43 | # The following example return versions of an object with specific key name | ||
| 44 | # prefix. The request limits the number of items returned to two. If there are | ||
| 45 | # are more than two object version, S3 returns NextToken in the response. You | ||
| 46 | # can specify this token value in your next request to fetch next set of object | ||
| 47 | # versions. | ||
| 48 | my $ListObjectVersionsOutput = $s3->ListObjectVersions( | ||
| 49 | 'Bucket' => 'examplebucket', | ||
| 50 | 'Prefix' => 'HappyFace.jpg' | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $Versions = $ListObjectVersionsOutput->Versions; | ||
| 55 | |||
| 56 | # Returns a L<Paws::S3::ListObjectVersionsOutput> 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/ListObjectVersions> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Bucket => Str | ||
| 65 | |||
| 66 | The bucket name that contains the objects. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 Delimiter => Str | ||
| 71 | |||
| 72 | A delimiter is a character that you specify to group keys. All keys | ||
| 73 | that contain the same string between the C<prefix> and the first | ||
| 74 | occurrence of the delimiter are grouped under a single result element | ||
| 75 | in CommonPrefixes. These groups are counted as one result against the | ||
| 76 | max-keys limitation. These keys are not returned elsewhere in the | ||
| 77 | response. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 EncodingType => Str | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | Valid values are: C<"url"> | ||
| 86 | |||
| 87 | =head2 ExpectedBucketOwner => Str | ||
| 88 | |||
| 89 | The account ID of the expected bucket owner. If the bucket is owned by | ||
| 90 | a different account, the request will fail with an HTTP C<403 (Access | ||
| 91 | Denied)> error. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 KeyMarker => Str | ||
| 96 | |||
| 97 | Specifies the key to start with when listing objects in a bucket. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 MaxKeys => Int | ||
| 102 | |||
| 103 | Sets the maximum number of keys returned in the response. By default | ||
| 104 | the action returns up to 1,000 key names. The response might contain | ||
| 105 | fewer keys but will never contain more. If additional keys satisfy the | ||
| 106 | search criteria, but were not returned because max-keys was exceeded, | ||
| 107 | the response contains E<lt>isTruncatedE<gt>trueE<lt>/isTruncatedE<gt>. | ||
| 108 | To return the additional keys, see key-marker and version-id-marker. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 Prefix => Str | ||
| 113 | |||
| 114 | Use this parameter to select only those keys that begin with the | ||
| 115 | specified prefix. You can use prefixes to separate a bucket into | ||
| 116 | different groupings of keys. (You can think of using prefix to make | ||
| 117 | groups in the same way you'd use a folder in a file system.) You can | ||
| 118 | use prefix with delimiter to roll up numerous objects into a single | ||
| 119 | result under CommonPrefixes. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 VersionIdMarker => Str | ||
| 124 | |||
| 125 | Specifies the object version you want to start listing from. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method ListObjectVersions 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 | |||