drs / Client / describe_recovery_snapshots

describe_recovery_snapshots#

drs.Client.describe_recovery_snapshots(**kwargs)#

Lists all Recovery Snapshots for a single Source Server.

See also: AWS API Documentation

Request Syntax

response = client.describe_recovery_snapshots(
    filters={
        'fromDateTime': 'string',
        'toDateTime': 'string'
    },
    maxResults=123,
    nextToken='string',
    order='ASC'|'DESC',
    sourceServerID='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.

  • maxResults (integer) – Maximum number of Recovery Snapshots to retrieve.

  • nextToken (string) – The token of the next Recovery Snapshot to retrieve.

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

  • sourceServerID (string) –

    [REQUIRED]

    Filter Recovery Snapshots by Source Server ID.

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) –

      The token of the next Recovery Snapshot to retrieve.

Exceptions