AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Interface for accessing CostExplorer
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.
Namespace: Amazon.CostExplorer
Assembly: AWSSDK.CostExplorer.dll
Version: 3.x.y.z
public interface IAmazonCostExplorer IAmazonService, IDisposable
The IAmazonCostExplorer type exposes the following members
Name | Type | Description | |
---|---|---|---|
Paginators | Amazon.CostExplorer.Model.ICostExplorerPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
CreateAnomalyMonitor(CreateAnomalyMonitorRequest) |
Creates a new cost anomaly detection monitor with the requested type and monitor specification. |
|
CreateAnomalyMonitorAsync(CreateAnomalyMonitorRequest, CancellationToken) |
Creates a new cost anomaly detection monitor with the requested type and monitor specification. |
|
CreateAnomalySubscription(CreateAnomalySubscriptionRequest) |
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. |
|
CreateAnomalySubscriptionAsync(CreateAnomalySubscriptionRequest, CancellationToken) |
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. |
|
CreateCostCategoryDefinition(CreateCostCategoryDefinitionRequest) |
Creates a new Cost Category with the requested name and rules. |
|
CreateCostCategoryDefinitionAsync(CreateCostCategoryDefinitionRequest, CancellationToken) |
Creates a new Cost Category with the requested name and rules. |
|
DeleteAnomalyMonitor(DeleteAnomalyMonitorRequest) |
Deletes a cost anomaly monitor. |
|
DeleteAnomalyMonitorAsync(DeleteAnomalyMonitorRequest, CancellationToken) |
Deletes a cost anomaly monitor. |
|
DeleteAnomalySubscription(DeleteAnomalySubscriptionRequest) |
Deletes a cost anomaly subscription. |
|
DeleteAnomalySubscriptionAsync(DeleteAnomalySubscriptionRequest, CancellationToken) |
Deletes a cost anomaly subscription. |
|
DeleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest) |
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category. |
|
DeleteCostCategoryDefinitionAsync(DeleteCostCategoryDefinitionRequest, CancellationToken) |
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category. |
|
DescribeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest) |
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 |
|
DescribeCostCategoryDefinitionAsync(DescribeCostCategoryDefinitionRequest, CancellationToken) |
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 |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
GetAnomalies(GetAnomaliesRequest) |
Retrieves all of the cost anomalies detected on your account during the time period
that's specified by the |
|
GetAnomaliesAsync(GetAnomaliesRequest, CancellationToken) |
Retrieves all of the cost anomalies detected on your account during the time period
that's specified by the |
|
GetAnomalyMonitors(GetAnomalyMonitorsRequest) |
Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs). |
|
GetAnomalyMonitorsAsync(GetAnomalyMonitorsRequest, CancellationToken) |
Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs). |
|
GetAnomalySubscriptions(GetAnomalySubscriptionsRequest) |
Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs). |
|
GetAnomalySubscriptionsAsync(GetAnomalySubscriptionsRequest, CancellationToken) |
Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs). |
|
GetApproximateUsageRecords(GetApproximateUsageRecordsRequest) |
Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity. |
|
GetApproximateUsageRecordsAsync(GetApproximateUsageRecordsRequest, CancellationToken) |
Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity. |
|
GetCostAndUsage(GetCostAndUsageRequest) |
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. |
|
GetCostAndUsageAsync(GetCostAndUsageRequest, CancellationToken) |
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. |
|
GetCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest) |
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. |
|
GetCostAndUsageWithResourcesAsync(GetCostAndUsageWithResourcesRequest, CancellationToken) |
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. |
|
GetCostCategories(GetCostCategoriesRequest) |
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.
|
|
GetCostCategoriesAsync(GetCostCategoriesRequest, CancellationToken) |
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.
|
|
GetCostForecast(GetCostForecastRequest) |
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. |
|
GetCostForecastAsync(GetCostForecastRequest, CancellationToken) |
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. |
|
GetDimensionValues(GetDimensionValuesRequest) |
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. |
|
GetDimensionValuesAsync(GetDimensionValuesRequest, CancellationToken) |
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. |
|
GetReservationCoverage(GetReservationCoverageRequest) |
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 |
|
GetReservationCoverageAsync(GetReservationCoverageRequest, CancellationToken) |
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 |
|
GetReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest) |
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 |
|
GetReservationPurchaseRecommendationAsync(GetReservationPurchaseRecommendationRequest, CancellationToken) |
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 |
|
GetReservationUtilization(GetReservationUtilizationRequest) |
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 |
|
GetReservationUtilizationAsync(GetReservationUtilizationRequest, CancellationToken) |
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 |
|
GetRightsizingRecommendation(GetRightsizingRecommendationRequest) |
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. |
|
GetRightsizingRecommendationAsync(GetRightsizingRecommendationRequest, CancellationToken) |
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. |
|
GetSavingsPlanPurchaseRecommendationDetails(GetSavingsPlanPurchaseRecommendationDetailsRequest) |
Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts. |
|
GetSavingsPlanPurchaseRecommendationDetailsAsync(GetSavingsPlanPurchaseRecommendationDetailsRequest, CancellationToken) |
Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts. |
|
GetSavingsPlansCoverage(GetSavingsPlansCoverageRequest) |
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 |
|
GetSavingsPlansCoverageAsync(GetSavingsPlansCoverageRequest, CancellationToken) |
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 |
|
GetSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest) |
Retrieves the Savings Plans recommendations for your account. First use |
|
GetSavingsPlansPurchaseRecommendationAsync(GetSavingsPlansPurchaseRecommendationRequest, CancellationToken) |
Retrieves the Savings Plans recommendations for your account. First use |
|
GetSavingsPlansUtilization(GetSavingsPlansUtilizationRequest) |
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 |
|
GetSavingsPlansUtilizationAsync(GetSavingsPlansUtilizationRequest, CancellationToken) |
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 |
|
GetSavingsPlansUtilizationDetails(GetSavingsPlansUtilizationDetailsRequest) |
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
|
|
GetSavingsPlansUtilizationDetailsAsync(GetSavingsPlansUtilizationDetailsRequest, CancellationToken) |
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
|
|
GetTags(GetTagsRequest) |
Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. |
|
GetTagsAsync(GetTagsRequest, CancellationToken) |
Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. |
|
GetUsageForecast(GetUsageForecastRequest) |
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. |
|
GetUsageForecastAsync(GetUsageForecastRequest, CancellationToken) |
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. |
|
ListCostAllocationTagBackfillHistory(ListCostAllocationTagBackfillHistoryRequest) |
Retrieves a list of your historical cost allocation tag backfill requests. |
|
ListCostAllocationTagBackfillHistoryAsync(ListCostAllocationTagBackfillHistoryRequest, CancellationToken) |
Retrieves a list of your historical cost allocation tag backfill requests. |
|
ListCostAllocationTags(ListCostAllocationTagsRequest) |
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. |
|
ListCostAllocationTagsAsync(ListCostAllocationTagsRequest, CancellationToken) |
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. |
|
ListCostCategoryDefinitions(ListCostCategoryDefinitionsRequest) |
Returns the name, Amazon Resource Name (ARN), |
|
ListCostCategoryDefinitionsAsync(ListCostCategoryDefinitionsRequest, CancellationToken) |
Returns the name, Amazon Resource Name (ARN), |
|
ListSavingsPlansPurchaseRecommendationGeneration(ListSavingsPlansPurchaseRecommendationGenerationRequest) |
Retrieves a list of your historical recommendation generations within the past 30 days. |
|
ListSavingsPlansPurchaseRecommendationGenerationAsync(ListSavingsPlansPurchaseRecommendationGenerationRequest, CancellationToken) |
Retrieves a list of your historical recommendation generations within the past 30 days. |
|
ListTagsForResource(ListTagsForResourceRequest) |
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN). |
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN). |
|
ProvideAnomalyFeedback(ProvideAnomalyFeedbackRequest) |
Modifies the feedback property of a given cost anomaly. |
|
ProvideAnomalyFeedbackAsync(ProvideAnomalyFeedbackRequest, CancellationToken) |
Modifies the feedback property of a given cost anomaly. |
|
StartCostAllocationTagBackfill(StartCostAllocationTagBackfillRequest) |
Request a cost allocation tag backfill. This will backfill the activation status
(either You can request a backfill once every 24 hours. |
|
StartCostAllocationTagBackfillAsync(StartCostAllocationTagBackfillRequest, CancellationToken) |
Request a cost allocation tag backfill. This will backfill the activation status
(either You can request a backfill once every 24 hours. |
|
StartSavingsPlansPurchaseRecommendationGeneration(StartSavingsPlansPurchaseRecommendationGenerationRequest) |
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.
|
|
StartSavingsPlansPurchaseRecommendationGenerationAsync(StartSavingsPlansPurchaseRecommendationGenerationRequest, CancellationToken) |
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.
|
|
TagResource(TagResourceRequest) |
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. |
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
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. |
|
UntagResource(UntagResourceRequest) |
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value. |
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value. |
|
UpdateAnomalyMonitor(UpdateAnomalyMonitorRequest) |
Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past. |
|
UpdateAnomalyMonitorAsync(UpdateAnomalyMonitorRequest, CancellationToken) |
Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past. |
|
UpdateAnomalySubscription(UpdateAnomalySubscriptionRequest) |
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 |
|
UpdateAnomalySubscriptionAsync(UpdateAnomalySubscriptionRequest, CancellationToken) |
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 |
|
UpdateCostAllocationTagsStatus(UpdateCostAllocationTagsStatusRequest) |
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). |
|
UpdateCostAllocationTagsStatusAsync(UpdateCostAllocationTagsStatusRequest, CancellationToken) |
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). |
|
UpdateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest) |
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. |
|
UpdateCostCategoryDefinitionAsync(UpdateCostCategoryDefinitionRequest, CancellationToken) |
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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5