class Aws::S3::Types::InventoryConfiguration

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

[1]: docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html

@note When making an API call, you may pass InventoryConfiguration

data as a hash:

    {
      destination: { # required
        s3_bucket_destination: { # required
          account_id: "AccountId",
          bucket: "BucketName", # required
          format: "CSV", # required, accepts CSV, ORC, Parquet
          prefix: "Prefix",
          encryption: {
            sses3: {
            },
            ssekms: {
              key_id: "SSEKMSKeyId", # required
            },
          },
        },
      },
      is_enabled: false, # required
      filter: {
        prefix: "Prefix", # required
      },
      id: "InventoryId", # required
      included_object_versions: "All", # required, accepts All, Current
      optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier, BucketKeyStatus
      schedule: { # required
        frequency: "Daily", # required, accepts Daily, Weekly
      },
    }

@!attribute [rw] destination

Contains information about where to publish the inventory results.
@return [Types::InventoryDestination]

@!attribute [rw] is_enabled

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.
@return [Boolean]

@!attribute [rw] filter

Specifies an inventory filter. The inventory only includes objects
that meet the filter's criteria.
@return [Types::InventoryFilter]

@!attribute [rw] id

The ID used to identify the inventory configuration.
@return [String]

@!attribute [rw] included_object_versions

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.
@return [String]

@!attribute [rw] optional_fields

Contains the optional fields that are included in the inventory
results.
@return [Array<String>]

@!attribute [rw] schedule

Specifies the schedule for generating inventory results.
@return [Types::InventorySchedule]

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/InventoryConfiguration AWS API Documentation

Constants

SENSITIVE