@aws-sdk/client-qapps 3.696.0 → 3.701.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/README.md +56 -0
  2. package/dist-cjs/QApps.js +14 -0
  3. package/dist-cjs/commands/CreatePresignedUrlCommand.js +26 -0
  4. package/dist-cjs/commands/DescribeQAppPermissionsCommand.js +26 -0
  5. package/dist-cjs/commands/ExportQAppSessionDataCommand.js +26 -0
  6. package/dist-cjs/commands/GetQAppSessionMetadataCommand.js +26 -0
  7. package/dist-cjs/commands/ListQAppSessionDataCommand.js +26 -0
  8. package/dist-cjs/commands/UpdateQAppPermissionsCommand.js +26 -0
  9. package/dist-cjs/commands/UpdateQAppSessionMetadataCommand.js +26 -0
  10. package/dist-cjs/commands/index.js +7 -0
  11. package/dist-cjs/models/models_0.js +24 -1
  12. package/dist-cjs/protocols/Aws_restJson1.js +352 -3
  13. package/dist-es/QApps.js +14 -0
  14. package/dist-es/commands/CreatePresignedUrlCommand.js +22 -0
  15. package/dist-es/commands/DescribeQAppPermissionsCommand.js +22 -0
  16. package/dist-es/commands/ExportQAppSessionDataCommand.js +22 -0
  17. package/dist-es/commands/GetQAppSessionMetadataCommand.js +22 -0
  18. package/dist-es/commands/ListQAppSessionDataCommand.js +22 -0
  19. package/dist-es/commands/UpdateQAppPermissionsCommand.js +22 -0
  20. package/dist-es/commands/UpdateQAppSessionMetadataCommand.js +22 -0
  21. package/dist-es/commands/index.js +7 -0
  22. package/dist-es/models/models_0.js +23 -0
  23. package/dist-es/protocols/Aws_restJson1.js +336 -1
  24. package/dist-types/QApps.d.ts +49 -0
  25. package/dist-types/QAppsClient.d.ts +9 -2
  26. package/dist-types/commands/CreatePresignedUrlCommand.d.ts +102 -0
  27. package/dist-types/commands/CreateQAppCommand.d.ts +13 -4
  28. package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts +102 -0
  29. package/dist-types/commands/ExportQAppSessionDataCommand.d.ts +101 -0
  30. package/dist-types/commands/GetQAppCommand.d.ts +20 -4
  31. package/dist-types/commands/GetQAppSessionCommand.d.ts +13 -2
  32. package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts +103 -0
  33. package/dist-types/commands/ListQAppSessionDataCommand.d.ts +108 -0
  34. package/dist-types/commands/PredictQAppCommand.d.ts +13 -4
  35. package/dist-types/commands/StartQAppSessionCommand.d.ts +5 -0
  36. package/dist-types/commands/UpdateQAppCommand.d.ts +13 -4
  37. package/dist-types/commands/UpdateQAppPermissionsCommand.d.ts +114 -0
  38. package/dist-types/commands/UpdateQAppSessionCommand.d.ts +4 -0
  39. package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts +108 -0
  40. package/dist-types/commands/index.d.ts +7 -0
  41. package/dist-types/models/models_0.d.ts +704 -11
  42. package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
  43. package/dist-types/ts3.4/QApps.d.ts +119 -0
  44. package/dist-types/ts3.4/QAppsClient.d.ts +44 -2
  45. package/dist-types/ts3.4/commands/CreatePresignedUrlCommand.d.ts +51 -0
  46. package/dist-types/ts3.4/commands/DescribeQAppPermissionsCommand.d.ts +51 -0
  47. package/dist-types/ts3.4/commands/ExportQAppSessionDataCommand.d.ts +51 -0
  48. package/dist-types/ts3.4/commands/GetQAppSessionMetadataCommand.d.ts +51 -0
  49. package/dist-types/ts3.4/commands/ListQAppSessionDataCommand.d.ts +51 -0
  50. package/dist-types/ts3.4/commands/UpdateQAppPermissionsCommand.d.ts +51 -0
  51. package/dist-types/ts3.4/commands/UpdateQAppSessionMetadataCommand.d.ts +51 -0
  52. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  53. package/dist-types/ts3.4/models/models_0.d.ts +202 -5
  54. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +84 -0
  55. package/package.json +4 -4
@@ -1,4 +1,5 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { DocumentType as __DocumentType } from "@smithy/types";
2
3
  import { QAppsServiceException as __BaseException } from "./QAppsServiceException";
3
4
  /**
4
5
  * <p>The client is not authorized to perform the requested operation.</p>
@@ -12,12 +13,25 @@ export declare class AccessDeniedException extends __BaseException {
12
13
  */
13
14
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
15
  }
16
+ /**
17
+ * @public
18
+ * @enum
19
+ */
20
+ export declare const Action: {
21
+ readonly READ: "read";
22
+ readonly WRITE: "write";
23
+ };
24
+ /**
25
+ * @public
26
+ */
27
+ export type Action = (typeof Action)[keyof typeof Action];
15
28
  /**
16
29
  * @public
17
30
  * @enum
18
31
  */
19
32
  export declare const CardType: {
20
33
  readonly FILE_UPLOAD: "file-upload";
34
+ readonly FORM_INPUT: "form-input";
21
35
  readonly Q_PLUGIN: "q-plugin";
22
36
  readonly Q_QUERY: "q-query";
23
37
  readonly TEXT_INPUT: "text-input";
@@ -67,6 +81,71 @@ export interface FileUploadCard {
67
81
  */
68
82
  allowOverride?: boolean | undefined;
69
83
  }
84
+ /**
85
+ * @public
86
+ * @enum
87
+ */
88
+ export declare const InputCardComputeMode: {
89
+ readonly APPEND: "append";
90
+ readonly REPLACE: "replace";
91
+ };
92
+ /**
93
+ * @public
94
+ */
95
+ export type InputCardComputeMode = (typeof InputCardComputeMode)[keyof typeof InputCardComputeMode];
96
+ /**
97
+ * <p>The metadata of the form input card.</p>
98
+ * @public
99
+ */
100
+ export interface FormInputCardMetadata {
101
+ /**
102
+ * <p>The JSON schema that defines the shape of the response data.</p>
103
+ * @public
104
+ */
105
+ schema: __DocumentType | undefined;
106
+ }
107
+ /**
108
+ * <p>A card in an Amazon Q App that allows the user to submit a response.</p>
109
+ * @public
110
+ */
111
+ export interface FormInputCard {
112
+ /**
113
+ * <p>The unique identifier of the form input card.</p>
114
+ * @public
115
+ */
116
+ id: string | undefined;
117
+ /**
118
+ * <p>The title of the form input card.</p>
119
+ * @public
120
+ */
121
+ title: string | undefined;
122
+ /**
123
+ * <p>Any dependencies or requirements for the form input card.</p>
124
+ * @public
125
+ */
126
+ dependencies: string[] | undefined;
127
+ /**
128
+ * <p>The type of the card.</p>
129
+ * @public
130
+ */
131
+ type: CardType | undefined;
132
+ /**
133
+ * <p>The metadata that defines the form input card data.</p>
134
+ * @public
135
+ */
136
+ metadata: FormInputCardMetadata | undefined;
137
+ /**
138
+ * <p>The compute mode of the form input card.
139
+ * This property determines whether individual participants of a
140
+ * data collection session can submit multiple response or one response.
141
+ * A compute mode of <code>append</code> shall allow participants
142
+ * to submit the same form multiple times with different values.
143
+ * A compute mode of <code>replace</code>code&gt; shall overwrite
144
+ * the current value for each participant.</p>
145
+ * @public
146
+ */
147
+ computeMode?: InputCardComputeMode | undefined;
148
+ }
70
149
  /**
71
150
  * @public
72
151
  * @enum
@@ -302,6 +381,43 @@ export interface FileUploadCardInput {
302
381
  */
303
382
  allowOverride?: boolean | undefined;
304
383
  }
384
+ /**
385
+ * <p>Represents a form input card for an Amazon Q App.</p>
386
+ * @public
387
+ */
388
+ export interface FormInputCardInput {
389
+ /**
390
+ * <p>The title or label of the form input card.</p>
391
+ * @public
392
+ */
393
+ title: string | undefined;
394
+ /**
395
+ * <p>The unique identifier of the form input card.</p>
396
+ * @public
397
+ */
398
+ id: string | undefined;
399
+ /**
400
+ * <p>The type of the card.</p>
401
+ * @public
402
+ */
403
+ type: CardType | undefined;
404
+ /**
405
+ * <p>The metadata that defines the form input card data.</p>
406
+ * @public
407
+ */
408
+ metadata: FormInputCardMetadata | undefined;
409
+ /**
410
+ * <p>The compute mode of the form input card.
411
+ * This property determines whether individual participants of a
412
+ * data collection session can submit multiple response or one response.
413
+ * A compute mode of <code>append</code> shall allow participants
414
+ * to submit the same form multiple times with different values.
415
+ * A compute mode of <code>replace</code>code&gt; shall overwrite
416
+ * the current value for each participant.</p>
417
+ * @public
418
+ */
419
+ computeMode?: InputCardComputeMode | undefined;
420
+ }
305
421
  /**
306
422
  * <p>The input shape for defining a plugin card in an Amazon Q App.</p>
307
423
  * @public
@@ -665,6 +781,7 @@ export interface BatchUpdateCategoryInput {
665
781
  */
666
782
  export declare const ExecutionStatus: {
667
783
  readonly COMPLETED: "COMPLETED";
784
+ readonly ERROR: "ERROR";
668
785
  readonly IN_PROGRESS: "IN_PROGRESS";
669
786
  readonly WAITING: "WAITING";
670
787
  };
@@ -672,6 +789,27 @@ export declare const ExecutionStatus: {
672
789
  * @public
673
790
  */
674
791
  export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionStatus];
792
+ /**
793
+ * <p>A record created when a user submits a form card.</p>
794
+ * @public
795
+ */
796
+ export interface Submission {
797
+ /**
798
+ * <p>The data submitted by the user.</p>
799
+ * @public
800
+ */
801
+ value?: __DocumentType | undefined;
802
+ /**
803
+ * <p>The unique identifier of the submission.</p>
804
+ * @public
805
+ */
806
+ submissionId?: string | undefined;
807
+ /**
808
+ * <p>The date and time when the card is submitted.</p>
809
+ * @public
810
+ */
811
+ timestamp?: Date | undefined;
812
+ }
675
813
  /**
676
814
  * <p>The current status and value of a card in an active Amazon Q App session.</p>
677
815
  * @public
@@ -687,6 +825,40 @@ export interface CardStatus {
687
825
  * @public
688
826
  */
689
827
  currentValue: string | undefined;
828
+ /**
829
+ * <p>A list of previous submissions, if the card is a form card.</p>
830
+ * @public
831
+ */
832
+ submissions?: Submission[] | undefined;
833
+ }
834
+ /**
835
+ * @public
836
+ * @enum
837
+ */
838
+ export declare const SubmissionMutationKind: {
839
+ readonly add: "add";
840
+ readonly delete: "delete";
841
+ readonly edit: "edit";
842
+ };
843
+ /**
844
+ * @public
845
+ */
846
+ export type SubmissionMutationKind = (typeof SubmissionMutationKind)[keyof typeof SubmissionMutationKind];
847
+ /**
848
+ * <p>Represents an action performed on a submission.</p>
849
+ * @public
850
+ */
851
+ export interface SubmissionMutation {
852
+ /**
853
+ * <p>The unique identifier of the submission.</p>
854
+ * @public
855
+ */
856
+ submissionId: string | undefined;
857
+ /**
858
+ * <p>The operation that is performed on a submission.</p>
859
+ * @public
860
+ */
861
+ mutationType: SubmissionMutationKind | undefined;
690
862
  }
691
863
  /**
692
864
  * <p>The value or result associated with a card in a Amazon Q App session.</p>
@@ -703,6 +875,12 @@ export interface CardValue {
703
875
  * @public
704
876
  */
705
877
  value: string | undefined;
878
+ /**
879
+ * <p>The structure that describes how the current form card value is mutated.
880
+ * Only applies for form cards when multiple responses are allowed.</p>
881
+ * @public
882
+ */
883
+ submissionMutation?: SubmissionMutation | undefined;
706
884
  }
707
885
  /**
708
886
  * <p>A category used to classify and filter library items for Amazon Q Apps.</p>
@@ -851,6 +1029,83 @@ export interface CreateLibraryItemOutput {
851
1029
  */
852
1030
  isVerified?: boolean | undefined;
853
1031
  }
1032
+ /**
1033
+ * @public
1034
+ * @enum
1035
+ */
1036
+ export declare const DocumentScope: {
1037
+ readonly APPLICATION: "APPLICATION";
1038
+ readonly SESSION: "SESSION";
1039
+ };
1040
+ /**
1041
+ * @public
1042
+ */
1043
+ export type DocumentScope = (typeof DocumentScope)[keyof typeof DocumentScope];
1044
+ /**
1045
+ * @public
1046
+ */
1047
+ export interface CreatePresignedUrlInput {
1048
+ /**
1049
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1050
+ * @public
1051
+ */
1052
+ instanceId: string | undefined;
1053
+ /**
1054
+ * <p>The unique identifier of the card the file is associated with.</p>
1055
+ * @public
1056
+ */
1057
+ cardId: string | undefined;
1058
+ /**
1059
+ * <p>The unique identifier of the Q App the file is associated with.</p>
1060
+ * @public
1061
+ */
1062
+ appId: string | undefined;
1063
+ /**
1064
+ * <p>The Base64-encoded SHA-256 digest of the contents of the file to be uploaded.</p>
1065
+ * @public
1066
+ */
1067
+ fileContentsSha256: string | undefined;
1068
+ /**
1069
+ * <p>The name of the file to be uploaded.</p>
1070
+ * @public
1071
+ */
1072
+ fileName: string | undefined;
1073
+ /**
1074
+ * <p>Whether the file is associated with a Q App definition or a specific Q App session.</p>
1075
+ * @public
1076
+ */
1077
+ scope: DocumentScope | undefined;
1078
+ /**
1079
+ * <p>The unique identifier of the Q App session the file is associated with, if applicable.</p>
1080
+ * @public
1081
+ */
1082
+ sessionId?: string | undefined;
1083
+ }
1084
+ /**
1085
+ * @public
1086
+ */
1087
+ export interface CreatePresignedUrlOutput {
1088
+ /**
1089
+ * <p>The unique identifier assigned to the file to be uploaded.</p>
1090
+ * @public
1091
+ */
1092
+ fileId: string | undefined;
1093
+ /**
1094
+ * <p>The URL for a presigned S3 POST operation used to upload a file.</p>
1095
+ * @public
1096
+ */
1097
+ presignedUrl: string | undefined;
1098
+ /**
1099
+ * <p>The form fields to include in the presigned S3 POST operation used to upload a file.</p>
1100
+ * @public
1101
+ */
1102
+ presignedUrlFields: Record<string, string> | undefined;
1103
+ /**
1104
+ * <p>The date and time that the presigned URL will expire in ISO 8601 format.</p>
1105
+ * @public
1106
+ */
1107
+ presignedUrlExpiration: Date | undefined;
1108
+ }
854
1109
  /**
855
1110
  * @public
856
1111
  */
@@ -946,6 +1201,90 @@ export interface DeleteQAppInput {
946
1201
  */
947
1202
  appId: string | undefined;
948
1203
  }
1204
+ /**
1205
+ * @public
1206
+ */
1207
+ export interface DescribeQAppPermissionsInput {
1208
+ /**
1209
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1210
+ * @public
1211
+ */
1212
+ instanceId: string | undefined;
1213
+ /**
1214
+ * <p>The unique identifier of the Amazon Q App for which to retrieve permissions.</p>
1215
+ * @public
1216
+ */
1217
+ appId: string | undefined;
1218
+ }
1219
+ /**
1220
+ * @public
1221
+ * @enum
1222
+ */
1223
+ export declare const UserType: {
1224
+ readonly OWNER: "owner";
1225
+ readonly USER: "user";
1226
+ };
1227
+ /**
1228
+ * @public
1229
+ */
1230
+ export type UserType = (typeof UserType)[keyof typeof UserType];
1231
+ /**
1232
+ * <p>The principal for which the permission applies.</p>
1233
+ * @public
1234
+ */
1235
+ export interface PrincipalOutput {
1236
+ /**
1237
+ * <p>The unique identifier of the user.</p>
1238
+ * @public
1239
+ */
1240
+ userId?: string | undefined;
1241
+ /**
1242
+ * <p>The type of the user.</p>
1243
+ * @public
1244
+ */
1245
+ userType?: UserType | undefined;
1246
+ /**
1247
+ * <p>The email address associated with the user.</p>
1248
+ * @public
1249
+ */
1250
+ email?: string | undefined;
1251
+ }
1252
+ /**
1253
+ * <p>The permission granted to the Amazon Q App.</p>
1254
+ * @public
1255
+ */
1256
+ export interface PermissionOutput {
1257
+ /**
1258
+ * <p>The action associated with the permission.</p>
1259
+ * @public
1260
+ */
1261
+ action: Action | undefined;
1262
+ /**
1263
+ * <p>The principal user to which the permission applies.</p>
1264
+ * @public
1265
+ */
1266
+ principal: PrincipalOutput | undefined;
1267
+ }
1268
+ /**
1269
+ * @public
1270
+ */
1271
+ export interface DescribeQAppPermissionsOutput {
1272
+ /**
1273
+ * <p>The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned.</p>
1274
+ * @public
1275
+ */
1276
+ resourceArn?: string | undefined;
1277
+ /**
1278
+ * <p>The unique identifier of the Amazon Q App for which permissions are returned.</p>
1279
+ * @public
1280
+ */
1281
+ appId?: string | undefined;
1282
+ /**
1283
+ * <p>The list of permissions granted for the Amazon Q App.</p>
1284
+ * @public
1285
+ */
1286
+ permissions?: PermissionOutput[] | undefined;
1287
+ }
949
1288
  /**
950
1289
  * @public
951
1290
  */
@@ -978,16 +1317,39 @@ export interface DisassociateQAppFromUserInput {
978
1317
  }
979
1318
  /**
980
1319
  * @public
981
- * @enum
982
1320
  */
983
- export declare const DocumentScope: {
984
- readonly APPLICATION: "APPLICATION";
985
- readonly SESSION: "SESSION";
986
- };
1321
+ export interface ExportQAppSessionDataInput {
1322
+ /**
1323
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1324
+ * @public
1325
+ */
1326
+ instanceId: string | undefined;
1327
+ /**
1328
+ * <p>The unique identifier of the Q App data collection session.</p>
1329
+ * @public
1330
+ */
1331
+ sessionId: string | undefined;
1332
+ }
987
1333
  /**
988
1334
  * @public
989
1335
  */
990
- export type DocumentScope = (typeof DocumentScope)[keyof typeof DocumentScope];
1336
+ export interface ExportQAppSessionDataOutput {
1337
+ /**
1338
+ * <p>The link where the exported Q App session data can be downloaded from.</p>
1339
+ * @public
1340
+ */
1341
+ csvFileLink: string | undefined;
1342
+ /**
1343
+ * <p>The date and time when the link for the exported Q App session data expires.</p>
1344
+ * @public
1345
+ */
1346
+ expiresAt: Date | undefined;
1347
+ /**
1348
+ * <p>The Amazon Resource Name (ARN) of the Q App data collection session.</p>
1349
+ * @public
1350
+ */
1351
+ sessionArn: string | undefined;
1352
+ }
991
1353
  /**
992
1354
  * @public
993
1355
  */
@@ -1092,6 +1454,11 @@ export interface GetQAppInput {
1092
1454
  * @public
1093
1455
  */
1094
1456
  appId: string | undefined;
1457
+ /**
1458
+ * <p>The version of the Q App.</p>
1459
+ * @public
1460
+ */
1461
+ appVersion?: number | undefined;
1095
1462
  }
1096
1463
  /**
1097
1464
  * @public
@@ -1122,6 +1489,21 @@ export interface GetQAppSessionOutput {
1122
1489
  * @public
1123
1490
  */
1124
1491
  sessionArn: string | undefined;
1492
+ /**
1493
+ * <p>The name of the Q App session.</p>
1494
+ * @public
1495
+ */
1496
+ sessionName?: string | undefined;
1497
+ /**
1498
+ * <p>The version of the Q App used for the session.</p>
1499
+ * @public
1500
+ */
1501
+ appVersion?: number | undefined;
1502
+ /**
1503
+ * <p>The latest published version of the Q App used for the session.</p>
1504
+ * @public
1505
+ */
1506
+ latestPublishedAppVersion?: number | undefined;
1125
1507
  /**
1126
1508
  * <p>The current status of the Q App session.</p>
1127
1509
  * @public
@@ -1132,6 +1514,77 @@ export interface GetQAppSessionOutput {
1132
1514
  * @public
1133
1515
  */
1134
1516
  cardStatus: Record<string, CardStatus> | undefined;
1517
+ /**
1518
+ * <p>Indicates whether the current user is the owner of the Q App data collection session.</p>
1519
+ * @public
1520
+ */
1521
+ userIsHost?: boolean | undefined;
1522
+ }
1523
+ /**
1524
+ * @public
1525
+ */
1526
+ export interface GetQAppSessionMetadataInput {
1527
+ /**
1528
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1529
+ * @public
1530
+ */
1531
+ instanceId: string | undefined;
1532
+ /**
1533
+ * <p>The unique identifier of the Q App session.</p>
1534
+ * @public
1535
+ */
1536
+ sessionId: string | undefined;
1537
+ }
1538
+ /**
1539
+ * <p>The sharing configuration of an Amazon Q App data collection session.</p>
1540
+ * @public
1541
+ */
1542
+ export interface SessionSharingConfiguration {
1543
+ /**
1544
+ * <p>Indicates whether an Q App session is shareable with other users.</p>
1545
+ * @public
1546
+ */
1547
+ enabled: boolean | undefined;
1548
+ /**
1549
+ * <p>Indicates whether an Q App session can accept responses from users.</p>
1550
+ * @public
1551
+ */
1552
+ acceptResponses?: boolean | undefined;
1553
+ /**
1554
+ * <p>Indicates whether collected responses for an Q App session are revealed for all users.</p>
1555
+ * @public
1556
+ */
1557
+ revealCards?: boolean | undefined;
1558
+ }
1559
+ /**
1560
+ * @public
1561
+ */
1562
+ export interface GetQAppSessionMetadataOutput {
1563
+ /**
1564
+ * <p>The unique identifier of the Q App session.</p>
1565
+ * @public
1566
+ */
1567
+ sessionId: string | undefined;
1568
+ /**
1569
+ * <p>The Amazon Resource Name (ARN) of the Q App session.</p>
1570
+ * @public
1571
+ */
1572
+ sessionArn: string | undefined;
1573
+ /**
1574
+ * <p>The name of the Q App session.</p>
1575
+ * @public
1576
+ */
1577
+ sessionName?: string | undefined;
1578
+ /**
1579
+ * <p>The sharing configuration of the Q App data collection session.</p>
1580
+ * @public
1581
+ */
1582
+ sharingConfiguration: SessionSharingConfiguration | undefined;
1583
+ /**
1584
+ * <p>Indicates whether the current user is the owner of the Q App session.</p>
1585
+ * @public
1586
+ */
1587
+ sessionOwner?: boolean | undefined;
1135
1588
  }
1136
1589
  /**
1137
1590
  * @public
@@ -1143,7 +1596,7 @@ export interface ImportDocumentInput {
1143
1596
  */
1144
1597
  instanceId: string | undefined;
1145
1598
  /**
1146
- * <p>The unique identifier of the card the file is associated with, if applicable.</p>
1599
+ * <p>The unique identifier of the card the file is associated with.</p>
1147
1600
  * @public
1148
1601
  */
1149
1602
  cardId: string | undefined;
@@ -1163,7 +1616,7 @@ export interface ImportDocumentInput {
1163
1616
  */
1164
1617
  fileName: string | undefined;
1165
1618
  /**
1166
- * <p>Whether the file is associated with an Q App definition or a specific Q App session.</p>
1619
+ * <p>Whether the file is associated with a Q App definition or a specific Q App session.</p>
1167
1620
  * @public
1168
1621
  */
1169
1622
  scope: DocumentScope | undefined;
@@ -1409,6 +1862,89 @@ export interface ListQAppsOutput {
1409
1862
  */
1410
1863
  nextToken?: string | undefined;
1411
1864
  }
1865
+ /**
1866
+ * @public
1867
+ */
1868
+ export interface ListQAppSessionDataInput {
1869
+ /**
1870
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
1871
+ * @public
1872
+ */
1873
+ instanceId: string | undefined;
1874
+ /**
1875
+ * <p>The unique identifier of the Q App data collection session.</p>
1876
+ * @public
1877
+ */
1878
+ sessionId: string | undefined;
1879
+ }
1880
+ /**
1881
+ * <p>A user of an Amazon Q App.</p>
1882
+ * @public
1883
+ */
1884
+ export interface User {
1885
+ /**
1886
+ * <p>The unique identifier of a user.</p>
1887
+ * @public
1888
+ */
1889
+ userId?: string | undefined;
1890
+ }
1891
+ /**
1892
+ * <p>The response collected for a Amazon Q App session.
1893
+ * This container represents a single response to a Q App session.</p>
1894
+ * @public
1895
+ */
1896
+ export interface QAppSessionData {
1897
+ /**
1898
+ * <p>The card Id associated with the response submitted for a Q App session.</p>
1899
+ * @public
1900
+ */
1901
+ cardId: string | undefined;
1902
+ /**
1903
+ * <p>The response submitted for a Q App session.</p>
1904
+ * @public
1905
+ */
1906
+ value?: __DocumentType | undefined;
1907
+ /**
1908
+ * <p>The user who submitted the response for a Q App session.</p>
1909
+ * @public
1910
+ */
1911
+ user: User | undefined;
1912
+ /**
1913
+ * <p>The unique identifier of the submission.</p>
1914
+ * @public
1915
+ */
1916
+ submissionId?: string | undefined;
1917
+ /**
1918
+ * <p>The date and time when the session data is submitted.</p>
1919
+ * @public
1920
+ */
1921
+ timestamp?: Date | undefined;
1922
+ }
1923
+ /**
1924
+ * @public
1925
+ */
1926
+ export interface ListQAppSessionDataOutput {
1927
+ /**
1928
+ * <p>The unique identifier of the Q App data collection session.</p>
1929
+ * @public
1930
+ */
1931
+ sessionId: string | undefined;
1932
+ /**
1933
+ * <p>The Amazon Resource Name (ARN) of the Q App data collection session.</p>
1934
+ * @public
1935
+ */
1936
+ sessionArn: string | undefined;
1937
+ /**
1938
+ * <p>The collected responses of a Q App session.</p>
1939
+ * @public
1940
+ */
1941
+ sessionData?: QAppSessionData[] | undefined;
1942
+ /**
1943
+ * <p> The pagination token that indicates the next set of results to retrieve.</p>
1944
+ * @public
1945
+ */
1946
+ nextToken?: string | undefined;
1947
+ }
1412
1948
  /**
1413
1949
  * @public
1414
1950
  */
@@ -1429,6 +1965,22 @@ export interface ListTagsForResourceResponse {
1429
1965
  */
1430
1966
  tags?: Record<string, string> | undefined;
1431
1967
  }
1968
+ /**
1969
+ * <p>The permission to grant or revoke for a Amazon Q App.</p>
1970
+ * @public
1971
+ */
1972
+ export interface PermissionInput {
1973
+ /**
1974
+ * <p>The action associated with the permission.</p>
1975
+ * @public
1976
+ */
1977
+ action: Action | undefined;
1978
+ /**
1979
+ * <p>The principal user to which the permission applies.</p>
1980
+ * @public
1981
+ */
1982
+ principal: string | undefined;
1983
+ }
1432
1984
  /**
1433
1985
  * <p>The input options for generating an Q App definition.</p>
1434
1986
  * @public
@@ -1510,6 +2062,11 @@ export interface StartQAppSessionInput {
1510
2062
  * @public
1511
2063
  */
1512
2064
  initialValues?: CardValue[] | undefined;
2065
+ /**
2066
+ * <p>The unique identifier of the a Q App session.</p>
2067
+ * @public
2068
+ */
2069
+ sessionId?: string | undefined;
1513
2070
  /**
1514
2071
  * <p>Optional tags to associate with the new Q App session.</p>
1515
2072
  * @public
@@ -1521,7 +2078,7 @@ export interface StartQAppSessionInput {
1521
2078
  */
1522
2079
  export interface StartQAppSessionOutput {
1523
2080
  /**
1524
- * <p>The unique identifier of the new Q App session.</p>
2081
+ * <p>The unique identifier of the new or retrieved Q App session.</p>
1525
2082
  * @public
1526
2083
  */
1527
2084
  sessionId: string | undefined;
@@ -1766,6 +2323,51 @@ export interface UpdateQAppOutput {
1766
2323
  */
1767
2324
  requiredCapabilities?: AppRequiredCapability[] | undefined;
1768
2325
  }
2326
+ /**
2327
+ * @public
2328
+ */
2329
+ export interface UpdateQAppPermissionsInput {
2330
+ /**
2331
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
2332
+ * @public
2333
+ */
2334
+ instanceId: string | undefined;
2335
+ /**
2336
+ * <p>The unique identifier of the Amazon Q App for which permissions are being updated.</p>
2337
+ * @public
2338
+ */
2339
+ appId: string | undefined;
2340
+ /**
2341
+ * <p>The list of permissions to grant for the Amazon Q App.</p>
2342
+ * @public
2343
+ */
2344
+ grantPermissions?: PermissionInput[] | undefined;
2345
+ /**
2346
+ * <p>The list of permissions to revoke for the Amazon Q App.</p>
2347
+ * @public
2348
+ */
2349
+ revokePermissions?: PermissionInput[] | undefined;
2350
+ }
2351
+ /**
2352
+ * @public
2353
+ */
2354
+ export interface UpdateQAppPermissionsOutput {
2355
+ /**
2356
+ * <p>The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated.</p>
2357
+ * @public
2358
+ */
2359
+ resourceArn?: string | undefined;
2360
+ /**
2361
+ * <p>The unique identifier of the Amazon Q App for which permissions were updated.</p>
2362
+ * @public
2363
+ */
2364
+ appId?: string | undefined;
2365
+ /**
2366
+ * <p>The updated list of permissions for the Amazon Q App.</p>
2367
+ * @public
2368
+ */
2369
+ permissions?: PermissionOutput[] | undefined;
2370
+ }
1769
2371
  /**
1770
2372
  * @public
1771
2373
  */
@@ -1801,6 +2403,56 @@ export interface UpdateQAppSessionOutput {
1801
2403
  */
1802
2404
  sessionArn: string | undefined;
1803
2405
  }
2406
+ /**
2407
+ * @public
2408
+ */
2409
+ export interface UpdateQAppSessionMetadataInput {
2410
+ /**
2411
+ * <p>The unique identifier of the Amazon Q Business application environment instance.</p>
2412
+ * @public
2413
+ */
2414
+ instanceId: string | undefined;
2415
+ /**
2416
+ * <p>The unique identifier of the Q App session to update configuration for.</p>
2417
+ * @public
2418
+ */
2419
+ sessionId: string | undefined;
2420
+ /**
2421
+ * <p>The new name for the Q App session.</p>
2422
+ * @public
2423
+ */
2424
+ sessionName?: string | undefined;
2425
+ /**
2426
+ * <p>The new sharing configuration for the Q App data collection session.</p>
2427
+ * @public
2428
+ */
2429
+ sharingConfiguration: SessionSharingConfiguration | undefined;
2430
+ }
2431
+ /**
2432
+ * @public
2433
+ */
2434
+ export interface UpdateQAppSessionMetadataOutput {
2435
+ /**
2436
+ * <p>The unique identifier of the updated Q App session.</p>
2437
+ * @public
2438
+ */
2439
+ sessionId: string | undefined;
2440
+ /**
2441
+ * <p>The Amazon Resource Name (ARN) of the updated Q App session.</p>
2442
+ * @public
2443
+ */
2444
+ sessionArn: string | undefined;
2445
+ /**
2446
+ * <p>The new name of the updated Q App session.</p>
2447
+ * @public
2448
+ */
2449
+ sessionName?: string | undefined;
2450
+ /**
2451
+ * <p>The new sharing configuration of the updated Q App data collection session.</p>
2452
+ * @public
2453
+ */
2454
+ sharingConfiguration: SessionSharingConfiguration | undefined;
2455
+ }
1804
2456
  /**
1805
2457
  * <p>The filter criteria used on responses based on document attributes or metadata fields.</p>
1806
2458
  * @public
@@ -1913,6 +2565,11 @@ export interface QQueryCard {
1913
2565
  * @public
1914
2566
  */
1915
2567
  attributeFilter?: AttributeFilter | undefined;
2568
+ /**
2569
+ * <p>Any dependencies for the query card, where the dependencies are references to the collected responses.</p>
2570
+ * @public
2571
+ */
2572
+ memoryReferences?: string[] | undefined;
1916
2573
  }
1917
2574
  /**
1918
2575
  * <p>The input shape for defining a query card in an Amazon Q App.</p>
@@ -1954,7 +2611,7 @@ export interface QQueryCardInput {
1954
2611
  * <p>A card representing a component or step in an Amazon Q App's flow.</p>
1955
2612
  * @public
1956
2613
  */
1957
- export type Card = Card.FileUploadMember | Card.QPluginMember | Card.QQueryMember | Card.TextInputMember | Card.$UnknownMember;
2614
+ export type Card = Card.FileUploadMember | Card.FormInputMember | Card.QPluginMember | Card.QQueryMember | Card.TextInputMember | Card.$UnknownMember;
1958
2615
  /**
1959
2616
  * @public
1960
2617
  */
@@ -1968,6 +2625,7 @@ export declare namespace Card {
1968
2625
  qQuery?: never;
1969
2626
  qPlugin?: never;
1970
2627
  fileUpload?: never;
2628
+ formInput?: never;
1971
2629
  $unknown?: never;
1972
2630
  }
1973
2631
  /**
@@ -1979,6 +2637,7 @@ export declare namespace Card {
1979
2637
  qQuery: QQueryCard;
1980
2638
  qPlugin?: never;
1981
2639
  fileUpload?: never;
2640
+ formInput?: never;
1982
2641
  $unknown?: never;
1983
2642
  }
1984
2643
  /**
@@ -1990,6 +2649,7 @@ export declare namespace Card {
1990
2649
  qQuery?: never;
1991
2650
  qPlugin: QPluginCard;
1992
2651
  fileUpload?: never;
2652
+ formInput?: never;
1993
2653
  $unknown?: never;
1994
2654
  }
1995
2655
  /**
@@ -2001,6 +2661,19 @@ export declare namespace Card {
2001
2661
  qQuery?: never;
2002
2662
  qPlugin?: never;
2003
2663
  fileUpload: FileUploadCard;
2664
+ formInput?: never;
2665
+ $unknown?: never;
2666
+ }
2667
+ /**
2668
+ * <p>A container for the properties of the form input card.</p>
2669
+ * @public
2670
+ */
2671
+ interface FormInputMember {
2672
+ textInput?: never;
2673
+ qQuery?: never;
2674
+ qPlugin?: never;
2675
+ fileUpload?: never;
2676
+ formInput: FormInputCard;
2004
2677
  $unknown?: never;
2005
2678
  }
2006
2679
  /**
@@ -2011,6 +2684,7 @@ export declare namespace Card {
2011
2684
  qQuery?: never;
2012
2685
  qPlugin?: never;
2013
2686
  fileUpload?: never;
2687
+ formInput?: never;
2014
2688
  $unknown: [string, any];
2015
2689
  }
2016
2690
  interface Visitor<T> {
@@ -2018,6 +2692,7 @@ export declare namespace Card {
2018
2692
  qQuery: (value: QQueryCard) => T;
2019
2693
  qPlugin: (value: QPluginCard) => T;
2020
2694
  fileUpload: (value: FileUploadCard) => T;
2695
+ formInput: (value: FormInputCard) => T;
2021
2696
  _: (name: string, value: any) => T;
2022
2697
  }
2023
2698
  const visit: <T>(value: Card, visitor: Visitor<T>) => T;
@@ -2026,7 +2701,7 @@ export declare namespace Card {
2026
2701
  * <p>The properties defining an input card in an Amazon Q App.</p>
2027
2702
  * @public
2028
2703
  */
2029
- export type CardInput = CardInput.FileUploadMember | CardInput.QPluginMember | CardInput.QQueryMember | CardInput.TextInputMember | CardInput.$UnknownMember;
2704
+ export type CardInput = CardInput.FileUploadMember | CardInput.FormInputMember | CardInput.QPluginMember | CardInput.QQueryMember | CardInput.TextInputMember | CardInput.$UnknownMember;
2030
2705
  /**
2031
2706
  * @public
2032
2707
  */
@@ -2040,6 +2715,7 @@ export declare namespace CardInput {
2040
2715
  qQuery?: never;
2041
2716
  qPlugin?: never;
2042
2717
  fileUpload?: never;
2718
+ formInput?: never;
2043
2719
  $unknown?: never;
2044
2720
  }
2045
2721
  /**
@@ -2051,6 +2727,7 @@ export declare namespace CardInput {
2051
2727
  qQuery: QQueryCardInput;
2052
2728
  qPlugin?: never;
2053
2729
  fileUpload?: never;
2730
+ formInput?: never;
2054
2731
  $unknown?: never;
2055
2732
  }
2056
2733
  /**
@@ -2062,6 +2739,7 @@ export declare namespace CardInput {
2062
2739
  qQuery?: never;
2063
2740
  qPlugin: QPluginCardInput;
2064
2741
  fileUpload?: never;
2742
+ formInput?: never;
2065
2743
  $unknown?: never;
2066
2744
  }
2067
2745
  /**
@@ -2073,6 +2751,19 @@ export declare namespace CardInput {
2073
2751
  qQuery?: never;
2074
2752
  qPlugin?: never;
2075
2753
  fileUpload: FileUploadCardInput;
2754
+ formInput?: never;
2755
+ $unknown?: never;
2756
+ }
2757
+ /**
2758
+ * <p>A container for the properties of the form input card.</p>
2759
+ * @public
2760
+ */
2761
+ interface FormInputMember {
2762
+ textInput?: never;
2763
+ qQuery?: never;
2764
+ qPlugin?: never;
2765
+ fileUpload?: never;
2766
+ formInput: FormInputCardInput;
2076
2767
  $unknown?: never;
2077
2768
  }
2078
2769
  /**
@@ -2083,6 +2774,7 @@ export declare namespace CardInput {
2083
2774
  qQuery?: never;
2084
2775
  qPlugin?: never;
2085
2776
  fileUpload?: never;
2777
+ formInput?: never;
2086
2778
  $unknown: [string, any];
2087
2779
  }
2088
2780
  interface Visitor<T> {
@@ -2090,6 +2782,7 @@ export declare namespace CardInput {
2090
2782
  qQuery: (value: QQueryCardInput) => T;
2091
2783
  qPlugin: (value: QPluginCardInput) => T;
2092
2784
  fileUpload: (value: FileUploadCardInput) => T;
2785
+ formInput: (value: FormInputCardInput) => T;
2093
2786
  _: (name: string, value: any) => T;
2094
2787
  }
2095
2788
  const visit: <T>(value: CardInput, visitor: Visitor<T>) => T;