Skip to content

get_ipam_prefix_list_resolver_versions

Operation

get_ipam_prefix_list_resolver_versions

get_ipam_prefix_list_resolver_versions(request: GetIpamPrefixListResolverVersionsInput | GetIpamPrefixListResolverVersionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamPrefixListResolverVersionsInputDict]) -> GetIpamPrefixListResolverVersionsOutput

Retrieves version information for an IPAM prefix list resolver.

Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.

Version example:

Initial State (Version 1)

Production environment:

  • vpc-prod-web (10.1.0.0/16) - tagged env=prod

  • vpc-prod-db (10.2.0.0/16) - tagged env=prod

Resolver rule: Include all VPCs tagged env=prod

Version 1 CIDRs: 10.1.0.0/16, 10.2.0.0/16

Infrastructure Change (Version 2)

New VPC added:

  • vpc-prod-api (10.3.0.0/16) - tagged env=prod

IPAM automatically detects the change and creates a new version.

Version 2 CIDRs: 10.1.0.0/16, 10.2.0.0/16, 10.3.0.0/16

Parameters:

Name Type Description Default
request GetIpamPrefixListResolverVersionsInput | GetIpamPrefixListResolverVersionsInputDict | 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[GetIpamPrefixListResolverVersionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamPrefixListResolverVersionsOutput

An instance of GetIpamPrefixListResolverVersionsOutput.

get_ipam_prefix_list_resolver_versions async

get_ipam_prefix_list_resolver_versions(request: GetIpamPrefixListResolverVersionsInput | GetIpamPrefixListResolverVersionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamPrefixListResolverVersionsInputDict]) -> GetIpamPrefixListResolverVersionsOutput

Retrieves version information for an IPAM prefix list resolver.

Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.

Version example:

Initial State (Version 1)

Production environment:

  • vpc-prod-web (10.1.0.0/16) - tagged env=prod

  • vpc-prod-db (10.2.0.0/16) - tagged env=prod

Resolver rule: Include all VPCs tagged env=prod

Version 1 CIDRs: 10.1.0.0/16, 10.2.0.0/16

Infrastructure Change (Version 2)

New VPC added:

  • vpc-prod-api (10.3.0.0/16) - tagged env=prod

IPAM automatically detects the change and creates a new version.

Version 2 CIDRs: 10.1.0.0/16, 10.2.0.0/16, 10.3.0.0/16

Parameters:

Name Type Description Default
request GetIpamPrefixListResolverVersionsInput | GetIpamPrefixListResolverVersionsInputDict | 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[GetIpamPrefixListResolverVersionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamPrefixListResolverVersionsOutput

An instance of GetIpamPrefixListResolverVersionsOutput.

Input

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

GetIpamPrefixListResolverVersionsInputDict

Bases: TypedDict

Dictionary form of GetIpamPrefixListResolverVersionsInput.

Attributes

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

One or more filters to limit the results.

ipam_prefix_list_resolver_id instance-attribute
ipam_prefix_list_resolver_id: Required[str]

The ID of the IPAM prefix list resolver whose versions you want to retrieve.

ipam_prefix_list_resolver_versions instance-attribute
ipam_prefix_list_resolver_versions: Sequence[int] | None

Specific version numbers to retrieve. If not specified, all versions are returned.

max_results instance-attribute
max_results: int | None

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

GetIpamPrefixListResolverVersionsInput dataclass

Bases: _SerdeShape

Dataclass for GetIpamPrefixListResolverVersionsInput structure.

Attributes

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

One or more filters to limit the results.

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

The ID of the IPAM prefix list resolver whose versions you want to retrieve.

ipam_prefix_list_resolver_versions class-attribute instance-attribute
ipam_prefix_list_resolver_versions: list[int] | None = ...

Specific version numbers to retrieve. If not specified, all versions are returned.

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

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

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

The token for the next page of results.

Output

GetIpamPrefixListResolverVersionsOutput dataclass

Bases: _SerdeShape

Dataclass for GetIpamPrefixListResolverVersionsOutput structure.

Attributes

ipam_prefix_list_resolver_versions class-attribute instance-attribute
ipam_prefix_list_resolver_versions: list[IpamPrefixListResolverVersion] | None = ...

Information about the IPAM prefix list resolver versions.

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.