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

UpdateDomainAssociation

Note

We recommend that you use the UpdateDomainAssociation API operation to move a domain association, as it supports both standard distributions and distribution tenants. AssociateAlias performs similar checks but only supports standard distributions.

Moves a domain from its current standard distribution or distribution tenant to another one.

You must first disable the source distribution (standard distribution or distribution tenant) and then separately call this operation to move the domain to another target distribution (standard distribution or distribution tenant).

To use this operation, specify the domain and the ID of the target resource (standard distribution or distribution tenant). For more information, including how to set up the target resource, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide.

Request Syntax


POST /2020-05-31/domain-association HTTP/1.1
If-Match: IfMatch
<?xml version="1.0" encoding="UTF-8"?>
<UpdateDomainAssociationRequest xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/">
   <Domain>string</Domain>
   <TargetResource>
      <DistributionId>string</DistributionId>
      <DistributionTenantId>string</DistributionTenantId>
   </TargetResource>
</UpdateDomainAssociationRequest>

URI Request Parameters

The request uses the following URI parameters.

If-Match: The value of the ETag identifier for the standard distribution or distribution tenant that will be associated with the domain.

Request Body

The request accepts the following data in XML format.

UpdateDomainAssociationRequest

Root level tag for the UpdateDomainAssociationRequest parameters.

Required: Yes

Domain

The domain to update.

Type: String

Required: Yes

TargetResource

The target standard distribution or distribution tenant resource for the domain. You can specify either DistributionId or DistributionTenantId, but not both.

Type: DistributionResourceId object

Required: Yes

Response Syntax


HTTP/1.1 200
ETag: ETag
<?xml version="1.0" encoding="UTF-8"?>
<UpdateDomainAssociationResult>
   <Domain>string</Domain>
   <ResourceId>string</ResourceId>
</UpdateDomainAssociationResult>

Response Elements

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

The response returns the following HTTP headers.

ETag: The current version of the target standard distribution or distribution tenant that was associated with the domain.

The following data is returned in XML format by the service.

UpdateDomainAssociationResult

Root level tag for the UpdateDomainAssociationResult parameters.

Required: Yes

Domain

The domain that you're moving.

Type: String

ResourceId

The intended destination for the domain.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDenied

Access denied.

HTTP Status Code: 403

EntityNotFound

The entity was not found.

HTTP Status Code: 404

IllegalUpdate

The update contains modifications that are not allowed.

HTTP Status Code: 400

InvalidArgument

An argument is invalid.

HTTP Status Code: 400

InvalidIfMatchVersion

The If-Match version is missing or not valid.

HTTP Status Code: 400

PreconditionFailed

The precondition in one or more of the request fields evaluated to false.

HTTP Status Code: 412