Skip to content

S3  >  Dictionaries  >  InventoryConfigurationDict

InventoryConfigurationDict

Dictionary Type

InventoryConfigurationDict

Bases: TypedDict

Dictionary form of InventoryConfiguration.

Attributes

destination instance-attribute

Contains information about where to publish the inventory results.

filter instance-attribute

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

id instance-attribute

The ID used to identify the inventory configuration.

included_object_versions instance-attribute
included_object_versions: Required[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: Required[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 instance-attribute
optional_fields: Sequence[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

Specifies the schedule for generating inventory results.