AssociateEmailAddressAlias - Amazon Connect

AssociateEmailAddressAlias

Associates an email address alias with an existing email address in an Amazon Connect 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 Amazon Connect 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 Amazon Connect endpoints and quotas.

Related operations

Request Syntax

POST /email-addresses/InstanceId/EmailAddressId/associate-alias HTTP/1.1 Content-type: application/json { "AliasConfiguration": { "EmailAddressId": "string" }, "ClientToken": "string" }

URI Request Parameters

The request uses the following URI parameters.

EmailAddressId

The identifier of the email address.

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

Required: Yes

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

Request Body

The request accepts the following data in JSON format.

AliasConfiguration

Configuration object that specifies which email address will serve as the alias. The specified email address must already exist in the Amazon Connect instance and cannot already be configured as an alias or have an alias of its own.

Type: AliasConfiguration object

Required: Yes

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

Length Constraints: Maximum length of 500.

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

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

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

IdempotencyException

An entity with the same name already exists.

HTTP Status Code: 409

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

ResourceConflictException

A resource already has that name.

HTTP Status Code: 409

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

Examples

Example 1: Basic alias association

The following example creates a forwarding relationship where support@example.com (87654321-4321-4321-4321-210987654321) forwards to customerservice@example.com (11111111-2222-3333-4444-555555555555).

Request

POST / HTTP/1.1 Host: connect.us-east-1.amazonaws.com Content-Length: 152 X-Amz-Target: AmazonConnectService.AssociateEmailAddressAlias X-Amz-Date: 20170705T211529Z Authorization: AWS4-HMAC-SHA256\ Credential=AKIAI44QH8DHBEXAMPLE/20170705/us-east-1/connect/aws4_request,\ SignedHeaders=content-type;host;x-amz-date;x-amz-target,\ Signature=6bcb6a5ef9ee7585d83955e8a5c3f6d47cf581596208fc0e436fa1de26ef3f6a Content-Type: application/x-amz-json-1.1 { "InstanceId": "12345678-1234-1234-1234-123456789012", "EmailAddressId": "87654321-4321-4321-4321-210987654321", "AliasConfiguration": { "EmailAddressId": "11111111-2222-3333-4444-555555555555" } }

Example 2: Alias association with client token for idempotency

The following example response shows a safely created alias association with guaranteed idempotency for retry scenarios.

HTTP/1.1 200 OK Date: Wed, 05 Jul 2017 21:15:29 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 2 Connection: keep-alive x-amzn-RequestId: 12345678-1234-1234-1234-123456789012 {}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: