@aws-sdk/client-wellarchitected 3.1107.0 → 3.1109.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 (131) hide show
  1. package/README.md +162 -6
  2. package/dist-cjs/index.js +1125 -107
  3. package/dist-es/WellArchitected.js +58 -0
  4. package/dist-es/commands/CreateAgentContextCommand.js +4 -0
  5. package/dist-es/commands/CreateAgentGoalCommand.js +4 -0
  6. package/dist-es/commands/CreateAgentProfileCommand.js +4 -0
  7. package/dist-es/commands/DeleteAgentContextCommand.js +4 -0
  8. package/dist-es/commands/DeleteAgentGoalCommand.js +4 -0
  9. package/dist-es/commands/DeleteAgentProfileCommand.js +4 -0
  10. package/dist-es/commands/GetAgentContextCommand.js +4 -0
  11. package/dist-es/commands/GetAgentGoalCommand.js +4 -0
  12. package/dist-es/commands/GetAgentProfileCommand.js +4 -0
  13. package/dist-es/commands/GetAgentRecommendationCommand.js +4 -0
  14. package/dist-es/commands/GetAgentRecommendationGenerationCommand.js +4 -0
  15. package/dist-es/commands/ListAgentContextsCommand.js +4 -0
  16. package/dist-es/commands/ListAgentGoalsCommand.js +4 -0
  17. package/dist-es/commands/ListAgentProfilesCommand.js +4 -0
  18. package/dist-es/commands/ListAgentRecommendationGenerationsCommand.js +4 -0
  19. package/dist-es/commands/ListAgentRecommendationItemsCommand.js +4 -0
  20. package/dist-es/commands/ListAgentRecommendationsCommand.js +4 -0
  21. package/dist-es/commands/PutAgentRecommendationFeedbackCommand.js +4 -0
  22. package/dist-es/commands/StartAgentRecommendationGenerationCommand.js +4 -0
  23. package/dist-es/commands/UpdateAgentContextCommand.js +4 -0
  24. package/dist-es/commands/UpdateAgentGoalCommand.js +4 -0
  25. package/dist-es/commands/UpdateAgentProfileCommand.js +4 -0
  26. package/dist-es/commands/UpdateAgentRecommendationStatusCommand.js +4 -0
  27. package/dist-es/commands/index.js +23 -0
  28. package/dist-es/models/enums.js +92 -0
  29. package/dist-es/pagination/ListAgentContextsPaginator.js +4 -0
  30. package/dist-es/pagination/ListAgentGoalsPaginator.js +4 -0
  31. package/dist-es/pagination/ListAgentProfilesPaginator.js +4 -0
  32. package/dist-es/pagination/ListAgentRecommendationGenerationsPaginator.js +4 -0
  33. package/dist-es/pagination/ListAgentRecommendationItemsPaginator.js +4 -0
  34. package/dist-es/pagination/ListAgentRecommendationsPaginator.js +4 -0
  35. package/dist-es/pagination/index.js +6 -0
  36. package/dist-es/schemas/schemas_0.js +799 -106
  37. package/dist-types/WellArchitected.d.ts +205 -6
  38. package/dist-types/WellArchitectedClient.d.ts +26 -8
  39. package/dist-types/commands/AssociateLensesCommand.d.ts +1 -11
  40. package/dist-types/commands/CreateAgentContextCommand.d.ts +158 -0
  41. package/dist-types/commands/CreateAgentGoalCommand.d.ts +110 -0
  42. package/dist-types/commands/CreateAgentProfileCommand.d.ts +146 -0
  43. package/dist-types/commands/CreateLensShareCommand.d.ts +1 -21
  44. package/dist-types/commands/CreateLensVersionCommand.d.ts +1 -7
  45. package/dist-types/commands/CreateReviewTemplateCommand.d.ts +1 -12
  46. package/dist-types/commands/CreateTemplateShareCommand.d.ts +1 -15
  47. package/dist-types/commands/CreateWorkloadCommand.d.ts +1 -36
  48. package/dist-types/commands/CreateWorkloadShareCommand.d.ts +1 -8
  49. package/dist-types/commands/DeleteAgentContextCommand.d.ts +85 -0
  50. package/dist-types/commands/DeleteAgentGoalCommand.d.ts +85 -0
  51. package/dist-types/commands/DeleteAgentProfileCommand.d.ts +87 -0
  52. package/dist-types/commands/DeleteLensCommand.d.ts +1 -15
  53. package/dist-types/commands/DeleteLensShareCommand.d.ts +1 -15
  54. package/dist-types/commands/DeleteProfileCommand.d.ts +1 -12
  55. package/dist-types/commands/DeleteReviewTemplateCommand.d.ts +1 -5
  56. package/dist-types/commands/DeleteTemplateShareCommand.d.ts +1 -4
  57. package/dist-types/commands/DisassociateLensesCommand.d.ts +1 -6
  58. package/dist-types/commands/ExportLensCommand.d.ts +1 -16
  59. package/dist-types/commands/GetAgentContextCommand.d.ts +124 -0
  60. package/dist-types/commands/GetAgentGoalCommand.d.ts +99 -0
  61. package/dist-types/commands/GetAgentProfileCommand.d.ts +119 -0
  62. package/dist-types/commands/GetAgentRecommendationCommand.d.ts +188 -0
  63. package/dist-types/commands/GetAgentRecommendationGenerationCommand.d.ts +123 -0
  64. package/dist-types/commands/GetConsolidatedReportCommand.d.ts +1 -2
  65. package/dist-types/commands/ImportLensCommand.d.ts +1 -20
  66. package/dist-types/commands/ListAgentContextsCommand.d.ts +125 -0
  67. package/dist-types/commands/ListAgentGoalsCommand.d.ts +100 -0
  68. package/dist-types/commands/ListAgentProfilesCommand.d.ts +122 -0
  69. package/dist-types/commands/ListAgentRecommendationGenerationsCommand.d.ts +102 -0
  70. package/dist-types/commands/ListAgentRecommendationItemsCommand.d.ts +101 -0
  71. package/dist-types/commands/ListAgentRecommendationsCommand.d.ts +124 -0
  72. package/dist-types/commands/ListShareInvitationsCommand.d.ts +1 -5
  73. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -4
  74. package/dist-types/commands/PutAgentRecommendationFeedbackCommand.d.ts +87 -0
  75. package/dist-types/commands/StartAgentRecommendationGenerationCommand.d.ts +118 -0
  76. package/dist-types/commands/TagResourceCommand.d.ts +1 -4
  77. package/dist-types/commands/UntagResourceCommand.d.ts +1 -8
  78. package/dist-types/commands/UpdateAgentContextCommand.d.ts +152 -0
  79. package/dist-types/commands/UpdateAgentGoalCommand.d.ts +105 -0
  80. package/dist-types/commands/UpdateAgentProfileCommand.d.ts +137 -0
  81. package/dist-types/commands/UpdateAgentRecommendationStatusCommand.d.ts +86 -0
  82. package/dist-types/commands/UpdateShareInvitationCommand.d.ts +1 -4
  83. package/dist-types/commands/index.d.ts +23 -0
  84. package/dist-types/index.d.ts +1 -6
  85. package/dist-types/models/enums.d.ts +228 -0
  86. package/dist-types/models/models_0.d.ts +2830 -1786
  87. package/dist-types/pagination/ListAgentContextsPaginator.d.ts +7 -0
  88. package/dist-types/pagination/ListAgentGoalsPaginator.d.ts +7 -0
  89. package/dist-types/pagination/ListAgentProfilesPaginator.d.ts +7 -0
  90. package/dist-types/pagination/ListAgentRecommendationGenerationsPaginator.d.ts +7 -0
  91. package/dist-types/pagination/ListAgentRecommendationItemsPaginator.d.ts +7 -0
  92. package/dist-types/pagination/ListAgentRecommendationsPaginator.d.ts +7 -0
  93. package/dist-types/pagination/index.d.ts +6 -0
  94. package/dist-types/schemas/schemas_0.d.ts +92 -0
  95. package/dist-types/ts3.4/WellArchitected.d.ts +434 -0
  96. package/dist-types/ts3.4/WellArchitectedClient.d.ts +138 -0
  97. package/dist-types/ts3.4/commands/CreateAgentContextCommand.d.ts +39 -0
  98. package/dist-types/ts3.4/commands/CreateAgentGoalCommand.d.ts +38 -0
  99. package/dist-types/ts3.4/commands/CreateAgentProfileCommand.d.ts +39 -0
  100. package/dist-types/ts3.4/commands/DeleteAgentContextCommand.d.ts +39 -0
  101. package/dist-types/ts3.4/commands/DeleteAgentGoalCommand.d.ts +38 -0
  102. package/dist-types/ts3.4/commands/DeleteAgentProfileCommand.d.ts +39 -0
  103. package/dist-types/ts3.4/commands/GetAgentContextCommand.d.ts +38 -0
  104. package/dist-types/ts3.4/commands/GetAgentGoalCommand.d.ts +38 -0
  105. package/dist-types/ts3.4/commands/GetAgentProfileCommand.d.ts +38 -0
  106. package/dist-types/ts3.4/commands/GetAgentRecommendationCommand.d.ts +39 -0
  107. package/dist-types/ts3.4/commands/GetAgentRecommendationGenerationCommand.d.ts +42 -0
  108. package/dist-types/ts3.4/commands/ListAgentContextsCommand.d.ts +39 -0
  109. package/dist-types/ts3.4/commands/ListAgentGoalsCommand.d.ts +38 -0
  110. package/dist-types/ts3.4/commands/ListAgentProfilesCommand.d.ts +39 -0
  111. package/dist-types/ts3.4/commands/ListAgentRecommendationGenerationsCommand.d.ts +42 -0
  112. package/dist-types/ts3.4/commands/ListAgentRecommendationItemsCommand.d.ts +42 -0
  113. package/dist-types/ts3.4/commands/ListAgentRecommendationsCommand.d.ts +42 -0
  114. package/dist-types/ts3.4/commands/PutAgentRecommendationFeedbackCommand.d.ts +42 -0
  115. package/dist-types/ts3.4/commands/StartAgentRecommendationGenerationCommand.d.ts +42 -0
  116. package/dist-types/ts3.4/commands/UpdateAgentContextCommand.d.ts +39 -0
  117. package/dist-types/ts3.4/commands/UpdateAgentGoalCommand.d.ts +38 -0
  118. package/dist-types/ts3.4/commands/UpdateAgentProfileCommand.d.ts +39 -0
  119. package/dist-types/ts3.4/commands/UpdateAgentRecommendationStatusCommand.d.ts +42 -0
  120. package/dist-types/ts3.4/commands/index.d.ts +23 -0
  121. package/dist-types/ts3.4/models/enums.d.ts +111 -0
  122. package/dist-types/ts3.4/models/models_0.d.ts +494 -0
  123. package/dist-types/ts3.4/pagination/ListAgentContextsPaginator.d.ts +11 -0
  124. package/dist-types/ts3.4/pagination/ListAgentGoalsPaginator.d.ts +11 -0
  125. package/dist-types/ts3.4/pagination/ListAgentProfilesPaginator.d.ts +11 -0
  126. package/dist-types/ts3.4/pagination/ListAgentRecommendationGenerationsPaginator.d.ts +11 -0
  127. package/dist-types/ts3.4/pagination/ListAgentRecommendationItemsPaginator.d.ts +11 -0
  128. package/dist-types/ts3.4/pagination/ListAgentRecommendationsPaginator.d.ts +11 -0
  129. package/dist-types/ts3.4/pagination/index.d.ts +6 -0
  130. package/dist-types/ts3.4/schemas/schemas_0.d.ts +92 -0
  131. package/package.json +6 -6
@@ -0,0 +1,188 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { GetAgentRecommendationRequest, GetAgentRecommendationResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link GetAgentRecommendationCommand}.
11
+ */
12
+ export interface GetAgentRecommendationCommandInput extends GetAgentRecommendationRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link GetAgentRecommendationCommand}.
18
+ */
19
+ export interface GetAgentRecommendationCommandOutput extends GetAgentRecommendationResponse, __MetadataBearer {
20
+ }
21
+ declare const GetAgentRecommendationCommand_base: {
22
+ new (input: GetAgentRecommendationCommandInput): import("@smithy/core/client").CommandImpl<GetAgentRecommendationCommandInput, GetAgentRecommendationCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: GetAgentRecommendationCommandInput): import("@smithy/core/client").CommandImpl<GetAgentRecommendationCommandInput, GetAgentRecommendationCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { WellArchitectedClient, GetAgentRecommendationCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
32
+ * // const { WellArchitectedClient, GetAgentRecommendationCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
33
+ * // import type { WellArchitectedClientConfig } from "@aws-sdk/client-wellarchitected";
34
+ * const config = {}; // type is WellArchitectedClientConfig
35
+ * const client = new WellArchitectedClient(config);
36
+ * const input = { // GetAgentRecommendationRequest
37
+ * recommendationArn: "STRING_VALUE", // required
38
+ * remediationType: "AUTO_REMEDIATION" || "CONSOLE" || "CLI" || "SDK" || "IAC" || "MCP",
39
+ * };
40
+ * const command = new GetAgentRecommendationCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetAgentRecommendationResponse
43
+ * // recommendationArn: "STRING_VALUE", // required
44
+ * // profileArn: "STRING_VALUE", // required
45
+ * // title: "STRING_VALUE", // required
46
+ * // description: "STRING_VALUE", // required
47
+ * // type: "RESOURCE" || "ARCHITECTURE" || "APPLICATION", // required
48
+ * // pillar: "COST_OPTIMIZATION" || "SECURITY" || "RESILIENCE" || "PERFORMANCE" || "OPERATIONAL_EXCELLENCE", // required
49
+ * // priority: "HIGH" || "MEDIUM" || "LOW", // required
50
+ * // effort: "LARGE" || "MEDIUM" || "SMALL", // required
51
+ * // status: "ACTIVE" || "SUPPRESSED" || "COMPLETED", // required
52
+ * // state: "OPEN" || "CLOSED", // required
53
+ * // updateReason: "STRING_VALUE",
54
+ * // impact: "HIGH" || "MEDIUM" || "LOW", // required
55
+ * // roi: { // Roi
56
+ * // estimate: "STRING_VALUE",
57
+ * // detail: "STRING_VALUE", // required
58
+ * // },
59
+ * // numberOfResources: Number("int"),
60
+ * // awsServices: [ // StringList
61
+ * // "STRING_VALUE",
62
+ * // ],
63
+ * // businessUnits: [
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // applications: [
67
+ * // "STRING_VALUE",
68
+ * // ],
69
+ * // impactDetails: [ // ImpactDetails // required
70
+ * // "STRING_VALUE",
71
+ * // ],
72
+ * // insights: [ // InsightList // required
73
+ * // { // Insight
74
+ * // usagePattern: "STRING_VALUE", // required
75
+ * // signalsDetected: "STRING_VALUE",
76
+ * // },
77
+ * // ],
78
+ * // highlights: [ // Highlights // required
79
+ * // "STRING_VALUE",
80
+ * // ],
81
+ * // remediationSummary: { // RemediationSummary
82
+ * // recommendation: "STRING_VALUE", // required
83
+ * // steps: [ // RecommendedFixSteps // required
84
+ * // "STRING_VALUE",
85
+ * // ],
86
+ * // },
87
+ * // crossPillarBenefits: [ // CrossPillarBenefits
88
+ * // { // CrossPillarBenefit
89
+ * // pillar: "COST_OPTIMIZATION" || "SECURITY" || "RESILIENCE" || "PERFORMANCE" || "OPERATIONAL_EXCELLENCE", // required
90
+ * // title: "STRING_VALUE", // required
91
+ * // description: "STRING_VALUE", // required
92
+ * // impact: "HIGH" || "MEDIUM" || "LOW", // required
93
+ * // },
94
+ * // ],
95
+ * // tradeOffs: [ // TradeOffs
96
+ * // { // TradeOff
97
+ * // pillar: "COST_OPTIMIZATION" || "SECURITY" || "RESILIENCE" || "PERFORMANCE" || "OPERATIONAL_EXCELLENCE", // required
98
+ * // title: "STRING_VALUE", // required
99
+ * // description: "STRING_VALUE", // required
100
+ * // risk: "LOW" || "MEDIUM" || "HIGH", // required
101
+ * // mitigation: "STRING_VALUE", // required
102
+ * // riskExplanation: "STRING_VALUE",
103
+ * // },
104
+ * // ],
105
+ * // sources: [ // RecommendationSourceList
106
+ * // "TRUSTED_ADVISOR" || "COST_EXPLORER" || "CLOUDWATCH" || "WELL_ARCHITECTED_TOOL" || "WELL_ARCHITECTED_AGENT" || "CUSTOMER_IAC",
107
+ * // ],
108
+ * // goals: [ // RecommendationGoals
109
+ * // { // RecommendationGoal
110
+ * // title: "STRING_VALUE", // required
111
+ * // },
112
+ * // ],
113
+ * // tags: [ // Tags
114
+ * // { // Tag
115
+ * // key: "STRING_VALUE", // required
116
+ * // value: "STRING_VALUE", // required
117
+ * // },
118
+ * // ],
119
+ * // createdBy: "STRING_VALUE", // required
120
+ * // createdAt: new Date("TIMESTAMP"), // required
121
+ * // lastModifiedBy: "STRING_VALUE",
122
+ * // lastModifiedAt: new Date("TIMESTAMP"),
123
+ * // remediations: [ // AgentRecommendationRemediations
124
+ * // { // AgentRecommendationRemediation
125
+ * // recommendationArn: "STRING_VALUE", // required
126
+ * // type: "AUTO_REMEDIATION" || "CONSOLE" || "CLI" || "SDK" || "IAC" || "MCP", // required
127
+ * // steps: [ // RemediationSteps // required
128
+ * // { // RemediationStep
129
+ * // title: "STRING_VALUE",
130
+ * // content: "STRING_VALUE", // required
131
+ * // },
132
+ * // ],
133
+ * // resourceLinks: [ // ResourceLinks
134
+ * // { // ResourceLink
135
+ * // url: "STRING_VALUE", // required
136
+ * // title: "STRING_VALUE",
137
+ * // },
138
+ * // ],
139
+ * // createdBy: "STRING_VALUE", // required
140
+ * // createdAt: new Date("TIMESTAMP"), // required
141
+ * // lastModifiedBy: "STRING_VALUE",
142
+ * // lastModifiedAt: new Date("TIMESTAMP"),
143
+ * // },
144
+ * // ],
145
+ * // };
146
+ *
147
+ * ```
148
+ *
149
+ * @param GetAgentRecommendationCommandInput - {@link GetAgentRecommendationCommandInput}
150
+ * @returns {@link GetAgentRecommendationCommandOutput}
151
+ * @see {@link GetAgentRecommendationCommandInput} for command's `input` shape.
152
+ * @see {@link GetAgentRecommendationCommandOutput} for command's `response` shape.
153
+ * @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
154
+ *
155
+ * @throws {@link AccessDeniedException} (client fault)
156
+ * <p>User does not have sufficient access to perform this action.</p>
157
+ *
158
+ * @throws {@link InternalServerException} (server fault)
159
+ * <p>There is a problem with the Well-Architected Tool API service.</p>
160
+ *
161
+ * @throws {@link ResourceNotFoundException} (client fault)
162
+ * <p>The requested resource was not found.</p>
163
+ *
164
+ * @throws {@link ThrottlingException} (client fault)
165
+ * <p>Request was denied due to request throttling.</p>
166
+ *
167
+ * @throws {@link ValidationException} (client fault)
168
+ * <p>The user input is not valid.</p>
169
+ *
170
+ * @throws {@link WellArchitectedServiceException}
171
+ * <p>Base exception class for all service exceptions from WellArchitected service.</p>
172
+ *
173
+ *
174
+ * @public
175
+ */
176
+ export declare class GetAgentRecommendationCommand extends GetAgentRecommendationCommand_base {
177
+ /** @internal type navigation helper, not in runtime. */
178
+ protected static __types: {
179
+ api: {
180
+ input: GetAgentRecommendationRequest;
181
+ output: GetAgentRecommendationResponse;
182
+ };
183
+ sdk: {
184
+ input: GetAgentRecommendationCommandInput;
185
+ output: GetAgentRecommendationCommandOutput;
186
+ };
187
+ };
188
+ }
@@ -0,0 +1,123 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { GetAgentRecommendationGenerationRequest, GetAgentRecommendationGenerationResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link GetAgentRecommendationGenerationCommand}.
11
+ */
12
+ export interface GetAgentRecommendationGenerationCommandInput extends GetAgentRecommendationGenerationRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link GetAgentRecommendationGenerationCommand}.
18
+ */
19
+ export interface GetAgentRecommendationGenerationCommandOutput extends GetAgentRecommendationGenerationResponse, __MetadataBearer {
20
+ }
21
+ declare const GetAgentRecommendationGenerationCommand_base: {
22
+ new (input: GetAgentRecommendationGenerationCommandInput): import("@smithy/core/client").CommandImpl<GetAgentRecommendationGenerationCommandInput, GetAgentRecommendationGenerationCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: GetAgentRecommendationGenerationCommandInput): import("@smithy/core/client").CommandImpl<GetAgentRecommendationGenerationCommandInput, GetAgentRecommendationGenerationCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves information about a recommendation generation process, including its status, progress, and results. Recommendation generation is asynchronous: poll this operation until status reaches a terminal value of COMPLETED (results are ready) or ERROR (see errorDetails). Intermediate values are QUEUED and IN_PROGRESS.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { WellArchitectedClient, GetAgentRecommendationGenerationCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
32
+ * // const { WellArchitectedClient, GetAgentRecommendationGenerationCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
33
+ * // import type { WellArchitectedClientConfig } from "@aws-sdk/client-wellarchitected";
34
+ * const config = {}; // type is WellArchitectedClientConfig
35
+ * const client = new WellArchitectedClient(config);
36
+ * const input = { // GetAgentRecommendationGenerationRequest
37
+ * profileArn: "STRING_VALUE", // required
38
+ * generationId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetAgentRecommendationGenerationCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetAgentRecommendationGenerationResponse
43
+ * // id: "STRING_VALUE", // required
44
+ * // profileArn: "STRING_VALUE", // required
45
+ * // name: "STRING_VALUE",
46
+ * // status: "QUEUED" || "IN_PROGRESS" || "COMPLETED" || "ERROR", // required
47
+ * // estimatedCompletionTime: new Date("TIMESTAMP"),
48
+ * // createdBy: "STRING_VALUE", // required
49
+ * // createdAt: new Date("TIMESTAMP"), // required
50
+ * // lastModifiedBy: "STRING_VALUE",
51
+ * // lastModifiedAt: new Date("TIMESTAMP"),
52
+ * // additionalContext: "DOCUMENT_VALUE",
53
+ * // scope: { // Scope
54
+ * // pillars: [ // Pillars // required
55
+ * // "COST_OPTIMIZATION" || "SECURITY" || "RESILIENCE" || "PERFORMANCE" || "OPERATIONAL_EXCELLENCE",
56
+ * // ],
57
+ * // goalIds: [ // GoalIdList
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // items: [ // PillarItems
61
+ * // { // PillarItem
62
+ * // pillar: "COST_OPTIMIZATION" || "SECURITY" || "RESILIENCE" || "PERFORMANCE" || "OPERATIONAL_EXCELLENCE", // required
63
+ * // ids: [ // ItemIds // required
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // },
67
+ * // ],
68
+ * // },
69
+ * // startedAt: new Date("TIMESTAMP"),
70
+ * // endedAt: new Date("TIMESTAMP"),
71
+ * // progress: { // Progress
72
+ * // stepsCompleted: Number("int"), // required
73
+ * // totalSteps: Number("int"), // required
74
+ * // completionPercentage: Number("double"), // required
75
+ * // },
76
+ * // errorDetails: { // ErrorDetails
77
+ * // code: "STRING_VALUE", // required
78
+ * // message: "STRING_VALUE", // required
79
+ * // },
80
+ * // };
81
+ *
82
+ * ```
83
+ *
84
+ * @param GetAgentRecommendationGenerationCommandInput - {@link GetAgentRecommendationGenerationCommandInput}
85
+ * @returns {@link GetAgentRecommendationGenerationCommandOutput}
86
+ * @see {@link GetAgentRecommendationGenerationCommandInput} for command's `input` shape.
87
+ * @see {@link GetAgentRecommendationGenerationCommandOutput} for command's `response` shape.
88
+ * @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
89
+ *
90
+ * @throws {@link AccessDeniedException} (client fault)
91
+ * <p>User does not have sufficient access to perform this action.</p>
92
+ *
93
+ * @throws {@link InternalServerException} (server fault)
94
+ * <p>There is a problem with the Well-Architected Tool API service.</p>
95
+ *
96
+ * @throws {@link ResourceNotFoundException} (client fault)
97
+ * <p>The requested resource was not found.</p>
98
+ *
99
+ * @throws {@link ThrottlingException} (client fault)
100
+ * <p>Request was denied due to request throttling.</p>
101
+ *
102
+ * @throws {@link ValidationException} (client fault)
103
+ * <p>The user input is not valid.</p>
104
+ *
105
+ * @throws {@link WellArchitectedServiceException}
106
+ * <p>Base exception class for all service exceptions from WellArchitected service.</p>
107
+ *
108
+ *
109
+ * @public
110
+ */
111
+ export declare class GetAgentRecommendationGenerationCommand extends GetAgentRecommendationGenerationCommand_base {
112
+ /** @internal type navigation helper, not in runtime. */
113
+ protected static __types: {
114
+ api: {
115
+ input: GetAgentRecommendationGenerationRequest;
116
+ output: GetAgentRecommendationGenerationResponse;
117
+ };
118
+ sdk: {
119
+ input: GetAgentRecommendationGenerationCommandInput;
120
+ output: GetAgentRecommendationGenerationCommandOutput;
121
+ };
122
+ };
123
+ }
@@ -24,8 +24,7 @@ declare const GetConsolidatedReportCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Get a consolidated report of your workloads.</p>
28
- * <p>You can optionally choose to include workloads that have been shared with you.</p>
27
+ * <p>Get a consolidated report of your workloads.</p> <p>You can optionally choose to include workloads that have been shared with you.</p>
29
28
  * @example
30
29
  * Use a bare-bones client and the command you need to make an API call.
31
30
  * ```javascript
@@ -24,26 +24,7 @@ declare const ImportLensCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Import a new custom lens or update an existing custom lens.</p>
28
- * <p>To update an existing custom lens, specify its ARN as the <code>LensAlias</code>. If
29
- * no ARN is specified, a new custom lens is created.</p>
30
- * <p>The new or updated lens will have a status of <code>DRAFT</code>. The lens cannot be
31
- * applied to workloads or shared with other Amazon Web Services accounts until it's
32
- * published with <a>CreateLensVersion</a>.</p>
33
- * <p>Lenses are defined in JSON. For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html">JSON format specification</a>
34
- * in the <i>Well-Architected Tool User Guide</i>.</p>
35
- * <p>A custom lens cannot exceed 500 KB in size.</p>
36
- * <note>
37
- * <p>
38
- * <b>Disclaimer</b>
39
- * </p>
40
- * <p>Do not include or gather personal identifiable information (PII) of end users or
41
- * other identifiable individuals in or via your custom lenses. If your custom
42
- * lens or those shared with you and used in your account do include or collect
43
- * PII you are responsible for: ensuring that the included PII is processed in accordance
44
- * with applicable law, providing adequate privacy notices, and obtaining necessary
45
- * consents for processing such data.</p>
46
- * </note>
27
+ * <p>Import a new custom lens or update an existing custom lens.</p> <p>To update an existing custom lens, specify its ARN as the <code>LensAlias</code>. If no ARN is specified, a new custom lens is created.</p> <p>The new or updated lens will have a status of <code>DRAFT</code>. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with <a>CreateLensVersion</a>.</p> <p>Lenses are defined in JSON. For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html">JSON format specification</a> in the <i>Well-Architected Tool User Guide</i>.</p> <p>A custom lens cannot exceed 500 KB in size.</p> <note> <p> <b>Disclaimer</b> </p> <p>Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.</p> </note>
47
28
  * @example
48
29
  * Use a bare-bones client and the command you need to make an API call.
49
30
  * ```javascript
@@ -0,0 +1,125 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { ListAgentContextsRequest, ListAgentContextsResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link ListAgentContextsCommand}.
11
+ */
12
+ export interface ListAgentContextsCommandInput extends ListAgentContextsRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link ListAgentContextsCommand}.
18
+ */
19
+ export interface ListAgentContextsCommandOutput extends ListAgentContextsResponse, __MetadataBearer {
20
+ }
21
+ declare const ListAgentContextsCommand_base: {
22
+ new (input: ListAgentContextsCommandInput): import("@smithy/core/client").CommandImpl<ListAgentContextsCommandInput, ListAgentContextsCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: ListAgentContextsCommandInput): import("@smithy/core/client").CommandImpl<ListAgentContextsCommandInput, ListAgentContextsCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Lists contexts associated with a profile.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { WellArchitectedClient, ListAgentContextsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
32
+ * // const { WellArchitectedClient, ListAgentContextsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
33
+ * // import type { WellArchitectedClientConfig } from "@aws-sdk/client-wellarchitected";
34
+ * const config = {}; // type is WellArchitectedClientConfig
35
+ * const client = new WellArchitectedClient(config);
36
+ * const input = { // ListAgentContextsRequest
37
+ * profileArn: "STRING_VALUE", // required
38
+ * maxResults: Number("int"),
39
+ * nextToken: "STRING_VALUE",
40
+ * };
41
+ * const command = new ListAgentContextsCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // ListAgentContextsResponse
44
+ * // items: [ // ContextSummaries // required
45
+ * // { // ContextSummary
46
+ * // id: "STRING_VALUE", // required
47
+ * // profileArn: "STRING_VALUE", // required
48
+ * // title: "STRING_VALUE", // required
49
+ * // contextType: "APPLICATION", // required
50
+ * // content: { // ContextContent
51
+ * // accountIds: [ // ContextAccountIdList
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // regions: [ // ContextRegionList
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // awsServices: [ // ContextAwsServiceList
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // resourceTypes: [ // ContextResourceTypeList
61
+ * // "STRING_VALUE",
62
+ * // ],
63
+ * // resourceTags: [ // ContextResourceTagList
64
+ * // { // ContextResourceTag
65
+ * // key: "STRING_VALUE", // required
66
+ * // value: "STRING_VALUE", // required
67
+ * // },
68
+ * // ],
69
+ * // applicationOverview: "STRING_VALUE",
70
+ * // industry: "STRING_VALUE",
71
+ * // applicationType: "SAS" || "DESKTOP_APPLICATION" || "OTHER",
72
+ * // criticality: "MISSION_CRITICAL" || "BUSINESS_CRITICAL" || "NON_CRITICAL" || "TEST_DEVELOPMENT",
73
+ * // architectureOverview: "STRING_VALUE",
74
+ * // additionalContext: "STRING_VALUE",
75
+ * // },
76
+ * // applicationType: "SAS" || "DESKTOP_APPLICATION" || "OTHER",
77
+ * // criticality: "MISSION_CRITICAL" || "BUSINESS_CRITICAL" || "NON_CRITICAL" || "TEST_DEVELOPMENT",
78
+ * // createdBy: "STRING_VALUE", // required
79
+ * // createdAt: new Date("TIMESTAMP"), // required
80
+ * // lastModifiedBy: "STRING_VALUE",
81
+ * // lastModifiedAt: new Date("TIMESTAMP"),
82
+ * // },
83
+ * // ],
84
+ * // nextToken: "STRING_VALUE",
85
+ * // };
86
+ *
87
+ * ```
88
+ *
89
+ * @param ListAgentContextsCommandInput - {@link ListAgentContextsCommandInput}
90
+ * @returns {@link ListAgentContextsCommandOutput}
91
+ * @see {@link ListAgentContextsCommandInput} for command's `input` shape.
92
+ * @see {@link ListAgentContextsCommandOutput} for command's `response` shape.
93
+ * @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
94
+ *
95
+ * @throws {@link AccessDeniedException} (client fault)
96
+ * <p>User does not have sufficient access to perform this action.</p>
97
+ *
98
+ * @throws {@link InternalServerException} (server fault)
99
+ * <p>There is a problem with the Well-Architected Tool API service.</p>
100
+ *
101
+ * @throws {@link ThrottlingException} (client fault)
102
+ * <p>Request was denied due to request throttling.</p>
103
+ *
104
+ * @throws {@link ValidationException} (client fault)
105
+ * <p>The user input is not valid.</p>
106
+ *
107
+ * @throws {@link WellArchitectedServiceException}
108
+ * <p>Base exception class for all service exceptions from WellArchitected service.</p>
109
+ *
110
+ *
111
+ * @public
112
+ */
113
+ export declare class ListAgentContextsCommand extends ListAgentContextsCommand_base {
114
+ /** @internal type navigation helper, not in runtime. */
115
+ protected static __types: {
116
+ api: {
117
+ input: ListAgentContextsRequest;
118
+ output: ListAgentContextsResponse;
119
+ };
120
+ sdk: {
121
+ input: ListAgentContextsCommandInput;
122
+ output: ListAgentContextsCommandOutput;
123
+ };
124
+ };
125
+ }
@@ -0,0 +1,100 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { ListAgentGoalsRequest, ListAgentGoalsResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link ListAgentGoalsCommand}.
11
+ */
12
+ export interface ListAgentGoalsCommandInput extends ListAgentGoalsRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link ListAgentGoalsCommand}.
18
+ */
19
+ export interface ListAgentGoalsCommandOutput extends ListAgentGoalsResponse, __MetadataBearer {
20
+ }
21
+ declare const ListAgentGoalsCommand_base: {
22
+ new (input: ListAgentGoalsCommandInput): import("@smithy/core/client").CommandImpl<ListAgentGoalsCommandInput, ListAgentGoalsCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: ListAgentGoalsCommandInput): import("@smithy/core/client").CommandImpl<ListAgentGoalsCommandInput, ListAgentGoalsCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Lists optimization goals associated with a specified profile. Goals define specific targets and objectives for the optimization process.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { WellArchitectedClient, ListAgentGoalsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
32
+ * // const { WellArchitectedClient, ListAgentGoalsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
33
+ * // import type { WellArchitectedClientConfig } from "@aws-sdk/client-wellarchitected";
34
+ * const config = {}; // type is WellArchitectedClientConfig
35
+ * const client = new WellArchitectedClient(config);
36
+ * const input = { // ListAgentGoalsRequest
37
+ * profileArn: "STRING_VALUE", // required
38
+ * maxResults: Number("int"),
39
+ * nextToken: "STRING_VALUE",
40
+ * };
41
+ * const command = new ListAgentGoalsCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // ListAgentGoalsResponse
44
+ * // items: [ // GoalSummaries // required
45
+ * // { // GoalSummary
46
+ * // id: "STRING_VALUE", // required
47
+ * // profileArn: "STRING_VALUE", // required
48
+ * // pillars: [ // Pillars // required
49
+ * // "COST_OPTIMIZATION" || "SECURITY" || "RESILIENCE" || "PERFORMANCE" || "OPERATIONAL_EXCELLENCE",
50
+ * // ],
51
+ * // title: "STRING_VALUE", // required
52
+ * // description: "STRING_VALUE",
53
+ * // createdBy: "STRING_VALUE", // required
54
+ * // createdAt: new Date("TIMESTAMP"), // required
55
+ * // lastModifiedBy: "STRING_VALUE",
56
+ * // lastModifiedAt: new Date("TIMESTAMP"),
57
+ * // },
58
+ * // ],
59
+ * // nextToken: "STRING_VALUE",
60
+ * // };
61
+ *
62
+ * ```
63
+ *
64
+ * @param ListAgentGoalsCommandInput - {@link ListAgentGoalsCommandInput}
65
+ * @returns {@link ListAgentGoalsCommandOutput}
66
+ * @see {@link ListAgentGoalsCommandInput} for command's `input` shape.
67
+ * @see {@link ListAgentGoalsCommandOutput} for command's `response` shape.
68
+ * @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
69
+ *
70
+ * @throws {@link AccessDeniedException} (client fault)
71
+ * <p>User does not have sufficient access to perform this action.</p>
72
+ *
73
+ * @throws {@link InternalServerException} (server fault)
74
+ * <p>There is a problem with the Well-Architected Tool API service.</p>
75
+ *
76
+ * @throws {@link ThrottlingException} (client fault)
77
+ * <p>Request was denied due to request throttling.</p>
78
+ *
79
+ * @throws {@link ValidationException} (client fault)
80
+ * <p>The user input is not valid.</p>
81
+ *
82
+ * @throws {@link WellArchitectedServiceException}
83
+ * <p>Base exception class for all service exceptions from WellArchitected service.</p>
84
+ *
85
+ *
86
+ * @public
87
+ */
88
+ export declare class ListAgentGoalsCommand extends ListAgentGoalsCommand_base {
89
+ /** @internal type navigation helper, not in runtime. */
90
+ protected static __types: {
91
+ api: {
92
+ input: ListAgentGoalsRequest;
93
+ output: ListAgentGoalsResponse;
94
+ };
95
+ sdk: {
96
+ input: ListAgentGoalsCommandInput;
97
+ output: ListAgentGoalsCommandOutput;
98
+ };
99
+ };
100
+ }