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

********************
update_ingress_point
********************



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

  

  Update attributes of a provisioned ingress endpoint resource.

  

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


  **Request Syntax**
  ::

    response = client.update_ingress_point(
        IngressPointId='string',
        IngressPointName='string',
        StatusToUpdate='ACTIVE'|'CLOSED',
        RuleSetId='string',
        TrafficPolicyId='string',
        IngressPointConfiguration={
            'SmtpPassword': 'string',
            'SecretArn': 'string'
        }
    )
    
  :type IngressPointId: string
  :param IngressPointId: **[REQUIRED]** 

    The identifier for the ingress endpoint you want to update.

    

  
  :type IngressPointName: string
  :param IngressPointName: 

    A user friendly name for the ingress endpoint resource.

    

  
  :type StatusToUpdate: string
  :param StatusToUpdate: 

    The update status of an ingress endpoint.

    

  
  :type RuleSetId: string
  :param RuleSetId: 

    The identifier of an existing rule set that you attach to an ingress endpoint resource.

    

  
  :type TrafficPolicyId: string
  :param TrafficPolicyId: 

    The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

    

  
  :type IngressPointConfiguration: dict
  :param IngressPointConfiguration: 

    If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.

    .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``SmtpPassword``, ``SecretArn``. 

  
    - **SmtpPassword** *(string) --* 

      The password of the ingress endpoint resource.

      

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

      The SecretsManager::Secret ARN of the ingress endpoint resource.

      

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`MailManager.Client.exceptions.ValidationException`

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

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

  