budgets: AWS Budgets

Description Usage Arguments Value Service syntax Operations Examples

View source: R/budgets_service.R

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:

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:

Service Endpoint

The AWS Budgets API provides the following endpoint:

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

Usage

1
budgets(config = list())

Arguments

config

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

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.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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

1
2
3
4
5
6
7
## Not run: 
svc <- budgets()
svc$create_budget(
  Foo = 123
)

## End(Not run)

paws.cost.management documentation built on Aug. 23, 2021, 9:20 a.m.