DescribeRecoverySnapshots

class drs.Paginator.DescribeRecoverySnapshots
paginator = client.get_paginator('describe_recovery_snapshots')
paginate(**kwargs)

Creates an iterator that will paginate through responses from drs.Client.describe_recovery_snapshots().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters={
        'fromDateTime': 'string',
        'toDateTime': 'string'
    },
    order='ASC'|'DESC',
    sourceServerID='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • filters (dict) --

    A set of filters by which to return Recovery Snapshots.

    • fromDateTime (string) --

      The start date in a date range query.

    • toDateTime (string) --

      The end date in a date range query.

  • order (string) -- The sorted ordering by which to return Recovery Snapshots.
  • sourceServerID (string) --

    [REQUIRED]

    Filter Recovery Snapshots by Source Server ID.

  • 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

{
    'items': [
        {
            'ebsSnapshots': [
                'string',
            ],
            'expectedTimestamp': 'string',
            'snapshotID': 'string',
            'sourceServerID': 'string',
            'timestamp': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      An array of Recovery Snapshots.

      • (dict) --

        A snapshot of a Source Server used during recovery.

        • ebsSnapshots (list) --

          A list of EBS snapshots.

          • (string) --
        • expectedTimestamp (string) --

          The timestamp of when we expect the snapshot to be taken.

        • snapshotID (string) --

          The ID of the Recovery Snapshot.

        • sourceServerID (string) --

          The ID of the Source Server that the snapshot was taken for.

        • timestamp (string) --

          The actual timestamp that the snapshot was taken.

    • NextToken (string) --

      A token to resume pagination.