Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListQueueEmailAddresses

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

Request Syntax


GET /queues/InstanceId/QueueId/email-addresses?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

InstanceId

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

MaxResults

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

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.

QueueId

The identifier for the queue.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "EmailAddressMetadataList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "IsDefaultOutboundEmail": boolean
      }
   ],
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EmailAddressMetadataList

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.

Type: Array of EmailAddressSummary objects

LastModifiedRegion

The AWS Region where this resource was last modified.

Type: String

Pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

LastModifiedTime

The timestamp when this resource was last modified.

Type: Timestamp

NextToken

If there are additional results, this is the token for the next set of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429