@aws-sdk/client-cost-optimization-hub 3.934.0 → 3.936.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist-cjs/index.js +158 -81
- package/dist-es/CostOptimizationHub.js +2 -0
- package/dist-es/commands/ListEfficiencyMetricsCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +85 -0
- package/dist-es/models/errors.js +67 -0
- package/dist-es/models/models_0.js +1 -148
- package/dist-es/pagination/ListEfficiencyMetricsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +55 -1
- package/dist-types/CostOptimizationHub.d.ts +7 -0
- package/dist-types/CostOptimizationHubClient.d.ts +3 -2
- package/dist-types/commands/ListEfficiencyMetricsCommand.d.ts +111 -0
- package/dist-types/commands/UpdateEnrollmentStatusCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +3 -1
- package/dist-types/models/enums.d.ts +211 -0
- package/dist-types/models/errors.d.ts +79 -0
- package/dist-types/models/models_0.d.ts +127 -283
- package/dist-types/pagination/ListEfficiencyMetricsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +8 -0
- package/dist-types/ts3.4/CostOptimizationHub.d.ts +17 -0
- package/dist-types/ts3.4/CostOptimizationHubClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/ListEfficiencyMetricsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/index.d.ts +3 -1
- package/dist-types/ts3.4/models/enums.d.ts +109 -0
- package/dist-types/ts3.4/models/errors.d.ts +42 -0
- package/dist-types/ts3.4/models/models_0.d.ts +46 -146
- package/dist-types/ts3.4/pagination/ListEfficiencyMetricsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +8 -0
- package/package.json +19 -19
- package/dist-es/models/index.js +0 -1
- package/dist-types/models/index.d.ts +0 -1
- package/dist-types/ts3.4/models/index.d.ts +0 -1
|
@@ -1,29 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { CostOptimizationHubServiceException as __BaseException } from "./CostOptimizationHubServiceException";
|
|
3
|
-
/**
|
|
4
|
-
* <p>You are not authorized to use this operation with the given parameters.</p>
|
|
5
|
-
* @public
|
|
6
|
-
*/
|
|
7
|
-
export declare class AccessDeniedException extends __BaseException {
|
|
8
|
-
readonly name: "AccessDeniedException";
|
|
9
|
-
readonly $fault: "client";
|
|
10
|
-
/**
|
|
11
|
-
* @internal
|
|
12
|
-
*/
|
|
13
|
-
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* @public
|
|
17
|
-
* @enum
|
|
18
|
-
*/
|
|
19
|
-
export declare const EnrollmentStatus: {
|
|
20
|
-
readonly ACTIVE: "Active";
|
|
21
|
-
readonly INACTIVE: "Inactive";
|
|
22
|
-
};
|
|
23
|
-
/**
|
|
24
|
-
* @public
|
|
25
|
-
*/
|
|
26
|
-
export type EnrollmentStatus = (typeof EnrollmentStatus)[keyof typeof EnrollmentStatus];
|
|
1
|
+
import { ActionType, AllocationStrategy, Ec2AutoScalingGroupType, EnrollmentStatus, GranularityType, ImplementationEffort, MemberAccountDiscountVisibility, Order, PaymentOption, ResourceType, SavingsEstimationMode, Source, SummaryMetrics, Term } from "./enums";
|
|
27
2
|
/**
|
|
28
3
|
* <p>Describes the enrollment status of an organization's member accounts in Cost Optimization Hub.</p>
|
|
29
4
|
* @public
|
|
@@ -50,36 +25,6 @@ export interface AccountEnrollmentStatus {
|
|
|
50
25
|
*/
|
|
51
26
|
createdTimestamp?: Date | undefined;
|
|
52
27
|
}
|
|
53
|
-
/**
|
|
54
|
-
* @public
|
|
55
|
-
* @enum
|
|
56
|
-
*/
|
|
57
|
-
export declare const ActionType: {
|
|
58
|
-
readonly DELETE: "Delete";
|
|
59
|
-
readonly MIGRATE_TO_GRAVITON: "MigrateToGraviton";
|
|
60
|
-
readonly PURCHASE_RESERVED_INSTANCES: "PurchaseReservedInstances";
|
|
61
|
-
readonly PURCHASE_SAVINGS_PLANS: "PurchaseSavingsPlans";
|
|
62
|
-
readonly RIGHTSIZE: "Rightsize";
|
|
63
|
-
readonly SCALE_IN: "ScaleIn";
|
|
64
|
-
readonly STOP: "Stop";
|
|
65
|
-
readonly UPGRADE: "Upgrade";
|
|
66
|
-
};
|
|
67
|
-
/**
|
|
68
|
-
* @public
|
|
69
|
-
*/
|
|
70
|
-
export type ActionType = (typeof ActionType)[keyof typeof ActionType];
|
|
71
|
-
/**
|
|
72
|
-
* @public
|
|
73
|
-
* @enum
|
|
74
|
-
*/
|
|
75
|
-
export declare const AllocationStrategy: {
|
|
76
|
-
readonly LOWEST_PRICE: "LowestPrice";
|
|
77
|
-
readonly PRIORITIZED: "Prioritized";
|
|
78
|
-
};
|
|
79
|
-
/**
|
|
80
|
-
* @public
|
|
81
|
-
*/
|
|
82
|
-
export type AllocationStrategy = (typeof AllocationStrategy)[keyof typeof AllocationStrategy];
|
|
83
28
|
/**
|
|
84
29
|
* <p>The Aurora DB cluster storage configuration used for recommendations.</p>
|
|
85
30
|
* @public
|
|
@@ -270,27 +215,27 @@ export interface ComputeSavingsPlansConfiguration {
|
|
|
270
215
|
hourlyCommitment?: string | undefined;
|
|
271
216
|
}
|
|
272
217
|
/**
|
|
273
|
-
* <p>Pricing information about a Savings
|
|
218
|
+
* <p>Pricing information about a Savings Plans.</p>
|
|
274
219
|
* @public
|
|
275
220
|
*/
|
|
276
221
|
export interface SavingsPlansPricing {
|
|
277
222
|
/**
|
|
278
|
-
* <p>The cost of paying for the recommended Savings
|
|
223
|
+
* <p>The cost of paying for the recommended Savings Plans monthly.</p>
|
|
279
224
|
* @public
|
|
280
225
|
*/
|
|
281
226
|
monthlySavingsPlansEligibleCost?: number | undefined;
|
|
282
227
|
/**
|
|
283
|
-
* <p>Estimated monthly commitment for the Savings
|
|
228
|
+
* <p>Estimated monthly commitment for the Savings Plans.</p>
|
|
284
229
|
* @public
|
|
285
230
|
*/
|
|
286
231
|
estimatedMonthlyCommitment?: number | undefined;
|
|
287
232
|
/**
|
|
288
|
-
* <p>Estimated savings as a percentage of your overall costs after buying the Savings
|
|
233
|
+
* <p>Estimated savings as a percentage of your overall costs after buying the Savings Plans.</p>
|
|
289
234
|
* @public
|
|
290
235
|
*/
|
|
291
236
|
savingsPercentage?: number | undefined;
|
|
292
237
|
/**
|
|
293
|
-
* <p>Estimated On-Demand cost you will pay after buying the Savings
|
|
238
|
+
* <p>Estimated On-Demand cost you will pay after buying the Savings Plans.</p>
|
|
294
239
|
* @public
|
|
295
240
|
*/
|
|
296
241
|
estimatedOnDemandCost?: number | undefined;
|
|
@@ -327,43 +272,6 @@ export interface ComputeSavingsPlans {
|
|
|
327
272
|
*/
|
|
328
273
|
export interface GetPreferencesRequest {
|
|
329
274
|
}
|
|
330
|
-
/**
|
|
331
|
-
* @public
|
|
332
|
-
* @enum
|
|
333
|
-
*/
|
|
334
|
-
export declare const MemberAccountDiscountVisibility: {
|
|
335
|
-
readonly ALL: "All";
|
|
336
|
-
readonly NONE: "None";
|
|
337
|
-
};
|
|
338
|
-
/**
|
|
339
|
-
* @public
|
|
340
|
-
*/
|
|
341
|
-
export type MemberAccountDiscountVisibility = (typeof MemberAccountDiscountVisibility)[keyof typeof MemberAccountDiscountVisibility];
|
|
342
|
-
/**
|
|
343
|
-
* @public
|
|
344
|
-
* @enum
|
|
345
|
-
*/
|
|
346
|
-
export declare const PaymentOption: {
|
|
347
|
-
readonly ALL_UPFRONT: "AllUpfront";
|
|
348
|
-
readonly NO_UPFRONT: "NoUpfront";
|
|
349
|
-
readonly PARTIAL_UPFRONT: "PartialUpfront";
|
|
350
|
-
};
|
|
351
|
-
/**
|
|
352
|
-
* @public
|
|
353
|
-
*/
|
|
354
|
-
export type PaymentOption = (typeof PaymentOption)[keyof typeof PaymentOption];
|
|
355
|
-
/**
|
|
356
|
-
* @public
|
|
357
|
-
* @enum
|
|
358
|
-
*/
|
|
359
|
-
export declare const Term: {
|
|
360
|
-
readonly ONE_YEAR: "OneYear";
|
|
361
|
-
readonly THREE_YEARS: "ThreeYears";
|
|
362
|
-
};
|
|
363
|
-
/**
|
|
364
|
-
* @public
|
|
365
|
-
*/
|
|
366
|
-
export type Term = (typeof Term)[keyof typeof Term];
|
|
367
275
|
/**
|
|
368
276
|
* <p>The preferred configuration for Reserved Instances and Savings Plans commitment-based discounts, consisting of a payment option and a commitment duration.</p>
|
|
369
277
|
* @public
|
|
@@ -380,18 +288,6 @@ export interface PreferredCommitment {
|
|
|
380
288
|
*/
|
|
381
289
|
paymentOption?: PaymentOption | undefined;
|
|
382
290
|
}
|
|
383
|
-
/**
|
|
384
|
-
* @public
|
|
385
|
-
* @enum
|
|
386
|
-
*/
|
|
387
|
-
export declare const SavingsEstimationMode: {
|
|
388
|
-
readonly AFTER_DISCOUNTS: "AfterDiscounts";
|
|
389
|
-
readonly BEFORE_DISCOUNTS: "BeforeDiscounts";
|
|
390
|
-
};
|
|
391
|
-
/**
|
|
392
|
-
* @public
|
|
393
|
-
*/
|
|
394
|
-
export type SavingsEstimationMode = (typeof SavingsEstimationMode)[keyof typeof SavingsEstimationMode];
|
|
395
291
|
/**
|
|
396
292
|
* @public
|
|
397
293
|
*/
|
|
@@ -412,30 +308,6 @@ export interface GetPreferencesResponse {
|
|
|
412
308
|
*/
|
|
413
309
|
preferredCommitment?: PreferredCommitment | undefined;
|
|
414
310
|
}
|
|
415
|
-
/**
|
|
416
|
-
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
417
|
-
* @public
|
|
418
|
-
*/
|
|
419
|
-
export declare class InternalServerException extends __BaseException {
|
|
420
|
-
readonly name: "InternalServerException";
|
|
421
|
-
readonly $fault: "server";
|
|
422
|
-
/**
|
|
423
|
-
* @internal
|
|
424
|
-
*/
|
|
425
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
426
|
-
}
|
|
427
|
-
/**
|
|
428
|
-
* <p>The request was denied due to request throttling.</p>
|
|
429
|
-
* @public
|
|
430
|
-
*/
|
|
431
|
-
export declare class ThrottlingException extends __BaseException {
|
|
432
|
-
readonly name: "ThrottlingException";
|
|
433
|
-
readonly $fault: "client";
|
|
434
|
-
/**
|
|
435
|
-
* @internal
|
|
436
|
-
*/
|
|
437
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
438
|
-
}
|
|
439
311
|
/**
|
|
440
312
|
* <p>The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.</p>
|
|
441
313
|
* @public
|
|
@@ -452,40 +324,6 @@ export interface ValidationExceptionDetail {
|
|
|
452
324
|
*/
|
|
453
325
|
message: string | undefined;
|
|
454
326
|
}
|
|
455
|
-
/**
|
|
456
|
-
* @public
|
|
457
|
-
* @enum
|
|
458
|
-
*/
|
|
459
|
-
export declare const ValidationExceptionReason: {
|
|
460
|
-
readonly FIELD_VALIDATION_FAILED: "FieldValidationFailed";
|
|
461
|
-
readonly OTHER: "Other";
|
|
462
|
-
};
|
|
463
|
-
/**
|
|
464
|
-
* @public
|
|
465
|
-
*/
|
|
466
|
-
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
467
|
-
/**
|
|
468
|
-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
469
|
-
* @public
|
|
470
|
-
*/
|
|
471
|
-
export declare class ValidationException extends __BaseException {
|
|
472
|
-
readonly name: "ValidationException";
|
|
473
|
-
readonly $fault: "client";
|
|
474
|
-
/**
|
|
475
|
-
* <p>The reason for the validation exception.</p>
|
|
476
|
-
* @public
|
|
477
|
-
*/
|
|
478
|
-
reason?: ValidationExceptionReason | undefined;
|
|
479
|
-
/**
|
|
480
|
-
* <p>The list of fields that are invalid.</p>
|
|
481
|
-
* @public
|
|
482
|
-
*/
|
|
483
|
-
fields?: ValidationExceptionDetail[] | undefined;
|
|
484
|
-
/**
|
|
485
|
-
* @internal
|
|
486
|
-
*/
|
|
487
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
488
|
-
}
|
|
489
327
|
/**
|
|
490
328
|
* @public
|
|
491
329
|
*/
|
|
@@ -675,18 +513,6 @@ export interface MixedInstanceConfiguration {
|
|
|
675
513
|
*/
|
|
676
514
|
type?: string | undefined;
|
|
677
515
|
}
|
|
678
|
-
/**
|
|
679
|
-
* @public
|
|
680
|
-
* @enum
|
|
681
|
-
*/
|
|
682
|
-
export declare const Ec2AutoScalingGroupType: {
|
|
683
|
-
readonly MIXED_INSTANCE_TYPES: "MixedInstanceTypes";
|
|
684
|
-
readonly SINGLE_INSTANCE_TYPE: "SingleInstanceType";
|
|
685
|
-
};
|
|
686
|
-
/**
|
|
687
|
-
* @public
|
|
688
|
-
*/
|
|
689
|
-
export type Ec2AutoScalingGroupType = (typeof Ec2AutoScalingGroupType)[keyof typeof Ec2AutoScalingGroupType];
|
|
690
516
|
/**
|
|
691
517
|
* <p>The EC2 Auto Scaling group configuration used for recommendations.</p>
|
|
692
518
|
* @public
|
|
@@ -782,7 +608,7 @@ export interface Ec2InstanceSavingsPlansConfiguration {
|
|
|
782
608
|
*/
|
|
783
609
|
hourlyCommitment?: string | undefined;
|
|
784
610
|
/**
|
|
785
|
-
* <p>The instance family of the recommended Savings
|
|
611
|
+
* <p>The instance family of the recommended Savings Plans.</p>
|
|
786
612
|
* @public
|
|
787
613
|
*/
|
|
788
614
|
instanceFamily?: string | undefined;
|
|
@@ -2045,61 +1871,6 @@ export declare namespace ResourceDetails {
|
|
|
2045
1871
|
_: (name: string, value: any) => T;
|
|
2046
1872
|
}
|
|
2047
1873
|
}
|
|
2048
|
-
/**
|
|
2049
|
-
* @public
|
|
2050
|
-
* @enum
|
|
2051
|
-
*/
|
|
2052
|
-
export declare const ResourceType: {
|
|
2053
|
-
readonly AURORA_DB_CLUSTER_STORAGE: "AuroraDbClusterStorage";
|
|
2054
|
-
readonly COMPUTE_SAVINGS_PLANS: "ComputeSavingsPlans";
|
|
2055
|
-
readonly DYNAMO_DB_RESERVED_CAPACITY: "DynamoDbReservedCapacity";
|
|
2056
|
-
readonly EBS_VOLUME: "EbsVolume";
|
|
2057
|
-
readonly EC2_AUTO_SCALING_GROUP: "Ec2AutoScalingGroup";
|
|
2058
|
-
readonly EC2_INSTANCE: "Ec2Instance";
|
|
2059
|
-
readonly EC2_INSTANCE_SAVINGS_PLANS: "Ec2InstanceSavingsPlans";
|
|
2060
|
-
readonly EC2_RESERVED_INSTANCES: "Ec2ReservedInstances";
|
|
2061
|
-
readonly ECS_SERVICE: "EcsService";
|
|
2062
|
-
readonly ELASTI_CACHE_RESERVED_INSTANCES: "ElastiCacheReservedInstances";
|
|
2063
|
-
readonly LAMBDA_FUNCTION: "LambdaFunction";
|
|
2064
|
-
readonly MEMORY_DB_RESERVED_INSTANCES: "MemoryDbReservedInstances";
|
|
2065
|
-
readonly OPEN_SEARCH_RESERVED_INSTANCES: "OpenSearchReservedInstances";
|
|
2066
|
-
readonly RDS_DB_INSTANCE: "RdsDbInstance";
|
|
2067
|
-
readonly RDS_DB_INSTANCE_STORAGE: "RdsDbInstanceStorage";
|
|
2068
|
-
readonly RDS_RESERVED_INSTANCES: "RdsReservedInstances";
|
|
2069
|
-
readonly REDSHIFT_RESERVED_INSTANCES: "RedshiftReservedInstances";
|
|
2070
|
-
readonly SAGE_MAKER_SAVINGS_PLANS: "SageMakerSavingsPlans";
|
|
2071
|
-
};
|
|
2072
|
-
/**
|
|
2073
|
-
* @public
|
|
2074
|
-
*/
|
|
2075
|
-
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
2076
|
-
/**
|
|
2077
|
-
* @public
|
|
2078
|
-
* @enum
|
|
2079
|
-
*/
|
|
2080
|
-
export declare const ImplementationEffort: {
|
|
2081
|
-
readonly HIGH: "High";
|
|
2082
|
-
readonly LOW: "Low";
|
|
2083
|
-
readonly MEDIUM: "Medium";
|
|
2084
|
-
readonly VERY_HIGH: "VeryHigh";
|
|
2085
|
-
readonly VERY_LOW: "VeryLow";
|
|
2086
|
-
};
|
|
2087
|
-
/**
|
|
2088
|
-
* @public
|
|
2089
|
-
*/
|
|
2090
|
-
export type ImplementationEffort = (typeof ImplementationEffort)[keyof typeof ImplementationEffort];
|
|
2091
|
-
/**
|
|
2092
|
-
* @public
|
|
2093
|
-
* @enum
|
|
2094
|
-
*/
|
|
2095
|
-
export declare const Source: {
|
|
2096
|
-
readonly COMPUTE_OPTIMIZER: "ComputeOptimizer";
|
|
2097
|
-
readonly COST_EXPLORER: "CostExplorer";
|
|
2098
|
-
};
|
|
2099
|
-
/**
|
|
2100
|
-
* @public
|
|
2101
|
-
*/
|
|
2102
|
-
export type Source = (typeof Source)[keyof typeof Source];
|
|
2103
1874
|
/**
|
|
2104
1875
|
* <p>The tag structure that contains a tag key and value.</p>
|
|
2105
1876
|
* @public
|
|
@@ -2237,21 +2008,133 @@ export interface GetRecommendationResponse {
|
|
|
2237
2008
|
tags?: Tag[] | undefined;
|
|
2238
2009
|
}
|
|
2239
2010
|
/**
|
|
2240
|
-
* <p>
|
|
2011
|
+
* <p>Defines how rows will be sorted in the response.</p>
|
|
2012
|
+
* @public
|
|
2013
|
+
*/
|
|
2014
|
+
export interface OrderBy {
|
|
2015
|
+
/**
|
|
2016
|
+
* <p>Sorts by dimension values.</p>
|
|
2017
|
+
* @public
|
|
2018
|
+
*/
|
|
2019
|
+
dimension?: string | undefined;
|
|
2020
|
+
/**
|
|
2021
|
+
* <p>The order that's used to sort the data.</p>
|
|
2022
|
+
* @public
|
|
2023
|
+
*/
|
|
2024
|
+
order?: Order | undefined;
|
|
2025
|
+
}
|
|
2026
|
+
/**
|
|
2027
|
+
* <p>Specifies a date range for retrieving efficiency metrics. The start date is inclusive and the end date is exclusive.</p>
|
|
2028
|
+
* @public
|
|
2029
|
+
*/
|
|
2030
|
+
export interface TimePeriod {
|
|
2031
|
+
/**
|
|
2032
|
+
* <p>The beginning of the time period (inclusive). Specify the date in ISO 8601 format, such as 2024-01-01.</p>
|
|
2033
|
+
* @public
|
|
2034
|
+
*/
|
|
2035
|
+
start: string | undefined;
|
|
2036
|
+
/**
|
|
2037
|
+
* <p>The end of the time period (exclusive). Specify the date in ISO 8601 format, such as 2024-12-31.</p>
|
|
2038
|
+
* @public
|
|
2039
|
+
*/
|
|
2040
|
+
end: string | undefined;
|
|
2041
|
+
}
|
|
2042
|
+
/**
|
|
2043
|
+
* @public
|
|
2044
|
+
*/
|
|
2045
|
+
export interface ListEfficiencyMetricsRequest {
|
|
2046
|
+
/**
|
|
2047
|
+
* <p>The dimension by which to group the cost efficiency metrics. Valid values include account ID, Amazon Web Services Region. When no grouping is specified, metrics are aggregated across all resources in the specified time period.</p>
|
|
2048
|
+
* @public
|
|
2049
|
+
*/
|
|
2050
|
+
groupBy?: string | undefined;
|
|
2051
|
+
/**
|
|
2052
|
+
* <p>The time granularity for the cost efficiency metrics. Specify <code>Daily</code> for metrics aggregated by day, or <code>Monthly</code> for metrics aggregated by month.</p>
|
|
2053
|
+
* @public
|
|
2054
|
+
*/
|
|
2055
|
+
granularity: GranularityType | undefined;
|
|
2056
|
+
/**
|
|
2057
|
+
* <p>The time period for which to retrieve the cost efficiency metrics. The start date is inclusive and the end date is exclusive. Dates can be specified in either YYYY-MM-DD format or YYYY-MM format depending on the desired granularity.</p>
|
|
2058
|
+
* @public
|
|
2059
|
+
*/
|
|
2060
|
+
timePeriod: TimePeriod | undefined;
|
|
2061
|
+
/**
|
|
2062
|
+
* <p>The maximum number of groups to return in the response. Valid values range from 0 to 1000. Use in conjunction with <code>nextToken</code> to paginate through results when the total number of groups exceeds this limit.</p>
|
|
2063
|
+
* @public
|
|
2064
|
+
*/
|
|
2065
|
+
maxResults?: number | undefined;
|
|
2066
|
+
/**
|
|
2067
|
+
* <p>The ordering specification for the results. Defines which dimension to sort by and whether to sort in ascending or descending order.</p>
|
|
2068
|
+
* @public
|
|
2069
|
+
*/
|
|
2070
|
+
orderBy?: OrderBy | undefined;
|
|
2071
|
+
/**
|
|
2072
|
+
* <p>The token to retrieve the next page of results. This value is returned in the response when the number of groups exceeds the specified <code>maxResults</code> value.</p>
|
|
2073
|
+
* @public
|
|
2074
|
+
*/
|
|
2075
|
+
nextToken?: string | undefined;
|
|
2076
|
+
}
|
|
2077
|
+
/**
|
|
2078
|
+
* <p>Contains efficiency metrics for a specific point in time, including an efficiency score, potential savings, optimizable spend, and timestamp.</p>
|
|
2241
2079
|
* @public
|
|
2242
2080
|
*/
|
|
2243
|
-
export
|
|
2244
|
-
readonly name: "ResourceNotFoundException";
|
|
2245
|
-
readonly $fault: "client";
|
|
2081
|
+
export interface MetricsByTime {
|
|
2246
2082
|
/**
|
|
2247
|
-
* <p>The
|
|
2083
|
+
* <p>The efficiency score for this time period. The score represents a measure of how effectively the cloud resources are being optimized, with higher scores indicating better optimization performance.</p>
|
|
2248
2084
|
* @public
|
|
2249
2085
|
*/
|
|
2250
|
-
|
|
2086
|
+
score?: number | undefined;
|
|
2251
2087
|
/**
|
|
2252
|
-
*
|
|
2088
|
+
* <p>The estimated savings amount for this time period, representing the potential cost reduction achieved through optimization recommendations.</p>
|
|
2089
|
+
* @public
|
|
2090
|
+
*/
|
|
2091
|
+
savings?: number | undefined;
|
|
2092
|
+
/**
|
|
2093
|
+
* <p>The total spending amount for this time period.</p>
|
|
2094
|
+
* @public
|
|
2095
|
+
*/
|
|
2096
|
+
spend?: number | undefined;
|
|
2097
|
+
/**
|
|
2098
|
+
* <p>The timestamp for this data point. The format depends on the granularity: YYYY-MM-DD for daily metrics, or YYYY-MM for monthly metrics.</p>
|
|
2099
|
+
* @public
|
|
2253
2100
|
*/
|
|
2254
|
-
|
|
2101
|
+
timestamp?: string | undefined;
|
|
2102
|
+
}
|
|
2103
|
+
/**
|
|
2104
|
+
* <p>Contains cost efficiency metrics for a specific group over time. The group is defined by the grouping dimension specified in the request, such as account ID, Amazon Web Services Region.</p>
|
|
2105
|
+
* @public
|
|
2106
|
+
*/
|
|
2107
|
+
export interface EfficiencyMetricsByGroup {
|
|
2108
|
+
/**
|
|
2109
|
+
* <p>A list of time-series data points containing efficiency metrics for this group. Each data point includes an efficiency score, estimated savings, spending, and a timestamp corresponding to the specified granularity. This field is null when efficiency metrics cannot be calculated for the group, in which case the message field provides an explanation.</p>
|
|
2110
|
+
* @public
|
|
2111
|
+
*/
|
|
2112
|
+
metricsByTime?: MetricsByTime[] | undefined;
|
|
2113
|
+
/**
|
|
2114
|
+
* <p>The value of the grouping dimension for this set of metrics. For example, if grouped by account ID, this field contains the account ID. If no grouping is specified, this field is empty.</p>
|
|
2115
|
+
* @public
|
|
2116
|
+
*/
|
|
2117
|
+
group?: string | undefined;
|
|
2118
|
+
/**
|
|
2119
|
+
* <p>An explanation of why efficiency metrics could not be calculated for this group when the metricsByTime field is null. Common reasons include insufficient or inconclusive cost and usage data during the specified time period. This field is null or empty when metrics are successfully calculated.</p>
|
|
2120
|
+
* @public
|
|
2121
|
+
*/
|
|
2122
|
+
message?: string | undefined;
|
|
2123
|
+
}
|
|
2124
|
+
/**
|
|
2125
|
+
* @public
|
|
2126
|
+
*/
|
|
2127
|
+
export interface ListEfficiencyMetricsResponse {
|
|
2128
|
+
/**
|
|
2129
|
+
* <p>A list of cost efficiency metrics grouped by the specified dimension. Each group contains time-series data points with cost efficiency, potential savings, and optimzable spend for the specified time period.</p>
|
|
2130
|
+
* @public
|
|
2131
|
+
*/
|
|
2132
|
+
efficiencyMetricsByGroup?: EfficiencyMetricsByGroup[] | undefined;
|
|
2133
|
+
/**
|
|
2134
|
+
* <p>The token to retrieve the next page of results. When this value is present in the response, additional groups are available. Pass this token in the <code>nextToken</code> parameter of a subsequent request to retrieve the next page.</p>
|
|
2135
|
+
* @public
|
|
2136
|
+
*/
|
|
2137
|
+
nextToken?: string | undefined;
|
|
2255
2138
|
}
|
|
2256
2139
|
/**
|
|
2257
2140
|
* @public
|
|
@@ -2359,34 +2242,6 @@ export interface Filter {
|
|
|
2359
2242
|
*/
|
|
2360
2243
|
recommendationIds?: string[] | undefined;
|
|
2361
2244
|
}
|
|
2362
|
-
/**
|
|
2363
|
-
* @public
|
|
2364
|
-
* @enum
|
|
2365
|
-
*/
|
|
2366
|
-
export declare const Order: {
|
|
2367
|
-
readonly ASC: "Asc";
|
|
2368
|
-
readonly DESC: "Desc";
|
|
2369
|
-
};
|
|
2370
|
-
/**
|
|
2371
|
-
* @public
|
|
2372
|
-
*/
|
|
2373
|
-
export type Order = (typeof Order)[keyof typeof Order];
|
|
2374
|
-
/**
|
|
2375
|
-
* <p>Defines how rows will be sorted in the response.</p>
|
|
2376
|
-
* @public
|
|
2377
|
-
*/
|
|
2378
|
-
export interface OrderBy {
|
|
2379
|
-
/**
|
|
2380
|
-
* <p>Sorts by dimension values.</p>
|
|
2381
|
-
* @public
|
|
2382
|
-
*/
|
|
2383
|
-
dimension?: string | undefined;
|
|
2384
|
-
/**
|
|
2385
|
-
* <p>The order that's used to sort the data.</p>
|
|
2386
|
-
* @public
|
|
2387
|
-
*/
|
|
2388
|
-
order?: Order | undefined;
|
|
2389
|
-
}
|
|
2390
2245
|
/**
|
|
2391
2246
|
* @public
|
|
2392
2247
|
*/
|
|
@@ -2543,17 +2398,6 @@ export interface ListRecommendationsResponse {
|
|
|
2543
2398
|
*/
|
|
2544
2399
|
nextToken?: string | undefined;
|
|
2545
2400
|
}
|
|
2546
|
-
/**
|
|
2547
|
-
* @public
|
|
2548
|
-
* @enum
|
|
2549
|
-
*/
|
|
2550
|
-
export declare const SummaryMetrics: {
|
|
2551
|
-
readonly SAVINGS_PERCENTAGE: "SavingsPercentage";
|
|
2552
|
-
};
|
|
2553
|
-
/**
|
|
2554
|
-
* @public
|
|
2555
|
-
*/
|
|
2556
|
-
export type SummaryMetrics = (typeof SummaryMetrics)[keyof typeof SummaryMetrics];
|
|
2557
2401
|
/**
|
|
2558
2402
|
* @public
|
|
2559
2403
|
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListEfficiencyMetricsCommandInput, ListEfficiencyMetricsCommandOutput } from "../commands/ListEfficiencyMetricsCommand";
|
|
3
|
+
import { CostOptimizationHubPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListEfficiencyMetrics: (config: CostOptimizationHubPaginationConfiguration, input: ListEfficiencyMetricsCommandInput, ...rest: any[]) => Paginator<ListEfficiencyMetricsCommandOutput>;
|
|
@@ -22,6 +22,7 @@ export declare var Ec2ReservedInstances: StaticStructureSchema;
|
|
|
22
22
|
export declare var Ec2ReservedInstancesConfiguration: StaticStructureSchema;
|
|
23
23
|
export declare var EcsService: StaticStructureSchema;
|
|
24
24
|
export declare var EcsServiceConfiguration: StaticStructureSchema;
|
|
25
|
+
export declare var EfficiencyMetricsByGroup: StaticStructureSchema;
|
|
25
26
|
export declare var ElastiCacheReservedInstances: StaticStructureSchema;
|
|
26
27
|
export declare var ElastiCacheReservedInstancesConfiguration: StaticStructureSchema;
|
|
27
28
|
export declare var EstimatedDiscounts: StaticStructureSchema;
|
|
@@ -34,6 +35,8 @@ export declare var InstanceConfiguration: StaticStructureSchema;
|
|
|
34
35
|
export declare var InternalServerException: StaticErrorSchema;
|
|
35
36
|
export declare var LambdaFunction: StaticStructureSchema;
|
|
36
37
|
export declare var LambdaFunctionConfiguration: StaticStructureSchema;
|
|
38
|
+
export declare var ListEfficiencyMetricsRequest: StaticStructureSchema;
|
|
39
|
+
export declare var ListEfficiencyMetricsResponse: StaticStructureSchema;
|
|
37
40
|
export declare var ListEnrollmentStatusesRequest: StaticStructureSchema;
|
|
38
41
|
export declare var ListEnrollmentStatusesResponse: StaticStructureSchema;
|
|
39
42
|
export declare var ListRecommendationsRequest: StaticStructureSchema;
|
|
@@ -42,6 +45,7 @@ export declare var ListRecommendationSummariesRequest: StaticStructureSchema;
|
|
|
42
45
|
export declare var ListRecommendationSummariesResponse: StaticStructureSchema;
|
|
43
46
|
export declare var MemoryDbReservedInstances: StaticStructureSchema;
|
|
44
47
|
export declare var MemoryDbReservedInstancesConfiguration: StaticStructureSchema;
|
|
48
|
+
export declare var MetricsByTime: StaticStructureSchema;
|
|
45
49
|
export declare var MixedInstanceConfiguration: StaticStructureSchema;
|
|
46
50
|
export declare var OpenSearchReservedInstances: StaticStructureSchema;
|
|
47
51
|
export declare var OpenSearchReservedInstancesConfiguration: StaticStructureSchema;
|
|
@@ -70,6 +74,7 @@ export declare var StorageConfiguration: StaticStructureSchema;
|
|
|
70
74
|
export declare var SummaryMetricsResult: StaticStructureSchema;
|
|
71
75
|
export declare var Tag: StaticStructureSchema;
|
|
72
76
|
export declare var ThrottlingException: StaticErrorSchema;
|
|
77
|
+
export declare var TimePeriod: StaticStructureSchema;
|
|
73
78
|
export declare var UpdateEnrollmentStatusRequest: StaticStructureSchema;
|
|
74
79
|
export declare var UpdateEnrollmentStatusResponse: StaticStructureSchema;
|
|
75
80
|
export declare var UpdatePreferencesRequest: StaticStructureSchema;
|
|
@@ -82,7 +87,9 @@ export declare var CostOptimizationHubServiceException: StaticErrorSchema;
|
|
|
82
87
|
export declare var AccountEnrollmentStatuses: StaticListSchema;
|
|
83
88
|
export declare var AccountIdList: number;
|
|
84
89
|
export declare var ActionTypeList: number;
|
|
90
|
+
export declare var EfficiencyMetricsByGroupList: StaticListSchema;
|
|
85
91
|
export declare var ImplementationEffortList: number;
|
|
92
|
+
export declare var MetricsByTimeList: StaticListSchema;
|
|
86
93
|
export declare var MixedInstanceConfigurationList: StaticListSchema;
|
|
87
94
|
export declare var RecommendationIdList: number;
|
|
88
95
|
export declare var RecommendationList: StaticListSchema;
|
|
@@ -98,6 +105,7 @@ export declare var ValidationExceptionDetails: StaticListSchema;
|
|
|
98
105
|
export declare var ResourceDetails: StaticStructureSchema;
|
|
99
106
|
export declare var GetPreferences: StaticOperationSchema;
|
|
100
107
|
export declare var GetRecommendation: StaticOperationSchema;
|
|
108
|
+
export declare var ListEfficiencyMetrics: StaticOperationSchema;
|
|
101
109
|
export declare var ListEnrollmentStatuses: StaticOperationSchema;
|
|
102
110
|
export declare var ListRecommendations: StaticOperationSchema;
|
|
103
111
|
export declare var ListRecommendationSummaries: StaticOperationSchema;
|
|
@@ -7,6 +7,10 @@ import {
|
|
|
7
7
|
GetRecommendationCommandInput,
|
|
8
8
|
GetRecommendationCommandOutput,
|
|
9
9
|
} from "./commands/GetRecommendationCommand";
|
|
10
|
+
import {
|
|
11
|
+
ListEfficiencyMetricsCommandInput,
|
|
12
|
+
ListEfficiencyMetricsCommandOutput,
|
|
13
|
+
} from "./commands/ListEfficiencyMetricsCommand";
|
|
10
14
|
import {
|
|
11
15
|
ListEnrollmentStatusesCommandInput,
|
|
12
16
|
ListEnrollmentStatusesCommandOutput,
|
|
@@ -56,6 +60,19 @@ export interface CostOptimizationHub {
|
|
|
56
60
|
options: __HttpHandlerOptions,
|
|
57
61
|
cb: (err: any, data?: GetRecommendationCommandOutput) => void
|
|
58
62
|
): void;
|
|
63
|
+
listEfficiencyMetrics(
|
|
64
|
+
args: ListEfficiencyMetricsCommandInput,
|
|
65
|
+
options?: __HttpHandlerOptions
|
|
66
|
+
): Promise<ListEfficiencyMetricsCommandOutput>;
|
|
67
|
+
listEfficiencyMetrics(
|
|
68
|
+
args: ListEfficiencyMetricsCommandInput,
|
|
69
|
+
cb: (err: any, data?: ListEfficiencyMetricsCommandOutput) => void
|
|
70
|
+
): void;
|
|
71
|
+
listEfficiencyMetrics(
|
|
72
|
+
args: ListEfficiencyMetricsCommandInput,
|
|
73
|
+
options: __HttpHandlerOptions,
|
|
74
|
+
cb: (err: any, data?: ListEfficiencyMetricsCommandOutput) => void
|
|
75
|
+
): void;
|
|
59
76
|
listEnrollmentStatuses(): Promise<ListEnrollmentStatusesCommandOutput>;
|
|
60
77
|
listEnrollmentStatuses(
|
|
61
78
|
args: ListEnrollmentStatusesCommandInput,
|
|
@@ -56,6 +56,10 @@ import {
|
|
|
56
56
|
GetRecommendationCommandInput,
|
|
57
57
|
GetRecommendationCommandOutput,
|
|
58
58
|
} from "./commands/GetRecommendationCommand";
|
|
59
|
+
import {
|
|
60
|
+
ListEfficiencyMetricsCommandInput,
|
|
61
|
+
ListEfficiencyMetricsCommandOutput,
|
|
62
|
+
} from "./commands/ListEfficiencyMetricsCommand";
|
|
59
63
|
import {
|
|
60
64
|
ListEnrollmentStatusesCommandInput,
|
|
61
65
|
ListEnrollmentStatusesCommandOutput,
|
|
@@ -86,6 +90,7 @@ export { __Client };
|
|
|
86
90
|
export type ServiceInputTypes =
|
|
87
91
|
| GetPreferencesCommandInput
|
|
88
92
|
| GetRecommendationCommandInput
|
|
93
|
+
| ListEfficiencyMetricsCommandInput
|
|
89
94
|
| ListEnrollmentStatusesCommandInput
|
|
90
95
|
| ListRecommendationSummariesCommandInput
|
|
91
96
|
| ListRecommendationsCommandInput
|
|
@@ -94,6 +99,7 @@ export type ServiceInputTypes =
|
|
|
94
99
|
export type ServiceOutputTypes =
|
|
95
100
|
| GetPreferencesCommandOutput
|
|
96
101
|
| GetRecommendationCommandOutput
|
|
102
|
+
| ListEfficiencyMetricsCommandOutput
|
|
97
103
|
| ListEnrollmentStatusesCommandOutput
|
|
98
104
|
| ListRecommendationSummariesCommandOutput
|
|
99
105
|
| ListRecommendationsCommandOutput
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import {
|
|
4
|
+
CostOptimizationHubClientResolvedConfig,
|
|
5
|
+
ServiceInputTypes,
|
|
6
|
+
ServiceOutputTypes,
|
|
7
|
+
} from "../CostOptimizationHubClient";
|
|
8
|
+
import {
|
|
9
|
+
ListEfficiencyMetricsRequest,
|
|
10
|
+
ListEfficiencyMetricsResponse,
|
|
11
|
+
} from "../models/models_0";
|
|
12
|
+
export { __MetadataBearer };
|
|
13
|
+
export { $Command };
|
|
14
|
+
export interface ListEfficiencyMetricsCommandInput
|
|
15
|
+
extends ListEfficiencyMetricsRequest {}
|
|
16
|
+
export interface ListEfficiencyMetricsCommandOutput
|
|
17
|
+
extends ListEfficiencyMetricsResponse,
|
|
18
|
+
__MetadataBearer {}
|
|
19
|
+
declare const ListEfficiencyMetricsCommand_base: {
|
|
20
|
+
new (
|
|
21
|
+
input: ListEfficiencyMetricsCommandInput
|
|
22
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
23
|
+
ListEfficiencyMetricsCommandInput,
|
|
24
|
+
ListEfficiencyMetricsCommandOutput,
|
|
25
|
+
CostOptimizationHubClientResolvedConfig,
|
|
26
|
+
ServiceInputTypes,
|
|
27
|
+
ServiceOutputTypes
|
|
28
|
+
>;
|
|
29
|
+
new (
|
|
30
|
+
input: ListEfficiencyMetricsCommandInput
|
|
31
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
32
|
+
ListEfficiencyMetricsCommandInput,
|
|
33
|
+
ListEfficiencyMetricsCommandOutput,
|
|
34
|
+
CostOptimizationHubClientResolvedConfig,
|
|
35
|
+
ServiceInputTypes,
|
|
36
|
+
ServiceOutputTypes
|
|
37
|
+
>;
|
|
38
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
39
|
+
};
|
|
40
|
+
export declare class ListEfficiencyMetricsCommand extends ListEfficiencyMetricsCommand_base {
|
|
41
|
+
protected static __types: {
|
|
42
|
+
api: {
|
|
43
|
+
input: ListEfficiencyMetricsRequest;
|
|
44
|
+
output: ListEfficiencyMetricsResponse;
|
|
45
|
+
};
|
|
46
|
+
sdk: {
|
|
47
|
+
input: ListEfficiencyMetricsCommandInput;
|
|
48
|
+
output: ListEfficiencyMetricsCommandOutput;
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
}
|