S3Control / Paginator / ListAccessPointsForDirectoryBuckets

ListAccessPointsForDirectoryBuckets

class S3Control.Paginator.ListAccessPointsForDirectoryBuckets

paginator = client.get_paginator('list_access_points_for_directory_buckets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from S3Control.Client.list_access_points_for_directory_buckets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AccountId='string',
    DirectoryBucket='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AccountId (string) –

  [REQUIRED]

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

• DirectoryBucket (string) – The name of the directory bucket associated with the access points you want to list.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

• (dict) –

  • AccessPointList (list) –

    Contains identification and configuration information for one or more access points associated with the directory 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.