Skip to content

PutBucketPolicyRequest

Source code in docs_src/capo_s3_control/types/put_bucket_policy_request.py
class PutBucketPolicyRequest(TypedDict, closed=True):
    account_id: "capo_s3_control.types.account_id.AccountId"
    """<p>The Amazon Web Services account ID of the Outposts bucket.</p>"""
    bucket: "capo_s3_control.types.bucket_name.BucketName"
    """<p>Specifies the bucket.</p> <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p> <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>"""
    confirm_remove_self_bucket_access: "capo_s3_control.types.confirm_remove_self_bucket_access.ConfirmRemoveSelfBucketAccess"
    """<p>Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.</p> <note> <p>This is not supported by Amazon S3 on Outposts buckets.</p> </note>"""
    policy: "capo_s3_control.types.policy.Policy"
    """<p>The bucket policy as a JSON document.</p>"""

account_id instance-attribute

account_id: AccountId

The Amazon Web Services account ID of the Outposts bucket.

bucket instance-attribute

bucket: BucketName

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:::outpost//bucket/. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

confirm_remove_self_bucket_access instance-attribute

confirm_remove_self_bucket_access: ConfirmRemoveSelfBucketAccess

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

This is not supported by Amazon S3 on Outposts buckets.

policy instance-attribute

policy: Policy

The bucket policy as a JSON document.