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.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: BudgetTypeDef, # (1)
NotificationsWithSubscribers: Sequence[NotificationWithSubscribersTypeDef] = ..., # (2)
) -> Dict[str, Any]:
...
# create_budget method usage example with argument unpacking
kwargs: CreateBudgetRequestRequestTypeDef = { # (1)
"AccountId": ...,
"Budget": ...,
}
parent.create_budget(**kwargs)
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: DefinitionTypeDef, # (4)
ExecutionRoleArn: str,
ApprovalModel: ApprovalModelType, # (5)
Subscribers: Sequence[SubscriberTypeDef], # (6)
) -> CreateBudgetActionResponseTypeDef: # (7)
...
- See NotificationTypeType
- See ActionTypeType
- See ActionThresholdTypeDef
- See DefinitionTypeDef
- See ApprovalModelType
- See SubscriberTypeDef
- 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)
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]:
...
- See NotificationTypeDef
- See SubscriberTypeDef
# create_notification method usage example with argument unpacking
kwargs: CreateNotificationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
"Notification": ...,
"Subscribers": ...,
}
parent.create_notification(**kwargs)
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]:
...
- See NotificationTypeDef
- See SubscriberTypeDef
# create_subscriber method usage example with argument unpacking
kwargs: CreateSubscriberRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
"Notification": ...,
"Subscriber": ...,
}
parent.create_subscriber(**kwargs)
delete_budget#
Deletes a budget.
Type annotations and code completion for boto3.client("budgets").delete_budget
method.
boto3 documentation
# delete_budget method definition
def delete_budget(
self,
*,
AccountId: str,
BudgetName: str,
) -> Dict[str, Any]:
...
# delete_budget method usage example with argument unpacking
kwargs: DeleteBudgetRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
}
parent.delete_budget(**kwargs)
delete_budget_action#
Deletes a budget action.
Type annotations and code completion for boto3.client("budgets").delete_budget_action
method.
boto3 documentation
# delete_budget_action method definition
def delete_budget_action(
self,
*,
AccountId: str,
BudgetName: str,
ActionId: str,
) -> DeleteBudgetActionResponseTypeDef: # (1)
...
# delete_budget_action method usage example with argument unpacking
kwargs: DeleteBudgetActionRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
"ActionId": ...,
}
parent.delete_budget_action(**kwargs)
delete_notification#
Deletes a notification.
Type annotations and code completion for boto3.client("budgets").delete_notification
method.
boto3 documentation
# delete_notification method definition
def delete_notification(
self,
*,
AccountId: str,
BudgetName: str,
Notification: NotificationTypeDef, # (1)
) -> Dict[str, Any]:
...
# delete_notification method usage example with argument unpacking
kwargs: DeleteNotificationRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
"Notification": ...,
}
parent.delete_notification(**kwargs)
delete_subscriber#
Deletes a subscriber.
Type annotations and code completion for boto3.client("budgets").delete_subscriber
method.
boto3 documentation
# delete_subscriber method definition
def delete_subscriber(
self,
*,
AccountId: str,
BudgetName: str,
Notification: NotificationTypeDef, # (1)
Subscriber: SubscriberTypeDef, # (2)
) -> Dict[str, Any]:
...
- See NotificationTypeDef
- See SubscriberTypeDef
# delete_subscriber method usage example with argument unpacking
kwargs: DeleteSubscriberRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
"Notification": ...,
"Subscriber": ...,
}
parent.delete_subscriber(**kwargs)
describe_budget#
Describes a budget.
Type annotations and code completion for boto3.client("budgets").describe_budget
method.
boto3 documentation
# describe_budget method definition
def describe_budget(
self,
*,
AccountId: str,
BudgetName: str,
) -> DescribeBudgetResponseTypeDef: # (1)
...
# describe_budget method usage example with argument unpacking
kwargs: DescribeBudgetRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
}
parent.describe_budget(**kwargs)
describe_budget_action#
Describes a budget action detail.
Type annotations and code completion for boto3.client("budgets").describe_budget_action
method.
boto3 documentation
# describe_budget_action method definition
def describe_budget_action(
self,
*,
AccountId: str,
BudgetName: str,
ActionId: str,
) -> DescribeBudgetActionResponseTypeDef: # (1)
...
# describe_budget_action method usage example with argument unpacking
kwargs: DescribeBudgetActionRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
"ActionId": ...,
}
parent.describe_budget_action(**kwargs)
describe_budget_action_histories#
Describes a budget action history detail.
Type annotations and code completion for boto3.client("budgets").describe_budget_action_histories
method.
boto3 documentation
# describe_budget_action_histories method definition
def describe_budget_action_histories(
self,
*,
AccountId: str,
BudgetName: str,
ActionId: str,
TimePeriod: TimePeriodTypeDef = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeBudgetActionHistoriesResponseTypeDef: # (2)
...
# describe_budget_action_histories method usage example with argument unpacking
kwargs: DescribeBudgetActionHistoriesRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
"ActionId": ...,
}
parent.describe_budget_action_histories(**kwargs)
describe_budget_actions_for_account#
Describes all of the budget actions for an account.
Type annotations and code completion for boto3.client("budgets").describe_budget_actions_for_account
method.
boto3 documentation
# describe_budget_actions_for_account method definition
def describe_budget_actions_for_account(
self,
*,
AccountId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeBudgetActionsForAccountResponseTypeDef: # (1)
...
# describe_budget_actions_for_account method usage example with argument unpacking
kwargs: DescribeBudgetActionsForAccountRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.describe_budget_actions_for_account(**kwargs)
describe_budget_actions_for_budget#
Describes all of the budget actions for a budget.
Type annotations and code completion for boto3.client("budgets").describe_budget_actions_for_budget
method.
boto3 documentation
# describe_budget_actions_for_budget method definition
def describe_budget_actions_for_budget(
self,
*,
AccountId: str,
BudgetName: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeBudgetActionsForBudgetResponseTypeDef: # (1)
...
# describe_budget_actions_for_budget method usage example with argument unpacking
kwargs: DescribeBudgetActionsForBudgetRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
}
parent.describe_budget_actions_for_budget(**kwargs)
describe_budget_notifications_for_account#
Lists the budget names and notifications that are associated with an account.
Type annotations and code completion for boto3.client("budgets").describe_budget_notifications_for_account
method.
boto3 documentation
# describe_budget_notifications_for_account method definition
def describe_budget_notifications_for_account(
self,
*,
AccountId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeBudgetNotificationsForAccountResponseTypeDef: # (1)
...
# describe_budget_notifications_for_account method usage example with argument unpacking
kwargs: DescribeBudgetNotificationsForAccountRequestRequestTypeDef = { # (1)
"AccountId": ...,
}
parent.describe_budget_notifications_for_account(**kwargs)
describe_budget_performance_history#
Describes the history for DAILY
, MONTHLY
, and QUARTERLY
budgets.
Type annotations and code completion for boto3.client("budgets").describe_budget_performance_history
method.
boto3 documentation
# describe_budget_performance_history method definition
def describe_budget_performance_history(
self,
*,
AccountId: str,
BudgetName: str,
TimePeriod: TimePeriodTypeDef = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeBudgetPerformanceHistoryResponseTypeDef: # (2)
...
# describe_budget_performance_history method usage example with argument unpacking
kwargs: DescribeBudgetPerformanceHistoryRequestRequestTypeDef = { # (1)
"AccountId": ...,
"BudgetName": ...,
}
parent.describe_budget_performance_history(**kwargs)
describe_budgets#
Lists the budgets that are associated with an account.
Type annotations and code completion for boto3.client("budgets").describe_budgets
method.
boto3 documentation
# describe_budgets method definition
def describe_budgets(
self,
*,
AccountId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeBudgetsResponseTypeDef: # (1)
...
# describe_budgets method usage example with argument unpacking
kwargs: Des