S3Files / Paginator / ListFileSystems

ListFileSystems¶

class S3Files.Paginator.ListFileSystems¶

paginator = client.get_paginator('list_file_systems')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

bucket (string) – Optional filter to list only file systems associated with the specified S3 bucket Amazon Resource Name (ARN). If provided, only file systems that provide access to this bucket will be returned in the response.
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

{
    'fileSystems': [
        {
            'creationTime': datetime(2015, 1, 1),
            'fileSystemArn': 'string',
            'fileSystemId': 'string',
            'name': 'string',
            'bucket': 'string',
            'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
            'statusMessage': 'string',
            'roleArn': 'string',
            'ownerId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- fileSystems (list) –
  
  An array of file system descriptions.
  - (dict) –
    
    Contains information about an S3 File System returned in list operations.
    - creationTime (datetime) –
      
      The time when the file system was created.
    - fileSystemArn (string) –
      
      The Amazon Resource Name (ARN) of the file system.
    - fileSystemId (string) –
      
      The ID of the file system.
    - name (string) –
      
      The name of the file system.
    - bucket (string) –
      
      The Amazon Resource Name (ARN) of the S3 bucket.
    - status (string) –
      
      The current status of the file system.
    - statusMessage (string) –
      
      Additional information about the file system status.
    - roleArn (string) –
      
      The Amazon Resource Name (ARN) of the IAM role used for S3 access.
    - ownerId (string) –
      
      The Amazon Web Services account ID of the file system owner.
- NextToken (string) –
  
  A token to resume pagination.