Skip to content

delete_rule

delete_rule(
    *,
    config_overrides: Optional[ElasticLoadBalancingv2ClientConfig] = None,
    rule_arn: Optional[RuleArn] = None,
) -> DeleteRuleOutput

Deletes the specified rule.

You can't delete the default rule.

Parameters:

  • rule_arn (Optional[RuleArn], default: None ) –

    The Amazon Resource Name (ARN) of the rule.

Raises:

Examples:

To delete a rule This example deletes the specified rule.

>>> client.delete_rule(rule_arn='arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3')
Source code in docs_src/capo_elastic_load_balancing_v2/_services/elastic_load_balancingv2.py
def delete_rule(
    self,
    *,
    config_overrides: Optional[ElasticLoadBalancingv2ClientConfig] = None,
    rule_arn: Optional[
        "capo_elastic_load_balancing_v2.types.rule_arn.RuleArn"
    ] = None,
) -> "capo_elastic_load_balancing_v2.types.delete_rule_output.DeleteRuleOutput":
    """<p>Deletes the specified rule.</p> <p>You can't delete the default rule.</p>

    Args:
        rule_arn: <p>The Amazon Resource Name (ARN) of the rule.</p>

    Raises:
        capo_elastic_load_balancing_v2.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>This operation is not allowed.</p>
        capo_elastic_load_balancing_v2.errors.rule_not_found_exception.RuleNotFoundException: <p>The specified rule does not exist.</p>
        capo_elastic_load_balancing_v2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To delete a rule
        This example deletes the specified rule.

        >>> client.delete_rule(rule_arn='arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3')
    """

    def _handler(
        req: "OperationRequest[capo_elastic_load_balancing_v2.types.delete_rule_input.DeleteRuleInput]",
    ) -> OperationResponse[
        "capo_elastic_load_balancing_v2.types.delete_rule_output.DeleteRuleOutput"
    ]:
        import capo_elastic_load_balancing_v2._operations.elastic_load_balancing_v10.delete_rule

        output, http_response = (
            capo_elastic_load_balancing_v2._operations.elastic_load_balancing_v10.delete_rule.delete_rule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRule")
    )
    input_: capo_elastic_load_balancing_v2.types.delete_rule_input.DeleteRuleInput = {}
    if rule_arn is not None:
        input_["rule_arn"] = rule_arn

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