delete_automation_rule ¶

delete_automation_rule(
    rule_arn: RuleArn,
    rule_revision: int,
    *,
    config_overrides: Optional[ComputeOptimizerAutomationClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> DeleteAutomationRuleResponse

Deletes an existing automation rule.

Parameters:

rule_arn (RuleArn) –

The ARN of the rule to delete.
rule_revision (int) –

The revision number of the rule to delete.
client_token (Optional[ClientToken], default: None ) –

A unique identifier to ensure idempotency of the request.

Raises:

AccessDeniedException –

You do not have sufficient permissions to perform this action.
ForbiddenException –

You are not authorized to perform this action.
IdempotencyTokenInUseException –

The specified client token is already in use.
IdempotentParameterMismatchException –

Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.
InternalServerException –

An internal error occurred while processing the request.
InvalidParameterValueException –

One or more parameter values are not valid.
OptInRequiredException –

The account must be opted in to Compute Optimizer Automation before performing this action.
ResourceNotFoundException –

The specified resource was not found.
ServiceUnavailableException –

The service is temporarily unavailable.
ThrottlingException –

The request was denied due to request throttling.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_compute_optimizer_automation/_services/compute_optimizer_automation.py

def delete_automation_rule(
    self,
    rule_arn: "capo_compute_optimizer_automation.types.rule_arn.RuleArn",
    rule_revision: int,
    *,
    config_overrides: Optional[ComputeOptimizerAutomationClientConfig] = None,
    client_token: Optional[
        "capo_compute_optimizer_automation.types.client_token.ClientToken"
    ] = None,
) -> "capo_compute_optimizer_automation.types.delete_automation_rule_response.DeleteAutomationRuleResponse":
    """<p> Deletes an existing automation rule. </p>

    Args:
        rule_arn: <p> The ARN of the rule to delete. </p>
        rule_revision: <p> The revision number of the rule to delete. </p>
        client_token: <p> A unique identifier to ensure idempotency of the request. </p>

    Raises:
        capo_compute_optimizer_automation.errors.access_denied_exception.AccessDeniedException: <p> You do not have sufficient permissions to perform this action. </p>
        capo_compute_optimizer_automation.errors.forbidden_exception.ForbiddenException: <p> You are not authorized to perform this action. </p>
        capo_compute_optimizer_automation.errors.idempotency_token_in_use_exception.IdempotencyTokenInUseException: <p> The specified client token is already in use. </p>
        capo_compute_optimizer_automation.errors.idempotent_parameter_mismatch_exception.IdempotentParameterMismatchException: <p>Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.</p>
        capo_compute_optimizer_automation.errors.internal_server_exception.InternalServerException: <p> An internal error occurred while processing the request. </p>
        capo_compute_optimizer_automation.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p> One or more parameter values are not valid. </p>
        capo_compute_optimizer_automation.errors.opt_in_required_exception.OptInRequiredException: <p> The account must be opted in to Compute Optimizer Automation before performing this action. </p>
        capo_compute_optimizer_automation.errors.resource_not_found_exception.ResourceNotFoundException: <p> The specified resource was not found. </p>
        capo_compute_optimizer_automation.errors.service_unavailable_exception.ServiceUnavailableException: <p> The service is temporarily unavailable. </p>
        capo_compute_optimizer_automation.errors.throttling_exception.ThrottlingException: <p> The request was denied due to request throttling. </p>
        capo_compute_optimizer_automation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_compute_optimizer_automation.types.delete_automation_rule_request.DeleteAutomationRuleRequest]",
    ) -> OperationResponse[
        "capo_compute_optimizer_automation.types.delete_automation_rule_response.DeleteAutomationRuleResponse"
    ]:
        import capo_compute_optimizer_automation._operations.compute_optimizer_automation_service.delete_automation_rule

        output, http_response = (
            capo_compute_optimizer_automation._operations.compute_optimizer_automation_service.delete_automation_rule.delete_automation_rule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteAutomationRule")
    )
    input_: capo_compute_optimizer_automation.types.delete_automation_rule_request.DeleteAutomationRuleRequest = {
        "rule_arn": rule_arn,
        "rule_revision": rule_revision,
    }
    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