Skip to content

get_bucket_policy_status

Operation

get_bucket_policy_status

get_bucket_policy_status(request: GetBucketPolicyStatusInput | GetBucketPolicyStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketPolicyStatusInputDict]) -> GetBucketPolicyStatusOutput
Note

This operation is not supported for directory buckets.

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

The following operations are related to GetBucketPolicyStatus:

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 GetBucketPolicyStatusInput | GetBucketPolicyStatusInputDict | 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[GetBucketPolicyStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetBucketPolicyStatusOutput

An instance of GetBucketPolicyStatusOutput.

get_bucket_policy_status async

get_bucket_policy_status(request: GetBucketPolicyStatusInput | GetBucketPolicyStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketPolicyStatusInputDict]) -> GetBucketPolicyStatusOutput
Note

This operation is not supported for directory buckets.

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

The following operations are related to GetBucketPolicyStatus:

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 GetBucketPolicyStatusInput | GetBucketPolicyStatusInputDict | 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[GetBucketPolicyStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetBucketPolicyStatusOutput

An instance of GetBucketPolicyStatusOutput.

Input

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

GetBucketPolicyStatusInputDict

Bases: TypedDict

Dictionary form of GetBucketPolicyStatusInput.

Attributes

bucket instance-attribute
bucket: Required[str]

The name of the Amazon S3 bucket whose policy status 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).

GetBucketPolicyStatusInput dataclass

Bases: _SerdeShape

Dataclass for GetBucketPolicyStatusInput structure.

Attributes

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

The name of the Amazon S3 bucket whose policy status 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

GetBucketPolicyStatusOutput dataclass

Bases: _SerdeShape

Dataclass for GetBucketPolicyStatusOutput structure.

Attributes

policy_status class-attribute instance-attribute
policy_status: PolicyStatus | None = ...

The policy status for the specified 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.