POST /#Action=GetIpamResourceCidrs

Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Servers

Request headers

Name Type Required Description
X-Amz-Content-Sha256 String No
X-Amz-Credential String No
Content-Type String Yes The media type of the request body.

Default value: "text/xml"

X-Amz-Date String No
X-Amz-Algorithm String No
X-Amz-SignedHeaders String No
X-Amz-Security-Token String No
X-Amz-Signature String No

Query parameters

Name Type Required Description
Version String Yes

Possible values:

  • "2016-11-15"
MaxResults String No

Pagination limit

NextToken String No

Pagination token

Action String Yes

Possible values:

  • "GetIpamResourceCidrs"

Request body fields

Name Type Required Description
IpamPoolId String No

The ID of the IPAM pool that the resource is in.

MaxResults Integer No

The maximum number of results to return in the request.

ResourceId String No

The ID of the resource.

ResourceOwner String No

The ID of the Amazon Web Services account that owns the resource.

Filters[] Array No

One or more filters for the request. For more information about filtering, see Filtering CLI output.

NextToken String No

The token for the next page of results.

DryRun Boolean No

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 String Yes

The ID of the scope that the resource is in.

ResourceType String No

The resource type.

Possible values:

  • "ipv6-pool"
  • "eip"
  • "public-ipv4-pool"
  • "subnet"
  • "vpc"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.