import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CostExplorerClient"; import type { GetCostForecastRequest, GetCostForecastResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetCostForecastCommand}. */ export interface GetCostForecastCommandInput extends GetCostForecastRequest { } /** * @public * * The output of {@link GetCostForecastCommand}. */ export interface GetCostForecastCommandOutput extends GetCostForecastResponse, __MetadataBearer { } declare const GetCostForecastCommand_base: { new (input: GetCostForecastCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetCostForecastCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CostExplorerClient, GetCostForecastCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import * // const { CostExplorerClient, GetCostForecastCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import * // import type { CostExplorerClientConfig } from "@aws-sdk/client-cost-explorer"; * const config = {}; // type is CostExplorerClientConfig * const client = new CostExplorerClient(config); * const input = { // GetCostForecastRequest * TimePeriod: { // DateInterval * Start: "STRING_VALUE", // required * End: "STRING_VALUE", // required * }, * Metric: "BLENDED_COST" || "UNBLENDED_COST" || "AMORTIZED_COST" || "NET_UNBLENDED_COST" || "NET_AMORTIZED_COST" || "USAGE_QUANTITY" || "NORMALIZED_USAGE_AMOUNT", // required * Granularity: "DAILY" || "MONTHLY" || "HOURLY", // required * Filter: { // Expression * Or: [ // Expressions * { * Or: [ * "", * ], * And: [ * "", * ], * Not: "", * Dimensions: { // DimensionValues * Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "PAYER_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "AGREEMENT_END_DATE_TIME_AFTER" || "AGREEMENT_END_DATE_TIME_BEFORE" || "INVOICING_ENTITY" || "ANOMALY_TOTAL_IMPACT_ABSOLUTE" || "ANOMALY_TOTAL_IMPACT_PERCENTAGE", * Values: [ // Values * "STRING_VALUE", * ], * MatchOptions: [ // MatchOptions * "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL", * ], * }, * Tags: { // TagValues * Key: "STRING_VALUE", * Values: [ * "STRING_VALUE", * ], * MatchOptions: [ * "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL", * ], * }, * CostCategories: { // CostCategoryValues * Key: "STRING_VALUE", * Values: [ * "STRING_VALUE", * ], * MatchOptions: [ * "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL", * ], * }, * }, * ], * And: [ * "", * ], * Not: "", * Dimensions: { * Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "PAYER_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "AGREEMENT_END_DATE_TIME_AFTER" || "AGREEMENT_END_DATE_TIME_BEFORE" || "INVOICING_ENTITY" || "ANOMALY_TOTAL_IMPACT_ABSOLUTE" || "ANOMALY_TOTAL_IMPACT_PERCENTAGE", * Values: [ * "STRING_VALUE", * ], * MatchOptions: [ * "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL", * ], * }, * Tags: { * Key: "STRING_VALUE", * Values: [ * "STRING_VALUE", * ], * MatchOptions: [ * "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL", * ], * }, * CostCategories: { * Key: "STRING_VALUE", * Values: "", * MatchOptions: "", * }, * }, * BillingViewArn: "STRING_VALUE", * PredictionIntervalLevel: Number("int"), * }; * const command = new GetCostForecastCommand(input); * const response = await client.send(command); * // { // GetCostForecastResponse * // Total: { // MetricValue * // Amount: "STRING_VALUE", * // Unit: "STRING_VALUE", * // }, * // ForecastResultsByTime: [ // ForecastResultsByTime * // { // ForecastResult * // TimePeriod: { // DateInterval * // Start: "STRING_VALUE", // required * // End: "STRING_VALUE", // required * // }, * // MeanValue: "STRING_VALUE", * // PredictionIntervalLowerBound: "STRING_VALUE", * // PredictionIntervalUpperBound: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param GetCostForecastCommandInput - {@link GetCostForecastCommandInput} * @returns {@link GetCostForecastCommandOutput} * @see {@link GetCostForecastCommandInput} for command's `input` shape. * @see {@link GetCostForecastCommandOutput} for command's `response` shape. * @see {@link CostExplorerClientResolvedConfig | config} for CostExplorerClient's `config` shape. * * @throws {@link BillingViewHealthStatusException} (client fault) *

* The billing view status must be HEALTHY to perform this action. Try again when the status is HEALTHY. *

* * @throws {@link DataUnavailableException} (client fault) *

The requested data is unavailable.

* * @throws {@link LimitExceededException} (client fault) *

You made too many calls in a short period of time. Try again later.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified ARN in the request doesn't exist.

* * @throws {@link CostExplorerServiceException} *

Base exception class for all service exceptions from CostExplorer service.

* * * @public */ export declare class GetCostForecastCommand extends GetCostForecastCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetCostForecastRequest; output: GetCostForecastResponse; }; sdk: { input: GetCostForecastCommandInput; output: GetCostForecastCommandOutput; }; }; }