@aws-sdk/client-wellarchitected 3.423.0 → 3.425.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.
- package/README.md +112 -0
- package/dist-cjs/WellArchitected.js +28 -0
- package/dist-cjs/commands/CreateReviewTemplateCommand.js +51 -0
- package/dist-cjs/commands/CreateTemplateShareCommand.js +51 -0
- package/dist-cjs/commands/DeleteReviewTemplateCommand.js +51 -0
- package/dist-cjs/commands/DeleteTemplateShareCommand.js +51 -0
- package/dist-cjs/commands/GetReviewTemplateAnswerCommand.js +51 -0
- package/dist-cjs/commands/GetReviewTemplateCommand.js +51 -0
- package/dist-cjs/commands/GetReviewTemplateLensReviewCommand.js +51 -0
- package/dist-cjs/commands/ListReviewTemplateAnswersCommand.js +51 -0
- package/dist-cjs/commands/ListReviewTemplatesCommand.js +51 -0
- package/dist-cjs/commands/ListTemplateSharesCommand.js +51 -0
- package/dist-cjs/commands/UpdateReviewTemplateAnswerCommand.js +51 -0
- package/dist-cjs/commands/UpdateReviewTemplateCommand.js +51 -0
- package/dist-cjs/commands/UpdateReviewTemplateLensReviewCommand.js +51 -0
- package/dist-cjs/commands/UpgradeReviewTemplateLensReviewCommand.js +51 -0
- package/dist-cjs/commands/index.js +14 -0
- package/dist-cjs/models/models_0.js +14 -1
- package/dist-cjs/pagination/ListReviewTemplateAnswersPaginator.js +29 -0
- package/dist-cjs/pagination/ListReviewTemplatesPaginator.js +29 -0
- package/dist-cjs/pagination/ListTemplateSharesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1098 -53
- package/dist-es/WellArchitected.js +28 -0
- package/dist-es/commands/CreateReviewTemplateCommand.js +47 -0
- package/dist-es/commands/CreateTemplateShareCommand.js +47 -0
- package/dist-es/commands/DeleteReviewTemplateCommand.js +47 -0
- package/dist-es/commands/DeleteTemplateShareCommand.js +47 -0
- package/dist-es/commands/GetReviewTemplateAnswerCommand.js +47 -0
- package/dist-es/commands/GetReviewTemplateCommand.js +47 -0
- package/dist-es/commands/GetReviewTemplateLensReviewCommand.js +47 -0
- package/dist-es/commands/ListReviewTemplateAnswersCommand.js +47 -0
- package/dist-es/commands/ListReviewTemplatesCommand.js +47 -0
- package/dist-es/commands/ListTemplateSharesCommand.js +47 -0
- package/dist-es/commands/UpdateReviewTemplateAnswerCommand.js +47 -0
- package/dist-es/commands/UpdateReviewTemplateCommand.js +47 -0
- package/dist-es/commands/UpdateReviewTemplateLensReviewCommand.js +47 -0
- package/dist-es/commands/UpgradeReviewTemplateLensReviewCommand.js +47 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/models/models_0.js +13 -0
- package/dist-es/pagination/ListReviewTemplateAnswersPaginator.js +25 -0
- package/dist-es/pagination/ListReviewTemplatesPaginator.js +25 -0
- package/dist-es/pagination/ListTemplateSharesPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1065 -48
- package/dist-types/WellArchitected.d.ts +98 -0
- package/dist-types/WellArchitectedClient.d.ts +18 -2
- package/dist-types/commands/CreateReviewTemplateCommand.d.ts +114 -0
- package/dist-types/commands/CreateTemplateShareCommand.d.ts +111 -0
- package/dist-types/commands/CreateWorkloadCommand.d.ts +26 -0
- package/dist-types/commands/DeleteReviewTemplateCommand.d.ts +94 -0
- package/dist-types/commands/DeleteTemplateShareCommand.d.ts +94 -0
- package/dist-types/commands/GetReviewTemplateAnswerCommand.d.ts +141 -0
- package/dist-types/commands/GetReviewTemplateCommand.d.ts +106 -0
- package/dist-types/commands/GetReviewTemplateLensReviewCommand.d.ts +112 -0
- package/dist-types/commands/ListNotificationsCommand.d.ts +3 -0
- package/dist-types/commands/ListReviewTemplateAnswersCommand.d.ts +141 -0
- package/dist-types/commands/ListReviewTemplatesCommand.d.ts +99 -0
- package/dist-types/commands/ListShareInvitationsCommand.d.ts +10 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTemplateSharesCommand.d.ts +101 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateReviewTemplateAnswerCommand.d.ts +157 -0
- package/dist-types/commands/UpdateReviewTemplateCommand.d.ts +118 -0
- package/dist-types/commands/UpdateReviewTemplateLensReviewCommand.d.ts +119 -0
- package/dist-types/commands/UpdateShareInvitationCommand.d.ts +2 -1
- package/dist-types/commands/UpgradeReviewTemplateLensReviewCommand.d.ts +91 -0
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/models/models_0.d.ts +1206 -103
- package/dist-types/pagination/ListReviewTemplateAnswersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListReviewTemplatesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTemplateSharesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
- package/dist-types/ts3.4/WellArchitected.d.ts +238 -0
- package/dist-types/ts3.4/WellArchitectedClient.d.ts +86 -2
- package/dist-types/ts3.4/commands/CreateReviewTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateTemplateShareCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteReviewTemplateCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DeleteTemplateShareCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/GetReviewTemplateAnswerCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetReviewTemplateCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetReviewTemplateLensReviewCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListReviewTemplateAnswersCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListReviewTemplatesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListTemplateSharesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateReviewTemplateAnswerCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateReviewTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateReviewTemplateLensReviewCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpgradeReviewTemplateLensReviewCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/models/models_0.d.ts +227 -0
- package/dist-types/ts3.4/pagination/ListReviewTemplateAnswersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListReviewTemplatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTemplateSharesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
- package/package.json +31 -31
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { DeleteTemplateShareInput } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, WellArchitectedClientResolvedConfig } from "../WellArchitectedClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteTemplateShareCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteTemplateShareCommandInput extends DeleteTemplateShareInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteTemplateShareCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteTemplateShareCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Delete a review template share.</p>
|
|
27
|
+
* <p>After the review template share is deleted, Amazon Web Services accounts, users,
|
|
28
|
+
* organizations, and organizational units (OUs) that you shared the review template with
|
|
29
|
+
* will no longer be able to apply it to new workloads.</p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { WellArchitectedClient, DeleteTemplateShareCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
|
|
34
|
+
* // const { WellArchitectedClient, DeleteTemplateShareCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
|
|
35
|
+
* const client = new WellArchitectedClient(config);
|
|
36
|
+
* const input = { // DeleteTemplateShareInput
|
|
37
|
+
* ShareId: "STRING_VALUE", // required
|
|
38
|
+
* TemplateArn: "STRING_VALUE", // required
|
|
39
|
+
* ClientRequestToken: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteTemplateShareCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param DeleteTemplateShareCommandInput - {@link DeleteTemplateShareCommandInput}
|
|
48
|
+
* @returns {@link DeleteTemplateShareCommandOutput}
|
|
49
|
+
* @see {@link DeleteTemplateShareCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link DeleteTemplateShareCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
54
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ConflictException} (client fault)
|
|
57
|
+
* <p>The resource has already been processed, was deleted, or is too large.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InternalServerException} (server fault)
|
|
60
|
+
* <p>There is a problem with the Well-Architected Tool API service.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
|
+
* <p>The requested resource was not found.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
66
|
+
* <p>Request was denied due to request throttling.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ValidationException} (client fault)
|
|
69
|
+
* <p>The user input is not valid.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link WellArchitectedServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from WellArchitected service.</p>
|
|
73
|
+
*
|
|
74
|
+
*/
|
|
75
|
+
export declare class DeleteTemplateShareCommand extends $Command<DeleteTemplateShareCommandInput, DeleteTemplateShareCommandOutput, WellArchitectedClientResolvedConfig> {
|
|
76
|
+
readonly input: DeleteTemplateShareCommandInput;
|
|
77
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
constructor(input: DeleteTemplateShareCommandInput);
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
85
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WellArchitectedClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteTemplateShareCommandInput, DeleteTemplateShareCommandOutput>;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
private serialize;
|
|
90
|
+
/**
|
|
91
|
+
* @internal
|
|
92
|
+
*/
|
|
93
|
+
private deserialize;
|
|
94
|
+
}
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetReviewTemplateAnswerInput, GetReviewTemplateAnswerOutput } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, WellArchitectedClientResolvedConfig } from "../WellArchitectedClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetReviewTemplateAnswerCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetReviewTemplateAnswerCommandInput extends GetReviewTemplateAnswerInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetReviewTemplateAnswerCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetReviewTemplateAnswerCommandOutput extends GetReviewTemplateAnswerOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Get review template answer.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { WellArchitectedClient, GetReviewTemplateAnswerCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
|
|
31
|
+
* // const { WellArchitectedClient, GetReviewTemplateAnswerCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
|
|
32
|
+
* const client = new WellArchitectedClient(config);
|
|
33
|
+
* const input = { // GetReviewTemplateAnswerInput
|
|
34
|
+
* TemplateArn: "STRING_VALUE", // required
|
|
35
|
+
* LensAlias: "STRING_VALUE", // required
|
|
36
|
+
* QuestionId: "STRING_VALUE", // required
|
|
37
|
+
* };
|
|
38
|
+
* const command = new GetReviewTemplateAnswerCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // GetReviewTemplateAnswerOutput
|
|
41
|
+
* // TemplateArn: "STRING_VALUE",
|
|
42
|
+
* // LensAlias: "STRING_VALUE",
|
|
43
|
+
* // Answer: { // ReviewTemplateAnswer
|
|
44
|
+
* // QuestionId: "STRING_VALUE",
|
|
45
|
+
* // PillarId: "STRING_VALUE",
|
|
46
|
+
* // QuestionTitle: "STRING_VALUE",
|
|
47
|
+
* // QuestionDescription: "STRING_VALUE",
|
|
48
|
+
* // ImprovementPlanUrl: "STRING_VALUE",
|
|
49
|
+
* // HelpfulResourceUrl: "STRING_VALUE",
|
|
50
|
+
* // HelpfulResourceDisplayText: "STRING_VALUE",
|
|
51
|
+
* // Choices: [ // Choices
|
|
52
|
+
* // { // Choice
|
|
53
|
+
* // ChoiceId: "STRING_VALUE",
|
|
54
|
+
* // Title: "STRING_VALUE",
|
|
55
|
+
* // Description: "STRING_VALUE",
|
|
56
|
+
* // HelpfulResource: { // ChoiceContent
|
|
57
|
+
* // DisplayText: "STRING_VALUE",
|
|
58
|
+
* // Url: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // ImprovementPlan: {
|
|
61
|
+
* // DisplayText: "STRING_VALUE",
|
|
62
|
+
* // Url: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // AdditionalResources: [ // AdditionalResourcesList
|
|
65
|
+
* // { // AdditionalResources
|
|
66
|
+
* // Type: "HELPFUL_RESOURCE" || "IMPROVEMENT_PLAN",
|
|
67
|
+
* // Content: [ // Urls
|
|
68
|
+
* // {
|
|
69
|
+
* // DisplayText: "STRING_VALUE",
|
|
70
|
+
* // Url: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // SelectedChoices: [ // SelectedChoices
|
|
78
|
+
* // "STRING_VALUE",
|
|
79
|
+
* // ],
|
|
80
|
+
* // ChoiceAnswers: [ // ChoiceAnswers
|
|
81
|
+
* // { // ChoiceAnswer
|
|
82
|
+
* // ChoiceId: "STRING_VALUE",
|
|
83
|
+
* // Status: "SELECTED" || "NOT_APPLICABLE" || "UNSELECTED",
|
|
84
|
+
* // Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
|
|
85
|
+
* // Notes: "STRING_VALUE",
|
|
86
|
+
* // },
|
|
87
|
+
* // ],
|
|
88
|
+
* // IsApplicable: true || false,
|
|
89
|
+
* // AnswerStatus: "UNANSWERED" || "ANSWERED",
|
|
90
|
+
* // Notes: "STRING_VALUE",
|
|
91
|
+
* // Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
|
|
92
|
+
* // },
|
|
93
|
+
* // };
|
|
94
|
+
*
|
|
95
|
+
* ```
|
|
96
|
+
*
|
|
97
|
+
* @param GetReviewTemplateAnswerCommandInput - {@link GetReviewTemplateAnswerCommandInput}
|
|
98
|
+
* @returns {@link GetReviewTemplateAnswerCommandOutput}
|
|
99
|
+
* @see {@link GetReviewTemplateAnswerCommandInput} for command's `input` shape.
|
|
100
|
+
* @see {@link GetReviewTemplateAnswerCommandOutput} for command's `response` shape.
|
|
101
|
+
* @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
104
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link InternalServerException} (server fault)
|
|
107
|
+
* <p>There is a problem with the Well-Architected Tool API service.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
110
|
+
* <p>The requested resource was not found.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
113
|
+
* <p>Request was denied due to request throttling.</p>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link ValidationException} (client fault)
|
|
116
|
+
* <p>The user input is not valid.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link WellArchitectedServiceException}
|
|
119
|
+
* <p>Base exception class for all service exceptions from WellArchitected service.</p>
|
|
120
|
+
*
|
|
121
|
+
*/
|
|
122
|
+
export declare class GetReviewTemplateAnswerCommand extends $Command<GetReviewTemplateAnswerCommandInput, GetReviewTemplateAnswerCommandOutput, WellArchitectedClientResolvedConfig> {
|
|
123
|
+
readonly input: GetReviewTemplateAnswerCommandInput;
|
|
124
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
125
|
+
/**
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
constructor(input: GetReviewTemplateAnswerCommandInput);
|
|
129
|
+
/**
|
|
130
|
+
* @internal
|
|
131
|
+
*/
|
|
132
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WellArchitectedClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetReviewTemplateAnswerCommandInput, GetReviewTemplateAnswerCommandOutput>;
|
|
133
|
+
/**
|
|
134
|
+
* @internal
|
|
135
|
+
*/
|
|
136
|
+
private serialize;
|
|
137
|
+
/**
|
|
138
|
+
* @internal
|
|
139
|
+
*/
|
|
140
|
+
private deserialize;
|
|
141
|
+
}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetReviewTemplateInput, GetReviewTemplateOutput } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, WellArchitectedClientResolvedConfig } from "../WellArchitectedClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetReviewTemplateCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetReviewTemplateCommandInput extends GetReviewTemplateInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetReviewTemplateCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetReviewTemplateCommandOutput extends GetReviewTemplateOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Get review template.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { WellArchitectedClient, GetReviewTemplateCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
|
|
31
|
+
* // const { WellArchitectedClient, GetReviewTemplateCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
|
|
32
|
+
* const client = new WellArchitectedClient(config);
|
|
33
|
+
* const input = { // GetReviewTemplateInput
|
|
34
|
+
* TemplateArn: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetReviewTemplateCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetReviewTemplateOutput
|
|
39
|
+
* // ReviewTemplate: { // ReviewTemplate
|
|
40
|
+
* // Description: "STRING_VALUE",
|
|
41
|
+
* // Lenses: [ // ReviewTemplateLenses
|
|
42
|
+
* // "STRING_VALUE",
|
|
43
|
+
* // ],
|
|
44
|
+
* // Notes: "STRING_VALUE",
|
|
45
|
+
* // QuestionCounts: { // QuestionCounts
|
|
46
|
+
* // "<keys>": Number("int"),
|
|
47
|
+
* // },
|
|
48
|
+
* // Owner: "STRING_VALUE",
|
|
49
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
50
|
+
* // TemplateArn: "STRING_VALUE",
|
|
51
|
+
* // TemplateName: "STRING_VALUE",
|
|
52
|
+
* // Tags: { // TagMap
|
|
53
|
+
* // "<keys>": "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // UpdateStatus: "CURRENT" || "LENS_NOT_CURRENT",
|
|
56
|
+
* // ShareInvitationId: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* @param GetReviewTemplateCommandInput - {@link GetReviewTemplateCommandInput}
|
|
63
|
+
* @returns {@link GetReviewTemplateCommandOutput}
|
|
64
|
+
* @see {@link GetReviewTemplateCommandInput} for command's `input` shape.
|
|
65
|
+
* @see {@link GetReviewTemplateCommandOutput} for command's `response` shape.
|
|
66
|
+
* @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
69
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InternalServerException} (server fault)
|
|
72
|
+
* <p>There is a problem with the Well-Architected Tool API service.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
+
* <p>The requested resource was not found.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
78
|
+
* <p>Request was denied due to request throttling.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ValidationException} (client fault)
|
|
81
|
+
* <p>The user input is not valid.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link WellArchitectedServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from WellArchitected service.</p>
|
|
85
|
+
*
|
|
86
|
+
*/
|
|
87
|
+
export declare class GetReviewTemplateCommand extends $Command<GetReviewTemplateCommandInput, GetReviewTemplateCommandOutput, WellArchitectedClientResolvedConfig> {
|
|
88
|
+
readonly input: GetReviewTemplateCommandInput;
|
|
89
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
constructor(input: GetReviewTemplateCommandInput);
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WellArchitectedClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetReviewTemplateCommandInput, GetReviewTemplateCommandOutput>;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
private serialize;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
private deserialize;
|
|
106
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetReviewTemplateLensReviewInput, GetReviewTemplateLensReviewOutput } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, WellArchitectedClientResolvedConfig } from "../WellArchitectedClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetReviewTemplateLensReviewCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetReviewTemplateLensReviewCommandInput extends GetReviewTemplateLensReviewInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetReviewTemplateLensReviewCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetReviewTemplateLensReviewCommandOutput extends GetReviewTemplateLensReviewOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Get a lens review associated with a review template.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { WellArchitectedClient, GetReviewTemplateLensReviewCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
|
|
31
|
+
* // const { WellArchitectedClient, GetReviewTemplateLensReviewCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
|
|
32
|
+
* const client = new WellArchitectedClient(config);
|
|
33
|
+
* const input = { // GetReviewTemplateLensReviewInput
|
|
34
|
+
* TemplateArn: "STRING_VALUE", // required
|
|
35
|
+
* LensAlias: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new GetReviewTemplateLensReviewCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // GetReviewTemplateLensReviewOutput
|
|
40
|
+
* // TemplateArn: "STRING_VALUE",
|
|
41
|
+
* // LensReview: { // ReviewTemplateLensReview
|
|
42
|
+
* // LensAlias: "STRING_VALUE",
|
|
43
|
+
* // LensArn: "STRING_VALUE",
|
|
44
|
+
* // LensVersion: "STRING_VALUE",
|
|
45
|
+
* // LensName: "STRING_VALUE",
|
|
46
|
+
* // LensStatus: "CURRENT" || "NOT_CURRENT" || "DEPRECATED" || "DELETED" || "UNSHARED",
|
|
47
|
+
* // PillarReviewSummaries: [ // ReviewTemplatePillarReviewSummaries
|
|
48
|
+
* // { // ReviewTemplatePillarReviewSummary
|
|
49
|
+
* // PillarId: "STRING_VALUE",
|
|
50
|
+
* // PillarName: "STRING_VALUE",
|
|
51
|
+
* // Notes: "STRING_VALUE",
|
|
52
|
+
* // QuestionCounts: { // QuestionCounts
|
|
53
|
+
* // "<keys>": Number("int"),
|
|
54
|
+
* // },
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
58
|
+
* // Notes: "STRING_VALUE",
|
|
59
|
+
* // QuestionCounts: {
|
|
60
|
+
* // "<keys>": Number("int"),
|
|
61
|
+
* // },
|
|
62
|
+
* // NextToken: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param GetReviewTemplateLensReviewCommandInput - {@link GetReviewTemplateLensReviewCommandInput}
|
|
69
|
+
* @returns {@link GetReviewTemplateLensReviewCommandOutput}
|
|
70
|
+
* @see {@link GetReviewTemplateLensReviewCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link GetReviewTemplateLensReviewCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InternalServerException} (server fault)
|
|
78
|
+
* <p>There is a problem with the Well-Architected Tool API service.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
81
|
+
* <p>The requested resource was not found.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
84
|
+
* <p>Request was denied due to request throttling.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ValidationException} (client fault)
|
|
87
|
+
* <p>The user input is not valid.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link WellArchitectedServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from WellArchitected service.</p>
|
|
91
|
+
*
|
|
92
|
+
*/
|
|
93
|
+
export declare class GetReviewTemplateLensReviewCommand extends $Command<GetReviewTemplateLensReviewCommandInput, GetReviewTemplateLensReviewCommandOutput, WellArchitectedClientResolvedConfig> {
|
|
94
|
+
readonly input: GetReviewTemplateLensReviewCommandInput;
|
|
95
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
96
|
+
/**
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
constructor(input: GetReviewTemplateLensReviewCommandInput);
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WellArchitectedClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetReviewTemplateLensReviewCommandInput, GetReviewTemplateLensReviewCommandOutput>;
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
private serialize;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
private deserialize;
|
|
112
|
+
}
|
|
@@ -34,6 +34,7 @@ export interface ListNotificationsCommandOutput extends ListNotificationsOutput,
|
|
|
34
34
|
* WorkloadId: "STRING_VALUE",
|
|
35
35
|
* NextToken: "STRING_VALUE",
|
|
36
36
|
* MaxResults: Number("int"),
|
|
37
|
+
* ResourceArn: "STRING_VALUE",
|
|
37
38
|
* };
|
|
38
39
|
* const command = new ListNotificationsCommand(input);
|
|
39
40
|
* const response = await client.send(command);
|
|
@@ -48,6 +49,8 @@ export interface ListNotificationsCommandOutput extends ListNotificationsOutput,
|
|
|
48
49
|
* // LensArn: "STRING_VALUE",
|
|
49
50
|
* // CurrentLensVersion: "STRING_VALUE",
|
|
50
51
|
* // LatestLensVersion: "STRING_VALUE",
|
|
52
|
+
* // ResourceArn: "STRING_VALUE",
|
|
53
|
+
* // ResourceName: "STRING_VALUE",
|
|
51
54
|
* // },
|
|
52
55
|
* // },
|
|
53
56
|
* // ],
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ListReviewTemplateAnswersInput, ListReviewTemplateAnswersOutput } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, WellArchitectedClientResolvedConfig } from "../WellArchitectedClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListReviewTemplateAnswersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListReviewTemplateAnswersCommandInput extends ListReviewTemplateAnswersInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListReviewTemplateAnswersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListReviewTemplateAnswersCommandOutput extends ListReviewTemplateAnswersOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>List the answers of a review template.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { WellArchitectedClient, ListReviewTemplateAnswersCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
|
|
31
|
+
* // const { WellArchitectedClient, ListReviewTemplateAnswersCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
|
|
32
|
+
* const client = new WellArchitectedClient(config);
|
|
33
|
+
* const input = { // ListReviewTemplateAnswersInput
|
|
34
|
+
* TemplateArn: "STRING_VALUE", // required
|
|
35
|
+
* LensAlias: "STRING_VALUE", // required
|
|
36
|
+
* PillarId: "STRING_VALUE",
|
|
37
|
+
* NextToken: "STRING_VALUE",
|
|
38
|
+
* MaxResults: Number("int"),
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ListReviewTemplateAnswersCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ListReviewTemplateAnswersOutput
|
|
43
|
+
* // TemplateArn: "STRING_VALUE",
|
|
44
|
+
* // LensAlias: "STRING_VALUE",
|
|
45
|
+
* // AnswerSummaries: [ // ReviewTemplateAnswerSummaries
|
|
46
|
+
* // { // ReviewTemplateAnswerSummary
|
|
47
|
+
* // QuestionId: "STRING_VALUE",
|
|
48
|
+
* // PillarId: "STRING_VALUE",
|
|
49
|
+
* // QuestionTitle: "STRING_VALUE",
|
|
50
|
+
* // Choices: [ // Choices
|
|
51
|
+
* // { // Choice
|
|
52
|
+
* // ChoiceId: "STRING_VALUE",
|
|
53
|
+
* // Title: "STRING_VALUE",
|
|
54
|
+
* // Description: "STRING_VALUE",
|
|
55
|
+
* // HelpfulResource: { // ChoiceContent
|
|
56
|
+
* // DisplayText: "STRING_VALUE",
|
|
57
|
+
* // Url: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // ImprovementPlan: {
|
|
60
|
+
* // DisplayText: "STRING_VALUE",
|
|
61
|
+
* // Url: "STRING_VALUE",
|
|
62
|
+
* // },
|
|
63
|
+
* // AdditionalResources: [ // AdditionalResourcesList
|
|
64
|
+
* // { // AdditionalResources
|
|
65
|
+
* // Type: "HELPFUL_RESOURCE" || "IMPROVEMENT_PLAN",
|
|
66
|
+
* // Content: [ // Urls
|
|
67
|
+
* // {
|
|
68
|
+
* // DisplayText: "STRING_VALUE",
|
|
69
|
+
* // Url: "STRING_VALUE",
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // SelectedChoices: [ // SelectedChoices
|
|
77
|
+
* // "STRING_VALUE",
|
|
78
|
+
* // ],
|
|
79
|
+
* // ChoiceAnswerSummaries: [ // ChoiceAnswerSummaries
|
|
80
|
+
* // { // ChoiceAnswerSummary
|
|
81
|
+
* // ChoiceId: "STRING_VALUE",
|
|
82
|
+
* // Status: "SELECTED" || "NOT_APPLICABLE" || "UNSELECTED",
|
|
83
|
+
* // Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
|
|
84
|
+
* // },
|
|
85
|
+
* // ],
|
|
86
|
+
* // IsApplicable: true || false,
|
|
87
|
+
* // AnswerStatus: "UNANSWERED" || "ANSWERED",
|
|
88
|
+
* // Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
|
|
89
|
+
* // QuestionType: "PRIORITIZED" || "NON_PRIORITIZED",
|
|
90
|
+
* // },
|
|
91
|
+
* // ],
|
|
92
|
+
* // NextToken: "STRING_VALUE",
|
|
93
|
+
* // };
|
|
94
|
+
*
|
|
95
|
+
* ```
|
|
96
|
+
*
|
|
97
|
+
* @param ListReviewTemplateAnswersCommandInput - {@link ListReviewTemplateAnswersCommandInput}
|
|
98
|
+
* @returns {@link ListReviewTemplateAnswersCommandOutput}
|
|
99
|
+
* @see {@link ListReviewTemplateAnswersCommandInput} for command's `input` shape.
|
|
100
|
+
* @see {@link ListReviewTemplateAnswersCommandOutput} for command's `response` shape.
|
|
101
|
+
* @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
104
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link InternalServerException} (server fault)
|
|
107
|
+
* <p>There is a problem with the Well-Architected Tool API service.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
110
|
+
* <p>The requested resource was not found.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
113
|
+
* <p>Request was denied due to request throttling.</p>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link ValidationException} (client fault)
|
|
116
|
+
* <p>The user input is not valid.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link WellArchitectedServiceException}
|
|
119
|
+
* <p>Base exception class for all service exceptions from WellArchitected service.</p>
|
|
120
|
+
*
|
|
121
|
+
*/
|
|
122
|
+
export declare class ListReviewTemplateAnswersCommand extends $Command<ListReviewTemplateAnswersCommandInput, ListReviewTemplateAnswersCommandOutput, WellArchitectedClientResolvedConfig> {
|
|
123
|
+
readonly input: ListReviewTemplateAnswersCommandInput;
|
|
124
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
125
|
+
/**
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
constructor(input: ListReviewTemplateAnswersCommandInput);
|
|
129
|
+
/**
|
|
130
|
+
* @internal
|
|
131
|
+
*/
|
|
132
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WellArchitectedClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListReviewTemplateAnswersCommandInput, ListReviewTemplateAnswersCommandOutput>;
|
|
133
|
+
/**
|
|
134
|
+
* @internal
|
|
135
|
+
*/
|
|
136
|
+
private serialize;
|
|
137
|
+
/**
|
|
138
|
+
* @internal
|
|
139
|
+
*/
|
|
140
|
+
private deserialize;
|
|
141
|
+
}
|