S3 / Client / put_bucket_inventory_configuration

put_bucket_inventory_configuration#

S3.Client.put_bucket_inventory_configuration(**kwargs)#

Note

This operation is not supported for directory buckets.

This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.

Warning

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

Permissions

To use this operation, you must have permission to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others.

The s3:PutInventoryConfiguration permission allows a user to create an S3 Inventory report that includes all object metadata fields available and to specify the destination bucket to store the inventory. A user with read access to objects in the destination bucket can also access all object metadata fields that are available in the inventory report.

To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the Amazon S3 User Guide.

PutBucketInventoryConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.

The following operations are related to PutBucketInventoryConfiguration:

Request Syntax

response = client.put_bucket_inventory_configuration(
    Bucket='string',
    Id='string',
    InventoryConfiguration={
        'Destination': {
            'S3BucketDestination': {
                'AccountId': 'string',
                'Bucket': 'string',
                'Format': 'CSV'|'ORC'|'Parquet',
                'Prefix': 'string',
                'Encryption': {
                    'SSES3': {}
                    ,
                    'SSEKMS': {
                        'KeyId': 'string'
                    }
                }
            }
        },
        'IsEnabled': True|False,
        'Filter': {
            'Prefix': 'string'
        },
        'Id': 'string',
        'IncludedObjectVersions': 'All'|'Current',
        'OptionalFields': [
            'Size'|'LastModifiedDate'|'StorageClass'|'ETag'|'IsMultipartUploaded'|'ReplicationStatus'|'EncryptionStatus'|'ObjectLockRetainUntilDate'|'ObjectLockMode'|'ObjectLockLegalHoldStatus'|'IntelligentTieringAccessTier'|'BucketKeyStatus'|'ChecksumAlgorithm'|'ObjectAccessControlList'|'ObjectOwner',
        ],
        'Schedule': {
            'Frequency': 'Daily'|'Weekly'
        }
    },
    ExpectedBucketOwner='string'
)

Parameters:

Bucket (string) –
[REQUIRED]

The name of the bucket where the inventory configuration will be stored.
Id (string) –
[REQUIRED]

The ID used to identify the inventory configuration.
InventoryConfiguration (dict) –
[REQUIRED]

Specifies the inventory configuration.
- Destination (dict) – [REQUIRED]
  
  Contains information about where to publish the inventory results.
  - S3BucketDestination (dict) – [REQUIRED]
    
    Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.
    - AccountId (string) –
      
      The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.
      
      Note
      Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
    - Bucket (string) – [REQUIRED]
      
      The Amazon Resource Name (ARN) of the bucket where inventory results will be published.
    - Format (string) – [REQUIRED]
      
      Specifies the output format of the inventory results.
    - Prefix (string) –
      
      The prefix that is prepended to all inventory results.
    - Encryption (dict) –
      
      Contains the type of server-side encryption used to encrypt the inventory results.
      - SSES3 (dict) –
        
        Specifies the use of SSE-S3 to encrypt delivered inventory reports.
      - SSEKMS (dict) –
        
        Specifies the use of SSE-KMS to encrypt delivered inventory reports.
        
        KeyId (string) – [REQUIRED]
        
        Specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key to use for encrypting inventory reports.
- IsEnabled (boolean) – [REQUIRED]
  
  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.
- Filter (dict) –
  
  Specifies an inventory filter. The inventory only includes objects that meet the filter’s criteria.
  - Prefix (string) – [REQUIRED]
    
    The prefix that an object must have to be included in the inventory results.
- Id (string) – [REQUIRED]
  
  The ID used to identify the inventory configuration.
- IncludedObjectVersions (string) – [REQUIRED]
  
  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.
- OptionalFields (list) –
  
  Contains the optional fields that are included in the inventory results.
  - (string) –
- Schedule (dict) – [REQUIRED]
  
  Specifies the schedule for generating inventory results.
  - Frequency (string) – [REQUIRED]
    
    Specifies how frequently inventory results are produced.
ExpectedBucketOwner (string) – The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

None