@aws-sdk/client-cost-optimization-hub 3.933.0 → 3.935.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 +12 -12
- 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,148 +1 @@
|
|
|
1
|
-
|
|
2
|
-
export class AccessDeniedException extends __BaseException {
|
|
3
|
-
name = "AccessDeniedException";
|
|
4
|
-
$fault = "client";
|
|
5
|
-
constructor(opts) {
|
|
6
|
-
super({
|
|
7
|
-
name: "AccessDeniedException",
|
|
8
|
-
$fault: "client",
|
|
9
|
-
...opts,
|
|
10
|
-
});
|
|
11
|
-
Object.setPrototypeOf(this, AccessDeniedException.prototype);
|
|
12
|
-
}
|
|
13
|
-
}
|
|
14
|
-
export const EnrollmentStatus = {
|
|
15
|
-
ACTIVE: "Active",
|
|
16
|
-
INACTIVE: "Inactive",
|
|
17
|
-
};
|
|
18
|
-
export const ActionType = {
|
|
19
|
-
DELETE: "Delete",
|
|
20
|
-
MIGRATE_TO_GRAVITON: "MigrateToGraviton",
|
|
21
|
-
PURCHASE_RESERVED_INSTANCES: "PurchaseReservedInstances",
|
|
22
|
-
PURCHASE_SAVINGS_PLANS: "PurchaseSavingsPlans",
|
|
23
|
-
RIGHTSIZE: "Rightsize",
|
|
24
|
-
SCALE_IN: "ScaleIn",
|
|
25
|
-
STOP: "Stop",
|
|
26
|
-
UPGRADE: "Upgrade",
|
|
27
|
-
};
|
|
28
|
-
export const AllocationStrategy = {
|
|
29
|
-
LOWEST_PRICE: "LowestPrice",
|
|
30
|
-
PRIORITIZED: "Prioritized",
|
|
31
|
-
};
|
|
32
|
-
export const MemberAccountDiscountVisibility = {
|
|
33
|
-
ALL: "All",
|
|
34
|
-
NONE: "None",
|
|
35
|
-
};
|
|
36
|
-
export const PaymentOption = {
|
|
37
|
-
ALL_UPFRONT: "AllUpfront",
|
|
38
|
-
NO_UPFRONT: "NoUpfront",
|
|
39
|
-
PARTIAL_UPFRONT: "PartialUpfront",
|
|
40
|
-
};
|
|
41
|
-
export const Term = {
|
|
42
|
-
ONE_YEAR: "OneYear",
|
|
43
|
-
THREE_YEARS: "ThreeYears",
|
|
44
|
-
};
|
|
45
|
-
export const SavingsEstimationMode = {
|
|
46
|
-
AFTER_DISCOUNTS: "AfterDiscounts",
|
|
47
|
-
BEFORE_DISCOUNTS: "BeforeDiscounts",
|
|
48
|
-
};
|
|
49
|
-
export class InternalServerException extends __BaseException {
|
|
50
|
-
name = "InternalServerException";
|
|
51
|
-
$fault = "server";
|
|
52
|
-
constructor(opts) {
|
|
53
|
-
super({
|
|
54
|
-
name: "InternalServerException",
|
|
55
|
-
$fault: "server",
|
|
56
|
-
...opts,
|
|
57
|
-
});
|
|
58
|
-
Object.setPrototypeOf(this, InternalServerException.prototype);
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
export class ThrottlingException extends __BaseException {
|
|
62
|
-
name = "ThrottlingException";
|
|
63
|
-
$fault = "client";
|
|
64
|
-
constructor(opts) {
|
|
65
|
-
super({
|
|
66
|
-
name: "ThrottlingException",
|
|
67
|
-
$fault: "client",
|
|
68
|
-
...opts,
|
|
69
|
-
});
|
|
70
|
-
Object.setPrototypeOf(this, ThrottlingException.prototype);
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
export const ValidationExceptionReason = {
|
|
74
|
-
FIELD_VALIDATION_FAILED: "FieldValidationFailed",
|
|
75
|
-
OTHER: "Other",
|
|
76
|
-
};
|
|
77
|
-
export class ValidationException extends __BaseException {
|
|
78
|
-
name = "ValidationException";
|
|
79
|
-
$fault = "client";
|
|
80
|
-
reason;
|
|
81
|
-
fields;
|
|
82
|
-
constructor(opts) {
|
|
83
|
-
super({
|
|
84
|
-
name: "ValidationException",
|
|
85
|
-
$fault: "client",
|
|
86
|
-
...opts,
|
|
87
|
-
});
|
|
88
|
-
Object.setPrototypeOf(this, ValidationException.prototype);
|
|
89
|
-
this.reason = opts.reason;
|
|
90
|
-
this.fields = opts.fields;
|
|
91
|
-
}
|
|
92
|
-
}
|
|
93
|
-
export const Ec2AutoScalingGroupType = {
|
|
94
|
-
MIXED_INSTANCE_TYPES: "MixedInstanceTypes",
|
|
95
|
-
SINGLE_INSTANCE_TYPE: "SingleInstanceType",
|
|
96
|
-
};
|
|
97
|
-
export const ResourceType = {
|
|
98
|
-
AURORA_DB_CLUSTER_STORAGE: "AuroraDbClusterStorage",
|
|
99
|
-
COMPUTE_SAVINGS_PLANS: "ComputeSavingsPlans",
|
|
100
|
-
DYNAMO_DB_RESERVED_CAPACITY: "DynamoDbReservedCapacity",
|
|
101
|
-
EBS_VOLUME: "EbsVolume",
|
|
102
|
-
EC2_AUTO_SCALING_GROUP: "Ec2AutoScalingGroup",
|
|
103
|
-
EC2_INSTANCE: "Ec2Instance",
|
|
104
|
-
EC2_INSTANCE_SAVINGS_PLANS: "Ec2InstanceSavingsPlans",
|
|
105
|
-
EC2_RESERVED_INSTANCES: "Ec2ReservedInstances",
|
|
106
|
-
ECS_SERVICE: "EcsService",
|
|
107
|
-
ELASTI_CACHE_RESERVED_INSTANCES: "ElastiCacheReservedInstances",
|
|
108
|
-
LAMBDA_FUNCTION: "LambdaFunction",
|
|
109
|
-
MEMORY_DB_RESERVED_INSTANCES: "MemoryDbReservedInstances",
|
|
110
|
-
OPEN_SEARCH_RESERVED_INSTANCES: "OpenSearchReservedInstances",
|
|
111
|
-
RDS_DB_INSTANCE: "RdsDbInstance",
|
|
112
|
-
RDS_DB_INSTANCE_STORAGE: "RdsDbInstanceStorage",
|
|
113
|
-
RDS_RESERVED_INSTANCES: "RdsReservedInstances",
|
|
114
|
-
REDSHIFT_RESERVED_INSTANCES: "RedshiftReservedInstances",
|
|
115
|
-
SAGE_MAKER_SAVINGS_PLANS: "SageMakerSavingsPlans",
|
|
116
|
-
};
|
|
117
|
-
export const ImplementationEffort = {
|
|
118
|
-
HIGH: "High",
|
|
119
|
-
LOW: "Low",
|
|
120
|
-
MEDIUM: "Medium",
|
|
121
|
-
VERY_HIGH: "VeryHigh",
|
|
122
|
-
VERY_LOW: "VeryLow",
|
|
123
|
-
};
|
|
124
|
-
export const Source = {
|
|
125
|
-
COMPUTE_OPTIMIZER: "ComputeOptimizer",
|
|
126
|
-
COST_EXPLORER: "CostExplorer",
|
|
127
|
-
};
|
|
128
|
-
export class ResourceNotFoundException extends __BaseException {
|
|
129
|
-
name = "ResourceNotFoundException";
|
|
130
|
-
$fault = "client";
|
|
131
|
-
resourceId;
|
|
132
|
-
constructor(opts) {
|
|
133
|
-
super({
|
|
134
|
-
name: "ResourceNotFoundException",
|
|
135
|
-
$fault: "client",
|
|
136
|
-
...opts,
|
|
137
|
-
});
|
|
138
|
-
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
|
|
139
|
-
this.resourceId = opts.resourceId;
|
|
140
|
-
}
|
|
141
|
-
}
|
|
142
|
-
export const Order = {
|
|
143
|
-
ASC: "Asc",
|
|
144
|
-
DESC: "Desc",
|
|
145
|
-
};
|
|
146
|
-
export const SummaryMetrics = {
|
|
147
|
-
SAVINGS_PERCENTAGE: "SavingsPercentage",
|
|
148
|
-
};
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { createPaginator } from "@smithy/core";
|
|
2
|
+
import { ListEfficiencyMetricsCommand, } from "../commands/ListEfficiencyMetricsCommand";
|
|
3
|
+
import { CostOptimizationHubClient } from "../CostOptimizationHubClient";
|
|
4
|
+
export const paginateListEfficiencyMetrics = createPaginator(CostOptimizationHubClient, ListEfficiencyMetricsCommand, "nextToken", "nextToken", "maxResults");
|
|
@@ -19,6 +19,8 @@ const _EI = "Ec2Instance";
|
|
|
19
19
|
const _EIC = "Ec2InstanceConfiguration";
|
|
20
20
|
const _EISP = "Ec2InstanceSavingsPlans";
|
|
21
21
|
const _EISPC = "Ec2InstanceSavingsPlansConfiguration";
|
|
22
|
+
const _EMBG = "EfficiencyMetricsByGroup";
|
|
23
|
+
const _EMBGL = "EfficiencyMetricsByGroupList";
|
|
22
24
|
const _ERI = "Ec2ReservedInstances";
|
|
23
25
|
const _ERIC = "Ec2ReservedInstancesConfiguration";
|
|
24
26
|
const _ES = "EcsService";
|
|
@@ -34,6 +36,9 @@ const _GRR = "GetRecommendationRequest";
|
|
|
34
36
|
const _GRRe = "GetRecommendationResponse";
|
|
35
37
|
const _IC = "InstanceConfiguration";
|
|
36
38
|
const _ISE = "InternalServerException";
|
|
39
|
+
const _LEM = "ListEfficiencyMetrics";
|
|
40
|
+
const _LEMR = "ListEfficiencyMetricsRequest";
|
|
41
|
+
const _LEMRi = "ListEfficiencyMetricsResponse";
|
|
37
42
|
const _LES = "ListEnrollmentStatuses";
|
|
38
43
|
const _LESR = "ListEnrollmentStatusesRequest";
|
|
39
44
|
const _LESRi = "ListEnrollmentStatusesResponse";
|
|
@@ -45,6 +50,8 @@ const _LRRi = "ListRecommendationsResponse";
|
|
|
45
50
|
const _LRS = "ListRecommendationSummaries";
|
|
46
51
|
const _LRSR = "ListRecommendationSummariesRequest";
|
|
47
52
|
const _LRSRi = "ListRecommendationSummariesResponse";
|
|
53
|
+
const _MBT = "MetricsByTime";
|
|
54
|
+
const _MBTL = "MetricsByTimeList";
|
|
48
55
|
const _MDRI = "MemoryDbReservedInstances";
|
|
49
56
|
const _MDRIC = "MemoryDbReservedInstancesConfiguration";
|
|
50
57
|
const _MIC = "MixedInstanceConfiguration";
|
|
@@ -80,6 +87,7 @@ const _SPP = "SavingsPlansPricing";
|
|
|
80
87
|
const _T = "Tag";
|
|
81
88
|
const _TE = "ThrottlingException";
|
|
82
89
|
const _TL = "TagList";
|
|
90
|
+
const _TP = "TimePeriod";
|
|
83
91
|
const _U = "Usage";
|
|
84
92
|
const _UES = "UpdateEnrollmentStatus";
|
|
85
93
|
const _UESR = "UpdateEnrollmentStatusRequest";
|
|
@@ -129,6 +137,7 @@ const _eD = "estimatedDiscounts";
|
|
|
129
137
|
const _eI = "ec2Instance";
|
|
130
138
|
const _eISP = "ec2InstanceSavingsPlans";
|
|
131
139
|
const _eMARC = "estimatedMonthlyAmortizedReservationCost";
|
|
140
|
+
const _eMBG = "efficiencyMetricsByGroup";
|
|
132
141
|
const _eMC = "estimatedMonthlyCost";
|
|
133
142
|
const _eMCs = "estimatedMonthlyCommitment";
|
|
134
143
|
const _eMS = "estimatedMonthlySavings";
|
|
@@ -140,11 +149,13 @@ const _eSOCCLP = "estimatedSavingsOverCostCalculationLookbackPeriod";
|
|
|
140
149
|
const _eSP = "estimatedSavingsPercentage";
|
|
141
150
|
const _eTDS = "estimatedTotalDedupedSavings";
|
|
142
151
|
const _eV = "ebsVolume";
|
|
152
|
+
const _en = "end";
|
|
143
153
|
const _f = "filter";
|
|
144
154
|
const _fN = "fieldName";
|
|
145
155
|
const _fi = "fields";
|
|
146
156
|
const _g = "group";
|
|
147
157
|
const _gB = "groupBy";
|
|
158
|
+
const _gr = "granularity";
|
|
148
159
|
const _hC = "hourlyCommitment";
|
|
149
160
|
const _hE = "httpError";
|
|
150
161
|
const _i = "iops";
|
|
@@ -164,6 +175,7 @@ const _lRT = "lastRefreshTimestamp";
|
|
|
164
175
|
const _lUT = "lastUpdatedTimestamp";
|
|
165
176
|
const _m = "message";
|
|
166
177
|
const _mADV = "memberAccountDiscountVisibility";
|
|
178
|
+
const _mBT = "metricsByTime";
|
|
167
179
|
const _mDRI = "memoryDbReservedInstances";
|
|
168
180
|
const _mI = "mixedInstances";
|
|
169
181
|
const _mR = "maxResults";
|
|
@@ -221,15 +233,21 @@ const _sPD = "savingsPlansDiscount";
|
|
|
221
233
|
const _sPR = "savingsPlansRegion";
|
|
222
234
|
const _sT = "storageType";
|
|
223
235
|
const _sTt = "storageThroughput";
|
|
236
|
+
const _sa = "savings";
|
|
237
|
+
const _sc = "score";
|
|
224
238
|
const _se = "service";
|
|
225
239
|
const _ser = "server";
|
|
226
240
|
const _sm = "smithy.ts.sdk.synthetic.com.amazonaws.costoptimizationhub";
|
|
227
241
|
const _so = "source";
|
|
242
|
+
const _sp = "spend";
|
|
228
243
|
const _st = "storage";
|
|
244
|
+
const _sta = "start";
|
|
229
245
|
const _t = "throughput";
|
|
246
|
+
const _tP = "timePeriod";
|
|
230
247
|
const _ta = "tags";
|
|
231
248
|
const _te = "term";
|
|
232
249
|
const _ten = "tenancy";
|
|
250
|
+
const _ti = "timestamp";
|
|
233
251
|
const _ty = "type";
|
|
234
252
|
const _u = "usages";
|
|
235
253
|
const _uA = "usageAmount";
|
|
@@ -241,7 +259,7 @@ const _vC = "vCpu";
|
|
|
241
259
|
const n0 = "com.amazonaws.costoptimizationhub";
|
|
242
260
|
import { TypeRegistry } from "@smithy/core/schema";
|
|
243
261
|
import { CostOptimizationHubServiceException as __CostOptimizationHubServiceException } from "../models/CostOptimizationHubServiceException";
|
|
244
|
-
import { AccessDeniedException as __AccessDeniedException, InternalServerException as __InternalServerException, ResourceNotFoundException as __ResourceNotFoundException, ThrottlingException as __ThrottlingException, ValidationException as __ValidationException, } from "../models/
|
|
262
|
+
import { AccessDeniedException as __AccessDeniedException, InternalServerException as __InternalServerException, ResourceNotFoundException as __ResourceNotFoundException, ThrottlingException as __ThrottlingException, ValidationException as __ValidationException, } from "../models/errors";
|
|
245
263
|
export var AccessDeniedException = [
|
|
246
264
|
-3,
|
|
247
265
|
n0,
|
|
@@ -381,6 +399,14 @@ export var EcsService = [
|
|
|
381
399
|
[() => EcsServiceConfiguration, () => ResourceCostCalculation],
|
|
382
400
|
];
|
|
383
401
|
export var EcsServiceConfiguration = [3, n0, _ESC, 0, [_com], [() => ComputeConfiguration]];
|
|
402
|
+
export var EfficiencyMetricsByGroup = [
|
|
403
|
+
3,
|
|
404
|
+
n0,
|
|
405
|
+
_EMBG,
|
|
406
|
+
0,
|
|
407
|
+
[_mBT, _g, _m],
|
|
408
|
+
[() => MetricsByTimeList, 0, 0],
|
|
409
|
+
];
|
|
384
410
|
export var ElastiCacheReservedInstances = [
|
|
385
411
|
3,
|
|
386
412
|
n0,
|
|
@@ -494,6 +520,22 @@ export var LambdaFunction = [
|
|
|
494
520
|
[() => LambdaFunctionConfiguration, () => ResourceCostCalculation],
|
|
495
521
|
];
|
|
496
522
|
export var LambdaFunctionConfiguration = [3, n0, _LFC, 0, [_com], [() => ComputeConfiguration]];
|
|
523
|
+
export var ListEfficiencyMetricsRequest = [
|
|
524
|
+
3,
|
|
525
|
+
n0,
|
|
526
|
+
_LEMR,
|
|
527
|
+
0,
|
|
528
|
+
[_gB, _gr, _tP, _mR, _oB, _nT],
|
|
529
|
+
[0, 0, () => TimePeriod, 1, () => OrderBy, 0],
|
|
530
|
+
];
|
|
531
|
+
export var ListEfficiencyMetricsResponse = [
|
|
532
|
+
3,
|
|
533
|
+
n0,
|
|
534
|
+
_LEMRi,
|
|
535
|
+
0,
|
|
536
|
+
[_eMBG, _nT],
|
|
537
|
+
[() => EfficiencyMetricsByGroupList, 0],
|
|
538
|
+
];
|
|
497
539
|
export var ListEnrollmentStatusesRequest = [
|
|
498
540
|
3,
|
|
499
541
|
n0,
|
|
@@ -558,6 +600,7 @@ export var MemoryDbReservedInstancesConfiguration = [
|
|
|
558
600
|
[_aS, _se, _te, _pO, _rIR, _uC, _mRC, _nUTP, _nOITP, _iT, _iF, _sFE, _cG],
|
|
559
601
|
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 0],
|
|
560
602
|
];
|
|
603
|
+
export var MetricsByTime = [3, n0, _MBT, 0, [_sc, _sa, _sp, _ti], [1, 1, 1, 0]];
|
|
561
604
|
export var MixedInstanceConfiguration = [3, n0, _MIC, 0, [_ty], [0]];
|
|
562
605
|
export var OpenSearchReservedInstances = [
|
|
563
606
|
3,
|
|
@@ -749,6 +792,7 @@ export var ThrottlingException = [
|
|
|
749
792
|
[0],
|
|
750
793
|
];
|
|
751
794
|
TypeRegistry.for(n0).registerError(ThrottlingException, __ThrottlingException);
|
|
795
|
+
export var TimePeriod = [3, n0, _TP, 0, [_sta, _en], [0, 0]];
|
|
752
796
|
export var UpdateEnrollmentStatusRequest = [3, n0, _UESR, 0, [_s, _iMA], [0, 2]];
|
|
753
797
|
export var UpdateEnrollmentStatusResponse = [3, n0, _UESRp, 0, [_s], [0]];
|
|
754
798
|
export var UpdatePreferencesRequest = [
|
|
@@ -794,7 +838,9 @@ TypeRegistry.for(_sm).registerError(CostOptimizationHubServiceException, __CostO
|
|
|
794
838
|
export var AccountEnrollmentStatuses = [1, n0, _AESc, 0, () => AccountEnrollmentStatus];
|
|
795
839
|
export var AccountIdList = 64 | 0;
|
|
796
840
|
export var ActionTypeList = 64 | 0;
|
|
841
|
+
export var EfficiencyMetricsByGroupList = [1, n0, _EMBGL, 0, () => EfficiencyMetricsByGroup];
|
|
797
842
|
export var ImplementationEffortList = 64 | 0;
|
|
843
|
+
export var MetricsByTimeList = [1, n0, _MBTL, 0, () => MetricsByTime];
|
|
798
844
|
export var MixedInstanceConfigurationList = [1, n0, _MICL, 0, () => MixedInstanceConfiguration];
|
|
799
845
|
export var RecommendationIdList = 64 | 0;
|
|
800
846
|
export var RecommendationList = [1, n0, _RL, 0, () => Recommendation];
|
|
@@ -850,6 +896,14 @@ export var GetRecommendation = [
|
|
|
850
896
|
() => GetRecommendationRequest,
|
|
851
897
|
() => GetRecommendationResponse,
|
|
852
898
|
];
|
|
899
|
+
export var ListEfficiencyMetrics = [
|
|
900
|
+
9,
|
|
901
|
+
n0,
|
|
902
|
+
_LEM,
|
|
903
|
+
0,
|
|
904
|
+
() => ListEfficiencyMetricsRequest,
|
|
905
|
+
() => ListEfficiencyMetricsResponse,
|
|
906
|
+
];
|
|
853
907
|
export var ListEnrollmentStatuses = [
|
|
854
908
|
9,
|
|
855
909
|
n0,
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
2
2
|
import { GetPreferencesCommandInput, GetPreferencesCommandOutput } from "./commands/GetPreferencesCommand";
|
|
3
3
|
import { GetRecommendationCommandInput, GetRecommendationCommandOutput } from "./commands/GetRecommendationCommand";
|
|
4
|
+
import { ListEfficiencyMetricsCommandInput, ListEfficiencyMetricsCommandOutput } from "./commands/ListEfficiencyMetricsCommand";
|
|
4
5
|
import { ListEnrollmentStatusesCommandInput, ListEnrollmentStatusesCommandOutput } from "./commands/ListEnrollmentStatusesCommand";
|
|
5
6
|
import { ListRecommendationsCommandInput, ListRecommendationsCommandOutput } from "./commands/ListRecommendationsCommand";
|
|
6
7
|
import { ListRecommendationSummariesCommandInput, ListRecommendationSummariesCommandOutput } from "./commands/ListRecommendationSummariesCommand";
|
|
@@ -21,6 +22,12 @@ export interface CostOptimizationHub {
|
|
|
21
22
|
getRecommendation(args: GetRecommendationCommandInput, options?: __HttpHandlerOptions): Promise<GetRecommendationCommandOutput>;
|
|
22
23
|
getRecommendation(args: GetRecommendationCommandInput, cb: (err: any, data?: GetRecommendationCommandOutput) => void): void;
|
|
23
24
|
getRecommendation(args: GetRecommendationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommendationCommandOutput) => void): void;
|
|
25
|
+
/**
|
|
26
|
+
* @see {@link ListEfficiencyMetricsCommand}
|
|
27
|
+
*/
|
|
28
|
+
listEfficiencyMetrics(args: ListEfficiencyMetricsCommandInput, options?: __HttpHandlerOptions): Promise<ListEfficiencyMetricsCommandOutput>;
|
|
29
|
+
listEfficiencyMetrics(args: ListEfficiencyMetricsCommandInput, cb: (err: any, data?: ListEfficiencyMetricsCommandOutput) => void): void;
|
|
30
|
+
listEfficiencyMetrics(args: ListEfficiencyMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEfficiencyMetricsCommandOutput) => void): void;
|
|
24
31
|
/**
|
|
25
32
|
* @see {@link ListEnrollmentStatusesCommand}
|
|
26
33
|
*/
|
|
@@ -9,6 +9,7 @@ import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalc
|
|
|
9
9
|
import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
|
|
10
10
|
import { GetPreferencesCommandInput, GetPreferencesCommandOutput } from "./commands/GetPreferencesCommand";
|
|
11
11
|
import { GetRecommendationCommandInput, GetRecommendationCommandOutput } from "./commands/GetRecommendationCommand";
|
|
12
|
+
import { ListEfficiencyMetricsCommandInput, ListEfficiencyMetricsCommandOutput } from "./commands/ListEfficiencyMetricsCommand";
|
|
12
13
|
import { ListEnrollmentStatusesCommandInput, ListEnrollmentStatusesCommandOutput } from "./commands/ListEnrollmentStatusesCommand";
|
|
13
14
|
import { ListRecommendationsCommandInput, ListRecommendationsCommandOutput } from "./commands/ListRecommendationsCommand";
|
|
14
15
|
import { ListRecommendationSummariesCommandInput, ListRecommendationSummariesCommandOutput } from "./commands/ListRecommendationSummariesCommand";
|
|
@@ -20,11 +21,11 @@ export { __Client };
|
|
|
20
21
|
/**
|
|
21
22
|
* @public
|
|
22
23
|
*/
|
|
23
|
-
export type ServiceInputTypes = GetPreferencesCommandInput | GetRecommendationCommandInput | ListEnrollmentStatusesCommandInput | ListRecommendationSummariesCommandInput | ListRecommendationsCommandInput | UpdateEnrollmentStatusCommandInput | UpdatePreferencesCommandInput;
|
|
24
|
+
export type ServiceInputTypes = GetPreferencesCommandInput | GetRecommendationCommandInput | ListEfficiencyMetricsCommandInput | ListEnrollmentStatusesCommandInput | ListRecommendationSummariesCommandInput | ListRecommendationsCommandInput | UpdateEnrollmentStatusCommandInput | UpdatePreferencesCommandInput;
|
|
24
25
|
/**
|
|
25
26
|
* @public
|
|
26
27
|
*/
|
|
27
|
-
export type ServiceOutputTypes = GetPreferencesCommandOutput | GetRecommendationCommandOutput | ListEnrollmentStatusesCommandOutput | ListRecommendationSummariesCommandOutput | ListRecommendationsCommandOutput | UpdateEnrollmentStatusCommandOutput | UpdatePreferencesCommandOutput;
|
|
28
|
+
export type ServiceOutputTypes = GetPreferencesCommandOutput | GetRecommendationCommandOutput | ListEfficiencyMetricsCommandOutput | ListEnrollmentStatusesCommandOutput | ListRecommendationSummariesCommandOutput | ListRecommendationsCommandOutput | UpdateEnrollmentStatusCommandOutput | UpdatePreferencesCommandOutput;
|
|
28
29
|
/**
|
|
29
30
|
* @public
|
|
30
31
|
*/
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CostOptimizationHubClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CostOptimizationHubClient";
|
|
4
|
+
import { ListEfficiencyMetricsRequest, ListEfficiencyMetricsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListEfficiencyMetricsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListEfficiencyMetricsCommandInput extends ListEfficiencyMetricsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListEfficiencyMetricsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListEfficiencyMetricsCommandOutput extends ListEfficiencyMetricsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListEfficiencyMetricsCommand_base: {
|
|
25
|
+
new (input: ListEfficiencyMetricsCommandInput): import("@smithy/smithy-client").CommandImpl<ListEfficiencyMetricsCommandInput, ListEfficiencyMetricsCommandOutput, CostOptimizationHubClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListEfficiencyMetricsCommandInput): import("@smithy/smithy-client").CommandImpl<ListEfficiencyMetricsCommandInput, ListEfficiencyMetricsCommandOutput, CostOptimizationHubClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns cost efficiency metrics aggregated over time and optionally grouped by a specified dimension. The metrics provide insights into your cost optimization progress by tracking estimated savings, spending, and measures how effectively you're optimizing your Cloud resources.</p> <p>The operation supports both daily and monthly time granularities and allows grouping results by account ID, Amazon Web Services Region. Results are returned as time-series data, enabling you to analyze trends in your cost optimization performance over the specified time period.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { CostOptimizationHubClient, ListEfficiencyMetricsCommand } from "@aws-sdk/client-cost-optimization-hub"; // ES Modules import
|
|
35
|
+
* // const { CostOptimizationHubClient, ListEfficiencyMetricsCommand } = require("@aws-sdk/client-cost-optimization-hub"); // CommonJS import
|
|
36
|
+
* // import type { CostOptimizationHubClientConfig } from "@aws-sdk/client-cost-optimization-hub";
|
|
37
|
+
* const config = {}; // type is CostOptimizationHubClientConfig
|
|
38
|
+
* const client = new CostOptimizationHubClient(config);
|
|
39
|
+
* const input = { // ListEfficiencyMetricsRequest
|
|
40
|
+
* groupBy: "STRING_VALUE",
|
|
41
|
+
* granularity: "Daily" || "Monthly", // required
|
|
42
|
+
* timePeriod: { // TimePeriod
|
|
43
|
+
* start: "STRING_VALUE", // required
|
|
44
|
+
* end: "STRING_VALUE", // required
|
|
45
|
+
* },
|
|
46
|
+
* maxResults: Number("int"),
|
|
47
|
+
* orderBy: { // OrderBy
|
|
48
|
+
* dimension: "STRING_VALUE",
|
|
49
|
+
* order: "Asc" || "Desc",
|
|
50
|
+
* },
|
|
51
|
+
* nextToken: "STRING_VALUE",
|
|
52
|
+
* };
|
|
53
|
+
* const command = new ListEfficiencyMetricsCommand(input);
|
|
54
|
+
* const response = await client.send(command);
|
|
55
|
+
* // { // ListEfficiencyMetricsResponse
|
|
56
|
+
* // efficiencyMetricsByGroup: [ // EfficiencyMetricsByGroupList
|
|
57
|
+
* // { // EfficiencyMetricsByGroup
|
|
58
|
+
* // metricsByTime: [ // MetricsByTimeList
|
|
59
|
+
* // { // MetricsByTime
|
|
60
|
+
* // score: Number("double"),
|
|
61
|
+
* // savings: Number("double"),
|
|
62
|
+
* // spend: Number("double"),
|
|
63
|
+
* // timestamp: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // group: "STRING_VALUE",
|
|
67
|
+
* // message: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // nextToken: "STRING_VALUE",
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @param ListEfficiencyMetricsCommandInput - {@link ListEfficiencyMetricsCommandInput}
|
|
76
|
+
* @returns {@link ListEfficiencyMetricsCommandOutput}
|
|
77
|
+
* @see {@link ListEfficiencyMetricsCommandInput} for command's `input` shape.
|
|
78
|
+
* @see {@link ListEfficiencyMetricsCommandOutput} for command's `response` shape.
|
|
79
|
+
* @see {@link CostOptimizationHubClientResolvedConfig | config} for CostOptimizationHubClient's `config` shape.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
82
|
+
* <p>You are not authorized to use this operation with the given parameters.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InternalServerException} (server fault)
|
|
85
|
+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
88
|
+
* <p>The request was denied due to request throttling.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ValidationException} (client fault)
|
|
91
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link CostOptimizationHubServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>
|
|
95
|
+
*
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class ListEfficiencyMetricsCommand extends ListEfficiencyMetricsCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: ListEfficiencyMetricsRequest;
|
|
104
|
+
output: ListEfficiencyMetricsResponse;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: ListEfficiencyMetricsCommandInput;
|
|
108
|
+
output: ListEfficiencyMetricsCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|
|
@@ -27,7 +27,7 @@ declare const UpdateEnrollmentStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.</p> <p>If the account is a management account
|
|
30
|
+
* <p>Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.</p> <p>If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.</p> <p>You must have the appropriate permissions to opt in to Cost Optimization Hub and to view its recommendations. When you opt in, Cost Optimization Hub automatically creates a service-linked role in your account to access its data.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from "./GetPreferencesCommand";
|
|
2
2
|
export * from "./GetRecommendationCommand";
|
|
3
|
+
export * from "./ListEfficiencyMetricsCommand";
|
|
3
4
|
export * from "./ListEnrollmentStatusesCommand";
|
|
4
5
|
export * from "./ListRecommendationSummariesCommand";
|
|
5
6
|
export * from "./ListRecommendationsCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -10,5 +10,7 @@ export type { RuntimeExtension } from "./runtimeExtensions";
|
|
|
10
10
|
export type { CostOptimizationHubExtensionConfiguration } from "./extensionConfiguration";
|
|
11
11
|
export * from "./commands";
|
|
12
12
|
export * from "./pagination";
|
|
13
|
-
export * from "./models";
|
|
13
|
+
export * from "./models/enums";
|
|
14
|
+
export * from "./models/errors";
|
|
15
|
+
export type * from "./models/models_0";
|
|
14
16
|
export { CostOptimizationHubServiceException } from "./models/CostOptimizationHubServiceException";
|