StorageGateway / Paginator / DescribeTapeRecoveryPoints

DescribeTapeRecoveryPoints

class StorageGateway.Paginator.DescribeTapeRecoveryPoints

paginator = client.get_paginator('describe_tape_recovery_points')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GatewayARN='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.

• 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

{
    'GatewayARN': 'string',
    'TapeRecoveryPointInfos': [
        {
            'TapeARN': 'string',
            'TapeRecoveryPointTime': datetime(2015, 1, 1),
            'TapeSizeInBytes': 123,
            'TapeStatus': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  DescribeTapeRecoveryPointsOutput

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

  • TapeRecoveryPointInfos (list) –

    An array of TapeRecoveryPointInfos that are available for the specified gateway.

    • (dict) –

      Describes a recovery point.

      • TapeARN (string) –

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

      • TapeRecoveryPointTime (datetime) –

        The time when the point-in-time view of the virtual tape was replicated for later recovery.

        The default timestamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD’T’HH:MM:SS’Z’ format.

      • TapeSizeInBytes (integer) –

        The size, in bytes, of the virtual tapes to recover.

      • TapeStatus (string) –

        The status of the virtual tapes.

  • NextToken (string) –

    A token to resume pagination.