@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.
- package/README.md +8 -0
- package/dist-cjs/WellArchitected.js +15 -0
- package/dist-cjs/commands/GetConsolidatedReportCommand.js +45 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +132 -148
- package/dist-cjs/pagination/GetConsolidatedReportPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +177 -2
- package/dist-es/WellArchitected.js +15 -0
- package/dist-es/commands/GetConsolidatedReportCommand.js +41 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +131 -147
- package/dist-es/pagination/GetConsolidatedReportPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +173 -0
- package/dist-types/WellArchitected.d.ts +69 -43
- package/dist-types/WellArchitectedClient.d.ts +3 -3
- package/dist-types/commands/AssociateLensesCommand.d.ts +5 -5
- package/dist-types/commands/CreateLensShareCommand.d.ts +10 -4
- package/dist-types/commands/CreateLensVersionCommand.d.ts +7 -5
- package/dist-types/commands/CreateMilestoneCommand.d.ts +2 -2
- package/dist-types/commands/CreateWorkloadCommand.d.ts +22 -12
- package/dist-types/commands/CreateWorkloadShareCommand.d.ts +6 -4
- package/dist-types/commands/DeleteLensCommand.d.ts +4 -4
- package/dist-types/commands/DeleteLensShareCommand.d.ts +4 -4
- package/dist-types/commands/DeleteWorkloadCommand.d.ts +2 -2
- package/dist-types/commands/DeleteWorkloadShareCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateLensesCommand.d.ts +6 -6
- package/dist-types/commands/ExportLensCommand.d.ts +6 -5
- package/dist-types/commands/GetAnswerCommand.d.ts +1 -1
- package/dist-types/commands/GetConsolidatedReportCommand.d.ts +82 -0
- package/dist-types/commands/GetLensCommand.d.ts +1 -1
- package/dist-types/commands/GetLensReviewCommand.d.ts +1 -1
- package/dist-types/commands/GetLensReviewReportCommand.d.ts +1 -1
- package/dist-types/commands/GetLensVersionDifferenceCommand.d.ts +1 -1
- package/dist-types/commands/GetMilestoneCommand.d.ts +1 -1
- package/dist-types/commands/GetWorkloadCommand.d.ts +1 -1
- package/dist-types/commands/ImportLensCommand.d.ts +12 -11
- package/dist-types/commands/ListAnswersCommand.d.ts +2 -2
- package/dist-types/commands/ListCheckDetailsCommand.d.ts +1 -1
- package/dist-types/commands/ListCheckSummariesCommand.d.ts +1 -1
- package/dist-types/commands/ListLensReviewImprovementsCommand.d.ts +1 -1
- package/dist-types/commands/ListLensReviewsCommand.d.ts +2 -2
- package/dist-types/commands/ListLensSharesCommand.d.ts +1 -1
- package/dist-types/commands/ListLensesCommand.d.ts +1 -1
- package/dist-types/commands/ListMilestonesCommand.d.ts +1 -1
- package/dist-types/commands/ListNotificationsCommand.d.ts +1 -1
- package/dist-types/commands/ListShareInvitationsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/ListWorkloadSharesCommand.d.ts +1 -1
- package/dist-types/commands/ListWorkloadsCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +5 -6
- package/dist-types/commands/UpdateAnswerCommand.d.ts +5 -5
- package/dist-types/commands/UpdateGlobalSettingsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateLensReviewCommand.d.ts +4 -4
- package/dist-types/commands/UpdateShareInvitationCommand.d.ts +3 -3
- package/dist-types/commands/UpdateWorkloadCommand.d.ts +8 -8
- package/dist-types/commands/UpdateWorkloadShareCommand.d.ts +2 -2
- package/dist-types/commands/UpgradeLensReviewCommand.d.ts +3 -3
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +833 -445
- package/dist-types/pagination/GetConsolidatedReportPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/WellArchitected.d.ts +17 -0
- package/dist-types/ts3.4/WellArchitectedClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/GetConsolidatedReportCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +210 -124
- package/dist-types/ts3.4/pagination/GetConsolidatedReportPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +34 -34
|
@@ -18,14 +18,19 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
20
|
* @public
|
|
21
|
+
* @enum
|
|
21
22
|
*/
|
|
22
|
-
export declare
|
|
23
|
-
ERROR
|
|
24
|
-
FETCH_FAILED
|
|
25
|
-
NOT_AVAILABLE
|
|
26
|
-
OKAY
|
|
27
|
-
WARNING
|
|
28
|
-
}
|
|
23
|
+
export declare const CheckStatus: {
|
|
24
|
+
readonly ERROR: "ERROR";
|
|
25
|
+
readonly FETCH_FAILED: "FETCH_FAILED";
|
|
26
|
+
readonly NOT_AVAILABLE: "NOT_AVAILABLE";
|
|
27
|
+
readonly OKAY: "OKAY";
|
|
28
|
+
readonly WARNING: "WARNING";
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export type CheckStatus = (typeof CheckStatus)[keyof typeof CheckStatus];
|
|
29
34
|
/**
|
|
30
35
|
* @public
|
|
31
36
|
* <p>The choice content.</p>
|
|
@@ -42,43 +47,59 @@ export interface ChoiceContent {
|
|
|
42
47
|
}
|
|
43
48
|
/**
|
|
44
49
|
* @public
|
|
50
|
+
* @enum
|
|
45
51
|
*/
|
|
46
|
-
export declare
|
|
47
|
-
HELPFUL_RESOURCE
|
|
48
|
-
IMPROVEMENT_PLAN
|
|
49
|
-
}
|
|
52
|
+
export declare const AdditionalResourceType: {
|
|
53
|
+
readonly HELPFUL_RESOURCE: "HELPFUL_RESOURCE";
|
|
54
|
+
readonly IMPROVEMENT_PLAN: "IMPROVEMENT_PLAN";
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
export type AdditionalResourceType = (typeof AdditionalResourceType)[keyof typeof AdditionalResourceType];
|
|
50
60
|
/**
|
|
51
61
|
* @public
|
|
52
|
-
* <p>The choice level additional resources.</p>
|
|
62
|
+
* <p>The choice level additional resources for a custom lens.</p>
|
|
63
|
+
* <p>This field does not apply to Amazon Web Services official lenses.</p>
|
|
53
64
|
*/
|
|
54
65
|
export interface AdditionalResources {
|
|
55
66
|
/**
|
|
56
|
-
* <p>Type of additional resource.</p>
|
|
67
|
+
* <p>Type of additional resource for a custom lens.</p>
|
|
57
68
|
*/
|
|
58
69
|
Type?: AdditionalResourceType | string;
|
|
59
70
|
/**
|
|
60
|
-
* <p>The URLs for additional resources, either helpful resources or improvement plans. Up to five additional URLs can be specified.</p>
|
|
71
|
+
* <p>The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.</p>
|
|
61
72
|
*/
|
|
62
73
|
Content?: ChoiceContent[];
|
|
63
74
|
}
|
|
64
75
|
/**
|
|
65
76
|
* @public
|
|
77
|
+
* @enum
|
|
66
78
|
*/
|
|
67
|
-
export declare
|
|
68
|
-
ARCHITECTURE_CONSTRAINTS
|
|
69
|
-
BUSINESS_PRIORITIES
|
|
70
|
-
NONE
|
|
71
|
-
OTHER
|
|
72
|
-
OUT_OF_SCOPE
|
|
73
|
-
}
|
|
79
|
+
export declare const ChoiceReason: {
|
|
80
|
+
readonly ARCHITECTURE_CONSTRAINTS: "ARCHITECTURE_CONSTRAINTS";
|
|
81
|
+
readonly BUSINESS_PRIORITIES: "BUSINESS_PRIORITIES";
|
|
82
|
+
readonly NONE: "NONE";
|
|
83
|
+
readonly OTHER: "OTHER";
|
|
84
|
+
readonly OUT_OF_SCOPE: "OUT_OF_SCOPE";
|
|
85
|
+
};
|
|
74
86
|
/**
|
|
75
87
|
* @public
|
|
76
88
|
*/
|
|
77
|
-
export
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
89
|
+
export type ChoiceReason = (typeof ChoiceReason)[keyof typeof ChoiceReason];
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
* @enum
|
|
93
|
+
*/
|
|
94
|
+
export declare const ChoiceStatus: {
|
|
95
|
+
readonly NOT_APPLICABLE: "NOT_APPLICABLE";
|
|
96
|
+
readonly SELECTED: "SELECTED";
|
|
97
|
+
readonly UNSELECTED: "UNSELECTED";
|
|
98
|
+
};
|
|
99
|
+
/**
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
export type ChoiceStatus = (typeof ChoiceStatus)[keyof typeof ChoiceStatus];
|
|
82
103
|
/**
|
|
83
104
|
* @public
|
|
84
105
|
* <p>A choice that has been answered on a question in your workload.</p>
|
|
@@ -119,39 +140,52 @@ export interface Choice {
|
|
|
119
140
|
*/
|
|
120
141
|
Description?: string;
|
|
121
142
|
/**
|
|
122
|
-
* <p>The
|
|
143
|
+
* <p>The helpful resource (both text and URL) for a particular choice.</p>
|
|
144
|
+
* <p>This field only applies to custom lenses. Each choice can have only one helpful resource.</p>
|
|
123
145
|
*/
|
|
124
146
|
HelpfulResource?: ChoiceContent;
|
|
125
147
|
/**
|
|
126
|
-
* <p>The
|
|
148
|
+
* <p>The improvement plan (both text and URL) for a particular choice.</p>
|
|
149
|
+
* <p>This field only applies to custom lenses. Each choice can have only one improvement plan.</p>
|
|
127
150
|
*/
|
|
128
151
|
ImprovementPlan?: ChoiceContent;
|
|
129
152
|
/**
|
|
130
|
-
* <p>The additional resources for a choice
|
|
153
|
+
* <p>The additional resources for a choice in a custom lens.</p>
|
|
154
|
+
* <p>A choice can have up to two additional resources: one of type <code>HELPFUL_RESOURCE</code>,
|
|
131
155
|
* one of type <code>IMPROVEMENT_PLAN</code>, or both.</p>
|
|
132
156
|
*/
|
|
133
157
|
AdditionalResources?: AdditionalResources[];
|
|
134
158
|
}
|
|
135
159
|
/**
|
|
136
160
|
* @public
|
|
161
|
+
* @enum
|
|
137
162
|
*/
|
|
138
|
-
export declare
|
|
139
|
-
ARCHITECTURE_CONSTRAINTS
|
|
140
|
-
BUSINESS_PRIORITIES
|
|
141
|
-
NONE
|
|
142
|
-
OTHER
|
|
143
|
-
OUT_OF_SCOPE
|
|
144
|
-
}
|
|
163
|
+
export declare const AnswerReason: {
|
|
164
|
+
readonly ARCHITECTURE_CONSTRAINTS: "ARCHITECTURE_CONSTRAINTS";
|
|
165
|
+
readonly BUSINESS_PRIORITIES: "BUSINESS_PRIORITIES";
|
|
166
|
+
readonly NONE: "NONE";
|
|
167
|
+
readonly OTHER: "OTHER";
|
|
168
|
+
readonly OUT_OF_SCOPE: "OUT_OF_SCOPE";
|
|
169
|
+
};
|
|
145
170
|
/**
|
|
146
171
|
* @public
|
|
147
172
|
*/
|
|
148
|
-
export
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
173
|
+
export type AnswerReason = (typeof AnswerReason)[keyof typeof AnswerReason];
|
|
174
|
+
/**
|
|
175
|
+
* @public
|
|
176
|
+
* @enum
|
|
177
|
+
*/
|
|
178
|
+
export declare const Risk: {
|
|
179
|
+
readonly HIGH: "HIGH";
|
|
180
|
+
readonly MEDIUM: "MEDIUM";
|
|
181
|
+
readonly NONE: "NONE";
|
|
182
|
+
readonly NOT_APPLICABLE: "NOT_APPLICABLE";
|
|
183
|
+
readonly UNANSWERED: "UNANSWERED";
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
export type Risk = (typeof Risk)[keyof typeof Risk];
|
|
155
189
|
/**
|
|
156
190
|
* @public
|
|
157
191
|
* <p>An answer of the question.</p>
|
|
@@ -163,7 +197,7 @@ export interface Answer {
|
|
|
163
197
|
QuestionId?: string;
|
|
164
198
|
/**
|
|
165
199
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
166
|
-
*
|
|
200
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
167
201
|
*/
|
|
168
202
|
PillarId?: string;
|
|
169
203
|
/**
|
|
@@ -175,16 +209,21 @@ export interface Answer {
|
|
|
175
209
|
*/
|
|
176
210
|
QuestionDescription?: string;
|
|
177
211
|
/**
|
|
178
|
-
* <p>The improvement plan URL for a question.</p>
|
|
179
|
-
*
|
|
212
|
+
* <p>The improvement plan URL for a question in an Amazon Web Services official lenses.</p>
|
|
213
|
+
* <p>This value is only available if the question has been answered.</p>
|
|
214
|
+
* <p>This value does not apply to custom lenses.</p>
|
|
180
215
|
*/
|
|
181
216
|
ImprovementPlanUrl?: string;
|
|
182
217
|
/**
|
|
183
|
-
* <p>The helpful resource URL
|
|
218
|
+
* <p>The helpful resource URL.</p>
|
|
219
|
+
* <p>For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.</p>
|
|
220
|
+
* <p>For custom lenses, this is the helpful resource URL for a question and is only provided
|
|
221
|
+
* if <code>HelpfulResourceDisplayText</code> was specified for the question.</p>
|
|
184
222
|
*/
|
|
185
223
|
HelpfulResourceUrl?: string;
|
|
186
224
|
/**
|
|
187
|
-
* <p>The helpful resource text to be displayed.</p>
|
|
225
|
+
* <p>The helpful resource text to be displayed for a custom lens.</p>
|
|
226
|
+
* <p>This field does not apply to Amazon Web Services official lenses.</p>
|
|
188
227
|
*/
|
|
189
228
|
HelpfulResourceDisplayText?: string;
|
|
190
229
|
/**
|
|
@@ -193,7 +232,7 @@ export interface Answer {
|
|
|
193
232
|
Choices?: Choice[];
|
|
194
233
|
/**
|
|
195
234
|
* <p>List of selected choice IDs in a question answer.</p>
|
|
196
|
-
*
|
|
235
|
+
* <p>The values entered replace the previously selected choices.</p>
|
|
197
236
|
*/
|
|
198
237
|
SelectedChoices?: string[];
|
|
199
238
|
/**
|
|
@@ -246,7 +285,7 @@ export interface AnswerSummary {
|
|
|
246
285
|
QuestionId?: string;
|
|
247
286
|
/**
|
|
248
287
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
249
|
-
*
|
|
288
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
250
289
|
*/
|
|
251
290
|
PillarId?: string;
|
|
252
291
|
/**
|
|
@@ -259,7 +298,7 @@ export interface AnswerSummary {
|
|
|
259
298
|
Choices?: Choice[];
|
|
260
299
|
/**
|
|
261
300
|
* <p>List of selected choice IDs in a question answer.</p>
|
|
262
|
-
*
|
|
301
|
+
* <p>The values entered replace the previously selected choices.</p>
|
|
263
302
|
*/
|
|
264
303
|
SelectedChoices?: string[];
|
|
265
304
|
/**
|
|
@@ -290,13 +329,13 @@ export interface AssociateLensesInput {
|
|
|
290
329
|
WorkloadId: string | undefined;
|
|
291
330
|
/**
|
|
292
331
|
* <p>List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.</p>
|
|
293
|
-
*
|
|
332
|
+
* <p>Identify a lens using its <a>LensSummary$LensAlias</a>.</p>
|
|
294
333
|
*/
|
|
295
334
|
LensAliases: string[] | undefined;
|
|
296
335
|
}
|
|
297
336
|
/**
|
|
298
337
|
* @public
|
|
299
|
-
* <p>The resource already
|
|
338
|
+
* <p>The resource has already been processed, was deleted, or is too large.</p>
|
|
300
339
|
*/
|
|
301
340
|
export declare class ConflictException extends __BaseException {
|
|
302
341
|
readonly name: "ConflictException";
|
|
@@ -398,13 +437,18 @@ export interface ValidationExceptionField {
|
|
|
398
437
|
}
|
|
399
438
|
/**
|
|
400
439
|
* @public
|
|
440
|
+
* @enum
|
|
401
441
|
*/
|
|
402
|
-
export declare
|
|
403
|
-
CANNOT_PARSE
|
|
404
|
-
FIELD_VALIDATION_FAILED
|
|
405
|
-
OTHER
|
|
406
|
-
UNKNOWN_OPERATION
|
|
407
|
-
}
|
|
442
|
+
export declare const ValidationExceptionReason: {
|
|
443
|
+
readonly CANNOT_PARSE: "CANNOT_PARSE";
|
|
444
|
+
readonly FIELD_VALIDATION_FAILED: "FIELD_VALIDATION_FAILED";
|
|
445
|
+
readonly OTHER: "OTHER";
|
|
446
|
+
readonly UNKNOWN_OPERATION: "UNKNOWN_OPERATION";
|
|
447
|
+
};
|
|
448
|
+
/**
|
|
449
|
+
* @public
|
|
450
|
+
*/
|
|
451
|
+
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
408
452
|
/**
|
|
409
453
|
* @public
|
|
410
454
|
* <p>The user input is not valid.</p>
|
|
@@ -431,19 +475,43 @@ export declare class ValidationException extends __BaseException {
|
|
|
431
475
|
}
|
|
432
476
|
/**
|
|
433
477
|
* @public
|
|
478
|
+
* <p>A best practice, or question choice, that has been identified as a risk in this question.</p>
|
|
434
479
|
*/
|
|
435
|
-
export
|
|
436
|
-
|
|
480
|
+
export interface BestPractice {
|
|
481
|
+
/**
|
|
482
|
+
* <p>The ID of a choice.</p>
|
|
483
|
+
*/
|
|
484
|
+
ChoiceId?: string;
|
|
485
|
+
/**
|
|
486
|
+
* <p>The title of a choice.</p>
|
|
487
|
+
*/
|
|
488
|
+
ChoiceTitle?: string;
|
|
437
489
|
}
|
|
438
490
|
/**
|
|
439
491
|
* @public
|
|
492
|
+
* @enum
|
|
440
493
|
*/
|
|
441
|
-
export declare
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
494
|
+
export declare const CheckProvider: {
|
|
495
|
+
readonly TRUSTED_ADVISOR: "TRUSTED_ADVISOR";
|
|
496
|
+
};
|
|
497
|
+
/**
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
export type CheckProvider = (typeof CheckProvider)[keyof typeof CheckProvider];
|
|
501
|
+
/**
|
|
502
|
+
* @public
|
|
503
|
+
* @enum
|
|
504
|
+
*/
|
|
505
|
+
export declare const CheckFailureReason: {
|
|
506
|
+
readonly ACCESS_DENIED: "ACCESS_DENIED";
|
|
507
|
+
readonly ASSUME_ROLE_ERROR: "ASSUME_ROLE_ERROR";
|
|
508
|
+
readonly PREMIUM_SUPPORT_REQUIRED: "PREMIUM_SUPPORT_REQUIRED";
|
|
509
|
+
readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
|
|
510
|
+
};
|
|
511
|
+
/**
|
|
512
|
+
* @public
|
|
513
|
+
*/
|
|
514
|
+
export type CheckFailureReason = (typeof CheckFailureReason)[keyof typeof CheckFailureReason];
|
|
447
515
|
/**
|
|
448
516
|
* @public
|
|
449
517
|
* <p>Account details for a Well-Architected best practice in relation to Trusted Advisor checks.</p>
|
|
@@ -471,7 +539,7 @@ export interface CheckDetail {
|
|
|
471
539
|
LensArn?: string;
|
|
472
540
|
/**
|
|
473
541
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
474
|
-
*
|
|
542
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
475
543
|
*/
|
|
476
544
|
PillarId?: string;
|
|
477
545
|
/**
|
|
@@ -534,7 +602,7 @@ export interface CheckSummary {
|
|
|
534
602
|
LensArn?: string;
|
|
535
603
|
/**
|
|
536
604
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
537
|
-
*
|
|
605
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
538
606
|
*/
|
|
539
607
|
PillarId?: string;
|
|
540
608
|
/**
|
|
@@ -568,8 +636,9 @@ export interface ChoiceImprovementPlan {
|
|
|
568
636
|
*/
|
|
569
637
|
DisplayText?: string;
|
|
570
638
|
/**
|
|
571
|
-
* <p>The improvement plan URL for a question.</p>
|
|
572
|
-
*
|
|
639
|
+
* <p>The improvement plan URL for a question in an Amazon Web Services official lenses.</p>
|
|
640
|
+
* <p>This value is only available if the question has been answered.</p>
|
|
641
|
+
* <p>This value does not apply to custom lenses.</p>
|
|
573
642
|
*/
|
|
574
643
|
ImprovementPlanUrl?: string;
|
|
575
644
|
}
|
|
@@ -591,16 +660,125 @@ export interface ChoiceUpdate {
|
|
|
591
660
|
*/
|
|
592
661
|
Notes?: string;
|
|
593
662
|
}
|
|
663
|
+
/**
|
|
664
|
+
* @public
|
|
665
|
+
* <p>A metric for a particular question in the pillar. </p>
|
|
666
|
+
*/
|
|
667
|
+
export interface QuestionMetric {
|
|
668
|
+
/**
|
|
669
|
+
* <p>The ID of the question.</p>
|
|
670
|
+
*/
|
|
671
|
+
QuestionId?: string;
|
|
672
|
+
/**
|
|
673
|
+
* <p>The risk for a given workload, lens review, pillar, or question.</p>
|
|
674
|
+
*/
|
|
675
|
+
Risk?: Risk | string;
|
|
676
|
+
/**
|
|
677
|
+
* <p>The best practices, or choices, that have been identified as contributing to risk in a question.</p>
|
|
678
|
+
*/
|
|
679
|
+
BestPractices?: BestPractice[];
|
|
680
|
+
}
|
|
681
|
+
/**
|
|
682
|
+
* @public
|
|
683
|
+
* <p>A metric for a particular pillar in a lens.</p>
|
|
684
|
+
*/
|
|
685
|
+
export interface PillarMetric {
|
|
686
|
+
/**
|
|
687
|
+
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
688
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
689
|
+
*/
|
|
690
|
+
PillarId?: string;
|
|
691
|
+
/**
|
|
692
|
+
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
693
|
+
*/
|
|
694
|
+
RiskCounts?: Record<string, number>;
|
|
695
|
+
/**
|
|
696
|
+
* <p>The questions that have been identified as risks in the pillar.</p>
|
|
697
|
+
*/
|
|
698
|
+
Questions?: QuestionMetric[];
|
|
699
|
+
}
|
|
700
|
+
/**
|
|
701
|
+
* @public
|
|
702
|
+
* <p>A metric for a particular lens in a workload.</p>
|
|
703
|
+
*/
|
|
704
|
+
export interface LensMetric {
|
|
705
|
+
/**
|
|
706
|
+
* <p>The lens ARN.</p>
|
|
707
|
+
*/
|
|
708
|
+
LensArn?: string;
|
|
709
|
+
/**
|
|
710
|
+
* <p>The metrics for the pillars in a lens.</p>
|
|
711
|
+
*/
|
|
712
|
+
Pillars?: PillarMetric[];
|
|
713
|
+
/**
|
|
714
|
+
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
715
|
+
*/
|
|
716
|
+
RiskCounts?: Record<string, number>;
|
|
717
|
+
}
|
|
718
|
+
/**
|
|
719
|
+
* @public
|
|
720
|
+
* @enum
|
|
721
|
+
*/
|
|
722
|
+
export declare const MetricType: {
|
|
723
|
+
readonly WORKLOAD: "WORKLOAD";
|
|
724
|
+
};
|
|
725
|
+
/**
|
|
726
|
+
* @public
|
|
727
|
+
*/
|
|
728
|
+
export type MetricType = (typeof MetricType)[keyof typeof MetricType];
|
|
729
|
+
/**
|
|
730
|
+
* @public
|
|
731
|
+
* <p>A metric that contributes to the consolidated report.</p>
|
|
732
|
+
*/
|
|
733
|
+
export interface ConsolidatedReportMetric {
|
|
734
|
+
/**
|
|
735
|
+
* <p>The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.</p>
|
|
736
|
+
*/
|
|
737
|
+
MetricType?: MetricType | string;
|
|
738
|
+
/**
|
|
739
|
+
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
740
|
+
*/
|
|
741
|
+
RiskCounts?: Record<string, number>;
|
|
742
|
+
/**
|
|
743
|
+
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
744
|
+
*/
|
|
745
|
+
WorkloadId?: string;
|
|
746
|
+
/**
|
|
747
|
+
* <p>The name of the workload.</p>
|
|
748
|
+
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
749
|
+
* are ignored when checking for uniqueness.</p>
|
|
750
|
+
*/
|
|
751
|
+
WorkloadName?: string;
|
|
752
|
+
/**
|
|
753
|
+
* <p>The ARN for the workload.</p>
|
|
754
|
+
*/
|
|
755
|
+
WorkloadArn?: string;
|
|
756
|
+
/**
|
|
757
|
+
* <p>The date and time recorded.</p>
|
|
758
|
+
*/
|
|
759
|
+
UpdatedAt?: Date;
|
|
760
|
+
/**
|
|
761
|
+
* <p>The metrics for the lenses in the workload.</p>
|
|
762
|
+
*/
|
|
763
|
+
Lenses?: LensMetric[];
|
|
764
|
+
/**
|
|
765
|
+
* <p>The total number of lenses applied to the workload.</p>
|
|
766
|
+
*/
|
|
767
|
+
LensesAppliedCount?: number;
|
|
768
|
+
}
|
|
594
769
|
/**
|
|
595
770
|
* @public
|
|
596
771
|
*/
|
|
597
772
|
export interface CreateLensShareInput {
|
|
598
773
|
/**
|
|
599
774
|
* <p>The alias of the lens.</p>
|
|
600
|
-
*
|
|
601
|
-
*
|
|
602
|
-
*
|
|
603
|
-
*
|
|
775
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
776
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
777
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
778
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
779
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
780
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
781
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
604
782
|
*/
|
|
605
783
|
LensAlias: string | undefined;
|
|
606
784
|
/**
|
|
@@ -610,14 +788,14 @@ export interface CreateLensShareInput {
|
|
|
610
788
|
/**
|
|
611
789
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
612
790
|
* (executes only once).</p>
|
|
613
|
-
*
|
|
614
|
-
* the same client request token and the same parameters after
|
|
615
|
-
* successfully, the result of the original request is returned
|
|
616
|
-
*
|
|
791
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
792
|
+
* the same client request token and the same parameters after the original request has completed
|
|
793
|
+
* successfully, the result of the original request is returned.</p>
|
|
794
|
+
* <important>
|
|
617
795
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
618
796
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
619
797
|
* you must provide this token or the request will fail.</p>
|
|
620
|
-
*
|
|
798
|
+
* </important>
|
|
621
799
|
*/
|
|
622
800
|
ClientRequestToken?: string;
|
|
623
801
|
}
|
|
@@ -668,10 +846,13 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
668
846
|
export interface CreateLensVersionInput {
|
|
669
847
|
/**
|
|
670
848
|
* <p>The alias of the lens.</p>
|
|
671
|
-
*
|
|
672
|
-
*
|
|
673
|
-
*
|
|
674
|
-
*
|
|
849
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
850
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
851
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
852
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
853
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
854
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
855
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
675
856
|
*/
|
|
676
857
|
LensAlias: string | undefined;
|
|
677
858
|
/**
|
|
@@ -685,14 +866,14 @@ export interface CreateLensVersionInput {
|
|
|
685
866
|
/**
|
|
686
867
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
687
868
|
* (executes only once).</p>
|
|
688
|
-
*
|
|
689
|
-
* the same client request token and the same parameters after
|
|
690
|
-
* successfully, the result of the original request is returned
|
|
691
|
-
*
|
|
869
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
870
|
+
* the same client request token and the same parameters after the original request has completed
|
|
871
|
+
* successfully, the result of the original request is returned.</p>
|
|
872
|
+
* <important>
|
|
692
873
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
693
874
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
694
875
|
* you must provide this token or the request will fail.</p>
|
|
695
|
-
*
|
|
876
|
+
* </important>
|
|
696
877
|
*/
|
|
697
878
|
ClientRequestToken?: string;
|
|
698
879
|
}
|
|
@@ -720,20 +901,20 @@ export interface CreateMilestoneInput {
|
|
|
720
901
|
WorkloadId: string | undefined;
|
|
721
902
|
/**
|
|
722
903
|
* <p>The name of the milestone in a workload.</p>
|
|
723
|
-
*
|
|
904
|
+
* <p>Milestone names must be unique within a workload.</p>
|
|
724
905
|
*/
|
|
725
906
|
MilestoneName: string | undefined;
|
|
726
907
|
/**
|
|
727
908
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
728
909
|
* (executes only once).</p>
|
|
729
|
-
*
|
|
730
|
-
* the same client request token and the same parameters after
|
|
731
|
-
* successfully, the result of the original request is returned
|
|
732
|
-
*
|
|
910
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
911
|
+
* the same client request token and the same parameters after the original request has completed
|
|
912
|
+
* successfully, the result of the original request is returned.</p>
|
|
913
|
+
* <important>
|
|
733
914
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
734
915
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
735
916
|
* you must provide this token or the request will fail.</p>
|
|
736
|
-
*
|
|
917
|
+
* </important>
|
|
737
918
|
*/
|
|
738
919
|
ClientRequestToken?: string;
|
|
739
920
|
}
|
|
@@ -748,17 +929,22 @@ export interface CreateMilestoneOutput {
|
|
|
748
929
|
WorkloadId?: string;
|
|
749
930
|
/**
|
|
750
931
|
* <p>The milestone number.</p>
|
|
751
|
-
*
|
|
932
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
752
933
|
*/
|
|
753
934
|
MilestoneNumber?: number;
|
|
754
935
|
}
|
|
755
936
|
/**
|
|
756
937
|
* @public
|
|
938
|
+
* @enum
|
|
757
939
|
*/
|
|
758
|
-
export declare
|
|
759
|
-
DISABLED
|
|
760
|
-
ENABLED
|
|
761
|
-
}
|
|
940
|
+
export declare const TrustedAdvisorIntegrationStatus: {
|
|
941
|
+
readonly DISABLED: "DISABLED";
|
|
942
|
+
readonly ENABLED: "ENABLED";
|
|
943
|
+
};
|
|
944
|
+
/**
|
|
945
|
+
* @public
|
|
946
|
+
*/
|
|
947
|
+
export type TrustedAdvisorIntegrationStatus = (typeof TrustedAdvisorIntegrationStatus)[keyof typeof TrustedAdvisorIntegrationStatus];
|
|
762
948
|
/**
|
|
763
949
|
* @public
|
|
764
950
|
* <p>Discovery configuration associated to the workload.</p>
|
|
@@ -771,11 +957,16 @@ export interface WorkloadDiscoveryConfig {
|
|
|
771
957
|
}
|
|
772
958
|
/**
|
|
773
959
|
* @public
|
|
960
|
+
* @enum
|
|
774
961
|
*/
|
|
775
|
-
export declare
|
|
776
|
-
PREPRODUCTION
|
|
777
|
-
PRODUCTION
|
|
778
|
-
}
|
|
962
|
+
export declare const WorkloadEnvironment: {
|
|
963
|
+
readonly PREPRODUCTION: "PREPRODUCTION";
|
|
964
|
+
readonly PRODUCTION: "PRODUCTION";
|
|
965
|
+
};
|
|
966
|
+
/**
|
|
967
|
+
* @public
|
|
968
|
+
*/
|
|
969
|
+
export type WorkloadEnvironment = (typeof WorkloadEnvironment)[keyof typeof WorkloadEnvironment];
|
|
779
970
|
/**
|
|
780
971
|
* @public
|
|
781
972
|
* <p>Input for workload creation.</p>
|
|
@@ -783,7 +974,7 @@ export declare enum WorkloadEnvironment {
|
|
|
783
974
|
export interface CreateWorkloadInput {
|
|
784
975
|
/**
|
|
785
976
|
* <p>The name of the workload.</p>
|
|
786
|
-
*
|
|
977
|
+
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
787
978
|
* are ignored when checking for uniqueness.</p>
|
|
788
979
|
*/
|
|
789
980
|
WorkloadName: string | undefined;
|
|
@@ -824,140 +1015,140 @@ export interface CreateWorkloadInput {
|
|
|
824
1015
|
ReviewOwner?: string;
|
|
825
1016
|
/**
|
|
826
1017
|
* <p>The industry type for the workload.</p>
|
|
827
|
-
*
|
|
828
|
-
*
|
|
1018
|
+
* <p>If specified, must be one of the following:</p>
|
|
1019
|
+
* <ul>
|
|
829
1020
|
* <li>
|
|
830
|
-
*
|
|
1021
|
+
* <p>
|
|
831
1022
|
* <code>Agriculture</code>
|
|
832
1023
|
* </p>
|
|
833
1024
|
* </li>
|
|
834
1025
|
* <li>
|
|
835
|
-
*
|
|
1026
|
+
* <p>
|
|
836
1027
|
* <code>Automobile</code>
|
|
837
1028
|
* </p>
|
|
838
1029
|
* </li>
|
|
839
1030
|
* <li>
|
|
840
|
-
*
|
|
1031
|
+
* <p>
|
|
841
1032
|
* <code>Defense</code>
|
|
842
1033
|
* </p>
|
|
843
1034
|
* </li>
|
|
844
1035
|
* <li>
|
|
845
|
-
*
|
|
1036
|
+
* <p>
|
|
846
1037
|
* <code>Design and Engineering</code>
|
|
847
1038
|
* </p>
|
|
848
1039
|
* </li>
|
|
849
1040
|
* <li>
|
|
850
|
-
*
|
|
1041
|
+
* <p>
|
|
851
1042
|
* <code>Digital Advertising</code>
|
|
852
1043
|
* </p>
|
|
853
1044
|
* </li>
|
|
854
1045
|
* <li>
|
|
855
|
-
*
|
|
1046
|
+
* <p>
|
|
856
1047
|
* <code>Education</code>
|
|
857
1048
|
* </p>
|
|
858
1049
|
* </li>
|
|
859
1050
|
* <li>
|
|
860
|
-
*
|
|
1051
|
+
* <p>
|
|
861
1052
|
* <code>Environmental Protection</code>
|
|
862
1053
|
* </p>
|
|
863
1054
|
* </li>
|
|
864
1055
|
* <li>
|
|
865
|
-
*
|
|
1056
|
+
* <p>
|
|
866
1057
|
* <code>Financial Services</code>
|
|
867
1058
|
* </p>
|
|
868
1059
|
* </li>
|
|
869
1060
|
* <li>
|
|
870
|
-
*
|
|
1061
|
+
* <p>
|
|
871
1062
|
* <code>Gaming</code>
|
|
872
1063
|
* </p>
|
|
873
1064
|
* </li>
|
|
874
1065
|
* <li>
|
|
875
|
-
*
|
|
1066
|
+
* <p>
|
|
876
1067
|
* <code>General Public Services</code>
|
|
877
1068
|
* </p>
|
|
878
1069
|
* </li>
|
|
879
1070
|
* <li>
|
|
880
|
-
*
|
|
1071
|
+
* <p>
|
|
881
1072
|
* <code>Healthcare</code>
|
|
882
1073
|
* </p>
|
|
883
1074
|
* </li>
|
|
884
1075
|
* <li>
|
|
885
|
-
*
|
|
1076
|
+
* <p>
|
|
886
1077
|
* <code>Hospitality</code>
|
|
887
1078
|
* </p>
|
|
888
1079
|
* </li>
|
|
889
1080
|
* <li>
|
|
890
|
-
*
|
|
1081
|
+
* <p>
|
|
891
1082
|
* <code>InfoTech</code>
|
|
892
1083
|
* </p>
|
|
893
1084
|
* </li>
|
|
894
1085
|
* <li>
|
|
895
|
-
*
|
|
1086
|
+
* <p>
|
|
896
1087
|
* <code>Justice and Public Safety</code>
|
|
897
1088
|
* </p>
|
|
898
1089
|
* </li>
|
|
899
1090
|
* <li>
|
|
900
|
-
*
|
|
1091
|
+
* <p>
|
|
901
1092
|
* <code>Life Sciences</code>
|
|
902
1093
|
* </p>
|
|
903
1094
|
* </li>
|
|
904
1095
|
* <li>
|
|
905
|
-
*
|
|
1096
|
+
* <p>
|
|
906
1097
|
* <code>Manufacturing</code>
|
|
907
1098
|
* </p>
|
|
908
1099
|
* </li>
|
|
909
1100
|
* <li>
|
|
910
|
-
*
|
|
1101
|
+
* <p>
|
|
911
1102
|
* <code>Media & Entertainment</code>
|
|
912
1103
|
* </p>
|
|
913
1104
|
* </li>
|
|
914
1105
|
* <li>
|
|
915
|
-
*
|
|
1106
|
+
* <p>
|
|
916
1107
|
* <code>Mining & Resources</code>
|
|
917
1108
|
* </p>
|
|
918
1109
|
* </li>
|
|
919
1110
|
* <li>
|
|
920
|
-
*
|
|
1111
|
+
* <p>
|
|
921
1112
|
* <code>Oil & Gas</code>
|
|
922
1113
|
* </p>
|
|
923
1114
|
* </li>
|
|
924
1115
|
* <li>
|
|
925
|
-
*
|
|
1116
|
+
* <p>
|
|
926
1117
|
* <code>Power & Utilities</code>
|
|
927
1118
|
* </p>
|
|
928
1119
|
* </li>
|
|
929
1120
|
* <li>
|
|
930
|
-
*
|
|
1121
|
+
* <p>
|
|
931
1122
|
* <code>Professional Services</code>
|
|
932
1123
|
* </p>
|
|
933
1124
|
* </li>
|
|
934
1125
|
* <li>
|
|
935
|
-
*
|
|
1126
|
+
* <p>
|
|
936
1127
|
* <code>Real Estate & Construction</code>
|
|
937
1128
|
* </p>
|
|
938
1129
|
* </li>
|
|
939
1130
|
* <li>
|
|
940
|
-
*
|
|
1131
|
+
* <p>
|
|
941
1132
|
* <code>Retail & Wholesale</code>
|
|
942
1133
|
* </p>
|
|
943
1134
|
* </li>
|
|
944
1135
|
* <li>
|
|
945
|
-
*
|
|
1136
|
+
* <p>
|
|
946
1137
|
* <code>Social Protection</code>
|
|
947
1138
|
* </p>
|
|
948
1139
|
* </li>
|
|
949
1140
|
* <li>
|
|
950
|
-
*
|
|
1141
|
+
* <p>
|
|
951
1142
|
* <code>Telecommunications</code>
|
|
952
1143
|
* </p>
|
|
953
1144
|
* </li>
|
|
954
1145
|
* <li>
|
|
955
|
-
*
|
|
1146
|
+
* <p>
|
|
956
1147
|
* <code>Travel, Transportation & Logistics</code>
|
|
957
1148
|
* </p>
|
|
958
1149
|
* </li>
|
|
959
1150
|
* <li>
|
|
960
|
-
*
|
|
1151
|
+
* <p>
|
|
961
1152
|
* <code>Other</code>
|
|
962
1153
|
* </p>
|
|
963
1154
|
* </li>
|
|
@@ -979,14 +1170,14 @@ export interface CreateWorkloadInput {
|
|
|
979
1170
|
/**
|
|
980
1171
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
981
1172
|
* (executes only once).</p>
|
|
982
|
-
*
|
|
983
|
-
* the same client request token and the same parameters after
|
|
984
|
-
* successfully, the result of the original request is returned
|
|
985
|
-
*
|
|
1173
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
1174
|
+
* the same client request token and the same parameters after the original request has completed
|
|
1175
|
+
* successfully, the result of the original request is returned.</p>
|
|
1176
|
+
* <important>
|
|
986
1177
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
987
1178
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
988
1179
|
* you must provide this token or the request will fail.</p>
|
|
989
|
-
*
|
|
1180
|
+
* </important>
|
|
990
1181
|
*/
|
|
991
1182
|
ClientRequestToken?: string;
|
|
992
1183
|
/**
|
|
@@ -1018,11 +1209,16 @@ export interface CreateWorkloadOutput {
|
|
|
1018
1209
|
}
|
|
1019
1210
|
/**
|
|
1020
1211
|
* @public
|
|
1212
|
+
* @enum
|
|
1021
1213
|
*/
|
|
1022
|
-
export declare
|
|
1023
|
-
CONTRIBUTOR
|
|
1024
|
-
READONLY
|
|
1025
|
-
}
|
|
1214
|
+
export declare const PermissionType: {
|
|
1215
|
+
readonly CONTRIBUTOR: "CONTRIBUTOR";
|
|
1216
|
+
readonly READONLY: "READONLY";
|
|
1217
|
+
};
|
|
1218
|
+
/**
|
|
1219
|
+
* @public
|
|
1220
|
+
*/
|
|
1221
|
+
export type PermissionType = (typeof PermissionType)[keyof typeof PermissionType];
|
|
1026
1222
|
/**
|
|
1027
1223
|
* @public
|
|
1028
1224
|
* <p>Input for Create Workload Share</p>
|
|
@@ -1043,14 +1239,14 @@ export interface CreateWorkloadShareInput {
|
|
|
1043
1239
|
/**
|
|
1044
1240
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1045
1241
|
* (executes only once).</p>
|
|
1046
|
-
*
|
|
1047
|
-
* the same client request token and the same parameters after
|
|
1048
|
-
* successfully, the result of the original request is returned
|
|
1049
|
-
*
|
|
1242
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
1243
|
+
* the same client request token and the same parameters after the original request has completed
|
|
1244
|
+
* successfully, the result of the original request is returned.</p>
|
|
1245
|
+
* <important>
|
|
1050
1246
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
1051
1247
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
1052
1248
|
* you must provide this token or the request will fail.</p>
|
|
1053
|
-
*
|
|
1249
|
+
* </important>
|
|
1054
1250
|
*/
|
|
1055
1251
|
ClientRequestToken?: string;
|
|
1056
1252
|
}
|
|
@@ -1070,35 +1266,43 @@ export interface CreateWorkloadShareOutput {
|
|
|
1070
1266
|
}
|
|
1071
1267
|
/**
|
|
1072
1268
|
* @public
|
|
1269
|
+
* @enum
|
|
1073
1270
|
*/
|
|
1074
|
-
export declare
|
|
1075
|
-
ALL
|
|
1076
|
-
DRAFT
|
|
1077
|
-
PUBLISHED
|
|
1078
|
-
}
|
|
1271
|
+
export declare const LensStatusType: {
|
|
1272
|
+
readonly ALL: "ALL";
|
|
1273
|
+
readonly DRAFT: "DRAFT";
|
|
1274
|
+
readonly PUBLISHED: "PUBLISHED";
|
|
1275
|
+
};
|
|
1276
|
+
/**
|
|
1277
|
+
* @public
|
|
1278
|
+
*/
|
|
1279
|
+
export type LensStatusType = (typeof LensStatusType)[keyof typeof LensStatusType];
|
|
1079
1280
|
/**
|
|
1080
1281
|
* @public
|
|
1081
1282
|
*/
|
|
1082
1283
|
export interface DeleteLensInput {
|
|
1083
1284
|
/**
|
|
1084
1285
|
* <p>The alias of the lens.</p>
|
|
1085
|
-
*
|
|
1086
|
-
*
|
|
1087
|
-
*
|
|
1088
|
-
*
|
|
1286
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1287
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1288
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1289
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1290
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1291
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1292
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1089
1293
|
*/
|
|
1090
1294
|
LensAlias: string | undefined;
|
|
1091
1295
|
/**
|
|
1092
1296
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1093
1297
|
* (executes only once).</p>
|
|
1094
|
-
*
|
|
1095
|
-
* the same client request token and the same parameters after
|
|
1096
|
-
* successfully, the result of the original request is returned
|
|
1097
|
-
*
|
|
1298
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
1299
|
+
* the same client request token and the same parameters after the original request has completed
|
|
1300
|
+
* successfully, the result of the original request is returned.</p>
|
|
1301
|
+
* <important>
|
|
1098
1302
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
1099
1303
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
1100
1304
|
* you must provide this token or the request will fail.</p>
|
|
1101
|
-
*
|
|
1305
|
+
* </important>
|
|
1102
1306
|
*/
|
|
1103
1307
|
ClientRequestToken?: string;
|
|
1104
1308
|
/**
|
|
@@ -1116,23 +1320,26 @@ export interface DeleteLensShareInput {
|
|
|
1116
1320
|
ShareId: string | undefined;
|
|
1117
1321
|
/**
|
|
1118
1322
|
* <p>The alias of the lens.</p>
|
|
1119
|
-
*
|
|
1120
|
-
*
|
|
1121
|
-
*
|
|
1122
|
-
*
|
|
1323
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1324
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1325
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1326
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1327
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1328
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1329
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1123
1330
|
*/
|
|
1124
1331
|
LensAlias: string | undefined;
|
|
1125
1332
|
/**
|
|
1126
1333
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1127
1334
|
* (executes only once).</p>
|
|
1128
|
-
*
|
|
1129
|
-
* the same client request token and the same parameters after
|
|
1130
|
-
* successfully, the result of the original request is returned
|
|
1131
|
-
*
|
|
1335
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
1336
|
+
* the same client request token and the same parameters after the original request has completed
|
|
1337
|
+
* successfully, the result of the original request is returned.</p>
|
|
1338
|
+
* <important>
|
|
1132
1339
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
1133
1340
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
1134
1341
|
* you must provide this token or the request will fail.</p>
|
|
1135
|
-
*
|
|
1342
|
+
* </important>
|
|
1136
1343
|
*/
|
|
1137
1344
|
ClientRequestToken?: string;
|
|
1138
1345
|
}
|
|
@@ -1148,14 +1355,14 @@ export interface DeleteWorkloadInput {
|
|
|
1148
1355
|
/**
|
|
1149
1356
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1150
1357
|
* (executes only once).</p>
|
|
1151
|
-
*
|
|
1152
|
-
* the same client request token and the same parameters after
|
|
1153
|
-
* successfully, the result of the original request is returned
|
|
1154
|
-
*
|
|
1358
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
1359
|
+
* the same client request token and the same parameters after the original request has completed
|
|
1360
|
+
* successfully, the result of the original request is returned.</p>
|
|
1361
|
+
* <important>
|
|
1155
1362
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
1156
1363
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
1157
1364
|
* you must provide this token or the request will fail.</p>
|
|
1158
|
-
*
|
|
1365
|
+
* </important>
|
|
1159
1366
|
*/
|
|
1160
1367
|
ClientRequestToken?: string;
|
|
1161
1368
|
}
|
|
@@ -1175,25 +1382,30 @@ export interface DeleteWorkloadShareInput {
|
|
|
1175
1382
|
/**
|
|
1176
1383
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1177
1384
|
* (executes only once).</p>
|
|
1178
|
-
*
|
|
1179
|
-
* the same client request token and the same parameters after
|
|
1180
|
-
* successfully, the result of the original request is returned
|
|
1181
|
-
*
|
|
1385
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
1386
|
+
* the same client request token and the same parameters after the original request has completed
|
|
1387
|
+
* successfully, the result of the original request is returned.</p>
|
|
1388
|
+
* <important>
|
|
1182
1389
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
1183
1390
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
1184
1391
|
* you must provide this token or the request will fail.</p>
|
|
1185
|
-
*
|
|
1392
|
+
* </important>
|
|
1186
1393
|
*/
|
|
1187
1394
|
ClientRequestToken?: string;
|
|
1188
1395
|
}
|
|
1189
1396
|
/**
|
|
1190
1397
|
* @public
|
|
1398
|
+
* @enum
|
|
1191
1399
|
*/
|
|
1192
|
-
export declare
|
|
1193
|
-
DELETED
|
|
1194
|
-
NEW
|
|
1195
|
-
UPDATED
|
|
1196
|
-
}
|
|
1400
|
+
export declare const DifferenceStatus: {
|
|
1401
|
+
readonly DELETED: "DELETED";
|
|
1402
|
+
readonly NEW: "NEW";
|
|
1403
|
+
readonly UPDATED: "UPDATED";
|
|
1404
|
+
};
|
|
1405
|
+
/**
|
|
1406
|
+
* @public
|
|
1407
|
+
*/
|
|
1408
|
+
export type DifferenceStatus = (typeof DifferenceStatus)[keyof typeof DifferenceStatus];
|
|
1197
1409
|
/**
|
|
1198
1410
|
* @public
|
|
1199
1411
|
* <p>Input to disassociate lens reviews.</p>
|
|
@@ -1205,7 +1417,7 @@ export interface DisassociateLensesInput {
|
|
|
1205
1417
|
WorkloadId: string | undefined;
|
|
1206
1418
|
/**
|
|
1207
1419
|
* <p>List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.</p>
|
|
1208
|
-
*
|
|
1420
|
+
* <p>Identify a lens using its <a>LensSummary$LensAlias</a>.</p>
|
|
1209
1421
|
*/
|
|
1210
1422
|
LensAliases: string[] | undefined;
|
|
1211
1423
|
}
|
|
@@ -1215,10 +1427,13 @@ export interface DisassociateLensesInput {
|
|
|
1215
1427
|
export interface ExportLensInput {
|
|
1216
1428
|
/**
|
|
1217
1429
|
* <p>The alias of the lens.</p>
|
|
1218
|
-
*
|
|
1219
|
-
*
|
|
1220
|
-
*
|
|
1221
|
-
*
|
|
1430
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1431
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1432
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1433
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1434
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1435
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1436
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1222
1437
|
*/
|
|
1223
1438
|
LensAlias: string | undefined;
|
|
1224
1439
|
/**
|
|
@@ -1231,7 +1446,7 @@ export interface ExportLensInput {
|
|
|
1231
1446
|
*/
|
|
1232
1447
|
export interface ExportLensOutput {
|
|
1233
1448
|
/**
|
|
1234
|
-
* <p>The JSON
|
|
1449
|
+
* <p>The JSON representation of a lens.</p>
|
|
1235
1450
|
*/
|
|
1236
1451
|
LensJSON?: string;
|
|
1237
1452
|
}
|
|
@@ -1246,10 +1461,13 @@ export interface GetAnswerInput {
|
|
|
1246
1461
|
WorkloadId: string | undefined;
|
|
1247
1462
|
/**
|
|
1248
1463
|
* <p>The alias of the lens.</p>
|
|
1249
|
-
*
|
|
1250
|
-
*
|
|
1251
|
-
*
|
|
1252
|
-
*
|
|
1464
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1465
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1466
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1467
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1468
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1469
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1470
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1253
1471
|
*/
|
|
1254
1472
|
LensAlias: string | undefined;
|
|
1255
1473
|
/**
|
|
@@ -1258,7 +1476,7 @@ export interface GetAnswerInput {
|
|
|
1258
1476
|
QuestionId: string | undefined;
|
|
1259
1477
|
/**
|
|
1260
1478
|
* <p>The milestone number.</p>
|
|
1261
|
-
*
|
|
1479
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1262
1480
|
*/
|
|
1263
1481
|
MilestoneNumber?: number;
|
|
1264
1482
|
}
|
|
@@ -1273,15 +1491,18 @@ export interface GetAnswerOutput {
|
|
|
1273
1491
|
WorkloadId?: string;
|
|
1274
1492
|
/**
|
|
1275
1493
|
* <p>The milestone number.</p>
|
|
1276
|
-
*
|
|
1494
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1277
1495
|
*/
|
|
1278
1496
|
MilestoneNumber?: number;
|
|
1279
1497
|
/**
|
|
1280
1498
|
* <p>The alias of the lens.</p>
|
|
1281
|
-
*
|
|
1282
|
-
*
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1499
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1500
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1501
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1502
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1503
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1504
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1505
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1285
1506
|
*/
|
|
1286
1507
|
LensAlias?: string;
|
|
1287
1508
|
/**
|
|
@@ -1293,16 +1514,75 @@ export interface GetAnswerOutput {
|
|
|
1293
1514
|
*/
|
|
1294
1515
|
Answer?: Answer;
|
|
1295
1516
|
}
|
|
1517
|
+
/**
|
|
1518
|
+
* @public
|
|
1519
|
+
* @enum
|
|
1520
|
+
*/
|
|
1521
|
+
export declare const ReportFormat: {
|
|
1522
|
+
readonly JSON: "JSON";
|
|
1523
|
+
readonly PDF: "PDF";
|
|
1524
|
+
};
|
|
1525
|
+
/**
|
|
1526
|
+
* @public
|
|
1527
|
+
*/
|
|
1528
|
+
export type ReportFormat = (typeof ReportFormat)[keyof typeof ReportFormat];
|
|
1529
|
+
/**
|
|
1530
|
+
* @public
|
|
1531
|
+
*/
|
|
1532
|
+
export interface GetConsolidatedReportInput {
|
|
1533
|
+
/**
|
|
1534
|
+
* <p>The format of the consolidated report.</p>
|
|
1535
|
+
* <p>For <code>PDF</code>, <code>Base64String</code> is returned. For <code>JSON</code>,
|
|
1536
|
+
* <code>Metrics</code> is returned.</p>
|
|
1537
|
+
*/
|
|
1538
|
+
Format: ReportFormat | string | undefined;
|
|
1539
|
+
/**
|
|
1540
|
+
* <p>Set to <code>true</code> to have shared resources included in the report.</p>
|
|
1541
|
+
*/
|
|
1542
|
+
IncludeSharedResources?: boolean;
|
|
1543
|
+
/**
|
|
1544
|
+
* <p>The token to use to retrieve the next set of results.</p>
|
|
1545
|
+
*/
|
|
1546
|
+
NextToken?: string;
|
|
1547
|
+
/**
|
|
1548
|
+
* <p>The maximum number of results to return for this request.</p>
|
|
1549
|
+
*/
|
|
1550
|
+
MaxResults?: number;
|
|
1551
|
+
}
|
|
1552
|
+
/**
|
|
1553
|
+
* @public
|
|
1554
|
+
*/
|
|
1555
|
+
export interface GetConsolidatedReportOutput {
|
|
1556
|
+
/**
|
|
1557
|
+
* <p>The metrics that make up the consolidated report.</p>
|
|
1558
|
+
* <p>Only returned when <code>JSON</code> format is requested.</p>
|
|
1559
|
+
*/
|
|
1560
|
+
Metrics?: ConsolidatedReportMetric[];
|
|
1561
|
+
/**
|
|
1562
|
+
* <p>The token to use to retrieve the next set of results.</p>
|
|
1563
|
+
*/
|
|
1564
|
+
NextToken?: string;
|
|
1565
|
+
/**
|
|
1566
|
+
* <p>The Base64-encoded string representation of a lens review report.</p>
|
|
1567
|
+
* <p>This data can be used to create a PDF file.</p>
|
|
1568
|
+
* <p>Only returned by <a>GetConsolidatedReport</a>
|
|
1569
|
+
* when <code>PDF</code> format is requested.</p>
|
|
1570
|
+
*/
|
|
1571
|
+
Base64String?: string;
|
|
1572
|
+
}
|
|
1296
1573
|
/**
|
|
1297
1574
|
* @public
|
|
1298
1575
|
*/
|
|
1299
1576
|
export interface GetLensInput {
|
|
1300
1577
|
/**
|
|
1301
1578
|
* <p>The alias of the lens.</p>
|
|
1302
|
-
*
|
|
1303
|
-
*
|
|
1304
|
-
*
|
|
1305
|
-
*
|
|
1579
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1580
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1581
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1582
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1583
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1584
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1585
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1306
1586
|
*/
|
|
1307
1587
|
LensAlias: string | undefined;
|
|
1308
1588
|
/**
|
|
@@ -1364,28 +1644,36 @@ export interface GetLensReviewInput {
|
|
|
1364
1644
|
WorkloadId: string | undefined;
|
|
1365
1645
|
/**
|
|
1366
1646
|
* <p>The alias of the lens.</p>
|
|
1367
|
-
*
|
|
1368
|
-
*
|
|
1369
|
-
*
|
|
1370
|
-
*
|
|
1647
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1648
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1649
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1650
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1651
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1652
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1653
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1371
1654
|
*/
|
|
1372
1655
|
LensAlias: string | undefined;
|
|
1373
1656
|
/**
|
|
1374
1657
|
* <p>The milestone number.</p>
|
|
1375
|
-
*
|
|
1658
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1376
1659
|
*/
|
|
1377
1660
|
MilestoneNumber?: number;
|
|
1378
1661
|
}
|
|
1379
1662
|
/**
|
|
1380
1663
|
* @public
|
|
1664
|
+
* @enum
|
|
1381
1665
|
*/
|
|
1382
|
-
export declare
|
|
1383
|
-
CURRENT
|
|
1384
|
-
DELETED
|
|
1385
|
-
DEPRECATED
|
|
1386
|
-
NOT_CURRENT
|
|
1387
|
-
UNSHARED
|
|
1388
|
-
}
|
|
1666
|
+
export declare const LensStatus: {
|
|
1667
|
+
readonly CURRENT: "CURRENT";
|
|
1668
|
+
readonly DELETED: "DELETED";
|
|
1669
|
+
readonly DEPRECATED: "DEPRECATED";
|
|
1670
|
+
readonly NOT_CURRENT: "NOT_CURRENT";
|
|
1671
|
+
readonly UNSHARED: "UNSHARED";
|
|
1672
|
+
};
|
|
1673
|
+
/**
|
|
1674
|
+
* @public
|
|
1675
|
+
*/
|
|
1676
|
+
export type LensStatus = (typeof LensStatus)[keyof typeof LensStatus];
|
|
1389
1677
|
/**
|
|
1390
1678
|
* @public
|
|
1391
1679
|
* <p>A pillar review summary of a lens review.</p>
|
|
@@ -1393,7 +1681,7 @@ export declare enum LensStatus {
|
|
|
1393
1681
|
export interface PillarReviewSummary {
|
|
1394
1682
|
/**
|
|
1395
1683
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
1396
|
-
*
|
|
1684
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
1397
1685
|
*/
|
|
1398
1686
|
PillarId?: string;
|
|
1399
1687
|
/**
|
|
@@ -1405,7 +1693,7 @@ export interface PillarReviewSummary {
|
|
|
1405
1693
|
*/
|
|
1406
1694
|
Notes?: string;
|
|
1407
1695
|
/**
|
|
1408
|
-
* <p>A map from risk names to the count of how questions have that rating.</p>
|
|
1696
|
+
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
1409
1697
|
*/
|
|
1410
1698
|
RiskCounts?: Record<string, number>;
|
|
1411
1699
|
}
|
|
@@ -1416,10 +1704,13 @@ export interface PillarReviewSummary {
|
|
|
1416
1704
|
export interface LensReview {
|
|
1417
1705
|
/**
|
|
1418
1706
|
* <p>The alias of the lens.</p>
|
|
1419
|
-
*
|
|
1420
|
-
*
|
|
1421
|
-
*
|
|
1422
|
-
*
|
|
1707
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1708
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1709
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1710
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1711
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1712
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1713
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1423
1714
|
*/
|
|
1424
1715
|
LensAlias?: string;
|
|
1425
1716
|
/**
|
|
@@ -1451,7 +1742,7 @@ export interface LensReview {
|
|
|
1451
1742
|
*/
|
|
1452
1743
|
Notes?: string;
|
|
1453
1744
|
/**
|
|
1454
|
-
* <p>A map from risk names to the count of how questions have that rating.</p>
|
|
1745
|
+
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
1455
1746
|
*/
|
|
1456
1747
|
RiskCounts?: Record<string, number>;
|
|
1457
1748
|
/**
|
|
@@ -1470,7 +1761,7 @@ export interface GetLensReviewOutput {
|
|
|
1470
1761
|
WorkloadId?: string;
|
|
1471
1762
|
/**
|
|
1472
1763
|
* <p>The milestone number.</p>
|
|
1473
|
-
*
|
|
1764
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1474
1765
|
*/
|
|
1475
1766
|
MilestoneNumber?: number;
|
|
1476
1767
|
/**
|
|
@@ -1489,15 +1780,18 @@ export interface GetLensReviewReportInput {
|
|
|
1489
1780
|
WorkloadId: string | undefined;
|
|
1490
1781
|
/**
|
|
1491
1782
|
* <p>The alias of the lens.</p>
|
|
1492
|
-
*
|
|
1493
|
-
*
|
|
1494
|
-
*
|
|
1495
|
-
*
|
|
1783
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1784
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1785
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1786
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1787
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1788
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1789
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1496
1790
|
*/
|
|
1497
1791
|
LensAlias: string | undefined;
|
|
1498
1792
|
/**
|
|
1499
1793
|
* <p>The milestone number.</p>
|
|
1500
|
-
*
|
|
1794
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1501
1795
|
*/
|
|
1502
1796
|
MilestoneNumber?: number;
|
|
1503
1797
|
}
|
|
@@ -1508,10 +1802,13 @@ export interface GetLensReviewReportInput {
|
|
|
1508
1802
|
export interface LensReviewReport {
|
|
1509
1803
|
/**
|
|
1510
1804
|
* <p>The alias of the lens.</p>
|
|
1511
|
-
*
|
|
1512
|
-
*
|
|
1513
|
-
*
|
|
1514
|
-
*
|
|
1805
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1806
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1807
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1808
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1809
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1810
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1811
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1515
1812
|
*/
|
|
1516
1813
|
LensAlias?: string;
|
|
1517
1814
|
/**
|
|
@@ -1520,7 +1817,9 @@ export interface LensReviewReport {
|
|
|
1520
1817
|
LensArn?: string;
|
|
1521
1818
|
/**
|
|
1522
1819
|
* <p>The Base64-encoded string representation of a lens review report.</p>
|
|
1523
|
-
*
|
|
1820
|
+
* <p>This data can be used to create a PDF file.</p>
|
|
1821
|
+
* <p>Only returned by <a>GetConsolidatedReport</a>
|
|
1822
|
+
* when <code>PDF</code> format is requested.</p>
|
|
1524
1823
|
*/
|
|
1525
1824
|
Base64String?: string;
|
|
1526
1825
|
}
|
|
@@ -1535,7 +1834,7 @@ export interface GetLensReviewReportOutput {
|
|
|
1535
1834
|
WorkloadId?: string;
|
|
1536
1835
|
/**
|
|
1537
1836
|
* <p>The milestone number.</p>
|
|
1538
|
-
*
|
|
1837
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1539
1838
|
*/
|
|
1540
1839
|
MilestoneNumber?: number;
|
|
1541
1840
|
/**
|
|
@@ -1549,10 +1848,13 @@ export interface GetLensReviewReportOutput {
|
|
|
1549
1848
|
export interface GetLensVersionDifferenceInput {
|
|
1550
1849
|
/**
|
|
1551
1850
|
* <p>The alias of the lens.</p>
|
|
1552
|
-
*
|
|
1553
|
-
*
|
|
1554
|
-
*
|
|
1555
|
-
*
|
|
1851
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1852
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1853
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1854
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1855
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1856
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1857
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1556
1858
|
*/
|
|
1557
1859
|
LensAlias: string | undefined;
|
|
1558
1860
|
/**
|
|
@@ -1589,7 +1891,7 @@ export interface QuestionDifference {
|
|
|
1589
1891
|
export interface PillarDifference {
|
|
1590
1892
|
/**
|
|
1591
1893
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
1592
|
-
*
|
|
1894
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
1593
1895
|
*/
|
|
1594
1896
|
PillarId?: string;
|
|
1595
1897
|
/**
|
|
@@ -1621,10 +1923,13 @@ export interface VersionDifferences {
|
|
|
1621
1923
|
export interface GetLensVersionDifferenceOutput {
|
|
1622
1924
|
/**
|
|
1623
1925
|
* <p>The alias of the lens.</p>
|
|
1624
|
-
*
|
|
1625
|
-
*
|
|
1626
|
-
*
|
|
1627
|
-
*
|
|
1926
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1927
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
1928
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
1929
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
1930
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
1931
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
1932
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1628
1933
|
*/
|
|
1629
1934
|
LensAlias?: string;
|
|
1630
1935
|
/**
|
|
@@ -1659,20 +1964,25 @@ export interface GetMilestoneInput {
|
|
|
1659
1964
|
WorkloadId: string | undefined;
|
|
1660
1965
|
/**
|
|
1661
1966
|
* <p>The milestone number.</p>
|
|
1662
|
-
*
|
|
1967
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1663
1968
|
*/
|
|
1664
1969
|
MilestoneNumber: number | undefined;
|
|
1665
1970
|
}
|
|
1666
1971
|
/**
|
|
1667
1972
|
* @public
|
|
1973
|
+
* @enum
|
|
1668
1974
|
*/
|
|
1669
|
-
export declare
|
|
1670
|
-
COMPLETE
|
|
1671
|
-
IN_PROGRESS
|
|
1672
|
-
NOT_APPLICABLE
|
|
1673
|
-
NOT_STARTED
|
|
1674
|
-
RISK_ACKNOWLEDGED
|
|
1675
|
-
}
|
|
1975
|
+
export declare const WorkloadImprovementStatus: {
|
|
1976
|
+
readonly COMPLETE: "COMPLETE";
|
|
1977
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
1978
|
+
readonly NOT_APPLICABLE: "NOT_APPLICABLE";
|
|
1979
|
+
readonly NOT_STARTED: "NOT_STARTED";
|
|
1980
|
+
readonly RISK_ACKNOWLEDGED: "RISK_ACKNOWLEDGED";
|
|
1981
|
+
};
|
|
1982
|
+
/**
|
|
1983
|
+
* @public
|
|
1984
|
+
*/
|
|
1985
|
+
export type WorkloadImprovementStatus = (typeof WorkloadImprovementStatus)[keyof typeof WorkloadImprovementStatus];
|
|
1676
1986
|
/**
|
|
1677
1987
|
* @public
|
|
1678
1988
|
* <p>A workload return object.</p>
|
|
@@ -1688,7 +1998,7 @@ export interface Workload {
|
|
|
1688
1998
|
WorkloadArn?: string;
|
|
1689
1999
|
/**
|
|
1690
2000
|
* <p>The name of the workload.</p>
|
|
1691
|
-
*
|
|
2001
|
+
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
1692
2002
|
* are ignored when checking for uniqueness.</p>
|
|
1693
2003
|
*/
|
|
1694
2004
|
WorkloadName?: string;
|
|
@@ -1733,147 +2043,147 @@ export interface Workload {
|
|
|
1733
2043
|
/**
|
|
1734
2044
|
* <p>Flag indicating whether the workload owner has acknowledged that the <i>Review
|
|
1735
2045
|
* owner</i> field is required.</p>
|
|
1736
|
-
*
|
|
2046
|
+
* <p>If a <b>Review owner</b> is not added to the workload within
|
|
1737
2047
|
* 60 days of acknowledgement, access to the workload is restricted until an owner is
|
|
1738
2048
|
* added.</p>
|
|
1739
2049
|
*/
|
|
1740
2050
|
IsReviewOwnerUpdateAcknowledged?: boolean;
|
|
1741
2051
|
/**
|
|
1742
2052
|
* <p>The industry type for the workload.</p>
|
|
1743
|
-
*
|
|
1744
|
-
*
|
|
2053
|
+
* <p>If specified, must be one of the following:</p>
|
|
2054
|
+
* <ul>
|
|
1745
2055
|
* <li>
|
|
1746
|
-
*
|
|
2056
|
+
* <p>
|
|
1747
2057
|
* <code>Agriculture</code>
|
|
1748
2058
|
* </p>
|
|
1749
2059
|
* </li>
|
|
1750
2060
|
* <li>
|
|
1751
|
-
*
|
|
2061
|
+
* <p>
|
|
1752
2062
|
* <code>Automobile</code>
|
|
1753
2063
|
* </p>
|
|
1754
2064
|
* </li>
|
|
1755
2065
|
* <li>
|
|
1756
|
-
*
|
|
2066
|
+
* <p>
|
|
1757
2067
|
* <code>Defense</code>
|
|
1758
2068
|
* </p>
|
|
1759
2069
|
* </li>
|
|
1760
2070
|
* <li>
|
|
1761
|
-
*
|
|
2071
|
+
* <p>
|
|
1762
2072
|
* <code>Design and Engineering</code>
|
|
1763
2073
|
* </p>
|
|
1764
2074
|
* </li>
|
|
1765
2075
|
* <li>
|
|
1766
|
-
*
|
|
2076
|
+
* <p>
|
|
1767
2077
|
* <code>Digital Advertising</code>
|
|
1768
2078
|
* </p>
|
|
1769
2079
|
* </li>
|
|
1770
2080
|
* <li>
|
|
1771
|
-
*
|
|
2081
|
+
* <p>
|
|
1772
2082
|
* <code>Education</code>
|
|
1773
2083
|
* </p>
|
|
1774
2084
|
* </li>
|
|
1775
2085
|
* <li>
|
|
1776
|
-
*
|
|
2086
|
+
* <p>
|
|
1777
2087
|
* <code>Environmental Protection</code>
|
|
1778
2088
|
* </p>
|
|
1779
2089
|
* </li>
|
|
1780
2090
|
* <li>
|
|
1781
|
-
*
|
|
2091
|
+
* <p>
|
|
1782
2092
|
* <code>Financial Services</code>
|
|
1783
2093
|
* </p>
|
|
1784
2094
|
* </li>
|
|
1785
2095
|
* <li>
|
|
1786
|
-
*
|
|
2096
|
+
* <p>
|
|
1787
2097
|
* <code>Gaming</code>
|
|
1788
2098
|
* </p>
|
|
1789
2099
|
* </li>
|
|
1790
2100
|
* <li>
|
|
1791
|
-
*
|
|
2101
|
+
* <p>
|
|
1792
2102
|
* <code>General Public Services</code>
|
|
1793
2103
|
* </p>
|
|
1794
2104
|
* </li>
|
|
1795
2105
|
* <li>
|
|
1796
|
-
*
|
|
2106
|
+
* <p>
|
|
1797
2107
|
* <code>Healthcare</code>
|
|
1798
2108
|
* </p>
|
|
1799
2109
|
* </li>
|
|
1800
2110
|
* <li>
|
|
1801
|
-
*
|
|
2111
|
+
* <p>
|
|
1802
2112
|
* <code>Hospitality</code>
|
|
1803
2113
|
* </p>
|
|
1804
2114
|
* </li>
|
|
1805
2115
|
* <li>
|
|
1806
|
-
*
|
|
2116
|
+
* <p>
|
|
1807
2117
|
* <code>InfoTech</code>
|
|
1808
2118
|
* </p>
|
|
1809
2119
|
* </li>
|
|
1810
2120
|
* <li>
|
|
1811
|
-
*
|
|
2121
|
+
* <p>
|
|
1812
2122
|
* <code>Justice and Public Safety</code>
|
|
1813
2123
|
* </p>
|
|
1814
2124
|
* </li>
|
|
1815
2125
|
* <li>
|
|
1816
|
-
*
|
|
2126
|
+
* <p>
|
|
1817
2127
|
* <code>Life Sciences</code>
|
|
1818
2128
|
* </p>
|
|
1819
2129
|
* </li>
|
|
1820
2130
|
* <li>
|
|
1821
|
-
*
|
|
2131
|
+
* <p>
|
|
1822
2132
|
* <code>Manufacturing</code>
|
|
1823
2133
|
* </p>
|
|
1824
2134
|
* </li>
|
|
1825
2135
|
* <li>
|
|
1826
|
-
*
|
|
2136
|
+
* <p>
|
|
1827
2137
|
* <code>Media & Entertainment</code>
|
|
1828
2138
|
* </p>
|
|
1829
2139
|
* </li>
|
|
1830
2140
|
* <li>
|
|
1831
|
-
*
|
|
2141
|
+
* <p>
|
|
1832
2142
|
* <code>Mining & Resources</code>
|
|
1833
2143
|
* </p>
|
|
1834
2144
|
* </li>
|
|
1835
2145
|
* <li>
|
|
1836
|
-
*
|
|
2146
|
+
* <p>
|
|
1837
2147
|
* <code>Oil & Gas</code>
|
|
1838
2148
|
* </p>
|
|
1839
2149
|
* </li>
|
|
1840
2150
|
* <li>
|
|
1841
|
-
*
|
|
2151
|
+
* <p>
|
|
1842
2152
|
* <code>Power & Utilities</code>
|
|
1843
2153
|
* </p>
|
|
1844
2154
|
* </li>
|
|
1845
2155
|
* <li>
|
|
1846
|
-
*
|
|
2156
|
+
* <p>
|
|
1847
2157
|
* <code>Professional Services</code>
|
|
1848
2158
|
* </p>
|
|
1849
2159
|
* </li>
|
|
1850
2160
|
* <li>
|
|
1851
|
-
*
|
|
2161
|
+
* <p>
|
|
1852
2162
|
* <code>Real Estate & Construction</code>
|
|
1853
2163
|
* </p>
|
|
1854
2164
|
* </li>
|
|
1855
2165
|
* <li>
|
|
1856
|
-
*
|
|
2166
|
+
* <p>
|
|
1857
2167
|
* <code>Retail & Wholesale</code>
|
|
1858
2168
|
* </p>
|
|
1859
2169
|
* </li>
|
|
1860
2170
|
* <li>
|
|
1861
|
-
*
|
|
2171
|
+
* <p>
|
|
1862
2172
|
* <code>Social Protection</code>
|
|
1863
2173
|
* </p>
|
|
1864
2174
|
* </li>
|
|
1865
2175
|
* <li>
|
|
1866
|
-
*
|
|
2176
|
+
* <p>
|
|
1867
2177
|
* <code>Telecommunications</code>
|
|
1868
2178
|
* </p>
|
|
1869
2179
|
* </li>
|
|
1870
2180
|
* <li>
|
|
1871
|
-
*
|
|
2181
|
+
* <p>
|
|
1872
2182
|
* <code>Travel, Transportation & Logistics</code>
|
|
1873
2183
|
* </p>
|
|
1874
2184
|
* </li>
|
|
1875
2185
|
* <li>
|
|
1876
|
-
*
|
|
2186
|
+
* <p>
|
|
1877
2187
|
* <code>Other</code>
|
|
1878
2188
|
* </p>
|
|
1879
2189
|
* </li>
|
|
@@ -1893,7 +2203,7 @@ export interface Workload {
|
|
|
1893
2203
|
*/
|
|
1894
2204
|
ImprovementStatus?: WorkloadImprovementStatus | string;
|
|
1895
2205
|
/**
|
|
1896
|
-
* <p>A map from risk names to the count of how questions have that rating.</p>
|
|
2206
|
+
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
1897
2207
|
*/
|
|
1898
2208
|
RiskCounts?: Record<string, number>;
|
|
1899
2209
|
/**
|
|
@@ -1933,12 +2243,12 @@ export interface Workload {
|
|
|
1933
2243
|
export interface Milestone {
|
|
1934
2244
|
/**
|
|
1935
2245
|
* <p>The milestone number.</p>
|
|
1936
|
-
*
|
|
2246
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1937
2247
|
*/
|
|
1938
2248
|
MilestoneNumber?: number;
|
|
1939
2249
|
/**
|
|
1940
2250
|
* <p>The name of the milestone in a workload.</p>
|
|
1941
|
-
*
|
|
2251
|
+
* <p>Milestone names must be unique within a workload.</p>
|
|
1942
2252
|
*/
|
|
1943
2253
|
MilestoneName?: string;
|
|
1944
2254
|
/**
|
|
@@ -1990,10 +2300,13 @@ export interface GetWorkloadOutput {
|
|
|
1990
2300
|
export interface ImportLensInput {
|
|
1991
2301
|
/**
|
|
1992
2302
|
* <p>The alias of the lens.</p>
|
|
1993
|
-
*
|
|
1994
|
-
*
|
|
1995
|
-
*
|
|
1996
|
-
*
|
|
2303
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2304
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
2305
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
2306
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
2307
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
2308
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
2309
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1997
2310
|
*/
|
|
1998
2311
|
LensAlias?: string;
|
|
1999
2312
|
/**
|
|
@@ -2003,14 +2316,14 @@ export interface ImportLensInput {
|
|
|
2003
2316
|
/**
|
|
2004
2317
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
2005
2318
|
* (executes only once).</p>
|
|
2006
|
-
*
|
|
2007
|
-
* the same client request token and the same parameters after
|
|
2008
|
-
* successfully, the result of the original request is returned
|
|
2009
|
-
*
|
|
2319
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
2320
|
+
* the same client request token and the same parameters after the original request has completed
|
|
2321
|
+
* successfully, the result of the original request is returned.</p>
|
|
2322
|
+
* <important>
|
|
2010
2323
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
2011
2324
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
2012
2325
|
* you must provide this token or the request will fail.</p>
|
|
2013
|
-
*
|
|
2326
|
+
* </important>
|
|
2014
2327
|
*/
|
|
2015
2328
|
ClientRequestToken?: string;
|
|
2016
2329
|
/**
|
|
@@ -2020,18 +2333,23 @@ export interface ImportLensInput {
|
|
|
2020
2333
|
}
|
|
2021
2334
|
/**
|
|
2022
2335
|
* @public
|
|
2336
|
+
* @enum
|
|
2023
2337
|
*/
|
|
2024
|
-
export declare
|
|
2025
|
-
COMPLETE
|
|
2026
|
-
ERROR
|
|
2027
|
-
IN_PROGRESS
|
|
2028
|
-
}
|
|
2338
|
+
export declare const ImportLensStatus: {
|
|
2339
|
+
readonly COMPLETE: "COMPLETE";
|
|
2340
|
+
readonly ERROR: "ERROR";
|
|
2341
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
2342
|
+
};
|
|
2343
|
+
/**
|
|
2344
|
+
* @public
|
|
2345
|
+
*/
|
|
2346
|
+
export type ImportLensStatus = (typeof ImportLensStatus)[keyof typeof ImportLensStatus];
|
|
2029
2347
|
/**
|
|
2030
2348
|
* @public
|
|
2031
2349
|
*/
|
|
2032
2350
|
export interface ImportLensOutput {
|
|
2033
2351
|
/**
|
|
2034
|
-
* <p>The ARN for the lens.</p>
|
|
2352
|
+
* <p>The ARN for the lens that was created or updated.</p>
|
|
2035
2353
|
*/
|
|
2036
2354
|
LensArn?: string;
|
|
2037
2355
|
/**
|
|
@@ -2050,7 +2368,7 @@ export interface ImprovementSummary {
|
|
|
2050
2368
|
QuestionId?: string;
|
|
2051
2369
|
/**
|
|
2052
2370
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
2053
|
-
*
|
|
2371
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
2054
2372
|
*/
|
|
2055
2373
|
PillarId?: string;
|
|
2056
2374
|
/**
|
|
@@ -2062,8 +2380,9 @@ export interface ImprovementSummary {
|
|
|
2062
2380
|
*/
|
|
2063
2381
|
Risk?: Risk | string;
|
|
2064
2382
|
/**
|
|
2065
|
-
* <p>The improvement plan URL for a question.</p>
|
|
2066
|
-
*
|
|
2383
|
+
* <p>The improvement plan URL for a question in an Amazon Web Services official lenses.</p>
|
|
2384
|
+
* <p>This value is only available if the question has been answered.</p>
|
|
2385
|
+
* <p>This value does not apply to custom lenses.</p>
|
|
2067
2386
|
*/
|
|
2068
2387
|
ImprovementPlanUrl?: string;
|
|
2069
2388
|
/**
|
|
@@ -2078,10 +2397,13 @@ export interface ImprovementSummary {
|
|
|
2078
2397
|
export interface LensReviewSummary {
|
|
2079
2398
|
/**
|
|
2080
2399
|
* <p>The alias of the lens.</p>
|
|
2081
|
-
*
|
|
2082
|
-
*
|
|
2083
|
-
*
|
|
2084
|
-
*
|
|
2400
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2401
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
2402
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
2403
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
2404
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
2405
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
2406
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2085
2407
|
*/
|
|
2086
2408
|
LensAlias?: string;
|
|
2087
2409
|
/**
|
|
@@ -2105,23 +2427,28 @@ export interface LensReviewSummary {
|
|
|
2105
2427
|
*/
|
|
2106
2428
|
UpdatedAt?: Date;
|
|
2107
2429
|
/**
|
|
2108
|
-
* <p>A map from risk names to the count of how questions have that rating.</p>
|
|
2430
|
+
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
2109
2431
|
*/
|
|
2110
2432
|
RiskCounts?: Record<string, number>;
|
|
2111
2433
|
}
|
|
2112
2434
|
/**
|
|
2113
2435
|
* @public
|
|
2436
|
+
* @enum
|
|
2114
2437
|
*/
|
|
2115
|
-
export declare
|
|
2116
|
-
ACCEPTED
|
|
2117
|
-
ASSOCIATED
|
|
2118
|
-
ASSOCIATING
|
|
2119
|
-
EXPIRED
|
|
2120
|
-
FAILED
|
|
2121
|
-
PENDING
|
|
2122
|
-
REJECTED
|
|
2123
|
-
REVOKED
|
|
2124
|
-
}
|
|
2438
|
+
export declare const ShareStatus: {
|
|
2439
|
+
readonly ACCEPTED: "ACCEPTED";
|
|
2440
|
+
readonly ASSOCIATED: "ASSOCIATED";
|
|
2441
|
+
readonly ASSOCIATING: "ASSOCIATING";
|
|
2442
|
+
readonly EXPIRED: "EXPIRED";
|
|
2443
|
+
readonly FAILED: "FAILED";
|
|
2444
|
+
readonly PENDING: "PENDING";
|
|
2445
|
+
readonly REJECTED: "REJECTED";
|
|
2446
|
+
readonly REVOKED: "REVOKED";
|
|
2447
|
+
};
|
|
2448
|
+
/**
|
|
2449
|
+
* @public
|
|
2450
|
+
*/
|
|
2451
|
+
export type ShareStatus = (typeof ShareStatus)[keyof typeof ShareStatus];
|
|
2125
2452
|
/**
|
|
2126
2453
|
* @public
|
|
2127
2454
|
* <p>A lens share summary return object.</p>
|
|
@@ -2146,12 +2473,17 @@ export interface LensShareSummary {
|
|
|
2146
2473
|
}
|
|
2147
2474
|
/**
|
|
2148
2475
|
* @public
|
|
2476
|
+
* @enum
|
|
2149
2477
|
*/
|
|
2150
|
-
export declare
|
|
2151
|
-
AWS_OFFICIAL
|
|
2152
|
-
CUSTOM_SELF
|
|
2153
|
-
CUSTOM_SHARED
|
|
2154
|
-
}
|
|
2478
|
+
export declare const LensType: {
|
|
2479
|
+
readonly AWS_OFFICIAL: "AWS_OFFICIAL";
|
|
2480
|
+
readonly CUSTOM_SELF: "CUSTOM_SELF";
|
|
2481
|
+
readonly CUSTOM_SHARED: "CUSTOM_SHARED";
|
|
2482
|
+
};
|
|
2483
|
+
/**
|
|
2484
|
+
* @public
|
|
2485
|
+
*/
|
|
2486
|
+
export type LensType = (typeof LensType)[keyof typeof LensType];
|
|
2155
2487
|
/**
|
|
2156
2488
|
* @public
|
|
2157
2489
|
* <p>A lens summary of a lens.</p>
|
|
@@ -2163,10 +2495,13 @@ export interface LensSummary {
|
|
|
2163
2495
|
LensArn?: string;
|
|
2164
2496
|
/**
|
|
2165
2497
|
* <p>The alias of the lens.</p>
|
|
2166
|
-
*
|
|
2167
|
-
*
|
|
2168
|
-
*
|
|
2169
|
-
*
|
|
2498
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2499
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
2500
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
2501
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
2502
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
2503
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
2504
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2170
2505
|
*/
|
|
2171
2506
|
LensAlias?: string;
|
|
2172
2507
|
/**
|
|
@@ -2213,16 +2548,19 @@ export interface LensUpgradeSummary {
|
|
|
2213
2548
|
WorkloadId?: string;
|
|
2214
2549
|
/**
|
|
2215
2550
|
* <p>The name of the workload.</p>
|
|
2216
|
-
*
|
|
2551
|
+
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
2217
2552
|
* are ignored when checking for uniqueness.</p>
|
|
2218
2553
|
*/
|
|
2219
2554
|
WorkloadName?: string;
|
|
2220
2555
|
/**
|
|
2221
2556
|
* <p>The alias of the lens.</p>
|
|
2222
|
-
*
|
|
2223
|
-
*
|
|
2224
|
-
*
|
|
2225
|
-
*
|
|
2557
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2558
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
2559
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
2560
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
2561
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
2562
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
2563
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2226
2564
|
*/
|
|
2227
2565
|
LensAlias?: string;
|
|
2228
2566
|
/**
|
|
@@ -2249,20 +2587,23 @@ export interface ListAnswersInput {
|
|
|
2249
2587
|
WorkloadId: string | undefined;
|
|
2250
2588
|
/**
|
|
2251
2589
|
* <p>The alias of the lens.</p>
|
|
2252
|
-
*
|
|
2253
|
-
*
|
|
2254
|
-
*
|
|
2255
|
-
*
|
|
2590
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2591
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
2592
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
2593
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
2594
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
2595
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
2596
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2256
2597
|
*/
|
|
2257
2598
|
LensAlias: string | undefined;
|
|
2258
2599
|
/**
|
|
2259
2600
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
2260
|
-
*
|
|
2601
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
2261
2602
|
*/
|
|
2262
2603
|
PillarId?: string;
|
|
2263
2604
|
/**
|
|
2264
2605
|
* <p>The milestone number.</p>
|
|
2265
|
-
*
|
|
2606
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2266
2607
|
*/
|
|
2267
2608
|
MilestoneNumber?: number;
|
|
2268
2609
|
/**
|
|
@@ -2285,15 +2626,18 @@ export interface ListAnswersOutput {
|
|
|
2285
2626
|
WorkloadId?: string;
|
|
2286
2627
|
/**
|
|
2287
2628
|
* <p>The milestone number.</p>
|
|
2288
|
-
*
|
|
2629
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2289
2630
|
*/
|
|
2290
2631
|
MilestoneNumber?: number;
|
|
2291
2632
|
/**
|
|
2292
2633
|
* <p>The alias of the lens.</p>
|
|
2293
|
-
*
|
|
2294
|
-
*
|
|
2295
|
-
*
|
|
2296
|
-
*
|
|
2634
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2635
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
2636
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
2637
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
2638
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
2639
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
2640
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2297
2641
|
*/
|
|
2298
2642
|
LensAlias?: string;
|
|
2299
2643
|
/**
|
|
@@ -2331,7 +2675,7 @@ export interface ListCheckDetailsInput {
|
|
|
2331
2675
|
LensArn: string | undefined;
|
|
2332
2676
|
/**
|
|
2333
2677
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
2334
|
-
*
|
|
2678
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
2335
2679
|
*/
|
|
2336
2680
|
PillarId: string | undefined;
|
|
2337
2681
|
/**
|
|
@@ -2378,7 +2722,7 @@ export interface ListCheckSummariesInput {
|
|
|
2378
2722
|
LensArn: string | undefined;
|
|
2379
2723
|
/**
|
|
2380
2724
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
2381
|
-
*
|
|
2725
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
2382
2726
|
*/
|
|
2383
2727
|
PillarId: string | undefined;
|
|
2384
2728
|
/**
|
|
@@ -2454,20 +2798,23 @@ export interface ListLensReviewImprovementsInput {
|
|
|
2454
2798
|
WorkloadId: string | undefined;
|
|
2455
2799
|
/**
|
|
2456
2800
|
* <p>The alias of the lens.</p>
|
|
2457
|
-
*
|
|
2458
|
-
*
|
|
2459
|
-
*
|
|
2460
|
-
*
|
|
2801
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2802
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
2803
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
2804
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
2805
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
2806
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
2807
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2461
2808
|
*/
|
|
2462
2809
|
LensAlias: string | undefined;
|
|
2463
2810
|
/**
|
|
2464
2811
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
2465
|
-
*
|
|
2812
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
2466
2813
|
*/
|
|
2467
2814
|
PillarId?: string;
|
|
2468
2815
|
/**
|
|
2469
2816
|
* <p>The milestone number.</p>
|
|
2470
|
-
*
|
|
2817
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2471
2818
|
*/
|
|
2472
2819
|
MilestoneNumber?: number;
|
|
2473
2820
|
/**
|
|
@@ -2490,15 +2837,18 @@ export interface ListLensReviewImprovementsOutput {
|
|
|
2490
2837
|
WorkloadId?: string;
|
|
2491
2838
|
/**
|
|
2492
2839
|
* <p>The milestone number.</p>
|
|
2493
|
-
*
|
|
2840
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2494
2841
|
*/
|
|
2495
2842
|
MilestoneNumber?: number;
|
|
2496
2843
|
/**
|
|
2497
2844
|
* <p>The alias of the lens.</p>
|
|
2498
|
-
*
|
|
2499
|
-
*
|
|
2500
|
-
*
|
|
2501
|
-
*
|
|
2845
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2846
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
2847
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
2848
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
2849
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
2850
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
2851
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2502
2852
|
*/
|
|
2503
2853
|
LensAlias?: string;
|
|
2504
2854
|
/**
|
|
@@ -2525,7 +2875,7 @@ export interface ListLensReviewsInput {
|
|
|
2525
2875
|
WorkloadId: string | undefined;
|
|
2526
2876
|
/**
|
|
2527
2877
|
* <p>The milestone number.</p>
|
|
2528
|
-
*
|
|
2878
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2529
2879
|
*/
|
|
2530
2880
|
MilestoneNumber?: number;
|
|
2531
2881
|
/**
|
|
@@ -2548,7 +2898,7 @@ export interface ListLensReviewsOutput {
|
|
|
2548
2898
|
WorkloadId?: string;
|
|
2549
2899
|
/**
|
|
2550
2900
|
* <p>The milestone number.</p>
|
|
2551
|
-
*
|
|
2901
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2552
2902
|
*/
|
|
2553
2903
|
MilestoneNumber?: number;
|
|
2554
2904
|
/**
|
|
@@ -2566,10 +2916,13 @@ export interface ListLensReviewsOutput {
|
|
|
2566
2916
|
export interface ListLensSharesInput {
|
|
2567
2917
|
/**
|
|
2568
2918
|
* <p>The alias of the lens.</p>
|
|
2569
|
-
*
|
|
2570
|
-
*
|
|
2571
|
-
*
|
|
2572
|
-
*
|
|
2919
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2920
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
2921
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
2922
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
2923
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
2924
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
2925
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2573
2926
|
*/
|
|
2574
2927
|
LensAlias: string | undefined;
|
|
2575
2928
|
/**
|
|
@@ -2635,7 +2988,7 @@ export interface WorkloadSummary {
|
|
|
2635
2988
|
WorkloadArn?: string;
|
|
2636
2989
|
/**
|
|
2637
2990
|
* <p>The name of the workload.</p>
|
|
2638
|
-
*
|
|
2991
|
+
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
2639
2992
|
* are ignored when checking for uniqueness.</p>
|
|
2640
2993
|
*/
|
|
2641
2994
|
WorkloadName?: string;
|
|
@@ -2652,7 +3005,7 @@ export interface WorkloadSummary {
|
|
|
2652
3005
|
*/
|
|
2653
3006
|
Lenses?: string[];
|
|
2654
3007
|
/**
|
|
2655
|
-
* <p>A map from risk names to the count of how questions have that rating.</p>
|
|
3008
|
+
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
2656
3009
|
*/
|
|
2657
3010
|
RiskCounts?: Record<string, number>;
|
|
2658
3011
|
/**
|
|
@@ -2667,12 +3020,12 @@ export interface WorkloadSummary {
|
|
|
2667
3020
|
export interface MilestoneSummary {
|
|
2668
3021
|
/**
|
|
2669
3022
|
* <p>The milestone number.</p>
|
|
2670
|
-
*
|
|
3023
|
+
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2671
3024
|
*/
|
|
2672
3025
|
MilestoneNumber?: number;
|
|
2673
3026
|
/**
|
|
2674
3027
|
* <p>The name of the milestone in a workload.</p>
|
|
2675
|
-
*
|
|
3028
|
+
* <p>Milestone names must be unique within a workload.</p>
|
|
2676
3029
|
*/
|
|
2677
3030
|
MilestoneName?: string;
|
|
2678
3031
|
/**
|
|
@@ -2721,11 +3074,16 @@ export interface ListNotificationsInput {
|
|
|
2721
3074
|
}
|
|
2722
3075
|
/**
|
|
2723
3076
|
* @public
|
|
3077
|
+
* @enum
|
|
2724
3078
|
*/
|
|
2725
|
-
export declare
|
|
2726
|
-
LENS_VERSION_DEPRECATED
|
|
2727
|
-
LENS_VERSION_UPGRADED
|
|
2728
|
-
}
|
|
3079
|
+
export declare const NotificationType: {
|
|
3080
|
+
readonly LENS_VERSION_DEPRECATED: "LENS_VERSION_DEPRECATED";
|
|
3081
|
+
readonly LENS_VERSION_UPGRADED: "LENS_VERSION_UPGRADED";
|
|
3082
|
+
};
|
|
3083
|
+
/**
|
|
3084
|
+
* @public
|
|
3085
|
+
*/
|
|
3086
|
+
export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType];
|
|
2729
3087
|
/**
|
|
2730
3088
|
* @public
|
|
2731
3089
|
* <p>A notification summary return object.</p>
|
|
@@ -2755,11 +3113,16 @@ export interface ListNotificationsOutput {
|
|
|
2755
3113
|
}
|
|
2756
3114
|
/**
|
|
2757
3115
|
* @public
|
|
3116
|
+
* @enum
|
|
2758
3117
|
*/
|
|
2759
|
-
export declare
|
|
2760
|
-
LENS
|
|
2761
|
-
WORKLOAD
|
|
2762
|
-
}
|
|
3118
|
+
export declare const ShareResourceType: {
|
|
3119
|
+
readonly LENS: "LENS";
|
|
3120
|
+
readonly WORKLOAD: "WORKLOAD";
|
|
3121
|
+
};
|
|
3122
|
+
/**
|
|
3123
|
+
* @public
|
|
3124
|
+
*/
|
|
3125
|
+
export type ShareResourceType = (typeof ShareResourceType)[keyof typeof ShareResourceType];
|
|
2763
3126
|
/**
|
|
2764
3127
|
* @public
|
|
2765
3128
|
* <p>Input for List Share Invitations</p>
|
|
@@ -2814,7 +3177,7 @@ export interface ShareInvitationSummary {
|
|
|
2814
3177
|
ShareResourceType?: ShareResourceType | string;
|
|
2815
3178
|
/**
|
|
2816
3179
|
* <p>The name of the workload.</p>
|
|
2817
|
-
*
|
|
3180
|
+
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
2818
3181
|
* are ignored when checking for uniqueness.</p>
|
|
2819
3182
|
*/
|
|
2820
3183
|
WorkloadName?: string;
|
|
@@ -2968,11 +3331,16 @@ export interface ListWorkloadSharesOutput {
|
|
|
2968
3331
|
}
|
|
2969
3332
|
/**
|
|
2970
3333
|
* @public
|
|
3334
|
+
* @enum
|
|
2971
3335
|
*/
|
|
2972
|
-
export declare
|
|
2973
|
-
DISABLED
|
|
2974
|
-
ENABLED
|
|
2975
|
-
}
|
|
3336
|
+
export declare const OrganizationSharingStatus: {
|
|
3337
|
+
readonly DISABLED: "DISABLED";
|
|
3338
|
+
readonly ENABLED: "ENABLED";
|
|
3339
|
+
};
|
|
3340
|
+
/**
|
|
3341
|
+
* @public
|
|
3342
|
+
*/
|
|
3343
|
+
export type OrganizationSharingStatus = (typeof OrganizationSharingStatus)[keyof typeof OrganizationSharingStatus];
|
|
2976
3344
|
/**
|
|
2977
3345
|
* @public
|
|
2978
3346
|
* <p>The share invitation.</p>
|
|
@@ -2992,10 +3360,13 @@ export interface ShareInvitation {
|
|
|
2992
3360
|
WorkloadId?: string;
|
|
2993
3361
|
/**
|
|
2994
3362
|
* <p>The alias of the lens.</p>
|
|
2995
|
-
*
|
|
2996
|
-
*
|
|
2997
|
-
*
|
|
2998
|
-
*
|
|
3363
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3364
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
3365
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3366
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3367
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
3368
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3369
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2999
3370
|
*/
|
|
3000
3371
|
LensAlias?: string;
|
|
3001
3372
|
/**
|
|
@@ -3005,11 +3376,16 @@ export interface ShareInvitation {
|
|
|
3005
3376
|
}
|
|
3006
3377
|
/**
|
|
3007
3378
|
* @public
|
|
3379
|
+
* @enum
|
|
3008
3380
|
*/
|
|
3009
|
-
export declare
|
|
3010
|
-
ACCEPT
|
|
3011
|
-
REJECT
|
|
3012
|
-
}
|
|
3381
|
+
export declare const ShareInvitationAction: {
|
|
3382
|
+
readonly ACCEPT: "ACCEPT";
|
|
3383
|
+
readonly REJECT: "REJECT";
|
|
3384
|
+
};
|
|
3385
|
+
/**
|
|
3386
|
+
* @public
|
|
3387
|
+
*/
|
|
3388
|
+
export type ShareInvitationAction = (typeof ShareInvitationAction)[keyof typeof ShareInvitationAction];
|
|
3013
3389
|
/**
|
|
3014
3390
|
* @public
|
|
3015
3391
|
*/
|
|
@@ -3058,10 +3434,13 @@ export interface UpdateAnswerInput {
|
|
|
3058
3434
|
WorkloadId: string | undefined;
|
|
3059
3435
|
/**
|
|
3060
3436
|
* <p>The alias of the lens.</p>
|
|
3061
|
-
*
|
|
3062
|
-
*
|
|
3063
|
-
*
|
|
3064
|
-
*
|
|
3437
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3438
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
3439
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3440
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3441
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
3442
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3443
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3065
3444
|
*/
|
|
3066
3445
|
LensAlias: string | undefined;
|
|
3067
3446
|
/**
|
|
@@ -3070,7 +3449,7 @@ export interface UpdateAnswerInput {
|
|
|
3070
3449
|
QuestionId: string | undefined;
|
|
3071
3450
|
/**
|
|
3072
3451
|
* <p>List of selected choice IDs in a question answer.</p>
|
|
3073
|
-
*
|
|
3452
|
+
* <p>The values entered replace the previously selected choices.</p>
|
|
3074
3453
|
*/
|
|
3075
3454
|
SelectedChoices?: string[];
|
|
3076
3455
|
/**
|
|
@@ -3102,10 +3481,13 @@ export interface UpdateAnswerOutput {
|
|
|
3102
3481
|
WorkloadId?: string;
|
|
3103
3482
|
/**
|
|
3104
3483
|
* <p>The alias of the lens.</p>
|
|
3105
|
-
*
|
|
3106
|
-
*
|
|
3107
|
-
*
|
|
3108
|
-
*
|
|
3484
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3485
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
3486
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3487
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3488
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
3489
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3490
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3109
3491
|
*/
|
|
3110
3492
|
LensAlias?: string;
|
|
3111
3493
|
/**
|
|
@@ -3137,10 +3519,13 @@ export interface UpdateLensReviewInput {
|
|
|
3137
3519
|
WorkloadId: string | undefined;
|
|
3138
3520
|
/**
|
|
3139
3521
|
* <p>The alias of the lens.</p>
|
|
3140
|
-
*
|
|
3141
|
-
*
|
|
3142
|
-
*
|
|
3143
|
-
*
|
|
3522
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3523
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
3524
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3525
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3526
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
3527
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3528
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3144
3529
|
*/
|
|
3145
3530
|
LensAlias: string | undefined;
|
|
3146
3531
|
/**
|
|
@@ -3200,7 +3585,7 @@ export interface UpdateWorkloadInput {
|
|
|
3200
3585
|
WorkloadId: string | undefined;
|
|
3201
3586
|
/**
|
|
3202
3587
|
* <p>The name of the workload.</p>
|
|
3203
|
-
*
|
|
3588
|
+
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
3204
3589
|
* are ignored when checking for uniqueness.</p>
|
|
3205
3590
|
*/
|
|
3206
3591
|
WorkloadName?: string;
|
|
@@ -3242,147 +3627,147 @@ export interface UpdateWorkloadInput {
|
|
|
3242
3627
|
/**
|
|
3243
3628
|
* <p>Flag indicating whether the workload owner has acknowledged that the <i>Review
|
|
3244
3629
|
* owner</i> field is required.</p>
|
|
3245
|
-
*
|
|
3630
|
+
* <p>If a <b>Review owner</b> is not added to the workload within
|
|
3246
3631
|
* 60 days of acknowledgement, access to the workload is restricted until an owner is
|
|
3247
3632
|
* added.</p>
|
|
3248
3633
|
*/
|
|
3249
3634
|
IsReviewOwnerUpdateAcknowledged?: boolean;
|
|
3250
3635
|
/**
|
|
3251
3636
|
* <p>The industry type for the workload.</p>
|
|
3252
|
-
*
|
|
3253
|
-
*
|
|
3637
|
+
* <p>If specified, must be one of the following:</p>
|
|
3638
|
+
* <ul>
|
|
3254
3639
|
* <li>
|
|
3255
|
-
*
|
|
3640
|
+
* <p>
|
|
3256
3641
|
* <code>Agriculture</code>
|
|
3257
3642
|
* </p>
|
|
3258
3643
|
* </li>
|
|
3259
3644
|
* <li>
|
|
3260
|
-
*
|
|
3645
|
+
* <p>
|
|
3261
3646
|
* <code>Automobile</code>
|
|
3262
3647
|
* </p>
|
|
3263
3648
|
* </li>
|
|
3264
3649
|
* <li>
|
|
3265
|
-
*
|
|
3650
|
+
* <p>
|
|
3266
3651
|
* <code>Defense</code>
|
|
3267
3652
|
* </p>
|
|
3268
3653
|
* </li>
|
|
3269
3654
|
* <li>
|
|
3270
|
-
*
|
|
3655
|
+
* <p>
|
|
3271
3656
|
* <code>Design and Engineering</code>
|
|
3272
3657
|
* </p>
|
|
3273
3658
|
* </li>
|
|
3274
3659
|
* <li>
|
|
3275
|
-
*
|
|
3660
|
+
* <p>
|
|
3276
3661
|
* <code>Digital Advertising</code>
|
|
3277
3662
|
* </p>
|
|
3278
3663
|
* </li>
|
|
3279
3664
|
* <li>
|
|
3280
|
-
*
|
|
3665
|
+
* <p>
|
|
3281
3666
|
* <code>Education</code>
|
|
3282
3667
|
* </p>
|
|
3283
3668
|
* </li>
|
|
3284
3669
|
* <li>
|
|
3285
|
-
*
|
|
3670
|
+
* <p>
|
|
3286
3671
|
* <code>Environmental Protection</code>
|
|
3287
3672
|
* </p>
|
|
3288
3673
|
* </li>
|
|
3289
3674
|
* <li>
|
|
3290
|
-
*
|
|
3675
|
+
* <p>
|
|
3291
3676
|
* <code>Financial Services</code>
|
|
3292
3677
|
* </p>
|
|
3293
3678
|
* </li>
|
|
3294
3679
|
* <li>
|
|
3295
|
-
*
|
|
3680
|
+
* <p>
|
|
3296
3681
|
* <code>Gaming</code>
|
|
3297
3682
|
* </p>
|
|
3298
3683
|
* </li>
|
|
3299
3684
|
* <li>
|
|
3300
|
-
*
|
|
3685
|
+
* <p>
|
|
3301
3686
|
* <code>General Public Services</code>
|
|
3302
3687
|
* </p>
|
|
3303
3688
|
* </li>
|
|
3304
3689
|
* <li>
|
|
3305
|
-
*
|
|
3690
|
+
* <p>
|
|
3306
3691
|
* <code>Healthcare</code>
|
|
3307
3692
|
* </p>
|
|
3308
3693
|
* </li>
|
|
3309
3694
|
* <li>
|
|
3310
|
-
*
|
|
3695
|
+
* <p>
|
|
3311
3696
|
* <code>Hospitality</code>
|
|
3312
3697
|
* </p>
|
|
3313
3698
|
* </li>
|
|
3314
3699
|
* <li>
|
|
3315
|
-
*
|
|
3700
|
+
* <p>
|
|
3316
3701
|
* <code>InfoTech</code>
|
|
3317
3702
|
* </p>
|
|
3318
3703
|
* </li>
|
|
3319
3704
|
* <li>
|
|
3320
|
-
*
|
|
3705
|
+
* <p>
|
|
3321
3706
|
* <code>Justice and Public Safety</code>
|
|
3322
3707
|
* </p>
|
|
3323
3708
|
* </li>
|
|
3324
3709
|
* <li>
|
|
3325
|
-
*
|
|
3710
|
+
* <p>
|
|
3326
3711
|
* <code>Life Sciences</code>
|
|
3327
3712
|
* </p>
|
|
3328
3713
|
* </li>
|
|
3329
3714
|
* <li>
|
|
3330
|
-
*
|
|
3715
|
+
* <p>
|
|
3331
3716
|
* <code>Manufacturing</code>
|
|
3332
3717
|
* </p>
|
|
3333
3718
|
* </li>
|
|
3334
3719
|
* <li>
|
|
3335
|
-
*
|
|
3720
|
+
* <p>
|
|
3336
3721
|
* <code>Media & Entertainment</code>
|
|
3337
3722
|
* </p>
|
|
3338
3723
|
* </li>
|
|
3339
3724
|
* <li>
|
|
3340
|
-
*
|
|
3725
|
+
* <p>
|
|
3341
3726
|
* <code>Mining & Resources</code>
|
|
3342
3727
|
* </p>
|
|
3343
3728
|
* </li>
|
|
3344
3729
|
* <li>
|
|
3345
|
-
*
|
|
3730
|
+
* <p>
|
|
3346
3731
|
* <code>Oil & Gas</code>
|
|
3347
3732
|
* </p>
|
|
3348
3733
|
* </li>
|
|
3349
3734
|
* <li>
|
|
3350
|
-
*
|
|
3735
|
+
* <p>
|
|
3351
3736
|
* <code>Power & Utilities</code>
|
|
3352
3737
|
* </p>
|
|
3353
3738
|
* </li>
|
|
3354
3739
|
* <li>
|
|
3355
|
-
*
|
|
3740
|
+
* <p>
|
|
3356
3741
|
* <code>Professional Services</code>
|
|
3357
3742
|
* </p>
|
|
3358
3743
|
* </li>
|
|
3359
3744
|
* <li>
|
|
3360
|
-
*
|
|
3745
|
+
* <p>
|
|
3361
3746
|
* <code>Real Estate & Construction</code>
|
|
3362
3747
|
* </p>
|
|
3363
3748
|
* </li>
|
|
3364
3749
|
* <li>
|
|
3365
|
-
*
|
|
3750
|
+
* <p>
|
|
3366
3751
|
* <code>Retail & Wholesale</code>
|
|
3367
3752
|
* </p>
|
|
3368
3753
|
* </li>
|
|
3369
3754
|
* <li>
|
|
3370
|
-
*
|
|
3755
|
+
* <p>
|
|
3371
3756
|
* <code>Social Protection</code>
|
|
3372
3757
|
* </p>
|
|
3373
3758
|
* </li>
|
|
3374
3759
|
* <li>
|
|
3375
|
-
*
|
|
3760
|
+
* <p>
|
|
3376
3761
|
* <code>Telecommunications</code>
|
|
3377
3762
|
* </p>
|
|
3378
3763
|
* </li>
|
|
3379
3764
|
* <li>
|
|
3380
|
-
*
|
|
3765
|
+
* <p>
|
|
3381
3766
|
* <code>Travel, Transportation & Logistics</code>
|
|
3382
3767
|
* </p>
|
|
3383
3768
|
* </li>
|
|
3384
3769
|
* <li>
|
|
3385
|
-
*
|
|
3770
|
+
* <p>
|
|
3386
3771
|
* <code>Other</code>
|
|
3387
3772
|
* </p>
|
|
3388
3773
|
* </li>
|
|
@@ -3465,7 +3850,7 @@ export interface WorkloadShare {
|
|
|
3465
3850
|
Status?: ShareStatus | string;
|
|
3466
3851
|
/**
|
|
3467
3852
|
* <p>The name of the workload.</p>
|
|
3468
|
-
*
|
|
3853
|
+
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
3469
3854
|
* are ignored when checking for uniqueness.</p>
|
|
3470
3855
|
*/
|
|
3471
3856
|
WorkloadName?: string;
|
|
@@ -3498,28 +3883,31 @@ export interface UpgradeLensReviewInput {
|
|
|
3498
3883
|
WorkloadId: string | undefined;
|
|
3499
3884
|
/**
|
|
3500
3885
|
* <p>The alias of the lens.</p>
|
|
3501
|
-
*
|
|
3502
|
-
*
|
|
3503
|
-
*
|
|
3504
|
-
*
|
|
3886
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3887
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
3888
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3889
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3890
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
3891
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3892
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3505
3893
|
*/
|
|
3506
3894
|
LensAlias: string | undefined;
|
|
3507
3895
|
/**
|
|
3508
3896
|
* <p>The name of the milestone in a workload.</p>
|
|
3509
|
-
*
|
|
3897
|
+
* <p>Milestone names must be unique within a workload.</p>
|
|
3510
3898
|
*/
|
|
3511
3899
|
MilestoneName: string | undefined;
|
|
3512
3900
|
/**
|
|
3513
3901
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
3514
3902
|
* (executes only once).</p>
|
|
3515
|
-
*
|
|
3516
|
-
* the same client request token and the same parameters after
|
|
3517
|
-
* successfully, the result of the original request is returned
|
|
3518
|
-
*
|
|
3903
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
3904
|
+
* the same client request token and the same parameters after the original request has completed
|
|
3905
|
+
* successfully, the result of the original request is returned.</p>
|
|
3906
|
+
* <important>
|
|
3519
3907
|
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
3520
3908
|
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
3521
3909
|
* you must provide this token or the request will fail.</p>
|
|
3522
|
-
*
|
|
3910
|
+
* </important>
|
|
3523
3911
|
*/
|
|
3524
3912
|
ClientRequestToken?: string;
|
|
3525
3913
|
}
|