mypy-boto3-budgets 1.20.35.post1

PyPI - Python Version
Docs
PyPI - Downloads

boto3.typed

Type annotations for
boto3.Budgets 1.20.35
service compatible with VSCode,
PyCharm,
Emacs,
Sublime Text,
mypy,
pyright and other tools.

Generated by
mypy-boto3-builder 6.3.2.

More information can be found on
boto3-stubs page and in
mypy-boto3-budgets docs

See how it helps to find and fix potential bugs:

boto3-stubs demo

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.

python -m pip install boto3-stubs[budgets]

Usage

VSCode

  • Install
    Python extension
  • Install
    Pylance extension
  • Set Pylance as your Python Language Server
  • Install boto-stubs[budgets] in your environment:
    python -m pip install 'boto3-stubs[budgets]'

Both type checking and auto-complete should work for Budgets service. No
explicit type annotations required, write your boto3 code as usual.

PyCharm

  • Install boto-stubs[budgets] in your environment:
    python -m pip install 'boto3-stubs[budgets]'

Both type checking and auto-complete should work for Budgets service. No
explicit type annotations required, write your boto3 code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
boto3-stubs submodules.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything
should work.

mypy

  • Install mypy: python -m pip install mypy
  • Install boto-stubs[budgets] in your environment:
    python -m pip install 'boto3-stubs[budgets]'
  • Run mypy as usual

Type checking should work for Budgets service. No explicit type annotations
required, write your boto3 code as usual.

pyright

  • Install pyright: yarn global add pyright
  • Install boto-stubs[budgets] in your environment:
    python -m pip install 'boto3-stubs[budgets]'
  • Optionally, you can install boto3-stubs to typings folder.

Type checking should work for Budgets service. No explicit type annotations
required, write your boto3 code as usual.

Explicit type annotations

Client annotations

BudgetsClient provides annotations for boto3.client("budgets").

import boto3

from mypy_boto3_budgets import BudgetsClient

client: BudgetsClient = boto3.client("budgets")

# now client usage is checked by mypy and IDE should provide code auto-complete

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: BudgetsClient = session.client("budgets")

Paginators annotations

mypy_boto3_budgets.paginator module contains type annotations for all
paginators.

from mypy_boto3_budgets import BudgetsClient
from mypy_boto3_budgets.paginator import (
    DescribeBudgetActionHistoriesPaginator,
    DescribeBudgetActionsForAccountPaginator,
    DescribeBudgetActionsForBudgetPaginator,
    DescribeBudgetPerformanceHistoryPaginator,
    DescribeBudgetsPaginator,
    DescribeNotificationsForBudgetPaginator,
    DescribeSubscribersForNotificationPaginator,
)

client: BudgetsClient = boto3.client("budgets")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_budget_action_histories_paginator: DescribeBudgetActionHistoriesPaginator = client.get_paginator("describe_budget_action_histories")
describe_budget_actions_for_account_paginator: DescribeBudgetActionsForAccountPaginator = client.get_paginator("describe_budget_actions_for_account")
describe_budget_actions_for_budget_paginator: DescribeBudgetActionsForBudgetPaginator = client.get_paginator("describe_budget_actions_for_budget")
describe_budget_performance_history_paginator: DescribeBudgetPerformanceHistoryPaginator = client.get_paginator("describe_budget_performance_history")
describe_budgets_paginator: DescribeBudgetsPaginator = client.get_paginator("describe_budgets")
describe_notifications_for_budget_paginator: DescribeNotificationsForBudgetPaginator = client.get_paginator("describe_notifications_for_budget")
describe_subscribers_for_notification_paginator: DescribeSubscribersForNotificationPaginator = client.get_paginator("describe_subscribers_for_notification")

Literals

mypy_boto3_budgets.literals module contains literals extracted from shapes
that can be used in user code for type checking.

from mypy_boto3_budgets.literals import (
    ActionStatusType,
    ActionSubTypeType,
    ActionTypeType,
    ApprovalModelType,
    BudgetTypeType,
    ComparisonOperatorType,
    DescribeBudgetActionHistoriesPaginatorName,
    DescribeBudgetActionsForAccountPaginatorName,
    DescribeBudgetActionsForBudgetPaginatorName,
    DescribeBudgetPerformanceHistoryPaginatorName,
    DescribeBudgetsPaginatorName,
    DescribeNotificationsForBudgetPaginatorName,
    DescribeSubscribersForNotificationPaginatorName,
    EventTypeType,
    ExecutionTypeType,
    NotificationStateType,
    NotificationTypeType,
    SubscriptionTypeType,
    ThresholdTypeType,
    TimeUnitType,
    ServiceName,
    PaginatorName,
)

def check_value(value: ActionStatusType) -> bool:
    ...

Typed dictionaries

mypy_boto3_budgets.type_defs module contains structures and shapes assembled
to typed dictionaries for additional type checking.

from mypy_boto3_budgets.type_defs import (
    ActionHistoryDetailsTypeDef,
    ActionHistoryTypeDef,
    ActionThresholdTypeDef,
    ActionTypeDef,
    BudgetPerformanceHistoryTypeDef,
    BudgetTypeDef,
    BudgetedAndActualAmountsTypeDef,
    CalculatedSpendTypeDef,
    CostTypesTypeDef,
    CreateBudgetActionRequestRequestTypeDef,
    CreateBudgetActionResponseTypeDef,
    CreateBudgetRequestRequestTypeDef,
    CreateNotificationRequestRequestTypeDef,
    CreateSubscriberRequestRequestTypeDef,
    DefinitionTypeDef,
    DeleteBudgetActionRequestRequestTypeDef,
    DeleteBudgetActionResponseTypeDef,
    DeleteBudgetRequestRequestTypeDef,
    DeleteNotificationRequestRequestTypeDef,
    DeleteSubscriberRequestRequestTypeDef,
    DescribeBudgetActionHistoriesRequestRequestTypeDef,
    DescribeBudgetActionHistoriesResponseTypeDef,
    DescribeBudgetActionRequestRequestTypeDef,
    DescribeBudgetActionResponseTypeDef,
    DescribeBudgetActionsForAccountRequestRequestTypeDef,
    DescribeBudgetActionsForAccountResponseTypeDef,
    DescribeBudgetActionsForBudgetRequestRequestTypeDef,
    DescribeBudgetActionsForBudgetResponseTypeDef,
    DescribeBudgetPerformanceHistoryRequestRequestTypeDef,
    DescribeBudgetPerformanceHistoryResponseTypeDef,
    DescribeBudgetRequestRequestTypeDef,
    DescribeBudgetResponseTypeDef,
    DescribeBudgetsRequestRequestTypeDef,
    DescribeBudgetsResponseTypeDef,
    DescribeNotificationsForBudgetRequestRequestTypeDef,
    DescribeNotificationsForBudgetResponseTypeDef,
    DescribeSubscribersForNotificationRequestRequestTypeDef,
    DescribeSubscribersForNotificationResponseTypeDef,
    ExecuteBudgetActionRequestRequestTypeDef,
    ExecuteBudgetActionResponseTypeDef,
    IamActionDefinitionTypeDef,
    NotificationTypeDef,
    NotificationWithSubscribersTypeDef,
    PaginatorConfigTypeDef,
    ResponseMetadataTypeDef,
    ScpActionDefinitionTypeDef,
    SpendTypeDef,
    SsmActionDefinitionTypeDef,
    SubscriberTypeDef,
    TimePeriodTypeDef,
    UpdateBudgetActionRequestRequestTypeDef,
    UpdateBudgetActionResponseTypeDef,
    UpdateBudgetRequestRequestTypeDef,
    UpdateNotificationRequestRequestTypeDef,
    UpdateSubscriberRequestRequestTypeDef,
)

def get_structure() -> ActionHistoryDetailsTypeDef:
    return {
      ...
    }

Versioning

mypy-boto3-budgets version is the same as related boto3 version and follows
PEP 440 format.

Documentation

All type annotations can be found in
mypy-boto3-budgets docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features
in mypy-boto3-builder
repository.

Related Posts

Comments

Stay Connected

21,935FansLike
2,507FollowersFollow
0SubscribersSubscribe

Recent Stories

Trois budgets pour ODW – CB News

Le 27 janvier 2022 à 20:16 ...

Household budgets face a good belt tightening as rising interest rates push up mortgage payments – Interest.co.nz

Many households will be in for an unpleasant economic shock over the next couple of years as the low interest rate party comes to...

Grand Valley Public Library budgets $329,702 for 2022 – Orangeville Banner

Grand Valley Public Library budgets $329,702 for 2022  Orangeville Ban

Smaller weddings, tighter budgets derail Kanchipuram's silk industry, eyes now on Budget 2022 – CNBCTV18

There's a noticeable absence of bustle on Kanchipuram's Gandhi Road, home to the town's famous Kanjeevaram silk houses. It doesn't matter that it's the...