NetworkSecurityManagerCustomerAPI / Client / list_policies

list_policies¶

NetworkSecurityManagerCustomerAPI.Client.list_policies(**kwargs)¶

Lists the policies in the account. You can filter the results by status and page through them using maxResults and nextToken.

Request Syntax

response = client.list_policies(
    maxResults=123,
    nextToken='string',
    status='ACTIVE'|'DRAFT'|'DISABLED'
)

Parameters:

maxResults (integer) – The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
nextToken (string) – The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
status (string) – Filters the results by status, either ACTIVE or DRAFT.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'policies': [
        {
            '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)
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
- policies (list) –
  
  The list of policies.
  - (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.

Exceptions

NetworkSecurityManagerCustomerAPI.Client.exceptions.ValidationException
NetworkSecurityManagerCustomerAPI.Client.exceptions.InternalServerException
NetworkSecurityManagerCustomerAPI.Client.exceptions.AccessDeniedException
NetworkSecurityManagerCustomerAPI.Client.exceptions.ThrottlingException