drs / Paginator / ListRecoveryPlans

ListRecoveryPlans¶

class drs.Paginator.ListRecoveryPlans¶

paginator = client.get_paginator('list_recovery_plans')

paginate(**kwargs)¶

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

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

{
    '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) –
  
  A token to resume pagination.