@aws-sdk/client-wellarchitected 3.423.0 → 3.424.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +112 -0
- package/dist-cjs/WellArchitected.js +28 -0
- package/dist-cjs/commands/CreateReviewTemplateCommand.js +51 -0
- package/dist-cjs/commands/CreateTemplateShareCommand.js +51 -0
- package/dist-cjs/commands/DeleteReviewTemplateCommand.js +51 -0
- package/dist-cjs/commands/DeleteTemplateShareCommand.js +51 -0
- package/dist-cjs/commands/GetReviewTemplateAnswerCommand.js +51 -0
- package/dist-cjs/commands/GetReviewTemplateCommand.js +51 -0
- package/dist-cjs/commands/GetReviewTemplateLensReviewCommand.js +51 -0
- package/dist-cjs/commands/ListReviewTemplateAnswersCommand.js +51 -0
- package/dist-cjs/commands/ListReviewTemplatesCommand.js +51 -0
- package/dist-cjs/commands/ListTemplateSharesCommand.js +51 -0
- package/dist-cjs/commands/UpdateReviewTemplateAnswerCommand.js +51 -0
- package/dist-cjs/commands/UpdateReviewTemplateCommand.js +51 -0
- package/dist-cjs/commands/UpdateReviewTemplateLensReviewCommand.js +51 -0
- package/dist-cjs/commands/UpgradeReviewTemplateLensReviewCommand.js +51 -0
- package/dist-cjs/commands/index.js +14 -0
- package/dist-cjs/models/models_0.js +14 -1
- package/dist-cjs/pagination/ListReviewTemplateAnswersPaginator.js +29 -0
- package/dist-cjs/pagination/ListReviewTemplatesPaginator.js +29 -0
- package/dist-cjs/pagination/ListTemplateSharesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1098 -53
- package/dist-es/WellArchitected.js +28 -0
- package/dist-es/commands/CreateReviewTemplateCommand.js +47 -0
- package/dist-es/commands/CreateTemplateShareCommand.js +47 -0
- package/dist-es/commands/DeleteReviewTemplateCommand.js +47 -0
- package/dist-es/commands/DeleteTemplateShareCommand.js +47 -0
- package/dist-es/commands/GetReviewTemplateAnswerCommand.js +47 -0
- package/dist-es/commands/GetReviewTemplateCommand.js +47 -0
- package/dist-es/commands/GetReviewTemplateLensReviewCommand.js +47 -0
- package/dist-es/commands/ListReviewTemplateAnswersCommand.js +47 -0
- package/dist-es/commands/ListReviewTemplatesCommand.js +47 -0
- package/dist-es/commands/ListTemplateSharesCommand.js +47 -0
- package/dist-es/commands/UpdateReviewTemplateAnswerCommand.js +47 -0
- package/dist-es/commands/UpdateReviewTemplateCommand.js +47 -0
- package/dist-es/commands/UpdateReviewTemplateLensReviewCommand.js +47 -0
- package/dist-es/commands/UpgradeReviewTemplateLensReviewCommand.js +47 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/models/models_0.js +13 -0
- package/dist-es/pagination/ListReviewTemplateAnswersPaginator.js +25 -0
- package/dist-es/pagination/ListReviewTemplatesPaginator.js +25 -0
- package/dist-es/pagination/ListTemplateSharesPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1065 -48
- package/dist-types/WellArchitected.d.ts +98 -0
- package/dist-types/WellArchitectedClient.d.ts +16 -2
- package/dist-types/commands/CreateReviewTemplateCommand.d.ts +114 -0
- package/dist-types/commands/CreateTemplateShareCommand.d.ts +111 -0
- package/dist-types/commands/CreateWorkloadCommand.d.ts +26 -0
- package/dist-types/commands/DeleteReviewTemplateCommand.d.ts +94 -0
- package/dist-types/commands/DeleteTemplateShareCommand.d.ts +94 -0
- package/dist-types/commands/GetReviewTemplateAnswerCommand.d.ts +141 -0
- package/dist-types/commands/GetReviewTemplateCommand.d.ts +106 -0
- package/dist-types/commands/GetReviewTemplateLensReviewCommand.d.ts +112 -0
- package/dist-types/commands/ListNotificationsCommand.d.ts +3 -0
- package/dist-types/commands/ListReviewTemplateAnswersCommand.d.ts +141 -0
- package/dist-types/commands/ListReviewTemplatesCommand.d.ts +99 -0
- package/dist-types/commands/ListShareInvitationsCommand.d.ts +10 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTemplateSharesCommand.d.ts +101 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateReviewTemplateAnswerCommand.d.ts +157 -0
- package/dist-types/commands/UpdateReviewTemplateCommand.d.ts +118 -0
- package/dist-types/commands/UpdateReviewTemplateLensReviewCommand.d.ts +119 -0
- package/dist-types/commands/UpdateShareInvitationCommand.d.ts +2 -1
- package/dist-types/commands/UpgradeReviewTemplateLensReviewCommand.d.ts +91 -0
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/models/models_0.d.ts +1206 -103
- package/dist-types/pagination/ListReviewTemplateAnswersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListReviewTemplatesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTemplateSharesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
- package/dist-types/ts3.4/WellArchitected.d.ts +238 -0
- package/dist-types/ts3.4/WellArchitectedClient.d.ts +86 -2
- package/dist-types/ts3.4/commands/CreateReviewTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateTemplateShareCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteReviewTemplateCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DeleteTemplateShareCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/GetReviewTemplateAnswerCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetReviewTemplateCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetReviewTemplateLensReviewCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListReviewTemplateAnswersCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListReviewTemplatesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListTemplateSharesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateReviewTemplateAnswerCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateReviewTemplateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateReviewTemplateLensReviewCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpgradeReviewTemplateLensReviewCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/models/models_0.d.ts +227 -0
- package/dist-types/ts3.4/pagination/ListReviewTemplateAnswersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListReviewTemplatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTemplateSharesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
- package/package.json +1 -1
|
@@ -277,6 +277,7 @@ export interface Answer {
|
|
|
277
277
|
/**
|
|
278
278
|
* @public
|
|
279
279
|
* <p>The notes associated with the workload.</p>
|
|
280
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
280
281
|
*/
|
|
281
282
|
Notes?: string;
|
|
282
283
|
/**
|
|
@@ -923,7 +924,8 @@ export interface CreateLensShareInput {
|
|
|
923
924
|
LensAlias: string | undefined;
|
|
924
925
|
/**
|
|
925
926
|
* @public
|
|
926
|
-
* <p>The Amazon Web Services account ID,
|
|
927
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which
|
|
928
|
+
* the workload, lens, profile, or review template is shared.</p>
|
|
927
929
|
*/
|
|
928
930
|
SharedWith: string | undefined;
|
|
929
931
|
/**
|
|
@@ -1173,7 +1175,8 @@ export interface CreateProfileShareInput {
|
|
|
1173
1175
|
ProfileArn: string | undefined;
|
|
1174
1176
|
/**
|
|
1175
1177
|
* @public
|
|
1176
|
-
* <p>The Amazon Web Services account ID,
|
|
1178
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which
|
|
1179
|
+
* the workload, lens, profile, or review template is shared.</p>
|
|
1177
1180
|
*/
|
|
1178
1181
|
SharedWith: string | undefined;
|
|
1179
1182
|
/**
|
|
@@ -1206,6 +1209,106 @@ export interface CreateProfileShareOutput {
|
|
|
1206
1209
|
*/
|
|
1207
1210
|
ProfileArn?: string;
|
|
1208
1211
|
}
|
|
1212
|
+
/**
|
|
1213
|
+
* @public
|
|
1214
|
+
*/
|
|
1215
|
+
export interface CreateReviewTemplateInput {
|
|
1216
|
+
/**
|
|
1217
|
+
* @public
|
|
1218
|
+
* <p>Name of the review template.</p>
|
|
1219
|
+
*/
|
|
1220
|
+
TemplateName: string | undefined;
|
|
1221
|
+
/**
|
|
1222
|
+
* @public
|
|
1223
|
+
* <p>The review template description.</p>
|
|
1224
|
+
*/
|
|
1225
|
+
Description: string | undefined;
|
|
1226
|
+
/**
|
|
1227
|
+
* @public
|
|
1228
|
+
* <p>Lenses applied to the review template.</p>
|
|
1229
|
+
*/
|
|
1230
|
+
Lenses: string[] | undefined;
|
|
1231
|
+
/**
|
|
1232
|
+
* @public
|
|
1233
|
+
* <p>The notes associated with the workload.</p>
|
|
1234
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
1235
|
+
*/
|
|
1236
|
+
Notes?: string;
|
|
1237
|
+
/**
|
|
1238
|
+
* @public
|
|
1239
|
+
* <p>The tags assigned to the review template.</p>
|
|
1240
|
+
*/
|
|
1241
|
+
Tags?: Record<string, string>;
|
|
1242
|
+
/**
|
|
1243
|
+
* @public
|
|
1244
|
+
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1245
|
+
* (executes only once).</p>
|
|
1246
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
1247
|
+
* the same client request token and the same parameters after the original request has completed
|
|
1248
|
+
* successfully, the result of the original request is returned.</p>
|
|
1249
|
+
* <important>
|
|
1250
|
+
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
1251
|
+
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
1252
|
+
* you must provide this token or the request will fail.</p>
|
|
1253
|
+
* </important>
|
|
1254
|
+
*/
|
|
1255
|
+
ClientRequestToken?: string;
|
|
1256
|
+
}
|
|
1257
|
+
/**
|
|
1258
|
+
* @public
|
|
1259
|
+
*/
|
|
1260
|
+
export interface CreateReviewTemplateOutput {
|
|
1261
|
+
/**
|
|
1262
|
+
* @public
|
|
1263
|
+
* <p>The review template ARN.</p>
|
|
1264
|
+
*/
|
|
1265
|
+
TemplateArn?: string;
|
|
1266
|
+
}
|
|
1267
|
+
/**
|
|
1268
|
+
* @public
|
|
1269
|
+
*/
|
|
1270
|
+
export interface CreateTemplateShareInput {
|
|
1271
|
+
/**
|
|
1272
|
+
* @public
|
|
1273
|
+
* <p>The review template ARN.</p>
|
|
1274
|
+
*/
|
|
1275
|
+
TemplateArn: string | undefined;
|
|
1276
|
+
/**
|
|
1277
|
+
* @public
|
|
1278
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which
|
|
1279
|
+
* the workload, lens, profile, or review template is shared.</p>
|
|
1280
|
+
*/
|
|
1281
|
+
SharedWith: string | undefined;
|
|
1282
|
+
/**
|
|
1283
|
+
* @public
|
|
1284
|
+
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1285
|
+
* (executes only once).</p>
|
|
1286
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
1287
|
+
* the same client request token and the same parameters after the original request has completed
|
|
1288
|
+
* successfully, the result of the original request is returned.</p>
|
|
1289
|
+
* <important>
|
|
1290
|
+
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
1291
|
+
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
1292
|
+
* you must provide this token or the request will fail.</p>
|
|
1293
|
+
* </important>
|
|
1294
|
+
*/
|
|
1295
|
+
ClientRequestToken?: string;
|
|
1296
|
+
}
|
|
1297
|
+
/**
|
|
1298
|
+
* @public
|
|
1299
|
+
*/
|
|
1300
|
+
export interface CreateTemplateShareOutput {
|
|
1301
|
+
/**
|
|
1302
|
+
* @public
|
|
1303
|
+
* <p>The review template ARN.</p>
|
|
1304
|
+
*/
|
|
1305
|
+
TemplateArn?: string;
|
|
1306
|
+
/**
|
|
1307
|
+
* @public
|
|
1308
|
+
* <p>The ID associated with the share.</p>
|
|
1309
|
+
*/
|
|
1310
|
+
ShareId?: string;
|
|
1311
|
+
}
|
|
1209
1312
|
/**
|
|
1210
1313
|
* @public
|
|
1211
1314
|
* @enum
|
|
@@ -1465,11 +1568,14 @@ export interface CreateWorkloadInput {
|
|
|
1465
1568
|
/**
|
|
1466
1569
|
* @public
|
|
1467
1570
|
* <p>The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
1571
|
+
* <p>If a review template that specifies lenses is applied to the workload, those lenses are applied
|
|
1572
|
+
* to the workload in addition to these lenses.</p>
|
|
1468
1573
|
*/
|
|
1469
1574
|
Lenses: string[] | undefined;
|
|
1470
1575
|
/**
|
|
1471
1576
|
* @public
|
|
1472
1577
|
* <p>The notes associated with the workload.</p>
|
|
1578
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
1473
1579
|
*/
|
|
1474
1580
|
Notes?: string;
|
|
1475
1581
|
/**
|
|
@@ -1506,6 +1612,11 @@ export interface CreateWorkloadInput {
|
|
|
1506
1612
|
* <p>The list of profile ARNs associated with the workload.</p>
|
|
1507
1613
|
*/
|
|
1508
1614
|
ProfileArns?: string[];
|
|
1615
|
+
/**
|
|
1616
|
+
* @public
|
|
1617
|
+
* <p>The list of review template ARNs to associate with the workload.</p>
|
|
1618
|
+
*/
|
|
1619
|
+
ReviewTemplateArns?: string[];
|
|
1509
1620
|
}
|
|
1510
1621
|
/**
|
|
1511
1622
|
* @public
|
|
@@ -1547,7 +1658,8 @@ export interface CreateWorkloadShareInput {
|
|
|
1547
1658
|
WorkloadId: string | undefined;
|
|
1548
1659
|
/**
|
|
1549
1660
|
* @public
|
|
1550
|
-
* <p>The Amazon Web Services account ID,
|
|
1661
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which
|
|
1662
|
+
* the workload, lens, profile, or review template is shared.</p>
|
|
1551
1663
|
*/
|
|
1552
1664
|
SharedWith: string | undefined;
|
|
1553
1665
|
/**
|
|
@@ -1724,6 +1836,59 @@ export interface DeleteProfileShareInput {
|
|
|
1724
1836
|
*/
|
|
1725
1837
|
ClientRequestToken?: string;
|
|
1726
1838
|
}
|
|
1839
|
+
/**
|
|
1840
|
+
* @public
|
|
1841
|
+
*/
|
|
1842
|
+
export interface DeleteReviewTemplateInput {
|
|
1843
|
+
/**
|
|
1844
|
+
* @public
|
|
1845
|
+
* <p>The review template ARN.</p>
|
|
1846
|
+
*/
|
|
1847
|
+
TemplateArn: string | undefined;
|
|
1848
|
+
/**
|
|
1849
|
+
* @public
|
|
1850
|
+
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1851
|
+
* (executes only once).</p>
|
|
1852
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
1853
|
+
* the same client request token and the same parameters after the original request has completed
|
|
1854
|
+
* successfully, the result of the original request is returned.</p>
|
|
1855
|
+
* <important>
|
|
1856
|
+
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
1857
|
+
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
1858
|
+
* you must provide this token or the request will fail.</p>
|
|
1859
|
+
* </important>
|
|
1860
|
+
*/
|
|
1861
|
+
ClientRequestToken?: string;
|
|
1862
|
+
}
|
|
1863
|
+
/**
|
|
1864
|
+
* @public
|
|
1865
|
+
*/
|
|
1866
|
+
export interface DeleteTemplateShareInput {
|
|
1867
|
+
/**
|
|
1868
|
+
* @public
|
|
1869
|
+
* <p>The ID associated with the share.</p>
|
|
1870
|
+
*/
|
|
1871
|
+
ShareId: string | undefined;
|
|
1872
|
+
/**
|
|
1873
|
+
* @public
|
|
1874
|
+
* <p>The review template ARN.</p>
|
|
1875
|
+
*/
|
|
1876
|
+
TemplateArn: string | undefined;
|
|
1877
|
+
/**
|
|
1878
|
+
* @public
|
|
1879
|
+
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
1880
|
+
* (executes only once).</p>
|
|
1881
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
1882
|
+
* the same client request token and the same parameters after the original request has completed
|
|
1883
|
+
* successfully, the result of the original request is returned.</p>
|
|
1884
|
+
* <important>
|
|
1885
|
+
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
1886
|
+
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
1887
|
+
* you must provide this token or the request will fail.</p>
|
|
1888
|
+
* </important>
|
|
1889
|
+
*/
|
|
1890
|
+
ClientRequestToken?: string;
|
|
1891
|
+
}
|
|
1727
1892
|
/**
|
|
1728
1893
|
* @public
|
|
1729
1894
|
* <p>Input for workload deletion.</p>
|
|
@@ -2140,6 +2305,7 @@ export interface PillarReviewSummary {
|
|
|
2140
2305
|
/**
|
|
2141
2306
|
* @public
|
|
2142
2307
|
* <p>The notes associated with the workload.</p>
|
|
2308
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
2143
2309
|
*/
|
|
2144
2310
|
Notes?: string;
|
|
2145
2311
|
/**
|
|
@@ -2219,6 +2385,7 @@ export interface LensReview {
|
|
|
2219
2385
|
/**
|
|
2220
2386
|
* @public
|
|
2221
2387
|
* <p>The notes associated with the workload.</p>
|
|
2388
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
2222
2389
|
*/
|
|
2223
2390
|
Notes?: string;
|
|
2224
2391
|
/**
|
|
@@ -2735,6 +2902,7 @@ export interface Workload {
|
|
|
2735
2902
|
/**
|
|
2736
2903
|
* @public
|
|
2737
2904
|
* <p>The notes associated with the workload.</p>
|
|
2905
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
2738
2906
|
*/
|
|
2739
2907
|
Notes?: string;
|
|
2740
2908
|
/**
|
|
@@ -2756,6 +2924,8 @@ export interface Workload {
|
|
|
2756
2924
|
/**
|
|
2757
2925
|
* @public
|
|
2758
2926
|
* <p>The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
2927
|
+
* <p>If a review template that specifies lenses is applied to the workload, those lenses are applied
|
|
2928
|
+
* to the workload in addition to these lenses.</p>
|
|
2759
2929
|
*/
|
|
2760
2930
|
Lenses?: string[];
|
|
2761
2931
|
/**
|
|
@@ -3081,139 +3251,119 @@ export interface GetProfileTemplateOutput {
|
|
|
3081
3251
|
}
|
|
3082
3252
|
/**
|
|
3083
3253
|
* @public
|
|
3084
|
-
* <p>Input to get a workload.</p>
|
|
3085
3254
|
*/
|
|
3086
|
-
export interface
|
|
3255
|
+
export interface GetReviewTemplateInput {
|
|
3087
3256
|
/**
|
|
3088
3257
|
* @public
|
|
3089
|
-
* <p>The
|
|
3258
|
+
* <p>The review template ARN.</p>
|
|
3090
3259
|
*/
|
|
3091
|
-
|
|
3260
|
+
TemplateArn: string | undefined;
|
|
3092
3261
|
}
|
|
3093
3262
|
/**
|
|
3094
3263
|
* @public
|
|
3095
|
-
*
|
|
3264
|
+
* @enum
|
|
3096
3265
|
*/
|
|
3097
|
-
export
|
|
3098
|
-
|
|
3099
|
-
|
|
3100
|
-
|
|
3101
|
-
*/
|
|
3102
|
-
Workload?: Workload;
|
|
3103
|
-
}
|
|
3266
|
+
export declare const Question: {
|
|
3267
|
+
readonly ANSWERED: "ANSWERED";
|
|
3268
|
+
readonly UNANSWERED: "UNANSWERED";
|
|
3269
|
+
};
|
|
3104
3270
|
/**
|
|
3105
3271
|
* @public
|
|
3106
3272
|
*/
|
|
3107
|
-
export
|
|
3273
|
+
export type Question = (typeof Question)[keyof typeof Question];
|
|
3274
|
+
/**
|
|
3275
|
+
* @public
|
|
3276
|
+
* @enum
|
|
3277
|
+
*/
|
|
3278
|
+
export declare const ReviewTemplateUpdateStatus: {
|
|
3279
|
+
readonly CURRENT: "CURRENT";
|
|
3280
|
+
readonly LENS_NOT_CURRENT: "LENS_NOT_CURRENT";
|
|
3281
|
+
};
|
|
3282
|
+
/**
|
|
3283
|
+
* @public
|
|
3284
|
+
*/
|
|
3285
|
+
export type ReviewTemplateUpdateStatus = (typeof ReviewTemplateUpdateStatus)[keyof typeof ReviewTemplateUpdateStatus];
|
|
3286
|
+
/**
|
|
3287
|
+
* @public
|
|
3288
|
+
* <p>A review template.</p>
|
|
3289
|
+
*/
|
|
3290
|
+
export interface ReviewTemplate {
|
|
3108
3291
|
/**
|
|
3109
3292
|
* @public
|
|
3110
|
-
* <p>The
|
|
3111
|
-
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3112
|
-
* <code>serverless</code>, or the lens ARN, such as
|
|
3113
|
-
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3114
|
-
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3115
|
-
* <p>For custom lenses, this is the lens ARN, such as
|
|
3116
|
-
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3117
|
-
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3293
|
+
* <p>The review template description.</p>
|
|
3118
3294
|
*/
|
|
3119
|
-
|
|
3295
|
+
Description?: string;
|
|
3120
3296
|
/**
|
|
3121
3297
|
* @public
|
|
3122
|
-
* <p>The
|
|
3298
|
+
* <p>The lenses applied to the review template.</p>
|
|
3123
3299
|
*/
|
|
3124
|
-
|
|
3300
|
+
Lenses?: string[];
|
|
3125
3301
|
/**
|
|
3126
3302
|
* @public
|
|
3127
|
-
* <p>
|
|
3128
|
-
*
|
|
3129
|
-
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
3130
|
-
* the same client request token and the same parameters after the original request has completed
|
|
3131
|
-
* successfully, the result of the original request is returned.</p>
|
|
3132
|
-
* <important>
|
|
3133
|
-
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
3134
|
-
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
3135
|
-
* you must provide this token or the request will fail.</p>
|
|
3136
|
-
* </important>
|
|
3303
|
+
* <p>The notes associated with the workload.</p>
|
|
3304
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
3137
3305
|
*/
|
|
3138
|
-
|
|
3306
|
+
Notes?: string;
|
|
3139
3307
|
/**
|
|
3140
3308
|
* @public
|
|
3141
|
-
* <p>
|
|
3309
|
+
* <p>A count of how many total questions are answered and unanswered in the review template.</p>
|
|
3142
3310
|
*/
|
|
3143
|
-
|
|
3144
|
-
}
|
|
3145
|
-
/**
|
|
3146
|
-
* @public
|
|
3147
|
-
* @enum
|
|
3148
|
-
*/
|
|
3149
|
-
export declare const ImportLensStatus: {
|
|
3150
|
-
readonly COMPLETE: "COMPLETE";
|
|
3151
|
-
readonly ERROR: "ERROR";
|
|
3152
|
-
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
3153
|
-
};
|
|
3154
|
-
/**
|
|
3155
|
-
* @public
|
|
3156
|
-
*/
|
|
3157
|
-
export type ImportLensStatus = (typeof ImportLensStatus)[keyof typeof ImportLensStatus];
|
|
3158
|
-
/**
|
|
3159
|
-
* @public
|
|
3160
|
-
*/
|
|
3161
|
-
export interface ImportLensOutput {
|
|
3311
|
+
QuestionCounts?: Record<string, number>;
|
|
3162
3312
|
/**
|
|
3163
3313
|
* @public
|
|
3164
|
-
* <p>
|
|
3314
|
+
* <p>An Amazon Web Services account ID.</p>
|
|
3165
3315
|
*/
|
|
3166
|
-
|
|
3316
|
+
Owner?: string;
|
|
3167
3317
|
/**
|
|
3168
3318
|
* @public
|
|
3169
|
-
* <p>The
|
|
3319
|
+
* <p>The date and time recorded.</p>
|
|
3170
3320
|
*/
|
|
3171
|
-
|
|
3172
|
-
}
|
|
3173
|
-
/**
|
|
3174
|
-
* @public
|
|
3175
|
-
* <p>An improvement summary of a lens review in a workload.</p>
|
|
3176
|
-
*/
|
|
3177
|
-
export interface ImprovementSummary {
|
|
3321
|
+
UpdatedAt?: Date;
|
|
3178
3322
|
/**
|
|
3179
3323
|
* @public
|
|
3180
|
-
* <p>The
|
|
3324
|
+
* <p>The review template ARN.</p>
|
|
3181
3325
|
*/
|
|
3182
|
-
|
|
3326
|
+
TemplateArn?: string;
|
|
3183
3327
|
/**
|
|
3184
3328
|
* @public
|
|
3185
|
-
* <p>The
|
|
3186
|
-
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
3329
|
+
* <p>The name of the review template.</p>
|
|
3187
3330
|
*/
|
|
3188
|
-
|
|
3331
|
+
TemplateName?: string;
|
|
3189
3332
|
/**
|
|
3190
3333
|
* @public
|
|
3191
|
-
* <p>The
|
|
3334
|
+
* <p>The tags assigned to the review template.</p>
|
|
3192
3335
|
*/
|
|
3193
|
-
|
|
3336
|
+
Tags?: Record<string, string>;
|
|
3194
3337
|
/**
|
|
3195
3338
|
* @public
|
|
3196
|
-
* <p>The
|
|
3339
|
+
* <p>The latest status of a review template.</p>
|
|
3197
3340
|
*/
|
|
3198
|
-
|
|
3341
|
+
UpdateStatus?: ReviewTemplateUpdateStatus | string;
|
|
3199
3342
|
/**
|
|
3200
3343
|
* @public
|
|
3201
|
-
* <p>The
|
|
3202
|
-
* <p>This value is only available if the question has been answered.</p>
|
|
3203
|
-
* <p>This value does not apply to custom lenses.</p>
|
|
3344
|
+
* <p>The ID assigned to the template share invitation.</p>
|
|
3204
3345
|
*/
|
|
3205
|
-
|
|
3346
|
+
ShareInvitationId?: string;
|
|
3347
|
+
}
|
|
3348
|
+
/**
|
|
3349
|
+
* @public
|
|
3350
|
+
*/
|
|
3351
|
+
export interface GetReviewTemplateOutput {
|
|
3206
3352
|
/**
|
|
3207
3353
|
* @public
|
|
3208
|
-
* <p>The
|
|
3354
|
+
* <p>The review template.</p>
|
|
3209
3355
|
*/
|
|
3210
|
-
|
|
3356
|
+
ReviewTemplate?: ReviewTemplate;
|
|
3211
3357
|
}
|
|
3212
3358
|
/**
|
|
3213
3359
|
* @public
|
|
3214
|
-
* <p>A lens review summary of a workload.</p>
|
|
3215
3360
|
*/
|
|
3216
|
-
export interface
|
|
3361
|
+
export interface GetReviewTemplateAnswerInput {
|
|
3362
|
+
/**
|
|
3363
|
+
* @public
|
|
3364
|
+
* <p>The review template ARN.</p>
|
|
3365
|
+
*/
|
|
3366
|
+
TemplateArn: string | undefined;
|
|
3217
3367
|
/**
|
|
3218
3368
|
* @public
|
|
3219
3369
|
* <p>The alias of the lens.</p>
|
|
@@ -3225,15 +3375,423 @@ export interface LensReviewSummary {
|
|
|
3225
3375
|
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3226
3376
|
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3227
3377
|
*/
|
|
3228
|
-
LensAlias
|
|
3229
|
-
/**
|
|
3230
|
-
* @public
|
|
3231
|
-
* <p>The ARN for the lens.</p>
|
|
3232
|
-
*/
|
|
3233
|
-
LensArn?: string;
|
|
3378
|
+
LensAlias: string | undefined;
|
|
3234
3379
|
/**
|
|
3235
3380
|
* @public
|
|
3236
|
-
* <p>The
|
|
3381
|
+
* <p>The ID of the question.</p>
|
|
3382
|
+
*/
|
|
3383
|
+
QuestionId: string | undefined;
|
|
3384
|
+
}
|
|
3385
|
+
/**
|
|
3386
|
+
* @public
|
|
3387
|
+
* @enum
|
|
3388
|
+
*/
|
|
3389
|
+
export declare const ReviewTemplateAnswerStatus: {
|
|
3390
|
+
readonly ANSWERED: "ANSWERED";
|
|
3391
|
+
readonly UNANSWERED: "UNANSWERED";
|
|
3392
|
+
};
|
|
3393
|
+
/**
|
|
3394
|
+
* @public
|
|
3395
|
+
*/
|
|
3396
|
+
export type ReviewTemplateAnswerStatus = (typeof ReviewTemplateAnswerStatus)[keyof typeof ReviewTemplateAnswerStatus];
|
|
3397
|
+
/**
|
|
3398
|
+
* @public
|
|
3399
|
+
* <p>An answer of the question.</p>
|
|
3400
|
+
*/
|
|
3401
|
+
export interface ReviewTemplateAnswer {
|
|
3402
|
+
/**
|
|
3403
|
+
* @public
|
|
3404
|
+
* <p>The ID of the question.</p>
|
|
3405
|
+
*/
|
|
3406
|
+
QuestionId?: string;
|
|
3407
|
+
/**
|
|
3408
|
+
* @public
|
|
3409
|
+
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
3410
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
3411
|
+
*/
|
|
3412
|
+
PillarId?: string;
|
|
3413
|
+
/**
|
|
3414
|
+
* @public
|
|
3415
|
+
* <p>The title of the question.</p>
|
|
3416
|
+
*/
|
|
3417
|
+
QuestionTitle?: string;
|
|
3418
|
+
/**
|
|
3419
|
+
* @public
|
|
3420
|
+
* <p>The description of the question.</p>
|
|
3421
|
+
*/
|
|
3422
|
+
QuestionDescription?: string;
|
|
3423
|
+
/**
|
|
3424
|
+
* @public
|
|
3425
|
+
* <p>The improvement plan URL for a question in an Amazon Web Services official lenses.</p>
|
|
3426
|
+
* <p>This value is only available if the question has been answered.</p>
|
|
3427
|
+
* <p>This value does not apply to custom lenses.</p>
|
|
3428
|
+
*/
|
|
3429
|
+
ImprovementPlanUrl?: string;
|
|
3430
|
+
/**
|
|
3431
|
+
* @public
|
|
3432
|
+
* <p>The helpful resource URL.</p>
|
|
3433
|
+
* <p>For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.</p>
|
|
3434
|
+
* <p>For custom lenses, this is the helpful resource URL for a question and is only provided
|
|
3435
|
+
* if <code>HelpfulResourceDisplayText</code> was specified for the question.</p>
|
|
3436
|
+
*/
|
|
3437
|
+
HelpfulResourceUrl?: string;
|
|
3438
|
+
/**
|
|
3439
|
+
* @public
|
|
3440
|
+
* <p>The helpful resource text to be displayed for a custom lens.</p>
|
|
3441
|
+
* <note>
|
|
3442
|
+
* <p>This field does not apply to Amazon Web Services official lenses.</p>
|
|
3443
|
+
* </note>
|
|
3444
|
+
*/
|
|
3445
|
+
HelpfulResourceDisplayText?: string;
|
|
3446
|
+
/**
|
|
3447
|
+
* @public
|
|
3448
|
+
* <p>List of choices available for a question.</p>
|
|
3449
|
+
*/
|
|
3450
|
+
Choices?: Choice[];
|
|
3451
|
+
/**
|
|
3452
|
+
* @public
|
|
3453
|
+
* <p>List of selected choice IDs in a question answer.</p>
|
|
3454
|
+
* <p>The values entered replace the previously selected choices.</p>
|
|
3455
|
+
*/
|
|
3456
|
+
SelectedChoices?: string[];
|
|
3457
|
+
/**
|
|
3458
|
+
* @public
|
|
3459
|
+
* <p>A list of selected choices to a question in your review template.</p>
|
|
3460
|
+
*/
|
|
3461
|
+
ChoiceAnswers?: ChoiceAnswer[];
|
|
3462
|
+
/**
|
|
3463
|
+
* @public
|
|
3464
|
+
* <p>Defines whether this question is applicable to a lens review.</p>
|
|
3465
|
+
*/
|
|
3466
|
+
IsApplicable?: boolean;
|
|
3467
|
+
/**
|
|
3468
|
+
* @public
|
|
3469
|
+
* <p>The status of whether or not this question has been answered.</p>
|
|
3470
|
+
*/
|
|
3471
|
+
AnswerStatus?: ReviewTemplateAnswerStatus | string;
|
|
3472
|
+
/**
|
|
3473
|
+
* @public
|
|
3474
|
+
* <p>The notes associated with the workload.</p>
|
|
3475
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
3476
|
+
*/
|
|
3477
|
+
Notes?: string;
|
|
3478
|
+
/**
|
|
3479
|
+
* @public
|
|
3480
|
+
* <p>The reason why the question is not applicable to your review template.</p>
|
|
3481
|
+
*/
|
|
3482
|
+
Reason?: AnswerReason | string;
|
|
3483
|
+
}
|
|
3484
|
+
/**
|
|
3485
|
+
* @public
|
|
3486
|
+
*/
|
|
3487
|
+
export interface GetReviewTemplateAnswerOutput {
|
|
3488
|
+
/**
|
|
3489
|
+
* @public
|
|
3490
|
+
* <p>The review template ARN.</p>
|
|
3491
|
+
*/
|
|
3492
|
+
TemplateArn?: string;
|
|
3493
|
+
/**
|
|
3494
|
+
* @public
|
|
3495
|
+
* <p>The alias of the lens.</p>
|
|
3496
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3497
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
3498
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3499
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3500
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
3501
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3502
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3503
|
+
*/
|
|
3504
|
+
LensAlias?: string;
|
|
3505
|
+
/**
|
|
3506
|
+
* @public
|
|
3507
|
+
* <p>An answer of the question.</p>
|
|
3508
|
+
*/
|
|
3509
|
+
Answer?: ReviewTemplateAnswer;
|
|
3510
|
+
}
|
|
3511
|
+
/**
|
|
3512
|
+
* @public
|
|
3513
|
+
*/
|
|
3514
|
+
export interface GetReviewTemplateLensReviewInput {
|
|
3515
|
+
/**
|
|
3516
|
+
* @public
|
|
3517
|
+
* <p>The review template ARN.</p>
|
|
3518
|
+
*/
|
|
3519
|
+
TemplateArn: string | undefined;
|
|
3520
|
+
/**
|
|
3521
|
+
* @public
|
|
3522
|
+
* <p>The alias of the lens.</p>
|
|
3523
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3524
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
3525
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3526
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3527
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
3528
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3529
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3530
|
+
*/
|
|
3531
|
+
LensAlias: string | undefined;
|
|
3532
|
+
}
|
|
3533
|
+
/**
|
|
3534
|
+
* @public
|
|
3535
|
+
* <p>Summary of a review template.</p>
|
|
3536
|
+
*/
|
|
3537
|
+
export interface ReviewTemplatePillarReviewSummary {
|
|
3538
|
+
/**
|
|
3539
|
+
* @public
|
|
3540
|
+
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
3541
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
3542
|
+
*/
|
|
3543
|
+
PillarId?: string;
|
|
3544
|
+
/**
|
|
3545
|
+
* @public
|
|
3546
|
+
* <p>The name of the pillar.</p>
|
|
3547
|
+
*/
|
|
3548
|
+
PillarName?: string;
|
|
3549
|
+
/**
|
|
3550
|
+
* @public
|
|
3551
|
+
* <p>The notes associated with the workload.</p>
|
|
3552
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
3553
|
+
*/
|
|
3554
|
+
Notes?: string;
|
|
3555
|
+
/**
|
|
3556
|
+
* @public
|
|
3557
|
+
* <p>A count of how many questions are answered and unanswered in the requested pillar of the lens review.</p>
|
|
3558
|
+
*/
|
|
3559
|
+
QuestionCounts?: Record<string, number>;
|
|
3560
|
+
}
|
|
3561
|
+
/**
|
|
3562
|
+
* @public
|
|
3563
|
+
* <p>The lens review of a review template.</p>
|
|
3564
|
+
*/
|
|
3565
|
+
export interface ReviewTemplateLensReview {
|
|
3566
|
+
/**
|
|
3567
|
+
* @public
|
|
3568
|
+
* <p>The alias of the lens.</p>
|
|
3569
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3570
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
3571
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3572
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3573
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
3574
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3575
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3576
|
+
*/
|
|
3577
|
+
LensAlias?: string;
|
|
3578
|
+
/**
|
|
3579
|
+
* @public
|
|
3580
|
+
* <p>The lens ARN.</p>
|
|
3581
|
+
*/
|
|
3582
|
+
LensArn?: string;
|
|
3583
|
+
/**
|
|
3584
|
+
* @public
|
|
3585
|
+
* <p>The version of the lens.</p>
|
|
3586
|
+
*/
|
|
3587
|
+
LensVersion?: string;
|
|
3588
|
+
/**
|
|
3589
|
+
* @public
|
|
3590
|
+
* <p>The full name of the lens.</p>
|
|
3591
|
+
*/
|
|
3592
|
+
LensName?: string;
|
|
3593
|
+
/**
|
|
3594
|
+
* @public
|
|
3595
|
+
* <p>The status of the lens.</p>
|
|
3596
|
+
*/
|
|
3597
|
+
LensStatus?: LensStatus | string;
|
|
3598
|
+
/**
|
|
3599
|
+
* @public
|
|
3600
|
+
* <p>Pillar review summaries of a lens review.</p>
|
|
3601
|
+
*/
|
|
3602
|
+
PillarReviewSummaries?: ReviewTemplatePillarReviewSummary[];
|
|
3603
|
+
/**
|
|
3604
|
+
* @public
|
|
3605
|
+
* <p>The date and time recorded.</p>
|
|
3606
|
+
*/
|
|
3607
|
+
UpdatedAt?: Date;
|
|
3608
|
+
/**
|
|
3609
|
+
* @public
|
|
3610
|
+
* <p>The notes associated with the workload.</p>
|
|
3611
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
3612
|
+
*/
|
|
3613
|
+
Notes?: string;
|
|
3614
|
+
/**
|
|
3615
|
+
* @public
|
|
3616
|
+
* <p>A count of how many questions are answered and unanswered in the lens review.</p>
|
|
3617
|
+
*/
|
|
3618
|
+
QuestionCounts?: Record<string, number>;
|
|
3619
|
+
/**
|
|
3620
|
+
* @public
|
|
3621
|
+
* <p>The token to use to retrieve the next set of results.</p>
|
|
3622
|
+
*/
|
|
3623
|
+
NextToken?: string;
|
|
3624
|
+
}
|
|
3625
|
+
/**
|
|
3626
|
+
* @public
|
|
3627
|
+
*/
|
|
3628
|
+
export interface GetReviewTemplateLensReviewOutput {
|
|
3629
|
+
/**
|
|
3630
|
+
* @public
|
|
3631
|
+
* <p>The review template ARN.</p>
|
|
3632
|
+
*/
|
|
3633
|
+
TemplateArn?: string;
|
|
3634
|
+
/**
|
|
3635
|
+
* @public
|
|
3636
|
+
* <p>A lens review of a question.</p>
|
|
3637
|
+
*/
|
|
3638
|
+
LensReview?: ReviewTemplateLensReview;
|
|
3639
|
+
}
|
|
3640
|
+
/**
|
|
3641
|
+
* @public
|
|
3642
|
+
* <p>Input to get a workload.</p>
|
|
3643
|
+
*/
|
|
3644
|
+
export interface GetWorkloadInput {
|
|
3645
|
+
/**
|
|
3646
|
+
* @public
|
|
3647
|
+
* <p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>
|
|
3648
|
+
*/
|
|
3649
|
+
WorkloadId: string | undefined;
|
|
3650
|
+
}
|
|
3651
|
+
/**
|
|
3652
|
+
* @public
|
|
3653
|
+
* <p>Output of a get workload call.</p>
|
|
3654
|
+
*/
|
|
3655
|
+
export interface GetWorkloadOutput {
|
|
3656
|
+
/**
|
|
3657
|
+
* @public
|
|
3658
|
+
* <p>A workload return object.</p>
|
|
3659
|
+
*/
|
|
3660
|
+
Workload?: Workload;
|
|
3661
|
+
}
|
|
3662
|
+
/**
|
|
3663
|
+
* @public
|
|
3664
|
+
*/
|
|
3665
|
+
export interface ImportLensInput {
|
|
3666
|
+
/**
|
|
3667
|
+
* @public
|
|
3668
|
+
* <p>The alias of the lens.</p>
|
|
3669
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3670
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
3671
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3672
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3673
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
3674
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3675
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3676
|
+
*/
|
|
3677
|
+
LensAlias?: string;
|
|
3678
|
+
/**
|
|
3679
|
+
* @public
|
|
3680
|
+
* <p>The JSON representation of a lens.</p>
|
|
3681
|
+
*/
|
|
3682
|
+
JSONString: string | undefined;
|
|
3683
|
+
/**
|
|
3684
|
+
* @public
|
|
3685
|
+
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
3686
|
+
* (executes only once).</p>
|
|
3687
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
3688
|
+
* the same client request token and the same parameters after the original request has completed
|
|
3689
|
+
* successfully, the result of the original request is returned.</p>
|
|
3690
|
+
* <important>
|
|
3691
|
+
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
3692
|
+
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
3693
|
+
* you must provide this token or the request will fail.</p>
|
|
3694
|
+
* </important>
|
|
3695
|
+
*/
|
|
3696
|
+
ClientRequestToken?: string;
|
|
3697
|
+
/**
|
|
3698
|
+
* @public
|
|
3699
|
+
* <p>Tags to associate to a lens.</p>
|
|
3700
|
+
*/
|
|
3701
|
+
Tags?: Record<string, string>;
|
|
3702
|
+
}
|
|
3703
|
+
/**
|
|
3704
|
+
* @public
|
|
3705
|
+
* @enum
|
|
3706
|
+
*/
|
|
3707
|
+
export declare const ImportLensStatus: {
|
|
3708
|
+
readonly COMPLETE: "COMPLETE";
|
|
3709
|
+
readonly ERROR: "ERROR";
|
|
3710
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
3711
|
+
};
|
|
3712
|
+
/**
|
|
3713
|
+
* @public
|
|
3714
|
+
*/
|
|
3715
|
+
export type ImportLensStatus = (typeof ImportLensStatus)[keyof typeof ImportLensStatus];
|
|
3716
|
+
/**
|
|
3717
|
+
* @public
|
|
3718
|
+
*/
|
|
3719
|
+
export interface ImportLensOutput {
|
|
3720
|
+
/**
|
|
3721
|
+
* @public
|
|
3722
|
+
* <p>The ARN for the lens that was created or updated.</p>
|
|
3723
|
+
*/
|
|
3724
|
+
LensArn?: string;
|
|
3725
|
+
/**
|
|
3726
|
+
* @public
|
|
3727
|
+
* <p>The status of the imported lens.</p>
|
|
3728
|
+
*/
|
|
3729
|
+
Status?: ImportLensStatus | string;
|
|
3730
|
+
}
|
|
3731
|
+
/**
|
|
3732
|
+
* @public
|
|
3733
|
+
* <p>An improvement summary of a lens review in a workload.</p>
|
|
3734
|
+
*/
|
|
3735
|
+
export interface ImprovementSummary {
|
|
3736
|
+
/**
|
|
3737
|
+
* @public
|
|
3738
|
+
* <p>The ID of the question.</p>
|
|
3739
|
+
*/
|
|
3740
|
+
QuestionId?: string;
|
|
3741
|
+
/**
|
|
3742
|
+
* @public
|
|
3743
|
+
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
3744
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
3745
|
+
*/
|
|
3746
|
+
PillarId?: string;
|
|
3747
|
+
/**
|
|
3748
|
+
* @public
|
|
3749
|
+
* <p>The title of the question.</p>
|
|
3750
|
+
*/
|
|
3751
|
+
QuestionTitle?: string;
|
|
3752
|
+
/**
|
|
3753
|
+
* @public
|
|
3754
|
+
* <p>The risk for a given workload, lens review, pillar, or question.</p>
|
|
3755
|
+
*/
|
|
3756
|
+
Risk?: Risk | string;
|
|
3757
|
+
/**
|
|
3758
|
+
* @public
|
|
3759
|
+
* <p>The improvement plan URL for a question in an Amazon Web Services official lenses.</p>
|
|
3760
|
+
* <p>This value is only available if the question has been answered.</p>
|
|
3761
|
+
* <p>This value does not apply to custom lenses.</p>
|
|
3762
|
+
*/
|
|
3763
|
+
ImprovementPlanUrl?: string;
|
|
3764
|
+
/**
|
|
3765
|
+
* @public
|
|
3766
|
+
* <p>The improvement plan details.</p>
|
|
3767
|
+
*/
|
|
3768
|
+
ImprovementPlans?: ChoiceImprovementPlan[];
|
|
3769
|
+
}
|
|
3770
|
+
/**
|
|
3771
|
+
* @public
|
|
3772
|
+
* <p>A lens review summary of a workload.</p>
|
|
3773
|
+
*/
|
|
3774
|
+
export interface LensReviewSummary {
|
|
3775
|
+
/**
|
|
3776
|
+
* @public
|
|
3777
|
+
* <p>The alias of the lens.</p>
|
|
3778
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
3779
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
3780
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
3781
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
3782
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
3783
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
3784
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
3785
|
+
*/
|
|
3786
|
+
LensAlias?: string;
|
|
3787
|
+
/**
|
|
3788
|
+
* @public
|
|
3789
|
+
* <p>The ARN for the lens.</p>
|
|
3790
|
+
*/
|
|
3791
|
+
LensArn?: string;
|
|
3792
|
+
/**
|
|
3793
|
+
* @public
|
|
3794
|
+
* <p>The version of the lens.</p>
|
|
3237
3795
|
*/
|
|
3238
3796
|
LensVersion?: string;
|
|
3239
3797
|
/**
|
|
@@ -3297,7 +3855,8 @@ export interface LensShareSummary {
|
|
|
3297
3855
|
ShareId?: string;
|
|
3298
3856
|
/**
|
|
3299
3857
|
* @public
|
|
3300
|
-
* <p>The Amazon Web Services account ID,
|
|
3858
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which
|
|
3859
|
+
* the workload, lens, profile, or review template is shared.</p>
|
|
3301
3860
|
*/
|
|
3302
3861
|
SharedWith?: string;
|
|
3303
3862
|
/**
|
|
@@ -3431,6 +3990,19 @@ export interface LensUpgradeSummary {
|
|
|
3431
3990
|
* <p>The latest version of the lens.</p>
|
|
3432
3991
|
*/
|
|
3433
3992
|
LatestLensVersion?: string;
|
|
3993
|
+
/**
|
|
3994
|
+
* @public
|
|
3995
|
+
* <p>
|
|
3996
|
+
* <code>ResourceArn</code> of the lens being upgraded</p>
|
|
3997
|
+
*/
|
|
3998
|
+
ResourceArn?: string;
|
|
3999
|
+
/**
|
|
4000
|
+
* @public
|
|
4001
|
+
* <p>The name of the workload.</p>
|
|
4002
|
+
* <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization
|
|
4003
|
+
* are ignored when checking for uniqueness.</p>
|
|
4004
|
+
*/
|
|
4005
|
+
ResourceName?: string;
|
|
3434
4006
|
}
|
|
3435
4007
|
/**
|
|
3436
4008
|
* @public
|
|
@@ -3863,7 +4435,7 @@ export interface ListLensSharesInput {
|
|
|
3863
4435
|
LensAlias: string | undefined;
|
|
3864
4436
|
/**
|
|
3865
4437
|
* @public
|
|
3866
|
-
* <p>The Amazon Web Services account ID,
|
|
4438
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the lens is shared.</p>
|
|
3867
4439
|
*/
|
|
3868
4440
|
SharedWithPrefix?: string;
|
|
3869
4441
|
/**
|
|
@@ -3953,6 +4525,8 @@ export interface WorkloadSummary {
|
|
|
3953
4525
|
/**
|
|
3954
4526
|
* @public
|
|
3955
4527
|
* <p>The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
4528
|
+
* <p>If a review template that specifies lenses is applied to the workload, those lenses are applied
|
|
4529
|
+
* to the workload in addition to these lenses.</p>
|
|
3956
4530
|
*/
|
|
3957
4531
|
Lenses?: string[];
|
|
3958
4532
|
/**
|
|
@@ -4044,6 +4618,14 @@ export interface ListNotificationsInput {
|
|
|
4044
4618
|
* <p>The maximum number of results to return for this request.</p>
|
|
4045
4619
|
*/
|
|
4046
4620
|
MaxResults?: number;
|
|
4621
|
+
/**
|
|
4622
|
+
* @public
|
|
4623
|
+
* <p>The ARN for the related resource for the notification.</p>
|
|
4624
|
+
* <note>
|
|
4625
|
+
* <p>Only one of <code>WorkloadID</code> or <code>ResourceARN</code> should be specified.</p>
|
|
4626
|
+
* </note>
|
|
4627
|
+
*/
|
|
4628
|
+
ResourceArn?: string;
|
|
4047
4629
|
}
|
|
4048
4630
|
/**
|
|
4049
4631
|
* @public
|
|
@@ -4196,7 +4778,8 @@ export type ProfileOwnerType = (typeof ProfileOwnerType)[keyof typeof ProfileOwn
|
|
|
4196
4778
|
export interface ListProfilesInput {
|
|
4197
4779
|
/**
|
|
4198
4780
|
* @public
|
|
4199
|
-
* <p>
|
|
4781
|
+
* <p>An optional string added to the beginning of each profile name returned in the
|
|
4782
|
+
* results.</p>
|
|
4200
4783
|
*/
|
|
4201
4784
|
ProfileNamePrefix?: string;
|
|
4202
4785
|
/**
|
|
@@ -4282,7 +4865,7 @@ export interface ListProfileSharesInput {
|
|
|
4282
4865
|
ProfileArn: string | undefined;
|
|
4283
4866
|
/**
|
|
4284
4867
|
* @public
|
|
4285
|
-
* <p>The Amazon Web Services account ID,
|
|
4868
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.</p>
|
|
4286
4869
|
*/
|
|
4287
4870
|
SharedWithPrefix?: string;
|
|
4288
4871
|
/**
|
|
@@ -4313,7 +4896,8 @@ export interface ProfileShareSummary {
|
|
|
4313
4896
|
ShareId?: string;
|
|
4314
4897
|
/**
|
|
4315
4898
|
* @public
|
|
4316
|
-
* <p>The Amazon Web Services account ID,
|
|
4899
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which
|
|
4900
|
+
* the workload, lens, profile, or review template is shared.</p>
|
|
4317
4901
|
*/
|
|
4318
4902
|
SharedWith?: string;
|
|
4319
4903
|
/**
|
|
@@ -4335,7 +4919,206 @@ export interface ListProfileSharesOutput {
|
|
|
4335
4919
|
* @public
|
|
4336
4920
|
* <p>Profile share summaries.</p>
|
|
4337
4921
|
*/
|
|
4338
|
-
ProfileShareSummaries?: ProfileShareSummary[];
|
|
4922
|
+
ProfileShareSummaries?: ProfileShareSummary[];
|
|
4923
|
+
/**
|
|
4924
|
+
* @public
|
|
4925
|
+
* <p>The token to use to retrieve the next set of results.</p>
|
|
4926
|
+
*/
|
|
4927
|
+
NextToken?: string;
|
|
4928
|
+
}
|
|
4929
|
+
/**
|
|
4930
|
+
* @public
|
|
4931
|
+
*/
|
|
4932
|
+
export interface ListReviewTemplateAnswersInput {
|
|
4933
|
+
/**
|
|
4934
|
+
* @public
|
|
4935
|
+
* <p>The ARN of the review template.</p>
|
|
4936
|
+
*/
|
|
4937
|
+
TemplateArn: string | undefined;
|
|
4938
|
+
/**
|
|
4939
|
+
* @public
|
|
4940
|
+
* <p>The alias of the lens.</p>
|
|
4941
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
4942
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
4943
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
4944
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
4945
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
4946
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
4947
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
4948
|
+
*/
|
|
4949
|
+
LensAlias: string | undefined;
|
|
4950
|
+
/**
|
|
4951
|
+
* @public
|
|
4952
|
+
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
4953
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
4954
|
+
*/
|
|
4955
|
+
PillarId?: string;
|
|
4956
|
+
/**
|
|
4957
|
+
* @public
|
|
4958
|
+
* <p>The token to use to retrieve the next set of results.</p>
|
|
4959
|
+
*/
|
|
4960
|
+
NextToken?: string;
|
|
4961
|
+
/**
|
|
4962
|
+
* @public
|
|
4963
|
+
* <p>The maximum number of results to return for this request.</p>
|
|
4964
|
+
*/
|
|
4965
|
+
MaxResults?: number;
|
|
4966
|
+
}
|
|
4967
|
+
/**
|
|
4968
|
+
* @public
|
|
4969
|
+
* <p>The summary of review template answers.</p>
|
|
4970
|
+
*/
|
|
4971
|
+
export interface ReviewTemplateAnswerSummary {
|
|
4972
|
+
/**
|
|
4973
|
+
* @public
|
|
4974
|
+
* <p>The ID of the question.</p>
|
|
4975
|
+
*/
|
|
4976
|
+
QuestionId?: string;
|
|
4977
|
+
/**
|
|
4978
|
+
* @public
|
|
4979
|
+
* <p>The ID used to identify a pillar, for example, <code>security</code>.</p>
|
|
4980
|
+
* <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>
|
|
4981
|
+
*/
|
|
4982
|
+
PillarId?: string;
|
|
4983
|
+
/**
|
|
4984
|
+
* @public
|
|
4985
|
+
* <p>The title of the question.</p>
|
|
4986
|
+
*/
|
|
4987
|
+
QuestionTitle?: string;
|
|
4988
|
+
/**
|
|
4989
|
+
* @public
|
|
4990
|
+
* <p>List of choices available for a question.</p>
|
|
4991
|
+
*/
|
|
4992
|
+
Choices?: Choice[];
|
|
4993
|
+
/**
|
|
4994
|
+
* @public
|
|
4995
|
+
* <p>List of selected choice IDs in a question answer.</p>
|
|
4996
|
+
* <p>The values entered replace the previously selected choices.</p>
|
|
4997
|
+
*/
|
|
4998
|
+
SelectedChoices?: string[];
|
|
4999
|
+
/**
|
|
5000
|
+
* @public
|
|
5001
|
+
* <p>A list of selected choices to a question in the review template.</p>
|
|
5002
|
+
*/
|
|
5003
|
+
ChoiceAnswerSummaries?: ChoiceAnswerSummary[];
|
|
5004
|
+
/**
|
|
5005
|
+
* @public
|
|
5006
|
+
* <p>Defines whether this question is applicable to a lens review.</p>
|
|
5007
|
+
*/
|
|
5008
|
+
IsApplicable?: boolean;
|
|
5009
|
+
/**
|
|
5010
|
+
* @public
|
|
5011
|
+
* <p>The status of whether or not this question has been answered.</p>
|
|
5012
|
+
*/
|
|
5013
|
+
AnswerStatus?: ReviewTemplateAnswerStatus | string;
|
|
5014
|
+
/**
|
|
5015
|
+
* @public
|
|
5016
|
+
* <p>The reason why a choice is not-applicable to a question in the review template.</p>
|
|
5017
|
+
*/
|
|
5018
|
+
Reason?: AnswerReason | string;
|
|
5019
|
+
/**
|
|
5020
|
+
* @public
|
|
5021
|
+
* <p>The type of question.</p>
|
|
5022
|
+
*/
|
|
5023
|
+
QuestionType?: QuestionType | string;
|
|
5024
|
+
}
|
|
5025
|
+
/**
|
|
5026
|
+
* @public
|
|
5027
|
+
*/
|
|
5028
|
+
export interface ListReviewTemplateAnswersOutput {
|
|
5029
|
+
/**
|
|
5030
|
+
* @public
|
|
5031
|
+
* <p>The ARN of the review template.</p>
|
|
5032
|
+
*/
|
|
5033
|
+
TemplateArn?: string;
|
|
5034
|
+
/**
|
|
5035
|
+
* @public
|
|
5036
|
+
* <p>The alias of the lens.</p>
|
|
5037
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
5038
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
5039
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
5040
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
5041
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
5042
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
5043
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
5044
|
+
*/
|
|
5045
|
+
LensAlias?: string;
|
|
5046
|
+
/**
|
|
5047
|
+
* @public
|
|
5048
|
+
* <p>List of answer summaries of a lens review in a review template.</p>
|
|
5049
|
+
*/
|
|
5050
|
+
AnswerSummaries?: ReviewTemplateAnswerSummary[];
|
|
5051
|
+
/**
|
|
5052
|
+
* @public
|
|
5053
|
+
* <p>The token to use to retrieve the next set of results.</p>
|
|
5054
|
+
*/
|
|
5055
|
+
NextToken?: string;
|
|
5056
|
+
}
|
|
5057
|
+
/**
|
|
5058
|
+
* @public
|
|
5059
|
+
*/
|
|
5060
|
+
export interface ListReviewTemplatesInput {
|
|
5061
|
+
/**
|
|
5062
|
+
* @public
|
|
5063
|
+
* <p>The token to use to retrieve the next set of results.</p>
|
|
5064
|
+
*/
|
|
5065
|
+
NextToken?: string;
|
|
5066
|
+
/**
|
|
5067
|
+
* @public
|
|
5068
|
+
* <p>The maximum number of results to return for this request.</p>
|
|
5069
|
+
*/
|
|
5070
|
+
MaxResults?: number;
|
|
5071
|
+
}
|
|
5072
|
+
/**
|
|
5073
|
+
* @public
|
|
5074
|
+
* <p>Summary of a review template.</p>
|
|
5075
|
+
*/
|
|
5076
|
+
export interface ReviewTemplateSummary {
|
|
5077
|
+
/**
|
|
5078
|
+
* @public
|
|
5079
|
+
* <p>Description of the review template.</p>
|
|
5080
|
+
*/
|
|
5081
|
+
Description?: string;
|
|
5082
|
+
/**
|
|
5083
|
+
* @public
|
|
5084
|
+
* <p>Lenses associated with the review template.</p>
|
|
5085
|
+
*/
|
|
5086
|
+
Lenses?: string[];
|
|
5087
|
+
/**
|
|
5088
|
+
* @public
|
|
5089
|
+
* <p>An Amazon Web Services account ID.</p>
|
|
5090
|
+
*/
|
|
5091
|
+
Owner?: string;
|
|
5092
|
+
/**
|
|
5093
|
+
* @public
|
|
5094
|
+
* <p>The date and time recorded.</p>
|
|
5095
|
+
*/
|
|
5096
|
+
UpdatedAt?: Date;
|
|
5097
|
+
/**
|
|
5098
|
+
* @public
|
|
5099
|
+
* <p>The review template ARN.</p>
|
|
5100
|
+
*/
|
|
5101
|
+
TemplateArn?: string;
|
|
5102
|
+
/**
|
|
5103
|
+
* @public
|
|
5104
|
+
* <p>The name of the review template.</p>
|
|
5105
|
+
*/
|
|
5106
|
+
TemplateName?: string;
|
|
5107
|
+
/**
|
|
5108
|
+
* @public
|
|
5109
|
+
* <p>The latest status of a review template.</p>
|
|
5110
|
+
*/
|
|
5111
|
+
UpdateStatus?: ReviewTemplateUpdateStatus | string;
|
|
5112
|
+
}
|
|
5113
|
+
/**
|
|
5114
|
+
* @public
|
|
5115
|
+
*/
|
|
5116
|
+
export interface ListReviewTemplatesOutput {
|
|
5117
|
+
/**
|
|
5118
|
+
* @public
|
|
5119
|
+
* <p>List of review templates.</p>
|
|
5120
|
+
*/
|
|
5121
|
+
ReviewTemplates?: ReviewTemplateSummary[];
|
|
4339
5122
|
/**
|
|
4340
5123
|
* @public
|
|
4341
5124
|
* <p>The token to use to retrieve the next set of results.</p>
|
|
@@ -4349,6 +5132,7 @@ export interface ListProfileSharesOutput {
|
|
|
4349
5132
|
export declare const ShareResourceType: {
|
|
4350
5133
|
readonly LENS: "LENS";
|
|
4351
5134
|
readonly PROFILE: "PROFILE";
|
|
5135
|
+
readonly TEMPLATE: "TEMPLATE";
|
|
4352
5136
|
readonly WORKLOAD: "WORKLOAD";
|
|
4353
5137
|
};
|
|
4354
5138
|
/**
|
|
@@ -4388,9 +5172,16 @@ export interface ListShareInvitationsInput {
|
|
|
4388
5172
|
MaxResults?: number;
|
|
4389
5173
|
/**
|
|
4390
5174
|
* @public
|
|
4391
|
-
* <p>
|
|
5175
|
+
* <p>An optional string added to the beginning of each profile name returned in the
|
|
5176
|
+
* results.</p>
|
|
4392
5177
|
*/
|
|
4393
5178
|
ProfileNamePrefix?: string;
|
|
5179
|
+
/**
|
|
5180
|
+
* @public
|
|
5181
|
+
* <p>An optional string added to the beginning of each review template name returned in the
|
|
5182
|
+
* results.</p>
|
|
5183
|
+
*/
|
|
5184
|
+
TemplateNamePrefix?: string;
|
|
4394
5185
|
}
|
|
4395
5186
|
/**
|
|
4396
5187
|
* @public
|
|
@@ -4409,7 +5200,8 @@ export interface ShareInvitationSummary {
|
|
|
4409
5200
|
SharedBy?: string;
|
|
4410
5201
|
/**
|
|
4411
5202
|
* @public
|
|
4412
|
-
* <p>The Amazon Web Services account ID,
|
|
5203
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which
|
|
5204
|
+
* the workload, lens, profile, or review template is shared.</p>
|
|
4413
5205
|
*/
|
|
4414
5206
|
SharedWith?: string;
|
|
4415
5207
|
/**
|
|
@@ -4454,6 +5246,16 @@ export interface ShareInvitationSummary {
|
|
|
4454
5246
|
* <p>The profile ARN.</p>
|
|
4455
5247
|
*/
|
|
4456
5248
|
ProfileArn?: string;
|
|
5249
|
+
/**
|
|
5250
|
+
* @public
|
|
5251
|
+
* <p>The name of the review template.</p>
|
|
5252
|
+
*/
|
|
5253
|
+
TemplateName?: string;
|
|
5254
|
+
/**
|
|
5255
|
+
* @public
|
|
5256
|
+
* <p>The review template ARN.</p>
|
|
5257
|
+
*/
|
|
5258
|
+
TemplateArn?: string;
|
|
4457
5259
|
}
|
|
4458
5260
|
/**
|
|
4459
5261
|
* @public
|
|
@@ -4491,6 +5293,84 @@ export interface ListTagsForResourceOutput {
|
|
|
4491
5293
|
*/
|
|
4492
5294
|
Tags?: Record<string, string>;
|
|
4493
5295
|
}
|
|
5296
|
+
/**
|
|
5297
|
+
* @public
|
|
5298
|
+
*/
|
|
5299
|
+
export interface ListTemplateSharesInput {
|
|
5300
|
+
/**
|
|
5301
|
+
* @public
|
|
5302
|
+
* <p>The review template ARN.</p>
|
|
5303
|
+
*/
|
|
5304
|
+
TemplateArn: string | undefined;
|
|
5305
|
+
/**
|
|
5306
|
+
* @public
|
|
5307
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit
|
|
5308
|
+
* (OU) ID with which the profile is shared.</p>
|
|
5309
|
+
*/
|
|
5310
|
+
SharedWithPrefix?: string;
|
|
5311
|
+
/**
|
|
5312
|
+
* @public
|
|
5313
|
+
* <p>The token to use to retrieve the next set of results.</p>
|
|
5314
|
+
*/
|
|
5315
|
+
NextToken?: string;
|
|
5316
|
+
/**
|
|
5317
|
+
* @public
|
|
5318
|
+
* <p>The maximum number of results to return for this request.</p>
|
|
5319
|
+
*/
|
|
5320
|
+
MaxResults?: number;
|
|
5321
|
+
/**
|
|
5322
|
+
* @public
|
|
5323
|
+
* <p>The status of the share request.</p>
|
|
5324
|
+
*/
|
|
5325
|
+
Status?: ShareStatus | string;
|
|
5326
|
+
}
|
|
5327
|
+
/**
|
|
5328
|
+
* @public
|
|
5329
|
+
* <p>Summary of a review template share.</p>
|
|
5330
|
+
*/
|
|
5331
|
+
export interface TemplateShareSummary {
|
|
5332
|
+
/**
|
|
5333
|
+
* @public
|
|
5334
|
+
* <p>The ID associated with the share.</p>
|
|
5335
|
+
*/
|
|
5336
|
+
ShareId?: string;
|
|
5337
|
+
/**
|
|
5338
|
+
* @public
|
|
5339
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which
|
|
5340
|
+
* the workload, lens, profile, or review template is shared.</p>
|
|
5341
|
+
*/
|
|
5342
|
+
SharedWith?: string;
|
|
5343
|
+
/**
|
|
5344
|
+
* @public
|
|
5345
|
+
* <p>The status of the share request.</p>
|
|
5346
|
+
*/
|
|
5347
|
+
Status?: ShareStatus | string;
|
|
5348
|
+
/**
|
|
5349
|
+
* @public
|
|
5350
|
+
* <p>Review template share invitation status message. </p>
|
|
5351
|
+
*/
|
|
5352
|
+
StatusMessage?: string;
|
|
5353
|
+
}
|
|
5354
|
+
/**
|
|
5355
|
+
* @public
|
|
5356
|
+
*/
|
|
5357
|
+
export interface ListTemplateSharesOutput {
|
|
5358
|
+
/**
|
|
5359
|
+
* @public
|
|
5360
|
+
* <p>The review template ARN.</p>
|
|
5361
|
+
*/
|
|
5362
|
+
TemplateArn?: string;
|
|
5363
|
+
/**
|
|
5364
|
+
* @public
|
|
5365
|
+
* <p>A review template share summary return object.</p>
|
|
5366
|
+
*/
|
|
5367
|
+
TemplateShareSummaries?: TemplateShareSummary[];
|
|
5368
|
+
/**
|
|
5369
|
+
* @public
|
|
5370
|
+
* <p>The token to use to retrieve the next set of results.</p>
|
|
5371
|
+
*/
|
|
5372
|
+
NextToken?: string;
|
|
5373
|
+
}
|
|
4494
5374
|
/**
|
|
4495
5375
|
* @public
|
|
4496
5376
|
* <p>Input to list all workloads.</p>
|
|
@@ -4541,7 +5421,7 @@ export interface ListWorkloadSharesInput {
|
|
|
4541
5421
|
WorkloadId: string | undefined;
|
|
4542
5422
|
/**
|
|
4543
5423
|
* @public
|
|
4544
|
-
* <p>The Amazon Web Services account ID,
|
|
5424
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload is shared.</p>
|
|
4545
5425
|
*/
|
|
4546
5426
|
SharedWithPrefix?: string;
|
|
4547
5427
|
/**
|
|
@@ -4572,7 +5452,8 @@ export interface WorkloadShareSummary {
|
|
|
4572
5452
|
ShareId?: string;
|
|
4573
5453
|
/**
|
|
4574
5454
|
* @public
|
|
4575
|
-
* <p>The Amazon Web Services account ID,
|
|
5455
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which
|
|
5456
|
+
* the workload, lens, profile, or review template is shared.</p>
|
|
4576
5457
|
*/
|
|
4577
5458
|
SharedWith?: string;
|
|
4578
5459
|
/**
|
|
@@ -4666,6 +5547,11 @@ export interface ShareInvitation {
|
|
|
4666
5547
|
* <p>The profile ARN.</p>
|
|
4667
5548
|
*/
|
|
4668
5549
|
ProfileArn?: string;
|
|
5550
|
+
/**
|
|
5551
|
+
* @public
|
|
5552
|
+
* <p>The review template ARN.</p>
|
|
5553
|
+
*/
|
|
5554
|
+
TemplateArn?: string;
|
|
4669
5555
|
}
|
|
4670
5556
|
/**
|
|
4671
5557
|
* @public
|
|
@@ -4762,6 +5648,7 @@ export interface UpdateAnswerInput {
|
|
|
4762
5648
|
/**
|
|
4763
5649
|
* @public
|
|
4764
5650
|
* <p>The notes associated with the workload.</p>
|
|
5651
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
4765
5652
|
*/
|
|
4766
5653
|
Notes?: string;
|
|
4767
5654
|
/**
|
|
@@ -4848,11 +5735,13 @@ export interface UpdateLensReviewInput {
|
|
|
4848
5735
|
/**
|
|
4849
5736
|
* @public
|
|
4850
5737
|
* <p>The notes associated with the workload.</p>
|
|
5738
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
4851
5739
|
*/
|
|
4852
5740
|
LensNotes?: string;
|
|
4853
5741
|
/**
|
|
4854
5742
|
* @public
|
|
4855
5743
|
* <p>List of pillar notes of a lens review in a workload.</p>
|
|
5744
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
4856
5745
|
*/
|
|
4857
5746
|
PillarNotes?: Record<string, string>;
|
|
4858
5747
|
}
|
|
@@ -4902,6 +5791,182 @@ export interface UpdateProfileOutput {
|
|
|
4902
5791
|
*/
|
|
4903
5792
|
Profile?: Profile;
|
|
4904
5793
|
}
|
|
5794
|
+
/**
|
|
5795
|
+
* @public
|
|
5796
|
+
*/
|
|
5797
|
+
export interface UpdateReviewTemplateInput {
|
|
5798
|
+
/**
|
|
5799
|
+
* @public
|
|
5800
|
+
* <p>The review template ARN.</p>
|
|
5801
|
+
*/
|
|
5802
|
+
TemplateArn: string | undefined;
|
|
5803
|
+
/**
|
|
5804
|
+
* @public
|
|
5805
|
+
* <p>The review template name.</p>
|
|
5806
|
+
*/
|
|
5807
|
+
TemplateName?: string;
|
|
5808
|
+
/**
|
|
5809
|
+
* @public
|
|
5810
|
+
* <p>The review template description.</p>
|
|
5811
|
+
*/
|
|
5812
|
+
Description?: string;
|
|
5813
|
+
/**
|
|
5814
|
+
* @public
|
|
5815
|
+
* <p>The notes associated with the workload.</p>
|
|
5816
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
5817
|
+
*/
|
|
5818
|
+
Notes?: string;
|
|
5819
|
+
/**
|
|
5820
|
+
* @public
|
|
5821
|
+
* <p>A list of lens aliases or ARNs to apply to the review template.</p>
|
|
5822
|
+
*/
|
|
5823
|
+
LensesToAssociate?: string[];
|
|
5824
|
+
/**
|
|
5825
|
+
* @public
|
|
5826
|
+
* <p>A list of lens aliases or ARNs to unapply to the review template. The <code>wellarchitected</code> lens cannot be unapplied.</p>
|
|
5827
|
+
*/
|
|
5828
|
+
LensesToDisassociate?: string[];
|
|
5829
|
+
}
|
|
5830
|
+
/**
|
|
5831
|
+
* @public
|
|
5832
|
+
*/
|
|
5833
|
+
export interface UpdateReviewTemplateOutput {
|
|
5834
|
+
/**
|
|
5835
|
+
* @public
|
|
5836
|
+
* <p>A review template.</p>
|
|
5837
|
+
*/
|
|
5838
|
+
ReviewTemplate?: ReviewTemplate;
|
|
5839
|
+
}
|
|
5840
|
+
/**
|
|
5841
|
+
* @public
|
|
5842
|
+
*/
|
|
5843
|
+
export interface UpdateReviewTemplateAnswerInput {
|
|
5844
|
+
/**
|
|
5845
|
+
* @public
|
|
5846
|
+
* <p>The review template ARN.</p>
|
|
5847
|
+
*/
|
|
5848
|
+
TemplateArn: string | undefined;
|
|
5849
|
+
/**
|
|
5850
|
+
* @public
|
|
5851
|
+
* <p>The alias of the lens.</p>
|
|
5852
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
5853
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
5854
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
5855
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
5856
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
5857
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
5858
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
5859
|
+
*/
|
|
5860
|
+
LensAlias: string | undefined;
|
|
5861
|
+
/**
|
|
5862
|
+
* @public
|
|
5863
|
+
* <p>The ID of the question.</p>
|
|
5864
|
+
*/
|
|
5865
|
+
QuestionId: string | undefined;
|
|
5866
|
+
/**
|
|
5867
|
+
* @public
|
|
5868
|
+
* <p>List of selected choice IDs in a question answer.</p>
|
|
5869
|
+
* <p>The values entered replace the previously selected choices.</p>
|
|
5870
|
+
*/
|
|
5871
|
+
SelectedChoices?: string[];
|
|
5872
|
+
/**
|
|
5873
|
+
* @public
|
|
5874
|
+
* <p>A list of choices to be updated.</p>
|
|
5875
|
+
*/
|
|
5876
|
+
ChoiceUpdates?: Record<string, ChoiceUpdate>;
|
|
5877
|
+
/**
|
|
5878
|
+
* @public
|
|
5879
|
+
* <p>The notes associated with the workload.</p>
|
|
5880
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
5881
|
+
*/
|
|
5882
|
+
Notes?: string;
|
|
5883
|
+
/**
|
|
5884
|
+
* @public
|
|
5885
|
+
* <p>Defines whether this question is applicable to a lens review.</p>
|
|
5886
|
+
*/
|
|
5887
|
+
IsApplicable?: boolean;
|
|
5888
|
+
/**
|
|
5889
|
+
* @public
|
|
5890
|
+
* <p>The update reason.</p>
|
|
5891
|
+
*/
|
|
5892
|
+
Reason?: AnswerReason | string;
|
|
5893
|
+
}
|
|
5894
|
+
/**
|
|
5895
|
+
* @public
|
|
5896
|
+
*/
|
|
5897
|
+
export interface UpdateReviewTemplateAnswerOutput {
|
|
5898
|
+
/**
|
|
5899
|
+
* @public
|
|
5900
|
+
* <p>The review template ARN.</p>
|
|
5901
|
+
*/
|
|
5902
|
+
TemplateArn?: string;
|
|
5903
|
+
/**
|
|
5904
|
+
* @public
|
|
5905
|
+
* <p>The alias of the lens.</p>
|
|
5906
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
5907
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
5908
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
5909
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
5910
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
5911
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
5912
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
5913
|
+
*/
|
|
5914
|
+
LensAlias?: string;
|
|
5915
|
+
/**
|
|
5916
|
+
* @public
|
|
5917
|
+
* <p>An answer of the question.</p>
|
|
5918
|
+
*/
|
|
5919
|
+
Answer?: ReviewTemplateAnswer;
|
|
5920
|
+
}
|
|
5921
|
+
/**
|
|
5922
|
+
* @public
|
|
5923
|
+
*/
|
|
5924
|
+
export interface UpdateReviewTemplateLensReviewInput {
|
|
5925
|
+
/**
|
|
5926
|
+
* @public
|
|
5927
|
+
* <p>The review template ARN.</p>
|
|
5928
|
+
*/
|
|
5929
|
+
TemplateArn: string | undefined;
|
|
5930
|
+
/**
|
|
5931
|
+
* @public
|
|
5932
|
+
* <p>The alias of the lens.</p>
|
|
5933
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
5934
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
5935
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
5936
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
5937
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
5938
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
5939
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
5940
|
+
*/
|
|
5941
|
+
LensAlias: string | undefined;
|
|
5942
|
+
/**
|
|
5943
|
+
* @public
|
|
5944
|
+
* <p>The notes associated with the workload.</p>
|
|
5945
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
5946
|
+
*/
|
|
5947
|
+
LensNotes?: string;
|
|
5948
|
+
/**
|
|
5949
|
+
* @public
|
|
5950
|
+
* <p>List of pillar notes of a lens review in a workload.</p>
|
|
5951
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
5952
|
+
*/
|
|
5953
|
+
PillarNotes?: Record<string, string>;
|
|
5954
|
+
}
|
|
5955
|
+
/**
|
|
5956
|
+
* @public
|
|
5957
|
+
*/
|
|
5958
|
+
export interface UpdateReviewTemplateLensReviewOutput {
|
|
5959
|
+
/**
|
|
5960
|
+
* @public
|
|
5961
|
+
* <p>The review template ARN.</p>
|
|
5962
|
+
*/
|
|
5963
|
+
TemplateArn?: string;
|
|
5964
|
+
/**
|
|
5965
|
+
* @public
|
|
5966
|
+
* <p>A lens review of a question.</p>
|
|
5967
|
+
*/
|
|
5968
|
+
LensReview?: ReviewTemplateLensReview;
|
|
5969
|
+
}
|
|
4905
5970
|
/**
|
|
4906
5971
|
* @public
|
|
4907
5972
|
* <p>Input for Update Share Invitation</p>
|
|
@@ -5148,6 +6213,7 @@ export interface UpdateWorkloadInput {
|
|
|
5148
6213
|
/**
|
|
5149
6214
|
* @public
|
|
5150
6215
|
* <p>The notes associated with the workload.</p>
|
|
6216
|
+
* <p>For a review template, these are the notes that will be associated with the workload when the template is applied.</p>
|
|
5151
6217
|
*/
|
|
5152
6218
|
Notes?: string;
|
|
5153
6219
|
/**
|
|
@@ -5215,7 +6281,8 @@ export interface WorkloadShare {
|
|
|
5215
6281
|
SharedBy?: string;
|
|
5216
6282
|
/**
|
|
5217
6283
|
* @public
|
|
5218
|
-
* <p>The Amazon Web Services account ID,
|
|
6284
|
+
* <p>The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which
|
|
6285
|
+
* the workload, lens, profile, or review template is shared.</p>
|
|
5219
6286
|
*/
|
|
5220
6287
|
SharedWith?: string;
|
|
5221
6288
|
/**
|
|
@@ -5334,3 +6401,39 @@ export interface UpgradeProfileVersionInput {
|
|
|
5334
6401
|
*/
|
|
5335
6402
|
ClientRequestToken?: string;
|
|
5336
6403
|
}
|
|
6404
|
+
/**
|
|
6405
|
+
* @public
|
|
6406
|
+
*/
|
|
6407
|
+
export interface UpgradeReviewTemplateLensReviewInput {
|
|
6408
|
+
/**
|
|
6409
|
+
* @public
|
|
6410
|
+
* <p>The ARN of the review template.</p>
|
|
6411
|
+
*/
|
|
6412
|
+
TemplateArn: string | undefined;
|
|
6413
|
+
/**
|
|
6414
|
+
* @public
|
|
6415
|
+
* <p>The alias of the lens.</p>
|
|
6416
|
+
* <p>For Amazon Web Services official lenses, this is either the lens alias, such as
|
|
6417
|
+
* <code>serverless</code>, or the lens ARN, such as
|
|
6418
|
+
* <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some
|
|
6419
|
+
* operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.</p>
|
|
6420
|
+
* <p>For custom lenses, this is the lens ARN, such as
|
|
6421
|
+
* <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. </p>
|
|
6422
|
+
* <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>
|
|
6423
|
+
*/
|
|
6424
|
+
LensAlias: string | undefined;
|
|
6425
|
+
/**
|
|
6426
|
+
* @public
|
|
6427
|
+
* <p>A unique case-sensitive string used to ensure that this request is idempotent
|
|
6428
|
+
* (executes only once).</p>
|
|
6429
|
+
* <p>You should not reuse the same token for other requests. If you retry a request with
|
|
6430
|
+
* the same client request token and the same parameters after the original request has completed
|
|
6431
|
+
* successfully, the result of the original request is returned.</p>
|
|
6432
|
+
* <important>
|
|
6433
|
+
* <p>This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs
|
|
6434
|
+
* automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,
|
|
6435
|
+
* you must provide this token or the request will fail.</p>
|
|
6436
|
+
* </important>
|
|
6437
|
+
*/
|
|
6438
|
+
ClientRequestToken?: string;
|
|
6439
|
+
}
|