ARCRegionswitch / Paginator / ListPlans

ListPlans

class ARCRegionswitch.Paginator.ListPlans

paginator = client.get_paginator('list_plans')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ARCRegionswitch.Client.list_plans().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'plans': [
        {
            'arn': 'string',
            'owner': 'string',
            'name': 'string',
            'regions': [
                'string',
            ],
            'recoveryApproach': 'activeActive'|'activePassive',
            'primaryRegion': 'string',
            'version': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'description': 'string',
            'executionRole': 'string',
            'activePlanExecution': 'string',
            'recoveryTimeObjectiveMinutes': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • plans (list) –

    The plans that were requested.

    • (dict) –

      A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.

      • arn (string) –

        The Amazon Resource Name (ARN) of the Region switch plan.

      • owner (string) –

        The owner of a Region switch plan.

      • name (string) –

        The name of a Region switch plan.

      • regions (list) –

        The Amazon Web Services Region specified for a Region switch plan.

        • (string) –

      • recoveryApproach (string) –

        The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

      • primaryRegion (string) –

        The primary Region for a plan.

      • version (string) –

        The version for the plan.

      • updatedAt (datetime) –

        The timestamp when the plan execution was last updated.

      • description (string) –

        The description of a Region switch plan.

      • executionRole (string) –

        The execution role is a way to categorize a Region switch plan.

      • activePlanExecution (string) –

        Specifies if this is the active plan execution at this time.

      • recoveryTimeObjectiveMinutes (integer) –

        The recovery time objective that you’ve specified.

  • NextToken (string) –

    A token to resume pagination.