BudgetsClient

Index > Budgets > BudgetsClient

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

BudgetsClient

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

# BudgetsClient usage example

from boto3.session import Session
from mypy_boto3_budgets.client import BudgetsClient

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

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("budgets").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("budgets")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.CreationLimitExceededException,
    client.exceptions.DuplicateRecordException,
    client.exceptions.ExpiredNextTokenException,
    client.exceptions.InternalErrorException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidParameterException,
    client.exceptions.NotFoundException,
    client.exceptions.ResourceLockedException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_budgets.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("budgets").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("budgets").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_budget

Creates a budget and, if included, notifications and subscribers.

Type annotations and code completion for boto3.client("budgets").create_budget method. boto3 documentation

# create_budget method definition

def create_budget(
    self,
    *,
    AccountId: str,
    Budget: Union[BudgetTypeDef, BudgetExtraOutputTypeDef],  # (1)
    NotificationsWithSubscribers: Sequence[NotificationWithSubscribersTypeDef] = ...,  # (2)
    ResourceTags: Sequence[ResourceTagTypeDef] = ...,  # (3)
) -> Dict[str, Any]:
    ...

1. See BudgetTypeDef BudgetExtraOutputTypeDef
2. See NotificationWithSubscribersTypeDef
3. See ResourceTagTypeDef

# create_budget method usage example with argument unpacking

kwargs: CreateBudgetRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "Budget": ...,
}

parent.create_budget(**kwargs)

1. See CreateBudgetRequestRequestTypeDef

create_budget_action

Creates a budget action.

Type annotations and code completion for boto3.client("budgets").create_budget_action method. boto3 documentation

# create_budget_action method definition

def create_budget_action(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    NotificationType: NotificationTypeType,  # (1)
    ActionType: ActionTypeType,  # (2)
    ActionThreshold: ActionThresholdTypeDef,  # (3)
    Definition: Union[DefinitionTypeDef, DefinitionExtraOutputTypeDef],  # (4)
    ExecutionRoleArn: str,
    ApprovalModel: ApprovalModelType,  # (5)
    Subscribers: Sequence[SubscriberTypeDef],  # (6)
    ResourceTags: Sequence[ResourceTagTypeDef] = ...,  # (7)
) -> CreateBudgetActionResponseTypeDef:  # (8)
    ...

1. See NotificationTypeType
2. See ActionTypeType
3. See ActionThresholdTypeDef
4. See DefinitionTypeDef DefinitionExtraOutputTypeDef
5. See ApprovalModelType
6. See SubscriberTypeDef
7. See ResourceTagTypeDef
8. See CreateBudgetActionResponseTypeDef

# create_budget_action method usage example with argument unpacking

kwargs: CreateBudgetActionRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "NotificationType": ...,
    "ActionType": ...,
    "ActionThreshold": ...,
    "Definition": ...,
    "ExecutionRoleArn": ...,
    "ApprovalModel": ...,
    "Subscribers": ...,
}

parent.create_budget_action(**kwargs)

1. See CreateBudgetActionRequestRequestTypeDef

create_notification

Creates a notification.

Type annotations and code completion for boto3.client("budgets").create_notification method. boto3 documentation

# create_notification method definition

def create_notification(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
    Subscribers: Sequence[SubscriberTypeDef],  # (2)
) -> Dict[str, Any]:
    ...

1. See NotificationTypeDef
2. See SubscriberTypeDef

# create_notification method usage example with argument unpacking

kwargs: CreateNotificationRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "Notification": ...,
    "Subscribers": ...,
}

parent.create_notification(**kwargs)

1. See CreateNotificationRequestRequestTypeDef

create_subscriber

Creates a subscriber.

Type annotations and code completion for boto3.client("budgets").create_subscriber method. boto3 documentation

# create_subscriber method definition

def create_subscriber(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
    Subscriber: SubscriberTypeDef,  # (2)
) -> Dict[str, Any]:
    ...

1. See NotificationTypeDef
2. See SubscriberTypeDef

# create_subscriber method usage example with argument unpacking

kwargs: CreateSubscriberRequestRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "Notification": ...,
    "Subscriber": ...,
}

parent.create_subscriber(**kwargs)

1. See CreateSubscriberRequestRequestTypeDef

delete_budget

Deletes a budget.

Type annotations and code completion for boto3.client("budgets").delete_budget method.