Amazon Route 53 Route 53 Queryloggingconfig API

openapi: 3.1.0
info:
  title: Amazon Route 53 Queryloggingconfig API
  version: '2013-04-01'
  description: Generated from AWS's published Smithy model for Amazon Route 53. 4 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://route53.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /2013-04-01/queryloggingconfig:
    post:
      operationId: CreateQueryLoggingConfig
      summary: Create Query Logging Config
      description: 'Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon
        Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. DNS query logs contain information about
        the queries that Route 53 receives for a specified public hosted zone, such as the following: Route 53 edge location
        that responded to the DNS query Domain or subdomain that was requested DNS record type, such as A or AAAA DNS response
        code, such as NoError or ServFail Log Group and Resource Policy Before you create a query logging configuration, perform
        the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs
        these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when
        you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region.
        You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure
        query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for
        example: /aws/route53/hosted zone nam'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateQueryLoggingConfigResponse'
        '400':
          description: ConcurrentModification; InsufficientCloudWatchLogsResourcePolicy; InvalidInput
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConcurrentModification'
        '404':
          description: NoSuchCloudWatchLogsLogGroup; NoSuchHostedZone
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchCloudWatchLogsLogGroup'
        '409':
          description: QueryLoggingConfigAlreadyExists
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/QueryLoggingConfigAlreadyExists'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateQueryLoggingConfigRequest'
      tags:
      - Queryloggingconfig
    get:
      operationId: ListQueryLoggingConfigs
      summary: List Query Logging Configs
      description: Lists the configurations for DNS query logging that are associated with the current Amazon Web Services
        account or the configuration that is associated with a specified hosted zone. For more information about DNS query
        logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging
        DNS Queries in the Amazon Route 53 Developer Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListQueryLoggingConfigsResponse'
        '400':
          description: InvalidInput; InvalidPaginationToken
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '404':
          description: NoSuchHostedZone
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchHostedZone'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ListQueryLoggingConfigsRequest'
      tags:
      - Queryloggingconfig
  /2013-04-01/queryloggingconfig/{Id}:
    delete:
      operationId: DeleteQueryLoggingConfig
      summary: Delete Query Logging Config
      description: Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending
        query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs. For more information
        about DNS query logs, see CreateQueryLoggingConfig.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteQueryLoggingConfigResponse'
        '400':
          description: ConcurrentModification; InvalidInput
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConcurrentModification'
        '404':
          description: NoSuchQueryLoggingConfig
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchQueryLoggingConfig'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/DeleteQueryLoggingConfigRequest'
      tags:
      - Queryloggingconfig
    get:
      operationId: GetQueryLoggingConfig
      summary: Get Query Logging Config
      description: Gets information about a specified configuration for DNS query logging. For more information about DNS
        query logs, see CreateQueryLoggingConfig and Logging DNS Queries.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetQueryLoggingConfigResponse'
        '400':
          description: InvalidInput
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '404':
          description: NoSuchQueryLoggingConfig
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchQueryLoggingConfig'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/GetQueryLoggingConfigRequest'
      tags:
      - Queryloggingconfig
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: route53
  schemas:
    ConcurrentModification:
      type: object
      properties:
        message:
          type: string
    CreateQueryLoggingConfigRequest:
      type: object
      properties:
        HostedZoneId:
          type: string
          description: The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted
            zones.
        CloudWatchLogsLogGroupArn:
          type: string
          description: 'The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs
            to. This is the format of the ARN: arn:aws:logs:region:account-id:log-group:log_group_name To get the ARN for
            a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command,
            or the applicable command in one of the Amazon Web Services SDKs.'
      required:
      - HostedZoneId
      - CloudWatchLogsLogGroupArn
    CreateQueryLoggingConfigResponse:
      type: object
      properties:
        QueryLoggingConfig:
          $ref: '#/components/schemas/QueryLoggingConfig'
        Location:
          type: string
          description: The unique URL representing the new query logging configuration.
      required:
      - QueryLoggingConfig
      - Location
    DeleteQueryLoggingConfigRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the configuration that you want to delete.
      required:
      - Id
    DeleteQueryLoggingConfigResponse:
      type: object
      properties: {}
    GetQueryLoggingConfigRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the configuration for DNS query logging that you want to get information about.
      required:
      - Id
    GetQueryLoggingConfigResponse:
      type: object
      properties:
        QueryLoggingConfig:
          $ref: '#/components/schemas/QueryLoggingConfig'
      required:
      - QueryLoggingConfig
    InvalidInput:
      type: object
      properties:
        message:
          type: string
    ListQueryLoggingConfigsRequest:
      type: object
      properties:
        HostedZoneId:
          type: string
          description: (Optional) If you want to list the query logging configuration that is associated with a hosted zone,
            specify the ID in HostedZoneId. If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of
            the configurations that are associated with the current Amazon Web Services account.
        NextToken:
          type: string
          description: (Optional) If the current Amazon Web Services account has more than MaxResults query logging configurations,
            use NextToken to get the second and subsequent pages of results. For the first ListQueryLoggingConfigs request,
            omit this value. For the second and subsequent requests, get the value of NextToken from the previous response
            and specify that value for NextToken in the request.
        MaxResults:
          type: integer
          description: (Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return
            in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations,
            use the value of NextToken in the response to get the next page of results. If you don't specify a value for MaxResults,
            Route 53 returns up to 100 configurations.
    ListQueryLoggingConfigsResponse:
      type: object
      properties:
        QueryLoggingConfigs:
          type: array
          items:
            $ref: '#/components/schemas/QueryLoggingConfig'
          description: An array that contains one QueryLoggingConfig element for each configuration for DNS query logging
            that is associated with the current Amazon Web Services account.
        NextToken:
          type: string
          description: If a response includes the last of the query logging configurations that are associated with the current
            Amazon Web Services account, NextToken doesn't appear in the response. If a response doesn't include the last
            of the configurations, you can get more configurations by submitting another ListQueryLoggingConfigs request.
            Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken
            in the next request.
      required:
      - QueryLoggingConfigs
    NoSuchCloudWatchLogsLogGroup:
      type: object
      properties:
        message:
          type: string
    NoSuchHostedZone:
      type: object
      properties:
        message:
          type: string
    NoSuchQueryLoggingConfig:
      type: object
      properties:
        message:
          type: string
    QueryLoggingConfig:
      type: object
      properties:
        Id:
          type: string
          description: The ID for a configuration for DNS query logging.
        HostedZoneId:
          type: string
          description: The ID of the hosted zone that CloudWatch Logs is logging queries for.
        CloudWatchLogsLogGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing
            logs to.
      required:
      - Id
      - HostedZoneId
      - CloudWatchLogsLogGroupArn
    QueryLoggingConfigAlreadyExists:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/route-53/service/2013-04-01/route-53-2013-04-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)