put_bucket_inventory_configuration¶
Operation¶
put_bucket_inventory_configuration
async
¶
put_bucket_inventory_configuration(request: PutBucketInventoryConfigurationInput | PutBucketInventoryConfigurationInputDict, /, *, plugins: list[Plugin] | None = None) -> PutBucketInventoryConfigurationOutput
put_bucket_inventory_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutBucketInventoryConfigurationInputDict]) -> PutBucketInventoryConfigurationOutput
This implementation of the PUT action adds an S3 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.
Note:
Directory buckets - For directory buckets, you must make requests
for this API operation to the Regional endpoint. These endpoints support
path-style requests in the format
https://s3express-control.region-code.amazonaws.com/bucket-name.
Virtual-hosted-style requests aren't supported. For more information
about endpoints in Availability Zones, see Regional and Zonal endpoints
for directory buckets in Availability
Zones
in the Amazon S3 User Guide. For more information about endpoints in
Local Zones, see Concepts for directory buckets in Local
Zones
in the Amazon S3 User Guide.
- Permissions
-
To use this operation, you must have permission to perform the
s3:PutInventoryConfigurationaction. The bucket owner has this permission by default and can grant this permission to others.The
s3:PutInventoryConfigurationpermission 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.-
General purpose bucket permissions - The
s3:PutInventoryConfigurationpermission is required in a policy. For more information about general purpose buckets permissions, see Using Bucket Policies and User Policies in the Amazon S3 User Guide. -
Directory bucket permissions - To grant access to this API operation, you must have the
s3express:PutInventoryConfigurationpermission in an IAM identity-based policy instead of a bucket policy. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
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.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region-code.amazonaws.com.
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:PutInventoryConfigurationbucket permission to set the configuration on the bucket.
The following operations are related to
PutBucketInventoryConfiguration:
Warning
You must URL encode any signed header values that contain spaces. For
example, if your header value is my file.txt, containing two spaces
after my, you must URL encode this value to my%20%20file.txt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
PutBucketInventoryConfigurationOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
PutBucketInventoryConfigurationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutBucketInventoryConfigurationInput structure.
Attributes¶
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the bucket where the inventory configuration will be stored.
Directory buckets - When you use this operation with a directory
bucket, you must use path-style requests in the format
https://s3express-control.region-code.amazonaws.com/bucket-name.
Virtual-hosted-style requests aren't supported. Directory bucket names
must be unique in the chosen Zone (Availability Zone or Local Zone).
Bucket names must also follow the format
bucket-base-name--zone-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information
about bucket naming restrictions, see Directory bucket naming
rules
in the Amazon S3 User Guide
expected_bucket_owner
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
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).
Note
For directory buckets, this header is not supported in this API
operation. If you specify this header, the request fails with the HTTP
status code 501 Not Implemented.
id
class-attribute
instance-attribute
¶
id: str | None = ...
The ID used to identify the inventory configuration.
inventory_configuration
class-attribute
instance-attribute
¶
inventory_configuration: InventoryConfiguration | None = ...
Specifies the inventory configuration.
Dictionaries¶
PutBucketInventoryConfigurationInputDict
¶
Bases: TypedDict
Dictionary form of PutBucketInventoryConfigurationInput.
Attributes¶
bucket
instance-attribute
¶
The name of the bucket where the inventory configuration will be stored.
Directory buckets - When you use this operation with a directory
bucket, you must use path-style requests in the format
https://s3express-control.region-code.amazonaws.com/bucket-name.
Virtual-hosted-style requests aren't supported. Directory bucket names
must be unique in the chosen Zone (Availability Zone or Local Zone).
Bucket names must also follow the format
bucket-base-name--zone-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information
about bucket naming restrictions, see Directory bucket naming
rules
in the Amazon S3 User Guide
expected_bucket_owner
instance-attribute
¶
expected_bucket_owner: str | None
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).
Note
For directory buckets, this header is not supported in this API
operation. If you specify this header, the request fails with the HTTP
status code 501 Not Implemented.
inventory_configuration
instance-attribute
¶
inventory_configuration: Required[InventoryConfiguration | InventoryConfigurationDict]
Specifies the inventory configuration.
Output¶
PutBucketInventoryConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutBucketInventoryConfigurationOutput structure.