blib/lib/Paws/S3/GetObjectRetention.pm untested

filter: Statementstmt 0.0% 0 / 21 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 23 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::S3::GetObjectRetention;
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 => 'GetObjectRetention');
14 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}?retention');
15 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::GetObjectRetentionOutput');
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::GetObjectRetention - Arguments for method GetObjectRetention on L<Paws::S3>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method GetObjectRetention on the
31 L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class
32 as arguments to method GetObjectRetention.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetObjectRetention.
35  
36 =head1 SYNOPSIS
37  
38 my $s3 = Paws->service('S3');
39 my $GetObjectRetentionOutput = $s3->GetObjectRetention(
40 Bucket => 'MyBucketName',
41 Key => 'MyObjectKey',
42 ExpectedBucketOwner => 'MyAccountId', # OPTIONAL
43 RequestPayer => 'requester', # OPTIONAL
44 VersionId => 'MyObjectVersionId', # OPTIONAL
45 );
46  
47 # Results:
48 my $Retention = $GetObjectRetentionOutput->Retention;
49  
50 # Returns a L<Paws::S3::GetObjectRetentionOutput> object.
51  
52 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.
53 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/GetObjectRetention>
54  
55 =head1 ATTRIBUTES
56  
57  
58 =head2 B<REQUIRED> Bucket => Str
59  
60 The bucket name containing the object whose retention settings you want
61 to retrieve.
62  
63 When using this action with an access point, you must direct requests
64 to the access point hostname. The access point hostname takes the form
65 I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com.
66 When using this action with an access point through the AWS SDKs, you
67 provide the access point ARN in place of the bucket name. For more
68 information about access point ARNs, see Using access points
69 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
70 in the I<Amazon S3 User Guide>.
71  
72  
73  
74 =head2 ExpectedBucketOwner => Str
75  
76 The account ID of the expected bucket owner. If the bucket is owned by
77 a different account, the request will fail with an HTTP C<403 (Access
78 Denied)> error.
79  
80  
81  
82 =head2 B<REQUIRED> Key => Str
83  
84 The key name for the object whose retention settings you want to
85 retrieve.
86  
87  
88  
89 =head2 RequestPayer => Str
90  
91  
92  
93 Valid values are: C<"requester">
94  
95 =head2 VersionId => Str
96  
97 The version ID for the object whose retention settings you want to
98 retrieve.
99  
100  
101  
102  
103 =head1 SEE ALSO
104  
105 This class forms part of L<Paws>, documenting arguments for method GetObjectRetention in L<Paws::S3>
106  
107 =head1 BUGS and CONTRIBUTIONS
108  
109 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
110  
111 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
112  
113 =cut
114