Skip to content

CloudFront  >  Operations  >  list_domain_conflicts

list_domain_conflicts

Operation

list_domain_conflicts async

list_domain_conflicts(request: ListDomainConflictsInput | ListDomainConflictsInputDict, /, *, plugins: list[Plugin] | None = None) -> ListDomainConflictsOutput
list_domain_conflicts(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDomainConflictsInputDict]) -> 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
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 ListDomainConflictsOutput.

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

ListDomainConflictsInput dataclass

Bases: _SerdeShape

Dataclass for ListDomainConflictsInput structure.

Attributes
domain class-attribute instance-attribute
domain: str | None = ...

The domain to check for conflicts.

domain_control_validation_resource class-attribute instance-attribute
domain_control_validation_resource: DistributionResourceId | None = ...

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.

marker class-attribute instance-attribute
marker: str | None = ...

The marker for the next set of domain conflicts.

max_items class-attribute instance-attribute
max_items: int | None = ...

The maximum number of domain conflicts to return.

Dictionaries

ListDomainConflictsInputDict

Bases: TypedDict

Dictionary form of ListDomainConflictsInput.

Attributes
domain instance-attribute
domain: Required[str]

The domain to check for conflicts.

domain_control_validation_resource instance-attribute
domain_control_validation_resource: Required[DistributionResourceId | DistributionResourceIdDict]

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.

marker instance-attribute
marker: str | None

The marker for the next set of domain conflicts.

max_items instance-attribute
max_items: int | None

The maximum number of domain conflicts to return.

Output

ListDomainConflictsOutput dataclass

Bases: _SerdeShape

Dataclass for ListDomainConflictsOutput structure.

Attributes

domain_conflicts class-attribute instance-attribute
domain_conflicts: list[DomainConflict] | None = ...

Contains details about the domain conflicts.

next_marker 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.