MailManager / Paginator / ListTrafficPolicies

ListTrafficPolicies

class MailManager.Paginator.ListTrafficPolicies

paginator = client.get_paginator('list_traffic_policies')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MailManager.Client.list_traffic_policies().

See also: AWS API Documentation

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

{
    'TrafficPolicies': [
        {
            'DefaultAction': 'ALLOW'|'DENY',
            'TrafficPolicyId': 'string',
            'TrafficPolicyName': '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.

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