@aws-sdk/client-compute-optimizer 3.696.0 → 3.699.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.
Files changed (31) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/index.js +255 -2
  3. package/dist-es/ComputeOptimizer.js +4 -0
  4. package/dist-es/commands/ExportIdleRecommendationsCommand.js +22 -0
  5. package/dist-es/commands/GetIdleRecommendationsCommand.js +22 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/models_0.js +87 -0
  8. package/dist-es/protocols/Aws_json1_0.js +122 -0
  9. package/dist-types/ComputeOptimizer.d.ts +15 -0
  10. package/dist-types/ComputeOptimizerClient.d.ts +4 -2
  11. package/dist-types/commands/DeleteRecommendationPreferencesCommand.d.ts +1 -1
  12. package/dist-types/commands/DescribeRecommendationExportJobsCommand.d.ts +1 -1
  13. package/dist-types/commands/ExportIdleRecommendationsCommand.d.ts +127 -0
  14. package/dist-types/commands/ExportRDSDatabaseRecommendationsCommand.d.ts +1 -1
  15. package/dist-types/commands/GetIdleRecommendationsCommand.d.ts +166 -0
  16. package/dist-types/commands/GetRDSDatabaseRecommendationProjectedMetricsCommand.d.ts +1 -1
  17. package/dist-types/commands/GetRDSDatabaseRecommendationsCommand.d.ts +6 -3
  18. package/dist-types/commands/GetRecommendationPreferencesCommand.d.ts +2 -2
  19. package/dist-types/commands/GetRecommendationSummariesCommand.d.ts +20 -0
  20. package/dist-types/commands/PutRecommendationPreferencesCommand.d.ts +1 -1
  21. package/dist-types/commands/index.d.ts +2 -0
  22. package/dist-types/models/models_0.d.ts +623 -4
  23. package/dist-types/protocols/Aws_json1_0.d.ts +18 -0
  24. package/dist-types/ts3.4/ComputeOptimizer.d.ts +35 -0
  25. package/dist-types/ts3.4/ComputeOptimizerClient.d.ts +12 -0
  26. package/dist-types/ts3.4/commands/ExportIdleRecommendationsCommand.d.ts +51 -0
  27. package/dist-types/ts3.4/commands/GetIdleRecommendationsCommand.d.ts +51 -0
  28. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  29. package/dist-types/ts3.4/models/models_0.d.ts +184 -0
  30. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +24 -0
  31. package/package.json +4 -4
@@ -0,0 +1,166 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ComputeOptimizerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComputeOptimizerClient";
4
+ import { GetIdleRecommendationsRequest, GetIdleRecommendationsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetIdleRecommendationsCommand}.
14
+ */
15
+ export interface GetIdleRecommendationsCommandInput extends GetIdleRecommendationsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetIdleRecommendationsCommand}.
21
+ */
22
+ export interface GetIdleRecommendationsCommandOutput extends GetIdleRecommendationsResponse, __MetadataBearer {
23
+ }
24
+ declare const GetIdleRecommendationsCommand_base: {
25
+ new (input: GetIdleRecommendationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetIdleRecommendationsCommandInput, GetIdleRecommendationsCommandOutput, ComputeOptimizerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [GetIdleRecommendationsCommandInput]): import("@smithy/smithy-client").CommandImpl<GetIdleRecommendationsCommandInput, GetIdleRecommendationsCommandOutput, ComputeOptimizerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns idle resource recommendations. Compute Optimizer generates recommendations for
31
+ * idle resources that meet a specific set of requirements. For more information, see
32
+ * <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html">Resource requirements</a> in the
33
+ * <i>Compute Optimizer User Guide</i>
34
+ * </p>
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { ComputeOptimizerClient, GetIdleRecommendationsCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import
39
+ * // const { ComputeOptimizerClient, GetIdleRecommendationsCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import
40
+ * const client = new ComputeOptimizerClient(config);
41
+ * const input = { // GetIdleRecommendationsRequest
42
+ * resourceArns: [ // ResourceArns
43
+ * "STRING_VALUE",
44
+ * ],
45
+ * nextToken: "STRING_VALUE",
46
+ * maxResults: Number("int"),
47
+ * filters: [ // IdleRecommendationFilters
48
+ * { // IdleRecommendationFilter
49
+ * name: "Finding" || "ResourceType",
50
+ * values: [ // FilterValues
51
+ * "STRING_VALUE",
52
+ * ],
53
+ * },
54
+ * ],
55
+ * accountIds: [ // AccountIds
56
+ * "STRING_VALUE",
57
+ * ],
58
+ * orderBy: { // OrderBy
59
+ * dimension: "SavingsValue" || "SavingsValueAfterDiscount",
60
+ * order: "Asc" || "Desc",
61
+ * },
62
+ * };
63
+ * const command = new GetIdleRecommendationsCommand(input);
64
+ * const response = await client.send(command);
65
+ * // { // GetIdleRecommendationsResponse
66
+ * // nextToken: "STRING_VALUE",
67
+ * // idleRecommendations: [ // IdleRecommendations
68
+ * // { // IdleRecommendation
69
+ * // resourceArn: "STRING_VALUE",
70
+ * // resourceId: "STRING_VALUE",
71
+ * // resourceType: "EC2Instance" || "AutoScalingGroup" || "EBSVolume" || "ECSService" || "RDSDBInstance",
72
+ * // accountId: "STRING_VALUE",
73
+ * // finding: "Idle" || "Unattached",
74
+ * // findingDescription: "STRING_VALUE",
75
+ * // savingsOpportunity: { // IdleSavingsOpportunity
76
+ * // savingsOpportunityPercentage: Number("double"),
77
+ * // estimatedMonthlySavings: { // IdleEstimatedMonthlySavings
78
+ * // currency: "USD" || "CNY",
79
+ * // value: Number("double"),
80
+ * // },
81
+ * // },
82
+ * // savingsOpportunityAfterDiscounts: { // IdleSavingsOpportunityAfterDiscounts
83
+ * // savingsOpportunityPercentage: Number("double"),
84
+ * // estimatedMonthlySavings: {
85
+ * // currency: "USD" || "CNY",
86
+ * // value: Number("double"),
87
+ * // },
88
+ * // },
89
+ * // utilizationMetrics: [ // IdleUtilizationMetrics
90
+ * // { // IdleUtilizationMetric
91
+ * // name: "CPU" || "Memory" || "NetworkOutBytesPerSecond" || "NetworkInBytesPerSecond" || "DatabaseConnections" || "EBSVolumeReadIOPS" || "EBSVolumeWriteIOPS" || "VolumeReadOpsPerSecond" || "VolumeWriteOpsPerSecond",
92
+ * // statistic: "Maximum" || "Average",
93
+ * // value: Number("double"),
94
+ * // },
95
+ * // ],
96
+ * // lookBackPeriodInDays: Number("double"),
97
+ * // lastRefreshTimestamp: new Date("TIMESTAMP"),
98
+ * // tags: [ // Tags
99
+ * // { // Tag
100
+ * // key: "STRING_VALUE",
101
+ * // value: "STRING_VALUE",
102
+ * // },
103
+ * // ],
104
+ * // },
105
+ * // ],
106
+ * // errors: [ // IdleRecommendationErrors
107
+ * // { // IdleRecommendationError
108
+ * // identifier: "STRING_VALUE",
109
+ * // code: "STRING_VALUE",
110
+ * // message: "STRING_VALUE",
111
+ * // resourceType: "EC2Instance" || "AutoScalingGroup" || "EBSVolume" || "ECSService" || "RDSDBInstance",
112
+ * // },
113
+ * // ],
114
+ * // };
115
+ *
116
+ * ```
117
+ *
118
+ * @param GetIdleRecommendationsCommandInput - {@link GetIdleRecommendationsCommandInput}
119
+ * @returns {@link GetIdleRecommendationsCommandOutput}
120
+ * @see {@link GetIdleRecommendationsCommandInput} for command's `input` shape.
121
+ * @see {@link GetIdleRecommendationsCommandOutput} for command's `response` shape.
122
+ * @see {@link ComputeOptimizerClientResolvedConfig | config} for ComputeOptimizerClient's `config` shape.
123
+ *
124
+ * @throws {@link AccessDeniedException} (client fault)
125
+ * <p>You do not have sufficient access to perform this action.</p>
126
+ *
127
+ * @throws {@link InternalServerException} (server fault)
128
+ * <p>An internal error has occurred. Try your call again.</p>
129
+ *
130
+ * @throws {@link InvalidParameterValueException} (client fault)
131
+ * <p>The value supplied for the input parameter is out of range or not valid.</p>
132
+ *
133
+ * @throws {@link MissingAuthenticationToken} (client fault)
134
+ * <p>The request must contain either a valid (registered) Amazon Web Services access key ID
135
+ * or X.509 certificate.</p>
136
+ *
137
+ * @throws {@link OptInRequiredException} (client fault)
138
+ * <p>The account is not opted in to Compute Optimizer.</p>
139
+ *
140
+ * @throws {@link ResourceNotFoundException} (client fault)
141
+ * <p>A resource that is required for the action doesn't exist.</p>
142
+ *
143
+ * @throws {@link ServiceUnavailableException} (server fault)
144
+ * <p>The request has failed due to a temporary failure of the server.</p>
145
+ *
146
+ * @throws {@link ThrottlingException} (client fault)
147
+ * <p>The request was denied due to request throttling.</p>
148
+ *
149
+ * @throws {@link ComputeOptimizerServiceException}
150
+ * <p>Base exception class for all service exceptions from ComputeOptimizer service.</p>
151
+ *
152
+ * @public
153
+ */
154
+ export declare class GetIdleRecommendationsCommand extends GetIdleRecommendationsCommand_base {
155
+ /** @internal type navigation helper, not in runtime. */
156
+ protected static __types: {
157
+ api: {
158
+ input: GetIdleRecommendationsRequest;
159
+ output: GetIdleRecommendationsResponse;
160
+ };
161
+ sdk: {
162
+ input: GetIdleRecommendationsCommandInput;
163
+ output: GetIdleRecommendationsCommandOutput;
164
+ };
165
+ };
166
+ }
@@ -57,7 +57,7 @@ declare const GetRDSDatabaseRecommendationProjectedMetricsCommand_base: {
57
57
  * // rank: Number("int"),
58
58
  * // projectedMetrics: [ // RDSDatabaseProjectedMetrics
59
59
  * // { // RDSDatabaseProjectedMetric
60
- * // name: "CPU" || "Memory" || "EBSVolumeStorageSpaceUtilization" || "NetworkReceiveThroughput" || "NetworkTransmitThroughput" || "EBSVolumeReadIOPS" || "EBSVolumeWriteIOPS" || "EBSVolumeReadThroughput" || "EBSVolumeWriteThroughput" || "DatabaseConnections",
60
+ * // name: "CPU" || "Memory" || "EBSVolumeStorageSpaceUtilization" || "NetworkReceiveThroughput" || "NetworkTransmitThroughput" || "EBSVolumeReadIOPS" || "EBSVolumeWriteIOPS" || "EBSVolumeReadThroughput" || "EBSVolumeWriteThroughput" || "DatabaseConnections" || "StorageNetworkReceiveThroughput" || "StorageNetworkTransmitThroughput" || "AuroraMemoryHealthState" || "AuroraMemoryNumDeclinedSql" || "AuroraMemoryNumKillConnTotal" || "AuroraMemoryNumKillQueryTotal" || "ReadIOPSEphemeralStorage" || "WriteIOPSEphemeralStorage",
61
61
  * // timestamps: [ // Timestamps
62
62
  * // new Date("TIMESTAMP"),
63
63
  * // ],
@@ -74,6 +74,7 @@ declare const GetRDSDatabaseRecommendationsCommand_base: {
74
74
  * // accountId: "STRING_VALUE",
75
75
  * // engine: "STRING_VALUE",
76
76
  * // engineVersion: "STRING_VALUE",
77
+ * // promotionTier: Number("int"),
77
78
  * // currentDBInstanceClass: "STRING_VALUE",
78
79
  * // currentStorageConfiguration: { // DBStorageConfiguration
79
80
  * // storageType: "STRING_VALUE",
@@ -82,12 +83,14 @@ declare const GetRDSDatabaseRecommendationsCommand_base: {
82
83
  * // maxAllocatedStorage: Number("int"),
83
84
  * // storageThroughput: Number("int"),
84
85
  * // },
86
+ * // dbClusterIdentifier: "STRING_VALUE",
85
87
  * // idle: "True" || "False",
86
88
  * // instanceFinding: "Optimized" || "Underprovisioned" || "Overprovisioned",
87
89
  * // storageFinding: "Optimized" || "Underprovisioned" || "Overprovisioned",
88
90
  * // instanceFindingReasonCodes: [ // RDSInstanceFindingReasonCodes
89
- * // "CPUOverprovisioned" || "NetworkBandwidthOverprovisioned" || "EBSIOPSOverprovisioned" || "EBSThroughputOverprovisioned" || "CPUUnderprovisioned" || "NetworkBandwidthUnderprovisioned" || "EBSThroughputUnderprovisioned" || "NewGenerationDBInstanceClassAvailable" || "NewEngineVersionAvailable",
91
+ * // "CPUOverprovisioned" || "NetworkBandwidthOverprovisioned" || "EBSIOPSOverprovisioned" || "EBSIOPSUnderprovisioned" || "EBSThroughputOverprovisioned" || "CPUUnderprovisioned" || "NetworkBandwidthUnderprovisioned" || "EBSThroughputUnderprovisioned" || "NewGenerationDBInstanceClassAvailable" || "NewEngineVersionAvailable" || "DBClusterWriterUnderprovisioned" || "MemoryUnderprovisioned" || "InstanceStorageReadIOPSUnderprovisioned" || "InstanceStorageWriteIOPSUnderprovisioned",
90
92
  * // ],
93
+ * // currentInstancePerformanceRisk: "VeryLow" || "Low" || "Medium" || "High",
91
94
  * // storageFindingReasonCodes: [ // RDSStorageFindingReasonCodes
92
95
  * // "EBSVolumeAllocatedStorageUnderprovisioned" || "EBSVolumeThroughputUnderprovisioned" || "EBSVolumeIOPSOverprovisioned" || "EBSVolumeThroughputOverprovisioned" || "NewGenerationStorageTypeAvailable",
93
96
  * // ],
@@ -96,7 +99,7 @@ declare const GetRDSDatabaseRecommendationsCommand_base: {
96
99
  * // dbInstanceClass: "STRING_VALUE",
97
100
  * // projectedUtilizationMetrics: [ // RDSDBProjectedUtilizationMetrics
98
101
  * // { // RDSDBUtilizationMetric
99
- * // name: "CPU" || "Memory" || "EBSVolumeStorageSpaceUtilization" || "NetworkReceiveThroughput" || "NetworkTransmitThroughput" || "EBSVolumeReadIOPS" || "EBSVolumeWriteIOPS" || "EBSVolumeReadThroughput" || "EBSVolumeWriteThroughput" || "DatabaseConnections",
102
+ * // name: "CPU" || "Memory" || "EBSVolumeStorageSpaceUtilization" || "NetworkReceiveThroughput" || "NetworkTransmitThroughput" || "EBSVolumeReadIOPS" || "EBSVolumeWriteIOPS" || "EBSVolumeReadThroughput" || "EBSVolumeWriteThroughput" || "DatabaseConnections" || "StorageNetworkReceiveThroughput" || "StorageNetworkTransmitThroughput" || "AuroraMemoryHealthState" || "AuroraMemoryNumDeclinedSql" || "AuroraMemoryNumKillConnTotal" || "AuroraMemoryNumKillQueryTotal" || "ReadIOPSEphemeralStorage" || "WriteIOPSEphemeralStorage",
100
103
  * // statistic: "Maximum" || "Minimum" || "Average",
101
104
  * // value: Number("double"),
102
105
  * // },
@@ -147,7 +150,7 @@ declare const GetRDSDatabaseRecommendationsCommand_base: {
147
150
  * // ],
148
151
  * // utilizationMetrics: [ // RDSDBUtilizationMetrics
149
152
  * // {
150
- * // name: "CPU" || "Memory" || "EBSVolumeStorageSpaceUtilization" || "NetworkReceiveThroughput" || "NetworkTransmitThroughput" || "EBSVolumeReadIOPS" || "EBSVolumeWriteIOPS" || "EBSVolumeReadThroughput" || "EBSVolumeWriteThroughput" || "DatabaseConnections",
153
+ * // name: "CPU" || "Memory" || "EBSVolumeStorageSpaceUtilization" || "NetworkReceiveThroughput" || "NetworkTransmitThroughput" || "EBSVolumeReadIOPS" || "EBSVolumeWriteIOPS" || "EBSVolumeReadThroughput" || "EBSVolumeWriteThroughput" || "DatabaseConnections" || "StorageNetworkReceiveThroughput" || "StorageNetworkTransmitThroughput" || "AuroraMemoryHealthState" || "AuroraMemoryNumDeclinedSql" || "AuroraMemoryNumKillConnTotal" || "AuroraMemoryNumKillQueryTotal" || "ReadIOPSEphemeralStorage" || "WriteIOPSEphemeralStorage",
151
154
  * // statistic: "Maximum" || "Minimum" || "Average",
152
155
  * // value: Number("double"),
153
156
  * // },
@@ -42,7 +42,7 @@ declare const GetRecommendationPreferencesCommand_base: {
42
42
  * // const { ComputeOptimizerClient, GetRecommendationPreferencesCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import
43
43
  * const client = new ComputeOptimizerClient(config);
44
44
  * const input = { // GetRecommendationPreferencesRequest
45
- * resourceType: "Ec2Instance" || "AutoScalingGroup" || "EbsVolume" || "LambdaFunction" || "NotApplicable" || "EcsService" || "License" || "RdsDBInstance", // required
45
+ * resourceType: "Ec2Instance" || "AutoScalingGroup" || "EbsVolume" || "LambdaFunction" || "NotApplicable" || "EcsService" || "License" || "RdsDBInstance" || "Idle", // required
46
46
  * scope: { // Scope
47
47
  * name: "Organization" || "AccountId" || "ResourceArn",
48
48
  * value: "STRING_VALUE",
@@ -60,7 +60,7 @@ declare const GetRecommendationPreferencesCommand_base: {
60
60
  * // name: "Organization" || "AccountId" || "ResourceArn",
61
61
  * // value: "STRING_VALUE",
62
62
  * // },
63
- * // resourceType: "Ec2Instance" || "AutoScalingGroup" || "EbsVolume" || "LambdaFunction" || "NotApplicable" || "EcsService" || "License" || "RdsDBInstance",
63
+ * // resourceType: "Ec2Instance" || "AutoScalingGroup" || "EbsVolume" || "LambdaFunction" || "NotApplicable" || "EcsService" || "License" || "RdsDBInstance" || "Idle",
64
64
  * // enhancedInfrastructureMetrics: "Active" || "Inactive",
65
65
  * // inferredWorkloadTypes: "Active" || "Inactive",
66
66
  * // externalMetricsPreference: { // ExternalMetricsPreference
@@ -83,6 +83,12 @@ declare const GetRecommendationSummariesCommand_base: {
83
83
  * // ],
84
84
  * // },
85
85
  * // ],
86
+ * // idleSummaries: [ // IdleSummaries
87
+ * // { // IdleSummary
88
+ * // name: "Idle" || "Unattached",
89
+ * // value: Number("double"),
90
+ * // },
91
+ * // ],
86
92
  * // recommendationResourceType: "Ec2Instance" || "AutoScalingGroup" || "EbsVolume" || "LambdaFunction" || "EcsService" || "License" || "RdsDBInstance" || "RdsDBInstanceStorage",
87
93
  * // accountId: "STRING_VALUE",
88
94
  * // savingsOpportunity: { // SavingsOpportunity
@@ -92,6 +98,20 @@ declare const GetRecommendationSummariesCommand_base: {
92
98
  * // value: Number("double"),
93
99
  * // },
94
100
  * // },
101
+ * // idleSavingsOpportunity: {
102
+ * // savingsOpportunityPercentage: Number("double"),
103
+ * // estimatedMonthlySavings: {
104
+ * // currency: "USD" || "CNY",
105
+ * // value: Number("double"),
106
+ * // },
107
+ * // },
108
+ * // aggregatedSavingsOpportunity: {
109
+ * // savingsOpportunityPercentage: Number("double"),
110
+ * // estimatedMonthlySavings: {
111
+ * // currency: "USD" || "CNY",
112
+ * // value: Number("double"),
113
+ * // },
114
+ * // },
95
115
  * // currentPerformanceRiskRatings: { // CurrentPerformanceRiskRatings
96
116
  * // high: Number("long"),
97
117
  * // medium: Number("long"),
@@ -39,7 +39,7 @@ declare const PutRecommendationPreferencesCommand_base: {
39
39
  * // const { ComputeOptimizerClient, PutRecommendationPreferencesCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import
40
40
  * const client = new ComputeOptimizerClient(config);
41
41
  * const input = { // PutRecommendationPreferencesRequest
42
- * resourceType: "Ec2Instance" || "AutoScalingGroup" || "EbsVolume" || "LambdaFunction" || "NotApplicable" || "EcsService" || "License" || "RdsDBInstance", // required
42
+ * resourceType: "Ec2Instance" || "AutoScalingGroup" || "EbsVolume" || "LambdaFunction" || "NotApplicable" || "EcsService" || "License" || "RdsDBInstance" || "Idle", // required
43
43
  * scope: { // Scope
44
44
  * name: "Organization" || "AccountId" || "ResourceArn",
45
45
  * value: "STRING_VALUE",
@@ -4,6 +4,7 @@ export * from "./ExportAutoScalingGroupRecommendationsCommand";
4
4
  export * from "./ExportEBSVolumeRecommendationsCommand";
5
5
  export * from "./ExportEC2InstanceRecommendationsCommand";
6
6
  export * from "./ExportECSServiceRecommendationsCommand";
7
+ export * from "./ExportIdleRecommendationsCommand";
7
8
  export * from "./ExportLambdaFunctionRecommendationsCommand";
8
9
  export * from "./ExportLicenseRecommendationsCommand";
9
10
  export * from "./ExportRDSDatabaseRecommendationsCommand";
@@ -16,6 +17,7 @@ export * from "./GetECSServiceRecommendationsCommand";
16
17
  export * from "./GetEffectiveRecommendationPreferencesCommand";
17
18
  export * from "./GetEnrollmentStatusCommand";
18
19
  export * from "./GetEnrollmentStatusesForOrganizationCommand";
20
+ export * from "./GetIdleRecommendationsCommand";
19
21
  export * from "./GetLambdaFunctionRecommendationsCommand";
20
22
  export * from "./GetLicenseRecommendationsCommand";
21
23
  export * from "./GetRDSDatabaseRecommendationProjectedMetricsCommand";