StorageGateway / Client / list_tape_pools

list_tape_pools#

StorageGateway.Client.list_tape_pools(**kwargs)#

Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don’t specify a custom tape pool ARN, the operation lists all custom tape pools.

This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.

See also: AWS API Documentation

Request Syntax

response = client.list_tape_pools(
    PoolARNs=[
        'string',
    ],
    Marker='string',
    Limit=123
)
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) –

  • Marker (string) – A string that indicates the position at which to begin the returned list of tape pools.

  • Limit (integer) – An optional number limit for the tape pools in the list returned by this call.

Return type:

dict

Returns:

Response Syntax

{
    'PoolInfos': [
        {
            'PoolARN': 'string',
            'PoolName': 'string',
            'StorageClass': 'DEEP_ARCHIVE'|'GLACIER',
            'RetentionLockType': 'COMPLIANCE'|'GOVERNANCE'|'NONE',
            'RetentionLockTimeInDays': 123,
            'PoolStatus': 'ACTIVE'|'DELETED'
        },
    ],
    'Marker': '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.

    • Marker (string) –

      A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError