@aws-sdk/client-wellarchitected 3.379.1 → 3.382.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/dist-types/models/models_0.d.ts +630 -0
- package/package.json +5 -5
|
@@ -8,6 +8,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
9
9
|
readonly $fault: "client";
|
|
10
10
|
/**
|
|
11
|
+
* @public
|
|
11
12
|
* <p>Description of the error.</p>
|
|
12
13
|
*/
|
|
13
14
|
Message: string | undefined;
|
|
@@ -37,10 +38,12 @@ export type CheckStatus = (typeof CheckStatus)[keyof typeof CheckStatus];
|
|
|
37
38
|
*/
|
|
38
39
|
export interface ChoiceContent {
|
|
39
40
|
/**
|
|
41
|
+
* @public
|
|
40
42
|
* <p>The display text for the choice content.</p>
|
|
41
43
|
*/
|
|
42
44
|
DisplayText?: string;
|
|
43
45
|
/**
|
|
46
|
+
* @public
|
|
44
47
|
* <p>The URL for the choice content.</p>
|
|
45
48
|
*/
|
|
46
49
|
Url?: string;
|
|
@@ -64,10 +67,12 @@ export type AdditionalResourceType = (typeof AdditionalResourceType)[keyof typeo
|
|
|
64
67
|
*/
|
|
65
68
|
export interface AdditionalResources {
|
|
66
69
|
/**
|
|
70
|
+
* @public
|
|
67
71
|
* <p>Type of additional resource for a custom lens.</p>
|
|
68
72
|
*/
|
|
69
73
|
Type?: AdditionalResourceType | string;
|
|
70
74
|
/**
|
|
75
|
+
* @public
|
|
71
76
|
* <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>
|
|
72
77
|
*/
|
|
73
78
|
Content?: ChoiceContent[];
|
|
@@ -106,18 +111,22 @@ export type ChoiceStatus = (typeof ChoiceStatus)[keyof typeof ChoiceStatus];
|
|
|
106
111
|
*/
|
|
107
112
|
export interface ChoiceAnswer {
|
|
108
113
|
/**
|
|
114
|
+
* @public
|
|
109
115
|
* <p>The ID of a choice.</p>
|
|
110
116
|
*/
|
|
111
117
|
ChoiceId?: string;
|
|
112
118
|
/**
|
|
119
|
+
* @public
|
|
113
120
|
* <p>The status of a choice.</p>
|
|
114
121
|
*/
|
|
115
122
|
Status?: ChoiceStatus | string;
|
|
116
123
|
/**
|
|
124
|
+
* @public
|
|
117
125
|
* <p>The reason why a choice is non-applicable to a question in your workload.</p>
|
|
118
126
|
*/
|
|
119
127
|
Reason?: ChoiceReason | string;
|
|
120
128
|
/**
|
|
129
|
+
* @public
|
|
121
130
|
* <p>The notes associated with a choice.</p>
|
|
122
131
|
*/
|
|
123
132
|
Notes?: string;
|
|
@@ -128,28 +137,34 @@ export interface ChoiceAnswer {
|
|
|
128
137
|
*/
|
|
129
138
|
export interface Choice {
|
|
130
139
|
/**
|
|
140
|
+
* @public
|
|
131
141
|
* <p>The ID of a choice.</p>
|
|
132
142
|
*/
|
|
133
143
|
ChoiceId?: string;
|
|
134
144
|
/**
|
|
145
|
+
* @public
|
|
135
146
|
* <p>The title of a choice.</p>
|
|
136
147
|
*/
|
|
137
148
|
Title?: string;
|
|
138
149
|
/**
|
|
150
|
+
* @public
|
|
139
151
|
* <p>The description of a choice.</p>
|
|
140
152
|
*/
|
|
141
153
|
Description?: string;
|
|
142
154
|
/**
|
|
155
|
+
* @public
|
|
143
156
|
* <p>The helpful resource (both text and URL) for a particular choice.</p>
|
|
144
157
|
* <p>This field only applies to custom lenses. Each choice can have only one helpful resource.</p>
|
|
145
158
|
*/
|
|
146
159
|
HelpfulResource?: ChoiceContent;
|
|
147
160
|
/**
|
|
161
|
+
* @public
|
|
148
162
|
* <p>The improvement plan (both text and URL) for a particular choice.</p>
|
|
149
163
|
* <p>This field only applies to custom lenses. Each choice can have only one improvement plan.</p>
|
|
150
164
|
*/
|
|
151
165
|
ImprovementPlan?: ChoiceContent;
|
|
152
166
|
/**
|
|
167
|
+
* @public
|
|
153
168
|
* <p>The additional resources for a choice in a custom lens.</p>
|
|
154
169
|
* <p>A choice can have up to two additional resources: one of type <code>HELPFUL_RESOURCE</code>,
|
|
155
170
|
* one of type <code>IMPROVEMENT_PLAN</code>, or both.</p>
|
|
@@ -192,29 +207,35 @@ export type Risk = (typeof Risk)[keyof typeof Risk];
|
|
|
192
207
|
*/
|
|
193
208
|
export interface Answer {
|
|
194
209
|
/**
|
|
210
|
+
* @public
|
|
195
211
|
* <p>The ID of the question.</p>
|
|
196
212
|
*/
|
|
197
213
|
QuestionId?: string;
|
|
198
214
|
/**
|
|
215
|
+
* @public
|
|
199
216
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
200
217
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
201
218
|
*/
|
|
202
219
|
PillarId?: string;
|
|
203
220
|
/**
|
|
221
|
+
* @public
|
|
204
222
|
* <p>The title of the question.</p>
|
|
205
223
|
*/
|
|
206
224
|
QuestionTitle?: string;
|
|
207
225
|
/**
|
|
226
|
+
* @public
|
|
208
227
|
* <p>The description of the question.</p>
|
|
209
228
|
*/
|
|
210
229
|
QuestionDescription?: string;
|
|
211
230
|
/**
|
|
231
|
+
* @public
|
|
212
232
|
* <p>The improvement plan URL for a question in an Amazon Web Services official lenses.</p>
|
|
213
233
|
* <p>This value is only available if the question has been answered.</p>
|
|
214
234
|
* <p>This value does not apply to custom lenses.</p>
|
|
215
235
|
*/
|
|
216
236
|
ImprovementPlanUrl?: string;
|
|
217
237
|
/**
|
|
238
|
+
* @public
|
|
218
239
|
* <p>The helpful resource URL.</p>
|
|
219
240
|
* <p>For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.</p>
|
|
220
241
|
* <p>For custom lenses, this is the helpful resource URL for a question and is only provided
|
|
@@ -222,36 +243,44 @@ export interface Answer {
|
|
|
222
243
|
*/
|
|
223
244
|
HelpfulResourceUrl?: string;
|
|
224
245
|
/**
|
|
246
|
+
* @public
|
|
225
247
|
* <p>The helpful resource text to be displayed for a custom lens.</p>
|
|
226
248
|
* <p>This field does not apply to Amazon Web Services official lenses.</p>
|
|
227
249
|
*/
|
|
228
250
|
HelpfulResourceDisplayText?: string;
|
|
229
251
|
/**
|
|
252
|
+
* @public
|
|
230
253
|
* <p>List of choices available for a question.</p>
|
|
231
254
|
*/
|
|
232
255
|
Choices?: Choice[];
|
|
233
256
|
/**
|
|
257
|
+
* @public
|
|
234
258
|
* <p>List of selected choice IDs in a question answer.</p>
|
|
235
259
|
* <p>The values entered replace the previously selected choices.</p>
|
|
236
260
|
*/
|
|
237
261
|
SelectedChoices?: string[];
|
|
238
262
|
/**
|
|
263
|
+
* @public
|
|
239
264
|
* <p>A list of selected choices to a question in your workload.</p>
|
|
240
265
|
*/
|
|
241
266
|
ChoiceAnswers?: ChoiceAnswer[];
|
|
242
267
|
/**
|
|
268
|
+
* @public
|
|
243
269
|
* <p>Defines whether this question is applicable to a lens review.</p>
|
|
244
270
|
*/
|
|
245
271
|
IsApplicable?: boolean;
|
|
246
272
|
/**
|
|
273
|
+
* @public
|
|
247
274
|
* <p>The risk for a given workload, lens review, pillar, or question.</p>
|
|
248
275
|
*/
|
|
249
276
|
Risk?: Risk | string;
|
|
250
277
|
/**
|
|
278
|
+
* @public
|
|
251
279
|
* <p>The notes associated with the workload.</p>
|
|
252
280
|
*/
|
|
253
281
|
Notes?: string;
|
|
254
282
|
/**
|
|
283
|
+
* @public
|
|
255
284
|
* <p>The reason why the question is not applicable to your workload.</p>
|
|
256
285
|
*/
|
|
257
286
|
Reason?: AnswerReason | string;
|
|
@@ -262,14 +291,17 @@ export interface Answer {
|
|
|
262
291
|
*/
|
|
263
292
|
export interface ChoiceAnswerSummary {
|
|
264
293
|
/**
|
|
294
|
+
* @public
|
|
265
295
|
* <p>The ID of a choice.</p>
|
|
266
296
|
*/
|
|
267
297
|
ChoiceId?: string;
|
|
268
298
|
/**
|
|
299
|
+
* @public
|
|
269
300
|
* <p>The status of a choice.</p>
|
|
270
301
|
*/
|
|
271
302
|
Status?: ChoiceStatus | string;
|
|
272
303
|
/**
|
|
304
|
+
* @public
|
|
273
305
|
* <p>The reason why a choice is non-applicable to a question in your workload.</p>
|
|
274
306
|
*/
|
|
275
307
|
Reason?: ChoiceReason | string;
|
|
@@ -292,44 +324,54 @@ export type QuestionType = (typeof QuestionType)[keyof typeof QuestionType];
|
|
|
292
324
|
*/
|
|
293
325
|
export interface AnswerSummary {
|
|
294
326
|
/**
|
|
327
|
+
* @public
|
|
295
328
|
* <p>The ID of the question.</p>
|
|
296
329
|
*/
|
|
297
330
|
QuestionId?: string;
|
|
298
331
|
/**
|
|
332
|
+
* @public
|
|
299
333
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
300
334
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
301
335
|
*/
|
|
302
336
|
PillarId?: string;
|
|
303
337
|
/**
|
|
338
|
+
* @public
|
|
304
339
|
* <p>The title of the question.</p>
|
|
305
340
|
*/
|
|
306
341
|
QuestionTitle?: string;
|
|
307
342
|
/**
|
|
343
|
+
* @public
|
|
308
344
|
* <p>List of choices available for a question.</p>
|
|
309
345
|
*/
|
|
310
346
|
Choices?: Choice[];
|
|
311
347
|
/**
|
|
348
|
+
* @public
|
|
312
349
|
* <p>List of selected choice IDs in a question answer.</p>
|
|
313
350
|
* <p>The values entered replace the previously selected choices.</p>
|
|
314
351
|
*/
|
|
315
352
|
SelectedChoices?: string[];
|
|
316
353
|
/**
|
|
354
|
+
* @public
|
|
317
355
|
* <p>A list of selected choices to a question in your workload.</p>
|
|
318
356
|
*/
|
|
319
357
|
ChoiceAnswerSummaries?: ChoiceAnswerSummary[];
|
|
320
358
|
/**
|
|
359
|
+
* @public
|
|
321
360
|
* <p>Defines whether this question is applicable to a lens review.</p>
|
|
322
361
|
*/
|
|
323
362
|
IsApplicable?: boolean;
|
|
324
363
|
/**
|
|
364
|
+
* @public
|
|
325
365
|
* <p>The risk for a given workload, lens review, pillar, or question.</p>
|
|
326
366
|
*/
|
|
327
367
|
Risk?: Risk | string;
|
|
328
368
|
/**
|
|
369
|
+
* @public
|
|
329
370
|
* <p>The reason why a choice is non-applicable to a question in your workload.</p>
|
|
330
371
|
*/
|
|
331
372
|
Reason?: AnswerReason | string;
|
|
332
373
|
/**
|
|
374
|
+
* @public
|
|
333
375
|
* <p>The type of the question.</p>
|
|
334
376
|
*/
|
|
335
377
|
QuestionType?: QuestionType | string;
|
|
@@ -340,10 +382,12 @@ export interface AnswerSummary {
|
|
|
340
382
|
*/
|
|
341
383
|
export interface AssociateLensesInput {
|
|
342
384
|
/**
|
|
385
|
+
* @public
|
|
343
386
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
344
387
|
*/
|
|
345
388
|
WorkloadId: string | undefined;
|
|
346
389
|
/**
|
|
390
|
+
* @public
|
|
347
391
|
* <p>List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.</p>
|
|
348
392
|
* <p>Identify a lens using its <a>LensSummary$LensAlias</a>.</p>
|
|
349
393
|
*/
|
|
@@ -357,14 +401,17 @@ export declare class ConflictException extends __BaseException {
|
|
|
357
401
|
readonly name: "ConflictException";
|
|
358
402
|
readonly $fault: "client";
|
|
359
403
|
/**
|
|
404
|
+
* @public
|
|
360
405
|
* <p>Description of the error.</p>
|
|
361
406
|
*/
|
|
362
407
|
Message: string | undefined;
|
|
363
408
|
/**
|
|
409
|
+
* @public
|
|
364
410
|
* <p>Identifier of the resource affected.</p>
|
|
365
411
|
*/
|
|
366
412
|
ResourceId: string | undefined;
|
|
367
413
|
/**
|
|
414
|
+
* @public
|
|
368
415
|
* <p>Type of the resource affected.</p>
|
|
369
416
|
*/
|
|
370
417
|
ResourceType: string | undefined;
|
|
@@ -381,6 +428,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
381
428
|
readonly name: "InternalServerException";
|
|
382
429
|
readonly $fault: "server";
|
|
383
430
|
/**
|
|
431
|
+
* @public
|
|
384
432
|
* <p>Description of the error.</p>
|
|
385
433
|
*/
|
|
386
434
|
Message: string | undefined;
|
|
@@ -397,14 +445,17 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
397
445
|
readonly name: "ResourceNotFoundException";
|
|
398
446
|
readonly $fault: "client";
|
|
399
447
|
/**
|
|
448
|
+
* @public
|
|
400
449
|
* <p>Description of the error.</p>
|
|
401
450
|
*/
|
|
402
451
|
Message: string | undefined;
|
|
403
452
|
/**
|
|
453
|
+
* @public
|
|
404
454
|
* <p>Identifier of the resource affected.</p>
|
|
405
455
|
*/
|
|
406
456
|
ResourceId: string | undefined;
|
|
407
457
|
/**
|
|
458
|
+
* @public
|
|
408
459
|
* <p>Type of the resource affected.</p>
|
|
409
460
|
*/
|
|
410
461
|
ResourceType: string | undefined;
|
|
@@ -421,14 +472,17 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
421
472
|
readonly name: "ThrottlingException";
|
|
422
473
|
readonly $fault: "client";
|
|
423
474
|
/**
|
|
475
|
+
* @public
|
|
424
476
|
* <p>Description of the error.</p>
|
|
425
477
|
*/
|
|
426
478
|
Message: string | undefined;
|
|
427
479
|
/**
|
|
480
|
+
* @public
|
|
428
481
|
* <p>Service Quotas requirement to identify originating quota.</p>
|
|
429
482
|
*/
|
|
430
483
|
QuotaCode?: string;
|
|
431
484
|
/**
|
|
485
|
+
* @public
|
|
432
486
|
* <p>Service Quotas requirement to identify originating service.</p>
|
|
433
487
|
*/
|
|
434
488
|
ServiceCode?: string;
|
|
@@ -443,10 +497,12 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
443
497
|
*/
|
|
444
498
|
export interface ValidationExceptionField {
|
|
445
499
|
/**
|
|
500
|
+
* @public
|
|
446
501
|
* <p>The field name for which validation failed.</p>
|
|
447
502
|
*/
|
|
448
503
|
Name: string | undefined;
|
|
449
504
|
/**
|
|
505
|
+
* @public
|
|
450
506
|
* <p>Description of the error.</p>
|
|
451
507
|
*/
|
|
452
508
|
Message: string | undefined;
|
|
@@ -473,14 +529,17 @@ export declare class ValidationException extends __BaseException {
|
|
|
473
529
|
readonly name: "ValidationException";
|
|
474
530
|
readonly $fault: "client";
|
|
475
531
|
/**
|
|
532
|
+
* @public
|
|
476
533
|
* <p>Description of the error.</p>
|
|
477
534
|
*/
|
|
478
535
|
Message: string | undefined;
|
|
479
536
|
/**
|
|
537
|
+
* @public
|
|
480
538
|
* <p>The reason why the request failed validation.</p>
|
|
481
539
|
*/
|
|
482
540
|
Reason?: ValidationExceptionReason | string;
|
|
483
541
|
/**
|
|
542
|
+
* @public
|
|
484
543
|
* <p>The fields that caused the error, if applicable.</p>
|
|
485
544
|
*/
|
|
486
545
|
Fields?: ValidationExceptionField[];
|
|
@@ -494,10 +553,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
494
553
|
*/
|
|
495
554
|
export interface AssociateProfilesInput {
|
|
496
555
|
/**
|
|
556
|
+
* @public
|
|
497
557
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
498
558
|
*/
|
|
499
559
|
WorkloadId: string | undefined;
|
|
500
560
|
/**
|
|
561
|
+
* @public
|
|
501
562
|
* <p>The list of profile ARNs to associate with the workload.</p>
|
|
502
563
|
*/
|
|
503
564
|
ProfileArns: string[] | undefined;
|
|
@@ -508,10 +569,12 @@ export interface AssociateProfilesInput {
|
|
|
508
569
|
*/
|
|
509
570
|
export interface BestPractice {
|
|
510
571
|
/**
|
|
572
|
+
* @public
|
|
511
573
|
* <p>The ID of a choice.</p>
|
|
512
574
|
*/
|
|
513
575
|
ChoiceId?: string;
|
|
514
576
|
/**
|
|
577
|
+
* @public
|
|
515
578
|
* <p>The title of a choice.</p>
|
|
516
579
|
*/
|
|
517
580
|
ChoiceTitle?: string;
|
|
@@ -547,55 +610,68 @@ export type CheckFailureReason = (typeof CheckFailureReason)[keyof typeof CheckF
|
|
|
547
610
|
*/
|
|
548
611
|
export interface CheckDetail {
|
|
549
612
|
/**
|
|
613
|
+
* @public
|
|
550
614
|
* <p>Trusted Advisor check ID.</p>
|
|
551
615
|
*/
|
|
552
616
|
Id?: string;
|
|
553
617
|
/**
|
|
618
|
+
* @public
|
|
554
619
|
* <p>Trusted Advisor check name.</p>
|
|
555
620
|
*/
|
|
556
621
|
Name?: string;
|
|
557
622
|
/**
|
|
623
|
+
* @public
|
|
558
624
|
* <p>Trusted Advisor check description.</p>
|
|
559
625
|
*/
|
|
560
626
|
Description?: string;
|
|
561
627
|
/**
|
|
628
|
+
* @public
|
|
562
629
|
* <p>Provider of the check related to the best practice.</p>
|
|
563
630
|
*/
|
|
564
631
|
Provider?: CheckProvider | string;
|
|
565
632
|
/**
|
|
633
|
+
* @public
|
|
566
634
|
* <p>Well-Architected Lens ARN associated to the check.</p>
|
|
567
635
|
*/
|
|
568
636
|
LensArn?: string;
|
|
569
637
|
/**
|
|
638
|
+
* @public
|
|
570
639
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
571
640
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
572
641
|
*/
|
|
573
642
|
PillarId?: string;
|
|
574
643
|
/**
|
|
644
|
+
* @public
|
|
575
645
|
* <p>The ID of the question.</p>
|
|
576
646
|
*/
|
|
577
647
|
QuestionId?: string;
|
|
578
648
|
/**
|
|
649
|
+
* @public
|
|
579
650
|
* <p>The ID of a choice.</p>
|
|
580
651
|
*/
|
|
581
652
|
ChoiceId?: string;
|
|
582
653
|
/**
|
|
654
|
+
* @public
|
|
583
655
|
* <p>Status associated to the check.</p>
|
|
584
656
|
*/
|
|
585
657
|
Status?: CheckStatus | string;
|
|
586
658
|
/**
|
|
659
|
+
* @public
|
|
587
660
|
* <p>An Amazon Web Services account ID.</p>
|
|
588
661
|
*/
|
|
589
662
|
AccountId?: string;
|
|
590
663
|
/**
|
|
664
|
+
* @public
|
|
591
665
|
* <p>Count of flagged resources associated to the check.</p>
|
|
592
666
|
*/
|
|
593
667
|
FlaggedResources?: number;
|
|
594
668
|
/**
|
|
669
|
+
* @public
|
|
595
670
|
* <p>Reason associated to the check.</p>
|
|
596
671
|
*/
|
|
597
672
|
Reason?: CheckFailureReason | string;
|
|
598
673
|
/**
|
|
674
|
+
* @public
|
|
599
675
|
* <p>The date and time recorded.</p>
|
|
600
676
|
*/
|
|
601
677
|
UpdatedAt?: Date;
|
|
@@ -606,47 +682,58 @@ export interface CheckDetail {
|
|
|
606
682
|
*/
|
|
607
683
|
export interface CheckSummary {
|
|
608
684
|
/**
|
|
685
|
+
* @public
|
|
609
686
|
* <p>Trusted Advisor check ID.</p>
|
|
610
687
|
*/
|
|
611
688
|
Id?: string;
|
|
612
689
|
/**
|
|
690
|
+
* @public
|
|
613
691
|
* <p>Trusted Advisor check name.</p>
|
|
614
692
|
*/
|
|
615
693
|
Name?: string;
|
|
616
694
|
/**
|
|
695
|
+
* @public
|
|
617
696
|
* <p>Provider of the check related to the best practice.</p>
|
|
618
697
|
*/
|
|
619
698
|
Provider?: CheckProvider | string;
|
|
620
699
|
/**
|
|
700
|
+
* @public
|
|
621
701
|
* <p>Trusted Advisor check description.</p>
|
|
622
702
|
*/
|
|
623
703
|
Description?: string;
|
|
624
704
|
/**
|
|
705
|
+
* @public
|
|
625
706
|
* <p>The date and time recorded.</p>
|
|
626
707
|
*/
|
|
627
708
|
UpdatedAt?: Date;
|
|
628
709
|
/**
|
|
710
|
+
* @public
|
|
629
711
|
* <p>Well-Architected Lens ARN associated to the check.</p>
|
|
630
712
|
*/
|
|
631
713
|
LensArn?: string;
|
|
632
714
|
/**
|
|
715
|
+
* @public
|
|
633
716
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
634
717
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
635
718
|
*/
|
|
636
719
|
PillarId?: string;
|
|
637
720
|
/**
|
|
721
|
+
* @public
|
|
638
722
|
* <p>The ID of the question.</p>
|
|
639
723
|
*/
|
|
640
724
|
QuestionId?: string;
|
|
641
725
|
/**
|
|
726
|
+
* @public
|
|
642
727
|
* <p>The ID of a choice.</p>
|
|
643
728
|
*/
|
|
644
729
|
ChoiceId?: string;
|
|
645
730
|
/**
|
|
731
|
+
* @public
|
|
646
732
|
* <p>Status associated to the check.</p>
|
|
647
733
|
*/
|
|
648
734
|
Status?: CheckStatus | string;
|
|
649
735
|
/**
|
|
736
|
+
* @public
|
|
650
737
|
* <p>Account summary associated to the check.</p>
|
|
651
738
|
*/
|
|
652
739
|
AccountSummary?: Record<string, number>;
|
|
@@ -657,14 +744,17 @@ export interface CheckSummary {
|
|
|
657
744
|
*/
|
|
658
745
|
export interface ChoiceImprovementPlan {
|
|
659
746
|
/**
|
|
747
|
+
* @public
|
|
660
748
|
* <p>The ID of a choice.</p>
|
|
661
749
|
*/
|
|
662
750
|
ChoiceId?: string;
|
|
663
751
|
/**
|
|
752
|
+
* @public
|
|
664
753
|
* <p>The display text for the improvement plan.</p>
|
|
665
754
|
*/
|
|
666
755
|
DisplayText?: string;
|
|
667
756
|
/**
|
|
757
|
+
* @public
|
|
668
758
|
* <p>The improvement plan URL for a question in an Amazon Web Services official lenses.</p>
|
|
669
759
|
* <p>This value is only available if the question has been answered.</p>
|
|
670
760
|
* <p>This value does not apply to custom lenses.</p>
|
|
@@ -677,14 +767,17 @@ export interface ChoiceImprovementPlan {
|
|
|
677
767
|
*/
|
|
678
768
|
export interface ChoiceUpdate {
|
|
679
769
|
/**
|
|
770
|
+
* @public
|
|
680
771
|
* <p>The status of a choice.</p>
|
|
681
772
|
*/
|
|
682
773
|
Status: ChoiceStatus | string | undefined;
|
|
683
774
|
/**
|
|
775
|
+
* @public
|
|
684
776
|
* <p>The reason why a choice is non-applicable to a question in your workload.</p>
|
|
685
777
|
*/
|
|
686
778
|
Reason?: ChoiceReason | string;
|
|
687
779
|
/**
|
|
780
|
+
* @public
|
|
688
781
|
* <p>The notes associated with a choice.</p>
|
|
689
782
|
*/
|
|
690
783
|
Notes?: string;
|
|
@@ -695,14 +788,17 @@ export interface ChoiceUpdate {
|
|
|
695
788
|
*/
|
|
696
789
|
export interface QuestionMetric {
|
|
697
790
|
/**
|
|
791
|
+
* @public
|
|
698
792
|
* <p>The ID of the question.</p>
|
|
699
793
|
*/
|
|
700
794
|
QuestionId?: string;
|
|
701
795
|
/**
|
|
796
|
+
* @public
|
|
702
797
|
* <p>The risk for a given workload, lens review, pillar, or question.</p>
|
|
703
798
|
*/
|
|
704
799
|
Risk?: Risk | string;
|
|
705
800
|
/**
|
|
801
|
+
* @public
|
|
706
802
|
* <p>The best practices, or choices, that have been identified as contributing to risk in a question.</p>
|
|
707
803
|
*/
|
|
708
804
|
BestPractices?: BestPractice[];
|
|
@@ -713,15 +809,18 @@ export interface QuestionMetric {
|
|
|
713
809
|
*/
|
|
714
810
|
export interface PillarMetric {
|
|
715
811
|
/**
|
|
812
|
+
* @public
|
|
716
813
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
717
814
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
718
815
|
*/
|
|
719
816
|
PillarId?: string;
|
|
720
817
|
/**
|
|
818
|
+
* @public
|
|
721
819
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
722
820
|
*/
|
|
723
821
|
RiskCounts?: Record<string, number>;
|
|
724
822
|
/**
|
|
823
|
+
* @public
|
|
725
824
|
* <p>The questions that have been identified as risks in the pillar.</p>
|
|
726
825
|
*/
|
|
727
826
|
Questions?: QuestionMetric[];
|
|
@@ -732,14 +831,17 @@ export interface PillarMetric {
|
|
|
732
831
|
*/
|
|
733
832
|
export interface LensMetric {
|
|
734
833
|
/**
|
|
834
|
+
* @public
|
|
735
835
|
* <p>The lens ARN.</p>
|
|
736
836
|
*/
|
|
737
837
|
LensArn?: string;
|
|
738
838
|
/**
|
|
839
|
+
* @public
|
|
739
840
|
* <p>The metrics for the pillars in a lens.</p>
|
|
740
841
|
*/
|
|
741
842
|
Pillars?: PillarMetric[];
|
|
742
843
|
/**
|
|
844
|
+
* @public
|
|
743
845
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
744
846
|
*/
|
|
745
847
|
RiskCounts?: Record<string, number>;
|
|
@@ -761,36 +863,44 @@ export type MetricType = (typeof MetricType)[keyof typeof MetricType];
|
|
|
761
863
|
*/
|
|
762
864
|
export interface ConsolidatedReportMetric {
|
|
763
865
|
/**
|
|
866
|
+
* @public
|
|
764
867
|
* <p>The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.</p>
|
|
765
868
|
*/
|
|
766
869
|
MetricType?: MetricType | string;
|
|
767
870
|
/**
|
|
871
|
+
* @public
|
|
768
872
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
769
873
|
*/
|
|
770
874
|
RiskCounts?: Record<string, number>;
|
|
771
875
|
/**
|
|
876
|
+
* @public
|
|
772
877
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
773
878
|
*/
|
|
774
879
|
WorkloadId?: string;
|
|
775
880
|
/**
|
|
881
|
+
* @public
|
|
776
882
|
* <p>The name of the workload.</p>
|
|
777
883
|
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
778
884
|
* are ignored when checking for uniqueness.</p>
|
|
779
885
|
*/
|
|
780
886
|
WorkloadName?: string;
|
|
781
887
|
/**
|
|
888
|
+
* @public
|
|
782
889
|
* <p>The ARN for the workload.</p>
|
|
783
890
|
*/
|
|
784
891
|
WorkloadArn?: string;
|
|
785
892
|
/**
|
|
893
|
+
* @public
|
|
786
894
|
* <p>The date and time recorded.</p>
|
|
787
895
|
*/
|
|
788
896
|
UpdatedAt?: Date;
|
|
789
897
|
/**
|
|
898
|
+
* @public
|
|
790
899
|
* <p>The metrics for the lenses in the workload.</p>
|
|
791
900
|
*/
|
|
792
901
|
Lenses?: LensMetric[];
|
|
793
902
|
/**
|
|
903
|
+
* @public
|
|
794
904
|
* <p>The total number of lenses applied to the workload.</p>
|
|
795
905
|
*/
|
|
796
906
|
LensesAppliedCount?: number;
|
|
@@ -800,6 +910,7 @@ export interface ConsolidatedReportMetric {
|
|
|
800
910
|
*/
|
|
801
911
|
export interface CreateLensShareInput {
|
|
802
912
|
/**
|
|
913
|
+
* @public
|
|
803
914
|
* <p>The alias of the lens.</p>
|
|
804
915
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
805
916
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -811,10 +922,12 @@ export interface CreateLensShareInput {
|
|
|
811
922
|
*/
|
|
812
923
|
LensAlias: string | undefined;
|
|
813
924
|
/**
|
|
925
|
+
* @public
|
|
814
926
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.</p>
|
|
815
927
|
*/
|
|
816
928
|
SharedWith: string | undefined;
|
|
817
929
|
/**
|
|
930
|
+
* @public
|
|
818
931
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
819
932
|
* (executes only once).</p>
|
|
820
933
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -833,6 +946,7 @@ export interface CreateLensShareInput {
|
|
|
833
946
|
*/
|
|
834
947
|
export interface CreateLensShareOutput {
|
|
835
948
|
/**
|
|
949
|
+
* @public
|
|
836
950
|
* <p>The ID associated with the share.</p>
|
|
837
951
|
*/
|
|
838
952
|
ShareId?: string;
|
|
@@ -845,22 +959,27 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
845
959
|
readonly name: "ServiceQuotaExceededException";
|
|
846
960
|
readonly $fault: "client";
|
|
847
961
|
/**
|
|
962
|
+
* @public
|
|
848
963
|
* <p>Description of the error.</p>
|
|
849
964
|
*/
|
|
850
965
|
Message: string | undefined;
|
|
851
966
|
/**
|
|
967
|
+
* @public
|
|
852
968
|
* <p>Identifier of the resource affected.</p>
|
|
853
969
|
*/
|
|
854
970
|
ResourceId?: string;
|
|
855
971
|
/**
|
|
972
|
+
* @public
|
|
856
973
|
* <p>Type of the resource affected.</p>
|
|
857
974
|
*/
|
|
858
975
|
ResourceType?: string;
|
|
859
976
|
/**
|
|
977
|
+
* @public
|
|
860
978
|
* <p>Service Quotas requirement to identify originating quota.</p>
|
|
861
979
|
*/
|
|
862
980
|
QuotaCode: string | undefined;
|
|
863
981
|
/**
|
|
982
|
+
* @public
|
|
864
983
|
* <p>Service Quotas requirement to identify originating service.</p>
|
|
865
984
|
*/
|
|
866
985
|
ServiceCode: string | undefined;
|
|
@@ -874,6 +993,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
874
993
|
*/
|
|
875
994
|
export interface CreateLensVersionInput {
|
|
876
995
|
/**
|
|
996
|
+
* @public
|
|
877
997
|
* <p>The alias of the lens.</p>
|
|
878
998
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
879
999
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -885,14 +1005,17 @@ export interface CreateLensVersionInput {
|
|
|
885
1005
|
*/
|
|
886
1006
|
LensAlias: string | undefined;
|
|
887
1007
|
/**
|
|
1008
|
+
* @public
|
|
888
1009
|
* <p>The version of the lens being created.</p>
|
|
889
1010
|
*/
|
|
890
1011
|
LensVersion: string | undefined;
|
|
891
1012
|
/**
|
|
1013
|
+
* @public
|
|
892
1014
|
* <p>Set to true if this new major lens version.</p>
|
|
893
1015
|
*/
|
|
894
1016
|
IsMajorVersion?: boolean;
|
|
895
1017
|
/**
|
|
1018
|
+
* @public
|
|
896
1019
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
897
1020
|
* (executes only once).</p>
|
|
898
1021
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -911,10 +1034,12 @@ export interface CreateLensVersionInput {
|
|
|
911
1034
|
*/
|
|
912
1035
|
export interface CreateLensVersionOutput {
|
|
913
1036
|
/**
|
|
1037
|
+
* @public
|
|
914
1038
|
* <p>The ARN for the lens.</p>
|
|
915
1039
|
*/
|
|
916
1040
|
LensArn?: string;
|
|
917
1041
|
/**
|
|
1042
|
+
* @public
|
|
918
1043
|
* <p>The version of the lens.</p>
|
|
919
1044
|
*/
|
|
920
1045
|
LensVersion?: string;
|
|
@@ -925,15 +1050,18 @@ export interface CreateLensVersionOutput {
|
|
|
925
1050
|
*/
|
|
926
1051
|
export interface CreateMilestoneInput {
|
|
927
1052
|
/**
|
|
1053
|
+
* @public
|
|
928
1054
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
929
1055
|
*/
|
|
930
1056
|
WorkloadId: string | undefined;
|
|
931
1057
|
/**
|
|
1058
|
+
* @public
|
|
932
1059
|
* <p>The name of the milestone in a workload.</p>
|
|
933
1060
|
* <p>Milestone names must be unique within a workload.</p>
|
|
934
1061
|
*/
|
|
935
1062
|
MilestoneName: string | undefined;
|
|
936
1063
|
/**
|
|
1064
|
+
* @public
|
|
937
1065
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
938
1066
|
* (executes only once).</p>
|
|
939
1067
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -953,10 +1081,12 @@ export interface CreateMilestoneInput {
|
|
|
953
1081
|
*/
|
|
954
1082
|
export interface CreateMilestoneOutput {
|
|
955
1083
|
/**
|
|
1084
|
+
* @public
|
|
956
1085
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
957
1086
|
*/
|
|
958
1087
|
WorkloadId?: string;
|
|
959
1088
|
/**
|
|
1089
|
+
* @public
|
|
960
1090
|
* <p>The milestone number.</p>
|
|
961
1091
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
962
1092
|
*/
|
|
@@ -968,10 +1098,12 @@ export interface CreateMilestoneOutput {
|
|
|
968
1098
|
*/
|
|
969
1099
|
export interface ProfileQuestionUpdate {
|
|
970
1100
|
/**
|
|
1101
|
+
* @public
|
|
971
1102
|
* <p>The ID of the question.</p>
|
|
972
1103
|
*/
|
|
973
1104
|
QuestionId?: string;
|
|
974
1105
|
/**
|
|
1106
|
+
* @public
|
|
975
1107
|
* <p>The selected choices.</p>
|
|
976
1108
|
*/
|
|
977
1109
|
SelectedChoiceIds?: string[];
|
|
@@ -981,18 +1113,22 @@ export interface ProfileQuestionUpdate {
|
|
|
981
1113
|
*/
|
|
982
1114
|
export interface CreateProfileInput {
|
|
983
1115
|
/**
|
|
1116
|
+
* @public
|
|
984
1117
|
* <p>Name of the profile.</p>
|
|
985
1118
|
*/
|
|
986
1119
|
ProfileName: string | undefined;
|
|
987
1120
|
/**
|
|
1121
|
+
* @public
|
|
988
1122
|
* <p>The profile description.</p>
|
|
989
1123
|
*/
|
|
990
1124
|
ProfileDescription: string | undefined;
|
|
991
1125
|
/**
|
|
1126
|
+
* @public
|
|
992
1127
|
* <p>The profile questions.</p>
|
|
993
1128
|
*/
|
|
994
1129
|
ProfileQuestions: ProfileQuestionUpdate[] | undefined;
|
|
995
1130
|
/**
|
|
1131
|
+
* @public
|
|
996
1132
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
997
1133
|
* (executes only once).</p>
|
|
998
1134
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -1006,6 +1142,7 @@ export interface CreateProfileInput {
|
|
|
1006
1142
|
*/
|
|
1007
1143
|
ClientRequestToken?: string;
|
|
1008
1144
|
/**
|
|
1145
|
+
* @public
|
|
1009
1146
|
* <p>The tags assigned to the profile.</p>
|
|
1010
1147
|
*/
|
|
1011
1148
|
Tags?: Record<string, string>;
|
|
@@ -1015,10 +1152,12 @@ export interface CreateProfileInput {
|
|
|
1015
1152
|
*/
|
|
1016
1153
|
export interface CreateProfileOutput {
|
|
1017
1154
|
/**
|
|
1155
|
+
* @public
|
|
1018
1156
|
* <p>The profile ARN.</p>
|
|
1019
1157
|
*/
|
|
1020
1158
|
ProfileArn?: string;
|
|
1021
1159
|
/**
|
|
1160
|
+
* @public
|
|
1022
1161
|
* <p>Version of the profile.</p>
|
|
1023
1162
|
*/
|
|
1024
1163
|
ProfileVersion?: string;
|
|
@@ -1028,14 +1167,17 @@ export interface CreateProfileOutput {
|
|
|
1028
1167
|
*/
|
|
1029
1168
|
export interface CreateProfileShareInput {
|
|
1030
1169
|
/**
|
|
1170
|
+
* @public
|
|
1031
1171
|
* <p>The profile ARN.</p>
|
|
1032
1172
|
*/
|
|
1033
1173
|
ProfileArn: string | undefined;
|
|
1034
1174
|
/**
|
|
1175
|
+
* @public
|
|
1035
1176
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.</p>
|
|
1036
1177
|
*/
|
|
1037
1178
|
SharedWith: string | undefined;
|
|
1038
1179
|
/**
|
|
1180
|
+
* @public
|
|
1039
1181
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1040
1182
|
* (executes only once).</p>
|
|
1041
1183
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -1054,10 +1196,12 @@ export interface CreateProfileShareInput {
|
|
|
1054
1196
|
*/
|
|
1055
1197
|
export interface CreateProfileShareOutput {
|
|
1056
1198
|
/**
|
|
1199
|
+
* @public
|
|
1057
1200
|
* <p>The ID associated with the share.</p>
|
|
1058
1201
|
*/
|
|
1059
1202
|
ShareId?: string;
|
|
1060
1203
|
/**
|
|
1204
|
+
* @public
|
|
1061
1205
|
* <p>The profile ARN.</p>
|
|
1062
1206
|
*/
|
|
1063
1207
|
ProfileArn?: string;
|
|
@@ -1092,10 +1236,12 @@ export type DefinitionType = (typeof DefinitionType)[keyof typeof DefinitionType
|
|
|
1092
1236
|
*/
|
|
1093
1237
|
export interface WorkloadDiscoveryConfig {
|
|
1094
1238
|
/**
|
|
1239
|
+
* @public
|
|
1095
1240
|
* <p>Discovery integration status in respect to Trusted Advisor for the workload.</p>
|
|
1096
1241
|
*/
|
|
1097
1242
|
TrustedAdvisorIntegrationStatus?: TrustedAdvisorIntegrationStatus | string;
|
|
1098
1243
|
/**
|
|
1244
|
+
* @public
|
|
1099
1245
|
* <p>The mode to use for identifying resources associated with the workload.</p>
|
|
1100
1246
|
* <p>You can specify <code>WORKLOAD_METADATA</code>, <code>APP_REGISTRY</code>, or both.</p>
|
|
1101
1247
|
*/
|
|
@@ -1119,47 +1265,57 @@ export type WorkloadEnvironment = (typeof WorkloadEnvironment)[keyof typeof Work
|
|
|
1119
1265
|
*/
|
|
1120
1266
|
export interface CreateWorkloadInput {
|
|
1121
1267
|
/**
|
|
1268
|
+
* @public
|
|
1122
1269
|
* <p>The name of the workload.</p>
|
|
1123
1270
|
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
1124
1271
|
* are ignored when checking for uniqueness.</p>
|
|
1125
1272
|
*/
|
|
1126
1273
|
WorkloadName: string | undefined;
|
|
1127
1274
|
/**
|
|
1275
|
+
* @public
|
|
1128
1276
|
* <p>The description for the workload.</p>
|
|
1129
1277
|
*/
|
|
1130
1278
|
Description: string | undefined;
|
|
1131
1279
|
/**
|
|
1280
|
+
* @public
|
|
1132
1281
|
* <p>The environment for the workload.</p>
|
|
1133
1282
|
*/
|
|
1134
1283
|
Environment: WorkloadEnvironment | string | undefined;
|
|
1135
1284
|
/**
|
|
1285
|
+
* @public
|
|
1136
1286
|
* <p>The list of Amazon Web Services account IDs associated with the workload.</p>
|
|
1137
1287
|
*/
|
|
1138
1288
|
AccountIds?: string[];
|
|
1139
1289
|
/**
|
|
1290
|
+
* @public
|
|
1140
1291
|
* <p>The list of Amazon Web Services Regions associated with the workload, for example,
|
|
1141
1292
|
* <code>us-east-2</code>, or <code>ca-central-1</code>.</p>
|
|
1142
1293
|
*/
|
|
1143
1294
|
AwsRegions?: string[];
|
|
1144
1295
|
/**
|
|
1296
|
+
* @public
|
|
1145
1297
|
* <p> The list of non-Amazon Web Services Regions associated with the workload.</p>
|
|
1146
1298
|
*/
|
|
1147
1299
|
NonAwsRegions?: string[];
|
|
1148
1300
|
/**
|
|
1301
|
+
* @public
|
|
1149
1302
|
* <p>The priorities of the pillars, which are used to order items in the improvement plan.
|
|
1150
1303
|
* Each pillar is represented by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
1151
1304
|
*/
|
|
1152
1305
|
PillarPriorities?: string[];
|
|
1153
1306
|
/**
|
|
1307
|
+
* @public
|
|
1154
1308
|
* <p>The URL of the architectural design for the workload.</p>
|
|
1155
1309
|
*/
|
|
1156
1310
|
ArchitecturalDesign?: string;
|
|
1157
1311
|
/**
|
|
1312
|
+
* @public
|
|
1158
1313
|
* <p>The review owner of the workload. The name, email address, or identifier for the
|
|
1159
1314
|
* primary group or individual that owns the workload review process.</p>
|
|
1160
1315
|
*/
|
|
1161
1316
|
ReviewOwner?: string;
|
|
1162
1317
|
/**
|
|
1318
|
+
* @public
|
|
1163
1319
|
* <p>The industry type for the workload.</p>
|
|
1164
1320
|
* <p>If specified, must be one of the following:</p>
|
|
1165
1321
|
* <ul>
|
|
@@ -1302,18 +1458,22 @@ export interface CreateWorkloadInput {
|
|
|
1302
1458
|
*/
|
|
1303
1459
|
IndustryType?: string;
|
|
1304
1460
|
/**
|
|
1461
|
+
* @public
|
|
1305
1462
|
* <p>The industry for the workload.</p>
|
|
1306
1463
|
*/
|
|
1307
1464
|
Industry?: string;
|
|
1308
1465
|
/**
|
|
1466
|
+
* @public
|
|
1309
1467
|
* <p>The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1310
1468
|
*/
|
|
1311
1469
|
Lenses: string[] | undefined;
|
|
1312
1470
|
/**
|
|
1471
|
+
* @public
|
|
1313
1472
|
* <p>The notes associated with the workload.</p>
|
|
1314
1473
|
*/
|
|
1315
1474
|
Notes?: string;
|
|
1316
1475
|
/**
|
|
1476
|
+
* @public
|
|
1317
1477
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1318
1478
|
* (executes only once).</p>
|
|
1319
1479
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -1327,18 +1487,22 @@ export interface CreateWorkloadInput {
|
|
|
1327
1487
|
*/
|
|
1328
1488
|
ClientRequestToken?: string;
|
|
1329
1489
|
/**
|
|
1490
|
+
* @public
|
|
1330
1491
|
* <p>The tags to be associated with the workload.</p>
|
|
1331
1492
|
*/
|
|
1332
1493
|
Tags?: Record<string, string>;
|
|
1333
1494
|
/**
|
|
1495
|
+
* @public
|
|
1334
1496
|
* <p>Well-Architected discovery configuration settings associated to the workload.</p>
|
|
1335
1497
|
*/
|
|
1336
1498
|
DiscoveryConfig?: WorkloadDiscoveryConfig;
|
|
1337
1499
|
/**
|
|
1500
|
+
* @public
|
|
1338
1501
|
* <p>List of AppRegistry application ARNs associated to the workload.</p>
|
|
1339
1502
|
*/
|
|
1340
1503
|
Applications?: string[];
|
|
1341
1504
|
/**
|
|
1505
|
+
* @public
|
|
1342
1506
|
* <p>The list of profile ARNs associated with the workload.</p>
|
|
1343
1507
|
*/
|
|
1344
1508
|
ProfileArns?: string[];
|
|
@@ -1349,10 +1513,12 @@ export interface CreateWorkloadInput {
|
|
|
1349
1513
|
*/
|
|
1350
1514
|
export interface CreateWorkloadOutput {
|
|
1351
1515
|
/**
|
|
1516
|
+
* @public
|
|
1352
1517
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
1353
1518
|
*/
|
|
1354
1519
|
WorkloadId?: string;
|
|
1355
1520
|
/**
|
|
1521
|
+
* @public
|
|
1356
1522
|
* <p>The ARN for the workload.</p>
|
|
1357
1523
|
*/
|
|
1358
1524
|
WorkloadArn?: string;
|
|
@@ -1375,18 +1541,22 @@ export type PermissionType = (typeof PermissionType)[keyof typeof PermissionType
|
|
|
1375
1541
|
*/
|
|
1376
1542
|
export interface CreateWorkloadShareInput {
|
|
1377
1543
|
/**
|
|
1544
|
+
* @public
|
|
1378
1545
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
1379
1546
|
*/
|
|
1380
1547
|
WorkloadId: string | undefined;
|
|
1381
1548
|
/**
|
|
1549
|
+
* @public
|
|
1382
1550
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.</p>
|
|
1383
1551
|
*/
|
|
1384
1552
|
SharedWith: string | undefined;
|
|
1385
1553
|
/**
|
|
1554
|
+
* @public
|
|
1386
1555
|
* <p>Permission granted on a share request.</p>
|
|
1387
1556
|
*/
|
|
1388
1557
|
PermissionType: PermissionType | string | undefined;
|
|
1389
1558
|
/**
|
|
1559
|
+
* @public
|
|
1390
1560
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1391
1561
|
* (executes only once).</p>
|
|
1392
1562
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -1406,10 +1576,12 @@ export interface CreateWorkloadShareInput {
|
|
|
1406
1576
|
*/
|
|
1407
1577
|
export interface CreateWorkloadShareOutput {
|
|
1408
1578
|
/**
|
|
1579
|
+
* @public
|
|
1409
1580
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
1410
1581
|
*/
|
|
1411
1582
|
WorkloadId?: string;
|
|
1412
1583
|
/**
|
|
1584
|
+
* @public
|
|
1413
1585
|
* <p>The ID associated with the share.</p>
|
|
1414
1586
|
*/
|
|
1415
1587
|
ShareId?: string;
|
|
@@ -1432,6 +1604,7 @@ export type LensStatusType = (typeof LensStatusType)[keyof typeof LensStatusType
|
|
|
1432
1604
|
*/
|
|
1433
1605
|
export interface DeleteLensInput {
|
|
1434
1606
|
/**
|
|
1607
|
+
* @public
|
|
1435
1608
|
* <p>The alias of the lens.</p>
|
|
1436
1609
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1437
1610
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -1443,6 +1616,7 @@ export interface DeleteLensInput {
|
|
|
1443
1616
|
*/
|
|
1444
1617
|
LensAlias: string | undefined;
|
|
1445
1618
|
/**
|
|
1619
|
+
* @public
|
|
1446
1620
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1447
1621
|
* (executes only once).</p>
|
|
1448
1622
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -1456,6 +1630,7 @@ export interface DeleteLensInput {
|
|
|
1456
1630
|
*/
|
|
1457
1631
|
ClientRequestToken?: string;
|
|
1458
1632
|
/**
|
|
1633
|
+
* @public
|
|
1459
1634
|
* <p>The status of the lens to be deleted.</p>
|
|
1460
1635
|
*/
|
|
1461
1636
|
LensStatus: LensStatusType | string | undefined;
|
|
@@ -1465,10 +1640,12 @@ export interface DeleteLensInput {
|
|
|
1465
1640
|
*/
|
|
1466
1641
|
export interface DeleteLensShareInput {
|
|
1467
1642
|
/**
|
|
1643
|
+
* @public
|
|
1468
1644
|
* <p>The ID associated with the share.</p>
|
|
1469
1645
|
*/
|
|
1470
1646
|
ShareId: string | undefined;
|
|
1471
1647
|
/**
|
|
1648
|
+
* @public
|
|
1472
1649
|
* <p>The alias of the lens.</p>
|
|
1473
1650
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1474
1651
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -1480,6 +1657,7 @@ export interface DeleteLensShareInput {
|
|
|
1480
1657
|
*/
|
|
1481
1658
|
LensAlias: string | undefined;
|
|
1482
1659
|
/**
|
|
1660
|
+
* @public
|
|
1483
1661
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1484
1662
|
* (executes only once).</p>
|
|
1485
1663
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -1498,10 +1676,12 @@ export interface DeleteLensShareInput {
|
|
|
1498
1676
|
*/
|
|
1499
1677
|
export interface DeleteProfileInput {
|
|
1500
1678
|
/**
|
|
1679
|
+
* @public
|
|
1501
1680
|
* <p>The profile ARN.</p>
|
|
1502
1681
|
*/
|
|
1503
1682
|
ProfileArn: string | undefined;
|
|
1504
1683
|
/**
|
|
1684
|
+
* @public
|
|
1505
1685
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1506
1686
|
* (executes only once).</p>
|
|
1507
1687
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -1520,14 +1700,17 @@ export interface DeleteProfileInput {
|
|
|
1520
1700
|
*/
|
|
1521
1701
|
export interface DeleteProfileShareInput {
|
|
1522
1702
|
/**
|
|
1703
|
+
* @public
|
|
1523
1704
|
* <p>The ID associated with the share.</p>
|
|
1524
1705
|
*/
|
|
1525
1706
|
ShareId: string | undefined;
|
|
1526
1707
|
/**
|
|
1708
|
+
* @public
|
|
1527
1709
|
* <p>The profile ARN.</p>
|
|
1528
1710
|
*/
|
|
1529
1711
|
ProfileArn: string | undefined;
|
|
1530
1712
|
/**
|
|
1713
|
+
* @public
|
|
1531
1714
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1532
1715
|
* (executes only once).</p>
|
|
1533
1716
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -1547,10 +1730,12 @@ export interface DeleteProfileShareInput {
|
|
|
1547
1730
|
*/
|
|
1548
1731
|
export interface DeleteWorkloadInput {
|
|
1549
1732
|
/**
|
|
1733
|
+
* @public
|
|
1550
1734
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
1551
1735
|
*/
|
|
1552
1736
|
WorkloadId: string | undefined;
|
|
1553
1737
|
/**
|
|
1738
|
+
* @public
|
|
1554
1739
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1555
1740
|
* (executes only once).</p>
|
|
1556
1741
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -1570,14 +1755,17 @@ export interface DeleteWorkloadInput {
|
|
|
1570
1755
|
*/
|
|
1571
1756
|
export interface DeleteWorkloadShareInput {
|
|
1572
1757
|
/**
|
|
1758
|
+
* @public
|
|
1573
1759
|
* <p>The ID associated with the share.</p>
|
|
1574
1760
|
*/
|
|
1575
1761
|
ShareId: string | undefined;
|
|
1576
1762
|
/**
|
|
1763
|
+
* @public
|
|
1577
1764
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
1578
1765
|
*/
|
|
1579
1766
|
WorkloadId: string | undefined;
|
|
1580
1767
|
/**
|
|
1768
|
+
* @public
|
|
1581
1769
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1582
1770
|
* (executes only once).</p>
|
|
1583
1771
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -1610,10 +1798,12 @@ export type DifferenceStatus = (typeof DifferenceStatus)[keyof typeof Difference
|
|
|
1610
1798
|
*/
|
|
1611
1799
|
export interface DisassociateLensesInput {
|
|
1612
1800
|
/**
|
|
1801
|
+
* @public
|
|
1613
1802
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
1614
1803
|
*/
|
|
1615
1804
|
WorkloadId: string | undefined;
|
|
1616
1805
|
/**
|
|
1806
|
+
* @public
|
|
1617
1807
|
* <p>List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.</p>
|
|
1618
1808
|
* <p>Identify a lens using its <a>LensSummary$LensAlias</a>.</p>
|
|
1619
1809
|
*/
|
|
@@ -1624,10 +1814,12 @@ export interface DisassociateLensesInput {
|
|
|
1624
1814
|
*/
|
|
1625
1815
|
export interface DisassociateProfilesInput {
|
|
1626
1816
|
/**
|
|
1817
|
+
* @public
|
|
1627
1818
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
1628
1819
|
*/
|
|
1629
1820
|
WorkloadId: string | undefined;
|
|
1630
1821
|
/**
|
|
1822
|
+
* @public
|
|
1631
1823
|
* <p>The list of profile ARNs to disassociate from the workload.</p>
|
|
1632
1824
|
*/
|
|
1633
1825
|
ProfileArns: string[] | undefined;
|
|
@@ -1649,6 +1841,7 @@ export type DiscoveryIntegrationStatus = (typeof DiscoveryIntegrationStatus)[key
|
|
|
1649
1841
|
*/
|
|
1650
1842
|
export interface ExportLensInput {
|
|
1651
1843
|
/**
|
|
1844
|
+
* @public
|
|
1652
1845
|
* <p>The alias of the lens.</p>
|
|
1653
1846
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1654
1847
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -1660,6 +1853,7 @@ export interface ExportLensInput {
|
|
|
1660
1853
|
*/
|
|
1661
1854
|
LensAlias: string | undefined;
|
|
1662
1855
|
/**
|
|
1856
|
+
* @public
|
|
1663
1857
|
* <p>The lens version to be exported.</p>
|
|
1664
1858
|
*/
|
|
1665
1859
|
LensVersion?: string;
|
|
@@ -1669,6 +1863,7 @@ export interface ExportLensInput {
|
|
|
1669
1863
|
*/
|
|
1670
1864
|
export interface ExportLensOutput {
|
|
1671
1865
|
/**
|
|
1866
|
+
* @public
|
|
1672
1867
|
* <p>The JSON representation of a lens.</p>
|
|
1673
1868
|
*/
|
|
1674
1869
|
LensJSON?: string;
|
|
@@ -1679,10 +1874,12 @@ export interface ExportLensOutput {
|
|
|
1679
1874
|
*/
|
|
1680
1875
|
export interface GetAnswerInput {
|
|
1681
1876
|
/**
|
|
1877
|
+
* @public
|
|
1682
1878
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
1683
1879
|
*/
|
|
1684
1880
|
WorkloadId: string | undefined;
|
|
1685
1881
|
/**
|
|
1882
|
+
* @public
|
|
1686
1883
|
* <p>The alias of the lens.</p>
|
|
1687
1884
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1688
1885
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -1694,10 +1891,12 @@ export interface GetAnswerInput {
|
|
|
1694
1891
|
*/
|
|
1695
1892
|
LensAlias: string | undefined;
|
|
1696
1893
|
/**
|
|
1894
|
+
* @public
|
|
1697
1895
|
* <p>The ID of the question.</p>
|
|
1698
1896
|
*/
|
|
1699
1897
|
QuestionId: string | undefined;
|
|
1700
1898
|
/**
|
|
1899
|
+
* @public
|
|
1701
1900
|
* <p>The milestone number.</p>
|
|
1702
1901
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1703
1902
|
*/
|
|
@@ -1709,15 +1908,18 @@ export interface GetAnswerInput {
|
|
|
1709
1908
|
*/
|
|
1710
1909
|
export interface GetAnswerOutput {
|
|
1711
1910
|
/**
|
|
1911
|
+
* @public
|
|
1712
1912
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
1713
1913
|
*/
|
|
1714
1914
|
WorkloadId?: string;
|
|
1715
1915
|
/**
|
|
1916
|
+
* @public
|
|
1716
1917
|
* <p>The milestone number.</p>
|
|
1717
1918
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1718
1919
|
*/
|
|
1719
1920
|
MilestoneNumber?: number;
|
|
1720
1921
|
/**
|
|
1922
|
+
* @public
|
|
1721
1923
|
* <p>The alias of the lens.</p>
|
|
1722
1924
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1723
1925
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -1729,10 +1931,12 @@ export interface GetAnswerOutput {
|
|
|
1729
1931
|
*/
|
|
1730
1932
|
LensAlias?: string;
|
|
1731
1933
|
/**
|
|
1934
|
+
* @public
|
|
1732
1935
|
* <p>The ARN for the lens.</p>
|
|
1733
1936
|
*/
|
|
1734
1937
|
LensArn?: string;
|
|
1735
1938
|
/**
|
|
1939
|
+
* @public
|
|
1736
1940
|
* <p>An answer of the question.</p>
|
|
1737
1941
|
*/
|
|
1738
1942
|
Answer?: Answer;
|
|
@@ -1754,20 +1958,24 @@ export type ReportFormat = (typeof ReportFormat)[keyof typeof ReportFormat];
|
|
|
1754
1958
|
*/
|
|
1755
1959
|
export interface GetConsolidatedReportInput {
|
|
1756
1960
|
/**
|
|
1961
|
+
* @public
|
|
1757
1962
|
* <p>The format of the consolidated report.</p>
|
|
1758
1963
|
* <p>For <code>PDF</code>, <code>Base64String</code> is returned. For <code>JSON</code>,
|
|
1759
1964
|
* <code>Metrics</code> is returned.</p>
|
|
1760
1965
|
*/
|
|
1761
1966
|
Format: ReportFormat | string | undefined;
|
|
1762
1967
|
/**
|
|
1968
|
+
* @public
|
|
1763
1969
|
* <p>Set to <code>true</code> to have shared resources included in the report.</p>
|
|
1764
1970
|
*/
|
|
1765
1971
|
IncludeSharedResources?: boolean;
|
|
1766
1972
|
/**
|
|
1973
|
+
* @public
|
|
1767
1974
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
1768
1975
|
*/
|
|
1769
1976
|
NextToken?: string;
|
|
1770
1977
|
/**
|
|
1978
|
+
* @public
|
|
1771
1979
|
* <p>The maximum number of results to return for this request.</p>
|
|
1772
1980
|
*/
|
|
1773
1981
|
MaxResults?: number;
|
|
@@ -1777,15 +1985,18 @@ export interface GetConsolidatedReportInput {
|
|
|
1777
1985
|
*/
|
|
1778
1986
|
export interface GetConsolidatedReportOutput {
|
|
1779
1987
|
/**
|
|
1988
|
+
* @public
|
|
1780
1989
|
* <p>The metrics that make up the consolidated report.</p>
|
|
1781
1990
|
* <p>Only returned when <code>JSON</code> format is requested.</p>
|
|
1782
1991
|
*/
|
|
1783
1992
|
Metrics?: ConsolidatedReportMetric[];
|
|
1784
1993
|
/**
|
|
1994
|
+
* @public
|
|
1785
1995
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
1786
1996
|
*/
|
|
1787
1997
|
NextToken?: string;
|
|
1788
1998
|
/**
|
|
1999
|
+
* @public
|
|
1789
2000
|
* <p>The Base64-encoded string representation of a lens review report.</p>
|
|
1790
2001
|
* <p>This data can be used to create a PDF file.</p>
|
|
1791
2002
|
* <p>Only returned by <a>GetConsolidatedReport</a>
|
|
@@ -1798,6 +2009,7 @@ export interface GetConsolidatedReportOutput {
|
|
|
1798
2009
|
*/
|
|
1799
2010
|
export interface GetLensInput {
|
|
1800
2011
|
/**
|
|
2012
|
+
* @public
|
|
1801
2013
|
* <p>The alias of the lens.</p>
|
|
1802
2014
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1803
2015
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -1809,6 +2021,7 @@ export interface GetLensInput {
|
|
|
1809
2021
|
*/
|
|
1810
2022
|
LensAlias: string | undefined;
|
|
1811
2023
|
/**
|
|
2024
|
+
* @public
|
|
1812
2025
|
* <p>The lens version to be retrieved.</p>
|
|
1813
2026
|
*/
|
|
1814
2027
|
LensVersion?: string;
|
|
@@ -1819,30 +2032,37 @@ export interface GetLensInput {
|
|
|
1819
2032
|
*/
|
|
1820
2033
|
export interface Lens {
|
|
1821
2034
|
/**
|
|
2035
|
+
* @public
|
|
1822
2036
|
* <p>The ARN of a lens.</p>
|
|
1823
2037
|
*/
|
|
1824
2038
|
LensArn?: string;
|
|
1825
2039
|
/**
|
|
2040
|
+
* @public
|
|
1826
2041
|
* <p>The version of a lens.</p>
|
|
1827
2042
|
*/
|
|
1828
2043
|
LensVersion?: string;
|
|
1829
2044
|
/**
|
|
2045
|
+
* @public
|
|
1830
2046
|
* <p>The full name of the lens.</p>
|
|
1831
2047
|
*/
|
|
1832
2048
|
Name?: string;
|
|
1833
2049
|
/**
|
|
2050
|
+
* @public
|
|
1834
2051
|
* <p>The description of the lens.</p>
|
|
1835
2052
|
*/
|
|
1836
2053
|
Description?: string;
|
|
1837
2054
|
/**
|
|
2055
|
+
* @public
|
|
1838
2056
|
* <p>The Amazon Web Services account ID that owns the lens.</p>
|
|
1839
2057
|
*/
|
|
1840
2058
|
Owner?: string;
|
|
1841
2059
|
/**
|
|
2060
|
+
* @public
|
|
1842
2061
|
* <p>The ID assigned to the share invitation.</p>
|
|
1843
2062
|
*/
|
|
1844
2063
|
ShareInvitationId?: string;
|
|
1845
2064
|
/**
|
|
2065
|
+
* @public
|
|
1846
2066
|
* <p>The tags assigned to the lens.</p>
|
|
1847
2067
|
*/
|
|
1848
2068
|
Tags?: Record<string, string>;
|
|
@@ -1852,6 +2072,7 @@ export interface Lens {
|
|
|
1852
2072
|
*/
|
|
1853
2073
|
export interface GetLensOutput {
|
|
1854
2074
|
/**
|
|
2075
|
+
* @public
|
|
1855
2076
|
* <p>A lens return object.</p>
|
|
1856
2077
|
*/
|
|
1857
2078
|
Lens?: Lens;
|
|
@@ -1862,10 +2083,12 @@ export interface GetLensOutput {
|
|
|
1862
2083
|
*/
|
|
1863
2084
|
export interface GetLensReviewInput {
|
|
1864
2085
|
/**
|
|
2086
|
+
* @public
|
|
1865
2087
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
1866
2088
|
*/
|
|
1867
2089
|
WorkloadId: string | undefined;
|
|
1868
2090
|
/**
|
|
2091
|
+
* @public
|
|
1869
2092
|
* <p>The alias of the lens.</p>
|
|
1870
2093
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1871
2094
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -1877,6 +2100,7 @@ export interface GetLensReviewInput {
|
|
|
1877
2100
|
*/
|
|
1878
2101
|
LensAlias: string | undefined;
|
|
1879
2102
|
/**
|
|
2103
|
+
* @public
|
|
1880
2104
|
* <p>The milestone number.</p>
|
|
1881
2105
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
1882
2106
|
*/
|
|
@@ -1903,23 +2127,28 @@ export type LensStatus = (typeof LensStatus)[keyof typeof LensStatus];
|
|
|
1903
2127
|
*/
|
|
1904
2128
|
export interface PillarReviewSummary {
|
|
1905
2129
|
/**
|
|
2130
|
+
* @public
|
|
1906
2131
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
1907
2132
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
1908
2133
|
*/
|
|
1909
2134
|
PillarId?: string;
|
|
1910
2135
|
/**
|
|
2136
|
+
* @public
|
|
1911
2137
|
* <p>The name of the pillar.</p>
|
|
1912
2138
|
*/
|
|
1913
2139
|
PillarName?: string;
|
|
1914
2140
|
/**
|
|
2141
|
+
* @public
|
|
1915
2142
|
* <p>The notes associated with the workload.</p>
|
|
1916
2143
|
*/
|
|
1917
2144
|
Notes?: string;
|
|
1918
2145
|
/**
|
|
2146
|
+
* @public
|
|
1919
2147
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
1920
2148
|
*/
|
|
1921
2149
|
RiskCounts?: Record<string, number>;
|
|
1922
2150
|
/**
|
|
2151
|
+
* @public
|
|
1923
2152
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
1924
2153
|
*/
|
|
1925
2154
|
PrioritizedRiskCounts?: Record<string, number>;
|
|
@@ -1930,10 +2159,12 @@ export interface PillarReviewSummary {
|
|
|
1930
2159
|
*/
|
|
1931
2160
|
export interface WorkloadProfile {
|
|
1932
2161
|
/**
|
|
2162
|
+
* @public
|
|
1933
2163
|
* <p>The profile ARN.</p>
|
|
1934
2164
|
*/
|
|
1935
2165
|
ProfileArn?: string;
|
|
1936
2166
|
/**
|
|
2167
|
+
* @public
|
|
1937
2168
|
* <p>The profile version.</p>
|
|
1938
2169
|
*/
|
|
1939
2170
|
ProfileVersion?: string;
|
|
@@ -1944,6 +2175,7 @@ export interface WorkloadProfile {
|
|
|
1944
2175
|
*/
|
|
1945
2176
|
export interface LensReview {
|
|
1946
2177
|
/**
|
|
2178
|
+
* @public
|
|
1947
2179
|
* <p>The alias of the lens.</p>
|
|
1948
2180
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
1949
2181
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -1955,46 +2187,57 @@ export interface LensReview {
|
|
|
1955
2187
|
*/
|
|
1956
2188
|
LensAlias?: string;
|
|
1957
2189
|
/**
|
|
2190
|
+
* @public
|
|
1958
2191
|
* <p>The ARN for the lens.</p>
|
|
1959
2192
|
*/
|
|
1960
2193
|
LensArn?: string;
|
|
1961
2194
|
/**
|
|
2195
|
+
* @public
|
|
1962
2196
|
* <p>The version of the lens.</p>
|
|
1963
2197
|
*/
|
|
1964
2198
|
LensVersion?: string;
|
|
1965
2199
|
/**
|
|
2200
|
+
* @public
|
|
1966
2201
|
* <p>The full name of the lens.</p>
|
|
1967
2202
|
*/
|
|
1968
2203
|
LensName?: string;
|
|
1969
2204
|
/**
|
|
2205
|
+
* @public
|
|
1970
2206
|
* <p>The status of the lens.</p>
|
|
1971
2207
|
*/
|
|
1972
2208
|
LensStatus?: LensStatus | string;
|
|
1973
2209
|
/**
|
|
2210
|
+
* @public
|
|
1974
2211
|
* <p>List of pillar review summaries of lens review in a workload.</p>
|
|
1975
2212
|
*/
|
|
1976
2213
|
PillarReviewSummaries?: PillarReviewSummary[];
|
|
1977
2214
|
/**
|
|
2215
|
+
* @public
|
|
1978
2216
|
* <p>The date and time recorded.</p>
|
|
1979
2217
|
*/
|
|
1980
2218
|
UpdatedAt?: Date;
|
|
1981
2219
|
/**
|
|
2220
|
+
* @public
|
|
1982
2221
|
* <p>The notes associated with the workload.</p>
|
|
1983
2222
|
*/
|
|
1984
2223
|
Notes?: string;
|
|
1985
2224
|
/**
|
|
2225
|
+
* @public
|
|
1986
2226
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
1987
2227
|
*/
|
|
1988
2228
|
RiskCounts?: Record<string, number>;
|
|
1989
2229
|
/**
|
|
2230
|
+
* @public
|
|
1990
2231
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
1991
2232
|
*/
|
|
1992
2233
|
NextToken?: string;
|
|
1993
2234
|
/**
|
|
2235
|
+
* @public
|
|
1994
2236
|
* <p>The profiles associated with the workload.</p>
|
|
1995
2237
|
*/
|
|
1996
2238
|
Profiles?: WorkloadProfile[];
|
|
1997
2239
|
/**
|
|
2240
|
+
* @public
|
|
1998
2241
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
1999
2242
|
*/
|
|
2000
2243
|
PrioritizedRiskCounts?: Record<string, number>;
|
|
@@ -2005,15 +2248,18 @@ export interface LensReview {
|
|
|
2005
2248
|
*/
|
|
2006
2249
|
export interface GetLensReviewOutput {
|
|
2007
2250
|
/**
|
|
2251
|
+
* @public
|
|
2008
2252
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
2009
2253
|
*/
|
|
2010
2254
|
WorkloadId?: string;
|
|
2011
2255
|
/**
|
|
2256
|
+
* @public
|
|
2012
2257
|
* <p>The milestone number.</p>
|
|
2013
2258
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2014
2259
|
*/
|
|
2015
2260
|
MilestoneNumber?: number;
|
|
2016
2261
|
/**
|
|
2262
|
+
* @public
|
|
2017
2263
|
* <p>A lens review of a question.</p>
|
|
2018
2264
|
*/
|
|
2019
2265
|
LensReview?: LensReview;
|
|
@@ -2024,10 +2270,12 @@ export interface GetLensReviewOutput {
|
|
|
2024
2270
|
*/
|
|
2025
2271
|
export interface GetLensReviewReportInput {
|
|
2026
2272
|
/**
|
|
2273
|
+
* @public
|
|
2027
2274
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
2028
2275
|
*/
|
|
2029
2276
|
WorkloadId: string | undefined;
|
|
2030
2277
|
/**
|
|
2278
|
+
* @public
|
|
2031
2279
|
* <p>The alias of the lens.</p>
|
|
2032
2280
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2033
2281
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -2039,6 +2287,7 @@ export interface GetLensReviewReportInput {
|
|
|
2039
2287
|
*/
|
|
2040
2288
|
LensAlias: string | undefined;
|
|
2041
2289
|
/**
|
|
2290
|
+
* @public
|
|
2042
2291
|
* <p>The milestone number.</p>
|
|
2043
2292
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2044
2293
|
*/
|
|
@@ -2050,6 +2299,7 @@ export interface GetLensReviewReportInput {
|
|
|
2050
2299
|
*/
|
|
2051
2300
|
export interface LensReviewReport {
|
|
2052
2301
|
/**
|
|
2302
|
+
* @public
|
|
2053
2303
|
* <p>The alias of the lens.</p>
|
|
2054
2304
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2055
2305
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -2061,10 +2311,12 @@ export interface LensReviewReport {
|
|
|
2061
2311
|
*/
|
|
2062
2312
|
LensAlias?: string;
|
|
2063
2313
|
/**
|
|
2314
|
+
* @public
|
|
2064
2315
|
* <p>The ARN for the lens.</p>
|
|
2065
2316
|
*/
|
|
2066
2317
|
LensArn?: string;
|
|
2067
2318
|
/**
|
|
2319
|
+
* @public
|
|
2068
2320
|
* <p>The Base64-encoded string representation of a lens review report.</p>
|
|
2069
2321
|
* <p>This data can be used to create a PDF file.</p>
|
|
2070
2322
|
* <p>Only returned by <a>GetConsolidatedReport</a>
|
|
@@ -2078,15 +2330,18 @@ export interface LensReviewReport {
|
|
|
2078
2330
|
*/
|
|
2079
2331
|
export interface GetLensReviewReportOutput {
|
|
2080
2332
|
/**
|
|
2333
|
+
* @public
|
|
2081
2334
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
2082
2335
|
*/
|
|
2083
2336
|
WorkloadId?: string;
|
|
2084
2337
|
/**
|
|
2338
|
+
* @public
|
|
2085
2339
|
* <p>The milestone number.</p>
|
|
2086
2340
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2087
2341
|
*/
|
|
2088
2342
|
MilestoneNumber?: number;
|
|
2089
2343
|
/**
|
|
2344
|
+
* @public
|
|
2090
2345
|
* <p>A report of a lens review.</p>
|
|
2091
2346
|
*/
|
|
2092
2347
|
LensReviewReport?: LensReviewReport;
|
|
@@ -2096,6 +2351,7 @@ export interface GetLensReviewReportOutput {
|
|
|
2096
2351
|
*/
|
|
2097
2352
|
export interface GetLensVersionDifferenceInput {
|
|
2098
2353
|
/**
|
|
2354
|
+
* @public
|
|
2099
2355
|
* <p>The alias of the lens.</p>
|
|
2100
2356
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2101
2357
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -2107,10 +2363,12 @@ export interface GetLensVersionDifferenceInput {
|
|
|
2107
2363
|
*/
|
|
2108
2364
|
LensAlias: string | undefined;
|
|
2109
2365
|
/**
|
|
2366
|
+
* @public
|
|
2110
2367
|
* <p>The base version of the lens.</p>
|
|
2111
2368
|
*/
|
|
2112
2369
|
BaseLensVersion?: string;
|
|
2113
2370
|
/**
|
|
2371
|
+
* @public
|
|
2114
2372
|
* <p>The lens version to target a difference for.</p>
|
|
2115
2373
|
*/
|
|
2116
2374
|
TargetLensVersion?: string;
|
|
@@ -2121,14 +2379,17 @@ export interface GetLensVersionDifferenceInput {
|
|
|
2121
2379
|
*/
|
|
2122
2380
|
export interface QuestionDifference {
|
|
2123
2381
|
/**
|
|
2382
|
+
* @public
|
|
2124
2383
|
* <p>The ID of the question.</p>
|
|
2125
2384
|
*/
|
|
2126
2385
|
QuestionId?: string;
|
|
2127
2386
|
/**
|
|
2387
|
+
* @public
|
|
2128
2388
|
* <p>The title of the question.</p>
|
|
2129
2389
|
*/
|
|
2130
2390
|
QuestionTitle?: string;
|
|
2131
2391
|
/**
|
|
2392
|
+
* @public
|
|
2132
2393
|
* <p>Indicates the type of change to the question.</p>
|
|
2133
2394
|
*/
|
|
2134
2395
|
DifferenceStatus?: DifferenceStatus | string;
|
|
@@ -2139,19 +2400,23 @@ export interface QuestionDifference {
|
|
|
2139
2400
|
*/
|
|
2140
2401
|
export interface PillarDifference {
|
|
2141
2402
|
/**
|
|
2403
|
+
* @public
|
|
2142
2404
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
2143
2405
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
2144
2406
|
*/
|
|
2145
2407
|
PillarId?: string;
|
|
2146
2408
|
/**
|
|
2409
|
+
* @public
|
|
2147
2410
|
* <p>The name of the pillar.</p>
|
|
2148
2411
|
*/
|
|
2149
2412
|
PillarName?: string;
|
|
2150
2413
|
/**
|
|
2414
|
+
* @public
|
|
2151
2415
|
* <p>Indicates the type of change to the pillar.</p>
|
|
2152
2416
|
*/
|
|
2153
2417
|
DifferenceStatus?: DifferenceStatus | string;
|
|
2154
2418
|
/**
|
|
2419
|
+
* @public
|
|
2155
2420
|
* <p>List of question differences.</p>
|
|
2156
2421
|
*/
|
|
2157
2422
|
QuestionDifferences?: QuestionDifference[];
|
|
@@ -2162,6 +2427,7 @@ export interface PillarDifference {
|
|
|
2162
2427
|
*/
|
|
2163
2428
|
export interface VersionDifferences {
|
|
2164
2429
|
/**
|
|
2430
|
+
* @public
|
|
2165
2431
|
* <p>The differences between the base and latest versions of the lens.</p>
|
|
2166
2432
|
*/
|
|
2167
2433
|
PillarDifferences?: PillarDifference[];
|
|
@@ -2171,6 +2437,7 @@ export interface VersionDifferences {
|
|
|
2171
2437
|
*/
|
|
2172
2438
|
export interface GetLensVersionDifferenceOutput {
|
|
2173
2439
|
/**
|
|
2440
|
+
* @public
|
|
2174
2441
|
* <p>The alias of the lens.</p>
|
|
2175
2442
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2176
2443
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -2182,22 +2449,27 @@ export interface GetLensVersionDifferenceOutput {
|
|
|
2182
2449
|
*/
|
|
2183
2450
|
LensAlias?: string;
|
|
2184
2451
|
/**
|
|
2452
|
+
* @public
|
|
2185
2453
|
* <p>The ARN for the lens.</p>
|
|
2186
2454
|
*/
|
|
2187
2455
|
LensArn?: string;
|
|
2188
2456
|
/**
|
|
2457
|
+
* @public
|
|
2189
2458
|
* <p>The base version of the lens.</p>
|
|
2190
2459
|
*/
|
|
2191
2460
|
BaseLensVersion?: string;
|
|
2192
2461
|
/**
|
|
2462
|
+
* @public
|
|
2193
2463
|
* <p>The target lens version for the lens.</p>
|
|
2194
2464
|
*/
|
|
2195
2465
|
TargetLensVersion?: string;
|
|
2196
2466
|
/**
|
|
2467
|
+
* @public
|
|
2197
2468
|
* <p>The latest version of the lens.</p>
|
|
2198
2469
|
*/
|
|
2199
2470
|
LatestLensVersion?: string;
|
|
2200
2471
|
/**
|
|
2472
|
+
* @public
|
|
2201
2473
|
* <p>The differences between the base and latest versions of the lens.</p>
|
|
2202
2474
|
*/
|
|
2203
2475
|
VersionDifferences?: VersionDifferences;
|
|
@@ -2208,10 +2480,12 @@ export interface GetLensVersionDifferenceOutput {
|
|
|
2208
2480
|
*/
|
|
2209
2481
|
export interface GetMilestoneInput {
|
|
2210
2482
|
/**
|
|
2483
|
+
* @public
|
|
2211
2484
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
2212
2485
|
*/
|
|
2213
2486
|
WorkloadId: string | undefined;
|
|
2214
2487
|
/**
|
|
2488
|
+
* @public
|
|
2215
2489
|
* <p>The milestone number.</p>
|
|
2216
2490
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2217
2491
|
*/
|
|
@@ -2238,58 +2512,71 @@ export type WorkloadImprovementStatus = (typeof WorkloadImprovementStatus)[keyof
|
|
|
2238
2512
|
*/
|
|
2239
2513
|
export interface Workload {
|
|
2240
2514
|
/**
|
|
2515
|
+
* @public
|
|
2241
2516
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
2242
2517
|
*/
|
|
2243
2518
|
WorkloadId?: string;
|
|
2244
2519
|
/**
|
|
2520
|
+
* @public
|
|
2245
2521
|
* <p>The ARN for the workload.</p>
|
|
2246
2522
|
*/
|
|
2247
2523
|
WorkloadArn?: string;
|
|
2248
2524
|
/**
|
|
2525
|
+
* @public
|
|
2249
2526
|
* <p>The name of the workload.</p>
|
|
2250
2527
|
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
2251
2528
|
* are ignored when checking for uniqueness.</p>
|
|
2252
2529
|
*/
|
|
2253
2530
|
WorkloadName?: string;
|
|
2254
2531
|
/**
|
|
2532
|
+
* @public
|
|
2255
2533
|
* <p>The description for the workload.</p>
|
|
2256
2534
|
*/
|
|
2257
2535
|
Description?: string;
|
|
2258
2536
|
/**
|
|
2537
|
+
* @public
|
|
2259
2538
|
* <p>The environment for the workload.</p>
|
|
2260
2539
|
*/
|
|
2261
2540
|
Environment?: WorkloadEnvironment | string;
|
|
2262
2541
|
/**
|
|
2542
|
+
* @public
|
|
2263
2543
|
* <p>The date and time recorded.</p>
|
|
2264
2544
|
*/
|
|
2265
2545
|
UpdatedAt?: Date;
|
|
2266
2546
|
/**
|
|
2547
|
+
* @public
|
|
2267
2548
|
* <p>The list of Amazon Web Services account IDs associated with the workload.</p>
|
|
2268
2549
|
*/
|
|
2269
2550
|
AccountIds?: string[];
|
|
2270
2551
|
/**
|
|
2552
|
+
* @public
|
|
2271
2553
|
* <p>The list of Amazon Web Services Regions associated with the workload, for example,
|
|
2272
2554
|
* <code>us-east-2</code>, or <code>ca-central-1</code>.</p>
|
|
2273
2555
|
*/
|
|
2274
2556
|
AwsRegions?: string[];
|
|
2275
2557
|
/**
|
|
2558
|
+
* @public
|
|
2276
2559
|
* <p> The list of non-Amazon Web Services Regions associated with the workload.</p>
|
|
2277
2560
|
*/
|
|
2278
2561
|
NonAwsRegions?: string[];
|
|
2279
2562
|
/**
|
|
2563
|
+
* @public
|
|
2280
2564
|
* <p>The URL of the architectural design for the workload.</p>
|
|
2281
2565
|
*/
|
|
2282
2566
|
ArchitecturalDesign?: string;
|
|
2283
2567
|
/**
|
|
2568
|
+
* @public
|
|
2284
2569
|
* <p>The review owner of the workload. The name, email address, or identifier for the
|
|
2285
2570
|
* primary group or individual that owns the workload review process.</p>
|
|
2286
2571
|
*/
|
|
2287
2572
|
ReviewOwner?: string;
|
|
2288
2573
|
/**
|
|
2574
|
+
* @public
|
|
2289
2575
|
* <p>The date and time recorded.</p>
|
|
2290
2576
|
*/
|
|
2291
2577
|
ReviewRestrictionDate?: Date;
|
|
2292
2578
|
/**
|
|
2579
|
+
* @public
|
|
2293
2580
|
* <p>Flag indicating whether the workload owner has acknowledged that the <i>Review
|
|
2294
2581
|
* owner</i> field is required.</p>
|
|
2295
2582
|
* <p>If a <b>Review owner</b> is not added to the workload within
|
|
@@ -2298,6 +2585,7 @@ export interface Workload {
|
|
|
2298
2585
|
*/
|
|
2299
2586
|
IsReviewOwnerUpdateAcknowledged?: boolean;
|
|
2300
2587
|
/**
|
|
2588
|
+
* @public
|
|
2301
2589
|
* <p>The industry type for the workload.</p>
|
|
2302
2590
|
* <p>If specified, must be one of the following:</p>
|
|
2303
2591
|
* <ul>
|
|
@@ -2440,55 +2728,68 @@ export interface Workload {
|
|
|
2440
2728
|
*/
|
|
2441
2729
|
IndustryType?: string;
|
|
2442
2730
|
/**
|
|
2731
|
+
* @public
|
|
2443
2732
|
* <p>The industry for the workload.</p>
|
|
2444
2733
|
*/
|
|
2445
2734
|
Industry?: string;
|
|
2446
2735
|
/**
|
|
2736
|
+
* @public
|
|
2447
2737
|
* <p>The notes associated with the workload.</p>
|
|
2448
2738
|
*/
|
|
2449
2739
|
Notes?: string;
|
|
2450
2740
|
/**
|
|
2741
|
+
* @public
|
|
2451
2742
|
* <p>The improvement status for a workload.</p>
|
|
2452
2743
|
*/
|
|
2453
2744
|
ImprovementStatus?: WorkloadImprovementStatus | string;
|
|
2454
2745
|
/**
|
|
2746
|
+
* @public
|
|
2455
2747
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
2456
2748
|
*/
|
|
2457
2749
|
RiskCounts?: Record<string, number>;
|
|
2458
2750
|
/**
|
|
2751
|
+
* @public
|
|
2459
2752
|
* <p>The priorities of the pillars, which are used to order items in the improvement plan.
|
|
2460
2753
|
* Each pillar is represented by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
2461
2754
|
*/
|
|
2462
2755
|
PillarPriorities?: string[];
|
|
2463
2756
|
/**
|
|
2757
|
+
* @public
|
|
2464
2758
|
* <p>The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2465
2759
|
*/
|
|
2466
2760
|
Lenses?: string[];
|
|
2467
2761
|
/**
|
|
2762
|
+
* @public
|
|
2468
2763
|
* <p>An Amazon Web Services account ID.</p>
|
|
2469
2764
|
*/
|
|
2470
2765
|
Owner?: string;
|
|
2471
2766
|
/**
|
|
2767
|
+
* @public
|
|
2472
2768
|
* <p>The ID assigned to the share invitation.</p>
|
|
2473
2769
|
*/
|
|
2474
2770
|
ShareInvitationId?: string;
|
|
2475
2771
|
/**
|
|
2772
|
+
* @public
|
|
2476
2773
|
* <p>The tags associated with the workload.</p>
|
|
2477
2774
|
*/
|
|
2478
2775
|
Tags?: Record<string, string>;
|
|
2479
2776
|
/**
|
|
2777
|
+
* @public
|
|
2480
2778
|
* <p>Discovery configuration associated to the workload.</p>
|
|
2481
2779
|
*/
|
|
2482
2780
|
DiscoveryConfig?: WorkloadDiscoveryConfig;
|
|
2483
2781
|
/**
|
|
2782
|
+
* @public
|
|
2484
2783
|
* <p>List of AppRegistry application ARNs associated to the workload.</p>
|
|
2485
2784
|
*/
|
|
2486
2785
|
Applications?: string[];
|
|
2487
2786
|
/**
|
|
2787
|
+
* @public
|
|
2488
2788
|
* <p>Profile associated with a workload.</p>
|
|
2489
2789
|
*/
|
|
2490
2790
|
Profiles?: WorkloadProfile[];
|
|
2491
2791
|
/**
|
|
2792
|
+
* @public
|
|
2492
2793
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
2493
2794
|
*/
|
|
2494
2795
|
PrioritizedRiskCounts?: Record<string, number>;
|
|
@@ -2499,20 +2800,24 @@ export interface Workload {
|
|
|
2499
2800
|
*/
|
|
2500
2801
|
export interface Milestone {
|
|
2501
2802
|
/**
|
|
2803
|
+
* @public
|
|
2502
2804
|
* <p>The milestone number.</p>
|
|
2503
2805
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
2504
2806
|
*/
|
|
2505
2807
|
MilestoneNumber?: number;
|
|
2506
2808
|
/**
|
|
2809
|
+
* @public
|
|
2507
2810
|
* <p>The name of the milestone in a workload.</p>
|
|
2508
2811
|
* <p>Milestone names must be unique within a workload.</p>
|
|
2509
2812
|
*/
|
|
2510
2813
|
MilestoneName?: string;
|
|
2511
2814
|
/**
|
|
2815
|
+
* @public
|
|
2512
2816
|
* <p>The date and time recorded.</p>
|
|
2513
2817
|
*/
|
|
2514
2818
|
RecordedAt?: Date;
|
|
2515
2819
|
/**
|
|
2820
|
+
* @public
|
|
2516
2821
|
* <p>A workload return object.</p>
|
|
2517
2822
|
*/
|
|
2518
2823
|
Workload?: Workload;
|
|
@@ -2523,10 +2828,12 @@ export interface Milestone {
|
|
|
2523
2828
|
*/
|
|
2524
2829
|
export interface GetMilestoneOutput {
|
|
2525
2830
|
/**
|
|
2831
|
+
* @public
|
|
2526
2832
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
2527
2833
|
*/
|
|
2528
2834
|
WorkloadId?: string;
|
|
2529
2835
|
/**
|
|
2836
|
+
* @public
|
|
2530
2837
|
* <p>A milestone return object.</p>
|
|
2531
2838
|
*/
|
|
2532
2839
|
Milestone?: Milestone;
|
|
@@ -2536,10 +2843,12 @@ export interface GetMilestoneOutput {
|
|
|
2536
2843
|
*/
|
|
2537
2844
|
export interface GetProfileInput {
|
|
2538
2845
|
/**
|
|
2846
|
+
* @public
|
|
2539
2847
|
* <p>The profile ARN.</p>
|
|
2540
2848
|
*/
|
|
2541
2849
|
ProfileArn: string | undefined;
|
|
2542
2850
|
/**
|
|
2851
|
+
* @public
|
|
2543
2852
|
* <p>The profile version.</p>
|
|
2544
2853
|
*/
|
|
2545
2854
|
ProfileVersion?: string;
|
|
@@ -2550,14 +2859,17 @@ export interface GetProfileInput {
|
|
|
2550
2859
|
*/
|
|
2551
2860
|
export interface ProfileChoice {
|
|
2552
2861
|
/**
|
|
2862
|
+
* @public
|
|
2553
2863
|
* <p>The ID of a choice.</p>
|
|
2554
2864
|
*/
|
|
2555
2865
|
ChoiceId?: string;
|
|
2556
2866
|
/**
|
|
2867
|
+
* @public
|
|
2557
2868
|
* <p>The title of a choice.</p>
|
|
2558
2869
|
*/
|
|
2559
2870
|
ChoiceTitle?: string;
|
|
2560
2871
|
/**
|
|
2872
|
+
* @public
|
|
2561
2873
|
* <p>The description of a choice.</p>
|
|
2562
2874
|
*/
|
|
2563
2875
|
ChoiceDescription?: string;
|
|
@@ -2568,30 +2880,37 @@ export interface ProfileChoice {
|
|
|
2568
2880
|
*/
|
|
2569
2881
|
export interface ProfileQuestion {
|
|
2570
2882
|
/**
|
|
2883
|
+
* @public
|
|
2571
2884
|
* <p>The ID of the question.</p>
|
|
2572
2885
|
*/
|
|
2573
2886
|
QuestionId?: string;
|
|
2574
2887
|
/**
|
|
2888
|
+
* @public
|
|
2575
2889
|
* <p>The title of the question.</p>
|
|
2576
2890
|
*/
|
|
2577
2891
|
QuestionTitle?: string;
|
|
2578
2892
|
/**
|
|
2893
|
+
* @public
|
|
2579
2894
|
* <p>The description of the question.</p>
|
|
2580
2895
|
*/
|
|
2581
2896
|
QuestionDescription?: string;
|
|
2582
2897
|
/**
|
|
2898
|
+
* @public
|
|
2583
2899
|
* <p>The question choices.</p>
|
|
2584
2900
|
*/
|
|
2585
2901
|
QuestionChoices?: ProfileChoice[];
|
|
2586
2902
|
/**
|
|
2903
|
+
* @public
|
|
2587
2904
|
* <p>The selected choices.</p>
|
|
2588
2905
|
*/
|
|
2589
2906
|
SelectedChoiceIds?: string[];
|
|
2590
2907
|
/**
|
|
2908
|
+
* @public
|
|
2591
2909
|
* <p>The minimum number of selected choices.</p>
|
|
2592
2910
|
*/
|
|
2593
2911
|
MinSelectedChoices?: number;
|
|
2594
2912
|
/**
|
|
2913
|
+
* @public
|
|
2595
2914
|
* <p>The maximum number of selected choices.</p>
|
|
2596
2915
|
*/
|
|
2597
2916
|
MaxSelectedChoices?: number;
|
|
@@ -2602,42 +2921,52 @@ export interface ProfileQuestion {
|
|
|
2602
2921
|
*/
|
|
2603
2922
|
export interface Profile {
|
|
2604
2923
|
/**
|
|
2924
|
+
* @public
|
|
2605
2925
|
* <p>The profile ARN.</p>
|
|
2606
2926
|
*/
|
|
2607
2927
|
ProfileArn?: string;
|
|
2608
2928
|
/**
|
|
2929
|
+
* @public
|
|
2609
2930
|
* <p>The profile version.</p>
|
|
2610
2931
|
*/
|
|
2611
2932
|
ProfileVersion?: string;
|
|
2612
2933
|
/**
|
|
2934
|
+
* @public
|
|
2613
2935
|
* <p>The profile name.</p>
|
|
2614
2936
|
*/
|
|
2615
2937
|
ProfileName?: string;
|
|
2616
2938
|
/**
|
|
2939
|
+
* @public
|
|
2617
2940
|
* <p>The profile description.</p>
|
|
2618
2941
|
*/
|
|
2619
2942
|
ProfileDescription?: string;
|
|
2620
2943
|
/**
|
|
2944
|
+
* @public
|
|
2621
2945
|
* <p>Profile questions.</p>
|
|
2622
2946
|
*/
|
|
2623
2947
|
ProfileQuestions?: ProfileQuestion[];
|
|
2624
2948
|
/**
|
|
2949
|
+
* @public
|
|
2625
2950
|
* <p>An Amazon Web Services account ID.</p>
|
|
2626
2951
|
*/
|
|
2627
2952
|
Owner?: string;
|
|
2628
2953
|
/**
|
|
2954
|
+
* @public
|
|
2629
2955
|
* <p>The date and time recorded.</p>
|
|
2630
2956
|
*/
|
|
2631
2957
|
CreatedAt?: Date;
|
|
2632
2958
|
/**
|
|
2959
|
+
* @public
|
|
2633
2960
|
* <p>The date and time recorded.</p>
|
|
2634
2961
|
*/
|
|
2635
2962
|
UpdatedAt?: Date;
|
|
2636
2963
|
/**
|
|
2964
|
+
* @public
|
|
2637
2965
|
* <p>The ID assigned to the share invitation.</p>
|
|
2638
2966
|
*/
|
|
2639
2967
|
ShareInvitationId?: string;
|
|
2640
2968
|
/**
|
|
2969
|
+
* @public
|
|
2641
2970
|
* <p>The tags assigned to the profile.</p>
|
|
2642
2971
|
*/
|
|
2643
2972
|
Tags?: Record<string, string>;
|
|
@@ -2647,6 +2976,7 @@ export interface Profile {
|
|
|
2647
2976
|
*/
|
|
2648
2977
|
export interface GetProfileOutput {
|
|
2649
2978
|
/**
|
|
2979
|
+
* @public
|
|
2650
2980
|
* <p>The profile.</p>
|
|
2651
2981
|
*/
|
|
2652
2982
|
Profile?: Profile;
|
|
@@ -2662,14 +2992,17 @@ export interface GetProfileTemplateInput {
|
|
|
2662
2992
|
*/
|
|
2663
2993
|
export interface ProfileTemplateChoice {
|
|
2664
2994
|
/**
|
|
2995
|
+
* @public
|
|
2665
2996
|
* <p>The ID of a choice.</p>
|
|
2666
2997
|
*/
|
|
2667
2998
|
ChoiceId?: string;
|
|
2668
2999
|
/**
|
|
3000
|
+
* @public
|
|
2669
3001
|
* <p>The title of a choice.</p>
|
|
2670
3002
|
*/
|
|
2671
3003
|
ChoiceTitle?: string;
|
|
2672
3004
|
/**
|
|
3005
|
+
* @public
|
|
2673
3006
|
* <p>The description of a choice.</p>
|
|
2674
3007
|
*/
|
|
2675
3008
|
ChoiceDescription?: string;
|
|
@@ -2680,26 +3013,32 @@ export interface ProfileTemplateChoice {
|
|
|
2680
3013
|
*/
|
|
2681
3014
|
export interface ProfileTemplateQuestion {
|
|
2682
3015
|
/**
|
|
3016
|
+
* @public
|
|
2683
3017
|
* <p>The ID of the question.</p>
|
|
2684
3018
|
*/
|
|
2685
3019
|
QuestionId?: string;
|
|
2686
3020
|
/**
|
|
3021
|
+
* @public
|
|
2687
3022
|
* <p>The title of the question.</p>
|
|
2688
3023
|
*/
|
|
2689
3024
|
QuestionTitle?: string;
|
|
2690
3025
|
/**
|
|
3026
|
+
* @public
|
|
2691
3027
|
* <p>The description of the question.</p>
|
|
2692
3028
|
*/
|
|
2693
3029
|
QuestionDescription?: string;
|
|
2694
3030
|
/**
|
|
3031
|
+
* @public
|
|
2695
3032
|
* <p>The question choices.</p>
|
|
2696
3033
|
*/
|
|
2697
3034
|
QuestionChoices?: ProfileTemplateChoice[];
|
|
2698
3035
|
/**
|
|
3036
|
+
* @public
|
|
2699
3037
|
* <p>The minimum number of choices selected.</p>
|
|
2700
3038
|
*/
|
|
2701
3039
|
MinSelectedChoices?: number;
|
|
2702
3040
|
/**
|
|
3041
|
+
* @public
|
|
2703
3042
|
* <p>The maximum number of choices selected.</p>
|
|
2704
3043
|
*/
|
|
2705
3044
|
MaxSelectedChoices?: number;
|
|
@@ -2710,18 +3049,22 @@ export interface ProfileTemplateQuestion {
|
|
|
2710
3049
|
*/
|
|
2711
3050
|
export interface ProfileTemplate {
|
|
2712
3051
|
/**
|
|
3052
|
+
* @public
|
|
2713
3053
|
* <p>The name of the profile template.</p>
|
|
2714
3054
|
*/
|
|
2715
3055
|
TemplateName?: string;
|
|
2716
3056
|
/**
|
|
3057
|
+
* @public
|
|
2717
3058
|
* <p>Profile template questions.</p>
|
|
2718
3059
|
*/
|
|
2719
3060
|
TemplateQuestions?: ProfileTemplateQuestion[];
|
|
2720
3061
|
/**
|
|
3062
|
+
* @public
|
|
2721
3063
|
* <p>The date and time recorded.</p>
|
|
2722
3064
|
*/
|
|
2723
3065
|
CreatedAt?: Date;
|
|
2724
3066
|
/**
|
|
3067
|
+
* @public
|
|
2725
3068
|
* <p>The date and time recorded.</p>
|
|
2726
3069
|
*/
|
|
2727
3070
|
UpdatedAt?: Date;
|
|
@@ -2731,6 +3074,7 @@ export interface ProfileTemplate {
|
|
|
2731
3074
|
*/
|
|
2732
3075
|
export interface GetProfileTemplateOutput {
|
|
2733
3076
|
/**
|
|
3077
|
+
* @public
|
|
2734
3078
|
* <p>The profile template.</p>
|
|
2735
3079
|
*/
|
|
2736
3080
|
ProfileTemplate?: ProfileTemplate;
|
|
@@ -2741,6 +3085,7 @@ export interface GetProfileTemplateOutput {
|
|
|
2741
3085
|
*/
|
|
2742
3086
|
export interface GetWorkloadInput {
|
|
2743
3087
|
/**
|
|
3088
|
+
* @public
|
|
2744
3089
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
2745
3090
|
*/
|
|
2746
3091
|
WorkloadId: string | undefined;
|
|
@@ -2751,6 +3096,7 @@ export interface GetWorkloadInput {
|
|
|
2751
3096
|
*/
|
|
2752
3097
|
export interface GetWorkloadOutput {
|
|
2753
3098
|
/**
|
|
3099
|
+
* @public
|
|
2754
3100
|
* <p>A workload return object.</p>
|
|
2755
3101
|
*/
|
|
2756
3102
|
Workload?: Workload;
|
|
@@ -2760,6 +3106,7 @@ export interface GetWorkloadOutput {
|
|
|
2760
3106
|
*/
|
|
2761
3107
|
export interface ImportLensInput {
|
|
2762
3108
|
/**
|
|
3109
|
+
* @public
|
|
2763
3110
|
* <p>The alias of the lens.</p>
|
|
2764
3111
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2765
3112
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -2771,10 +3118,12 @@ export interface ImportLensInput {
|
|
|
2771
3118
|
*/
|
|
2772
3119
|
LensAlias?: string;
|
|
2773
3120
|
/**
|
|
3121
|
+
* @public
|
|
2774
3122
|
* <p>The JSON representation of a lens.</p>
|
|
2775
3123
|
*/
|
|
2776
3124
|
JSONString: string | undefined;
|
|
2777
3125
|
/**
|
|
3126
|
+
* @public
|
|
2778
3127
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
2779
3128
|
* (executes only once).</p>
|
|
2780
3129
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -2788,6 +3137,7 @@ export interface ImportLensInput {
|
|
|
2788
3137
|
*/
|
|
2789
3138
|
ClientRequestToken?: string;
|
|
2790
3139
|
/**
|
|
3140
|
+
* @public
|
|
2791
3141
|
* <p>Tags to associate to a lens.</p>
|
|
2792
3142
|
*/
|
|
2793
3143
|
Tags?: Record<string, string>;
|
|
@@ -2810,10 +3160,12 @@ export type ImportLensStatus = (typeof ImportLensStatus)[keyof typeof ImportLens
|
|
|
2810
3160
|
*/
|
|
2811
3161
|
export interface ImportLensOutput {
|
|
2812
3162
|
/**
|
|
3163
|
+
* @public
|
|
2813
3164
|
* <p>The ARN for the lens that was created or updated.</p>
|
|
2814
3165
|
*/
|
|
2815
3166
|
LensArn?: string;
|
|
2816
3167
|
/**
|
|
3168
|
+
* @public
|
|
2817
3169
|
* <p>The status of the imported lens.</p>
|
|
2818
3170
|
*/
|
|
2819
3171
|
Status?: ImportLensStatus | string;
|
|
@@ -2824,29 +3176,35 @@ export interface ImportLensOutput {
|
|
|
2824
3176
|
*/
|
|
2825
3177
|
export interface ImprovementSummary {
|
|
2826
3178
|
/**
|
|
3179
|
+
* @public
|
|
2827
3180
|
* <p>The ID of the question.</p>
|
|
2828
3181
|
*/
|
|
2829
3182
|
QuestionId?: string;
|
|
2830
3183
|
/**
|
|
3184
|
+
* @public
|
|
2831
3185
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
2832
3186
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
2833
3187
|
*/
|
|
2834
3188
|
PillarId?: string;
|
|
2835
3189
|
/**
|
|
3190
|
+
* @public
|
|
2836
3191
|
* <p>The title of the question.</p>
|
|
2837
3192
|
*/
|
|
2838
3193
|
QuestionTitle?: string;
|
|
2839
3194
|
/**
|
|
3195
|
+
* @public
|
|
2840
3196
|
* <p>The risk for a given workload, lens review, pillar, or question.</p>
|
|
2841
3197
|
*/
|
|
2842
3198
|
Risk?: Risk | string;
|
|
2843
3199
|
/**
|
|
3200
|
+
* @public
|
|
2844
3201
|
* <p>The improvement plan URL for a question in an Amazon Web Services official lenses.</p>
|
|
2845
3202
|
* <p>This value is only available if the question has been answered.</p>
|
|
2846
3203
|
* <p>This value does not apply to custom lenses.</p>
|
|
2847
3204
|
*/
|
|
2848
3205
|
ImprovementPlanUrl?: string;
|
|
2849
3206
|
/**
|
|
3207
|
+
* @public
|
|
2850
3208
|
* <p>The improvement plan details.</p>
|
|
2851
3209
|
*/
|
|
2852
3210
|
ImprovementPlans?: ChoiceImprovementPlan[];
|
|
@@ -2857,6 +3215,7 @@ export interface ImprovementSummary {
|
|
|
2857
3215
|
*/
|
|
2858
3216
|
export interface LensReviewSummary {
|
|
2859
3217
|
/**
|
|
3218
|
+
* @public
|
|
2860
3219
|
* <p>The alias of the lens.</p>
|
|
2861
3220
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2862
3221
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -2868,34 +3227,42 @@ export interface LensReviewSummary {
|
|
|
2868
3227
|
*/
|
|
2869
3228
|
LensAlias?: string;
|
|
2870
3229
|
/**
|
|
3230
|
+
* @public
|
|
2871
3231
|
* <p>The ARN for the lens.</p>
|
|
2872
3232
|
*/
|
|
2873
3233
|
LensArn?: string;
|
|
2874
3234
|
/**
|
|
3235
|
+
* @public
|
|
2875
3236
|
* <p>The version of the lens.</p>
|
|
2876
3237
|
*/
|
|
2877
3238
|
LensVersion?: string;
|
|
2878
3239
|
/**
|
|
3240
|
+
* @public
|
|
2879
3241
|
* <p>The full name of the lens.</p>
|
|
2880
3242
|
*/
|
|
2881
3243
|
LensName?: string;
|
|
2882
3244
|
/**
|
|
3245
|
+
* @public
|
|
2883
3246
|
* <p>The status of the lens.</p>
|
|
2884
3247
|
*/
|
|
2885
3248
|
LensStatus?: LensStatus | string;
|
|
2886
3249
|
/**
|
|
3250
|
+
* @public
|
|
2887
3251
|
* <p>The date and time recorded.</p>
|
|
2888
3252
|
*/
|
|
2889
3253
|
UpdatedAt?: Date;
|
|
2890
3254
|
/**
|
|
3255
|
+
* @public
|
|
2891
3256
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
2892
3257
|
*/
|
|
2893
3258
|
RiskCounts?: Record<string, number>;
|
|
2894
3259
|
/**
|
|
3260
|
+
* @public
|
|
2895
3261
|
* <p>The profiles associated with the workload.</p>
|
|
2896
3262
|
*/
|
|
2897
3263
|
Profiles?: WorkloadProfile[];
|
|
2898
3264
|
/**
|
|
3265
|
+
* @public
|
|
2899
3266
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
2900
3267
|
*/
|
|
2901
3268
|
PrioritizedRiskCounts?: Record<string, number>;
|
|
@@ -2924,18 +3291,22 @@ export type ShareStatus = (typeof ShareStatus)[keyof typeof ShareStatus];
|
|
|
2924
3291
|
*/
|
|
2925
3292
|
export interface LensShareSummary {
|
|
2926
3293
|
/**
|
|
3294
|
+
* @public
|
|
2927
3295
|
* <p>The ID associated with the share.</p>
|
|
2928
3296
|
*/
|
|
2929
3297
|
ShareId?: string;
|
|
2930
3298
|
/**
|
|
3299
|
+
* @public
|
|
2931
3300
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.</p>
|
|
2932
3301
|
*/
|
|
2933
3302
|
SharedWith?: string;
|
|
2934
3303
|
/**
|
|
3304
|
+
* @public
|
|
2935
3305
|
* <p>The status of the share request.</p>
|
|
2936
3306
|
*/
|
|
2937
3307
|
Status?: ShareStatus | string;
|
|
2938
3308
|
/**
|
|
3309
|
+
* @public
|
|
2939
3310
|
* <p>Optional message to compliment the Status field.</p>
|
|
2940
3311
|
*/
|
|
2941
3312
|
StatusMessage?: string;
|
|
@@ -2959,10 +3330,12 @@ export type LensType = (typeof LensType)[keyof typeof LensType];
|
|
|
2959
3330
|
*/
|
|
2960
3331
|
export interface LensSummary {
|
|
2961
3332
|
/**
|
|
3333
|
+
* @public
|
|
2962
3334
|
* <p>The ARN of the lens.</p>
|
|
2963
3335
|
*/
|
|
2964
3336
|
LensArn?: string;
|
|
2965
3337
|
/**
|
|
3338
|
+
* @public
|
|
2966
3339
|
* <p>The alias of the lens.</p>
|
|
2967
3340
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
2968
3341
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -2974,34 +3347,42 @@ export interface LensSummary {
|
|
|
2974
3347
|
*/
|
|
2975
3348
|
LensAlias?: string;
|
|
2976
3349
|
/**
|
|
3350
|
+
* @public
|
|
2977
3351
|
* <p>The full name of the lens.</p>
|
|
2978
3352
|
*/
|
|
2979
3353
|
LensName?: string;
|
|
2980
3354
|
/**
|
|
3355
|
+
* @public
|
|
2981
3356
|
* <p>The type of the lens.</p>
|
|
2982
3357
|
*/
|
|
2983
3358
|
LensType?: LensType | string;
|
|
2984
3359
|
/**
|
|
3360
|
+
* @public
|
|
2985
3361
|
* <p>The description of the lens.</p>
|
|
2986
3362
|
*/
|
|
2987
3363
|
Description?: string;
|
|
2988
3364
|
/**
|
|
3365
|
+
* @public
|
|
2989
3366
|
* <p>The date and time recorded.</p>
|
|
2990
3367
|
*/
|
|
2991
3368
|
CreatedAt?: Date;
|
|
2992
3369
|
/**
|
|
3370
|
+
* @public
|
|
2993
3371
|
* <p>The date and time recorded.</p>
|
|
2994
3372
|
*/
|
|
2995
3373
|
UpdatedAt?: Date;
|
|
2996
3374
|
/**
|
|
3375
|
+
* @public
|
|
2997
3376
|
* <p>The version of the lens.</p>
|
|
2998
3377
|
*/
|
|
2999
3378
|
LensVersion?: string;
|
|
3000
3379
|
/**
|
|
3380
|
+
* @public
|
|
3001
3381
|
* <p>An Amazon Web Services account ID.</p>
|
|
3002
3382
|
*/
|
|
3003
3383
|
Owner?: string;
|
|
3004
3384
|
/**
|
|
3385
|
+
* @public
|
|
3005
3386
|
* <p>The status of the lens.</p>
|
|
3006
3387
|
*/
|
|
3007
3388
|
LensStatus?: LensStatus | string;
|
|
@@ -3012,16 +3393,19 @@ export interface LensSummary {
|
|
|
3012
3393
|
*/
|
|
3013
3394
|
export interface LensUpgradeSummary {
|
|
3014
3395
|
/**
|
|
3396
|
+
* @public
|
|
3015
3397
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3016
3398
|
*/
|
|
3017
3399
|
WorkloadId?: string;
|
|
3018
3400
|
/**
|
|
3401
|
+
* @public
|
|
3019
3402
|
* <p>The name of the workload.</p>
|
|
3020
3403
|
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
3021
3404
|
* are ignored when checking for uniqueness.</p>
|
|
3022
3405
|
*/
|
|
3023
3406
|
WorkloadName?: string;
|
|
3024
3407
|
/**
|
|
3408
|
+
* @public
|
|
3025
3409
|
* <p>The alias of the lens.</p>
|
|
3026
3410
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3027
3411
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -3033,14 +3417,17 @@ export interface LensUpgradeSummary {
|
|
|
3033
3417
|
*/
|
|
3034
3418
|
LensAlias?: string;
|
|
3035
3419
|
/**
|
|
3420
|
+
* @public
|
|
3036
3421
|
* <p>The ARN for the lens.</p>
|
|
3037
3422
|
*/
|
|
3038
3423
|
LensArn?: string;
|
|
3039
3424
|
/**
|
|
3425
|
+
* @public
|
|
3040
3426
|
* <p>The current version of the lens.</p>
|
|
3041
3427
|
*/
|
|
3042
3428
|
CurrentLensVersion?: string;
|
|
3043
3429
|
/**
|
|
3430
|
+
* @public
|
|
3044
3431
|
* <p>The latest version of the lens.</p>
|
|
3045
3432
|
*/
|
|
3046
3433
|
LatestLensVersion?: string;
|
|
@@ -3063,10 +3450,12 @@ export type QuestionPriority = (typeof QuestionPriority)[keyof typeof QuestionPr
|
|
|
3063
3450
|
*/
|
|
3064
3451
|
export interface ListAnswersInput {
|
|
3065
3452
|
/**
|
|
3453
|
+
* @public
|
|
3066
3454
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3067
3455
|
*/
|
|
3068
3456
|
WorkloadId: string | undefined;
|
|
3069
3457
|
/**
|
|
3458
|
+
* @public
|
|
3070
3459
|
* <p>The alias of the lens.</p>
|
|
3071
3460
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3072
3461
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -3078,24 +3467,29 @@ export interface ListAnswersInput {
|
|
|
3078
3467
|
*/
|
|
3079
3468
|
LensAlias: string | undefined;
|
|
3080
3469
|
/**
|
|
3470
|
+
* @public
|
|
3081
3471
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
3082
3472
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
3083
3473
|
*/
|
|
3084
3474
|
PillarId?: string;
|
|
3085
3475
|
/**
|
|
3476
|
+
* @public
|
|
3086
3477
|
* <p>The milestone number.</p>
|
|
3087
3478
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
3088
3479
|
*/
|
|
3089
3480
|
MilestoneNumber?: number;
|
|
3090
3481
|
/**
|
|
3482
|
+
* @public
|
|
3091
3483
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3092
3484
|
*/
|
|
3093
3485
|
NextToken?: string;
|
|
3094
3486
|
/**
|
|
3487
|
+
* @public
|
|
3095
3488
|
* <p>The maximum number of results to return for this request.</p>
|
|
3096
3489
|
*/
|
|
3097
3490
|
MaxResults?: number;
|
|
3098
3491
|
/**
|
|
3492
|
+
* @public
|
|
3099
3493
|
* <p>The priority of the question.</p>
|
|
3100
3494
|
*/
|
|
3101
3495
|
QuestionPriority?: QuestionPriority | string;
|
|
@@ -3106,15 +3500,18 @@ export interface ListAnswersInput {
|
|
|
3106
3500
|
*/
|
|
3107
3501
|
export interface ListAnswersOutput {
|
|
3108
3502
|
/**
|
|
3503
|
+
* @public
|
|
3109
3504
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3110
3505
|
*/
|
|
3111
3506
|
WorkloadId?: string;
|
|
3112
3507
|
/**
|
|
3508
|
+
* @public
|
|
3113
3509
|
* <p>The milestone number.</p>
|
|
3114
3510
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
3115
3511
|
*/
|
|
3116
3512
|
MilestoneNumber?: number;
|
|
3117
3513
|
/**
|
|
3514
|
+
* @public
|
|
3118
3515
|
* <p>The alias of the lens.</p>
|
|
3119
3516
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3120
3517
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -3126,14 +3523,17 @@ export interface ListAnswersOutput {
|
|
|
3126
3523
|
*/
|
|
3127
3524
|
LensAlias?: string;
|
|
3128
3525
|
/**
|
|
3526
|
+
* @public
|
|
3129
3527
|
* <p>The ARN for the lens.</p>
|
|
3130
3528
|
*/
|
|
3131
3529
|
LensArn?: string;
|
|
3132
3530
|
/**
|
|
3531
|
+
* @public
|
|
3133
3532
|
* <p>List of answer summaries of lens review in a workload.</p>
|
|
3134
3533
|
*/
|
|
3135
3534
|
AnswerSummaries?: AnswerSummary[];
|
|
3136
3535
|
/**
|
|
3536
|
+
* @public
|
|
3137
3537
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3138
3538
|
*/
|
|
3139
3539
|
NextToken?: string;
|
|
@@ -3143,31 +3543,38 @@ export interface ListAnswersOutput {
|
|
|
3143
3543
|
*/
|
|
3144
3544
|
export interface ListCheckDetailsInput {
|
|
3145
3545
|
/**
|
|
3546
|
+
* @public
|
|
3146
3547
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3147
3548
|
*/
|
|
3148
3549
|
WorkloadId: string | undefined;
|
|
3149
3550
|
/**
|
|
3551
|
+
* @public
|
|
3150
3552
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3151
3553
|
*/
|
|
3152
3554
|
NextToken?: string;
|
|
3153
3555
|
/**
|
|
3556
|
+
* @public
|
|
3154
3557
|
* <p>The maximum number of results to return for this request.</p>
|
|
3155
3558
|
*/
|
|
3156
3559
|
MaxResults?: number;
|
|
3157
3560
|
/**
|
|
3561
|
+
* @public
|
|
3158
3562
|
* <p>Well-Architected Lens ARN.</p>
|
|
3159
3563
|
*/
|
|
3160
3564
|
LensArn: string | undefined;
|
|
3161
3565
|
/**
|
|
3566
|
+
* @public
|
|
3162
3567
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
3163
3568
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
3164
3569
|
*/
|
|
3165
3570
|
PillarId: string | undefined;
|
|
3166
3571
|
/**
|
|
3572
|
+
* @public
|
|
3167
3573
|
* <p>The ID of the question.</p>
|
|
3168
3574
|
*/
|
|
3169
3575
|
QuestionId: string | undefined;
|
|
3170
3576
|
/**
|
|
3577
|
+
* @public
|
|
3171
3578
|
* <p>The ID of a choice.</p>
|
|
3172
3579
|
*/
|
|
3173
3580
|
ChoiceId: string | undefined;
|
|
@@ -3177,10 +3584,12 @@ export interface ListCheckDetailsInput {
|
|
|
3177
3584
|
*/
|
|
3178
3585
|
export interface ListCheckDetailsOutput {
|
|
3179
3586
|
/**
|
|
3587
|
+
* @public
|
|
3180
3588
|
* <p>The details about the Trusted Advisor checks related to the Well-Architected best practice.</p>
|
|
3181
3589
|
*/
|
|
3182
3590
|
CheckDetails?: CheckDetail[];
|
|
3183
3591
|
/**
|
|
3592
|
+
* @public
|
|
3184
3593
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3185
3594
|
*/
|
|
3186
3595
|
NextToken?: string;
|
|
@@ -3190,31 +3599,38 @@ export interface ListCheckDetailsOutput {
|
|
|
3190
3599
|
*/
|
|
3191
3600
|
export interface ListCheckSummariesInput {
|
|
3192
3601
|
/**
|
|
3602
|
+
* @public
|
|
3193
3603
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3194
3604
|
*/
|
|
3195
3605
|
WorkloadId: string | undefined;
|
|
3196
3606
|
/**
|
|
3607
|
+
* @public
|
|
3197
3608
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3198
3609
|
*/
|
|
3199
3610
|
NextToken?: string;
|
|
3200
3611
|
/**
|
|
3612
|
+
* @public
|
|
3201
3613
|
* <p>The maximum number of results to return for this request.</p>
|
|
3202
3614
|
*/
|
|
3203
3615
|
MaxResults?: number;
|
|
3204
3616
|
/**
|
|
3617
|
+
* @public
|
|
3205
3618
|
* <p>Well-Architected Lens ARN.</p>
|
|
3206
3619
|
*/
|
|
3207
3620
|
LensArn: string | undefined;
|
|
3208
3621
|
/**
|
|
3622
|
+
* @public
|
|
3209
3623
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
3210
3624
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
3211
3625
|
*/
|
|
3212
3626
|
PillarId: string | undefined;
|
|
3213
3627
|
/**
|
|
3628
|
+
* @public
|
|
3214
3629
|
* <p>The ID of the question.</p>
|
|
3215
3630
|
*/
|
|
3216
3631
|
QuestionId: string | undefined;
|
|
3217
3632
|
/**
|
|
3633
|
+
* @public
|
|
3218
3634
|
* <p>The ID of a choice.</p>
|
|
3219
3635
|
*/
|
|
3220
3636
|
ChoiceId: string | undefined;
|
|
@@ -3224,10 +3640,12 @@ export interface ListCheckSummariesInput {
|
|
|
3224
3640
|
*/
|
|
3225
3641
|
export interface ListCheckSummariesOutput {
|
|
3226
3642
|
/**
|
|
3643
|
+
* @public
|
|
3227
3644
|
* <p>List of Trusted Advisor summaries related to the Well-Architected best practice.</p>
|
|
3228
3645
|
*/
|
|
3229
3646
|
CheckSummaries?: CheckSummary[];
|
|
3230
3647
|
/**
|
|
3648
|
+
* @public
|
|
3231
3649
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3232
3650
|
*/
|
|
3233
3651
|
NextToken?: string;
|
|
@@ -3238,22 +3656,27 @@ export interface ListCheckSummariesOutput {
|
|
|
3238
3656
|
*/
|
|
3239
3657
|
export interface ListLensesInput {
|
|
3240
3658
|
/**
|
|
3659
|
+
* @public
|
|
3241
3660
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3242
3661
|
*/
|
|
3243
3662
|
NextToken?: string;
|
|
3244
3663
|
/**
|
|
3664
|
+
* @public
|
|
3245
3665
|
* <p>The maximum number of results to return for this request.</p>
|
|
3246
3666
|
*/
|
|
3247
3667
|
MaxResults?: number;
|
|
3248
3668
|
/**
|
|
3669
|
+
* @public
|
|
3249
3670
|
* <p>The type of lenses to be returned.</p>
|
|
3250
3671
|
*/
|
|
3251
3672
|
LensType?: LensType | string;
|
|
3252
3673
|
/**
|
|
3674
|
+
* @public
|
|
3253
3675
|
* <p>The status of lenses to be returned.</p>
|
|
3254
3676
|
*/
|
|
3255
3677
|
LensStatus?: LensStatusType | string;
|
|
3256
3678
|
/**
|
|
3679
|
+
* @public
|
|
3257
3680
|
* <p>The full name of the lens.</p>
|
|
3258
3681
|
*/
|
|
3259
3682
|
LensName?: string;
|
|
@@ -3264,10 +3687,12 @@ export interface ListLensesInput {
|
|
|
3264
3687
|
*/
|
|
3265
3688
|
export interface ListLensesOutput {
|
|
3266
3689
|
/**
|
|
3690
|
+
* @public
|
|
3267
3691
|
* <p>List of lens summaries of available lenses.</p>
|
|
3268
3692
|
*/
|
|
3269
3693
|
LensSummaries?: LensSummary[];
|
|
3270
3694
|
/**
|
|
3695
|
+
* @public
|
|
3271
3696
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3272
3697
|
*/
|
|
3273
3698
|
NextToken?: string;
|
|
@@ -3278,10 +3703,12 @@ export interface ListLensesOutput {
|
|
|
3278
3703
|
*/
|
|
3279
3704
|
export interface ListLensReviewImprovementsInput {
|
|
3280
3705
|
/**
|
|
3706
|
+
* @public
|
|
3281
3707
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3282
3708
|
*/
|
|
3283
3709
|
WorkloadId: string | undefined;
|
|
3284
3710
|
/**
|
|
3711
|
+
* @public
|
|
3285
3712
|
* <p>The alias of the lens.</p>
|
|
3286
3713
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3287
3714
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -3293,24 +3720,29 @@ export interface ListLensReviewImprovementsInput {
|
|
|
3293
3720
|
*/
|
|
3294
3721
|
LensAlias: string | undefined;
|
|
3295
3722
|
/**
|
|
3723
|
+
* @public
|
|
3296
3724
|
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
3297
3725
|
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
3298
3726
|
*/
|
|
3299
3727
|
PillarId?: string;
|
|
3300
3728
|
/**
|
|
3729
|
+
* @public
|
|
3301
3730
|
* <p>The milestone number.</p>
|
|
3302
3731
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
3303
3732
|
*/
|
|
3304
3733
|
MilestoneNumber?: number;
|
|
3305
3734
|
/**
|
|
3735
|
+
* @public
|
|
3306
3736
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3307
3737
|
*/
|
|
3308
3738
|
NextToken?: string;
|
|
3309
3739
|
/**
|
|
3740
|
+
* @public
|
|
3310
3741
|
* <p>The maximum number of results to return for this request.</p>
|
|
3311
3742
|
*/
|
|
3312
3743
|
MaxResults?: number;
|
|
3313
3744
|
/**
|
|
3745
|
+
* @public
|
|
3314
3746
|
* <p>The priority of the question.</p>
|
|
3315
3747
|
*/
|
|
3316
3748
|
QuestionPriority?: QuestionPriority | string;
|
|
@@ -3321,15 +3753,18 @@ export interface ListLensReviewImprovementsInput {
|
|
|
3321
3753
|
*/
|
|
3322
3754
|
export interface ListLensReviewImprovementsOutput {
|
|
3323
3755
|
/**
|
|
3756
|
+
* @public
|
|
3324
3757
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3325
3758
|
*/
|
|
3326
3759
|
WorkloadId?: string;
|
|
3327
3760
|
/**
|
|
3761
|
+
* @public
|
|
3328
3762
|
* <p>The milestone number.</p>
|
|
3329
3763
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
3330
3764
|
*/
|
|
3331
3765
|
MilestoneNumber?: number;
|
|
3332
3766
|
/**
|
|
3767
|
+
* @public
|
|
3333
3768
|
* <p>The alias of the lens.</p>
|
|
3334
3769
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3335
3770
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -3341,14 +3776,17 @@ export interface ListLensReviewImprovementsOutput {
|
|
|
3341
3776
|
*/
|
|
3342
3777
|
LensAlias?: string;
|
|
3343
3778
|
/**
|
|
3779
|
+
* @public
|
|
3344
3780
|
* <p>The ARN for the lens.</p>
|
|
3345
3781
|
*/
|
|
3346
3782
|
LensArn?: string;
|
|
3347
3783
|
/**
|
|
3784
|
+
* @public
|
|
3348
3785
|
* <p>List of improvement summaries of lens review in a workload.</p>
|
|
3349
3786
|
*/
|
|
3350
3787
|
ImprovementSummaries?: ImprovementSummary[];
|
|
3351
3788
|
/**
|
|
3789
|
+
* @public
|
|
3352
3790
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3353
3791
|
*/
|
|
3354
3792
|
NextToken?: string;
|
|
@@ -3359,19 +3797,23 @@ export interface ListLensReviewImprovementsOutput {
|
|
|
3359
3797
|
*/
|
|
3360
3798
|
export interface ListLensReviewsInput {
|
|
3361
3799
|
/**
|
|
3800
|
+
* @public
|
|
3362
3801
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3363
3802
|
*/
|
|
3364
3803
|
WorkloadId: string | undefined;
|
|
3365
3804
|
/**
|
|
3805
|
+
* @public
|
|
3366
3806
|
* <p>The milestone number.</p>
|
|
3367
3807
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
3368
3808
|
*/
|
|
3369
3809
|
MilestoneNumber?: number;
|
|
3370
3810
|
/**
|
|
3811
|
+
* @public
|
|
3371
3812
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3372
3813
|
*/
|
|
3373
3814
|
NextToken?: string;
|
|
3374
3815
|
/**
|
|
3816
|
+
* @public
|
|
3375
3817
|
* <p>The maximum number of results to return for this request.</p>
|
|
3376
3818
|
*/
|
|
3377
3819
|
MaxResults?: number;
|
|
@@ -3382,19 +3824,23 @@ export interface ListLensReviewsInput {
|
|
|
3382
3824
|
*/
|
|
3383
3825
|
export interface ListLensReviewsOutput {
|
|
3384
3826
|
/**
|
|
3827
|
+
* @public
|
|
3385
3828
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3386
3829
|
*/
|
|
3387
3830
|
WorkloadId?: string;
|
|
3388
3831
|
/**
|
|
3832
|
+
* @public
|
|
3389
3833
|
* <p>The milestone number.</p>
|
|
3390
3834
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
3391
3835
|
*/
|
|
3392
3836
|
MilestoneNumber?: number;
|
|
3393
3837
|
/**
|
|
3838
|
+
* @public
|
|
3394
3839
|
* <p>List of lens summaries of lens reviews of a workload.</p>
|
|
3395
3840
|
*/
|
|
3396
3841
|
LensReviewSummaries?: LensReviewSummary[];
|
|
3397
3842
|
/**
|
|
3843
|
+
* @public
|
|
3398
3844
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3399
3845
|
*/
|
|
3400
3846
|
NextToken?: string;
|
|
@@ -3404,6 +3850,7 @@ export interface ListLensReviewsOutput {
|
|
|
3404
3850
|
*/
|
|
3405
3851
|
export interface ListLensSharesInput {
|
|
3406
3852
|
/**
|
|
3853
|
+
* @public
|
|
3407
3854
|
* <p>The alias of the lens.</p>
|
|
3408
3855
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3409
3856
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -3415,18 +3862,22 @@ export interface ListLensSharesInput {
|
|
|
3415
3862
|
*/
|
|
3416
3863
|
LensAlias: string | undefined;
|
|
3417
3864
|
/**
|
|
3865
|
+
* @public
|
|
3418
3866
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.</p>
|
|
3419
3867
|
*/
|
|
3420
3868
|
SharedWithPrefix?: string;
|
|
3421
3869
|
/**
|
|
3870
|
+
* @public
|
|
3422
3871
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3423
3872
|
*/
|
|
3424
3873
|
NextToken?: string;
|
|
3425
3874
|
/**
|
|
3875
|
+
* @public
|
|
3426
3876
|
* <p>The maximum number of results to return for this request.</p>
|
|
3427
3877
|
*/
|
|
3428
3878
|
MaxResults?: number;
|
|
3429
3879
|
/**
|
|
3880
|
+
* @public
|
|
3430
3881
|
* <p>The status of the share request.</p>
|
|
3431
3882
|
*/
|
|
3432
3883
|
Status?: ShareStatus | string;
|
|
@@ -3436,10 +3887,12 @@ export interface ListLensSharesInput {
|
|
|
3436
3887
|
*/
|
|
3437
3888
|
export interface ListLensSharesOutput {
|
|
3438
3889
|
/**
|
|
3890
|
+
* @public
|
|
3439
3891
|
* <p>A list of lens share summaries.</p>
|
|
3440
3892
|
*/
|
|
3441
3893
|
LensShareSummaries?: LensShareSummary[];
|
|
3442
3894
|
/**
|
|
3895
|
+
* @public
|
|
3443
3896
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3444
3897
|
*/
|
|
3445
3898
|
NextToken?: string;
|
|
@@ -3450,14 +3903,17 @@ export interface ListLensSharesOutput {
|
|
|
3450
3903
|
*/
|
|
3451
3904
|
export interface ListMilestonesInput {
|
|
3452
3905
|
/**
|
|
3906
|
+
* @public
|
|
3453
3907
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3454
3908
|
*/
|
|
3455
3909
|
WorkloadId: string | undefined;
|
|
3456
3910
|
/**
|
|
3911
|
+
* @public
|
|
3457
3912
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3458
3913
|
*/
|
|
3459
3914
|
NextToken?: string;
|
|
3460
3915
|
/**
|
|
3916
|
+
* @public
|
|
3461
3917
|
* <p>The maximum number of results to return for this request.</p>
|
|
3462
3918
|
*/
|
|
3463
3919
|
MaxResults?: number;
|
|
@@ -3468,44 +3924,54 @@ export interface ListMilestonesInput {
|
|
|
3468
3924
|
*/
|
|
3469
3925
|
export interface WorkloadSummary {
|
|
3470
3926
|
/**
|
|
3927
|
+
* @public
|
|
3471
3928
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3472
3929
|
*/
|
|
3473
3930
|
WorkloadId?: string;
|
|
3474
3931
|
/**
|
|
3932
|
+
* @public
|
|
3475
3933
|
* <p>The ARN for the workload.</p>
|
|
3476
3934
|
*/
|
|
3477
3935
|
WorkloadArn?: string;
|
|
3478
3936
|
/**
|
|
3937
|
+
* @public
|
|
3479
3938
|
* <p>The name of the workload.</p>
|
|
3480
3939
|
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
3481
3940
|
* are ignored when checking for uniqueness.</p>
|
|
3482
3941
|
*/
|
|
3483
3942
|
WorkloadName?: string;
|
|
3484
3943
|
/**
|
|
3944
|
+
* @public
|
|
3485
3945
|
* <p>An Amazon Web Services account ID.</p>
|
|
3486
3946
|
*/
|
|
3487
3947
|
Owner?: string;
|
|
3488
3948
|
/**
|
|
3949
|
+
* @public
|
|
3489
3950
|
* <p>The date and time recorded.</p>
|
|
3490
3951
|
*/
|
|
3491
3952
|
UpdatedAt?: Date;
|
|
3492
3953
|
/**
|
|
3954
|
+
* @public
|
|
3493
3955
|
* <p>The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3494
3956
|
*/
|
|
3495
3957
|
Lenses?: string[];
|
|
3496
3958
|
/**
|
|
3959
|
+
* @public
|
|
3497
3960
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
3498
3961
|
*/
|
|
3499
3962
|
RiskCounts?: Record<string, number>;
|
|
3500
3963
|
/**
|
|
3964
|
+
* @public
|
|
3501
3965
|
* <p>The improvement status for a workload.</p>
|
|
3502
3966
|
*/
|
|
3503
3967
|
ImprovementStatus?: WorkloadImprovementStatus | string;
|
|
3504
3968
|
/**
|
|
3969
|
+
* @public
|
|
3505
3970
|
* <p>Profile associated with a workload.</p>
|
|
3506
3971
|
*/
|
|
3507
3972
|
Profiles?: WorkloadProfile[];
|
|
3508
3973
|
/**
|
|
3974
|
+
* @public
|
|
3509
3975
|
* <p>A map from risk names to the count of how many questions have that rating.</p>
|
|
3510
3976
|
*/
|
|
3511
3977
|
PrioritizedRiskCounts?: Record<string, number>;
|
|
@@ -3516,20 +3982,24 @@ export interface WorkloadSummary {
|
|
|
3516
3982
|
*/
|
|
3517
3983
|
export interface MilestoneSummary {
|
|
3518
3984
|
/**
|
|
3985
|
+
* @public
|
|
3519
3986
|
* <p>The milestone number.</p>
|
|
3520
3987
|
* <p>A workload can have a maximum of 100 milestones.</p>
|
|
3521
3988
|
*/
|
|
3522
3989
|
MilestoneNumber?: number;
|
|
3523
3990
|
/**
|
|
3991
|
+
* @public
|
|
3524
3992
|
* <p>The name of the milestone in a workload.</p>
|
|
3525
3993
|
* <p>Milestone names must be unique within a workload.</p>
|
|
3526
3994
|
*/
|
|
3527
3995
|
MilestoneName?: string;
|
|
3528
3996
|
/**
|
|
3997
|
+
* @public
|
|
3529
3998
|
* <p>The date and time recorded.</p>
|
|
3530
3999
|
*/
|
|
3531
4000
|
RecordedAt?: Date;
|
|
3532
4001
|
/**
|
|
4002
|
+
* @public
|
|
3533
4003
|
* <p>A workload summary return object.</p>
|
|
3534
4004
|
*/
|
|
3535
4005
|
WorkloadSummary?: WorkloadSummary;
|
|
@@ -3540,14 +4010,17 @@ export interface MilestoneSummary {
|
|
|
3540
4010
|
*/
|
|
3541
4011
|
export interface ListMilestonesOutput {
|
|
3542
4012
|
/**
|
|
4013
|
+
* @public
|
|
3543
4014
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3544
4015
|
*/
|
|
3545
4016
|
WorkloadId?: string;
|
|
3546
4017
|
/**
|
|
4018
|
+
* @public
|
|
3547
4019
|
* <p>A list of milestone summaries.</p>
|
|
3548
4020
|
*/
|
|
3549
4021
|
MilestoneSummaries?: MilestoneSummary[];
|
|
3550
4022
|
/**
|
|
4023
|
+
* @public
|
|
3551
4024
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3552
4025
|
*/
|
|
3553
4026
|
NextToken?: string;
|
|
@@ -3557,14 +4030,17 @@ export interface ListMilestonesOutput {
|
|
|
3557
4030
|
*/
|
|
3558
4031
|
export interface ListNotificationsInput {
|
|
3559
4032
|
/**
|
|
4033
|
+
* @public
|
|
3560
4034
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3561
4035
|
*/
|
|
3562
4036
|
WorkloadId?: string;
|
|
3563
4037
|
/**
|
|
4038
|
+
* @public
|
|
3564
4039
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3565
4040
|
*/
|
|
3566
4041
|
NextToken?: string;
|
|
3567
4042
|
/**
|
|
4043
|
+
* @public
|
|
3568
4044
|
* <p>The maximum number of results to return for this request.</p>
|
|
3569
4045
|
*/
|
|
3570
4046
|
MaxResults?: number;
|
|
@@ -3587,10 +4063,12 @@ export type NotificationType = (typeof NotificationType)[keyof typeof Notificati
|
|
|
3587
4063
|
*/
|
|
3588
4064
|
export interface NotificationSummary {
|
|
3589
4065
|
/**
|
|
4066
|
+
* @public
|
|
3590
4067
|
* <p>The type of notification.</p>
|
|
3591
4068
|
*/
|
|
3592
4069
|
Type?: NotificationType | string;
|
|
3593
4070
|
/**
|
|
4071
|
+
* @public
|
|
3594
4072
|
* <p>Summary of lens upgrade.</p>
|
|
3595
4073
|
*/
|
|
3596
4074
|
LensUpgradeSummary?: LensUpgradeSummary;
|
|
@@ -3600,10 +4078,12 @@ export interface NotificationSummary {
|
|
|
3600
4078
|
*/
|
|
3601
4079
|
export interface ListNotificationsOutput {
|
|
3602
4080
|
/**
|
|
4081
|
+
* @public
|
|
3603
4082
|
* <p>List of lens notification summaries in a workload.</p>
|
|
3604
4083
|
*/
|
|
3605
4084
|
NotificationSummaries?: NotificationSummary[];
|
|
3606
4085
|
/**
|
|
4086
|
+
* @public
|
|
3607
4087
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3608
4088
|
*/
|
|
3609
4089
|
NextToken?: string;
|
|
@@ -3613,14 +4093,17 @@ export interface ListNotificationsOutput {
|
|
|
3613
4093
|
*/
|
|
3614
4094
|
export interface ListProfileNotificationsInput {
|
|
3615
4095
|
/**
|
|
4096
|
+
* @public
|
|
3616
4097
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3617
4098
|
*/
|
|
3618
4099
|
WorkloadId?: string;
|
|
3619
4100
|
/**
|
|
4101
|
+
* @public
|
|
3620
4102
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3621
4103
|
*/
|
|
3622
4104
|
NextToken?: string;
|
|
3623
4105
|
/**
|
|
4106
|
+
* @public
|
|
3624
4107
|
* <p>The maximum number of results to return for this request.</p>
|
|
3625
4108
|
*/
|
|
3626
4109
|
MaxResults?: number;
|
|
@@ -3643,30 +4126,37 @@ export type ProfileNotificationType = (typeof ProfileNotificationType)[keyof typ
|
|
|
3643
4126
|
*/
|
|
3644
4127
|
export interface ProfileNotificationSummary {
|
|
3645
4128
|
/**
|
|
4129
|
+
* @public
|
|
3646
4130
|
* <p>The current profile version.</p>
|
|
3647
4131
|
*/
|
|
3648
4132
|
CurrentProfileVersion?: string;
|
|
3649
4133
|
/**
|
|
4134
|
+
* @public
|
|
3650
4135
|
* <p>The latest profile version.</p>
|
|
3651
4136
|
*/
|
|
3652
4137
|
LatestProfileVersion?: string;
|
|
3653
4138
|
/**
|
|
4139
|
+
* @public
|
|
3654
4140
|
* <p>Type of notification.</p>
|
|
3655
4141
|
*/
|
|
3656
4142
|
Type?: ProfileNotificationType | string;
|
|
3657
4143
|
/**
|
|
4144
|
+
* @public
|
|
3658
4145
|
* <p>The profile ARN.</p>
|
|
3659
4146
|
*/
|
|
3660
4147
|
ProfileArn?: string;
|
|
3661
4148
|
/**
|
|
4149
|
+
* @public
|
|
3662
4150
|
* <p>The profile name.</p>
|
|
3663
4151
|
*/
|
|
3664
4152
|
ProfileName?: string;
|
|
3665
4153
|
/**
|
|
4154
|
+
* @public
|
|
3666
4155
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3667
4156
|
*/
|
|
3668
4157
|
WorkloadId?: string;
|
|
3669
4158
|
/**
|
|
4159
|
+
* @public
|
|
3670
4160
|
* <p>The name of the workload.</p>
|
|
3671
4161
|
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
3672
4162
|
* are ignored when checking for uniqueness.</p>
|
|
@@ -3678,10 +4168,12 @@ export interface ProfileNotificationSummary {
|
|
|
3678
4168
|
*/
|
|
3679
4169
|
export interface ListProfileNotificationsOutput {
|
|
3680
4170
|
/**
|
|
4171
|
+
* @public
|
|
3681
4172
|
* <p>Notification summaries.</p>
|
|
3682
4173
|
*/
|
|
3683
4174
|
NotificationSummaries?: ProfileNotificationSummary[];
|
|
3684
4175
|
/**
|
|
4176
|
+
* @public
|
|
3685
4177
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3686
4178
|
*/
|
|
3687
4179
|
NextToken?: string;
|
|
@@ -3703,18 +4195,22 @@ export type ProfileOwnerType = (typeof ProfileOwnerType)[keyof typeof ProfileOwn
|
|
|
3703
4195
|
*/
|
|
3704
4196
|
export interface ListProfilesInput {
|
|
3705
4197
|
/**
|
|
4198
|
+
* @public
|
|
3706
4199
|
* <p>Prefix for profile name.</p>
|
|
3707
4200
|
*/
|
|
3708
4201
|
ProfileNamePrefix?: string;
|
|
3709
4202
|
/**
|
|
4203
|
+
* @public
|
|
3710
4204
|
* <p>Profile owner type.</p>
|
|
3711
4205
|
*/
|
|
3712
4206
|
ProfileOwnerType?: ProfileOwnerType | string;
|
|
3713
4207
|
/**
|
|
4208
|
+
* @public
|
|
3714
4209
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3715
4210
|
*/
|
|
3716
4211
|
NextToken?: string;
|
|
3717
4212
|
/**
|
|
4213
|
+
* @public
|
|
3718
4214
|
* <p>The maximum number of results to return for this request.</p>
|
|
3719
4215
|
*/
|
|
3720
4216
|
MaxResults?: number;
|
|
@@ -3725,30 +4221,37 @@ export interface ListProfilesInput {
|
|
|
3725
4221
|
*/
|
|
3726
4222
|
export interface ProfileSummary {
|
|
3727
4223
|
/**
|
|
4224
|
+
* @public
|
|
3728
4225
|
* <p>The profile ARN.</p>
|
|
3729
4226
|
*/
|
|
3730
4227
|
ProfileArn?: string;
|
|
3731
4228
|
/**
|
|
4229
|
+
* @public
|
|
3732
4230
|
* <p>The profile version.</p>
|
|
3733
4231
|
*/
|
|
3734
4232
|
ProfileVersion?: string;
|
|
3735
4233
|
/**
|
|
4234
|
+
* @public
|
|
3736
4235
|
* <p>The profile name.</p>
|
|
3737
4236
|
*/
|
|
3738
4237
|
ProfileName?: string;
|
|
3739
4238
|
/**
|
|
4239
|
+
* @public
|
|
3740
4240
|
* <p>The profile description.</p>
|
|
3741
4241
|
*/
|
|
3742
4242
|
ProfileDescription?: string;
|
|
3743
4243
|
/**
|
|
4244
|
+
* @public
|
|
3744
4245
|
* <p>An Amazon Web Services account ID.</p>
|
|
3745
4246
|
*/
|
|
3746
4247
|
Owner?: string;
|
|
3747
4248
|
/**
|
|
4249
|
+
* @public
|
|
3748
4250
|
* <p>The date and time recorded.</p>
|
|
3749
4251
|
*/
|
|
3750
4252
|
CreatedAt?: Date;
|
|
3751
4253
|
/**
|
|
4254
|
+
* @public
|
|
3752
4255
|
* <p>The date and time recorded.</p>
|
|
3753
4256
|
*/
|
|
3754
4257
|
UpdatedAt?: Date;
|
|
@@ -3758,10 +4261,12 @@ export interface ProfileSummary {
|
|
|
3758
4261
|
*/
|
|
3759
4262
|
export interface ListProfilesOutput {
|
|
3760
4263
|
/**
|
|
4264
|
+
* @public
|
|
3761
4265
|
* <p>Profile summaries.</p>
|
|
3762
4266
|
*/
|
|
3763
4267
|
ProfileSummaries?: ProfileSummary[];
|
|
3764
4268
|
/**
|
|
4269
|
+
* @public
|
|
3765
4270
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3766
4271
|
*/
|
|
3767
4272
|
NextToken?: string;
|
|
@@ -3771,22 +4276,27 @@ export interface ListProfilesOutput {
|
|
|
3771
4276
|
*/
|
|
3772
4277
|
export interface ListProfileSharesInput {
|
|
3773
4278
|
/**
|
|
4279
|
+
* @public
|
|
3774
4280
|
* <p>The profile ARN.</p>
|
|
3775
4281
|
*/
|
|
3776
4282
|
ProfileArn: string | undefined;
|
|
3777
4283
|
/**
|
|
4284
|
+
* @public
|
|
3778
4285
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the profile is shared.</p>
|
|
3779
4286
|
*/
|
|
3780
4287
|
SharedWithPrefix?: string;
|
|
3781
4288
|
/**
|
|
4289
|
+
* @public
|
|
3782
4290
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3783
4291
|
*/
|
|
3784
4292
|
NextToken?: string;
|
|
3785
4293
|
/**
|
|
4294
|
+
* @public
|
|
3786
4295
|
* <p>The maximum number of results to return for this request.</p>
|
|
3787
4296
|
*/
|
|
3788
4297
|
MaxResults?: number;
|
|
3789
4298
|
/**
|
|
4299
|
+
* @public
|
|
3790
4300
|
* <p>The status of the share request.</p>
|
|
3791
4301
|
*/
|
|
3792
4302
|
Status?: ShareStatus | string;
|
|
@@ -3797,18 +4307,22 @@ export interface ListProfileSharesInput {
|
|
|
3797
4307
|
*/
|
|
3798
4308
|
export interface ProfileShareSummary {
|
|
3799
4309
|
/**
|
|
4310
|
+
* @public
|
|
3800
4311
|
* <p>The ID associated with the share.</p>
|
|
3801
4312
|
*/
|
|
3802
4313
|
ShareId?: string;
|
|
3803
4314
|
/**
|
|
4315
|
+
* @public
|
|
3804
4316
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.</p>
|
|
3805
4317
|
*/
|
|
3806
4318
|
SharedWith?: string;
|
|
3807
4319
|
/**
|
|
4320
|
+
* @public
|
|
3808
4321
|
* <p>The status of the share request.</p>
|
|
3809
4322
|
*/
|
|
3810
4323
|
Status?: ShareStatus | string;
|
|
3811
4324
|
/**
|
|
4325
|
+
* @public
|
|
3812
4326
|
* <p>Profile share invitation status message.</p>
|
|
3813
4327
|
*/
|
|
3814
4328
|
StatusMessage?: string;
|
|
@@ -3818,10 +4332,12 @@ export interface ProfileShareSummary {
|
|
|
3818
4332
|
*/
|
|
3819
4333
|
export interface ListProfileSharesOutput {
|
|
3820
4334
|
/**
|
|
4335
|
+
* @public
|
|
3821
4336
|
* <p>Profile share summaries.</p>
|
|
3822
4337
|
*/
|
|
3823
4338
|
ProfileShareSummaries?: ProfileShareSummary[];
|
|
3824
4339
|
/**
|
|
4340
|
+
* @public
|
|
3825
4341
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3826
4342
|
*/
|
|
3827
4343
|
NextToken?: string;
|
|
@@ -3845,27 +4361,33 @@ export type ShareResourceType = (typeof ShareResourceType)[keyof typeof ShareRes
|
|
|
3845
4361
|
*/
|
|
3846
4362
|
export interface ListShareInvitationsInput {
|
|
3847
4363
|
/**
|
|
4364
|
+
* @public
|
|
3848
4365
|
* <p>An optional string added to the beginning of each workload name returned in the
|
|
3849
4366
|
* results.</p>
|
|
3850
4367
|
*/
|
|
3851
4368
|
WorkloadNamePrefix?: string;
|
|
3852
4369
|
/**
|
|
4370
|
+
* @public
|
|
3853
4371
|
* <p>An optional string added to the beginning of each lens name returned in the results.</p>
|
|
3854
4372
|
*/
|
|
3855
4373
|
LensNamePrefix?: string;
|
|
3856
4374
|
/**
|
|
4375
|
+
* @public
|
|
3857
4376
|
* <p>The type of share invitations to be returned.</p>
|
|
3858
4377
|
*/
|
|
3859
4378
|
ShareResourceType?: ShareResourceType | string;
|
|
3860
4379
|
/**
|
|
4380
|
+
* @public
|
|
3861
4381
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3862
4382
|
*/
|
|
3863
4383
|
NextToken?: string;
|
|
3864
4384
|
/**
|
|
4385
|
+
* @public
|
|
3865
4386
|
* <p>The maximum number of results to return for this request.</p>
|
|
3866
4387
|
*/
|
|
3867
4388
|
MaxResults?: number;
|
|
3868
4389
|
/**
|
|
4390
|
+
* @public
|
|
3869
4391
|
* <p>Profile name prefix.</p>
|
|
3870
4392
|
*/
|
|
3871
4393
|
ProfileNamePrefix?: string;
|
|
@@ -3876,48 +4398,59 @@ export interface ListShareInvitationsInput {
|
|
|
3876
4398
|
*/
|
|
3877
4399
|
export interface ShareInvitationSummary {
|
|
3878
4400
|
/**
|
|
4401
|
+
* @public
|
|
3879
4402
|
* <p>The ID assigned to the share invitation.</p>
|
|
3880
4403
|
*/
|
|
3881
4404
|
ShareInvitationId?: string;
|
|
3882
4405
|
/**
|
|
4406
|
+
* @public
|
|
3883
4407
|
* <p>An Amazon Web Services account ID.</p>
|
|
3884
4408
|
*/
|
|
3885
4409
|
SharedBy?: string;
|
|
3886
4410
|
/**
|
|
4411
|
+
* @public
|
|
3887
4412
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.</p>
|
|
3888
4413
|
*/
|
|
3889
4414
|
SharedWith?: string;
|
|
3890
4415
|
/**
|
|
4416
|
+
* @public
|
|
3891
4417
|
* <p>Permission granted on a share request.</p>
|
|
3892
4418
|
*/
|
|
3893
4419
|
PermissionType?: PermissionType | string;
|
|
3894
4420
|
/**
|
|
4421
|
+
* @public
|
|
3895
4422
|
* <p>The resource type of the share invitation.</p>
|
|
3896
4423
|
*/
|
|
3897
4424
|
ShareResourceType?: ShareResourceType | string;
|
|
3898
4425
|
/**
|
|
4426
|
+
* @public
|
|
3899
4427
|
* <p>The name of the workload.</p>
|
|
3900
4428
|
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
3901
4429
|
* are ignored when checking for uniqueness.</p>
|
|
3902
4430
|
*/
|
|
3903
4431
|
WorkloadName?: string;
|
|
3904
4432
|
/**
|
|
4433
|
+
* @public
|
|
3905
4434
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3906
4435
|
*/
|
|
3907
4436
|
WorkloadId?: string;
|
|
3908
4437
|
/**
|
|
4438
|
+
* @public
|
|
3909
4439
|
* <p>The full name of the lens.</p>
|
|
3910
4440
|
*/
|
|
3911
4441
|
LensName?: string;
|
|
3912
4442
|
/**
|
|
4443
|
+
* @public
|
|
3913
4444
|
* <p>The ARN for the lens.</p>
|
|
3914
4445
|
*/
|
|
3915
4446
|
LensArn?: string;
|
|
3916
4447
|
/**
|
|
4448
|
+
* @public
|
|
3917
4449
|
* <p>The profile name.</p>
|
|
3918
4450
|
*/
|
|
3919
4451
|
ProfileName?: string;
|
|
3920
4452
|
/**
|
|
4453
|
+
* @public
|
|
3921
4454
|
* <p>The profile ARN.</p>
|
|
3922
4455
|
*/
|
|
3923
4456
|
ProfileArn?: string;
|
|
@@ -3928,10 +4461,12 @@ export interface ShareInvitationSummary {
|
|
|
3928
4461
|
*/
|
|
3929
4462
|
export interface ListShareInvitationsOutput {
|
|
3930
4463
|
/**
|
|
4464
|
+
* @public
|
|
3931
4465
|
* <p>List of share invitation summaries in a workload.</p>
|
|
3932
4466
|
*/
|
|
3933
4467
|
ShareInvitationSummaries?: ShareInvitationSummary[];
|
|
3934
4468
|
/**
|
|
4469
|
+
* @public
|
|
3935
4470
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3936
4471
|
*/
|
|
3937
4472
|
NextToken?: string;
|
|
@@ -3941,6 +4476,7 @@ export interface ListShareInvitationsOutput {
|
|
|
3941
4476
|
*/
|
|
3942
4477
|
export interface ListTagsForResourceInput {
|
|
3943
4478
|
/**
|
|
4479
|
+
* @public
|
|
3944
4480
|
* <p>The ARN for the workload.</p>
|
|
3945
4481
|
*/
|
|
3946
4482
|
WorkloadArn: string | undefined;
|
|
@@ -3950,6 +4486,7 @@ export interface ListTagsForResourceInput {
|
|
|
3950
4486
|
*/
|
|
3951
4487
|
export interface ListTagsForResourceOutput {
|
|
3952
4488
|
/**
|
|
4489
|
+
* @public
|
|
3953
4490
|
* <p>The tags for the resource.</p>
|
|
3954
4491
|
*/
|
|
3955
4492
|
Tags?: Record<string, string>;
|
|
@@ -3960,15 +4497,18 @@ export interface ListTagsForResourceOutput {
|
|
|
3960
4497
|
*/
|
|
3961
4498
|
export interface ListWorkloadsInput {
|
|
3962
4499
|
/**
|
|
4500
|
+
* @public
|
|
3963
4501
|
* <p>An optional string added to the beginning of each workload name returned in the
|
|
3964
4502
|
* results.</p>
|
|
3965
4503
|
*/
|
|
3966
4504
|
WorkloadNamePrefix?: string;
|
|
3967
4505
|
/**
|
|
4506
|
+
* @public
|
|
3968
4507
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3969
4508
|
*/
|
|
3970
4509
|
NextToken?: string;
|
|
3971
4510
|
/**
|
|
4511
|
+
* @public
|
|
3972
4512
|
* <p>The maximum number of results to return for this request.</p>
|
|
3973
4513
|
*/
|
|
3974
4514
|
MaxResults?: number;
|
|
@@ -3979,10 +4519,12 @@ export interface ListWorkloadsInput {
|
|
|
3979
4519
|
*/
|
|
3980
4520
|
export interface ListWorkloadsOutput {
|
|
3981
4521
|
/**
|
|
4522
|
+
* @public
|
|
3982
4523
|
* <p>A list of workload summaries.</p>
|
|
3983
4524
|
*/
|
|
3984
4525
|
WorkloadSummaries?: WorkloadSummary[];
|
|
3985
4526
|
/**
|
|
4527
|
+
* @public
|
|
3986
4528
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
3987
4529
|
*/
|
|
3988
4530
|
NextToken?: string;
|
|
@@ -3993,22 +4535,27 @@ export interface ListWorkloadsOutput {
|
|
|
3993
4535
|
*/
|
|
3994
4536
|
export interface ListWorkloadSharesInput {
|
|
3995
4537
|
/**
|
|
4538
|
+
* @public
|
|
3996
4539
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3997
4540
|
*/
|
|
3998
4541
|
WorkloadId: string | undefined;
|
|
3999
4542
|
/**
|
|
4543
|
+
* @public
|
|
4000
4544
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.</p>
|
|
4001
4545
|
*/
|
|
4002
4546
|
SharedWithPrefix?: string;
|
|
4003
4547
|
/**
|
|
4548
|
+
* @public
|
|
4004
4549
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
4005
4550
|
*/
|
|
4006
4551
|
NextToken?: string;
|
|
4007
4552
|
/**
|
|
4553
|
+
* @public
|
|
4008
4554
|
* <p>The maximum number of results to return for this request.</p>
|
|
4009
4555
|
*/
|
|
4010
4556
|
MaxResults?: number;
|
|
4011
4557
|
/**
|
|
4558
|
+
* @public
|
|
4012
4559
|
* <p>The status of the share request.</p>
|
|
4013
4560
|
*/
|
|
4014
4561
|
Status?: ShareStatus | string;
|
|
@@ -4019,22 +4566,27 @@ export interface ListWorkloadSharesInput {
|
|
|
4019
4566
|
*/
|
|
4020
4567
|
export interface WorkloadShareSummary {
|
|
4021
4568
|
/**
|
|
4569
|
+
* @public
|
|
4022
4570
|
* <p>The ID associated with the share.</p>
|
|
4023
4571
|
*/
|
|
4024
4572
|
ShareId?: string;
|
|
4025
4573
|
/**
|
|
4574
|
+
* @public
|
|
4026
4575
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.</p>
|
|
4027
4576
|
*/
|
|
4028
4577
|
SharedWith?: string;
|
|
4029
4578
|
/**
|
|
4579
|
+
* @public
|
|
4030
4580
|
* <p>Permission granted on a share request.</p>
|
|
4031
4581
|
*/
|
|
4032
4582
|
PermissionType?: PermissionType | string;
|
|
4033
4583
|
/**
|
|
4584
|
+
* @public
|
|
4034
4585
|
* <p>The status of the share request.</p>
|
|
4035
4586
|
*/
|
|
4036
4587
|
Status?: ShareStatus | string;
|
|
4037
4588
|
/**
|
|
4589
|
+
* @public
|
|
4038
4590
|
* <p>Optional message to compliment the Status field.</p>
|
|
4039
4591
|
*/
|
|
4040
4592
|
StatusMessage?: string;
|
|
@@ -4045,14 +4597,17 @@ export interface WorkloadShareSummary {
|
|
|
4045
4597
|
*/
|
|
4046
4598
|
export interface ListWorkloadSharesOutput {
|
|
4047
4599
|
/**
|
|
4600
|
+
* @public
|
|
4048
4601
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4049
4602
|
*/
|
|
4050
4603
|
WorkloadId?: string;
|
|
4051
4604
|
/**
|
|
4605
|
+
* @public
|
|
4052
4606
|
* <p>A list of workload share summaries.</p>
|
|
4053
4607
|
*/
|
|
4054
4608
|
WorkloadShareSummaries?: WorkloadShareSummary[];
|
|
4055
4609
|
/**
|
|
4610
|
+
* @public
|
|
4056
4611
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
4057
4612
|
*/
|
|
4058
4613
|
NextToken?: string;
|
|
@@ -4075,18 +4630,22 @@ export type OrganizationSharingStatus = (typeof OrganizationSharingStatus)[keyof
|
|
|
4075
4630
|
*/
|
|
4076
4631
|
export interface ShareInvitation {
|
|
4077
4632
|
/**
|
|
4633
|
+
* @public
|
|
4078
4634
|
* <p>The ID assigned to the share invitation.</p>
|
|
4079
4635
|
*/
|
|
4080
4636
|
ShareInvitationId?: string;
|
|
4081
4637
|
/**
|
|
4638
|
+
* @public
|
|
4082
4639
|
* <p>The resource type of the share invitation.</p>
|
|
4083
4640
|
*/
|
|
4084
4641
|
ShareResourceType?: ShareResourceType | string;
|
|
4085
4642
|
/**
|
|
4643
|
+
* @public
|
|
4086
4644
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4087
4645
|
*/
|
|
4088
4646
|
WorkloadId?: string;
|
|
4089
4647
|
/**
|
|
4648
|
+
* @public
|
|
4090
4649
|
* <p>The alias of the lens.</p>
|
|
4091
4650
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
4092
4651
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -4098,10 +4657,12 @@ export interface ShareInvitation {
|
|
|
4098
4657
|
*/
|
|
4099
4658
|
LensAlias?: string;
|
|
4100
4659
|
/**
|
|
4660
|
+
* @public
|
|
4101
4661
|
* <p>The ARN for the lens.</p>
|
|
4102
4662
|
*/
|
|
4103
4663
|
LensArn?: string;
|
|
4104
4664
|
/**
|
|
4665
|
+
* @public
|
|
4105
4666
|
* <p>The profile ARN.</p>
|
|
4106
4667
|
*/
|
|
4107
4668
|
ProfileArn?: string;
|
|
@@ -4123,10 +4684,12 @@ export type ShareInvitationAction = (typeof ShareInvitationAction)[keyof typeof
|
|
|
4123
4684
|
*/
|
|
4124
4685
|
export interface TagResourceInput {
|
|
4125
4686
|
/**
|
|
4687
|
+
* @public
|
|
4126
4688
|
* <p>The ARN for the workload.</p>
|
|
4127
4689
|
*/
|
|
4128
4690
|
WorkloadArn: string | undefined;
|
|
4129
4691
|
/**
|
|
4692
|
+
* @public
|
|
4130
4693
|
* <p>The tags for the resource.</p>
|
|
4131
4694
|
*/
|
|
4132
4695
|
Tags: Record<string, string> | undefined;
|
|
@@ -4141,10 +4704,12 @@ export interface TagResourceOutput {
|
|
|
4141
4704
|
*/
|
|
4142
4705
|
export interface UntagResourceInput {
|
|
4143
4706
|
/**
|
|
4707
|
+
* @public
|
|
4144
4708
|
* <p>The ARN for the workload.</p>
|
|
4145
4709
|
*/
|
|
4146
4710
|
WorkloadArn: string | undefined;
|
|
4147
4711
|
/**
|
|
4712
|
+
* @public
|
|
4148
4713
|
* <p>A list of tag keys. Existing tags of the resource
|
|
4149
4714
|
* whose keys are members of this list are removed from the resource.</p>
|
|
4150
4715
|
*/
|
|
@@ -4161,10 +4726,12 @@ export interface UntagResourceOutput {
|
|
|
4161
4726
|
*/
|
|
4162
4727
|
export interface UpdateAnswerInput {
|
|
4163
4728
|
/**
|
|
4729
|
+
* @public
|
|
4164
4730
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4165
4731
|
*/
|
|
4166
4732
|
WorkloadId: string | undefined;
|
|
4167
4733
|
/**
|
|
4734
|
+
* @public
|
|
4168
4735
|
* <p>The alias of the lens.</p>
|
|
4169
4736
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
4170
4737
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -4176,28 +4743,34 @@ export interface UpdateAnswerInput {
|
|
|
4176
4743
|
*/
|
|
4177
4744
|
LensAlias: string | undefined;
|
|
4178
4745
|
/**
|
|
4746
|
+
* @public
|
|
4179
4747
|
* <p>The ID of the question.</p>
|
|
4180
4748
|
*/
|
|
4181
4749
|
QuestionId: string | undefined;
|
|
4182
4750
|
/**
|
|
4751
|
+
* @public
|
|
4183
4752
|
* <p>List of selected choice IDs in a question answer.</p>
|
|
4184
4753
|
* <p>The values entered replace the previously selected choices.</p>
|
|
4185
4754
|
*/
|
|
4186
4755
|
SelectedChoices?: string[];
|
|
4187
4756
|
/**
|
|
4757
|
+
* @public
|
|
4188
4758
|
* <p>A list of choices to update on a question in your workload. The String key
|
|
4189
4759
|
* corresponds to the choice ID to be updated.</p>
|
|
4190
4760
|
*/
|
|
4191
4761
|
ChoiceUpdates?: Record<string, ChoiceUpdate>;
|
|
4192
4762
|
/**
|
|
4763
|
+
* @public
|
|
4193
4764
|
* <p>The notes associated with the workload.</p>
|
|
4194
4765
|
*/
|
|
4195
4766
|
Notes?: string;
|
|
4196
4767
|
/**
|
|
4768
|
+
* @public
|
|
4197
4769
|
* <p>Defines whether this question is applicable to a lens review.</p>
|
|
4198
4770
|
*/
|
|
4199
4771
|
IsApplicable?: boolean;
|
|
4200
4772
|
/**
|
|
4773
|
+
* @public
|
|
4201
4774
|
* <p>The reason why a question is not applicable to your workload.</p>
|
|
4202
4775
|
*/
|
|
4203
4776
|
Reason?: AnswerReason | string;
|
|
@@ -4208,10 +4781,12 @@ export interface UpdateAnswerInput {
|
|
|
4208
4781
|
*/
|
|
4209
4782
|
export interface UpdateAnswerOutput {
|
|
4210
4783
|
/**
|
|
4784
|
+
* @public
|
|
4211
4785
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4212
4786
|
*/
|
|
4213
4787
|
WorkloadId?: string;
|
|
4214
4788
|
/**
|
|
4789
|
+
* @public
|
|
4215
4790
|
* <p>The alias of the lens.</p>
|
|
4216
4791
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
4217
4792
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -4223,10 +4798,12 @@ export interface UpdateAnswerOutput {
|
|
|
4223
4798
|
*/
|
|
4224
4799
|
LensAlias?: string;
|
|
4225
4800
|
/**
|
|
4801
|
+
* @public
|
|
4226
4802
|
* <p>The ARN for the lens.</p>
|
|
4227
4803
|
*/
|
|
4228
4804
|
LensArn?: string;
|
|
4229
4805
|
/**
|
|
4806
|
+
* @public
|
|
4230
4807
|
* <p>An answer of the question.</p>
|
|
4231
4808
|
*/
|
|
4232
4809
|
Answer?: Answer;
|
|
@@ -4236,10 +4813,12 @@ export interface UpdateAnswerOutput {
|
|
|
4236
4813
|
*/
|
|
4237
4814
|
export interface UpdateGlobalSettingsInput {
|
|
4238
4815
|
/**
|
|
4816
|
+
* @public
|
|
4239
4817
|
* <p>The status of organization sharing settings.</p>
|
|
4240
4818
|
*/
|
|
4241
4819
|
OrganizationSharingStatus?: OrganizationSharingStatus | string;
|
|
4242
4820
|
/**
|
|
4821
|
+
* @public
|
|
4243
4822
|
* <p>The status of discovery support settings.</p>
|
|
4244
4823
|
*/
|
|
4245
4824
|
DiscoveryIntegrationStatus?: DiscoveryIntegrationStatus | string;
|
|
@@ -4250,10 +4829,12 @@ export interface UpdateGlobalSettingsInput {
|
|
|
4250
4829
|
*/
|
|
4251
4830
|
export interface UpdateLensReviewInput {
|
|
4252
4831
|
/**
|
|
4832
|
+
* @public
|
|
4253
4833
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4254
4834
|
*/
|
|
4255
4835
|
WorkloadId: string | undefined;
|
|
4256
4836
|
/**
|
|
4837
|
+
* @public
|
|
4257
4838
|
* <p>The alias of the lens.</p>
|
|
4258
4839
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
4259
4840
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -4265,10 +4846,12 @@ export interface UpdateLensReviewInput {
|
|
|
4265
4846
|
*/
|
|
4266
4847
|
LensAlias: string | undefined;
|
|
4267
4848
|
/**
|
|
4849
|
+
* @public
|
|
4268
4850
|
* <p>The notes associated with the workload.</p>
|
|
4269
4851
|
*/
|
|
4270
4852
|
LensNotes?: string;
|
|
4271
4853
|
/**
|
|
4854
|
+
* @public
|
|
4272
4855
|
* <p>List of pillar notes of a lens review in a workload.</p>
|
|
4273
4856
|
*/
|
|
4274
4857
|
PillarNotes?: Record<string, string>;
|
|
@@ -4279,10 +4862,12 @@ export interface UpdateLensReviewInput {
|
|
|
4279
4862
|
*/
|
|
4280
4863
|
export interface UpdateLensReviewOutput {
|
|
4281
4864
|
/**
|
|
4865
|
+
* @public
|
|
4282
4866
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4283
4867
|
*/
|
|
4284
4868
|
WorkloadId?: string;
|
|
4285
4869
|
/**
|
|
4870
|
+
* @public
|
|
4286
4871
|
* <p>A lens review of a question.</p>
|
|
4287
4872
|
*/
|
|
4288
4873
|
LensReview?: LensReview;
|
|
@@ -4292,14 +4877,17 @@ export interface UpdateLensReviewOutput {
|
|
|
4292
4877
|
*/
|
|
4293
4878
|
export interface UpdateProfileInput {
|
|
4294
4879
|
/**
|
|
4880
|
+
* @public
|
|
4295
4881
|
* <p>The profile ARN.</p>
|
|
4296
4882
|
*/
|
|
4297
4883
|
ProfileArn: string | undefined;
|
|
4298
4884
|
/**
|
|
4885
|
+
* @public
|
|
4299
4886
|
* <p>The profile description.</p>
|
|
4300
4887
|
*/
|
|
4301
4888
|
ProfileDescription?: string;
|
|
4302
4889
|
/**
|
|
4890
|
+
* @public
|
|
4303
4891
|
* <p>Profile questions.</p>
|
|
4304
4892
|
*/
|
|
4305
4893
|
ProfileQuestions?: ProfileQuestionUpdate[];
|
|
@@ -4309,6 +4897,7 @@ export interface UpdateProfileInput {
|
|
|
4309
4897
|
*/
|
|
4310
4898
|
export interface UpdateProfileOutput {
|
|
4311
4899
|
/**
|
|
4900
|
+
* @public
|
|
4312
4901
|
* <p>The profile.</p>
|
|
4313
4902
|
*/
|
|
4314
4903
|
Profile?: Profile;
|
|
@@ -4319,10 +4908,12 @@ export interface UpdateProfileOutput {
|
|
|
4319
4908
|
*/
|
|
4320
4909
|
export interface UpdateShareInvitationInput {
|
|
4321
4910
|
/**
|
|
4911
|
+
* @public
|
|
4322
4912
|
* <p>The ID assigned to the share invitation.</p>
|
|
4323
4913
|
*/
|
|
4324
4914
|
ShareInvitationId: string | undefined;
|
|
4325
4915
|
/**
|
|
4916
|
+
* @public
|
|
4326
4917
|
* <p>Share invitation action taken by contributor.</p>
|
|
4327
4918
|
*/
|
|
4328
4919
|
ShareInvitationAction: ShareInvitationAction | string | undefined;
|
|
@@ -4332,6 +4923,7 @@ export interface UpdateShareInvitationInput {
|
|
|
4332
4923
|
*/
|
|
4333
4924
|
export interface UpdateShareInvitationOutput {
|
|
4334
4925
|
/**
|
|
4926
|
+
* @public
|
|
4335
4927
|
* <p>The updated workload or custom lens share invitation.</p>
|
|
4336
4928
|
*/
|
|
4337
4929
|
ShareInvitation?: ShareInvitation;
|
|
@@ -4342,51 +4934,62 @@ export interface UpdateShareInvitationOutput {
|
|
|
4342
4934
|
*/
|
|
4343
4935
|
export interface UpdateWorkloadInput {
|
|
4344
4936
|
/**
|
|
4937
|
+
* @public
|
|
4345
4938
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4346
4939
|
*/
|
|
4347
4940
|
WorkloadId: string | undefined;
|
|
4348
4941
|
/**
|
|
4942
|
+
* @public
|
|
4349
4943
|
* <p>The name of the workload.</p>
|
|
4350
4944
|
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
4351
4945
|
* are ignored when checking for uniqueness.</p>
|
|
4352
4946
|
*/
|
|
4353
4947
|
WorkloadName?: string;
|
|
4354
4948
|
/**
|
|
4949
|
+
* @public
|
|
4355
4950
|
* <p>The description for the workload.</p>
|
|
4356
4951
|
*/
|
|
4357
4952
|
Description?: string;
|
|
4358
4953
|
/**
|
|
4954
|
+
* @public
|
|
4359
4955
|
* <p>The environment for the workload.</p>
|
|
4360
4956
|
*/
|
|
4361
4957
|
Environment?: WorkloadEnvironment | string;
|
|
4362
4958
|
/**
|
|
4959
|
+
* @public
|
|
4363
4960
|
* <p>The list of Amazon Web Services account IDs associated with the workload.</p>
|
|
4364
4961
|
*/
|
|
4365
4962
|
AccountIds?: string[];
|
|
4366
4963
|
/**
|
|
4964
|
+
* @public
|
|
4367
4965
|
* <p>The list of Amazon Web Services Regions associated with the workload, for example,
|
|
4368
4966
|
* <code>us-east-2</code>, or <code>ca-central-1</code>.</p>
|
|
4369
4967
|
*/
|
|
4370
4968
|
AwsRegions?: string[];
|
|
4371
4969
|
/**
|
|
4970
|
+
* @public
|
|
4372
4971
|
* <p> The list of non-Amazon Web Services Regions associated with the workload.</p>
|
|
4373
4972
|
*/
|
|
4374
4973
|
NonAwsRegions?: string[];
|
|
4375
4974
|
/**
|
|
4975
|
+
* @public
|
|
4376
4976
|
* <p>The priorities of the pillars, which are used to order items in the improvement plan.
|
|
4377
4977
|
* Each pillar is represented by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
4378
4978
|
*/
|
|
4379
4979
|
PillarPriorities?: string[];
|
|
4380
4980
|
/**
|
|
4981
|
+
* @public
|
|
4381
4982
|
* <p>The URL of the architectural design for the workload.</p>
|
|
4382
4983
|
*/
|
|
4383
4984
|
ArchitecturalDesign?: string;
|
|
4384
4985
|
/**
|
|
4986
|
+
* @public
|
|
4385
4987
|
* <p>The review owner of the workload. The name, email address, or identifier for the
|
|
4386
4988
|
* primary group or individual that owns the workload review process.</p>
|
|
4387
4989
|
*/
|
|
4388
4990
|
ReviewOwner?: string;
|
|
4389
4991
|
/**
|
|
4992
|
+
* @public
|
|
4390
4993
|
* <p>Flag indicating whether the workload owner has acknowledged that the <i>Review
|
|
4391
4994
|
* owner</i> field is required.</p>
|
|
4392
4995
|
* <p>If a <b>Review owner</b> is not added to the workload within
|
|
@@ -4395,6 +4998,7 @@ export interface UpdateWorkloadInput {
|
|
|
4395
4998
|
*/
|
|
4396
4999
|
IsReviewOwnerUpdateAcknowledged?: boolean;
|
|
4397
5000
|
/**
|
|
5001
|
+
* @public
|
|
4398
5002
|
* <p>The industry type for the workload.</p>
|
|
4399
5003
|
* <p>If specified, must be one of the following:</p>
|
|
4400
5004
|
* <ul>
|
|
@@ -4537,22 +5141,27 @@ export interface UpdateWorkloadInput {
|
|
|
4537
5141
|
*/
|
|
4538
5142
|
IndustryType?: string;
|
|
4539
5143
|
/**
|
|
5144
|
+
* @public
|
|
4540
5145
|
* <p>The industry for the workload.</p>
|
|
4541
5146
|
*/
|
|
4542
5147
|
Industry?: string;
|
|
4543
5148
|
/**
|
|
5149
|
+
* @public
|
|
4544
5150
|
* <p>The notes associated with the workload.</p>
|
|
4545
5151
|
*/
|
|
4546
5152
|
Notes?: string;
|
|
4547
5153
|
/**
|
|
5154
|
+
* @public
|
|
4548
5155
|
* <p>The improvement status for a workload.</p>
|
|
4549
5156
|
*/
|
|
4550
5157
|
ImprovementStatus?: WorkloadImprovementStatus | string;
|
|
4551
5158
|
/**
|
|
5159
|
+
* @public
|
|
4552
5160
|
* <p>Well-Architected discovery configuration settings to associate to the workload.</p>
|
|
4553
5161
|
*/
|
|
4554
5162
|
DiscoveryConfig?: WorkloadDiscoveryConfig;
|
|
4555
5163
|
/**
|
|
5164
|
+
* @public
|
|
4556
5165
|
* <p>List of AppRegistry application ARNs to associate to the workload.</p>
|
|
4557
5166
|
*/
|
|
4558
5167
|
Applications?: string[];
|
|
@@ -4563,6 +5172,7 @@ export interface UpdateWorkloadInput {
|
|
|
4563
5172
|
*/
|
|
4564
5173
|
export interface UpdateWorkloadOutput {
|
|
4565
5174
|
/**
|
|
5175
|
+
* @public
|
|
4566
5176
|
* <p>A workload return object.</p>
|
|
4567
5177
|
*/
|
|
4568
5178
|
Workload?: Workload;
|
|
@@ -4573,14 +5183,17 @@ export interface UpdateWorkloadOutput {
|
|
|
4573
5183
|
*/
|
|
4574
5184
|
export interface UpdateWorkloadShareInput {
|
|
4575
5185
|
/**
|
|
5186
|
+
* @public
|
|
4576
5187
|
* <p>The ID associated with the share.</p>
|
|
4577
5188
|
*/
|
|
4578
5189
|
ShareId: string | undefined;
|
|
4579
5190
|
/**
|
|
5191
|
+
* @public
|
|
4580
5192
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4581
5193
|
*/
|
|
4582
5194
|
WorkloadId: string | undefined;
|
|
4583
5195
|
/**
|
|
5196
|
+
* @public
|
|
4584
5197
|
* <p>Permission granted on a share request.</p>
|
|
4585
5198
|
*/
|
|
4586
5199
|
PermissionType: PermissionType | string | undefined;
|
|
@@ -4591,32 +5204,39 @@ export interface UpdateWorkloadShareInput {
|
|
|
4591
5204
|
*/
|
|
4592
5205
|
export interface WorkloadShare {
|
|
4593
5206
|
/**
|
|
5207
|
+
* @public
|
|
4594
5208
|
* <p>The ID associated with the share.</p>
|
|
4595
5209
|
*/
|
|
4596
5210
|
ShareId?: string;
|
|
4597
5211
|
/**
|
|
5212
|
+
* @public
|
|
4598
5213
|
* <p>An Amazon Web Services account ID.</p>
|
|
4599
5214
|
*/
|
|
4600
5215
|
SharedBy?: string;
|
|
4601
5216
|
/**
|
|
5217
|
+
* @public
|
|
4602
5218
|
* <p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.</p>
|
|
4603
5219
|
*/
|
|
4604
5220
|
SharedWith?: string;
|
|
4605
5221
|
/**
|
|
5222
|
+
* @public
|
|
4606
5223
|
* <p>Permission granted on a share request.</p>
|
|
4607
5224
|
*/
|
|
4608
5225
|
PermissionType?: PermissionType | string;
|
|
4609
5226
|
/**
|
|
5227
|
+
* @public
|
|
4610
5228
|
* <p>The status of the share request.</p>
|
|
4611
5229
|
*/
|
|
4612
5230
|
Status?: ShareStatus | string;
|
|
4613
5231
|
/**
|
|
5232
|
+
* @public
|
|
4614
5233
|
* <p>The name of the workload.</p>
|
|
4615
5234
|
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
4616
5235
|
* are ignored when checking for uniqueness.</p>
|
|
4617
5236
|
*/
|
|
4618
5237
|
WorkloadName?: string;
|
|
4619
5238
|
/**
|
|
5239
|
+
* @public
|
|
4620
5240
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4621
5241
|
*/
|
|
4622
5242
|
WorkloadId?: string;
|
|
@@ -4627,10 +5247,12 @@ export interface WorkloadShare {
|
|
|
4627
5247
|
*/
|
|
4628
5248
|
export interface UpdateWorkloadShareOutput {
|
|
4629
5249
|
/**
|
|
5250
|
+
* @public
|
|
4630
5251
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4631
5252
|
*/
|
|
4632
5253
|
WorkloadId?: string;
|
|
4633
5254
|
/**
|
|
5255
|
+
* @public
|
|
4634
5256
|
* <p>A workload share return object.</p>
|
|
4635
5257
|
*/
|
|
4636
5258
|
WorkloadShare?: WorkloadShare;
|
|
@@ -4640,10 +5262,12 @@ export interface UpdateWorkloadShareOutput {
|
|
|
4640
5262
|
*/
|
|
4641
5263
|
export interface UpgradeLensReviewInput {
|
|
4642
5264
|
/**
|
|
5265
|
+
* @public
|
|
4643
5266
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4644
5267
|
*/
|
|
4645
5268
|
WorkloadId: string | undefined;
|
|
4646
5269
|
/**
|
|
5270
|
+
* @public
|
|
4647
5271
|
* <p>The alias of the lens.</p>
|
|
4648
5272
|
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
4649
5273
|
* <code>serverless</code>, or the lens ARN, such as
|
|
@@ -4655,11 +5279,13 @@ export interface UpgradeLensReviewInput {
|
|
|
4655
5279
|
*/
|
|
4656
5280
|
LensAlias: string | undefined;
|
|
4657
5281
|
/**
|
|
5282
|
+
* @public
|
|
4658
5283
|
* <p>The name of the milestone in a workload.</p>
|
|
4659
5284
|
* <p>Milestone names must be unique within a workload.</p>
|
|
4660
5285
|
*/
|
|
4661
5286
|
MilestoneName: string | undefined;
|
|
4662
5287
|
/**
|
|
5288
|
+
* @public
|
|
4663
5289
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
4664
5290
|
* (executes only once).</p>
|
|
4665
5291
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
@@ -4678,19 +5304,23 @@ export interface UpgradeLensReviewInput {
|
|
|
4678
5304
|
*/
|
|
4679
5305
|
export interface UpgradeProfileVersionInput {
|
|
4680
5306
|
/**
|
|
5307
|
+
* @public
|
|
4681
5308
|
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
4682
5309
|
*/
|
|
4683
5310
|
WorkloadId: string | undefined;
|
|
4684
5311
|
/**
|
|
5312
|
+
* @public
|
|
4685
5313
|
* <p>The profile ARN.</p>
|
|
4686
5314
|
*/
|
|
4687
5315
|
ProfileArn: string | undefined;
|
|
4688
5316
|
/**
|
|
5317
|
+
* @public
|
|
4689
5318
|
* <p>The name of the milestone in a workload.</p>
|
|
4690
5319
|
* <p>Milestone names must be unique within a workload.</p>
|
|
4691
5320
|
*/
|
|
4692
5321
|
MilestoneName?: string;
|
|
4693
5322
|
/**
|
|
5323
|
+
* @public
|
|
4694
5324
|
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
4695
5325
|
* (executes only once).</p>
|
|
4696
5326
|
* <p>You should not reuse the same token for other requests. If you retry a request with
|