« blib/lib/Paws/S3/GetObjectRetentionOutput.pm
↑ Summary
blib/lib/Paws/S3/GetObjectTaggingOutput.pm »
| 1 | |||
| 2 | package Paws::S3::GetObjectTagging; | ||
| 3 | use Moose; | ||
| 4 | has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1); | ||
| 5 | has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']); | ||
| 6 | has Key => (is => 'ro', isa => 'Str', uri_name => 'Key', traits => ['ParamInURI'], required => 1); | ||
| 7 | has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']); | ||
| 8 | has VersionId => (is => 'ro', isa => 'Str', query_name => 'versionId', traits => ['ParamInQuery']); | ||
| 9 | |||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetObjectTagging'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}?tagging'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::GetObjectTaggingOutput'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | |||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::S3::GetObjectTagging - Arguments for method GetObjectTagging on L<Paws::S3> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method GetObjectTagging on the | ||
| 31 | L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class | ||
| 32 | as arguments to method GetObjectTagging. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetObjectTagging. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $s3 = Paws->service('S3'); | ||
| 39 | # To retrieve tag set of an object | ||
| 40 | # The following example retrieves tag set of an object. | ||
| 41 | my $GetObjectTaggingOutput = $s3->GetObjectTagging( | ||
| 42 | 'Bucket' => 'examplebucket', | ||
| 43 | 'Key' => 'HappyFace.jpg' | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $TagSet = $GetObjectTaggingOutput->TagSet; | ||
| 48 | my $VersionId = $GetObjectTaggingOutput->VersionId; | ||
| 49 | |||
| 50 | # Returns a L<Paws::S3::GetObjectTaggingOutput> object. | ||
| 51 | # To retrieve tag set of a specific object version | ||
| 52 | # The following example retrieves tag set of an object. The request specifies | ||
| 53 | # object version. | ||
| 54 | my $GetObjectTaggingOutput = $s3->GetObjectTagging( | ||
| 55 | 'Bucket' => 'examplebucket', | ||
| 56 | 'Key' => 'exampleobject', | ||
| 57 | 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI' | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $TagSet = $GetObjectTaggingOutput->TagSet; | ||
| 62 | my $VersionId = $GetObjectTaggingOutput->VersionId; | ||
| 63 | |||
| 64 | # Returns a L<Paws::S3::GetObjectTaggingOutput> object. | ||
| 65 | |||
| 66 | 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. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/GetObjectTagging> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> Bucket => Str | ||
| 73 | |||
| 74 | The bucket name containing the object for which to get the tagging | ||
| 75 | information. | ||
| 76 | |||
| 77 | When using this action with an access point, you must direct requests | ||
| 78 | to the access point hostname. The access point hostname takes the form | ||
| 79 | I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com. | ||
| 80 | When using this action with an access point through the AWS SDKs, you | ||
| 81 | provide the access point ARN in place of the bucket name. For more | ||
| 82 | information about access point ARNs, see Using access points | ||
| 83 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) | ||
| 84 | in the I<Amazon S3 User Guide>. | ||
| 85 | |||
| 86 | When using this action with Amazon S3 on Outposts, you must direct | ||
| 87 | requests to the S3 on Outposts hostname. The S3 on Outposts hostname | ||
| 88 | takes the form | ||
| 89 | I<AccessPointName>-I<AccountId>.I<outpostID>.s3-outposts.I<Region>.amazonaws.com. | ||
| 90 | When using this action using S3 on Outposts through the AWS SDKs, you | ||
| 91 | provide the Outposts bucket ARN in place of the bucket name. For more | ||
| 92 | information about S3 on Outposts ARNs, see Using S3 on Outposts | ||
| 93 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) | ||
| 94 | in the I<Amazon S3 User Guide>. | ||
| 95 | |||
| 96 | |||
| 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 B<REQUIRED> Key => Str | ||
| 107 | |||
| 108 | Object key for which to get the tagging information. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 RequestPayer => Str | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | Valid values are: C<"requester"> | ||
| 117 | |||
| 118 | =head2 VersionId => Str | ||
| 119 | |||
| 120 | The versionId of the object for which to get the tagging information. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head1 SEE ALSO | ||
| 126 | |||
| 127 | This class forms part of L<Paws>, documenting arguments for method GetObjectTagging in L<Paws::S3> | ||
| 128 | |||
| 129 | =head1 BUGS and CONTRIBUTIONS | ||
| 130 | |||
| 131 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 132 | |||
| 133 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 134 | |||
| 135 | =cut | ||
| 136 |