MailManager / Client / list_ingress_points

list_ingress_points#

MailManager.Client.list_ingress_points(**kwargs)#

List all ingress endpoint resources.

See also: AWS API Documentation

Request Syntax

response = client.list_ingress_points(
    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 ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

Return type:

dict

Returns:

Response Syntax

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

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.

    • 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