StorageGateway / Paginator / ListFileSystemAssociations

ListFileSystemAssociations

class StorageGateway.Paginator.ListFileSystemAssociations

paginator = client.get_paginator('list_file_system_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from StorageGateway.Client.list_file_system_associations().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• GatewayARN (string) – The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• 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

{
    'Marker': 'string',
    'FileSystemAssociationSummaryList': [
        {
            'FileSystemAssociationId': 'string',
            'FileSystemAssociationARN': 'string',
            'FileSystemAssociationStatus': 'string',
            'GatewayARN': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Marker (string) –

    If the request includes Marker, the response returns that value in this field.

  • FileSystemAssociationSummaryList (list) –

    An array of information about the Amazon FSx gateway’s file system associations.

    • (dict) –

      Gets the summary returned by ListFileSystemAssociation, which is a summary of a created file system association.

      • FileSystemAssociationId (string) –

        The ID of the file system association.

      • FileSystemAssociationARN (string) –

        The Amazon Resource Name (ARN) of the file system association.

      • FileSystemAssociationStatus (string) –

        The status of the file share. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR

      • GatewayARN (string) –

        The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • NextToken (string) –

    A token to resume pagination.