Class: Aws::S3::Types::InventoryTableConfigurationResult

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

The inventory table configuration for an S3 Metadata configuration.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_state ⇒ String

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

Returns:

  • (String) 


10421
10422
10423
10424
10425
10426
10427
10428
10429
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10421

class InventoryTableConfigurationResult < Struct.new(
  :configuration_state,
  :table_status,
  :error,
  :table_name,
  :table_arn)
  SENSITIVE = []
  include Aws::Structure
end

#error ⇒ Types::ErrorDetails

If an S3 Metadata V1 CreateBucketMetadataTableConfiguration or V2 CreateBucketMetadataConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.

If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.

Returns:



10421
10422
10423
10424
10425
10426
10427
10428
10429
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10421

class InventoryTableConfigurationResult < Struct.new(
  :configuration_state,
  :table_status,
  :error,
  :table_name,
  :table_arn)
  SENSITIVE = []
  include Aws::Structure
end

#table_arn ⇒ String

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

Returns:

  • (String) 


10421
10422
10423
10424
10425
10426
10427
10428
10429
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10421

class InventoryTableConfigurationResult < Struct.new(
  :configuration_state,
  :table_status,
  :error,
  :table_name,
  :table_arn)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

The name of the inventory table.

Returns:

  • (String) 


10421
10422
10423
10424
10425
10426
10427
10428
10429
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10421

class InventoryTableConfigurationResult < Struct.new(
  :configuration_state,
  :table_status,
  :error,
  :table_name,
  :table_arn)
  SENSITIVE = []
  include Aws::Structure
end

#table_status ⇒ String

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.

Returns:

  • (String) 


10421
10422
10423
10424
10425
10426
10427
10428
10429
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10421

class InventoryTableConfigurationResult < Struct.new(
  :configuration_state,
  :table_status,
  :error,
  :table_name,
  :table_arn)
  SENSITIVE = []
  include Aws::Structure
end