@aws-sdk/client-wellarchitected 3.300.0 → 3.303.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 (76) 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 +5 -5
  21. package/dist-types/commands/CreateLensShareCommand.d.ts +10 -4
  22. package/dist-types/commands/CreateLensVersionCommand.d.ts +7 -5
  23. package/dist-types/commands/CreateMilestoneCommand.d.ts +2 -2
  24. package/dist-types/commands/CreateWorkloadCommand.d.ts +22 -12
  25. package/dist-types/commands/CreateWorkloadShareCommand.d.ts +6 -4
  26. package/dist-types/commands/DeleteLensCommand.d.ts +4 -4
  27. package/dist-types/commands/DeleteLensShareCommand.d.ts +4 -4
  28. package/dist-types/commands/DeleteWorkloadCommand.d.ts +2 -2
  29. package/dist-types/commands/DeleteWorkloadShareCommand.d.ts +2 -2
  30. package/dist-types/commands/DisassociateLensesCommand.d.ts +6 -6
  31. package/dist-types/commands/ExportLensCommand.d.ts +6 -5
  32. package/dist-types/commands/GetAnswerCommand.d.ts +1 -1
  33. package/dist-types/commands/GetConsolidatedReportCommand.d.ts +82 -0
  34. package/dist-types/commands/GetLensCommand.d.ts +1 -1
  35. package/dist-types/commands/GetLensReviewCommand.d.ts +1 -1
  36. package/dist-types/commands/GetLensReviewReportCommand.d.ts +1 -1
  37. package/dist-types/commands/GetLensVersionDifferenceCommand.d.ts +1 -1
  38. package/dist-types/commands/GetMilestoneCommand.d.ts +1 -1
  39. package/dist-types/commands/GetWorkloadCommand.d.ts +1 -1
  40. package/dist-types/commands/ImportLensCommand.d.ts +12 -11
  41. package/dist-types/commands/ListAnswersCommand.d.ts +2 -2
  42. package/dist-types/commands/ListCheckDetailsCommand.d.ts +1 -1
  43. package/dist-types/commands/ListCheckSummariesCommand.d.ts +1 -1
  44. package/dist-types/commands/ListLensReviewImprovementsCommand.d.ts +1 -1
  45. package/dist-types/commands/ListLensReviewsCommand.d.ts +2 -2
  46. package/dist-types/commands/ListLensSharesCommand.d.ts +1 -1
  47. package/dist-types/commands/ListLensesCommand.d.ts +1 -1
  48. package/dist-types/commands/ListMilestonesCommand.d.ts +1 -1
  49. package/dist-types/commands/ListNotificationsCommand.d.ts +1 -1
  50. package/dist-types/commands/ListShareInvitationsCommand.d.ts +1 -1
  51. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
  52. package/dist-types/commands/ListWorkloadSharesCommand.d.ts +1 -1
  53. package/dist-types/commands/ListWorkloadsCommand.d.ts +2 -2
  54. package/dist-types/commands/TagResourceCommand.d.ts +3 -3
  55. package/dist-types/commands/UntagResourceCommand.d.ts +5 -6
  56. package/dist-types/commands/UpdateAnswerCommand.d.ts +5 -5
  57. package/dist-types/commands/UpdateGlobalSettingsCommand.d.ts +2 -2
  58. package/dist-types/commands/UpdateLensReviewCommand.d.ts +4 -4
  59. package/dist-types/commands/UpdateShareInvitationCommand.d.ts +3 -3
  60. package/dist-types/commands/UpdateWorkloadCommand.d.ts +8 -8
  61. package/dist-types/commands/UpdateWorkloadShareCommand.d.ts +2 -2
  62. package/dist-types/commands/UpgradeLensReviewCommand.d.ts +3 -3
  63. package/dist-types/commands/index.d.ts +1 -0
  64. package/dist-types/models/models_0.d.ts +833 -445
  65. package/dist-types/pagination/GetConsolidatedReportPaginator.d.ts +7 -0
  66. package/dist-types/pagination/index.d.ts +1 -0
  67. package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
  68. package/dist-types/ts3.4/WellArchitected.d.ts +17 -0
  69. package/dist-types/ts3.4/WellArchitectedClient.d.ts +6 -0
  70. package/dist-types/ts3.4/commands/GetConsolidatedReportCommand.d.ts +41 -0
  71. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  72. package/dist-types/ts3.4/models/models_0.d.ts +210 -124
  73. package/dist-types/ts3.4/pagination/GetConsolidatedReportPaginator.d.ts +11 -0
  74. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  75. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  76. package/package.json +34 -34
@@ -26,7 +26,7 @@ export interface DeleteWorkloadCommandOutput extends __MetadataBearer {
26
26
  * import { WellArchitectedClient, DeleteWorkloadCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, DeleteWorkloadCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // DeleteWorkloadInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * ClientRequestToken: "STRING_VALUE", // required
32
32
  * };
@@ -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>
@@ -26,7 +26,7 @@ export interface DeleteWorkloadShareCommandOutput extends __MetadataBearer {
26
26
  * import { WellArchitectedClient, DeleteWorkloadShareCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, DeleteWorkloadShareCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // DeleteWorkloadShareInput
30
30
  * ShareId: "STRING_VALUE", // required
31
31
  * WorkloadId: "STRING_VALUE", // required
32
32
  * ClientRequestToken: "STRING_VALUE", // required
@@ -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,20 +20,20 @@ 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
31
31
  * import { WellArchitectedClient, DisassociateLensesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
32
32
  * // const { WellArchitectedClient, DisassociateLensesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
33
33
  * const client = new WellArchitectedClient(config);
34
- * const input = {
34
+ * const input = { // DisassociateLensesInput
35
35
  * WorkloadId: "STRING_VALUE", // required
36
- * LensAliases: [ // required
36
+ * LensAliases: [ // LensAliases // required
37
37
  * "STRING_VALUE",
38
38
  * ],
39
39
  * };
@@ -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>
@@ -40,7 +41,7 @@ export interface ExportLensCommandOutput extends ExportLensOutput, __MetadataBea
40
41
  * import { WellArchitectedClient, ExportLensCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
41
42
  * // const { WellArchitectedClient, ExportLensCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
42
43
  * const client = new WellArchitectedClient(config);
43
- * const input = {
44
+ * const input = { // ExportLensInput
44
45
  * LensAlias: "STRING_VALUE", // required
45
46
  * LensVersion: "STRING_VALUE",
46
47
  * };
@@ -26,7 +26,7 @@ export interface GetAnswerCommandOutput extends GetAnswerOutput, __MetadataBeare
26
26
  * import { WellArchitectedClient, GetAnswerCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, GetAnswerCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // GetAnswerInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * LensAlias: "STRING_VALUE", // required
32
32
  * QuestionId: "STRING_VALUE", // required
@@ -0,0 +1,82 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { GetConsolidatedReportInput, GetConsolidatedReportOutput } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, WellArchitectedClientResolvedConfig } from "../WellArchitectedClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link GetConsolidatedReportCommand}.
10
+ */
11
+ export interface GetConsolidatedReportCommandInput extends GetConsolidatedReportInput {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link GetConsolidatedReportCommand}.
17
+ */
18
+ export interface GetConsolidatedReportCommandOutput extends GetConsolidatedReportOutput, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Get a consolidated report of your workloads.</p>
23
+ * <p>You can optionally choose to include workloads that have been shared with you.</p>
24
+ * @example
25
+ * Use a bare-bones client and the command you need to make an API call.
26
+ * ```javascript
27
+ * import { WellArchitectedClient, GetConsolidatedReportCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
28
+ * // const { WellArchitectedClient, GetConsolidatedReportCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
29
+ * const client = new WellArchitectedClient(config);
30
+ * const input = { // GetConsolidatedReportInput
31
+ * Format: "PDF" || "JSON", // required
32
+ * IncludeSharedResources: true || false,
33
+ * NextToken: "STRING_VALUE",
34
+ * MaxResults: Number("int"),
35
+ * };
36
+ * const command = new GetConsolidatedReportCommand(input);
37
+ * const response = await client.send(command);
38
+ * ```
39
+ *
40
+ * @param GetConsolidatedReportCommandInput - {@link GetConsolidatedReportCommandInput}
41
+ * @returns {@link GetConsolidatedReportCommandOutput}
42
+ * @see {@link GetConsolidatedReportCommandInput} for command's `input` shape.
43
+ * @see {@link GetConsolidatedReportCommandOutput} for command's `response` shape.
44
+ * @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
45
+ *
46
+ * @throws {@link AccessDeniedException} (client fault)
47
+ * <p>User does not have sufficient access to perform this action.</p>
48
+ *
49
+ * @throws {@link ConflictException} (client fault)
50
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
51
+ *
52
+ * @throws {@link InternalServerException} (server fault)
53
+ * <p>There is a problem with the Well-Architected Tool API service.</p>
54
+ *
55
+ * @throws {@link ThrottlingException} (client fault)
56
+ * <p>Request was denied due to request throttling.</p>
57
+ *
58
+ * @throws {@link ValidationException} (client fault)
59
+ * <p>The user input is not valid.</p>
60
+ *
61
+ *
62
+ */
63
+ export declare class GetConsolidatedReportCommand extends $Command<GetConsolidatedReportCommandInput, GetConsolidatedReportCommandOutput, WellArchitectedClientResolvedConfig> {
64
+ readonly input: GetConsolidatedReportCommandInput;
65
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
69
+ constructor(input: GetConsolidatedReportCommandInput);
70
+ /**
71
+ * @internal
72
+ */
73
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WellArchitectedClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConsolidatedReportCommandInput, GetConsolidatedReportCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
77
+ private serialize;
78
+ /**
79
+ * @internal
80
+ */
81
+ private deserialize;
82
+ }
@@ -26,7 +26,7 @@ export interface GetLensCommandOutput extends GetLensOutput, __MetadataBearer {
26
26
  * import { WellArchitectedClient, GetLensCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, GetLensCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // GetLensInput
30
30
  * LensAlias: "STRING_VALUE", // required
31
31
  * LensVersion: "STRING_VALUE",
32
32
  * };
@@ -26,7 +26,7 @@ export interface GetLensReviewCommandOutput extends GetLensReviewOutput, __Metad
26
26
  * import { WellArchitectedClient, GetLensReviewCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, GetLensReviewCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // GetLensReviewInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * LensAlias: "STRING_VALUE", // required
32
32
  * MilestoneNumber: Number("int"),
@@ -26,7 +26,7 @@ export interface GetLensReviewReportCommandOutput extends GetLensReviewReportOut
26
26
  * import { WellArchitectedClient, GetLensReviewReportCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, GetLensReviewReportCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // GetLensReviewReportInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * LensAlias: "STRING_VALUE", // required
32
32
  * MilestoneNumber: Number("int"),
@@ -26,7 +26,7 @@ export interface GetLensVersionDifferenceCommandOutput extends GetLensVersionDif
26
26
  * import { WellArchitectedClient, GetLensVersionDifferenceCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, GetLensVersionDifferenceCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // GetLensVersionDifferenceInput
30
30
  * LensAlias: "STRING_VALUE", // required
31
31
  * BaseLensVersion: "STRING_VALUE",
32
32
  * TargetLensVersion: "STRING_VALUE",
@@ -26,7 +26,7 @@ export interface GetMilestoneCommandOutput extends GetMilestoneOutput, __Metadat
26
26
  * import { WellArchitectedClient, GetMilestoneCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, GetMilestoneCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // GetMilestoneInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * MilestoneNumber: Number("int"), // required
32
32
  * };
@@ -26,7 +26,7 @@ export interface GetWorkloadCommandOutput extends GetWorkloadOutput, __MetadataB
26
26
  * import { WellArchitectedClient, GetWorkloadCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, GetWorkloadCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // GetWorkloadInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * };
32
32
  * const command = new GetWorkloadCommand(input);
@@ -19,15 +19,16 @@ export interface ImportLensCommandOutput extends ImportLensOutput, __MetadataBea
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Import a new lens.</p>
23
- * <p>The lens cannot be applied to workloads or shared with other Amazon Web Services accounts
24
- * until it's published with <a>CreateLensVersion</a>
25
- * </p>
26
- * <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>
22
+ * <p>Import a new custom lens or update an existing custom lens.</p>
23
+ * <p>To update an existing custom lens, specify its ARN as the <code>LensAlias</code>. If
24
+ * no ARN is specified, a new custom lens is created.</p>
25
+ * <p>The new or updated lens will have a status of <code>DRAFT</code>. The lens cannot be
26
+ * applied to workloads or shared with other Amazon Web Services accounts until it's
27
+ * published with <a>CreateLensVersion</a>.</p>
28
+ * <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>
27
29
  * in the <i>Well-Architected Tool User Guide</i>.</p>
28
- * <p>A custom lens cannot exceed 500 KB in size.</p>
29
- *
30
- * <note>
30
+ * <p>A custom lens cannot exceed 500 KB in size.</p>
31
+ * <note>
31
32
  * <p>
32
33
  * <b>Disclaimer</b>
33
34
  * </p>
@@ -44,11 +45,11 @@ export interface ImportLensCommandOutput extends ImportLensOutput, __MetadataBea
44
45
  * import { WellArchitectedClient, ImportLensCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
45
46
  * // const { WellArchitectedClient, ImportLensCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
46
47
  * const client = new WellArchitectedClient(config);
47
- * const input = {
48
+ * const input = { // ImportLensInput
48
49
  * LensAlias: "STRING_VALUE",
49
50
  * JSONString: "STRING_VALUE", // required
50
51
  * ClientRequestToken: "STRING_VALUE", // required
51
- * Tags: {
52
+ * Tags: { // TagMap
52
53
  * "<keys>": "STRING_VALUE",
53
54
  * },
54
55
  * };
@@ -66,7 +67,7 @@ export interface ImportLensCommandOutput extends ImportLensOutput, __MetadataBea
66
67
  * <p>User does not have sufficient access to perform this action.</p>
67
68
  *
68
69
  * @throws {@link ConflictException} (client fault)
69
- * <p>The resource already exists.</p>
70
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
70
71
  *
71
72
  * @throws {@link InternalServerException} (server fault)
72
73
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -19,14 +19,14 @@ export interface ListAnswersCommandOutput extends ListAnswersOutput, __MetadataB
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>List of answers.</p>
22
+ * <p>List of answers for a particular workload and lens.</p>
23
23
  * @example
24
24
  * Use a bare-bones client and the command you need to make an API call.
25
25
  * ```javascript
26
26
  * import { WellArchitectedClient, ListAnswersCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListAnswersCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListAnswersInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * LensAlias: "STRING_VALUE", // required
32
32
  * PillarId: "STRING_VALUE",
@@ -26,7 +26,7 @@ export interface ListCheckDetailsCommandOutput extends ListCheckDetailsOutput, _
26
26
  * import { WellArchitectedClient, ListCheckDetailsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListCheckDetailsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListCheckDetailsInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * NextToken: "STRING_VALUE",
32
32
  * MaxResults: Number("int"),
@@ -26,7 +26,7 @@ export interface ListCheckSummariesCommandOutput extends ListCheckSummariesOutpu
26
26
  * import { WellArchitectedClient, ListCheckSummariesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListCheckSummariesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListCheckSummariesInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * NextToken: "STRING_VALUE",
32
32
  * MaxResults: Number("int"),
@@ -26,7 +26,7 @@ export interface ListLensReviewImprovementsCommandOutput extends ListLensReviewI
26
26
  * import { WellArchitectedClient, ListLensReviewImprovementsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListLensReviewImprovementsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListLensReviewImprovementsInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * LensAlias: "STRING_VALUE", // required
32
32
  * PillarId: "STRING_VALUE",
@@ -19,14 +19,14 @@ export interface ListLensReviewsCommandOutput extends ListLensReviewsOutput, __M
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>List lens reviews.</p>
22
+ * <p>List lens reviews for a particular workload.</p>
23
23
  * @example
24
24
  * Use a bare-bones client and the command you need to make an API call.
25
25
  * ```javascript
26
26
  * import { WellArchitectedClient, ListLensReviewsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListLensReviewsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListLensReviewsInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * MilestoneNumber: Number("int"),
32
32
  * NextToken: "STRING_VALUE",
@@ -26,7 +26,7 @@ export interface ListLensSharesCommandOutput extends ListLensSharesOutput, __Met
26
26
  * import { WellArchitectedClient, ListLensSharesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListLensSharesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListLensSharesInput
30
30
  * LensAlias: "STRING_VALUE", // required
31
31
  * SharedWithPrefix: "STRING_VALUE",
32
32
  * NextToken: "STRING_VALUE",
@@ -26,7 +26,7 @@ export interface ListLensesCommandOutput extends ListLensesOutput, __MetadataBea
26
26
  * import { WellArchitectedClient, ListLensesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListLensesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListLensesInput
30
30
  * NextToken: "STRING_VALUE",
31
31
  * MaxResults: Number("int"),
32
32
  * LensType: "AWS_OFFICIAL" || "CUSTOM_SHARED" || "CUSTOM_SELF",
@@ -26,7 +26,7 @@ export interface ListMilestonesCommandOutput extends ListMilestonesOutput, __Met
26
26
  * import { WellArchitectedClient, ListMilestonesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListMilestonesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListMilestonesInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * NextToken: "STRING_VALUE",
32
32
  * MaxResults: Number("int"),
@@ -26,7 +26,7 @@ export interface ListNotificationsCommandOutput extends ListNotificationsOutput,
26
26
  * import { WellArchitectedClient, ListNotificationsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListNotificationsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListNotificationsInput
30
30
  * WorkloadId: "STRING_VALUE",
31
31
  * NextToken: "STRING_VALUE",
32
32
  * MaxResults: Number("int"),
@@ -26,7 +26,7 @@ export interface ListShareInvitationsCommandOutput extends ListShareInvitationsO
26
26
  * import { WellArchitectedClient, ListShareInvitationsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListShareInvitationsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListShareInvitationsInput
30
30
  * WorkloadNamePrefix: "STRING_VALUE",
31
31
  * LensNamePrefix: "STRING_VALUE",
32
32
  * ShareResourceType: "WORKLOAD" || "LENS",
@@ -20,7 +20,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
20
20
  /**
21
21
  * @public
22
22
  * <p>List the tags for a resource.</p>
23
- * <note>
23
+ * <note>
24
24
  * <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p>
25
25
  * </note>
26
26
  * @example
@@ -29,7 +29,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
29
29
  * import { WellArchitectedClient, ListTagsForResourceCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
30
30
  * // const { WellArchitectedClient, ListTagsForResourceCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
31
31
  * const client = new WellArchitectedClient(config);
32
- * const input = {
32
+ * const input = { // ListTagsForResourceInput
33
33
  * WorkloadArn: "STRING_VALUE", // required
34
34
  * };
35
35
  * const command = new ListTagsForResourceCommand(input);
@@ -26,7 +26,7 @@ export interface ListWorkloadSharesCommandOutput extends ListWorkloadSharesOutpu
26
26
  * import { WellArchitectedClient, ListWorkloadSharesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListWorkloadSharesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListWorkloadSharesInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * SharedWithPrefix: "STRING_VALUE",
32
32
  * NextToken: "STRING_VALUE",
@@ -19,14 +19,14 @@ export interface ListWorkloadsCommandOutput extends ListWorkloadsOutput, __Metad
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>List workloads. Paginated.</p>
22
+ * <p>Paginated list of workloads.</p>
23
23
  * @example
24
24
  * Use a bare-bones client and the command you need to make an API call.
25
25
  * ```javascript
26
26
  * import { WellArchitectedClient, ListWorkloadsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, ListWorkloadsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // ListWorkloadsInput
30
30
  * WorkloadNamePrefix: "STRING_VALUE",
31
31
  * NextToken: "STRING_VALUE",
32
32
  * MaxResults: Number("int"),
@@ -20,7 +20,7 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
20
20
  /**
21
21
  * @public
22
22
  * <p>Adds one or more tags to the specified resource.</p>
23
- * <note>
23
+ * <note>
24
24
  * <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p>
25
25
  * </note>
26
26
  * @example
@@ -29,9 +29,9 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
29
29
  * import { WellArchitectedClient, TagResourceCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
30
30
  * // const { WellArchitectedClient, TagResourceCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
31
31
  * const client = new WellArchitectedClient(config);
32
- * const input = {
32
+ * const input = { // TagResourceInput
33
33
  * WorkloadArn: "STRING_VALUE", // required
34
- * Tags: { // required
34
+ * Tags: { // TagMap // required
35
35
  * "<keys>": "STRING_VALUE",
36
36
  * },
37
37
  * };
@@ -20,12 +20,11 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
20
20
  /**
21
21
  * @public
22
22
  * <p>Deletes specified tags from a resource.</p>
23
- * <note>
23
+ * <note>
24
24
  * <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p>
25
25
  * </note>
26
- *
27
- * <p>To specify multiple tags, use separate <b>tagKeys</b> parameters, for example:</p>
28
- * <p>
26
+ * <p>To specify multiple tags, use separate <b>tagKeys</b> parameters, for example:</p>
27
+ * <p>
29
28
  * <code>DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2</code>
30
29
  * </p>
31
30
  * @example
@@ -34,9 +33,9 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
34
33
  * import { WellArchitectedClient, UntagResourceCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
35
34
  * // const { WellArchitectedClient, UntagResourceCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
36
35
  * const client = new WellArchitectedClient(config);
37
- * const input = {
36
+ * const input = { // UntagResourceInput
38
37
  * WorkloadArn: "STRING_VALUE", // required
39
- * TagKeys: [ // required
38
+ * TagKeys: [ // TagKeyList // required
40
39
  * "STRING_VALUE",
41
40
  * ],
42
41
  * };
@@ -26,15 +26,15 @@ export interface UpdateAnswerCommandOutput extends UpdateAnswerOutput, __Metadat
26
26
  * import { WellArchitectedClient, UpdateAnswerCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, UpdateAnswerCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // UpdateAnswerInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * LensAlias: "STRING_VALUE", // required
32
32
  * QuestionId: "STRING_VALUE", // required
33
- * SelectedChoices: [
33
+ * SelectedChoices: [ // SelectedChoices
34
34
  * "STRING_VALUE",
35
35
  * ],
36
- * ChoiceUpdates: {
37
- * "<keys>": {
36
+ * ChoiceUpdates: { // ChoiceUpdates
37
+ * "<keys>": { // ChoiceUpdate
38
38
  * Status: "SELECTED" || "NOT_APPLICABLE" || "UNSELECTED", // required
39
39
  * Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
40
40
  * Notes: "STRING_VALUE",
@@ -58,7 +58,7 @@ export interface UpdateAnswerCommandOutput extends UpdateAnswerOutput, __Metadat
58
58
  * <p>User does not have sufficient access to perform this action.</p>
59
59
  *
60
60
  * @throws {@link ConflictException} (client fault)
61
- * <p>The resource already exists.</p>
61
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
62
62
  *
63
63
  * @throws {@link InternalServerException} (server fault)
64
64
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -26,7 +26,7 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {
26
26
  * import { WellArchitectedClient, UpdateGlobalSettingsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, UpdateGlobalSettingsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // UpdateGlobalSettingsInput
30
30
  * OrganizationSharingStatus: "ENABLED" || "DISABLED",
31
31
  * };
32
32
  * const command = new UpdateGlobalSettingsCommand(input);
@@ -43,7 +43,7 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {
43
43
  * <p>User does not have sufficient access to perform this action.</p>
44
44
  *
45
45
  * @throws {@link ConflictException} (client fault)
46
- * <p>The resource already exists.</p>
46
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
47
47
  *
48
48
  * @throws {@link InternalServerException} (server fault)
49
49
  * <p>There is a problem with the Well-Architected Tool API service.</p>
@@ -19,18 +19,18 @@ export interface UpdateLensReviewCommandOutput extends UpdateLensReviewOutput, _
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Update lens review.</p>
22
+ * <p>Update lens review for a particular workload.</p>
23
23
  * @example
24
24
  * Use a bare-bones client and the command you need to make an API call.
25
25
  * ```javascript
26
26
  * import { WellArchitectedClient, UpdateLensReviewCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
27
27
  * // const { WellArchitectedClient, UpdateLensReviewCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
28
28
  * const client = new WellArchitectedClient(config);
29
- * const input = {
29
+ * const input = { // UpdateLensReviewInput
30
30
  * WorkloadId: "STRING_VALUE", // required
31
31
  * LensAlias: "STRING_VALUE", // required
32
32
  * LensNotes: "STRING_VALUE",
33
- * PillarNotes: {
33
+ * PillarNotes: { // PillarNotes
34
34
  * "<keys>": "STRING_VALUE",
35
35
  * },
36
36
  * };
@@ -48,7 +48,7 @@ export interface UpdateLensReviewCommandOutput extends UpdateLensReviewOutput, _
48
48
  * <p>User does not have sufficient access to perform this action.</p>
49
49
  *
50
50
  * @throws {@link ConflictException} (client fault)
51
- * <p>The resource already exists.</p>
51
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
52
52
  *
53
53
  * @throws {@link InternalServerException} (server fault)
54
54
  * <p>There is a problem with the Well-Architected Tool API service.</p>