Amazon Connect Service

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

See also: AWS API Documentation

Request Syntax

client.disassociate_queue_email_addresses(
    InstanceId='string',
    QueueId='string',
    EmailAddressesId=[
        'string',
    ],
    ClientToken='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

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

type QueueId:

string

param QueueId:

[REQUIRED]

The identifier for the queue.

type EmailAddressesId:

list

param EmailAddressesId:

[REQUIRED]

List of email address identifiers to disassociate from the queue. These are the unique identifiers of email addresses that should no longer be routed to this queue.

• (string) --

type ClientToken:

string

param ClientToken:

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

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

client.associate_queue_email_addresses(
    InstanceId='string',
    QueueId='string',
    EmailAddressesConfig=[
        {
            'EmailAddressId': 'string'
        },
    ],
    ClientToken='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

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

type QueueId:

string

param QueueId:

[REQUIRED]

The identifier for the queue.

type EmailAddressesConfig:

list

param EmailAddressesConfig:

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

type ClientToken:

string

param ClientToken:

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

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

client.list_queue_email_addresses(
    InstanceId='string',
    QueueId='string',
    NextToken='string',
    MaxResults=123
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

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

type QueueId:

string

param QueueId:

[REQUIRED]

The identifier for the queue.

type NextToken:

string

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

rtype:

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.

{'EmailAddressesConfig': [{'EmailAddressId': 'string'}]}

Creates a new queue for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.create_queue(
    InstanceId='string',
    Name='string',
    Description='string',
    OutboundCallerConfig={
        'OutboundCallerIdName': 'string',
        'OutboundCallerIdNumberId': 'string',
        'OutboundFlowId': 'string'
    },
    OutboundEmailConfig={
        'OutboundEmailAddressId': 'string'
    },
    HoursOfOperationId='string',
    MaxContacts=123,
    QuickConnectIds=[
        'string',
    ],
    EmailAddressesConfig=[
        {
            'EmailAddressId': 'string'
        },
    ],
    Tags={
        'string': 'string'
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

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

type Name:

string

param Name:

[REQUIRED]

The name of the queue.

type Description:

string

param Description:

The description of the queue.

type OutboundCallerConfig:

dict

param OutboundCallerConfig:

The outbound caller ID name, number, and outbound whisper flow.

• OutboundCallerIdName (string) --

  The caller ID name.

• OutboundCallerIdNumberId (string) --

  The caller ID number.

• OutboundFlowId (string) --

  The outbound whisper flow to be used during an outbound call.

type OutboundEmailConfig:

dict

param OutboundEmailConfig:

The outbound email address ID for a specified queue.

• OutboundEmailAddressId (string) --

  The identifier of the email address.

type HoursOfOperationId:

string

param HoursOfOperationId:

[REQUIRED]

The identifier for the hours of operation.

type MaxContacts:

integer

param MaxContacts:

The maximum number of contacts that can be in the queue before it is considered full.

type QuickConnectIds:

list

param QuickConnectIds:

The quick connects available to agents who are working the queue.

• (string) --

type EmailAddressesConfig:

list

param EmailAddressesConfig:

Configuration list containing the email addresses to associate with the queue during creation. Each configuration specifies an email address ID that agents can select when handling email contacts in this queue.

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

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'QueueArn': 'string',
    'QueueId': 'string'
}

Response Structure

• (dict) --

  • QueueArn (string) --

    The Amazon Resource Name (ARN) of the queue.

  • QueueId (string) --

    The identifier for the queue.