CloudFront / Paginator / ListDomainConflicts

ListDomainConflicts

class CloudFront.Paginator.ListDomainConflicts

paginator = client.get_paginator('list_domain_conflicts')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudFront.Client.list_domain_conflicts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Domain='string',
    DomainControlValidationResource={
        'DistributionId': 'string',
        'DistributionTenantId': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'DomainConflicts': [
        {
            'Domain': 'string',
            'ResourceType': 'distribution'|'distribution-tenant',
            'ResourceId': 'string',
            'AccountId': 'string'
        },
    ],
    'NextToken': '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.

  • NextToken (string) –

    A token to resume pagination.