GET /#Action=GetIpamAddressHistory

Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

Servers

Request headers

Name Type Required Description
X-Amz-Content-Sha256 String No
X-Amz-Credential String No
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"
EndTime String No

The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.

MaxResults Integer No

The maximum number of historical results you would like returned per page. Defaults to 100.

StartTime String No

The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.

Cidr String Yes

The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.

VpcId String No

The ID of the VPC you want your history records filtered by.

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 IPAM scope that the CIDR is in.

Action String Yes

Possible values:

  • "GetIpamAddressHistory"

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.