Connect / Client / associate_queue_email_addresses

associate_queue_email_addresses

Connect.Client.associate_queue_email_addresses(**kwargs)

Associates a set of email addresses with a queue to enable agents to select different “From” (system) email addresses when replying to inbound email contacts or initiating outbound email contacts. This allows agents to handle email contacts across different brands and business units within the same queue.

Important things to know

  • You can associate up to 49 additional email addresses with a single queue, plus 1 default outbound email address, for a total of 50.

  • The email addresses must already exist in the Amazon Connect instance before they can be associated with a queue.

  • Agents will be able to select from these associated email addresses when handling email contacts in the queue.

  • For inbound email contacts, agents can select from email addresses associated with the queue where the contact was accepted.

  • For outbound email contacts, agents can select from email addresses associated with their default outbound queue configured in their routing profile.

See also: AWS API Documentation

Request Syntax

response = client.associate_queue_email_addresses(
    InstanceId='string',
    QueueId='string',
    EmailAddressesConfig=[
        {
            'EmailAddressId': '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.

  • QueueId (string) –

    [REQUIRED]

    The identifier for the queue.

  • EmailAddressesConfig (list) –

    [REQUIRED]

    Configuration list containing the email addresses to associate with the queue. Each configuration specifies an email address ID that should be linked to this queue for routing purposes.

    • (dict) –

      Configuration object that specifies an email address to be associated with a queue. This configuration contains the identifier of the email address that should be linked to the queue for routing email contacts.

      • EmailAddressId (string) – [REQUIRED]

        The identifier of the email address that should be associated with the queue. This email address must already exist in the Amazon Connect instance and will be used to route incoming email contacts to the specified queue.

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

    This field is autopopulated if not provided.

Returns:

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.LimitExceededException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.AccessDeniedException