Elastic Disaster Recovery Service

2026/08/17 - Elastic Disaster Recovery Service - 20 new api methods

Changes  AWS Elastic Disaster Recovery (AWS DRS) now offers Recovery Plans to recover multi-server applications in the right order in one action. Define the launch sequence once, with ordered steps and wait times, and DRS runs it automatically. Validate with non-disruptive drills and monitor in real time.

ListRecoveryPlans (new) Link ¶

Lists all Recovery Plans in the account.

See also: AWS API Documentation

Request Syntax

client.list_recovery_plans(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

Maximum number of results to return.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlans': [
        {
            'recoveryPlanArn': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'INVALID',
            'createdAt': 'string',
            'updatedAt': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • recoveryPlans (list) --

      The list of Recovery Plans.

      • (dict) --

        Summary information about a Recovery Plan.

        • recoveryPlanArn (string) --

          The ARN of the Recovery Plan.

        • name (string) --

          The name of a Recovery Plan.

        • status (string) --

          The status of the Recovery Plan.

        • createdAt (string) --

          The timestamp when the Recovery Plan was created.

        • updatedAt (string) --

          The timestamp when the Recovery Plan was last updated.

    • nextToken (string) --

      The token for the next page of results.

GetRecoveryPlanStep (new) Link ¶

Gets a Recovery Plan step by ARN.

See also: AWS API Documentation

Request Syntax

client.get_recovery_plan_step(
    recoveryPlanStepArn='string'
)
type recoveryPlanStepArn:

string

param recoveryPlanStepArn:

[REQUIRED]

The ARN of the Recovery Plan step to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanStep': {
        'recoveryPlanStepArn': 'string',
        'stepOrder': 123,
        'stepName': 'string',
        'configuration': {
            'serverStepConfiguration': {
                'servers': [
                    {
                        'serverArn': 'string',
                        'impactLevel': 'CRITICAL'|'OPTIONAL'
                    },
                ]
            },
            'waitStepConfiguration': {
                'waitDurationMinutes': 123
            }
        },
        'createdAt': 'string',
        'updatedAt': 'string'
    }
}

Response Structure

  • (dict) --

    • recoveryPlanStep (dict) --

      A Recovery Plan Step resource.

      • recoveryPlanStepArn (string) --

        The ARN of the Recovery Plan step.

      • stepOrder (integer) --

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

      • stepName (string) --

        The name of a Recovery Plan Step.

      • configuration (dict) --

        Type-specific configuration for a recovery plan step. Exactly one member must be set.

        • serverStepConfiguration (dict) --

          Configuration for a SERVER type step.

          • servers (list) --

            The list of servers to recover in this step.

            • (dict) --

              A server associated with a Recovery Plan Step.

              • serverArn (string) --

                The ARN of the source server.

              • impactLevel (string) --

                Defaults to CRITICAL if not specified.

        • waitStepConfiguration (dict) --

          Configuration for a WAIT type step.

          • waitDurationMinutes (integer) --

            The wait duration in minutes for a Wait type step.

      • createdAt (string) --

        The timestamp when the step was created.

      • updatedAt (string) --

        The timestamp when the step was last updated.

CreateRecoveryPlanStep (new) Link ¶

Creates a step in a Recovery Plan. A step is either SERVER type (servers to recover in parallel) or WAIT type (timed pause between steps).

See also: AWS API Documentation

Request Syntax

client.create_recovery_plan_step(
    recoveryPlanArn='string',
    stepName='string',
    stepOrder=123,
    configuration={
        'serverStepConfiguration': {
            'servers': [
                {
                    'serverArn': 'string',
                    'impactLevel': 'CRITICAL'|'OPTIONAL'
                },
            ]
        },
        'waitStepConfiguration': {
            'waitDurationMinutes': 123
        }
    },
    clientToken='string'
)
type recoveryPlanArn:

string

param recoveryPlanArn:

[REQUIRED]

The ARN of the Recovery Plan to add the step to.

type stepName:

string

param stepName:

[REQUIRED]

The name of a Recovery Plan Step.

type stepOrder:

integer

param stepOrder:

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

type configuration:

dict

param configuration:

[REQUIRED]

Type-specific configuration for a recovery plan step. Exactly one member must be set.

  • serverStepConfiguration (dict) --

    Configuration for a SERVER type step.

    • servers (list) -- [REQUIRED]

      The list of servers to recover in this step.

      • (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.

  • waitStepConfiguration (dict) --

    Configuration for a WAIT type step.

    • waitDurationMinutes (integer) -- [REQUIRED]

      The wait duration in minutes for a Wait type step.

type clientToken:

string

param clientToken:

A unique string provided to ensure request idempotency.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanStep': {
        'recoveryPlanStepArn': 'string',
        'stepOrder': 123,
        'stepName': 'string',
        'configuration': {
            'serverStepConfiguration': {
                'servers': [
                    {
                        'serverArn': 'string',
                        'impactLevel': 'CRITICAL'|'OPTIONAL'
                    },
                ]
            },
            'waitStepConfiguration': {
                'waitDurationMinutes': 123
            }
        },
        'createdAt': 'string',
        'updatedAt': 'string'
    }
}

Response Structure

  • (dict) --

    • recoveryPlanStep (dict) --

      A Recovery Plan Step resource.

      • recoveryPlanStepArn (string) --

        The ARN of the Recovery Plan step.

      • stepOrder (integer) --

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

      • stepName (string) --

        The name of a Recovery Plan Step.

      • configuration (dict) --

        Type-specific configuration for a recovery plan step. Exactly one member must be set.

        • serverStepConfiguration (dict) --

          Configuration for a SERVER type step.

          • servers (list) --

            The list of servers to recover in this step.

            • (dict) --

              A server associated with a Recovery Plan Step.

              • serverArn (string) --

                The ARN of the source server.

              • impactLevel (string) --

                Defaults to CRITICAL if not specified.

        • waitStepConfiguration (dict) --

          Configuration for a WAIT type step.

          • waitDurationMinutes (integer) --

            The wait duration in minutes for a Wait type step.

      • createdAt (string) --

        The timestamp when the step was created.

      • updatedAt (string) --

        The timestamp when the step was last updated.

ReorderRecoveryPlanSteps (new) Link ¶

Reorders steps in a Recovery Plan. Accepts a complete ordered list of step ARNs.

See also: AWS API Documentation

Request Syntax

client.reorder_recovery_plan_steps(
    recoveryPlanArn='string',
    orderedStepArns=[
        'string',
    ]
)
type recoveryPlanArn:

string

param recoveryPlanArn:

[REQUIRED]

The ARN of the Recovery Plan.

type orderedStepArns:

list

param orderedStepArns:

[REQUIRED]

Ordered list of all step ARNs representing the desired sequence.

  • (string) --

    Strict ARN type for Recovery Plan resources. Only allows safe characters in the resource portion — rejects HTML/script injection characters (<, >, ", ', etc.) per AWS API input validation standards. Resource portion allows: [A-Za-z0-9_/.-] which covers all DRS recovery plan resource identifiers (plan-xxx, st-xxx, exec-xxx, step-xxx).

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanSteps': [
        {
            'recoveryPlanStepArn': 'string',
            'stepOrder': 123,
            'stepName': 'string',
            'configuration': {
                'serverStepConfiguration': {
                    'servers': [
                        {
                            'serverArn': 'string',
                            'impactLevel': 'CRITICAL'|'OPTIONAL'
                        },
                    ]
                },
                'waitStepConfiguration': {
                    'waitDurationMinutes': 123
                }
            },
            'createdAt': 'string',
            'updatedAt': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • recoveryPlanSteps (list) --

      The steps with updated order.

      • (dict) --

        A Recovery Plan Step resource.

        • recoveryPlanStepArn (string) --

          The ARN of the Recovery Plan step.

        • stepOrder (integer) --

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

        • stepName (string) --

          The name of a Recovery Plan Step.

        • configuration (dict) --

          Type-specific configuration for a recovery plan step. Exactly one member must be set.

          • serverStepConfiguration (dict) --

            Configuration for a SERVER type step.

            • servers (list) --

              The list of servers to recover in this step.

              • (dict) --

                A server associated with a Recovery Plan Step.

                • serverArn (string) --

                  The ARN of the source server.

                • impactLevel (string) --

                  Defaults to CRITICAL if not specified.

          • waitStepConfiguration (dict) --

            Configuration for a WAIT type step.

            • waitDurationMinutes (integer) --

              The wait duration in minutes for a Wait type step.

        • createdAt (string) --

          The timestamp when the step was created.

        • updatedAt (string) --

          The timestamp when the step was last updated.

CreateRecoveryPlan (new) Link ¶

Creates a Recovery Plan to orchestrate multi-server disaster recovery.

See also: AWS API Documentation

Request Syntax

client.create_recovery_plan(
    name='string',
    description='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
type name:

string

param name:

[REQUIRED]

The name of a Recovery Plan.

type description:

string

param description:

The description of a Recovery Plan.

type clientToken:

string

param clientToken:

A unique string provided to ensure request idempotency.

This field is autopopulated if not provided.

type tags:

dict

param tags:

The tags to apply to the Recovery Plan.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlan': {
        'recoveryPlanArn': 'string',
        'name': 'string',
        'description': 'string',
        'status': 'ACTIVE'|'INVALID',
        'createdAt': 'string',
        'updatedAt': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • recoveryPlan (dict) --

      A Recovery Plan resource.

      • recoveryPlanArn (string) --

        The ARN of the Recovery Plan.

      • name (string) --

        The name of a Recovery Plan.

      • description (string) --

        The description of a Recovery Plan.

      • status (string) --

        The status of the Recovery Plan.

      • createdAt (string) --

        The timestamp when the Recovery Plan was created.

      • updatedAt (string) --

        The timestamp when the Recovery Plan was last updated.

      • tags (dict) --

        The tags associated with the Recovery Plan.

        • (string) --

          • (string) --

ListRecoveryPlanSteps (new) Link ¶

Lists all steps in a Recovery Plan.

See also: AWS API Documentation

Request Syntax

client.list_recovery_plan_steps(
    recoveryPlanArn='string',
    maxResults=123,
    nextToken='string'
)
type recoveryPlanArn:

string

param recoveryPlanArn:

[REQUIRED]

The ARN of the Recovery Plan.

type maxResults:

integer

param maxResults:

Maximum number of results to return.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanSteps': [
        {
            'recoveryPlanStepArn': 'string',
            'stepOrder': 123,
            'stepName': 'string',
            'configuration': {
                'serverStepConfiguration': {
                    'servers': [
                        {
                            'serverArn': 'string',
                            'impactLevel': 'CRITICAL'|'OPTIONAL'
                        },
                    ]
                },
                'waitStepConfiguration': {
                    'waitDurationMinutes': 123
                }
            },
            'createdAt': 'string',
            'updatedAt': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • recoveryPlanSteps (list) --

      The list of Recovery Plan steps.

      • (dict) --

        A Recovery Plan Step resource.

        • recoveryPlanStepArn (string) --

          The ARN of the Recovery Plan step.

        • stepOrder (integer) --

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

        • stepName (string) --

          The name of a Recovery Plan Step.

        • configuration (dict) --

          Type-specific configuration for a recovery plan step. Exactly one member must be set.

          • serverStepConfiguration (dict) --

            Configuration for a SERVER type step.

            • servers (list) --

              The list of servers to recover in this step.

              • (dict) --

                A server associated with a Recovery Plan Step.

                • serverArn (string) --

                  The ARN of the source server.

                • impactLevel (string) --

                  Defaults to CRITICAL if not specified.

          • waitStepConfiguration (dict) --

            Configuration for a WAIT type step.

            • waitDurationMinutes (integer) --

              The wait duration in minutes for a Wait type step.

        • createdAt (string) --

          The timestamp when the step was created.

        • updatedAt (string) --

          The timestamp when the step was last updated.

    • nextToken (string) --

      The token for the next page of results.

UpdateRecoveryPlan (new) Link ¶

Updates a Recovery Plan's name or description.

See also: AWS API Documentation

Request Syntax

client.update_recovery_plan(
    recoveryPlanArn='string',
    name='string',
    description='string'
)
type recoveryPlanArn:

string

param recoveryPlanArn:

[REQUIRED]

The ARN of the Recovery Plan to update.

type name:

string

param name:

The name of a Recovery Plan.

type description:

string

param description:

The description of a Recovery Plan.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlan': {
        'recoveryPlanArn': 'string',
        'name': 'string',
        'description': 'string',
        'status': 'ACTIVE'|'INVALID',
        'createdAt': 'string',
        'updatedAt': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • recoveryPlan (dict) --

      A Recovery Plan resource.

      • recoveryPlanArn (string) --

        The ARN of the Recovery Plan.

      • name (string) --

        The name of a Recovery Plan.

      • description (string) --

        The description of a Recovery Plan.

      • status (string) --

        The status of the Recovery Plan.

      • createdAt (string) --

        The timestamp when the Recovery Plan was created.

      • updatedAt (string) --

        The timestamp when the Recovery Plan was last updated.

      • tags (dict) --

        The tags associated with the Recovery Plan.

        • (string) --

          • (string) --

ListRecoveryPlanExecutionSteps (new) Link ¶

Lists all steps within a Recovery Plan execution.

See also: AWS API Documentation

Request Syntax

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

string

param recoveryPlanExecutionArn:

[REQUIRED]

The ARN of the Recovery Plan execution.

type filter:

dict

param filter:

Filters for listing execution steps.

  • status (string) --

    Filter by execution step status.

type maxResults:

integer

param maxResults:

Maximum number of results to return.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

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.

          • 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.

DeleteRecoveryPlanExecution (new) Link ¶

Deletes a Recovery Plan execution record. Must be in a terminal status.

See also: AWS API Documentation

Request Syntax

client.delete_recovery_plan_execution(
    recoveryPlanExecutionArn='string'
)
type recoveryPlanExecutionArn:

string

param recoveryPlanExecutionArn:

[REQUIRED]

The ARN of the Recovery Plan execution to delete.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanExecutionArn': 'string'
}

Response Structure

  • (dict) --

    • recoveryPlanExecutionArn (string) --

      The ARN of the deleted Recovery Plan execution.

CancelRecoveryPlanExecution (new) Link ¶

Cancels an in-progress Recovery Plan execution. Remaining steps are skipped.

See also: AWS API Documentation

Request Syntax

client.cancel_recovery_plan_execution(
    recoveryPlanExecutionArn='string'
)
type recoveryPlanExecutionArn:

string

param recoveryPlanExecutionArn:

[REQUIRED]

The ARN of the Recovery Plan execution to cancel.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanExecution': {
        'recoveryPlanExecutionArn': 'string',
        'recoveryPlanArn': 'string',
        'mode': 'DRILL'|'RECOVERY',
        'status': 'CREATED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
        'startedAt': 'string',
        'completedAt': 'string',
        'errorDetail': {
            'message': 'string',
            'code': 'string'
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • recoveryPlanExecution (dict) --

      The cancelled Recovery Plan execution.

      • recoveryPlanExecutionArn (string) --

        The ARN of the Recovery Plan execution.

      • recoveryPlanArn (string) --

        The ARN of the Recovery Plan being executed.

      • mode (string) --

        The execution mode.

      • status (string) --

        The execution status.

      • startedAt (string) --

        The timestamp when the execution started.

      • completedAt (string) --

        The timestamp when the execution completed.

      • errorDetail (dict) --

        Error details if the execution failed.

        • message (string) --

          The error message.

        • code (string) --

          The error code.

      • tags (dict) --

        The tags associated with the Recovery Plan execution.

        • (string) --

          • (string) --

GetRecoveryPlan (new) Link ¶

Gets a Recovery Plan by ARN.

See also: AWS API Documentation

Request Syntax

client.get_recovery_plan(
    recoveryPlanArn='string'
)
type recoveryPlanArn:

string

param recoveryPlanArn:

[REQUIRED]

The ARN of the Recovery Plan to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlan': {
        'recoveryPlanArn': 'string',
        'name': 'string',
        'description': 'string',
        'status': 'ACTIVE'|'INVALID',
        'createdAt': 'string',
        'updatedAt': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • recoveryPlan (dict) --

      A Recovery Plan resource.

      • recoveryPlanArn (string) --

        The ARN of the Recovery Plan.

      • name (string) --

        The name of a Recovery Plan.

      • description (string) --

        The description of a Recovery Plan.

      • status (string) --

        The status of the Recovery Plan.

      • createdAt (string) --

        The timestamp when the Recovery Plan was created.

      • updatedAt (string) --

        The timestamp when the Recovery Plan was last updated.

      • tags (dict) --

        The tags associated with the Recovery Plan.

        • (string) --

          • (string) --

ListRecoveryPlanExecutions (new) Link ¶

Lists executions of Recovery Plans, optionally filtered by plan or status.

See also: AWS API Documentation

Request Syntax

client.list_recovery_plan_executions(
    recoveryPlanArn='string',
    status='CREATED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
    maxResults=123,
    nextToken='string'
)
type recoveryPlanArn:

string

param recoveryPlanArn:

Filter executions by Recovery Plan ARN.

type status:

string

param status:

Filter executions by status.

type maxResults:

integer

param maxResults:

Maximum number of results to return.

type nextToken:

string

param nextToken:

The token for the next page of results.

rtype:

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

      The token for the next page of results.

DeleteRecoveryPlanStep (new) Link ¶

Deletes a step from a Recovery Plan.

See also: AWS API Documentation

Request Syntax

client.delete_recovery_plan_step(
    recoveryPlanStepArn='string'
)
type recoveryPlanStepArn:

string

param recoveryPlanStepArn:

[REQUIRED]

The ARN of the Recovery Plan step to delete.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanStepArn': 'string'
}

Response Structure

  • (dict) --

    • recoveryPlanStepArn (string) --

      The ARN of the deleted Recovery Plan step.

GetRecoveryPlanExecution (new) Link ¶

Gets the details of a Recovery Plan execution.

See also: AWS API Documentation

Request Syntax

client.get_recovery_plan_execution(
    recoveryPlanExecutionArn='string'
)
type recoveryPlanExecutionArn:

string

param recoveryPlanExecutionArn:

[REQUIRED]

The ARN of the Recovery Plan execution.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanExecution': {
        'recoveryPlanExecutionArn': 'string',
        'recoveryPlanArn': 'string',
        'mode': 'DRILL'|'RECOVERY',
        'status': 'CREATED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
        'startedAt': 'string',
        'completedAt': 'string',
        'errorDetail': {
            'message': 'string',
            'code': 'string'
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • recoveryPlanExecution (dict) --

      The Recovery Plan execution details.

      • recoveryPlanExecutionArn (string) --

        The ARN of the Recovery Plan execution.

      • recoveryPlanArn (string) --

        The ARN of the Recovery Plan being executed.

      • mode (string) --

        The execution mode.

      • status (string) --

        The execution status.

      • startedAt (string) --

        The timestamp when the execution started.

      • completedAt (string) --

        The timestamp when the execution completed.

      • errorDetail (dict) --

        Error details if the execution failed.

        • message (string) --

          The error message.

        • code (string) --

          The error code.

      • tags (dict) --

        The tags associated with the Recovery Plan execution.

        • (string) --

          • (string) --

RetryRecoveryPlanExecutionStep (new) Link ¶

Retries a failed SERVER type execution step.

See also: AWS API Documentation

Request Syntax

client.retry_recovery_plan_execution_step(
    recoveryPlanExecutionStepArn='string'
)
type recoveryPlanExecutionStepArn:

string

param recoveryPlanExecutionStepArn:

[REQUIRED]

The ARN of the execution step to retry.

rtype:

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.

        • 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.

GetRecoveryPlanExecutionStep (new) Link ¶

Gets the details of a step within a Recovery Plan execution.

See also: AWS API Documentation

Request Syntax

client.get_recovery_plan_execution_step(
    recoveryPlanExecutionStepArn='string'
)
type recoveryPlanExecutionStepArn:

string

param recoveryPlanExecutionStepArn:

[REQUIRED]

The ARN of the execution step.

rtype:

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.

        • 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.

UpdateRecoveryPlanStep (new) Link ¶

Updates a Recovery Plan step's name or configuration. Step type is immutable.

See also: AWS API Documentation

Request Syntax

client.update_recovery_plan_step(
    recoveryPlanStepArn='string',
    stepName='string',
    configuration={
        'serverStepConfiguration': {
            'servers': [
                {
                    'serverArn': 'string',
                    'impactLevel': 'CRITICAL'|'OPTIONAL'
                },
            ]
        },
        'waitStepConfiguration': {
            'waitDurationMinutes': 123
        }
    }
)
type recoveryPlanStepArn:

string

param recoveryPlanStepArn:

[REQUIRED]

The ARN of the Recovery Plan step to update.

type stepName:

string

param stepName:

The name of a Recovery Plan Step.

type configuration:

dict

param configuration:

Type-specific configuration for a recovery plan step. Exactly one member must be set.

  • serverStepConfiguration (dict) --

    Configuration for a SERVER type step.

    • servers (list) -- [REQUIRED]

      The list of servers to recover in this step.

      • (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.

  • waitStepConfiguration (dict) --

    Configuration for a WAIT type step.

    • waitDurationMinutes (integer) -- [REQUIRED]

      The wait duration in minutes for a Wait type step.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanStep': {
        'recoveryPlanStepArn': 'string',
        'stepOrder': 123,
        'stepName': 'string',
        'configuration': {
            'serverStepConfiguration': {
                'servers': [
                    {
                        'serverArn': 'string',
                        'impactLevel': 'CRITICAL'|'OPTIONAL'
                    },
                ]
            },
            'waitStepConfiguration': {
                'waitDurationMinutes': 123
            }
        },
        'createdAt': 'string',
        'updatedAt': 'string'
    }
}

Response Structure

  • (dict) --

    • recoveryPlanStep (dict) --

      A Recovery Plan Step resource.

      • recoveryPlanStepArn (string) --

        The ARN of the Recovery Plan step.

      • stepOrder (integer) --

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

      • stepName (string) --

        The name of a Recovery Plan Step.

      • configuration (dict) --

        Type-specific configuration for a recovery plan step. Exactly one member must be set.

        • serverStepConfiguration (dict) --

          Configuration for a SERVER type step.

          • servers (list) --

            The list of servers to recover in this step.

            • (dict) --

              A server associated with a Recovery Plan Step.

              • serverArn (string) --

                The ARN of the source server.

              • impactLevel (string) --

                Defaults to CRITICAL if not specified.

        • waitStepConfiguration (dict) --

          Configuration for a WAIT type step.

          • waitDurationMinutes (integer) --

            The wait duration in minutes for a Wait type step.

      • createdAt (string) --

        The timestamp when the step was created.

      • updatedAt (string) --

        The timestamp when the step was last updated.

StartRecoveryPlanExecution (new) Link ¶

Starts executing a Recovery Plan in DRILL or RECOVERY mode. A plan cannot have more than one execution in a non-terminal status at a time.

See also: AWS API Documentation

Request Syntax

client.start_recovery_plan_execution(
    recoveryPlanArn='string',
    mode='DRILL'|'RECOVERY',
    clientToken='string',
    sourceServers=[
        {
            'sourceServerID': 'string',
            'recoverySnapshotID': 'string'
        },
    ],
    tags={
        'string': 'string'
    }
)
type recoveryPlanArn:

string

param recoveryPlanArn:

[REQUIRED]

The ARN of the Recovery Plan to execute.

type mode:

string

param mode:

[REQUIRED]

The execution mode ( DRILL or RECOVERY).

type clientToken:

string

param clientToken:

A unique string provided to ensure request idempotency.

This field is autopopulated if not provided.

type sourceServers:

list

param sourceServers:

Optional list of source servers with specific recovery snapshots. If not provided, the latest snapshot is used for each server.

  • (dict) --

    A source server with a specific recovery snapshot for plan execution.

    • sourceServerID (string) -- [REQUIRED]

      The ID of the source server.

    • recoverySnapshotID (string) -- [REQUIRED]

      The ID of the recovery snapshot to use.

type tags:

dict

param tags:

The tags to apply to the Recovery Plan execution.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanExecution': {
        'recoveryPlanExecutionArn': 'string',
        'recoveryPlanArn': 'string',
        'mode': 'DRILL'|'RECOVERY',
        'status': 'CREATED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
        'startedAt': 'string',
        'completedAt': 'string',
        'errorDetail': {
            'message': 'string',
            'code': 'string'
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • recoveryPlanExecution (dict) --

      The started Recovery Plan execution.

      • recoveryPlanExecutionArn (string) --

        The ARN of the Recovery Plan execution.

      • recoveryPlanArn (string) --

        The ARN of the Recovery Plan being executed.

      • mode (string) --

        The execution mode.

      • status (string) --

        The execution status.

      • startedAt (string) --

        The timestamp when the execution started.

      • completedAt (string) --

        The timestamp when the execution completed.

      • errorDetail (dict) --

        Error details if the execution failed.

        • message (string) --

          The error message.

        • code (string) --

          The error code.

      • tags (dict) --

        The tags associated with the Recovery Plan execution.

        • (string) --

          • (string) --

UpdateRecoveryPlanExecutionStep (new) Link ¶

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

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
)
type recoveryPlanExecutionStepArn:

string

param recoveryPlanExecutionStepArn:

[REQUIRED]

The ARN of the execution step to update.

type status:

string

param status:

Only SKIPPED is accepted. Step must be in NOT_STARTED or FAILED status.

type servers:

list

param servers:

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.

type waitDurationMinutes:

integer

param waitDurationMinutes:

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

rtype:

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.

        • 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.

DeleteRecoveryPlan (new) Link ¶

Deletes a Recovery Plan. Cannot delete a plan that has an execution in a non-terminal status ( CREATED, IN_PROGRESS).

See also: AWS API Documentation

Request Syntax

client.delete_recovery_plan(
    recoveryPlanArn='string'
)
type recoveryPlanArn:

string

param recoveryPlanArn:

[REQUIRED]

The ARN of the Recovery Plan to delete.

rtype:

dict

returns:

Response Syntax

{
    'recoveryPlanArn': 'string'
}

Response Structure

  • (dict) --

    • recoveryPlanArn (string) --

      The ARN of the deleted Recovery Plan.