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 { GetReservationUtilizationRequest, GetReservationUtilizationResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetReservationUtilizationCommand}. */ export interface GetReservationUtilizationCommandInput extends GetReservationUtilizationRequest { } /** * @public * * The output of {@link GetReservationUtilizationCommand}. */ export interface GetReservationUtilizationCommandOutput extends GetReservationUtilizationResponse, __MetadataBearer { } declare const GetReservationUtilizationCommand_base: { new (input: GetReservationUtilizationCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetReservationUtilizationCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CostExplorerClient, GetReservationUtilizationCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import * // const { CostExplorerClient, GetReservationUtilizationCommand } = 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 = { // GetReservationUtilizationRequest * TimePeriod: { // DateInterval * Start: "STRING_VALUE", // required * End: "STRING_VALUE", // required * }, * GroupBy: [ // GroupDefinitions * { // GroupDefinition * Type: "DIMENSION" || "TAG" || "COST_CATEGORY", * Key: "STRING_VALUE", * }, * ], * Granularity: "DAILY" || "MONTHLY" || "HOURLY", * 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: "", * }, * }, * SortBy: { // SortDefinition * Key: "STRING_VALUE", // required * SortOrder: "ASCENDING" || "DESCENDING", * }, * NextPageToken: "STRING_VALUE", * MaxResults: Number("int"), * }; * const command = new GetReservationUtilizationCommand(input); * const response = await client.send(command); * // { // GetReservationUtilizationResponse * // UtilizationsByTime: [ // UtilizationsByTime // required * // { // UtilizationByTime * // TimePeriod: { // DateInterval * // Start: "STRING_VALUE", // required * // End: "STRING_VALUE", // required * // }, * // Groups: [ // ReservationUtilizationGroups * // { // ReservationUtilizationGroup * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // Attributes: { // Attributes * // "": "STRING_VALUE", * // }, * // Utilization: { // ReservationAggregates * // UtilizationPercentage: "STRING_VALUE", * // UtilizationPercentageInUnits: "STRING_VALUE", * // PurchasedHours: "STRING_VALUE", * // PurchasedUnits: "STRING_VALUE", * // TotalActualHours: "STRING_VALUE", * // TotalActualUnits: "STRING_VALUE", * // UnusedHours: "STRING_VALUE", * // UnusedUnits: "STRING_VALUE", * // OnDemandCostOfRIHoursUsed: "STRING_VALUE", * // NetRISavings: "STRING_VALUE", * // TotalPotentialRISavings: "STRING_VALUE", * // AmortizedUpfrontFee: "STRING_VALUE", * // AmortizedRecurringFee: "STRING_VALUE", * // TotalAmortizedFee: "STRING_VALUE", * // RICostForUnusedHours: "STRING_VALUE", * // RealizedSavings: "STRING_VALUE", * // UnrealizedSavings: "STRING_VALUE", * // }, * // }, * // ], * // Total: { * // UtilizationPercentage: "STRING_VALUE", * // UtilizationPercentageInUnits: "STRING_VALUE", * // PurchasedHours: "STRING_VALUE", * // PurchasedUnits: "STRING_VALUE", * // TotalActualHours: "STRING_VALUE", * // TotalActualUnits: "STRING_VALUE", * // UnusedHours: "STRING_VALUE", * // UnusedUnits: "STRING_VALUE", * // OnDemandCostOfRIHoursUsed: "STRING_VALUE", * // NetRISavings: "STRING_VALUE", * // TotalPotentialRISavings: "STRING_VALUE", * // AmortizedUpfrontFee: "STRING_VALUE", * // AmortizedRecurringFee: "STRING_VALUE", * // TotalAmortizedFee: "STRING_VALUE", * // RICostForUnusedHours: "STRING_VALUE", * // RealizedSavings: "STRING_VALUE", * // UnrealizedSavings: "STRING_VALUE", * // }, * // }, * // ], * // Total: "", * // NextPageToken: "STRING_VALUE", * // }; * * ``` * * @param GetReservationUtilizationCommandInput - {@link GetReservationUtilizationCommandInput} * @returns {@link GetReservationUtilizationCommandOutput} * @see {@link GetReservationUtilizationCommandInput} for command's `input` shape. * @see {@link GetReservationUtilizationCommandOutput} for command's `response` shape. * @see {@link CostExplorerClientResolvedConfig | config} for CostExplorerClient's `config` shape. * * @throws {@link DataUnavailableException} (client fault) *

The requested data is unavailable.

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

The pagination token is invalid. Try again without a pagination token.

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

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

* * @throws {@link CostExplorerServiceException} *

Base exception class for all service exceptions from CostExplorer service.

* * * @public */ export declare class GetReservationUtilizationCommand extends GetReservationUtilizationCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetReservationUtilizationRequest; output: GetReservationUtilizationResponse; }; sdk: { input: GetReservationUtilizationCommandInput; output: GetReservationUtilizationCommandOutput; }; }; }