NetworkSecurityManagerCustomerAPI / Paginator / ListPolicySnapshots

ListPolicySnapshots¶

class NetworkSecurityManagerCustomerAPI.Paginator.ListPolicySnapshots¶

paginator = client.get_paginator('list_policy_snapshots')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from NetworkSecurityManagerCustomerAPI.Client.list_policy_snapshots().

Request Syntax

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

Parameters:

policyIdentifier (string) –
[REQUIRED]

The identifier of the policy. This is the policy’s Amazon Resource Name (ARN).
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

{
    'snapshots': [
        {
            'policyId': 'string',
            'policyArn': 'string',
            'policyName': 'string',
            'status': 'DRAFT'|'ACTIVE'|'DISABLED',
            'version': 'string',
            'hasPublishedVersion': True|False,
            'firewallType': 'WAF'|'SHIELD_ADVANCED',
            'priority': 123,
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- snapshots (list) –
  
  The snapshots of the policy.
  - (dict) –
    
    Summary information about a policy.
    - policyId (string) –
      
      The service-generated id of the policy.
    - policyArn (string) –
      
      The Amazon Resource Name (ARN) of the policy.
    - policyName (string) –
      
      The name of the policy.
    - status (string) –
      
      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
    - version (string) –
      
      The version of the resource.
    - hasPublishedVersion (boolean) –
      
      Specifies whether a published version of the resource exists.
    - firewallType (string) –
      
      The firewall type associated with the resource.
    - priority (integer) –
      
      The priority of the resource. A lower number indicates a higher priority.
    - updatedAt (datetime) –
      
      The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
- NextToken (string) –
  
  A token to resume pagination.