View Source aws_cost_explorer (aws v0.7.13)
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
Link to this section Summary
Functions
Adds an alert subscription to a cost anomaly detection monitor.
Deletes a Cost Category.
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 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 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 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.
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.
Requests a Savings Plans recommendation generation.
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 status for cost allocation tags in bulk, with maximum batch size of 20.
Updates an existing Cost Category.
Link to this section Functions
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.Deletes a Cost Category.
Expenses from this month going forward will no longer be categorized with this Cost Category.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 useEffectiveOn 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.
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.
You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).Retrieves the cost anomaly subscription objects for your account.
You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).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.
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.
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.Retrieves all available filter values for a specified filter over a period of time.
You can search the dimension values for an arbitrary string.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
GetDimensionValues operation.
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 forc4.large because that is the smallest size instance in the c4 instance family.
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 useGetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.
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.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_ACCOUNTREGIONSERVICEINSTANCE_FAMILY
GetDimensionValues operation.
Retrieves the Savings Plans recommendations for your account.
First useStartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve them.
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.
GetSavingsPlansUtilization.
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.
Queries for available tag keys and tag values for a specified period.
You can search the tag values for an arbitrary string.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.Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective dates of all Cost Categories defined in the account.
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.
list_savings_plans_purchase_recommendation_generation(Client, Input)
View Sourcelist_savings_plans_purchase_recommendation_generation(Client, Input, Options)
View Sourcestart_savings_plans_purchase_recommendation_generation(Client, Input)
View SourceRequests 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.
start_savings_plans_purchase_recommendation_generation(Client, Input, Options)
View SourceAn 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.
Removes one or more tags from a resource.
Specify only tag keys in your request. Don't specify the value.Updates an existing cost anomaly monitor.
The changes made are applied going forward, and doesn't change anomalies detected in the past.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).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.