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

DisassociateEmailAddressAlias

Removes the alias association between two email addresses in an Amazon Connect 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 Amazon Connect endpoints and quotas.

Related operations

AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Amazon Connect 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).

Request Syntax


POST /email-addresses/InstanceId/EmailAddressId/disassociate-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 alias relationship to remove. The alias association must currently exist between the primary email address and the specified alias email address.

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

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 removal

The following example removes the forwarding relationship between two email addresses.


POST / HTTP/1.1
Host: connect.us-east-1.amazonaws.com
Content-Length: 156
X-Amz-Target: AmazonConnectService.DisassociateEmailAddressAlias
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 removal with error handling

The following example response shows a safely removed alias with proper error handling for non-existent relationships.


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
{}