S3Files / Client / list_access_points

list_access_points¶

S3Files.Client.list_access_points(**kwargs)¶

Returns resource information for all S3 File System Access Points associated with the specified S3 File System.

Request Syntax

response = client.list_access_points(
    fileSystemId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

fileSystemId (string) –
[REQUIRED]

The ID or Amazon Resource Name (ARN) of the S3 File System to list access points for.
maxResults (integer) – The maximum number of access points to return in a single response.
nextToken (string) – A pagination token returned from a previous call to continue listing access points.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  A pagination token to use in a subsequent request if more results are available.
- 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.

Exceptions

S3Files.Client.exceptions.InternalServerException
S3Files.Client.exceptions.ResourceNotFoundException
S3Files.Client.exceptions.ThrottlingException
S3Files.Client.exceptions.ValidationException