Amazon Route 53 Route 53 Trafficpolicy API

openapi: 3.1.0
info:
  title: Amazon Route 53 Trafficpolicy API
  version: '2013-04-01'
  description: Generated from AWS's published Smithy model for Amazon Route 53. 6 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/trafficpolicy:
    post:
      operationId: CreateTrafficPolicy
      summary: Create Traffic Policy
      description: Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name
        (such as example.com) or one subdomain name (such as www.example.com).
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTrafficPolicyResponse'
        '400':
          description: InvalidInput; InvalidTrafficPolicyDocument; TooManyTrafficPolicies
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '409':
          description: TrafficPolicyAlreadyExists
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TrafficPolicyAlreadyExists'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateTrafficPolicyRequest'
      tags:
      - Trafficpolicy
  /2013-04-01/trafficpolicy/{Id}:
    post:
      operationId: CreateTrafficPolicyVersion
      summary: Create Traffic Policy Version
      description: Creates a new version of an existing traffic policy. When you create a new version of a traffic policy,
        you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the
        new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com)
        or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If
        you reach the limit and need to create another version, you'll need to start a new traffic policy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTrafficPolicyVersionResponse'
        '400':
          description: ConcurrentModification; InvalidInput; InvalidTrafficPolicyDocument; TooManyTrafficPolicyVersionsForCurrentPolicy
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConcurrentModification'
        '404':
          description: NoSuchTrafficPolicy
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchTrafficPolicy'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateTrafficPolicyVersionRequest'
      tags:
      - Trafficpolicy
  /2013-04-01/trafficpolicy/{Id}/{Version}:
    delete:
      operationId: DeleteTrafficPolicy
      summary: Delete Traffic Policy
      description: 'Deletes a traffic policy. When you delete a traffic policy, Route 53 sets a flag on the policy to indicate
        that it has been deleted. However, Route 53 never fully deletes the traffic policy. Note the following: Deleted traffic
        policies aren''t listed if you run ListTrafficPolicies. There''s no way to get a list of deleted policies. If you
        retain the ID of the policy, you can get information about the policy, including the traffic policy document, by running
        GetTrafficPolicy.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTrafficPolicyResponse'
        '400':
          description: ConcurrentModification; InvalidInput; TrafficPolicyInUse
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConcurrentModification'
        '404':
          description: NoSuchTrafficPolicy
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchTrafficPolicy'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/DeleteTrafficPolicyRequest'
      tags:
      - Trafficpolicy
    get:
      operationId: GetTrafficPolicy
      summary: Get Traffic Policy
      description: Gets information about a specific traffic policy version. For information about how of deleting a traffic
        policy affects the response from GetTrafficPolicy, see DeleteTrafficPolicy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetTrafficPolicyResponse'
        '400':
          description: InvalidInput
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '404':
          description: NoSuchTrafficPolicy
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchTrafficPolicy'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/GetTrafficPolicyRequest'
      tags:
      - Trafficpolicy
    post:
      operationId: UpdateTrafficPolicyComment
      summary: Update Traffic Policy Comment
      description: Updates the comment for a specified traffic policy version.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UpdateTrafficPolicyCommentResponse'
        '400':
          description: ConcurrentModification; InvalidInput
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConcurrentModification'
        '404':
          description: NoSuchTrafficPolicy
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchTrafficPolicy'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/UpdateTrafficPolicyCommentRequest'
      tags:
      - Trafficpolicy
  /2013-04-01/trafficpolicies:
    get:
      operationId: ListTrafficPolicies
      summary: List Traffic Policies
      description: Gets information about the latest version for every traffic policy that is associated with the current
        Amazon Web Services account. Policies are listed in the order that they were created in. For information about how
        of deleting a traffic policy affects the response from ListTrafficPolicies, see DeleteTrafficPolicy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListTrafficPoliciesResponse'
        '400':
          description: InvalidInput
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidInput'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ListTrafficPoliciesRequest'
      tags:
      - Trafficpolicy
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
    CreateTrafficPolicyRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the traffic policy.
        Document:
          type: string
          description: The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document
            Format.
        Comment:
          type: string
          description: (Optional) Any comments that you want to include about the traffic policy.
      required:
      - Name
      - Document
    CreateTrafficPolicyResponse:
      type: object
      properties:
        TrafficPolicy:
          $ref: '#/components/schemas/TrafficPolicy'
        Location:
          type: string
          description: A unique URL that represents a new traffic policy.
      required:
      - TrafficPolicy
      - Location
    CreateTrafficPolicyVersionRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the traffic policy for which you want to create a new version.
        Document:
          type: string
          description: The definition of this version of the traffic policy, in JSON format. You specified the JSON in the
            CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy.
        Comment:
          type: string
          description: The comment that you specified in the CreateTrafficPolicyVersion request, if any.
      required:
      - Id
      - Document
    CreateTrafficPolicyVersionResponse:
      type: object
      properties:
        TrafficPolicy:
          $ref: '#/components/schemas/TrafficPolicy'
        Location:
          type: string
          description: A unique URL that represents a new traffic policy version.
      required:
      - TrafficPolicy
      - Location
    DeleteTrafficPolicyRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the traffic policy that you want to delete.
        Version:
          type: integer
          description: The version number of the traffic policy that you want to delete.
      required:
      - Id
      - Version
    DeleteTrafficPolicyResponse:
      type: object
      properties: {}
    GetTrafficPolicyRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the traffic policy that you want to get information about.
        Version:
          type: integer
          description: The version number of the traffic policy that you want to get information about.
      required:
      - Id
      - Version
    GetTrafficPolicyResponse:
      type: object
      properties:
        TrafficPolicy:
          $ref: '#/components/schemas/TrafficPolicy'
      required:
      - TrafficPolicy
    InvalidInput:
      type: object
      properties:
        message:
          type: string
    ListTrafficPoliciesRequest:
      type: object
      properties:
        TrafficPolicyIdMarker:
          type: string
          description: (Conditional) For your first request to ListTrafficPolicies, don't include the TrafficPolicyIdMarker
            parameter. If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the
            first MaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies.
            For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous
            response.
        MaxItems:
          type: integer
          description: (Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response
            to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is
            true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if
            you submit another request.
    ListTrafficPoliciesResponse:
      type: object
      properties:
        TrafficPolicySummaries:
          type: array
          items:
            $ref: '#/components/schemas/TrafficPolicySummary'
          description: A list that contains one TrafficPolicySummary element for each traffic policy that was created by the
            current Amazon Web Services account.
        IsTruncated:
          type: boolean
          description: A flag that indicates whether there are more traffic policies to be listed. If the response was truncated,
            you can get the next group of traffic policies by submitting another ListTrafficPolicies request and specifying
            the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter.
        TrafficPolicyIdMarker:
          type: string
          description: If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in
            the next group of MaxItems traffic policies.
        MaxItems:
          type: integer
          description: The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced
            the current response.
      required:
      - TrafficPolicySummaries
      - IsTruncated
      - TrafficPolicyIdMarker
      - MaxItems
    NoSuchTrafficPolicy:
      type: object
      properties:
        message:
          type: string
    TrafficPolicy:
      type: object
      properties:
        Id:
          type: string
          description: The ID that Amazon Route 53 assigned to a traffic policy when you created it.
        Version:
          type: integer
          description: The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the
            value of Version is always 1.
        Name:
          type: string
          description: The name that you specified when you created the traffic policy.
        Type:
          type: string
          enum:
          - SOA
          - A
          - TXT
          - NS
          - CNAME
          - MX
          - NAPTR
          - PTR
          - SRV
          - SPF
          - AAAA
          - CAA
          - DS
          - TLSA
          - SSHFP
          - SVCB
          - HTTPS
          description: The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy
            to create a traffic policy instance.
        Document:
          type: string
          description: The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic
            policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document
            Format.
        Comment:
          type: string
          description: The comment that you specify in the CreateTrafficPolicy request, if any.
      required:
      - Id
      - Version
      - Name
      - Type
      - Document
    TrafficPolicyAlreadyExists:
      type: object
      properties:
        message:
          type: string
    TrafficPolicySummary:
      type: object
      properties:
        Id:
          type: string
          description: The ID that Amazon Route 53 assigned to the traffic policy when you created it.
        Name:
          type: string
          description: The name that you specified for the traffic policy when you created it.
        Type:
          type: string
          enum:
          - SOA
          - A
          - TXT
          - NS
          - CNAME
          - MX
          - NAPTR
          - PTR
          - SRV
          - SPF
          - AAAA
          - CAA
          - DS
          - TLSA
          - SSHFP
          - SVCB
          - HTTPS
          description: The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy
            to create a traffic policy instance.
        LatestVersion:
          type: integer
          description: The version number of the latest version of the traffic policy.
        TrafficPolicyCount:
          type: integer
          description: The number of traffic policies that are associated with the current Amazon Web Services account.
      required:
      - Id
      - Name
      - Type
      - LatestVersion
      - TrafficPolicyCount
    UpdateTrafficPolicyCommentRequest:
      type: object
      properties:
        Id:
          type: string
          description: The value of Id for the traffic policy that you want to update the comment for.
        Version:
          type: integer
          description: The value of Version for the traffic policy that you want to update the comment for.
        Comment:
          type: string
          description: The new comment for the specified traffic policy and version.
      required:
      - Id
      - Version
      - Comment
    UpdateTrafficPolicyCommentResponse:
      type: object
      properties:
        TrafficPolicy:
          $ref: '#/components/schemas/TrafficPolicy'
      required:
      - TrafficPolicy
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)