MailManager / Paginator / ListIngressPoints

ListIngressPoints

class MailManager.Paginator.ListIngressPoints

paginator = client.get_paginator('list_ingress_points')

paginate(**kwargs)

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

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

{
    'IngressPoints': [
        {
            'ARecord': 'string',
            'IngressPointId': 'string',
            'IngressPointName': 'string',
            'Status': 'PROVISIONING'|'DEPROVISIONING'|'UPDATING'|'ACTIVE'|'CLOSED'|'FAILED',
            'Type': 'OPEN'|'AUTH'
        },
    ],

}

Response Structure

• (dict) –

  • IngressPoints (list) –

    The list of ingress endpoints.

    • (dict) –

      The structure of an ingress endpoint resource.

      • ARecord (string) –

        The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.

      • IngressPointId (string) –

        The identifier of the ingress endpoint resource.

      • IngressPointName (string) –

        A user friendly name for the ingress endpoint resource.

      • Status (string) –

        The status of the ingress endpoint resource.

      • Type (string) –

        The type of ingress endpoint resource.