blib/lib/Paws/S3/PutObjectTagging.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/PutObjectOutput.pm ↑ Summary blib/lib/Paws/S3/RecordsEvent.pm »
1  
2 package Paws::S3::PutObjectTagging;
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 ContentLength => (is => 'ro', isa => 'Int', header_name => 'Content-Length', traits => ['ParamInHeader']);
6 1 has ContentMD5 => (is => 'ro', isa => 'Str', header_name => 'Content-MD5', auto => 'MD5', traits => ['AutoInHeader']);
7 1 has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']);
8 1 has Key => (is => 'ro', isa => 'Str', uri_name => 'Key', traits => ['ParamInURI'], required => 1);
9 1 has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']);
10 1 has Tagging => (is => 'ro', isa => 'Paws::S3::Tagging', traits => ['ParamInBody'], required => 1);
11 1 has VersionId => (is => 'ro', isa => 'Str', query_name => 'versionId', 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 => 'PutObjectTagging');
17 1 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}?tagging');
18 1 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
19 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::PutObjectTaggingOutput');
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::PutObjectTagging - Arguments for method PutObjectTagging on L<Paws::S3>
30  
31 =head1 DESCRIPTION
32  
33 This class represents the parameters used for calling the method PutObjectTagging on the
34 L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class
35 as arguments to method PutObjectTagging.
36  
37 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutObjectTagging.
38  
39 =head1 SYNOPSIS
40  
41 my $s3 = Paws->service('S3');
42 # To add tags to an existing object
43 # The following example adds tags to an existing object.
44 my $PutObjectTaggingOutput = $s3->PutObjectTagging(
45 'Bucket' => 'examplebucket',
46 'Key' => 'HappyFace.jpg',
47 'Tagging' => {
48 'TagSet' => [
49  
50 {
51 'Key' => 'Key3',
52 'Value' => 'Value3'
53 },
54  
55 {
56 'Key' => 'Key4',
57 'Value' => 'Value4'
58 }
59 ]
60 }
61 );
62  
63 # Results:
64 my $VersionId = $PutObjectTaggingOutput->VersionId;
65  
66 # Returns a L<Paws::S3::PutObjectTaggingOutput> object.
67  
68 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.
69 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/PutObjectTagging>
70  
71 =head1 ATTRIBUTES
72  
73  
74 =head2 B<REQUIRED> Bucket => Str
75  
76 The bucket name containing the object.
77  
78 When using this action with an access point, you must direct requests
79 to the access point hostname. The access point hostname takes the form
80 I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com.
81 When using this action with an access point through the AWS SDKs, you
82 provide the access point ARN in place of the bucket name. For more
83 information about access point ARNs, see Using access points
84 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
85 in the I<Amazon S3 User Guide>.
86  
87 When using this action with Amazon S3 on Outposts, you must direct
88 requests to the S3 on Outposts hostname. The S3 on Outposts hostname
89 takes the form
90 I<AccessPointName>-I<AccountId>.I<outpostID>.s3-outposts.I<Region>.amazonaws.com.
91 When using this action using S3 on Outposts through the AWS SDKs, you
92 provide the Outposts bucket ARN in place of the bucket name. For more
93 information about S3 on Outposts ARNs, see Using S3 on Outposts
94 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html)
95 in the I<Amazon S3 User Guide>.
96  
97  
98  
99 =head2 ContentLength => Int
100  
101 Size of the body in bytes.
102  
103  
104  
105 =head2 ContentMD5 => Str
106  
107 The MD5 hash for the request body.
108  
109 For requests made using the AWS Command Line Interface (CLI) or AWS
110 SDKs, this field is calculated automatically.
111  
112  
113  
114 =head2 ExpectedBucketOwner => Str
115  
116 The account ID of the expected bucket owner. If the bucket is owned by
117 a different account, the request will fail with an HTTP C<403 (Access
118 Denied)> error.
119  
120  
121  
122 =head2 B<REQUIRED> Key => Str
123  
124 Name of the object key.
125  
126  
127  
128 =head2 RequestPayer => Str
129  
130  
131  
132 Valid values are: C<"requester">
133  
134 =head2 B<REQUIRED> Tagging => L<Paws::S3::Tagging>
135  
136 Container for the C<TagSet> and C<Tag> elements
137  
138  
139  
140 =head2 VersionId => Str
141  
142 The versionId of the object that the tag-set will be added to.
143  
144  
145  
146  
147 =head1 SEE ALSO
148  
149 This class forms part of L<Paws>, documenting arguments for method PutObjectTagging in L<Paws::S3>
150  
151 =head1 BUGS and CONTRIBUTIONS
152  
153 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
154  
155 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
156  
157 =cut
158  
« blib/lib/Paws/S3/PutObjectOutput.pm ↑ Summary blib/lib/Paws/S3/RecordsEvent.pm »