StorageGateway / Paginator / ListTapePools

ListTapePools

class StorageGateway.Paginator.ListTapePools

paginator = client.get_paginator('list_tape_pools')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• PoolARNs (list) –

  The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don’t specify a custom tape pool ARN, the response lists all custom tape pools.

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

{
    'PoolInfos': [
        {
            'PoolARN': 'string',
            'PoolName': 'string',
            'StorageClass': 'DEEP_ARCHIVE'|'GLACIER',
            'RetentionLockType': 'COMPLIANCE'|'GOVERNANCE'|'NONE',
            'RetentionLockTimeInDays': 123,
            'PoolStatus': 'ACTIVE'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • PoolInfos (list) –

    An array of PoolInfo objects, where each object describes a single custom tape pool. If there are no custom tape pools, the PoolInfos is an empty array.

    • (dict) –

      Describes a custom tape pool.

      • PoolARN (string) –

        The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and Amazon Web Services Region.

      • PoolName (string) –

        The name of the custom tape pool. PoolName can use all ASCII characters, except ‘/’ and ‘'.

      • StorageClass (string) –

        The storage class that is associated with the custom 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.

      • RetentionLockType (string) –

        Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.

      • RetentionLockTimeInDays (integer) –

        Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

      • PoolStatus (string) –

        Status of the custom tape pool. Pool can be ACTIVE or DELETED.

  • NextToken (string) –

    A token to resume pagination.