putBucketInventoryConfiguration method

Future<void> putBucketInventoryConfiguration({ required String bucket, required String id, required InventoryConfiguration inventoryConfiguration, String? expectedBucketOwner, })

This implementation of the PUT operation 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 AWS 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 Simple Storage Service Developer Guide. To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

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

  • Code: AccessDenied
  • 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.

Related Resources

• GetBucketInventoryConfiguration
• DeleteBucketInventoryConfiguration
• ListBucketInventoryConfigurations

Parameter bucket : The name of the bucket where the inventory configuration will be stored.

Parameter id : The ID used to identify the inventory configuration.

Parameter inventoryConfiguration : Specifies the inventory configuration.

Parameter expectedBucketOwner : The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Implementation

Future<void> putBucketInventoryConfiguration({
  required String bucket,
  required String id,
  required InventoryConfiguration inventoryConfiguration,
  String? expectedBucketOwner,
}) async {
  ArgumentError.checkNotNull(bucket, 'bucket');
  ArgumentError.checkNotNull(id, 'id');
  ArgumentError.checkNotNull(
      inventoryConfiguration, 'inventoryConfiguration');
  final headers = <String, String>{
    if (expectedBucketOwner != null)
      'x-amz-expected-bucket-owner': expectedBucketOwner.toString(),
  };
  final $query = <String, List<String>>{
    'id': [id],
  };
  await _protocol.send(
    method: 'PUT',
    requestUri: '/${Uri.encodeComponent(bucket)}?inventory',
    queryParams: $query,
    headers: headers,
    payload: inventoryConfiguration.toXml('InventoryConfiguration'),
    exceptionFnMap: _exceptionFns,
  );
}