Skip to content

InventoryTableConfigurationResult

Source code in docs_src/capo_s3/types/inventory_table_configuration_result.py
class InventoryTableConfigurationResult(TypedDict, closed=True):
    configuration_state: (
        "capo_s3.types.inventory_configuration_state.InventoryConfigurationState"
    )
    """<p> The configuration state of the inventory table, indicating whether the inventory table is enabled or disabled. </p>"""
    table_status: NotRequired["capo_s3.types.metadata_table_status.MetadataTableStatus"]
    """<p> The status of the inventory table. The status values are: </p> <ul> <li> <p> <code>CREATING</code> - The inventory table is in the process of being created in the specified Amazon Web Services managed table bucket.</p> </li> <li> <p> <code>BACKFILLING</code> - The inventory table is in the process of being backfilled. When you enable the inventory table for your metadata configuration, the table goes through a process known as backfilling, during which Amazon S3 scans your general purpose bucket to retrieve the initial metadata for all objects in the bucket. Depending on the number of objects in your bucket, this process can take several hours. When the backfilling process is finished, the status of your inventory table changes from <code>BACKFILLING</code> to <code>ACTIVE</code>. After backfilling is completed, updates to your objects are reflected in the inventory table within one hour.</p> </li> <li> <p> <code>ACTIVE</code> - The inventory table has been created successfully, and records are being delivered to the table. </p> </li> <li> <p> <code>FAILED</code> - Amazon S3 is unable to create the inventory table, or Amazon S3 is unable to deliver records.</p> </li> </ul>"""
    error: NotRequired["capo_s3.types.error_details.ErrorDetails"]
    table_name: NotRequired["capo_s3.types.s3_tables_name.S3TablesName"]
    """<p> The name of the inventory table. </p>"""
    table_arn: NotRequired["capo_s3.types.s3_tables_arn.S3TablesArn"]
    """<p> The Amazon Resource Name (ARN) for the inventory table. </p>"""

configuration_state instance-attribute

configuration_state: InventoryConfigurationState

The configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.

error instance-attribute

error: NotRequired[ErrorDetails]

table_arn instance-attribute

table_arn: NotRequired[S3TablesArn]

The Amazon Resource Name (ARN) for the inventory table.

table_name instance-attribute

table_name: NotRequired[S3TablesName]

The name of the inventory table.

table_status instance-attribute

table_status: NotRequired[MetadataTableStatus]

The status of the inventory table. The status values are:

  • CREATING - The inventory table is in the process of being created in the specified Amazon Web Services managed table bucket.

  • BACKFILLING - The inventory table is in the process of being backfilled. When you enable the inventory table for your metadata configuration, the table goes through a process known as backfilling, during which Amazon S3 scans your general purpose bucket to retrieve the initial metadata for all objects in the bucket. Depending on the number of objects in your bucket, this process can take several hours. When the backfilling process is finished, the status of your inventory table changes from BACKFILLING to ACTIVE. After backfilling is completed, updates to your objects are reflected in the inventory table within one hour.

  • ACTIVE - The inventory table has been created successfully, and records are being delivered to the table.

  • FAILED - Amazon S3 is unable to create the inventory table, or Amazon S3 is unable to deliver records.