Skip to content

Budgets module#

Index > Budgets

Auto-generated documentation for Budgets type annotations stubs module mypy-boto3-budgets.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Budgets.

From PyPI with pip#

Install boto3-stubs for Budgets service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[budgets]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[budgets]'


# standalone installation
python -m pip install mypy-boto3-budgets

How to uninstall#

python -m pip uninstall -y mypy-boto3-budgets

Usage#

Code samples can be found in Examples.

BudgetsClient#

Type annotations and code completion for boto3.client("budgets") as BudgetsClient boto3 documentation

# BudgetsClient usage example

from boto3.session import Session

from mypy_boto3_budgets.client import BudgetsClient

def get_client() -> BudgetsClient:
    return Session().client("budgets")

Paginators#

Type annotations and code completion for paginators from boto3.client("budgets").get_paginator("...").

# DescribeBudgetActionHistoriesPaginator usage example

from boto3.session import Session

from mypy_boto3_budgets.paginator import DescribeBudgetActionHistoriesPaginator

def get_describe_budget_action_histories_paginator() -> DescribeBudgetActionHistoriesPaginator:
    return Session().client("budgets").get_paginator("describe_budget_action_histories"))

Literals#

Type annotations for literals used in methods and schemas.

# ActionStatusType usage example

from mypy_boto3_budgets.literals import ActionStatusType

def get_value() -> ActionStatusType:
    return "EXECUTION_FAILURE"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ActionThresholdTypeDef usage example

from mypy_boto3_budgets.type_defs import ActionThresholdTypeDef

def get_value() -> ActionThresholdTypeDef:
    return {
        "ActionThresholdValue": ...,
        "ActionThresholdType": ...,
    }