CloudFront Verify Dns Configuration API

openapi: 3.1.0
info:
  title: Amazon CloudFront Verify Dns Configuration 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/verify-dns-configuration:
    post:
      operationId: VerifyDnsConfiguration
      summary: Verify Dns Configuration
      description: Verify the DNS configuration for your domain names. This API operation checks whether your domain name
        points to the correct routing endpoint of the connection group, such as d111111abcdef8.cloudfront.net. You can use
        this API operation to troubleshoot and resolve DNS configuration issues.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/VerifyDnsConfigurationResult'
        '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/VerifyDnsConfigurationRequest'
      tags:
      - Verify Dns Configuration
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
    DnsConfiguration:
      type: object
      properties:
        Domain:
          type: string
          description: The domain name that you're verifying.
        Status:
          type: string
          enum:
          - valid-configuration
          - invalid-configuration
          - unknown-configuration
          description: 'The status of your domain name. valid-configuration: The domain name is correctly configured and points
            to the correct routing endpoint of the connection group. invalid-configuration: There is either a missing DNS
            record or the DNS record exists but it''s using an incorrect routing endpoint. Update the DNS record to point
            to the correct routing endpoint. unknown-configuration: CloudFront can''t validate your DNS configuration. This
            status can appear if CloudFront can''t verify the DNS record, or the DNS lookup request failed or timed out.'
        Reason:
          type: string
          description: Explains the status of the DNS configuration.
      required:
      - Domain
      - Status
    EntityNotFound:
      type: object
      properties:
        Message:
          type: string
    InvalidArgument:
      type: object
      properties:
        Message:
          type: string
    VerifyDnsConfigurationRequest:
      type: object
      properties:
        Domain:
          type: string
          description: The domain name that you're verifying.
        Identifier:
          type: string
          description: The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution
            tenant.
      required:
      - Identifier
    VerifyDnsConfigurationResult:
      type: object
      properties:
        DnsConfigurationList:
          type: array
          items:
            $ref: '#/components/schemas/DnsConfiguration'
          description: The list of domain names, their statuses, and a description of each status.
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)