Skip to content

modify_ipam_prefix_list_resolver

modify_ipam_prefix_list_resolver(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_prefix_list_resolver_id: Optional[IpamPrefixListResolverId] = None,
    description: Optional[String] = None,
    rules: Optional[IpamPrefixListResolverRuleRequestSet] = None,
) -> ModifyIpamPrefixListResolverResult

Modifies an IPAM prefix list resolver. You can update the description and CIDR selection rules. Changes to rules will trigger re-evaluation and potential updates to associated prefix lists.

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 to modify.

  • description (Optional[String], default: None ) –

    A new description for the IPAM prefix list resolver.

  • rules (Optional[IpamPrefixListResolverRuleRequestSet], default: None ) –

    The updated CIDR selection rules for the resolver. These rules replace the existing rules entirely.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def modify_ipam_prefix_list_resolver(
    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,
    description: Optional["capo_ec2.types.string.String"] = None,
    rules: Optional[
        "capo_ec2.types.ipam_prefix_list_resolver_rule_request_set.IpamPrefixListResolverRuleRequestSet"
    ] = None,
) -> "capo_ec2.types.modify_ipam_prefix_list_resolver_result.ModifyIpamPrefixListResolverResult":
    """<p>Modifies an IPAM prefix list resolver. You can update the description and CIDR selection rules. Changes to rules will trigger re-evaluation and potential updates to associated prefix lists.</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 to modify.</p>
        description: <p>A new description for the IPAM prefix list resolver.</p>
        rules: <p>The updated CIDR selection rules for the resolver. These rules replace the existing rules entirely.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.modify_ipam_prefix_list_resolver_request.ModifyIpamPrefixListResolverRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.modify_ipam_prefix_list_resolver_result.ModifyIpamPrefixListResolverResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_ipam_prefix_list_resolver

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyIpamPrefixListResolver")
    )
    input_: capo_ec2.types.modify_ipam_prefix_list_resolver_request.ModifyIpamPrefixListResolverRequest = {}
    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 description is not None:
        input_["description"] = description
    if rules is not None:
        input_["rules"] = rules

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