Skip to content

InventoryConfiguration

Used by
Source code in docs_src/capo_s3/types/inventory_configuration.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class InventoryConfiguration(TypedDict, closed=True):
    destination: "capo_s3.types.inventory_destination.InventoryDestination"
    """<p>Contains information about where to publish the inventory results.</p>"""
    is_enabled: "capo_s3.types.is_enabled.IsEnabled"
    """<p>Specifies whether the inventory is enabled or disabled. If set to <code>True</code>, an inventory list is generated. If set to <code>False</code>, no inventory list is generated.</p>"""
    filter: NotRequired["capo_s3.types.inventory_filter.InventoryFilter"]
    """<p>Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.</p>"""
    id: "capo_s3.types.inventory_id.InventoryId"
    """<p>The ID used to identify the inventory configuration.</p>"""
    included_object_versions: "capo_s3.types.inventory_included_object_versions.InventoryIncludedObjectVersions"
    """<p>Object versions to include in the inventory list. If set to <code>All</code>, the list includes all the object versions, which adds the version-related fields <code>VersionId</code>, <code>IsLatest</code>, and <code>DeleteMarker</code> to the list. If set to <code>Current</code>, the list does not contain these version-related fields.</p>"""
    optional_fields: NotRequired[
        "capo_s3.types.inventory_optional_fields.InventoryOptionalFields"
    ]
    """<p>Contains the optional fields that are included in the inventory results.</p> <note> <p>The following optional fields are supported for directory buckets <code>Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | EncryptionStatus | BucketKeyStatus | ChecksumAlgorithm | LifecycleExpirationDate.</code> Throws MalformedXML error if unsupported optional field is provided. </p> </note>"""
    schedule: "capo_s3.types.inventory_schedule.InventorySchedule"
    """<p>Specifies the schedule for generating inventory results.</p>"""

destination instance-attribute 

destination: InventoryDestination

Contains information about where to publish the inventory results.

filter instance-attribute 

filter: NotRequired[InventoryFilter]

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

id instance-attribute 

id: InventoryId

The ID used to identify the inventory configuration.

included_object_versions instance-attribute 

included_object_versions: InventoryIncludedObjectVersions

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: IsEnabled

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: NotRequired[InventoryOptionalFields]

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

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.