list_domain_conflicts¶
Operation¶
async
¶
list_domain_conflicts(input: ListDomainConflictsInput, plugins: list[Plugin] | None = None) -> ListDomainConflictsOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListDomainConflictsInput
|
An instance of |
required |
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 |
|---|---|
ListDomainConflictsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListDomainConflictsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
domain: str | None = ...
The domain to check for conflicts.
class-attribute
instance-attribute
¶
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListDomainConflictsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
domain_conflicts: list[DomainConflict] | None = ...
Contains details about the domain conflicts.
class-attribute
instance-attribute
¶
next_marker: str | None = ...
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.
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.