UNPKG

65.4 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class CostExplorer extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: CostExplorer.Types.ClientConfiguration)
13 config: Config & CostExplorer.Types.ClientConfiguration;
14 /**
15 * Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.
16 */
17 getCostAndUsage(params: CostExplorer.Types.GetCostAndUsageRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetCostAndUsageResponse) => void): Request<CostExplorer.Types.GetCostAndUsageResponse, AWSError>;
18 /**
19 * Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.
20 */
21 getCostAndUsage(callback?: (err: AWSError, data: CostExplorer.Types.GetCostAndUsageResponse) => void): Request<CostExplorer.Types.GetCostAndUsageResponse, AWSError>;
22 /**
23 * 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.
24 */
25 getCostForecast(params: CostExplorer.Types.GetCostForecastRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetCostForecastResponse) => void): Request<CostExplorer.Types.GetCostForecastResponse, AWSError>;
26 /**
27 * 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.
28 */
29 getCostForecast(callback?: (err: AWSError, data: CostExplorer.Types.GetCostForecastResponse) => void): Request<CostExplorer.Types.GetCostForecastResponse, AWSError>;
30 /**
31 * Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
32 */
33 getDimensionValues(params: CostExplorer.Types.GetDimensionValuesRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetDimensionValuesResponse) => void): Request<CostExplorer.Types.GetDimensionValuesResponse, AWSError>;
34 /**
35 * Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
36 */
37 getDimensionValues(callback?: (err: AWSError, data: CostExplorer.Types.GetDimensionValuesResponse) => void): Request<CostExplorer.Types.GetDimensionValuesResponse, AWSError>;
38 /**
39 * Retrieves the reservation coverage for your account. This enables you 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 master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY To determine valid values for a dimension, use the GetDimensionValues operation.
40 */
41 getReservationCoverage(params: CostExplorer.Types.GetReservationCoverageRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetReservationCoverageResponse) => void): Request<CostExplorer.Types.GetReservationCoverageResponse, AWSError>;
42 /**
43 * Retrieves the reservation coverage for your account. This enables you 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 master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY To determine valid values for a dimension, use the GetDimensionValues operation.
44 */
45 getReservationCoverage(callback?: (err: AWSError, data: CostExplorer.Types.GetReservationCoverageResponse) => void): Request<CostExplorer.Types.GetReservationCoverageResponse, AWSError>;
46 /**
47 * Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing. AWS 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 AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings. For example, AWS 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. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large because that is the smallest size instance in the c4 instance family.
48 */
49 getReservationPurchaseRecommendation(params: CostExplorer.Types.GetReservationPurchaseRecommendationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetReservationPurchaseRecommendationResponse) => void): Request<CostExplorer.Types.GetReservationPurchaseRecommendationResponse, AWSError>;
50 /**
51 * Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing. AWS 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 AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings. For example, AWS 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. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large because that is the smallest size instance in the c4 instance family.
52 */
53 getReservationPurchaseRecommendation(callback?: (err: AWSError, data: CostExplorer.Types.GetReservationPurchaseRecommendationResponse) => void): Request<CostExplorer.Types.GetReservationPurchaseRecommendationResponse, AWSError>;
54 /**
55 * Retrieves the reservation utilization for your account. Master accounts 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.
56 */
57 getReservationUtilization(params: CostExplorer.Types.GetReservationUtilizationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetReservationUtilizationResponse) => void): Request<CostExplorer.Types.GetReservationUtilizationResponse, AWSError>;
58 /**
59 * Retrieves the reservation utilization for your account. Master accounts 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.
60 */
61 getReservationUtilization(callback?: (err: AWSError, data: CostExplorer.Types.GetReservationUtilizationResponse) => void): Request<CostExplorer.Types.GetReservationUtilizationResponse, AWSError>;
62 /**
63 * Creates recommendations that helps 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 details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations.
64 */
65 getRightsizingRecommendation(params: CostExplorer.Types.GetRightsizingRecommendationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetRightsizingRecommendationResponse) => void): Request<CostExplorer.Types.GetRightsizingRecommendationResponse, AWSError>;
66 /**
67 * Creates recommendations that helps 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 details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations.
68 */
69 getRightsizingRecommendation(callback?: (err: AWSError, data: CostExplorer.Types.GetRightsizingRecommendationResponse) => void): Request<CostExplorer.Types.GetRightsizingRecommendationResponse, AWSError>;
70 /**
71 * Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
72 */
73 getTags(params: CostExplorer.Types.GetTagsRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetTagsResponse) => void): Request<CostExplorer.Types.GetTagsResponse, AWSError>;
74 /**
75 * Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
76 */
77 getTags(callback?: (err: AWSError, data: CostExplorer.Types.GetTagsResponse) => void): Request<CostExplorer.Types.GetTagsResponse, AWSError>;
78 /**
79 * 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.
80 */
81 getUsageForecast(params: CostExplorer.Types.GetUsageForecastRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetUsageForecastResponse) => void): Request<CostExplorer.Types.GetUsageForecastResponse, AWSError>;
82 /**
83 * 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.
84 */
85 getUsageForecast(callback?: (err: AWSError, data: CostExplorer.Types.GetUsageForecastResponse) => void): Request<CostExplorer.Types.GetUsageForecastResponse, AWSError>;
86}
87declare namespace CostExplorer {
88 export type AccountScope = "PAYER"|"LINKED"|string;
89 export type AmortizedRecurringFee = string;
90 export type AmortizedUpfrontFee = string;
91 export type AttributeType = string;
92 export type AttributeValue = string;
93 export type Attributes = {[key: string]: AttributeValue};
94 export type Context = "COST_AND_USAGE"|"RESERVATIONS"|string;
95 export interface Coverage {
96 /**
97 * The amount of instance usage that the reservation covered, in hours.
98 */
99 CoverageHours?: CoverageHours;
100 /**
101 * The amount of instance usage that the reservation covered, in normalized units.
102 */
103 CoverageNormalizedUnits?: CoverageNormalizedUnits;
104 /**
105 * The amount of cost that the reservation covered.
106 */
107 CoverageCost?: CoverageCost;
108 }
109 export interface CoverageByTime {
110 /**
111 * The period that this coverage was used over.
112 */
113 TimePeriod?: DateInterval;
114 /**
115 * The groups of instances that the reservation covered.
116 */
117 Groups?: ReservationCoverageGroups;
118 /**
119 * The total reservation coverage, in hours.
120 */
121 Total?: Coverage;
122 }
123 export interface CoverageCost {
124 /**
125 * How much an On-Demand instance cost.
126 */
127 OnDemandCost?: OnDemandCost;
128 }
129 export interface CoverageHours {
130 /**
131 * The number of instance running hours that On-Demand Instances covered.
132 */
133 OnDemandHours?: OnDemandHours;
134 /**
135 * The number of instance running hours that reservations covered.
136 */
137 ReservedHours?: ReservedHours;
138 /**
139 * The total instance usage, in hours.
140 */
141 TotalRunningHours?: TotalRunningHours;
142 /**
143 * The percentage of instance hours that a reservation covered.
144 */
145 CoverageHoursPercentage?: CoverageHoursPercentage;
146 }
147 export type CoverageHoursPercentage = string;
148 export interface CoverageNormalizedUnits {
149 /**
150 * The number of normalized units that are covered by On-Demand Instances instead of a reservation.
151 */
152 OnDemandNormalizedUnits?: OnDemandNormalizedUnits;
153 /**
154 * The number of normalized units that a reservation covers.
155 */
156 ReservedNormalizedUnits?: ReservedNormalizedUnits;
157 /**
158 * The total number of normalized units that you used.
159 */
160 TotalRunningNormalizedUnits?: TotalRunningNormalizedUnits;
161 /**
162 * The percentage of your used instance normalized units that a reservation covers.
163 */
164 CoverageNormalizedUnitsPercentage?: CoverageNormalizedUnitsPercentage;
165 }
166 export type CoverageNormalizedUnitsPercentage = string;
167 export type CoveragesByTime = CoverageByTime[];
168 export interface CurrentInstance {
169 /**
170 * Resource ID of the current instance.
171 */
172 ResourceId?: GenericString;
173 /**
174 * Cost allocation resource tags applied to the instance.
175 */
176 Tags?: TagValuesList;
177 /**
178 * Details about the resource and utilization.
179 */
180 ResourceDetails?: ResourceDetails;
181 /**
182 * Utilization information of the current instance during the lookback period.
183 */
184 ResourceUtilization?: ResourceUtilization;
185 /**
186 * Number of hours during the lookback period covered by reservations.
187 */
188 ReservationCoveredHoursInLookbackPeriod?: GenericString;
189 /**
190 * Number of hours during the lookback period billed at On Demand rates.
191 */
192 OnDemandHoursInLookbackPeriod?: GenericString;
193 /**
194 * The total number of hours the instance ran during the lookback period.
195 */
196 TotalRunningHoursInLookbackPeriod?: GenericString;
197 /**
198 * Current On Demand cost of operating this instance on a monthly basis.
199 */
200 MonthlyCost?: GenericString;
201 /**
202 * The currency code that Amazon Web Services used to calculate the costs for this instance.
203 */
204 CurrencyCode?: GenericString;
205 }
206 export interface DateInterval {
207 /**
208 * The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01, AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.
209 */
210 Start: YearMonthDay;
211 /**
212 * The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01, AWS retrieves cost and usage data from the start date up to, but not including, 2017-05-01.
213 */
214 End: YearMonthDay;
215 }
216 export type Dimension = "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"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"|"RIGHTSIZING_TYPE"|string;
217 export interface DimensionValues {
218 /**
219 * The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.
220 */
221 Key?: Dimension;
222 /**
223 * The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values. Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute, Amazon Elasticsearch Service, Amazon ElastiCache, Amazon Redshift, and Amazon Relational Database Service.
224 */
225 Values?: Values;
226 }
227 export interface DimensionValuesWithAttributes {
228 /**
229 * The value of a dimension with a specific attribute.
230 */
231 Value?: Value;
232 /**
233 * The attribute that applies to a specific Dimension.
234 */
235 Attributes?: Attributes;
236 }
237 export type DimensionValuesWithAttributesList = DimensionValuesWithAttributes[];
238 export interface EC2InstanceDetails {
239 /**
240 * The instance family of the recommended reservation.
241 */
242 Family?: GenericString;
243 /**
244 * The type of instance that AWS recommends.
245 */
246 InstanceType?: GenericString;
247 /**
248 * The AWS Region of the recommended reservation.
249 */
250 Region?: GenericString;
251 /**
252 * The Availability Zone of the recommended reservation.
253 */
254 AvailabilityZone?: GenericString;
255 /**
256 * The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.
257 */
258 Platform?: GenericString;
259 /**
260 * Whether the recommended reservation is dedicated or shared.
261 */
262 Tenancy?: GenericString;
263 /**
264 * Whether the recommendation is for a current-generation instance.
265 */
266 CurrentGeneration?: GenericBoolean;
267 /**
268 * Whether the recommended reservation is size flexible.
269 */
270 SizeFlexEligible?: GenericBoolean;
271 }
272 export interface EC2ResourceDetails {
273 /**
274 * Hourly public On Demand rate for the instance type.
275 */
276 HourlyOnDemandRate?: GenericString;
277 /**
278 * The type of Amazon Web Services instance.
279 */
280 InstanceType?: GenericString;
281 /**
282 * The platform of the Amazon Web Services instance. The platform is the specific combination of operating system, license model, and software on an instance.
283 */
284 Platform?: GenericString;
285 /**
286 * The Amazon Web Services Region of the instance.
287 */
288 Region?: GenericString;
289 /**
290 * The SKU of the product.
291 */
292 Sku?: GenericString;
293 /**
294 * Memory capacity of Amazon Web Services instance.
295 */
296 Memory?: GenericString;
297 /**
298 * Network performance capacity of the Amazon Web Services instance.
299 */
300 NetworkPerformance?: GenericString;
301 /**
302 * The disk storage of the Amazon Web Services instance (Not EBS storage).
303 */
304 Storage?: GenericString;
305 /**
306 * Number of VCPU cores in the Amazon Web Services instance type.
307 */
308 Vcpu?: GenericString;
309 }
310 export interface EC2ResourceUtilization {
311 /**
312 * Maximum observed or expected CPU utilization of the instance.
313 */
314 MaxCpuUtilizationPercentage?: GenericString;
315 /**
316 * Maximum observed or expected memory utilization of the instance.
317 */
318 MaxMemoryUtilizationPercentage?: GenericString;
319 /**
320 * Maximum observed or expected storage utilization of the instance (does not measure EBS storage).
321 */
322 MaxStorageUtilizationPercentage?: GenericString;
323 }
324 export interface EC2Specification {
325 /**
326 * Whether you want a recommendation for standard or convertible reservations.
327 */
328 OfferingClass?: OfferingClass;
329 }
330 export interface ESInstanceDetails {
331 /**
332 * The class of instance that AWS recommends.
333 */
334 InstanceClass?: GenericString;
335 /**
336 * The size of instance that AWS recommends.
337 */
338 InstanceSize?: GenericString;
339 /**
340 * The AWS Region of the recommended reservation.
341 */
342 Region?: GenericString;
343 /**
344 * Whether the recommendation is for a current-generation instance.
345 */
346 CurrentGeneration?: GenericBoolean;
347 /**
348 * Whether the recommended reservation is size flexible.
349 */
350 SizeFlexEligible?: GenericBoolean;
351 }
352 export interface ElastiCacheInstanceDetails {
353 /**
354 * The instance family of the recommended reservation.
355 */
356 Family?: GenericString;
357 /**
358 * The type of node that AWS recommends.
359 */
360 NodeType?: GenericString;
361 /**
362 * The AWS Region of the recommended reservation.
363 */
364 Region?: GenericString;
365 /**
366 * The description of the recommended reservation.
367 */
368 ProductDescription?: GenericString;
369 /**
370 * Whether the recommendation is for a current generation instance.
371 */
372 CurrentGeneration?: GenericBoolean;
373 /**
374 * Whether the recommended reservation is size flexible.
375 */
376 SizeFlexEligible?: GenericBoolean;
377 }
378 export type Entity = string;
379 export type Estimated = boolean;
380 export interface Expression {
381 /**
382 * Return results that match either Dimension object.
383 */
384 Or?: Expressions;
385 /**
386 * Return results that match both Dimension objects.
387 */
388 And?: Expressions;
389 /**
390 * Return results that don't match a Dimension object.
391 */
392 Not?: Expression;
393 /**
394 * The specific Dimension to use for Expression.
395 */
396 Dimensions?: DimensionValues;
397 /**
398 * The specific Tag to use for Expression.
399 */
400 Tags?: TagValues;
401 }
402 export type Expressions = Expression[];
403 export interface ForecastResult {
404 /**
405 * The period of time that the forecast covers.
406 */
407 TimePeriod?: DateInterval;
408 /**
409 * The mean value of the forecast.
410 */
411 MeanValue?: GenericString;
412 /**
413 * The lower limit for the prediction interval.
414 */
415 PredictionIntervalLowerBound?: GenericString;
416 /**
417 * The upper limit for the prediction interval.
418 */
419 PredictionIntervalUpperBound?: GenericString;
420 }
421 export type ForecastResultsByTime = ForecastResult[];
422 export type GenericBoolean = boolean;
423 export type GenericString = string;
424 export interface GetCostAndUsageRequest {
425 /**
426 * Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
427 */
428 TimePeriod: DateInterval;
429 /**
430 * Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY. The GetCostAndUsageRequest operation supports only DAILY and MONTHLY granularities.
431 */
432 Granularity?: Granularity;
433 /**
434 * Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.
435 */
436 Filter?: Expression;
437 /**
438 * Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity. If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups. Metrics is required for GetCostAndUsage requests.
439 */
440 Metrics?: MetricNames;
441 /**
442 * You can group AWS costs using up to two different groups, either dimensions, tag keys, or both. When you group by tag key, you get all tag values, including empty strings. Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, and USAGE_TYPE.
443 */
444 GroupBy?: GroupDefinitions;
445 /**
446 * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
447 */
448 NextPageToken?: NextPageToken;
449 }
450 export interface GetCostAndUsageResponse {
451 /**
452 * The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
453 */
454 NextPageToken?: NextPageToken;
455 /**
456 * The groups that are specified by the Filter or GroupBy parameters in the request.
457 */
458 GroupDefinitions?: GroupDefinitions;
459 /**
460 * The time period that is covered by the results in the response.
461 */
462 ResultsByTime?: ResultsByTime;
463 }
464 export interface GetCostForecastRequest {
465 /**
466 * The period of time that you want the forecast to cover.
467 */
468 TimePeriod: DateInterval;
469 /**
470 * Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values for a GetCostForecast call are the following: AMORTIZED_COST BLENDED_COST NET_AMORTIZED_COST NET_UNBLENDED_COST UNBLENDED_COST
471 */
472 Metric: Metric;
473 /**
474 * How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts. The GetCostForecast operation supports only DAILY and MONTHLY granularities.
475 */
476 Granularity: Granularity;
477 /**
478 * The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.
479 */
480 Filter?: Expression;
481 /**
482 * Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
483 */
484 PredictionIntervalLevel?: PredictionIntervalLevel;
485 }
486 export interface GetCostForecastResponse {
487 /**
488 * How much you are forecasted to spend over the forecast period, in USD.
489 */
490 Total?: MetricValue;
491 /**
492 * The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.
493 */
494 ForecastResultsByTime?: ForecastResultsByTime;
495 }
496 export interface GetDimensionValuesRequest {
497 /**
498 * The value that you want to search the filter values for.
499 */
500 SearchString?: SearchString;
501 /**
502 * The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
503 */
504 TimePeriod: DateInterval;
505 /**
506 * The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.
507 */
508 Dimension: Dimension;
509 /**
510 * The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation. If you set the context to COST_AND_USAGE, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services. LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account. OPERATING_SYSTEM - The operating system. Examples are Windows or Linux. OPERATION - The action performed. Examples include RunInstance and CreateBucket. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances. SERVICE - The AWS service such as Amazon DynamoDB. USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs. USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute. RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits. If you set the context to RESERVATIONS, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux. DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. REGION - The AWS Region. SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone. TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI). TENANCY - The tenancy of a resource. Examples are shared or dedicated.
511 */
512 Context?: Context;
513 /**
514 * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
515 */
516 NextPageToken?: NextPageToken;
517 }
518 export interface GetDimensionValuesResponse {
519 /**
520 * The filters that you used to filter your request. Some dimensions are available only for a specific context. If you set the context to COST_AND_USAGE, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services. LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account. OPERATING_SYSTEM - The operating system. Examples are Windows or Linux. OPERATION - The action performed. Examples include RunInstance and CreateBucket. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances. SERVICE - The AWS service such as Amazon DynamoDB. USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs. USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute. RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits. If you set the context to RESERVATIONS, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux. DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. REGION - The AWS Region. SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone. TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI). TENANCY - The tenancy of a resource. Examples are shared or dedicated.
521 */
522 DimensionValues: DimensionValuesWithAttributesList;
523 /**
524 * The number of results that AWS returned at one time.
525 */
526 ReturnSize: PageSize;
527 /**
528 * The total number of search results.
529 */
530 TotalSize: PageSize;
531 /**
532 * The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
533 */
534 NextPageToken?: NextPageToken;
535 }
536 export interface GetReservationCoverageRequest {
537 /**
538 * The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
539 */
540 TimePeriod: DateInterval;
541 /**
542 * You can group the data by the following attributes: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION TENANCY
543 */
544 GroupBy?: GroupDefinitions;
545 /**
546 * The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY. If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.
547 */
548 Granularity?: Granularity;
549 /**
550 * Filters utilization data by dimensions. You can filter by the following dimensions: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together. If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.
551 */
552 Filter?: Expression;
553 /**
554 * The measurement that you want your reservation coverage reported in. Valid values are Hour, Unit, and Cost. You can use multiple values in a request.
555 */
556 Metrics?: MetricNames;
557 /**
558 * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
559 */
560 NextPageToken?: NextPageToken;
561 }
562 export interface GetReservationCoverageResponse {
563 /**
564 * The amount of time that your reservations covered.
565 */
566 CoveragesByTime: CoveragesByTime;
567 /**
568 * The total amount of instance usage that a reservation covered.
569 */
570 Total?: Coverage;
571 /**
572 * The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
573 */
574 NextPageToken?: NextPageToken;
575 }
576 export interface GetReservationPurchaseRecommendationRequest {
577 /**
578 * The account ID that is associated with the recommendation.
579 */
580 AccountId?: GenericString;
581 /**
582 * The specific service that you want recommendations for.
583 */
584 Service: GenericString;
585 /**
586 * The account scope that you want recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations. Valid values are PAYER and LINKED.
587 */
588 AccountScope?: AccountScope;
589 /**
590 * The number of previous days that you want AWS to consider when it calculates your recommendations.
591 */
592 LookbackPeriodInDays?: LookbackPeriodInDays;
593 /**
594 * The reservation term that you want recommendations for.
595 */
596 TermInYears?: TermInYears;
597 /**
598 * The reservation purchase option that you want recommendations for.
599 */
600 PaymentOption?: PaymentOption;
601 /**
602 * The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.
603 */
604 ServiceSpecification?: ServiceSpecification;
605 /**
606 * The number of recommendations that you want returned in a single response object.
607 */
608 PageSize?: NonNegativeInteger;
609 /**
610 * The pagination token that indicates the next set of results that you want to retrieve.
611 */
612 NextPageToken?: NextPageToken;
613 }
614 export interface GetReservationPurchaseRecommendationResponse {
615 /**
616 * Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.
617 */
618 Metadata?: ReservationPurchaseRecommendationMetadata;
619 /**
620 * Recommendations for reservations to purchase.
621 */
622 Recommendations?: ReservationPurchaseRecommendations;
623 /**
624 * The pagination token for the next set of retrievable results.
625 */
626 NextPageToken?: NextPageToken;
627 }
628 export interface GetReservationUtilizationRequest {
629 /**
630 * Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
631 */
632 TimePeriod: DateInterval;
633 /**
634 * Groups only by SUBSCRIPTION_ID. Metadata is included.
635 */
636 GroupBy?: GroupDefinitions;
637 /**
638 * If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY. The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.
639 */
640 Granularity?: Granularity;
641 /**
642 * Filters utilization data by dimensions. You can filter by the following dimensions: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE SCOPE TENANCY GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.
643 */
644 Filter?: Expression;
645 /**
646 * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
647 */
648 NextPageToken?: NextPageToken;
649 }
650 export interface GetReservationUtilizationResponse {
651 /**
652 * The amount of time that you used your RIs.
653 */
654 UtilizationsByTime: UtilizationsByTime;
655 /**
656 * The total amount of time that you used your RIs.
657 */
658 Total?: ReservationAggregates;
659 /**
660 * The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
661 */
662 NextPageToken?: NextPageToken;
663 }
664 export interface GetRightsizingRecommendationRequest {
665 Filter?: Expression;
666 /**
667 * The specific service that you want recommendations for.
668 */
669 Service: GenericString;
670 /**
671 * The number of recommendations that you want returned in a single response object.
672 */
673 PageSize?: NonNegativeInteger;
674 /**
675 * The pagination token that indicates the next set of results that you want to retrieve.
676 */
677 NextPageToken?: NextPageToken;
678 }
679 export interface GetRightsizingRecommendationResponse {
680 /**
681 * Information regarding this specific recommendation set.
682 */
683 Metadata?: RightsizingRecommendationMetadata;
684 /**
685 * Summary of this recommendation set.
686 */
687 Summary?: RightsizingRecommendationSummary;
688 /**
689 * Recommendations to rightsize resources.
690 */
691 RightsizingRecommendations?: RightsizingRecommendationList;
692 /**
693 * The token to retrieve the next set of results.
694 */
695 NextPageToken?: NextPageToken;
696 }
697 export interface GetTagsRequest {
698 /**
699 * The value that you want to search for.
700 */
701 SearchString?: SearchString;
702 /**
703 * The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
704 */
705 TimePeriod: DateInterval;
706 /**
707 * The key of the tag that you want to return values for.
708 */
709 TagKey?: TagKey;
710 /**
711 * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
712 */
713 NextPageToken?: NextPageToken;
714 }
715 export interface GetTagsResponse {
716 /**
717 * The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
718 */
719 NextPageToken?: NextPageToken;
720 /**
721 * The tags that match your request.
722 */
723 Tags: TagList;
724 /**
725 * The number of query results that AWS returns at a time.
726 */
727 ReturnSize: PageSize;
728 /**
729 * The total number of query results.
730 */
731 TotalSize: PageSize;
732 }
733 export interface GetUsageForecastRequest {
734 /**
735 * The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
736 */
737 TimePeriod: DateInterval;
738 /**
739 * Which metric Cost Explorer uses to create your forecast. Valid values for a GetUsageForecast call are the following: USAGE_QUANTITY NORMALIZED_USAGE_AMOUNT
740 */
741 Metric: Metric;
742 /**
743 * How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts. The GetUsageForecast operation supports only DAILY and MONTHLY granularities.
744 */
745 Granularity: Granularity;
746 /**
747 * The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.
748 */
749 Filter?: Expression;
750 /**
751 * Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
752 */
753 PredictionIntervalLevel?: PredictionIntervalLevel;
754 }
755 export interface GetUsageForecastResponse {
756 /**
757 * How much you're forecasted to use over the forecast period.
758 */
759 Total?: MetricValue;
760 /**
761 * The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.
762 */
763 ForecastResultsByTime?: ForecastResultsByTime;
764 }
765 export type Granularity = "DAILY"|"MONTHLY"|"HOURLY"|string;
766 export interface Group {
767 /**
768 * The keys that are included in this group.
769 */
770 Keys?: Keys;
771 /**
772 * The metrics that are included in this group.
773 */
774 Metrics?: Metrics;
775 }
776 export interface GroupDefinition {
777 /**
778 * The string that represents the type of group.
779 */
780 Type?: GroupDefinitionType;
781 /**
782 * The string that represents a key for a specified group.
783 */
784 Key?: GroupDefinitionKey;
785 }
786 export type GroupDefinitionKey = string;
787 export type GroupDefinitionType = "DIMENSION"|"TAG"|string;
788 export type GroupDefinitions = GroupDefinition[];
789 export type Groups = Group[];
790 export interface InstanceDetails {
791 /**
792 * The Amazon EC2 instances that AWS recommends that you purchase.
793 */
794 EC2InstanceDetails?: EC2InstanceDetails;
795 /**
796 * The Amazon RDS instances that AWS recommends that you purchase.
797 */
798 RDSInstanceDetails?: RDSInstanceDetails;
799 /**
800 * The Amazon Redshift instances that AWS recommends that you purchase.
801 */
802 RedshiftInstanceDetails?: RedshiftInstanceDetails;
803 /**
804 * The ElastiCache instances that AWS recommends that you purchase.
805 */
806 ElastiCacheInstanceDetails?: ElastiCacheInstanceDetails;
807 /**
808 * The Amazon ES instances that AWS recommends that you purchase.
809 */
810 ESInstanceDetails?: ESInstanceDetails;
811 }
812 export type Key = string;
813 export type Keys = Key[];
814 export type LookbackPeriodInDays = "SEVEN_DAYS"|"THIRTY_DAYS"|"SIXTY_DAYS"|string;
815 export type Metric = "BLENDED_COST"|"UNBLENDED_COST"|"AMORTIZED_COST"|"NET_UNBLENDED_COST"|"NET_AMORTIZED_COST"|"USAGE_QUANTITY"|"NORMALIZED_USAGE_AMOUNT"|string;
816 export type MetricAmount = string;
817 export type MetricName = string;
818 export type MetricNames = MetricName[];
819 export type MetricUnit = string;
820 export interface MetricValue {
821 /**
822 * The actual number that represents the metric.
823 */
824 Amount?: MetricAmount;
825 /**
826 * The unit that the metric is given in.
827 */
828 Unit?: MetricUnit;
829 }
830 export type Metrics = {[key: string]: MetricValue};
831 export interface ModifyRecommendationDetail {
832 /**
833 * Identifies whether this instance type is the Amazon Web Services default recommendation.
834 */
835 TargetInstances?: TargetInstancesList;
836 }
837 export type NetRISavings = string;
838 export type NextPageToken = string;
839 export type NonNegativeInteger = number;
840 export type OfferingClass = "STANDARD"|"CONVERTIBLE"|string;
841 export type OnDemandCost = string;
842 export type OnDemandCostOfRIHoursUsed = string;
843 export type OnDemandHours = string;
844 export type OnDemandNormalizedUnits = string;
845 export type PageSize = number;
846 export type PaymentOption = "NO_UPFRONT"|"PARTIAL_UPFRONT"|"ALL_UPFRONT"|"LIGHT_UTILIZATION"|"MEDIUM_UTILIZATION"|"HEAVY_UTILIZATION"|string;
847 export type PredictionIntervalLevel = number;
848 export type PurchasedHours = string;
849 export type PurchasedUnits = string;
850 export interface RDSInstanceDetails {
851 /**
852 * The instance family of the recommended reservation.
853 */
854 Family?: GenericString;
855 /**
856 * The type of instance that AWS recommends.
857 */
858 InstanceType?: GenericString;
859 /**
860 * The AWS Region of the recommended reservation.
861 */
862 Region?: GenericString;
863 /**
864 * The database engine that the recommended reservation supports.
865 */
866 DatabaseEngine?: GenericString;
867 /**
868 * The database edition that the recommended reservation supports.
869 */
870 DatabaseEdition?: GenericString;
871 /**
872 * Whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.
873 */
874 DeploymentOption?: GenericString;
875 /**
876 * The license model that the recommended reservation supports.
877 */
878 LicenseModel?: GenericString;
879 /**
880 * Whether the recommendation is for a current-generation instance.
881 */
882 CurrentGeneration?: GenericBoolean;
883 /**
884 * Whether the recommended reservation is size flexible.
885 */
886 SizeFlexEligible?: GenericBoolean;
887 }
888 export interface RedshiftInstanceDetails {
889 /**
890 * The instance family of the recommended reservation.
891 */
892 Family?: GenericString;
893 /**
894 * The type of node that AWS recommends.
895 */
896 NodeType?: GenericString;
897 /**
898 * The AWS Region of the recommended reservation.
899 */
900 Region?: GenericString;
901 /**
902 * Whether the recommendation is for a current-generation instance.
903 */
904 CurrentGeneration?: GenericBoolean;
905 /**
906 * Whether the recommended reservation is size flexible.
907 */
908 SizeFlexEligible?: GenericBoolean;
909 }
910 export interface ReservationAggregates {
911 /**
912 * The percentage of reservation time that you used.
913 */
914 UtilizationPercentage?: UtilizationPercentage;
915 /**
916 * The percentage of Amazon EC2 reservation time that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
917 */
918 UtilizationPercentageInUnits?: UtilizationPercentageInUnits;
919 /**
920 * How many reservation hours that you purchased.
921 */
922 PurchasedHours?: PurchasedHours;
923 /**
924 * How many Amazon EC2 reservation hours that you purchased, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
925 */
926 PurchasedUnits?: PurchasedUnits;
927 /**
928 * The total number of reservation hours that you used.
929 */
930 TotalActualHours?: TotalActualHours;
931 /**
932 * The total number of Amazon EC2 reservation hours that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
933 */
934 TotalActualUnits?: TotalActualUnits;
935 /**
936 * The number of reservation hours that you didn't use.
937 */
938 UnusedHours?: UnusedHours;
939 /**
940 * The number of Amazon EC2 reservation hours that you didn't use, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.
941 */
942 UnusedUnits?: UnusedUnits;
943 /**
944 * How much your reservation would cost if charged On-Demand rates.
945 */
946 OnDemandCostOfRIHoursUsed?: OnDemandCostOfRIHoursUsed;
947 /**
948 * How much you saved due to purchasing and utilizing reservation. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed.
949 */
950 NetRISavings?: NetRISavings;
951 /**
952 * How much you could save if you use your entire reservation.
953 */
954 TotalPotentialRISavings?: TotalPotentialRISavings;
955 /**
956 * The upfront cost of your reservation, amortized over the reservation period.
957 */
958 AmortizedUpfrontFee?: AmortizedUpfrontFee;
959 /**
960 * The monthly cost of your reservation, amortized over the reservation period.
961 */
962 AmortizedRecurringFee?: AmortizedRecurringFee;
963 /**
964 * The total cost of your reservation, amortized over the reservation period.
965 */
966 TotalAmortizedFee?: TotalAmortizedFee;
967 }
968 export interface ReservationCoverageGroup {
969 /**
970 * The attributes for this group of reservations.
971 */
972 Attributes?: Attributes;
973 /**
974 * How much instance usage this group of reservations covered.
975 */
976 Coverage?: Coverage;
977 }
978 export type ReservationCoverageGroups = ReservationCoverageGroup[];
979 export type ReservationGroupKey = string;
980 export type ReservationGroupValue = string;
981 export interface ReservationPurchaseRecommendation {
982 /**
983 * The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.
984 */
985 AccountScope?: AccountScope;
986 /**
987 * How many days of previous usage that AWS considers when making this recommendation.
988 */
989 LookbackPeriodInDays?: LookbackPeriodInDays;
990 /**
991 * The term of the reservation that you want recommendations for, in years.
992 */
993 TermInYears?: TermInYears;
994 /**
995 * The payment option for the reservation. For example, AllUpfront or NoUpfront.
996 */
997 PaymentOption?: PaymentOption;
998 /**
999 * Hardware specifications for the service that you want recommendations for.
1000 */
1001 ServiceSpecification?: ServiceSpecification;
1002 /**
1003 * Details about the recommended purchases.
1004 */
1005 RecommendationDetails?: ReservationPurchaseRecommendationDetails;
1006 /**
1007 * A summary about the recommended purchase.
1008 */
1009 RecommendationSummary?: ReservationPurchaseRecommendationSummary;
1010 }
1011 export interface ReservationPurchaseRecommendationDetail {
1012 /**
1013 * The account that this RI recommendation is for.
1014 */
1015 AccountId?: GenericString;
1016 /**
1017 * Details about the instances that AWS recommends that you purchase.
1018 */
1019 InstanceDetails?: InstanceDetails;
1020 /**
1021 * The number of instances that AWS recommends that you purchase.
1022 */
1023 RecommendedNumberOfInstancesToPurchase?: GenericString;
1024 /**
1025 * The number of normalized units that AWS recommends that you purchase.
1026 */
1027 RecommendedNormalizedUnitsToPurchase?: GenericString;
1028 /**
1029 * The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
1030 */
1031 MinimumNumberOfInstancesUsedPerHour?: GenericString;
1032 /**
1033 * The minimum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
1034 */
1035 MinimumNormalizedUnitsUsedPerHour?: GenericString;
1036 /**
1037 * The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
1038 */
1039 MaximumNumberOfInstancesUsedPerHour?: GenericString;
1040 /**
1041 * The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
1042 */
1043 MaximumNormalizedUnitsUsedPerHour?: GenericString;
1044 /**
1045 * The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
1046 */
1047 AverageNumberOfInstancesUsedPerHour?: GenericString;
1048 /**
1049 * The average number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
1050 */
1051 AverageNormalizedUnitsUsedPerHour?: GenericString;
1052 /**
1053 * The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.
1054 */
1055 AverageUtilization?: GenericString;
1056 /**
1057 * How long AWS estimates that it takes for this instance to start saving you money, in months.
1058 */
1059 EstimatedBreakEvenInMonths?: GenericString;
1060 /**
1061 * The currency code that AWS used to calculate the costs for this instance.
1062 */
1063 CurrencyCode?: GenericString;
1064 /**
1065 * How much AWS estimates that this specific recommendation could save you in a month.
1066 */
1067 EstimatedMonthlySavingsAmount?: GenericString;
1068 /**
1069 * How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.
1070 */
1071 EstimatedMonthlySavingsPercentage?: GenericString;
1072 /**
1073 * How much AWS estimates that you spend on On-Demand Instances in a month.
1074 */
1075 EstimatedMonthlyOnDemandCost?: GenericString;
1076 /**
1077 * How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation.
1078 */
1079 EstimatedReservationCostForLookbackPeriod?: GenericString;
1080 /**
1081 * How much purchasing this instance costs you upfront.
1082 */
1083 UpfrontCost?: GenericString;
1084 /**
1085 * How much purchasing this instance costs you on a monthly basis.
1086 */
1087 RecurringStandardMonthlyCost?: GenericString;
1088 }
1089 export type ReservationPurchaseRecommendationDetails = ReservationPurchaseRecommendationDetail[];
1090 export interface ReservationPurchaseRecommendationMetadata {
1091 /**
1092 * The ID for this specific recommendation.
1093 */
1094 RecommendationId?: GenericString;
1095 /**
1096 * The time stamp for when AWS made this recommendation.
1097 */
1098 GenerationTimestamp?: GenericString;
1099 }
1100 export interface ReservationPurchaseRecommendationSummary {
1101 /**
1102 * The total amount that AWS estimates that this recommendation could save you in a month.
1103 */
1104 TotalEstimatedMonthlySavingsAmount?: GenericString;
1105 /**
1106 * The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs.
1107 */
1108 TotalEstimatedMonthlySavingsPercentage?: GenericString;
1109 /**
1110 * The currency code used for this recommendation.
1111 */
1112 CurrencyCode?: GenericString;
1113 }
1114 export type ReservationPurchaseRecommendations = ReservationPurchaseRecommendation[];
1115 export interface ReservationUtilizationGroup {
1116 /**
1117 * The key for a specific reservation attribute.
1118 */
1119 Key?: ReservationGroupKey;
1120 /**
1121 * The value of a specific reservation attribute.
1122 */
1123 Value?: ReservationGroupValue;
1124 /**
1125 * The attributes for this group of reservations.
1126 */
1127 Attributes?: Attributes;
1128 /**
1129 * How much you used this group of reservations.
1130 */
1131 Utilization?: ReservationAggregates;
1132 }
1133 export type ReservationUtilizationGroups = ReservationUtilizationGroup[];
1134 export type ReservedHours = string;
1135 export type ReservedNormalizedUnits = string;
1136 export interface ResourceDetails {
1137 /**
1138 * Details on the Amazon EC2 resource.
1139 */
1140 EC2ResourceDetails?: EC2ResourceDetails;
1141 }
1142 export interface ResourceUtilization {
1143 /**
1144 * Utilization of current Amazon EC2 Instance
1145 */
1146 EC2ResourceUtilization?: EC2ResourceUtilization;
1147 }
1148 export interface ResultByTime {
1149 /**
1150 * The time period that the result covers.
1151 */
1152 TimePeriod?: DateInterval;
1153 /**
1154 * The total amount of cost or usage accrued during the time period.
1155 */
1156 Total?: Metrics;
1157 /**
1158 * The groups that this time period includes.
1159 */
1160 Groups?: Groups;
1161 /**
1162 * Whether the result is estimated.
1163 */
1164 Estimated?: Estimated;
1165 }
1166 export type ResultsByTime = ResultByTime[];
1167 export interface RightsizingRecommendation {
1168 /**
1169 * The account that this recommendation is for.
1170 */
1171 AccountId?: GenericString;
1172 /**
1173 * Context regarding the current instance.
1174 */
1175 CurrentInstance?: CurrentInstance;
1176 /**
1177 * Recommendation to either terminate or modify the resource.
1178 */
1179 RightsizingType?: RightsizingType;
1180 /**
1181 * Details for modification recommendations.
1182 */
1183 ModifyRecommendationDetail?: ModifyRecommendationDetail;
1184 /**
1185 * Details for termination recommendations.
1186 */
1187 TerminateRecommendationDetail?: TerminateRecommendationDetail;
1188 }
1189 export type RightsizingRecommendationList = RightsizingRecommendation[];
1190 export interface RightsizingRecommendationMetadata {
1191 /**
1192 * The ID for this specific recommendation.
1193 */
1194 RecommendationId?: GenericString;
1195 /**
1196 * The time stamp for when Amazon Web Services made this recommendation.
1197 */
1198 GenerationTimestamp?: GenericString;
1199 /**
1200 * How many days of previous usage that Amazon Web Services considers when making this recommendation.
1201 */
1202 LookbackPeriodInDays?: LookbackPeriodInDays;
1203 }
1204 export interface RightsizingRecommendationSummary {
1205 /**
1206 * Total number of instance recommendations.
1207 */
1208 TotalRecommendationCount?: GenericString;
1209 /**
1210 * Estimated total savings resulting from modifications, on a monthly basis.
1211 */
1212 EstimatedTotalMonthlySavingsAmount?: GenericString;
1213 /**
1214 * The currency code that Amazon Web Services used to calculate the savings.
1215 */
1216 SavingsCurrencyCode?: GenericString;
1217 /**
1218 * Savings percentage based on the recommended modifications, relative to the total On Demand costs associated with these instances.
1219 */
1220 SavingsPercentage?: GenericString;
1221 }
1222 export type RightsizingType = "TERMINATE"|"MODIFY"|string;
1223 export type SearchString = string;
1224 export interface ServiceSpecification {
1225 /**
1226 * The Amazon EC2 hardware specifications that you want AWS to provide recommendations for.
1227 */
1228 EC2Specification?: EC2Specification;
1229 }
1230 export type TagKey = string;
1231 export type TagList = Entity[];
1232 export interface TagValues {
1233 /**
1234 * The key for the tag.
1235 */
1236 Key?: TagKey;
1237 /**
1238 * The specific value of the tag.
1239 */
1240 Values?: Values;
1241 }
1242 export type TagValuesList = TagValues[];
1243 export interface TargetInstance {
1244 /**
1245 * Expected cost to operate this instance type on a monthly basis.
1246 */
1247 EstimatedMonthlyCost?: GenericString;
1248 /**
1249 * Estimated savings resulting from modification, on a monthly basis.
1250 */
1251 EstimatedMonthlySavings?: GenericString;
1252 /**
1253 * The currency code that Amazon Web Services used to calculate the costs for this instance.
1254 */
1255 CurrencyCode?: GenericString;
1256 /**
1257 * Indicates whether or not this recommendation is the defaulted Amazon Web Services recommendation.
1258 */
1259 DefaultTargetInstance?: GenericBoolean;
1260 /**
1261 * Details on the target instance type.
1262 */
1263 ResourceDetails?: ResourceDetails;
1264 /**
1265 * Expected utilization metrics for target instance type.
1266 */
1267 ExpectedResourceUtilization?: ResourceUtilization;
1268 }
1269 export type TargetInstancesList = TargetInstance[];
1270 export type TermInYears = "ONE_YEAR"|"THREE_YEARS"|string;
1271 export interface TerminateRecommendationDetail {
1272 /**
1273 * Estimated savings resulting from modification, on a monthly basis.
1274 */
1275 EstimatedMonthlySavings?: GenericString;
1276 /**
1277 * The currency code that Amazon Web Services used to calculate the costs for this instance.
1278 */
1279 CurrencyCode?: GenericString;
1280 }
1281 export type TotalActualHours = string;
1282 export type TotalActualUnits = string;
1283 export type TotalAmortizedFee = string;
1284 export type TotalPotentialRISavings = string;
1285 export type TotalRunningHours = string;
1286 export type TotalRunningNormalizedUnits = string;
1287 export type UnusedHours = string;
1288 export type UnusedUnits = string;
1289 export interface UtilizationByTime {
1290 /**
1291 * The period of time that this utilization was used for.
1292 */
1293 TimePeriod?: DateInterval;
1294 /**
1295 * The groups that this utilization result uses.
1296 */
1297 Groups?: ReservationUtilizationGroups;
1298 /**
1299 * The total number of reservation hours that were used.
1300 */
1301 Total?: ReservationAggregates;
1302 }
1303 export type UtilizationPercentage = string;
1304 export type UtilizationPercentageInUnits = string;
1305 export type UtilizationsByTime = UtilizationByTime[];
1306 export type Value = string;
1307 export type Values = Value[];
1308 export type YearMonthDay = string;
1309 /**
1310 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1311 */
1312 export type apiVersion = "2017-10-25"|"latest"|string;
1313 export interface ClientApiVersions {
1314 /**
1315 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1316 */
1317 apiVersion?: apiVersion;
1318 }
1319 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1320 /**
1321 * Contains interfaces for use with the CostExplorer client.
1322 */
1323 export import Types = CostExplorer;
1324}
1325export = CostExplorer;