StorageGateway / Paginator / DescribeTapes

DescribeTapes

class StorageGateway.Paginator.DescribeTapes

paginator = client.get_paginator('describe_tapes')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• GatewayARN (string) –

  [REQUIRED]

  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.

• TapeARNs (list) –

  Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

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

{
    'Tapes': [
        {
            'TapeARN': 'string',
            'TapeBarcode': 'string',
            'TapeCreatedDate': datetime(2015, 1, 1),
            'TapeSizeInBytes': 123,
            'TapeStatus': 'string',
            'VTLDevice': 'string',
            'Progress': 123.0,
            'TapeUsedInBytes': 123,
            'KMSKey': 'string',
            'PoolId': 'string',
            'Worm': True|False,
            'RetentionStartDate': datetime(2015, 1, 1),
            'PoolEntryDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  DescribeTapesOutput

  • Tapes (list) –

    An array of virtual tape descriptions.

    • (dict) –

      Describes a virtual tape object.

      • TapeARN (string) –

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

      • TapeBarcode (string) –

        The barcode that identifies a specific virtual tape.

      • TapeCreatedDate (datetime) –

        The date the virtual tape was created.

      • TapeSizeInBytes (integer) –

        The size, in bytes, of the virtual tape capacity.

      • TapeStatus (string) –

        The current state of the virtual tape.

      • VTLDevice (string) –

        The virtual tape library (VTL) device that the virtual tape is associated with.

      • Progress (float) –

        For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

        Range: 0 (not started) to 100 (complete).

      • TapeUsedInBytes (integer) –

        The size, in bytes, of data stored on the virtual tape.

        Note

        This value is not available for tapes created prior to May 13, 2015.

      • KMSKey (string) –

        Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.

      • PoolId (string) –

        The ID of the pool that contains tapes that will be archived. The tapes in this pool are 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.

      • Worm (boolean) –

        If the tape is archived as write-once-read-many (WORM), this value is true.

      • RetentionStartDate (datetime) –

        The date that the tape is first archived with tape retention lock enabled.

      • PoolEntryDate (datetime) –

        The date that the tape enters a custom tape pool.

  • NextToken (string) –

    A token to resume pagination.