Budgets

import { Budgets } from "https://aws-api.deno.dev/v0.3/services/budgets.ts?docs=full";

class Budgets {

constructor(apiFactory: client.ApiFactory);

async createBudget(params: CreateBudgetRequest, opts?: client.RequestOptions): Promise<void>;

async createBudgetAction(params: CreateBudgetActionRequest, opts?: client.RequestOptions): Promise<CreateBudgetActionResponse>;

async createNotification(params: CreateNotificationRequest, opts?: client.RequestOptions): Promise<void>;

async createSubscriber(params: CreateSubscriberRequest, opts?: client.RequestOptions): Promise<void>;

async deleteBudget(params: DeleteBudgetRequest, opts?: client.RequestOptions): Promise<void>;

async deleteBudgetAction(params: DeleteBudgetActionRequest, opts?: client.RequestOptions): Promise<DeleteBudgetActionResponse>;

async deleteNotification(params: DeleteNotificationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteSubscriber(params: DeleteSubscriberRequest, opts?: client.RequestOptions): Promise<void>;

async describeBudget(params: DescribeBudgetRequest, opts?: client.RequestOptions): Promise<DescribeBudgetResponse>;

async describeBudgetAction(params: DescribeBudgetActionRequest, opts?: client.RequestOptions): Promise<DescribeBudgetActionResponse>;

async describeBudgetActionHistories(params: DescribeBudgetActionHistoriesRequest, opts?: client.RequestOptions): Promise<DescribeBudgetActionHistoriesResponse>;

async describeBudgetActionsForAccount(params: DescribeBudgetActionsForAccountRequest, opts?: client.RequestOptions): Promise<DescribeBudgetActionsForAccountResponse>;

async describeBudgetActionsForBudget(params: DescribeBudgetActionsForBudgetRequest, opts?: client.RequestOptions): Promise<DescribeBudgetActionsForBudgetResponse>;

async describeBudgetPerformanceHistory(params: DescribeBudgetPerformanceHistoryRequest, opts?: client.RequestOptions): Promise<DescribeBudgetPerformanceHistoryResponse>;

async describeBudgets(params: DescribeBudgetsRequest, opts?: client.RequestOptions): Promise<DescribeBudgetsResponse>;

async describeNotificationsForBudget(params: DescribeNotificationsForBudgetRequest, opts?: client.RequestOptions): Promise<DescribeNotificationsForBudgetResponse>;

async describeSubscribersForNotification(params: DescribeSubscribersForNotificationRequest, opts?: client.RequestOptions): Promise<DescribeSubscribersForNotificationResponse>;

async executeBudgetAction(params: ExecuteBudgetActionRequest, opts?: client.RequestOptions): Promise<ExecuteBudgetActionResponse>;

async updateBudget(params: UpdateBudgetRequest, opts?: client.RequestOptions): Promise<void>;

async updateBudgetAction(params: UpdateBudgetActionRequest, opts?: client.RequestOptions): Promise<UpdateBudgetActionResponse>;

async updateNotification(params: UpdateNotificationRequest, opts?: client.RequestOptions): Promise<void>;

async updateSubscriber(params: UpdateSubscriberRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Budgets(apiFactory: client.ApiFactory)

[src]

§Methods

createBudget(params: CreateBudgetRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

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

createBudgetAction(params: CreateBudgetActionRequest, opts?: client.RequestOptions): Promise<CreateBudgetActionResponse>

[src]

Creates a budget action.

createNotification(params: CreateNotificationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Creates a notification. You must create the budget before you create the associated notification.

createSubscriber(params: CreateSubscriberRequest, opts?: client.RequestOptions): Promise<void>

[src]

Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

deleteBudget(params: DeleteBudgetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a budget. You can delete your budget at any time.

! IMPORTANT: ! Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

deleteBudgetAction(params: DeleteBudgetActionRequest, opts?: client.RequestOptions): Promise<DeleteBudgetActionResponse>

[src]

Deletes a budget action.

deleteNotification(params: DeleteNotificationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a notification.

! IMPORTANT: ! Deleting a notification also deletes the subscribers that are associated with the notification.

deleteSubscriber(params: DeleteSubscriberRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a subscriber.

! IMPORTANT: ! Deleting the last subscriber to a notification also deletes the notification.

describeBudget(params: DescribeBudgetRequest, opts?: client.RequestOptions): Promise<DescribeBudgetResponse>

[src]

Describes a budget.

! IMPORTANT: ! The Request Syntax section shows the BudgetLimit syntax. ! For PlannedBudgetLimits, see the Examples section.

describeBudgetAction(params: DescribeBudgetActionRequest, opts?: client.RequestOptions): Promise<DescribeBudgetActionResponse>

[src]

Describes a budget action detail.

describeBudgetActionHistories(params: DescribeBudgetActionHistoriesRequest, opts?: client.RequestOptions): Promise<DescribeBudgetActionHistoriesResponse>

[src]

Describes a budget action history detail.

describeBudgetActionsForAccount(params: DescribeBudgetActionsForAccountRequest, opts?: client.RequestOptions): Promise<DescribeBudgetActionsForAccountResponse>

[src]

Describes all of the budget actions for an account.

describeBudgetActionsForBudget(params: DescribeBudgetActionsForBudgetRequest, opts?: client.RequestOptions): Promise<DescribeBudgetActionsForBudgetResponse>

[src]

Describes all of the budget actions for a budget.

describeBudgetPerformanceHistory(params: DescribeBudgetPerformanceHistoryRequest, opts?: client.RequestOptions): Promise<DescribeBudgetPerformanceHistoryResponse>

[src]

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

describeBudgets(params: DescribeBudgetsRequest, opts?: client.RequestOptions): Promise<DescribeBudgetsResponse>

[src]

Lists the budgets that are associated with an account.

! IMPORTANT: ! The Request Syntax section shows the BudgetLimit syntax. ! For PlannedBudgetLimits, see the Examples section.

describeNotificationsForBudget(params: DescribeNotificationsForBudgetRequest, opts?: client.RequestOptions): Promise<DescribeNotificationsForBudgetResponse>

[src]

Lists the notifications that are associated with a budget.

describeSubscribersForNotification(params: DescribeSubscribersForNotificationRequest, opts?: client.RequestOptions): Promise<DescribeSubscribersForNotificationResponse>

[src]

Lists the subscribers that are associated with a notification.

executeBudgetAction(params: ExecuteBudgetActionRequest, opts?: client.RequestOptions): Promise<ExecuteBudgetActionResponse>

[src]

Executes a budget action.

updateBudget(params: UpdateBudgetRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting.

updateBudgetAction(params: UpdateBudgetActionRequest, opts?: client.RequestOptions): Promise<UpdateBudgetActionResponse>

[src]

Updates a budget action.

updateNotification(params: UpdateNotificationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a notification.

updateSubscriber(params: UpdateSubscriberRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates a subscriber.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]