Connect / Client / list_queue_email_addresses

list_queue_email_addresses

Connect.Client.list_queue_email_addresses(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_queue_email_addresses(
    InstanceId='string',
    QueueId='string',
    NextToken='string',
    MaxResults=123
)
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.

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

  • MaxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'EmailAddressMetadataList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'IsDefaultOutboundEmail': True|False
        },
    ],
    'LastModifiedTime': datetime(2015, 1, 1),
    'LastModifiedRegion': 'string'
}

Response Structure

  • (dict) –

    • NextToken (string) –

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

    • EmailAddressMetadataList (list) –

      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.

      • (dict) –

        Summary information about an email address associated with a queue. Contains the essential details needed to identify and manage the email address routing configuration.

        • Id (string) –

          The unique identifier of the email address associated with the queue.

        • Arn (string) –

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

        • IsDefaultOutboundEmail (boolean) –

          Indicates whether this email address is configured as the default outbound email address for the queue. When set to true, this email address is used as the default sender for outbound email contacts from this queue.

    • LastModifiedTime (datetime) –

      The timestamp when this resource was last modified.

    • LastModifiedRegion (string) –

      The Amazon Web Services Region where this resource was last modified.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.AccessDeniedException