@aws-sdk/client-compute-optimizer-automation 3.938.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 (173) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +392 -0
  3. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  4. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  5. package/dist-cjs/endpoint/ruleset.js +7 -0
  6. package/dist-cjs/index.js +1668 -0
  7. package/dist-cjs/runtimeConfig.browser.js +39 -0
  8. package/dist-cjs/runtimeConfig.js +56 -0
  9. package/dist-cjs/runtimeConfig.native.js +15 -0
  10. package/dist-cjs/runtimeConfig.shared.js +41 -0
  11. package/dist-es/ComputeOptimizerAutomation.js +53 -0
  12. package/dist-es/ComputeOptimizerAutomationClient.js +50 -0
  13. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  14. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  15. package/dist-es/commands/AssociateAccountsCommand.js +16 -0
  16. package/dist-es/commands/CreateAutomationRuleCommand.js +16 -0
  17. package/dist-es/commands/DeleteAutomationRuleCommand.js +16 -0
  18. package/dist-es/commands/DisassociateAccountsCommand.js +16 -0
  19. package/dist-es/commands/GetAutomationEventCommand.js +16 -0
  20. package/dist-es/commands/GetAutomationRuleCommand.js +16 -0
  21. package/dist-es/commands/GetEnrollmentConfigurationCommand.js +16 -0
  22. package/dist-es/commands/ListAccountsCommand.js +16 -0
  23. package/dist-es/commands/ListAutomationEventStepsCommand.js +16 -0
  24. package/dist-es/commands/ListAutomationEventSummariesCommand.js +16 -0
  25. package/dist-es/commands/ListAutomationEventsCommand.js +16 -0
  26. package/dist-es/commands/ListAutomationRulePreviewCommand.js +16 -0
  27. package/dist-es/commands/ListAutomationRulePreviewSummariesCommand.js +16 -0
  28. package/dist-es/commands/ListAutomationRulesCommand.js +16 -0
  29. package/dist-es/commands/ListRecommendedActionSummariesCommand.js +16 -0
  30. package/dist-es/commands/ListRecommendedActionsCommand.js +16 -0
  31. package/dist-es/commands/ListTagsForResourceCommand.js +16 -0
  32. package/dist-es/commands/RollbackAutomationEventCommand.js +16 -0
  33. package/dist-es/commands/StartAutomationEventCommand.js +16 -0
  34. package/dist-es/commands/TagResourceCommand.js +16 -0
  35. package/dist-es/commands/UntagResourceCommand.js +16 -0
  36. package/dist-es/commands/UpdateAutomationRuleCommand.js +16 -0
  37. package/dist-es/commands/UpdateEnrollmentConfigurationCommand.js +16 -0
  38. package/dist-es/commands/index.js +23 -0
  39. package/dist-es/endpoint/EndpointParameters.js +13 -0
  40. package/dist-es/endpoint/endpointResolver.js +14 -0
  41. package/dist-es/endpoint/ruleset.js +4 -0
  42. package/dist-es/extensionConfiguration.js +1 -0
  43. package/dist-es/index.js +7 -0
  44. package/dist-es/models/ComputeOptimizerAutomationServiceException.js +8 -0
  45. package/dist-es/models/enums.js +74 -0
  46. package/dist-es/models/errors.js +145 -0
  47. package/dist-es/models/models_0.js +28 -0
  48. package/dist-es/pagination/Interfaces.js +1 -0
  49. package/dist-es/pagination/ListAccountsPaginator.js +4 -0
  50. package/dist-es/pagination/ListAutomationEventStepsPaginator.js +4 -0
  51. package/dist-es/pagination/ListAutomationEventSummariesPaginator.js +4 -0
  52. package/dist-es/pagination/ListAutomationEventsPaginator.js +4 -0
  53. package/dist-es/pagination/ListAutomationRulePreviewPaginator.js +4 -0
  54. package/dist-es/pagination/ListAutomationRulePreviewSummariesPaginator.js +4 -0
  55. package/dist-es/pagination/ListAutomationRulesPaginator.js +4 -0
  56. package/dist-es/pagination/ListRecommendedActionSummariesPaginator.js +4 -0
  57. package/dist-es/pagination/ListRecommendedActionsPaginator.js +4 -0
  58. package/dist-es/pagination/index.js +10 -0
  59. package/dist-es/runtimeConfig.browser.js +34 -0
  60. package/dist-es/runtimeConfig.js +51 -0
  61. package/dist-es/runtimeConfig.native.js +11 -0
  62. package/dist-es/runtimeConfig.shared.js +37 -0
  63. package/dist-es/runtimeExtensions.js +9 -0
  64. package/dist-es/schemas/schemas_0.js +950 -0
  65. package/dist-types/ComputeOptimizerAutomation.d.ts +178 -0
  66. package/dist-types/ComputeOptimizerAutomationClient.d.ts +219 -0
  67. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  68. package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
  69. package/dist-types/commands/AssociateAccountsCommand.d.ts +112 -0
  70. package/dist-types/commands/CreateAutomationRuleCommand.d.ts +294 -0
  71. package/dist-types/commands/DeleteAutomationRuleCommand.d.ts +104 -0
  72. package/dist-types/commands/DisassociateAccountsCommand.d.ts +112 -0
  73. package/dist-types/commands/GetAutomationEventCommand.d.ts +117 -0
  74. package/dist-types/commands/GetAutomationRuleCommand.d.ts +195 -0
  75. package/dist-types/commands/GetEnrollmentConfigurationCommand.d.ts +99 -0
  76. package/dist-types/commands/ListAccountsCommand.d.ts +108 -0
  77. package/dist-types/commands/ListAutomationEventStepsCommand.d.ts +117 -0
  78. package/dist-types/commands/ListAutomationEventSummariesCommand.d.ts +130 -0
  79. package/dist-types/commands/ListAutomationEventsCommand.d.ts +130 -0
  80. package/dist-types/commands/ListAutomationRulePreviewCommand.d.ts +219 -0
  81. package/dist-types/commands/ListAutomationRulePreviewSummariesCommand.d.ts +186 -0
  82. package/dist-types/commands/ListAutomationRulesCommand.d.ts +133 -0
  83. package/dist-types/commands/ListRecommendedActionSummariesCommand.d.ts +118 -0
  84. package/dist-types/commands/ListRecommendedActionsCommand.d.ts +151 -0
  85. package/dist-types/commands/ListTagsForResourceCommand.d.ts +103 -0
  86. package/dist-types/commands/RollbackAutomationEventCommand.d.ts +106 -0
  87. package/dist-types/commands/StartAutomationEventCommand.d.ts +110 -0
  88. package/dist-types/commands/TagResourceCommand.d.ts +110 -0
  89. package/dist-types/commands/UntagResourceCommand.d.ts +107 -0
  90. package/dist-types/commands/UpdateAutomationRuleCommand.d.ts +281 -0
  91. package/dist-types/commands/UpdateEnrollmentConfigurationCommand.d.ts +110 -0
  92. package/dist-types/commands/index.d.ts +23 -0
  93. package/dist-types/endpoint/EndpointParameters.d.ts +38 -0
  94. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  95. package/dist-types/endpoint/ruleset.d.ts +2 -0
  96. package/dist-types/extensionConfiguration.d.ts +9 -0
  97. package/dist-types/index.d.ts +16 -0
  98. package/dist-types/models/ComputeOptimizerAutomationServiceException.d.ts +14 -0
  99. package/dist-types/models/enums.d.ts +178 -0
  100. package/dist-types/models/errors.d.ts +146 -0
  101. package/dist-types/models/models_0.d.ts +2028 -0
  102. package/dist-types/pagination/Interfaces.d.ts +8 -0
  103. package/dist-types/pagination/ListAccountsPaginator.d.ts +7 -0
  104. package/dist-types/pagination/ListAutomationEventStepsPaginator.d.ts +7 -0
  105. package/dist-types/pagination/ListAutomationEventSummariesPaginator.d.ts +7 -0
  106. package/dist-types/pagination/ListAutomationEventsPaginator.d.ts +7 -0
  107. package/dist-types/pagination/ListAutomationRulePreviewPaginator.d.ts +7 -0
  108. package/dist-types/pagination/ListAutomationRulePreviewSummariesPaginator.d.ts +7 -0
  109. package/dist-types/pagination/ListAutomationRulesPaginator.d.ts +7 -0
  110. package/dist-types/pagination/ListRecommendedActionSummariesPaginator.d.ts +7 -0
  111. package/dist-types/pagination/ListRecommendedActionsPaginator.d.ts +7 -0
  112. package/dist-types/pagination/index.d.ts +10 -0
  113. package/dist-types/runtimeConfig.browser.d.ts +51 -0
  114. package/dist-types/runtimeConfig.d.ts +51 -0
  115. package/dist-types/runtimeConfig.native.d.ts +50 -0
  116. package/dist-types/runtimeConfig.shared.d.ts +22 -0
  117. package/dist-types/runtimeExtensions.d.ts +17 -0
  118. package/dist-types/schemas/schemas_0.d.ts +141 -0
  119. package/dist-types/ts3.4/ComputeOptimizerAutomation.d.ts +411 -0
  120. package/dist-types/ts3.4/ComputeOptimizerAutomationClient.d.ts +264 -0
  121. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  122. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
  123. package/dist-types/ts3.4/commands/AssociateAccountsCommand.d.ts +51 -0
  124. package/dist-types/ts3.4/commands/CreateAutomationRuleCommand.d.ts +51 -0
  125. package/dist-types/ts3.4/commands/DeleteAutomationRuleCommand.d.ts +51 -0
  126. package/dist-types/ts3.4/commands/DisassociateAccountsCommand.d.ts +51 -0
  127. package/dist-types/ts3.4/commands/GetAutomationEventCommand.d.ts +51 -0
  128. package/dist-types/ts3.4/commands/GetAutomationRuleCommand.d.ts +51 -0
  129. package/dist-types/ts3.4/commands/GetEnrollmentConfigurationCommand.d.ts +51 -0
  130. package/dist-types/ts3.4/commands/ListAccountsCommand.d.ts +47 -0
  131. package/dist-types/ts3.4/commands/ListAutomationEventStepsCommand.d.ts +51 -0
  132. package/dist-types/ts3.4/commands/ListAutomationEventSummariesCommand.d.ts +51 -0
  133. package/dist-types/ts3.4/commands/ListAutomationEventsCommand.d.ts +51 -0
  134. package/dist-types/ts3.4/commands/ListAutomationRulePreviewCommand.d.ts +51 -0
  135. package/dist-types/ts3.4/commands/ListAutomationRulePreviewSummariesCommand.d.ts +51 -0
  136. package/dist-types/ts3.4/commands/ListAutomationRulesCommand.d.ts +51 -0
  137. package/dist-types/ts3.4/commands/ListRecommendedActionSummariesCommand.d.ts +51 -0
  138. package/dist-types/ts3.4/commands/ListRecommendedActionsCommand.d.ts +51 -0
  139. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
  140. package/dist-types/ts3.4/commands/RollbackAutomationEventCommand.d.ts +51 -0
  141. package/dist-types/ts3.4/commands/StartAutomationEventCommand.d.ts +51 -0
  142. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
  143. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
  144. package/dist-types/ts3.4/commands/UpdateAutomationRuleCommand.d.ts +51 -0
  145. package/dist-types/ts3.4/commands/UpdateEnrollmentConfigurationCommand.d.ts +51 -0
  146. package/dist-types/ts3.4/commands/index.d.ts +23 -0
  147. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  148. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  149. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  150. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  151. package/dist-types/ts3.4/index.d.ts +11 -0
  152. package/dist-types/ts3.4/models/ComputeOptimizerAutomationServiceException.d.ts +9 -0
  153. package/dist-types/ts3.4/models/enums.d.ts +93 -0
  154. package/dist-types/ts3.4/models/errors.d.ts +87 -0
  155. package/dist-types/ts3.4/models/models_0.d.ts +520 -0
  156. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  157. package/dist-types/ts3.4/pagination/ListAccountsPaginator.d.ts +11 -0
  158. package/dist-types/ts3.4/pagination/ListAutomationEventStepsPaginator.d.ts +11 -0
  159. package/dist-types/ts3.4/pagination/ListAutomationEventSummariesPaginator.d.ts +11 -0
  160. package/dist-types/ts3.4/pagination/ListAutomationEventsPaginator.d.ts +11 -0
  161. package/dist-types/ts3.4/pagination/ListAutomationRulePreviewPaginator.d.ts +11 -0
  162. package/dist-types/ts3.4/pagination/ListAutomationRulePreviewSummariesPaginator.d.ts +11 -0
  163. package/dist-types/ts3.4/pagination/ListAutomationRulesPaginator.d.ts +11 -0
  164. package/dist-types/ts3.4/pagination/ListRecommendedActionSummariesPaginator.d.ts +11 -0
  165. package/dist-types/ts3.4/pagination/ListRecommendedActionsPaginator.d.ts +11 -0
  166. package/dist-types/ts3.4/pagination/index.d.ts +10 -0
  167. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +98 -0
  168. package/dist-types/ts3.4/runtimeConfig.d.ts +93 -0
  169. package/dist-types/ts3.4/runtimeConfig.native.d.ts +102 -0
  170. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +27 -0
  171. package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
  172. package/dist-types/ts3.4/schemas/schemas_0.d.ts +146 -0
  173. package/package.json +99 -0
@@ -0,0 +1,130 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComputeOptimizerAutomationClient";
4
+ import { ListAutomationEventsRequest, ListAutomationEventsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListAutomationEventsCommand}.
14
+ */
15
+ export interface ListAutomationEventsCommandInput extends ListAutomationEventsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListAutomationEventsCommand}.
21
+ */
22
+ export interface ListAutomationEventsCommandOutput extends ListAutomationEventsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListAutomationEventsCommand_base: {
25
+ new (input: ListAutomationEventsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAutomationEventsCommandInput, ListAutomationEventsCommandOutput, ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListAutomationEventsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListAutomationEventsCommandInput, ListAutomationEventsCommandOutput, ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists automation events based on specified filters. You can retrieve events that were created within the past year. </p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ComputeOptimizerAutomationClient, ListAutomationEventsCommand } from "@aws-sdk/client-compute-optimizer-automation"; // ES Modules import
35
+ * // const { ComputeOptimizerAutomationClient, ListAutomationEventsCommand } = require("@aws-sdk/client-compute-optimizer-automation"); // CommonJS import
36
+ * // import type { ComputeOptimizerAutomationClientConfig } from "@aws-sdk/client-compute-optimizer-automation";
37
+ * const config = {}; // type is ComputeOptimizerAutomationClientConfig
38
+ * const client = new ComputeOptimizerAutomationClient(config);
39
+ * const input = { // ListAutomationEventsRequest
40
+ * filters: [ // AutomationEventFilterList
41
+ * { // AutomationEventFilter
42
+ * name: "STRING_VALUE", // required
43
+ * values: [ // FilterValues // required
44
+ * "STRING_VALUE",
45
+ * ],
46
+ * },
47
+ * ],
48
+ * startTimeInclusive: new Date("TIMESTAMP"),
49
+ * endTimeExclusive: new Date("TIMESTAMP"),
50
+ * maxResults: Number("int"),
51
+ * nextToken: "STRING_VALUE",
52
+ * };
53
+ * const command = new ListAutomationEventsCommand(input);
54
+ * const response = await client.send(command);
55
+ * // { // ListAutomationEventsResponse
56
+ * // automationEvents: [ // AutomationEvents
57
+ * // { // AutomationEvent
58
+ * // eventId: "STRING_VALUE",
59
+ * // eventDescription: "STRING_VALUE",
60
+ * // eventType: "SnapshotAndDeleteUnattachedEbsVolume" || "UpgradeEbsVolumeType",
61
+ * // eventStatus: "Ready" || "InProgress" || "Complete" || "Failed" || "Cancelled" || "RollbackReady" || "RollbackInProgress" || "RollbackComplete" || "RollbackFailed",
62
+ * // eventStatusReason: "STRING_VALUE",
63
+ * // resourceArn: "STRING_VALUE",
64
+ * // resourceId: "STRING_VALUE",
65
+ * // recommendedActionId: "STRING_VALUE",
66
+ * // accountId: "STRING_VALUE",
67
+ * // region: "STRING_VALUE",
68
+ * // ruleId: "STRING_VALUE",
69
+ * // resourceType: "EbsVolume",
70
+ * // createdTimestamp: new Date("TIMESTAMP"),
71
+ * // completedTimestamp: new Date("TIMESTAMP"),
72
+ * // estimatedMonthlySavings: { // EstimatedMonthlySavings
73
+ * // currency: "STRING_VALUE", // required
74
+ * // beforeDiscountSavings: Number("double"), // required
75
+ * // afterDiscountSavings: Number("double"), // required
76
+ * // savingsEstimationMode: "BeforeDiscount" || "AfterDiscount", // required
77
+ * // },
78
+ * // },
79
+ * // ],
80
+ * // nextToken: "STRING_VALUE",
81
+ * // };
82
+ *
83
+ * ```
84
+ *
85
+ * @param ListAutomationEventsCommandInput - {@link ListAutomationEventsCommandInput}
86
+ * @returns {@link ListAutomationEventsCommandOutput}
87
+ * @see {@link ListAutomationEventsCommandInput} for command's `input` shape.
88
+ * @see {@link ListAutomationEventsCommandOutput} for command's `response` shape.
89
+ * @see {@link ComputeOptimizerAutomationClientResolvedConfig | config} for ComputeOptimizerAutomationClient's `config` shape.
90
+ *
91
+ * @throws {@link AccessDeniedException} (client fault)
92
+ * <p> You do not have sufficient permissions to perform this action. </p>
93
+ *
94
+ * @throws {@link ForbiddenException} (client fault)
95
+ * <p> You are not authorized to perform this action. </p>
96
+ *
97
+ * @throws {@link InternalServerException} (server fault)
98
+ * <p> An internal error occurred while processing the request. </p>
99
+ *
100
+ * @throws {@link InvalidParameterValueException} (client fault)
101
+ * <p> One or more parameter values are not valid. </p>
102
+ *
103
+ * @throws {@link OptInRequiredException} (client fault)
104
+ * <p> The account must be opted in to Compute Optimizer Automation before performing this action. </p>
105
+ *
106
+ * @throws {@link ServiceUnavailableException} (server fault)
107
+ * <p> The service is temporarily unavailable. </p>
108
+ *
109
+ * @throws {@link ThrottlingException} (client fault)
110
+ * <p> The request was denied due to request throttling. </p>
111
+ *
112
+ * @throws {@link ComputeOptimizerAutomationServiceException}
113
+ * <p>Base exception class for all service exceptions from ComputeOptimizerAutomation service.</p>
114
+ *
115
+ *
116
+ * @public
117
+ */
118
+ export declare class ListAutomationEventsCommand extends ListAutomationEventsCommand_base {
119
+ /** @internal type navigation helper, not in runtime. */
120
+ protected static __types: {
121
+ api: {
122
+ input: ListAutomationEventsRequest;
123
+ output: ListAutomationEventsResponse;
124
+ };
125
+ sdk: {
126
+ input: ListAutomationEventsCommandInput;
127
+ output: ListAutomationEventsCommandOutput;
128
+ };
129
+ };
130
+ }
@@ -0,0 +1,219 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComputeOptimizerAutomationClient";
4
+ import { ListAutomationRulePreviewRequest, ListAutomationRulePreviewResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListAutomationRulePreviewCommand}.
14
+ */
15
+ export interface ListAutomationRulePreviewCommandInput extends ListAutomationRulePreviewRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListAutomationRulePreviewCommand}.
21
+ */
22
+ export interface ListAutomationRulePreviewCommandOutput extends ListAutomationRulePreviewResponse, __MetadataBearer {
23
+ }
24
+ declare const ListAutomationRulePreviewCommand_base: {
25
+ new (input: ListAutomationRulePreviewCommandInput): import("@smithy/smithy-client").CommandImpl<ListAutomationRulePreviewCommandInput, ListAutomationRulePreviewCommandOutput, ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ListAutomationRulePreviewCommandInput): import("@smithy/smithy-client").CommandImpl<ListAutomationRulePreviewCommandInput, ListAutomationRulePreviewCommandOutput, ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a preview of the recommended actions that match your Automation rule's configuration and criteria. </p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ComputeOptimizerAutomationClient, ListAutomationRulePreviewCommand } from "@aws-sdk/client-compute-optimizer-automation"; // ES Modules import
35
+ * // const { ComputeOptimizerAutomationClient, ListAutomationRulePreviewCommand } = require("@aws-sdk/client-compute-optimizer-automation"); // CommonJS import
36
+ * // import type { ComputeOptimizerAutomationClientConfig } from "@aws-sdk/client-compute-optimizer-automation";
37
+ * const config = {}; // type is ComputeOptimizerAutomationClientConfig
38
+ * const client = new ComputeOptimizerAutomationClient(config);
39
+ * const input = { // ListAutomationRulePreviewRequest
40
+ * ruleType: "OrganizationRule" || "AccountRule", // required
41
+ * organizationScope: { // OrganizationScope
42
+ * accountIds: [ // OrganizationConfigurationAccountIds
43
+ * "STRING_VALUE",
44
+ * ],
45
+ * },
46
+ * recommendedActionTypes: [ // RecommendedActionTypeList // required
47
+ * "SnapshotAndDeleteUnattachedEbsVolume" || "UpgradeEbsVolumeType",
48
+ * ],
49
+ * criteria: { // Criteria
50
+ * region: [ // StringCriteriaConditionList
51
+ * { // StringCriteriaCondition
52
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
53
+ * values: [ // StringCriteriaValues
54
+ * "STRING_VALUE",
55
+ * ],
56
+ * },
57
+ * ],
58
+ * resourceArn: [
59
+ * {
60
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
61
+ * values: [
62
+ * "STRING_VALUE",
63
+ * ],
64
+ * },
65
+ * ],
66
+ * ebsVolumeType: [
67
+ * {
68
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
69
+ * values: [
70
+ * "STRING_VALUE",
71
+ * ],
72
+ * },
73
+ * ],
74
+ * ebsVolumeSizeInGib: [ // IntegerCriteriaConditionList
75
+ * { // IntegerCriteriaCondition
76
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
77
+ * values: [ // IntegerList
78
+ * Number("int"),
79
+ * ],
80
+ * },
81
+ * ],
82
+ * estimatedMonthlySavings: [ // DoubleCriteriaConditionList
83
+ * { // DoubleCriteriaCondition
84
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
85
+ * values: [ // DoubleList
86
+ * Number("double"),
87
+ * ],
88
+ * },
89
+ * ],
90
+ * resourceTag: [ // ResourceTagsCriteriaConditionList
91
+ * { // ResourceTagsCriteriaCondition
92
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
93
+ * key: "STRING_VALUE",
94
+ * values: [
95
+ * "STRING_VALUE",
96
+ * ],
97
+ * },
98
+ * ],
99
+ * lookBackPeriodInDays: [
100
+ * {
101
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
102
+ * values: [
103
+ * Number("int"),
104
+ * ],
105
+ * },
106
+ * ],
107
+ * restartNeeded: [
108
+ * {
109
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
110
+ * values: [
111
+ * "STRING_VALUE",
112
+ * ],
113
+ * },
114
+ * ],
115
+ * },
116
+ * maxResults: Number("int"),
117
+ * nextToken: "STRING_VALUE",
118
+ * };
119
+ * const command = new ListAutomationRulePreviewCommand(input);
120
+ * const response = await client.send(command);
121
+ * // { // ListAutomationRulePreviewResponse
122
+ * // previewResults: [ // PreviewResults
123
+ * // { // PreviewResult
124
+ * // recommendedActionId: "STRING_VALUE",
125
+ * // resourceArn: "STRING_VALUE",
126
+ * // resourceId: "STRING_VALUE",
127
+ * // accountId: "STRING_VALUE",
128
+ * // region: "STRING_VALUE",
129
+ * // resourceType: "EbsVolume",
130
+ * // lookBackPeriodInDays: Number("int"),
131
+ * // recommendedActionType: "SnapshotAndDeleteUnattachedEbsVolume" || "UpgradeEbsVolumeType",
132
+ * // currentResourceSummary: "STRING_VALUE",
133
+ * // currentResourceDetails: { // ResourceDetails Union: only one key present
134
+ * // ebsVolume: { // EbsVolume
135
+ * // configuration: { // EbsVolumeConfiguration
136
+ * // type: "STRING_VALUE",
137
+ * // sizeInGib: Number("int"),
138
+ * // iops: Number("int"),
139
+ * // throughput: Number("int"),
140
+ * // },
141
+ * // },
142
+ * // },
143
+ * // recommendedResourceSummary: "STRING_VALUE",
144
+ * // recommendedResourceDetails: {// Union: only one key present
145
+ * // ebsVolume: {
146
+ * // configuration: {
147
+ * // type: "STRING_VALUE",
148
+ * // sizeInGib: Number("int"),
149
+ * // iops: Number("int"),
150
+ * // throughput: Number("int"),
151
+ * // },
152
+ * // },
153
+ * // },
154
+ * // restartNeeded: true || false,
155
+ * // estimatedMonthlySavings: { // EstimatedMonthlySavings
156
+ * // currency: "STRING_VALUE", // required
157
+ * // beforeDiscountSavings: Number("double"), // required
158
+ * // afterDiscountSavings: Number("double"), // required
159
+ * // savingsEstimationMode: "BeforeDiscount" || "AfterDiscount", // required
160
+ * // },
161
+ * // resourceTags: [ // TagList
162
+ * // { // Tag
163
+ * // key: "STRING_VALUE", // required
164
+ * // value: "STRING_VALUE", // required
165
+ * // },
166
+ * // ],
167
+ * // },
168
+ * // ],
169
+ * // nextToken: "STRING_VALUE",
170
+ * // };
171
+ *
172
+ * ```
173
+ *
174
+ * @param ListAutomationRulePreviewCommandInput - {@link ListAutomationRulePreviewCommandInput}
175
+ * @returns {@link ListAutomationRulePreviewCommandOutput}
176
+ * @see {@link ListAutomationRulePreviewCommandInput} for command's `input` shape.
177
+ * @see {@link ListAutomationRulePreviewCommandOutput} for command's `response` shape.
178
+ * @see {@link ComputeOptimizerAutomationClientResolvedConfig | config} for ComputeOptimizerAutomationClient's `config` shape.
179
+ *
180
+ * @throws {@link AccessDeniedException} (client fault)
181
+ * <p> You do not have sufficient permissions to perform this action. </p>
182
+ *
183
+ * @throws {@link ForbiddenException} (client fault)
184
+ * <p> You are not authorized to perform this action. </p>
185
+ *
186
+ * @throws {@link InternalServerException} (server fault)
187
+ * <p> An internal error occurred while processing the request. </p>
188
+ *
189
+ * @throws {@link InvalidParameterValueException} (client fault)
190
+ * <p> One or more parameter values are not valid. </p>
191
+ *
192
+ * @throws {@link OptInRequiredException} (client fault)
193
+ * <p> The account must be opted in to Compute Optimizer Automation before performing this action. </p>
194
+ *
195
+ * @throws {@link ServiceUnavailableException} (server fault)
196
+ * <p> The service is temporarily unavailable. </p>
197
+ *
198
+ * @throws {@link ThrottlingException} (client fault)
199
+ * <p> The request was denied due to request throttling. </p>
200
+ *
201
+ * @throws {@link ComputeOptimizerAutomationServiceException}
202
+ * <p>Base exception class for all service exceptions from ComputeOptimizerAutomation service.</p>
203
+ *
204
+ *
205
+ * @public
206
+ */
207
+ export declare class ListAutomationRulePreviewCommand extends ListAutomationRulePreviewCommand_base {
208
+ /** @internal type navigation helper, not in runtime. */
209
+ protected static __types: {
210
+ api: {
211
+ input: ListAutomationRulePreviewRequest;
212
+ output: ListAutomationRulePreviewResponse;
213
+ };
214
+ sdk: {
215
+ input: ListAutomationRulePreviewCommandInput;
216
+ output: ListAutomationRulePreviewCommandOutput;
217
+ };
218
+ };
219
+ }
@@ -0,0 +1,186 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComputeOptimizerAutomationClient";
4
+ import { ListAutomationRulePreviewSummariesRequest, ListAutomationRulePreviewSummariesResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListAutomationRulePreviewSummariesCommand}.
14
+ */
15
+ export interface ListAutomationRulePreviewSummariesCommandInput extends ListAutomationRulePreviewSummariesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListAutomationRulePreviewSummariesCommand}.
21
+ */
22
+ export interface ListAutomationRulePreviewSummariesCommandOutput extends ListAutomationRulePreviewSummariesResponse, __MetadataBearer {
23
+ }
24
+ declare const ListAutomationRulePreviewSummariesCommand_base: {
25
+ new (input: ListAutomationRulePreviewSummariesCommandInput): import("@smithy/smithy-client").CommandImpl<ListAutomationRulePreviewSummariesCommandInput, ListAutomationRulePreviewSummariesCommandOutput, ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ListAutomationRulePreviewSummariesCommandInput): import("@smithy/smithy-client").CommandImpl<ListAutomationRulePreviewSummariesCommandInput, ListAutomationRulePreviewSummariesCommandOutput, ComputeOptimizerAutomationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a summary of the recommended actions that match your rule preview configuration and criteria. </p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ComputeOptimizerAutomationClient, ListAutomationRulePreviewSummariesCommand } from "@aws-sdk/client-compute-optimizer-automation"; // ES Modules import
35
+ * // const { ComputeOptimizerAutomationClient, ListAutomationRulePreviewSummariesCommand } = require("@aws-sdk/client-compute-optimizer-automation"); // CommonJS import
36
+ * // import type { ComputeOptimizerAutomationClientConfig } from "@aws-sdk/client-compute-optimizer-automation";
37
+ * const config = {}; // type is ComputeOptimizerAutomationClientConfig
38
+ * const client = new ComputeOptimizerAutomationClient(config);
39
+ * const input = { // ListAutomationRulePreviewSummariesRequest
40
+ * ruleType: "OrganizationRule" || "AccountRule", // required
41
+ * organizationScope: { // OrganizationScope
42
+ * accountIds: [ // OrganizationConfigurationAccountIds
43
+ * "STRING_VALUE",
44
+ * ],
45
+ * },
46
+ * recommendedActionTypes: [ // RecommendedActionTypeList // required
47
+ * "SnapshotAndDeleteUnattachedEbsVolume" || "UpgradeEbsVolumeType",
48
+ * ],
49
+ * criteria: { // Criteria
50
+ * region: [ // StringCriteriaConditionList
51
+ * { // StringCriteriaCondition
52
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
53
+ * values: [ // StringCriteriaValues
54
+ * "STRING_VALUE",
55
+ * ],
56
+ * },
57
+ * ],
58
+ * resourceArn: [
59
+ * {
60
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
61
+ * values: [
62
+ * "STRING_VALUE",
63
+ * ],
64
+ * },
65
+ * ],
66
+ * ebsVolumeType: [
67
+ * {
68
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
69
+ * values: [
70
+ * "STRING_VALUE",
71
+ * ],
72
+ * },
73
+ * ],
74
+ * ebsVolumeSizeInGib: [ // IntegerCriteriaConditionList
75
+ * { // IntegerCriteriaCondition
76
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
77
+ * values: [ // IntegerList
78
+ * Number("int"),
79
+ * ],
80
+ * },
81
+ * ],
82
+ * estimatedMonthlySavings: [ // DoubleCriteriaConditionList
83
+ * { // DoubleCriteriaCondition
84
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
85
+ * values: [ // DoubleList
86
+ * Number("double"),
87
+ * ],
88
+ * },
89
+ * ],
90
+ * resourceTag: [ // ResourceTagsCriteriaConditionList
91
+ * { // ResourceTagsCriteriaCondition
92
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
93
+ * key: "STRING_VALUE",
94
+ * values: [
95
+ * "STRING_VALUE",
96
+ * ],
97
+ * },
98
+ * ],
99
+ * lookBackPeriodInDays: [
100
+ * {
101
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
102
+ * values: [
103
+ * Number("int"),
104
+ * ],
105
+ * },
106
+ * ],
107
+ * restartNeeded: [
108
+ * {
109
+ * comparison: "StringEquals" || "StringNotEquals" || "StringEqualsIgnoreCase" || "StringNotEqualsIgnoreCase" || "StringLike" || "StringNotLike" || "NumericEquals" || "NumericNotEquals" || "NumericLessThan" || "NumericLessThanEquals" || "NumericGreaterThan" || "NumericGreaterThanEquals",
110
+ * values: [
111
+ * "STRING_VALUE",
112
+ * ],
113
+ * },
114
+ * ],
115
+ * },
116
+ * maxResults: Number("int"),
117
+ * nextToken: "STRING_VALUE",
118
+ * };
119
+ * const command = new ListAutomationRulePreviewSummariesCommand(input);
120
+ * const response = await client.send(command);
121
+ * // { // ListAutomationRulePreviewSummariesResponse
122
+ * // previewResultSummaries: [ // PreviewResultSummaries
123
+ * // { // PreviewResultSummary
124
+ * // key: "STRING_VALUE", // required
125
+ * // total: { // RulePreviewTotal
126
+ * // recommendedActionCount: Number("int"), // required
127
+ * // estimatedMonthlySavings: { // EstimatedMonthlySavings
128
+ * // currency: "STRING_VALUE", // required
129
+ * // beforeDiscountSavings: Number("double"), // required
130
+ * // afterDiscountSavings: Number("double"), // required
131
+ * // savingsEstimationMode: "BeforeDiscount" || "AfterDiscount", // required
132
+ * // },
133
+ * // },
134
+ * // },
135
+ * // ],
136
+ * // nextToken: "STRING_VALUE",
137
+ * // };
138
+ *
139
+ * ```
140
+ *
141
+ * @param ListAutomationRulePreviewSummariesCommandInput - {@link ListAutomationRulePreviewSummariesCommandInput}
142
+ * @returns {@link ListAutomationRulePreviewSummariesCommandOutput}
143
+ * @see {@link ListAutomationRulePreviewSummariesCommandInput} for command's `input` shape.
144
+ * @see {@link ListAutomationRulePreviewSummariesCommandOutput} for command's `response` shape.
145
+ * @see {@link ComputeOptimizerAutomationClientResolvedConfig | config} for ComputeOptimizerAutomationClient's `config` shape.
146
+ *
147
+ * @throws {@link AccessDeniedException} (client fault)
148
+ * <p> You do not have sufficient permissions to perform this action. </p>
149
+ *
150
+ * @throws {@link ForbiddenException} (client fault)
151
+ * <p> You are not authorized to perform this action. </p>
152
+ *
153
+ * @throws {@link InternalServerException} (server fault)
154
+ * <p> An internal error occurred while processing the request. </p>
155
+ *
156
+ * @throws {@link InvalidParameterValueException} (client fault)
157
+ * <p> One or more parameter values are not valid. </p>
158
+ *
159
+ * @throws {@link OptInRequiredException} (client fault)
160
+ * <p> The account must be opted in to Compute Optimizer Automation before performing this action. </p>
161
+ *
162
+ * @throws {@link ServiceUnavailableException} (server fault)
163
+ * <p> The service is temporarily unavailable. </p>
164
+ *
165
+ * @throws {@link ThrottlingException} (client fault)
166
+ * <p> The request was denied due to request throttling. </p>
167
+ *
168
+ * @throws {@link ComputeOptimizerAutomationServiceException}
169
+ * <p>Base exception class for all service exceptions from ComputeOptimizerAutomation service.</p>
170
+ *
171
+ *
172
+ * @public
173
+ */
174
+ export declare class ListAutomationRulePreviewSummariesCommand extends ListAutomationRulePreviewSummariesCommand_base {
175
+ /** @internal type navigation helper, not in runtime. */
176
+ protected static __types: {
177
+ api: {
178
+ input: ListAutomationRulePreviewSummariesRequest;
179
+ output: ListAutomationRulePreviewSummariesResponse;
180
+ };
181
+ sdk: {
182
+ input: ListAutomationRulePreviewSummariesCommandInput;
183
+ output: ListAutomationRulePreviewSummariesCommandOutput;
184
+ };
185
+ };
186
+ }