StorageGateway / Client / list_file_shares

list_file_shares#

StorageGateway.Client.list_file_shares(**kwargs)#

Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling user account. This operation is only supported for S3 File Gateways.

See also: AWS API Documentation

Request Syntax

response = client.list_file_shares(
    GatewayARN='string',
    Limit=123,
    Marker='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.

  • Limit (integer) – The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.

  • Marker (string) – Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'NextMarker': 'string',
    'FileShareInfoList': [
        {
            'FileShareType': 'NFS'|'SMB',
            'FileShareARN': 'string',
            'FileShareId': 'string',
            'FileShareStatus': 'string',
            'GatewayARN': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    ListFileShareOutput

    • Marker (string) –

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

    • NextMarker (string) –

      If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.

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

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError