S3Files / Paginator / ListAccessPoints

ListAccessPoints¶

class S3Files.Paginator.ListAccessPoints¶

paginator = client.get_paginator('list_access_points')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from S3Files.Client.list_access_points().

Request Syntax

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

Parameters:

fileSystemId (string) –
[REQUIRED]

The ID or Amazon Resource Name (ARN) of the S3 File System to list access points for.
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

{
    'accessPoints': [
        {
            'accessPointArn': 'string',
            'accessPointId': 'string',
            'fileSystemId': 'string',
            'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
            'ownerId': 'string',
            'posixUser': {
                'uid': 123,
                'gid': 123,
                'secondaryGids': [
                    123,
                ]
            },
            'rootDirectory': {
                'path': 'string',
                'creationPermissions': {
                    'ownerUid': 123,
                    'ownerGid': 123,
                    'permissions': 'string'
                }
            },
            'name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- accessPoints (list) –
  
  An array of access point descriptions.
  - (dict) –
    
    Contains information about an S3 File System Access Point returned in list operations.
    - accessPointArn (string) –
      
      The Amazon Resource Name (ARN) of the access point.
    - accessPointId (string) –
      
      The ID of the access point.
    - fileSystemId (string) –
      
      The ID of the S3 File System.
    - status (string) –
      
      The current status of the access point.
    - ownerId (string) –
      
      The Amazon Web Services account ID of the access point owner.
    - posixUser (dict) –
      
      The POSIX identity configured for this access point.
      - uid (integer) –
        
        The POSIX user ID.
      - gid (integer) –
        
        The POSIX group ID.
      - secondaryGids (list) –
        
        An array of secondary POSIX group IDs.
        
        (integer) –
    - rootDirectory (dict) –
      
      The root directory configuration for this access point.
      - path (string) –
        
        The path to use as the root directory for the access point.
      - creationPermissions (dict) –
        
        The permissions to set on newly created directories.
        
        ownerUid (integer) –
        
        The POSIX user ID to assign to newly created directories.
        
        ownerGid (integer) –
        
        The POSIX group ID to assign to newly created directories.
        
        permissions (string) –
        
        The octal permissions to assign to newly created directories.
    - name (string) –
      
      The name of the access point.
- NextToken (string) –
  
  A token to resume pagination.