BudgetsClient

Index > Budgets > BudgetsClient

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

BudgetsClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_budgets.client import BudgetsClient

session = Session()
async with session.client("budgets") as client:
    client: BudgetsClient

Exceptions

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

Usage example

async with session.client("budgets") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ClientError,
        client.CreationLimitExceededException,
        client.DuplicateRecordException,
        client.ExpiredNextTokenException,
        client.InternalErrorException,
        client.InvalidNextTokenException,
        client.InvalidParameterException,
        client.NotFoundException,
        client.ResourceLockedException,
        client.ThrottlingException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_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 session.client("budgets").can_paginate method. boto3 documentation

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

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

create_budget

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

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

Method definition

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

1. See BudgetTypeDef
2. See NotificationWithSubscribersTypeDef

Usage example with kwargs

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 session.client("budgets").create_budget_action method. boto3 documentation

Method definition

await 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)
    ...

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

Usage example with kwargs

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 session.client("budgets").create_notification method. boto3 documentation

Method definition

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

1. See NotificationTypeDef
2. See SubscriberTypeDef

Usage example with kwargs

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 session.client("budgets").create_subscriber method. boto3 documentation

Method definition

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

1. See NotificationTypeDef
2. See SubscriberTypeDef

Usage example with kwargs

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 session.client("budgets").delete_budget method. boto3 documentation

Method definition

await def delete_budget(
    self,
    *,
    AccountId: str,
    BudgetName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_budget(**kwargs)

1. See DeleteBudgetRequestRequestTypeDef

delete_budget_action

Deletes a budget action.

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

Method definition

await def delete_budget_action(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    ActionId: str,
) -> DeleteBudgetActionResponseTypeDef:  # (1)
    ...

1. See DeleteBudgetActionResponseTypeDef

Usage example with kwargs

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

parent.delete_budget_action(**kwargs)

1. See DeleteBudgetActionRequestRequestTypeDef

delete_notification

Deletes a notification.

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

Method definition

await def delete_notification(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See NotificationTypeDef

Usage example with kwargs

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

parent.delete_notification(**kwargs)

1. See DeleteNotificationRequestRequestTypeDef

delete_subscriber

Deletes a subscriber.

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

Method definition

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

1. See NotificationTypeDef
2. See SubscriberTypeDef

Usage example with kwargs

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

parent.delete_subscriber(**kwargs)

1. See DeleteSubscriberRequestRequestTypeDef

describe_budget

Describes a budget.

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

Method definition

await def describe_budget(
    self,
    *,
    AccountId: str,
    BudgetName: str,
) -> DescribeBudgetResponseTypeDef:  # (1)
    ...

1. See DescribeBudgetResponseTypeDef

Usage example with kwargs

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

parent.describe_budget(**kwargs)

1. See DescribeBudgetRequestRequestTypeDef

describe_budget_action

Describes a budget action detail.

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

Method definition

await def describe_budget_action(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    ActionId: str,
) -> DescribeBudgetActionResponseTypeDef:  # (1)
    ...

1. See DescribeBudgetActionResponseTypeDef

Usage example with kwargs

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

parent.describe_budget_action(**kwargs)

1. See DescribeBudgetActionRequestRequestTypeDef

describe_budget_action_histories

Describes a budget action history detail.

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

Method definition

await def describe_budget_action_histories(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    ActionId: str,
    TimePeriod: TimePeriodTypeDef = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeBudgetActionHistoriesResponseTypeDef:  # (2)
    ...

1. See TimePeriodTypeDef
2. See DescribeBudgetActionHistoriesResponseTypeDef

Usage example with kwargs

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

parent.describe_budget_action_histories(**kwargs)

1. See DescribeBudgetActionHistoriesRequestRequestTypeDef

describe_budget_actions_for_account

Describes all of the budget actions for an account.

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

Method definition

await def describe_budget_actions_for_account(
    self,
    *,
    AccountId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeBudgetActionsForAccountResponseTypeDef:  # (1)
    ...

1. See DescribeBudgetActionsForAccountResponseTypeDef

Usage example with kwargs

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

parent.describe_budget_actions_for_account(**kwargs)

1. See DescribeBudgetActionsForAccountRequestRequestTypeDef

describe_budget_actions_for_budget

Describes all of the budget actions for a budget.

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

Method definition

await def describe_budget_actions_for_budget(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeBudgetActionsForBudgetResponseTypeDef:  # (1)
    ...

1. See DescribeBudgetActionsForBudgetResponseTypeDef

Usage example with kwargs

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

parent.describe_budget_actions_for_budget(**kwargs)

1. See DescribeBudgetActionsForBudgetRequestRequestTypeDef

describe_budget_notifications_for_account

Lists the budget names and notifications that are associated with an account.

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

Method definition

await def describe_budget_notifications_for_account(
    self,
    *,
    AccountId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeBudgetNotificationsForAccountResponseTypeDef:  # (1)
    ...

1. See DescribeBudgetNotificationsForAccountResponseTypeDef

Usage example with kwargs

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

parent.describe_budget_notifications_for_account(**kwargs)

1. See DescribeBudgetNotificationsForAccountRequestRequestTypeDef

describe_budget_performance_history

Describes the history for DAILY , MONTHLY , and QUARTERLY budgets.

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

Method definition

await def describe_budget_performance_history(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    TimePeriod: TimePeriodTypeDef = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeBudgetPerformanceHistoryResponseTypeDef:  # (2)
    ...

1. See TimePeriodTypeDef
2. See DescribeBudgetPerformanceHistoryResponseTypeDef

Usage example with kwargs

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

parent.describe_budget_performance_history(**kwargs)

1. See DescribeBudgetPerformanceHistoryRequestRequestTypeDef

describe_budgets

Lists the budgets that are associated with an account.

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

Method definition

await def describe_budgets(
    self,
    *,
    AccountId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeBudgetsResponseTypeDef:  # (1)
    ...

1. See DescribeBudgetsResponseTypeDef

Usage example with kwargs

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

parent.describe_budgets(**kwargs)

1. See DescribeBudgetsRequestRequestTypeDef

describe_notifications_for_budget

Lists the notifications that are associated with a budget.

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

Method definition

await def describe_notifications_for_budget(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeNotificationsForBudgetResponseTypeDef:  # (1)
    ...

1. See DescribeNotificationsForBudgetResponseTypeDef

Usage example with kwargs

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

parent.describe_notifications_for_budget(**kwargs)

1. See DescribeNotificationsForBudgetRequestRequestTypeDef

describe_subscribers_for_notification

Lists the subscribers that are associated with a notification.

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

Method definition

await 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

Usage example with kwargs

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

parent.describe_subscribers_for_notification(**kwargs)

1. See DescribeSubscribersForNotificationRequestRequestTypeDef

execute_budget_action

Executes a budget action.

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

Method definition

await def execute_budget_action(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    ActionId: str,
    ExecutionType: ExecutionTypeType,  # (1)
) -> ExecuteBudgetActionResponseTypeDef:  # (2)
    ...

1. See ExecutionTypeType
2. See ExecuteBudgetActionResponseTypeDef

Usage example with kwargs

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

parent.execute_budget_action(**kwargs)

1. See ExecuteBudgetActionRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

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

update_budget

Updates a budget.

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

Method definition

await def update_budget(
    self,
    *,
    AccountId: str,
    NewBudget: BudgetTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See BudgetTypeDef

Usage example with kwargs

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

parent.update_budget(**kwargs)

1. See UpdateBudgetRequestRequestTypeDef

update_budget_action

Updates a budget action.

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

Method definition

await def update_budget_action(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    ActionId: str,
    NotificationType: NotificationTypeType = ...,  # (1)
    ActionThreshold: ActionThresholdTypeDef = ...,  # (2)
    Definition: DefinitionTypeDef = ...,  # (3)
    ExecutionRoleArn: str = ...,
    ApprovalModel: ApprovalModelType = ...,  # (4)
    Subscribers: Sequence[SubscriberTypeDef] = ...,  # (5)
) -> UpdateBudgetActionResponseTypeDef:  # (6)
    ...

1. See NotificationTypeType
2. See ActionThresholdTypeDef
3. See DefinitionTypeDef
4. See ApprovalModelType
5. See SubscriberTypeDef
6. See UpdateBudgetActionResponseTypeDef

Usage example with kwargs

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

parent.update_budget_action(**kwargs)

1. See UpdateBudgetActionRequestRequestTypeDef

update_notification

Updates a notification.

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

Method definition

await def update_notification(
    self,
    *,
    AccountId: str,
    BudgetName: str,
    OldNotification: NotificationTypeDef,  # (1)
    NewNotification: NotificationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See NotificationTypeDef
2. See NotificationTypeDef

Usage example with kwargs

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

parent.update_notification(**kwargs)

1. See UpdateNotificationRequestRequestTypeDef

update_subscriber

Updates a subscriber.

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

Method definition

await 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

Usage example with kwargs

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

parent.update_subscriber(**kwargs)

1. See UpdateSubscriberRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> BudgetsClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

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

• client.get_paginator("describe_budget_action_histories") -> DescribeBudgetActionHistoriesPaginator
• client.get_paginator("describe_budget_actions_for_account") -> DescribeBudgetActionsForAccountPaginator
• client.get_paginator("describe_budget_actions_for_budget") -> DescribeBudgetActionsForBudgetPaginator
• client.get_paginator("describe_budget_notifications_for_account") -> DescribeBudgetNotificationsForAccountPaginator
• client.get_paginator("describe_budget_performance_history") -> DescribeBudgetPerformanceHistoryPaginator
• client.get_paginator("describe_budgets") -> DescribeBudgetsPaginator
• client.get_paginator("describe_notifications_for_budget") -> DescribeNotificationsForBudgetPaginator
• client.get_paginator("describe_subscribers_for_notification") -> DescribeSubscribersForNotificationPaginator