Skip to content

delete_budget async

delete_budget(
    account_id: AccountId,
    budget_name: BudgetName,
    *,
    config_overrides: Optional[AsyncBudgetsClientConfig] = None,
) -> DeleteBudgetResponse

Deletes a budget. You can delete your budget at any time.

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

Parameters:

  • account_id (AccountId) –

    The accountId that is associated with the budget that you want to delete.

  • budget_name (BudgetName) –

    The name of the budget that you want to delete.

Raises:

  • AccessDeniedException –

    You are not authorized to use this operation with the given parameters.

  • InternalErrorException –

    An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException –

    An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException –

    We can’t locate the resource that you specified.

  • ThrottlingException –

    The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

  • UnknownServiceError –

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

Source code in docs_src/capo_budgets/_services/async_budgets.py
async def delete_budget(
    self,
    account_id: "capo_budgets.types.account_id.AccountId",
    budget_name: "capo_budgets.types.budget_name.BudgetName",
    *,
    config_overrides: Optional[AsyncBudgetsClientConfig] = None,
) -> "capo_budgets.types.delete_budget_response.DeleteBudgetResponse":
    """<p>Deletes a budget. You can delete your budget at any time.</p> <important> <p>Deleting a budget also deletes the notifications and subscribers that are associated with that budget.</p> </important>

    Args:
        account_id: <p>The <code>accountId</code> that is associated with the budget that you want to delete.</p>
        budget_name: <p>The name of the budget that you want to delete.</p>

    Raises:
        capo_budgets.errors.access_denied_exception.AccessDeniedException: <p>You are not authorized to use this operation with the given parameters.</p>
        capo_budgets.errors.internal_error_exception.InternalErrorException: <p>An error on the server occurred during the processing of your request. Try again later.</p>
        capo_budgets.errors.invalid_parameter_exception.InvalidParameterException: <p>An error on the client occurred. Typically, the cause is an invalid input value.</p>
        capo_budgets.errors.not_found_exception.NotFoundException: <p>We can’t locate the resource that you specified.</p>
        capo_budgets.errors.throttling_exception.ThrottlingException: <p>The number of API requests has exceeded the maximum allowed API request throttling limit for the account.</p>
        capo_budgets.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_budgets.types.delete_budget_request.DeleteBudgetRequest]",
    ) -> AsyncOperationResponse[
        "capo_budgets.types.delete_budget_response.DeleteBudgetResponse"
    ]:
        import capo_budgets._operations.aws_budget_service_gateway.delete_budget

        (
            output,
            http_response,
        ) = await capo_budgets._operations.aws_budget_service_gateway.delete_budget.async_delete_budget(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteBudget")
    )
    input_: capo_budgets.types.delete_budget_request.DeleteBudgetRequest = {
        "account_id": account_id,
        "budget_name": budget_name,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output