« blib/lib/Paws/S3/PutBucketAccelerateConfiguration.pm
↑ Summary
blib/lib/Paws/S3/PutBucketCors.pm »
| 1 | |||
| 2 | package Paws::S3::PutBucketAcl; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has AccessControlPolicy => (is => 'ro', isa => 'Paws::S3::AccessControlPolicy', traits => ['ParamInBody']); | |
| 5 | 1 | has ACL => (is => 'ro', isa => 'Str', header_name => 'x-amz-acl', traits => ['ParamInHeader']); | |
| 6 | 1 | has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1); | |
| 7 | 1 | has ContentLength => (is => 'ro', isa => 'Int', header_name => 'Content-Length', traits => ['ParamInHeader']); | |
| 8 | 1 | has ContentMD5 => (is => 'ro', isa => 'Str', header_name => 'Content-MD5', auto => 'MD5', traits => ['AutoInHeader']); | |
| 9 | 1 | has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']); | |
| 10 | 1 | has GrantFullControl => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-full-control', traits => ['ParamInHeader']); | |
| 11 | 1 | has GrantRead => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-read', traits => ['ParamInHeader']); | |
| 12 | 1 | has GrantReadACP => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-read-acp', traits => ['ParamInHeader']); | |
| 13 | 1 | has GrantWrite => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-write', traits => ['ParamInHeader']); | |
| 14 | 1 | has GrantWriteACP => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-write-acp', traits => ['ParamInHeader']); | |
| 15 | |||
| 16 | |||
| 17 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 18 | |||
| 19 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutBucketAcl'); | |
| 20 | 1 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}?acl'); | |
| 21 | 1 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | |
| 22 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | |
| 23 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 24 | |||
| 25 | |||
| 26 | 1 | 1; | |
| 27 | |||
| 28 | ### main pod documentation begin ### | ||
| 29 | |||
| 30 | =head1 NAME | ||
| 31 | |||
| 32 | Paws::S3::PutBucketAcl - Arguments for method PutBucketAcl on L<Paws::S3> | ||
| 33 | |||
| 34 | =head1 DESCRIPTION | ||
| 35 | |||
| 36 | This class represents the parameters used for calling the method PutBucketAcl on the | ||
| 37 | L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class | ||
| 38 | as arguments to method PutBucketAcl. | ||
| 39 | |||
| 40 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutBucketAcl. | ||
| 41 | |||
| 42 | =head1 SYNOPSIS | ||
| 43 | |||
| 44 | my $s3 = Paws->service('S3'); | ||
| 45 | # Put bucket acl | ||
| 46 | # The following example replaces existing ACL on a bucket. The ACL grants the | ||
| 47 | # bucket owner (specified using the owner ID) and write permission to the | ||
| 48 | # LogDelivery group. Because this is a replace operation, you must specify all | ||
| 49 | # the grants in your request. To incrementally add or remove ACL grants, you | ||
| 50 | # might use the console. | ||
| 51 | $s3->PutBucketAcl( | ||
| 52 | 'Bucket' => 'examplebucket', | ||
| 53 | 'GrantFullControl' => | ||
| 54 | 'id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484', | ||
| 55 | 'GrantWrite' => 'uri=http://acs.amazonaws.com/groups/s3/LogDelivery' | ||
| 56 | ); | ||
| 57 | |||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/PutBucketAcl> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 AccessControlPolicy => L<Paws::S3::AccessControlPolicy> | ||
| 66 | |||
| 67 | Contains the elements that set the ACL permissions for an object per | ||
| 68 | grantee. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 ACL => Str | ||
| 73 | |||
| 74 | The canned ACL to apply to the bucket. | ||
| 75 | |||
| 76 | Valid values are: C<"private">, C<"public-read">, C<"public-read-write">, C<"authenticated-read"> | ||
| 77 | |||
| 78 | =head2 B<REQUIRED> Bucket => Str | ||
| 79 | |||
| 80 | The bucket to which to apply the ACL. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 ContentLength => Int | ||
| 85 | |||
| 86 | Size of the body in bytes. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 ContentMD5 => Str | ||
| 91 | |||
| 92 | The base64-encoded 128-bit MD5 digest of the data. This header must be | ||
| 93 | used as a message integrity check to verify that the request body was | ||
| 94 | not corrupted in transit. For more information, go to RFC 1864. | ||
| 95 | (http://www.ietf.org/rfc/rfc1864.txt) | ||
| 96 | |||
| 97 | For requests made using the AWS Command Line Interface (CLI) or AWS | ||
| 98 | SDKs, this field is calculated automatically. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 ExpectedBucketOwner => Str | ||
| 103 | |||
| 104 | The account ID of the expected bucket owner. If the bucket is owned by | ||
| 105 | a different account, the request will fail with an HTTP C<403 (Access | ||
| 106 | Denied)> error. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 GrantFullControl => Str | ||
| 111 | |||
| 112 | Allows grantee the read, write, read ACP, and write ACP permissions on | ||
| 113 | the bucket. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 GrantRead => Str | ||
| 118 | |||
| 119 | Allows grantee to list the objects in the bucket. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 GrantReadACP => Str | ||
| 124 | |||
| 125 | Allows grantee to read the bucket ACL. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 GrantWrite => Str | ||
| 130 | |||
| 131 | Allows grantee to create new objects in the bucket. | ||
| 132 | |||
| 133 | For the bucket and object owners of existing objects, also allows | ||
| 134 | deletions and overwrites of those objects. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 GrantWriteACP => Str | ||
| 139 | |||
| 140 | Allows grantee to write the ACL for the applicable bucket. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head1 SEE ALSO | ||
| 146 | |||
| 147 | This class forms part of L<Paws>, documenting arguments for method PutBucketAcl in L<Paws::S3> | ||
| 148 | |||
| 149 | =head1 BUGS and CONTRIBUTIONS | ||
| 150 | |||
| 151 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 152 | |||
| 153 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 154 | |||
| 155 | =cut | ||
| 156 | |||