« blib/lib/Paws/S3/PutObjectLegalHoldOutput.pm
↑ Summary
blib/lib/Paws/S3/PutObjectLockConfigurationOutput.pm »
| 1 | |||
| 2 | package Paws::S3::PutObjectLockConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1); | ||
| 5 | has ContentMD5 => (is => 'ro', isa => 'Str', header_name => 'Content-MD5', auto => 'MD5', traits => ['AutoInHeader']); | ||
| 6 | has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']); | ||
| 7 | has ObjectLockConfiguration => (is => 'ro', isa => 'Paws::S3::ObjectLockConfiguration', traits => ['ParamInBody']); | ||
| 8 | has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']); | ||
| 9 | has Token => (is => 'ro', isa => 'Str', header_name => 'x-amz-bucket-object-lock-token', traits => ['ParamInHeader']); | ||
| 10 | |||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutObjectLockConfiguration'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}?object-lock'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::PutObjectLockConfigurationOutput'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | |||
| 20 | |||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::S3::PutObjectLockConfiguration - Arguments for method PutObjectLockConfiguration on L<Paws::S3> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method PutObjectLockConfiguration on the | ||
| 32 | L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class | ||
| 33 | as arguments to method PutObjectLockConfiguration. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutObjectLockConfiguration. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $s3 = Paws->service('S3'); | ||
| 40 | my $PutObjectLockConfigurationOutput = $s3->PutObjectLockConfiguration( | ||
| 41 | Bucket => 'MyBucketName', | ||
| 42 | ContentMD5 => 'MyContentMD5', # OPTIONAL | ||
| 43 | ExpectedBucketOwner => 'MyAccountId', # OPTIONAL | ||
| 44 | ObjectLockConfiguration => { | ||
| 45 | ObjectLockEnabled => 'Enabled', # values: Enabled; OPTIONAL | ||
| 46 | Rule => { | ||
| 47 | DefaultRetention => { | ||
| 48 | Days => 1, # OPTIONAL | ||
| 49 | Mode => 'GOVERNANCE', # values: GOVERNANCE, COMPLIANCE; OPTIONAL | ||
| 50 | Years => 1, # OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | }, # OPTIONAL | ||
| 53 | }, # OPTIONAL | ||
| 54 | RequestPayer => 'requester', # OPTIONAL | ||
| 55 | Token => 'MyObjectLockToken', # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $RequestCharged = $PutObjectLockConfigurationOutput->RequestCharged; | ||
| 60 | |||
| 61 | # Returns a L<Paws::S3::PutObjectLockConfigurationOutput> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/PutObjectLockConfiguration> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> Bucket => Str | ||
| 70 | |||
| 71 | The bucket whose Object Lock configuration you want to create or | ||
| 72 | replace. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 ContentMD5 => Str | ||
| 77 | |||
| 78 | The MD5 hash for the request body. | ||
| 79 | |||
| 80 | For requests made using the AWS Command Line Interface (CLI) or AWS | ||
| 81 | SDKs, this field is calculated automatically. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 ExpectedBucketOwner => Str | ||
| 86 | |||
| 87 | The account ID of the expected bucket owner. If the bucket is owned by | ||
| 88 | a different account, the request will fail with an HTTP C<403 (Access | ||
| 89 | Denied)> error. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 ObjectLockConfiguration => L<Paws::S3::ObjectLockConfiguration> | ||
| 94 | |||
| 95 | The Object Lock configuration that you want to apply to the specified | ||
| 96 | bucket. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 RequestPayer => Str | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | Valid values are: C<"requester"> | ||
| 105 | |||
| 106 | =head2 Token => Str | ||
| 107 | |||
| 108 | A token to allow Object Lock to be enabled for an existing bucket. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head1 SEE ALSO | ||
| 114 | |||
| 115 | This class forms part of L<Paws>, documenting arguments for method PutObjectLockConfiguration in L<Paws::S3> | ||
| 116 | |||
| 117 | =head1 BUGS and CONTRIBUTIONS | ||
| 118 | |||
| 119 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 120 | |||
| 121 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 122 | |||
| 123 | =cut | ||
| 124 |