ListConflictingAliases
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and AWS accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap
with the provided alias. 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 aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution 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
GET /2020-05-31/conflicting-alias?Alias=Alias
&DistributionId=DistributionId
&Marker=Marker
&MaxItems=MaxItems
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Alias
-
The alias (also called a CNAME) to search for conflicting aliases.
Length Constraints: Minimum length of 0. Maximum length of 253.
Required: Yes
- DistributionId
-
The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.
Length Constraints: Minimum length of 0. Maximum length of 25.
Required: Yes
- Marker
-
Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field's value to the value of
NextMarker
from the current page's response. - MaxItems
-
The maximum number of conflicting aliases that you want in the response.
Valid Range: Maximum value of 100.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ConflictingAliasesList>
<Items>
<ConflictingAlias>
<AccountId>string</AccountId>
<Alias>string</Alias>
<DistributionId>string</DistributionId>
</ConflictingAlias>
</Items>
<MaxItems>integer</MaxItems>
<NextMarker>string</NextMarker>
<Quantity>integer</Quantity>
</ConflictingAliasesList>
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.
- ConflictingAliasesList
-
Root level tag for the ConflictingAliasesList parameters.
Required: Yes
- Items
-
Contains the conflicting aliases in the list.
Type: Array of ConflictingAlias objects
- MaxItems
-
The maximum number of conflicting aliases requested.
Type: Integer
- NextMarker
-
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the
Marker
field of a subsequent request to continue listing conflicting aliases where you left off.Type: String
- Quantity
-
The number of conflicting aliases returned in the response.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidArgument
-
An argument is invalid.
HTTP Status Code: 400
- NoSuchDistribution
-
The specified distribution does not exist.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: