Connect / Client / update_email_address_metadata

update_email_address_metadata#

Connect.Client.update_email_address_metadata(**kwargs)#

Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_email_address_metadata(
    InstanceId='string',
    EmailAddressId='string',
    Description='string',
    DisplayName='string',
    ClientToken='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • EmailAddressId (string) –

    [REQUIRED]

    The identifier of the email address.

  • Description (string) – The description of the email address.

  • DisplayName (string) – The display name of email address.

  • ClientToken (string) – 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.

Return type:

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

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.AccessDeniedException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.IdempotencyException