Amazon EC2 Ec2 Ipam Resource Discovery API
The Ec2 Ipam Resource Discovery API from Amazon EC2 — 6 operation(s) for ec2 ipam resource discovery.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-ec2:amazon-ec2-ipam-resource-discovery-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.
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 Resource Discovery API
version: '2016-11-15'
description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 6 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 Resource Discovery
paths:
/?Action=AssociateIpamResourceDiscovery:
post:
operationId: AssociateIpamResourceDiscovery
summary: Associate Ipam Resource Discovery
description: Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AssociateIpamResourceDiscoveryResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: AssociateIpamResourceDiscovery
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/AssociateIpamResourceDiscoveryRequest'
tags:
- Ipam Resource Discovery
/?Action=CreateIpamResourceDiscovery:
post:
operationId: CreateIpamResourceDiscovery
summary: Create Ipam Resource Discovery
description: Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateIpamResourceDiscoveryResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: CreateIpamResourceDiscovery
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/CreateIpamResourceDiscoveryRequest'
tags:
- Ipam Resource Discovery
/?Action=DeleteIpamResourceDiscovery:
post:
operationId: DeleteIpamResourceDiscovery
summary: Delete Ipam Resource Discovery
description: Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteIpamResourceDiscoveryResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DeleteIpamResourceDiscovery
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/DeleteIpamResourceDiscoveryRequest'
tags:
- Ipam Resource Discovery
/?Action=DescribeIpamResourceDiscoveries:
post:
operationId: DescribeIpamResourceDiscoveries
summary: Describe Ipam Resource Discoveries
description: Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamResourceDiscoveriesResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DescribeIpamResourceDiscoveries
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/DescribeIpamResourceDiscoveriesRequest'
tags:
- Ipam Resource Discovery
/?Action=DisassociateIpamResourceDiscovery:
post:
operationId: DisassociateIpamResourceDiscovery
summary: Disassociate Ipam Resource Discovery
description: Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateIpamResourceDiscoveryResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DisassociateIpamResourceDiscovery
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/DisassociateIpamResourceDiscoveryRequest'
tags:
- Ipam Resource Discovery
/?Action=ModifyIpamResourceDiscovery:
post:
operationId: ModifyIpamResourceDiscovery
summary: Modify Ipam Resource Discovery
description: Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyIpamResourceDiscoveryResult'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: ModifyIpamResourceDiscovery
Version:
type: string
const: '2016-11-15'
- $ref: '#/components/schemas/ModifyIpamResourceDiscoveryRequest'
tags:
- Ipam Resource Discovery
components:
schemas:
IpamResourceDiscovery:
type: object
properties:
OwnerId:
type: string
description: The ID of the owner.
IpamResourceDiscoveryId:
type: string
description: The resource discovery ID.
IpamResourceDiscoveryArn:
type: string
description: The resource discovery Amazon Resource Name (ARN).
IpamResourceDiscoveryRegion:
type: string
description: The resource discovery Region.
Description:
type: string
description: The resource discovery description.
OperatingRegions:
type: array
items:
$ref: '#/components/schemas/IpamOperatingRegion'
description: The operating Regions for the resource discovery. 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.
IsDefault:
type: boolean
description: Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
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 lifecycle state of the resource discovery. create-in-progress - Resource discovery is being created. create-complete - Resource discovery creation is complete. create-failed - Resource discovery creation has failed. modify-in-progress - Resource discovery is being modified. modify-complete - Resource discovery modification is complete. modify-failed - Resource discovery modification has failed. delete-in-progress - Resource discovery is being deleted. delete-complete - Resource discovery deletion is complete. delete-failed - Resource discovery deletion has failed. isolate-in-progress - Ama
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
OrganizationalUnitExclusions:
type: array
items:
$ref: '#/components/schemas/IpamOrganizationalUnitExclusion'
description: If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
AddIpamOrganizationalUnitExclusion:
type: object
properties:
OrganizationsEntityPath:
type: string
description: 'An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a /. Include all child OUs by ending the path with /*. Example 1 Path to a child OU: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/ In this example, o-a1b2c3d4e5 is the organization ID, r-f6g7h8i9j0example is the root ID , ou-ghi0-awsccccc is an OU ID, and ou-jkl0-awsddddd is a child OU ID. IPAM will not manage the IP addresses in accounts in the child OU. Example 2 Path where all child OUs will be part of the exclusion: o-a1b2c3d4e5/r-f6g'
DescribeIpamResourceDiscoveriesRequest:
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.
IpamResourceDiscoveryIds:
type: array
items:
type: string
description: The IPAM resource discovery IDs.
NextToken:
type: string
description: The token for the next page of results.
MaxResults:
type: integer
description: The maximum number of resource discoveries to return in one page of results.
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: The resource discovery filters.
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.
AddIpamOperatingRegion:
type: object
properties:
RegionName:
type: string
description: The name of the operating Region.
AssociateIpamResourceDiscoveryRequest:
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: An IPAM ID.
IpamResourceDiscoveryId:
type: string
description: A resource discovery ID.
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: Tag specifications.
ClientToken:
type: string
description: A client token.
required:
- IpamId
- IpamResourceDiscoveryId
DisassociateIpamResourceDiscoveryRequest:
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.
IpamResourceDiscoveryAssociationId:
type: string
description: A resource discovery association ID.
required:
- IpamResourceDiscoveryAssociationId
DescribeIpamResourceDiscoveriesResult:
type: object
properties:
IpamResourceDiscoveries:
type: array
items:
$ref: '#/components/schemas/IpamResourceDiscovery'
description: The resource discoveries.
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.
CreateIpamResourceDiscoveryResult:
type: object
properties:
IpamResourceDiscovery:
$ref: '#/components/schemas/IpamResourceDiscovery'
ModifyIpamResourceDiscoveryResult:
type: object
properties:
IpamResourceDiscovery:
$ref: '#/components/schemas/IpamResourceDiscovery'
IpamOrganizationalUnitExclusion:
type: object
properties:
OrganizationsEntityPath:
type: string
description: An Amazon Web Services Organizations entity path. For more information on the entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.
ModifyIpamResourceDiscoveryRequest:
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.
IpamResourceDiscoveryId:
type: string
description: A resource discovery ID.
Description:
type: string
description: A resource discovery description.
AddOperatingRegions:
type: array
items:
$ref: '#/components/schemas/AddIpamOperatingRegion'
description: Add operating Regions to the resource discovery. 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.
RemoveOperatingRegions:
type: array
items:
$ref: '#/components/schemas/RemoveIpamOperatingRegion'
description: Remove operating Regions.
AddOrganizationalUnitExclusions:
type: array
items:
$ref: '#/components/schemas/AddIpamOrganizationalUnitExclusion'
description: 'Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide. The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process in '
RemoveOrganizationalUnitExclusions:
type: array
items:
$ref: '#/components/schemas/RemoveIpamOrganizationalUnitExclusion'
description: 'Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide. The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process '
required:
- IpamResourceDiscoveryId
IpamOperatingRegion:
type: object
properties:
RegionName:
type: string
description: The name of the operating Region.
IpamResourceDiscoveryAssociation:
type: object
properties:
OwnerId:
type: string
description: The Amazon Web Services account ID of the resource discovery owner.
IpamResourceDiscoveryAssociationId:
type: string
description: The resource discovery association ID.
IpamResourceDiscoveryAssociationArn:
type: string
description: The resource discovery association Amazon Resource Name (ARN).
IpamResourceDiscoveryId:
type: string
description: The resource discovery ID.
IpamId:
type: string
description: The IPAM ID.
IpamArn:
type: string
description: The IPAM ARN.
IpamRegion:
type: string
description: The IPAM home Region.
IsDefault:
type: boolean
description: Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.
ResourceDiscoveryStatus:
type: string
enum:
- active
- not-found
description: The resource discovery status. active - Connection or permissions required to read the results of the resource discovery are intact. not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact.
State:
type: string
enum:
- associate-in-progress
- associate-complete
- associate-failed
- disassociate-in-progress
- disassociate-complete
- disassociate-failed
- isolate-in-progress
- isolate-complete
- restore-in-progress
description: The lifecycle state of the association when you associate or disassociate a resource discovery. associate-in-progress - Resource discovery is being associated. associate-complete - Resource discovery association is complete. associate-failed - Resource discovery association has failed. disassociate-in-progress - Resource discovery is being disassociated. disassociate-complete - Resource discovery disassociation is complete. disassociate-failed - Resource discovery disassociation has failed. isolate-in-progress - Amazon Web Services account that created the resource discovery association has be
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
RemoveIpamOrganizationalUnitExclusion:
type: object
properties:
OrganizationsEntityPath:
type: string
description: 'An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a /. Include all child OUs by ending the path with /*. Example 1 Path to a child OU: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/ In this example, o-a1b2c3d4e5 is the organization ID, r-f6g7h8i9j0example is the root ID , ou-ghi0-awsccccc is an OU ID, and ou-jkl0-awsddddd is a child OU ID. IPAM will not manage the IP addresses in accounts in the child OU. Example 2 Path where all child OUs will be part of the exclusion: o-a1b2c3d4e5/r-f6g'
DeleteIpamResourceDiscoveryResult:
type: object
properties:
IpamResourceDiscovery:
$ref: '#/components/schemas/IpamResourceDiscovery'
DisassociateIpamResourceDiscoveryResult:
type: object
properties:
IpamResourceDiscoveryAssociation:
$ref: '#/components/schemas/IpamResourceDiscoveryAssociation'
RemoveIpamOperatingRegion:
type: object
properties:
RegionName:
type: string
description: The name of the operating Region you want to remove.
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.
DeleteIpamResourceDiscoveryRequest:
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.
IpamResourceDiscoveryId:
type: string
description: The IPAM resource discovery ID.
required:
- IpamResourceDiscoveryId
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.'
CreateIpamResourceDiscoveryRequest:
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 resource discovery.
OperatingRegions:
type: array
items:
$ref: '#/components/schemas/AddIpamOperatingRegion'
description: Operating Regions for the IPAM resource discovery. 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.
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: Tag specifications for the IPAM resource discovery.
ClientToken:
type: string
description: A client token for the IPAM resource discovery.
AssociateIpamResourceDiscoveryResult:
type: object
properties:
IpamResourceDiscoveryAssociation:
$ref: '#/components/schemas/IpamResourceDiscoveryAssociation'
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)