list_conflicting_aliases¶
Operation¶
list_conflicting_aliases
async
¶
list_conflicting_aliases(request: ListConflictingAliasesInput | ListConflictingAliasesInputDict, /, *, plugins: list[Plugin] | None = None) -> ListConflictingAliasesOutput
list_conflicting_aliases(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListConflictingAliasesInputDict]) -> ListConflictingAliasesOutput
Note
The ListConflictingAliases API operation only supports standard
distributions. To list domain conflicts for both standard distributions
and distribution tenants, we recommend that you use the
ListDomainConflicts
API operation instead.
Gets a list of aliases that conflict or overlap with the provided alias, and the associated CloudFront standard distribution and Amazon Web Services accounts for each conflicting alias. An alias is commonly known as a custom domain or vanity domain. It can also be called a CNAME or alternate domain name.
In the returned list, the standard distribution and account IDs are partially hidden, which allows you to identify the standard distribution and accounts that you own, and 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, specify the alias to search and the ID of a standard distribution in your account that has an attached TLS certificate that includes the provided alias. For more information, including how to set up the standard distribution and 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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ListConflictingAliasesOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
ListConflictingAliasesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListConflictingAliasesInput structure.
Attributes¶
alias
class-attribute
instance-attribute
¶
alias: str | None = ...
The alias (also called a CNAME) to search for conflicting aliases.
distribution_id
class-attribute
instance-attribute
¶
distribution_id: str | None = ...
The ID of a standard distribution in your account that has an attached TLS certificate that includes the provided alias.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
Dictionaries¶
ListConflictingAliasesInputDict
¶
Bases: TypedDict
Dictionary form of ListConflictingAliasesInput.
Attributes¶
alias
instance-attribute
¶
The alias (also called a CNAME) to search for conflicting aliases.
distribution_id
instance-attribute
¶
The ID of a standard distribution in your account that has an attached TLS certificate that includes the provided alias.
marker
instance-attribute
¶
marker: str | None
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.
Output¶
ListConflictingAliasesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListConflictingAliasesOutput structure.
Attributes¶
conflicting_aliases_list
class-attribute
instance-attribute
¶
conflicting_aliases_list: ConflictingAliasesList | None = ...
A list of conflicting aliases.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.