StorageGateway / Paginator / ListFileShares

ListFileShares#

class StorageGateway.Paginator.ListFileShares#
paginator = client.get_paginator('list_file_shares')
paginate(**kwargs)#

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

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 whose file shares you want to list. If this field is not present, all file shares under your account are listed.

  • 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',
    'FileShareInfoList': [
        {
            'FileShareType': 'NFS'|'SMB',
            'FileShareARN': 'string',
            'FileShareId': 'string',
            'FileShareStatus': 'string',
            'GatewayARN': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    ListFileShareOutput

    • Marker (string) –

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

    • FileShareInfoList (list) –

      An array of information about the S3 File Gateway’s file shares.

      • (dict) –

        Describes a file share. Only supported S3 File Gateway.

        • FileShareType (string) –

          The type of the file share.

        • FileShareARN (string) –

          The Amazon Resource Name (ARN) of the file share.

        • FileShareId (string) –

          The ID of the file share.

        • FileShareStatus (string) –

          The status of the file share.

          Valid Values: CREATING | UPDATING | AVAILABLE | DELETING

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