MailManager / Client / list_traffic_policies

list_traffic_policies¶

MailManager.Client.list_traffic_policies(**kwargs)¶

List traffic policy resources.

Request Syntax

response = client.list_traffic_policies(
    PageSize=123,
    NextToken='string'
)

Parameters:

PageSize (integer) – The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.
NextToken (string) – If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'TrafficPolicies': [
        {
            'TrafficPolicyName': 'string',
            'TrafficPolicyId': 'string',
            'DefaultAction': 'ALLOW'|'DENY'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- TrafficPolicies (list) –
  
  The list of traffic policies.
  - (dict) –
    
    The structure of a traffic policy resource which is a container for policy statements.
    - TrafficPolicyName (string) –
      
      A user-friendly name of the traffic policy resource.
    - TrafficPolicyId (string) –
      
      The identifier of the traffic policy resource.
    - DefaultAction (string) –
      
      Default action instructs the traﬃc policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements
- NextToken (string) –
  
  If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Exceptions

MailManager.Client.exceptions.ValidationException