Amazon EC2 Ec2 Subnet Cidr Reservation API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Subnet Cidr Reservation API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 3 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Subnet Cidr Reservation
paths:
  /?Action=CreateSubnetCidrReservation:
    post:
      operationId: CreateSubnetCidrReservation
      summary: Create Subnet Cidr Reservation
      description: Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations in the Amazon VPC User Guide and Manage prefixes for your network interfaces in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateSubnetCidrReservationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateSubnetCidrReservation
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateSubnetCidrReservationRequest'
      tags:
      - Subnet Cidr Reservation
  /?Action=DeleteSubnetCidrReservation:
    post:
      operationId: DeleteSubnetCidrReservation
      summary: Delete Subnet Cidr Reservation
      description: Deletes a subnet CIDR reservation.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteSubnetCidrReservationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteSubnetCidrReservation
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteSubnetCidrReservationRequest'
      tags:
      - Subnet Cidr Reservation
  /?Action=GetSubnetCidrReservations:
    post:
      operationId: GetSubnetCidrReservations
      summary: Get Subnet Cidr Reservations
      description: Gets information about the subnet CIDR reservations.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetSubnetCidrReservationsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetSubnetCidrReservations
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/GetSubnetCidrReservationsRequest'
      tags:
      - Subnet Cidr Reservation
components:
  schemas:
    GetSubnetCidrReservationsRequest:
      type: object
      properties:
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'One or more filters. reservationType - The type of reservation (prefix | explicit). subnet-id - The ID of the subnet. tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.'
        SubnetId:
          type: string
          description: The ID of the subnet.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        NextToken:
          type: string
          description: The token for the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
      required:
      - SubnetId
    DeleteSubnetCidrReservationResult:
      type: object
      properties:
        DeletedSubnetCidrReservation:
          $ref: '#/components/schemas/SubnetCidrReservation'
    DeleteSubnetCidrReservationRequest:
      type: object
      properties:
        SubnetCidrReservationId:
          type: string
          description: The ID of the subnet CIDR reservation.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - SubnetCidrReservationId
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
        Value:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    SubnetCidrReservation:
      type: object
      properties:
        SubnetCidrReservationId:
          type: string
          description: The ID of the subnet CIDR reservation.
        SubnetId:
          type: string
          description: The ID of the subnet.
        Cidr:
          type: string
          description: The CIDR that has been reserved.
        ReservationType:
          type: string
          enum:
          - prefix
          - explicit
          description: The type of reservation.
        OwnerId:
          type: string
          description: The ID of the account that owns the subnet CIDR reservation.
        Description:
          type: string
          description: The description assigned to the subnet CIDR reservation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the subnet CIDR reservation.
    GetSubnetCidrReservationsResult:
      type: object
      properties:
        SubnetIpv4CidrReservations:
          type: array
          items:
            $ref: '#/components/schemas/SubnetCidrReservation'
          description: Information about the IPv4 subnet CIDR reservations.
        SubnetIpv6CidrReservations:
          type: array
          items:
            $ref: '#/components/schemas/SubnetCidrReservation'
          description: Information about the IPv6 subnet CIDR reservations.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
    CreateSubnetCidrReservationResult:
      type: object
      properties:
        SubnetCidrReservation:
          $ref: '#/components/schemas/SubnetCidrReservation'
    TagSpecification:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - capacity-reservation
          - client-vpn-endpoint
          - customer-gateway
          - carrier-gateway
          - coip-pool
          - declarative-policies-report
          - dedicated-host
          - dhcp-options
          - egress-only-internet-gateway
          - elastic-ip
          - elastic-gpu
          - export-image-task
          - export-instance-task
          - fleet
          - fpga-image
          - host-reservation
          - image
          - image-usage-report
          - import-image-task
          - import-snapshot-task
          - instance
          - instance-event-window
          - internet-gateway
          - ipam
          - ipam-pool
          - ipam-scope
          - ipv4pool-ec2
          - ipv6pool-ec2
          - key-pair
          - launch-template
          - local-gateway
          - local-gateway-route-table
          - local-gateway-virtual-interface
          - local-gateway-virtual-interface-group
          - local-gateway-route-table-vpc-association
          - local-gateway-route-table-virtual-interface-group-association
          - natgateway
          - network-acl
          - network-interface
          - network-insights-analysis
          - network-insights-path
          - network-insights-access-scope
          - network-insights-access-scope-analysis
          - outpost-lag
          - placement-group
          - prefix-list
          - replace-root-volume-task
          - reserved-instances
          - route-table
          - security-group
          - security-group-rule
          - service-link-virtual-interface
          - snapshot
          - spot-fleet-request
          - spot-instances-request
          - subnet
          - subnet-cidr-reservation
          - traffic-mirror-filter
          - traffic-mirror-session
          - traffic-mirror-target
          - transit-gateway
          - transit-gateway-attachment
          - transit-gateway-connect-peer
          - transit-gateway-multicast-domain
          - transit-gateway-policy-table
          - transit-gateway-metering-policy
          - transit-gateway-route-table
          - transit-gateway-route-table-announcement
          - volume
          - vpc
          - vpc-endpoint
          - vpc-endpoint-connection
          - vpc-endpoint-service
          - vpc-endpoint-service-permission
          - vpc-peering-connection
          - vpn-connection
          - vpn-gateway
          - vpc-flow-log
          - capacity-reservation-fleet
          - traffic-mirror-filter-rule
          - vpc-endpoint-connection-device-type
          - verified-access-instance
          - verified-access-group
          - verified-access-endpoint
          - verified-access-policy
          - verified-access-trust-provider
          - vpn-connection-device-type
          - vpc-block-public-access-exclusion
          - vpc-encryption-control
          - route-server
          - route-server-endpoint
          - route-server-peer
          - ipam-resource-discovery
          - ipam-resource-discovery-association
          - instance-connect-endpoint
          - verified-access-endpoint-target
          - ipam-external-resource-verification-token
          - capacity-block
          - mac-modification-task
          - ipam-prefix-list-resolver
          - ipam-policy
          - ipam-prefix-list-resolver-target
          - ipam-internet-registry-association
          - secondary-interface
          - secondary-network
          - secondary-subnet
          - capacity-manager-data-export
          - vpn-concentrator
          - ipam-pool-allocation
          - capacity-reservation-cancellation-quote
          - application-status-check
          - capacity-reservation-modification-quote
          description: The type of resource to tag on creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to apply to the resource.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    CreateSubnetCidrReservationRequest:
      type: object
      properties:
        SubnetId:
          type: string
          description: The ID of the subnet.
        Cidr:
          type: string
          description: The IPv4 or IPV6 CIDR range to reserve.
        ReservationType:
          type: string
          enum:
          - prefix
          - explicit
          description: The type of reservation. The reservation type determines how the reserved IP addresses are assigned to resources. prefix - Amazon Web Services assigns the reserved IP addresses to network interfaces. explicit - You assign the reserved IP addresses to network interfaces.
        Description:
          type: string
          description: The description to assign to the subnet CIDR reservation.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to assign to the subnet CIDR reservation.
      required:
      - SubnetId
      - Cidr
      - ReservationType
  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: ec2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)