GetIpamAddressHistory - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

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.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

Cidr

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.

Type: String

Required: Yes

DryRun

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.

Type: Boolean

Required: No

EndTime

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.

Type: Timestamp

Required: No

IpamScopeId

The ID of the IPAM scope that the CIDR is in.

Type: String

Required: Yes

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

The token for the next page of results.

Type: String

Required: No

StartTime

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.

Type: Timestamp

Required: No

VpcId

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

Type: String

Required: No

Response Elements

The following elements are returned by the service.

historyRecordSet

A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.

Type: Array of IpamAddressHistoryRecord objects

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: