getBucketOwnershipControls method

Future<GetBucketOwnershipControlsOutput> getBucketOwnershipControls({ required String bucket, String? expectedBucketOwner, })

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to GetBucketOwnershipControls:

• PutBucketOwnershipControls
• DeleteBucketOwnershipControls

Parameter bucket : The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.

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<GetBucketOwnershipControlsOutput> getBucketOwnershipControls({
  required String bucket,
  String? expectedBucketOwner,
}) async {
  ArgumentError.checkNotNull(bucket, 'bucket');
  final headers = <String, String>{
    if (expectedBucketOwner != null)
      'x-amz-expected-bucket-owner': expectedBucketOwner.toString(),
  };
  final $result = await _protocol.sendRaw(
    method: 'GET',
    requestUri: '/${Uri.encodeComponent(bucket)}?ownershipControls',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  final $elem = await _s.xmlFromResponse($result);
  return GetBucketOwnershipControlsOutput(
    ownershipControls: OwnershipControls.fromXml($elem),
  );
}