Skip to content

delete_ipam_routing_policy_registration

delete_ipam_routing_policy_registration(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_internet_registry_association_id: Optional[
        IpamInternetRegistryAssociationId
    ] = None,
    cidr: Optional[String] = None,
    force: Optional[BoxedBoolean] = None,
    client_token: Optional[String] = None,
) -> DeleteIpamRoutingPolicyRegistrationResult

Deletes a routing policy registration for a specified CIDR prefix.

Parameters:

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the operation, 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_internet_registry_association_id (Optional[IpamInternetRegistryAssociationId], default: None ) –

    The ID of the IPAM internet registry association.

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

    The IP address prefix in CIDR notation identifying the routing policy registration to delete.

  • force (Optional[BoxedBoolean], default: None ) –

    Forces the deletion even if it conflicts with an announced route. Default: false.

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

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def delete_ipam_routing_policy_registration(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_internet_registry_association_id: Optional[
        "capo_ec2.types.ipam_internet_registry_association_id.IpamInternetRegistryAssociationId"
    ] = None,
    cidr: Optional["capo_ec2.types.string.String"] = None,
    force: Optional["capo_ec2.types.boxed_boolean.BoxedBoolean"] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.delete_ipam_routing_policy_registration_result.DeleteIpamRoutingPolicyRegistrationResult":
    """<p>Deletes a routing policy registration for a specified CIDR prefix.</p>

    Args:
        dry_run: <p>Checks whether you have the required permissions for the operation, 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_internet_registry_association_id: <p>The ID of the IPAM internet registry association.</p>
        cidr: <p>The IP address prefix in CIDR notation identifying the routing policy registration to delete.</p>
        force: <p>Forces the deletion even if it conflicts with an announced route. Default: <code>false</code>.</p>
        client_token: <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation ignores the request, but does not return an error.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.delete_ipam_routing_policy_registration_request.DeleteIpamRoutingPolicyRegistrationRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_ipam_routing_policy_registration_result.DeleteIpamRoutingPolicyRegistrationResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_ipam_routing_policy_registration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIpamRoutingPolicyRegistration")
    )
    input_: capo_ec2.types.delete_ipam_routing_policy_registration_request.DeleteIpamRoutingPolicyRegistrationRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_internet_registry_association_id is not None:
        input_["ipam_internet_registry_association_id"] = (
            ipam_internet_registry_association_id
        )
    if cidr is not None:
        input_["cidr"] = cidr
    if force is not None:
        input_["force"] = force
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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