CloudFront Domain Conflicts API

openapi: 3.1.0
info:
  title: Amazon CloudFront Domain Conflicts API
  version: '2020-05-31'
  description: Generated from AWS's published Smithy model for Amazon CloudFront. 1 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://cloudfront.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /2020-05-31/domain-conflicts:
    post:
      operationId: ListDomainConflicts
      summary: List Domain Conflicts
      description: '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 in'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListDomainConflictsResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '404':
          description: EntityNotFound
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EntityNotFound'
        '400':
          description: InvalidArgument
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ListDomainConflictsRequest'
      tags:
      - Domain Conflicts
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: cloudfront
  schemas:
    AccessDenied:
      type: object
      properties:
        Message:
          type: string
    DistributionResourceId:
      type: object
      properties:
        DistributionId:
          type: string
          description: The ID of the multi-tenant distribution.
        DistributionTenantId:
          type: string
          description: The ID of the distribution tenant.
    DomainConflict:
      type: object
      properties:
        Domain:
          type: string
          description: The domain used to find existing conflicts for domain configurations.
        ResourceType:
          type: string
          enum:
          - distribution
          - distribution-tenant
          description: The CloudFront resource type that has a domain conflict.
        ResourceId:
          type: string
          description: The ID of the resource that has a domain conflict.
        AccountId:
          type: string
          description: The ID of the Amazon Web Services account for the domain conflict.
      required:
      - Domain
      - ResourceType
      - ResourceId
      - AccountId
    EntityNotFound:
      type: object
      properties:
        Message:
          type: string
    InvalidArgument:
      type: object
      properties:
        Message:
          type: string
    ListDomainConflictsRequest:
      type: object
      properties:
        Domain:
          type: string
          description: The domain to check for conflicts.
        DomainControlValidationResource:
          $ref: '#/components/schemas/DistributionResourceId'
        MaxItems:
          type: integer
          description: The maximum number of domain conflicts to return.
        Marker:
          type: string
          description: The marker for the next set of domain conflicts.
      required:
      - Domain
      - DomainControlValidationResource
    ListDomainConflictsResult:
      type: object
      properties:
        DomainConflicts:
          type: array
          items:
            $ref: '#/components/schemas/DomainConflict'
          description: Contains details about the domain conflicts.
        NextMarker:
          type: string
          description: 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.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)