« blib/lib/Paws/S3/PutBucketEncryption.pm
↑ Summary
blib/lib/Paws/S3/PutBucketLifecycleConfiguration.pm »
| 1 | |||
| 2 | package Paws::S3::PutBucketInventoryConfiguration; | ||
| 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 ContentLength => (is => 'ro', isa => 'Int', header_name => 'Content-Length', traits => ['ParamInHeader']); | |
| 6 | 1 | has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']); | |
| 7 | 1 | has Id => (is => 'ro', isa => 'Str', query_name => 'id', traits => ['ParamInQuery'], required => 1); | |
| 8 | 1 | has InventoryConfiguration => (is => 'ro', isa => 'Paws::S3::InventoryConfiguration', traits => ['ParamInBody'], required => 1); | |
| 9 | |||
| 10 | |||
| 11 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 12 | |||
| 13 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutBucketInventoryConfiguration'); | |
| 14 | 1 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}?inventory'); | |
| 15 | 1 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | |
| 16 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | |
| 17 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 18 | |||
| 19 | |||
| 20 | 1 | 1; | |
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::S3::PutBucketInventoryConfiguration - Arguments for method PutBucketInventoryConfiguration on L<Paws::S3> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method PutBucketInventoryConfiguration on the | ||
| 31 | L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class | ||
| 32 | as arguments to method PutBucketInventoryConfiguration. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutBucketInventoryConfiguration. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $s3 = Paws->service('S3'); | ||
| 39 | $s3->PutBucketInventoryConfiguration( | ||
| 40 | Bucket => 'MyBucketName', | ||
| 41 | Id => 'MyInventoryId', | ||
| 42 | InventoryConfiguration => { | ||
| 43 | Destination => { | ||
| 44 | S3BucketDestination => { | ||
| 45 | Bucket => 'MyBucketName', | ||
| 46 | Format => 'CSV', # values: CSV, ORC, Parquet | ||
| 47 | AccountId => 'MyAccountId', # OPTIONAL | ||
| 48 | Encryption => { | ||
| 49 | SSEKMS => { | ||
| 50 | KeyId => 'MySSEKMSKeyId', | ||
| 51 | |||
| 52 | }, # OPTIONAL | ||
| 53 | SSES3 => { | ||
| 54 | |||
| 55 | }, # OPTIONAL | ||
| 56 | }, # OPTIONAL | ||
| 57 | Prefix => 'MyPrefix', # OPTIONAL | ||
| 58 | }, | ||
| 59 | |||
| 60 | }, | ||
| 61 | Id => 'MyInventoryId', | ||
| 62 | IncludedObjectVersions => 'All', # values: All, Current | ||
| 63 | IsEnabled => 1, | ||
| 64 | Schedule => { | ||
| 65 | Frequency => 'Daily', # values: Daily, Weekly | ||
| 66 | |||
| 67 | }, | ||
| 68 | Filter => { | ||
| 69 | Prefix => 'MyPrefix', # OPTIONAL | ||
| 70 | |||
| 71 | }, # OPTIONAL | ||
| 72 | OptionalFields => [ | ||
| 73 | 'Size', | ||
| 74 | ... # values: Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier, BucketKeyStatus | ||
| 75 | ], # OPTIONAL | ||
| 76 | }, | ||
| 77 | ContentLength => 1, # OPTIONAL | ||
| 78 | ExpectedBucketOwner => 'MyAccountId', # OPTIONAL | ||
| 79 | ); | ||
| 80 | |||
| 81 | 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. | ||
| 82 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/PutBucketInventoryConfiguration> | ||
| 83 | |||
| 84 | =head1 ATTRIBUTES | ||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> Bucket => Str | ||
| 88 | |||
| 89 | The name of the bucket where the inventory configuration will be | ||
| 90 | stored. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 ContentLength => Int | ||
| 95 | |||
| 96 | Size of the body in bytes. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 ExpectedBucketOwner => Str | ||
| 101 | |||
| 102 | The account ID of the expected bucket owner. If the bucket is owned by | ||
| 103 | a different account, the request will fail with an HTTP C<403 (Access | ||
| 104 | Denied)> error. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 B<REQUIRED> Id => Str | ||
| 109 | |||
| 110 | The ID used to identify the inventory configuration. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> InventoryConfiguration => L<Paws::S3::InventoryConfiguration> | ||
| 115 | |||
| 116 | Specifies the inventory configuration. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, documenting arguments for method PutBucketInventoryConfiguration in L<Paws::S3> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 | |||