@aws-sdk/client-qbusiness 3.703.0 → 3.707.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 (144) hide show
  1. package/README.md +96 -0
  2. package/dist-cjs/index.js +797 -42
  3. package/dist-es/QBusiness.js +24 -0
  4. package/dist-es/commands/AssociatePermissionCommand.js +22 -0
  5. package/dist-es/commands/ChatCommand.js +2 -1
  6. package/dist-es/commands/CreateDataAccessorCommand.js +23 -0
  7. package/dist-es/commands/DeleteDataAccessorCommand.js +22 -0
  8. package/dist-es/commands/DisassociatePermissionCommand.js +22 -0
  9. package/dist-es/commands/GetDataAccessorCommand.js +23 -0
  10. package/dist-es/commands/GetPolicyCommand.js +22 -0
  11. package/dist-es/commands/ListDataAccessorsCommand.js +23 -0
  12. package/dist-es/commands/ListPluginActionsCommand.js +22 -0
  13. package/dist-es/commands/ListPluginTypeActionsCommand.js +22 -0
  14. package/dist-es/commands/ListPluginTypeMetadataCommand.js +22 -0
  15. package/dist-es/commands/SearchRelevantContentCommand.js +22 -0
  16. package/dist-es/commands/UpdateDataAccessorCommand.js +23 -0
  17. package/dist-es/commands/index.js +12 -0
  18. package/dist-es/models/index.js +1 -0
  19. package/dist-es/models/models_0.js +59 -52
  20. package/dist-es/models/models_1.js +54 -0
  21. package/dist-es/pagination/ListDataAccessorsPaginator.js +4 -0
  22. package/dist-es/pagination/ListPluginActionsPaginator.js +4 -0
  23. package/dist-es/pagination/ListPluginTypeActionsPaginator.js +4 -0
  24. package/dist-es/pagination/ListPluginTypeMetadataPaginator.js +4 -0
  25. package/dist-es/pagination/SearchRelevantContentPaginator.js +4 -0
  26. package/dist-es/pagination/index.js +5 -0
  27. package/dist-es/protocols/Aws_restJson1.js +451 -4
  28. package/dist-types/QBusiness.d.ts +85 -0
  29. package/dist-types/QBusinessClient.d.ts +14 -2
  30. package/dist-types/commands/AssociatePermissionCommand.d.ts +105 -0
  31. package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +2 -2
  32. package/dist-types/commands/BatchPutDocumentCommand.d.ts +2 -2
  33. package/dist-types/commands/ChatCommand.d.ts +5 -4
  34. package/dist-types/commands/ChatSyncCommand.d.ts +5 -4
  35. package/dist-types/commands/CreateApplicationCommand.d.ts +6 -3
  36. package/dist-types/commands/CreateDataAccessorCommand.d.ts +203 -0
  37. package/dist-types/commands/CreateDataSourceCommand.d.ts +2 -2
  38. package/dist-types/commands/CreateIndexCommand.d.ts +2 -2
  39. package/dist-types/commands/CreatePluginCommand.d.ts +9 -3
  40. package/dist-types/commands/CreateRetrieverCommand.d.ts +2 -2
  41. package/dist-types/commands/CreateUserCommand.d.ts +2 -2
  42. package/dist-types/commands/CreateWebExperienceCommand.d.ts +8 -2
  43. package/dist-types/commands/DeleteApplicationCommand.d.ts +2 -2
  44. package/dist-types/commands/DeleteChatControlsConfigurationCommand.d.ts +2 -2
  45. package/dist-types/commands/DeleteConversationCommand.d.ts +2 -2
  46. package/dist-types/commands/DeleteDataAccessorCommand.d.ts +95 -0
  47. package/dist-types/commands/DeleteDataSourceCommand.d.ts +2 -2
  48. package/dist-types/commands/DeleteGroupCommand.d.ts +2 -2
  49. package/dist-types/commands/DeleteIndexCommand.d.ts +2 -2
  50. package/dist-types/commands/DeletePluginCommand.d.ts +2 -2
  51. package/dist-types/commands/DeleteRetrieverCommand.d.ts +2 -2
  52. package/dist-types/commands/DeleteUserCommand.d.ts +2 -2
  53. package/dist-types/commands/DeleteWebExperienceCommand.d.ts +2 -2
  54. package/dist-types/commands/DisassociatePermissionCommand.d.ts +95 -0
  55. package/dist-types/commands/GetApplicationCommand.d.ts +6 -3
  56. package/dist-types/commands/GetChatControlsConfigurationCommand.d.ts +2 -2
  57. package/dist-types/commands/GetDataAccessorCommand.d.ts +191 -0
  58. package/dist-types/commands/GetDataSourceCommand.d.ts +2 -2
  59. package/dist-types/commands/GetGroupCommand.d.ts +2 -2
  60. package/dist-types/commands/GetIndexCommand.d.ts +2 -2
  61. package/dist-types/commands/GetMediaCommand.d.ts +2 -2
  62. package/dist-types/commands/GetPluginCommand.d.ts +9 -3
  63. package/dist-types/commands/GetPolicyCommand.d.ts +92 -0
  64. package/dist-types/commands/GetRetrieverCommand.d.ts +2 -2
  65. package/dist-types/commands/GetUserCommand.d.ts +2 -2
  66. package/dist-types/commands/GetWebExperienceCommand.d.ts +8 -2
  67. package/dist-types/commands/ListApplicationsCommand.d.ts +4 -1
  68. package/dist-types/commands/ListAttachmentsCommand.d.ts +2 -2
  69. package/dist-types/commands/ListConversationsCommand.d.ts +2 -2
  70. package/dist-types/commands/ListDataAccessorsCommand.d.ts +106 -0
  71. package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +2 -2
  72. package/dist-types/commands/ListDataSourcesCommand.d.ts +2 -2
  73. package/dist-types/commands/ListDocumentsCommand.d.ts +2 -2
  74. package/dist-types/commands/ListGroupsCommand.d.ts +2 -2
  75. package/dist-types/commands/ListIndicesCommand.d.ts +2 -2
  76. package/dist-types/commands/ListMessagesCommand.d.ts +3 -3
  77. package/dist-types/commands/ListPluginActionsCommand.d.ts +102 -0
  78. package/dist-types/commands/ListPluginTypeActionsCommand.d.ts +98 -0
  79. package/dist-types/commands/ListPluginTypeMetadataCommand.d.ts +95 -0
  80. package/dist-types/commands/ListPluginsCommand.d.ts +3 -3
  81. package/dist-types/commands/ListRetrieversCommand.d.ts +3 -3
  82. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
  83. package/dist-types/commands/ListWebExperiencesCommand.d.ts +2 -2
  84. package/dist-types/commands/PutFeedbackCommand.d.ts +2 -2
  85. package/dist-types/commands/PutGroupCommand.d.ts +2 -2
  86. package/dist-types/commands/SearchRelevantContentCommand.d.ts +214 -0
  87. package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +4 -3
  88. package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +3 -3
  89. package/dist-types/commands/TagResourceCommand.d.ts +3 -3
  90. package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
  91. package/dist-types/commands/UpdateApplicationCommand.d.ts +2 -2
  92. package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +3 -3
  93. package/dist-types/commands/UpdateDataAccessorCommand.d.ts +186 -0
  94. package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -2
  95. package/dist-types/commands/UpdateIndexCommand.d.ts +2 -2
  96. package/dist-types/commands/UpdatePluginCommand.d.ts +8 -2
  97. package/dist-types/commands/UpdateRetrieverCommand.d.ts +2 -2
  98. package/dist-types/commands/UpdateUserCommand.d.ts +3 -3
  99. package/dist-types/commands/UpdateWebExperienceCommand.d.ts +8 -2
  100. package/dist-types/commands/index.d.ts +12 -0
  101. package/dist-types/models/index.d.ts +1 -0
  102. package/dist-types/models/models_0.d.ts +735 -636
  103. package/dist-types/models/models_1.d.ts +742 -0
  104. package/dist-types/pagination/ListDataAccessorsPaginator.d.ts +7 -0
  105. package/dist-types/pagination/ListPluginActionsPaginator.d.ts +7 -0
  106. package/dist-types/pagination/ListPluginTypeActionsPaginator.d.ts +7 -0
  107. package/dist-types/pagination/ListPluginTypeMetadataPaginator.d.ts +7 -0
  108. package/dist-types/pagination/SearchRelevantContentPaginator.d.ts +7 -0
  109. package/dist-types/pagination/index.d.ts +5 -0
  110. package/dist-types/protocols/Aws_restJson1.d.ts +108 -0
  111. package/dist-types/ts3.4/QBusiness.d.ts +205 -0
  112. package/dist-types/ts3.4/QBusinessClient.d.ts +72 -0
  113. package/dist-types/ts3.4/commands/AssociatePermissionCommand.d.ts +51 -0
  114. package/dist-types/ts3.4/commands/ChatCommand.d.ts +2 -1
  115. package/dist-types/ts3.4/commands/ChatSyncCommand.d.ts +2 -1
  116. package/dist-types/ts3.4/commands/CreateDataAccessorCommand.d.ts +49 -0
  117. package/dist-types/ts3.4/commands/DeleteDataAccessorCommand.d.ts +51 -0
  118. package/dist-types/ts3.4/commands/DisassociatePermissionCommand.d.ts +51 -0
  119. package/dist-types/ts3.4/commands/GetDataAccessorCommand.d.ts +48 -0
  120. package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +47 -0
  121. package/dist-types/ts3.4/commands/ListDataAccessorsCommand.d.ts +51 -0
  122. package/dist-types/ts3.4/commands/ListPluginActionsCommand.d.ts +51 -0
  123. package/dist-types/ts3.4/commands/ListPluginTypeActionsCommand.d.ts +51 -0
  124. package/dist-types/ts3.4/commands/ListPluginTypeMetadataCommand.d.ts +51 -0
  125. package/dist-types/ts3.4/commands/SearchRelevantContentCommand.d.ts +49 -0
  126. package/dist-types/ts3.4/commands/StartDataSourceSyncJobCommand.d.ts +2 -4
  127. package/dist-types/ts3.4/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
  128. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  129. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  130. package/dist-types/ts3.4/commands/UpdateChatControlsConfigurationCommand.d.ts +1 -1
  131. package/dist-types/ts3.4/commands/UpdateDataAccessorCommand.d.ts +49 -0
  132. package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +1 -1
  133. package/dist-types/ts3.4/commands/index.d.ts +12 -0
  134. package/dist-types/ts3.4/models/index.d.ts +1 -0
  135. package/dist-types/ts3.4/models/models_0.d.ts +250 -224
  136. package/dist-types/ts3.4/models/models_1.d.ts +239 -0
  137. package/dist-types/ts3.4/pagination/ListDataAccessorsPaginator.d.ts +11 -0
  138. package/dist-types/ts3.4/pagination/ListPluginActionsPaginator.d.ts +11 -0
  139. package/dist-types/ts3.4/pagination/ListPluginTypeActionsPaginator.d.ts +11 -0
  140. package/dist-types/ts3.4/pagination/ListPluginTypeMetadataPaginator.d.ts +11 -0
  141. package/dist-types/ts3.4/pagination/SearchRelevantContentPaginator.d.ts +11 -0
  142. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  143. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +144 -0
  144. package/package.json +1 -1
@@ -171,6 +171,98 @@ export declare class AccessDeniedException extends __BaseException {
171
171
  */
172
172
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
173
173
  }
174
+ /**
175
+ * <p>The value of a document attribute. You can only provide one value for a document
176
+ * attribute.</p>
177
+ * @public
178
+ */
179
+ export type DocumentAttributeValue = DocumentAttributeValue.DateValueMember | DocumentAttributeValue.LongValueMember | DocumentAttributeValue.StringListValueMember | DocumentAttributeValue.StringValueMember | DocumentAttributeValue.$UnknownMember;
180
+ /**
181
+ * @public
182
+ */
183
+ export declare namespace DocumentAttributeValue {
184
+ /**
185
+ * <p>A string.</p>
186
+ * @public
187
+ */
188
+ interface StringValueMember {
189
+ stringValue: string;
190
+ stringListValue?: never;
191
+ longValue?: never;
192
+ dateValue?: never;
193
+ $unknown?: never;
194
+ }
195
+ /**
196
+ * <p>A list of strings.</p>
197
+ * @public
198
+ */
199
+ interface StringListValueMember {
200
+ stringValue?: never;
201
+ stringListValue: string[];
202
+ longValue?: never;
203
+ dateValue?: never;
204
+ $unknown?: never;
205
+ }
206
+ /**
207
+ * <p>A long integer value. </p>
208
+ * @public
209
+ */
210
+ interface LongValueMember {
211
+ stringValue?: never;
212
+ stringListValue?: never;
213
+ longValue: number;
214
+ dateValue?: never;
215
+ $unknown?: never;
216
+ }
217
+ /**
218
+ * <p>A date expressed as an ISO 8601 string.</p>
219
+ * <p>It's important for the time zone to be included in the ISO 8601 date-time format. For
220
+ * example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012
221
+ * at 12:30PM (plus 10 seconds) in Central European Time. </p>
222
+ * @public
223
+ */
224
+ interface DateValueMember {
225
+ stringValue?: never;
226
+ stringListValue?: never;
227
+ longValue?: never;
228
+ dateValue: Date;
229
+ $unknown?: never;
230
+ }
231
+ /**
232
+ * @public
233
+ */
234
+ interface $UnknownMember {
235
+ stringValue?: never;
236
+ stringListValue?: never;
237
+ longValue?: never;
238
+ dateValue?: never;
239
+ $unknown: [string, any];
240
+ }
241
+ interface Visitor<T> {
242
+ stringValue: (value: string) => T;
243
+ stringListValue: (value: string[]) => T;
244
+ longValue: (value: number) => T;
245
+ dateValue: (value: Date) => T;
246
+ _: (name: string, value: any) => T;
247
+ }
248
+ const visit: <T>(value: DocumentAttributeValue, visitor: Visitor<T>) => T;
249
+ }
250
+ /**
251
+ * <p>A document attribute or metadata field.</p>
252
+ * @public
253
+ */
254
+ export interface DocumentAttribute {
255
+ /**
256
+ * <p>The identifier for the attribute.</p>
257
+ * @public
258
+ */
259
+ name: string | undefined;
260
+ /**
261
+ * <p>The value of the attribute. </p>
262
+ * @public
263
+ */
264
+ value: DocumentAttributeValue | undefined;
265
+ }
174
266
  /**
175
267
  * <p>A user input field in an plugin action execution payload.</p>
176
268
  * @public
@@ -308,7 +400,7 @@ export interface ActionReviewPayloadField {
308
400
  allowedFormat?: string | undefined;
309
401
  /**
310
402
  * <p>Use to create a custom form with array fields (fields with nested objects inside an
311
- * array). </p>
403
+ * array).</p>
312
404
  * @public
313
405
  */
314
406
  arrayItemJsonSchema?: __DocumentType | undefined;
@@ -323,11 +415,23 @@ export interface ActionReviewPayloadField {
323
415
  * @enum
324
416
  */
325
417
  export declare const PluginType: {
418
+ readonly ASANA: "ASANA";
419
+ readonly ATLASSIAN_CONFLUENCE: "ATLASSIAN_CONFLUENCE";
326
420
  readonly CUSTOM: "CUSTOM";
421
+ readonly GOOGLE_CALENDAR: "GOOGLE_CALENDAR";
327
422
  readonly JIRA: "JIRA";
423
+ readonly JIRA_CLOUD: "JIRA_CLOUD";
424
+ readonly MICROSOFT_EXCHANGE: "MICROSOFT_EXCHANGE";
425
+ readonly MICROSOFT_TEAMS: "MICROSOFT_TEAMS";
426
+ readonly PAGERDUTY_ADVANCE: "PAGERDUTY_ADVANCE";
427
+ readonly QUICKSIGHT: "QUICKSIGHT";
328
428
  readonly SALESFORCE: "SALESFORCE";
429
+ readonly SALESFORCE_CRM: "SALESFORCE_CRM";
430
+ readonly SERVICENOW_NOW_PLATFORM: "SERVICENOW_NOW_PLATFORM";
329
431
  readonly SERVICE_NOW: "SERVICE_NOW";
432
+ readonly SMARTSHEET: "SMARTSHEET";
330
433
  readonly ZENDESK: "ZENDESK";
434
+ readonly ZENDESK_SUITE: "ZENDESK_SUITE";
331
435
  };
332
436
  /**
333
437
  * @public
@@ -412,6 +516,44 @@ export interface ActionReviewEvent {
412
516
  */
413
517
  payloadFieldNameSeparator?: string | undefined;
414
518
  }
519
+ /**
520
+ * <p>Summary information for an Amazon Q Business plugin action.</p>
521
+ * @public
522
+ */
523
+ export interface ActionSummary {
524
+ /**
525
+ * <p>The identifier of an Amazon Q Business plugin action.</p>
526
+ * @public
527
+ */
528
+ actionIdentifier?: string | undefined;
529
+ /**
530
+ * <p>The display name assigned by Amazon Q Business to a plugin action. You can't
531
+ * modify this value.</p>
532
+ * @public
533
+ */
534
+ displayName?: string | undefined;
535
+ /**
536
+ * <p>An Amazon Q Business suggested prompt and end user can use to invoke a plugin
537
+ * action. This value can be modified and sent as input to initiate an action. For
538
+ * example:</p>
539
+ * <ul>
540
+ * <li>
541
+ * <p>Create a Jira task</p>
542
+ * </li>
543
+ * <li>
544
+ * <p>Create a chat assistant task to find the root cause of a specific
545
+ * incident</p>
546
+ * </li>
547
+ * </ul>
548
+ * @public
549
+ */
550
+ instructionExample?: string | undefined;
551
+ /**
552
+ * <p>The description of an Amazon Q Business plugin action.</p>
553
+ * @public
554
+ */
555
+ description?: string | undefined;
556
+ }
415
557
  /**
416
558
  * <p>Information required for Amazon Q Business to find a specific file in an Amazon S3
417
559
  * bucket.</p>
@@ -495,11 +637,27 @@ export declare const IdentityType: {
495
637
  readonly AWS_IAM_IDC: "AWS_IAM_IDC";
496
638
  readonly AWS_IAM_IDP_OIDC: "AWS_IAM_IDP_OIDC";
497
639
  readonly AWS_IAM_IDP_SAML: "AWS_IAM_IDP_SAML";
640
+ readonly AWS_QUICKSIGHT_IDP: "AWS_QUICKSIGHT_IDP";
498
641
  };
499
642
  /**
500
643
  * @public
501
644
  */
502
645
  export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
646
+ /**
647
+ * <p>The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
648
+ * For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html">Creating an
649
+ * Amazon QuickSight integrated application</a>.</p>
650
+ * @public
651
+ */
652
+ export interface QuickSightConfiguration {
653
+ /**
654
+ * <p>The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see
655
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html">Namespace operations</a>.
656
+ * </p>
657
+ * @public
658
+ */
659
+ clientNamespace: string | undefined;
660
+ }
503
661
  /**
504
662
  * @public
505
663
  * @enum
@@ -551,6 +709,11 @@ export interface Application {
551
709
  * @public
552
710
  */
553
711
  identityType?: IdentityType | undefined;
712
+ /**
713
+ * <p>The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.</p>
714
+ * @public
715
+ */
716
+ quickSightConfiguration?: QuickSightConfiguration | undefined;
554
717
  }
555
718
  /**
556
719
  * <p>You are trying to perform an action that conflicts with the current status of your
@@ -762,6 +925,13 @@ export interface CreateApplicationRequest {
762
925
  * @public
763
926
  */
764
927
  personalizationConfiguration?: PersonalizationConfiguration | undefined;
928
+ /**
929
+ * <p>The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is
930
+ * required if your application uses QuickSight as the identity provider. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html">Creating an
931
+ * Amazon QuickSight integrated application</a>.</p>
932
+ * @public
933
+ */
934
+ quickSightConfiguration?: QuickSightConfiguration | undefined;
765
935
  }
766
936
  /**
767
937
  * @public
@@ -792,8 +962,8 @@ export declare class InternalServerException extends __BaseException {
792
962
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
793
963
  }
794
964
  /**
795
- * <p>The resource you want to use doesn’t exist. Make sure you have provided the correct
796
- * resource and try again.</p>
965
+ * <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
966
+ * provided the correct resource and try again.</p>
797
967
  * @public
798
968
  */
799
969
  export declare class ResourceNotFoundException extends __BaseException {
@@ -902,6 +1072,142 @@ export declare class ValidationException extends __BaseException {
902
1072
  */
903
1073
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
904
1074
  }
1075
+ /**
1076
+ * @public
1077
+ */
1078
+ export interface CreateDataAccessorResponse {
1079
+ /**
1080
+ * <p>The unique identifier of the created data accessor.</p>
1081
+ * @public
1082
+ */
1083
+ dataAccessorId: string | undefined;
1084
+ /**
1085
+ * <p>The Amazon Resource Name (ARN) of the AWS IAM Identity Center application created for this data accessor.</p>
1086
+ * @public
1087
+ */
1088
+ idcApplicationArn: string | undefined;
1089
+ /**
1090
+ * <p>The Amazon Resource Name (ARN) of the created data accessor.</p>
1091
+ * @public
1092
+ */
1093
+ dataAccessorArn: string | undefined;
1094
+ }
1095
+ /**
1096
+ * @public
1097
+ */
1098
+ export interface DeleteDataAccessorRequest {
1099
+ /**
1100
+ * <p>The unique identifier of the Q Business application.</p>
1101
+ * @public
1102
+ */
1103
+ applicationId: string | undefined;
1104
+ /**
1105
+ * <p>The unique identifier of the data accessor to delete.</p>
1106
+ * @public
1107
+ */
1108
+ dataAccessorId: string | undefined;
1109
+ }
1110
+ /**
1111
+ * @public
1112
+ */
1113
+ export interface DeleteDataAccessorResponse {
1114
+ }
1115
+ /**
1116
+ * @public
1117
+ */
1118
+ export interface GetDataAccessorRequest {
1119
+ /**
1120
+ * <p>The unique identifier of the Q Business application.</p>
1121
+ * @public
1122
+ */
1123
+ applicationId: string | undefined;
1124
+ /**
1125
+ * <p>The unique identifier of the data accessor to retrieve.</p>
1126
+ * @public
1127
+ */
1128
+ dataAccessorId: string | undefined;
1129
+ }
1130
+ /**
1131
+ * @public
1132
+ */
1133
+ export interface ListDataAccessorsRequest {
1134
+ /**
1135
+ * <p>The unique identifier of the Q Business application.</p>
1136
+ * @public
1137
+ */
1138
+ applicationId: string | undefined;
1139
+ /**
1140
+ * <p>The token for the next set of results. (You received this token from a previous call.)</p>
1141
+ * @public
1142
+ */
1143
+ nextToken?: string | undefined;
1144
+ /**
1145
+ * <p>The maximum number of results to return in a single call.</p>
1146
+ * @public
1147
+ */
1148
+ maxResults?: number | undefined;
1149
+ }
1150
+ /**
1151
+ * <p>Provides summary information about a data accessor.</p>
1152
+ * @public
1153
+ */
1154
+ export interface DataAccessor {
1155
+ /**
1156
+ * <p>The friendly name of the data accessor.</p>
1157
+ * @public
1158
+ */
1159
+ displayName?: string | undefined;
1160
+ /**
1161
+ * <p>The unique identifier of the data accessor.</p>
1162
+ * @public
1163
+ */
1164
+ dataAccessorId?: string | undefined;
1165
+ /**
1166
+ * <p>The Amazon Resource Name (ARN) of the data accessor.</p>
1167
+ * @public
1168
+ */
1169
+ dataAccessorArn?: string | undefined;
1170
+ /**
1171
+ * <p>The Amazon Resource Name (ARN) of the associated AWS IAM Identity Center application.</p>
1172
+ * @public
1173
+ */
1174
+ idcApplicationArn?: string | undefined;
1175
+ /**
1176
+ * <p>The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.</p>
1177
+ * @public
1178
+ */
1179
+ principal?: string | undefined;
1180
+ /**
1181
+ * <p>The timestamp when the data accessor was created.</p>
1182
+ * @public
1183
+ */
1184
+ createdAt?: Date | undefined;
1185
+ /**
1186
+ * <p>The timestamp when the data accessor was last updated.</p>
1187
+ * @public
1188
+ */
1189
+ updatedAt?: Date | undefined;
1190
+ }
1191
+ /**
1192
+ * @public
1193
+ */
1194
+ export interface ListDataAccessorsResponse {
1195
+ /**
1196
+ * <p>The list of data accessors.</p>
1197
+ * @public
1198
+ */
1199
+ dataAccessors?: DataAccessor[] | undefined;
1200
+ /**
1201
+ * <p>The token to use to retrieve the next set of results, if there are any.</p>
1202
+ * @public
1203
+ */
1204
+ nextToken?: string | undefined;
1205
+ }
1206
+ /**
1207
+ * @public
1208
+ */
1209
+ export interface UpdateDataAccessorResponse {
1210
+ }
905
1211
  /**
906
1212
  * @public
907
1213
  */
@@ -1118,6 +1424,11 @@ export interface GetApplicationResponse {
1118
1424
  * @public
1119
1425
  */
1120
1426
  clientIdsForOIDC?: string[] | undefined;
1427
+ /**
1428
+ * <p>The Amazon QuickSight authentication configuration for the Amazon Q Business application.</p>
1429
+ * @public
1430
+ */
1431
+ quickSightConfiguration?: QuickSightConfiguration | undefined;
1121
1432
  }
1122
1433
  /**
1123
1434
  * <p>Provides information about index capacity configuration.</p>
@@ -1226,98 +1537,22 @@ export declare const DocumentEnrichmentConditionOperator: {
1226
1537
  */
1227
1538
  export type DocumentEnrichmentConditionOperator = (typeof DocumentEnrichmentConditionOperator)[keyof typeof DocumentEnrichmentConditionOperator];
1228
1539
  /**
1229
- * <p>The value of a document attribute. You can only provide one value for a document
1230
- * attribute.</p>
1231
- * @public
1232
- */
1233
- export type DocumentAttributeValue = DocumentAttributeValue.DateValueMember | DocumentAttributeValue.LongValueMember | DocumentAttributeValue.StringListValueMember | DocumentAttributeValue.StringValueMember | DocumentAttributeValue.$UnknownMember;
1234
- /**
1540
+ * <p>The condition used for the target document attribute or metadata field when ingesting
1541
+ * documents into Amazon Q Business. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
1542
+ * <code>DocumentAttributeTarget</code>
1543
+ * </a> to apply the condition.</p>
1544
+ * <p>For example, you can create the 'Department' target field and have it prefill
1545
+ * department names associated with the documents based on information in the 'Source_URI'
1546
+ * field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI
1547
+ * value, then prefill the target field 'Department' with the target value 'Finance' for
1548
+ * the document.</p>
1549
+ * <p>Amazon Q Business can't create a target field if it has not already been created as an
1550
+ * index field. After you create your index field, you can create a document metadata field
1551
+ * using <code>DocumentAttributeTarget</code>. Amazon Q Business then will map your newly
1552
+ * created metadata field to your index field.</p>
1235
1553
  * @public
1236
1554
  */
1237
- export declare namespace DocumentAttributeValue {
1238
- /**
1239
- * <p>A string.</p>
1240
- * @public
1241
- */
1242
- interface StringValueMember {
1243
- stringValue: string;
1244
- stringListValue?: never;
1245
- longValue?: never;
1246
- dateValue?: never;
1247
- $unknown?: never;
1248
- }
1249
- /**
1250
- * <p>A list of strings.</p>
1251
- * @public
1252
- */
1253
- interface StringListValueMember {
1254
- stringValue?: never;
1255
- stringListValue: string[];
1256
- longValue?: never;
1257
- dateValue?: never;
1258
- $unknown?: never;
1259
- }
1260
- /**
1261
- * <p>A long integer value. </p>
1262
- * @public
1263
- */
1264
- interface LongValueMember {
1265
- stringValue?: never;
1266
- stringListValue?: never;
1267
- longValue: number;
1268
- dateValue?: never;
1269
- $unknown?: never;
1270
- }
1271
- /**
1272
- * <p>A date expressed as an ISO 8601 string.</p>
1273
- * <p>It's important for the time zone to be included in the ISO 8601 date-time format. For
1274
- * example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012
1275
- * at 12:30PM (plus 10 seconds) in Central European Time. </p>
1276
- * @public
1277
- */
1278
- interface DateValueMember {
1279
- stringValue?: never;
1280
- stringListValue?: never;
1281
- longValue?: never;
1282
- dateValue: Date;
1283
- $unknown?: never;
1284
- }
1285
- /**
1286
- * @public
1287
- */
1288
- interface $UnknownMember {
1289
- stringValue?: never;
1290
- stringListValue?: never;
1291
- longValue?: never;
1292
- dateValue?: never;
1293
- $unknown: [string, any];
1294
- }
1295
- interface Visitor<T> {
1296
- stringValue: (value: string) => T;
1297
- stringListValue: (value: string[]) => T;
1298
- longValue: (value: number) => T;
1299
- dateValue: (value: Date) => T;
1300
- _: (name: string, value: any) => T;
1301
- }
1302
- const visit: <T>(value: DocumentAttributeValue, visitor: Visitor<T>) => T;
1303
- }
1304
- /**
1305
- * <p>The condition used for the target document attribute or metadata field when ingesting
1306
- * documents into Amazon Q Business. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
1307
- * <code>DocumentAttributeTarget</code>
1308
- * </a> to apply the condition.</p>
1309
- * <p>For example, you can create the 'Department' target field and have it prefill
1310
- * department names associated with the documents based on information in the 'Source_URI'
1311
- * field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI
1312
- * value, then prefill the target field 'Department' with the target value 'Finance' for
1313
- * the document.</p>
1314
- * <p>Amazon Q Business can't create a target field if it has not already been created as an
1315
- * index field. After you create your index field, you can create a document metadata field
1316
- * using <code>DocumentAttributeTarget</code>. Amazon Q Business then will map your newly
1317
- * created metadata field to your index field.</p>
1318
- * @public
1319
- */
1320
- export interface DocumentAttributeCondition {
1555
+ export interface DocumentAttributeCondition {
1321
1556
  /**
1322
1557
  * <p>The identifier of the document attribute used for the condition.</p>
1323
1558
  * <p>For example, 'Source_URI' could be an identifier for the attribute or metadata field
@@ -2422,6 +2657,23 @@ export interface BasicAuthConfiguration {
2422
2657
  */
2423
2658
  roleArn: string | undefined;
2424
2659
  }
2660
+ /**
2661
+ * <p>Information about the IAM Identity Center Application used to configure authentication for a plugin.</p>
2662
+ * @public
2663
+ */
2664
+ export interface IdcAuthConfiguration {
2665
+ /**
2666
+ * <p>The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication.</p>
2667
+ * @public
2668
+ */
2669
+ idcApplicationArn: string | undefined;
2670
+ /**
2671
+ * <p>The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services
2672
+ * on your behalf.</p>
2673
+ * @public
2674
+ */
2675
+ roleArn: string | undefined;
2676
+ }
2425
2677
  /**
2426
2678
  * <p>Information about invoking a custom plugin without any authentication or authorization
2427
2679
  * requirement.</p>
@@ -2447,12 +2699,24 @@ export interface OAuth2ClientCredentialConfiguration {
2447
2699
  * @public
2448
2700
  */
2449
2701
  roleArn: string | undefined;
2702
+ /**
2703
+ * <p>The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to
2704
+ * authenticate a plugin user through a third party authentication server.</p>
2705
+ * @public
2706
+ */
2707
+ authorizationUrl?: string | undefined;
2708
+ /**
2709
+ * <p>The URL required by the OAuth 2.0 protocol to exchange an end user authorization code
2710
+ * for an access token.</p>
2711
+ * @public
2712
+ */
2713
+ tokenUrl?: string | undefined;
2450
2714
  }
2451
2715
  /**
2452
2716
  * <p>Authentication configuration information for an Amazon Q Business plugin.</p>
2453
2717
  * @public
2454
2718
  */
2455
- export type PluginAuthConfiguration = PluginAuthConfiguration.BasicAuthConfigurationMember | PluginAuthConfiguration.NoAuthConfigurationMember | PluginAuthConfiguration.OAuth2ClientCredentialConfigurationMember | PluginAuthConfiguration.$UnknownMember;
2719
+ export type PluginAuthConfiguration = PluginAuthConfiguration.BasicAuthConfigurationMember | PluginAuthConfiguration.IdcAuthConfigurationMember | PluginAuthConfiguration.NoAuthConfigurationMember | PluginAuthConfiguration.OAuth2ClientCredentialConfigurationMember | PluginAuthConfiguration.$UnknownMember;
2456
2720
  /**
2457
2721
  * @public
2458
2722
  */
@@ -2466,6 +2730,7 @@ export declare namespace PluginAuthConfiguration {
2466
2730
  basicAuthConfiguration: BasicAuthConfiguration;
2467
2731
  oAuth2ClientCredentialConfiguration?: never;
2468
2732
  noAuthConfiguration?: never;
2733
+ idcAuthConfiguration?: never;
2469
2734
  $unknown?: never;
2470
2735
  }
2471
2736
  /**
@@ -2477,6 +2742,7 @@ export declare namespace PluginAuthConfiguration {
2477
2742
  basicAuthConfiguration?: never;
2478
2743
  oAuth2ClientCredentialConfiguration: OAuth2ClientCredentialConfiguration;
2479
2744
  noAuthConfiguration?: never;
2745
+ idcAuthConfiguration?: never;
2480
2746
  $unknown?: never;
2481
2747
  }
2482
2748
  /**
@@ -2487,6 +2753,18 @@ export declare namespace PluginAuthConfiguration {
2487
2753
  basicAuthConfiguration?: never;
2488
2754
  oAuth2ClientCredentialConfiguration?: never;
2489
2755
  noAuthConfiguration: NoAuthConfiguration;
2756
+ idcAuthConfiguration?: never;
2757
+ $unknown?: never;
2758
+ }
2759
+ /**
2760
+ * <p>Information about the IAM Identity Center Application used to configure authentication for a plugin.</p>
2761
+ * @public
2762
+ */
2763
+ interface IdcAuthConfigurationMember {
2764
+ basicAuthConfiguration?: never;
2765
+ oAuth2ClientCredentialConfiguration?: never;
2766
+ noAuthConfiguration?: never;
2767
+ idcAuthConfiguration: IdcAuthConfiguration;
2490
2768
  $unknown?: never;
2491
2769
  }
2492
2770
  /**
@@ -2496,12 +2774,14 @@ export declare namespace PluginAuthConfiguration {
2496
2774
  basicAuthConfiguration?: never;
2497
2775
  oAuth2ClientCredentialConfiguration?: never;
2498
2776
  noAuthConfiguration?: never;
2777
+ idcAuthConfiguration?: never;
2499
2778
  $unknown: [string, any];
2500
2779
  }
2501
2780
  interface Visitor<T> {
2502
2781
  basicAuthConfiguration: (value: BasicAuthConfiguration) => T;
2503
2782
  oAuth2ClientCredentialConfiguration: (value: OAuth2ClientCredentialConfiguration) => T;
2504
2783
  noAuthConfiguration: (value: NoAuthConfiguration) => T;
2784
+ idcAuthConfiguration: (value: IdcAuthConfiguration) => T;
2505
2785
  _: (name: string, value: any) => T;
2506
2786
  }
2507
2787
  const visit: <T>(value: PluginAuthConfiguration, visitor: Visitor<T>) => T;
@@ -3524,6 +3804,32 @@ export interface BrowserExtensionConfiguration {
3524
3804
  */
3525
3805
  enabledBrowserExtensions: BrowserExtension[] | undefined;
3526
3806
  }
3807
+ /**
3808
+ * <p>Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.</p>
3809
+ * @public
3810
+ */
3811
+ export interface CustomizationConfiguration {
3812
+ /**
3813
+ * <p>Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.</p>
3814
+ * @public
3815
+ */
3816
+ customCSSUrl?: string | undefined;
3817
+ /**
3818
+ * <p>Provides the URL where the custom logo file is hosted for an Amazon Q web experience.</p>
3819
+ * @public
3820
+ */
3821
+ logoUrl?: string | undefined;
3822
+ /**
3823
+ * <p>Provides the URL where the custom font file is hosted for an Amazon Q web experience.</p>
3824
+ * @public
3825
+ */
3826
+ fontUrl?: string | undefined;
3827
+ /**
3828
+ * <p>Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.</p>
3829
+ * @public
3830
+ */
3831
+ faviconUrl?: string | undefined;
3832
+ }
3527
3833
  /**
3528
3834
  * <p>Information about the OIDC-compliant identity provider (IdP) used to authenticate end
3529
3835
  * users of an Amazon Q Business web experience.</p>
@@ -3702,6 +4008,11 @@ export interface CreateWebExperienceRequest {
3702
4008
  * @public
3703
4009
  */
3704
4010
  browserExtensionConfiguration?: BrowserExtensionConfiguration | undefined;
4011
+ /**
4012
+ * <p>Sets the custom logo, favicon, font, and color used in the Amazon Q web experience. </p>
4013
+ * @public
4014
+ */
4015
+ customizationConfiguration?: CustomizationConfiguration | undefined;
3705
4016
  }
3706
4017
  /**
3707
4018
  * @public
@@ -3937,6 +4248,12 @@ export interface GetWebExperienceResponse {
3937
4248
  * @public
3938
4249
  */
3939
4250
  browserExtensionConfiguration?: BrowserExtensionConfiguration | undefined;
4251
+ /**
4252
+ * <p>Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.
4253
+ * </p>
4254
+ * @public
4255
+ */
4256
+ customizationConfiguration?: CustomizationConfiguration | undefined;
3940
4257
  }
3941
4258
  /**
3942
4259
  * @public
@@ -4098,6 +4415,11 @@ export interface UpdateWebExperienceRequest {
4098
4415
  * @public
4099
4416
  */
4100
4417
  browserExtensionConfiguration?: BrowserExtensionConfiguration | undefined;
4418
+ /**
4419
+ * <p>Updates the custom logo, favicon, font, and color used in the Amazon Q web experience. </p>
4420
+ * @public
4421
+ */
4422
+ customizationConfiguration?: CustomizationConfiguration | undefined;
4101
4423
  }
4102
4424
  /**
4103
4425
  * @public
@@ -4131,6 +4453,41 @@ export interface AppliedCreatorModeConfiguration {
4131
4453
  */
4132
4454
  creatorModeControl: CreatorModeControl | undefined;
4133
4455
  }
4456
+ /**
4457
+ * @public
4458
+ */
4459
+ export interface AssociatePermissionRequest {
4460
+ /**
4461
+ * <p>The unique identifier of the Q Business application.</p>
4462
+ * @public
4463
+ */
4464
+ applicationId: string | undefined;
4465
+ /**
4466
+ * <p>A unique identifier for the policy statement.</p>
4467
+ * @public
4468
+ */
4469
+ statementId: string | undefined;
4470
+ /**
4471
+ * <p>The list of Q Business actions that the ISV is allowed to perform.</p>
4472
+ * @public
4473
+ */
4474
+ actions: string[] | undefined;
4475
+ /**
4476
+ * <p>The Amazon Resource Name (ARN) of the IAM role for the ISV that is being granted permission.</p>
4477
+ * @public
4478
+ */
4479
+ principal: string | undefined;
4480
+ }
4481
+ /**
4482
+ * @public
4483
+ */
4484
+ export interface AssociatePermissionResponse {
4485
+ /**
4486
+ * <p>The JSON representation of the added permission statement.</p>
4487
+ * @public
4488
+ */
4489
+ statement?: string | undefined;
4490
+ }
4134
4491
  /**
4135
4492
  * <p>The source reference for an existing attachment in an existing conversation.</p>
4136
4493
  * @public
@@ -4309,22 +4666,6 @@ export interface AttachmentOutput {
4309
4666
  */
4310
4667
  conversationId?: string | undefined;
4311
4668
  }
4312
- /**
4313
- * <p>A document attribute or metadata field.</p>
4314
- * @public
4315
- */
4316
- export interface DocumentAttribute {
4317
- /**
4318
- * <p>The identifier for the attribute.</p>
4319
- * @public
4320
- */
4321
- name: string | undefined;
4322
- /**
4323
- * <p>The value of the attribute. </p>
4324
- * @public
4325
- */
4326
- value: DocumentAttributeValue | undefined;
4327
- }
4328
4669
  /**
4329
4670
  * <p>A request made by Amazon Q Business to a third paty authentication server to authenticate
4330
4671
  * a custom plugin user.</p>
@@ -5126,6 +5467,47 @@ export interface ContentRetrievalRule {
5126
5467
  */
5127
5468
  eligibleDataSources?: EligibleDataSource[] | undefined;
5128
5469
  }
5470
+ /**
5471
+ * <p>Specifies a retriever as the content source for a search.</p>
5472
+ * @public
5473
+ */
5474
+ export interface RetrieverContentSource {
5475
+ /**
5476
+ * <p>The unique identifier of the retriever to use as the content source.</p>
5477
+ * @public
5478
+ */
5479
+ retrieverId: string | undefined;
5480
+ }
5481
+ /**
5482
+ * <p>Specifies the source of content to search in.</p>
5483
+ * @public
5484
+ */
5485
+ export type ContentSource = ContentSource.RetrieverMember | ContentSource.$UnknownMember;
5486
+ /**
5487
+ * @public
5488
+ */
5489
+ export declare namespace ContentSource {
5490
+ /**
5491
+ * <p>The retriever to use as the content source.</p>
5492
+ * @public
5493
+ */
5494
+ interface RetrieverMember {
5495
+ retriever: RetrieverContentSource;
5496
+ $unknown?: never;
5497
+ }
5498
+ /**
5499
+ * @public
5500
+ */
5501
+ interface $UnknownMember {
5502
+ retriever?: never;
5503
+ $unknown: [string, any];
5504
+ }
5505
+ interface Visitor<T> {
5506
+ retriever: (value: RetrieverContentSource) => T;
5507
+ _: (name: string, value: any) => T;
5508
+ }
5509
+ const visit: <T>(value: ContentSource, visitor: Visitor<T>) => T;
5510
+ }
5129
5511
  /**
5130
5512
  * <p>A conversation in an Amazon Q Business application.</p>
5131
5513
  * @public
@@ -5413,6 +5795,26 @@ export interface DeleteUserRequest {
5413
5795
  */
5414
5796
  export interface DeleteUserResponse {
5415
5797
  }
5798
+ /**
5799
+ * @public
5800
+ */
5801
+ export interface DisassociatePermissionRequest {
5802
+ /**
5803
+ * <p>The unique identifier of the Q Business application.</p>
5804
+ * @public
5805
+ */
5806
+ applicationId: string | undefined;
5807
+ /**
5808
+ * <p>The statement ID of the permission to remove.</p>
5809
+ * @public
5810
+ */
5811
+ statementId: string | undefined;
5812
+ }
5813
+ /**
5814
+ * @public
5815
+ */
5816
+ export interface DisassociatePermissionResponse {
5817
+ }
5416
5818
  /**
5417
5819
  * @public
5418
5820
  * @enum
@@ -5789,6 +6191,26 @@ export declare class MediaTooLargeException extends __BaseException {
5789
6191
  */
5790
6192
  constructor(opts: __ExceptionOptionType<MediaTooLargeException, __BaseException>);
5791
6193
  }
6194
+ /**
6195
+ * @public
6196
+ */
6197
+ export interface GetPolicyRequest {
6198
+ /**
6199
+ * <p>The unique identifier of the Q Business application.</p>
6200
+ * @public
6201
+ */
6202
+ applicationId: string | undefined;
6203
+ }
6204
+ /**
6205
+ * @public
6206
+ */
6207
+ export interface GetPolicyResponse {
6208
+ /**
6209
+ * <p>The JSON representation of the permission policy.</p>
6210
+ * @public
6211
+ */
6212
+ policy?: string | undefined;
6213
+ }
5792
6214
  /**
5793
6215
  * @public
5794
6216
  */
@@ -6198,29 +6620,178 @@ export interface ListMessagesResponse {
6198
6620
  /**
6199
6621
  * @public
6200
6622
  */
6201
- export interface ListTagsForResourceRequest {
6623
+ export interface ListPluginActionsRequest {
6202
6624
  /**
6203
- * <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get
6204
- * a list of tags for.</p>
6625
+ * <p>The identifier of the Amazon Q Business application the plugin is attached
6626
+ * to.</p>
6205
6627
  * @public
6206
6628
  */
6207
- resourceARN: string | undefined;
6629
+ applicationId: string | undefined;
6630
+ /**
6631
+ * <p>The identifier of the Amazon Q Business plugin.</p>
6632
+ * @public
6633
+ */
6634
+ pluginId: string | undefined;
6635
+ /**
6636
+ * <p>If the number of plugin actions returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set
6637
+ * of plugin actions.</p>
6638
+ * @public
6639
+ */
6640
+ nextToken?: string | undefined;
6641
+ /**
6642
+ * <p>The maximum number of plugin actions to return.</p>
6643
+ * @public
6644
+ */
6645
+ maxResults?: number | undefined;
6208
6646
  }
6209
6647
  /**
6210
6648
  * @public
6211
6649
  */
6212
- export interface ListTagsForResourceResponse {
6650
+ export interface ListPluginActionsResponse {
6213
6651
  /**
6214
- * <p>A list of tags associated with the Amazon Q Business application or data source.</p>
6652
+ * <p>If the response is truncated, Amazon Q Business returns this token, which you
6653
+ * can use in a later request to list the next set of plugin actions.</p>
6215
6654
  * @public
6216
6655
  */
6217
- tags?: Tag[] | undefined;
6656
+ nextToken?: string | undefined;
6657
+ /**
6658
+ * <p>An array of information on one or more plugin actions.</p>
6659
+ * @public
6660
+ */
6661
+ items?: ActionSummary[] | undefined;
6218
6662
  }
6219
6663
  /**
6220
6664
  * @public
6221
- * @enum
6222
6665
  */
6223
- export declare const MessageUsefulnessReason: {
6666
+ export interface ListPluginTypeActionsRequest {
6667
+ /**
6668
+ * <p>The type of the plugin.</p>
6669
+ * @public
6670
+ */
6671
+ pluginType: PluginType | undefined;
6672
+ /**
6673
+ * <p>If the number of plugins returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set
6674
+ * of plugins.</p>
6675
+ * @public
6676
+ */
6677
+ nextToken?: string | undefined;
6678
+ /**
6679
+ * <p>The maximum number of plugins to return.</p>
6680
+ * @public
6681
+ */
6682
+ maxResults?: number | undefined;
6683
+ }
6684
+ /**
6685
+ * @public
6686
+ */
6687
+ export interface ListPluginTypeActionsResponse {
6688
+ /**
6689
+ * <p>If the response is truncated, Amazon Q Business returns this token, which you
6690
+ * can use in a later request to list the next set of plugins.</p>
6691
+ * @public
6692
+ */
6693
+ nextToken?: string | undefined;
6694
+ /**
6695
+ * <p>An array of information on one or more plugins.</p>
6696
+ * @public
6697
+ */
6698
+ items?: ActionSummary[] | undefined;
6699
+ }
6700
+ /**
6701
+ * @public
6702
+ */
6703
+ export interface ListPluginTypeMetadataRequest {
6704
+ /**
6705
+ * <p>If the metadata returned exceeds <code>maxResults</code>, Amazon Q Business
6706
+ * returns a next token as a pagination token to retrieve the next set of metadata.</p>
6707
+ * @public
6708
+ */
6709
+ nextToken?: string | undefined;
6710
+ /**
6711
+ * <p>The maximum number of plugin metadata items to return.</p>
6712
+ * @public
6713
+ */
6714
+ maxResults?: number | undefined;
6715
+ }
6716
+ /**
6717
+ * @public
6718
+ * @enum
6719
+ */
6720
+ export declare const PluginTypeCategory: {
6721
+ readonly COMMUNICATION: "Communication";
6722
+ readonly CRM: "Customer relationship management (CRM)";
6723
+ readonly PRODUCTIVITY: "Productivity";
6724
+ readonly PROJECT_MANAGEMENT: "Project management";
6725
+ readonly TICKETING_MANAGEMENT: "Ticketing and incident management";
6726
+ };
6727
+ /**
6728
+ * @public
6729
+ */
6730
+ export type PluginTypeCategory = (typeof PluginTypeCategory)[keyof typeof PluginTypeCategory];
6731
+ /**
6732
+ * <p>Summary metadata information for a Amazon Q Business plugin.</p>
6733
+ * @public
6734
+ */
6735
+ export interface PluginTypeMetadataSummary {
6736
+ /**
6737
+ * <p>The type of the plugin.</p>
6738
+ * @public
6739
+ */
6740
+ type?: PluginType | undefined;
6741
+ /**
6742
+ * <p>The category of the plugin type.</p>
6743
+ * @public
6744
+ */
6745
+ category?: PluginTypeCategory | undefined;
6746
+ /**
6747
+ * <p>The description assigned by Amazon Q Business to a plugin. You can't
6748
+ * modify this value.</p>
6749
+ * @public
6750
+ */
6751
+ description?: string | undefined;
6752
+ }
6753
+ /**
6754
+ * @public
6755
+ */
6756
+ export interface ListPluginTypeMetadataResponse {
6757
+ /**
6758
+ * <p>If the response is truncated, Amazon Q Business returns this token, which you
6759
+ * can use in a later request to list the next set of plugin metadata.</p>
6760
+ * @public
6761
+ */
6762
+ nextToken?: string | undefined;
6763
+ /**
6764
+ * <p>An array of information on plugin metadata.</p>
6765
+ * @public
6766
+ */
6767
+ items?: PluginTypeMetadataSummary[] | undefined;
6768
+ }
6769
+ /**
6770
+ * @public
6771
+ */
6772
+ export interface ListTagsForResourceRequest {
6773
+ /**
6774
+ * <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get
6775
+ * a list of tags for.</p>
6776
+ * @public
6777
+ */
6778
+ resourceARN: string | undefined;
6779
+ }
6780
+ /**
6781
+ * @public
6782
+ */
6783
+ export interface ListTagsForResourceResponse {
6784
+ /**
6785
+ * <p>A list of tags associated with the Amazon Q Business application or data source.</p>
6786
+ * @public
6787
+ */
6788
+ tags?: Tag[] | undefined;
6789
+ }
6790
+ /**
6791
+ * @public
6792
+ * @enum
6793
+ */
6794
+ export declare const MessageUsefulnessReason: {
6224
6795
  readonly COMPLETE: "COMPLETE";
6225
6796
  readonly FACTUALLY_CORRECT: "FACTUALLY_CORRECT";
6226
6797
  readonly HARMFUL_OR_UNSAFE: "HARMFUL_OR_UNSAFE";
@@ -6426,585 +6997,121 @@ export interface PutGroupResponse {
6426
6997
  }
6427
6998
  /**
6428
6999
  * @public
7000
+ * @enum
6429
7001
  */
6430
- export interface StartDataSourceSyncJobRequest {
6431
- /**
6432
- * <p> The identifier of the data source connector. </p>
6433
- * @public
6434
- */
6435
- dataSourceId: string | undefined;
6436
- /**
6437
- * <p>The identifier of Amazon Q Business application the data source is connected to.</p>
6438
- * @public
6439
- */
6440
- applicationId: string | undefined;
6441
- /**
6442
- * <p>The identifier of the index used with the data source connector.</p>
6443
- * @public
6444
- */
6445
- indexId: string | undefined;
6446
- }
6447
- /**
6448
- * @public
6449
- */
6450
- export interface StartDataSourceSyncJobResponse {
6451
- /**
6452
- * <p>The identifier for a particular synchronization job.</p>
6453
- * @public
6454
- */
6455
- executionId?: string | undefined;
6456
- }
6457
- /**
6458
- * @public
6459
- */
6460
- export interface StopDataSourceSyncJobRequest {
6461
- /**
6462
- * <p> The identifier of the data source connector. </p>
6463
- * @public
6464
- */
6465
- dataSourceId: string | undefined;
6466
- /**
6467
- * <p>The identifier of the Amazon Q Business application that the data source is connected
6468
- * to.</p>
6469
- * @public
6470
- */
6471
- applicationId: string | undefined;
6472
- /**
6473
- * <p>The identifier of the index used with the Amazon Q Business data source connector.</p>
6474
- * @public
6475
- */
6476
- indexId: string | undefined;
6477
- }
6478
- /**
6479
- * @public
6480
- */
6481
- export interface StopDataSourceSyncJobResponse {
6482
- }
6483
- /**
6484
- * @public
6485
- */
6486
- export interface TagResourceRequest {
6487
- /**
6488
- * <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to
6489
- * tag.</p>
6490
- * @public
6491
- */
6492
- resourceARN: string | undefined;
6493
- /**
6494
- * <p>A list of tag keys to add to the Amazon Q Business application or data source. If a tag
6495
- * already exists, the existing value is replaced with the new value.</p>
6496
- * @public
6497
- */
6498
- tags: Tag[] | undefined;
6499
- }
7002
+ export declare const ScoreConfidence: {
7003
+ readonly HIGH: "HIGH";
7004
+ readonly LOW: "LOW";
7005
+ readonly MEDIUM: "MEDIUM";
7006
+ readonly NOT_AVAILABLE: "NOT_AVAILABLE";
7007
+ readonly VERY_HIGH: "VERY_HIGH";
7008
+ };
6500
7009
  /**
6501
7010
  * @public
6502
7011
  */
6503
- export interface TagResourceResponse {
6504
- }
7012
+ export type ScoreConfidence = (typeof ScoreConfidence)[keyof typeof ScoreConfidence];
6505
7013
  /**
7014
+ * <p>Provides information about the relevance score of content.</p>
6506
7015
  * @public
6507
7016
  */
6508
- export interface UntagResourceRequest {
7017
+ export interface ScoreAttributes {
6509
7018
  /**
6510
- * <p>The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to
6511
- * remove the tag from.</p>
7019
+ * <p>The confidence level of the relevance score.</p>
6512
7020
  * @public
6513
7021
  */
6514
- resourceARN: string | undefined;
6515
- /**
6516
- * <p>A list of tag keys to remove from the Amazon Q Business application or data source. If a
6517
- * tag key does not exist on the resource, it is ignored.</p>
6518
- * @public
6519
- */
6520
- tagKeys: string[] | undefined;
6521
- }
6522
- /**
6523
- * @public
6524
- */
6525
- export interface UntagResourceResponse {
7022
+ scoreConfidence?: ScoreConfidence | undefined;
6526
7023
  }
6527
7024
  /**
7025
+ * <p>Represents a piece of content that is relevant to a search query.</p>
6528
7026
  * @public
6529
7027
  */
6530
- export interface UpdateChatControlsConfigurationRequest {
6531
- /**
6532
- * <p>The identifier of the application for which the chat controls are configured.</p>
6533
- * @public
6534
- */
6535
- applicationId: string | undefined;
6536
- /**
6537
- * <p>A token that you provide to identify the request to update a Amazon Q Business application
6538
- * chat configuration.</p>
6539
- * @public
6540
- */
6541
- clientToken?: string | undefined;
6542
- /**
6543
- * <p>The response scope configured for your application. This determines whether your
6544
- * application uses its retrieval augmented generation (RAG) system to generate answers
6545
- * only from your enterprise data, or also uses the large language models (LLM) knowledge
6546
- * to respons to end user questions in chat.</p>
6547
- * @public
6548
- */
6549
- responseScope?: ResponseScope | undefined;
7028
+ export interface RelevantContent {
6550
7029
  /**
6551
- * <p>The phrases blocked from chat by your chat control configuration.</p>
7030
+ * <p>The actual content of the relevant item.</p>
6552
7031
  * @public
6553
7032
  */
6554
- blockedPhrasesConfigurationUpdate?: BlockedPhrasesConfigurationUpdate | undefined;
7033
+ content?: string | undefined;
6555
7034
  /**
6556
- * <p>The configured topic specific chat controls you want to update.</p>
7035
+ * <p>The unique identifier of the document containing the relevant content.</p>
6557
7036
  * @public
6558
7037
  */
6559
- topicConfigurationsToCreateOrUpdate?: TopicConfiguration[] | undefined;
6560
- /**
6561
- * <p>The configured topic specific chat controls you want to delete.</p>
6562
- * @public
6563
- */
6564
- topicConfigurationsToDelete?: TopicConfiguration[] | undefined;
6565
- /**
6566
- * <p>The configuration details for <code>CREATOR_MODE</code>.</p>
6567
- * @public
6568
- */
6569
- creatorModeConfiguration?: CreatorModeConfiguration | undefined;
6570
- }
6571
- /**
6572
- * @public
6573
- */
6574
- export interface UpdateChatControlsConfigurationResponse {
6575
- }
6576
- /**
6577
- * @public
6578
- */
6579
- export interface UpdateUserRequest {
7038
+ documentId?: string | undefined;
6580
7039
  /**
6581
- * <p>The identifier of the application the user is attached to.</p>
7040
+ * <p>The title of the document containing the relevant content.</p>
6582
7041
  * @public
6583
7042
  */
6584
- applicationId: string | undefined;
7043
+ documentTitle?: string | undefined;
6585
7044
  /**
6586
- * <p>The email id attached to the user.</p>
7045
+ * <p>The URI of the document containing the relevant content.</p>
6587
7046
  * @public
6588
7047
  */
6589
- userId: string | undefined;
7048
+ documentUri?: string | undefined;
6590
7049
  /**
6591
- * <p>The user aliases attached to the user id that are to be updated.</p>
7050
+ * <p>Additional attributes of the document containing the relevant content.</p>
6592
7051
  * @public
6593
7052
  */
6594
- userAliasesToUpdate?: UserAlias[] | undefined;
7053
+ documentAttributes?: DocumentAttribute[] | undefined;
6595
7054
  /**
6596
- * <p>The user aliases attached to the user id that are to be deleted.</p>
7055
+ * <p>Attributes related to the relevance score of the content.</p>
6597
7056
  * @public
6598
7057
  */
6599
- userAliasesToDelete?: UserAlias[] | undefined;
7058
+ scoreAttributes?: ScoreAttributes | undefined;
6600
7059
  }
6601
7060
  /**
6602
7061
  * @public
6603
7062
  */
6604
- export interface UpdateUserResponse {
6605
- /**
6606
- * <p>The user aliases that have been to be added to a user id.</p>
6607
- * @public
6608
- */
6609
- userAliasesAdded?: UserAlias[] | undefined;
7063
+ export interface SearchRelevantContentResponse {
6610
7064
  /**
6611
- * <p>The user aliases attached to a user id that have been updated.</p>
7065
+ * <p>The list of relevant content items found.</p>
6612
7066
  * @public
6613
7067
  */
6614
- userAliasesUpdated?: UserAlias[] | undefined;
7068
+ relevantContent?: RelevantContent[] | undefined;
6615
7069
  /**
6616
- * <p>The user aliases that have been deleted from a user id.</p>
7070
+ * <p>The token to use to retrieve the next set of results, if there are any.</p>
6617
7071
  * @public
6618
7072
  */
6619
- userAliasesDeleted?: UserAlias[] | undefined;
7073
+ nextToken?: string | undefined;
6620
7074
  }
6621
7075
  /**
6622
- * <p>Enables filtering of responses based on document attributes or metadata fields.</p>
6623
7076
  * @public
6624
7077
  */
6625
- export interface AttributeFilter {
6626
- /**
6627
- * <p>Performs a logical <code>AND</code> operation on all supplied filters.</p>
6628
- * @public
6629
- */
6630
- andAllFilters?: AttributeFilter[] | undefined;
6631
- /**
6632
- * <p> Performs a logical <code>OR</code> operation on all supplied filters. </p>
6633
- * @public
6634
- */
6635
- orAllFilters?: AttributeFilter[] | undefined;
6636
- /**
6637
- * <p>Performs a logical <code>NOT</code> operation on all supplied filters. </p>
6638
- * @public
6639
- */
6640
- notFilter?: AttributeFilter | undefined;
6641
- /**
6642
- * <p>Performs an equals operation on two document attributes or metadata fields. Supported
6643
- * for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>,
6644
- * <code>longValue</code>, <code>stringListValue</code> and
6645
- * <code>stringValue</code>.</p>
6646
- * @public
6647
- */
6648
- equalsTo?: DocumentAttribute | undefined;
6649
- /**
6650
- * <p>Returns <code>true</code> when a document contains all the specified document
6651
- * attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
6652
- * <code>stringListValue</code>.</p>
6653
- * @public
6654
- */
6655
- containsAll?: DocumentAttribute | undefined;
6656
- /**
6657
- * <p>Returns <code>true</code> when a document contains any of the specified document
6658
- * attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
6659
- * <code>stringListValue</code>.</p>
6660
- * @public
6661
- */
6662
- containsAny?: DocumentAttribute | undefined;
6663
- /**
6664
- * <p>Performs a greater than operation on two document attributes or metadata fields.
6665
- * Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
6666
- * and <code>longValue</code>.</p>
6667
- * @public
6668
- */
6669
- greaterThan?: DocumentAttribute | undefined;
6670
- /**
6671
- * <p>Performs a greater or equals than operation on two document attributes or metadata
6672
- * fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
6673
- * and <code>longValue</code>. </p>
6674
- * @public
6675
- */
6676
- greaterThanOrEquals?: DocumentAttribute | undefined;
6677
- /**
6678
- * <p>Performs a less than operation on two document attributes or metadata fields.
6679
- * Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
6680
- * and <code>longValue</code>.</p>
6681
- * @public
6682
- */
6683
- lessThan?: DocumentAttribute | undefined;
7078
+ export interface StartDataSourceSyncJobRequest {
6684
7079
  /**
6685
- * <p>Performs a less than or equals operation on two document attributes or metadata
6686
- * fields.Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value type</a>: <code>dateValue</code>
6687
- * and <code>longValue</code>. </p>
7080
+ * <p> The identifier of the data source connector. </p>
6688
7081
  * @public
6689
7082
  */
6690
- lessThanOrEquals?: DocumentAttribute | undefined;
6691
- }
6692
- /**
6693
- * @public
6694
- */
6695
- export interface ChatSyncInput {
7083
+ dataSourceId: string | undefined;
6696
7084
  /**
6697
- * <p>The identifier of the Amazon Q Business application linked to the Amazon Q Business
6698
- * conversation.</p>
7085
+ * <p>The identifier of Amazon Q Business application the data source is connected to.</p>
6699
7086
  * @public
6700
7087
  */
6701
7088
  applicationId: string | undefined;
6702
7089
  /**
6703
- * <p>The identifier of the user attached to the chat input.</p>
6704
- * @public
6705
- */
6706
- userId?: string | undefined;
6707
- /**
6708
- * <p>The group names that a user associated with the chat input belongs to.</p>
6709
- * @public
6710
- */
6711
- userGroups?: string[] | undefined;
6712
- /**
6713
- * <p>A end user message in a conversation.</p>
6714
- * @public
6715
- */
6716
- userMessage?: string | undefined;
6717
- /**
6718
- * <p>A list of files uploaded directly during chat. You can upload a maximum of 5 files of
6719
- * upto 10 MB each.</p>
6720
- * @public
6721
- */
6722
- attachments?: AttachmentInput[] | undefined;
6723
- /**
6724
- * <p>A request from an end user to perform an Amazon Q Business plugin action.</p>
6725
- * @public
6726
- */
6727
- actionExecution?: ActionExecution | undefined;
6728
- /**
6729
- * <p>An authentication verification event response by a third party authentication server
6730
- * to Amazon Q Business.</p>
6731
- * @public
6732
- */
6733
- authChallengeResponse?: AuthChallengeResponse | undefined;
6734
- /**
6735
- * <p>The identifier of the Amazon Q Business conversation.</p>
6736
- * @public
6737
- */
6738
- conversationId?: string | undefined;
6739
- /**
6740
- * <p>The identifier of the previous system message in a conversation.</p>
6741
- * @public
6742
- */
6743
- parentMessageId?: string | undefined;
6744
- /**
6745
- * <p>Enables filtering of Amazon Q Business web experience responses based on document
6746
- * attributes or metadata fields.</p>
6747
- * @public
6748
- */
6749
- attributeFilter?: AttributeFilter | undefined;
6750
- /**
6751
- * <p>The <code>chatMode</code> parameter determines the chat modes available to
6752
- * Amazon Q Business users:</p>
6753
- * <ul>
6754
- * <li>
6755
- * <p>
6756
- * <code>RETRIEVAL_MODE</code> - If you choose this mode, Amazon Q generates responses solely from the data sources connected and
6757
- * indexed by the application. If an answer is not found in the data sources or
6758
- * there are no data sources available, Amazon Q will respond with a
6759
- * "<i>No Answer Found</i>" message, unless LLM knowledge has
6760
- * been enabled. In that case, Amazon Q will generate a response from
6761
- * the LLM knowledge</p>
6762
- * </li>
6763
- * <li>
6764
- * <p>
6765
- * <code>CREATOR_MODE</code> - By selecting this mode, you can choose to generate
6766
- * responses only from the LLM knowledge. You can also attach files and have Amazon Q
6767
- * generate a response based on the data in those files.
6768
- * If the attached files do not contain an answer for the query, Amazon Q
6769
- * will automatically fall back to generating a response from the LLM knowledge.</p>
6770
- * </li>
6771
- * <li>
6772
- * <p>
6773
- * <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to
6774
- * use plugins in chat to get their responses.</p>
6775
- * </li>
6776
- * </ul>
6777
- * <note>
6778
- * <p>If none of the modes are selected, Amazon Q will only respond using the information
6779
- * from the attached files.</p>
6780
- * </note>
6781
- * <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>,
6782
- * and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Response sources</a>.</p>
6783
- * @public
6784
- */
6785
- chatMode?: ChatMode | undefined;
6786
- /**
6787
- * <p>The chat mode configuration for an Amazon Q Business application.</p>
6788
- * @public
6789
- */
6790
- chatModeConfiguration?: ChatModeConfiguration | undefined;
6791
- /**
6792
- * <p>A token that you provide to identify a chat request.</p>
6793
- * @public
6794
- */
6795
- clientToken?: string | undefined;
6796
- }
6797
- /**
6798
- * <p>A configuration event activated by an end user request to select a specific chat
6799
- * mode.</p>
6800
- * @public
6801
- */
6802
- export interface ConfigurationEvent {
6803
- /**
6804
- * <p>The chat modes available to an Amazon Q Business end user.</p>
6805
- * <ul>
6806
- * <li>
6807
- * <p>
6808
- * <code>RETRIEVAL_MODE</code> - The default chat mode for an
6809
- * Amazon Q Business application. When this mode is enabled, Amazon Q Business generates
6810
- * responses only from data sources connected to an Amazon Q Business
6811
- * application.</p>
6812
- * </li>
6813
- * <li>
6814
- * <p>
6815
- * <code>CREATOR_MODE</code> - By selecting this mode, users can choose to
6816
- * generate responses only from the LLM knowledge, without consulting connected
6817
- * data sources, for a chat request.</p>
6818
- * </li>
6819
- * <li>
6820
- * <p>
6821
- * <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to
6822
- * use plugins in chat.</p>
6823
- * </li>
6824
- * </ul>
6825
- * <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>,
6826
- * and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
6827
- * @public
6828
- */
6829
- chatMode?: ChatMode | undefined;
6830
- /**
6831
- * <p>Configuration information for Amazon Q Business conversation modes.</p>
6832
- * <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
6833
- * @public
6834
- */
6835
- chatModeConfiguration?: ChatModeConfiguration | undefined;
6836
- /**
6837
- * <p>Enables filtering of responses based on document attributes or metadata fields.</p>
7090
+ * <p>The identifier of the index used with the data source connector.</p>
6838
7091
  * @public
6839
7092
  */
6840
- attributeFilter?: AttributeFilter | undefined;
7093
+ indexId: string | undefined;
6841
7094
  }
6842
7095
  /**
6843
- * <p>The streaming input for the <code>Chat</code> API.</p>
6844
- * @public
6845
- */
6846
- export type ChatInputStream = ChatInputStream.ActionExecutionEventMember | ChatInputStream.AttachmentEventMember | ChatInputStream.AuthChallengeResponseEventMember | ChatInputStream.ConfigurationEventMember | ChatInputStream.EndOfInputEventMember | ChatInputStream.TextEventMember | ChatInputStream.$UnknownMember;
6847
- /**
6848
- * @public
7096
+ * @internal
6849
7097
  */
6850
- export declare namespace ChatInputStream {
6851
- /**
6852
- * <p>A configuration event activated by an end user request to select a specific chat
6853
- * mode.</p>
6854
- * @public
6855
- */
6856
- interface ConfigurationEventMember {
6857
- configurationEvent: ConfigurationEvent;
6858
- textEvent?: never;
6859
- attachmentEvent?: never;
6860
- actionExecutionEvent?: never;
6861
- endOfInputEvent?: never;
6862
- authChallengeResponseEvent?: never;
6863
- $unknown?: never;
6864
- }
6865
- /**
6866
- * <p>Information about the payload of the <code>ChatInputStream</code> event containing the
6867
- * end user message input.</p>
6868
- * @public
6869
- */
6870
- interface TextEventMember {
6871
- configurationEvent?: never;
6872
- textEvent: TextInputEvent;
6873
- attachmentEvent?: never;
6874
- actionExecutionEvent?: never;
6875
- endOfInputEvent?: never;
6876
- authChallengeResponseEvent?: never;
6877
- $unknown?: never;
6878
- }
6879
- /**
6880
- * <p>A request by an end user to upload a file during chat.</p>
6881
- * @public
6882
- */
6883
- interface AttachmentEventMember {
6884
- configurationEvent?: never;
6885
- textEvent?: never;
6886
- attachmentEvent: AttachmentInputEvent;
6887
- actionExecutionEvent?: never;
6888
- endOfInputEvent?: never;
6889
- authChallengeResponseEvent?: never;
6890
- $unknown?: never;
6891
- }
6892
- /**
6893
- * <p>A request from an end user to perform an Amazon Q Business plugin action.</p>
6894
- * @public
6895
- */
6896
- interface ActionExecutionEventMember {
6897
- configurationEvent?: never;
6898
- textEvent?: never;
6899
- attachmentEvent?: never;
6900
- actionExecutionEvent: ActionExecutionEvent;
6901
- endOfInputEvent?: never;
6902
- authChallengeResponseEvent?: never;
6903
- $unknown?: never;
6904
- }
6905
- /**
6906
- * <p>The end of the streaming input for the <code>Chat</code> API.</p>
6907
- * @public
6908
- */
6909
- interface EndOfInputEventMember {
6910
- configurationEvent?: never;
6911
- textEvent?: never;
6912
- attachmentEvent?: never;
6913
- actionExecutionEvent?: never;
6914
- endOfInputEvent: EndOfInputEvent;
6915
- authChallengeResponseEvent?: never;
6916
- $unknown?: never;
6917
- }
6918
- /**
6919
- * <p>An authentication verification event response by a third party authentication server
6920
- * to Amazon Q Business.</p>
6921
- * @public
6922
- */
6923
- interface AuthChallengeResponseEventMember {
6924
- configurationEvent?: never;
6925
- textEvent?: never;
6926
- attachmentEvent?: never;
6927
- actionExecutionEvent?: never;
6928
- endOfInputEvent?: never;
6929
- authChallengeResponseEvent: AuthChallengeResponseEvent;
6930
- $unknown?: never;
6931
- }
6932
- /**
6933
- * @public
6934
- */
6935
- interface $UnknownMember {
6936
- configurationEvent?: never;
6937
- textEvent?: never;
6938
- attachmentEvent?: never;
6939
- actionExecutionEvent?: never;
6940
- endOfInputEvent?: never;
6941
- authChallengeResponseEvent?: never;
6942
- $unknown: [string, any];
6943
- }
6944
- interface Visitor<T> {
6945
- configurationEvent: (value: ConfigurationEvent) => T;
6946
- textEvent: (value: TextInputEvent) => T;
6947
- attachmentEvent: (value: AttachmentInputEvent) => T;
6948
- actionExecutionEvent: (value: ActionExecutionEvent) => T;
6949
- endOfInputEvent: (value: EndOfInputEvent) => T;
6950
- authChallengeResponseEvent: (value: AuthChallengeResponseEvent) => T;
6951
- _: (name: string, value: any) => T;
6952
- }
6953
- const visit: <T>(value: ChatInputStream, visitor: Visitor<T>) => T;
6954
- }
7098
+ export declare const APISchemaFilterSensitiveLog: (obj: APISchema) => any;
6955
7099
  /**
6956
- * @public
7100
+ * @internal
6957
7101
  */
6958
- export interface ChatInput {
6959
- /**
6960
- * <p>The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business
6961
- * conversation.</p>
6962
- * @public
6963
- */
6964
- applicationId: string | undefined;
6965
- /**
6966
- * <p>The identifier of the user attached to the chat input. </p>
6967
- * @public
6968
- */
6969
- userId?: string | undefined;
6970
- /**
6971
- * <p>The group names that a user associated with the chat input belongs to.</p>
6972
- * @public
6973
- */
6974
- userGroups?: string[] | undefined;
6975
- /**
6976
- * <p>The identifier of the Amazon Q Business conversation.</p>
6977
- * @public
6978
- */
6979
- conversationId?: string | undefined;
6980
- /**
6981
- * <p>The identifier used to associate a user message with a AI generated response.</p>
6982
- * @public
6983
- */
6984
- parentMessageId?: string | undefined;
6985
- /**
6986
- * <p>A token that you provide to identify the chat input.</p>
6987
- * @public
6988
- */
6989
- clientToken?: string | undefined;
6990
- /**
6991
- * <p>The streaming input for the <code>Chat</code> API.</p>
6992
- * @public
6993
- */
6994
- inputStream?: AsyncIterable<ChatInputStream> | undefined;
6995
- }
7102
+ export declare const EncryptionConfigurationFilterSensitiveLog: (obj: EncryptionConfiguration) => any;
6996
7103
  /**
6997
7104
  * @internal
6998
7105
  */
6999
- export declare const APISchemaFilterSensitiveLog: (obj: APISchema) => any;
7106
+ export declare const CreateApplicationRequestFilterSensitiveLog: (obj: CreateApplicationRequest) => any;
7000
7107
  /**
7001
7108
  * @internal
7002
7109
  */
7003
- export declare const EncryptionConfigurationFilterSensitiveLog: (obj: EncryptionConfiguration) => any;
7110
+ export declare const DataAccessorFilterSensitiveLog: (obj: DataAccessor) => any;
7004
7111
  /**
7005
7112
  * @internal
7006
7113
  */
7007
- export declare const CreateApplicationRequestFilterSensitiveLog: (obj: CreateApplicationRequest) => any;
7114
+ export declare const ListDataAccessorsResponseFilterSensitiveLog: (obj: ListDataAccessorsResponse) => any;
7008
7115
  /**
7009
7116
  * @internal
7010
7117
  */
@@ -7033,11 +7140,3 @@ export declare const ChatOutputStreamFilterSensitiveLog: (obj: ChatOutputStream)
7033
7140
  * @internal
7034
7141
  */
7035
7142
  export declare const ChatOutputFilterSensitiveLog: (obj: ChatOutput) => any;
7036
- /**
7037
- * @internal
7038
- */
7039
- export declare const ChatInputStreamFilterSensitiveLog: (obj: ChatInputStream) => any;
7040
- /**
7041
- * @internal
7042
- */
7043
- export declare const ChatInputFilterSensitiveLog: (obj: ChatInput) => any;