drs / Client / update_recovery_plan_execution_step

update_recovery_plan_execution_step

drs.Client.update_recovery_plan_execution_step(**kwargs)

Updates an execution step. Supports two actions: (1) skip a step that is in NOT_STARTED or FAILED status; (2) update the wait duration of a WAIT type step that is in NOT_STARTED status.

See also: AWS API Documentation

Request Syntax

response = client.update_recovery_plan_execution_step(
    recoveryPlanExecutionStepArn='string',
    status='NOT_STARTED'|'EXECUTING'|'WAITING'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'SKIPPED',
    servers=[
        {
            'serverArn': 'string',
            'impactLevel': 'CRITICAL'|'OPTIONAL'
        },
    ],
    waitDurationMinutes=123
)

Parameters:

• recoveryPlanExecutionStepArn (string) –

  [REQUIRED]

  The ARN of the execution step to update.

• status (string) – Only SKIPPED is accepted. Step must be in NOT_STARTED or FAILED status.

• servers (list) –

  Full replacement of the server list. Only allowed when the step is in NOT_STARTED status (Server type steps only).

  • (dict) –

    A server associated with a Recovery Plan Step.

    • serverArn (string) – [REQUIRED]

      The ARN of the source server.

    • impactLevel (string) –

      Defaults to CRITICAL if not specified.

• waitDurationMinutes (integer) – Updated wait duration. Only allowed when the step is in NOT_STARTED status (Wait type steps only).

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • recoveryPlanExecutionStep (dict) –

    A Recovery Plan Execution Step resource.

    • recoveryPlanExecutionStepArn (string) –

      The ARN of the execution step.

    • stepIndex (integer) –

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

    • status (string) –

      The status of the execution step.

    • stepName (string) –

      The name of a Recovery Plan 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.

    • attempt (integer) –

      The number of times this step has been attempted.

    • createdAt (string) –

      The timestamp when the execution step was created.

    • updatedAt (string) –

      The timestamp when the execution step was last updated.

Exceptions

• drs.Client.exceptions.ResourceNotFoundException

• drs.Client.exceptions.InternalServerException

• drs.Client.exceptions.ConflictException

• drs.Client.exceptions.ThrottlingException

• drs.Client.exceptions.AccessDeniedException

• drs.Client.exceptions.ValidationException

• drs.Client.exceptions.UninitializedAccountException