(constructor)

[configuration]

Constructs a new instance of the <code>CostExplorerClient</code> class

config

The resolved configuration of CostExplorerClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-cost-explorer!CostExplorerClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

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: <ul> <li> <code>https://ce.us-east-1.amazonaws.com</code> </li> </ul> For information about the costs that are associated with the Cost Explorer API, see <a href="http://aws.amazon.com/aws-cost-management/pricing/">Amazon Web Services Cost Management Pricing</a>.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

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

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 <code>EffectiveOn</code> to return a Cost Category that's active on a specific date. If there's no <code>EffectiveOn</code> specified, you see a Cost Category that's effective on the current date. If Cost Category is still effective, <code>EffectiveEnd</code> is omitted in the response.

GetAnomaliesCommand

Retrieves all of the cost anomalies detected on your account during the time period that's specified by the <code>DateInterval</code> object. Anomalies are available for up to 90 days.

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 <code>AnalysisId</code>.

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 <code>BlendedCosts</code> or <code>UsageQuantity</code>. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html">GetDimensionValues</a> operation. Management account in an organization in Organizations have access to all member accounts. For information about filter limitations, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-limits.html">Quotas and restrictions</a> 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 <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html">GetDimensionValues</a> operation. Management account in an organization in Organizations have access to all member accounts. Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud) resource-level data. All other resource-level data is available at daily granularity. <note> 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 <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-access.html">Controlling Access for Cost Explorer</a> in the Billing and Cost Management User Guide. </note>

GetCostCategoriesCommand

Retrieves an array of Cost Category names and values incurred cost. <note> If some Cost Category names and values are not associated with any cost, they will not be returned by this API. </note>

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: <ul> <li> AZ </li> <li> CACHE_ENGINE </li> <li> DATABASE_ENGINE </li> <li> DEPLOYMENT_OPTION </li> <li> INSTANCE_TYPE </li> <li> LINKED_ACCOUNT </li> <li> OPERATING_SYSTEM </li> <li> PLATFORM </li> <li> REGION </li> <li> SERVICE </li> <li> TAG </li> <li> TENANCY </li> </ul> To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation.

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 <code>c4.large</code> because that is the smallest size instance in the c4 instance family.

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 <code>GetDimensionValues</code> to determine the possible dimension values. Currently, you can group only by <code>SUBSCRIPTION_ID</code>.

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 <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-rightsizing.html">Optimizing Your Cost with Rightsizing Recommendations</a> 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: <ul> <li> <code>LINKED_ACCOUNT</code> </li> <li> <code>REGION</code> </li> <li> <code>SERVICE</code> </li> <li> <code>INSTANCE_FAMILY</code> </li> </ul> To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation.

GetSavingsPlansPurchaseRecommendationCommand

Retrieves the Savings Plans recommendations for your account. First use <code>StartSavingsPlansPurchaseRecommendationGeneration</code> to generate a new set of recommendations, and then use <code>GetSavingsPlansPurchaseRecommendation</code> to retrieve them.

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 <code>GetDimensionValues</code> in <code>SAVINGS_PLANS</code> to determine the possible dimension values. <note> You can't group by any dimension values for <code>GetSavingsPlansUtilization</code>. </note>

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 <code>GetSavingsPlanUtilization</code>, but you have the option to make multiple calls to <code>GetSavingsPlanUtilizationDetails</code> by providing individual dates. You can use <code>GetDimensionValues</code> in <code>SAVINGS_PLANS</code> to determine the possible dimension values. <note> <code>GetSavingsPlanUtilizationDetails</code> internally groups data by <code>SavingsPlansArn</code>. </note>

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), <code>NumberOfRules</code> and effective dates of all Cost Categories defined in the account. You have the option to use <code>EffectiveOn</code> to return a list of Cost Categories that were active on a specific date. If there is no <code>EffectiveOn</code> specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, <code>EffectiveEnd</code> is omitted in the response. <code>ListCostCategoryDefinitions</code> supports pagination. The request can have a <code>MaxResults</code> range up to 100.

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 <code>active</code> or <code>inactive</code>) for all tag keys from <code>para:BackfillFrom</code> up to the when this request is made. 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. <note> <code>StartSavingsPlansPurchaseRecommendationGeneration</code> has no request syntax because no input parameters are needed to support this operation. </note>

TagResourceCommand

An API operation for adding one or more tags (key-value pairs) to a resource. You can use the <code>TagResource</code> 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.

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. <note> The JSON below describes the generic construct for each type. See Request Parameters</a> for possible values as they apply to <code>AnomalySubscription</code>. </note>

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.