Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.
Contents
- Destination
-
Contains information about where to publish the inventory results.
Type: InventoryDestination data type
Required: Yes
- Id
-
The ID used to identify the inventory configuration.
Type: String
Required: Yes
- IncludedObjectVersions
-
Object versions to include in the inventory list. If set to
All, the list includes all the object versions, which adds the version-related fieldsVersionId,IsLatest, andDeleteMarkerto the list. If set toCurrent, the list does not contain these version-related fields.Type: String
Valid Values:
All | CurrentRequired: Yes
- IsEnabled
-
Specifies whether the inventory is enabled or disabled. If set to
True, an inventory list is generated. If set toFalse, no inventory list is generated.Type: Boolean
Required: Yes
- Schedule
-
Specifies the schedule for generating inventory results.
Type: InventorySchedule data type
Required: Yes
- Filter
-
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.
Type: InventoryFilter data type
Required: No
- OptionalFields
-
Contains the optional fields that are included in the inventory results.
Type: Array of strings
Valid Values:
Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | ReplicationStatus | EncryptionStatus | ObjectLockRetainUntilDate | ObjectLockMode | ObjectLockLegalHoldStatus | IntelligentTieringAccessTier | BucketKeyStatus | ChecksumAlgorithm | ObjectAccessControlList | ObjectOwnerRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
