Amazon Route 53 Route 53 Delegationset API

openapi: 3.1.0
info:
  title: Amazon Route 53 Delegationset 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/delegationset:
    post:
      operationId: CreateReusableDelegationSet
      summary: Create Reusable Delegation Set
      description: 'Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that
        were created by the same Amazon Web Services account. You can also create a reusable delegation set that uses the
        four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet
        request. You can''t associate a reusable delegation set with a private hosted zone. For information about using a
        reusable delegation set to configure white label name servers, see Configuring White Label Name Servers. The process
        for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring
        white label name servers. You need to perform the following steps: Create a reusable delegation set. Recreate hosted
        zones, and reduce the TTL to 60 seconds or less. Recreate resource record sets in the new hosted zones. Change the
        registrar''s name servers to use the name servers for the new hosted zones. Monitor traffic for the website or application.
        Change TTLs back to their original values. If you want to migrate existing hosted zones to use a reusable delegation
        set, the existing hosted zones can'''
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateReusableDelegationSetResponse'
        '400':
          description: DelegationSetAlreadyCreated; DelegationSetAlreadyReusable; DelegationSetNotAvailable; HostedZoneNotFound;
            InvalidArgument; InvalidInput; LimitsExceeded
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DelegationSetAlreadyCreated'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateReusableDelegationSetRequest'
      tags:
      - Delegationset
    get:
      operationId: ListReusableDelegationSets
      summary: List Reusable Delegation Sets
      description: Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services
        account.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListReusableDelegationSetsResponse'
        '400':
          description: InvalidInput
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidInput'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ListReusableDelegationSetsRequest'
      tags:
      - Delegationset
  /2013-04-01/delegationset/{Id}:
    delete:
      operationId: DeleteReusableDelegationSet
      summary: Delete Reusable Delegation Set
      description: Deletes a reusable delegation set. You can delete a reusable delegation set only if it isn't associated
        with any hosted zones. To verify that the reusable delegation set is not associated with any hosted zones, submit
        a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteReusableDelegationSetResponse'
        '400':
          description: DelegationSetInUse; DelegationSetNotReusable; InvalidInput; NoSuchDelegationSet
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DelegationSetInUse'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/DeleteReusableDelegationSetRequest'
      tags:
      - Delegationset
    get:
      operationId: GetReusableDelegationSet
      summary: Get Reusable Delegation Set
      description: Retrieves information about a specified reusable delegation set, including the four name servers that are
        assigned to the delegation set.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetReusableDelegationSetResponse'
        '400':
          description: DelegationSetNotReusable; InvalidInput; NoSuchDelegationSet
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DelegationSetNotReusable'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/GetReusableDelegationSetRequest'
      tags:
      - Delegationset
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:
    CreateReusableDelegationSetRequest:
      type: object
      properties:
        CallerReference:
          type: string
          description: A unique string that identifies the request, and that allows you to retry failed CreateReusableDelegationSet
            requests without the risk of executing the operation twice. You must use a unique CallerReference string every
            time you submit a CreateReusableDelegationSet request. CallerReference can be any unique string, for example a
            date/time stamp.
        HostedZoneId:
          type: string
          description: If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted
            zone.
      required:
      - CallerReference
    CreateReusableDelegationSetResponse:
      type: object
      properties:
        DelegationSet:
          $ref: '#/components/schemas/DelegationSet'
        Location:
          type: string
          description: The unique URL representing the new reusable delegation set.
      required:
      - DelegationSet
      - Location
    DelegationSet:
      type: object
      properties:
        Id:
          type: string
          description: The ID that Amazon Route 53 assigns to a reusable delegation set.
        CallerReference:
          type: string
          description: The value that you specified for CallerReference when you created the reusable delegation set.
        NameServers:
          type: array
          items:
            type: string
          description: A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable
            delegation set.
      required:
      - NameServers
    DelegationSetAlreadyCreated:
      type: object
      properties:
        message:
          type: string
    DelegationSetInUse:
      type: object
      properties:
        message:
          type: string
    DelegationSetNotReusable:
      type: object
      properties:
        message:
          type: string
    DeleteReusableDelegationSetRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the reusable delegation set that you want to delete.
      required:
      - Id
    DeleteReusableDelegationSetResponse:
      type: object
      properties: {}
    GetReusableDelegationSetRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the reusable delegation set that you want to get a list of name servers for.
      required:
      - Id
    GetReusableDelegationSetResponse:
      type: object
      properties:
        DelegationSet:
          $ref: '#/components/schemas/DelegationSet'
      required:
      - DelegationSet
    InvalidInput:
      type: object
      properties:
        message:
          type: string
    ListReusableDelegationSetsRequest:
      type: object
      properties:
        Marker:
          type: string
          description: If the value of IsTruncated in the previous response was true, you have more reusable delegation sets.
            To get another group, submit another ListReusableDelegationSets request. For the value of marker, specify the
            value of NextMarker from the previous response, which is the ID of the first reusable delegation set that Amazon
            Route 53 will return if you submit another request. If the value of IsTruncated in the previous response was false,
            there are no more reusable delegation sets to get.
        MaxItems:
          type: integer
          description: The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this
            request. If you specify a value greater than 100, Route 53 returns only the first 100 reusable delegation sets.
    ListReusableDelegationSetsResponse:
      type: object
      properties:
        DelegationSets:
          type: array
          items:
            $ref: '#/components/schemas/DelegationSet'
          description: A complex type that contains one DelegationSet element for each reusable delegation set that was created
            by the current Amazon Web Services account.
        Marker:
          type: string
          description: For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified
            for the marker parameter in the request that produced the current response.
        IsTruncated:
          type: boolean
          description: A flag that indicates whether there are more reusable delegation sets to be listed.
        NextMarker:
          type: string
          description: If IsTruncated is true, the value of NextMarker identifies the next reusable delegation set that Amazon
            Route 53 will return if you submit another ListReusableDelegationSets request and specify the value of NextMarker
            in the marker parameter.
        MaxItems:
          type: integer
          description: The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that
            produced the current response.
      required:
      - DelegationSets
      - Marker
      - IsTruncated
      - MaxItems
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)