getBucketInventoryConfiguration method

Future<GetBucketInventoryConfigurationOutput> getBucketInventoryConfiguration({ required String bucket, required String id, String? expectedBucketOwner, })

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration 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.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

• DeleteBucketInventoryConfiguration
• ListBucketInventoryConfigurations
• PutBucketInventoryConfiguration

Parameter bucket : The name of the bucket containing the inventory configuration to retrieve.

Parameter id : The ID used to identify 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<GetBucketInventoryConfigurationOutput>
    getBucketInventoryConfiguration({
  required String bucket,
  required String id,
  String? expectedBucketOwner,
}) async {
  ArgumentError.checkNotNull(bucket, 'bucket');
  ArgumentError.checkNotNull(id, 'id');
  final headers = <String, String>{
    if (expectedBucketOwner != null)
      'x-amz-expected-bucket-owner': expectedBucketOwner.toString(),
  };
  final $query = <String, List<String>>{
    'id': [id],
  };
  final $result = await _protocol.sendRaw(
    method: 'GET',
    requestUri: '/${Uri.encodeComponent(bucket)}?inventory',
    queryParams: $query,
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  final $elem = await _s.xmlFromResponse($result);
  return GetBucketInventoryConfigurationOutput(
    inventoryConfiguration: InventoryConfiguration.fromXml($elem),
  );
}