import type { HttpHandlerOptions as __HttpHandlerOptions, PaginationConfiguration, Paginator } from "@smithy/types"; import { BudgetsClient } from "./BudgetsClient"; import { type CreateBudgetActionCommandInput, type CreateBudgetActionCommandOutput } from "./commands/CreateBudgetActionCommand"; import { type CreateBudgetCommandInput, type CreateBudgetCommandOutput } from "./commands/CreateBudgetCommand"; import { type CreateNotificationCommandInput, type CreateNotificationCommandOutput } from "./commands/CreateNotificationCommand"; import { type CreateSubscriberCommandInput, type CreateSubscriberCommandOutput } from "./commands/CreateSubscriberCommand"; import { type DeleteBudgetActionCommandInput, type DeleteBudgetActionCommandOutput } from "./commands/DeleteBudgetActionCommand"; import { type DeleteBudgetCommandInput, type DeleteBudgetCommandOutput } from "./commands/DeleteBudgetCommand"; import { type DeleteNotificationCommandInput, type DeleteNotificationCommandOutput } from "./commands/DeleteNotificationCommand"; import { type DeleteSubscriberCommandInput, type DeleteSubscriberCommandOutput } from "./commands/DeleteSubscriberCommand"; import { type DescribeBudgetActionCommandInput, type DescribeBudgetActionCommandOutput } from "./commands/DescribeBudgetActionCommand"; import { type DescribeBudgetActionHistoriesCommandInput, type DescribeBudgetActionHistoriesCommandOutput } from "./commands/DescribeBudgetActionHistoriesCommand"; import { type DescribeBudgetActionsForAccountCommandInput, type DescribeBudgetActionsForAccountCommandOutput } from "./commands/DescribeBudgetActionsForAccountCommand"; import { type DescribeBudgetActionsForBudgetCommandInput, type DescribeBudgetActionsForBudgetCommandOutput } from "./commands/DescribeBudgetActionsForBudgetCommand"; import { type DescribeBudgetCommandInput, type DescribeBudgetCommandOutput } from "./commands/DescribeBudgetCommand"; import { type DescribeBudgetNotificationsForAccountCommandInput, type DescribeBudgetNotificationsForAccountCommandOutput } from "./commands/DescribeBudgetNotificationsForAccountCommand"; import { type DescribeBudgetPerformanceHistoryCommandInput, type DescribeBudgetPerformanceHistoryCommandOutput } from "./commands/DescribeBudgetPerformanceHistoryCommand"; import { type DescribeBudgetsCommandInput, type DescribeBudgetsCommandOutput } from "./commands/DescribeBudgetsCommand"; import { type DescribeNotificationsForBudgetCommandInput, type DescribeNotificationsForBudgetCommandOutput } from "./commands/DescribeNotificationsForBudgetCommand"; import { type DescribeSubscribersForNotificationCommandInput, type DescribeSubscribersForNotificationCommandOutput } from "./commands/DescribeSubscribersForNotificationCommand"; import { type ExecuteBudgetActionCommandInput, type ExecuteBudgetActionCommandOutput } from "./commands/ExecuteBudgetActionCommand"; import { type ListTagsForResourceCommandInput, type ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand"; import { type TagResourceCommandInput, type TagResourceCommandOutput } from "./commands/TagResourceCommand"; import { type UntagResourceCommandInput, type UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; import { type UpdateBudgetActionCommandInput, type UpdateBudgetActionCommandOutput } from "./commands/UpdateBudgetActionCommand"; import { type UpdateBudgetCommandInput, type UpdateBudgetCommandOutput } from "./commands/UpdateBudgetCommand"; import { type UpdateNotificationCommandInput, type UpdateNotificationCommandOutput } from "./commands/UpdateNotificationCommand"; import { type UpdateSubscriberCommandInput, type UpdateSubscriberCommandOutput } from "./commands/UpdateSubscriberCommand"; export interface Budgets { /** * @see {@link CreateBudgetCommand} */ createBudget(args: CreateBudgetCommandInput, options?: __HttpHandlerOptions): Promise; createBudget(args: CreateBudgetCommandInput, cb: (err: any, data?: CreateBudgetCommandOutput) => void): void; createBudget(args: CreateBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBudgetCommandOutput) => void): void; /** * @see {@link CreateBudgetActionCommand} */ createBudgetAction(args: CreateBudgetActionCommandInput, options?: __HttpHandlerOptions): Promise; createBudgetAction(args: CreateBudgetActionCommandInput, cb: (err: any, data?: CreateBudgetActionCommandOutput) => void): void; createBudgetAction(args: CreateBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBudgetActionCommandOutput) => void): void; /** * @see {@link CreateNotificationCommand} */ createNotification(args: CreateNotificationCommandInput, options?: __HttpHandlerOptions): Promise; createNotification(args: CreateNotificationCommandInput, cb: (err: any, data?: CreateNotificationCommandOutput) => void): void; createNotification(args: CreateNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotificationCommandOutput) => void): void; /** * @see {@link CreateSubscriberCommand} */ createSubscriber(args: CreateSubscriberCommandInput, options?: __HttpHandlerOptions): Promise; createSubscriber(args: CreateSubscriberCommandInput, cb: (err: any, data?: CreateSubscriberCommandOutput) => void): void; createSubscriber(args: CreateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriberCommandOutput) => void): void; /** * @see {@link DeleteBudgetCommand} */ deleteBudget(args: DeleteBudgetCommandInput, options?: __HttpHandlerOptions): Promise; deleteBudget(args: DeleteBudgetCommandInput, cb: (err: any, data?: DeleteBudgetCommandOutput) => void): void; deleteBudget(args: DeleteBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBudgetCommandOutput) => void): void; /** * @see {@link DeleteBudgetActionCommand} */ deleteBudgetAction(args: DeleteBudgetActionCommandInput, options?: __HttpHandlerOptions): Promise; deleteBudgetAction(args: DeleteBudgetActionCommandInput, cb: (err: any, data?: DeleteBudgetActionCommandOutput) => void): void; deleteBudgetAction(args: DeleteBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBudgetActionCommandOutput) => void): void; /** * @see {@link DeleteNotificationCommand} */ deleteNotification(args: DeleteNotificationCommandInput, options?: __HttpHandlerOptions): Promise; deleteNotification(args: DeleteNotificationCommandInput, cb: (err: any, data?: DeleteNotificationCommandOutput) => void): void; deleteNotification(args: DeleteNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationCommandOutput) => void): void; /** * @see {@link DeleteSubscriberCommand} */ deleteSubscriber(args: DeleteSubscriberCommandInput, options?: __HttpHandlerOptions): Promise; deleteSubscriber(args: DeleteSubscriberCommandInput, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void): void; deleteSubscriber(args: DeleteSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void): void; /** * @see {@link DescribeBudgetCommand} */ describeBudget(args: DescribeBudgetCommandInput, options?: __HttpHandlerOptions): Promise; describeBudget(args: DescribeBudgetCommandInput, cb: (err: any, data?: DescribeBudgetCommandOutput) => void): void; describeBudget(args: DescribeBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetCommandOutput) => void): void; /** * @see {@link DescribeBudgetActionCommand} */ describeBudgetAction(args: DescribeBudgetActionCommandInput, options?: __HttpHandlerOptions): Promise; describeBudgetAction(args: DescribeBudgetActionCommandInput, cb: (err: any, data?: DescribeBudgetActionCommandOutput) => void): void; describeBudgetAction(args: DescribeBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionCommandOutput) => void): void; /** * @see {@link DescribeBudgetActionHistoriesCommand} */ describeBudgetActionHistories(args: DescribeBudgetActionHistoriesCommandInput, options?: __HttpHandlerOptions): Promise; describeBudgetActionHistories(args: DescribeBudgetActionHistoriesCommandInput, cb: (err: any, data?: DescribeBudgetActionHistoriesCommandOutput) => void): void; describeBudgetActionHistories(args: DescribeBudgetActionHistoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionHistoriesCommandOutput) => void): void; /** * @see {@link DescribeBudgetActionsForAccountCommand} */ describeBudgetActionsForAccount(args: DescribeBudgetActionsForAccountCommandInput, options?: __HttpHandlerOptions): Promise; describeBudgetActionsForAccount(args: DescribeBudgetActionsForAccountCommandInput, cb: (err: any, data?: DescribeBudgetActionsForAccountCommandOutput) => void): void; describeBudgetActionsForAccount(args: DescribeBudgetActionsForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionsForAccountCommandOutput) => void): void; /** * @see {@link DescribeBudgetActionsForBudgetCommand} */ describeBudgetActionsForBudget(args: DescribeBudgetActionsForBudgetCommandInput, options?: __HttpHandlerOptions): Promise; describeBudgetActionsForBudget(args: DescribeBudgetActionsForBudgetCommandInput, cb: (err: any, data?: DescribeBudgetActionsForBudgetCommandOutput) => void): void; describeBudgetActionsForBudget(args: DescribeBudgetActionsForBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionsForBudgetCommandOutput) => void): void; /** * @see {@link DescribeBudgetNotificationsForAccountCommand} */ describeBudgetNotificationsForAccount(args: DescribeBudgetNotificationsForAccountCommandInput, options?: __HttpHandlerOptions): Promise; describeBudgetNotificationsForAccount(args: DescribeBudgetNotificationsForAccountCommandInput, cb: (err: any, data?: DescribeBudgetNotificationsForAccountCommandOutput) => void): void; describeBudgetNotificationsForAccount(args: DescribeBudgetNotificationsForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetNotificationsForAccountCommandOutput) => void): void; /** * @see {@link DescribeBudgetPerformanceHistoryCommand} */ describeBudgetPerformanceHistory(args: DescribeBudgetPerformanceHistoryCommandInput, options?: __HttpHandlerOptions): Promise; describeBudgetPerformanceHistory(args: DescribeBudgetPerformanceHistoryCommandInput, cb: (err: any, data?: DescribeBudgetPerformanceHistoryCommandOutput) => void): void; describeBudgetPerformanceHistory(args: DescribeBudgetPerformanceHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetPerformanceHistoryCommandOutput) => void): void; /** * @see {@link DescribeBudgetsCommand} */ describeBudgets(args: DescribeBudgetsCommandInput, options?: __HttpHandlerOptions): Promise; describeBudgets(args: DescribeBudgetsCommandInput, cb: (err: any, data?: DescribeBudgetsCommandOutput) => void): void; describeBudgets(args: DescribeBudgetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetsCommandOutput) => void): void; /** * @see {@link DescribeNotificationsForBudgetCommand} */ describeNotificationsForBudget(args: DescribeNotificationsForBudgetCommandInput, options?: __HttpHandlerOptions): Promise; describeNotificationsForBudget(args: DescribeNotificationsForBudgetCommandInput, cb: (err: any, data?: DescribeNotificationsForBudgetCommandOutput) => void): void; describeNotificationsForBudget(args: DescribeNotificationsForBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotificationsForBudgetCommandOutput) => void): void; /** * @see {@link DescribeSubscribersForNotificationCommand} */ describeSubscribersForNotification(args: DescribeSubscribersForNotificationCommandInput, options?: __HttpHandlerOptions): Promise; describeSubscribersForNotification(args: DescribeSubscribersForNotificationCommandInput, cb: (err: any, data?: DescribeSubscribersForNotificationCommandOutput) => void): void; describeSubscribersForNotification(args: DescribeSubscribersForNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscribersForNotificationCommandOutput) => void): void; /** * @see {@link ExecuteBudgetActionCommand} */ executeBudgetAction(args: ExecuteBudgetActionCommandInput, options?: __HttpHandlerOptions): Promise; executeBudgetAction(args: ExecuteBudgetActionCommandInput, cb: (err: any, data?: ExecuteBudgetActionCommandOutput) => void): void; executeBudgetAction(args: ExecuteBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteBudgetActionCommandOutput) => void): void; /** * @see {@link ListTagsForResourceCommand} */ listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise; listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void; listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void; /** * @see {@link TagResourceCommand} */ tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void; /** * @see {@link UntagResourceCommand} */ untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise; untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void; /** * @see {@link UpdateBudgetCommand} */ updateBudget(args: UpdateBudgetCommandInput, options?: __HttpHandlerOptions): Promise; updateBudget(args: UpdateBudgetCommandInput, cb: (err: any, data?: UpdateBudgetCommandOutput) => void): void; updateBudget(args: UpdateBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBudgetCommandOutput) => void): void; /** * @see {@link UpdateBudgetActionCommand} */ updateBudgetAction(args: UpdateBudgetActionCommandInput, options?: __HttpHandlerOptions): Promise; updateBudgetAction(args: UpdateBudgetActionCommandInput, cb: (err: any, data?: UpdateBudgetActionCommandOutput) => void): void; updateBudgetAction(args: UpdateBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBudgetActionCommandOutput) => void): void; /** * @see {@link UpdateNotificationCommand} */ updateNotification(args: UpdateNotificationCommandInput, options?: __HttpHandlerOptions): Promise; updateNotification(args: UpdateNotificationCommandInput, cb: (err: any, data?: UpdateNotificationCommandOutput) => void): void; updateNotification(args: UpdateNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotificationCommandOutput) => void): void; /** * @see {@link UpdateSubscriberCommand} */ updateSubscriber(args: UpdateSubscriberCommandInput, options?: __HttpHandlerOptions): Promise; updateSubscriber(args: UpdateSubscriberCommandInput, cb: (err: any, data?: UpdateSubscriberCommandOutput) => void): void; updateSubscriber(args: UpdateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriberCommandOutput) => void): void; /** * @see {@link DescribeBudgetActionHistoriesCommand} * @param args - command input. * @param paginationConfig - optional pagination config. * @returns AsyncIterable of {@link DescribeBudgetActionHistoriesCommandOutput}. */ paginateDescribeBudgetActionHistories(args: DescribeBudgetActionHistoriesCommandInput, paginationConfig?: Omit): Paginator; /** * @see {@link DescribeBudgetActionsForAccountCommand} * @param args - command input. * @param paginationConfig - optional pagination config. * @returns AsyncIterable of {@link DescribeBudgetActionsForAccountCommandOutput}. */ paginateDescribeBudgetActionsForAccount(args: DescribeBudgetActionsForAccountCommandInput, paginationConfig?: Omit): Paginator; /** * @see {@link DescribeBudgetActionsForBudgetCommand} * @param args - command input. * @param paginationConfig - optional pagination config. * @returns AsyncIterable of {@link DescribeBudgetActionsForBudgetCommandOutput}. */ paginateDescribeBudgetActionsForBudget(args: DescribeBudgetActionsForBudgetCommandInput, paginationConfig?: Omit): Paginator; /** * @see {@link DescribeBudgetNotificationsForAccountCommand} * @param args - command input. * @param paginationConfig - optional pagination config. * @returns AsyncIterable of {@link DescribeBudgetNotificationsForAccountCommandOutput}. */ paginateDescribeBudgetNotificationsForAccount(args: DescribeBudgetNotificationsForAccountCommandInput, paginationConfig?: Omit): Paginator; /** * @see {@link DescribeBudgetPerformanceHistoryCommand} * @param args - command input. * @param paginationConfig - optional pagination config. * @returns AsyncIterable of {@link DescribeBudgetPerformanceHistoryCommandOutput}. */ paginateDescribeBudgetPerformanceHistory(args: DescribeBudgetPerformanceHistoryCommandInput, paginationConfig?: Omit): Paginator; /** * @see {@link DescribeBudgetsCommand} * @param args - command input. * @param paginationConfig - optional pagination config. * @returns AsyncIterable of {@link DescribeBudgetsCommandOutput}. */ paginateDescribeBudgets(args: DescribeBudgetsCommandInput, paginationConfig?: Omit): Paginator; /** * @see {@link DescribeNotificationsForBudgetCommand} * @param args - command input. * @param paginationConfig - optional pagination config. * @returns AsyncIterable of {@link DescribeNotificationsForBudgetCommandOutput}. */ paginateDescribeNotificationsForBudget(args: DescribeNotificationsForBudgetCommandInput, paginationConfig?: Omit): Paginator; /** * @see {@link DescribeSubscribersForNotificationCommand} * @param args - command input. * @param paginationConfig - optional pagination config. * @returns AsyncIterable of {@link DescribeSubscribersForNotificationCommandOutput}. */ paginateDescribeSubscribersForNotification(args: DescribeSubscribersForNotificationCommandInput, paginationConfig?: Omit): Paginator; } /** *

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.

*

Budgets provide you with a way to see the following information:

*
    *
  • *

    How close your plan is to your budgeted amount or to the free tier limits

    *
  • *
  • *

    Your usage-to-date, including how much you've used of your Reserved Instances (RIs)

    *
  • *
  • *

    Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month

    *
  • *
  • *

    How much of your budget has been used

    *
  • *
*

Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:

*
    *
  • *

    * Cost budgets - Plan how much you want to spend on a service.

    *
  • *
  • *

    * Usage budgets - Plan how much you want to use one or more services.

    *
  • *
  • *

    * RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.

    *
  • *
  • *

    * RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.

    *
  • *
*

Service Endpoint

*

The Amazon Web Services Budgets API provides the following endpoint:

*
    *
  • *

    https://budgets.amazonaws.com

    *
  • *
*

For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.

* @public */ export declare class Budgets extends BudgetsClient implements Budgets { }