queue_email_addresses

Creates, updates, deletes, gets or lists a queue_email_addresses resource.

Overview

Name	queue_email_addresses
Type	Resource
Id	aws.connect.queue_email_addresses

Fields

The following fields are returned by SELECT queries:

list_queue_email_addresses

Name	Datatype	Description
email_address_metadata_list	array	List of email address summary information for all email addresses associated with the queue. Each item contains the email address identifier, ARN, and configuration details.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
next_token	string	If there are additional results, this is the token for the next set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_queue_email_addresses	select	instance_id, queue_id, region	nextToken, maxResults	Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units. Important things to know The response includes metadata about each email address available for agent selection, including whether it's configured as the default outbound email. Agents can select from these email addresses when replying to inbound contacts or initiating outbound contacts in this queue. The list includes both explicitly associated email addresses and any default outbound email address configured for the queue. Results are paginated to handle queues with many associated email addresses (up to 50 per queue).
associate_queue_email_addresses	update	instance_id, queue_id, region, EmailAddressesConfig		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 Connect Customer 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.
disassociate_queue_email_addresses	update	instance_id, queue_id, region, EmailAddressesId		Removes the association between a set of email addresses and a queue. After disassociation, agents will no longer be able to select these email addresses as "From" addresses when replying to inbound email contacts or initiating outbound email contacts in this queue. Important things to know Agents will no longer see these email addresses in their "From" address selection options for this queue. The email addresses themselves are not deleted from the instance, only their availability for agent selection in this queue is removed. Changes take effect immediately and will affect the agent experience in the Contact Control Panel (CCP).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
queue_id	string	The identifier for the queue.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

list_queue_email_addresses

Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units. Important things to know The response includes metadata about each email address available for agent selection, including whether it's configured as the default outbound email. Agents can select from these email addresses when replying to inbound contacts or initiating outbound contacts in this queue. The list includes both explicitly associated email addresses and any default outbound email address configured for the queue. Results are paginated to handle queues with many associated email addresses (up to 50 per queue).

SELECT
email_address_metadata_list,
last_modified_region,
last_modified_time,
next_token
FROM aws.connect.queue_email_addresses
WHERE instance_id = '{{ instance_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

associate_queue_email_addresses

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 Connect Customer 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.

UPDATE aws.connect.queue_email_addresses
SET 
EmailAddressesConfig = '{{ EmailAddressesConfig }}',
ClientToken = '{{ ClientToken }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND region = '{{ region }}' --required
AND EmailAddressesConfig = '{{ EmailAddressesConfig }}' --required;

disassociate_queue_email_addresses

Removes the association between a set of email addresses and a queue. After disassociation, agents will no longer be able to select these email addresses as "From" addresses when replying to inbound email contacts or initiating outbound email contacts in this queue. Important things to know Agents will no longer see these email addresses in their "From" address selection options for this queue. The email addresses themselves are not deleted from the instance, only their availability for agent selection in this queue is removed. Changes take effect immediately and will affect the agent experience in the Contact Control Panel (CCP).

UPDATE aws.connect.queue_email_addresses
SET 
EmailAddressesId = '{{ EmailAddressesId }}',
ClientToken = '{{ ClientToken }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND region = '{{ region }}' --required
AND EmailAddressesId = '{{ EmailAddressesId }}' --required;