import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateBudgetRequest, CreateBudgetResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateBudgetCommand}. */ export interface CreateBudgetCommandInput extends CreateBudgetRequest { } /** * @public * * The output of {@link CreateBudgetCommand}. */ export interface CreateBudgetCommandOutput extends CreateBudgetResponse, __MetadataBearer { } declare const CreateBudgetCommand_base: { new (input: CreateBudgetCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateBudgetCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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

* *

Only one of BudgetLimit or PlannedBudgetLimits can be present in * the syntax at one time. Use the syntax that matches your use case. The Request Syntax * section shows the BudgetLimit syntax. For PlannedBudgetLimits, * see the Examples section.

*

Similarly, only one set of filter and metric selections can be present in the syntax * at one time. Either FilterExpression and Metrics or * CostFilters and CostTypes, not both or a different * combination. We recommend using FilterExpression and Metrics * as they provide more flexible and powerful filtering capabilities. The Request Syntax * section shows the FilterExpression/Metrics syntax.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { BudgetsClient, CreateBudgetCommand } from "@aws-sdk/client-budgets"; // ES Modules import * // const { BudgetsClient, CreateBudgetCommand } = require("@aws-sdk/client-budgets"); // CommonJS import * // import type { BudgetsClientConfig } from "@aws-sdk/client-budgets"; * const config = {}; // type is BudgetsClientConfig * const client = new BudgetsClient(config); * const input = { // CreateBudgetRequest * AccountId: "STRING_VALUE", // required * Budget: { // Budget * BudgetName: "STRING_VALUE", // required * BudgetLimit: { // Spend * Amount: "STRING_VALUE", // required * Unit: "STRING_VALUE", // required * }, * PlannedBudgetLimits: { // PlannedBudgetLimits * "": { * Amount: "STRING_VALUE", // required * Unit: "STRING_VALUE", // required * }, * }, * CostFilters: { // CostFilters * "": [ // DimensionValues * "STRING_VALUE", * ], * }, * CostTypes: { // CostTypes * IncludeTax: true || false, * IncludeSubscription: true || false, * UseBlended: true || false, * IncludeRefund: true || false, * IncludeCredit: true || false, * IncludeUpfront: true || false, * IncludeRecurring: true || false, * IncludeOtherSubscription: true || false, * IncludeSupport: true || false, * IncludeDiscount: true || false, * UseAmortized: true || false, * }, * TimeUnit: "DAILY" || "MONTHLY" || "QUARTERLY" || "ANNUALLY" || "CUSTOM", // required * TimePeriod: { // TimePeriod * Start: new Date("TIMESTAMP"), * End: new Date("TIMESTAMP"), * }, * CalculatedSpend: { // CalculatedSpend * ActualSpend: { * Amount: "STRING_VALUE", // required * Unit: "STRING_VALUE", // required * }, * ForecastedSpend: { * Amount: "STRING_VALUE", // required * Unit: "STRING_VALUE", // required * }, * }, * BudgetType: "USAGE" || "COST" || "RI_UTILIZATION" || "RI_COVERAGE" || "SAVINGS_PLANS_UTILIZATION" || "SAVINGS_PLANS_COVERAGE", // required * LastUpdatedTime: new Date("TIMESTAMP"), * AutoAdjustData: { // AutoAdjustData * AutoAdjustType: "HISTORICAL" || "FORECAST", // required * HistoricalOptions: { // HistoricalOptions * BudgetAdjustmentPeriod: Number("int"), // required * LookBackAvailablePeriods: Number("int"), * }, * LastAutoAdjustTime: new Date("TIMESTAMP"), * }, * FilterExpression: { // Expression * Or: [ // Expressions * { * Or: [ * "", * ], * And: [ * "", * ], * Not: "", * Dimensions: { // ExpressionDimensionValues * Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "INVOICING_ENTITY" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "RESERVATION_MODIFIED" || "TAG_KEY" || "COST_CATEGORY_NAME", // required * Values: [ // Values // required * "STRING_VALUE", * ], * MatchOptions: [ // MatchOptions * "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE", * ], * }, * Tags: { // TagValues * Key: "STRING_VALUE", * Values: [ * "STRING_VALUE", * ], * MatchOptions: [ * "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE", * ], * }, * CostCategories: { // CostCategoryValues * Key: "STRING_VALUE", * Values: [ * "STRING_VALUE", * ], * MatchOptions: [ * "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE", * ], * }, * }, * ], * And: [ * "", * ], * Not: "", * Dimensions: { * Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "INVOICING_ENTITY" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "RESERVATION_MODIFIED" || "TAG_KEY" || "COST_CATEGORY_NAME", // required * Values: [ // required * "STRING_VALUE", * ], * MatchOptions: [ * "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE", * ], * }, * Tags: { * Key: "STRING_VALUE", * Values: [ * "STRING_VALUE", * ], * MatchOptions: [ * "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL" || "CASE_SENSITIVE" || "CASE_INSENSITIVE", * ], * }, * CostCategories: { * Key: "STRING_VALUE", * Values: "", * MatchOptions: "", * }, * }, * Metrics: [ // Metrics * "BlendedCost" || "UnblendedCost" || "AmortizedCost" || "NetUnblendedCost" || "NetAmortizedCost" || "UsageQuantity" || "NormalizedUsageAmount" || "Hours", * ], * BillingViewArn: "STRING_VALUE", * HealthStatus: { // HealthStatus * Status: "HEALTHY" || "UNHEALTHY", * StatusReason: "BILLING_VIEW_NO_ACCESS" || "BILLING_VIEW_UNHEALTHY" || "FILTER_INVALID" || "MULTI_YEAR_HISTORICAL_DATA_DISABLED", * LastUpdatedTime: new Date("TIMESTAMP"), * }, * }, * NotificationsWithSubscribers: [ // NotificationWithSubscribersList * { // NotificationWithSubscribers * Notification: { // Notification * NotificationType: "ACTUAL" || "FORECASTED", // required * ComparisonOperator: "GREATER_THAN" || "LESS_THAN" || "EQUAL_TO", // required * Threshold: Number("double"), // required * ThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", * NotificationState: "OK" || "ALARM", * }, * Subscribers: [ // Subscribers // required * { // Subscriber * SubscriptionType: "SNS" || "EMAIL", // required * Address: "STRING_VALUE", // required * }, * ], * }, * ], * ResourceTags: [ // ResourceTagList * { // ResourceTag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }; * const command = new CreateBudgetCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param CreateBudgetCommandInput - {@link CreateBudgetCommandInput} * @returns {@link CreateBudgetCommandOutput} * @see {@link CreateBudgetCommandInput} for command's `input` shape. * @see {@link CreateBudgetCommandOutput} for command's `response` shape. * @see {@link BudgetsClientResolvedConfig | config} for BudgetsClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You are not authorized to use this operation with the given parameters.

* * @throws {@link BillingViewHealthStatusException} (client fault) *

* The billing view status must be HEALTHY to perform this action. Try again when the status is HEALTHY. *

* * @throws {@link CreationLimitExceededException} (client fault) *

You've exceeded the notification or subscriber limit.

* * @throws {@link DuplicateRecordException} (client fault) *

The budget name already exists. Budget names must be unique within an account.

* * @throws {@link InternalErrorException} (server fault) *

An error on the server occurred during the processing of your request. Try again later.

* * @throws {@link InvalidParameterException} (client fault) *

An error on the client occurred. Typically, the cause is an invalid input value.

* * @throws {@link NotFoundException} (client fault) *

We can’t locate the resource that you specified.

* * @throws {@link ServiceQuotaExceededException} (client fault) *

You've reached a Service Quota limit on this resource.

* * @throws {@link ThrottlingException} (client fault) *

The number of API requests has exceeded the maximum allowed API request throttling limit * for the account.

* * @throws {@link BudgetsServiceException} *

Base exception class for all service exceptions from Budgets service.

* * * @public */ export declare class CreateBudgetCommand extends CreateBudgetCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateBudgetRequest; output: {}; }; sdk: { input: CreateBudgetCommandInput; output: CreateBudgetCommandOutput; }; }; }