Client
budgets | R Documentation |
AWS Budgets¶
Description¶
Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.
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 Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
-
How much of your budget has been used
Amazon Web Services 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 Amazon Web Services Budgets API provides the following endpoint:
- https://budgets.amazonaws.com
For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
Usage¶
Arguments¶
config
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to
true
to force the request to use path-style addressing, i.e.http://s3.amazonaws.com/BUCKET/KEY
.sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint
Optional shorthand for complete URL to use for the constructed client.
region
Optional shorthand for AWS Region used in instantiating the client.
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¶
svc <- budgets(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
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
- Lists the budget names and notifications that are associated with an account
- 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
- list_tags_for_resource
- Lists tags associated with a budget or budget action resource
- tag_resource
- Creates tags for a budget or budget action resource
- untag_resource
- Deletes tags associated with a budget or budget action resource
- update_budget
- Updates a budget
- update_budget_action
- Updates a budget action
- update_notification
- Updates a notification
- update_subscriber
- Updates a subscriber