Skip to content

BudgetsClient#

Index > Budgets > BudgetsClient

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

BudgetsClient#

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

# BudgetsClient usage example

from boto3.session import Session
from types_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.BillingViewHealthStatusException,
    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 types_boto3_budgets.client import Exceptions

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

Methods#

can_paginate#

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:
    ...

generate_presigned_url#

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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: BudgetUnionTypeDef,  # (1)
    NotificationsWithSubscribers: Sequence[NotificationWithSubscribersTypeDef] = ...,  # (2)
    ResourceTags: Sequence[ResourceTagTypeDef] = ...,  # (3)
) -> Dict[str, Any]:
    ...
  1. See BudgetUnionTypeDef
  2. See Sequence[NotificationWithSubscribersTypeDef]
  3. See Sequence[ResourceTagTypeDef]
# create_budget method usage example with argument unpacking

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

parent.create_budget(**kwargs)
  1. See CreateBudgetRequestTypeDef

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: DefinitionUnionTypeDef,  # (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 DefinitionUnionTypeDef
  5. See ApprovalModelType
  6. See Sequence[SubscriberTypeDef]
  7. See Sequence[ResourceTagTypeDef]
  8. See CreateBudgetActionResponseTypeDef
# create_budget_action method usage example with argument unpacking

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

parent.create_budget_action(**kwargs)
  1. See CreateBudgetActionRequestTypeDef

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 Sequence[SubscriberTypeDef]
# create_notification method usage example with argument unpacking

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

parent.create_notification(**kwargs)
  1. See CreateNotificationRequestTypeDef

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: CreateSubscriberRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "Notification": ...,
    "Subscriber": ...,
}

parent.create_subscriber(**kwargs)
  1. See CreateSubscriberRequestTypeDef

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: DeleteBudgetRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
}

parent.delete_budget(**kwargs)
  1. See DeleteBudgetRequestTypeDef

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)
    ...
  1. See DeleteBudgetActionResponseTypeDef
# delete_budget_action method usage example with argument unpacking

kwargs: DeleteBudgetActionRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "ActionId": ...,
}

parent.delete_budget_action(**kwargs)
  1. See DeleteBudgetActionRequestTypeDef

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]:
    ...
  1. See NotificationTypeDef
# delete_notification method usage example with argument unpacking

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

parent.delete_notification(**kwargs)
  1. See DeleteNotificationRequestTypeDef

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]:
    ...
  1. See NotificationTypeDef
  2. See SubscriberTypeDef
# delete_subscriber method usage example with argument unpacking

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

parent.delete_subscriber(**kwargs)
  1. See DeleteSubscriberRequestTypeDef

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,
    ShowFilterExpression: bool = ...,
) -> DescribeBudgetResponseTypeDef:  # (1)
    ...
  1. See DescribeBudgetResponseTypeDef
# describe_budget method usage example with argument unpacking

kwargs: DescribeBudgetRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
}

parent.describe_budget(**kwargs)
  1. See DescribeBudgetRequestTypeDef

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)
    ...
  1. See DescribeBudgetActionResponseTypeDef
# describe_budget_action method usage example with argument unpacking

kwargs: DescribeBudgetActionRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "ActionId": ...,
}

parent.describe_budget_action(**kwargs)
  1. See DescribeBudgetActionRequestTypeDef

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: TimePeriodUnionTypeDef = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeBudgetActionHistoriesResponseTypeDef:  # (2)
    ...
  1. See TimePeriodUnionTypeDef
  2. See DescribeBudgetActionHistoriesResponseTypeDef
# describe_budget_action_histories method usage example with argument unpacking

kwargs: DescribeBudgetActionHistoriesRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "ActionId": ...,
}

parent.describe_budget_action_histories(**kwargs)
  1. See DescribeBudgetActionHistoriesRequestTypeDef

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)
    ...
  1. See DescribeBudgetActionsForAccountResponseTypeDef
# describe_budget_actions_for_account method usage example with argument unpacking

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

parent.describe_budget_actions_for_account(**kwargs)
  1. See DescribeBudgetActionsForAccountRequestTypeDef

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)
    ...
  1. See DescribeBudgetActionsForBudgetResponseTypeDef
# describe_budget_actions_for_budget method usage example with argument unpacking

kwargs: DescribeBudgetActionsForBudgetRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
}

parent.describe_budget_actions_for_budget(**kwargs)
  1. See DescribeBudgetActionsForBudgetRequestTypeDef

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)
    ...
  1. See DescribeBudgetNotificationsForAccountResponseTypeDef
# describe_budget_notifications_for_account method usage example with argument unpacking

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

parent.describe_budget_notifications_for_account(**kwargs)
  1. See DescribeBudgetNotificationsForAccountRequestTypeDef

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: TimePeriodUnionTypeDef = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeBudgetPerformanceHistoryResponseTypeDef:  # (2)
    ...
  1. See TimePeriodUnionTypeDef
  2. See DescribeBudgetPerformanceHistoryResponseTypeDef
# describe_budget_performance_history method usage example with argument unpacking

kwargs: DescribeBudgetPerformanceHistoryRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
}

parent.describe_budget_performance_history(**kwargs)
  1. See DescribeBudgetPerformanceHistoryRequestTypeDef

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 = ...,
    ShowFilterExpression: bool = ...,
) -> DescribeBudgetsResponseTypeDef:  # (1)
    ...
  1. See DescribeBudgetsResponseTypeDef
# describe_budgets method usage example with argument unpacking

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

parent.describe_budgets(**kwargs)
  1. See DescribeBudgetsRequestTypeDef

describe_notifications_for_budget#

Lists the notifications that are associated with a budget.

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

# describe_notifications_for_budget method definition

def describe_notifications_for_budget(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeNotificationsForBudgetResponseTypeDef:  # (1)
    ...
  1. See DescribeNotificationsForBudgetResponseTypeDef
# describe_notifications_for_budget method usage example with argument unpacking

kwargs: DescribeNotificationsForBudgetRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
}

parent.describe_notifications_for_budget(**kwargs)
  1. See DescribeNotificationsForBudgetRequestTypeDef

describe_subscribers_for_notification#

Lists the subscribers that are associated with a notification.

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

# describe_subscribers_for_notification method definition

def describe_subscribers_for_notification(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeSubscribersForNotificationResponseTypeDef:  # (2)
    ...
  1. See NotificationTypeDef
  2. See DescribeSubscribersForNotificationResponseTypeDef
# describe_subscribers_for_notification method usage example with argument unpacking

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

parent.describe_subscribers_for_notification(**kwargs)
  1. See DescribeSubscribersForNotificationRequestTypeDef

execute_budget_action#

Executes a budget action.

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

# execute_budget_action method definition

def execute_budget_action(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    ActionId: str,
    ExecutionType: ExecutionTypeType,  # (1)
) -> ExecuteBudgetActionResponseTypeDef:  # (2)
    ...
  1. See ExecutionTypeType
  2. See ExecuteBudgetActionResponseTypeDef
# execute_budget_action method usage example with argument unpacking

kwargs: ExecuteBudgetActionRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "ActionId": ...,
    "ExecutionType": ...,
}

parent.execute_budget_action(**kwargs)
  1. See ExecuteBudgetActionRequestTypeDef

list_tags_for_resource#

Lists tags associated with a budget or budget action resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

tag_resource#

Creates tags for a budget or budget action resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    ResourceTags: Sequence[ResourceTagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[ResourceTagTypeDef]
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "ResourceTags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Deletes tags associated with a budget or budget action resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    ResourceTagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "ResourceTagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_budget#

Updates a budget.

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

# update_budget method definition

def update_budget(
    self,
    *,
    AccountId: str,
    NewBudget: BudgetUnionTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See BudgetUnionTypeDef
# update_budget method usage example with argument unpacking

kwargs: UpdateBudgetRequestTypeDef = {  # (1)
    "AccountId": ...,
    "NewBudget": ...,
}

parent.update_budget(**kwargs)
  1. See UpdateBudgetRequestTypeDef

update_budget_action#

Updates a budget action.

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

# update_budget_action method definition

def update_budget_action(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    ActionId: str,
    NotificationType: NotificationTypeType = ...,  # (1)
    ActionThreshold: ActionThresholdTypeDef = ...,  # (2)
    Definition: DefinitionUnionTypeDef = ...,  # (3)
    ExecutionRoleArn: str = ...,
    ApprovalModel: ApprovalModelType = ...,  # (4)
    Subscribers: Sequence[SubscriberTypeDef] = ...,  # (5)
) -> UpdateBudgetActionResponseTypeDef:  # (6)
    ...
  1. See NotificationTypeType
  2. See ActionThresholdTypeDef
  3. See DefinitionUnionTypeDef
  4. See ApprovalModelType
  5. See Sequence[SubscriberTypeDef]
  6. See UpdateBudgetActionResponseTypeDef
# update_budget_action method usage example with argument unpacking

kwargs: UpdateBudgetActionRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "ActionId": ...,
}

parent.update_budget_action(**kwargs)
  1. See UpdateBudgetActionRequestTypeDef

update_notification#

Updates a notification.

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

# update_notification method definition

def update_notification(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    OldNotification: NotificationTypeDef,  # (1)
    NewNotification: NotificationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See NotificationTypeDef
  2. See NotificationTypeDef
# update_notification method usage example with argument unpacking

kwargs: UpdateNotificationRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "OldNotification": ...,
    "NewNotification": ...,
}

parent.update_notification(**kwargs)
  1. See UpdateNotificationRequestTypeDef

update_subscriber#

Updates a subscriber.

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

# update_subscriber method definition

def update_subscriber(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
    OldSubscriber: SubscriberTypeDef,  # (2)
    NewSubscriber: SubscriberTypeDef,  # (2)
) -> Dict[str, Any]:
    ...
  1. See NotificationTypeDef
  2. See SubscriberTypeDef
  3. See SubscriberTypeDef
# update_subscriber method usage example with argument unpacking

kwargs: UpdateSubscriberRequestTypeDef = {  # (1)
    "AccountId": ...,
    "BudgetName": ...,
    "Notification": ...,
    "OldSubscriber": ...,
    "NewSubscriber": ...,
}

parent.update_subscriber(**kwargs)
  1. See UpdateSubscriberRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("budgets").get_paginator method with overloads.