drs / Client / list_recovery_plan_steps

list_recovery_plan_steps

drs.Client.list_recovery_plan_steps(**kwargs)

Lists all steps in a Recovery Plan.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• recoveryPlanArn (string) –

  [REQUIRED]

  The ARN of the Recovery Plan.

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

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

Return type:

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.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: serverStepConfiguration, 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'}
        

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

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