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

*****************
get_ingress_point
*****************



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

  

  Fetch ingress endpoint resource attributes.

  

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


  **Request Syntax**
  ::

    response = client.get_ingress_point(
        IngressPointId='string'
    )
    
  :type IngressPointId: string
  :param IngressPointId: **[REQUIRED]** 

    The identifier of an ingress endpoint.

    

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

    
    ::

      {
          'IngressPointId': 'string',
          'IngressPointName': 'string',
          'IngressPointArn': 'string',
          'Status': 'PROVISIONING'|'DEPROVISIONING'|'UPDATING'|'ACTIVE'|'CLOSED'|'FAILED',
          'Type': 'OPEN'|'AUTH',
          'ARecord': 'string',
          'RuleSetId': 'string',
          'TrafficPolicyId': 'string',
          'IngressPointAuthConfiguration': {
              'IngressPointPasswordConfiguration': {
                  'SmtpPasswordVersion': 'string',
                  'PreviousSmtpPasswordVersion': 'string',
                  'PreviousSmtpPasswordExpiryTimestamp': datetime(2015, 1, 1)
              },
              'SecretArn': 'string'
          },
          'NetworkConfiguration': {
              'PublicNetworkConfiguration': {
                  'IpType': 'IPV4'|'DUAL_STACK'
              },
              'PrivateNetworkConfiguration': {
                  'VpcEndpointId': 'string'
              }
          },
          'CreatedTimestamp': datetime(2015, 1, 1),
          'LastUpdatedTimestamp': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The identifier of an ingress endpoint resource.

        
      

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

        A user friendly name for the ingress endpoint.

        
      

      - **IngressPointArn** *(string) --* 

        The Amazon Resource Name (ARN) of the ingress endpoint resource.

        
      

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

        The status of the ingress endpoint resource.

        
      

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

        The type of ingress endpoint.

        
      

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

        
      

      - **RuleSetId** *(string) --* 

        The identifier of a rule set resource associated with the ingress endpoint.

        
      

      - **TrafficPolicyId** *(string) --* 

        The identifier of the traffic policy resource associated with the ingress endpoint.

        
      

      - **IngressPointAuthConfiguration** *(dict) --* 

        The authentication configuration of the ingress endpoint resource.

        
        

        - **IngressPointPasswordConfiguration** *(dict) --* 

          The ingress endpoint password configuration for the ingress endpoint resource.

          
          

          - **SmtpPasswordVersion** *(string) --* 

            The current password expiry timestamp of the ingress endpoint resource.

            
          

          - **PreviousSmtpPasswordVersion** *(string) --* 

            The previous password version of the ingress endpoint resource.

            
          

          - **PreviousSmtpPasswordExpiryTimestamp** *(datetime) --* 

            The previous password expiry timestamp of the ingress endpoint resource.

            
      
        

        - **SecretArn** *(string) --* 

          The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.

          
    
      

      - **NetworkConfiguration** *(dict) --* 

        The network configuration for the ingress point.

        .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``PublicNetworkConfiguration``, ``PrivateNetworkConfiguration``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


      
        

        - **PublicNetworkConfiguration** *(dict) --* 

          Specifies the network configuration for the public ingress point.

          
          

          - **IpType** *(string) --* 

            The IP address type for the public ingress point. Valid values are IPV4 and DUAL_STACK.

            
      
        

        - **PrivateNetworkConfiguration** *(dict) --* 

          Specifies the network configuration for the private ingress point.

          
          

          - **VpcEndpointId** *(string) --* 

            The identifier of the VPC endpoint to associate with this private ingress point.

            
      
    
      

      - **CreatedTimestamp** *(datetime) --* 

        The timestamp of when the ingress endpoint was created.

        
      

      - **LastUpdatedTimestamp** *(datetime) --* 

        The timestamp of when the ingress endpoint was last updated.

        
  
  **Exceptions**
  
  *   :py:class:`MailManager.Client.exceptions.ValidationException`

  
  *   :py:class:`MailManager.Client.exceptions.ResourceNotFoundException`

  