Amazon Route 53 Route 53 Cidrcollection API

openapi: 3.1.0
info:
  title: Amazon Route 53 Cidrcollection API
  version: '2013-04-01'
  description: Generated from AWS's published Smithy model for Amazon Route 53. 5 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/cidrcollection/{Id}:
    post:
      operationId: ChangeCidrCollection
      summary: Change Cidr Collection
      description: 'Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping
        blocks to one or multiple locations. A change request can update multiple locations in a collection at a time, which
        is helpful if you want to move one or more CIDR blocks from one location to another in one transaction, without downtime.
        Limits The max number of CIDR blocks included in the request is 1000. As a result, big updates require multiple API
        calls. PUT and DELETE_IF_EXISTS Use ChangeCidrCollection to perform the following actions: PUT: Create a CIDR block
        within the specified collection. DELETE_IF_EXISTS: Delete an existing CIDR block from the collection.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ChangeCidrCollectionResponse'
        '400':
          description: CidrBlockInUseException; ConcurrentModification; InvalidInput; LimitsExceeded
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CidrBlockInUseException'
        '409':
          description: CidrCollectionVersionMismatchException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CidrCollectionVersionMismatchException'
        '404':
          description: NoSuchCidrCollectionException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchCidrCollectionException'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ChangeCidrCollectionRequest'
      tags:
      - Cidrcollection
    delete:
      operationId: DeleteCidrCollection
      summary: Delete Cidr Collection
      description: Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before
        it can be deleted.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteCidrCollectionResponse'
        '400':
          description: CidrCollectionInUseException; ConcurrentModification; InvalidInput
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CidrCollectionInUseException'
        '404':
          description: NoSuchCidrCollectionException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchCidrCollectionException'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/DeleteCidrCollectionRequest'
      tags:
      - Cidrcollection
  /2013-04-01/cidrcollection:
    post:
      operationId: CreateCidrCollection
      summary: Create Cidr Collection
      description: Creates a CIDR collection in the current Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateCidrCollectionResponse'
        '400':
          description: CidrCollectionAlreadyExistsException; ConcurrentModification; InvalidInput; LimitsExceeded
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CidrCollectionAlreadyExistsException'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateCidrCollectionRequest'
      tags:
      - Cidrcollection
    get:
      operationId: ListCidrCollections
      summary: List Cidr Collections
      description: Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListCidrCollectionsResponse'
        '400':
          description: InvalidInput
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidInput'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ListCidrCollectionsRequest'
      tags:
      - Cidrcollection
  /2013-04-01/cidrcollection/{CollectionId}:
    get:
      operationId: ListCidrLocations
      summary: List Cidr Locations
      description: Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR
        blocks).
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListCidrLocationsResponse'
        '400':
          description: InvalidInput
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '404':
          description: NoSuchCidrCollectionException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchCidrCollectionException'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ListCidrLocationsRequest'
      tags:
      - Cidrcollection
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:
    ChangeCidrCollectionRequest:
      type: object
      properties:
        Id:
          type: string
          description: The UUID of the CIDR collection to update.
        CollectionVersion:
          type: integer
          description: 'A sequential counter that Amazon Route 53 sets to 1 when you create a collection and increments it
            by 1 each time you update the collection. We recommend that you use ListCidrCollection to get the current value
            of CollectionVersion for the collection that you want to update, and then include that value with the change request.
            This prevents Route 53 from overwriting an intervening update: If the value in the request matches the value of
            CollectionVersion in the collection, Route 53 updates the collection. If the value of CollectionVersion in the
            collection is greater than the value in the requ'
        Changes:
          type: array
          items:
            $ref: '#/components/schemas/CidrCollectionChange'
          description: Information about changes to a CIDR collection.
      required:
      - Id
      - Changes
    ChangeCidrCollectionResponse:
      type: object
      properties:
        Id:
          type: string
          description: The ID that is returned by ChangeCidrCollection. You can use it as input to GetChange to see if a CIDR
            collection change has propagated or not.
      required:
      - Id
    CidrBlockInUseException:
      type: object
      properties:
        Message:
          type: string
    CidrCollection:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the collection. Can be used to reference the collection in IAM policy or in another Amazon
            Web Services account.
        Id:
          type: string
          description: The unique ID of the CIDR collection.
        Name:
          type: string
          description: The name of a CIDR collection.
        Version:
          type: integer
          description: A sequential counter that Route 53 sets to 1 when you create a CIDR collection and increments by 1
            each time you update settings for the CIDR collection.
    CidrCollectionAlreadyExistsException:
      type: object
      properties:
        Message:
          type: string
    CidrCollectionChange:
      type: object
      properties:
        LocationName:
          type: string
          description: Name of the location that is associated with the CIDR collection.
        Action:
          type: string
          enum:
          - PUT
          - DELETE_IF_EXISTS
          description: CIDR collection change action.
        CidrList:
          type: array
          items:
            type: string
          description: List of CIDR blocks.
      required:
      - LocationName
      - Action
      - CidrList
    CidrCollectionInUseException:
      type: object
      properties:
        Message:
          type: string
    CidrCollectionVersionMismatchException:
      type: object
      properties:
        Message:
          type: string
    CollectionSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the collection summary. Can be used to reference the collection in IAM policy or cross-account.
        Id:
          type: string
          description: Unique ID for the CIDR collection.
        Name:
          type: string
          description: The name of a CIDR collection.
        Version:
          type: integer
          description: A sequential counter that Route 53 sets to 1 when you create a CIDR collection and increments by 1
            each time you update settings for the CIDR collection.
    CreateCidrCollectionRequest:
      type: object
      properties:
        Name:
          type: string
          description: A unique identifier for the account that can be used to reference the collection from other API calls.
        CallerReference:
          type: string
          description: A client-specific token that allows requests to be securely retried so that the intended outcome will
            only occur once, retries receive a similar response, and there are no additional edge cases to handle.
      required:
      - Name
      - CallerReference
    CreateCidrCollectionResponse:
      type: object
      properties:
        Collection:
          $ref: '#/components/schemas/CidrCollection'
        Location:
          type: string
          description: A unique URL that represents the location for the CIDR collection.
    DeleteCidrCollectionRequest:
      type: object
      properties:
        Id:
          type: string
          description: The UUID of the collection to delete.
      required:
      - Id
    DeleteCidrCollectionResponse:
      type: object
      properties: {}
    InvalidInput:
      type: object
      properties:
        message:
          type: string
    ListCidrCollectionsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: An opaque pagination token to indicate where the service is to begin enumerating results. If no value
            is provided, the listing of results starts from the beginning.
        MaxResults:
          type: integer
          description: The maximum number of CIDR collections to return in the response.
    ListCidrCollectionsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: An opaque pagination token to indicate where the service is to begin enumerating results. If no value
            is provided, the listing of results starts from the beginning.
        CidrCollections:
          type: array
          items:
            $ref: '#/components/schemas/CollectionSummary'
          description: A complex type with information about the CIDR collection.
    ListCidrLocationsRequest:
      type: object
      properties:
        CollectionId:
          type: string
          description: The CIDR collection ID.
        NextToken:
          type: string
          description: An opaque pagination token to indicate where the service is to begin enumerating results. If no value
            is provided, the listing of results starts from the beginning.
        MaxResults:
          type: integer
          description: The maximum number of CIDR collection locations to return in the response.
      required:
      - CollectionId
    ListCidrLocationsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: An opaque pagination token to indicate where the service is to begin enumerating results. If no value
            is provided, the listing of results starts from the beginning.
        CidrLocations:
          type: array
          items:
            $ref: '#/components/schemas/LocationSummary'
          description: A complex type that contains information about the list of CIDR locations.
    LocationSummary:
      type: object
      properties:
        LocationName:
          type: string
          description: A string that specifies a location name.
    NoSuchCidrCollectionException:
      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)