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

************
update_relay
************



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

  

  Updates the attributes of an existing relay resource.

  

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


  **Request Syntax**
  ::

    response = client.update_relay(
        RelayId='string',
        RelayName='string',
        ServerName='string',
        ServerPort=123,
        Authentication={
            'SecretArn': 'string',
            'NoAuthentication': {}
            
        }
    )
    
  :type RelayId: string
  :param RelayId: **[REQUIRED]** 

    The unique relay identifier.

    

  
  :type RelayName: string
  :param RelayName: 

    The name of the relay resource.

    

  
  :type ServerName: string
  :param ServerName: 

    The destination relay server address.

    

  
  :type ServerPort: integer
  :param ServerPort: 

    The destination relay server port.

    

  
  :type Authentication: dict
  :param Authentication: 

    Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

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

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

      The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.

      

    
    - **NoAuthentication** *(dict) --* 

      Keep an empty structure if the relay destination server does not require SMTP credential authentication.

      

    
    
  
  
  :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`

  