Contents

BudgetsClient Class

(QtAws::Budgets::BudgetsClient)

The BudgetsClient class provides access to the AWS Budgets service. More...

Header: #include <BudgetsClient>
Inherits: QtAws::Core::AwsAbstractClient

Public Functions

BudgetsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
BudgetsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Public Slots

CreateBudgetResponse *createBudget(const CreateBudgetRequest &request)
CreateNotificationResponse *createNotification(const CreateNotificationRequest &request)
CreateSubscriberResponse *createSubscriber(const CreateSubscriberRequest &request)
DeleteBudgetResponse *deleteBudget(const DeleteBudgetRequest &request)
DeleteNotificationResponse *deleteNotification(const DeleteNotificationRequest &request)
DeleteSubscriberResponse *deleteSubscriber(const DeleteSubscriberRequest &request)
DescribeBudgetResponse *describeBudget(const DescribeBudgetRequest &request)
DescribeBudgetsResponse *describeBudgets(const DescribeBudgetsRequest &request)
DescribeNotificationsForBudgetResponse *describeNotificationsForBudget(const DescribeNotificationsForBudgetRequest &request)
DescribeSubscribersForNotificationResponse *describeSubscribersForNotification(const DescribeSubscribersForNotificationRequest &request)
UpdateBudgetResponse *updateBudget(const UpdateBudgetRequest &request)
UpdateNotificationResponse *updateNotification(const UpdateNotificationRequest &request)
UpdateSubscriberResponse *updateSubscriber(const UpdateSubscriberRequest &request)

Additional Inherited Members

Detailed Description

The BudgetsClient class provides access to the AWS Budgets service.

Budgets enable you to plan your service usage, service costs, and your RI utilization. You can also track how close your plan is to your budgeted amount or to the free tier limits. Budgets provide you with a quick way to see your usage-to-date and current estimated charges from AWS and to see how much your predicted usage accrues in charges by the end of the month. Budgets also compare current estimates and charges to the amount that you indicated you want to use or spend and lets you see how much of your budget has been used. AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, and refunds. You can create the following types of

budgets> <ul> <li>

Cost budgets allow you to say how much you want to spend on a

service> </li> <li>

Usage budgets allow you to say how many hours you want to use for one or more

services> </li> <li>

RI utilization budgets allow you to define a utilization threshold and receive alerts when RIs are tracking below that

threshold> </li> </ul>

You can create up to 20,000 budgets per AWS master account. Your first two budgets are free of charge. Each additional budget costs $0.02 per day. You can set up optional notifications that warn you if you exceed, or are forecasted to exceed, your budgeted amount. You can have notifications sent to an Amazon SNS topic, to an email address, or to both. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-sns-policy.html">Creating an Amazon SNS Topic for Budget Notifications</a>. AWS Free Tier usage alerts via AWS Budgets are provided for you, and do not count toward your budget

limits>

Service

Endpoin>

The AWS Budgets API provides the following

endpoint> <ul> <li>

https://budgets.amazonaws.co> </li> </ul>

For information about costs associated with the AWS Budgets API, see <a href="https://aws.amazon.com/aws-cost-management/pricing/">AWS Cost Management

Member Function Documentation

BudgetsClient::BudgetsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a BudgetsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

BudgetsClient::BudgetsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads BudgetsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CreateBudgetResponse *BudgetsClient::createBudget(const CreateBudgetRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an CreateBudgetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateNotificationResponse *BudgetsClient::createNotification(const CreateNotificationRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an CreateNotificationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateSubscriberResponse *BudgetsClient::createSubscriber(const CreateSubscriberRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an CreateSubscriberResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteBudgetResponse *BudgetsClient::deleteBudget(const DeleteBudgetRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an DeleteBudgetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a budget. You can delete your budget at any

time>

<b>Deleting a budget also deletes the notifications and subscribers associated with that budget.</b>

[slot] DeleteNotificationResponse *BudgetsClient::deleteNotification(const DeleteNotificationRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an DeleteNotificationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a

notification>

<b>Deleting a notification also deletes the subscribers associated with the notification.</b>

[slot] DeleteSubscriberResponse *BudgetsClient::deleteSubscriber(const DeleteSubscriberRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an DeleteSubscriberResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a

subscriber>

<b>Deleting the last subscriber to a notification also deletes the notification.</b>

[slot] DescribeBudgetResponse *BudgetsClient::describeBudget(const DescribeBudgetRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an DescribeBudgetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes a

[slot] DescribeBudgetsResponse *BudgetsClient::describeBudgets(const DescribeBudgetsRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an DescribeBudgetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the budgets associated with an

[slot] DescribeNotificationsForBudgetResponse *BudgetsClient::describeNotificationsForBudget(const DescribeNotificationsForBudgetRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an DescribeNotificationsForBudgetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the notifications associated with a

[slot] DescribeSubscribersForNotificationResponse *BudgetsClient::describeSubscribersForNotification(const DescribeSubscribersForNotificationRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an DescribeSubscribersForNotificationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the subscribers associated with a

[slot] UpdateBudgetResponse *BudgetsClient::updateBudget(const UpdateBudgetRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an UpdateBudgetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When a budget is modified, the <code>calculatedSpend</code> drops to zero until AWS has new usage data to use for

[slot] UpdateNotificationResponse *BudgetsClient::updateNotification(const UpdateNotificationRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an UpdateNotificationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a

[slot] UpdateSubscriberResponse *BudgetsClient::updateSubscriber(const UpdateSubscriberRequest &request)

Sends request to the BudgetsClient service, and returns a pointer to an UpdateSubscriberResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.