Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the request
and an S3 on Outposts endpoint hostname prefix instead of s3-control
.
For an example of the request syntax for Amazon S3 on Outposts that uses
the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id
derived using the access point ARN, see the
Examples
section.
The following actions are related to
put_access_point_policy
:
get_access_point_policy
delete_access_point_policy
s3control_put_access_point_policy(AccountId, Name, Policy)
An empty list.
[required] The AWS account ID for owner of the bucket associated with the specified access point.
[required] The name of the access point that you want to associate with the specified policy.
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 AWS SDK and CLI,
you must specify the ARN of the access point accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
.
For example, to access the access point reports-ap
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/accesspoint/reports-ap
.
The value must be URL encoded.
[required] The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
svc$put_access_point_policy(
AccountId = "string",
Name = "string",
Policy = "string"
)