:doc:`Connect <../../connect>` / Client / update_email_address_metadata

*****************************
update_email_address_metadata
*****************************



.. py:method:: Connect.Client.update_email_address_metadata(**kwargs)

  

  Updates an email address metadata. For more information about email addresses, see `Create email addresses <https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html>`__ in the Amazon Connect Administrator Guide.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateEmailAddressMetadata>`_  


  **Request Syntax**
  ::

    response = client.update_email_address_metadata(
        InstanceId='string',
        EmailAddressId='string',
        Description='string',
        DisplayName='string',
        ClientToken='string'
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

  
  :type EmailAddressId: string
  :param EmailAddressId: **[REQUIRED]** 

    The identifier of the email address.

    

  
  :type Description: string
  :param Description: 

    The description of the email address.

    

  
  :type DisplayName: string
  :param DisplayName: 

    The display name of email address.

    

  
  :type ClientToken: string
  :param ClientToken: 

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see `Making retries safe with idempotent APIs <https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/>`__.

    

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

    
    ::

      {
          'EmailAddressId': 'string',
          'EmailAddressArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **EmailAddressId** *(string) --* 

        The identifier of the email address.

        
      

      - **EmailAddressArn** *(string) --* 

        The Amazon Resource Name (ARN) of the email address.

        
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Connect.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Connect.Client.exceptions.IdempotencyException`

  