S3 / Client / get_bucket_policy_status

get_bucket_policy_status#

S3.Client.get_bucket_policy_status(**kwargs)#

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 :

See also: AWS API Documentation

Request Syntax

response = client.get_bucket_policy_status(
    Bucket='string',
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

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

  • ExpectedBucketOwner (string) – The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Return type:

dict

Returns:

Response Syntax

{
    'PolicyStatus': {
        'IsPublic': True|False
    }
}

Response Structure

  • (dict) –

    • PolicyStatus (dict) –

      The policy status for the specified bucket.

      • IsPublic (boolean) –

        The policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public.