Connect / Client / disassociate_email_address_alias

disassociate_email_address_alias

Connect.Client.disassociate_email_address_alias(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.disassociate_email_address_alias(
    EmailAddressId='string',
    InstanceId='string',
    AliasConfiguration={
        'EmailAddressId': 'string'
    },
    ClientToken='string'
)

Parameters:

• EmailAddressId (string) –

  [REQUIRED]

  The identifier of the email address.

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

• AliasConfiguration (dict) –

  [REQUIRED]

  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.

  • EmailAddressId (string) – [REQUIRED]

    The email address ID.

• ClientToken (string) –

  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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.AccessDeniedException

• Connect.Client.exceptions.InvalidParameterException

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.InternalServiceException

• Connect.Client.exceptions.ResourceConflictException