Skip to content

S3  >  Structures  >  InventoryConfiguration

InventoryConfiguration

Structure Class

InventoryConfiguration dataclass

Bases: _SerdeShape

Specifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

Attributes

destination instance-attribute 
destination: InventoryDestination

Contains information about where to publish the inventory results.

filter class-attribute instance-attribute 
filter: InventoryFilter | None = ...

Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

id instance-attribute 
id: str

The ID used to identify the inventory configuration.

included_object_versions instance-attribute 
included_object_versions: str

Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

is_enabled instance-attribute 
is_enabled: bool

Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

optional_fields class-attribute instance-attribute 
optional_fields: list[str] | None = ...

Contains the optional fields that are included in the inventory results.

Note

The following optional fields are supported for directory buckets Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | EncryptionStatus | BucketKeyStatus | ChecksumAlgorithm | LifecycleExpirationDate. Throws MalformedXML error if unsupported optional field is provided.

schedule instance-attribute 
schedule: InventorySchedule

Specifies the schedule for generating inventory results.