StorageGateway / Paginator / ListTapes

ListTapes

class StorageGateway.Paginator.ListTapes

paginator = client.get_paginator('list_tapes')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• TapeARNs (list) –

  The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don’t specify a tape ARN, the response lists all tapes in both your VTL and VTS.

  • (string) –

• 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

{
    'TapeInfos': [
        {
            'TapeARN': 'string',
            'TapeBarcode': 'string',
            'TapeSizeInBytes': 123,
            'TapeStatus': 'string',
            'GatewayARN': 'string',
            'PoolId': 'string',
            'RetentionStartDate': datetime(2015, 1, 1),
            'PoolEntryDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  A JSON object containing the following fields:

  • ListTapesOutput$Marker

  • ListTapesOutput$VolumeInfos

  • TapeInfos (list) –

    An array of TapeInfo objects, where each object describes a single tape. If there are no tapes in the tape library or VTS, then the TapeInfos is an empty array.

    • (dict) –

      Describes a virtual tape.

      • TapeARN (string) –

        The Amazon Resource Name (ARN) of a virtual tape.

      • TapeBarcode (string) –

        The barcode that identifies a specific virtual tape.

      • TapeSizeInBytes (integer) –

        The size, in bytes, of a virtual tape.

      • TapeStatus (string) –

        The status of the tape.

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

      • PoolId (string) –

        The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

      • RetentionStartDate (datetime) –

        The date that the tape became subject to tape retention lock.

      • PoolEntryDate (datetime) –

        The date that the tape entered the custom tape pool with tape retention lock enabled.

  • NextToken (string) –

    A token to resume pagination.