| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::S3::InventoryConfiguration; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has Destination => (is => 'ro', isa => 'Paws::S3::InventoryDestination', required => 1); | |
| 5 | 1 | has Filter => (is => 'ro', isa => 'Paws::S3::InventoryFilter'); | |
| 6 | 1 | has Id => (is => 'ro', isa => 'Str', required => 1); | |
| 7 | 1 | has IncludedObjectVersions => (is => 'ro', isa => 'Str', required => 1); | |
| 8 | 1 | has IsEnabled => (is => 'ro', isa => 'Bool', required => 1); | |
| 9 | 1 | has OptionalFields => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'Field', traits => ['NameInRequest']); | |
| 10 | 1 | has Schedule => (is => 'ro', isa => 'Paws::S3::InventorySchedule', required => 1); | |
| 11 | |||
| 12 | 1 | 1; | |
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::S3::InventoryConfiguration | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::S3::InventoryConfiguration object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { Destination => $value, ..., Schedule => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::S3::InventoryConfiguration object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->Destination | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Specifies the inventory configuration for an Amazon S3 bucket. For more | ||
| 43 | information, see GET Bucket inventory | ||
| 44 | (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) | ||
| 45 | in the I<Amazon S3 API Reference>. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> Destination => L<Paws::S3::InventoryDestination> | ||
| 51 | |||
| 52 | Contains information about where to publish the inventory results. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Filter => L<Paws::S3::InventoryFilter> | ||
| 56 | |||
| 57 | Specifies an inventory filter. The inventory only includes objects that | ||
| 58 | meet the filter's criteria. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> Id => Str | ||
| 62 | |||
| 63 | The ID used to identify the inventory configuration. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> IncludedObjectVersions => Str | ||
| 67 | |||
| 68 | Object versions to include in the inventory list. If set to C<All>, the | ||
| 69 | list includes all the object versions, which adds the version-related | ||
| 70 | fields C<VersionId>, C<IsLatest>, and C<DeleteMarker> to the list. If | ||
| 71 | set to C<Current>, the list does not contain these version-related | ||
| 72 | fields. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> IsEnabled => Bool | ||
| 76 | |||
| 77 | Specifies whether the inventory is enabled or disabled. If set to | ||
| 78 | C<True>, an inventory list is generated. If set to C<False>, no | ||
| 79 | inventory list is generated. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 OptionalFields => ArrayRef[Str|Undef] | ||
| 83 | |||
| 84 | Contains the optional fields that are included in the inventory | ||
| 85 | results. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> Schedule => L<Paws::S3::InventorySchedule> | ||
| 89 | |||
| 90 | Specifies the schedule for generating inventory results. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, describing an object used in L<Paws::S3> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 | |||