paws (version 0.1.12)

budgets: AWS Budgets

Description

The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Budgets.

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 AWS, and how much your predicted usage will accrue in charges by the end of the month

• How much of your budget has been used

AWS 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 AWS Budgets API provides the following endpoint:

• https://budgets.amazonaws.com

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

Usage

budgets(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- budgets(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_budget	Creates a budget and, if included, notifications and subscribers
create_budget_action	Creates a budget action
create_notification	Creates a notification
create_subscriber	Creates a subscriber
delete_budget	Deletes a budget
delete_budget_action	Deletes a budget action
delete_notification	Deletes a notification
delete_subscriber	Deletes a subscriber
describe_budget	Describes a budget
describe_budget_action	Describes a budget action detail
describe_budget_action_histories	Describes a budget action history detail
describe_budget_actions_for_account	Describes all of the budget actions for an account
describe_budget_actions_for_budget	Describes all of the budget actions for a budget
describe_budget_performance_history	Describes the history for DAILY, MONTHLY, and QUARTERLY budgets
describe_budgets	Lists the budgets that are associated with an account
describe_notifications_for_budget	Lists the notifications that are associated with a budget
describe_subscribers_for_notification	Lists the subscribers that are associated with a notification
execute_budget_action	Executes a budget action
update_budget	Updates a budget
update_budget_action	Updates a budget action
update_notification	Updates a notification
update_subscriber	Updates a subscriber

Examples

if (FALSE) {
svc <- budgets()
svc$create_budget(
  Foo = 123
)
}