computeoptimizer.d.ts
44.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class ComputeOptimizer extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ComputeOptimizer.Types.ClientConfiguration)
config: Config & ComputeOptimizer.Types.ClientConfiguration;
/**
* Describes recommendation export jobs created in the last seven days. Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.
*/
describeRecommendationExportJobs(params: ComputeOptimizer.Types.DescribeRecommendationExportJobsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.DescribeRecommendationExportJobsResponse) => void): Request<ComputeOptimizer.Types.DescribeRecommendationExportJobsResponse, AWSError>;
/**
* Describes recommendation export jobs created in the last seven days. Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.
*/
describeRecommendationExportJobs(callback?: (err: AWSError, data: ComputeOptimizer.Types.DescribeRecommendationExportJobsResponse) => void): Request<ComputeOptimizer.Types.DescribeRecommendationExportJobsResponse, AWSError>;
/**
* Exports optimization recommendations for Auto Scaling groups. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Auto Scaling group export job in progress per AWS Region.
*/
exportAutoScalingGroupRecommendations(params: ComputeOptimizer.Types.ExportAutoScalingGroupRecommendationsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.ExportAutoScalingGroupRecommendationsResponse) => void): Request<ComputeOptimizer.Types.ExportAutoScalingGroupRecommendationsResponse, AWSError>;
/**
* Exports optimization recommendations for Auto Scaling groups. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Auto Scaling group export job in progress per AWS Region.
*/
exportAutoScalingGroupRecommendations(callback?: (err: AWSError, data: ComputeOptimizer.Types.ExportAutoScalingGroupRecommendationsResponse) => void): Request<ComputeOptimizer.Types.ExportAutoScalingGroupRecommendationsResponse, AWSError>;
/**
* Exports optimization recommendations for Amazon EC2 instances. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Amazon EC2 instance export job in progress per AWS Region.
*/
exportEC2InstanceRecommendations(params: ComputeOptimizer.Types.ExportEC2InstanceRecommendationsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.ExportEC2InstanceRecommendationsResponse) => void): Request<ComputeOptimizer.Types.ExportEC2InstanceRecommendationsResponse, AWSError>;
/**
* Exports optimization recommendations for Amazon EC2 instances. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Amazon EC2 instance export job in progress per AWS Region.
*/
exportEC2InstanceRecommendations(callback?: (err: AWSError, data: ComputeOptimizer.Types.ExportEC2InstanceRecommendationsResponse) => void): Request<ComputeOptimizer.Types.ExportEC2InstanceRecommendationsResponse, AWSError>;
/**
* Returns Auto Scaling group recommendations. AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.
*/
getAutoScalingGroupRecommendations(params: ComputeOptimizer.Types.GetAutoScalingGroupRecommendationsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetAutoScalingGroupRecommendationsResponse) => void): Request<ComputeOptimizer.Types.GetAutoScalingGroupRecommendationsResponse, AWSError>;
/**
* Returns Auto Scaling group recommendations. AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.
*/
getAutoScalingGroupRecommendations(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetAutoScalingGroupRecommendationsResponse) => void): Request<ComputeOptimizer.Types.GetAutoScalingGroupRecommendationsResponse, AWSError>;
/**
* Returns Amazon EC2 instance recommendations. AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.
*/
getEC2InstanceRecommendations(params: ComputeOptimizer.Types.GetEC2InstanceRecommendationsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEC2InstanceRecommendationsResponse) => void): Request<ComputeOptimizer.Types.GetEC2InstanceRecommendationsResponse, AWSError>;
/**
* Returns Amazon EC2 instance recommendations. AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.
*/
getEC2InstanceRecommendations(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEC2InstanceRecommendationsResponse) => void): Request<ComputeOptimizer.Types.GetEC2InstanceRecommendationsResponse, AWSError>;
/**
* Returns the projected utilization metrics of Amazon EC2 instance recommendations. The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
*/
getEC2RecommendationProjectedMetrics(params: ComputeOptimizer.Types.GetEC2RecommendationProjectedMetricsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEC2RecommendationProjectedMetricsResponse) => void): Request<ComputeOptimizer.Types.GetEC2RecommendationProjectedMetricsResponse, AWSError>;
/**
* Returns the projected utilization metrics of Amazon EC2 instance recommendations. The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
*/
getEC2RecommendationProjectedMetrics(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEC2RecommendationProjectedMetricsResponse) => void): Request<ComputeOptimizer.Types.GetEC2RecommendationProjectedMetricsResponse, AWSError>;
/**
* Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service. If the account is the master account of an organization, this action also confirms the enrollment status of member accounts within the organization.
*/
getEnrollmentStatus(params: ComputeOptimizer.Types.GetEnrollmentStatusRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEnrollmentStatusResponse) => void): Request<ComputeOptimizer.Types.GetEnrollmentStatusResponse, AWSError>;
/**
* Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service. If the account is the master account of an organization, this action also confirms the enrollment status of member accounts within the organization.
*/
getEnrollmentStatus(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEnrollmentStatusResponse) => void): Request<ComputeOptimizer.Types.GetEnrollmentStatusResponse, AWSError>;
/**
* Returns the optimization findings for an account. For example, it returns the number of Amazon EC2 instances in an account that are under-provisioned, over-provisioned, or optimized. It also returns the number of Auto Scaling groups in an account that are not optimized, or optimized.
*/
getRecommendationSummaries(params: ComputeOptimizer.Types.GetRecommendationSummariesRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetRecommendationSummariesResponse) => void): Request<ComputeOptimizer.Types.GetRecommendationSummariesResponse, AWSError>;
/**
* Returns the optimization findings for an account. For example, it returns the number of Amazon EC2 instances in an account that are under-provisioned, over-provisioned, or optimized. It also returns the number of Auto Scaling groups in an account that are not optimized, or optimized.
*/
getRecommendationSummaries(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetRecommendationSummariesResponse) => void): Request<ComputeOptimizer.Types.GetRecommendationSummariesResponse, AWSError>;
/**
* Updates the enrollment (opt in) status of an account to the AWS Compute Optimizer service. If the account is a master account of an organization, this action can also be used to enroll member accounts within the organization.
*/
updateEnrollmentStatus(params: ComputeOptimizer.Types.UpdateEnrollmentStatusRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.UpdateEnrollmentStatusResponse) => void): Request<ComputeOptimizer.Types.UpdateEnrollmentStatusResponse, AWSError>;
/**
* Updates the enrollment (opt in) status of an account to the AWS Compute Optimizer service. If the account is a master account of an organization, this action can also be used to enroll member accounts within the organization.
*/
updateEnrollmentStatus(callback?: (err: AWSError, data: ComputeOptimizer.Types.UpdateEnrollmentStatusResponse) => void): Request<ComputeOptimizer.Types.UpdateEnrollmentStatusResponse, AWSError>;
}
declare namespace ComputeOptimizer {
export type AccountId = string;
export type AccountIds = AccountId[];
export type AutoScalingGroupArn = string;
export type AutoScalingGroupArns = AutoScalingGroupArn[];
export interface AutoScalingGroupConfiguration {
/**
* The desired capacity, or number of instances, for the Auto Scaling group.
*/
desiredCapacity?: DesiredCapacity;
/**
* The minimum size, or minimum number of instances, for the Auto Scaling group.
*/
minSize?: MinSize;
/**
* The maximum size, or maximum number of instances, for the Auto Scaling group.
*/
maxSize?: MaxSize;
/**
* The instance type for the Auto Scaling group.
*/
instanceType?: InstanceType;
}
export type AutoScalingGroupName = string;
export interface AutoScalingGroupRecommendation {
/**
* The AWS account ID of the Auto Scaling group.
*/
accountId?: AccountId;
/**
* The Amazon Resource Name (ARN) of the Auto Scaling group.
*/
autoScalingGroupArn?: AutoScalingGroupArn;
/**
* The name of the Auto Scaling group.
*/
autoScalingGroupName?: AutoScalingGroupName;
/**
* The finding classification for the Auto Scaling group. Findings for Auto Scaling groups include: NotOptimized —An Auto Scaling group is considered not optimized when AWS Compute Optimizer identifies a recommendation that can provide better performance for your workload. Optimized —An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type. The values that are returned might be NOT_OPTIMIZED or OPTIMIZED.
*/
finding?: Finding;
/**
* An array of objects that describe the utilization metrics of the Auto Scaling group.
*/
utilizationMetrics?: UtilizationMetrics;
/**
* The number of days for which utilization metrics were analyzed for the Auto Scaling group.
*/
lookBackPeriodInDays?: LookBackPeriodInDays;
/**
* An array of objects that describe the current configuration of the Auto Scaling group.
*/
currentConfiguration?: AutoScalingGroupConfiguration;
/**
* An array of objects that describe the recommendation options for the Auto Scaling group.
*/
recommendationOptions?: AutoScalingGroupRecommendationOptions;
/**
* The time stamp of when the Auto Scaling group recommendation was last refreshed.
*/
lastRefreshTimestamp?: LastRefreshTimestamp;
}
export interface AutoScalingGroupRecommendationOption {
/**
* An array of objects that describe an Auto Scaling group configuration.
*/
configuration?: AutoScalingGroupConfiguration;
/**
* An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option. The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
*/
projectedUtilizationMetrics?: ProjectedUtilizationMetrics;
/**
* The performance risk of the Auto Scaling group configuration recommendation. Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload. The lowest performance risk is categorized as 0, and the highest as 5.
*/
performanceRisk?: PerformanceRisk;
/**
* The rank of the Auto Scaling group recommendation option. The top recommendation option is ranked as 1.
*/
rank?: Rank;
}
export type AutoScalingGroupRecommendationOptions = AutoScalingGroupRecommendationOption[];
export type AutoScalingGroupRecommendations = AutoScalingGroupRecommendation[];
export type Code = string;
export type CreationTimestamp = Date;
export type CurrentInstanceType = string;
export interface DescribeRecommendationExportJobsRequest {
/**
* The identification numbers of the export jobs to return. An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions. All export jobs created in the last seven days are returned if this parameter is omitted.
*/
jobIds?: JobIds;
/**
* An array of objects that describe a filter to return a more specific list of export jobs.
*/
filters?: JobFilters;
/**
* The token to advance to the next page of export jobs.
*/
nextToken?: NextToken;
/**
* The maximum number of export jobs to return with a single request. To retrieve the remaining results, make another request with the returned NextToken value.
*/
maxResults?: MaxResults;
}
export interface DescribeRecommendationExportJobsResponse {
/**
* An array of objects that describe recommendation export jobs.
*/
recommendationExportJobs?: RecommendationExportJobs;
/**
* The token to use to advance to the next page of export jobs. This value is null when there are no more pages of export jobs to return.
*/
nextToken?: NextToken;
}
export type DesiredCapacity = number;
export type DestinationBucket = string;
export type DestinationKey = string;
export type DestinationKeyPrefix = string;
export interface ExportAutoScalingGroupRecommendationsRequest {
/**
* The IDs of the AWS accounts for which to export Auto Scaling group recommendations. If your account is the master account of an organization, use this parameter to specify the member accounts for which you want to export recommendations. This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive. Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted. You can specify multiple account IDs per request.
*/
accountIds?: AccountIds;
/**
* An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
*/
filters?: Filters;
/**
* The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
*/
fieldsToExport?: ExportableAutoScalingGroupFields;
/**
* An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job. You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide.
*/
s3DestinationConfig: S3DestinationConfig;
/**
* The format of the export file. The only export file format currently supported is Csv.
*/
fileFormat?: FileFormat;
/**
* Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization. The member accounts must also be opted in to Compute Optimizer. Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted. This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive. Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
*/
includeMemberAccounts?: IncludeMemberAccounts;
}
export interface ExportAutoScalingGroupRecommendationsResponse {
/**
* The identification number of the export job. Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
*/
jobId?: JobId;
/**
* An object that describes the destination Amazon S3 bucket of a recommendations export file.
*/
s3Destination?: S3Destination;
}
export interface ExportDestination {
/**
* An object that describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
*/
s3?: S3Destination;
}
export interface ExportEC2InstanceRecommendationsRequest {
/**
* The IDs of the AWS accounts for which to export instance recommendations. If your account is the master account of an organization, use this parameter to specify the member accounts for which you want to export recommendations. This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive. Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted. You can specify multiple account IDs per request.
*/
accountIds?: AccountIds;
/**
* An array of objects that describe a filter to export a more specific set of instance recommendations.
*/
filters?: Filters;
/**
* The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
*/
fieldsToExport?: ExportableInstanceFields;
/**
* An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job. You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide.
*/
s3DestinationConfig: S3DestinationConfig;
/**
* The format of the export file. The only export file format currently supported is Csv.
*/
fileFormat?: FileFormat;
/**
* Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization. The member accounts must also be opted in to Compute Optimizer. Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted. Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
*/
includeMemberAccounts?: IncludeMemberAccounts;
}
export interface ExportEC2InstanceRecommendationsResponse {
/**
* The identification number of the export job. Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
*/
jobId?: JobId;
/**
* An object that describes the destination Amazon S3 bucket of a recommendations export file.
*/
s3Destination?: S3Destination;
}
export type ExportableAutoScalingGroupField = "AccountId"|"AutoScalingGroupArn"|"AutoScalingGroupName"|"Finding"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"UtilizationMetricsEbsReadOpsPerSecondMaximum"|"UtilizationMetricsEbsWriteOpsPerSecondMaximum"|"UtilizationMetricsEbsReadBytesPerSecondMaximum"|"UtilizationMetricsEbsWriteBytesPerSecondMaximum"|"LookbackPeriodInDays"|"CurrentConfigurationInstanceType"|"CurrentConfigurationDesiredCapacity"|"CurrentConfigurationMinSize"|"CurrentConfigurationMaxSize"|"CurrentOnDemandPrice"|"CurrentStandardOneYearNoUpfrontReservedPrice"|"CurrentStandardThreeYearNoUpfrontReservedPrice"|"CurrentVCpus"|"CurrentMemory"|"CurrentStorage"|"CurrentNetwork"|"RecommendationOptionsConfigurationInstanceType"|"RecommendationOptionsConfigurationDesiredCapacity"|"RecommendationOptionsConfigurationMinSize"|"RecommendationOptionsConfigurationMaxSize"|"RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"|"RecommendationOptionsPerformanceRisk"|"RecommendationOptionsOnDemandPrice"|"RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"|"RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"|"RecommendationOptionsVcpus"|"RecommendationOptionsMemory"|"RecommendationOptionsStorage"|"RecommendationOptionsNetwork"|"LastRefreshTimestamp"|string;
export type ExportableAutoScalingGroupFields = ExportableAutoScalingGroupField[];
export type ExportableInstanceField = "AccountId"|"InstanceArn"|"InstanceName"|"Finding"|"LookbackPeriodInDays"|"CurrentInstanceType"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"UtilizationMetricsEbsReadOpsPerSecondMaximum"|"UtilizationMetricsEbsWriteOpsPerSecondMaximum"|"UtilizationMetricsEbsReadBytesPerSecondMaximum"|"UtilizationMetricsEbsWriteBytesPerSecondMaximum"|"CurrentOnDemandPrice"|"CurrentStandardOneYearNoUpfrontReservedPrice"|"CurrentStandardThreeYearNoUpfrontReservedPrice"|"CurrentVCpus"|"CurrentMemory"|"CurrentStorage"|"CurrentNetwork"|"RecommendationOptionsInstanceType"|"RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"|"RecommendationOptionsPerformanceRisk"|"RecommendationOptionsVcpus"|"RecommendationOptionsMemory"|"RecommendationOptionsStorage"|"RecommendationOptionsNetwork"|"RecommendationOptionsOnDemandPrice"|"RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"|"RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"|"RecommendationsSourcesRecommendationSourceArn"|"RecommendationsSourcesRecommendationSourceType"|"LastRefreshTimestamp"|string;
export type ExportableInstanceFields = ExportableInstanceField[];
export type FailureReason = string;
export type FileFormat = "Csv"|string;
export interface Filter {
/**
* The name of the filter. Specify Finding to return recommendations with a specific findings classification (e.g., Overprovisioned). Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup).
*/
name?: FilterName;
/**
* The value of the filter. If you specify the name parameter as Finding, and you request recommendations for an instance, then the valid values are Underprovisioned, Overprovisioned, NotOptimized, or Optimized. If you specify the name parameter as Finding, and you request recommendations for an Auto Scaling group, then the valid values are Optimized, or NotOptimized. If you specify the name parameter as RecommendationSourceType, then the valid values are Ec2Instance, or AutoScalingGroup.
*/
values?: FilterValues;
}
export type FilterName = "Finding"|"RecommendationSourceType"|string;
export type FilterValue = string;
export type FilterValues = FilterValue[];
export type Filters = Filter[];
export type Finding = "Underprovisioned"|"Overprovisioned"|"Optimized"|"NotOptimized"|string;
export interface GetAutoScalingGroupRecommendationsRequest {
/**
* The IDs of the AWS accounts for which to return Auto Scaling group recommendations. If your account is the master account of an organization, use this parameter to specify the member accounts for which you want to return Auto Scaling group recommendations. Only one account ID can be specified per request.
*/
accountIds?: AccountIds;
/**
* The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.
*/
autoScalingGroupArns?: AutoScalingGroupArns;
/**
* The token to advance to the next page of Auto Scaling group recommendations.
*/
nextToken?: NextToken;
/**
* The maximum number of Auto Scaling group recommendations to return with a single request. To retrieve the remaining results, make another request with the returned NextToken value.
*/
maxResults?: MaxResults;
/**
* An array of objects that describe a filter that returns a more specific list of Auto Scaling group recommendations.
*/
filters?: Filters;
}
export interface GetAutoScalingGroupRecommendationsResponse {
/**
* The token to use to advance to the next page of Auto Scaling group recommendations. This value is null when there are no more pages of Auto Scaling group recommendations to return.
*/
nextToken?: NextToken;
/**
* An array of objects that describe Auto Scaling group recommendations.
*/
autoScalingGroupRecommendations?: AutoScalingGroupRecommendations;
/**
* An array of objects that describe errors of the request. For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.
*/
errors?: GetRecommendationErrors;
}
export interface GetEC2InstanceRecommendationsRequest {
/**
* The Amazon Resource Name (ARN) of the instances for which to return recommendations.
*/
instanceArns?: InstanceArns;
/**
* The token to advance to the next page of instance recommendations.
*/
nextToken?: NextToken;
/**
* The maximum number of instance recommendations to return with a single request. To retrieve the remaining results, make another request with the returned NextToken value.
*/
maxResults?: MaxResults;
/**
* An array of objects that describe a filter that returns a more specific list of instance recommendations.
*/
filters?: Filters;
/**
* The IDs of the AWS accounts for which to return instance recommendations. If your account is the master account of an organization, use this parameter to specify the member accounts for which you want to return instance recommendations. Only one account ID can be specified per request.
*/
accountIds?: AccountIds;
}
export interface GetEC2InstanceRecommendationsResponse {
/**
* The token to use to advance to the next page of instance recommendations. This value is null when there are no more pages of instance recommendations to return.
*/
nextToken?: NextToken;
/**
* An array of objects that describe instance recommendations.
*/
instanceRecommendations?: InstanceRecommendations;
/**
* An array of objects that describe errors of the request. For example, an error is returned if you request recommendations for an instance of an unsupported instance family.
*/
errors?: GetRecommendationErrors;
}
export interface GetEC2RecommendationProjectedMetricsRequest {
/**
* The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.
*/
instanceArn: InstanceArn;
/**
* The statistic of the projected metrics.
*/
stat: MetricStatistic;
/**
* The granularity, in seconds, of the projected metrics data points.
*/
period: Period;
/**
* The time stamp of the first projected metrics data point to return.
*/
startTime: Timestamp;
/**
* The time stamp of the last projected metrics data point to return.
*/
endTime: Timestamp;
}
export interface GetEC2RecommendationProjectedMetricsResponse {
/**
* An array of objects that describe a projected metrics.
*/
recommendedOptionProjectedMetrics?: RecommendedOptionProjectedMetrics;
}
export interface GetEnrollmentStatusRequest {
}
export interface GetEnrollmentStatusResponse {
/**
* The enrollment status of the account.
*/
status?: Status;
/**
* The reason for the enrollment status of the account. For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.
*/
statusReason?: StatusReason;
/**
* Confirms the enrollment status of member accounts within the organization, if the account is a master account of an organization.
*/
memberAccountsEnrolled?: MemberAccountsEnrolled;
}
export interface GetRecommendationError {
/**
* The ID of the error.
*/
identifier?: Identifier;
/**
* The error code.
*/
code?: Code;
/**
* The message, or reason, for the error.
*/
message?: Message;
}
export type GetRecommendationErrors = GetRecommendationError[];
export interface GetRecommendationSummariesRequest {
/**
* The IDs of the AWS accounts for which to return recommendation summaries. If your account is the master account of an organization, use this parameter to specify the member accounts for which you want to return recommendation summaries. Only one account ID can be specified per request.
*/
accountIds?: AccountIds;
/**
* The token to advance to the next page of recommendation summaries.
*/
nextToken?: NextToken;
/**
* The maximum number of recommendation summaries to return with a single request. To retrieve the remaining results, make another request with the returned NextToken value.
*/
maxResults?: MaxResults;
}
export interface GetRecommendationSummariesResponse {
/**
* The token to use to advance to the next page of recommendation summaries. This value is null when there are no more pages of recommendation summaries to return.
*/
nextToken?: NextToken;
/**
* An array of objects that summarize a recommendation.
*/
recommendationSummaries?: RecommendationSummaries;
}
export type Identifier = string;
export type IncludeMemberAccounts = boolean;
export type InstanceArn = string;
export type InstanceArns = InstanceArn[];
export type InstanceName = string;
export interface InstanceRecommendation {
/**
* The Amazon Resource Name (ARN) of the current instance.
*/
instanceArn?: InstanceArn;
/**
* The AWS account ID of the instance.
*/
accountId?: AccountId;
/**
* The name of the current instance.
*/
instanceName?: InstanceName;
/**
* The instance type of the current instance.
*/
currentInstanceType?: CurrentInstanceType;
/**
* The finding classification for the instance. Findings for instances include: Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance. Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost. Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type. The values that are returned might be UNDER_PROVISIONED, OVER_PROVISIONED, or OPTIMIZED.
*/
finding?: Finding;
/**
* An array of objects that describe the utilization metrics of the instance.
*/
utilizationMetrics?: UtilizationMetrics;
/**
* The number of days for which utilization metrics were analyzed for the instance.
*/
lookBackPeriodInDays?: LookBackPeriodInDays;
/**
* An array of objects that describe the recommendation options for the instance.
*/
recommendationOptions?: RecommendationOptions;
/**
* An array of objects that describe the source resource of the recommendation.
*/
recommendationSources?: RecommendationSources;
/**
* The time stamp of when the instance recommendation was last refreshed.
*/
lastRefreshTimestamp?: LastRefreshTimestamp;
}
export interface InstanceRecommendationOption {
/**
* The instance type of the instance recommendation.
*/
instanceType?: InstanceType;
/**
* An array of objects that describe the projected utilization metrics of the instance recommendation option. The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
*/
projectedUtilizationMetrics?: ProjectedUtilizationMetrics;
/**
* The performance risk of the instance recommendation option. Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload. The lowest performance risk is categorized as 0, and the highest as 5.
*/
performanceRisk?: PerformanceRisk;
/**
* The rank of the instance recommendation option. The top recommendation option is ranked as 1.
*/
rank?: Rank;
}
export type InstanceRecommendations = InstanceRecommendation[];
export type InstanceType = string;
export interface JobFilter {
/**
* The name of the filter. Specify ResourceType to return export jobs of a specific resource type (e.g., Ec2Instance). Specify JobStatus to return export jobs with a specific status (e.g, Complete).
*/
name?: JobFilterName;
/**
* The value of the filter. If you specify the name parameter as ResourceType, the valid values are Ec2Instance or AutoScalingGroup. If you specify the name parameter as JobStatus, the valid values are Queued, InProgress, Complete, or Failed.
*/
values?: FilterValues;
}
export type JobFilterName = "ResourceType"|"JobStatus"|string;
export type JobFilters = JobFilter[];
export type JobId = string;
export type JobIds = JobId[];
export type JobStatus = "Queued"|"InProgress"|"Complete"|"Failed"|string;
export type LastRefreshTimestamp = Date;
export type LastUpdatedTimestamp = Date;
export type LookBackPeriodInDays = number;
export type MaxResults = number;
export type MaxSize = number;
export type MemberAccountsEnrolled = boolean;
export type Message = string;
export type MetadataKey = string;
export type MetricName = "Cpu"|"Memory"|"EBS_READ_OPS_PER_SECOND"|"EBS_WRITE_OPS_PER_SECOND"|"EBS_READ_BYTES_PER_SECOND"|"EBS_WRITE_BYTES_PER_SECOND"|string;
export type MetricStatistic = "Maximum"|"Average"|string;
export type MetricValue = number;
export type MetricValues = MetricValue[];
export type MinSize = number;
export type NextToken = string;
export type PerformanceRisk = number;
export type Period = number;
export interface ProjectedMetric {
/**
* The name of the projected utilization metric.
*/
name?: MetricName;
/**
* The time stamps of the projected utilization metric.
*/
timestamps?: Timestamps;
/**
* The values of the projected utilization metrics.
*/
values?: MetricValues;
}
export type ProjectedMetrics = ProjectedMetric[];
export type ProjectedUtilizationMetrics = UtilizationMetric[];
export type Rank = number;
export interface RecommendationExportJob {
/**
* The identification number of the export job.
*/
jobId?: JobId;
/**
* An object that describes the destination of the export file.
*/
destination?: ExportDestination;
/**
* The resource type of the exported recommendations.
*/
resourceType?: ResourceType;
/**
* The status of the export job.
*/
status?: JobStatus;
/**
* The timestamp of when the export job was created.
*/
creationTimestamp?: CreationTimestamp;
/**
* The timestamp of when the export job was last updated.
*/
lastUpdatedTimestamp?: LastUpdatedTimestamp;
/**
* The reason for an export job failure.
*/
failureReason?: FailureReason;
}
export type RecommendationExportJobs = RecommendationExportJob[];
export type RecommendationOptions = InstanceRecommendationOption[];
export interface RecommendationSource {
/**
* The Amazon Resource Name (ARN) of the recommendation source.
*/
recommendationSourceArn?: RecommendationSourceArn;
/**
* The resource type of the recommendation source.
*/
recommendationSourceType?: RecommendationSourceType;
}
export type RecommendationSourceArn = string;
export type RecommendationSourceType = "Ec2Instance"|"AutoScalingGroup"|string;
export type RecommendationSources = RecommendationSource[];
export type RecommendationSummaries = RecommendationSummary[];
export interface RecommendationSummary {
/**
* An array of objects that describe a recommendation summary.
*/
summaries?: Summaries;
/**
* The resource type of the recommendation.
*/
recommendationResourceType?: RecommendationSourceType;
/**
* The AWS account ID of the recommendation summary.
*/
accountId?: AccountId;
}
export type RecommendedInstanceType = string;
export interface RecommendedOptionProjectedMetric {
/**
* The recommended instance type.
*/
recommendedInstanceType?: RecommendedInstanceType;
/**
* The rank of the recommendation option projected metric. The top recommendation option is ranked as 1. The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as 1 is related to the recommendation option that is also ranked as 1 in the same response.
*/
rank?: Rank;
/**
* An array of objects that describe a projected utilization metric.
*/
projectedMetrics?: ProjectedMetrics;
}
export type RecommendedOptionProjectedMetrics = RecommendedOptionProjectedMetric[];
export type ResourceType = "Ec2Instance"|"AutoScalingGroup"|string;
export interface S3Destination {
/**
* The name of the Amazon S3 bucket used as the destination of an export file.
*/
bucket?: DestinationBucket;
/**
* The Amazon S3 bucket key of an export file. The key uniquely identifies the object, or export file, in the S3 bucket.
*/
key?: DestinationKey;
/**
* The Amazon S3 bucket key of a metadata file. The key uniquely identifies the object, or metadata file, in the S3 bucket.
*/
metadataKey?: MetadataKey;
}
export interface S3DestinationConfig {
/**
* The name of the Amazon S3 bucket to use as the destination for an export job.
*/
bucket?: DestinationBucket;
/**
* The Amazon S3 bucket prefix for an export job.
*/
keyPrefix?: DestinationKeyPrefix;
}
export type Status = "Active"|"Inactive"|"Pending"|"Failed"|string;
export type StatusReason = string;
export type Summaries = Summary[];
export interface Summary {
/**
* The finding classification of the recommendation.
*/
name?: Finding;
/**
* The value of the recommendation summary.
*/
value?: SummaryValue;
}
export type SummaryValue = number;
export type Timestamp = Date;
export type Timestamps = Timestamp[];
export interface UpdateEnrollmentStatusRequest {
/**
* The new enrollment status of the account. Accepted options are Active or Inactive. You will get an error if Pending or Failed are specified.
*/
status: Status;
/**
* Indicates whether to enroll member accounts of the organization if the your account is the master account of an organization.
*/
includeMemberAccounts?: IncludeMemberAccounts;
}
export interface UpdateEnrollmentStatusResponse {
/**
* The enrollment status of the account.
*/
status?: Status;
/**
* The reason for the enrollment status of the account. For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.
*/
statusReason?: StatusReason;
}
export interface UtilizationMetric {
/**
* The name of the utilization metric. The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
*/
name?: MetricName;
/**
* The statistic of the utilization metric.
*/
statistic?: MetricStatistic;
/**
* The value of the utilization metric.
*/
value?: MetricValue;
}
export type UtilizationMetrics = UtilizationMetric[];
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2019-11-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ComputeOptimizer client.
*/
export import Types = ComputeOptimizer;
}
export = ComputeOptimizer;