Amazon EC2 Ec2 Ipam API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Ipam 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
paths:
  /?Action=CreateIpam:
    post:
      operationId: CreateIpam
      summary: Create Ipam
      description: Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateIpamResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateIpam
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateIpamRequest'
      tags:
      - Ipam
  /?Action=DeleteIpam:
    post:
      operationId: DeleteIpam
      summary: Delete Ipam
      description: Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs. For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteIpamResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteIpam
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteIpamRequest'
      tags:
      - Ipam
  /?Action=DescribeIpams:
    post:
      operationId: DescribeIpams
      summary: Describe Ipams
      description: Get information about your IPAM pools. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeIpamsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeIpams
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeIpamsRequest'
      tags:
      - Ipam
  /?Action=ModifyIpam:
    post:
      operationId: ModifyIpam
      summary: Modify Ipam
      description: Modify the configurations of an IPAM.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyIpamResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyIpam
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyIpamRequest'
      tags:
      - Ipam
components:
  schemas:
    IpamOperatingRegion:
      type: object
      properties:
        RegionName:
          type: string
          description: The name of the operating Region.
    DescribeIpamsRequest:
      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.
        IpamIds:
          type: array
          items:
            type: string
          description: The IDs of the IPAMs you want information on.
    DeleteIpamRequest:
      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.
        IpamId:
          type: string
          description: The ID of the IPAM to delete.
        Cascade:
          type: boolean
          description: 'Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following: Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes. No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged. Deprovisions all IPv4 CIDRs provisioned to IPAM '
      required:
      - IpamId
    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.'
    CreateIpamRequest:
      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.
        Description:
          type: string
          description: A description for the IPAM.
        OperatingRegions:
          type: array
          items:
            $ref: '#/components/schemas/AddIpamOperatingRegion'
          description: The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
        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.
        Tier:
          type: string
          enum:
          - free
          - advanced
          description: IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
        EnablePrivateGua:
          type: boolean
          description: Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
        MeteredAccount:
          type: string
          enum:
          - ipam-owner
          - resource-owner
          description: 'A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide. Possible values: ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.'
    DeleteIpamResult:
      type: object
      properties:
        Ipam:
          $ref: '#/components/schemas/Ipam'
    DescribeIpamsResult:
      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.
        Ipams:
          type: array
          items:
            $ref: '#/components/schemas/Ipam'
          description: Information about the IPAMs.
    CreateIpamResult:
      type: object
      properties:
        Ipam:
          $ref: '#/components/schemas/Ipam'
    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.
    RemoveIpamOperatingRegion:
      type: object
      properties:
        RegionName:
          type: string
          description: The name of the operating Region you want to remove.
    ModifyIpamRequest:
      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.
        IpamId:
          type: string
          description: The ID of the IPAM you want to modify.
        Description:
          type: string
          description: The description of the IPAM you want to modify.
        AddOperatingRegions:
          type: array
          items:
            $ref: '#/components/schemas/AddIpamOperatingRegion'
          description: Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
        RemoveOperatingRegions:
          type: array
          items:
            $ref: '#/components/schemas/RemoveIpamOperatingRegion'
          description: The operating Regions to remove.
        Tier:
          type: string
          enum:
          - free
          - advanced
          description: IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
        EnablePrivateGua:
          type: boolean
          description: Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
        MeteredAccount:
          type: string
          enum:
          - ipam-owner
          - resource-owner
          description: 'A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide. Possible values: ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.'
      required:
      - IpamId
    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.
    Ipam:
      type: object
      properties:
        OwnerId:
          type: string
          description: The Amazon Web Services account ID of the owner of the IPAM.
        IpamId:
          type: string
          description: The ID of the IPAM.
        IpamArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IPAM.
        IpamRegion:
          type: string
          description: The Amazon Web Services Region of the IPAM.
        PublicDefaultScopeId:
          type: string
          description: The ID of the IPAM's default public scope.
        PrivateDefaultScopeId:
          type: string
          description: The ID of the IPAM's default private scope.
        ScopeCount:
          type: integer
          description: The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
        Description:
          type: string
          description: The description for the IPAM.
        OperatingRegions:
          type: array
          items:
            $ref: '#/components/schemas/IpamOperatingRegion'
          description: The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an 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.
        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.
        DefaultResourceDiscoveryId:
          type: string
          description: The IPAM's default resource discovery ID.
        DefaultResourceDiscoveryAssociationId:
          type: string
          description: The IPAM's default resource discovery association ID.
        ResourceDiscoveryAssociationCount:
          type: integer
          description: The IPAM's resource discovery association count.
        StateMessage:
          type: string
          description: The state message.
        Tier:
          type: string
          enum:
          - free
          - advanced
          description: IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
        EnablePrivateGua:
          type: boolean
          description: Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
        MeteredAccount:
          type: string
          enum:
          - ipam-owner
          - resource-owner
          description: 'A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide. Possible values: ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.'
    AddIpamOperatingRegion:
      type: object
      properties:
        RegionName:
          type: string
          description: The name of the operating Region.
    ModifyIpamResult:
      type: object
      properties:
        Ipam:
          $ref: '#/components/schemas/Ipam'
  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)