@aws-sdk/client-wellarchitected 3.301.0 → 3.306.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 (60) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/WellArchitected.js +15 -0
  3. package/dist-cjs/commands/GetConsolidatedReportCommand.js +45 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/endpoint/ruleset.js +3 -3
  6. package/dist-cjs/models/models_0.js +132 -148
  7. package/dist-cjs/pagination/GetConsolidatedReportPaginator.js +29 -0
  8. package/dist-cjs/pagination/index.js +1 -0
  9. package/dist-cjs/protocols/Aws_restJson1.js +177 -2
  10. package/dist-es/WellArchitected.js +15 -0
  11. package/dist-es/commands/GetConsolidatedReportCommand.js +41 -0
  12. package/dist-es/commands/index.js +1 -0
  13. package/dist-es/endpoint/ruleset.js +3 -3
  14. package/dist-es/models/models_0.js +131 -147
  15. package/dist-es/pagination/GetConsolidatedReportPaginator.js +25 -0
  16. package/dist-es/pagination/index.js +1 -0
  17. package/dist-es/protocols/Aws_restJson1.js +173 -0
  18. package/dist-types/WellArchitected.d.ts +69 -43
  19. package/dist-types/WellArchitectedClient.d.ts +3 -3
  20. package/dist-types/commands/AssociateLensesCommand.d.ts +3 -3
  21. package/dist-types/commands/CreateLensShareCommand.d.ts +9 -3
  22. package/dist-types/commands/CreateLensVersionCommand.d.ts +6 -4
  23. package/dist-types/commands/CreateMilestoneCommand.d.ts +1 -1
  24. package/dist-types/commands/CreateWorkloadCommand.d.ts +13 -3
  25. package/dist-types/commands/CreateWorkloadShareCommand.d.ts +5 -3
  26. package/dist-types/commands/DeleteLensCommand.d.ts +3 -3
  27. package/dist-types/commands/DeleteLensShareCommand.d.ts +3 -3
  28. package/dist-types/commands/DeleteWorkloadCommand.d.ts +1 -1
  29. package/dist-types/commands/DeleteWorkloadShareCommand.d.ts +1 -1
  30. package/dist-types/commands/DisassociateLensesCommand.d.ts +4 -4
  31. package/dist-types/commands/ExportLensCommand.d.ts +5 -4
  32. package/dist-types/commands/GetConsolidatedReportCommand.d.ts +82 -0
  33. package/dist-types/commands/ImportLensCommand.d.ts +10 -9
  34. package/dist-types/commands/ListAnswersCommand.d.ts +1 -1
  35. package/dist-types/commands/ListLensReviewsCommand.d.ts +1 -1
  36. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  37. package/dist-types/commands/ListWorkloadsCommand.d.ts +1 -1
  38. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  39. package/dist-types/commands/UntagResourceCommand.d.ts +3 -4
  40. package/dist-types/commands/UpdateAnswerCommand.d.ts +1 -1
  41. package/dist-types/commands/UpdateGlobalSettingsCommand.d.ts +1 -1
  42. package/dist-types/commands/UpdateLensReviewCommand.d.ts +2 -2
  43. package/dist-types/commands/UpdateShareInvitationCommand.d.ts +2 -2
  44. package/dist-types/commands/UpdateWorkloadCommand.d.ts +1 -1
  45. package/dist-types/commands/UpdateWorkloadShareCommand.d.ts +1 -1
  46. package/dist-types/commands/UpgradeLensReviewCommand.d.ts +2 -2
  47. package/dist-types/commands/index.d.ts +1 -0
  48. package/dist-types/models/models_0.d.ts +833 -445
  49. package/dist-types/pagination/GetConsolidatedReportPaginator.d.ts +7 -0
  50. package/dist-types/pagination/index.d.ts +1 -0
  51. package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
  52. package/dist-types/ts3.4/WellArchitected.d.ts +17 -0
  53. package/dist-types/ts3.4/WellArchitectedClient.d.ts +6 -0
  54. package/dist-types/ts3.4/commands/GetConsolidatedReportCommand.d.ts +41 -0
  55. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  56. package/dist-types/ts3.4/models/models_0.d.ts +210 -124
  57. package/dist-types/ts3.4/pagination/GetConsolidatedReportPaginator.d.ts +11 -0
  58. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  59. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  60. package/package.json +34 -34
@@ -12,6 +12,7 @@ import { DeleteWorkloadShareCommandInput, DeleteWorkloadShareCommandOutput } fro
12
12
  import { DisassociateLensesCommandInput, DisassociateLensesCommandOutput } from "./commands/DisassociateLensesCommand";
13
13
  import { ExportLensCommandInput, ExportLensCommandOutput } from "./commands/ExportLensCommand";
14
14
  import { GetAnswerCommandInput, GetAnswerCommandOutput } from "./commands/GetAnswerCommand";
15
+ import { GetConsolidatedReportCommandInput, GetConsolidatedReportCommandOutput } from "./commands/GetConsolidatedReportCommand";
15
16
  import { GetLensCommandInput, GetLensCommandOutput } from "./commands/GetLensCommand";
16
17
  import { GetLensReviewCommandInput, GetLensReviewCommandOutput } from "./commands/GetLensReviewCommand";
17
18
  import { GetLensReviewReportCommandInput, GetLensReviewReportCommandOutput } from "./commands/GetLensReviewReportCommand";
@@ -45,7 +46,6 @@ import { WellArchitectedClient } from "./WellArchitectedClient";
45
46
  /**
46
47
  * @public
47
48
  * <fullname>Well-Architected Tool</fullname>
48
- *
49
49
  * <p>This is the <i>Well-Architected Tool API Reference</i>. The WA Tool API provides programmatic access to the
50
50
  * <a href="http://aws.amazon.com/well-architected-tool">Well-Architected Tool</a> in the
51
51
  * <a href="https://console.aws.amazon.com/wellarchitected">Amazon Web Services Management Console</a>. For information
@@ -56,9 +56,9 @@ export declare class WellArchitected extends WellArchitectedClient {
56
56
  /**
57
57
  * @public
58
58
  * <p>Associate a lens to a workload.</p>
59
- * <p>Up to 10 lenses can be associated with a workload in a single API operation. A
59
+ * <p>Up to 10 lenses can be associated with a workload in a single API operation. A
60
60
  * maximum of 20 lenses can be associated with a workload.</p>
61
- * <note>
61
+ * <note>
62
62
  * <p>
63
63
  * <b>Disclaimer</b>
64
64
  * </p>
@@ -73,10 +73,16 @@ export declare class WellArchitected extends WellArchitectedClient {
73
73
  /**
74
74
  * @public
75
75
  * <p>Create a lens share.</p>
76
- * <p>The owner of a lens can share it with other Amazon Web Services accounts, IAM users, an organization,
76
+ * <p>The owner of a lens can share it with other Amazon Web Services accounts, users, an organization,
77
77
  * and organizational units (OUs) in the same Amazon Web Services Region.
78
+ * Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.</p>
79
+ * <p>
78
80
  * Shared access to a lens is not removed until the lens invitation is deleted.</p>
79
- * <note>
81
+ * <p>If you share a lens with an organization or OU, all accounts in the organization or OU
82
+ * are granted access to the lens.</p>
83
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-sharing.html">Sharing a custom lens</a> in the
84
+ * <i>Well-Architected Tool User Guide</i>.</p>
85
+ * <note>
80
86
  * <p>
81
87
  * <b>Disclaimer</b>
82
88
  * </p>
@@ -94,9 +100,11 @@ export declare class WellArchitected extends WellArchitectedClient {
94
100
  /**
95
101
  * @public
96
102
  * <p>Create a new lens version.</p>
97
- * <p>A lens can have up to 100 versions.</p>
98
- * <p>After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other
99
- * Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
103
+ * <p>A lens can have up to 100 versions.</p>
104
+ * <p>Use this operation to publish a new lens version after you have imported a lens. The <code>LensAlias</code>
105
+ * is used to identify the lens to be published.
106
+ * The owner of a lens can share the lens with other
107
+ * Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
100
108
  * </p>
101
109
  */
102
110
  createLensVersion(args: CreateLensVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateLensVersionCommandOutput>;
@@ -112,11 +120,18 @@ export declare class WellArchitected extends WellArchitectedClient {
112
120
  /**
113
121
  * @public
114
122
  * <p>Create a new workload.</p>
115
- * <p>The owner of a workload can share the workload with other Amazon Web Services accounts, IAM users,
123
+ * <p>The owner of a workload can share the workload with other Amazon Web Services accounts, users,
116
124
  * an organization, and organizational units (OUs)
117
125
  * in the same Amazon Web Services Region. Only the owner of a workload can delete it.</p>
118
- * <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html">Defining a Workload</a> in the
126
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html">Defining a Workload</a> in the
119
127
  * <i>Well-Architected Tool User Guide</i>.</p>
128
+ * <important>
129
+ * <p>Either <code>AwsRegions</code>, <code>NonAwsRegions</code>, or both must be specified when
130
+ * creating a workload.</p>
131
+ * <p>You also must specify <code>ReviewOwner</code>, even though the
132
+ * parameter is listed as not being required in the following section.
133
+ * </p>
134
+ * </important>
120
135
  */
121
136
  createWorkload(args: CreateWorkloadCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkloadCommandOutput>;
122
137
  createWorkload(args: CreateWorkloadCommandInput, cb: (err: any, data?: CreateWorkloadCommandOutput) => void): void;
@@ -124,10 +139,12 @@ export declare class WellArchitected extends WellArchitectedClient {
124
139
  /**
125
140
  * @public
126
141
  * <p>Create a workload share.</p>
127
- * <p>The owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same
142
+ * <p>The owner of a workload can share it with other Amazon Web Services accounts and users in the same
128
143
  * Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is
129
144
  * deleted.</p>
130
- * <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html">Sharing a Workload</a> in the
145
+ * <p>If you share a workload with an organization or OU, all accounts in the organization or OU
146
+ * are granted access to the workload.</p>
147
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html">Sharing a workload</a> in the
131
148
  * <i>Well-Architected Tool User Guide</i>.</p>
132
149
  */
133
150
  createWorkloadShare(args: CreateWorkloadShareCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkloadShareCommandOutput>;
@@ -136,10 +153,10 @@ export declare class WellArchitected extends WellArchitectedClient {
136
153
  /**
137
154
  * @public
138
155
  * <p>Delete an existing lens.</p>
139
- * <p>Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM users
156
+ * <p>Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users
140
157
  * that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
141
158
  * </p>
142
- * <note>
159
+ * <note>
143
160
  * <p>
144
161
  * <b>Disclaimer</b>
145
162
  * </p>
@@ -157,10 +174,10 @@ export declare class WellArchitected extends WellArchitectedClient {
157
174
  /**
158
175
  * @public
159
176
  * <p>Delete a lens share.</p>
160
- * <p>After the lens share is deleted, Amazon Web Services accounts, IAM users, organizations,
177
+ * <p>After the lens share is deleted, Amazon Web Services accounts, users, organizations,
161
178
  * and organizational units (OUs)
162
179
  * that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.</p>
163
- * <note>
180
+ * <note>
164
181
  * <p>
165
182
  * <b>Disclaimer</b>
166
183
  * </p>
@@ -192,11 +209,11 @@ export declare class WellArchitected extends WellArchitectedClient {
192
209
  /**
193
210
  * @public
194
211
  * <p>Disassociate a lens from a workload.</p>
195
- * <p>Up to 10 lenses can be disassociated from a workload in a single API operation.</p>
196
- * <note>
212
+ * <p>Up to 10 lenses can be disassociated from a workload in a single API operation.</p>
213
+ * <note>
197
214
  * <p>The Amazon Web Services Well-Architected Framework lens (<code>wellarchitected</code>) cannot be
198
215
  * removed from a workload.</p>
199
- * </note>
216
+ * </note>
200
217
  */
201
218
  disassociateLenses(args: DisassociateLensesCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateLensesCommandOutput>;
202
219
  disassociateLenses(args: DisassociateLensesCommandInput, cb: (err: any, data?: DisassociateLensesCommandOutput) => void): void;
@@ -204,10 +221,11 @@ export declare class WellArchitected extends WellArchitectedClient {
204
221
  /**
205
222
  * @public
206
223
  * <p>Export an existing lens.</p>
207
- * <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>
208
- * in the <i>Well-Architected Tool User Guide</i>. Only the owner of a lens can export it.
209
- * </p>
210
- * <note>
224
+ * <p>Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content)
225
+ * cannot be exported.</p>
226
+ * <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>
227
+ * in the <i>Well-Architected Tool User Guide</i>.</p>
228
+ * <note>
211
229
  * <p>
212
230
  * <b>Disclaimer</b>
213
231
  * </p>
@@ -229,6 +247,14 @@ export declare class WellArchitected extends WellArchitectedClient {
229
247
  getAnswer(args: GetAnswerCommandInput, options?: __HttpHandlerOptions): Promise<GetAnswerCommandOutput>;
230
248
  getAnswer(args: GetAnswerCommandInput, cb: (err: any, data?: GetAnswerCommandOutput) => void): void;
231
249
  getAnswer(args: GetAnswerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAnswerCommandOutput) => void): void;
250
+ /**
251
+ * @public
252
+ * <p>Get a consolidated report of your workloads.</p>
253
+ * <p>You can optionally choose to include workloads that have been shared with you.</p>
254
+ */
255
+ getConsolidatedReport(args: GetConsolidatedReportCommandInput, options?: __HttpHandlerOptions): Promise<GetConsolidatedReportCommandOutput>;
256
+ getConsolidatedReport(args: GetConsolidatedReportCommandInput, cb: (err: any, data?: GetConsolidatedReportCommandOutput) => void): void;
257
+ getConsolidatedReport(args: GetConsolidatedReportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConsolidatedReportCommandOutput) => void): void;
232
258
  /**
233
259
  * @public
234
260
  * <p>Get an existing lens.</p>
@@ -273,15 +299,16 @@ export declare class WellArchitected extends WellArchitectedClient {
273
299
  getWorkload(args: GetWorkloadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkloadCommandOutput) => void): void;
274
300
  /**
275
301
  * @public
276
- * <p>Import a new lens.</p>
277
- * <p>The lens cannot be applied to workloads or shared with other Amazon Web Services accounts
278
- * until it's published with <a>CreateLensVersion</a>
279
- * </p>
280
- * <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>
302
+ * <p>Import a new custom lens or update an existing custom lens.</p>
303
+ * <p>To update an existing custom lens, specify its ARN as the <code>LensAlias</code>. If
304
+ * no ARN is specified, a new custom lens is created.</p>
305
+ * <p>The new or updated lens will have a status of <code>DRAFT</code>. The lens cannot be
306
+ * applied to workloads or shared with other Amazon Web Services accounts until it's
307
+ * published with <a>CreateLensVersion</a>.</p>
308
+ * <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>
281
309
  * in the <i>Well-Architected Tool User Guide</i>.</p>
282
- * <p>A custom lens cannot exceed 500 KB in size.</p>
283
- *
284
- * <note>
310
+ * <p>A custom lens cannot exceed 500 KB in size.</p>
311
+ * <note>
285
312
  * <p>
286
313
  * <b>Disclaimer</b>
287
314
  * </p>
@@ -298,7 +325,7 @@ export declare class WellArchitected extends WellArchitectedClient {
298
325
  importLens(args: ImportLensCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportLensCommandOutput) => void): void;
299
326
  /**
300
327
  * @public
301
- * <p>List of answers.</p>
328
+ * <p>List of answers for a particular workload and lens.</p>
302
329
  */
303
330
  listAnswers(args: ListAnswersCommandInput, options?: __HttpHandlerOptions): Promise<ListAnswersCommandOutput>;
304
331
  listAnswers(args: ListAnswersCommandInput, cb: (err: any, data?: ListAnswersCommandOutput) => void): void;
@@ -333,7 +360,7 @@ export declare class WellArchitected extends WellArchitectedClient {
333
360
  listLensReviewImprovements(args: ListLensReviewImprovementsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLensReviewImprovementsCommandOutput) => void): void;
334
361
  /**
335
362
  * @public
336
- * <p>List lens reviews.</p>
363
+ * <p>List lens reviews for a particular workload.</p>
337
364
  */
338
365
  listLensReviews(args: ListLensReviewsCommandInput, options?: __HttpHandlerOptions): Promise<ListLensReviewsCommandOutput>;
339
366
  listLensReviews(args: ListLensReviewsCommandInput, cb: (err: any, data?: ListLensReviewsCommandOutput) => void): void;
@@ -369,7 +396,7 @@ export declare class WellArchitected extends WellArchitectedClient {
369
396
  /**
370
397
  * @public
371
398
  * <p>List the tags for a resource.</p>
372
- * <note>
399
+ * <note>
373
400
  * <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p>
374
401
  * </note>
375
402
  */
@@ -378,7 +405,7 @@ export declare class WellArchitected extends WellArchitectedClient {
378
405
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
379
406
  /**
380
407
  * @public
381
- * <p>List workloads. Paginated.</p>
408
+ * <p>Paginated list of workloads.</p>
382
409
  */
383
410
  listWorkloads(args: ListWorkloadsCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkloadsCommandOutput>;
384
411
  listWorkloads(args: ListWorkloadsCommandInput, cb: (err: any, data?: ListWorkloadsCommandOutput) => void): void;
@@ -393,7 +420,7 @@ export declare class WellArchitected extends WellArchitectedClient {
393
420
  /**
394
421
  * @public
395
422
  * <p>Adds one or more tags to the specified resource.</p>
396
- * <note>
423
+ * <note>
397
424
  * <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p>
398
425
  * </note>
399
426
  */
@@ -403,12 +430,11 @@ export declare class WellArchitected extends WellArchitectedClient {
403
430
  /**
404
431
  * @public
405
432
  * <p>Deletes specified tags from a resource.</p>
406
- * <note>
433
+ * <note>
407
434
  * <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p>
408
435
  * </note>
409
- *
410
- * <p>To specify multiple tags, use separate <b>tagKeys</b> parameters, for example:</p>
411
- * <p>
436
+ * <p>To specify multiple tags, use separate <b>tagKeys</b> parameters, for example:</p>
437
+ * <p>
412
438
  * <code>DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2</code>
413
439
  * </p>
414
440
  */
@@ -431,7 +457,7 @@ export declare class WellArchitected extends WellArchitectedClient {
431
457
  updateGlobalSettings(args: UpdateGlobalSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void): void;
432
458
  /**
433
459
  * @public
434
- * <p>Update lens review.</p>
460
+ * <p>Update lens review for a particular workload.</p>
435
461
  */
436
462
  updateLensReview(args: UpdateLensReviewCommandInput, options?: __HttpHandlerOptions): Promise<UpdateLensReviewCommandOutput>;
437
463
  updateLensReview(args: UpdateLensReviewCommandInput, cb: (err: any, data?: UpdateLensReviewCommandOutput) => void): void;
@@ -439,7 +465,7 @@ export declare class WellArchitected extends WellArchitectedClient {
439
465
  /**
440
466
  * @public
441
467
  * <p>Update a workload or custom lens share invitation.</p>
442
- * <note>
468
+ * <note>
443
469
  * <p>This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.</p>
444
470
  * </note>
445
471
  */
@@ -462,7 +488,7 @@ export declare class WellArchitected extends WellArchitectedClient {
462
488
  updateWorkloadShare(args: UpdateWorkloadShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkloadShareCommandOutput) => void): void;
463
489
  /**
464
490
  * @public
465
- * <p>Upgrade lens review.</p>
491
+ * <p>Upgrade lens review for a particular workload.</p>
466
492
  */
467
493
  upgradeLensReview(args: UpgradeLensReviewCommandInput, options?: __HttpHandlerOptions): Promise<UpgradeLensReviewCommandOutput>;
468
494
  upgradeLensReview(args: UpgradeLensReviewCommandInput, cb: (err: any, data?: UpgradeLensReviewCommandOutput) => void): void;
@@ -20,6 +20,7 @@ import { DeleteWorkloadShareCommandInput, DeleteWorkloadShareCommandOutput } fro
20
20
  import { DisassociateLensesCommandInput, DisassociateLensesCommandOutput } from "./commands/DisassociateLensesCommand";
21
21
  import { ExportLensCommandInput, ExportLensCommandOutput } from "./commands/ExportLensCommand";
22
22
  import { GetAnswerCommandInput, GetAnswerCommandOutput } from "./commands/GetAnswerCommand";
23
+ import { GetConsolidatedReportCommandInput, GetConsolidatedReportCommandOutput } from "./commands/GetConsolidatedReportCommand";
23
24
  import { GetLensCommandInput, GetLensCommandOutput } from "./commands/GetLensCommand";
24
25
  import { GetLensReviewCommandInput, GetLensReviewCommandOutput } from "./commands/GetLensReviewCommand";
25
26
  import { GetLensReviewReportCommandInput, GetLensReviewReportCommandOutput } from "./commands/GetLensReviewReportCommand";
@@ -53,11 +54,11 @@ import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, Endpoi
53
54
  /**
54
55
  * @public
55
56
  */
56
- export type ServiceInputTypes = AssociateLensesCommandInput | CreateLensShareCommandInput | CreateLensVersionCommandInput | CreateMilestoneCommandInput | CreateWorkloadCommandInput | CreateWorkloadShareCommandInput | DeleteLensCommandInput | DeleteLensShareCommandInput | DeleteWorkloadCommandInput | DeleteWorkloadShareCommandInput | DisassociateLensesCommandInput | ExportLensCommandInput | GetAnswerCommandInput | GetLensCommandInput | GetLensReviewCommandInput | GetLensReviewReportCommandInput | GetLensVersionDifferenceCommandInput | GetMilestoneCommandInput | GetWorkloadCommandInput | ImportLensCommandInput | ListAnswersCommandInput | ListCheckDetailsCommandInput | ListCheckSummariesCommandInput | ListLensReviewImprovementsCommandInput | ListLensReviewsCommandInput | ListLensSharesCommandInput | ListLensesCommandInput | ListMilestonesCommandInput | ListNotificationsCommandInput | ListShareInvitationsCommandInput | ListTagsForResourceCommandInput | ListWorkloadSharesCommandInput | ListWorkloadsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAnswerCommandInput | UpdateGlobalSettingsCommandInput | UpdateLensReviewCommandInput | UpdateShareInvitationCommandInput | UpdateWorkloadCommandInput | UpdateWorkloadShareCommandInput | UpgradeLensReviewCommandInput;
57
+ export type ServiceInputTypes = AssociateLensesCommandInput | CreateLensShareCommandInput | CreateLensVersionCommandInput | CreateMilestoneCommandInput | CreateWorkloadCommandInput | CreateWorkloadShareCommandInput | DeleteLensCommandInput | DeleteLensShareCommandInput | DeleteWorkloadCommandInput | DeleteWorkloadShareCommandInput | DisassociateLensesCommandInput | ExportLensCommandInput | GetAnswerCommandInput | GetConsolidatedReportCommandInput | GetLensCommandInput | GetLensReviewCommandInput | GetLensReviewReportCommandInput | GetLensVersionDifferenceCommandInput | GetMilestoneCommandInput | GetWorkloadCommandInput | ImportLensCommandInput | ListAnswersCommandInput | ListCheckDetailsCommandInput | ListCheckSummariesCommandInput | ListLensReviewImprovementsCommandInput | ListLensReviewsCommandInput | ListLensSharesCommandInput | ListLensesCommandInput | ListMilestonesCommandInput | ListNotificationsCommandInput | ListShareInvitationsCommandInput | ListTagsForResourceCommandInput | ListWorkloadSharesCommandInput | ListWorkloadsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAnswerCommandInput | UpdateGlobalSettingsCommandInput | UpdateLensReviewCommandInput | UpdateShareInvitationCommandInput | UpdateWorkloadCommandInput | UpdateWorkloadShareCommandInput | UpgradeLensReviewCommandInput;
57
58
  /**
58
59
  * @public
59
60
  */
60
- export type ServiceOutputTypes = AssociateLensesCommandOutput | CreateLensShareCommandOutput | CreateLensVersionCommandOutput | CreateMilestoneCommandOutput | CreateWorkloadCommandOutput | CreateWorkloadShareCommandOutput | DeleteLensCommandOutput | DeleteLensShareCommandOutput | DeleteWorkloadCommandOutput | DeleteWorkloadShareCommandOutput | DisassociateLensesCommandOutput | ExportLensCommandOutput | GetAnswerCommandOutput | GetLensCommandOutput | GetLensReviewCommandOutput | GetLensReviewReportCommandOutput | GetLensVersionDifferenceCommandOutput | GetMilestoneCommandOutput | GetWorkloadCommandOutput | ImportLensCommandOutput | ListAnswersCommandOutput | ListCheckDetailsCommandOutput | ListCheckSummariesCommandOutput | ListLensReviewImprovementsCommandOutput | ListLensReviewsCommandOutput | ListLensSharesCommandOutput | ListLensesCommandOutput | ListMilestonesCommandOutput | ListNotificationsCommandOutput | ListShareInvitationsCommandOutput | ListTagsForResourceCommandOutput | ListWorkloadSharesCommandOutput | ListWorkloadsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAnswerCommandOutput | UpdateGlobalSettingsCommandOutput | UpdateLensReviewCommandOutput | UpdateShareInvitationCommandOutput | UpdateWorkloadCommandOutput | UpdateWorkloadShareCommandOutput | UpgradeLensReviewCommandOutput;
61
+ export type ServiceOutputTypes = AssociateLensesCommandOutput | CreateLensShareCommandOutput | CreateLensVersionCommandOutput | CreateMilestoneCommandOutput | CreateWorkloadCommandOutput | CreateWorkloadShareCommandOutput | DeleteLensCommandOutput | DeleteLensShareCommandOutput | DeleteWorkloadCommandOutput | DeleteWorkloadShareCommandOutput | DisassociateLensesCommandOutput | ExportLensCommandOutput | GetAnswerCommandOutput | GetConsolidatedReportCommandOutput | GetLensCommandOutput | GetLensReviewCommandOutput | GetLensReviewReportCommandOutput | GetLensVersionDifferenceCommandOutput | GetMilestoneCommandOutput | GetWorkloadCommandOutput | ImportLensCommandOutput | ListAnswersCommandOutput | ListCheckDetailsCommandOutput | ListCheckSummariesCommandOutput | ListLensReviewImprovementsCommandOutput | ListLensReviewsCommandOutput | ListLensSharesCommandOutput | ListLensesCommandOutput | ListMilestonesCommandOutput | ListNotificationsCommandOutput | ListShareInvitationsCommandOutput | ListTagsForResourceCommandOutput | ListWorkloadSharesCommandOutput | ListWorkloadsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAnswerCommandOutput | UpdateGlobalSettingsCommandOutput | UpdateLensReviewCommandOutput | UpdateShareInvitationCommandOutput | UpdateWorkloadCommandOutput | UpdateWorkloadShareCommandOutput | UpgradeLensReviewCommandOutput;
61
62
  /**
62
63
  * @public
63
64
  */
@@ -186,7 +187,6 @@ export interface WellArchitectedClientResolvedConfig extends WellArchitectedClie
186
187
  /**
187
188
  * @public
188
189
  * <fullname>Well-Architected Tool</fullname>
189
- *
190
190
  * <p>This is the <i>Well-Architected Tool API Reference</i>. The WA Tool API provides programmatic access to the
191
191
  * <a href="http://aws.amazon.com/well-architected-tool">Well-Architected Tool</a> in the
192
192
  * <a href="https://console.aws.amazon.com/wellarchitected">Amazon Web Services Management Console</a>. For information
@@ -20,9 +20,9 @@ export interface AssociateLensesCommandOutput extends __MetadataBearer {
20
20
  /**
21
21
  * @public
22
22
  * <p>Associate a lens to a workload.</p>
23
- * <p>Up to 10 lenses can be associated with a workload in a single API operation. A
23
+ * <p>Up to 10 lenses can be associated with a workload in a single API operation. A
24
24
  * maximum of 20 lenses can be associated with a workload.</p>
25
- * <note>
25
+ * <note>
26
26
  * <p>
27
27
  * <b>Disclaimer</b>
28
28
  * </p>
@@ -56,7 +56,7 @@ export interface AssociateLensesCommandOutput extends __MetadataBearer {
56
56
  * <p>User does not have sufficient access to perform this action.</p>
57
57
  *
58
58
  * @throws {@link ConflictException} (client fault)
59
- * <p>The resource already exists.</p>
59
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
60
60
  *
61
61
  * @throws {@link InternalServerException} (server fault)
62
62
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -20,10 +20,16 @@ export interface CreateLensShareCommandOutput extends CreateLensShareOutput, __M
20
20
  /**
21
21
  * @public
22
22
  * <p>Create a lens share.</p>
23
- * <p>The owner of a lens can share it with other Amazon Web Services accounts, IAM users, an organization,
23
+ * <p>The owner of a lens can share it with other Amazon Web Services accounts, users, an organization,
24
24
  * and organizational units (OUs) in the same Amazon Web Services Region.
25
+ * Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.</p>
26
+ * <p>
25
27
  * Shared access to a lens is not removed until the lens invitation is deleted.</p>
26
- * <note>
28
+ * <p>If you share a lens with an organization or OU, all accounts in the organization or OU
29
+ * are granted access to the lens.</p>
30
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-sharing.html">Sharing a custom lens</a> in the
31
+ * <i>Well-Architected Tool User Guide</i>.</p>
32
+ * <note>
27
33
  * <p>
28
34
  * <b>Disclaimer</b>
29
35
  * </p>
@@ -59,7 +65,7 @@ export interface CreateLensShareCommandOutput extends CreateLensShareOutput, __M
59
65
  * <p>User does not have sufficient access to perform this action.</p>
60
66
  *
61
67
  * @throws {@link ConflictException} (client fault)
62
- * <p>The resource already exists.</p>
68
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
63
69
  *
64
70
  * @throws {@link InternalServerException} (server fault)
65
71
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -20,9 +20,11 @@ export interface CreateLensVersionCommandOutput extends CreateLensVersionOutput,
20
20
  /**
21
21
  * @public
22
22
  * <p>Create a new lens version.</p>
23
- * <p>A lens can have up to 100 versions.</p>
24
- * <p>After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other
25
- * Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
23
+ * <p>A lens can have up to 100 versions.</p>
24
+ * <p>Use this operation to publish a new lens version after you have imported a lens. The <code>LensAlias</code>
25
+ * is used to identify the lens to be published.
26
+ * The owner of a lens can share the lens with other
27
+ * Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
26
28
  * </p>
27
29
  * @example
28
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -50,7 +52,7 @@ export interface CreateLensVersionCommandOutput extends CreateLensVersionOutput,
50
52
  * <p>User does not have sufficient access to perform this action.</p>
51
53
  *
52
54
  * @throws {@link ConflictException} (client fault)
53
- * <p>The resource already exists.</p>
55
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
54
56
  *
55
57
  * @throws {@link InternalServerException} (server fault)
56
58
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -45,7 +45,7 @@ export interface CreateMilestoneCommandOutput extends CreateMilestoneOutput, __M
45
45
  * <p>User does not have sufficient access to perform this action.</p>
46
46
  *
47
47
  * @throws {@link ConflictException} (client fault)
48
- * <p>The resource already exists.</p>
48
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
49
49
  *
50
50
  * @throws {@link InternalServerException} (server fault)
51
51
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -20,11 +20,18 @@ export interface CreateWorkloadCommandOutput extends CreateWorkloadOutput, __Met
20
20
  /**
21
21
  * @public
22
22
  * <p>Create a new workload.</p>
23
- * <p>The owner of a workload can share the workload with other Amazon Web Services accounts, IAM users,
23
+ * <p>The owner of a workload can share the workload with other Amazon Web Services accounts, users,
24
24
  * an organization, and organizational units (OUs)
25
25
  * in the same Amazon Web Services Region. Only the owner of a workload can delete it.</p>
26
- * <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html">Defining a Workload</a> in the
26
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html">Defining a Workload</a> in the
27
27
  * <i>Well-Architected Tool User Guide</i>.</p>
28
+ * <important>
29
+ * <p>Either <code>AwsRegions</code>, <code>NonAwsRegions</code>, or both must be specified when
30
+ * creating a workload.</p>
31
+ * <p>You also must specify <code>ReviewOwner</code>, even though the
32
+ * parameter is listed as not being required in the following section.
33
+ * </p>
34
+ * </important>
28
35
  * @example
29
36
  * Use a bare-bones client and the command you need to make an API call.
30
37
  * ```javascript
@@ -80,11 +87,14 @@ export interface CreateWorkloadCommandOutput extends CreateWorkloadOutput, __Met
80
87
  * <p>User does not have sufficient access to perform this action.</p>
81
88
  *
82
89
  * @throws {@link ConflictException} (client fault)
83
- * <p>The resource already exists.</p>
90
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
84
91
  *
85
92
  * @throws {@link InternalServerException} (server fault)
86
93
  * <p>There is a problem with the Well-Architected Tool API service.</p>
87
94
  *
95
+ * @throws {@link ResourceNotFoundException} (client fault)
96
+ * <p>The requested resource was not found.</p>
97
+ *
88
98
  * @throws {@link ServiceQuotaExceededException} (client fault)
89
99
  * <p>The user has reached their resource quota.</p>
90
100
  *
@@ -20,10 +20,12 @@ export interface CreateWorkloadShareCommandOutput extends CreateWorkloadShareOut
20
20
  /**
21
21
  * @public
22
22
  * <p>Create a workload share.</p>
23
- * <p>The owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same
23
+ * <p>The owner of a workload can share it with other Amazon Web Services accounts and users in the same
24
24
  * Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is
25
25
  * deleted.</p>
26
- * <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html">Sharing a Workload</a> in the
26
+ * <p>If you share a workload with an organization or OU, all accounts in the organization or OU
27
+ * are granted access to the workload.</p>
28
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html">Sharing a workload</a> in the
27
29
  * <i>Well-Architected Tool User Guide</i>.</p>
28
30
  * @example
29
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -51,7 +53,7 @@ export interface CreateWorkloadShareCommandOutput extends CreateWorkloadShareOut
51
53
  * <p>User does not have sufficient access to perform this action.</p>
52
54
  *
53
55
  * @throws {@link ConflictException} (client fault)
54
- * <p>The resource already exists.</p>
56
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
55
57
  *
56
58
  * @throws {@link InternalServerException} (server fault)
57
59
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -20,10 +20,10 @@ export interface DeleteLensCommandOutput extends __MetadataBearer {
20
20
  /**
21
21
  * @public
22
22
  * <p>Delete an existing lens.</p>
23
- * <p>Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM users
23
+ * <p>Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users
24
24
  * that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
25
25
  * </p>
26
- * <note>
26
+ * <note>
27
27
  * <p>
28
28
  * <b>Disclaimer</b>
29
29
  * </p>
@@ -59,7 +59,7 @@ export interface DeleteLensCommandOutput extends __MetadataBearer {
59
59
  * <p>User does not have sufficient access to perform this action.</p>
60
60
  *
61
61
  * @throws {@link ConflictException} (client fault)
62
- * <p>The resource already exists.</p>
62
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
63
63
  *
64
64
  * @throws {@link InternalServerException} (server fault)
65
65
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -20,10 +20,10 @@ export interface DeleteLensShareCommandOutput extends __MetadataBearer {
20
20
  /**
21
21
  * @public
22
22
  * <p>Delete a lens share.</p>
23
- * <p>After the lens share is deleted, Amazon Web Services accounts, IAM users, organizations,
23
+ * <p>After the lens share is deleted, Amazon Web Services accounts, users, organizations,
24
24
  * and organizational units (OUs)
25
25
  * that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.</p>
26
- * <note>
26
+ * <note>
27
27
  * <p>
28
28
  * <b>Disclaimer</b>
29
29
  * </p>
@@ -59,7 +59,7 @@ export interface DeleteLensShareCommandOutput extends __MetadataBearer {
59
59
  * <p>User does not have sufficient access to perform this action.</p>
60
60
  *
61
61
  * @throws {@link ConflictException} (client fault)
62
- * <p>The resource already exists.</p>
62
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
63
63
  *
64
64
  * @throws {@link InternalServerException} (server fault)
65
65
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -44,7 +44,7 @@ export interface DeleteWorkloadCommandOutput extends __MetadataBearer {
44
44
  * <p>User does not have sufficient access to perform this action.</p>
45
45
  *
46
46
  * @throws {@link ConflictException} (client fault)
47
- * <p>The resource already exists.</p>
47
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
48
48
  *
49
49
  * @throws {@link InternalServerException} (server fault)
50
50
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -45,7 +45,7 @@ export interface DeleteWorkloadShareCommandOutput extends __MetadataBearer {
45
45
  * <p>User does not have sufficient access to perform this action.</p>
46
46
  *
47
47
  * @throws {@link ConflictException} (client fault)
48
- * <p>The resource already exists.</p>
48
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
49
49
  *
50
50
  * @throws {@link InternalServerException} (server fault)
51
51
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -20,11 +20,11 @@ export interface DisassociateLensesCommandOutput extends __MetadataBearer {
20
20
  /**
21
21
  * @public
22
22
  * <p>Disassociate a lens from a workload.</p>
23
- * <p>Up to 10 lenses can be disassociated from a workload in a single API operation.</p>
24
- * <note>
23
+ * <p>Up to 10 lenses can be disassociated from a workload in a single API operation.</p>
24
+ * <note>
25
25
  * <p>The Amazon Web Services Well-Architected Framework lens (<code>wellarchitected</code>) cannot be
26
26
  * removed from a workload.</p>
27
- * </note>
27
+ * </note>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -51,7 +51,7 @@ export interface DisassociateLensesCommandOutput extends __MetadataBearer {
51
51
  * <p>User does not have sufficient access to perform this action.</p>
52
52
  *
53
53
  * @throws {@link ConflictException} (client fault)
54
- * <p>The resource already exists.</p>
54
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
55
55
  *
56
56
  * @throws {@link InternalServerException} (server fault)
57
57
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -20,10 +20,11 @@ export interface ExportLensCommandOutput extends ExportLensOutput, __MetadataBea
20
20
  /**
21
21
  * @public
22
22
  * <p>Export an existing lens.</p>
23
- * <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>
24
- * in the <i>Well-Architected Tool User Guide</i>. Only the owner of a lens can export it.
25
- * </p>
26
- * <note>
23
+ * <p>Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content)
24
+ * cannot be exported.</p>
25
+ * <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>
26
+ * in the <i>Well-Architected Tool User Guide</i>.</p>
27
+ * <note>
27
28
  * <p>
28
29
  * <b>Disclaimer</b>
29
30
  * </p>