Skip to content

get_bucket_ownership_controls

Operation

get_bucket_ownership_controls

get_bucket_ownership_controls(request: GetBucketOwnershipControlsInput | GetBucketOwnershipControlsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketOwnershipControlsInputDict]) -> GetBucketOwnershipControlsOutput
Note

This operation is not supported for directory buckets.

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.

Note

A bucket doesn't have OwnershipControls settings in the following cases:

  • The bucket was created before the BucketOwnerEnforced ownership setting was introduced and you've never explicitly applied this value

  • You've manually deleted the bucket ownership control value using the DeleteBucketOwnershipControls API operation.

By default, Amazon S3 sets OwnershipControls for all newly created buckets.

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

The following operations are related to GetBucketOwnershipControls:

  • PutBucketOwnershipControls

  • DeleteBucketOwnershipControls

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
request GetBucketOwnershipControlsInput | GetBucketOwnershipControlsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetBucketOwnershipControlsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetBucketOwnershipControlsOutput

An instance of GetBucketOwnershipControlsOutput.

get_bucket_ownership_controls async

get_bucket_ownership_controls(request: GetBucketOwnershipControlsInput | GetBucketOwnershipControlsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketOwnershipControlsInputDict]) -> GetBucketOwnershipControlsOutput
Note

This operation is not supported for directory buckets.

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.

Note

A bucket doesn't have OwnershipControls settings in the following cases:

  • The bucket was created before the BucketOwnerEnforced ownership setting was introduced and you've never explicitly applied this value

  • You've manually deleted the bucket ownership control value using the DeleteBucketOwnershipControls API operation.

By default, Amazon S3 sets OwnershipControls for all newly created buckets.

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

The following operations are related to GetBucketOwnershipControls:

  • PutBucketOwnershipControls

  • DeleteBucketOwnershipControls

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
request GetBucketOwnershipControlsInput | GetBucketOwnershipControlsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetBucketOwnershipControlsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetBucketOwnershipControlsOutput

An instance of GetBucketOwnershipControlsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetBucketOwnershipControlsInputDict

Bases: TypedDict

Dictionary form of GetBucketOwnershipControlsInput.

Attributes

bucket instance-attribute
bucket: Required[str]

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

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).

GetBucketOwnershipControlsInput dataclass

Bases: _SerdeShape

Dataclass for GetBucketOwnershipControlsInput structure.

Attributes

bucket class-attribute instance-attribute
bucket: str | None = ...

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

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).

Output

GetBucketOwnershipControlsOutput dataclass

Bases: _SerdeShape

Dataclass for GetBucketOwnershipControlsOutput structure.

Attributes

ownership_controls class-attribute instance-attribute
ownership_controls: OwnershipControls | None = ...

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.