S3Control / Client / get_access_point_policy

get_access_point_policy#

S3Control.Client.get_access_point_policy(**kwargs)#

Returns the access point policy associated with the specified access point.

The following actions are related to GetAccessPointPolicy:

See also: AWS API Documentation

Request Syntax

response = client.get_access_point_policy(
    AccountId='string',
    Name='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The account ID for the account that owns the specified access point.

  • Name (string) –

    [REQUIRED]

    The name of the access point whose policy you want to retrieve.

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

Return type:

dict

Returns:

Response Syntax

{
    'Policy': 'string'
}

Response Structure

  • (dict) –

    • Policy (string) –

      The access point policy associated with the specified access point.