@aws-sdk/client-compute-optimizer 3.236.0 → 3.237.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 +2 -1
- package/dist-cjs/ComputeOptimizer.js +45 -0
- package/dist-cjs/commands/ExportECSServiceRecommendationsCommand.js +46 -0
- package/dist-cjs/commands/GetECSServiceRecommendationProjectedMetricsCommand.js +46 -0
- package/dist-cjs/commands/GetECSServiceRecommendationsCommand.js +46 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/index.js +1 -0
- package/dist-cjs/models/models_0.js +137 -3
- package/dist-cjs/pagination/DescribeRecommendationExportJobsPaginator.js +36 -0
- package/dist-cjs/pagination/GetEnrollmentStatusesForOrganizationPaginator.js +36 -0
- package/dist-cjs/pagination/GetLambdaFunctionRecommendationsPaginator.js +36 -0
- package/dist-cjs/pagination/GetRecommendationPreferencesPaginator.js +36 -0
- package/dist-cjs/pagination/GetRecommendationSummariesPaginator.js +36 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/index.js +9 -0
- package/dist-cjs/protocols/Aws_json1_0.js +491 -1
- package/dist-es/ComputeOptimizer.js +45 -0
- package/dist-es/commands/ExportECSServiceRecommendationsCommand.js +42 -0
- package/dist-es/commands/GetECSServiceRecommendationProjectedMetricsCommand.js +42 -0
- package/dist-es/commands/GetECSServiceRecommendationsCommand.js +42 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/index.js +1 -0
- package/dist-es/models/models_0.js +117 -0
- package/dist-es/pagination/DescribeRecommendationExportJobsPaginator.js +32 -0
- package/dist-es/pagination/GetEnrollmentStatusesForOrganizationPaginator.js +32 -0
- package/dist-es/pagination/GetLambdaFunctionRecommendationsPaginator.js +32 -0
- package/dist-es/pagination/GetRecommendationPreferencesPaginator.js +32 -0
- package/dist-es/pagination/GetRecommendationSummariesPaginator.js +32 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/index.js +6 -0
- package/dist-es/protocols/Aws_json1_0.js +484 -0
- package/dist-types/ComputeOptimizer.d.ts +76 -32
- package/dist-types/ComputeOptimizerClient.d.ts +7 -3
- package/dist-types/commands/DeleteRecommendationPreferencesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRecommendationExportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ExportAutoScalingGroupRecommendationsCommand.d.ts +2 -2
- package/dist-types/commands/ExportEBSVolumeRecommendationsCommand.d.ts +2 -2
- package/dist-types/commands/ExportEC2InstanceRecommendationsCommand.d.ts +2 -2
- package/dist-types/commands/ExportECSServiceRecommendationsCommand.d.ts +44 -0
- package/dist-types/commands/ExportLambdaFunctionRecommendationsCommand.d.ts +2 -2
- package/dist-types/commands/GetAutoScalingGroupRecommendationsCommand.d.ts +1 -1
- package/dist-types/commands/GetEBSVolumeRecommendationsCommand.d.ts +1 -1
- package/dist-types/commands/GetEC2InstanceRecommendationsCommand.d.ts +1 -1
- package/dist-types/commands/GetEC2RecommendationProjectedMetricsCommand.d.ts +2 -2
- package/dist-types/commands/GetECSServiceRecommendationProjectedMetricsCommand.d.ts +39 -0
- package/dist-types/commands/GetECSServiceRecommendationsCommand.d.ts +46 -0
- package/dist-types/commands/GetEffectiveRecommendationPreferencesCommand.d.ts +1 -1
- package/dist-types/commands/GetEnrollmentStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetEnrollmentStatusesForOrganizationCommand.d.ts +1 -1
- package/dist-types/commands/GetLambdaFunctionRecommendationsCommand.d.ts +1 -1
- package/dist-types/commands/GetRecommendationPreferencesCommand.d.ts +2 -2
- package/dist-types/commands/GetRecommendationSummariesCommand.d.ts +10 -6
- package/dist-types/commands/PutRecommendationPreferencesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEnrollmentStatusCommand.d.ts +3 -3
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1353 -519
- package/dist-types/pagination/DescribeRecommendationExportJobsPaginator.d.ts +4 -0
- package/dist-types/pagination/GetEnrollmentStatusesForOrganizationPaginator.d.ts +4 -0
- package/dist-types/pagination/GetLambdaFunctionRecommendationsPaginator.d.ts +4 -0
- package/dist-types/pagination/GetRecommendationPreferencesPaginator.d.ts +4 -0
- package/dist-types/pagination/GetRecommendationSummariesPaginator.d.ts +4 -0
- package/dist-types/pagination/Interfaces.d.ts +6 -0
- package/dist-types/pagination/index.d.ts +6 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +9 -0
- package/dist-types/ts3.4/ComputeOptimizer.d.ts +57 -0
- package/dist-types/ts3.4/ComputeOptimizerClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/ExportECSServiceRecommendationsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetECSServiceRecommendationProjectedMetricsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetECSServiceRecommendationsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +210 -0
- package/dist-types/ts3.4/pagination/DescribeRecommendationExportJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetEnrollmentStatusesForOrganizationPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetLambdaFunctionRecommendationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetRecommendationPreferencesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetRecommendationSummariesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +7 -0
- package/dist-types/ts3.4/pagination/index.d.ts +6 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +36 -0
- package/package.json +1 -1
|
@@ -31,7 +31,7 @@ export interface AccountEnrollmentStatus {
|
|
|
31
31
|
status?: Status | string;
|
|
32
32
|
/**
|
|
33
33
|
* <p>The reason for the account enrollment status.</p>
|
|
34
|
-
*
|
|
34
|
+
* <p>For example, an account might show a status of <code>Pending</code> because member
|
|
35
35
|
* accounts of an organization require more time to be enrolled in the service.</p>
|
|
36
36
|
*/
|
|
37
37
|
statusReason?: string;
|
|
@@ -41,6 +41,10 @@ export interface AccountEnrollmentStatus {
|
|
|
41
41
|
*/
|
|
42
42
|
lastUpdatedTimestamp?: Date;
|
|
43
43
|
}
|
|
44
|
+
export declare enum AutoScalingConfiguration {
|
|
45
|
+
TARGET_TRACKING_SCALING_CPU = "TargetTrackingScalingCpu",
|
|
46
|
+
TARGET_TRACKING_SCALING_MEMORY = "TargetTrackingScalingMemory"
|
|
47
|
+
}
|
|
44
48
|
/**
|
|
45
49
|
* <p>Describes the configuration of an Auto Scaling group.</p>
|
|
46
50
|
*/
|
|
@@ -85,15 +89,12 @@ export declare enum ExternalMetricsSource {
|
|
|
85
89
|
NEWRELIC = "NewRelic"
|
|
86
90
|
}
|
|
87
91
|
/**
|
|
88
|
-
* <p>
|
|
89
|
-
* Describes the external metrics preferences for EC2 rightsizing recommendations.
|
|
92
|
+
* <p> Describes the external metrics preferences for EC2 rightsizing recommendations.
|
|
90
93
|
* </p>
|
|
91
94
|
*/
|
|
92
95
|
export interface ExternalMetricsPreference {
|
|
93
96
|
/**
|
|
94
|
-
* <p>
|
|
95
|
-
* Contains the source options for external metrics preferences.
|
|
96
|
-
* </p>
|
|
97
|
+
* <p> Contains the source options for external metrics preferences. </p>
|
|
97
98
|
*/
|
|
98
99
|
source?: ExternalMetricsSource | string;
|
|
99
100
|
}
|
|
@@ -108,18 +109,18 @@ export interface EffectiveRecommendationPreferences {
|
|
|
108
109
|
/**
|
|
109
110
|
* <p>Describes the CPU vendor and architecture for an instance or Auto Scaling group
|
|
110
111
|
* recommendations.</p>
|
|
111
|
-
*
|
|
112
|
-
*
|
|
112
|
+
* <p>For example, when you specify <code>AWS_ARM64</code> with:</p>
|
|
113
|
+
* <ul>
|
|
113
114
|
* <li>
|
|
114
|
-
*
|
|
115
|
+
* <p>A <a>GetEC2InstanceRecommendations</a> or <a>GetAutoScalingGroupRecommendations</a> request, Compute Optimizer
|
|
115
116
|
* returns recommendations that consist of Graviton2 instance types only.</p>
|
|
116
117
|
* </li>
|
|
117
118
|
* <li>
|
|
118
|
-
*
|
|
119
|
+
* <p>A <a>GetEC2RecommendationProjectedMetrics</a> request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type
|
|
119
120
|
* recommendations only.</p>
|
|
120
121
|
* </li>
|
|
121
122
|
* <li>
|
|
122
|
-
*
|
|
123
|
+
* <p>A <a>ExportEC2InstanceRecommendations</a> or <a>ExportAutoScalingGroupRecommendations</a> request, Compute Optimizer
|
|
123
124
|
* exports recommendations that consist of Graviton2 instance types only.</p>
|
|
124
125
|
* </li>
|
|
125
126
|
* </ul>
|
|
@@ -128,31 +129,26 @@ export interface EffectiveRecommendationPreferences {
|
|
|
128
129
|
/**
|
|
129
130
|
* <p>Describes the activation status of the enhanced infrastructure metrics
|
|
130
131
|
* preference.</p>
|
|
131
|
-
*
|
|
132
|
+
* <p>A status of <code>Active</code> confirms that the preference is applied in the latest
|
|
132
133
|
* recommendation refresh, and a status of <code>Inactive</code> confirms that it's not yet
|
|
133
134
|
* applied to recommendations.</p>
|
|
134
|
-
*
|
|
135
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Enhanced
|
|
135
136
|
* infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
136
137
|
* Guide</i>.</p>
|
|
137
138
|
*/
|
|
138
139
|
enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string;
|
|
139
140
|
/**
|
|
140
141
|
* <p>Describes the activation status of the inferred workload types preference.</p>
|
|
141
|
-
*
|
|
142
|
-
* <p>A status of <code>Active</code> confirms that the preference is applied in the latest
|
|
142
|
+
* <p>A status of <code>Active</code> confirms that the preference is applied in the latest
|
|
143
143
|
* recommendation refresh. A status of <code>Inactive</code> confirms that it's not yet
|
|
144
144
|
* applied to recommendations.</p>
|
|
145
145
|
*/
|
|
146
146
|
inferredWorkloadTypes?: InferredWorkloadTypesPreference | string;
|
|
147
147
|
/**
|
|
148
|
-
* <p>
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
* If the preference is applied in the latest recommendation refresh, an object with a valid
|
|
153
|
-
* <code>source</code> value appears in the response. If the preference isn't applied to the
|
|
154
|
-
* recommendations already, then this object doesn't appear in the response.
|
|
155
|
-
* </p>
|
|
148
|
+
* <p> An object that describes the external metrics recommendation preference. </p>
|
|
149
|
+
* <p> If the preference is applied in the latest recommendation refresh, an object with a
|
|
150
|
+
* valid <code>source</code> value appears in the response. If the preference isn't applied
|
|
151
|
+
* to the recommendations already, then this object doesn't appear in the response. </p>
|
|
156
152
|
*/
|
|
157
153
|
externalMetricsPreference?: ExternalMetricsPreference;
|
|
158
154
|
}
|
|
@@ -200,116 +196,116 @@ export declare enum MetricStatistic {
|
|
|
200
196
|
/**
|
|
201
197
|
* <p>Describes a utilization metric of a resource, such as an Amazon EC2
|
|
202
198
|
* instance.</p>
|
|
203
|
-
*
|
|
199
|
+
* <p>Compare the utilization metric data of your resource against its projected utilization
|
|
204
200
|
* metric data to determine the performance difference between your current resource and
|
|
205
201
|
* the recommended option.</p>
|
|
206
202
|
*/
|
|
207
203
|
export interface UtilizationMetric {
|
|
208
204
|
/**
|
|
209
205
|
* <p>The name of the utilization metric.</p>
|
|
210
|
-
*
|
|
211
|
-
*
|
|
206
|
+
* <p>The following utilization metrics are available:</p>
|
|
207
|
+
* <ul>
|
|
212
208
|
* <li>
|
|
213
|
-
*
|
|
209
|
+
* <p>
|
|
214
210
|
* <code>Cpu</code> - The percentage of allocated EC2 compute units that are
|
|
215
211
|
* currently in use on the instance. This metric identifies the processing power
|
|
216
212
|
* required to run an application on the instance.</p>
|
|
217
|
-
*
|
|
213
|
+
* <p>Depending on the instance type, tools in your operating system can show a
|
|
218
214
|
* lower percentage than CloudWatch when the instance is not allocated a full
|
|
219
215
|
* processor core.</p>
|
|
220
|
-
*
|
|
216
|
+
* <p>Units: Percent</p>
|
|
221
217
|
* </li>
|
|
222
218
|
* <li>
|
|
223
|
-
*
|
|
219
|
+
* <p>
|
|
224
220
|
* <code>Memory</code> - The percentage of memory that is currently in use on the
|
|
225
221
|
* instance. This metric identifies the amount of memory required to run an
|
|
226
222
|
* application on the instance.</p>
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
*
|
|
223
|
+
* <p>Units: Percent</p>
|
|
224
|
+
* <note>
|
|
225
|
+
* <p>The <code>Memory</code> metric is returned only for resources that have
|
|
230
226
|
* the unified CloudWatch agent installed on them. For more information,
|
|
231
227
|
* see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent">Enabling Memory
|
|
232
228
|
* Utilization with the CloudWatch Agent</a>.</p>
|
|
233
|
-
*
|
|
229
|
+
* </note>
|
|
234
230
|
* </li>
|
|
235
231
|
* <li>
|
|
236
|
-
*
|
|
232
|
+
* <p>
|
|
237
233
|
* <code>EBS_READ_OPS_PER_SECOND</code> - The completed read operations from all
|
|
238
234
|
* EBS volumes attached to the instance in a specified period of time.</p>
|
|
239
|
-
*
|
|
235
|
+
* <p>Unit: Count</p>
|
|
240
236
|
* </li>
|
|
241
237
|
* <li>
|
|
242
|
-
*
|
|
238
|
+
* <p>
|
|
243
239
|
* <code>EBS_WRITE_OPS_PER_SECOND</code> - The completed write operations to all
|
|
244
240
|
* EBS volumes attached to the instance in a specified period of time.</p>
|
|
245
|
-
*
|
|
241
|
+
* <p>Unit: Count</p>
|
|
246
242
|
* </li>
|
|
247
243
|
* <li>
|
|
248
|
-
*
|
|
244
|
+
* <p>
|
|
249
245
|
* <code>EBS_READ_BYTES_PER_SECOND</code> - The bytes read from all EBS volumes
|
|
250
246
|
* attached to the instance in a specified period of time.</p>
|
|
251
|
-
*
|
|
247
|
+
* <p>Unit: Bytes</p>
|
|
252
248
|
* </li>
|
|
253
249
|
* <li>
|
|
254
|
-
*
|
|
250
|
+
* <p>
|
|
255
251
|
* <code>EBS_WRITE_BYTES_PER_SECOND</code> - The bytes written to all EBS volumes
|
|
256
252
|
* attached to the instance in a specified period of time.</p>
|
|
257
|
-
*
|
|
253
|
+
* <p>Unit: Bytes</p>
|
|
258
254
|
* </li>
|
|
259
255
|
* <li>
|
|
260
|
-
*
|
|
256
|
+
* <p>
|
|
261
257
|
* <code>DISK_READ_OPS_PER_SECOND</code> - The completed read operations from all
|
|
262
258
|
* instance store volumes available to the instance in a specified period of
|
|
263
259
|
* time.</p>
|
|
264
|
-
*
|
|
260
|
+
* <p>If there are no instance store volumes, either the value is <code>0</code> or
|
|
265
261
|
* the metric is not reported.</p>
|
|
266
262
|
* </li>
|
|
267
263
|
* <li>
|
|
268
|
-
*
|
|
264
|
+
* <p>
|
|
269
265
|
* <code>DISK_WRITE_OPS_PER_SECOND</code> - The completed write operations from
|
|
270
266
|
* all instance store volumes available to the instance in a specified period of
|
|
271
267
|
* time.</p>
|
|
272
|
-
*
|
|
268
|
+
* <p>If there are no instance store volumes, either the value is <code>0</code> or
|
|
273
269
|
* the metric is not reported.</p>
|
|
274
270
|
* </li>
|
|
275
271
|
* <li>
|
|
276
|
-
*
|
|
272
|
+
* <p>
|
|
277
273
|
* <code>DISK_READ_BYTES_PER_SECOND</code> - The bytes read from all instance
|
|
278
274
|
* store volumes available to the instance. This metric is used to determine the
|
|
279
275
|
* volume of the data the application reads from the disk of the instance. This can
|
|
280
276
|
* be used to determine the speed of the application.</p>
|
|
281
|
-
*
|
|
277
|
+
* <p>If there are no instance store volumes, either the value is <code>0</code> or
|
|
282
278
|
* the metric is not reported.</p>
|
|
283
279
|
* </li>
|
|
284
280
|
* <li>
|
|
285
|
-
*
|
|
281
|
+
* <p>
|
|
286
282
|
* <code>DISK_WRITE_BYTES_PER_SECOND</code> - The bytes written to all instance
|
|
287
283
|
* store volumes available to the instance. This metric is used to determine the
|
|
288
284
|
* volume of the data the application writes onto the disk of the instance. This
|
|
289
285
|
* can be used to determine the speed of the application.</p>
|
|
290
|
-
*
|
|
286
|
+
* <p>If there are no instance store volumes, either the value is <code>0</code> or
|
|
291
287
|
* the metric is not reported.</p>
|
|
292
288
|
* </li>
|
|
293
289
|
* <li>
|
|
294
|
-
*
|
|
290
|
+
* <p>
|
|
295
291
|
* <code>NETWORK_IN_BYTES_PER_SECOND</code> - The number of bytes received by the
|
|
296
292
|
* instance on all network interfaces. This metric identifies the volume of
|
|
297
293
|
* incoming network traffic to a single instance.</p>
|
|
298
294
|
* </li>
|
|
299
295
|
* <li>
|
|
300
|
-
*
|
|
296
|
+
* <p>
|
|
301
297
|
* <code>NETWORK_OUT_BYTES_PER_SECOND</code> - The number of bytes sent out by
|
|
302
298
|
* the instance on all network interfaces. This metric identifies the volume of
|
|
303
299
|
* outgoing network traffic from a single instance.</p>
|
|
304
300
|
* </li>
|
|
305
301
|
* <li>
|
|
306
|
-
*
|
|
302
|
+
* <p>
|
|
307
303
|
* <code>NETWORK_PACKETS_IN_PER_SECOND</code> - The number of packets received by
|
|
308
304
|
* the instance on all network interfaces. This metric identifies the volume of
|
|
309
305
|
* incoming traffic in terms of the number of packets on a single instance.</p>
|
|
310
306
|
* </li>
|
|
311
307
|
* <li>
|
|
312
|
-
*
|
|
308
|
+
* <p>
|
|
313
309
|
* <code>NETWORK_PACKETS_OUT_PER_SECOND</code> - The number of packets sent out
|
|
314
310
|
* by the instance on all network interfaces. This metric identifies the volume of
|
|
315
311
|
* outgoing traffic in terms of the number of packets on a single instance.</p>
|
|
@@ -319,10 +315,10 @@ export interface UtilizationMetric {
|
|
|
319
315
|
name?: MetricName | string;
|
|
320
316
|
/**
|
|
321
317
|
* <p>The statistic of the utilization metric.</p>
|
|
322
|
-
*
|
|
318
|
+
* <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs
|
|
323
319
|
* return utilization metrics using only the <code>Maximum</code> statistic, which is the
|
|
324
320
|
* highest value observed during the specified period.</p>
|
|
325
|
-
*
|
|
321
|
+
* <p>The Compute Optimizer console displays graphs for some utilization metrics using the
|
|
326
322
|
* <code>Average</code> statistic, which is the value of <code>Sum</code> /
|
|
327
323
|
* <code>SampleCount</code> during the specified period. For more information, see
|
|
328
324
|
* <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html">Viewing resource
|
|
@@ -344,7 +340,7 @@ export declare enum Currency {
|
|
|
344
340
|
/**
|
|
345
341
|
* <p>Describes the estimated monthly savings amount possible, based on On-Demand instance
|
|
346
342
|
* pricing, by adopting Compute Optimizer recommendations for a given resource.</p>
|
|
347
|
-
*
|
|
343
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/view-ec2-recommendations.html#ec2-savings-calculation">Estimated monthly savings and savings opportunities</a> in the
|
|
348
344
|
* <i>Compute Optimizer User Guide</i>.</p>
|
|
349
345
|
*/
|
|
350
346
|
export interface EstimatedMonthlySavings {
|
|
@@ -361,9 +357,9 @@ export interface EstimatedMonthlySavings {
|
|
|
361
357
|
/**
|
|
362
358
|
* <p>Describes the savings opportunity for recommendations of a given resource type or for
|
|
363
359
|
* the recommendation option of an individual resource.</p>
|
|
364
|
-
*
|
|
360
|
+
* <p>Savings opportunity represents the estimated monthly savings you can achieve by
|
|
365
361
|
* implementing a given Compute Optimizer recommendation.</p>
|
|
366
|
-
*
|
|
362
|
+
* <important>
|
|
367
363
|
* <p>Savings opportunity data requires that you opt in to Cost Explorer, as well as
|
|
368
364
|
* activate <b>Receive Amazon EC2 resource
|
|
369
365
|
* recommendations</b> in the Cost Explorer preferences page. That
|
|
@@ -374,7 +370,7 @@ export interface EstimatedMonthlySavings {
|
|
|
374
370
|
* of the recommendations generated. For more information, see <a href="https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html">Enabling Cost Explorer</a> and <a href="https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html">Optimizing your cost
|
|
375
371
|
* with Rightsizing Recommendations</a> in the <i>Cost Management User
|
|
376
372
|
* Guide</i>.</p>
|
|
377
|
-
*
|
|
373
|
+
* </important>
|
|
378
374
|
*/
|
|
379
375
|
export interface SavingsOpportunity {
|
|
380
376
|
/**
|
|
@@ -399,19 +395,19 @@ export interface AutoScalingGroupRecommendationOption {
|
|
|
399
395
|
configuration?: AutoScalingGroupConfiguration;
|
|
400
396
|
/**
|
|
401
397
|
* <p>An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.</p>
|
|
402
|
-
*
|
|
398
|
+
* <note>
|
|
403
399
|
* <p>The <code>Cpu</code> and <code>Memory</code> metrics are the only projected
|
|
404
400
|
* utilization metrics returned. Additionally, the <code>Memory</code> metric is
|
|
405
401
|
* returned only for resources that have the unified CloudWatch agent installed
|
|
406
402
|
* on them. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent">Enabling Memory
|
|
407
403
|
* Utilization with the CloudWatch Agent</a>.</p>
|
|
408
|
-
*
|
|
404
|
+
* </note>
|
|
409
405
|
*/
|
|
410
406
|
projectedUtilizationMetrics?: UtilizationMetric[];
|
|
411
407
|
/**
|
|
412
408
|
* <p>The performance risk of the Auto Scaling group configuration
|
|
413
409
|
* recommendation.</p>
|
|
414
|
-
*
|
|
410
|
+
* <p>Performance risk indicates the likelihood of the recommended instance type not meeting
|
|
415
411
|
* the resource needs of your workload. Compute Optimizer calculates an individual
|
|
416
412
|
* performance risk score for each specification of the recommended instance, including
|
|
417
413
|
* CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput,
|
|
@@ -419,7 +415,7 @@ export interface AutoScalingGroupRecommendationOption {
|
|
|
419
415
|
* The performance
|
|
420
416
|
* risk of the recommended instance is calculated as the maximum performance risk score
|
|
421
417
|
* across the analyzed resource specifications.</p>
|
|
422
|
-
*
|
|
418
|
+
* <p>The value ranges from <code>0</code> - <code>4</code>, with <code>0</code> meaning
|
|
423
419
|
* that the recommended resource is predicted to always provide enough hardware capability.
|
|
424
420
|
* The higher the performance risk is, the more likely you should validate whether the
|
|
425
421
|
* recommendation will meet the performance requirements of your workload before migrating
|
|
@@ -428,7 +424,7 @@ export interface AutoScalingGroupRecommendationOption {
|
|
|
428
424
|
performanceRisk?: number;
|
|
429
425
|
/**
|
|
430
426
|
* <p>The rank of the Auto Scaling group recommendation option.</p>
|
|
431
|
-
*
|
|
427
|
+
* <p>The top recommendation option is ranked as <code>1</code>.</p>
|
|
432
428
|
*/
|
|
433
429
|
rank?: number;
|
|
434
430
|
/**
|
|
@@ -440,8 +436,7 @@ export interface AutoScalingGroupRecommendationOption {
|
|
|
440
436
|
/**
|
|
441
437
|
* <p>The level of effort required to migrate from the current instance type to the
|
|
442
438
|
* recommended instance type.</p>
|
|
443
|
-
*
|
|
444
|
-
* <p>For example, the migration effort is <code>Low</code> if Amazon EMR is the
|
|
439
|
+
* <p>For example, the migration effort is <code>Low</code> if Amazon EMR is the
|
|
445
440
|
* inferred workload type and an Amazon Web Services Graviton instance type is recommended.
|
|
446
441
|
* The migration effort is <code>Medium</code> if a workload type couldn't be inferred but
|
|
447
442
|
* an Amazon Web Services Graviton instance type is recommended. The migration effort is
|
|
@@ -468,17 +463,17 @@ export interface AutoScalingGroupRecommendation {
|
|
|
468
463
|
autoScalingGroupName?: string;
|
|
469
464
|
/**
|
|
470
465
|
* <p>The finding classification of the Auto Scaling group.</p>
|
|
471
|
-
*
|
|
472
|
-
*
|
|
466
|
+
* <p>Findings for Auto Scaling groups include:</p>
|
|
467
|
+
* <ul>
|
|
473
468
|
* <li>
|
|
474
|
-
*
|
|
469
|
+
* <p>
|
|
475
470
|
* <b>
|
|
476
471
|
* <code>NotOptimized</code>
|
|
477
472
|
* </b>—An Auto Scaling group is considered not optimized when Compute Optimizer identifies a
|
|
478
473
|
* recommendation that can provide better performance for your workload.</p>
|
|
479
474
|
* </li>
|
|
480
475
|
* <li>
|
|
481
|
-
*
|
|
476
|
+
* <p>
|
|
482
477
|
* <b>
|
|
483
478
|
* <code>Optimized</code>
|
|
484
479
|
* </b>—An Auto Scaling
|
|
@@ -527,43 +522,41 @@ export interface AutoScalingGroupRecommendation {
|
|
|
527
522
|
/**
|
|
528
523
|
* <p>The applications that might be running on the instances in the Auto Scaling group
|
|
529
524
|
* as inferred by Compute Optimizer.</p>
|
|
530
|
-
*
|
|
531
|
-
* <p>Compute Optimizer can infer if one of the following applications might be running on
|
|
525
|
+
* <p>Compute Optimizer can infer if one of the following applications might be running on
|
|
532
526
|
* the instances:</p>
|
|
533
|
-
*
|
|
534
|
-
* <ul>
|
|
527
|
+
* <ul>
|
|
535
528
|
* <li>
|
|
536
|
-
*
|
|
529
|
+
* <p>
|
|
537
530
|
* <code>AmazonEmr</code> - Infers that Amazon EMR might be running on
|
|
538
531
|
* the instances.</p>
|
|
539
532
|
* </li>
|
|
540
533
|
* <li>
|
|
541
|
-
*
|
|
534
|
+
* <p>
|
|
542
535
|
* <code>ApacheCassandra</code> - Infers that Apache Cassandra might be running
|
|
543
536
|
* on the instances.</p>
|
|
544
537
|
* </li>
|
|
545
538
|
* <li>
|
|
546
|
-
*
|
|
539
|
+
* <p>
|
|
547
540
|
* <code>ApacheHadoop</code> - Infers that Apache Hadoop might be running on the
|
|
548
541
|
* instances.</p>
|
|
549
542
|
* </li>
|
|
550
543
|
* <li>
|
|
551
|
-
*
|
|
544
|
+
* <p>
|
|
552
545
|
* <code>Memcached</code> - Infers that Memcached might be running on the
|
|
553
546
|
* instances.</p>
|
|
554
547
|
* </li>
|
|
555
548
|
* <li>
|
|
556
|
-
*
|
|
549
|
+
* <p>
|
|
557
550
|
* <code>NGINX</code> - Infers that NGINX might be running on the
|
|
558
551
|
* instances.</p>
|
|
559
552
|
* </li>
|
|
560
553
|
* <li>
|
|
561
|
-
*
|
|
554
|
+
* <p>
|
|
562
555
|
* <code>PostgreSql</code> - Infers that PostgreSQL might be running on the
|
|
563
556
|
* instances.</p>
|
|
564
557
|
* </li>
|
|
565
558
|
* <li>
|
|
566
|
-
*
|
|
559
|
+
* <p>
|
|
567
560
|
* <code>Redis</code> - Infers that Redis might be running on the
|
|
568
561
|
* instances.</p>
|
|
569
562
|
* </li>
|
|
@@ -580,6 +573,7 @@ export declare enum ResourceType {
|
|
|
580
573
|
AUTO_SCALING_GROUP = "AutoScalingGroup",
|
|
581
574
|
EBS_VOLUME = "EbsVolume",
|
|
582
575
|
EC2_INSTANCE = "Ec2Instance",
|
|
576
|
+
ECS_SERVICE = "EcsService",
|
|
583
577
|
LAMBDA_FUNCTION = "LambdaFunction",
|
|
584
578
|
NOT_APPLICABLE = "NotApplicable"
|
|
585
579
|
}
|
|
@@ -590,12 +584,12 @@ export declare enum ScopeName {
|
|
|
590
584
|
}
|
|
591
585
|
/**
|
|
592
586
|
* <p>Describes the scope of a recommendation preference.</p>
|
|
593
|
-
*
|
|
587
|
+
* <p>Recommendation preferences can be created at the organization level (for management
|
|
594
588
|
* accounts of an organization only), account level, and resource level. For more
|
|
595
589
|
* information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating
|
|
596
590
|
* enhanced infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
597
591
|
* Guide</i>.</p>
|
|
598
|
-
*
|
|
592
|
+
* <note>
|
|
599
593
|
* <p>You cannot create recommendation preferences for Auto Scaling groups at the
|
|
600
594
|
* organization and account levels. You can create recommendation preferences for
|
|
601
595
|
* Auto Scaling groups only at the resource level by specifying a scope name
|
|
@@ -604,27 +598,27 @@ export declare enum ScopeName {
|
|
|
604
598
|
* part of the specified Auto Scaling group. You also cannot create recommendation
|
|
605
599
|
* preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for
|
|
606
600
|
* standalone instances.</p>
|
|
607
|
-
*
|
|
601
|
+
* </note>
|
|
608
602
|
*/
|
|
609
603
|
export interface Scope {
|
|
610
604
|
/**
|
|
611
605
|
* <p>The name of the scope.</p>
|
|
612
|
-
*
|
|
613
|
-
*
|
|
606
|
+
* <p>The following scopes are possible:</p>
|
|
607
|
+
* <ul>
|
|
614
608
|
* <li>
|
|
615
|
-
*
|
|
609
|
+
* <p>
|
|
616
610
|
* <code>Organization</code> - Specifies that the recommendation preference
|
|
617
611
|
* applies at the organization level, for all member accounts of an
|
|
618
612
|
* organization.</p>
|
|
619
613
|
* </li>
|
|
620
614
|
* <li>
|
|
621
|
-
*
|
|
615
|
+
* <p>
|
|
622
616
|
* <code>AccountId</code> - Specifies that the recommendation preference applies
|
|
623
617
|
* at the account level, for all resources of a given resource type in an
|
|
624
618
|
* account.</p>
|
|
625
619
|
* </li>
|
|
626
620
|
* <li>
|
|
627
|
-
*
|
|
621
|
+
* <p>
|
|
628
622
|
* <code>ResourceArn</code> - Specifies that the recommendation preference
|
|
629
623
|
* applies at the individual resource level.</p>
|
|
630
624
|
* </li>
|
|
@@ -633,42 +627,42 @@ export interface Scope {
|
|
|
633
627
|
name?: ScopeName | string;
|
|
634
628
|
/**
|
|
635
629
|
* <p>The value of the scope.</p>
|
|
636
|
-
*
|
|
637
|
-
*
|
|
630
|
+
* <p>If you specified the <code>name</code> of the scope as:</p>
|
|
631
|
+
* <ul>
|
|
638
632
|
* <li>
|
|
639
|
-
*
|
|
633
|
+
* <p>
|
|
640
634
|
* <code>Organization</code> - The <code>value</code> must be
|
|
641
635
|
* <code>ALL_ACCOUNTS</code>.</p>
|
|
642
636
|
* </li>
|
|
643
637
|
* <li>
|
|
644
|
-
*
|
|
638
|
+
* <p>
|
|
645
639
|
* <code>AccountId</code> - The <code>value</code> must be a 12-digit Amazon Web Services account ID.</p>
|
|
646
640
|
* </li>
|
|
647
641
|
* <li>
|
|
648
|
-
*
|
|
642
|
+
* <p>
|
|
649
643
|
* <code>ResourceArn</code> - The <code>value</code> must be the Amazon Resource
|
|
650
644
|
* Name (ARN) of an EC2 instance or an Auto Scaling group.</p>
|
|
651
645
|
* </li>
|
|
652
646
|
* </ul>
|
|
653
|
-
*
|
|
647
|
+
* <p>Only EC2 instance and Auto Scaling group ARNs are currently supported.</p>
|
|
654
648
|
*/
|
|
655
649
|
value?: string;
|
|
656
650
|
}
|
|
657
651
|
export interface DeleteRecommendationPreferencesRequest {
|
|
658
652
|
/**
|
|
659
653
|
* <p>The target resource type of the recommendation preference to delete.</p>
|
|
660
|
-
*
|
|
654
|
+
* <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances
|
|
661
655
|
* that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option
|
|
662
656
|
* encompasses only instances that are part of an Auto Scaling group.</p>
|
|
663
|
-
*
|
|
657
|
+
* <note>
|
|
664
658
|
* <p>The valid values for this parameter are <code>Ec2Instance</code> and
|
|
665
659
|
* <code>AutoScalingGroup</code>.</p>
|
|
666
|
-
*
|
|
660
|
+
* </note>
|
|
667
661
|
*/
|
|
668
662
|
resourceType: ResourceType | string | undefined;
|
|
669
663
|
/**
|
|
670
664
|
* <p>An object that describes the scope of the recommendation preference to delete.</p>
|
|
671
|
-
*
|
|
665
|
+
* <p>You can delete recommendation preferences that are created at the organization level
|
|
672
666
|
* (for management accounts of an organization only), account level, and resource level.
|
|
673
667
|
* For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating
|
|
674
668
|
* enhanced infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
@@ -768,32 +762,32 @@ export declare enum JobFilterName {
|
|
|
768
762
|
* <p>Describes a filter that returns a more specific list of recommendation export jobs.
|
|
769
763
|
* Use this filter with the <a>DescribeRecommendationExportJobs</a>
|
|
770
764
|
* action.</p>
|
|
771
|
-
*
|
|
765
|
+
* <p>You can use <code>EBSFilter</code> with the <a>GetEBSVolumeRecommendations</a> action,
|
|
772
766
|
* <code>LambdaFunctionRecommendationFilter</code> with the <a>GetLambdaFunctionRecommendations</a> action, and <code>Filter</code> with
|
|
773
767
|
* the <a>GetAutoScalingGroupRecommendations</a> and <a>GetEC2InstanceRecommendations</a> actions.</p>
|
|
774
768
|
*/
|
|
775
769
|
export interface JobFilter {
|
|
776
770
|
/**
|
|
777
771
|
* <p>The name of the filter.</p>
|
|
778
|
-
*
|
|
772
|
+
* <p>Specify <code>ResourceType</code> to return export jobs of a specific resource type
|
|
779
773
|
* (for example, <code>Ec2Instance</code>).</p>
|
|
780
|
-
*
|
|
774
|
+
* <p>Specify <code>JobStatus</code> to return export jobs with a specific status (e.g,
|
|
781
775
|
* <code>Complete</code>).</p>
|
|
782
776
|
*/
|
|
783
777
|
name?: JobFilterName | string;
|
|
784
778
|
/**
|
|
785
779
|
* <p>The value of the filter.</p>
|
|
786
|
-
*
|
|
780
|
+
* <p>The valid values for this parameter are as follows, depending on what you specify for
|
|
787
781
|
* the <code>name</code> parameter:</p>
|
|
788
|
-
*
|
|
782
|
+
* <ul>
|
|
789
783
|
* <li>
|
|
790
|
-
*
|
|
784
|
+
* <p>Specify <code>Ec2Instance</code> or <code>AutoScalingGroup</code> if you
|
|
791
785
|
* specify the <code>name</code> parameter as <code>ResourceType</code>. There is
|
|
792
786
|
* no filter for EBS volumes because volume recommendations cannot be exported at
|
|
793
787
|
* this time.</p>
|
|
794
788
|
* </li>
|
|
795
789
|
* <li>
|
|
796
|
-
*
|
|
790
|
+
* <p>Specify <code>Queued</code>, <code>InProgress</code>, <code>Complete</code>,
|
|
797
791
|
* or <code>Failed</code> if you specify the <code>name</code> parameter as
|
|
798
792
|
* <code>JobStatus</code>.</p>
|
|
799
793
|
* </li>
|
|
@@ -804,8 +798,8 @@ export interface JobFilter {
|
|
|
804
798
|
export interface DescribeRecommendationExportJobsRequest {
|
|
805
799
|
/**
|
|
806
800
|
* <p>The identification numbers of the export jobs to return.</p>
|
|
807
|
-
*
|
|
808
|
-
*
|
|
801
|
+
* <p>An export job ID is returned when you create an export using the <a>ExportAutoScalingGroupRecommendations</a> or <a>ExportEC2InstanceRecommendations</a> actions.</p>
|
|
802
|
+
* <p>All export jobs created in the last seven days are returned if this parameter is
|
|
809
803
|
* omitted.</p>
|
|
810
804
|
*/
|
|
811
805
|
jobIds?: string[];
|
|
@@ -820,7 +814,7 @@ export interface DescribeRecommendationExportJobsRequest {
|
|
|
820
814
|
nextToken?: string;
|
|
821
815
|
/**
|
|
822
816
|
* <p>The maximum number of export jobs to return with a single request.</p>
|
|
823
|
-
*
|
|
817
|
+
* <p>To retrieve the remaining results, make another request with the returned
|
|
824
818
|
* <code>nextToken</code> value.</p>
|
|
825
819
|
*/
|
|
826
820
|
maxResults?: number;
|
|
@@ -837,12 +831,12 @@ export interface S3Destination {
|
|
|
837
831
|
bucket?: string;
|
|
838
832
|
/**
|
|
839
833
|
* <p>The Amazon S3 bucket key of an export file.</p>
|
|
840
|
-
*
|
|
834
|
+
* <p>The key uniquely identifies the object, or export file, in the S3 bucket.</p>
|
|
841
835
|
*/
|
|
842
836
|
key?: string;
|
|
843
837
|
/**
|
|
844
838
|
* <p>The Amazon S3 bucket key of a metadata file.</p>
|
|
845
|
-
*
|
|
839
|
+
* <p>The key uniquely identifies the object, or metadata file, in the S3 bucket.</p>
|
|
846
840
|
*/
|
|
847
841
|
metadataKey?: string;
|
|
848
842
|
}
|
|
@@ -865,9 +859,9 @@ export declare enum JobStatus {
|
|
|
865
859
|
}
|
|
866
860
|
/**
|
|
867
861
|
* <p>Describes a recommendation export job.</p>
|
|
868
|
-
*
|
|
862
|
+
* <p>Use the <a>DescribeRecommendationExportJobs</a> action to view your
|
|
869
863
|
* recommendation export jobs.</p>
|
|
870
|
-
*
|
|
864
|
+
* <p>Use the <a>ExportAutoScalingGroupRecommendations</a> or <a>ExportEC2InstanceRecommendations</a> actions to request an export of your
|
|
871
865
|
* recommendations.</p>
|
|
872
866
|
*/
|
|
873
867
|
export interface RecommendationExportJob {
|
|
@@ -907,7 +901,7 @@ export interface DescribeRecommendationExportJobsResponse {
|
|
|
907
901
|
recommendationExportJobs?: RecommendationExportJob[];
|
|
908
902
|
/**
|
|
909
903
|
* <p>The token to use to advance to the next page of export jobs.</p>
|
|
910
|
-
*
|
|
904
|
+
* <p>This value is null when there are no more pages of export jobs to return.</p>
|
|
911
905
|
*/
|
|
912
906
|
nextToken?: string;
|
|
913
907
|
}
|
|
@@ -978,125 +972,125 @@ export declare enum FilterName {
|
|
|
978
972
|
/**
|
|
979
973
|
* <p>Describes a filter that returns a more specific list of recommendations. Use this
|
|
980
974
|
* filter with the <a>GetAutoScalingGroupRecommendations</a> and <a>GetEC2InstanceRecommendations</a> actions.</p>
|
|
981
|
-
*
|
|
975
|
+
* <p>You can use <code>EBSFilter</code> with the <a>GetEBSVolumeRecommendations</a> action,
|
|
982
976
|
* <code>LambdaFunctionRecommendationFilter</code> with the <a>GetLambdaFunctionRecommendations</a> action, and <code>JobFilter</code> with
|
|
983
977
|
* the <a>DescribeRecommendationExportJobs</a> action.</p>
|
|
984
978
|
*/
|
|
985
979
|
export interface Filter {
|
|
986
980
|
/**
|
|
987
981
|
* <p>The name of the filter.</p>
|
|
988
|
-
*
|
|
982
|
+
* <p>Specify <code>Finding</code> to return recommendations with a specific finding
|
|
989
983
|
* classification (for example, <code>Underprovisioned</code>).</p>
|
|
990
|
-
*
|
|
984
|
+
* <p>Specify <code>RecommendationSourceType</code> to return recommendations of a specific
|
|
991
985
|
* resource type (for example, <code>Ec2Instance</code>).</p>
|
|
992
|
-
*
|
|
986
|
+
* <p>Specify <code>FindingReasonCodes</code> to return recommendations with a specific
|
|
993
987
|
* finding reason code (for example, <code>CPUUnderprovisioned</code>).</p>
|
|
994
988
|
*/
|
|
995
989
|
name?: FilterName | string;
|
|
996
990
|
/**
|
|
997
991
|
* <p>The value of the filter.</p>
|
|
998
|
-
*
|
|
992
|
+
* <p>The valid values for this parameter are as follows, depending on what you specify for
|
|
999
993
|
* the <code>name</code> parameter and the resource type that you wish to filter results
|
|
1000
994
|
* for:</p>
|
|
1001
|
-
*
|
|
995
|
+
* <ul>
|
|
1002
996
|
* <li>
|
|
1003
|
-
*
|
|
997
|
+
* <p>Specify <code>Optimized</code> or <code>NotOptimized</code> if you specify the
|
|
1004
998
|
* <code>name</code> parameter as <code>Finding</code> and you want to filter
|
|
1005
999
|
* results for Auto Scaling groups.</p>
|
|
1006
1000
|
* </li>
|
|
1007
1001
|
* <li>
|
|
1008
|
-
*
|
|
1002
|
+
* <p>Specify <code>Underprovisioned</code>, <code>Overprovisioned</code>, or
|
|
1009
1003
|
* <code>Optimized</code> if you specify the <code>name</code> parameter as
|
|
1010
1004
|
* <code>Finding</code> and you want to filter results for EC2
|
|
1011
1005
|
* instances.</p>
|
|
1012
1006
|
* </li>
|
|
1013
1007
|
* <li>
|
|
1014
|
-
*
|
|
1008
|
+
* <p>Specify <code>Ec2Instance</code> or <code>AutoScalingGroup</code> if you
|
|
1015
1009
|
* specify the <code>name</code> parameter as
|
|
1016
1010
|
* <code>RecommendationSourceType</code>.</p>
|
|
1017
1011
|
* </li>
|
|
1018
1012
|
* <li>
|
|
1019
|
-
*
|
|
1013
|
+
* <p>Specify one of the following options if you specify the <code>name</code>
|
|
1020
1014
|
* parameter as <code>FindingReasonCodes</code>:</p>
|
|
1021
|
-
*
|
|
1015
|
+
* <ul>
|
|
1022
1016
|
* <li>
|
|
1023
|
-
*
|
|
1017
|
+
* <p>
|
|
1024
1018
|
* <b>
|
|
1025
1019
|
* <code>CPUOverprovisioned</code>
|
|
1026
1020
|
* </b> — The
|
|
1027
1021
|
* instance’s CPU configuration can be sized down while still meeting the
|
|
1028
1022
|
* performance requirements of your workload.</p>
|
|
1029
|
-
*
|
|
1023
|
+
* </li>
|
|
1030
1024
|
* <li>
|
|
1031
|
-
*
|
|
1025
|
+
* <p>
|
|
1032
1026
|
* <b>
|
|
1033
1027
|
* <code>CPUUnderprovisioned</code>
|
|
1034
1028
|
* </b> —
|
|
1035
1029
|
* The instance’s CPU configuration doesn't meet the performance
|
|
1036
1030
|
* requirements of your workload and there is an alternative instance type
|
|
1037
1031
|
* that provides better CPU performance.</p>
|
|
1038
|
-
*
|
|
1032
|
+
* </li>
|
|
1039
1033
|
* <li>
|
|
1040
|
-
*
|
|
1034
|
+
* <p>
|
|
1041
1035
|
* <b>
|
|
1042
1036
|
* <code>MemoryOverprovisioned</code>
|
|
1043
1037
|
* </b> —
|
|
1044
1038
|
* The instance’s memory configuration can be sized down while still
|
|
1045
1039
|
* meeting the performance requirements of your workload.</p>
|
|
1046
|
-
*
|
|
1040
|
+
* </li>
|
|
1047
1041
|
* <li>
|
|
1048
|
-
*
|
|
1042
|
+
* <p>
|
|
1049
1043
|
* <b>
|
|
1050
1044
|
* <code>MemoryUnderprovisioned</code>
|
|
1051
1045
|
* </b> —
|
|
1052
1046
|
* The instance’s memory configuration doesn't meet the performance
|
|
1053
1047
|
* requirements of your workload and there is an alternative instance type
|
|
1054
1048
|
* that provides better memory performance.</p>
|
|
1055
|
-
*
|
|
1049
|
+
* </li>
|
|
1056
1050
|
* <li>
|
|
1057
|
-
*
|
|
1051
|
+
* <p>
|
|
1058
1052
|
* <b>
|
|
1059
1053
|
* <code>EBSThroughputOverprovisioned</code>
|
|
1060
1054
|
* </b> — The
|
|
1061
1055
|
* instance’s EBS throughput configuration can be sized down while still
|
|
1062
1056
|
* meeting the performance requirements of your workload.</p>
|
|
1063
|
-
*
|
|
1057
|
+
* </li>
|
|
1064
1058
|
* <li>
|
|
1065
|
-
*
|
|
1059
|
+
* <p>
|
|
1066
1060
|
* <b>
|
|
1067
1061
|
* <code>EBSThroughputUnderprovisioned</code>
|
|
1068
1062
|
* </b> — The
|
|
1069
1063
|
* instance’s EBS throughput configuration doesn't meet the performance
|
|
1070
1064
|
* requirements of your workload and there is an alternative instance type
|
|
1071
1065
|
* that provides better EBS throughput performance.</p>
|
|
1072
|
-
*
|
|
1066
|
+
* </li>
|
|
1073
1067
|
* <li>
|
|
1074
|
-
*
|
|
1068
|
+
* <p>
|
|
1075
1069
|
* <b>
|
|
1076
1070
|
* <code>EBSIOPSOverprovisioned</code>
|
|
1077
1071
|
* </b> —
|
|
1078
1072
|
* The instance’s EBS IOPS configuration can be sized down while still
|
|
1079
1073
|
* meeting the performance requirements of your workload.</p>
|
|
1080
|
-
*
|
|
1074
|
+
* </li>
|
|
1081
1075
|
* <li>
|
|
1082
|
-
*
|
|
1076
|
+
* <p>
|
|
1083
1077
|
* <b>
|
|
1084
1078
|
* <code>EBSIOPSUnderprovisioned</code>
|
|
1085
1079
|
* </b>
|
|
1086
1080
|
* — The instance’s EBS IOPS configuration doesn't meet the performance
|
|
1087
1081
|
* requirements of your workload and there is an alternative instance type
|
|
1088
1082
|
* that provides better EBS IOPS performance.</p>
|
|
1089
|
-
*
|
|
1083
|
+
* </li>
|
|
1090
1084
|
* <li>
|
|
1091
|
-
*
|
|
1085
|
+
* <p>
|
|
1092
1086
|
* <b>
|
|
1093
1087
|
* <code>NetworkBandwidthOverprovisioned</code>
|
|
1094
1088
|
* </b> — The
|
|
1095
1089
|
* instance’s network bandwidth configuration can be sized down while still
|
|
1096
1090
|
* meeting the performance requirements of your workload.</p>
|
|
1097
|
-
*
|
|
1091
|
+
* </li>
|
|
1098
1092
|
* <li>
|
|
1099
|
-
*
|
|
1093
|
+
* <p>
|
|
1100
1094
|
* <b>
|
|
1101
1095
|
* <code>NetworkBandwidthUnderprovisioned</code>
|
|
1102
1096
|
* </b> — The
|
|
@@ -1105,58 +1099,58 @@ export interface Filter {
|
|
|
1105
1099
|
* that provides better network bandwidth performance. This finding reason
|
|
1106
1100
|
* happens when the <code>NetworkIn</code> or <code>NetworkOut</code>
|
|
1107
1101
|
* performance of an instance is impacted.</p>
|
|
1108
|
-
*
|
|
1102
|
+
* </li>
|
|
1109
1103
|
* <li>
|
|
1110
|
-
*
|
|
1104
|
+
* <p>
|
|
1111
1105
|
* <b>
|
|
1112
1106
|
* <code>NetworkPPSOverprovisioned</code>
|
|
1113
1107
|
* </b> — The instance’s
|
|
1114
1108
|
* network PPS (packets per second) configuration can be sized down while
|
|
1115
1109
|
* still meeting the performance requirements of your workload.</p>
|
|
1116
|
-
*
|
|
1110
|
+
* </li>
|
|
1117
1111
|
* <li>
|
|
1118
|
-
*
|
|
1112
|
+
* <p>
|
|
1119
1113
|
* <b>
|
|
1120
1114
|
* <code>NetworkPPSUnderprovisioned</code>
|
|
1121
1115
|
* </b> — The instance’s
|
|
1122
1116
|
* network PPS (packets per second) configuration doesn't meet the
|
|
1123
1117
|
* performance requirements of your workload and there is an alternative
|
|
1124
1118
|
* instance type that provides better network PPS performance.</p>
|
|
1125
|
-
*
|
|
1119
|
+
* </li>
|
|
1126
1120
|
* <li>
|
|
1127
|
-
*
|
|
1121
|
+
* <p>
|
|
1128
1122
|
* <b>
|
|
1129
1123
|
* <code>DiskIOPSOverprovisioned</code>
|
|
1130
1124
|
* </b>
|
|
1131
1125
|
* — The instance’s disk IOPS configuration can be sized down while still
|
|
1132
1126
|
* meeting the performance requirements of your workload.</p>
|
|
1133
|
-
*
|
|
1127
|
+
* </li>
|
|
1134
1128
|
* <li>
|
|
1135
|
-
*
|
|
1129
|
+
* <p>
|
|
1136
1130
|
* <b>
|
|
1137
1131
|
* <code>DiskIOPSUnderprovisioned</code>
|
|
1138
1132
|
* </b>
|
|
1139
1133
|
* — The instance’s disk IOPS configuration doesn't meet the performance
|
|
1140
1134
|
* requirements of your workload and there is an alternative instance type
|
|
1141
1135
|
* that provides better disk IOPS performance.</p>
|
|
1142
|
-
*
|
|
1136
|
+
* </li>
|
|
1143
1137
|
* <li>
|
|
1144
|
-
*
|
|
1138
|
+
* <p>
|
|
1145
1139
|
* <b>
|
|
1146
1140
|
* <code>DiskThroughputOverprovisioned</code>
|
|
1147
1141
|
* </b> — The
|
|
1148
1142
|
* instance’s disk throughput configuration can be sized down while still
|
|
1149
1143
|
* meeting the performance requirements of your workload.</p>
|
|
1150
|
-
*
|
|
1144
|
+
* </li>
|
|
1151
1145
|
* <li>
|
|
1152
|
-
*
|
|
1146
|
+
* <p>
|
|
1153
1147
|
* <b>
|
|
1154
1148
|
* <code>DiskThroughputUnderprovisioned</code>
|
|
1155
1149
|
* </b> — The
|
|
1156
1150
|
* instance’s disk throughput configuration doesn't meet the performance
|
|
1157
1151
|
* requirements of your workload and there is an alternative instance type
|
|
1158
1152
|
* that provides better disk throughput performance.</p>
|
|
1159
|
-
*
|
|
1153
|
+
* </li>
|
|
1160
1154
|
* </ul>
|
|
1161
1155
|
* </li>
|
|
1162
1156
|
* </ul>
|
|
@@ -1169,18 +1163,18 @@ export interface Filter {
|
|
|
1169
1163
|
export interface RecommendationPreferences {
|
|
1170
1164
|
/**
|
|
1171
1165
|
* <p>Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.</p>
|
|
1172
|
-
*
|
|
1173
|
-
*
|
|
1166
|
+
* <p>For example, when you specify <code>AWS_ARM64</code> with:</p>
|
|
1167
|
+
* <ul>
|
|
1174
1168
|
* <li>
|
|
1175
|
-
*
|
|
1169
|
+
* <p>A <a>GetEC2InstanceRecommendations</a> or <a>GetAutoScalingGroupRecommendations</a> request, Compute Optimizer
|
|
1176
1170
|
* returns recommendations that consist of Graviton2 instance types only.</p>
|
|
1177
1171
|
* </li>
|
|
1178
1172
|
* <li>
|
|
1179
|
-
*
|
|
1173
|
+
* <p>A <a>GetEC2RecommendationProjectedMetrics</a> request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type
|
|
1180
1174
|
* recommendations only.</p>
|
|
1181
1175
|
* </li>
|
|
1182
1176
|
* <li>
|
|
1183
|
-
*
|
|
1177
|
+
* <p>A <a>ExportEC2InstanceRecommendations</a> or <a>ExportAutoScalingGroupRecommendations</a> request, Compute Optimizer
|
|
1184
1178
|
* exports recommendations that consist of Graviton2 instance types only.</p>
|
|
1185
1179
|
* </li>
|
|
1186
1180
|
* </ul>
|
|
@@ -1190,7 +1184,7 @@ export interface RecommendationPreferences {
|
|
|
1190
1184
|
/**
|
|
1191
1185
|
* <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
|
|
1192
1186
|
* key prefix for a recommendations export job.</p>
|
|
1193
|
-
*
|
|
1187
|
+
* <p>You must create the destination Amazon S3 bucket for your recommendations
|
|
1194
1188
|
* export before you create the export job. Compute Optimizer does not create the S3 bucket
|
|
1195
1189
|
* for you. After you create the S3 bucket, ensure that it has the required permission
|
|
1196
1190
|
* policy to allow Compute Optimizer to write the export file to it. If you plan to specify
|
|
@@ -1213,13 +1207,13 @@ export interface ExportAutoScalingGroupRecommendationsRequest {
|
|
|
1213
1207
|
/**
|
|
1214
1208
|
* <p>The IDs of the Amazon Web Services accounts for which to export Auto Scaling group
|
|
1215
1209
|
* recommendations.</p>
|
|
1216
|
-
*
|
|
1210
|
+
* <p>If your account is the management account of an organization, use this parameter to
|
|
1217
1211
|
* specify the member account for which you want to export recommendations.</p>
|
|
1218
|
-
*
|
|
1212
|
+
* <p>This parameter cannot be specified together with the include member accounts
|
|
1219
1213
|
* parameter. The parameters are mutually exclusive.</p>
|
|
1220
|
-
*
|
|
1214
|
+
* <p>Recommendations for member accounts are not included in the export if this parameter,
|
|
1221
1215
|
* or the include member accounts parameter, is omitted.</p>
|
|
1222
|
-
*
|
|
1216
|
+
* <p>You can specify multiple account IDs per request.</p>
|
|
1223
1217
|
*/
|
|
1224
1218
|
accountIds?: string[];
|
|
1225
1219
|
/**
|
|
@@ -1235,7 +1229,7 @@ export interface ExportAutoScalingGroupRecommendationsRequest {
|
|
|
1235
1229
|
/**
|
|
1236
1230
|
* <p>An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket
|
|
1237
1231
|
* name and key prefix for the export job.</p>
|
|
1238
|
-
*
|
|
1232
|
+
* <p>You must create the destination Amazon S3 bucket for your recommendations
|
|
1239
1233
|
* export before you create the export job. Compute Optimizer does not create the S3 bucket
|
|
1240
1234
|
* for you. After you create the S3 bucket, ensure that it has the required permissions
|
|
1241
1235
|
* policy to allow Compute Optimizer to write the export file to it. If you plan to specify
|
|
@@ -1246,21 +1240,21 @@ export interface ExportAutoScalingGroupRecommendationsRequest {
|
|
|
1246
1240
|
s3DestinationConfig: S3DestinationConfig | undefined;
|
|
1247
1241
|
/**
|
|
1248
1242
|
* <p>The format of the export file.</p>
|
|
1249
|
-
*
|
|
1243
|
+
* <p>The only export file format currently supported is <code>Csv</code>.</p>
|
|
1250
1244
|
*/
|
|
1251
1245
|
fileFormat?: FileFormat | string;
|
|
1252
1246
|
/**
|
|
1253
1247
|
* <p>Indicates whether to include recommendations for resources in all member accounts of
|
|
1254
1248
|
* the organization if your account is the management account of an organization.</p>
|
|
1255
|
-
*
|
|
1249
|
+
* <p>The member accounts must also be opted in to Compute Optimizer, and trusted access for
|
|
1256
1250
|
* Compute Optimizer must be enabled in the organization account. For more information,
|
|
1257
1251
|
* see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access">Compute Optimizer and Amazon Web Services Organizations trusted access</a> in the
|
|
1258
1252
|
* <i>Compute Optimizer User Guide</i>.</p>
|
|
1259
|
-
*
|
|
1253
|
+
* <p>Recommendations for member accounts of the organization are not included in the export
|
|
1260
1254
|
* file if this parameter is omitted.</p>
|
|
1261
|
-
*
|
|
1255
|
+
* <p>This parameter cannot be specified together with the account IDs parameter. The
|
|
1262
1256
|
* parameters are mutually exclusive.</p>
|
|
1263
|
-
*
|
|
1257
|
+
* <p>Recommendations for member accounts are not included in the export if this parameter,
|
|
1264
1258
|
* or the account IDs parameter, is omitted.</p>
|
|
1265
1259
|
*/
|
|
1266
1260
|
includeMemberAccounts?: boolean;
|
|
@@ -1273,7 +1267,7 @@ export interface ExportAutoScalingGroupRecommendationsRequest {
|
|
|
1273
1267
|
export interface ExportAutoScalingGroupRecommendationsResponse {
|
|
1274
1268
|
/**
|
|
1275
1269
|
* <p>The identification number of the export job.</p>
|
|
1276
|
-
*
|
|
1270
|
+
* <p>Use the <a>DescribeRecommendationExportJobs</a> action, and specify the job
|
|
1277
1271
|
* ID to view the status of an export job.</p>
|
|
1278
1272
|
*/
|
|
1279
1273
|
jobId?: string;
|
|
@@ -1330,20 +1324,20 @@ export declare enum EBSFilterName {
|
|
|
1330
1324
|
/**
|
|
1331
1325
|
* <p>Describes a filter that returns a more specific list of Amazon Elastic Block Store
|
|
1332
1326
|
* (Amazon EBS) volume recommendations. Use this filter with the <a>GetEBSVolumeRecommendations</a> action.</p>
|
|
1333
|
-
*
|
|
1327
|
+
* <p>You can use <code>LambdaFunctionRecommendationFilter</code> with the <a>GetLambdaFunctionRecommendations</a> action, <code>JobFilter</code> with the
|
|
1334
1328
|
* <a>DescribeRecommendationExportJobs</a> action, and <code>Filter</code>
|
|
1335
1329
|
* with the <a>GetAutoScalingGroupRecommendations</a> and <a>GetEC2InstanceRecommendations</a> actions.</p>
|
|
1336
1330
|
*/
|
|
1337
1331
|
export interface EBSFilter {
|
|
1338
1332
|
/**
|
|
1339
1333
|
* <p>The name of the filter.</p>
|
|
1340
|
-
*
|
|
1334
|
+
* <p>Specify <code>Finding</code> to return recommendations with a specific finding
|
|
1341
1335
|
* classification (for example, <code>NotOptimized</code>).</p>
|
|
1342
1336
|
*/
|
|
1343
1337
|
name?: EBSFilterName | string;
|
|
1344
1338
|
/**
|
|
1345
1339
|
* <p>The value of the filter.</p>
|
|
1346
|
-
*
|
|
1340
|
+
* <p>The valid values are <code>Optimized</code>, or <code>NotOptimized</code>.</p>
|
|
1347
1341
|
*/
|
|
1348
1342
|
values?: string[];
|
|
1349
1343
|
}
|
|
@@ -1351,13 +1345,13 @@ export interface ExportEBSVolumeRecommendationsRequest {
|
|
|
1351
1345
|
/**
|
|
1352
1346
|
* <p>The IDs of the Amazon Web Services accounts for which to export Amazon EBS
|
|
1353
1347
|
* volume recommendations.</p>
|
|
1354
|
-
*
|
|
1348
|
+
* <p>If your account is the management account of an organization, use this parameter to
|
|
1355
1349
|
* specify the member account for which you want to export recommendations.</p>
|
|
1356
|
-
*
|
|
1350
|
+
* <p>This parameter cannot be specified together with the include member accounts
|
|
1357
1351
|
* parameter. The parameters are mutually exclusive.</p>
|
|
1358
|
-
*
|
|
1352
|
+
* <p>Recommendations for member accounts are not included in the export if this parameter,
|
|
1359
1353
|
* or the include member accounts parameter, is omitted.</p>
|
|
1360
|
-
*
|
|
1354
|
+
* <p>You can specify multiple account IDs per request.</p>
|
|
1361
1355
|
*/
|
|
1362
1356
|
accountIds?: string[];
|
|
1363
1357
|
/**
|
|
@@ -1373,7 +1367,7 @@ export interface ExportEBSVolumeRecommendationsRequest {
|
|
|
1373
1367
|
/**
|
|
1374
1368
|
* <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
|
|
1375
1369
|
* key prefix for a recommendations export job.</p>
|
|
1376
|
-
*
|
|
1370
|
+
* <p>You must create the destination Amazon S3 bucket for your recommendations
|
|
1377
1371
|
* export before you create the export job. Compute Optimizer does not create the S3 bucket
|
|
1378
1372
|
* for you. After you create the S3 bucket, ensure that it has the required permission
|
|
1379
1373
|
* policy to allow Compute Optimizer to write the export file to it. If you plan to specify
|
|
@@ -1384,21 +1378,21 @@ export interface ExportEBSVolumeRecommendationsRequest {
|
|
|
1384
1378
|
s3DestinationConfig: S3DestinationConfig | undefined;
|
|
1385
1379
|
/**
|
|
1386
1380
|
* <p>The format of the export file.</p>
|
|
1387
|
-
*
|
|
1381
|
+
* <p>The only export file format currently supported is <code>Csv</code>.</p>
|
|
1388
1382
|
*/
|
|
1389
1383
|
fileFormat?: FileFormat | string;
|
|
1390
1384
|
/**
|
|
1391
1385
|
* <p>Indicates whether to include recommendations for resources in all member accounts of
|
|
1392
1386
|
* the organization if your account is the management account of an organization.</p>
|
|
1393
|
-
*
|
|
1387
|
+
* <p>The member accounts must also be opted in to Compute Optimizer, and trusted access for
|
|
1394
1388
|
* Compute Optimizer must be enabled in the organization account. For more information,
|
|
1395
1389
|
* see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access">Compute Optimizer and Amazon Web Services Organizations trusted access</a> in the
|
|
1396
1390
|
* <i>Compute Optimizer User Guide</i>.</p>
|
|
1397
|
-
*
|
|
1391
|
+
* <p>Recommendations for member accounts of the organization are not included in the export
|
|
1398
1392
|
* file if this parameter is omitted.</p>
|
|
1399
|
-
*
|
|
1393
|
+
* <p>This parameter cannot be specified together with the account IDs parameter. The
|
|
1400
1394
|
* parameters are mutually exclusive.</p>
|
|
1401
|
-
*
|
|
1395
|
+
* <p>Recommendations for member accounts are not included in the export if this parameter,
|
|
1402
1396
|
* or the account IDs parameter, is omitted.</p>
|
|
1403
1397
|
*/
|
|
1404
1398
|
includeMemberAccounts?: boolean;
|
|
@@ -1406,7 +1400,7 @@ export interface ExportEBSVolumeRecommendationsRequest {
|
|
|
1406
1400
|
export interface ExportEBSVolumeRecommendationsResponse {
|
|
1407
1401
|
/**
|
|
1408
1402
|
* <p>The identification number of the export job.</p>
|
|
1409
|
-
*
|
|
1403
|
+
* <p>Use the <a>DescribeRecommendationExportJobs</a> action, and specify the job
|
|
1410
1404
|
* ID to view the status of an export job.</p>
|
|
1411
1405
|
*/
|
|
1412
1406
|
jobId?: string;
|
|
@@ -1475,13 +1469,13 @@ export interface ExportEC2InstanceRecommendationsRequest {
|
|
|
1475
1469
|
/**
|
|
1476
1470
|
* <p>The IDs of the Amazon Web Services accounts for which to export instance
|
|
1477
1471
|
* recommendations.</p>
|
|
1478
|
-
*
|
|
1472
|
+
* <p>If your account is the management account of an organization, use this parameter to
|
|
1479
1473
|
* specify the member account for which you want to export recommendations.</p>
|
|
1480
|
-
*
|
|
1474
|
+
* <p>This parameter cannot be specified together with the include member accounts
|
|
1481
1475
|
* parameter. The parameters are mutually exclusive.</p>
|
|
1482
|
-
*
|
|
1476
|
+
* <p>Recommendations for member accounts are not included in the export if this parameter,
|
|
1483
1477
|
* or the include member accounts parameter, is omitted.</p>
|
|
1484
|
-
*
|
|
1478
|
+
* <p>You can specify multiple account IDs per request.</p>
|
|
1485
1479
|
*/
|
|
1486
1480
|
accountIds?: string[];
|
|
1487
1481
|
/**
|
|
@@ -1498,7 +1492,7 @@ export interface ExportEC2InstanceRecommendationsRequest {
|
|
|
1498
1492
|
/**
|
|
1499
1493
|
* <p>An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket
|
|
1500
1494
|
* name and key prefix for the export job.</p>
|
|
1501
|
-
*
|
|
1495
|
+
* <p>You must create the destination Amazon S3 bucket for your recommendations
|
|
1502
1496
|
* export before you create the export job. Compute Optimizer does not create the S3 bucket
|
|
1503
1497
|
* for you. After you create the S3 bucket, ensure that it has the required permissions
|
|
1504
1498
|
* policy to allow Compute Optimizer to write the export file to it.
|
|
@@ -1510,19 +1504,19 @@ export interface ExportEC2InstanceRecommendationsRequest {
|
|
|
1510
1504
|
s3DestinationConfig: S3DestinationConfig | undefined;
|
|
1511
1505
|
/**
|
|
1512
1506
|
* <p>The format of the export file.</p>
|
|
1513
|
-
*
|
|
1507
|
+
* <p>The only export file format currently supported is <code>Csv</code>.</p>
|
|
1514
1508
|
*/
|
|
1515
1509
|
fileFormat?: FileFormat | string;
|
|
1516
1510
|
/**
|
|
1517
1511
|
* <p>Indicates whether to include recommendations for resources in all member accounts of
|
|
1518
1512
|
* the organization if your account is the management account of an organization.</p>
|
|
1519
|
-
*
|
|
1513
|
+
* <p>The member accounts must also be opted in to Compute Optimizer, and trusted access for
|
|
1520
1514
|
* Compute Optimizer must be enabled in the organization account. For more information,
|
|
1521
1515
|
* see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access">Compute Optimizer and Amazon Web Services Organizations trusted access</a> in the
|
|
1522
1516
|
* <i>Compute Optimizer User Guide</i>.</p>
|
|
1523
|
-
*
|
|
1517
|
+
* <p>Recommendations for member accounts of the organization are not included in the export
|
|
1524
1518
|
* file if this parameter is omitted.</p>
|
|
1525
|
-
*
|
|
1519
|
+
* <p>Recommendations for member accounts are not included in the export if this parameter,
|
|
1526
1520
|
* or the account IDs parameter, is omitted.</p>
|
|
1527
1521
|
*/
|
|
1528
1522
|
includeMemberAccounts?: boolean;
|
|
@@ -1535,7 +1529,7 @@ export interface ExportEC2InstanceRecommendationsRequest {
|
|
|
1535
1529
|
export interface ExportEC2InstanceRecommendationsResponse {
|
|
1536
1530
|
/**
|
|
1537
1531
|
* <p>The identification number of the export job.</p>
|
|
1538
|
-
*
|
|
1532
|
+
* <p>Use the <a>DescribeRecommendationExportJobs</a> action, and specify the job
|
|
1539
1533
|
* ID to view the status of an export job.</p>
|
|
1540
1534
|
*/
|
|
1541
1535
|
jobId?: string;
|
|
@@ -1545,6 +1539,151 @@ export interface ExportEC2InstanceRecommendationsResponse {
|
|
|
1545
1539
|
*/
|
|
1546
1540
|
s3Destination?: S3Destination;
|
|
1547
1541
|
}
|
|
1542
|
+
export declare enum ExportableECSServiceField {
|
|
1543
|
+
ACCOUNT_ID = "AccountId",
|
|
1544
|
+
CURRENT_PERFORMANCE_RISK = "CurrentPerformanceRisk",
|
|
1545
|
+
CURRENT_SERVICE_CONFIGURATION_AUTO_SCALING_CONFIGURATION = "CurrentServiceConfigurationAutoScalingConfiguration",
|
|
1546
|
+
CURRENT_SERVICE_CONFIGURATION_CPU = "CurrentServiceConfigurationCpu",
|
|
1547
|
+
CURRENT_SERVICE_CONFIGURATION_MEMORY = "CurrentServiceConfigurationMemory",
|
|
1548
|
+
CURRENT_SERVICE_CONFIGURATION_TASK_DEFINITION_ARN = "CurrentServiceConfigurationTaskDefinitionArn",
|
|
1549
|
+
CURRENT_SERVICE_CONTAINER_CONFIGURATIONS = "CurrentServiceContainerConfigurations",
|
|
1550
|
+
FINDING = "Finding",
|
|
1551
|
+
FINDING_REASON_CODES = "FindingReasonCodes",
|
|
1552
|
+
LAST_REFRESH_TIMESTAMP = "LastRefreshTimestamp",
|
|
1553
|
+
LAUNCH_TYPE = "LaunchType",
|
|
1554
|
+
LOOKBACK_PERIOD_IN_DAYS = "LookbackPeriodInDays",
|
|
1555
|
+
RECOMMENDATION_OPTIONS_CONTAINER_RECOMMENDATIONS = "RecommendationOptionsContainerRecommendations",
|
|
1556
|
+
RECOMMENDATION_OPTIONS_CPU = "RecommendationOptionsCpu",
|
|
1557
|
+
RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY = "RecommendationOptionsEstimatedMonthlySavingsCurrency",
|
|
1558
|
+
RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE = "RecommendationOptionsEstimatedMonthlySavingsValue",
|
|
1559
|
+
RECOMMENDATION_OPTIONS_MEMORY = "RecommendationOptionsMemory",
|
|
1560
|
+
RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_CPU_MAXIMUM = "RecommendationOptionsProjectedUtilizationMetricsCpuMaximum",
|
|
1561
|
+
RECOMMENDATION_OPTIONS_PROJECTED_UTILIZATION_METRICS_MEMORY_MAXIMUM = "RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum",
|
|
1562
|
+
RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE = "RecommendationOptionsSavingsOpportunityPercentage",
|
|
1563
|
+
SERVICE_ARN = "ServiceArn",
|
|
1564
|
+
UTILIZATION_METRICS_CPU_MAXIMUM = "UtilizationMetricsCpuMaximum",
|
|
1565
|
+
UTILIZATION_METRICS_MEMORY_MAXIMUM = "UtilizationMetricsMemoryMaximum"
|
|
1566
|
+
}
|
|
1567
|
+
export declare enum ECSServiceRecommendationFilterName {
|
|
1568
|
+
FINDING = "Finding",
|
|
1569
|
+
FINDING_REASON_CODE = "FindingReasonCode"
|
|
1570
|
+
}
|
|
1571
|
+
/**
|
|
1572
|
+
* <p>
|
|
1573
|
+
* Describes a filter that returns a more specific list of Amazon ECS service
|
|
1574
|
+
* recommendations. Use this filter with the <a>GetECSServiceRecommendations</a> action.
|
|
1575
|
+
* </p>
|
|
1576
|
+
*/
|
|
1577
|
+
export interface ECSServiceRecommendationFilter {
|
|
1578
|
+
/**
|
|
1579
|
+
* <p>
|
|
1580
|
+
* The name of the filter.
|
|
1581
|
+
* </p>
|
|
1582
|
+
* <p>
|
|
1583
|
+
* Specify <code>Finding</code> to return recommendations with a specific finding classification.
|
|
1584
|
+
* </p>
|
|
1585
|
+
* <p>
|
|
1586
|
+
* Specify <code>FindingReasonCode</code> to return recommendations with a specific finding reason code.
|
|
1587
|
+
* </p>
|
|
1588
|
+
*/
|
|
1589
|
+
name?: ECSServiceRecommendationFilterName | string;
|
|
1590
|
+
/**
|
|
1591
|
+
* <p>
|
|
1592
|
+
* The value of the filter.
|
|
1593
|
+
* </p>
|
|
1594
|
+
* <p>The valid values for this parameter are as follows:</p>
|
|
1595
|
+
* <ul>
|
|
1596
|
+
* <li>
|
|
1597
|
+
* <p>If you specify the <code>name</code> parameter as <code>Finding</code>, specify
|
|
1598
|
+
* <code>Optimized</code>, <code>NotOptimized</code>, or <code>Unavailable</code>.</p>
|
|
1599
|
+
* </li>
|
|
1600
|
+
* <li>
|
|
1601
|
+
* <p>If you specify the <code>name</code> parameter as <code>FindingReasonCode</code>, specify
|
|
1602
|
+
* <code>CPUUnderprovisioned</code>, <code>CPUOverprovisioned</code>,
|
|
1603
|
+
* <code>MemoryUnderprovisioned</code>, or <code>MemoryOverprovisioned</code>.</p>
|
|
1604
|
+
* </li>
|
|
1605
|
+
* </ul>
|
|
1606
|
+
*/
|
|
1607
|
+
values?: string[];
|
|
1608
|
+
}
|
|
1609
|
+
export interface ExportECSServiceRecommendationsRequest {
|
|
1610
|
+
/**
|
|
1611
|
+
* <p>
|
|
1612
|
+
* The Amazon Web Services account IDs for the export ECS service recommendations.
|
|
1613
|
+
* </p>
|
|
1614
|
+
* <p>If your account is the management account or the delegated administrator
|
|
1615
|
+
* of an organization, use this parameter to specify the member account you want to
|
|
1616
|
+
* export recommendations to.</p>
|
|
1617
|
+
* <p>This parameter can't be specified together with the include member accounts
|
|
1618
|
+
* parameter. The parameters are mutually exclusive.</p>
|
|
1619
|
+
* <p>If this parameter or the include member accounts parameter is omitted,
|
|
1620
|
+
* the recommendations for member accounts aren't included in the export.</p>
|
|
1621
|
+
* <p>You can specify multiple account IDs per request.</p>
|
|
1622
|
+
*/
|
|
1623
|
+
accountIds?: string[];
|
|
1624
|
+
/**
|
|
1625
|
+
* <p>
|
|
1626
|
+
* An array of objects to specify a filter that exports a more specific set
|
|
1627
|
+
* of ECS service recommendations.
|
|
1628
|
+
* </p>
|
|
1629
|
+
*/
|
|
1630
|
+
filters?: ECSServiceRecommendationFilter[];
|
|
1631
|
+
/**
|
|
1632
|
+
* <p>The recommendations data to include in the export file. For more information about the
|
|
1633
|
+
* fields that can be exported, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files">Exported files</a> in the <i>Compute Optimizer User
|
|
1634
|
+
* Guide</i>.</p>
|
|
1635
|
+
*/
|
|
1636
|
+
fieldsToExport?: (ExportableECSServiceField | string)[];
|
|
1637
|
+
/**
|
|
1638
|
+
* <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
|
|
1639
|
+
* key prefix for a recommendations export job.</p>
|
|
1640
|
+
* <p>You must create the destination Amazon S3 bucket for your recommendations
|
|
1641
|
+
* export before you create the export job. Compute Optimizer does not create the S3 bucket
|
|
1642
|
+
* for you. After you create the S3 bucket, ensure that it has the required permission
|
|
1643
|
+
* policy to allow Compute Optimizer to write the export file to it. If you plan to specify
|
|
1644
|
+
* an object prefix when you create the export job, you must include the object prefix in
|
|
1645
|
+
* the policy that you add to the S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html">Amazon S3 Bucket Policy for Compute Optimizer</a> in the
|
|
1646
|
+
* <i>Compute Optimizer User Guide</i>.</p>
|
|
1647
|
+
*/
|
|
1648
|
+
s3DestinationConfig: S3DestinationConfig | undefined;
|
|
1649
|
+
/**
|
|
1650
|
+
* <p>
|
|
1651
|
+
* The format of the export file.
|
|
1652
|
+
* </p>
|
|
1653
|
+
* <p>The CSV file is the only export file format currently supported.</p>
|
|
1654
|
+
*/
|
|
1655
|
+
fileFormat?: FileFormat | string;
|
|
1656
|
+
/**
|
|
1657
|
+
* <p>If your account is the management account or the delegated administrator of an organization,
|
|
1658
|
+
* this parameter indicates whether to include recommendations for resources in all member accounts of
|
|
1659
|
+
* the organization.</p>
|
|
1660
|
+
* <p>The member accounts must also be opted in to Compute Optimizer, and trusted access for
|
|
1661
|
+
* Compute Optimizer must be enabled in the organization account. For more information,
|
|
1662
|
+
* see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access">Compute Optimizer and Amazon Web Services Organizations trusted access</a> in the
|
|
1663
|
+
* <i>Compute Optimizer User Guide</i>.</p>
|
|
1664
|
+
* <p>If this parameter is omitted, recommendations for member accounts of the
|
|
1665
|
+
* organization aren't included in the export file.</p>
|
|
1666
|
+
* <p>If this parameter or the account ID parameter is omitted, recommendations for
|
|
1667
|
+
* member accounts aren't included in the export.</p>
|
|
1668
|
+
*/
|
|
1669
|
+
includeMemberAccounts?: boolean;
|
|
1670
|
+
}
|
|
1671
|
+
export interface ExportECSServiceRecommendationsResponse {
|
|
1672
|
+
/**
|
|
1673
|
+
* <p>
|
|
1674
|
+
* The identification number of the export job.
|
|
1675
|
+
* </p>
|
|
1676
|
+
* <p>To view the status of an export job, use the
|
|
1677
|
+
* <a>DescribeRecommendationExportJobs</a> action and specify the job ID.
|
|
1678
|
+
* </p>
|
|
1679
|
+
*/
|
|
1680
|
+
jobId?: string;
|
|
1681
|
+
/**
|
|
1682
|
+
* <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
|
|
1683
|
+
* object keys of a recommendations export file, and its associated metadata file.</p>
|
|
1684
|
+
*/
|
|
1685
|
+
s3Destination?: S3Destination;
|
|
1686
|
+
}
|
|
1548
1687
|
export declare enum ExportableLambdaFunctionField {
|
|
1549
1688
|
ACCOUNT_ID = "AccountId",
|
|
1550
1689
|
CURRENT_CONFIGURATION_MEMORY_SIZE = "CurrentConfigurationMemorySize",
|
|
@@ -1580,31 +1719,31 @@ export declare enum LambdaFunctionRecommendationFilterName {
|
|
|
1580
1719
|
/**
|
|
1581
1720
|
* <p>Describes a filter that returns a more specific list of Lambda
|
|
1582
1721
|
* function recommendations. Use this filter with the <a>GetLambdaFunctionRecommendations</a> action.</p>
|
|
1583
|
-
*
|
|
1722
|
+
* <p>You can use <code>EBSFilter</code> with the <a>GetEBSVolumeRecommendations</a> action, <code>JobFilter</code> with the
|
|
1584
1723
|
* <a>DescribeRecommendationExportJobs</a> action, and <code>Filter</code>
|
|
1585
1724
|
* with the <a>GetAutoScalingGroupRecommendations</a> and <a>GetEC2InstanceRecommendations</a> actions.</p>
|
|
1586
1725
|
*/
|
|
1587
1726
|
export interface LambdaFunctionRecommendationFilter {
|
|
1588
1727
|
/**
|
|
1589
1728
|
* <p>The name of the filter.</p>
|
|
1590
|
-
*
|
|
1729
|
+
* <p>Specify <code>Finding</code> to return recommendations with a specific finding
|
|
1591
1730
|
* classification (for example, <code>NotOptimized</code>).</p>
|
|
1592
|
-
*
|
|
1731
|
+
* <p>Specify <code>FindingReasonCode</code> to return recommendations with a specific
|
|
1593
1732
|
* finding reason code (for example, <code>MemoryUnderprovisioned</code>).</p>
|
|
1594
1733
|
*/
|
|
1595
1734
|
name?: LambdaFunctionRecommendationFilterName | string;
|
|
1596
1735
|
/**
|
|
1597
1736
|
* <p>The value of the filter.</p>
|
|
1598
|
-
*
|
|
1737
|
+
* <p>The valid values for this parameter are as follows, depending on what you specify for
|
|
1599
1738
|
* the <code>name</code> parameter:</p>
|
|
1600
|
-
*
|
|
1739
|
+
* <ul>
|
|
1601
1740
|
* <li>
|
|
1602
|
-
*
|
|
1741
|
+
* <p>Specify <code>Optimized</code>, <code>NotOptimized</code>, or
|
|
1603
1742
|
* <code>Unavailable</code> if you specify the <code>name</code> parameter as
|
|
1604
1743
|
* <code>Finding</code>.</p>
|
|
1605
1744
|
* </li>
|
|
1606
1745
|
* <li>
|
|
1607
|
-
*
|
|
1746
|
+
* <p>Specify <code>MemoryOverprovisioned</code>,
|
|
1608
1747
|
* <code>MemoryUnderprovisioned</code>, <code>InsufficientData</code>, or
|
|
1609
1748
|
* <code>Inconclusive</code> if you specify the <code>name</code> parameter as
|
|
1610
1749
|
* <code>FindingReasonCode</code>.</p>
|
|
@@ -1617,13 +1756,13 @@ export interface ExportLambdaFunctionRecommendationsRequest {
|
|
|
1617
1756
|
/**
|
|
1618
1757
|
* <p>The IDs of the Amazon Web Services accounts for which to export Lambda
|
|
1619
1758
|
* function recommendations.</p>
|
|
1620
|
-
*
|
|
1759
|
+
* <p>If your account is the management account of an organization, use this parameter to
|
|
1621
1760
|
* specify the member account for which you want to export recommendations.</p>
|
|
1622
|
-
*
|
|
1761
|
+
* <p>This parameter cannot be specified together with the include member accounts
|
|
1623
1762
|
* parameter. The parameters are mutually exclusive.</p>
|
|
1624
|
-
*
|
|
1763
|
+
* <p>Recommendations for member accounts are not included in the export if this parameter,
|
|
1625
1764
|
* or the include member accounts parameter, is omitted.</p>
|
|
1626
|
-
*
|
|
1765
|
+
* <p>You can specify multiple account IDs per request.</p>
|
|
1627
1766
|
*/
|
|
1628
1767
|
accountIds?: string[];
|
|
1629
1768
|
/**
|
|
@@ -1639,7 +1778,7 @@ export interface ExportLambdaFunctionRecommendationsRequest {
|
|
|
1639
1778
|
/**
|
|
1640
1779
|
* <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
|
|
1641
1780
|
* key prefix for a recommendations export job.</p>
|
|
1642
|
-
*
|
|
1781
|
+
* <p>You must create the destination Amazon S3 bucket for your recommendations
|
|
1643
1782
|
* export before you create the export job. Compute Optimizer does not create the S3 bucket
|
|
1644
1783
|
* for you. After you create the S3 bucket, ensure that it has the required permission
|
|
1645
1784
|
* policy to allow Compute Optimizer to write the export file to it. If you plan to specify
|
|
@@ -1650,21 +1789,21 @@ export interface ExportLambdaFunctionRecommendationsRequest {
|
|
|
1650
1789
|
s3DestinationConfig: S3DestinationConfig | undefined;
|
|
1651
1790
|
/**
|
|
1652
1791
|
* <p>The format of the export file.</p>
|
|
1653
|
-
*
|
|
1792
|
+
* <p>The only export file format currently supported is <code>Csv</code>.</p>
|
|
1654
1793
|
*/
|
|
1655
1794
|
fileFormat?: FileFormat | string;
|
|
1656
1795
|
/**
|
|
1657
1796
|
* <p>Indicates whether to include recommendations for resources in all member accounts of
|
|
1658
1797
|
* the organization if your account is the management account of an organization.</p>
|
|
1659
|
-
*
|
|
1798
|
+
* <p>The member accounts must also be opted in to Compute Optimizer, and trusted access for
|
|
1660
1799
|
* Compute Optimizer must be enabled in the organization account. For more information,
|
|
1661
1800
|
* see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access">Compute Optimizer and Amazon Web Services Organizations trusted access</a> in the
|
|
1662
1801
|
* <i>Compute Optimizer User Guide</i>.</p>
|
|
1663
|
-
*
|
|
1802
|
+
* <p>Recommendations for member accounts of the organization are not included in the export
|
|
1664
1803
|
* file if this parameter is omitted.</p>
|
|
1665
|
-
*
|
|
1804
|
+
* <p>This parameter cannot be specified together with the account IDs parameter. The
|
|
1666
1805
|
* parameters are mutually exclusive.</p>
|
|
1667
|
-
*
|
|
1806
|
+
* <p>Recommendations for member accounts are not included in the export if this parameter,
|
|
1668
1807
|
* or the account IDs parameter, is omitted.</p>
|
|
1669
1808
|
*/
|
|
1670
1809
|
includeMemberAccounts?: boolean;
|
|
@@ -1672,7 +1811,7 @@ export interface ExportLambdaFunctionRecommendationsRequest {
|
|
|
1672
1811
|
export interface ExportLambdaFunctionRecommendationsResponse {
|
|
1673
1812
|
/**
|
|
1674
1813
|
* <p>The identification number of the export job.</p>
|
|
1675
|
-
*
|
|
1814
|
+
* <p>Use the <a>DescribeRecommendationExportJobs</a> action, and specify the job
|
|
1676
1815
|
* ID to view the status of an export job.</p>
|
|
1677
1816
|
*/
|
|
1678
1817
|
jobId?: string;
|
|
@@ -1686,10 +1825,10 @@ export interface GetAutoScalingGroupRecommendationsRequest {
|
|
|
1686
1825
|
/**
|
|
1687
1826
|
* <p>The ID of the Amazon Web Services account for which to return Auto Scaling group
|
|
1688
1827
|
* recommendations.</p>
|
|
1689
|
-
*
|
|
1828
|
+
* <p>If your account is the management account of an organization, use this parameter to
|
|
1690
1829
|
* specify the member account for which you want to return Auto Scaling group
|
|
1691
1830
|
* recommendations.</p>
|
|
1692
|
-
*
|
|
1831
|
+
* <p>Only one account ID can be specified per request.</p>
|
|
1693
1832
|
*/
|
|
1694
1833
|
accountIds?: string[];
|
|
1695
1834
|
/**
|
|
@@ -1705,7 +1844,7 @@ export interface GetAutoScalingGroupRecommendationsRequest {
|
|
|
1705
1844
|
/**
|
|
1706
1845
|
* <p>The maximum number of Auto Scaling group recommendations to return with a single
|
|
1707
1846
|
* request.</p>
|
|
1708
|
-
*
|
|
1847
|
+
* <p>To retrieve the remaining results, make another request with the returned
|
|
1709
1848
|
* <code>nextToken</code> value.</p>
|
|
1710
1849
|
*/
|
|
1711
1850
|
maxResults?: number;
|
|
@@ -1721,7 +1860,7 @@ export interface GetAutoScalingGroupRecommendationsRequest {
|
|
|
1721
1860
|
}
|
|
1722
1861
|
/**
|
|
1723
1862
|
* <p>Describes an error experienced when getting recommendations.</p>
|
|
1724
|
-
*
|
|
1863
|
+
* <p>For example, an error is returned if you request recommendations for an unsupported
|
|
1725
1864
|
* Auto Scaling group, or if you request recommendations for an instance of an
|
|
1726
1865
|
* unsupported instance family.</p>
|
|
1727
1866
|
*/
|
|
@@ -1743,7 +1882,7 @@ export interface GetAutoScalingGroupRecommendationsResponse {
|
|
|
1743
1882
|
/**
|
|
1744
1883
|
* <p>The token to use to advance to the next page of Auto Scaling group
|
|
1745
1884
|
* recommendations.</p>
|
|
1746
|
-
*
|
|
1885
|
+
* <p>This value is null when there are no more pages of Auto Scaling group
|
|
1747
1886
|
* recommendations to return.</p>
|
|
1748
1887
|
*/
|
|
1749
1888
|
nextToken?: string;
|
|
@@ -1753,7 +1892,7 @@ export interface GetAutoScalingGroupRecommendationsResponse {
|
|
|
1753
1892
|
autoScalingGroupRecommendations?: AutoScalingGroupRecommendation[];
|
|
1754
1893
|
/**
|
|
1755
1894
|
* <p>An array of objects that describe errors of the request.</p>
|
|
1756
|
-
*
|
|
1895
|
+
* <p>For example, an error is returned if you request recommendations for an unsupported
|
|
1757
1896
|
* Auto Scaling group.</p>
|
|
1758
1897
|
*/
|
|
1759
1898
|
errors?: GetRecommendationError[];
|
|
@@ -1770,7 +1909,7 @@ export interface GetEBSVolumeRecommendationsRequest {
|
|
|
1770
1909
|
nextToken?: string;
|
|
1771
1910
|
/**
|
|
1772
1911
|
* <p>The maximum number of volume recommendations to return with a single request.</p>
|
|
1773
|
-
*
|
|
1912
|
+
* <p>To retrieve the remaining results, make another request with the returned
|
|
1774
1913
|
* <code>nextToken</code> value.</p>
|
|
1775
1914
|
*/
|
|
1776
1915
|
maxResults?: number;
|
|
@@ -1782,9 +1921,9 @@ export interface GetEBSVolumeRecommendationsRequest {
|
|
|
1782
1921
|
/**
|
|
1783
1922
|
* <p>The ID of the Amazon Web Services account for which to return volume
|
|
1784
1923
|
* recommendations.</p>
|
|
1785
|
-
*
|
|
1924
|
+
* <p>If your account is the management account of an organization, use this parameter to
|
|
1786
1925
|
* specify the member account for which you want to return volume recommendations.</p>
|
|
1787
|
-
*
|
|
1926
|
+
* <p>Only one account ID can be specified per request.</p>
|
|
1788
1927
|
*/
|
|
1789
1928
|
accountIds?: string[];
|
|
1790
1929
|
}
|
|
@@ -1795,7 +1934,7 @@ export interface GetEBSVolumeRecommendationsRequest {
|
|
|
1795
1934
|
export interface VolumeConfiguration {
|
|
1796
1935
|
/**
|
|
1797
1936
|
* <p>The volume type.</p>
|
|
1798
|
-
*
|
|
1937
|
+
* <p>This can be <code>gp2</code> for General Purpose SSD, <code>io1</code> or
|
|
1799
1938
|
* <code>io2</code> for Provisioned IOPS SSD, <code>st1</code> for Throughput Optimized
|
|
1800
1939
|
* HDD, <code>sc1</code> for Cold HDD, or <code>standard</code> for Magnetic
|
|
1801
1940
|
* volumes.</p>
|
|
@@ -1835,48 +1974,48 @@ export declare enum EBSMetricName {
|
|
|
1835
1974
|
/**
|
|
1836
1975
|
* <p>Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS)
|
|
1837
1976
|
* volume.</p>
|
|
1838
|
-
*
|
|
1977
|
+
* <p>Compare the utilization metric data of your resource against its projected utilization
|
|
1839
1978
|
* metric data to determine the performance difference between your current resource and
|
|
1840
1979
|
* the recommended option.</p>
|
|
1841
1980
|
*/
|
|
1842
1981
|
export interface EBSUtilizationMetric {
|
|
1843
1982
|
/**
|
|
1844
1983
|
* <p>The name of the utilization metric.</p>
|
|
1845
|
-
*
|
|
1846
|
-
*
|
|
1984
|
+
* <p>The following utilization metrics are available:</p>
|
|
1985
|
+
* <ul>
|
|
1847
1986
|
* <li>
|
|
1848
|
-
*
|
|
1987
|
+
* <p>
|
|
1849
1988
|
* <code>VolumeReadOpsPerSecond</code> - The completed read operations per second
|
|
1850
1989
|
* from the volume in a specified period of time.</p>
|
|
1851
|
-
*
|
|
1990
|
+
* <p>Unit: Count</p>
|
|
1852
1991
|
* </li>
|
|
1853
1992
|
* <li>
|
|
1854
|
-
*
|
|
1993
|
+
* <p>
|
|
1855
1994
|
* <code>VolumeWriteOpsPerSecond</code> - The completed write operations per
|
|
1856
1995
|
* second to the volume in a specified period of time.</p>
|
|
1857
|
-
*
|
|
1996
|
+
* <p>Unit: Count</p>
|
|
1858
1997
|
* </li>
|
|
1859
1998
|
* <li>
|
|
1860
|
-
*
|
|
1999
|
+
* <p>
|
|
1861
2000
|
* <code>VolumeReadBytesPerSecond</code> - The bytes read per second from the
|
|
1862
2001
|
* volume in a specified period of time.</p>
|
|
1863
|
-
*
|
|
2002
|
+
* <p>Unit: Bytes</p>
|
|
1864
2003
|
* </li>
|
|
1865
2004
|
* <li>
|
|
1866
|
-
*
|
|
2005
|
+
* <p>
|
|
1867
2006
|
* <code>VolumeWriteBytesPerSecond</code> - The bytes written to the volume in a
|
|
1868
2007
|
* specified period of time.</p>
|
|
1869
|
-
*
|
|
2008
|
+
* <p>Unit: Bytes</p>
|
|
1870
2009
|
* </li>
|
|
1871
2010
|
* </ul>
|
|
1872
2011
|
*/
|
|
1873
2012
|
name?: EBSMetricName | string;
|
|
1874
2013
|
/**
|
|
1875
2014
|
* <p>The statistic of the utilization metric.</p>
|
|
1876
|
-
*
|
|
2015
|
+
* <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs
|
|
1877
2016
|
* return utilization metrics using only the <code>Maximum</code> statistic, which is the
|
|
1878
2017
|
* highest value observed during the specified period.</p>
|
|
1879
|
-
*
|
|
2018
|
+
* <p>The Compute Optimizer console displays graphs for some utilization metrics using the
|
|
1880
2019
|
* <code>Average</code> statistic, which is the value of <code>Sum</code> /
|
|
1881
2020
|
* <code>SampleCount</code> during the specified period. For more information, see
|
|
1882
2021
|
* <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html">Viewing resource
|
|
@@ -1902,9 +2041,9 @@ export interface VolumeRecommendationOption {
|
|
|
1902
2041
|
configuration?: VolumeConfiguration;
|
|
1903
2042
|
/**
|
|
1904
2043
|
* <p>The performance risk of the volume recommendation option.</p>
|
|
1905
|
-
*
|
|
2044
|
+
* <p>Performance risk is the likelihood of the recommended volume type meeting the
|
|
1906
2045
|
* performance requirement of your workload.</p>
|
|
1907
|
-
*
|
|
2046
|
+
* <p>The value ranges from <code>0</code> - <code>4</code>, with <code>0</code> meaning
|
|
1908
2047
|
* that the recommended resource is predicted to always provide enough hardware capability.
|
|
1909
2048
|
* The higher the performance risk is, the more likely you should validate whether the
|
|
1910
2049
|
* recommendation will meet the performance requirements of your workload before migrating
|
|
@@ -1913,7 +2052,7 @@ export interface VolumeRecommendationOption {
|
|
|
1913
2052
|
performanceRisk?: number;
|
|
1914
2053
|
/**
|
|
1915
2054
|
* <p>The rank of the volume recommendation option.</p>
|
|
1916
|
-
*
|
|
2055
|
+
* <p>The top recommendation option is ranked as <code>1</code>.</p>
|
|
1917
2056
|
*/
|
|
1918
2057
|
rank?: number;
|
|
1919
2058
|
/**
|
|
@@ -1941,19 +2080,18 @@ export interface VolumeRecommendation {
|
|
|
1941
2080
|
currentConfiguration?: VolumeConfiguration;
|
|
1942
2081
|
/**
|
|
1943
2082
|
* <p>The finding classification of the volume.</p>
|
|
1944
|
-
*
|
|
1945
|
-
*
|
|
2083
|
+
* <p>Findings for volumes include:</p>
|
|
2084
|
+
* <ul>
|
|
1946
2085
|
* <li>
|
|
1947
|
-
*
|
|
2086
|
+
* <p>
|
|
1948
2087
|
* <b>
|
|
1949
2088
|
* <code>NotOptimized</code>
|
|
1950
2089
|
* </b>—A volume is
|
|
1951
2090
|
* considered not optimized when Compute Optimizer identifies a recommendation
|
|
1952
2091
|
* that can provide better performance for your workload.</p>
|
|
1953
|
-
*
|
|
1954
2092
|
* </li>
|
|
1955
2093
|
* <li>
|
|
1956
|
-
*
|
|
2094
|
+
* <p>
|
|
1957
2095
|
* <b>
|
|
1958
2096
|
* <code>Optimized</code>
|
|
1959
2097
|
* </b>—An volume is
|
|
@@ -1961,7 +2099,6 @@ export interface VolumeRecommendation {
|
|
|
1961
2099
|
* correctly provisioned to run your workload based on the chosen volume type. For
|
|
1962
2100
|
* optimized resources, Compute Optimizer might recommend a new generation volume
|
|
1963
2101
|
* type.</p>
|
|
1964
|
-
*
|
|
1965
2102
|
* </li>
|
|
1966
2103
|
* </ul>
|
|
1967
2104
|
*/
|
|
@@ -1992,7 +2129,7 @@ export interface VolumeRecommendation {
|
|
|
1992
2129
|
export interface GetEBSVolumeRecommendationsResponse {
|
|
1993
2130
|
/**
|
|
1994
2131
|
* <p>The token to use to advance to the next page of volume recommendations.</p>
|
|
1995
|
-
*
|
|
2132
|
+
* <p>This value is null when there are no more pages of volume recommendations to
|
|
1996
2133
|
* return.</p>
|
|
1997
2134
|
*/
|
|
1998
2135
|
nextToken?: string;
|
|
@@ -2002,7 +2139,7 @@ export interface GetEBSVolumeRecommendationsResponse {
|
|
|
2002
2139
|
volumeRecommendations?: VolumeRecommendation[];
|
|
2003
2140
|
/**
|
|
2004
2141
|
* <p>An array of objects that describe errors of the request.</p>
|
|
2005
|
-
*
|
|
2142
|
+
* <p>For example, an error is returned if you request recommendations for an unsupported
|
|
2006
2143
|
* volume.</p>
|
|
2007
2144
|
*/
|
|
2008
2145
|
errors?: GetRecommendationError[];
|
|
@@ -2019,7 +2156,7 @@ export interface GetEC2InstanceRecommendationsRequest {
|
|
|
2019
2156
|
nextToken?: string;
|
|
2020
2157
|
/**
|
|
2021
2158
|
* <p>The maximum number of instance recommendations to return with a single request.</p>
|
|
2022
|
-
*
|
|
2159
|
+
* <p>To retrieve the remaining results, make another request with the returned
|
|
2023
2160
|
* <code>nextToken</code> value.</p>
|
|
2024
2161
|
*/
|
|
2025
2162
|
maxResults?: number;
|
|
@@ -2031,9 +2168,9 @@ export interface GetEC2InstanceRecommendationsRequest {
|
|
|
2031
2168
|
/**
|
|
2032
2169
|
* <p>The ID of the Amazon Web Services account for which to return instance
|
|
2033
2170
|
* recommendations.</p>
|
|
2034
|
-
*
|
|
2171
|
+
* <p>If your account is the management account of an organization, use this parameter to
|
|
2035
2172
|
* specify the member account for which you want to return instance recommendations.</p>
|
|
2036
|
-
*
|
|
2173
|
+
* <p>Only one account ID can be specified per request.</p>
|
|
2037
2174
|
*/
|
|
2038
2175
|
accountIds?: string[];
|
|
2039
2176
|
/**
|
|
@@ -2079,13 +2216,13 @@ export interface InstanceRecommendationOption {
|
|
|
2079
2216
|
/**
|
|
2080
2217
|
* <p>An array of objects that describe the projected utilization metrics of the instance
|
|
2081
2218
|
* recommendation option.</p>
|
|
2082
|
-
*
|
|
2219
|
+
* <note>
|
|
2083
2220
|
* <p>The <code>Cpu</code> and <code>Memory</code> metrics are the only projected
|
|
2084
2221
|
* utilization metrics returned. Additionally, the <code>Memory</code> metric is
|
|
2085
2222
|
* returned only for resources that have the unified CloudWatch agent installed
|
|
2086
2223
|
* on them. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent">Enabling Memory
|
|
2087
2224
|
* Utilization with the CloudWatch Agent</a>.</p>
|
|
2088
|
-
*
|
|
2225
|
+
* </note>
|
|
2089
2226
|
*/
|
|
2090
2227
|
projectedUtilizationMetrics?: UtilizationMetric[];
|
|
2091
2228
|
/**
|
|
@@ -2095,10 +2232,10 @@ export interface InstanceRecommendationOption {
|
|
|
2095
2232
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html">Change the instance type guide for Linux</a> and <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-resize.html">Change the instance type
|
|
2096
2233
|
* guide for Windows</a> provide general guidance for getting started with an
|
|
2097
2234
|
* instance migration.</p>
|
|
2098
|
-
*
|
|
2099
|
-
*
|
|
2235
|
+
* <p>Platform differences include:</p>
|
|
2236
|
+
* <ul>
|
|
2100
2237
|
* <li>
|
|
2101
|
-
*
|
|
2238
|
+
* <p>
|
|
2102
2239
|
* <b>
|
|
2103
2240
|
* <code>Hypervisor</code>
|
|
2104
2241
|
* </b> — The hypervisor of
|
|
@@ -2112,7 +2249,7 @@ export interface InstanceRecommendationOption {
|
|
|
2112
2249
|
* User Guide for Windows</i>.</p>
|
|
2113
2250
|
* </li>
|
|
2114
2251
|
* <li>
|
|
2115
|
-
*
|
|
2252
|
+
* <p>
|
|
2116
2253
|
* <b>
|
|
2117
2254
|
* <code>NetworkInterface</code>
|
|
2118
2255
|
* </b> — The network
|
|
@@ -2128,7 +2265,7 @@ export interface InstanceRecommendationOption {
|
|
|
2128
2265
|
* Windows</i>.</p>
|
|
2129
2266
|
* </li>
|
|
2130
2267
|
* <li>
|
|
2131
|
-
*
|
|
2268
|
+
* <p>
|
|
2132
2269
|
* <b>
|
|
2133
2270
|
* <code>StorageInterface</code>
|
|
2134
2271
|
* </b> — The storage
|
|
@@ -2143,7 +2280,7 @@ export interface InstanceRecommendationOption {
|
|
|
2143
2280
|
* Windows</i>.</p>
|
|
2144
2281
|
* </li>
|
|
2145
2282
|
* <li>
|
|
2146
|
-
*
|
|
2283
|
+
* <p>
|
|
2147
2284
|
* <b>
|
|
2148
2285
|
* <code>InstanceStoreAvailability</code>
|
|
2149
2286
|
* </b> — The
|
|
@@ -2159,7 +2296,7 @@ export interface InstanceRecommendationOption {
|
|
|
2159
2296
|
* Windows</i>.</p>
|
|
2160
2297
|
* </li>
|
|
2161
2298
|
* <li>
|
|
2162
|
-
*
|
|
2299
|
+
* <p>
|
|
2163
2300
|
* <b>
|
|
2164
2301
|
* <code>VirtualizationType</code>
|
|
2165
2302
|
* </b> — The
|
|
@@ -2172,7 +2309,7 @@ export interface InstanceRecommendationOption {
|
|
|
2172
2309
|
* Guide for Windows</i>.</p>
|
|
2173
2310
|
* </li>
|
|
2174
2311
|
* <li>
|
|
2175
|
-
*
|
|
2312
|
+
* <p>
|
|
2176
2313
|
* <b>
|
|
2177
2314
|
* <code>Architecture</code>
|
|
2178
2315
|
* </b> — The CPU
|
|
@@ -2189,7 +2326,7 @@ export interface InstanceRecommendationOption {
|
|
|
2189
2326
|
platformDifferences?: (PlatformDifference | string)[];
|
|
2190
2327
|
/**
|
|
2191
2328
|
* <p>The performance risk of the instance recommendation option.</p>
|
|
2192
|
-
*
|
|
2329
|
+
* <p>Performance risk indicates the likelihood of the recommended instance type not meeting
|
|
2193
2330
|
* the resource needs of your workload. Compute Optimizer calculates an individual
|
|
2194
2331
|
* performance risk score for each specification of the recommended instance, including
|
|
2195
2332
|
* CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput,
|
|
@@ -2197,7 +2334,7 @@ export interface InstanceRecommendationOption {
|
|
|
2197
2334
|
* The performance
|
|
2198
2335
|
* risk of the recommended instance is calculated as the maximum performance risk score
|
|
2199
2336
|
* across the analyzed resource specifications.</p>
|
|
2200
|
-
*
|
|
2337
|
+
* <p>The value ranges from <code>0</code> - <code>4</code>, with <code>0</code> meaning
|
|
2201
2338
|
* that the recommended resource is predicted to always provide enough hardware capability.
|
|
2202
2339
|
* The higher the performance risk is, the more likely you should validate whether the
|
|
2203
2340
|
* recommendation will meet the performance requirements of your workload before migrating
|
|
@@ -2206,7 +2343,7 @@ export interface InstanceRecommendationOption {
|
|
|
2206
2343
|
performanceRisk?: number;
|
|
2207
2344
|
/**
|
|
2208
2345
|
* <p>The rank of the instance recommendation option.</p>
|
|
2209
|
-
*
|
|
2346
|
+
* <p>The top recommendation option is ranked as <code>1</code>.</p>
|
|
2210
2347
|
*/
|
|
2211
2348
|
rank?: number;
|
|
2212
2349
|
/**
|
|
@@ -2218,8 +2355,7 @@ export interface InstanceRecommendationOption {
|
|
|
2218
2355
|
/**
|
|
2219
2356
|
* <p>The level of effort required to migrate from the current instance type to the
|
|
2220
2357
|
* recommended instance type.</p>
|
|
2221
|
-
*
|
|
2222
|
-
* <p>For example, the migration effort is <code>Low</code> if Amazon EMR is the
|
|
2358
|
+
* <p>For example, the migration effort is <code>Low</code> if Amazon EMR is the
|
|
2223
2359
|
* inferred workload type and an Amazon Web Services Graviton instance type is recommended.
|
|
2224
2360
|
* The migration effort is <code>Medium</code> if a workload type couldn't be inferred but
|
|
2225
2361
|
* an Amazon Web Services Graviton instance type is recommended. The migration effort is
|
|
@@ -2232,6 +2368,7 @@ export declare enum RecommendationSourceType {
|
|
|
2232
2368
|
AUTO_SCALING_GROUP = "AutoScalingGroup",
|
|
2233
2369
|
EBS_VOLUME = "EbsVolume",
|
|
2234
2370
|
EC2_INSTANCE = "Ec2Instance",
|
|
2371
|
+
ECS_SERVICE = "EcsService",
|
|
2235
2372
|
LAMBDA_FUNCTION = "LambdaFunction"
|
|
2236
2373
|
}
|
|
2237
2374
|
/**
|
|
@@ -2270,10 +2407,10 @@ export interface InstanceRecommendation {
|
|
|
2270
2407
|
currentInstanceType?: string;
|
|
2271
2408
|
/**
|
|
2272
2409
|
* <p>The finding classification of the instance.</p>
|
|
2273
|
-
*
|
|
2274
|
-
*
|
|
2410
|
+
* <p>Findings for instances include:</p>
|
|
2411
|
+
* <ul>
|
|
2275
2412
|
* <li>
|
|
2276
|
-
*
|
|
2413
|
+
* <p>
|
|
2277
2414
|
* <b>
|
|
2278
2415
|
* <code>Underprovisioned</code>
|
|
2279
2416
|
* </b>—An instance is
|
|
@@ -2283,7 +2420,7 @@ export interface InstanceRecommendation {
|
|
|
2283
2420
|
* performance.</p>
|
|
2284
2421
|
* </li>
|
|
2285
2422
|
* <li>
|
|
2286
|
-
*
|
|
2423
|
+
* <p>
|
|
2287
2424
|
* <b>
|
|
2288
2425
|
* <code>Overprovisioned</code>
|
|
2289
2426
|
* </b>—An instance is
|
|
@@ -2294,7 +2431,7 @@ export interface InstanceRecommendation {
|
|
|
2294
2431
|
* infrastructure cost.</p>
|
|
2295
2432
|
* </li>
|
|
2296
2433
|
* <li>
|
|
2297
|
-
*
|
|
2434
|
+
* <p>
|
|
2298
2435
|
* <b>
|
|
2299
2436
|
* <code>Optimized</code>
|
|
2300
2437
|
* </b>—An instance is
|
|
@@ -2308,10 +2445,10 @@ export interface InstanceRecommendation {
|
|
|
2308
2445
|
finding?: Finding | string;
|
|
2309
2446
|
/**
|
|
2310
2447
|
* <p>The reason for the finding classification of the instance.</p>
|
|
2311
|
-
*
|
|
2312
|
-
*
|
|
2448
|
+
* <p>Finding reason codes for instances include:</p>
|
|
2449
|
+
* <ul>
|
|
2313
2450
|
* <li>
|
|
2314
|
-
*
|
|
2451
|
+
* <p>
|
|
2315
2452
|
* <b>
|
|
2316
2453
|
* <code>CPUOverprovisioned</code>
|
|
2317
2454
|
* </b> — The
|
|
@@ -2321,7 +2458,7 @@ export interface InstanceRecommendation {
|
|
|
2321
2458
|
* look-back period.</p>
|
|
2322
2459
|
* </li>
|
|
2323
2460
|
* <li>
|
|
2324
|
-
*
|
|
2461
|
+
* <p>
|
|
2325
2462
|
* <b>
|
|
2326
2463
|
* <code>CPUUnderprovisioned</code>
|
|
2327
2464
|
* </b> — The
|
|
@@ -2331,7 +2468,7 @@ export interface InstanceRecommendation {
|
|
|
2331
2468
|
* metric of the current instance during the look-back period.</p>
|
|
2332
2469
|
* </li>
|
|
2333
2470
|
* <li>
|
|
2334
|
-
*
|
|
2471
|
+
* <p>
|
|
2335
2472
|
* <b>
|
|
2336
2473
|
* <code>MemoryOverprovisioned</code>
|
|
2337
2474
|
* </b> — The
|
|
@@ -2341,7 +2478,7 @@ export interface InstanceRecommendation {
|
|
|
2341
2478
|
* period.</p>
|
|
2342
2479
|
* </li>
|
|
2343
2480
|
* <li>
|
|
2344
|
-
*
|
|
2481
|
+
* <p>
|
|
2345
2482
|
* <b>
|
|
2346
2483
|
* <code>MemoryUnderprovisioned</code>
|
|
2347
2484
|
* </b> — The
|
|
@@ -2349,8 +2486,8 @@ export interface InstanceRecommendation {
|
|
|
2349
2486
|
* your workload and there is an alternative instance type that provides better
|
|
2350
2487
|
* memory performance. This is identified by analyzing the memory utilization
|
|
2351
2488
|
* metric of the current instance during the look-back period.</p>
|
|
2352
|
-
*
|
|
2353
|
-
*
|
|
2489
|
+
* <note>
|
|
2490
|
+
* <p>Memory utilization is analyzed only for resources that have the unified
|
|
2354
2491
|
* CloudWatch agent installed on them. For more information, see
|
|
2355
2492
|
* <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent">Enabling memory
|
|
2356
2493
|
* utilization with the Amazon CloudWatch Agent</a> in the
|
|
@@ -2361,10 +2498,10 @@ export interface InstanceRecommendation {
|
|
|
2361
2498
|
* namespace. On Windows instances, Compute Optimizer analyses the <code>Memory
|
|
2362
2499
|
* % Committed Bytes In Use</code> metric in the <code>CWAgent</code>
|
|
2363
2500
|
* namespace.</p>
|
|
2364
|
-
*
|
|
2501
|
+
* </note>
|
|
2365
2502
|
* </li>
|
|
2366
2503
|
* <li>
|
|
2367
|
-
*
|
|
2504
|
+
* <p>
|
|
2368
2505
|
* <b>
|
|
2369
2506
|
* <code>EBSThroughputOverprovisioned</code>
|
|
2370
2507
|
* </b> —
|
|
@@ -2375,7 +2512,7 @@ export interface InstanceRecommendation {
|
|
|
2375
2512
|
* period.</p>
|
|
2376
2513
|
* </li>
|
|
2377
2514
|
* <li>
|
|
2378
|
-
*
|
|
2515
|
+
* <p>
|
|
2379
2516
|
* <b>
|
|
2380
2517
|
* <code>EBSThroughputUnderprovisioned</code>
|
|
2381
2518
|
* </b> —
|
|
@@ -2386,7 +2523,7 @@ export interface InstanceRecommendation {
|
|
|
2386
2523
|
* volumes attached to the current instance during the look-back period.</p>
|
|
2387
2524
|
* </li>
|
|
2388
2525
|
* <li>
|
|
2389
|
-
*
|
|
2526
|
+
* <p>
|
|
2390
2527
|
* <b>
|
|
2391
2528
|
* <code>EBSIOPSOverprovisioned</code>
|
|
2392
2529
|
* </b> — The
|
|
@@ -2396,7 +2533,7 @@ export interface InstanceRecommendation {
|
|
|
2396
2533
|
* volumes attached to the current instance during the look-back period.</p>
|
|
2397
2534
|
* </li>
|
|
2398
2535
|
* <li>
|
|
2399
|
-
*
|
|
2536
|
+
* <p>
|
|
2400
2537
|
* <b>
|
|
2401
2538
|
* <code>EBSIOPSUnderprovisioned</code>
|
|
2402
2539
|
* </b> — The
|
|
@@ -2407,7 +2544,7 @@ export interface InstanceRecommendation {
|
|
|
2407
2544
|
* volumes attached to the current instance during the look-back period.</p>
|
|
2408
2545
|
* </li>
|
|
2409
2546
|
* <li>
|
|
2410
|
-
*
|
|
2547
|
+
* <p>
|
|
2411
2548
|
* <b>
|
|
2412
2549
|
* <code>NetworkBandwidthOverprovisioned</code>
|
|
2413
2550
|
* </b>
|
|
@@ -2417,7 +2554,7 @@ export interface InstanceRecommendation {
|
|
|
2417
2554
|
* current instance during the look-back period.</p>
|
|
2418
2555
|
* </li>
|
|
2419
2556
|
* <li>
|
|
2420
|
-
*
|
|
2557
|
+
* <p>
|
|
2421
2558
|
* <b>
|
|
2422
2559
|
* <code>NetworkBandwidthUnderprovisioned</code>
|
|
2423
2560
|
* </b>
|
|
@@ -2430,7 +2567,7 @@ export interface InstanceRecommendation {
|
|
|
2430
2567
|
* is impacted.</p>
|
|
2431
2568
|
* </li>
|
|
2432
2569
|
* <li>
|
|
2433
|
-
*
|
|
2570
|
+
* <p>
|
|
2434
2571
|
* <b>
|
|
2435
2572
|
* <code>NetworkPPSOverprovisioned</code>
|
|
2436
2573
|
* </b> — The
|
|
@@ -2441,7 +2578,7 @@ export interface InstanceRecommendation {
|
|
|
2441
2578
|
* look-back period.</p>
|
|
2442
2579
|
* </li>
|
|
2443
2580
|
* <li>
|
|
2444
|
-
*
|
|
2581
|
+
* <p>
|
|
2445
2582
|
* <b>
|
|
2446
2583
|
* <code>NetworkPPSUnderprovisioned</code>
|
|
2447
2584
|
* </b> — The
|
|
@@ -2452,7 +2589,7 @@ export interface InstanceRecommendation {
|
|
|
2452
2589
|
* metrics of the current instance during the look-back period.</p>
|
|
2453
2590
|
* </li>
|
|
2454
2591
|
* <li>
|
|
2455
|
-
*
|
|
2592
|
+
* <p>
|
|
2456
2593
|
* <b>
|
|
2457
2594
|
* <code>DiskIOPSOverprovisioned</code>
|
|
2458
2595
|
* </b> — The
|
|
@@ -2462,7 +2599,7 @@ export interface InstanceRecommendation {
|
|
|
2462
2599
|
* current instance during the look-back period.</p>
|
|
2463
2600
|
* </li>
|
|
2464
2601
|
* <li>
|
|
2465
|
-
*
|
|
2602
|
+
* <p>
|
|
2466
2603
|
* <b>
|
|
2467
2604
|
* <code>DiskIOPSUnderprovisioned</code>
|
|
2468
2605
|
* </b> — The
|
|
@@ -2473,7 +2610,7 @@ export interface InstanceRecommendation {
|
|
|
2473
2610
|
* current instance during the look-back period.</p>
|
|
2474
2611
|
* </li>
|
|
2475
2612
|
* <li>
|
|
2476
|
-
*
|
|
2613
|
+
* <p>
|
|
2477
2614
|
* <b>
|
|
2478
2615
|
* <code>DiskThroughputOverprovisioned</code>
|
|
2479
2616
|
* </b> —
|
|
@@ -2483,7 +2620,7 @@ export interface InstanceRecommendation {
|
|
|
2483
2620
|
* of the current instance during the look-back period.</p>
|
|
2484
2621
|
* </li>
|
|
2485
2622
|
* <li>
|
|
2486
|
-
*
|
|
2623
|
+
* <p>
|
|
2487
2624
|
* <b>
|
|
2488
2625
|
* <code>DiskThroughputUnderprovisioned</code>
|
|
2489
2626
|
* </b> —
|
|
@@ -2494,14 +2631,14 @@ export interface InstanceRecommendation {
|
|
|
2494
2631
|
* current instance during the look-back period.</p>
|
|
2495
2632
|
* </li>
|
|
2496
2633
|
* </ul>
|
|
2497
|
-
*
|
|
2634
|
+
* <note>
|
|
2498
2635
|
* <p>For more information about instance metrics, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/viewing_metrics_with_cloudwatch.html">List the
|
|
2499
2636
|
* available CloudWatch metrics for your instances</a> in the
|
|
2500
2637
|
* <i>Amazon Elastic Compute Cloud User Guide</i>. For more information
|
|
2501
2638
|
* about EBS volume metrics, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cloudwatch_ebs.html">Amazon CloudWatch
|
|
2502
2639
|
* metrics for Amazon EBS</a> in the <i>Amazon Elastic Compute Cloud
|
|
2503
2640
|
* User Guide</i>.</p>
|
|
2504
|
-
*
|
|
2641
|
+
* </note>
|
|
2505
2642
|
*/
|
|
2506
2643
|
findingReasonCodes?: (InstanceRecommendationFindingReasonCode | string)[];
|
|
2507
2644
|
/**
|
|
@@ -2538,43 +2675,41 @@ export interface InstanceRecommendation {
|
|
|
2538
2675
|
effectiveRecommendationPreferences?: EffectiveRecommendationPreferences;
|
|
2539
2676
|
/**
|
|
2540
2677
|
* <p>The applications that might be running on the instance as inferred by Compute Optimizer.</p>
|
|
2541
|
-
*
|
|
2542
|
-
* <p>Compute Optimizer can infer if one of the following applications might be running on
|
|
2678
|
+
* <p>Compute Optimizer can infer if one of the following applications might be running on
|
|
2543
2679
|
* the instance:</p>
|
|
2544
|
-
*
|
|
2545
|
-
* <ul>
|
|
2680
|
+
* <ul>
|
|
2546
2681
|
* <li>
|
|
2547
|
-
*
|
|
2682
|
+
* <p>
|
|
2548
2683
|
* <code>AmazonEmr</code> - Infers that Amazon EMR might be running on
|
|
2549
2684
|
* the instance.</p>
|
|
2550
2685
|
* </li>
|
|
2551
2686
|
* <li>
|
|
2552
|
-
*
|
|
2687
|
+
* <p>
|
|
2553
2688
|
* <code>ApacheCassandra</code> - Infers that Apache Cassandra might be running
|
|
2554
2689
|
* on the instance.</p>
|
|
2555
2690
|
* </li>
|
|
2556
2691
|
* <li>
|
|
2557
|
-
*
|
|
2692
|
+
* <p>
|
|
2558
2693
|
* <code>ApacheHadoop</code> - Infers that Apache Hadoop might be running on the
|
|
2559
2694
|
* instance.</p>
|
|
2560
2695
|
* </li>
|
|
2561
2696
|
* <li>
|
|
2562
|
-
*
|
|
2697
|
+
* <p>
|
|
2563
2698
|
* <code>Memcached</code> - Infers that Memcached might be running on the
|
|
2564
2699
|
* instance.</p>
|
|
2565
2700
|
* </li>
|
|
2566
2701
|
* <li>
|
|
2567
|
-
*
|
|
2702
|
+
* <p>
|
|
2568
2703
|
* <code>NGINX</code> - Infers that NGINX might be running on the
|
|
2569
2704
|
* instance.</p>
|
|
2570
2705
|
* </li>
|
|
2571
2706
|
* <li>
|
|
2572
|
-
*
|
|
2707
|
+
* <p>
|
|
2573
2708
|
* <code>PostgreSql</code> - Infers that PostgreSQL might be running on the
|
|
2574
2709
|
* instance.</p>
|
|
2575
2710
|
* </li>
|
|
2576
2711
|
* <li>
|
|
2577
|
-
*
|
|
2712
|
+
* <p>
|
|
2578
2713
|
* <code>Redis</code> - Infers that Redis might be running on the
|
|
2579
2714
|
* instance.</p>
|
|
2580
2715
|
* </li>
|
|
@@ -2585,7 +2720,7 @@ export interface InstanceRecommendation {
|
|
|
2585
2720
|
export interface GetEC2InstanceRecommendationsResponse {
|
|
2586
2721
|
/**
|
|
2587
2722
|
* <p>The token to use to advance to the next page of instance recommendations.</p>
|
|
2588
|
-
*
|
|
2723
|
+
* <p>This value is null when there are no more pages of instance recommendations to
|
|
2589
2724
|
* return.</p>
|
|
2590
2725
|
*/
|
|
2591
2726
|
nextToken?: string;
|
|
@@ -2595,7 +2730,7 @@ export interface GetEC2InstanceRecommendationsResponse {
|
|
|
2595
2730
|
instanceRecommendations?: InstanceRecommendation[];
|
|
2596
2731
|
/**
|
|
2597
2732
|
* <p>An array of objects that describe errors of the request.</p>
|
|
2598
|
-
*
|
|
2733
|
+
* <p>For example, an error is returned if you request recommendations for an instance of an
|
|
2599
2734
|
* unsupported instance family.</p>
|
|
2600
2735
|
*/
|
|
2601
2736
|
errors?: GetRecommendationError[];
|
|
@@ -2632,45 +2767,45 @@ export interface GetEC2RecommendationProjectedMetricsRequest {
|
|
|
2632
2767
|
* <p>Describes a projected utilization metric of a recommendation option, such as an
|
|
2633
2768
|
* Amazon EC2 instance. This represents the projected utilization of a
|
|
2634
2769
|
* recommendation option had you used that resource during the analyzed period.</p>
|
|
2635
|
-
*
|
|
2770
|
+
* <p>Compare the utilization metric data of your resource against its projected utilization
|
|
2636
2771
|
* metric data to determine the performance difference between your current resource and
|
|
2637
2772
|
* the recommended option.</p>
|
|
2638
|
-
*
|
|
2773
|
+
* <note>
|
|
2639
2774
|
* <p>The <code>Cpu</code> and <code>Memory</code> metrics are the only projected
|
|
2640
2775
|
* utilization metrics returned when you run the <a>GetEC2RecommendationProjectedMetrics</a> action. Additionally, the
|
|
2641
2776
|
* <code>Memory</code> metric is returned only for resources that have the unified
|
|
2642
2777
|
* CloudWatch agent installed on them. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent">Enabling Memory Utilization with the CloudWatch Agent</a>.</p>
|
|
2643
|
-
*
|
|
2778
|
+
* </note>
|
|
2644
2779
|
*/
|
|
2645
2780
|
export interface ProjectedMetric {
|
|
2646
2781
|
/**
|
|
2647
2782
|
* <p>The name of the projected utilization metric.</p>
|
|
2648
|
-
*
|
|
2649
|
-
*
|
|
2783
|
+
* <p>The following projected utilization metrics are returned:</p>
|
|
2784
|
+
* <ul>
|
|
2650
2785
|
* <li>
|
|
2651
|
-
*
|
|
2786
|
+
* <p>
|
|
2652
2787
|
* <code>Cpu</code> - The projected percentage of allocated EC2 compute units
|
|
2653
2788
|
* that would be in use on the recommendation option had you used that resource
|
|
2654
2789
|
* during the analyzed period. This metric identifies the processing power required
|
|
2655
2790
|
* to run an application on the recommendation option.</p>
|
|
2656
|
-
*
|
|
2791
|
+
* <p>Depending on the instance type, tools in your operating system can show a
|
|
2657
2792
|
* lower percentage than CloudWatch when the instance is not allocated a full
|
|
2658
2793
|
* processor core.</p>
|
|
2659
|
-
*
|
|
2794
|
+
* <p>Units: Percent</p>
|
|
2660
2795
|
* </li>
|
|
2661
2796
|
* <li>
|
|
2662
|
-
*
|
|
2797
|
+
* <p>
|
|
2663
2798
|
* <code>Memory</code> - The percentage of memory that would be in use on the
|
|
2664
2799
|
* recommendation option had you used that resource during the analyzed period.
|
|
2665
2800
|
* This metric identifies the amount of memory required to run an application on
|
|
2666
2801
|
* the recommendation option.</p>
|
|
2667
|
-
*
|
|
2668
|
-
*
|
|
2669
|
-
*
|
|
2802
|
+
* <p>Units: Percent</p>
|
|
2803
|
+
* <note>
|
|
2804
|
+
* <p>The <code>Memory</code> metric is returned only for resources that have
|
|
2670
2805
|
* the unified CloudWatch agent installed on them. For more information,
|
|
2671
2806
|
* see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent">Enabling Memory
|
|
2672
2807
|
* Utilization with the CloudWatch Agent</a>.</p>
|
|
2673
|
-
*
|
|
2808
|
+
* </note>
|
|
2674
2809
|
* </li>
|
|
2675
2810
|
* </ul>
|
|
2676
2811
|
*/
|
|
@@ -2686,12 +2821,12 @@ export interface ProjectedMetric {
|
|
|
2686
2821
|
}
|
|
2687
2822
|
/**
|
|
2688
2823
|
* <p>Describes a projected utilization metric of a recommendation option.</p>
|
|
2689
|
-
*
|
|
2824
|
+
* <note>
|
|
2690
2825
|
* <p>The <code>Cpu</code> and <code>Memory</code> metrics are the only projected
|
|
2691
2826
|
* utilization metrics returned when you run the <a>GetEC2RecommendationProjectedMetrics</a> action. Additionally, the
|
|
2692
2827
|
* <code>Memory</code> metric is returned only for resources that have the unified
|
|
2693
2828
|
* CloudWatch agent installed on them. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent">Enabling Memory Utilization with the CloudWatch Agent</a>.</p>
|
|
2694
|
-
*
|
|
2829
|
+
* </note>
|
|
2695
2830
|
*/
|
|
2696
2831
|
export interface RecommendedOptionProjectedMetric {
|
|
2697
2832
|
/**
|
|
@@ -2700,8 +2835,8 @@ export interface RecommendedOptionProjectedMetric {
|
|
|
2700
2835
|
recommendedInstanceType?: string;
|
|
2701
2836
|
/**
|
|
2702
2837
|
* <p>The rank of the recommendation option projected metric.</p>
|
|
2703
|
-
*
|
|
2704
|
-
*
|
|
2838
|
+
* <p>The top recommendation option is ranked as <code>1</code>.</p>
|
|
2839
|
+
* <p>The projected metric rank correlates to the recommendation option rank. For example,
|
|
2705
2840
|
* the projected metric ranked as <code>1</code> is related to the recommendation option
|
|
2706
2841
|
* that is also ranked as <code>1</code> in the same response.</p>
|
|
2707
2842
|
*/
|
|
@@ -2717,161 +2852,798 @@ export interface GetEC2RecommendationProjectedMetricsResponse {
|
|
|
2717
2852
|
*/
|
|
2718
2853
|
recommendedOptionProjectedMetrics?: RecommendedOptionProjectedMetric[];
|
|
2719
2854
|
}
|
|
2720
|
-
export interface
|
|
2855
|
+
export interface GetECSServiceRecommendationProjectedMetricsRequest {
|
|
2721
2856
|
/**
|
|
2722
|
-
* <p>
|
|
2723
|
-
*
|
|
2724
|
-
*
|
|
2857
|
+
* <p>
|
|
2858
|
+
* The ARN that identifies the ECS service.
|
|
2859
|
+
* </p>
|
|
2860
|
+
* <p>
|
|
2861
|
+
* The following is the format of the ARN:
|
|
2862
|
+
* </p>
|
|
2863
|
+
* <p>
|
|
2864
|
+
* <code>arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name</code>
|
|
2865
|
+
* </p>
|
|
2725
2866
|
*/
|
|
2726
|
-
|
|
2727
|
-
}
|
|
2728
|
-
export interface GetEffectiveRecommendationPreferencesResponse {
|
|
2867
|
+
serviceArn: string | undefined;
|
|
2729
2868
|
/**
|
|
2730
|
-
* <p>
|
|
2731
|
-
*
|
|
2732
|
-
*
|
|
2733
|
-
* <p>A status of <code>Active</code> confirms that the preference is applied in the latest
|
|
2734
|
-
* recommendation refresh, and a status of <code>Inactive</code> confirms that it's not yet
|
|
2735
|
-
* applied to recommendations.</p>
|
|
2736
|
-
* <p>To validate whether the preference is applied to your last generated set of
|
|
2737
|
-
* recommendations, review the <code>effectiveRecommendationPreferences</code> value in the
|
|
2738
|
-
* response of the <a>GetAutoScalingGroupRecommendations</a> and <a>GetEC2InstanceRecommendations</a> actions.</p>
|
|
2739
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Enhanced
|
|
2740
|
-
* infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
2741
|
-
* Guide</i>.</p>
|
|
2869
|
+
* <p>
|
|
2870
|
+
* The statistic of the projected metrics.
|
|
2871
|
+
* </p>
|
|
2742
2872
|
*/
|
|
2743
|
-
|
|
2873
|
+
stat: MetricStatistic | string | undefined;
|
|
2744
2874
|
/**
|
|
2745
|
-
* <p>
|
|
2746
|
-
*
|
|
2747
|
-
*
|
|
2748
|
-
* <p>If the preference is applied in the latest recommendation refresh, an object with a valid
|
|
2749
|
-
* <code>source</code> value appears in the response. If the preference isn't applied to the
|
|
2750
|
-
* recommendations already, then this object doesn't appear in the response.</p>
|
|
2751
|
-
* <p>To validate whether the preference is applied to your last generated set of
|
|
2752
|
-
* recommendations, review the <code>effectiveRecommendationPreferences</code> value in the
|
|
2753
|
-
* response of the <a>GetEC2InstanceRecommendations</a> actions.</p>
|
|
2754
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Enhanced
|
|
2755
|
-
* infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
2756
|
-
* Guide</i>.</p>
|
|
2875
|
+
* <p>
|
|
2876
|
+
* The granularity, in seconds, of the projected metrics data points.
|
|
2877
|
+
* </p>
|
|
2757
2878
|
*/
|
|
2758
|
-
|
|
2759
|
-
}
|
|
2760
|
-
export interface GetEnrollmentStatusRequest {
|
|
2761
|
-
}
|
|
2762
|
-
export interface GetEnrollmentStatusResponse {
|
|
2879
|
+
period: number | undefined;
|
|
2763
2880
|
/**
|
|
2764
|
-
* <p>
|
|
2881
|
+
* <p>
|
|
2882
|
+
* The timestamp of the first projected metrics data point to return.
|
|
2883
|
+
* </p>
|
|
2765
2884
|
*/
|
|
2766
|
-
|
|
2885
|
+
startTime: Date | undefined;
|
|
2767
2886
|
/**
|
|
2768
|
-
* <p>
|
|
2769
|
-
*
|
|
2770
|
-
*
|
|
2887
|
+
* <p>
|
|
2888
|
+
* The timestamp of the last projected metrics data point to return.
|
|
2889
|
+
* </p>
|
|
2771
2890
|
*/
|
|
2772
|
-
|
|
2891
|
+
endTime: Date | undefined;
|
|
2892
|
+
}
|
|
2893
|
+
export declare enum ECSServiceMetricName {
|
|
2894
|
+
CPU = "Cpu",
|
|
2895
|
+
MEMORY = "Memory"
|
|
2896
|
+
}
|
|
2897
|
+
/**
|
|
2898
|
+
* <p>
|
|
2899
|
+
* Describes the projected metrics of an Amazon ECS service recommendation option.
|
|
2900
|
+
* </p>
|
|
2901
|
+
* <p>To determine the performance difference between your current ECS service and the recommended option,
|
|
2902
|
+
* compare the metric data of your service against its projected metric data.</p>
|
|
2903
|
+
*/
|
|
2904
|
+
export interface ECSServiceProjectedMetric {
|
|
2773
2905
|
/**
|
|
2774
|
-
* <p>
|
|
2775
|
-
*
|
|
2906
|
+
* <p>
|
|
2907
|
+
* The name of the projected metric.
|
|
2908
|
+
* </p>
|
|
2909
|
+
* <p>The following metrics are available:</p>
|
|
2910
|
+
* <ul>
|
|
2911
|
+
* <li>
|
|
2912
|
+
* <p>
|
|
2913
|
+
* <code>CPU</code> — The percentage of allocated compute units
|
|
2914
|
+
* that are currently in use on the ECS service tasks.</p>
|
|
2915
|
+
* </li>
|
|
2916
|
+
* <li>
|
|
2917
|
+
* <p>
|
|
2918
|
+
* <code>Memory</code> — The percentage of memory that is
|
|
2919
|
+
* currently in use on the ECS service tasks.</p>
|
|
2920
|
+
* </li>
|
|
2921
|
+
* </ul>
|
|
2776
2922
|
*/
|
|
2777
|
-
|
|
2923
|
+
name?: ECSServiceMetricName | string;
|
|
2778
2924
|
/**
|
|
2779
|
-
* <p>
|
|
2780
|
-
*
|
|
2925
|
+
* <p>
|
|
2926
|
+
* The timestamps of the projected metric.
|
|
2927
|
+
* </p>
|
|
2781
2928
|
*/
|
|
2782
|
-
|
|
2929
|
+
timestamps?: Date[];
|
|
2783
2930
|
/**
|
|
2784
|
-
* <p>
|
|
2785
|
-
*
|
|
2931
|
+
* <p>
|
|
2932
|
+
* The upper bound values for the projected metric.
|
|
2933
|
+
* </p>
|
|
2786
2934
|
*/
|
|
2787
|
-
|
|
2788
|
-
|
|
2789
|
-
|
|
2790
|
-
|
|
2935
|
+
upperBoundValues?: number[];
|
|
2936
|
+
/**
|
|
2937
|
+
* <p>
|
|
2938
|
+
* The lower bound values for the projected metric.
|
|
2939
|
+
* </p>
|
|
2940
|
+
*/
|
|
2941
|
+
lowerBoundValues?: number[];
|
|
2791
2942
|
}
|
|
2792
2943
|
/**
|
|
2793
|
-
* <p>
|
|
2794
|
-
*
|
|
2795
|
-
*
|
|
2944
|
+
* <p>
|
|
2945
|
+
* Describes the projected metrics of an Amazon ECS service recommendation option.
|
|
2946
|
+
* </p>
|
|
2947
|
+
* <p>To determine the performance difference between your current ECS service and the recommended option,
|
|
2948
|
+
* compare the metric data of your service against its projected metric data.</p>
|
|
2796
2949
|
*/
|
|
2797
|
-
export interface
|
|
2798
|
-
/**
|
|
2799
|
-
* <p>The name of the filter.</p>
|
|
2800
|
-
* <p>Specify <code>Status</code> to return accounts with a specific enrollment status (for
|
|
2801
|
-
* example, <code>Active</code>).</p>
|
|
2802
|
-
*/
|
|
2803
|
-
name?: EnrollmentFilterName | string;
|
|
2950
|
+
export interface ECSServiceRecommendedOptionProjectedMetric {
|
|
2804
2951
|
/**
|
|
2805
|
-
* <p>
|
|
2806
|
-
*
|
|
2807
|
-
*
|
|
2952
|
+
* <p>
|
|
2953
|
+
* The recommended CPU size for the ECS service.
|
|
2954
|
+
* </p>
|
|
2808
2955
|
*/
|
|
2809
|
-
|
|
2810
|
-
}
|
|
2811
|
-
export interface GetEnrollmentStatusesForOrganizationRequest {
|
|
2956
|
+
recommendedCpuUnits?: number;
|
|
2812
2957
|
/**
|
|
2813
|
-
* <p>
|
|
2814
|
-
*
|
|
2958
|
+
* <p>
|
|
2959
|
+
* The recommended memory size for the ECS service.
|
|
2960
|
+
* </p>
|
|
2815
2961
|
*/
|
|
2816
|
-
|
|
2962
|
+
recommendedMemorySize?: number;
|
|
2817
2963
|
/**
|
|
2818
|
-
* <p>
|
|
2964
|
+
* <p>
|
|
2965
|
+
* An array of objects that describe the projected metric.
|
|
2966
|
+
* </p>
|
|
2819
2967
|
*/
|
|
2820
|
-
|
|
2968
|
+
projectedMetrics?: ECSServiceProjectedMetric[];
|
|
2969
|
+
}
|
|
2970
|
+
export interface GetECSServiceRecommendationProjectedMetricsResponse {
|
|
2821
2971
|
/**
|
|
2822
|
-
* <p>
|
|
2823
|
-
*
|
|
2824
|
-
*
|
|
2825
|
-
* <code>nextToken</code> value.</p>
|
|
2972
|
+
* <p>
|
|
2973
|
+
* An array of objects that describes the projected metrics.
|
|
2974
|
+
* </p>
|
|
2826
2975
|
*/
|
|
2827
|
-
|
|
2976
|
+
recommendedOptionProjectedMetrics?: ECSServiceRecommendedOptionProjectedMetric[];
|
|
2828
2977
|
}
|
|
2829
|
-
export interface
|
|
2978
|
+
export interface GetECSServiceRecommendationsRequest {
|
|
2830
2979
|
/**
|
|
2831
|
-
* <p>
|
|
2832
|
-
*
|
|
2980
|
+
* <p>
|
|
2981
|
+
* The ARN that identifies the ECS service.
|
|
2982
|
+
* </p>
|
|
2983
|
+
* <p>
|
|
2984
|
+
* The following is the format of the ARN:
|
|
2985
|
+
* </p>
|
|
2986
|
+
* <p>
|
|
2987
|
+
* <code>arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name</code>
|
|
2988
|
+
* </p>
|
|
2833
2989
|
*/
|
|
2834
|
-
|
|
2990
|
+
serviceArns?: string[];
|
|
2835
2991
|
/**
|
|
2836
|
-
* <p>
|
|
2837
|
-
*
|
|
2838
|
-
*
|
|
2992
|
+
* <p>
|
|
2993
|
+
* The token to advance to the next page of ECS service recommendations.
|
|
2994
|
+
* </p>
|
|
2839
2995
|
*/
|
|
2840
2996
|
nextToken?: string;
|
|
2841
|
-
}
|
|
2842
|
-
export interface GetLambdaFunctionRecommendationsRequest {
|
|
2843
2997
|
/**
|
|
2844
|
-
* <p>
|
|
2845
|
-
* recommendations
|
|
2846
|
-
*
|
|
2847
|
-
*
|
|
2848
|
-
*
|
|
2849
|
-
* with a version suffix, Compute Optimizer will return recommendations for the specified
|
|
2850
|
-
* function version. For more information about using function versions, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using">Using
|
|
2851
|
-
* versions</a> in the <i>Lambda Developer
|
|
2852
|
-
* Guide</i>.</p>
|
|
2998
|
+
* <p>
|
|
2999
|
+
* The maximum number of ECS service recommendations to return with a single request.
|
|
3000
|
+
* </p>
|
|
3001
|
+
* <p>To retrieve the remaining results, make another request with the returned
|
|
3002
|
+
* <code>nextToken</code> value.</p>
|
|
2853
3003
|
*/
|
|
2854
|
-
|
|
3004
|
+
maxResults?: number;
|
|
2855
3005
|
/**
|
|
2856
|
-
* <p>
|
|
2857
|
-
* recommendations
|
|
2858
|
-
*
|
|
2859
|
-
* specify the member account for which you want to return function recommendations.</p>
|
|
2860
|
-
* <p>Only one account ID can be specified per request.</p>
|
|
3006
|
+
* <p>
|
|
3007
|
+
* An array of objects to specify a filter that returns a more specific list of ECS service recommendations.
|
|
3008
|
+
* </p>
|
|
2861
3009
|
*/
|
|
2862
|
-
|
|
3010
|
+
filters?: ECSServiceRecommendationFilter[];
|
|
2863
3011
|
/**
|
|
2864
|
-
* <p>
|
|
2865
|
-
* recommendations
|
|
3012
|
+
* <p>
|
|
3013
|
+
* Return the ECS service recommendations to the specified Amazon Web Services account IDs.
|
|
3014
|
+
* </p>
|
|
3015
|
+
* <p>If your account is the management account or the delegated administrator
|
|
3016
|
+
* of an organization, use this parameter to return the ECS service recommendations to specific
|
|
3017
|
+
* member accounts.</p>
|
|
3018
|
+
* <p>You can only specify one account ID per request.</p>
|
|
2866
3019
|
*/
|
|
2867
|
-
|
|
3020
|
+
accountIds?: string[];
|
|
3021
|
+
}
|
|
3022
|
+
/**
|
|
3023
|
+
* <p>
|
|
3024
|
+
* The memory size configurations of a container.
|
|
3025
|
+
* </p>
|
|
3026
|
+
*/
|
|
3027
|
+
export interface MemorySizeConfiguration {
|
|
2868
3028
|
/**
|
|
2869
|
-
* <p>
|
|
3029
|
+
* <p>
|
|
3030
|
+
* The amount of memory in the container.
|
|
3031
|
+
* </p>
|
|
2870
3032
|
*/
|
|
2871
|
-
|
|
3033
|
+
memory?: number;
|
|
2872
3034
|
/**
|
|
2873
|
-
* <p>
|
|
2874
|
-
*
|
|
3035
|
+
* <p>
|
|
3036
|
+
* The limit of memory reserve for the container.
|
|
3037
|
+
* </p>
|
|
3038
|
+
*/
|
|
3039
|
+
memoryReservation?: number;
|
|
3040
|
+
}
|
|
3041
|
+
/**
|
|
3042
|
+
* <p>
|
|
3043
|
+
* Describes the container configurations within the tasks of your Amazon ECS service.
|
|
3044
|
+
* </p>
|
|
3045
|
+
*/
|
|
3046
|
+
export interface ContainerConfiguration {
|
|
3047
|
+
/**
|
|
3048
|
+
* <p>
|
|
3049
|
+
* The name of the container.
|
|
3050
|
+
* </p>
|
|
3051
|
+
*/
|
|
3052
|
+
containerName?: string;
|
|
3053
|
+
/**
|
|
3054
|
+
* <p>
|
|
3055
|
+
* The memory size configurations for the container.
|
|
3056
|
+
* </p>
|
|
3057
|
+
*/
|
|
3058
|
+
memorySizeConfiguration?: MemorySizeConfiguration;
|
|
3059
|
+
/**
|
|
3060
|
+
* <p>
|
|
3061
|
+
* The number of CPU units reserved for the container.
|
|
3062
|
+
* </p>
|
|
3063
|
+
*/
|
|
3064
|
+
cpu?: number;
|
|
3065
|
+
}
|
|
3066
|
+
/**
|
|
3067
|
+
* <p>
|
|
3068
|
+
* The Amazon ECS service configurations used for recommendations.
|
|
3069
|
+
* </p>
|
|
3070
|
+
*/
|
|
3071
|
+
export interface ServiceConfiguration {
|
|
3072
|
+
/**
|
|
3073
|
+
* <p>
|
|
3074
|
+
* The amount of memory used by the tasks in the ECS service.
|
|
3075
|
+
* </p>
|
|
3076
|
+
*/
|
|
3077
|
+
memory?: number;
|
|
3078
|
+
/**
|
|
3079
|
+
* <p>
|
|
3080
|
+
* The number of CPU units used by the tasks in the ECS service.
|
|
3081
|
+
* </p>
|
|
3082
|
+
*/
|
|
3083
|
+
cpu?: number;
|
|
3084
|
+
/**
|
|
3085
|
+
* <p>
|
|
3086
|
+
* The container configurations within a task of an ECS service.
|
|
3087
|
+
* </p>
|
|
3088
|
+
*/
|
|
3089
|
+
containerConfigurations?: ContainerConfiguration[];
|
|
3090
|
+
/**
|
|
3091
|
+
* <p>
|
|
3092
|
+
* Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects
|
|
3093
|
+
* the generated recommendations. For example, if Auto Scaling is configured on a
|
|
3094
|
+
* ECS service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations.
|
|
3095
|
+
* </p>
|
|
3096
|
+
* <p>The Auto Scaling configuration methods include:</p>
|
|
3097
|
+
* <ul>
|
|
3098
|
+
* <li>
|
|
3099
|
+
* <p>
|
|
3100
|
+
* <code>TARGET_TRACKING_SCALING_CPU</code> — If the ECS service is configured
|
|
3101
|
+
* to use target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations.</p>
|
|
3102
|
+
* </li>
|
|
3103
|
+
* <li>
|
|
3104
|
+
* <p>
|
|
3105
|
+
* <code>TARGET_TRACKING_SCALING_MEMORY</code> — If the ECS service is configured
|
|
3106
|
+
* to use target scaling on memory, Compute Optimizer doesn't generate memory recommendations.</p>
|
|
3107
|
+
* </li>
|
|
3108
|
+
* </ul>
|
|
3109
|
+
* <p>For more information about step scaling and target scaling, see
|
|
3110
|
+
* <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html">
|
|
3111
|
+
* Step scaling policies for Application Auto Scaling</a> and
|
|
3112
|
+
* <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html">
|
|
3113
|
+
* Target tracking scaling policies for Application Auto Scaling</a> in the
|
|
3114
|
+
* <i>Application Auto Scaling User Guide</i>.</p>
|
|
3115
|
+
*/
|
|
3116
|
+
autoScalingConfiguration?: AutoScalingConfiguration | string;
|
|
3117
|
+
/**
|
|
3118
|
+
* <p>
|
|
3119
|
+
* The task definition ARN used by the tasks in the ECS service.
|
|
3120
|
+
* </p>
|
|
3121
|
+
*/
|
|
3122
|
+
taskDefinitionArn?: string;
|
|
3123
|
+
}
|
|
3124
|
+
export declare enum ECSServiceRecommendationFinding {
|
|
3125
|
+
OPTIMIZED = "Optimized",
|
|
3126
|
+
OVER_PROVISIONED = "Overprovisioned",
|
|
3127
|
+
UNDER_PROVISIONED = "Underprovisioned"
|
|
3128
|
+
}
|
|
3129
|
+
export declare enum ECSServiceRecommendationFindingReasonCode {
|
|
3130
|
+
CPU_OVER_PROVISIONED = "CPUOverprovisioned",
|
|
3131
|
+
CPU_UNDER_PROVISIONED = "CPUUnderprovisioned",
|
|
3132
|
+
MEMORY_OVER_PROVISIONED = "MemoryOverprovisioned",
|
|
3133
|
+
MEMORY_UNDER_PROVISIONED = "MemoryUnderprovisioned"
|
|
3134
|
+
}
|
|
3135
|
+
export declare enum ECSServiceLaunchType {
|
|
3136
|
+
EC2 = "EC2",
|
|
3137
|
+
FARGATE = "Fargate"
|
|
3138
|
+
}
|
|
3139
|
+
/**
|
|
3140
|
+
* <p>
|
|
3141
|
+
* The CPU and memory recommendations for a container within the tasks of your Amazon ECS service.
|
|
3142
|
+
* </p>
|
|
3143
|
+
*/
|
|
3144
|
+
export interface ContainerRecommendation {
|
|
3145
|
+
/**
|
|
3146
|
+
* <p>
|
|
3147
|
+
* The name of the container.
|
|
3148
|
+
* </p>
|
|
3149
|
+
*/
|
|
3150
|
+
containerName?: string;
|
|
3151
|
+
/**
|
|
3152
|
+
* <p>
|
|
3153
|
+
* The recommended memory size configurations for the container.
|
|
3154
|
+
* </p>
|
|
3155
|
+
*/
|
|
3156
|
+
memorySizeConfiguration?: MemorySizeConfiguration;
|
|
3157
|
+
/**
|
|
3158
|
+
* <p>
|
|
3159
|
+
* The recommended number of CPU units reserved for the container.
|
|
3160
|
+
* </p>
|
|
3161
|
+
*/
|
|
3162
|
+
cpu?: number;
|
|
3163
|
+
}
|
|
3164
|
+
export declare enum ECSServiceMetricStatistic {
|
|
3165
|
+
AVERAGE = "Average",
|
|
3166
|
+
MAXIMUM = "Maximum"
|
|
3167
|
+
}
|
|
3168
|
+
/**
|
|
3169
|
+
* <p>
|
|
3170
|
+
* Describes the projected utilization metrics of an Amazon ECS service recommendation option.
|
|
3171
|
+
* </p>
|
|
3172
|
+
* <p>To determine the performance difference between your current ECS service and the recommended option,
|
|
3173
|
+
* compare the utilization metric data of your service against its projected utilization metric data.</p>
|
|
3174
|
+
*/
|
|
3175
|
+
export interface ECSServiceProjectedUtilizationMetric {
|
|
3176
|
+
/**
|
|
3177
|
+
* <p>
|
|
3178
|
+
* The name of the projected utilization metric.
|
|
3179
|
+
* </p>
|
|
3180
|
+
* <p>The following utilization metrics are available:</p>
|
|
3181
|
+
* <ul>
|
|
3182
|
+
* <li>
|
|
3183
|
+
* <p>
|
|
3184
|
+
* <code>CPU</code> — The percentage of allocated compute units
|
|
3185
|
+
* that are currently in use on the ECS service tasks.</p>
|
|
3186
|
+
* </li>
|
|
3187
|
+
* <li>
|
|
3188
|
+
* <p>
|
|
3189
|
+
* <code>Memory</code> — The percentage of memory that is
|
|
3190
|
+
* currently in use on the ECS service tasks.</p>
|
|
3191
|
+
* </li>
|
|
3192
|
+
* </ul>
|
|
3193
|
+
*/
|
|
3194
|
+
name?: ECSServiceMetricName | string;
|
|
3195
|
+
/**
|
|
3196
|
+
* <p>The statistic of the projected utilization metric.</p>
|
|
3197
|
+
* <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs
|
|
3198
|
+
* return utilization metrics using only the <code>Maximum</code> statistic, which is the
|
|
3199
|
+
* highest value observed during the specified period.</p>
|
|
3200
|
+
* <p>The Compute Optimizer console displays graphs for some utilization metrics using the
|
|
3201
|
+
* <code>Average</code> statistic, which is the value of <code>Sum</code> /
|
|
3202
|
+
* <code>SampleCount</code> during the specified period. For more information, see
|
|
3203
|
+
* <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html">Viewing resource
|
|
3204
|
+
* recommendations</a> in the <i>Compute Optimizer User
|
|
3205
|
+
* Guide</i>. You can also get averaged utilization metric data for your resources
|
|
3206
|
+
* using Amazon CloudWatch. For more information, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html">Amazon CloudWatch
|
|
3207
|
+
* User Guide</a>.</p>
|
|
3208
|
+
*/
|
|
3209
|
+
statistic?: ECSServiceMetricStatistic | string;
|
|
3210
|
+
/**
|
|
3211
|
+
* <p>
|
|
3212
|
+
* The lower bound values for the projected utilization metrics.
|
|
3213
|
+
* </p>
|
|
3214
|
+
*/
|
|
3215
|
+
lowerBoundValue?: number;
|
|
3216
|
+
/**
|
|
3217
|
+
* <p>
|
|
3218
|
+
* The upper bound values for the projected utilization metrics.
|
|
3219
|
+
* </p>
|
|
3220
|
+
*/
|
|
3221
|
+
upperBoundValue?: number;
|
|
3222
|
+
}
|
|
3223
|
+
/**
|
|
3224
|
+
* <p>
|
|
3225
|
+
* Describes the recommendation options for an Amazon ECS service.
|
|
3226
|
+
* </p>
|
|
3227
|
+
*/
|
|
3228
|
+
export interface ECSServiceRecommendationOption {
|
|
3229
|
+
/**
|
|
3230
|
+
* <p>
|
|
3231
|
+
* The memory size of the ECS service recommendation option.
|
|
3232
|
+
* </p>
|
|
3233
|
+
*/
|
|
3234
|
+
memory?: number;
|
|
3235
|
+
/**
|
|
3236
|
+
* <p>
|
|
3237
|
+
* The CPU size of the ECS service recommendation option.
|
|
3238
|
+
* </p>
|
|
3239
|
+
*/
|
|
3240
|
+
cpu?: number;
|
|
3241
|
+
/**
|
|
3242
|
+
* <p>Describes the savings opportunity for recommendations of a given resource type or for
|
|
3243
|
+
* the recommendation option of an individual resource.</p>
|
|
3244
|
+
* <p>Savings opportunity represents the estimated monthly savings you can achieve by
|
|
3245
|
+
* implementing a given Compute Optimizer recommendation.</p>
|
|
3246
|
+
* <important>
|
|
3247
|
+
* <p>Savings opportunity data requires that you opt in to Cost Explorer, as well as
|
|
3248
|
+
* activate <b>Receive Amazon EC2 resource
|
|
3249
|
+
* recommendations</b> in the Cost Explorer preferences page. That
|
|
3250
|
+
* creates a connection between Cost Explorer and Compute Optimizer. With this
|
|
3251
|
+
* connection, Cost Explorer generates savings estimates considering the price of
|
|
3252
|
+
* existing resources, the price of recommended resources, and historical usage data.
|
|
3253
|
+
* Estimated monthly savings reflects the projected dollar savings associated with each
|
|
3254
|
+
* of the recommendations generated. For more information, see <a href="https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html">Enabling Cost Explorer</a> and <a href="https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html">Optimizing your cost
|
|
3255
|
+
* with Rightsizing Recommendations</a> in the <i>Cost Management User
|
|
3256
|
+
* Guide</i>.</p>
|
|
3257
|
+
* </important>
|
|
3258
|
+
*/
|
|
3259
|
+
savingsOpportunity?: SavingsOpportunity;
|
|
3260
|
+
/**
|
|
3261
|
+
* <p>
|
|
3262
|
+
* An array of objects that describe the projected utilization metrics of the ECS service recommendation option.
|
|
3263
|
+
* </p>
|
|
3264
|
+
*/
|
|
3265
|
+
projectedUtilizationMetrics?: ECSServiceProjectedUtilizationMetric[];
|
|
3266
|
+
/**
|
|
3267
|
+
* <p>
|
|
3268
|
+
* The CPU and memory size recommendations for the containers within the task of your ECS service.
|
|
3269
|
+
* </p>
|
|
3270
|
+
*/
|
|
3271
|
+
containerRecommendations?: ContainerRecommendation[];
|
|
3272
|
+
}
|
|
3273
|
+
/**
|
|
3274
|
+
* <p>
|
|
3275
|
+
* Describes the utilization metric of an Amazon ECS service.
|
|
3276
|
+
* </p>
|
|
3277
|
+
* <p>To determine the performance difference between your current ECS service and the recommended option,
|
|
3278
|
+
* compare the utilization metric data of your service against its projected utilization metric data.</p>
|
|
3279
|
+
*/
|
|
3280
|
+
export interface ECSServiceUtilizationMetric {
|
|
3281
|
+
/**
|
|
3282
|
+
* <p>
|
|
3283
|
+
* The name of the utilization metric.
|
|
3284
|
+
* </p>
|
|
3285
|
+
* <p>The following utilization metrics are available:</p>
|
|
3286
|
+
* <ul>
|
|
3287
|
+
* <li>
|
|
3288
|
+
* <p>
|
|
3289
|
+
* <code>Cpu</code> — The amount of CPU units that are used in the service.</p>
|
|
3290
|
+
* </li>
|
|
3291
|
+
* <li>
|
|
3292
|
+
* <p>
|
|
3293
|
+
* <code>Memory</code> — The amount of memory that is used in the service.</p>
|
|
3294
|
+
* </li>
|
|
3295
|
+
* </ul>
|
|
3296
|
+
*/
|
|
3297
|
+
name?: ECSServiceMetricName | string;
|
|
3298
|
+
/**
|
|
3299
|
+
* <p>The statistic of the utilization metric.</p>
|
|
3300
|
+
* <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs
|
|
3301
|
+
* return utilization metrics using only the <code>Maximum</code> statistic, which is the
|
|
3302
|
+
* highest value observed during the specified period.</p>
|
|
3303
|
+
* <p>The Compute Optimizer console displays graphs for some utilization metrics using the
|
|
3304
|
+
* <code>Average</code> statistic, which is the value of <code>Sum</code> /
|
|
3305
|
+
* <code>SampleCount</code> during the specified period. For more information, see
|
|
3306
|
+
* <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html">Viewing resource
|
|
3307
|
+
* recommendations</a> in the <i>Compute Optimizer User
|
|
3308
|
+
* Guide</i>. You can also get averaged utilization metric data for your resources
|
|
3309
|
+
* using Amazon CloudWatch. For more information, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html">Amazon CloudWatch
|
|
3310
|
+
* User Guide</a>.</p>
|
|
3311
|
+
*/
|
|
3312
|
+
statistic?: ECSServiceMetricStatistic | string;
|
|
3313
|
+
/**
|
|
3314
|
+
* <p>
|
|
3315
|
+
* The value of the utilization metric.
|
|
3316
|
+
* </p>
|
|
3317
|
+
*/
|
|
3318
|
+
value?: number;
|
|
3319
|
+
}
|
|
3320
|
+
/**
|
|
3321
|
+
* <p>
|
|
3322
|
+
* Describes an Amazon ECS service recommendation.
|
|
3323
|
+
* </p>
|
|
3324
|
+
*/
|
|
3325
|
+
export interface ECSServiceRecommendation {
|
|
3326
|
+
/**
|
|
3327
|
+
* <p>
|
|
3328
|
+
* The Amazon Resource Name (ARN) of the current ECS service.
|
|
3329
|
+
* </p>
|
|
3330
|
+
* <p>
|
|
3331
|
+
* The following is the format of the ARN:
|
|
3332
|
+
* </p>
|
|
3333
|
+
* <p>
|
|
3334
|
+
* <code>arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name</code>
|
|
3335
|
+
* </p>
|
|
3336
|
+
*/
|
|
3337
|
+
serviceArn?: string;
|
|
3338
|
+
/**
|
|
3339
|
+
* <p>
|
|
3340
|
+
* The Amazon Web Services account ID of the ECS service.
|
|
3341
|
+
* </p>
|
|
3342
|
+
*/
|
|
3343
|
+
accountId?: string;
|
|
3344
|
+
/**
|
|
3345
|
+
* <p>
|
|
3346
|
+
* The configuration of the current ECS service.
|
|
3347
|
+
* </p>
|
|
3348
|
+
*/
|
|
3349
|
+
currentServiceConfiguration?: ServiceConfiguration;
|
|
3350
|
+
/**
|
|
3351
|
+
* <p>
|
|
3352
|
+
* An array of objects that describe the utilization metrics of the ECS service.
|
|
3353
|
+
* </p>
|
|
3354
|
+
*/
|
|
3355
|
+
utilizationMetrics?: ECSServiceUtilizationMetric[];
|
|
3356
|
+
/**
|
|
3357
|
+
* <p>
|
|
3358
|
+
* The number of days the ECS service utilization metrics were analyzed.
|
|
3359
|
+
* </p>
|
|
3360
|
+
*/
|
|
3361
|
+
lookbackPeriodInDays?: number;
|
|
3362
|
+
/**
|
|
3363
|
+
* <p>
|
|
3364
|
+
* The launch type the ECS service is using.
|
|
3365
|
+
* </p>
|
|
3366
|
+
* <note>
|
|
3367
|
+
* <p>Compute Optimizer only supports the Fargate launch type.</p>
|
|
3368
|
+
* </note>
|
|
3369
|
+
*/
|
|
3370
|
+
launchType?: ECSServiceLaunchType | string;
|
|
3371
|
+
/**
|
|
3372
|
+
* <p>
|
|
3373
|
+
* The timestamp of when the ECS service recommendation was last generated.
|
|
3374
|
+
* </p>
|
|
3375
|
+
*/
|
|
3376
|
+
lastRefreshTimestamp?: Date;
|
|
3377
|
+
/**
|
|
3378
|
+
* <p>
|
|
3379
|
+
* The finding classification of an ECS service.
|
|
3380
|
+
* </p>
|
|
3381
|
+
* <p>Findings for ECS services include:</p>
|
|
3382
|
+
* <ul>
|
|
3383
|
+
* <li>
|
|
3384
|
+
* <p>
|
|
3385
|
+
* <b>
|
|
3386
|
+
* <code>Underprovisioned</code>
|
|
3387
|
+
* </b> —
|
|
3388
|
+
* When Compute Optimizer detects that there’s not enough memory or CPU, an ECS
|
|
3389
|
+
* service is considered under-provisioned. An under-provisioned ECS service might
|
|
3390
|
+
* result in poor application performance.</p>
|
|
3391
|
+
* </li>
|
|
3392
|
+
* <li>
|
|
3393
|
+
* <p>
|
|
3394
|
+
* <b>
|
|
3395
|
+
* <code>Overprovisioned</code>
|
|
3396
|
+
* </b> —
|
|
3397
|
+
* When Compute Optimizer detects that there’s excessive memory or CPU, an ECS
|
|
3398
|
+
* service is considered over-provisioned. An over-provisioned ECS service might
|
|
3399
|
+
* result in additional infrastructure costs. </p>
|
|
3400
|
+
* </li>
|
|
3401
|
+
* <li>
|
|
3402
|
+
* <p>
|
|
3403
|
+
* <b>
|
|
3404
|
+
* <code>Optimized</code>
|
|
3405
|
+
* </b> —
|
|
3406
|
+
* When both the CPU and memory of your ECS service meet the performance requirements
|
|
3407
|
+
* of your workload, the service is considered optimized.</p>
|
|
3408
|
+
* </li>
|
|
3409
|
+
* </ul>
|
|
3410
|
+
*/
|
|
3411
|
+
finding?: ECSServiceRecommendationFinding | string;
|
|
3412
|
+
/**
|
|
3413
|
+
* <p>
|
|
3414
|
+
* The reason for the finding classification of an ECS service.
|
|
3415
|
+
* </p>
|
|
3416
|
+
* <p>Finding reason codes for ECS services include:</p>
|
|
3417
|
+
* <ul>
|
|
3418
|
+
* <li>
|
|
3419
|
+
* <p>
|
|
3420
|
+
* <b>
|
|
3421
|
+
* <code>CPUUnderprovisioned</code>
|
|
3422
|
+
* </b> —
|
|
3423
|
+
* The ECS service CPU configuration can be sized up to enhance the performance of
|
|
3424
|
+
* your workload. This is identified by analyzing the <code>CPUUtilization</code> metric of the
|
|
3425
|
+
* current service during the look-back period.</p>
|
|
3426
|
+
* </li>
|
|
3427
|
+
* <li>
|
|
3428
|
+
* <p>
|
|
3429
|
+
* <b>
|
|
3430
|
+
* <code>CPUOverprovisioned</code>
|
|
3431
|
+
* </b> —
|
|
3432
|
+
* The ECS service CPU configuration can be sized down while still meeting the performance
|
|
3433
|
+
* requirements of your workload. This is identified by analyzing the <code>CPUUtilization</code>
|
|
3434
|
+
* metric of the current service during the look-back period. </p>
|
|
3435
|
+
* </li>
|
|
3436
|
+
* <li>
|
|
3437
|
+
* <p>
|
|
3438
|
+
* <b>
|
|
3439
|
+
* <code>MemoryUnderprovisioned</code>
|
|
3440
|
+
* </b> —
|
|
3441
|
+
* The ECS service memory configuration can be sized up to enhance the performance of
|
|
3442
|
+
* your workload. This is identified by analyzing the <code>MemoryUtilization</code> metric of the
|
|
3443
|
+
* current service during the look-back period.</p>
|
|
3444
|
+
* </li>
|
|
3445
|
+
* <li>
|
|
3446
|
+
* <p>
|
|
3447
|
+
* <b>
|
|
3448
|
+
* <code>MemoryOverprovisioned</code>
|
|
3449
|
+
* </b> —
|
|
3450
|
+
* The ECS service memory configuration can be sized down while still meeting the
|
|
3451
|
+
* performance requirements of your workload. This is identified by analyzing the
|
|
3452
|
+
* <code>MemoryUtilization</code> metric of the current service during the look-back period.</p>
|
|
3453
|
+
* </li>
|
|
3454
|
+
* </ul>
|
|
3455
|
+
*/
|
|
3456
|
+
findingReasonCodes?: (ECSServiceRecommendationFindingReasonCode | string)[];
|
|
3457
|
+
/**
|
|
3458
|
+
* <p>
|
|
3459
|
+
* An array of objects that describe the recommendation options for the ECS service.
|
|
3460
|
+
* </p>
|
|
3461
|
+
*/
|
|
3462
|
+
serviceRecommendationOptions?: ECSServiceRecommendationOption[];
|
|
3463
|
+
/**
|
|
3464
|
+
* <p>
|
|
3465
|
+
* The risk of the current ECS service not meeting the performance needs of its workloads.
|
|
3466
|
+
* The higher the risk, the more likely the current service can't meet the performance
|
|
3467
|
+
* requirements of its workload.
|
|
3468
|
+
* </p>
|
|
3469
|
+
*/
|
|
3470
|
+
currentPerformanceRisk?: CurrentPerformanceRisk | string;
|
|
3471
|
+
}
|
|
3472
|
+
export interface GetECSServiceRecommendationsResponse {
|
|
3473
|
+
/**
|
|
3474
|
+
* <p>
|
|
3475
|
+
* The token to advance to the next page of ECS service recommendations.
|
|
3476
|
+
* </p>
|
|
3477
|
+
*/
|
|
3478
|
+
nextToken?: string;
|
|
3479
|
+
/**
|
|
3480
|
+
* <p>
|
|
3481
|
+
* An array of objects that describe the ECS service recommendations.
|
|
3482
|
+
* </p>
|
|
3483
|
+
*/
|
|
3484
|
+
ecsServiceRecommendations?: ECSServiceRecommendation[];
|
|
3485
|
+
/**
|
|
3486
|
+
* <p>
|
|
3487
|
+
* An array of objects that describe errors of the request.
|
|
3488
|
+
* </p>
|
|
3489
|
+
*/
|
|
3490
|
+
errors?: GetRecommendationError[];
|
|
3491
|
+
}
|
|
3492
|
+
export interface GetEffectiveRecommendationPreferencesRequest {
|
|
3493
|
+
/**
|
|
3494
|
+
* <p>The Amazon Resource Name (ARN) of the resource for which to confirm effective
|
|
3495
|
+
* recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are
|
|
3496
|
+
* currently supported.</p>
|
|
3497
|
+
*/
|
|
3498
|
+
resourceArn: string | undefined;
|
|
3499
|
+
}
|
|
3500
|
+
export interface GetEffectiveRecommendationPreferencesResponse {
|
|
3501
|
+
/**
|
|
3502
|
+
* <p>The status of the enhanced infrastructure metrics recommendation preference. Considers
|
|
3503
|
+
* all applicable preferences that you might have set at the resource, account, and
|
|
3504
|
+
* organization level.</p>
|
|
3505
|
+
* <p>A status of <code>Active</code> confirms that the preference is applied in the latest
|
|
3506
|
+
* recommendation refresh, and a status of <code>Inactive</code> confirms that it's not yet
|
|
3507
|
+
* applied to recommendations.</p>
|
|
3508
|
+
* <p>To validate whether the preference is applied to your last generated set of
|
|
3509
|
+
* recommendations, review the <code>effectiveRecommendationPreferences</code> value in the
|
|
3510
|
+
* response of the <a>GetAutoScalingGroupRecommendations</a> and <a>GetEC2InstanceRecommendations</a> actions.</p>
|
|
3511
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Enhanced
|
|
3512
|
+
* infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
3513
|
+
* Guide</i>.</p>
|
|
3514
|
+
*/
|
|
3515
|
+
enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string;
|
|
3516
|
+
/**
|
|
3517
|
+
* <p>The provider of the external metrics recommendation preference. Considers all
|
|
3518
|
+
* applicable preferences that you might have set at the account and organization
|
|
3519
|
+
* level.</p>
|
|
3520
|
+
* <p>If the preference is applied in the latest recommendation refresh, an object with a
|
|
3521
|
+
* valid <code>source</code> value appears in the response. If the preference isn't applied
|
|
3522
|
+
* to the recommendations already, then this object doesn't appear in the response.</p>
|
|
3523
|
+
* <p>To validate whether the preference is applied to your last generated set of
|
|
3524
|
+
* recommendations, review the <code>effectiveRecommendationPreferences</code> value in the
|
|
3525
|
+
* response of the <a>GetEC2InstanceRecommendations</a> actions.</p>
|
|
3526
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/external-metrics-ingestion.html">Enhanced
|
|
3527
|
+
* infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
3528
|
+
* Guide</i>.</p>
|
|
3529
|
+
*/
|
|
3530
|
+
externalMetricsPreference?: ExternalMetricsPreference;
|
|
3531
|
+
}
|
|
3532
|
+
export interface GetEnrollmentStatusRequest {
|
|
3533
|
+
}
|
|
3534
|
+
export interface GetEnrollmentStatusResponse {
|
|
3535
|
+
/**
|
|
3536
|
+
* <p>The enrollment status of the account.</p>
|
|
3537
|
+
*/
|
|
3538
|
+
status?: Status | string;
|
|
3539
|
+
/**
|
|
3540
|
+
* <p>The reason for the enrollment status of the account.</p>
|
|
3541
|
+
* <p>For example, an account might show a status of <code>Pending</code> because member
|
|
3542
|
+
* accounts of an organization require more time to be enrolled in the service.</p>
|
|
3543
|
+
*/
|
|
3544
|
+
statusReason?: string;
|
|
3545
|
+
/**
|
|
3546
|
+
* <p>Confirms the enrollment status of member accounts of the organization, if the account
|
|
3547
|
+
* is a management account of an organization.</p>
|
|
3548
|
+
*/
|
|
3549
|
+
memberAccountsEnrolled?: boolean;
|
|
3550
|
+
/**
|
|
3551
|
+
* <p>The Unix epoch timestamp, in seconds, of when the account enrollment status was last
|
|
3552
|
+
* updated.</p>
|
|
3553
|
+
*/
|
|
3554
|
+
lastUpdatedTimestamp?: Date;
|
|
3555
|
+
/**
|
|
3556
|
+
* <p>The count of organization member accounts that are opted in to the service, if your
|
|
3557
|
+
* account is an organization management account.</p>
|
|
3558
|
+
*/
|
|
3559
|
+
numberOfMemberAccountsOptedIn?: number;
|
|
3560
|
+
}
|
|
3561
|
+
export declare enum EnrollmentFilterName {
|
|
3562
|
+
STATUS = "Status"
|
|
3563
|
+
}
|
|
3564
|
+
/**
|
|
3565
|
+
* <p>Describes a filter that returns a more specific list of account enrollment statuses.
|
|
3566
|
+
* Use this filter with the <a>GetEnrollmentStatusesForOrganization</a>
|
|
3567
|
+
* action.</p>
|
|
3568
|
+
*/
|
|
3569
|
+
export interface EnrollmentFilter {
|
|
3570
|
+
/**
|
|
3571
|
+
* <p>The name of the filter.</p>
|
|
3572
|
+
* <p>Specify <code>Status</code> to return accounts with a specific enrollment status (for
|
|
3573
|
+
* example, <code>Active</code>).</p>
|
|
3574
|
+
*/
|
|
3575
|
+
name?: EnrollmentFilterName | string;
|
|
3576
|
+
/**
|
|
3577
|
+
* <p>The value of the filter.</p>
|
|
3578
|
+
* <p>The valid values are <code>Active</code>, <code>Inactive</code>, <code>Pending</code>,
|
|
3579
|
+
* and <code>Failed</code>.</p>
|
|
3580
|
+
*/
|
|
3581
|
+
values?: string[];
|
|
3582
|
+
}
|
|
3583
|
+
export interface GetEnrollmentStatusesForOrganizationRequest {
|
|
3584
|
+
/**
|
|
3585
|
+
* <p>An array of objects to specify a filter that returns a more specific list of account
|
|
3586
|
+
* enrollment statuses.</p>
|
|
3587
|
+
*/
|
|
3588
|
+
filters?: EnrollmentFilter[];
|
|
3589
|
+
/**
|
|
3590
|
+
* <p>The token to advance to the next page of account enrollment statuses.</p>
|
|
3591
|
+
*/
|
|
3592
|
+
nextToken?: string;
|
|
3593
|
+
/**
|
|
3594
|
+
* <p>The maximum number of account enrollment statuses to return with a single request. You
|
|
3595
|
+
* can specify up to 100 statuses to return with each request.</p>
|
|
3596
|
+
* <p>To retrieve the remaining results, make another request with the returned
|
|
3597
|
+
* <code>nextToken</code> value.</p>
|
|
3598
|
+
*/
|
|
3599
|
+
maxResults?: number;
|
|
3600
|
+
}
|
|
3601
|
+
export interface GetEnrollmentStatusesForOrganizationResponse {
|
|
3602
|
+
/**
|
|
3603
|
+
* <p>An array of objects that describe the enrollment statuses of organization member
|
|
3604
|
+
* accounts.</p>
|
|
3605
|
+
*/
|
|
3606
|
+
accountEnrollmentStatuses?: AccountEnrollmentStatus[];
|
|
3607
|
+
/**
|
|
3608
|
+
* <p>The token to use to advance to the next page of account enrollment statuses.</p>
|
|
3609
|
+
* <p>This value is null when there are no more pages of account enrollment statuses to
|
|
3610
|
+
* return.</p>
|
|
3611
|
+
*/
|
|
3612
|
+
nextToken?: string;
|
|
3613
|
+
}
|
|
3614
|
+
export interface GetLambdaFunctionRecommendationsRequest {
|
|
3615
|
+
/**
|
|
3616
|
+
* <p>The Amazon Resource Name (ARN) of the functions for which to return
|
|
3617
|
+
* recommendations.</p>
|
|
3618
|
+
* <p>You can specify a qualified or unqualified ARN. If you specify an unqualified ARN
|
|
3619
|
+
* without a function version suffix, Compute Optimizer will return recommendations for the
|
|
3620
|
+
* latest (<code>$LATEST</code>) version of the function. If you specify a qualified ARN
|
|
3621
|
+
* with a version suffix, Compute Optimizer will return recommendations for the specified
|
|
3622
|
+
* function version. For more information about using function versions, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using">Using
|
|
3623
|
+
* versions</a> in the <i>Lambda Developer
|
|
3624
|
+
* Guide</i>.</p>
|
|
3625
|
+
*/
|
|
3626
|
+
functionArns?: string[];
|
|
3627
|
+
/**
|
|
3628
|
+
* <p>The ID of the Amazon Web Services account for which to return function
|
|
3629
|
+
* recommendations.</p>
|
|
3630
|
+
* <p>If your account is the management account of an organization, use this parameter to
|
|
3631
|
+
* specify the member account for which you want to return function recommendations.</p>
|
|
3632
|
+
* <p>Only one account ID can be specified per request.</p>
|
|
3633
|
+
*/
|
|
3634
|
+
accountIds?: string[];
|
|
3635
|
+
/**
|
|
3636
|
+
* <p>An array of objects to specify a filter that returns a more specific list of function
|
|
3637
|
+
* recommendations.</p>
|
|
3638
|
+
*/
|
|
3639
|
+
filters?: LambdaFunctionRecommendationFilter[];
|
|
3640
|
+
/**
|
|
3641
|
+
* <p>The token to advance to the next page of function recommendations.</p>
|
|
3642
|
+
*/
|
|
3643
|
+
nextToken?: string;
|
|
3644
|
+
/**
|
|
3645
|
+
* <p>The maximum number of function recommendations to return with a single request.</p>
|
|
3646
|
+
* <p>To retrieve the remaining results, make another request with the returned
|
|
2875
3647
|
* <code>nextToken</code> value.</p>
|
|
2876
3648
|
*/
|
|
2877
3649
|
maxResults?: number;
|
|
@@ -2919,7 +3691,7 @@ export interface LambdaFunctionMemoryProjectedMetric {
|
|
|
2919
3691
|
export interface LambdaFunctionMemoryRecommendationOption {
|
|
2920
3692
|
/**
|
|
2921
3693
|
* <p>The rank of the function recommendation option.</p>
|
|
2922
|
-
*
|
|
3694
|
+
* <p>The top recommendation option is ranked as <code>1</code>.</p>
|
|
2923
3695
|
*/
|
|
2924
3696
|
rank?: number;
|
|
2925
3697
|
/**
|
|
@@ -2952,15 +3724,15 @@ export declare enum LambdaFunctionMetricStatistic {
|
|
|
2952
3724
|
export interface LambdaFunctionUtilizationMetric {
|
|
2953
3725
|
/**
|
|
2954
3726
|
* <p>The name of the utilization metric.</p>
|
|
2955
|
-
*
|
|
2956
|
-
*
|
|
3727
|
+
* <p>The following utilization metrics are available:</p>
|
|
3728
|
+
* <ul>
|
|
2957
3729
|
* <li>
|
|
2958
|
-
*
|
|
3730
|
+
* <p>
|
|
2959
3731
|
* <code>Duration</code> - The amount of time that your function code spends
|
|
2960
3732
|
* processing an event.</p>
|
|
2961
3733
|
* </li>
|
|
2962
3734
|
* <li>
|
|
2963
|
-
*
|
|
3735
|
+
* <p>
|
|
2964
3736
|
* <code>Memory</code> - The amount of memory used per invocation.</p>
|
|
2965
3737
|
* </li>
|
|
2966
3738
|
* </ul>
|
|
@@ -2968,10 +3740,10 @@ export interface LambdaFunctionUtilizationMetric {
|
|
|
2968
3740
|
name?: LambdaFunctionMetricName | string;
|
|
2969
3741
|
/**
|
|
2970
3742
|
* <p>The statistic of the utilization metric.</p>
|
|
2971
|
-
*
|
|
3743
|
+
* <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs
|
|
2972
3744
|
* return utilization metrics using only the <code>Maximum</code> statistic, which is the
|
|
2973
3745
|
* highest value observed during the specified period.</p>
|
|
2974
|
-
*
|
|
3746
|
+
* <p>The Compute Optimizer console displays graphs for some utilization metrics using the
|
|
2975
3747
|
* <code>Average</code> statistic, which is the value of <code>Sum</code> /
|
|
2976
3748
|
* <code>SampleCount</code> during the specified period. For more information, see
|
|
2977
3749
|
* <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html">Viewing resource
|
|
@@ -3025,10 +3797,10 @@ export interface LambdaFunctionRecommendation {
|
|
|
3025
3797
|
lastRefreshTimestamp?: Date;
|
|
3026
3798
|
/**
|
|
3027
3799
|
* <p>The finding classification of the function.</p>
|
|
3028
|
-
*
|
|
3029
|
-
*
|
|
3800
|
+
* <p>Findings for functions include:</p>
|
|
3801
|
+
* <ul>
|
|
3030
3802
|
* <li>
|
|
3031
|
-
*
|
|
3803
|
+
* <p>
|
|
3032
3804
|
* <b>
|
|
3033
3805
|
* <code>Optimized</code>
|
|
3034
3806
|
* </b> — The function is
|
|
@@ -3037,7 +3809,7 @@ export interface LambdaFunctionRecommendation {
|
|
|
3037
3809
|
* finding reason codes.</p>
|
|
3038
3810
|
* </li>
|
|
3039
3811
|
* <li>
|
|
3040
|
-
*
|
|
3812
|
+
* <p>
|
|
3041
3813
|
* <b>
|
|
3042
3814
|
* <code>NotOptimized</code>
|
|
3043
3815
|
* </b> — The function is
|
|
@@ -3050,7 +3822,7 @@ export interface LambdaFunctionRecommendation {
|
|
|
3050
3822
|
* finding reason codes.</p>
|
|
3051
3823
|
* </li>
|
|
3052
3824
|
* <li>
|
|
3053
|
-
*
|
|
3825
|
+
* <p>
|
|
3054
3826
|
* <b>
|
|
3055
3827
|
* <code>Unavailable</code>
|
|
3056
3828
|
* </b> — Compute Optimizer
|
|
@@ -3059,26 +3831,26 @@ export interface LambdaFunctionRecommendation {
|
|
|
3059
3831
|
* not qualify for a recommendation. This finding classification can include the
|
|
3060
3832
|
* <code>InsufficientData</code> and <code>Inconclusive</code> finding reason
|
|
3061
3833
|
* codes.</p>
|
|
3062
|
-
*
|
|
3063
|
-
*
|
|
3834
|
+
* <note>
|
|
3835
|
+
* <p>Functions with a finding of unavailable are not returned unless you
|
|
3064
3836
|
* specify the <code>filter</code> parameter with a value of
|
|
3065
3837
|
* <code>Unavailable</code> in your
|
|
3066
3838
|
* <code>GetLambdaFunctionRecommendations</code> request.</p>
|
|
3067
|
-
*
|
|
3839
|
+
* </note>
|
|
3068
3840
|
* </li>
|
|
3069
3841
|
* </ul>
|
|
3070
3842
|
*/
|
|
3071
3843
|
finding?: LambdaFunctionRecommendationFinding | string;
|
|
3072
3844
|
/**
|
|
3073
3845
|
* <p>The reason for the finding classification of the function.</p>
|
|
3074
|
-
*
|
|
3846
|
+
* <note>
|
|
3075
3847
|
* <p>Functions that have a finding classification of <code>Optimized</code> don't have
|
|
3076
3848
|
* a finding reason code.</p>
|
|
3077
|
-
*
|
|
3078
|
-
*
|
|
3079
|
-
*
|
|
3849
|
+
* </note>
|
|
3850
|
+
* <p>Finding reason codes for functions include:</p>
|
|
3851
|
+
* <ul>
|
|
3080
3852
|
* <li>
|
|
3081
|
-
*
|
|
3853
|
+
* <p>
|
|
3082
3854
|
* <b>
|
|
3083
3855
|
* <code>MemoryOverprovisioned</code>
|
|
3084
3856
|
* </b> — The
|
|
@@ -3089,7 +3861,7 @@ export interface LambdaFunctionRecommendation {
|
|
|
3089
3861
|
* classification.</p>
|
|
3090
3862
|
* </li>
|
|
3091
3863
|
* <li>
|
|
3092
|
-
*
|
|
3864
|
+
* <p>
|
|
3093
3865
|
* <b>
|
|
3094
3866
|
* <code>MemoryUnderprovisioned</code>
|
|
3095
3867
|
* </b> — The
|
|
@@ -3099,7 +3871,7 @@ export interface LambdaFunctionRecommendation {
|
|
|
3099
3871
|
* <code>NotOptimized</code> finding classification.</p>
|
|
3100
3872
|
* </li>
|
|
3101
3873
|
* <li>
|
|
3102
|
-
*
|
|
3874
|
+
* <p>
|
|
3103
3875
|
* <b>
|
|
3104
3876
|
* <code>InsufficientData</code>
|
|
3105
3877
|
* </b> — The function
|
|
@@ -3110,7 +3882,7 @@ export interface LambdaFunctionRecommendation {
|
|
|
3110
3882
|
* <code>Unavailable</code> finding classification.</p>
|
|
3111
3883
|
* </li>
|
|
3112
3884
|
* <li>
|
|
3113
|
-
*
|
|
3885
|
+
* <p>
|
|
3114
3886
|
* <b>
|
|
3115
3887
|
* <code>Inconclusive</code>
|
|
3116
3888
|
* </b> — The function does
|
|
@@ -3136,7 +3908,7 @@ export interface LambdaFunctionRecommendation {
|
|
|
3136
3908
|
export interface GetLambdaFunctionRecommendationsResponse {
|
|
3137
3909
|
/**
|
|
3138
3910
|
* <p>The token to use to advance to the next page of function recommendations.</p>
|
|
3139
|
-
*
|
|
3911
|
+
* <p>This value is null when there are no more pages of function recommendations to
|
|
3140
3912
|
* return.</p>
|
|
3141
3913
|
*/
|
|
3142
3914
|
nextToken?: string;
|
|
@@ -3149,18 +3921,18 @@ export interface GetRecommendationPreferencesRequest {
|
|
|
3149
3921
|
/**
|
|
3150
3922
|
* <p>The target resource type of the recommendation preference for which to return
|
|
3151
3923
|
* preferences.</p>
|
|
3152
|
-
*
|
|
3924
|
+
* <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances
|
|
3153
3925
|
* that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option
|
|
3154
3926
|
* encompasses only instances that are part of an Auto Scaling group.</p>
|
|
3155
|
-
*
|
|
3927
|
+
* <note>
|
|
3156
3928
|
* <p>The valid values for this parameter are <code>Ec2Instance</code> and
|
|
3157
3929
|
* <code>AutoScalingGroup</code>.</p>
|
|
3158
|
-
*
|
|
3930
|
+
* </note>
|
|
3159
3931
|
*/
|
|
3160
3932
|
resourceType: ResourceType | string | undefined;
|
|
3161
3933
|
/**
|
|
3162
3934
|
* <p>An object that describes the scope of the recommendation preference to return.</p>
|
|
3163
|
-
*
|
|
3935
|
+
* <p>You can return recommendation preferences that are created at the organization level
|
|
3164
3936
|
* (for management accounts of an organization only), account level, and resource level.
|
|
3165
3937
|
* For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating
|
|
3166
3938
|
* enhanced infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
@@ -3174,7 +3946,7 @@ export interface GetRecommendationPreferencesRequest {
|
|
|
3174
3946
|
/**
|
|
3175
3947
|
* <p>The maximum number of recommendation preferences to return with a single
|
|
3176
3948
|
* request.</p>
|
|
3177
|
-
*
|
|
3949
|
+
* <p>To retrieve the remaining results, make another request with the returned
|
|
3178
3950
|
* <code>nextToken</code> value.</p>
|
|
3179
3951
|
*/
|
|
3180
3952
|
maxResults?: number;
|
|
@@ -3185,7 +3957,7 @@ export interface GetRecommendationPreferencesRequest {
|
|
|
3185
3957
|
export interface RecommendationPreferencesDetail {
|
|
3186
3958
|
/**
|
|
3187
3959
|
* <p>An object that describes the scope of the recommendation preference.</p>
|
|
3188
|
-
*
|
|
3960
|
+
* <p>Recommendation preferences can be created at the organization level (for management
|
|
3189
3961
|
* accounts of an organization only), account level, and resource level. For more
|
|
3190
3962
|
* information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating
|
|
3191
3963
|
* enhanced infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
@@ -3194,45 +3966,42 @@ export interface RecommendationPreferencesDetail {
|
|
|
3194
3966
|
scope?: Scope;
|
|
3195
3967
|
/**
|
|
3196
3968
|
* <p>The target resource type of the recommendation preference to create.</p>
|
|
3197
|
-
*
|
|
3969
|
+
* <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances
|
|
3198
3970
|
* that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option
|
|
3199
3971
|
* encompasses only instances that are part of an Auto Scaling group.</p>
|
|
3200
3972
|
*/
|
|
3201
3973
|
resourceType?: ResourceType | string;
|
|
3202
3974
|
/**
|
|
3203
3975
|
* <p>The status of the enhanced infrastructure metrics recommendation preference.</p>
|
|
3204
|
-
*
|
|
3205
|
-
* that the preference is applied to the recommendations, and a status of
|
|
3206
|
-
*
|
|
3207
|
-
*
|
|
3976
|
+
* <p>When the recommendations page is refreshed, a status of <code>Active</code> confirms
|
|
3977
|
+
* that the preference is applied to the recommendations, and a status of
|
|
3978
|
+
* <code>Inactive</code> confirms that the preference isn't yet applied to
|
|
3979
|
+
* recommendations.</p>
|
|
3980
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Enhanced
|
|
3208
3981
|
* infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
3209
3982
|
* Guide</i>.</p>
|
|
3210
3983
|
*/
|
|
3211
3984
|
enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string;
|
|
3212
3985
|
/**
|
|
3213
3986
|
* <p>The status of the inferred workload types recommendation preference.</p>
|
|
3214
|
-
*
|
|
3215
|
-
*
|
|
3216
|
-
*
|
|
3217
|
-
*
|
|
3987
|
+
* <p>When the recommendations page is refreshed, a status of <code>Active</code> confirms
|
|
3988
|
+
* that the preference is applied to the recommendations, and a status of
|
|
3989
|
+
* <code>Inactive</code> confirms that the preference isn't yet applied to
|
|
3990
|
+
* recommendations.</p>
|
|
3218
3991
|
*/
|
|
3219
3992
|
inferredWorkloadTypes?: InferredWorkloadTypesPreference | string;
|
|
3220
3993
|
/**
|
|
3221
|
-
* <p>
|
|
3222
|
-
*
|
|
3223
|
-
*
|
|
3224
|
-
*
|
|
3225
|
-
* If the preference is applied in the latest recommendation refresh, an object with a valid
|
|
3226
|
-
* <code>source</code> value appears in the response. If the preference isn't applied to the
|
|
3227
|
-
* recommendations already, then this object doesn't appear in the response.
|
|
3228
|
-
* </p>
|
|
3994
|
+
* <p> An object that describes the external metrics recommendation preference. </p>
|
|
3995
|
+
* <p> If the preference is applied in the latest recommendation refresh, an object with a
|
|
3996
|
+
* valid <code>source</code> value appears in the response. If the preference isn't applied
|
|
3997
|
+
* to the recommendations already, then this object doesn't appear in the response. </p>
|
|
3229
3998
|
*/
|
|
3230
3999
|
externalMetricsPreference?: ExternalMetricsPreference;
|
|
3231
4000
|
}
|
|
3232
4001
|
export interface GetRecommendationPreferencesResponse {
|
|
3233
4002
|
/**
|
|
3234
4003
|
* <p>The token to use to advance to the next page of recommendation preferences.</p>
|
|
3235
|
-
*
|
|
4004
|
+
* <p>This value is null when there are no more pages of recommendation preferences to
|
|
3236
4005
|
* return.</p>
|
|
3237
4006
|
*/
|
|
3238
4007
|
nextToken?: string;
|
|
@@ -3245,9 +4014,9 @@ export interface GetRecommendationSummariesRequest {
|
|
|
3245
4014
|
/**
|
|
3246
4015
|
* <p>The ID of the Amazon Web Services account for which to return recommendation
|
|
3247
4016
|
* summaries.</p>
|
|
3248
|
-
*
|
|
4017
|
+
* <p>If your account is the management account of an organization, use this parameter to
|
|
3249
4018
|
* specify the member account for which you want to return recommendation summaries.</p>
|
|
3250
|
-
*
|
|
4019
|
+
* <p>Only one account ID can be specified per request.</p>
|
|
3251
4020
|
*/
|
|
3252
4021
|
accountIds?: string[];
|
|
3253
4022
|
/**
|
|
@@ -3256,14 +4025,14 @@ export interface GetRecommendationSummariesRequest {
|
|
|
3256
4025
|
nextToken?: string;
|
|
3257
4026
|
/**
|
|
3258
4027
|
* <p>The maximum number of recommendation summaries to return with a single request.</p>
|
|
3259
|
-
*
|
|
4028
|
+
* <p>To retrieve the remaining results, make another request with the returned
|
|
3260
4029
|
* <code>nextToken</code> value.</p>
|
|
3261
4030
|
*/
|
|
3262
4031
|
maxResults?: number;
|
|
3263
4032
|
}
|
|
3264
4033
|
/**
|
|
3265
4034
|
* <p>Describes the performance risk ratings for a given resource type.</p>
|
|
3266
|
-
*
|
|
4035
|
+
* <p>Resources with a <code>high</code> or <code>medium</code> rating are at risk of not
|
|
3267
4036
|
* meeting the performance needs of their workloads, while resources with a
|
|
3268
4037
|
* <code>low</code> rating are performing well in their workloads.</p>
|
|
3269
4038
|
*/
|
|
@@ -3350,7 +4119,7 @@ export interface RecommendationSummary {
|
|
|
3350
4119
|
export interface GetRecommendationSummariesResponse {
|
|
3351
4120
|
/**
|
|
3352
4121
|
* <p>The token to use to advance to the next page of recommendation summaries.</p>
|
|
3353
|
-
*
|
|
4122
|
+
* <p>This value is null when there are no more pages of recommendation summaries to
|
|
3354
4123
|
* return.</p>
|
|
3355
4124
|
*/
|
|
3356
4125
|
nextToken?: string;
|
|
@@ -3362,23 +4131,23 @@ export interface GetRecommendationSummariesResponse {
|
|
|
3362
4131
|
export interface PutRecommendationPreferencesRequest {
|
|
3363
4132
|
/**
|
|
3364
4133
|
* <p>The target resource type of the recommendation preference to create.</p>
|
|
3365
|
-
*
|
|
4134
|
+
* <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances
|
|
3366
4135
|
* that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option
|
|
3367
4136
|
* encompasses only instances that are part of an Auto Scaling group.</p>
|
|
3368
|
-
*
|
|
4137
|
+
* <note>
|
|
3369
4138
|
* <p>The valid values for this parameter are <code>Ec2Instance</code> and
|
|
3370
4139
|
* <code>AutoScalingGroup</code>.</p>
|
|
3371
|
-
*
|
|
4140
|
+
* </note>
|
|
3372
4141
|
*/
|
|
3373
4142
|
resourceType: ResourceType | string | undefined;
|
|
3374
4143
|
/**
|
|
3375
4144
|
* <p>An object that describes the scope of the recommendation preference to create.</p>
|
|
3376
|
-
*
|
|
4145
|
+
* <p>You can create recommendation preferences at the organization level (for management
|
|
3377
4146
|
* accounts of an organization only), account level, and resource level. For more
|
|
3378
4147
|
* information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating
|
|
3379
4148
|
* enhanced infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
3380
4149
|
* Guide</i>.</p>
|
|
3381
|
-
*
|
|
4150
|
+
* <note>
|
|
3382
4151
|
* <p>You cannot create recommendation preferences for Auto Scaling groups at the
|
|
3383
4152
|
* organization and account levels. You can create recommendation preferences for
|
|
3384
4153
|
* Auto Scaling groups only at the resource level by specifying a scope name
|
|
@@ -3387,15 +4156,15 @@ export interface PutRecommendationPreferencesRequest {
|
|
|
3387
4156
|
* part of the specified Auto Scaling group. You also cannot create recommendation
|
|
3388
4157
|
* preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for
|
|
3389
4158
|
* standalone instances.</p>
|
|
3390
|
-
*
|
|
4159
|
+
* </note>
|
|
3391
4160
|
*/
|
|
3392
4161
|
scope?: Scope;
|
|
3393
4162
|
/**
|
|
3394
4163
|
* <p>The status of the enhanced infrastructure metrics recommendation preference to create
|
|
3395
4164
|
* or update.</p>
|
|
3396
|
-
*
|
|
4165
|
+
* <p>Specify the <code>Active</code> status to activate the preference, or specify
|
|
3397
4166
|
* <code>Inactive</code> to deactivate the preference.</p>
|
|
3398
|
-
*
|
|
4167
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Enhanced
|
|
3399
4168
|
* infrastructure metrics</a> in the <i>Compute Optimizer User
|
|
3400
4169
|
* Guide</i>.</p>
|
|
3401
4170
|
*/
|
|
@@ -3403,29 +4172,26 @@ export interface PutRecommendationPreferencesRequest {
|
|
|
3403
4172
|
/**
|
|
3404
4173
|
* <p>The status of the inferred workload types recommendation preference to create or
|
|
3405
4174
|
* update.</p>
|
|
3406
|
-
*
|
|
3407
|
-
* <note>
|
|
4175
|
+
* <note>
|
|
3408
4176
|
* <p>The inferred workload type feature is active by default. To deactivate it, create
|
|
3409
4177
|
* a recommendation preference.</p>
|
|
3410
|
-
*
|
|
3411
|
-
*
|
|
3412
|
-
* <p>Specify the <code>Inactive</code> status to deactivate the feature, or specify
|
|
4178
|
+
* </note>
|
|
4179
|
+
* <p>Specify the <code>Inactive</code> status to deactivate the feature, or specify
|
|
3413
4180
|
* <code>Active</code> to activate it.</p>
|
|
3414
|
-
*
|
|
3415
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/inferred-workload-types.html">Inferred workload
|
|
4181
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/inferred-workload-types.html">Inferred workload
|
|
3416
4182
|
* types</a> in the <i>Compute Optimizer User Guide</i>.</p>
|
|
3417
4183
|
*/
|
|
3418
4184
|
inferredWorkloadTypes?: InferredWorkloadTypesPreference | string;
|
|
3419
4185
|
/**
|
|
3420
4186
|
* <p>The provider of the external metrics recommendation preference to create or
|
|
3421
4187
|
* update.</p>
|
|
3422
|
-
*
|
|
4188
|
+
* <p>Specify a valid provider in the <code>source</code> field to activate the preference.
|
|
3423
4189
|
* To delete this preference, see the <a>DeleteRecommendationPreferences</a>
|
|
3424
4190
|
* action.</p>
|
|
3425
|
-
*
|
|
3426
|
-
*
|
|
3427
|
-
*
|
|
3428
|
-
*
|
|
4191
|
+
* <p>This preference can only be set for the <code>Ec2Instance</code> resource type.</p>
|
|
4192
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/external-metrics-ingestion.html">External metrics
|
|
4193
|
+
* ingestion</a> in the <i>Compute Optimizer User
|
|
4194
|
+
* Guide</i>.</p>
|
|
3429
4195
|
*/
|
|
3430
4196
|
externalMetricsPreference?: ExternalMetricsPreference;
|
|
3431
4197
|
}
|
|
@@ -3434,27 +4200,27 @@ export interface PutRecommendationPreferencesResponse {
|
|
|
3434
4200
|
export interface UpdateEnrollmentStatusRequest {
|
|
3435
4201
|
/**
|
|
3436
4202
|
* <p>The new enrollment status of the account.</p>
|
|
3437
|
-
*
|
|
3438
|
-
*
|
|
4203
|
+
* <p>The following status options are available:</p>
|
|
4204
|
+
* <ul>
|
|
3439
4205
|
* <li>
|
|
3440
|
-
*
|
|
4206
|
+
* <p>
|
|
3441
4207
|
* <code>Active</code> - Opts in your account to the Compute Optimizer service.
|
|
3442
4208
|
* Compute Optimizer begins analyzing the configuration and utilization metrics
|
|
3443
4209
|
* of your Amazon Web Services resources after you opt in. For more information, see
|
|
3444
4210
|
* <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html">Metrics analyzed by Compute Optimizer</a> in the <i>Compute Optimizer User Guide</i>.</p>
|
|
3445
4211
|
* </li>
|
|
3446
4212
|
* <li>
|
|
3447
|
-
*
|
|
4213
|
+
* <p>
|
|
3448
4214
|
* <code>Inactive</code> - Opts out your account from the Compute Optimizer
|
|
3449
4215
|
* service. Your account's recommendations and related metrics data will be deleted
|
|
3450
4216
|
* from Compute Optimizer after you opt out.</p>
|
|
3451
4217
|
* </li>
|
|
3452
4218
|
* </ul>
|
|
3453
|
-
*
|
|
4219
|
+
* <note>
|
|
3454
4220
|
* <p>The <code>Pending</code> and <code>Failed</code> options cannot be used to update
|
|
3455
4221
|
* the enrollment status of an account. They are returned in the response of a request
|
|
3456
4222
|
* to update the enrollment status of an account.</p>
|
|
3457
|
-
*
|
|
4223
|
+
* </note>
|
|
3458
4224
|
*/
|
|
3459
4225
|
status: Status | string | undefined;
|
|
3460
4226
|
/**
|
|
@@ -3587,6 +4353,18 @@ export declare const ExportEC2InstanceRecommendationsRequestFilterSensitiveLog:
|
|
|
3587
4353
|
* @internal
|
|
3588
4354
|
*/
|
|
3589
4355
|
export declare const ExportEC2InstanceRecommendationsResponseFilterSensitiveLog: (obj: ExportEC2InstanceRecommendationsResponse) => any;
|
|
4356
|
+
/**
|
|
4357
|
+
* @internal
|
|
4358
|
+
*/
|
|
4359
|
+
export declare const ECSServiceRecommendationFilterFilterSensitiveLog: (obj: ECSServiceRecommendationFilter) => any;
|
|
4360
|
+
/**
|
|
4361
|
+
* @internal
|
|
4362
|
+
*/
|
|
4363
|
+
export declare const ExportECSServiceRecommendationsRequestFilterSensitiveLog: (obj: ExportECSServiceRecommendationsRequest) => any;
|
|
4364
|
+
/**
|
|
4365
|
+
* @internal
|
|
4366
|
+
*/
|
|
4367
|
+
export declare const ExportECSServiceRecommendationsResponseFilterSensitiveLog: (obj: ExportECSServiceRecommendationsResponse) => any;
|
|
3590
4368
|
/**
|
|
3591
4369
|
* @internal
|
|
3592
4370
|
*/
|
|
@@ -3671,6 +4449,62 @@ export declare const RecommendedOptionProjectedMetricFilterSensitiveLog: (obj: R
|
|
|
3671
4449
|
* @internal
|
|
3672
4450
|
*/
|
|
3673
4451
|
export declare const GetEC2RecommendationProjectedMetricsResponseFilterSensitiveLog: (obj: GetEC2RecommendationProjectedMetricsResponse) => any;
|
|
4452
|
+
/**
|
|
4453
|
+
* @internal
|
|
4454
|
+
*/
|
|
4455
|
+
export declare const GetECSServiceRecommendationProjectedMetricsRequestFilterSensitiveLog: (obj: GetECSServiceRecommendationProjectedMetricsRequest) => any;
|
|
4456
|
+
/**
|
|
4457
|
+
* @internal
|
|
4458
|
+
*/
|
|
4459
|
+
export declare const ECSServiceProjectedMetricFilterSensitiveLog: (obj: ECSServiceProjectedMetric) => any;
|
|
4460
|
+
/**
|
|
4461
|
+
* @internal
|
|
4462
|
+
*/
|
|
4463
|
+
export declare const ECSServiceRecommendedOptionProjectedMetricFilterSensitiveLog: (obj: ECSServiceRecommendedOptionProjectedMetric) => any;
|
|
4464
|
+
/**
|
|
4465
|
+
* @internal
|
|
4466
|
+
*/
|
|
4467
|
+
export declare const GetECSServiceRecommendationProjectedMetricsResponseFilterSensitiveLog: (obj: GetECSServiceRecommendationProjectedMetricsResponse) => any;
|
|
4468
|
+
/**
|
|
4469
|
+
* @internal
|
|
4470
|
+
*/
|
|
4471
|
+
export declare const GetECSServiceRecommendationsRequestFilterSensitiveLog: (obj: GetECSServiceRecommendationsRequest) => any;
|
|
4472
|
+
/**
|
|
4473
|
+
* @internal
|
|
4474
|
+
*/
|
|
4475
|
+
export declare const MemorySizeConfigurationFilterSensitiveLog: (obj: MemorySizeConfiguration) => any;
|
|
4476
|
+
/**
|
|
4477
|
+
* @internal
|
|
4478
|
+
*/
|
|
4479
|
+
export declare const ContainerConfigurationFilterSensitiveLog: (obj: ContainerConfiguration) => any;
|
|
4480
|
+
/**
|
|
4481
|
+
* @internal
|
|
4482
|
+
*/
|
|
4483
|
+
export declare const ServiceConfigurationFilterSensitiveLog: (obj: ServiceConfiguration) => any;
|
|
4484
|
+
/**
|
|
4485
|
+
* @internal
|
|
4486
|
+
*/
|
|
4487
|
+
export declare const ContainerRecommendationFilterSensitiveLog: (obj: ContainerRecommendation) => any;
|
|
4488
|
+
/**
|
|
4489
|
+
* @internal
|
|
4490
|
+
*/
|
|
4491
|
+
export declare const ECSServiceProjectedUtilizationMetricFilterSensitiveLog: (obj: ECSServiceProjectedUtilizationMetric) => any;
|
|
4492
|
+
/**
|
|
4493
|
+
* @internal
|
|
4494
|
+
*/
|
|
4495
|
+
export declare const ECSServiceRecommendationOptionFilterSensitiveLog: (obj: ECSServiceRecommendationOption) => any;
|
|
4496
|
+
/**
|
|
4497
|
+
* @internal
|
|
4498
|
+
*/
|
|
4499
|
+
export declare const ECSServiceUtilizationMetricFilterSensitiveLog: (obj: ECSServiceUtilizationMetric) => any;
|
|
4500
|
+
/**
|
|
4501
|
+
* @internal
|
|
4502
|
+
*/
|
|
4503
|
+
export declare const ECSServiceRecommendationFilterSensitiveLog: (obj: ECSServiceRecommendation) => any;
|
|
4504
|
+
/**
|
|
4505
|
+
* @internal
|
|
4506
|
+
*/
|
|
4507
|
+
export declare const GetECSServiceRecommendationsResponseFilterSensitiveLog: (obj: GetECSServiceRecommendationsResponse) => any;
|
|
3674
4508
|
/**
|
|
3675
4509
|
* @internal
|
|
3676
4510
|
*/
|