EC2 / Client / get_ipam_prefix_list_resolver_versions

get_ipam_prefix_list_resolver_versions

EC2.Client.get_ipam_prefix_list_resolver_versions(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_ipam_prefix_list_resolver_versions(
    DryRun=True|False,
    IpamPrefixListResolverId='string',
    IpamPrefixListResolverVersions=[
        123,
    ],
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='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.

  • IpamPrefixListResolverId (string) –

    [REQUIRED]

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

  • IpamPrefixListResolverVersions (list) –

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

    • (integer) –

  • MaxResults (integer) – 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.

  • Filters (list) –

    One or more filters to limit the results.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

      If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

      For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

      • Name (string) –

        The name of the filter. Filter names are case-sensitive.

      • Values (list) –

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

        • (string) –

  • NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPrefixListResolverVersions': [
        {
            'Version': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • IpamPrefixListResolverVersions (list) –

      Information about the IPAM prefix list resolver versions.

      • (dict) –

        Describes a version of 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

        • Version (integer) –

          The version number of the 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.

    • NextToken (string) –

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