drs / Client / list_recovery_plan_execution_steps

list_recovery_plan_execution_steps

drs.Client.list_recovery_plan_execution_steps(**kwargs)

Lists all steps within a Recovery Plan execution.

See also: AWS API Documentation

Request Syntax

response = client.list_recovery_plan_execution_steps(
    recoveryPlanExecutionArn='string',
    filter={
        'status': 'NOT_STARTED'|'EXECUTING'|'WAITING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'SKIPPED'
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

• recoveryPlanExecutionArn (string) –

  [REQUIRED]

  The ARN of the Recovery Plan execution.

• filter (dict) –

  Filters for listing execution steps.

  • status (string) –

    Filter by execution step status.

• maxResults (integer) – Maximum number of results to return.

• nextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'recoveryPlanExecutionSteps': [
        {
            'recoveryPlanExecutionStepArn': 'string',
            'stepName': 'string',
            'stepIndex': 123,
            'status': 'NOT_STARTED'|'EXECUTING'|'WAITING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'SKIPPED',
            'configuration': {
                'executionServerStepConfiguration': {
                    'servers': [
                        {
                            'serverArn': 'string',
                            'impactLevel': 'CRITICAL'|'OPTIONAL',
                            'jobID': 'string'
                        },
                    ]
                },
                'waitStepConfiguration': {
                    'waitDurationMinutes': 123
                }
            },
            'errorDetail': {
                'message': 'string',
                'code': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • recoveryPlanExecutionSteps (list) –

    The list of execution steps.

    • (dict) –

      Summary information about a Recovery Plan execution step.

      • recoveryPlanExecutionStepArn (string) –

        The ARN of the execution step.

      • stepName (string) –

        The name of a Recovery Plan Step.

      • stepIndex (integer) –

        The order of a step within a Recovery Plan (1-based).

      • status (string) –

        The status of the execution step.

      • configuration (dict) –

        Type-specific configuration for an execution step response. Mirrors RecoveryPlanStepConfiguration but uses execution-enriched server shapes.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: executionServerStepConfiguration, waitStepConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • executionServerStepConfiguration (dict) –

          Configuration for a SERVER type step (with execution state like jobID).

          • servers (list) –

            The list of servers in this execution step.

            • (dict) –

              A server within a recovery plan execution step, enriched with execution state.

              • serverArn (string) –

                The ARN of the source server.

              • impactLevel (string) –

                Defaults to CRITICAL if not specified.

              • jobID (string) –

                The DRS recovery job ID. Populated when recovery is initiated for this server.

        • waitStepConfiguration (dict) –

          Configuration for a WAIT type step.

          • waitDurationMinutes (integer) –

            The wait duration in minutes for a Wait type step.

      • errorDetail (dict) –

        Error details if the step failed.

        • message (string) –

          The error message.

        • code (string) –

          The error code.

  • nextToken (string) –

    The token for the next page of results.

Exceptions

• drs.Client.exceptions.ResourceNotFoundException

• drs.Client.exceptions.InternalServerException

• drs.Client.exceptions.ThrottlingException

• drs.Client.exceptions.AccessDeniedException

• drs.Client.exceptions.ValidationException

• drs.Client.exceptions.UninitializedAccountException