blib/lib/Paws/S3/RestoreObject.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/RequestPaymentConfiguration.pm ↑ Summary blib/lib/Paws/S3/SelectObjectContent.pm »
1  
2 package Paws::S3::RestoreObject;
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 ContentMD5 => (is => 'ro', isa => 'Str', header_name => 'Content-MD5', auto => 'MD5', traits => ['AutoInHeader']);
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 RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']);
9 1 has RestoreRequest => (is => 'ro', isa => 'Paws::S3::RestoreRequest', traits => ['ParamInBody']);
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 => 'RestoreObject');
16 1 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}?restore');
17 1 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
18 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::RestoreObjectOutput');
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::RestoreObject - Arguments for method RestoreObject on L<Paws::S3>
29  
30 =head1 DESCRIPTION
31  
32 This class represents the parameters used for calling the method RestoreObject on the
33 L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class
34 as arguments to method RestoreObject.
35  
36 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreObject.
37  
38 =head1 SYNOPSIS
39  
40 my $s3 = Paws->service('S3');
41 # To restore an archived object
42 # The following example restores for one day an archived copy of an object back
43 # into Amazon S3 bucket.
44 my $RestoreObjectOutput = $s3->RestoreObject(
45 'Bucket' => 'examplebucket',
46 'Key' => 'archivedobjectkey',
47 'RestoreRequest' => {
48 'Days' => 1,
49 'GlacierJobParameters' => {
50 'Tier' => 'Expedited'
51 }
52 }
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/RestoreObject>
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 B<REQUIRED> Bucket => Str
63  
64 The bucket name containing the object to restore.
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 ContentMD5 => Str
88  
89  
90  
91  
92  
93 =head2 ExpectedBucketOwner => Str
94  
95 The account ID of the expected bucket owner. If the bucket is owned by
96 a different account, the request will fail with an HTTP C<403 (Access
97 Denied)> error.
98  
99  
100  
101 =head2 B<REQUIRED> Key => Str
102  
103 Object key for which the action was initiated.
104  
105  
106  
107 =head2 RequestPayer => Str
108  
109  
110  
111 Valid values are: C<"requester">
112  
113 =head2 RestoreRequest => L<Paws::S3::RestoreRequest>
114  
115  
116  
117  
118  
119 =head2 VersionId => Str
120  
121 VersionId used to reference a specific version of the object.
122  
123  
124  
125  
126 =head1 SEE ALSO
127  
128 This class forms part of L<Paws>, documenting arguments for method RestoreObject in L<Paws::S3>
129  
130 =head1 BUGS and CONTRIBUTIONS
131  
132 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
133  
134 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
135  
136 =cut
137  
« blib/lib/Paws/S3/RequestPaymentConfiguration.pm ↑ Summary blib/lib/Paws/S3/SelectObjectContent.pm »