import { type HostHeaderInputConfig, type HostHeaderResolvedConfig, type UserAgentInputConfig, type UserAgentResolvedConfig } from "@aws-sdk/core/client"; import { type DefaultsMode as __DefaultsMode, type SmithyConfiguration as __SmithyConfiguration, type SmithyResolvedConfiguration as __SmithyResolvedConfiguration, Client as __Client } from "@smithy/core/client"; import { type RegionInputConfig, type RegionResolvedConfig } from "@smithy/core/config"; import { type EndpointInputConfig, type EndpointResolvedConfig } from "@smithy/core/endpoints"; import { type HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/core/protocols"; import { type RetryInputConfig, type RetryResolvedConfig } from "@smithy/core/retry"; import type { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types"; import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider"; import type { CreateBudgetActionCommandInput, CreateBudgetActionCommandOutput } from "./commands/CreateBudgetActionCommand"; import type { CreateBudgetCommandInput, CreateBudgetCommandOutput } from "./commands/CreateBudgetCommand"; import type { CreateNotificationCommandInput, CreateNotificationCommandOutput } from "./commands/CreateNotificationCommand"; import type { CreateSubscriberCommandInput, CreateSubscriberCommandOutput } from "./commands/CreateSubscriberCommand"; import type { DeleteBudgetActionCommandInput, DeleteBudgetActionCommandOutput } from "./commands/DeleteBudgetActionCommand"; import type { DeleteBudgetCommandInput, DeleteBudgetCommandOutput } from "./commands/DeleteBudgetCommand"; import type { DeleteNotificationCommandInput, DeleteNotificationCommandOutput } from "./commands/DeleteNotificationCommand"; import type { DeleteSubscriberCommandInput, DeleteSubscriberCommandOutput } from "./commands/DeleteSubscriberCommand"; import type { DescribeBudgetActionCommandInput, DescribeBudgetActionCommandOutput } from "./commands/DescribeBudgetActionCommand"; import type { DescribeBudgetActionHistoriesCommandInput, DescribeBudgetActionHistoriesCommandOutput } from "./commands/DescribeBudgetActionHistoriesCommand"; import type { DescribeBudgetActionsForAccountCommandInput, DescribeBudgetActionsForAccountCommandOutput } from "./commands/DescribeBudgetActionsForAccountCommand"; import type { DescribeBudgetActionsForBudgetCommandInput, DescribeBudgetActionsForBudgetCommandOutput } from "./commands/DescribeBudgetActionsForBudgetCommand"; import type { DescribeBudgetCommandInput, DescribeBudgetCommandOutput } from "./commands/DescribeBudgetCommand"; import type { DescribeBudgetNotificationsForAccountCommandInput, DescribeBudgetNotificationsForAccountCommandOutput } from "./commands/DescribeBudgetNotificationsForAccountCommand"; import type { DescribeBudgetPerformanceHistoryCommandInput, DescribeBudgetPerformanceHistoryCommandOutput } from "./commands/DescribeBudgetPerformanceHistoryCommand"; import type { DescribeBudgetsCommandInput, DescribeBudgetsCommandOutput } from "./commands/DescribeBudgetsCommand"; import type { DescribeNotificationsForBudgetCommandInput, DescribeNotificationsForBudgetCommandOutput } from "./commands/DescribeNotificationsForBudgetCommand"; import type { DescribeSubscribersForNotificationCommandInput, DescribeSubscribersForNotificationCommandOutput } from "./commands/DescribeSubscribersForNotificationCommand"; import type { ExecuteBudgetActionCommandInput, ExecuteBudgetActionCommandOutput } from "./commands/ExecuteBudgetActionCommand"; import type { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand"; import type { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; import type { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; import type { UpdateBudgetActionCommandInput, UpdateBudgetActionCommandOutput } from "./commands/UpdateBudgetActionCommand"; import type { UpdateBudgetCommandInput, UpdateBudgetCommandOutput } from "./commands/UpdateBudgetCommand"; import type { UpdateNotificationCommandInput, UpdateNotificationCommandOutput } from "./commands/UpdateNotificationCommand"; import type { UpdateSubscriberCommandInput, UpdateSubscriberCommandOutput } from "./commands/UpdateSubscriberCommand"; import { type ClientInputEndpointParameters, type ClientResolvedEndpointParameters, type EndpointParameters } from "./endpoint/EndpointParameters"; import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions"; export { __Client }; /** * @public */ export type ServiceInputTypes = CreateBudgetActionCommandInput | CreateBudgetCommandInput | CreateNotificationCommandInput | CreateSubscriberCommandInput | DeleteBudgetActionCommandInput | DeleteBudgetCommandInput | DeleteNotificationCommandInput | DeleteSubscriberCommandInput | DescribeBudgetActionCommandInput | DescribeBudgetActionHistoriesCommandInput | DescribeBudgetActionsForAccountCommandInput | DescribeBudgetActionsForBudgetCommandInput | DescribeBudgetCommandInput | DescribeBudgetNotificationsForAccountCommandInput | DescribeBudgetPerformanceHistoryCommandInput | DescribeBudgetsCommandInput | DescribeNotificationsForBudgetCommandInput | DescribeSubscribersForNotificationCommandInput | ExecuteBudgetActionCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateBudgetActionCommandInput | UpdateBudgetCommandInput | UpdateNotificationCommandInput | UpdateSubscriberCommandInput; /** * @public */ export type ServiceOutputTypes = CreateBudgetActionCommandOutput | CreateBudgetCommandOutput | CreateNotificationCommandOutput | CreateSubscriberCommandOutput | DeleteBudgetActionCommandOutput | DeleteBudgetCommandOutput | DeleteNotificationCommandOutput | DeleteSubscriberCommandOutput | DescribeBudgetActionCommandOutput | DescribeBudgetActionHistoriesCommandOutput | DescribeBudgetActionsForAccountCommandOutput | DescribeBudgetActionsForBudgetCommandOutput | DescribeBudgetCommandOutput | DescribeBudgetNotificationsForAccountCommandOutput | DescribeBudgetPerformanceHistoryCommandOutput | DescribeBudgetsCommandOutput | DescribeNotificationsForBudgetCommandOutput | DescribeSubscribersForNotificationCommandOutput | ExecuteBudgetActionCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateBudgetActionCommandOutput | UpdateBudgetCommandOutput | UpdateNotificationCommandOutput | UpdateSubscriberCommandOutput; /** * @public */ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> { /** * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. */ requestHandler?: __HttpHandlerUserInput; /** * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface * that computes the SHA-256 HMAC or checksum of a string or binary buffer. * @internal */ sha256?: __ChecksumConstructor | __HashConstructor; /** * The function that will be used to convert strings into HTTP endpoints. * @internal */ urlParser?: __UrlParser; /** * A function that can calculate the length of a request body. * @internal */ bodyLengthChecker?: __BodyLengthCalculator; /** * A function that converts a stream into an array of bytes. * @internal */ streamCollector?: __StreamCollector; /** * The function that will be used to convert a base64-encoded string to a byte array. * @internal */ base64Decoder?: __Decoder; /** * The function that will be used to convert binary data to a base64-encoded string. * @internal */ base64Encoder?: __Encoder; /** * The function that will be used to convert a UTF8-encoded string to a byte array. * @internal */ utf8Decoder?: __Decoder; /** * The function that will be used to convert binary data to a UTF-8 encoded string. * @internal */ utf8Encoder?: __Encoder; /** * The runtime environment. * @internal */ runtime?: string; /** * Disable dynamically changing the endpoint of the client based on the hostPrefix * trait of an operation. */ disableHostPrefix?: boolean; /** * Unique service identifier. * @internal */ serviceId?: string; /** * Enables IPv6/IPv4 dualstack endpoint. */ useDualstackEndpoint?: boolean | __Provider; /** * Enables FIPS compatible endpoints. */ useFipsEndpoint?: boolean | __Provider; /** * The AWS region to which this client will send requests */ region?: string | __Provider; /** * Setting a client profile is similar to setting a value for the * AWS_PROFILE environment variable. Setting a profile on a client * in code only affects the single client instance, unlike AWS_PROFILE. * * When set, and only for environments where an AWS configuration * file exists, fields configurable by this file will be retrieved * from the specified profile within that file. * Conflicting code configuration and environment variables will * still have higher priority. * * For client credential resolution that involves checking the AWS * configuration file, the client's profile (this value) will be * used unless a different profile is set in the credential * provider options. * */ profile?: string; /** * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header * @internal */ defaultUserAgentProvider?: __Provider<__UserAgent>; /** * Default credentials provider; Not available in browser runtime. * @deprecated * @internal */ credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider; /** * Value for how many times a request will be made at most in case of retry. */ maxAttempts?: number | __Provider; /** * Specifies which retry algorithm to use. * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/ * */ retryMode?: string | __Provider; /** * Optional logger for logging debug/info/warn/error. */ logger?: __Logger; /** * Optional extensions */ extensions?: RuntimeExtension[]; /** * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK. */ defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>; } /** * @public */ export type BudgetsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & UserAgentInputConfig & RetryInputConfig & RegionInputConfig & HostHeaderInputConfig & EndpointInputConfig & HttpAuthSchemeInputConfig & ClientInputEndpointParameters; /** * @public * * The configuration interface of BudgetsClient class constructor that set the region, credentials and other options. */ export interface BudgetsClientConfig extends BudgetsClientConfigType { } /** * @public */ export type BudgetsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required & RuntimeExtensionsConfig & UserAgentResolvedConfig & RetryResolvedConfig & RegionResolvedConfig & HostHeaderResolvedConfig & EndpointResolvedConfig & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters; /** * @public * * The resolved configuration interface of BudgetsClient class. This is resolved and normalized from the {@link BudgetsClientConfig | constructor configuration interface}. */ export interface BudgetsClientResolvedConfig extends BudgetsClientResolvedConfigType { } /** *

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 BudgetsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, BudgetsClientResolvedConfig> { /** * The resolved configuration of BudgetsClient class. This is resolved and normalized from the {@link BudgetsClientConfig | constructor configuration interface}. */ readonly config: BudgetsClientResolvedConfig; constructor(...[configuration]: __CheckOptionalClientConfig); /** * Destroy underlying resources, like sockets. It's usually not necessary to do this. * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. * Otherwise, sockets might stay open for quite a long time before the server terminates them. */ destroy(): void; }