find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-ec2:amazon-ec2-ipam-pool-allocation-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Ipam Pool Allocation 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: Ipam Pool Allocation
paths:
  /?Action=DescribeIpamPoolAllocations:
    post:
      operationId: DescribeIpamPoolAllocations
      summary: Describe Ipam Pool Allocations
      description: Describes IPAM pool allocations. You can describe all allocations owned by you across all pools, or you can describe specific allocations by ID. If you specify IpamPoolAllocationIds, the results include only the specified allocations. If you do not specify IpamPoolAllocationIds, the results include all allocations owned by you. You can use Filters to narrow the results. This action returns only allocations directly owned by you. To view all allocations in a pool you own or that has been shared with you, including allocations owned by other accounts, use GetIpamPoolAllocations.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeIpamPoolAllocationsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeIpamPoolAllocations
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeIpamPoolAllocationsRequest'
      tags:
      - Ipam Pool Allocation
  /?Action=GetIpamPoolAllocations:
    post:
      operationId: GetIpamPoolAllocations
      summary: Get Ipam Pool Allocations
      description: Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetIpamPoolAllocationsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetIpamPoolAllocations
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/GetIpamPoolAllocationsRequest'
      tags:
      - Ipam Pool Allocation
  /?Action=ModifyIpamPoolAllocation:
    post:
      operationId: ModifyIpamPoolAllocation
      summary: Modify Ipam Pool Allocation
      description: Modifies the description of an IPAM pool allocation. For more information, see Modify an IPAM pool allocation in the Amazon VPC IPAM User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyIpamPoolAllocationResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyIpamPoolAllocation
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyIpamPoolAllocationRequest'
      tags:
      - Ipam Pool Allocation
components:
  schemas:
    ModifyIpamPoolAllocationRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: A check for 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.
        IpamPoolAllocationId:
          type: string
          description: The ID of the IPAM pool allocation you want to modify.
        Description:
          type: string
          description: The new description for the IPAM pool allocation. If you submit a null value, the description is removed from the allocation.
      required:
      - IpamPoolAllocationId
    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.'
    GetIpamPoolAllocationsRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: A check for 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.
        IpamPoolId:
          type: string
          description: The ID of the IPAM pool you want to see the allocations for.
        IpamPoolAllocationId:
          type: string
          description: The ID of the allocation.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters for the request. For more information about filtering, see Filtering CLI output.
        MaxResults:
          type: integer
          description: The maximum number of results you would like returned per page.
        NextToken:
          type: string
          description: The token for the next page of results.
      required:
      - IpamPoolId
    DescribeIpamPoolAllocationsRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: A check for 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.
        IpamPoolAllocationIds:
          type: array
          items:
            type: string
          description: The IDs of the IPAM pool allocations you want to describe.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters for the request. For more information about filtering, see Filtering CLI output.
        MaxResults:
          type: integer
          description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
        NextToken:
          type: string
          description: The token for the next page of results.
    IpamPoolAllocation:
      type: object
      properties:
        Cidr:
          type: string
          description: The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.
        IpamPoolAllocationId:
          type: string
          description: The ID of an allocation.
        Description:
          type: string
          description: A description of the pool allocation.
        ResourceId:
          type: string
          description: The ID of the resource.
        ResourceType:
          type: string
          enum:
          - ipam-pool
          - vpc
          - ec2-public-ipv4-pool
          - custom
          - subnet
          - eip
          - anycast-ip-list
          description: The type of the resource.
        ResourceRegion:
          type: string
          description: The Amazon Web Services Region of the resource.
        ResourceOwner:
          type: string
          description: The owner of the resource.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags for the IPAM pool allocation.
    ModifyIpamPoolAllocationResult:
      type: object
      properties:
        IpamPoolAllocation:
          $ref: '#/components/schemas/IpamPoolAllocation'
    DescribeIpamPoolAllocationsResult:
      type: object
      properties:
        IpamPoolAllocations:
          type: array
          items:
            $ref: '#/components/schemas/IpamPoolAllocation'
          description: Information about the IPAM pool allocations.
        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.
    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.
    GetIpamPoolAllocationsResult:
      type: object
      properties:
        IpamPoolAllocations:
          type: array
          items:
            $ref: '#/components/schemas/IpamPoolAllocation'
          description: The IPAM pool allocations you want information on.
        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.
  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)