:doc:`MailManager <../../mailmanager>` / Client / list_ingress_points

*******************
list_ingress_points
*******************



.. py:method:: MailManager.Client.list_ingress_points(**kwargs)

  

  List all ingress endpoint resources.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListIngressPoints>`_  


  **Request Syntax**
  ::

    response = client.list_ingress_points(
        PageSize=123,
        NextToken='string'
    )
    
  :type PageSize: integer
  :param PageSize: 

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

    

  
  :type NextToken: string
  :param NextToken: 

    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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

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

    

    - *(dict) --* 
      

      - **IngressPoints** *(list) --* 

        The list of ingress endpoints.

        
        

        - *(dict) --* 

          The structure of an ingress endpoint resource.

          
          

          - **IngressPointName** *(string) --* 

            A user friendly name for the ingress endpoint resource.

            
          

          - **IngressPointId** *(string) --* 

            The identifier of the ingress endpoint resource.

            
          

          - **Status** *(string) --* 

            The status of the ingress endpoint resource.

            
          

          - **Type** *(string) --* 

            The type of 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.

            
      
    
      

      - **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**
  
  *   :py:class:`MailManager.Client.exceptions.ValidationException`

  