CloudFront / Client / list_domain_conflicts

list_domain_conflicts

CloudFront.Client.list_domain_conflicts(**kwargs)

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

You can use this API operation when transferring domains to identify potential domain conflicts. Domain conflicts must be resolved first before they can be moved.

See also: AWS API Documentation

Request Syntax

response = client.list_domain_conflicts(
    Domain='string',
    DomainControlValidationResource={
        'DistributionId': 'string',
        'DistributionTenantId': 'string'
    },
    MaxItems=123,
    Marker='string'
)
Parameters:

  • Domain (string) –

    [REQUIRED]

    The domain to check for conflicts.

  • DomainControlValidationResource (dict) –

    [REQUIRED]

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

    • DistributionId (string) –

      The ID of the multi-tenant distribution.

    • DistributionTenantId (string) –

      The ID of the distribution tenant.

  • MaxItems (integer) – The maximum number of domain conflicts to return.

  • Marker (string) – The marker for the next set of domain conflicts.

Return type:

dict

Returns:

Response Syntax

{
    'DomainConflicts': [
        {
            'Domain': 'string',
            'ResourceType': 'distribution'|'distribution-tenant',
            'ResourceId': 'string',
            'AccountId': 'string'
        },
    ],
    'NextMarker': 'string'
}

Response Structure

  • (dict) –

    • DomainConflicts (list) –

      Contains details about the domain conflicts.

      • (dict) –

        Contains information about the domain conflict. Use this information to determine the affected domain, the related resource, and the affected Amazon Web Services account.

        • Domain (string) –

          The domain used to find existing conflicts for domain configurations.

        • ResourceType (string) –

          The CloudFront resource type that has a domain conflict.

        • ResourceId (string) –

          The ID of the resource that has a domain conflict.

        • AccountId (string) –

          The ID of the Amazon Web Services account for the domain conflict.

    • NextMarker (string) –

      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.

Exceptions