Amazon EC2 Ec2 Ipam Pool API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Ipam Pool API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Ipam Pool
paths:
  /?Action=CreateIpamPool:
    post:
      operationId: CreateIpamPool
      summary: Create Ipam Pool
      description: Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each. For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateIpamPoolResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateIpamPool
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateIpamPoolRequest'
      tags:
      - Ipam Pool
  /?Action=DeleteIpamPool:
    post:
      operationId: DeleteIpamPool
      summary: Delete Ipam Pool
      description: Delete an IPAM pool. You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr. For more information, see Delete a pool in the Amazon VPC IPAM User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteIpamPoolResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteIpamPool
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteIpamPoolRequest'
      tags:
      - Ipam Pool
  /?Action=DescribeIpamPools:
    post:
      operationId: DescribeIpamPools
      summary: Describe Ipam Pools
      description: Get information about your IPAM pools.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeIpamPoolsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeIpamPools
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeIpamPoolsRequest'
      tags:
      - Ipam Pool
  /?Action=ModifyIpamPool:
    post:
      operationId: ModifyIpamPool
      summary: Modify Ipam Pool
      description: Modify the configurations of an IPAM pool. For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyIpamPoolResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyIpamPool
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyIpamPoolRequest'
      tags:
      - Ipam Pool
components:
  schemas:
    DeleteIpamPoolRequest:
      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 pool to delete.
        Cascade:
          type: boolean
          description: Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools. You can only use this option to delete pools in the private scope or pools in the public scope with a source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.
      required:
      - IpamPoolId
    IpamResourceTag:
      type: object
      properties:
        Key:
          type: string
          description: 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.
        Value:
          type: string
          description: The value of the tag.
    RequestIpamResourceTag:
      type: object
      properties:
        Key:
          type: string
          description: 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.
        Value:
          type: string
          description: The value for the tag.
    IpamPoolSourceResource:
      type: object
      properties:
        ResourceId:
          type: string
          description: The source resource ID.
        ResourceType:
          type: string
          enum:
          - vpc
          description: The source resource type.
        ResourceRegion:
          type: string
          description: The source resource Region.
        ResourceOwner:
          type: string
          description: The source resource owner.
    DescribeIpamPoolsResult:
      type: object
      properties:
        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.
        IpamPools:
          type: array
          items:
            $ref: '#/components/schemas/IpamPool'
          description: Information about the IPAM pools.
    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.'
    ModifyIpamPoolResult:
      type: object
      properties:
        IpamPool:
          $ref: '#/components/schemas/IpamPool'
    DescribeIpamPoolsRequest:
      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.
        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.
        IpamPoolIds:
          type: array
          items:
            type: string
          description: The IDs of the IPAM pools you would like information on.
    ModifyIpamPoolRequest:
      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 modify.
        Description:
          type: string
          description: The description of the IPAM pool you want to modify.
        AutoImport:
          type: boolean
          description: If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will rand
        AllocationMinNetmaskLength:
          type: integer
          description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.
        AllocationMaxNetmaskLength:
          type: integer
          description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.
        AllocationDefaultNetmaskLength:
          type: integer
          description: The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
        ClearAllocationDefaultNetmaskLength:
          type: boolean
          description: Clear the default netmask length allocation rule for this pool.
        AddAllocationResourceTags:
          type: array
          items:
            $ref: '#/components/schemas/RequestIpamResourceTag'
          description: Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
        RemoveAllocationResourceTags:
          type: array
          items:
            $ref: '#/components/schemas/RequestIpamResourceTag'
          description: Remove tag allocation rules from a pool.
      required:
      - IpamPoolId
    DeleteIpamPoolResult:
      type: object
      properties:
        IpamPool:
          $ref: '#/components/schemas/IpamPool'
    CreateIpamPoolResult:
      type: object
      properties:
        IpamPool:
          $ref: '#/components/schemas/IpamPool'
    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.
    IpamPool:
      type: object
      properties:
        OwnerId:
          type: string
          description: The Amazon Web Services account ID of the owner of the IPAM pool.
        IpamPoolId:
          type: string
          description: The ID of the IPAM pool.
        SourceIpamPoolId:
          type: string
          description: The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
        IpamPoolArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IPAM pool.
        IpamScopeArn:
          type: string
          description: The ARN of the scope of the IPAM pool.
        IpamScopeType:
          type: string
          enum:
          - public
          - private
          description: In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
        IpamArn:
          type: string
          description: The ARN of the IPAM.
        IpamRegion:
          type: string
          description: The Amazon Web Services Region of the IPAM pool.
        Locale:
          type: string
          description: 'The locale of the IPAM pool. The locale for the pool should be one of the following: An Amazon Web Services Region where you want this IPAM pool to be available for allocations. The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you''ll get an error.'
        PoolDepth:
          type: integer
          description: The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
        State:
          type: string
          enum:
          - create-in-progress
          - create-complete
          - create-failed
          - modify-in-progress
          - modify-complete
          - modify-failed
          - delete-in-progress
          - delete-complete
          - delete-failed
          - isolate-in-progress
          - isolate-complete
          - restore-in-progress
          description: The state of the IPAM pool.
        StateMessage:
          type: string
          description: The state message.
        Description:
          type: string
          description: The description of the IPAM pool.
        AutoImport:
          type: boolean
          description: 'If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will '
        PubliclyAdvertisable:
          type: boolean
          description: Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.
        AddressFamily:
          type: string
          enum:
          - ipv4
          - ipv6
          description: The address family of the pool.
        AllocationMinNetmaskLength:
          type: integer
          description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
        AllocationMaxNetmaskLength:
          type: integer
          description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
        AllocationDefaultNetmaskLength:
          type: integer
          description: The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
        AllocationResourceTags:
          type: array
          items:
            $ref: '#/components/schemas/IpamResourceTag'
          description: Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 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.
        AwsService:
          type: string
          enum:
          - ec2
          - global-services
          description: Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
        PublicIpSource:
          type: string
          enum:
          - amazon
          - byoip
          description: The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
        SourceResource:
          $ref: '#/components/schemas/IpamPoolSourceResource'
    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.
    CreateIpamPoolRequest:
      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.
        IpamScopeId:
          type: string
          description: The ID of the scope in which you would like to create the IPAM pool.
        Locale:
          type: string
          description: 'The locale for the pool should be one of the following: An Amazon Web Services Region where you want this IPAM pool to be available for allocations. The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope. Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone. Default is none and means any locale.'
        SourceIpamPoolId:
          type: string
          description: The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.
        Description:
          type: string
          description: A description for the IPAM pool.
        AddressFamily:
          type: string
          enum:
          - ipv4
          - ipv6
          description: The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
        AutoImport:
          type: boolean
          description: 'If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will '
        PubliclyAdvertisable:
          type: boolean
          description: Determines if the pool is publicly advertisable. The request can only contain PubliclyAdvertisable if AddressFamily is ipv6 and PublicIpSource is byoip.
        AllocationMinNetmaskLength:
          type: integer
          description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
        AllocationMaxNetmaskLength:
          type: integer
          description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
        AllocationDefaultNetmaskLength:
          type: integer
          description: The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
        AllocationResourceTags:
          type: array
          items:
            $ref: '#/components/schemas/RequestIpamResourceTag'
          description: Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: 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.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
        AwsService:
          type: string
          enum:
          - ec2
          - global-services
          description: Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
        PublicIpSource:
          type: string
          enum:
          - amazon
          - byoip
          description: The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
        SourceResource:
          $ref: '#/components/schemas/IpamPoolSourceResourceRequest'
      required:
      - IpamScopeId
      - AddressFamily
    IpamPoolSourceResourceRequest:
      type: object
      properties:
        ResourceId:
          type: string
          description: The source resource ID.
        ResourceType:
          type: string
          enum:
          - vpc
          description: The source resource type.
        ResourceRegion:
          type: string
          description: The source resource Region.
        ResourceOwner:
          type: string
          description: The source resource owner.
  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)