S3Control / Client / list_access_points_for_directory_buckets

list_access_points_for_directory_buckets

S3Control.Client.list_access_points_for_directory_buckets(**kwargs)

Returns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket.

To list access points for general purpose buckets, see ListAccesspoints.

To use this operation, you must have the permission to perform the s3express:ListAccessPointsForDirectoryBuckets action.

For information about REST API errors, see REST error responses.

See also: AWS API Documentation

Request Syntax

response = client.list_access_points_for_directory_buckets(
    AccountId='string',
    DirectoryBucket='string',
    NextToken='string',
    MaxResults=123
)

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.

• NextToken (string) – If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

• MaxResults (integer) – The maximum number of access points that you would like returned in the ListAccessPointsForDirectoryBuckets response. If the directory bucket is associated with more than this number of access points, the results include the pagination token NextToken. Make another call using the NextToken to retrieve more results.

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

  • NextToken (string) –

    If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.