# GetIpamAddressHistory
<a name="API_GetIpamAddressHistory"></a>

Retrieve historical information about a CIDR within an IPAM scope. For more information, see [View the history of IP addresses](https://docs.aws.amazon.com/vpc/latest/ipam/view-history-cidr-ipam.html) in the *Amazon VPC IPAM User Guide*.

## Request Parameters
<a name="API_GetIpamAddressHistory_RequestParameters"></a>

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](CommonParameters.md).

 **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
<a name="API_GetIpamAddressHistory_ResponseElements"></a>

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](API_IpamAddressHistoryRecord.md) 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
<a name="API_GetIpamAddressHistory_Errors"></a>

For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also
<a name="API_GetIpamAddressHistory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamAddressHistory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamAddressHistory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamAddressHistory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamAddressHistory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamAddressHistory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamAddressHistory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamAddressHistory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamAddressHistory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamAddressHistory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamAddressHistory)