costexplorer: AWS Cost Explorer Service

Description Usage Arguments Value Service syntax Operations Examples

View source: R/costexplorer_service.R

Description

The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.

Service Endpoint

The Cost Explorer API provides the following endpoint:

For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing.

Usage

1
costexplorer(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 <- costexplorer(
  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_anomaly_monitor Creates a new cost anomaly detection monitor with the requested type and monitor specification
create_anomaly_subscription Adds a subscription to a cost anomaly detection monitor
create_cost_category_definition Creates a new Cost Category with the requested name and rules
delete_anomaly_monitor Deletes a cost anomaly monitor
delete_anomaly_subscription Deletes a cost anomaly subscription
delete_cost_category_definition Deletes a Cost Category
describe_cost_category_definition Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account
get_anomalies Retrieves all of the cost anomalies detected on your account, during the time period specified by the DateInterval object
get_anomaly_monitors Retrieves the cost anomaly monitor definitions for your account
get_anomaly_subscriptions Retrieves the cost anomaly subscription objects for your account
get_cost_and_usage Retrieves cost and usage metrics for your account
get_cost_and_usage_with_resources Retrieves cost and usage metrics with resources for your account
get_cost_categories Retrieves an array of Cost Category names and values incurred cost
get_cost_forecast Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs
get_dimension_values Retrieves all available filter values for a specified filter over a period of time
get_reservation_coverage Retrieves the reservation coverage for your account
get_reservation_purchase_recommendation Gets recommendations for which reservations to purchase
get_reservation_utilization Retrieves the reservation utilization for your account
get_rightsizing_recommendation Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances
get_savings_plans_coverage Retrieves the Savings Plans covered for your account
get_savings_plans_purchase_recommendation Retrieves your request parameters, Savings Plan Recommendations Summary and Details
get_savings_plans_utilization Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity
get_savings_plans_utilization_details Retrieves attribute data along with aggregate utilization and savings data for a given time period
get_tags Queries for available tag keys and tag values for a specified period
get_usage_forecast Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage
list_cost_category_definitions Returns the name, ARN, NumberOfRules and effective dates of all Cost Categories defined in the account
provide_anomaly_feedback Modifies the feedback property of a given cost anomaly
update_anomaly_monitor Updates an existing cost anomaly monitor
update_anomaly_subscription Updates an existing cost anomaly monitor subscription
update_cost_category_definition Updates an existing Cost Category

Examples

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

## End(Not run)

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