ResilienceHubV2 / Paginator / ListPolicies

ListPolicies¶

class ResilienceHubV2.Paginator.ListPolicies¶

paginator = client.get_paginator('list_policies')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ResilienceHubV2.Client.list_policies().

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

{
    'policySummaries': [
        {
            'policyArn': 'string',
            'name': 'string',
            'availabilitySlo': {
                'target': 123.0
            },
            'multiAz': {
                'rtoInMinutes': 123,
                'rpoInMinutes': 123,
                'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
            },
            'multiRegion': {
                'rtoInMinutes': 123,
                'rpoInMinutes': 123,
                'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
            },
            'dataRecovery': {
                'timeBetweenBackupsInMinutes': 123
            },
            'associatedServiceCount': 123,
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- policySummaries (list) –
  
  The list of policy summaries.
  - (dict) –
    
    Contains summary information about a resilience policy.
    - policyArn (string) –
      
      ARN identifier.
    - name (string) –
      
      Resource name (used in ARN — no spaces allowed).
    - availabilitySlo (dict) –
      
      The availability SLO defined in the policy.
      - target (float) –
        
        The target availability percentage, expressed as a value between 0 and 100.
    - multiAz (dict) –
      
      The multi-AZ disaster recovery targets defined in the policy.
      - rtoInMinutes (integer) –
        
        The recovery time objective (RTO) target for multi-AZ, in minutes.
      - rpoInMinutes (integer) –
        
        The recovery point objective (RPO) target for multi-AZ, in minutes.
      - disasterRecoveryApproach (string) –
        
        The disaster recovery approach for multi-AZ.
    - multiRegion (dict) –
      
      The multi-Region disaster recovery targets defined in the policy.
      - rtoInMinutes (integer) –
        
        The recovery time objective (RTO) target for multi-Region, in minutes.
      - rpoInMinutes (integer) –
        
        The recovery point objective (RPO) target for multi-Region, in minutes.
      - disasterRecoveryApproach (string) –
        
        The disaster recovery approach for multi-Region.
    - dataRecovery (dict) –
      
      The data recovery targets defined in the policy.
      - timeBetweenBackupsInMinutes (integer) –
        
        The target time between backups, in minutes.
    - associatedServiceCount (integer) –
      
      The number of services associated with this policy.
    - createdAt (datetime) –
      
      The timestamp when the policy was created.
    - updatedAt (datetime) –
      
      The timestamp when the policy was last updated.
- NextToken (string) –
  
  A token to resume pagination.