Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface InventoryConfiguration

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


  • InventoryConfiguration


Destination: undefined | InventoryDestination

Contains information about where to publish the inventory results.

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

Id: undefined | string

The ID used to identify the inventory configuration.

IncludedObjectVersions: undefined | string

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.

IsEnabled: undefined | boolean

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.

OptionalFields?: string[]

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

Schedule: undefined | InventorySchedule

Specifies the schedule for generating inventory results.