drs / Paginator / ListRecoveryPlanExecutions

ListRecoveryPlanExecutions

class drs.Paginator.ListRecoveryPlanExecutions

paginator = client.get_paginator('list_recovery_plan_executions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    recoveryPlanArn='string',
    status='CREATED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• recoveryPlanArn (string) – Filter executions by Recovery Plan ARN.

• status (string) – Filter executions by status.

• 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

{
    'recoveryPlanExecutions': [
        {
            'recoveryPlanExecutionArn': 'string',
            'recoveryPlanArn': 'string',
            'mode': 'DRILL'|'RECOVERY',
            'status': 'CREATED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
            'startedAt': 'string',
            'errorDetail': {
                'message': 'string',
                'code': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • recoveryPlanExecutions (list) –

    The list of Recovery Plan executions.

    • (dict) –

      Summary information about a Recovery Plan execution.

      • recoveryPlanExecutionArn (string) –

        The ARN of the Recovery Plan execution.

      • recoveryPlanArn (string) –

        The ARN of the Recovery Plan.

      • mode (string) –

        The execution mode.

      • status (string) –

        The execution status.

      • startedAt (string) –

        The timestamp when the execution started.

      • errorDetail (dict) –

        Error details if the execution failed.

        • message (string) –

          The error message.

        • code (string) –

          The error code.

  • NextToken (string) –

    A token to resume pagination.