drs / Paginator / ListRecoveryPlanSteps

ListRecoveryPlanSteps

class drs.Paginator.ListRecoveryPlanSteps

paginator = client.get_paginator('list_recovery_plan_steps')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    recoveryPlanArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• recoveryPlanArn (string) –

  [REQUIRED]

  The ARN of the Recovery Plan.

• 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

{
    '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) –

    A token to resume pagination.