EC2 / Paginator / GetIpamAddressHistory

GetIpamAddressHistory#

class EC2.Paginator.GetIpamAddressHistory#

paginator = client.get_paginator('get_ipam_address_history')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from EC2.Client.get_ipam_address_history().

Request Syntax

response_iterator = paginator.paginate(
    DryRun=True|False,
    Cidr='string',
    IpamScopeId='string',
    VpcId='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

DryRun (boolean) – 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.
Cidr (string) –
[REQUIRED]

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.
IpamScopeId (string) –
[REQUIRED]

The ID of the IPAM scope that the CIDR is in.
VpcId (string) – The ID of the VPC you want your history records filtered by.
StartTime (datetime) – 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.
EndTime (datetime) – 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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'HistoryRecords': [
        {
            'ResourceOwnerId': 'string',
            'ResourceRegion': 'string',
            'ResourceType': 'eip'|'vpc'|'subnet'|'network-interface'|'instance',
            'ResourceId': 'string',
            'ResourceCidr': 'string',
            'ResourceName': 'string',
            'ResourceComplianceStatus': 'compliant'|'noncompliant'|'unmanaged'|'ignored',
            'ResourceOverlapStatus': 'overlapping'|'nonoverlapping'|'ignored',
            'VpcId': 'string',
            'SampledStartTime': datetime(2015, 1, 1),
            'SampledEndTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

(dict) –
- HistoryRecords (list) –
  
  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.
  - (dict) –
    
    The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.
    - ResourceOwnerId (string) –
      
      The ID of the resource owner.
    - ResourceRegion (string) –
      
      The Amazon Web Services Region of the resource.
    - ResourceType (string) –
      
      The type of the resource.
    - ResourceId (string) –
      
      The ID of the resource.
    - ResourceCidr (string) –
      
      The CIDR of the resource.
    - ResourceName (string) –
      
      The name of the resource.
    - ResourceComplianceStatus (string) –
      
      The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
    - ResourceOverlapStatus (string) –
      
      The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
    - VpcId (string) –
      
      The VPC ID of the resource.
    - SampledStartTime (datetime) –
      
      Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.
    - SampledEndTime (datetime) –
      
      Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.