View Source AWS.CostExplorer (aws-elixir v1.0.0)

You can use the Cost Explorer API 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. This might include 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:

*

https://ce.us-east-1.amazonaws.com

For information about the costs that are associated with the Cost Explorer API, see Amazon Web Services Cost Management Pricing.

Summary

Functions

Creates a new cost anomaly detection monitor with the requested type and monitor specification.

Adds an alert subscription to a cost anomaly detection monitor.

Creates a new Cost Category with the requested name and rules.

Deletes a cost anomaly subscription.

Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's defined in the account.

Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object.

Retrieves the cost anomaly monitor definitions for your account.

Retrieves the cost anomaly subscription objects for your account.

Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.

Retrieves cost and usage metrics for your account.

Retrieves cost and usage metrics with resources for your account.

Retrieves an array of Cost Category names and values incurred cost.

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.

Retrieves all available filter values for a specified filter over a period of time.

Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation.

Gets recommendations for reservation purchases.

Retrieves the reservation utilization for your account.

Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.

Retrieves the details for a Savings Plan recommendation.

Retrieves the Savings Plans covered for your account.

Retrieves the Savings Plans recommendations for your account.

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.

Retrieves attribute data along with aggregate utilization and savings data for a given time period.

Queries for available tag keys and tag values for a specified period.

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.

Retrieves a list of your historical cost allocation tag backfill requests.

Get a list of cost allocation tags.

Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective dates of all Cost Categories defined in the account.

Retrieves a list of your historical recommendation generations within the past 30 days.

Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).

Modifies the feedback property of a given cost anomaly.

An API operation for adding one or more tags (key-value pairs) to a resource.

Removes one or more tags from a resource.

Updates an existing cost anomaly monitor.

Updates an existing cost anomaly subscription.

Updates status for cost allocation tags in bulk, with maximum batch size of 20.

Functions

Link to this function

create_anomaly_monitor(client, input, options \\ [])

View Source

Creates a new cost anomaly detection monitor with the requested type and monitor specification.

Link to this function

create_anomaly_subscription(client, input, options \\ [])

View Source

Adds an alert subscription to a cost anomaly detection monitor.

You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set an absolute or percentage threshold and a time frequency for receiving notifications.

Link to this function

create_cost_category_definition(client, input, options \\ [])

View Source

Creates a new Cost Category with the requested name and rules.

Link to this function

delete_anomaly_monitor(client, input, options \\ [])

View Source

Deletes a cost anomaly monitor.

Link to this function

delete_anomaly_subscription(client, input, options \\ [])

View Source

Deletes a cost anomaly subscription.

Link to this function

delete_cost_category_definition(client, input, options \\ [])

View Source

Deletes a Cost Category.

Expenses from this month going forward will no longer be categorized with this Cost Category.

Link to this function

describe_cost_category_definition(client, input, options \\ [])

View Source

Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's defined in the account.

You have the option to use EffectiveOn to return a Cost Category that's active on a specific date. If there's no EffectiveOn specified, you see a Cost Category that's effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.

Link to this function

get_anomalies(client, input, options \\ [])

View Source

Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object.

Anomalies are available for up to 90 days.

Link to this function

get_anomaly_monitors(client, input, options \\ [])

View Source

Retrieves the cost anomaly monitor definitions for your account.

You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).

Link to this function

get_anomaly_subscriptions(client, input, options \\ [])

View Source

Retrieves the cost anomaly subscription objects for your account.

You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).

Link to this function

get_approximate_usage_records(client, input, options \\ [])

View Source

Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.

Link to this function

get_cost_and_usage(client, input, options \\ [])

View Source

Retrieves cost and usage metrics for your account.

You can specify which cost and usage-related metric that you want the request to return. For example, you can specify BlendedCosts or UsageQuantity. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts.

For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.

Link to this function

get_cost_and_usage_with_resources(client, input, options \\ [])

View Source

Retrieves cost and usage metrics with resources for your account.

You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information about how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.

Link to this function

get_cost_categories(client, input, options \\ [])

View Source

Retrieves an array of Cost Category names and values incurred cost.

If some Cost Category names and values are not associated with any cost, they will not be returned by this API.

Link to this function

get_cost_forecast(client, input, options \\ [])

View Source

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.

Link to this function

get_dimension_values(client, input, options \\ [])

View Source

Retrieves all available filter values for a specified filter over a period of time.

You can search the dimension values for an arbitrary string.

Link to this function

get_reservation_coverage(client, input, options \\ [])

View Source

Retrieves the reservation coverage for your account, which you can use to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation.

An organization's management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions:

* AZ

* CACHE_ENGINE

* DATABASE_ENGINE

* DEPLOYMENT_OPTION

* INSTANCE_TYPE

* LINKED_ACCOUNT

* OPERATING_SYSTEM

* PLATFORM

* REGION

* SERVICE

* TAG

* TENANCY

To determine valid values for a dimension, use the GetDimensionValues operation.

Link to this function

get_reservation_purchase_recommendation(client, input, options \\ [])

View Source

Gets recommendations for reservation purchases.

These recommendations might help you to reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

Amazon Web Services generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After Amazon Web Services has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of Reserved Instance (RI) to purchase to maximize your estimated savings.

For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of normalized units. This way, you can purchase any instance size that you want. For this example, your RI recommendation is for c4.large because that is the smallest size instance in the c4 instance family.

Link to this function

get_reservation_utilization(client, input, options \\ [])

View Source

Retrieves the reservation utilization for your account.

Management account in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.

Link to this function

get_rightsizing_recommendation(client, input, options \\ [])

View Source

Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.

Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For more information about calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide.

Link to this function

get_savings_plan_purchase_recommendation_details(client, input, options \\ [])

View Source

Retrieves the details for a Savings Plan recommendation.

These details include the hourly data-points that construct the cost, coverage, and utilization charts.

Link to this function

get_savings_plans_coverage(client, input, options \\ [])

View Source

Retrieves the Savings Plans covered for your account.

This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:

*

LINKED_ACCOUNT

*

REGION

*

SERVICE

*

INSTANCE_FAMILY

To determine valid values for a dimension, use the GetDimensionValues operation.

Link to this function

get_savings_plans_purchase_recommendation(client, input, options \\ [])

View Source

Retrieves the Savings Plans recommendations for your account.

First use StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve them.

Link to this function

get_savings_plans_utilization(client, input, options \\ [])

View Source

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.

Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

You can't group by any dimension values for GetSavingsPlansUtilization.

Link to this function

get_savings_plans_utilization_details(client, input, options \\ [])

View Source

Retrieves attribute data along with aggregate utilization and savings data for a given time period.

This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

Link to this function

get_tags(client, input, options \\ [])

View Source

Queries for available tag keys and tag values for a specified period.

You can search the tag values for an arbitrary string.

Link to this function

get_usage_forecast(client, input, options \\ [])

View Source

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.

Link to this function

list_cost_allocation_tag_backfill_history(client, input, options \\ [])

View Source

Retrieves a list of your historical cost allocation tag backfill requests.

Link to this function

list_cost_allocation_tags(client, input, options \\ [])

View Source

Get a list of cost allocation tags.

All inputs in the API are optional and serve as filters. By default, all cost allocation tags are returned.

Link to this function

list_cost_category_definitions(client, input, options \\ [])

View Source

Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective dates of all Cost Categories defined in the account.

You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response. ListCostCategoryDefinitions supports pagination. The request can have a MaxResults range up to 100.

Link to this function

list_savings_plans_purchase_recommendation_generation(client, input, options \\ [])

View Source

Retrieves a list of your historical recommendation generations within the past 30 days.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).

Link to this function

provide_anomaly_feedback(client, input, options \\ [])

View Source

Modifies the feedback property of a given cost anomaly.

Link to this function

start_cost_allocation_tag_backfill(client, input, options \\ [])

View Source

Request a cost allocation tag backfill.

This will backfill the activation status (either active or inactive) for all tag keys from para:BackfillFrom up to the when this request is made.

You can request a backfill once every 24 hours.

Link to this function

start_savings_plans_purchase_recommendation_generation(client, input, options \\ [])

View Source

Requests a Savings Plans recommendation generation.

This enables you to calculate a fresh set of Savings Plans recommendations that takes your latest usage data and current Savings Plans inventory into account. You can refresh Savings Plans recommendations up to three times daily for a consolidated billing family.

StartSavingsPlansPurchaseRecommendationGeneration has no request syntax because no input parameters are needed to support this operation.

Link to this function

tag_resource(client, input, options \\ [])

View Source

An API operation for adding one or more tags (key-value pairs) to a resource.

You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value you specify replaces the previous value for that tag.

Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes one or more tags from a resource.

Specify only tag keys in your request. Don't specify the value.

Link to this function

update_anomaly_monitor(client, input, options \\ [])

View Source

Updates an existing cost anomaly monitor.

The changes made are applied going forward, and doesn't change anomalies detected in the past.

Link to this function

update_anomaly_subscription(client, input, options \\ [])

View Source

Updates an existing cost anomaly subscription.

Specify the fields that you want to update. Omitted fields are unchanged.

The JSON below describes the generic construct for each type. See Request Parameters for possible values as they apply to AnomalySubscription.

Link to this function

update_cost_allocation_tags_status(client, input, options \\ [])

View Source

Updates status for cost allocation tags in bulk, with maximum batch size of 20.

If the tag status that's updated is the same as the existing tag status, the request doesn't fail. Instead, it doesn't have any effect on the tag status (for example, activating the active tag).

Link to this function

update_cost_category_definition(client, input, options \\ [])

View Source

Updates an existing Cost Category.

Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.