Skip to content

get_ipam_prefix_list_resolver_version_entries

get_ipam_prefix_list_resolver_version_entries(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_prefix_list_resolver_id: Optional[IpamPrefixListResolverId] = None,
    ipam_prefix_list_resolver_version: Optional[Long] = None,
    max_results: Optional[IpamMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> GetIpamPrefixListResolverVersionEntriesResult

Retrieves the CIDR entries for a specific version of an IPAM prefix list resolver. This shows the actual CIDRs that were selected and synchronized at a particular point in time.

Parameters:

  • dry_run (Optional[Boolean], default: 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.

  • ipam_prefix_list_resolver_id (Optional[IpamPrefixListResolverId], default: None ) –

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

  • ipam_prefix_list_resolver_version (Optional[Long], default: None ) –

    The version number of the resolver for which to retrieve CIDR entries. If not specified, the latest version is used.

  • max_results (Optional[IpamMaxResults], default: 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 (Optional[NextToken], default: None ) –

    The token for the next page of results.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def get_ipam_prefix_list_resolver_version_entries(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_prefix_list_resolver_id: Optional[
        "capo_ec2.types.ipam_prefix_list_resolver_id.IpamPrefixListResolverId"
    ] = None,
    ipam_prefix_list_resolver_version: Optional["capo_ec2.types.long.Long"] = None,
    max_results: Optional["capo_ec2.types.ipam_max_results.IpamMaxResults"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
) -> "capo_ec2.types.get_ipam_prefix_list_resolver_version_entries_result.GetIpamPrefixListResolverVersionEntriesResult":
    """<p>Retrieves the CIDR entries for a specific version of an IPAM prefix list resolver. This shows the actual CIDRs that were selected and synchronized at a particular point in time.</p>

    Args:
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        ipam_prefix_list_resolver_id: <p>The ID of the IPAM prefix list resolver whose version entries you want to retrieve.</p>
        ipam_prefix_list_resolver_version: <p>The version number of the resolver for which to retrieve CIDR entries. If not specified, the latest version is used.</p>
        max_results: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
        next_token: <p>The token for the next page of results.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.get_ipam_prefix_list_resolver_version_entries_request.GetIpamPrefixListResolverVersionEntriesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_ipam_prefix_list_resolver_version_entries_result.GetIpamPrefixListResolverVersionEntriesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_ipam_prefix_list_resolver_version_entries

        output, http_response = (
            capo_ec2._operations.amazon_ec2.get_ipam_prefix_list_resolver_version_entries.get_ipam_prefix_list_resolver_version_entries(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetIpamPrefixListResolverVersionEntries"),
    )
    input_: capo_ec2.types.get_ipam_prefix_list_resolver_version_entries_request.GetIpamPrefixListResolverVersionEntriesRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_prefix_list_resolver_id is not None:
        input_["ipam_prefix_list_resolver_id"] = ipam_prefix_list_resolver_id
    if ipam_prefix_list_resolver_version is not None:
        input_["ipam_prefix_list_resolver_version"] = (
            ipam_prefix_list_resolver_version
        )
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output