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

ListDomainConflicts

Note

We recommend that you use the ListDomainConflicts API operation to check for domain conflicts, as it supports both standard distributions and distribution tenants. ListConflictingAliases performs similar checks but only supports standard distributions.

Lists existing domain associations that conflict with the domain that you specify.

You can use this API operation to identify potential domain conflicts when moving domains between standard distributions and/or distribution tenants. Domain conflicts must be resolved first before they can be moved.

For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist.

To list conflicting domains, specify the following:

The domain to search for
The ID of a standard distribution or distribution tenant in your account that has an attached TLS certificate, which covers the specified domain

For more information, including how to set up the standard distribution or distribution tenant, and the certificate, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Request Syntax


POST /2020-05-31/domain-conflicts HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<ListDomainConflictsRequest xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/">
   <Domain>string</Domain>
   <DomainControlValidationResource>
      <DistributionId>string</DistributionId>
      <DistributionTenantId>string</DistributionTenantId>
   </DomainControlValidationResource>
   <Marker>string</Marker>
   <MaxItems>integer</MaxItems>
</ListDomainConflictsRequest>

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in XML format.

ListDomainConflictsRequest

Root level tag for the ListDomainConflictsRequest parameters.

Required: Yes

Domain

The domain to check for conflicts.

Type: String

Required: Yes

DomainControlValidationResource

The distribution resource identifier. This can be the standard distribution or distribution tenant that has a valid certificate, which covers the domain that you specify.

Type: DistributionResourceId object

Required: Yes

Marker

The marker for the next set of domain conflicts.

Type: String

Required: No

MaxItems

The maximum number of domain conflicts to return.

Type: Integer

Required: No

Response Syntax


HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListDomainConflictsResult>
   <DomainConflicts>
      <DomainConflicts>
         <AccountId>string</AccountId>
         <Domain>string</Domain>
         <ResourceId>string</ResourceId>
         <ResourceType>string</ResourceType>
      </DomainConflicts>
   </DomainConflicts>
   <NextMarker>string</NextMarker>
</ListDomainConflictsResult>

Response Elements

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

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

ListDomainConflictsResult

Root level tag for the ListDomainConflictsResult parameters.

Required: Yes

DomainConflicts

Contains details about the domain conflicts.

Type: Array of DomainConflict objects

NextMarker

A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.

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

InvalidArgument

An argument is invalid.

HTTP Status Code: 400