S3Files / Client / list_file_systems

list_file_systems

S3Files.Client.list_file_systems(**kwargs)

Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.

See also: AWS API Documentation

Request Syntax

response = client.list_file_systems(
    bucket='string',
    maxResults=123,
    nextToken='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.

  • maxResults (integer) – The maximum number of file systems to return in a single response. If not specified, up to 100 file systems are returned.

  • nextToken (string) – A pagination token returned from a previous call to continue listing file systems.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      A pagination token to use in a subsequent request if more results are available.

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

Exceptions

  • S3Files.Client.exceptions.InternalServerException

  • S3Files.Client.exceptions.ThrottlingException

  • S3Files.Client.exceptions.ValidationException