blib/lib/Paws/S3/DeleteObject.pm

filter: Statementstmt 100% 19 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 21 / 21 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/S3/DeleteMarkerEntry.pm ↑ Summary blib/lib/Paws/S3/DeleteObjectOutput.pm »
1  
2 package Paws::S3::DeleteObject;
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 BypassGovernanceRetention => (is => 'ro', isa => 'Bool', header_name => 'x-amz-bypass-governance-retention', traits => ['ParamInHeader']);
6 1 has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']);
7 1 has Key => (is => 'ro', isa => 'Str', uri_name => 'Key', traits => ['ParamInURI'], required => 1);
8 1 has MFA => (is => 'ro', isa => 'Str', header_name => 'x-amz-mfa', traits => ['ParamInHeader']);
9 1 has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']);
10 1 has VersionId => (is => 'ro', isa => 'Str', query_name => 'versionId', traits => ['ParamInQuery']);
11  
12  
13 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
14  
15 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteObject');
16 1 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}');
17 1 class_has _api_method => (isa => 'Str', is => 'ro', default => 'DELETE');
18 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::DeleteObjectOutput');
19 1 class_has _result_key => (isa => 'Str', is => 'ro');
20
21
22 1 1;
23  
24 ### main pod documentation begin ###
25  
26 =head1 NAME
27  
28 Paws::S3::DeleteObject - Arguments for method DeleteObject on L<Paws::S3>
29  
30 =head1 DESCRIPTION
31  
32 This class represents the parameters used for calling the method DeleteObject on the
33 L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class
34 as arguments to method DeleteObject.
35  
36 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteObject.
37  
38 =head1 SYNOPSIS
39  
40 my $s3 = Paws->service('S3');
41 # To delete an object
42 # The following example deletes an object from an S3 bucket.
43 my $DeleteObjectOutput = $s3->DeleteObject(
44 'Bucket' => 'examplebucket',
45 'Key' => 'objectkey.jpg'
46 );
47  
48 # To delete an object (from a non-versioned bucket)
49 # The following example deletes an object from a non-versioned bucket.
50 my $DeleteObjectOutput = $s3->DeleteObject(
51 'Bucket' => 'ExampleBucket',
52 'Key' => 'HappyFace.jpg'
53 );
54  
55  
56 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.
57 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/DeleteObject>
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 B<REQUIRED> Bucket => Str
63  
64 The bucket name of the bucket containing the object.
65  
66 When using this action with an access point, you must direct requests
67 to the access point hostname. The access point hostname takes the form
68 I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com.
69 When using this action with an access point through the AWS SDKs, you
70 provide the access point ARN in place of the bucket name. For more
71 information about access point ARNs, see Using access points
72 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
73 in the I<Amazon S3 User Guide>.
74  
75 When using this action with Amazon S3 on Outposts, you must direct
76 requests to the S3 on Outposts hostname. The S3 on Outposts hostname
77 takes the form
78 I<AccessPointName>-I<AccountId>.I<outpostID>.s3-outposts.I<Region>.amazonaws.com.
79 When using this action using S3 on Outposts through the AWS SDKs, you
80 provide the Outposts bucket ARN in place of the bucket name. For more
81 information about S3 on Outposts ARNs, see Using S3 on Outposts
82 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html)
83 in the I<Amazon S3 User Guide>.
84  
85  
86  
87 =head2 BypassGovernanceRetention => Bool
88  
89 Indicates whether S3 Object Lock should bypass Governance-mode
90 restrictions to process this operation.
91  
92  
93  
94 =head2 ExpectedBucketOwner => Str
95  
96 The account ID of the expected bucket owner. If the bucket is owned by
97 a different account, the request will fail with an HTTP C<403 (Access
98 Denied)> error.
99  
100  
101  
102 =head2 B<REQUIRED> Key => Str
103  
104 Key name of the object to delete.
105  
106  
107  
108 =head2 MFA => Str
109  
110 The concatenation of the authentication device's serial number, a
111 space, and the value that is displayed on your authentication device.
112 Required to permanently delete a versioned object if versioning is
113 configured with MFA delete enabled.
114  
115  
116  
117 =head2 RequestPayer => Str
118  
119  
120  
121 Valid values are: C<"requester">
122  
123 =head2 VersionId => Str
124  
125 VersionId used to reference a specific version of the object.
126  
127  
128  
129  
130 =head1 SEE ALSO
131  
132 This class forms part of L<Paws>, documenting arguments for method DeleteObject 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  
« blib/lib/Paws/S3/DeleteMarkerEntry.pm ↑ Summary blib/lib/Paws/S3/DeleteObjectOutput.pm »