email_address

Creates, updates, deletes, gets or lists an email_address resource.

Overview

Name	email_address
Type	Resource
Id	aws.connect.email_address

Fields

The following fields are returned by SELECT queries:

describe_email_address

Name	Datatype	Description
alias_configurations	array	A list of alias configurations associated with this email address. Contains details about email addresses that forward to this primary email address. The list can contain at most one alias configuration per email address.
create_timestamp	string	The email address creation timestamp in ISO 8601 Datetime.
description	string	The description of the email address.
display_name	string	The display name of email address
email_address	string	The email address, including the domain. (pattern: <code>[^\s@]+@[^\s@]+.[^\s@]+</code>)
email_address_arn	string	The Amazon Resource Name (ARN) of the email address.
email_address_id	string	The identifier of the email address.
modified_timestamp	string	The email address last modification timestamp in ISO 8601 Datetime.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_email_address	select	instance_id, email_address_id, region		Describe email address form the specified Connect Customer instance.
create_email_address	insert	instance_id, region, EmailAddress		Create new email address in the specified Connect Customer instance. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide.
associate_email_address_alias	update	email_address_id, instance_id, region, AliasConfiguration		Associates an email address alias with an existing email address in an Connect Customer instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address. Use cases Following are common uses cases for this API: Unified customer support: Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management. Department consolidation: Forward emails from legacy department addresses (for example, sales@example.com, info@example.com) to a centralized customer service email during organizational restructuring. Brand management: Enable you to use familiar brand-specific email addresses that forward to the appropriate Connect Customer instance email address. Important things to know Each email address can have a maximum of one alias. You cannot create multiple aliases for the same email address. If the alias email address already receives direct emails, it continues to receive direct emails plus forwarded emails. You cannot chain email aliases together (that is, create an alias of an alias). AssociateEmailAddressAlias does not return the following information: A confirmation of the alias relationship details (you must call DescribeEmailAddress to verify). The timestamp of when the association occurred. The status of the forwarding configuration. Endpoints: See Connect Customer endpoints and quotas. Related operations DisassociateEmailAddressAlias: Removes the alias association between two email addresses in an Connect Customer instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).
update_email_address_metadata	update	instance_id, email_address_id, region		Updates an email address metadata. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide.
delete_email_address	delete	instance_id, email_address_id, region		Deletes email address from the specified Connect Customer instance.
disassociate_email_address_alias	exec	email_address_id, instance_id, region, AliasConfiguration		Removes the alias association between two email addresses in an Connect Customer instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly. Use cases Following are common uses cases for this API: Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues. Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses. Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed. Important things to know Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked. Emails sent to the former alias address are still delivered directly to that address if it exists. You do not need to delete the email addresses after disassociation. Both addresses remain active independently. After a successful disassociation, you can immediately create a new alias relationship with the same addresses. 200 status means alias was successfully disassociated. DisassociateEmailAddressAlias does not return the following information: Details in the response about the email that was disassociated. The response returns an empty body. The timestamp of when the disassociation occurred. Endpoints: See Connect Customer endpoints and quotas. Related operations AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Connect Customer instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).

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
email_address_id	string	The identifier of the email address.
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.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_email_address

Describe email address form the specified Connect Customer instance.

SELECT
alias_configurations,
create_timestamp,
description,
display_name,
email_address,
email_address_arn,
email_address_id,
modified_timestamp,
tags
FROM aws.connect.email_address
WHERE instance_id = '{{ instance_id }}' -- required
AND email_address_id = '{{ email_address_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_email_address

Create new email address in the specified Connect Customer instance. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide.

INSERT INTO aws.connect.email_address (
Description,
EmailAddress,
DisplayName,
Tags,
ClientToken,
instance_id,
region
)
SELECT 
'{{ Description }}',
'{{ EmailAddress }}' /* required */,
'{{ DisplayName }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
email_address_arn,
email_address_id
;

Manifest

# Description fields are for documentation purposes
- name: email_address
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the email_address resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the email_address resource.
  - name: Description
    value: "{{ Description }}"
  - name: EmailAddress
    value: "{{ EmailAddress }}"
  - name: DisplayName
    value: "{{ DisplayName }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

associate_email_address_alias

Associates an email address alias with an existing email address in an Connect Customer instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address. Use cases Following are common uses cases for this API: Unified customer support: Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management. Department consolidation: Forward emails from legacy department addresses (for example, sales@example.com, info@example.com) to a centralized customer service email during organizational restructuring. Brand management: Enable you to use familiar brand-specific email addresses that forward to the appropriate Connect Customer instance email address. Important things to know Each email address can have a maximum of one alias. You cannot create multiple aliases for the same email address. If the alias email address already receives direct emails, it continues to receive direct emails plus forwarded emails. You cannot chain email aliases together (that is, create an alias of an alias). AssociateEmailAddressAlias does not return the following information: A confirmation of the alias relationship details (you must call DescribeEmailAddress to verify). The timestamp of when the association occurred. The status of the forwarding configuration. Endpoints: See Connect Customer endpoints and quotas. Related operations DisassociateEmailAddressAlias: Removes the alias association between two email addresses in an Connect Customer instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).

UPDATE aws.connect.email_address
SET 
AliasConfiguration = '{{ AliasConfiguration }}',
ClientToken = '{{ ClientToken }}'
WHERE 
email_address_id = '{{ email_address_id }}' --required
AND instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND AliasConfiguration = '{{ AliasConfiguration }}' --required;

update_email_address_metadata

Updates an email address metadata. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide.

UPDATE aws.connect.email_address
SET 
Description = '{{ Description }}',
DisplayName = '{{ DisplayName }}',
ClientToken = '{{ ClientToken }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND email_address_id = '{{ email_address_id }}' --required
AND region = '{{ region }}' --required
RETURNING
email_address_arn,
email_address_id;

DELETE examples

delete_email_address

Deletes email address from the specified Connect Customer instance.

DELETE FROM aws.connect.email_address
WHERE instance_id = '{{ instance_id }}' --required
AND email_address_id = '{{ email_address_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_email_address_alias

Removes the alias association between two email addresses in an Connect Customer instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly. Use cases Following are common uses cases for this API: Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues. Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses. Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed. Important things to know Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked. Emails sent to the former alias address are still delivered directly to that address if it exists. You do not need to delete the email addresses after disassociation. Both addresses remain active independently. After a successful disassociation, you can immediately create a new alias relationship with the same addresses. 200 status means alias was successfully disassociated. DisassociateEmailAddressAlias does not return the following information: Details in the response about the email that was disassociated. The response returns an empty body. The timestamp of when the disassociation occurred. Endpoints: See Connect Customer endpoints and quotas. Related operations AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Connect Customer instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).

EXEC aws.connect.email_address.disassociate_email_address_alias 
@email_address_id='{{ email_address_id }}' --required, 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"AliasConfiguration": "{{ AliasConfiguration }}", 
"ClientToken": "{{ ClientToken }}"
}'
;