S3Control / Client / list_access_points

list_access_points#

S3Control.Client.list_access_points(**kwargs)#

Note

This operation is not supported by directory buckets.

Returns a list of the access points that are owned by the current account that’s associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

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. In addition, you must use 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 by using the access point ARN, see the Examples section.

The following actions are related to ListAccessPoints:

See also: AWS API Documentation

Request Syntax

response = client.list_access_points(
    AccountId='string',
    Bucket='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID for the account that owns the specified access points.

  • Bucket (string) –

    The name of the bucket whose associated access points you want to list.

    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:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. 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.

  • NextToken (string) – A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

  • MaxResults (integer) – The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

Return type:

dict

Returns:

Response Syntax

{
    'AccessPointList': [
        {
            'Name': 'string',
            'NetworkOrigin': 'Internet'|'VPC',
            'VpcConfiguration': {
                'VpcId': 'string'
            },
            'Bucket': 'string',
            'AccessPointArn': 'string',
            'Alias': 'string',
            'BucketAccountId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AccessPointList (list) –

      Contains identification and configuration information for one or more access points associated with the specified bucket.

      • (dict) –

        An access point used to access a bucket.

        • Name (string) –

          The name of this access point.

        • NetworkOrigin (string) –

          Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn’t allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

        • VpcConfiguration (dict) –

          The virtual private cloud (VPC) configuration for this access point, if one exists.

          Note

          This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services services.

          • VpcId (string) –

            If this field is specified, this access point will only allow connections from the specified VPC ID.

        • Bucket (string) –

          The name of the bucket associated with this access point.

        • AccessPointArn (string) –

          The ARN for the access point.

        • Alias (string) –

          The name or alias of the access point.

        • BucketAccountId (string) –

          The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

    • NextToken (string) –

      If the specified bucket has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.