- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
CostExplorerClient
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 .
Installation
npm install @aws-sdk/client-cost-explorer
yarn add @aws-sdk/client-cost-explorer
pnpm add @aws-sdk/client-cost-explorer
CostExplorerClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateAnomalyMonitorCommand | Creates a new cost anomaly detection monitor with the requested type and monitor specification. |
CreateAnomalySubscriptionCommand | 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. |
CreateCostCategoryDefinitionCommand | Creates a new Cost Category with the requested name and rules. |
DeleteAnomalyMonitorCommand | Deletes a cost anomaly monitor. |
DeleteAnomalySubscriptionCommand | Deletes a cost anomaly subscription. |
DeleteCostCategoryDefinitionCommand | Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category. |
DescribeCostCategoryDefinitionCommand | 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 |
GetAnomaliesCommand | Retrieves all of the cost anomalies detected on your account during the time period that's specified by the |
GetAnomalyMonitorsCommand | Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs). |
GetAnomalySubscriptionsCommand | Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs). |
GetApproximateUsageRecordsCommand | Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity. |
GetCommitmentPurchaseAnalysisCommand | Retrieves a commitment purchase analysis result based on the |
GetCostAndUsageCommand | 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 For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide. |
GetCostAndUsageWithResourcesCommand | Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud) resource-level data. All other resource-level data is available at daily granularity. 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. |
GetCostCategoriesCommand | 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. |
GetCostForecastCommand | 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. |
GetDimensionValuesCommand | Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. |
GetReservationCoverageCommand | 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:
To determine valid values for a dimension, use the |
GetReservationPurchaseRecommendationCommand | 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 |
GetReservationUtilizationCommand | 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 |
GetRightsizingRecommendationCommand | 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. |
GetSavingsPlanPurchaseRecommendationDetailsCommand | Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts. |
GetSavingsPlansCoverageCommand | 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:
To determine valid values for a dimension, use the |
GetSavingsPlansPurchaseRecommendationCommand | Retrieves the Savings Plans recommendations for your account. First use |
GetSavingsPlansUtilizationCommand | 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 You can't group by any dimension values for |
GetSavingsPlansUtilizationDetailsCommand | 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 |
GetTagsCommand | Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. |
GetUsageForecastCommand | 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. |
ListCommitmentPurchaseAnalysesCommand | Lists the commitment purchase analyses for your account. |
ListCostAllocationTagBackfillHistoryCommand | Retrieves a list of your historical cost allocation tag backfill requests. |
ListCostAllocationTagsCommand | 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. |
ListCostCategoryDefinitionsCommand | Returns the name, Amazon Resource Name (ARN), |
ListSavingsPlansPurchaseRecommendationGenerationCommand | Retrieves a list of your historical recommendation generations within the past 30 days. |
ListTagsForResourceCommand | Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN). |
ProvideAnomalyFeedbackCommand | Modifies the feedback property of a given cost anomaly. |
StartCommitmentPurchaseAnalysisCommand | Specifies the parameters of a planned commitment purchase and starts the generation of the analysis. This enables you to estimate the cost, coverage, and utilization impact of your planned commitment purchases. |
StartCostAllocationTagBackfillCommand | Request a cost allocation tag backfill. This will backfill the activation status (either You can request a backfill once every 24 hours. |
StartSavingsPlansPurchaseRecommendationGenerationCommand | 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. |
TagResourceCommand | An API operation for adding one or more tags (key-value pairs) to a resource. You can use the Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use. |
UntagResourceCommand | Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value. |
UpdateAnomalyMonitorCommand | Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past. |
UpdateAnomalySubscriptionCommand | 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 |
UpdateCostAllocationTagsStatusCommand | 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). |
UpdateCostCategoryDefinitionCommand | 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. |
CostExplorerClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: CostExplorerClientConfig