MailManager / Client / list_traffic_policies

list_traffic_policies#

MailManager.Client.list_traffic_policies(**kwargs)#

List traffic policy resources.

See also: AWS API Documentation

Request Syntax

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

  • 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.

  • PageSize (integer) – The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • 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.

    • TrafficPolicies (list) –

      The list of traffic policies.

      • (dict) –

        The structure of a traffic policy resource which is a container for policy statements.

        • DefaultAction (string) –

          Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements

        • TrafficPolicyId (string) –

          The identifier of the traffic policy resource.

        • TrafficPolicyName (string) –

          A user-friendly name of the traffic policy resource.

Exceptions

  • MailManager.Client.exceptions.ValidationException