Skip to content

get_ipam_address_history

Operation

get_ipam_address_history

get_ipam_address_history(request: GetIpamAddressHistoryInput | GetIpamAddressHistoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamAddressHistoryInputDict]) -> GetIpamAddressHistoryOutput

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.

Parameters:

Name Type Description Default
request GetIpamAddressHistoryInput | GetIpamAddressHistoryInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetIpamAddressHistoryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamAddressHistoryOutput

An instance of GetIpamAddressHistoryOutput.

get_ipam_address_history async

get_ipam_address_history(request: GetIpamAddressHistoryInput | GetIpamAddressHistoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamAddressHistoryInputDict]) -> GetIpamAddressHistoryOutput

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.

Parameters:

Name Type Description Default
request GetIpamAddressHistoryInput | GetIpamAddressHistoryInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetIpamAddressHistoryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamAddressHistoryOutput

An instance of GetIpamAddressHistoryOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetIpamAddressHistoryInputDict

Bases: TypedDict

Dictionary form of GetIpamAddressHistoryInput.

Attributes

cidr instance-attribute
cidr: Required[str]

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.

dry_run instance-attribute
dry_run: bool | None

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.

end_time instance-attribute
end_time: datetime | None

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.

ipam_scope_id instance-attribute
ipam_scope_id: Required[str]

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

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

The token for the next page of results.

start_time instance-attribute
start_time: datetime | None

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.

vpc_id instance-attribute
vpc_id: str | None

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

GetIpamAddressHistoryInput dataclass

Bases: _SerdeShape

Dataclass for GetIpamAddressHistoryInput structure.

Attributes

cidr class-attribute instance-attribute
cidr: str | None = ...

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.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

end_time class-attribute instance-attribute
end_time: datetime | None = ...

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.

ipam_scope_id class-attribute instance-attribute
ipam_scope_id: str | None = ...

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

max_results class-attribute instance-attribute
max_results: int | None = ...

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

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next page of results.

start_time class-attribute instance-attribute
start_time: datetime | None = ...

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.

vpc_id class-attribute instance-attribute
vpc_id: str | None = ...

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

Output

GetIpamAddressHistoryOutput dataclass

Bases: _SerdeShape

Dataclass for GetIpamAddressHistoryOutput structure.

Attributes

history_records class-attribute instance-attribute
history_records: list[IpamAddressHistoryRecord] | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.