Examples

Index > Budgets > Examples

Auto-generated documentation for Budgets type annotations stubs module types-aiobotocore-budgets.

Client

Implicit type annotations

Can be used with types-aioboto3[budgets] package installed.

Write your Budgets code as usual, type checking and code completion should work out of the box.

# BudgetsClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("budgets") as client:  # (1)
    result = await client.create_budget_action()  # (2)

1. client: BudgetsClient
2. result: CreateBudgetActionResponseTypeDef

# DescribeBudgetActionHistoriesPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("budgets") as client:  # (1)
    paginator = client.get_paginator("describe_budget_action_histories")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: BudgetsClient
2. paginator: DescribeBudgetActionHistoriesPaginator
3. item: DescribeBudgetActionHistoriesResponsePaginatorTypeDef

Explicit type annotations

With types-aioboto3-lite[budgets] or a standalone types_aiobotocore_budgets package, you have to explicitly specify client: BudgetsClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# BudgetsClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_budgets.client import BudgetsClient
from types_aiobotocore_budgets.type_defs import CreateBudgetActionResponseTypeDef
from types_aiobotocore_budgets.type_defs import CreateBudgetActionRequestRequestTypeDef


session = Session()

client: BudgetsClient
async with session.client("budgets") as client:  # (1)
    kwargs: CreateBudgetActionRequestRequestTypeDef = {...}  # (2)
    result: CreateBudgetActionResponseTypeDef = await client.create_budget_action(**kwargs)  # (3)

1. client: BudgetsClient
2. kwargs: CreateBudgetActionRequestRequestTypeDef
3. result: CreateBudgetActionResponseTypeDef

# DescribeBudgetActionHistoriesPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_budgets.client import BudgetsClient
from types_aiobotocore_budgets.paginator import DescribeBudgetActionHistoriesPaginator
from types_aiobotocore_budgets.type_defs import DescribeBudgetActionHistoriesResponsePaginatorTypeDef


session = Session()

client: BudgetsClient
async with session.client("budgets") as client:  # (1)
    paginator: DescribeBudgetActionHistoriesPaginator = client.get_paginator("describe_budget_action_histories")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeBudgetActionHistoriesResponsePaginatorTypeDef
        print(item)  # (3)

1. client: BudgetsClient
2. paginator: DescribeBudgetActionHistoriesPaginator
3. item: DescribeBudgetActionHistoriesResponsePaginatorTypeDef