@aws-sdk/client-qconnect 3.835.0 → 3.840.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 (92) hide show
  1. package/README.md +1 -34
  2. package/dist-cjs/index.js +50 -14
  3. package/dist-es/models/models_0.js +12 -13
  4. package/dist-es/models/models_1.js +14 -1
  5. package/dist-es/protocols/Aws_restJson1.js +17 -1
  6. package/dist-types/QConnect.d.ts +1 -34
  7. package/dist-types/QConnectClient.d.ts +1 -34
  8. package/dist-types/commands/ActivateMessageTemplateCommand.d.ts +2 -8
  9. package/dist-types/commands/CreateAIAgentCommand.d.ts +5 -6
  10. package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +5 -6
  11. package/dist-types/commands/CreateAIGuardrailCommand.d.ts +5 -6
  12. package/dist-types/commands/CreateAIGuardrailVersionCommand.d.ts +5 -6
  13. package/dist-types/commands/CreateAIPromptCommand.d.ts +5 -6
  14. package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +5 -6
  15. package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +3 -9
  16. package/dist-types/commands/CreateAssistantCommand.d.ts +5 -6
  17. package/dist-types/commands/CreateContentAssociationCommand.d.ts +6 -25
  18. package/dist-types/commands/CreateContentCommand.d.ts +5 -6
  19. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +6 -30
  20. package/dist-types/commands/CreateMessageTemplateAttachmentCommand.d.ts +6 -11
  21. package/dist-types/commands/CreateMessageTemplateCommand.d.ts +3 -10
  22. package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +3 -16
  23. package/dist-types/commands/CreateQuickResponseCommand.d.ts +5 -6
  24. package/dist-types/commands/CreateSessionCommand.d.ts +5 -7
  25. package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +2 -7
  26. package/dist-types/commands/DeleteAIAgentCommand.d.ts +3 -0
  27. package/dist-types/commands/DeleteAIAgentVersionCommand.d.ts +4 -4
  28. package/dist-types/commands/DeleteAIGuardrailCommand.d.ts +4 -4
  29. package/dist-types/commands/DeleteAIGuardrailVersionCommand.d.ts +4 -4
  30. package/dist-types/commands/DeleteAIPromptCommand.d.ts +3 -0
  31. package/dist-types/commands/DeleteAIPromptVersionCommand.d.ts +4 -4
  32. package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +3 -0
  33. package/dist-types/commands/DeleteAssistantCommand.d.ts +3 -0
  34. package/dist-types/commands/DeleteContentAssociationCommand.d.ts +4 -4
  35. package/dist-types/commands/DeleteContentCommand.d.ts +4 -4
  36. package/dist-types/commands/DeleteImportJobCommand.d.ts +4 -4
  37. package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +5 -13
  38. package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +2 -7
  39. package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +2 -9
  40. package/dist-types/commands/DeleteQuickResponseCommand.d.ts +3 -0
  41. package/dist-types/commands/GetAIAgentCommand.d.ts +3 -0
  42. package/dist-types/commands/GetAIGuardrailCommand.d.ts +3 -0
  43. package/dist-types/commands/GetAIPromptCommand.d.ts +3 -0
  44. package/dist-types/commands/GetAssistantAssociationCommand.d.ts +3 -0
  45. package/dist-types/commands/GetAssistantCommand.d.ts +3 -0
  46. package/dist-types/commands/GetContentAssociationCommand.d.ts +4 -4
  47. package/dist-types/commands/GetContentCommand.d.ts +3 -0
  48. package/dist-types/commands/GetContentSummaryCommand.d.ts +3 -0
  49. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +3 -0
  50. package/dist-types/commands/GetMessageTemplateCommand.d.ts +4 -6
  51. package/dist-types/commands/GetQuickResponseCommand.d.ts +3 -0
  52. package/dist-types/commands/GetRecommendationsCommand.d.ts +1 -10
  53. package/dist-types/commands/GetSessionCommand.d.ts +3 -0
  54. package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +3 -0
  55. package/dist-types/commands/ListAIAgentsCommand.d.ts +3 -0
  56. package/dist-types/commands/ListAIGuardrailVersionsCommand.d.ts +3 -0
  57. package/dist-types/commands/ListAIGuardrailsCommand.d.ts +3 -0
  58. package/dist-types/commands/ListAIPromptVersionsCommand.d.ts +3 -0
  59. package/dist-types/commands/ListAIPromptsCommand.d.ts +3 -0
  60. package/dist-types/commands/ListAssistantsCommand.d.ts +3 -0
  61. package/dist-types/commands/ListContentAssociationsCommand.d.ts +4 -4
  62. package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +1 -2
  63. package/dist-types/commands/ListMessageTemplatesCommand.d.ts +1 -2
  64. package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +1 -3
  65. package/dist-types/commands/PutFeedbackCommand.d.ts +1 -2
  66. package/dist-types/commands/QueryAssistantCommand.d.ts +2 -11
  67. package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +1 -2
  68. package/dist-types/commands/RenderMessageTemplateCommand.d.ts +1 -5
  69. package/dist-types/commands/SearchContentCommand.d.ts +4 -2
  70. package/dist-types/commands/SearchMessageTemplatesCommand.d.ts +3 -0
  71. package/dist-types/commands/SearchQuickResponsesCommand.d.ts +4 -3
  72. package/dist-types/commands/SearchSessionsCommand.d.ts +3 -0
  73. package/dist-types/commands/SendMessageCommand.d.ts +2 -7
  74. package/dist-types/commands/StartContentUploadCommand.d.ts +4 -6
  75. package/dist-types/commands/StartImportJobCommand.d.ts +6 -16
  76. package/dist-types/commands/UpdateAIAgentCommand.d.ts +4 -4
  77. package/dist-types/commands/UpdateAIGuardrailCommand.d.ts +4 -4
  78. package/dist-types/commands/UpdateAIPromptCommand.d.ts +4 -4
  79. package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +1 -2
  80. package/dist-types/commands/UpdateContentCommand.d.ts +4 -2
  81. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -6
  82. package/dist-types/commands/UpdateMessageTemplateCommand.d.ts +2 -9
  83. package/dist-types/commands/UpdateMessageTemplateMetadataCommand.d.ts +2 -9
  84. package/dist-types/commands/UpdateQuickResponseCommand.d.ts +5 -6
  85. package/dist-types/commands/UpdateSessionCommand.d.ts +4 -3
  86. package/dist-types/commands/UpdateSessionDataCommand.d.ts +3 -0
  87. package/dist-types/index.d.ts +1 -34
  88. package/dist-types/models/models_0.d.ts +229 -1216
  89. package/dist-types/models/models_1.d.ts +185 -393
  90. package/dist-types/ts3.4/models/models_0.d.ts +7 -25
  91. package/dist-types/ts3.4/models/models_1.d.ts +26 -1
  92. package/package.json +18 -18
@@ -17,14 +17,12 @@ export declare class AccessDeniedException extends __BaseException {
17
17
  */
18
18
  export interface ActivateMessageTemplateRequest {
19
19
  /**
20
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
21
- * the ARN.</p>
20
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
22
21
  * @public
23
22
  */
24
23
  knowledgeBaseId: string | undefined;
25
24
  /**
26
- * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
27
- * any qualifier.</p>
25
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
28
26
  * @public
29
27
  */
30
28
  messageTemplateId: string | undefined;
@@ -55,10 +53,7 @@ export interface ActivateMessageTemplateResponse {
55
53
  versionNumber: number | undefined;
56
54
  }
57
55
  /**
58
- * <p>The request could not be processed because of conflict in the current state of the
59
- * resource. For example, if you're using a <code>Create</code> API (such as
60
- * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
61
- * same name) is being created or mutated.</p>
56
+ * <p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>
62
57
  * @public
63
58
  */
64
59
  export declare class ConflictException extends __BaseException {
@@ -144,8 +139,7 @@ export interface TagCondition {
144
139
  value?: string | undefined;
145
140
  }
146
141
  /**
147
- * <p>A list of conditions which would be applied together with an <code>OR</code>
148
- * condition.</p>
142
+ * <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
149
143
  * @public
150
144
  */
151
145
  export type OrCondition = OrCondition.AndConditionsMember | OrCondition.TagConditionMember | OrCondition.$UnknownMember;
@@ -154,8 +148,7 @@ export type OrCondition = OrCondition.AndConditionsMember | OrCondition.TagCondi
154
148
  */
155
149
  export declare namespace OrCondition {
156
150
  /**
157
- * <p>A list of conditions which would be applied together with an <code>AND</code>
158
- * condition.</p>
151
+ * <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
159
152
  * @public
160
153
  */
161
154
  interface AndConditionsMember {
@@ -207,8 +200,7 @@ export declare namespace TagFilter {
207
200
  $unknown?: never;
208
201
  }
209
202
  /**
210
- * <p>A list of conditions which would be applied together with an <code>AND</code>
211
- * condition.</p>
203
+ * <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
212
204
  * @public
213
205
  */
214
206
  interface AndConditionsMember {
@@ -218,8 +210,7 @@ export declare namespace TagFilter {
218
210
  $unknown?: never;
219
211
  }
220
212
  /**
221
- * <p>A list of conditions which would be applied together with an <code>OR</code>
222
- * condition.</p>
213
+ * <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
223
214
  * @public
224
215
  */
225
216
  interface OrConditionsMember {
@@ -258,8 +249,7 @@ export declare const KnowledgeBaseSearchType: {
258
249
  */
259
250
  export type KnowledgeBaseSearchType = (typeof KnowledgeBaseSearchType)[keyof typeof KnowledgeBaseSearchType];
260
251
  /**
261
- * <p>The data of the configuration for a <code>KNOWLEDGE_BASE</code> type Amazon Q in Connect
262
- * Assistant Association.</p>
252
+ * <p>The data of the configuration for a <code>KNOWLEDGE_BASE</code> type Amazon Q in Connect Assistant Association.</p>
263
253
  * @public
264
254
  */
265
255
  export interface KnowledgeBaseAssociationConfigurationData {
@@ -274,16 +264,13 @@ export interface KnowledgeBaseAssociationConfigurationData {
274
264
  */
275
265
  maxResults?: number | undefined;
276
266
  /**
277
- * <p>The search type to be used against the Knowledge Base for this request. The values can be
278
- * <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector
279
- * embeddings and raw text</p>
267
+ * <p>The search type to be used against the Knowledge Base for this request. The values can be <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector embeddings and raw text</p>
280
268
  * @public
281
269
  */
282
270
  overrideKnowledgeBaseSearchType?: KnowledgeBaseSearchType | undefined;
283
271
  }
284
272
  /**
285
- * <p>A typed union of the data of the configuration for an Amazon Q in Connect Assistant
286
- * Association.</p>
273
+ * <p>A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.</p>
287
274
  * @public
288
275
  */
289
276
  export type AssociationConfigurationData = AssociationConfigurationData.KnowledgeBaseAssociationConfigurationDataMember | AssociationConfigurationData.$UnknownMember;
@@ -292,8 +279,7 @@ export type AssociationConfigurationData = AssociationConfigurationData.Knowledg
292
279
  */
293
280
  export declare namespace AssociationConfigurationData {
294
281
  /**
295
- * <p>The data of the configuration for a <code>KNOWLEDGE_BASE</code> type Amazon Q in Connect
296
- * Assistant Association.</p>
282
+ * <p>The data of the configuration for a <code>KNOWLEDGE_BASE</code> type Amazon Q in Connect Assistant Association.</p>
297
283
  * @public
298
284
  */
299
285
  interface KnowledgeBaseAssociationConfigurationDataMember {
@@ -351,26 +337,22 @@ export interface AssociationConfiguration {
351
337
  */
352
338
  export interface AnswerRecommendationAIAgentConfiguration {
353
339
  /**
354
- * <p>The AI Prompt identifier for the Intent Labeling prompt used by the
355
- * <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
340
+ * <p>The AI Prompt identifier for the Intent Labeling prompt used by the <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
356
341
  * @public
357
342
  */
358
343
  intentLabelingGenerationAIPromptId?: string | undefined;
359
344
  /**
360
- * <p>The AI Prompt identifier for the Query Reformulation prompt used by the
361
- * <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
345
+ * <p>The AI Prompt identifier for the Query Reformulation prompt used by the <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
362
346
  * @public
363
347
  */
364
348
  queryReformulationAIPromptId?: string | undefined;
365
349
  /**
366
- * <p>The AI Prompt identifier for the Answer Generation prompt used by the
367
- * <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
350
+ * <p>The AI Prompt identifier for the Answer Generation prompt used by the <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
368
351
  * @public
369
352
  */
370
353
  answerGenerationAIPromptId?: string | undefined;
371
354
  /**
372
- * <p>The AI Guardrail identifier for the Answer Generation Guardrail used by the
373
- * <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
355
+ * <p>The AI Guardrail identifier for the Answer Generation Guardrail used by the <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
374
356
  * @public
375
357
  */
376
358
  answerGenerationAIGuardrailId?: string | undefined;
@@ -380,13 +362,7 @@ export interface AnswerRecommendationAIAgentConfiguration {
380
362
  */
381
363
  associationConfigurations?: AssociationConfiguration[] | undefined;
382
364
  /**
383
- * <p>The locale to which specifies the language and region settings that determine the response
384
- * language for <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html">QueryAssistant</a>.</p>
385
- * <note>
386
- * <p>Changing this locale to anything other than <code>en_US</code>, <code>en_GB</code>, or
387
- * <code>en_AU</code> will turn off recommendations triggered by contact transcripts for
388
- * agent assistance, as this feature is not supported in multiple languages.</p>
389
- * </note>
365
+ * <p>The locale to which specifies the language and region settings that determine the response language for <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html">QueryAssistant</a>.</p> <note> <p>For more information on supported locales, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#qic-notes-languages">Language support for Amazon Q in Connect</a>.</p> </note>
390
366
  * @public
391
367
  */
392
368
  locale?: string | undefined;
@@ -397,14 +373,12 @@ export interface AnswerRecommendationAIAgentConfiguration {
397
373
  */
398
374
  export interface ManualSearchAIAgentConfiguration {
399
375
  /**
400
- * <p>The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI
401
- * Agent.</p>
376
+ * <p>The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.</p>
402
377
  * @public
403
378
  */
404
379
  answerGenerationAIPromptId?: string | undefined;
405
380
  /**
406
- * <p>The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH
407
- * AI Agent.</p>
381
+ * <p>The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.</p>
408
382
  * @public
409
383
  */
410
384
  answerGenerationAIGuardrailId?: string | undefined;
@@ -414,8 +388,7 @@ export interface ManualSearchAIAgentConfiguration {
414
388
  */
415
389
  associationConfigurations?: AssociationConfiguration[] | undefined;
416
390
  /**
417
- * <p>The locale to which specifies the language and region settings that determine the response
418
- * language for <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html">QueryAssistant</a>.</p>
391
+ * <p>The locale to which specifies the language and region settings that determine the response language for <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html">QueryAssistant</a>.</p> <note> <p>For more information on supported locales, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#qic-notes-languages">Language support for Amazon Q in Connect</a>.</p> </note>
419
392
  * @public
420
393
  */
421
394
  locale?: string | undefined;
@@ -426,14 +399,12 @@ export interface ManualSearchAIAgentConfiguration {
426
399
  */
427
400
  export interface SelfServiceAIAgentConfiguration {
428
401
  /**
429
- * <p>The AI Prompt identifier for the Self Service Pre-Processing prompt used by the
430
- * SELF_SERVICE AI Agent</p>
402
+ * <p>The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent</p>
431
403
  * @public
432
404
  */
433
405
  selfServicePreProcessingAIPromptId?: string | undefined;
434
406
  /**
435
- * <p>The AI Prompt identifier for the Self Service Answer Generation prompt used by the
436
- * SELF_SERVICE AI Agent</p>
407
+ * <p>The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent</p>
437
408
  * @public
438
409
  */
439
410
  selfServiceAnswerGenerationAIPromptId?: string | undefined;
@@ -534,16 +505,12 @@ export type VisibilityStatus = (typeof VisibilityStatus)[keyof typeof Visibility
534
505
  */
535
506
  export interface CreateAIAgentRequest {
536
507
  /**
537
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
538
- * request. If not provided, the Amazon Web Services
539
- * SDK populates this field. For more information about idempotency, see
540
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
508
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
541
509
  * @public
542
510
  */
543
511
  clientToken?: string | undefined;
544
512
  /**
545
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
546
- * cannot contain the ARN.</p>
513
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
547
514
  * @public
548
515
  */
549
516
  assistantId: string | undefined;
@@ -612,8 +579,7 @@ export type Status = (typeof Status)[keyof typeof Status];
612
579
  */
613
580
  export interface AIAgentData {
614
581
  /**
615
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
616
- * cannot contain the ARN.</p>
582
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
617
583
  * @public
618
584
  */
619
585
  assistantId: string | undefined;
@@ -668,9 +634,7 @@ export interface AIAgentData {
668
634
  */
669
635
  tags?: Record<string, string> | undefined;
670
636
  /**
671
- * <p>Specifies the origin of the AI Agent. <code>SYSTEM</code> for a default AI Agent created
672
- * by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation
673
- * APIs. </p>
637
+ * <p>Specifies the origin of the AI Agent. <code>SYSTEM</code> for a default AI Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation APIs. </p>
674
638
  * @public
675
639
  */
676
640
  origin?: Origin | undefined;
@@ -691,8 +655,7 @@ export interface CreateAIAgentResponse {
691
655
  aiAgent?: AIAgentData | undefined;
692
656
  }
693
657
  /**
694
- * <p>You've exceeded your service quota. To perform the requested action, remove some of the
695
- * relevant resources, or use service quotas to request a service quota increase.</p>
658
+ * <p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>
696
659
  * @public
697
660
  */
698
661
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -703,13 +666,24 @@ export declare class ServiceQuotaExceededException extends __BaseException {
703
666
  */
704
667
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
705
668
  }
669
+ /**
670
+ * <p>You do not have permission to perform this action.</p>
671
+ * @public
672
+ */
673
+ export declare class UnauthorizedException extends __BaseException {
674
+ readonly name: "UnauthorizedException";
675
+ readonly $fault: "client";
676
+ /**
677
+ * @internal
678
+ */
679
+ constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
680
+ }
706
681
  /**
707
682
  * @public
708
683
  */
709
684
  export interface CreateAIAgentVersionRequest {
710
685
  /**
711
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
712
- * cannot contain the ARN.</p>
686
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
713
687
  * @public
714
688
  */
715
689
  assistantId: string | undefined;
@@ -719,19 +693,12 @@ export interface CreateAIAgentVersionRequest {
719
693
  */
720
694
  aiAgentId: string | undefined;
721
695
  /**
722
- * <p>The modification time of the AI Agent should be tracked for version creation. This field
723
- * should be specified to avoid version creation when simultaneous update to the underlying AI
724
- * Agent are possible. The value should be the modifiedTime returned from the request to create
725
- * or update an AI Agent so that version creation can fail if an update to the AI Agent post the
726
- * specified modification time has been made.</p>
696
+ * <p>The modification time of the AI Agent should be tracked for version creation. This field should be specified to avoid version creation when simultaneous update to the underlying AI Agent are possible. The value should be the modifiedTime returned from the request to create or update an AI Agent so that version creation can fail if an update to the AI Agent post the specified modification time has been made.</p>
727
697
  * @public
728
698
  */
729
699
  modifiedTime?: Date | undefined;
730
700
  /**
731
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
732
- * request. If not provided, the Amazon Web Services
733
- * SDK populates this field. For more information about idempotency, see
734
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
701
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
735
702
  * @public
736
703
  */
737
704
  clientToken?: string | undefined;
@@ -756,14 +723,12 @@ export interface CreateAIAgentVersionResponse {
756
723
  */
757
724
  export interface DeleteAIAgentRequest {
758
725
  /**
759
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
760
- * cannot contain the ARN.</p>
726
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
761
727
  * @public
762
728
  */
763
729
  assistantId: string | undefined;
764
730
  /**
765
- * <p>The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs
766
- * cannot contain the ARN.</p>
731
+ * <p>The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
767
732
  * @public
768
733
  */
769
734
  aiAgentId: string | undefined;
@@ -778,14 +743,12 @@ export interface DeleteAIAgentResponse {
778
743
  */
779
744
  export interface DeleteAIAgentVersionRequest {
780
745
  /**
781
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
782
- * cannot contain the ARN.</p>
746
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
783
747
  * @public
784
748
  */
785
749
  assistantId: string | undefined;
786
750
  /**
787
- * <p>The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs
788
- * cannot contain the ARN.</p>
751
+ * <p>The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
789
752
  * @public
790
753
  */
791
754
  aiAgentId: string | undefined;
@@ -805,14 +768,12 @@ export interface DeleteAIAgentVersionResponse {
805
768
  */
806
769
  export interface GetAIAgentRequest {
807
770
  /**
808
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
809
- * cannot contain the ARN.</p>
771
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
810
772
  * @public
811
773
  */
812
774
  assistantId: string | undefined;
813
775
  /**
814
- * <p>The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier).
815
- * Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
776
+ * <p>The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
816
777
  * @public
817
778
  */
818
779
  aiAgentId: string | undefined;
@@ -827,8 +788,7 @@ export interface GetAIAgentResponse {
827
788
  */
828
789
  aiAgent?: AIAgentData | undefined;
829
790
  /**
830
- * <p>The version number of the AI Agent version (returned if an AI Agent version was specified
831
- * via use of a qualifier for the <code>aiAgentId</code> on the request). </p>
791
+ * <p>The version number of the AI Agent version (returned if an AI Agent version was specified via use of a qualifier for the <code>aiAgentId</code> on the request). </p>
832
792
  * @public
833
793
  */
834
794
  versionNumber?: number | undefined;
@@ -838,14 +798,12 @@ export interface GetAIAgentResponse {
838
798
  */
839
799
  export interface ListAIAgentsRequest {
840
800
  /**
841
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
842
- * cannot contain the ARN.</p>
801
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
843
802
  * @public
844
803
  */
845
804
  assistantId: string | undefined;
846
805
  /**
847
- * <p>The token for the next set of results. Use the value returned in the previous response in
848
- * the next request to retrieve the next set of results.</p>
806
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
849
807
  * @public
850
808
  */
851
809
  nextToken?: string | undefined;
@@ -855,9 +813,7 @@ export interface ListAIAgentsRequest {
855
813
  */
856
814
  maxResults?: number | undefined;
857
815
  /**
858
- * <p>The origin of the AI Agents to be listed. <code>SYSTEM</code> for a default AI Agent
859
- * created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent
860
- * creation APIs. </p>
816
+ * <p>The origin of the AI Agents to be listed. <code>SYSTEM</code> for a default AI Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation APIs. </p>
861
817
  * @public
862
818
  */
863
819
  origin?: Origin | undefined;
@@ -873,8 +829,7 @@ export interface AIAgentSummary {
873
829
  */
874
830
  name: string | undefined;
875
831
  /**
876
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
877
- * cannot contain the ARN.</p>
832
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
878
833
  * @public
879
834
  */
880
835
  assistantId: string | undefined;
@@ -914,9 +869,7 @@ export interface AIAgentSummary {
914
869
  */
915
870
  configuration?: AIAgentConfiguration | undefined;
916
871
  /**
917
- * <p>The origin of the AI Agent. <code>SYSTEM</code> for a default AI Agent created by Q in
918
- * Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation
919
- * APIs.</p>
872
+ * <p>The origin of the AI Agent. <code>SYSTEM</code> for a default AI Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation APIs.</p>
920
873
  * @public
921
874
  */
922
875
  origin?: Origin | undefined;
@@ -946,8 +899,7 @@ export interface ListAIAgentsResponse {
946
899
  */
947
900
  aiAgentSummaries: AIAgentSummary[] | undefined;
948
901
  /**
949
- * <p>The token for the next set of results. Use the value returned in the previous response in
950
- * the next request to retrieve the next set of results.</p>
902
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
951
903
  * @public
952
904
  */
953
905
  nextToken?: string | undefined;
@@ -957,20 +909,17 @@ export interface ListAIAgentsResponse {
957
909
  */
958
910
  export interface ListAIAgentVersionsRequest {
959
911
  /**
960
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
961
- * cannot contain the ARN.</p>
912
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
962
913
  * @public
963
914
  */
964
915
  assistantId: string | undefined;
965
916
  /**
966
- * <p>The identifier of the Amazon Q in Connect AI Agent for which versions are to be
967
- * listed.</p>
917
+ * <p>The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.</p>
968
918
  * @public
969
919
  */
970
920
  aiAgentId: string | undefined;
971
921
  /**
972
- * <p>The token for the next set of results. Use the value returned in the previous response in
973
- * the next request to retrieve the next set of results.</p>
922
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
974
923
  * @public
975
924
  */
976
925
  nextToken?: string | undefined;
@@ -980,9 +929,7 @@ export interface ListAIAgentVersionsRequest {
980
929
  */
981
930
  maxResults?: number | undefined;
982
931
  /**
983
- * <p>The origin of the AI Agent versions to be listed. <code>SYSTEM</code> for a default AI
984
- * Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI
985
- * Agent creation APIs. </p>
932
+ * <p>The origin of the AI Agent versions to be listed. <code>SYSTEM</code> for a default AI Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation APIs. </p>
986
933
  * @public
987
934
  */
988
935
  origin?: Origin | undefined;
@@ -1013,8 +960,7 @@ export interface ListAIAgentVersionsResponse {
1013
960
  */
1014
961
  aiAgentVersionSummaries: AIAgentVersionSummary[] | undefined;
1015
962
  /**
1016
- * <p>The token for the next set of results. Use the value returned in the previous response in
1017
- * the next request to retrieve the next set of results.</p>
963
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
1018
964
  * @public
1019
965
  */
1020
966
  nextToken?: string | undefined;
@@ -1024,16 +970,12 @@ export interface ListAIAgentVersionsResponse {
1024
970
  */
1025
971
  export interface UpdateAIAgentRequest {
1026
972
  /**
1027
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1028
- * request. If not provided, the Amazon Web Services
1029
- * SDK populates this field. For more information about idempotency, see
1030
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
973
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
1031
974
  * @public
1032
975
  */
1033
976
  clientToken?: string | undefined;
1034
977
  /**
1035
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
1036
- * cannot contain the ARN.</p>
978
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1037
979
  * @public
1038
980
  */
1039
981
  assistantId: string | undefined;
@@ -1069,8 +1011,7 @@ export interface UpdateAIAgentResponse {
1069
1011
  aiAgent?: AIAgentData | undefined;
1070
1012
  }
1071
1013
  /**
1072
- * <p>A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be
1073
- * used for an AI Agent type on a session or assistant.</p>
1014
+ * <p>A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.</p>
1074
1015
  * @public
1075
1016
  */
1076
1017
  export interface AIAgentConfigurationData {
@@ -1111,44 +1052,7 @@ export declare const GuardrailContentFilterType: {
1111
1052
  */
1112
1053
  export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType];
1113
1054
  /**
1114
- * <p>Contains filter strengths for harmful content. AI Guardrail's support the following
1115
- * content filters to detect and filter harmful user inputs and FM-generated outputs.</p>
1116
- * <ul>
1117
- * <li>
1118
- * <p>
1119
- * <b>Hate</b>: Describes input prompts and model responses that
1120
- * discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of
1121
- * an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and
1122
- * national origin).</p>
1123
- * </li>
1124
- * <li>
1125
- * <p>
1126
- * <b>Insults</b>: Describes input prompts and model responses that
1127
- * includes demeaning, humiliating, mocking, insulting, or belittling language. This type of
1128
- * language is also labeled as bullying.</p>
1129
- * </li>
1130
- * <li>
1131
- * <p>
1132
- * <b>Sexual</b>: Describes input prompts and model responses that
1133
- * indicates sexual interest, activity, or arousal using direct or indirect references to
1134
- * body parts, physical traits, or sex.</p>
1135
- * </li>
1136
- * <li>
1137
- * <p>
1138
- * <b>Violence</b>: Describes input prompts and model responses
1139
- * that includes glorification of, or threats to inflict physical pain, hurt, or injury
1140
- * toward a person, group, or thing.</p>
1141
- * </li>
1142
- * </ul>
1143
- * <p>Content filtering depends on the confidence classification of user inputs and FM responses
1144
- * across each of the four harmful categories. All input and output statements are classified
1145
- * into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For
1146
- * example, if a statement is classified as <i>Hate</i> with HIGH confidence, the
1147
- * likelihood of the statement representing hateful content is high. A single statement can be
1148
- * classified across multiple categories with varying confidence levels. For example, a single
1149
- * statement can be classified as <i>Hate</i> with HIGH confidence, <i>
1150
- * Insults</i> with LOW confidence, <i>Sexual</i> with NONE confidence,
1151
- * and <i>Violence</i> with MEDIUM confidence.</p>
1055
+ * <p>Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs.</p> <ul> <li> <p> <b>Hate</b>: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).</p> </li> <li> <p> <b>Insults</b>: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.</p> </li> <li> <p> <b>Sexual</b>: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.</p> </li> <li> <p> <b>Violence</b>: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing.</p> </li> </ul> <p>Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as <i>Hate</i> with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as <i>Hate</i> with HIGH confidence, <i> Insults</i> with LOW confidence, <i>Sexual</i> with NONE confidence, and <i>Violence</i> with MEDIUM confidence.</p>
1152
1056
  * @public
1153
1057
  */
1154
1058
  export interface GuardrailContentFilterConfig {
@@ -1158,16 +1062,12 @@ export interface GuardrailContentFilterConfig {
1158
1062
  */
1159
1063
  type: GuardrailContentFilterType | undefined;
1160
1064
  /**
1161
- * <p>The strength of the content filter to apply to prompts. As you increase the filter
1162
- * strength, the likelihood of filtering harmful content increases and the probability of seeing
1163
- * harmful content in your application reduces.</p>
1065
+ * <p>The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.</p>
1164
1066
  * @public
1165
1067
  */
1166
1068
  inputStrength: GuardrailFilterStrength | undefined;
1167
1069
  /**
1168
- * <p>The strength of the content filter to apply to model responses. As you increase the filter
1169
- * strength, the likelihood of filtering harmful content increases and the probability of seeing
1170
- * harmful content in your application reduces.</p>
1070
+ * <p>The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.</p>
1171
1071
  * @public
1172
1072
  */
1173
1073
  outputStrength: GuardrailFilterStrength | undefined;
@@ -1178,8 +1078,7 @@ export interface GuardrailContentFilterConfig {
1178
1078
  */
1179
1079
  export interface AIGuardrailContentPolicyConfig {
1180
1080
  /**
1181
- * <p>Contains the type of the content filter and how strongly it should apply to prompts and
1182
- * model responses.</p>
1081
+ * <p>Contains the type of the content filter and how strongly it should apply to prompts and model responses.</p>
1183
1082
  * @public
1184
1083
  */
1185
1084
  filtersConfig: GuardrailContentFilterConfig[] | undefined;
@@ -1197,8 +1096,7 @@ export declare const GuardrailContextualGroundingFilterType: {
1197
1096
  */
1198
1097
  export type GuardrailContextualGroundingFilterType = (typeof GuardrailContextualGroundingFilterType)[keyof typeof GuardrailContextualGroundingFilterType];
1199
1098
  /**
1200
- * <p>The filter configuration details for the AI Guardrail's contextual grounding
1201
- * filter.</p>
1099
+ * <p>The filter configuration details for the AI Guardrail's contextual grounding filter.</p>
1202
1100
  * @public
1203
1101
  */
1204
1102
  export interface GuardrailContextualGroundingFilterConfig {
@@ -1214,8 +1112,7 @@ export interface GuardrailContextualGroundingFilterConfig {
1214
1112
  threshold: number | undefined;
1215
1113
  }
1216
1114
  /**
1217
- * <p>The policy configuration details for the AI Guardrail's contextual grounding
1218
- * policy.</p>
1115
+ * <p>The policy configuration details for the AI Guardrail's contextual grounding policy.</p>
1219
1116
  * @public
1220
1117
  */
1221
1118
  export interface AIGuardrailContextualGroundingPolicyConfig {
@@ -1284,307 +1181,7 @@ export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeo
1284
1181
  */
1285
1182
  export interface GuardrailPiiEntityConfig {
1286
1183
  /**
1287
- * <p>Configure AI Guardrail type when the PII entity is detected.</p>
1288
- * <p>The following PIIs are used to block or mask sensitive information:</p>
1289
- * <ul>
1290
- * <li>
1291
- * <p>
1292
- * <b>General</b>
1293
- * </p>
1294
- * <ul>
1295
- * <li>
1296
- * <p>
1297
- * <b>ADDRESS</b>
1298
- * </p>
1299
- * <p>A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12,
1300
- * Building 123". An address can include information such as the street, building,
1301
- * location, city, state, country, county, zip code, precinct, and neighborhood. </p>
1302
- * </li>
1303
- * <li>
1304
- * <p>
1305
- * <b>AGE</b>
1306
- * </p>
1307
- * <p>An individual's age, including the quantity and unit of time. For example, in the
1308
- * phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. </p>
1309
- * </li>
1310
- * <li>
1311
- * <p>
1312
- * <b>NAME</b>
1313
- * </p>
1314
- * <p>An individual's name. This entity type does not include titles, such as Dr., Mr.,
1315
- * Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of
1316
- * organizations or addresses. For example, AI Guardrail recognizes the "John Doe
1317
- * Organization" as an organization, and it recognizes "Jane Doe Street" as an address.
1318
- * </p>
1319
- * </li>
1320
- * <li>
1321
- * <p>
1322
- * <b>EMAIL</b>
1323
- * </p>
1324
- * <p>An email address, such as <i>marymajor@email.com</i>.</p>
1325
- * </li>
1326
- * <li>
1327
- * <p>
1328
- * <b>PHONE</b>
1329
- * </p>
1330
- * <p>A phone number. This entity type also includes fax and pager numbers. </p>
1331
- * </li>
1332
- * <li>
1333
- * <p>
1334
- * <b>USERNAME</b>
1335
- * </p>
1336
- * <p>A user name that identifies an account, such as a login name, screen name, nick
1337
- * name, or handle. </p>
1338
- * </li>
1339
- * <li>
1340
- * <p>
1341
- * <b>PASSWORD</b>
1342
- * </p>
1343
- * <p>An alphanumeric string that is used as a password, such as "*<i>
1344
- * very20special#pass*</i>". </p>
1345
- * </li>
1346
- * <li>
1347
- * <p>
1348
- * <b>DRIVER_ID</b>
1349
- * </p>
1350
- * <p>The number assigned to a driver's license, which is an official document
1351
- * permitting an individual to operate one or more motorized vehicles on a public road. A
1352
- * driver's license number consists of alphanumeric characters. </p>
1353
- * </li>
1354
- * <li>
1355
- * <p>
1356
- * <b>LICENSE_PLATE</b>
1357
- * </p>
1358
- * <p>A license plate for a vehicle is issued by the state or country where the vehicle
1359
- * is registered. The format for passenger vehicles is typically five to eight digits,
1360
- * consisting of upper-case letters and numbers. The format varies depending on the
1361
- * location of the issuing state or country. </p>
1362
- * </li>
1363
- * <li>
1364
- * <p>
1365
- * <b>VEHICLE_IDENTIFICATION_NUMBER</b>
1366
- * </p>
1367
- * <p>A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content
1368
- * and format are defined in the <i>ISO 3779</i> specification. Each
1369
- * country has specific codes and formats for VINs. </p>
1370
- * </li>
1371
- * </ul>
1372
- * </li>
1373
- * <li>
1374
- * <p>
1375
- * <b>Finance</b>
1376
- * </p>
1377
- * <ul>
1378
- * <li>
1379
- * <p>
1380
- * <b>CREDIT_DEBIT_CARD_CVV</b>
1381
- * </p>
1382
- * <p>A three-digit card verification code (CVV) that is present on VISA, MasterCard,
1383
- * and Discover credit and debit cards. For American Express credit or debit cards, the
1384
- * CVV is a four-digit numeric code. </p>
1385
- * </li>
1386
- * <li>
1387
- * <p>
1388
- * <b>CREDIT_DEBIT_CARD_EXPIRY</b>
1389
- * </p>
1390
- * <p>The expiration date for a credit or debit card. This number is usually four digits
1391
- * long and is often formatted as <i>month/year</i> or
1392
- * <i>MM/YY</i>. AI Guardrail recognizes expiration dates such as
1393
- * <i>01/21</i>, <i>01/2021</i>, and <i>Jan
1394
- * 2021</i>. </p>
1395
- * </li>
1396
- * <li>
1397
- * <p>
1398
- * <b>CREDIT_DEBIT_CARD_NUMBER</b>
1399
- * </p>
1400
- * <p>The number for a credit or debit card. These numbers can vary from 13 to 16 digits
1401
- * in length. However, Amazon Comprehend also recognizes credit or debit card numbers
1402
- * when only the last four digits are present. </p>
1403
- * </li>
1404
- * <li>
1405
- * <p>
1406
- * <b>PIN</b>
1407
- * </p>
1408
- * <p>A four-digit personal identification number (PIN) with which you can access your
1409
- * bank account. </p>
1410
- * </li>
1411
- * <li>
1412
- * <p>
1413
- * <b>INTERNATIONAL_BANK_ACCOUNT_NUMBER</b>
1414
- * </p>
1415
- * <p>An International Bank Account Number has specific formats in each country. For
1416
- * more information, see <a href="https://www.iban.com/structure">
1417
- * www.iban.com/structure</a>.</p>
1418
- * </li>
1419
- * <li>
1420
- * <p>
1421
- * <b>SWIFT_CODE</b>
1422
- * </p>
1423
- * <p>A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a
1424
- * particular bank or branch. Banks use these codes for money transfers such as
1425
- * international wire transfers.</p>
1426
- * <p>SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to
1427
- * specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer
1428
- * to the head or primary office.</p>
1429
- * </li>
1430
- * </ul>
1431
- * </li>
1432
- * <li>
1433
- * <p>
1434
- * <b>IT</b>
1435
- * </p>
1436
- * <ul>
1437
- * <li>
1438
- * <p>
1439
- * <b>IP_ADDRESS</b>
1440
- * </p>
1441
- * <p>An IPv4 address, such as <i>198.51.100.0</i>. </p>
1442
- * </li>
1443
- * <li>
1444
- * <p>
1445
- * <b>MAC_ADDRESS</b>
1446
- * </p>
1447
- * <p>A <i>media access control</i> (MAC) address is a unique identifier
1448
- * assigned to a network interface controller (NIC). </p>
1449
- * </li>
1450
- * <li>
1451
- * <p>
1452
- * <b>URL</b>
1453
- * </p>
1454
- * <p>A web address, such as <i>www.example.com</i>. </p>
1455
- * </li>
1456
- * <li>
1457
- * <p>
1458
- * <b>AWS_ACCESS_KEY</b>
1459
- * </p>
1460
- * <p>A unique identifier that's associated with a secret access key; you use the access
1461
- * key ID and secret access key to sign programmatic Amazon Web Services requests
1462
- * cryptographically. </p>
1463
- * </li>
1464
- * <li>
1465
- * <p>
1466
- * <b>AWS_SECRET_KEY</b>
1467
- * </p>
1468
- * <p>A unique identifier that's associated with an access key. You use the access key
1469
- * ID and secret access key to sign programmatic Amazon Web Services requests
1470
- * cryptographically. </p>
1471
- * </li>
1472
- * </ul>
1473
- * </li>
1474
- * <li>
1475
- * <p>
1476
- * <b>USA specific</b>
1477
- * </p>
1478
- * <ul>
1479
- * <li>
1480
- * <p>
1481
- * <b>US_BANK_ACCOUNT_NUMBER</b>
1482
- * </p>
1483
- * <p>A US bank account number, which is typically 10 to 12 digits long. </p>
1484
- * </li>
1485
- * <li>
1486
- * <p>
1487
- * <b>US_BANK_ROUTING_NUMBER</b>
1488
- * </p>
1489
- * <p>A US bank account routing number. These are typically nine digits long, </p>
1490
- * </li>
1491
- * <li>
1492
- * <p>
1493
- * <b>US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER</b>
1494
- * </p>
1495
- * <p>A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that
1496
- * starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be
1497
- * formatted with a space or a dash after the third and forth digits. </p>
1498
- * </li>
1499
- * <li>
1500
- * <p>
1501
- * <b>US_PASSPORT_NUMBER</b>
1502
- * </p>
1503
- * <p>A US passport number. Passport numbers range from six to nine alphanumeric
1504
- * characters. </p>
1505
- * </li>
1506
- * <li>
1507
- * <p>
1508
- * <b>US_SOCIAL_SECURITY_NUMBER</b>
1509
- * </p>
1510
- * <p>A US Social Security Number (SSN) is a nine-digit number that is issued to US
1511
- * citizens, permanent residents, and temporary working residents. </p>
1512
- * </li>
1513
- * </ul>
1514
- * </li>
1515
- * <li>
1516
- * <p>
1517
- * <b>Canada specific</b>
1518
- * </p>
1519
- * <ul>
1520
- * <li>
1521
- * <p>
1522
- * <b>CA_HEALTH_NUMBER</b>
1523
- * </p>
1524
- * <p>A Canadian Health Service Number is a 10-digit unique identifier, required for
1525
- * individuals to access healthcare benefits. </p>
1526
- * </li>
1527
- * <li>
1528
- * <p>
1529
- * <b>CA_SOCIAL_INSURANCE_NUMBER</b>
1530
- * </p>
1531
- * <p>A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier,
1532
- * required for individuals to access government programs and benefits.</p>
1533
- * <p>The SIN is formatted as three groups of three digits, such as <i>
1534
- * 123-456-789</i>. A SIN can be validated through a simple check-digit process
1535
- * called the <a href="https://www.wikipedia.org/wiki/Luhn_algorithm">Luhn
1536
- * algorithm</a> .</p>
1537
- * </li>
1538
- * </ul>
1539
- * </li>
1540
- * <li>
1541
- * <p>
1542
- * <b>UK Specific</b>
1543
- * </p>
1544
- * <ul>
1545
- * <li>
1546
- * <p>
1547
- * <b>UK_NATIONAL_HEALTH_SERVICE_NUMBER</b>
1548
- * </p>
1549
- * <p>A UK National Health Service Number is a 10-17 digit number, such as <i>485
1550
- * 555 3456</i>. The current system formats the 10-digit number with spaces
1551
- * after the third and sixth digits. The final digit is an error-detecting
1552
- * checksum.</p>
1553
- * </li>
1554
- * <li>
1555
- * <p>
1556
- * <b>UK_NATIONAL_INSURANCE_NUMBER</b>
1557
- * </p>
1558
- * <p>A UK National Insurance Number (NINO) provides individuals with access to National
1559
- * Insurance (social security) benefits. It is also used for some purposes in the UK tax
1560
- * system.</p>
1561
- * <p>The number is nine digits long and starts with two letters, followed by six
1562
- * numbers and one letter. A NINO can be formatted with a space or a dash after the two
1563
- * letters and after the second, forth, and sixth digits.</p>
1564
- * </li>
1565
- * <li>
1566
- * <p>
1567
- * <b>UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER</b>
1568
- * </p>
1569
- * <p>A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a
1570
- * taxpayer or a business. </p>
1571
- * </li>
1572
- * </ul>
1573
- * </li>
1574
- * <li>
1575
- * <p>
1576
- * <b>Custom</b>
1577
- * </p>
1578
- * <ul>
1579
- * <li>
1580
- * <p>
1581
- * <b>Regex filter</b> - You can use a regular expressions to
1582
- * define patterns for an AI Guardrail to recognize and act upon such as serial number,
1583
- * booking ID etc..</p>
1584
- * </li>
1585
- * </ul>
1586
- * </li>
1587
- * </ul>
1184
+ * <p>Configure AI Guardrail type when the PII entity is detected.</p> <p>The following PIIs are used to block or mask sensitive information:</p> <ul> <li> <p> <b>General</b> </p> <ul> <li> <p> <b>ADDRESS</b> </p> <p>A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. </p> </li> <li> <p> <b>AGE</b> </p> <p>An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. </p> </li> <li> <p> <b>NAME</b> </p> <p>An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. </p> </li> <li> <p> <b>EMAIL</b> </p> <p>An email address, such as <i>marymajor@email.com</i>.</p> </li> <li> <p> <b>PHONE</b> </p> <p>A phone number. This entity type also includes fax and pager numbers. </p> </li> <li> <p> <b>USERNAME</b> </p> <p>A user name that identifies an account, such as a login name, screen name, nick name, or handle. </p> </li> <li> <p> <b>PASSWORD</b> </p> <p>An alphanumeric string that is used as a password, such as "*<i> very20special#pass*</i>". </p> </li> <li> <p> <b>DRIVER_ID</b> </p> <p>The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. </p> </li> <li> <p> <b>LICENSE_PLATE</b> </p> <p>A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. </p> </li> <li> <p> <b>VEHICLE_IDENTIFICATION_NUMBER</b> </p> <p>A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the <i>ISO 3779</i> specification. Each country has specific codes and formats for VINs. </p> </li> </ul> </li> <li> <p> <b>Finance</b> </p> <ul> <li> <p> <b>CREDIT_DEBIT_CARD_CVV</b> </p> <p>A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. </p> </li> <li> <p> <b>CREDIT_DEBIT_CARD_EXPIRY</b> </p> <p>The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as <i>month/year</i> or <i>MM/YY</i>. AI Guardrail recognizes expiration dates such as <i>01/21</i>, <i>01/2021</i>, and <i>Jan 2021</i>. </p> </li> <li> <p> <b>CREDIT_DEBIT_CARD_NUMBER</b> </p> <p>The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. </p> </li> <li> <p> <b>PIN</b> </p> <p>A four-digit personal identification number (PIN) with which you can access your bank account. </p> </li> <li> <p> <b>INTERNATIONAL_BANK_ACCOUNT_NUMBER</b> </p> <p>An International Bank Account Number has specific formats in each country. For more information, see <a href="https://www.iban.com/structure"> www.iban.com/structure</a>.</p> </li> <li> <p> <b>SWIFT_CODE</b> </p> <p>A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.</p> <p>SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.</p> </li> </ul> </li> <li> <p> <b>IT</b> </p> <ul> <li> <p> <b>IP_ADDRESS</b> </p> <p>An IPv4 address, such as <i>198.51.100.0</i>. </p> </li> <li> <p> <b>MAC_ADDRESS</b> </p> <p>A <i>media access control</i> (MAC) address is a unique identifier assigned to a network interface controller (NIC). </p> </li> <li> <p> <b>URL</b> </p> <p>A web address, such as <i>www.example.com</i>. </p> </li> <li> <p> <b>AWS_ACCESS_KEY</b> </p> <p>A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. </p> </li> <li> <p> <b>AWS_SECRET_KEY</b> </p> <p>A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. </p> </li> </ul> </li> <li> <p> <b>USA specific</b> </p> <ul> <li> <p> <b>US_BANK_ACCOUNT_NUMBER</b> </p> <p>A US bank account number, which is typically 10 to 12 digits long. </p> </li> <li> <p> <b>US_BANK_ROUTING_NUMBER</b> </p> <p>A US bank account routing number. These are typically nine digits long, </p> </li> <li> <p> <b>US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER</b> </p> <p>A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. </p> </li> <li> <p> <b>US_PASSPORT_NUMBER</b> </p> <p>A US passport number. Passport numbers range from six to nine alphanumeric characters. </p> </li> <li> <p> <b>US_SOCIAL_SECURITY_NUMBER</b> </p> <p>A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. </p> </li> </ul> </li> <li> <p> <b>Canada specific</b> </p> <ul> <li> <p> <b>CA_HEALTH_NUMBER</b> </p> <p>A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. </p> </li> <li> <p> <b>CA_SOCIAL_INSURANCE_NUMBER</b> </p> <p>A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.</p> <p>The SIN is formatted as three groups of three digits, such as <i> 123-456-789</i>. A SIN can be validated through a simple check-digit process called the <a href="https://www.wikipedia.org/wiki/Luhn_algorithm">Luhn algorithm</a> .</p> </li> </ul> </li> <li> <p> <b>UK Specific</b> </p> <ul> <li> <p> <b>UK_NATIONAL_HEALTH_SERVICE_NUMBER</b> </p> <p>A UK National Health Service Number is a 10-17 digit number, such as <i>485 555 3456</i>. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.</p> </li> <li> <p> <b>UK_NATIONAL_INSURANCE_NUMBER</b> </p> <p>A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.</p> <p>The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.</p> </li> <li> <p> <b>UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER</b> </p> <p>A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. </p> </li> </ul> </li> <li> <p> <b>Custom</b> </p> <ul> <li> <p> <b>Regex filter</b> - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc..</p> </li> </ul> </li> </ul>
1588
1185
  * @public
1589
1186
  */
1590
1187
  type: GuardrailPiiEntityType | undefined;
@@ -1621,8 +1218,7 @@ export interface GuardrailRegexConfig {
1621
1218
  action: GuardrailSensitiveInformationAction | undefined;
1622
1219
  }
1623
1220
  /**
1624
- * <p>Contains details about PII entities and regular expressions to configure for the AI
1625
- * Guardrail.</p>
1221
+ * <p>Contains details about PII entities and regular expressions to configure for the AI Guardrail.</p>
1626
1222
  * @public
1627
1223
  */
1628
1224
  export interface AIGuardrailSensitiveInformationPolicyConfig {
@@ -1664,8 +1260,7 @@ export interface GuardrailTopicConfig {
1664
1260
  */
1665
1261
  definition: string | undefined;
1666
1262
  /**
1667
- * <p>A list of prompts, each of which is an example of a prompt that can be categorized as
1668
- * belonging to the topic.</p>
1263
+ * <p>A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.</p>
1669
1264
  * @public
1670
1265
  */
1671
1266
  examples?: string[] | undefined;
@@ -1740,16 +1335,12 @@ export interface AIGuardrailWordPolicyConfig {
1740
1335
  */
1741
1336
  export interface CreateAIGuardrailRequest {
1742
1337
  /**
1743
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1744
- * request. If not provided, the Amazon Web Services
1745
- * SDK populates this field. For more information about idempotency, see
1746
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
1338
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
1747
1339
  * @public
1748
1340
  */
1749
1341
  clientToken?: string | undefined;
1750
1342
  /**
1751
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
1752
- * cannot contain the ARN.</p>
1343
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1753
1344
  * @public
1754
1345
  */
1755
1346
  assistantId: string | undefined;
@@ -1815,8 +1406,7 @@ export interface CreateAIGuardrailRequest {
1815
1406
  */
1816
1407
  export interface AIGuardrailData {
1817
1408
  /**
1818
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
1819
- * cannot contain the ARN.</p>
1409
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1820
1410
  * @public
1821
1411
  */
1822
1412
  assistantId: string | undefined;
@@ -1876,14 +1466,12 @@ export interface AIGuardrailData {
1876
1466
  */
1877
1467
  wordPolicyConfig?: AIGuardrailWordPolicyConfig | undefined;
1878
1468
  /**
1879
- * <p>Contains details about PII entities and regular expressions to configure for the AI
1880
- * Guardrail.</p>
1469
+ * <p>Contains details about PII entities and regular expressions to configure for the AI Guardrail.</p>
1881
1470
  * @public
1882
1471
  */
1883
1472
  sensitiveInformationPolicyConfig?: AIGuardrailSensitiveInformationPolicyConfig | undefined;
1884
1473
  /**
1885
- * <p>The policy configuration details for the AI Guardrail's contextual grounding
1886
- * policy.</p>
1474
+ * <p>The policy configuration details for the AI Guardrail's contextual grounding policy.</p>
1887
1475
  * @public
1888
1476
  */
1889
1477
  contextualGroundingPolicyConfig?: AIGuardrailContextualGroundingPolicyConfig | undefined;
@@ -1918,8 +1506,7 @@ export interface CreateAIGuardrailResponse {
1918
1506
  */
1919
1507
  export interface CreateAIGuardrailVersionRequest {
1920
1508
  /**
1921
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
1922
- * cannot contain the ARN.</p>
1509
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1923
1510
  * @public
1924
1511
  */
1925
1512
  assistantId: string | undefined;
@@ -1934,10 +1521,7 @@ export interface CreateAIGuardrailVersionRequest {
1934
1521
  */
1935
1522
  modifiedTime?: Date | undefined;
1936
1523
  /**
1937
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1938
- * request. If not provided, the Amazon Web Services
1939
- * SDK populates this field. For more information about idempotency, see
1940
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
1524
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
1941
1525
  * @public
1942
1526
  */
1943
1527
  clientToken?: string | undefined;
@@ -1962,14 +1546,12 @@ export interface CreateAIGuardrailVersionResponse {
1962
1546
  */
1963
1547
  export interface DeleteAIGuardrailRequest {
1964
1548
  /**
1965
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
1966
- * cannot contain the ARN.</p>
1549
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1967
1550
  * @public
1968
1551
  */
1969
1552
  assistantId: string | undefined;
1970
1553
  /**
1971
- * <p>The identifier of the Amazon Q in Connect AI Guardrail. Can be either the ID or the ARN.
1972
- * URLs cannot contain the ARN.</p>
1554
+ * <p>The identifier of the Amazon Q in Connect AI Guardrail. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1973
1555
  * @public
1974
1556
  */
1975
1557
  aiGuardrailId: string | undefined;
@@ -1984,8 +1566,7 @@ export interface DeleteAIGuardrailResponse {
1984
1566
  */
1985
1567
  export interface DeleteAIGuardrailVersionRequest {
1986
1568
  /**
1987
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
1988
- * cannot contain the ARN.</p>
1569
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1989
1570
  * @public
1990
1571
  */
1991
1572
  assistantId: string | undefined;
@@ -2010,8 +1591,7 @@ export interface DeleteAIGuardrailVersionResponse {
2010
1591
  */
2011
1592
  export interface GetAIGuardrailRequest {
2012
1593
  /**
2013
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2014
- * cannot contain the ARN.</p>
1594
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2015
1595
  * @public
2016
1596
  */
2017
1597
  assistantId: string | undefined;
@@ -2031,8 +1611,7 @@ export interface GetAIGuardrailResponse {
2031
1611
  */
2032
1612
  aiGuardrail?: AIGuardrailData | undefined;
2033
1613
  /**
2034
- * <p>The version number of the AI Guardrail version (returned if an AI Guardrail version was
2035
- * specified via use of a qualifier for the <code>aiGuardrailId</code> on the request). </p>
1614
+ * <p>The version number of the AI Guardrail version (returned if an AI Guardrail version was specified via use of a qualifier for the <code>aiGuardrailId</code> on the request). </p>
2036
1615
  * @public
2037
1616
  */
2038
1617
  versionNumber?: number | undefined;
@@ -2042,14 +1621,12 @@ export interface GetAIGuardrailResponse {
2042
1621
  */
2043
1622
  export interface ListAIGuardrailsRequest {
2044
1623
  /**
2045
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2046
- * cannot contain the ARN.</p>
1624
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2047
1625
  * @public
2048
1626
  */
2049
1627
  assistantId: string | undefined;
2050
1628
  /**
2051
- * <p>The token for the next set of results. Use the value returned in the previous response in
2052
- * the next request to retrieve the next set of results.</p>
1629
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2053
1630
  * @public
2054
1631
  */
2055
1632
  nextToken?: string | undefined;
@@ -2070,8 +1647,7 @@ export interface AIGuardrailSummary {
2070
1647
  */
2071
1648
  name: string | undefined;
2072
1649
  /**
2073
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2074
- * cannot contain the ARN.</p>
1650
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2075
1651
  * @public
2076
1652
  */
2077
1653
  assistantId: string | undefined;
@@ -2126,8 +1702,7 @@ export interface ListAIGuardrailsResponse {
2126
1702
  */
2127
1703
  aiGuardrailSummaries: AIGuardrailSummary[] | undefined;
2128
1704
  /**
2129
- * <p>The token for the next set of results. Use the value returned in the previous response in
2130
- * the next request to retrieve the next set of results.</p>
1705
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2131
1706
  * @public
2132
1707
  */
2133
1708
  nextToken?: string | undefined;
@@ -2137,20 +1712,17 @@ export interface ListAIGuardrailsResponse {
2137
1712
  */
2138
1713
  export interface ListAIGuardrailVersionsRequest {
2139
1714
  /**
2140
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2141
- * cannot contain the ARN.</p>
1715
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2142
1716
  * @public
2143
1717
  */
2144
1718
  assistantId: string | undefined;
2145
1719
  /**
2146
- * <p>The identifier of the Amazon Q in Connect AI Guardrail for which versions are to be
2147
- * listed.</p>
1720
+ * <p>The identifier of the Amazon Q in Connect AI Guardrail for which versions are to be listed.</p>
2148
1721
  * @public
2149
1722
  */
2150
1723
  aiGuardrailId: string | undefined;
2151
1724
  /**
2152
- * <p>The token for the next set of results. Use the value returned in the previous response in
2153
- * the next request to retrieve the next set of results.</p>
1725
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2154
1726
  * @public
2155
1727
  */
2156
1728
  nextToken?: string | undefined;
@@ -2186,8 +1758,7 @@ export interface ListAIGuardrailVersionsResponse {
2186
1758
  */
2187
1759
  aiGuardrailVersionSummaries: AIGuardrailVersionSummary[] | undefined;
2188
1760
  /**
2189
- * <p>The token for the next set of results. Use the value returned in the previous response in
2190
- * the next request to retrieve the next set of results.</p>
1761
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2191
1762
  * @public
2192
1763
  */
2193
1764
  nextToken?: string | undefined;
@@ -2197,16 +1768,12 @@ export interface ListAIGuardrailVersionsResponse {
2197
1768
  */
2198
1769
  export interface UpdateAIGuardrailRequest {
2199
1770
  /**
2200
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2201
- * request. If not provided, the Amazon Web Services
2202
- * SDK populates this field. For more information about idempotency, see
2203
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
1771
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
2204
1772
  * @public
2205
1773
  */
2206
1774
  clientToken?: string | undefined;
2207
1775
  /**
2208
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2209
- * cannot contain the ARN.</p>
1776
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2210
1777
  * @public
2211
1778
  */
2212
1779
  assistantId: string | undefined;
@@ -2286,8 +1853,7 @@ export declare const AIPromptAPIFormat: {
2286
1853
  */
2287
1854
  export type AIPromptAPIFormat = (typeof AIPromptAPIFormat)[keyof typeof AIPromptAPIFormat];
2288
1855
  /**
2289
- * <p>The configuration for a prompt template that supports full textual prompt configuration
2290
- * using a YAML prompt.</p>
1856
+ * <p>The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.</p>
2291
1857
  * @public
2292
1858
  */
2293
1859
  export interface TextFullAIPromptEditTemplateConfiguration {
@@ -2298,8 +1864,7 @@ export interface TextFullAIPromptEditTemplateConfiguration {
2298
1864
  text: string | undefined;
2299
1865
  }
2300
1866
  /**
2301
- * <p>A typed union that specifies the configuration for a prompt template based on its
2302
- * type.</p>
1867
+ * <p>A typed union that specifies the configuration for a prompt template based on its type.</p>
2303
1868
  * @public
2304
1869
  */
2305
1870
  export type AIPromptTemplateConfiguration = AIPromptTemplateConfiguration.TextFullAIPromptEditTemplateConfigurationMember | AIPromptTemplateConfiguration.$UnknownMember;
@@ -2308,8 +1873,7 @@ export type AIPromptTemplateConfiguration = AIPromptTemplateConfiguration.TextFu
2308
1873
  */
2309
1874
  export declare namespace AIPromptTemplateConfiguration {
2310
1875
  /**
2311
- * <p>The configuration for a prompt template that supports full textual prompt configuration
2312
- * using a YAML prompt.</p>
1876
+ * <p>The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.</p>
2313
1877
  * @public
2314
1878
  */
2315
1879
  interface TextFullAIPromptEditTemplateConfigurationMember {
@@ -2360,16 +1924,12 @@ export type AIPromptType = (typeof AIPromptType)[keyof typeof AIPromptType];
2360
1924
  */
2361
1925
  export interface CreateAIPromptRequest {
2362
1926
  /**
2363
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2364
- * request. If not provided, the Amazon Web Services
2365
- * SDK populates this field. For more information about idempotency, see
2366
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
1927
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
2367
1928
  * @public
2368
1929
  */
2369
1930
  clientToken?: string | undefined;
2370
1931
  /**
2371
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2372
- * cannot contain the ARN.</p>
1932
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2373
1933
  * @public
2374
1934
  */
2375
1935
  assistantId: string | undefined;
@@ -2404,13 +1964,7 @@ export interface CreateAIPromptRequest {
2404
1964
  */
2405
1965
  modelId: string | undefined;
2406
1966
  /**
2407
- * <p>The API Format of the AI Prompt.</p>
2408
- * <p>Recommended values: <code>MESSAGES | TEXT_COMPLETIONS</code>
2409
- * </p>
2410
- * <note>
2411
- * <p>The values <code>ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS</code>
2412
- * will be deprecated.</p>
2413
- * </note>
1967
+ * <p>The API Format of the AI Prompt.</p> <p>Recommended values: <code>MESSAGES | TEXT_COMPLETIONS</code> </p> <note> <p>The values <code>ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS</code> will be deprecated.</p> </note>
2414
1968
  * @public
2415
1969
  */
2416
1970
  apiFormat: AIPromptAPIFormat | undefined;
@@ -2431,8 +1985,7 @@ export interface CreateAIPromptRequest {
2431
1985
  */
2432
1986
  export interface AIPromptData {
2433
1987
  /**
2434
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2435
- * cannot contain the ARN.</p>
1988
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2436
1989
  * @public
2437
1990
  */
2438
1991
  assistantId: string | undefined;
@@ -2467,95 +2020,7 @@ export interface AIPromptData {
2467
2020
  */
2468
2021
  templateType: AIPromptTemplateType | undefined;
2469
2022
  /**
2470
- * <p>The identifier of the model used for this AI Prompt. The following model Ids are
2471
- * supported:</p>
2472
- * <ul>
2473
- * <li>
2474
- * <p>
2475
- * <code>anthropic.claude-3-haiku--v1:0</code>
2476
- * </p>
2477
- * </li>
2478
- * <li>
2479
- * <p>
2480
- * <code>apac.amazon.nova-lite-v1:0</code>
2481
- * </p>
2482
- * </li>
2483
- * <li>
2484
- * <p>
2485
- * <code>apac.amazon.nova-micro-v1:0</code>
2486
- * </p>
2487
- * </li>
2488
- * <li>
2489
- * <p>
2490
- * <code>apac.amazon.nova-pro-v1:0</code>
2491
- * </p>
2492
- * </li>
2493
- * <li>
2494
- * <p>
2495
- * <code>apac.anthropic.claude-3-5-sonnet--v2:0</code>
2496
- * </p>
2497
- * </li>
2498
- * <li>
2499
- * <p>
2500
- * <code>apac.anthropic.claude-3-haiku-20240307-v1:0</code>
2501
- * </p>
2502
- * </li>
2503
- * <li>
2504
- * <p>
2505
- * <code>eu.amazon.nova-lite-v1:0</code>
2506
- * </p>
2507
- * </li>
2508
- * <li>
2509
- * <p>
2510
- * <code>eu.amazon.nova-micro-v1:0</code>
2511
- * </p>
2512
- * </li>
2513
- * <li>
2514
- * <p>
2515
- * <code>eu.amazon.nova-pro-v1:0</code>
2516
- * </p>
2517
- * </li>
2518
- * <li>
2519
- * <p>
2520
- * <code>eu.anthropic.claude-3-7-sonnet-20250219-v1:0</code>
2521
- * </p>
2522
- * </li>
2523
- * <li>
2524
- * <p>
2525
- * <code>eu.anthropic.claude-3-haiku-20240307-v1:0</code>
2526
- * </p>
2527
- * </li>
2528
- * <li>
2529
- * <p>
2530
- * <code>us.amazon.nova-lite-v1:0</code>
2531
- * </p>
2532
- * </li>
2533
- * <li>
2534
- * <p>
2535
- * <code>us.amazon.nova-micro-v1:0</code>
2536
- * </p>
2537
- * </li>
2538
- * <li>
2539
- * <p>
2540
- * <code>us.amazon.nova-pro-v1:0</code>
2541
- * </p>
2542
- * </li>
2543
- * <li>
2544
- * <p>
2545
- * <code>us.anthropic.claude-3-5-haiku-20241022-v1:0</code>
2546
- * </p>
2547
- * </li>
2548
- * <li>
2549
- * <p>
2550
- * <code>us.anthropic.claude-3-7-sonnet-20250219-v1:0</code>
2551
- * </p>
2552
- * </li>
2553
- * <li>
2554
- * <p>
2555
- * <code>us.anthropic.claude-3-haiku-20240307-v1:0</code>
2556
- * </p>
2557
- * </li>
2558
- * </ul>
2023
+ * <p>The identifier of the model used for this AI Prompt. The following model Ids are supported:</p> <ul> <li> <p> <code>anthropic.claude-3-haiku--v1:0</code> </p> </li> <li> <p> <code>apac.amazon.nova-lite-v1:0</code> </p> </li> <li> <p> <code>apac.amazon.nova-micro-v1:0</code> </p> </li> <li> <p> <code>apac.amazon.nova-pro-v1:0</code> </p> </li> <li> <p> <code>apac.anthropic.claude-3-5-sonnet--v2:0</code> </p> </li> <li> <p> <code>apac.anthropic.claude-3-haiku-20240307-v1:0</code> </p> </li> <li> <p> <code>eu.amazon.nova-lite-v1:0</code> </p> </li> <li> <p> <code>eu.amazon.nova-micro-v1:0</code> </p> </li> <li> <p> <code>eu.amazon.nova-pro-v1:0</code> </p> </li> <li> <p> <code>eu.anthropic.claude-3-7-sonnet-20250219-v1:0</code> </p> </li> <li> <p> <code>eu.anthropic.claude-3-haiku-20240307-v1:0</code> </p> </li> <li> <p> <code>us.amazon.nova-lite-v1:0</code> </p> </li> <li> <p> <code>us.amazon.nova-micro-v1:0</code> </p> </li> <li> <p> <code>us.amazon.nova-pro-v1:0</code> </p> </li> <li> <p> <code>us.anthropic.claude-3-5-haiku-20241022-v1:0</code> </p> </li> <li> <p> <code>us.anthropic.claude-3-7-sonnet-20250219-v1:0</code> </p> </li> <li> <p> <code>us.anthropic.claude-3-haiku-20240307-v1:0</code> </p> </li> </ul>
2559
2024
  * @public
2560
2025
  */
2561
2026
  modelId: string | undefined;
@@ -2590,9 +2055,7 @@ export interface AIPromptData {
2590
2055
  */
2591
2056
  tags?: Record<string, string> | undefined;
2592
2057
  /**
2593
- * <p>The origin of the AI Prompt. <code>SYSTEM</code> for a default AI Prompt created by Q in
2594
- * Connect or <code>CUSTOMER</code> for an AI Prompt created by calling AI Prompt creation APIs.
2595
- * </p>
2058
+ * <p>The origin of the AI Prompt. <code>SYSTEM</code> for a default AI Prompt created by Q in Connect or <code>CUSTOMER</code> for an AI Prompt created by calling AI Prompt creation APIs. </p>
2596
2059
  * @public
2597
2060
  */
2598
2061
  origin?: Origin | undefined;
@@ -2617,8 +2080,7 @@ export interface CreateAIPromptResponse {
2617
2080
  */
2618
2081
  export interface CreateAIPromptVersionRequest {
2619
2082
  /**
2620
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2621
- * cannot contain the ARN.</p>
2083
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2622
2084
  * @public
2623
2085
  */
2624
2086
  assistantId: string | undefined;
@@ -2633,10 +2095,7 @@ export interface CreateAIPromptVersionRequest {
2633
2095
  */
2634
2096
  modifiedTime?: Date | undefined;
2635
2097
  /**
2636
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2637
- * request. If not provided, the Amazon Web Services
2638
- * SDK populates this field. For more information about idempotency, see
2639
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
2098
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
2640
2099
  * @public
2641
2100
  */
2642
2101
  clientToken?: string | undefined;
@@ -2661,14 +2120,12 @@ export interface CreateAIPromptVersionResponse {
2661
2120
  */
2662
2121
  export interface DeleteAIPromptRequest {
2663
2122
  /**
2664
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2665
- * cannot contain the ARN.</p>
2123
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2666
2124
  * @public
2667
2125
  */
2668
2126
  assistantId: string | undefined;
2669
2127
  /**
2670
- * <p>The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs
2671
- * cannot contain the ARN.</p>
2128
+ * <p>The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2672
2129
  * @public
2673
2130
  */
2674
2131
  aiPromptId: string | undefined;
@@ -2683,8 +2140,7 @@ export interface DeleteAIPromptResponse {
2683
2140
  */
2684
2141
  export interface DeleteAIPromptVersionRequest {
2685
2142
  /**
2686
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2687
- * cannot contain the ARN.</p>
2143
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2688
2144
  * @public
2689
2145
  */
2690
2146
  assistantId: string | undefined;
@@ -2709,8 +2165,7 @@ export interface DeleteAIPromptVersionResponse {
2709
2165
  */
2710
2166
  export interface GetAIPromptRequest {
2711
2167
  /**
2712
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2713
- * cannot contain the ARN.</p>
2168
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2714
2169
  * @public
2715
2170
  */
2716
2171
  assistantId: string | undefined;
@@ -2730,8 +2185,7 @@ export interface GetAIPromptResponse {
2730
2185
  */
2731
2186
  aiPrompt?: AIPromptData | undefined;
2732
2187
  /**
2733
- * <p>The version number of the AI Prompt version (returned if an AI Prompt version was
2734
- * specified via use of a qualifier for the <code>aiPromptId</code> on the request). </p>
2188
+ * <p>The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the <code>aiPromptId</code> on the request). </p>
2735
2189
  * @public
2736
2190
  */
2737
2191
  versionNumber?: number | undefined;
@@ -2741,14 +2195,12 @@ export interface GetAIPromptResponse {
2741
2195
  */
2742
2196
  export interface ListAIPromptsRequest {
2743
2197
  /**
2744
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2745
- * cannot contain the ARN.</p>
2198
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2746
2199
  * @public
2747
2200
  */
2748
2201
  assistantId: string | undefined;
2749
2202
  /**
2750
- * <p>The token for the next set of results. Use the value returned in the previous response in
2751
- * the next request to retrieve the next set of results.</p>
2203
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2752
2204
  * @public
2753
2205
  */
2754
2206
  nextToken?: string | undefined;
@@ -2758,9 +2210,7 @@ export interface ListAIPromptsRequest {
2758
2210
  */
2759
2211
  maxResults?: number | undefined;
2760
2212
  /**
2761
- * <p>The origin of the AI Prompts to be listed. <code>SYSTEM</code> for a default AI Agent
2762
- * created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent
2763
- * creation APIs. </p>
2213
+ * <p>The origin of the AI Prompts to be listed. <code>SYSTEM</code> for a default AI Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation APIs. </p>
2764
2214
  * @public
2765
2215
  */
2766
2216
  origin?: Origin | undefined;
@@ -2776,8 +2226,7 @@ export interface AIPromptSummary {
2776
2226
  */
2777
2227
  name: string | undefined;
2778
2228
  /**
2779
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2780
- * cannot contain the ARN.</p>
2229
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2781
2230
  * @public
2782
2231
  */
2783
2232
  assistantId: string | undefined;
@@ -2812,8 +2261,7 @@ export interface AIPromptSummary {
2812
2261
  */
2813
2262
  templateType: AIPromptTemplateType | undefined;
2814
2263
  /**
2815
- * <p>The identifier of the model used for this AI Prompt. Model Ids supported are:
2816
- * <code>anthropic.claude-3-haiku-20240307-v1:0</code>.</p>
2264
+ * <p>The identifier of the model used for this AI Prompt. Model Ids supported are: <code>anthropic.claude-3-haiku-20240307-v1:0</code>.</p>
2817
2265
  * @public
2818
2266
  */
2819
2267
  modelId: string | undefined;
@@ -2828,9 +2276,7 @@ export interface AIPromptSummary {
2828
2276
  */
2829
2277
  visibilityStatus: VisibilityStatus | undefined;
2830
2278
  /**
2831
- * <p>The origin of the AI Prompt. <code>SYSTEM</code> for a default AI Prompt created by Q in
2832
- * Connect or <code>CUSTOMER</code> for an AI Prompt created by calling AI Prompt creation APIs.
2833
- * </p>
2279
+ * <p>The origin of the AI Prompt. <code>SYSTEM</code> for a default AI Prompt created by Q in Connect or <code>CUSTOMER</code> for an AI Prompt created by calling AI Prompt creation APIs. </p>
2834
2280
  * @public
2835
2281
  */
2836
2282
  origin?: Origin | undefined;
@@ -2860,8 +2306,7 @@ export interface ListAIPromptsResponse {
2860
2306
  */
2861
2307
  aiPromptSummaries: AIPromptSummary[] | undefined;
2862
2308
  /**
2863
- * <p>The token for the next set of results. Use the value returned in the previous response in
2864
- * the next request to retrieve the next set of results.</p>
2309
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2865
2310
  * @public
2866
2311
  */
2867
2312
  nextToken?: string | undefined;
@@ -2871,20 +2316,17 @@ export interface ListAIPromptsResponse {
2871
2316
  */
2872
2317
  export interface ListAIPromptVersionsRequest {
2873
2318
  /**
2874
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2875
- * cannot contain the ARN.</p>
2319
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2876
2320
  * @public
2877
2321
  */
2878
2322
  assistantId: string | undefined;
2879
2323
  /**
2880
- * <p>The identifier of the Amazon Q in Connect AI prompt for which versions are to be
2881
- * listed.</p>
2324
+ * <p>The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.</p>
2882
2325
  * @public
2883
2326
  */
2884
2327
  aiPromptId: string | undefined;
2885
2328
  /**
2886
- * <p>The token for the next set of results. Use the value returned in the previous response in
2887
- * the next request to retrieve the next set of results.</p>
2329
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2888
2330
  * @public
2889
2331
  */
2890
2332
  nextToken?: string | undefined;
@@ -2894,9 +2336,7 @@ export interface ListAIPromptVersionsRequest {
2894
2336
  */
2895
2337
  maxResults?: number | undefined;
2896
2338
  /**
2897
- * <p>The origin of the AI Prompt versions to be listed. <code>SYSTEM</code> for a default AI
2898
- * Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI
2899
- * Agent creation APIs. </p>
2339
+ * <p>The origin of the AI Prompt versions to be listed. <code>SYSTEM</code> for a default AI Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation APIs. </p>
2900
2340
  * @public
2901
2341
  */
2902
2342
  origin?: Origin | undefined;
@@ -2927,8 +2367,7 @@ export interface ListAIPromptVersionsResponse {
2927
2367
  */
2928
2368
  aiPromptVersionSummaries: AIPromptVersionSummary[] | undefined;
2929
2369
  /**
2930
- * <p>The token for the next set of results. Use the value returned in the previous response in
2931
- * the next request to retrieve the next set of results.</p>
2370
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
2932
2371
  * @public
2933
2372
  */
2934
2373
  nextToken?: string | undefined;
@@ -2938,16 +2377,12 @@ export interface ListAIPromptVersionsResponse {
2938
2377
  */
2939
2378
  export interface UpdateAIPromptRequest {
2940
2379
  /**
2941
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2942
- * request. If not provided, the Amazon Web Services
2943
- * SDK populates this field. For more information about idempotency, see
2944
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
2380
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..</p>
2945
2381
  * @public
2946
2382
  */
2947
2383
  clientToken?: string | undefined;
2948
2384
  /**
2949
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
2950
- * cannot contain the ARN.</p>
2385
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2951
2386
  * @public
2952
2387
  */
2953
2388
  assistantId: string | undefined;
@@ -2983,8 +2418,7 @@ export interface UpdateAIPromptResponse {
2983
2418
  aiPrompt?: AIPromptData | undefined;
2984
2419
  }
2985
2420
  /**
2986
- * <p>Content association data for a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html">step-by-step
2987
- * guide</a>.</p>
2421
+ * <p>Content association data for a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html">step-by-step guide</a>.</p>
2988
2422
  * @public
2989
2423
  */
2990
2424
  export interface AmazonConnectGuideAssociationData {
@@ -3000,70 +2434,12 @@ export interface AmazonConnectGuideAssociationData {
3000
2434
  */
3001
2435
  export interface AppIntegrationsConfiguration {
3002
2436
  /**
3003
- * <p>The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.</p>
3004
- * <ul>
3005
- * <li>
3006
- * <p> For <a href="https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm"> Salesforce</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if
3007
- * objectFields is not provided, including at least <code>Id</code>,
3008
- * <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>,
3009
- * <code>PublishStatus</code>, and <code>IsDeleted</code> as source fields. </p>
3010
- * </li>
3011
- * <li>
3012
- * <p> For <a href="https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api"> ServiceNow</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if
3013
- * objectFields is not provided, including at least <code>number</code>,
3014
- * <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>,
3015
- * and <code>active</code> as source fields. </p>
3016
- * </li>
3017
- * <li>
3018
- * <p> For <a href="https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/">
3019
- * Zendesk</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if
3020
- * <code>objectFields</code> is not provided, including at least <code>id</code>,
3021
- * <code>title</code>, <code>updated_at</code>, and <code>draft</code> as source fields.
3022
- * </p>
3023
- * </li>
3024
- * <li>
3025
- * <p> For <a href="https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index">SharePoint</a>, your AppIntegrations DataIntegration must have a FileConfiguration,
3026
- * including only file extensions that are among <code>docx</code>, <code>pdf</code>,
3027
- * <code>html</code>, <code>htm</code>, and <code>txt</code>. </p>
3028
- * </li>
3029
- * <li>
3030
- * <p> For <a href="http://aws.amazon.com/s3/">Amazon S3</a>, the
3031
- * ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null.
3032
- * The <code>SourceURI</code> of your DataIntegration must use the following format:
3033
- * <code>s3://your_s3_bucket_name</code>.</p>
3034
- * <important>
3035
- * <p>The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services
3036
- * principal <code>app-integrations.amazonaws.com</code> to perform
3037
- * <code>s3:ListBucket</code>, <code>s3:GetObject</code>, and
3038
- * <code>s3:GetBucketLocation</code> against the bucket.</p>
3039
- * </important>
3040
- * </li>
3041
- * </ul>
2437
+ * <p>The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.</p> <ul> <li> <p> For <a href="https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm"> Salesforce</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least <code>Id</code>, <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>, <code>PublishStatus</code>, and <code>IsDeleted</code> as source fields. </p> </li> <li> <p> For <a href="https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api"> ServiceNow</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least <code>number</code>, <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>, and <code>active</code> as source fields. </p> </li> <li> <p> For <a href="https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/"> Zendesk</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if <code>objectFields</code> is not provided, including at least <code>id</code>, <code>title</code>, <code>updated_at</code>, and <code>draft</code> as source fields. </p> </li> <li> <p> For <a href="https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index">SharePoint</a>, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among <code>docx</code>, <code>pdf</code>, <code>html</code>, <code>htm</code>, and <code>txt</code>. </p> </li> <li> <p> For <a href="http://aws.amazon.com/s3/">Amazon S3</a>, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The <code>SourceURI</code> of your DataIntegration must use the following format: <code>s3://your_s3_bucket_name</code>.</p> <important> <p>The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal <code>app-integrations.amazonaws.com</code> to perform <code>s3:ListBucket</code>, <code>s3:GetObject</code>, and <code>s3:GetBucketLocation</code> against the bucket.</p> </important> </li> </ul>
3042
2438
  * @public
3043
2439
  */
3044
2440
  appIntegrationArn: string | undefined;
3045
2441
  /**
3046
- * <p>The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if
3047
- * ObjectConfiguration is included in the provided DataIntegration. </p>
3048
- * <ul>
3049
- * <li>
3050
- * <p> For <a href="https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm"> Salesforce</a>, you must include at least <code>Id</code>,
3051
- * <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>,
3052
- * <code>PublishStatus</code>, and <code>IsDeleted</code>. </p>
3053
- * </li>
3054
- * <li>
3055
- * <p>For <a href="https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api"> ServiceNow</a>, you must include at least <code>number</code>,
3056
- * <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>,
3057
- * and <code>active</code>. </p>
3058
- * </li>
3059
- * <li>
3060
- * <p>For <a href="https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/">
3061
- * Zendesk</a>, you must include at least <code>id</code>, <code>title</code>,
3062
- * <code>updated_at</code>, and <code>draft</code>. </p>
3063
- * </li>
3064
- * </ul>
3065
- * <p>Make sure to include additional fields. These fields are indexed and used to source
3066
- * recommendations. </p>
2442
+ * <p>The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration. </p> <ul> <li> <p> For <a href="https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm"> Salesforce</a>, you must include at least <code>Id</code>, <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>, <code>PublishStatus</code>, and <code>IsDeleted</code>. </p> </li> <li> <p>For <a href="https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api"> ServiceNow</a>, you must include at least <code>number</code>, <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>, and <code>active</code>. </p> </li> <li> <p>For <a href="https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/"> Zendesk</a>, you must include at least <code>id</code>, <code>title</code>, <code>updated_at</code>, and <code>draft</code>. </p> </li> </ul> <p>Make sure to include additional fields. These fields are indexed and used to source recommendations. </p>
3067
2443
  * @public
3068
2444
  */
3069
2445
  objectFields?: string[] | undefined;
@@ -3129,10 +2505,7 @@ export interface CreateAssistantAssociationRequest {
3129
2505
  */
3130
2506
  association: AssistantAssociationInputData | undefined;
3131
2507
  /**
3132
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
3133
- * request. If not provided, the Amazon Web Services
3134
- * SDK populates this field. For more information about idempotency, see
3135
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
2508
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
3136
2509
  * @public
3137
2510
  */
3138
2511
  clientToken?: string | undefined;
@@ -3289,8 +2662,7 @@ export interface GetAssistantAssociationResponse {
3289
2662
  */
3290
2663
  export interface ListAssistantAssociationsRequest {
3291
2664
  /**
3292
- * <p>The token for the next set of results. Use the value returned in the previous
3293
- * response in the next request to retrieve the next set of results.</p>
2665
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
3294
2666
  * @public
3295
2667
  */
3296
2668
  nextToken?: string | undefined;
@@ -3367,9 +2739,7 @@ export interface ListAssistantAssociationsResponse {
3367
2739
  */
3368
2740
  export interface ServerSideEncryptionConfiguration {
3369
2741
  /**
3370
- * <p>The customer managed key used for encryption. For more information about setting up a
3371
- * customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.
3372
- * For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.</p>
2742
+ * <p>The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>. For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.</p>
3373
2743
  * @public
3374
2744
  */
3375
2745
  kmsKeyId?: string | undefined;
@@ -3390,10 +2760,7 @@ export type AssistantType = (typeof AssistantType)[keyof typeof AssistantType];
3390
2760
  */
3391
2761
  export interface CreateAssistantRequest {
3392
2762
  /**
3393
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
3394
- * request. If not provided, the Amazon Web Services
3395
- * SDK populates this field. For more information about idempotency, see
3396
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
2763
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
3397
2764
  * @public
3398
2765
  */
3399
2766
  clientToken?: string | undefined;
@@ -3418,16 +2785,7 @@ export interface CreateAssistantRequest {
3418
2785
  */
3419
2786
  tags?: Record<string, string> | undefined;
3420
2787
  /**
3421
- * <p>The configuration information for the customer managed key used for encryption. </p>
3422
- * <p>The customer managed key must have a policy that allows <code>kms:CreateGrant</code>,
3423
- * <code> kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
3424
- * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
3425
- * key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow
3426
- * <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
3427
- * <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
3428
- * principal. </p>
3429
- * <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
3430
- * your instance</a>.</p>
2788
+ * <p>The configuration information for the customer managed key used for encryption. </p> <p>The customer managed key must have a policy that allows <code>kms:CreateGrant</code>, <code> kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service principal. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>
3431
2789
  * @public
3432
2790
  */
3433
2791
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
@@ -3523,16 +2881,7 @@ export interface AssistantData {
3523
2881
  */
3524
2882
  tags?: Record<string, string> | undefined;
3525
2883
  /**
3526
- * <p>The configuration information for the customer managed key used for encryption. </p>
3527
- * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
3528
- * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
3529
- * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
3530
- * key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow
3531
- * <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
3532
- * <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
3533
- * principal. </p>
3534
- * <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
3535
- * your instance</a>.</p>
2884
+ * <p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service principal. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>
3536
2885
  * @public
3537
2886
  */
3538
2887
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
@@ -3547,8 +2896,7 @@ export interface AssistantData {
3547
2896
  */
3548
2897
  capabilityConfiguration?: AssistantCapabilityConfiguration | undefined;
3549
2898
  /**
3550
- * <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is
3551
- * set on the Amazon Q in Connect Assistant.</p>
2899
+ * <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.</p>
3552
2900
  * @public
3553
2901
  */
3554
2902
  aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
@@ -3618,16 +2966,12 @@ export interface GetRecommendationsRequest {
3618
2966
  */
3619
2967
  maxResults?: number | undefined;
3620
2968
  /**
3621
- * <p>The duration (in seconds) for which the call waits for a recommendation to be made
3622
- * available before returning. If a recommendation is available, the call returns sooner than
3623
- * <code>WaitTimeSeconds</code>. If no messages are available and the wait time expires, the
3624
- * call returns successfully with an empty list.</p>
2969
+ * <p>The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than <code>WaitTimeSeconds</code>. If no messages are available and the wait time expires, the call returns successfully with an empty list.</p>
3625
2970
  * @public
3626
2971
  */
3627
2972
  waitTimeSeconds?: number | undefined;
3628
2973
  /**
3629
- * <p>The token for the next set of chunks. Use the value returned in the previous response in
3630
- * the next request to retrieve the next set of chunks.</p>
2974
+ * <p>The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.</p>
3631
2975
  * @public
3632
2976
  */
3633
2977
  nextChunkToken?: string | undefined;
@@ -3662,8 +3006,7 @@ export interface RankingData {
3662
3006
  relevanceLevel?: RelevanceLevel | undefined;
3663
3007
  }
3664
3008
  /**
3665
- * <p>Offset specification to describe highlighting of document excerpts for rendering search
3666
- * results and recommendations.</p>
3009
+ * <p>Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.</p>
3667
3010
  * @public
3668
3011
  */
3669
3012
  export interface Highlight {
@@ -3743,8 +3086,7 @@ export interface IntentDetectedDataDetails {
3743
3086
  intentId: string | undefined;
3744
3087
  }
3745
3088
  /**
3746
- * <p>Contains information about where the text with a citation begins and ends in the generated
3747
- * output.</p>
3089
+ * <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
3748
3090
  * @public
3749
3091
  */
3750
3092
  export interface CitationSpan {
@@ -3796,8 +3138,7 @@ export interface SourceContentDataDetails {
3796
3138
  */
3797
3139
  rankingData: RankingData | undefined;
3798
3140
  /**
3799
- * <p>Contains information about where the text with a citation begins and ends in the generated
3800
- * output.</p>
3141
+ * <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
3801
3142
  * @public
3802
3143
  */
3803
3144
  citationSpan?: CitationSpan | undefined;
@@ -4014,9 +3355,7 @@ export declare const RecommendationTriggerType: {
4014
3355
  */
4015
3356
  export type RecommendationTriggerType = (typeof RecommendationTriggerType)[keyof typeof RecommendationTriggerType];
4016
3357
  /**
4017
- * <p>A recommendation trigger provides context on the event that produced the referenced
4018
- * recommendations. Recommendations are only referenced in <code>recommendationIds</code> by a
4019
- * single RecommendationTrigger.</p>
3358
+ * <p>A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in <code>recommendationIds</code> by a single RecommendationTrigger.</p>
4020
3359
  * @public
4021
3360
  */
4022
3361
  export interface RecommendationTrigger {
@@ -4031,17 +3370,7 @@ export interface RecommendationTrigger {
4031
3370
  */
4032
3371
  type: RecommendationTriggerType | undefined;
4033
3372
  /**
4034
- * <p>The source of the recommendation trigger.</p>
4035
- * <ul>
4036
- * <li>
4037
- * <p>ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens
4038
- * issue.</p>
4039
- * </li>
4040
- * <li>
4041
- * <p>RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens
4042
- * rule.</p>
4043
- * </li>
4044
- * </ul>
3373
+ * <p>The source of the recommendation trigger.</p> <ul> <li> <p>ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.</p> </li> <li> <p>RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.</p> </li> </ul>
4045
3374
  * @public
4046
3375
  */
4047
3376
  source: RecommendationSourceType | undefined;
@@ -4061,8 +3390,7 @@ export interface RecommendationTrigger {
4061
3390
  */
4062
3391
  export interface ListAssistantsRequest {
4063
3392
  /**
4064
- * <p>The token for the next set of results. Use the value returned in the previous
4065
- * response in the next request to retrieve the next set of results.</p>
3393
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
4066
3394
  * @public
4067
3395
  */
4068
3396
  nextToken?: string | undefined;
@@ -4113,16 +3441,7 @@ export interface AssistantSummary {
4113
3441
  */
4114
3442
  tags?: Record<string, string> | undefined;
4115
3443
  /**
4116
- * <p>The configuration information for the customer managed key used for encryption. </p>
4117
- * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
4118
- * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
4119
- * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
4120
- * key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow
4121
- * <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
4122
- * <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
4123
- * principal. </p>
4124
- * <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
4125
- * your instance</a>.</p>
3444
+ * <p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service principal. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>
4126
3445
  * @public
4127
3446
  */
4128
3447
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
@@ -4137,8 +3456,7 @@ export interface AssistantSummary {
4137
3456
  */
4138
3457
  capabilityConfiguration?: AssistantCapabilityConfiguration | undefined;
4139
3458
  /**
4140
- * <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is
4141
- * set on the Amazon Q in Connect Assistant.</p>
3459
+ * <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.</p>
4142
3460
  * @public
4143
3461
  */
4144
3462
  aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
@@ -4481,8 +3799,7 @@ export interface QueryAssistantRequest {
4481
3799
  */
4482
3800
  queryText?: string | undefined;
4483
3801
  /**
4484
- * <p>The token for the next set of results. Use the value returned in the previous
4485
- * response in the next request to retrieve the next set of results.</p>
3802
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
4486
3803
  * @public
4487
3804
  */
4488
3805
  nextToken?: string | undefined;
@@ -4492,8 +3809,7 @@ export interface QueryAssistantRequest {
4492
3809
  */
4493
3810
  maxResults?: number | undefined;
4494
3811
  /**
4495
- * <p>The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot
4496
- * contain the ARN.</p>
3812
+ * <p>The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
4497
3813
  * @public
4498
3814
  */
4499
3815
  sessionId?: string | undefined;
@@ -4508,9 +3824,7 @@ export interface QueryAssistantRequest {
4508
3824
  */
4509
3825
  queryInputData?: QueryInputData | undefined;
4510
3826
  /**
4511
- * <p>The search type to be used against the Knowledge Base for this request. The values can be
4512
- * <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector
4513
- * embeddings and raw text.</p>
3827
+ * <p>The search type to be used against the Knowledge Base for this request. The values can be <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector embeddings and raw text.</p>
4514
3828
  * @public
4515
3829
  */
4516
3830
  overrideKnowledgeBaseSearchType?: KnowledgeBaseSearchType | undefined;
@@ -4533,9 +3847,7 @@ export declare const QueryResultType: {
4533
3847
  */
4534
3848
  export type QueryResultType = (typeof QueryResultType)[keyof typeof QueryResultType];
4535
3849
  /**
4536
- * <p>The request reached the service more than 15 minutes after the date stamp on the request
4537
- * or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or
4538
- * the date stamp on the request is more than 15 minutes in the future.</p>
3850
+ * <p>The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.</p>
4539
3851
  * @public
4540
3852
  */
4541
3853
  export declare class RequestTimeoutException extends __BaseException {
@@ -4552,14 +3864,12 @@ export declare class RequestTimeoutException extends __BaseException {
4552
3864
  */
4553
3865
  export interface RemoveAssistantAIAgentRequest {
4554
3866
  /**
4555
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
4556
- * cannot contain the ARN.</p>
3867
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
4557
3868
  * @public
4558
3869
  */
4559
3870
  assistantId: string | undefined;
4560
3871
  /**
4561
- * <p>The type of the AI Agent being removed for use by default from the Amazon Q in Connect
4562
- * Assistant.</p>
3872
+ * <p>The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant.</p>
4563
3873
  * @public
4564
3874
  */
4565
3875
  aiAgentType: AIAgentType | undefined;
@@ -4628,8 +3938,7 @@ export interface SearchExpression {
4628
3938
  */
4629
3939
  export interface SearchSessionsRequest {
4630
3940
  /**
4631
- * <p>The token for the next set of results. Use the value returned in the previous
4632
- * response in the next request to retrieve the next set of results.</p>
3941
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
4633
3942
  * @public
4634
3943
  */
4635
3944
  nextToken?: string | undefined;
@@ -4695,10 +4004,7 @@ export interface SearchSessionsResponse {
4695
4004
  */
4696
4005
  export interface CreateSessionRequest {
4697
4006
  /**
4698
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
4699
- * request. If not provided, the Amazon Web Services
4700
- * SDK populates this field. For more information about idempotency, see
4701
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
4007
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
4702
4008
  * @public
4703
4009
  */
4704
4010
  clientToken?: string | undefined;
@@ -4728,8 +4034,7 @@ export interface CreateSessionRequest {
4728
4034
  */
4729
4035
  tagFilter?: TagFilter | undefined;
4730
4036
  /**
4731
- * <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that
4732
- * should be used by Amazon Q in Connect for this Session.</p>
4037
+ * <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.</p>
4733
4038
  * @public
4734
4039
  */
4735
4040
  aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
@@ -4786,14 +4091,12 @@ export interface SessionData {
4786
4091
  */
4787
4092
  tagFilter?: TagFilter | undefined;
4788
4093
  /**
4789
- * <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that
4790
- * should be used by Amazon Q in Connect for this Session.</p>
4094
+ * <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.</p>
4791
4095
  * @public
4792
4096
  */
4793
4097
  aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
4794
4098
  /**
4795
- * <p>The origin of the Session to be listed. <code>SYSTEM</code> for a default Session created
4796
- * by Amazon Q in Connect or <code>CUSTOMER</code> for a Session created by calling <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_CreateSession.html">CreateSession</a> API.</p>
4099
+ * <p>The origin of the Session to be listed. <code>SYSTEM</code> for a default Session created by Amazon Q in Connect or <code>CUSTOMER</code> for a Session created by calling <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_CreateSession.html">CreateSession</a> API.</p>
4797
4100
  * @public
4798
4101
  */
4799
4102
  origin?: Origin | undefined;
@@ -4823,8 +4126,7 @@ export interface GetNextMessageRequest {
4823
4126
  */
4824
4127
  sessionId: string | undefined;
4825
4128
  /**
4826
- * <p>The token for the next message. Use the value returned in the SendMessage or previous
4827
- * response in the next request to retrieve the next message.</p>
4129
+ * <p>The token for the next message. Use the value returned in the SendMessage or previous response in the next request to retrieve the next message.</p>
4828
4130
  * @public
4829
4131
  */
4830
4132
  nextMessageToken: string | undefined;
@@ -5083,8 +4385,7 @@ export interface ListMessagesRequest {
5083
4385
  */
5084
4386
  sessionId: string | undefined;
5085
4387
  /**
5086
- * <p>The token for the next set of results. Use the value returned in the previous response in
5087
- * the next request to retrieve the next set of results.</p>
4388
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
5088
4389
  * @public
5089
4390
  */
5090
4391
  nextToken?: string | undefined;
@@ -5104,15 +4405,13 @@ export interface ListMessagesResponse {
5104
4405
  */
5105
4406
  messages: MessageOutput[] | undefined;
5106
4407
  /**
5107
- * <p>The token for the next set of results. Use the value returned in the previous response in
5108
- * the next request to retrieve the next set of results.</p>
4408
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
5109
4409
  * @public
5110
4410
  */
5111
4411
  nextToken?: string | undefined;
5112
4412
  }
5113
4413
  /**
5114
- * <p>The configuration for a <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html">SendMessage</a>
5115
- * request.</p>
4414
+ * <p>The configuration for a <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html">SendMessage</a> request.</p>
5116
4415
  * @public
5117
4416
  */
5118
4417
  export interface MessageConfiguration {
@@ -5123,8 +4422,7 @@ export interface MessageConfiguration {
5123
4422
  generateFillerMessage?: boolean | undefined;
5124
4423
  }
5125
4424
  /**
5126
- * <p>The conversation history data to included in conversation context data before the Amazon Q
5127
- * in Connect session.</p>
4425
+ * <p>The conversation history data to included in conversation context data before the Amazon Q in Connect session.</p>
5128
4426
  * @public
5129
4427
  */
5130
4428
  export interface SelfServiceConversationHistory {
@@ -5196,15 +4494,12 @@ export interface SendMessageRequest {
5196
4494
  */
5197
4495
  conversationContext?: ConversationContext | undefined;
5198
4496
  /**
5199
- * <p>The configuration of the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html">SendMessage</a>
5200
- * request.</p>
4497
+ * <p>The configuration of the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html">SendMessage</a> request.</p>
5201
4498
  * @public
5202
4499
  */
5203
4500
  configuration?: MessageConfiguration | undefined;
5204
4501
  /**
5205
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
5206
- * request. If not provided, the AWS SDK populates this field.For more information about
5207
- * idempotency, see Making retries safe with idempotent APIs.</p>
4502
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field.For more information about idempotency, see Making retries safe with idempotent APIs.</p>
5208
4503
  * @public
5209
4504
  */
5210
4505
  clientToken?: string | undefined;
@@ -5219,8 +4514,7 @@ export interface SendMessageResponse {
5219
4514
  */
5220
4515
  requestMessageId: string | undefined;
5221
4516
  /**
5222
- * <p>The configuration of the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html">SendMessage</a>
5223
- * request.</p>
4517
+ * <p>The configuration of the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html">SendMessage</a> request.</p>
5224
4518
  * @public
5225
4519
  */
5226
4520
  configuration?: MessageConfiguration | undefined;
@@ -5255,8 +4549,7 @@ export interface UpdateSessionRequest {
5255
4549
  */
5256
4550
  tagFilter?: TagFilter | undefined;
5257
4551
  /**
5258
- * <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that
5259
- * should be used by Amazon Q in Connect for this Session.</p>
4552
+ * <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.</p>
5260
4553
  * @public
5261
4554
  */
5262
4555
  aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
@@ -5287,20 +4580,17 @@ export type SessionDataNamespace = (typeof SessionDataNamespace)[keyof typeof Se
5287
4580
  */
5288
4581
  export interface UpdateSessionDataRequest {
5289
4582
  /**
5290
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
5291
- * cannot contain the ARN.</p>
4583
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
5292
4584
  * @public
5293
4585
  */
5294
4586
  assistantId: string | undefined;
5295
4587
  /**
5296
- * <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the
5297
- * ARN.</p>
4588
+ * <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
5298
4589
  * @public
5299
4590
  */
5300
4591
  sessionId: string | undefined;
5301
4592
  /**
5302
- * <p>The namespace into which the session data is stored. Supported namespaces are:
5303
- * Custom</p>
4593
+ * <p>The namespace into which the session data is stored. Supported namespaces are: Custom</p>
5304
4594
  * @public
5305
4595
  */
5306
4596
  namespace?: SessionDataNamespace | undefined;
@@ -5325,8 +4615,7 @@ export interface UpdateSessionDataResponse {
5325
4615
  */
5326
4616
  sessionId: string | undefined;
5327
4617
  /**
5328
- * <p>The namespace into which the session data is stored. Supported namespaces are:
5329
- * Custom</p>
4618
+ * <p>The namespace into which the session data is stored. Supported namespaces are: Custom</p>
5330
4619
  * @public
5331
4620
  */
5332
4621
  namespace: SessionDataNamespace | undefined;
@@ -5341,20 +4630,17 @@ export interface UpdateSessionDataResponse {
5341
4630
  */
5342
4631
  export interface UpdateAssistantAIAgentRequest {
5343
4632
  /**
5344
- * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
5345
- * cannot contain the ARN.</p>
4633
+ * <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
5346
4634
  * @public
5347
4635
  */
5348
4636
  assistantId: string | undefined;
5349
4637
  /**
5350
- * <p>The type of the AI Agent being updated for use by default on the Amazon Q in Connect
5351
- * Assistant.</p>
4638
+ * <p>The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.</p>
5352
4639
  * @public
5353
4640
  */
5354
4641
  aiAgentType: AIAgentType | undefined;
5355
4642
  /**
5356
- * <p>The configuration of the AI Agent being updated for use by default on the Amazon Q in
5357
- * Connect Assistant.</p>
4643
+ * <p>The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.</p>
5358
4644
  * @public
5359
4645
  */
5360
4646
  configuration: AIAgentConfigurationData | undefined;
@@ -5423,8 +4709,7 @@ export declare const ChunkingStrategy: {
5423
4709
  */
5424
4710
  export type ChunkingStrategy = (typeof ChunkingStrategy)[keyof typeof ChunkingStrategy];
5425
4711
  /**
5426
- * <p>Configurations for when you choose fixed-size chunking. If you set the
5427
- * <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
4712
+ * <p>Configurations for when you choose fixed-size chunking. If you set the <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
5428
4713
  * @public
5429
4714
  */
5430
4715
  export interface FixedSizeChunkingConfiguration {
@@ -5451,9 +4736,7 @@ export interface HierarchicalChunkingLevelConfiguration {
5451
4736
  maxTokens: number | undefined;
5452
4737
  }
5453
4738
  /**
5454
- * <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking
5455
- * splits documents into layers of chunks where the first layer contains large chunks, and the
5456
- * second layer contains smaller chunks derived from the first layer.</p>
4739
+ * <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.</p>
5457
4740
  * @public
5458
4741
  */
5459
4742
  export interface HierarchicalChunkingConfiguration {
@@ -5469,9 +4752,7 @@ export interface HierarchicalChunkingConfiguration {
5469
4752
  overlapTokens: number | undefined;
5470
4753
  }
5471
4754
  /**
5472
- * <p>Settings for semantic document chunking for a data source. Semantic chunking splits a
5473
- * document into smaller documents based on groups of similar content derived from the text with
5474
- * natural language processing.</p>
4755
+ * <p>Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.</p>
5475
4756
  * @public
5476
4757
  */
5477
4758
  export interface SemanticChunkingConfiguration {
@@ -5492,38 +4773,27 @@ export interface SemanticChunkingConfiguration {
5492
4773
  breakpointPercentileThreshold: number | undefined;
5493
4774
  }
5494
4775
  /**
5495
- * <p>Details about how to chunk the documents in the data source. A chunk refers to an excerpt
5496
- * from a data source that is returned when the knowledge base that it belongs to is
5497
- * queried.</p>
4776
+ * <p>Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.</p>
5498
4777
  * @public
5499
4778
  */
5500
4779
  export interface ChunkingConfiguration {
5501
4780
  /**
5502
- * <p>Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a
5503
- * data source that is returned when the knowledge base that it belongs to is queried. You have
5504
- * the following options for chunking your data. If you opt for <code>NONE</code>, then you may
5505
- * want to pre-process your files by splitting them up such that each file corresponds to a
5506
- * chunk.</p>
4781
+ * <p>Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for <code>NONE</code>, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.</p>
5507
4782
  * @public
5508
4783
  */
5509
4784
  chunkingStrategy: ChunkingStrategy | undefined;
5510
4785
  /**
5511
- * <p>Configurations for when you choose fixed-size chunking. If you set the
5512
- * <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
4786
+ * <p>Configurations for when you choose fixed-size chunking. If you set the <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
5513
4787
  * @public
5514
4788
  */
5515
4789
  fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration | undefined;
5516
4790
  /**
5517
- * <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking
5518
- * splits documents into layers of chunks where the first layer contains large chunks, and the
5519
- * second layer contains smaller chunks derived from the first layer.</p>
4791
+ * <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.</p>
5520
4792
  * @public
5521
4793
  */
5522
4794
  hierarchicalChunkingConfiguration?: HierarchicalChunkingConfiguration | undefined;
5523
4795
  /**
5524
- * <p>Settings for semantic document chunking for a data source. Semantic chunking splits a
5525
- * document into smaller documents based on groups of similar content derived from the text with
5526
- * natural language processing.</p>
4796
+ * <p>Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.</p>
5527
4797
  * @public
5528
4798
  */
5529
4799
  semanticChunkingConfiguration?: SemanticChunkingConfiguration | undefined;
@@ -5615,10 +4885,7 @@ export type ContentAssociationType = (typeof ContentAssociationType)[keyof typeo
5615
4885
  */
5616
4886
  export interface CreateContentAssociationRequest {
5617
4887
  /**
5618
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
5619
- * request. If not provided, the Amazon Web Services
5620
- * SDK populates this field. For more information about idempotency, see
5621
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
4888
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
5622
4889
  * @public
5623
4890
  */
5624
4891
  clientToken?: string | undefined;
@@ -5769,8 +5036,7 @@ export interface GetContentAssociationResponse {
5769
5036
  */
5770
5037
  export interface ListContentAssociationsRequest {
5771
5038
  /**
5772
- * <p>The token for the next set of results. Use the value returned in the previous
5773
- * response in the next request to retrieve the next set of results.</p>
5039
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
5774
5040
  * @public
5775
5041
  */
5776
5042
  nextToken?: string | undefined;
@@ -5866,10 +5132,7 @@ export interface CreateContentRequest {
5866
5132
  */
5867
5133
  knowledgeBaseId: string | undefined;
5868
5134
  /**
5869
- * <p>The name of the content. Each piece of content in a knowledge base must have a unique
5870
- * name. You can retrieve a piece of content using only its knowledge base and its name with the
5871
- * <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html">SearchContent</a>
5872
- * API.</p>
5135
+ * <p>The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html">SearchContent</a> API.</p>
5873
5136
  * @public
5874
5137
  */
5875
5138
  name: string | undefined;
@@ -5879,14 +5142,12 @@ export interface CreateContentRequest {
5879
5142
  */
5880
5143
  title?: string | undefined;
5881
5144
  /**
5882
- * <p>The URI you want to use for the article. If the knowledge base has a templateUri, setting
5883
- * this argument overrides it for this piece of content.</p>
5145
+ * <p>The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.</p>
5884
5146
  * @public
5885
5147
  */
5886
5148
  overrideLinkOutUri?: string | undefined;
5887
5149
  /**
5888
- * <p>A key/value map to store attributes without affecting tagging or recommendations.
5889
- * For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
5150
+ * <p>A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
5890
5151
  * @public
5891
5152
  */
5892
5153
  metadata?: Record<string, string> | undefined;
@@ -5896,10 +5157,7 @@ export interface CreateContentRequest {
5896
5157
  */
5897
5158
  uploadId: string | undefined;
5898
5159
  /**
5899
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
5900
- * request. If not provided, the Amazon Web Services
5901
- * SDK populates this field. For more information about idempotency, see
5902
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
5160
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
5903
5161
  * @public
5904
5162
  */
5905
5163
  clientToken?: string | undefined;
@@ -5977,8 +5235,7 @@ export interface ContentData {
5977
5235
  */
5978
5236
  status: ContentStatus | undefined;
5979
5237
  /**
5980
- * <p>A key/value map to store attributes without affecting tagging or recommendations.
5981
- * For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
5238
+ * <p>A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
5982
5239
  * @public
5983
5240
  */
5984
5241
  metadata: Record<string, string> | undefined;
@@ -6124,8 +5381,7 @@ export interface ContentSummary {
6124
5381
  */
6125
5382
  status: ContentStatus | undefined;
6126
5383
  /**
6127
- * <p>A key/value map to store attributes without affecting tagging or recommendations.
6128
- * For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
5384
+ * <p>A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
6129
5385
  * @public
6130
5386
  */
6131
5387
  metadata: Record<string, string> | undefined;
@@ -6150,8 +5406,7 @@ export interface GetContentSummaryResponse {
6150
5406
  */
6151
5407
  export interface ListContentsRequest {
6152
5408
  /**
6153
- * <p>The token for the next set of results. Use the value returned in the previous
6154
- * response in the next request to retrieve the next set of results.</p>
5409
+ * <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
6155
5410
  * @public
6156
5411
  */
6157
5412
  nextToken?: string | undefined;
@@ -6182,8 +5437,7 @@ export interface ListContentsResponse {
6182
5437
  nextToken?: string | undefined;
6183
5438
  }
6184
5439
  /**
6185
- * <p>The provided <code>revisionId</code> does not match, indicating the content has been
6186
- * modified since it was last read.</p>
5440
+ * <p>The provided <code>revisionId</code> does not match, indicating the content has been modified since it was last read.</p>
6187
5441
  * @public
6188
5442
  */
6189
5443
  export declare class PreconditionFailedException extends __BaseException {
@@ -6209,11 +5463,7 @@ export interface UpdateContentRequest {
6209
5463
  */
6210
5464
  contentId: string | undefined;
6211
5465
  /**
6212
- * <p>The <code>revisionId</code> of the content resource to update, taken from an earlier call
6213
- * to <code>GetContent</code>, <code>GetContentSummary</code>, <code>SearchContent</code>, or
6214
- * <code>ListContents</code>. If included, this argument acts as an optimistic lock to ensure
6215
- * content was not modified since it was last read. If it has been modified, this API throws a
6216
- * <code>PreconditionFailedException</code>.</p>
5466
+ * <p>The <code>revisionId</code> of the content resource to update, taken from an earlier call to <code>GetContent</code>, <code>GetContentSummary</code>, <code>SearchContent</code>, or <code>ListContents</code>. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a <code>PreconditionFailedException</code>.</p>
6217
5467
  * @public
6218
5468
  */
6219
5469
  revisionId?: string | undefined;
@@ -6223,9 +5473,7 @@ export interface UpdateContentRequest {
6223
5473
  */
6224
5474
  title?: string | undefined;
6225
5475
  /**
6226
- * <p>The URI for the article. If the knowledge base has a templateUri, setting this argument
6227
- * overrides it for this piece of content. To remove an existing <code>overrideLinkOurUri</code>,
6228
- * exclude this argument and set <code>removeOverrideLinkOutUri</code> to true.</p>
5476
+ * <p>The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing <code>overrideLinkOurUri</code>, exclude this argument and set <code>removeOverrideLinkOutUri</code> to true.</p>
6229
5477
  * @public
6230
5478
  */
6231
5479
  overrideLinkOutUri?: string | undefined;
@@ -6235,9 +5483,7 @@ export interface UpdateContentRequest {
6235
5483
  */
6236
5484
  removeOverrideLinkOutUri?: boolean | undefined;
6237
5485
  /**
6238
- * <p>A key/value map to store attributes without affecting tagging or recommendations. For
6239
- * example, when synchronizing data between an external system and Amazon Q in Connect, you can store an
6240
- * external version identifier as metadata to utilize for determining drift.</p>
5486
+ * <p>A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
6241
5487
  * @public
6242
5488
  */
6243
5489
  metadata?: Record<string, string> | undefined;
@@ -6289,27 +5535,7 @@ export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof Knowledg
6289
5535
  */
6290
5536
  export interface RenderingConfiguration {
6291
5537
  /**
6292
- * <p>A URI template containing exactly one variable in <code>$\{variableName\} </code>format.
6293
- * This can only be set for <code>EXTERNAL</code> knowledge bases. For Salesforce, ServiceNow,
6294
- * and Zendesk, the variable must be one of the following:</p>
6295
- * <ul>
6296
- * <li>
6297
- * <p>Salesforce: <code>Id</code>, <code>ArticleNumber</code>, <code>VersionNumber</code>,
6298
- * <code>Title</code>, <code>PublishStatus</code>, or <code>IsDeleted</code>
6299
- * </p>
6300
- * </li>
6301
- * <li>
6302
- * <p>ServiceNow: <code>number</code>, <code>short_description</code>,
6303
- * <code>sys_mod_count</code>, <code>workflow_state</code>, or <code>active</code>
6304
- * </p>
6305
- * </li>
6306
- * <li>
6307
- * <p>Zendesk: <code>id</code>, <code>title</code>, <code>updated_at</code>, or
6308
- * <code>draft</code>
6309
- * </p>
6310
- * </li>
6311
- * </ul>
6312
- * <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
5538
+ * <p>A URI template containing exactly one variable in <code>$\{variableName\} </code>format. This can only be set for <code>EXTERNAL</code> knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:</p> <ul> <li> <p>Salesforce: <code>Id</code>, <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>, <code>PublishStatus</code>, or <code>IsDeleted</code> </p> </li> <li> <p>ServiceNow: <code>number</code>, <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>, or <code>active</code> </p> </li> <li> <p>Zendesk: <code>id</code>, <code>title</code>, <code>updated_at</code>, or <code>draft</code> </p> </li> </ul> <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
6313
5539
  * @public
6314
5540
  */
6315
5541
  templateUri?: string | undefined;
@@ -6349,8 +5575,7 @@ export interface SeedUrl {
6349
5575
  url?: string | undefined;
6350
5576
  }
6351
5577
  /**
6352
- * <p>The configuration of the URL/URLs for the web content that you want to crawl. You should
6353
- * be authorized to crawl the URLs.</p>
5578
+ * <p>The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.</p>
6354
5579
  * @public
6355
5580
  */
6356
5581
  export interface UrlConfiguration {
@@ -6366,8 +5591,7 @@ export interface UrlConfiguration {
6366
5591
  */
6367
5592
  export interface WebCrawlerConfiguration {
6368
5593
  /**
6369
- * <p>The configuration of the URL/URLs for the web content that you want to crawl. You should
6370
- * be authorized to crawl the URLs.</p>
5594
+ * <p>The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.</p>
6371
5595
  * @public
6372
5596
  */
6373
5597
  urlConfiguration: UrlConfiguration | undefined;
@@ -6377,26 +5601,17 @@ export interface WebCrawlerConfiguration {
6377
5601
  */
6378
5602
  crawlerLimits?: WebCrawlerLimits | undefined;
6379
5603
  /**
6380
- * <p>A list of one or more inclusion regular expression patterns to include certain URLs. If
6381
- * you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion
6382
- * filter takes precedence and the web content of the URL isn’t crawled.</p>
5604
+ * <p>A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</p>
6383
5605
  * @public
6384
5606
  */
6385
5607
  inclusionFilters?: string[] | undefined;
6386
5608
  /**
6387
- * <p>A list of one or more exclusion regular expression patterns to exclude certain URLs. If
6388
- * you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion
6389
- * filter takes precedence and the web content of the URL isn’t crawled.</p>
5609
+ * <p>A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.</p>
6390
5610
  * @public
6391
5611
  */
6392
5612
  exclusionFilters?: string[] | undefined;
6393
5613
  /**
6394
- * <p>The scope of what is crawled for your URLs. You can choose to crawl only web pages that
6395
- * belong to the same host or primary domain. For example, only web pages that contain the seed
6396
- * URL <code>https://docs.aws.amazon.com/bedrock/latest/userguide/</code> and no other domains.
6397
- * You can choose to include sub domains in addition to the host or primary domain. For example,
6398
- * web pages that contain <code>aws.amazon.com</code> can also include sub domain
6399
- * <code>docs.aws.amazon.com</code>.</p>
5614
+ * <p>The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL <code>https://docs.aws.amazon.com/bedrock/latest/userguide/</code> and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain <code>aws.amazon.com</code> can also include sub domain <code>docs.aws.amazon.com</code>.</p>
6400
5615
  * @public
6401
5616
  */
6402
5617
  scope?: WebScopeType | undefined;
@@ -6485,10 +5700,7 @@ export declare const ParsingStrategy: {
6485
5700
  */
6486
5701
  export type ParsingStrategy = (typeof ParsingStrategy)[keyof typeof ParsingStrategy];
6487
5702
  /**
6488
- * <p>Settings for parsing document contents. By default, the service converts the contents of
6489
- * each document into text before splitting it into chunks. To improve processing of PDF files
6490
- * with tables and images, you can configure the data source to convert the pages of text into
6491
- * images and use a model to describe the contents of each page.</p>
5703
+ * <p>Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.</p>
6492
5704
  * @public
6493
5705
  */
6494
5706
  export interface ParsingConfiguration {
@@ -6509,9 +5721,7 @@ export interface ParsingConfiguration {
6509
5721
  */
6510
5722
  export interface VectorIngestionConfiguration {
6511
5723
  /**
6512
- * <p>Details about how to chunk the documents in the data source. A chunk refers to an excerpt
6513
- * from a data source that is returned when the knowledge base that it belongs to is
6514
- * queried.</p>
5724
+ * <p>Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.</p>
6515
5725
  * @public
6516
5726
  */
6517
5727
  chunkingConfiguration?: ChunkingConfiguration | undefined;
@@ -6526,10 +5736,7 @@ export interface VectorIngestionConfiguration {
6526
5736
  */
6527
5737
  export interface CreateKnowledgeBaseRequest {
6528
5738
  /**
6529
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
6530
- * request. If not provided, the Amazon Web Services
6531
- * SDK populates this field. For more information about idempotency, see
6532
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
5739
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
6533
5740
  * @public
6534
5741
  */
6535
5742
  clientToken?: string | undefined;
@@ -6539,15 +5746,12 @@ export interface CreateKnowledgeBaseRequest {
6539
5746
  */
6540
5747
  name: string | undefined;
6541
5748
  /**
6542
- * <p>The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content.
6543
- * EXTERNAL knowledge bases support integrations with third-party systems whose content is
6544
- * synchronized automatically. </p>
5749
+ * <p>The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically. </p>
6545
5750
  * @public
6546
5751
  */
6547
5752
  knowledgeBaseType: KnowledgeBaseType | undefined;
6548
5753
  /**
6549
- * <p>The source of the knowledge base content. Only set this argument for EXTERNAL or Managed
6550
- * knowledge bases.</p>
5754
+ * <p>The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.</p>
6551
5755
  * @public
6552
5756
  */
6553
5757
  sourceConfiguration?: SourceConfiguration | undefined;
@@ -6562,13 +5766,7 @@ export interface CreateKnowledgeBaseRequest {
6562
5766
  */
6563
5767
  vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
6564
5768
  /**
6565
- * <p>The configuration information for the customer managed key used for encryption. </p>
6566
- * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
6567
- * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
6568
- * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
6569
- * key to invoke Amazon Q in Connect.</p>
6570
- * <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
6571
- * your instance</a>.</p>
5769
+ * <p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect.</p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>
6572
5770
  * @public
6573
5771
  */
6574
5772
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
@@ -6644,8 +5842,7 @@ export interface KnowledgeBaseData {
6644
5842
  */
6645
5843
  status: KnowledgeBaseStatus | undefined;
6646
5844
  /**
6647
- * <p>An epoch timestamp indicating the most recent content modification inside the knowledge
6648
- * base. If no content exists in a knowledge base, this value is unset.</p>
5845
+ * <p>An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.</p>
6649
5846
  * @public
6650
5847
  */
6651
5848
  lastContentModificationTime?: Date | undefined;
@@ -6665,13 +5862,7 @@ export interface KnowledgeBaseData {
6665
5862
  */
6666
5863
  renderingConfiguration?: RenderingConfiguration | undefined;
6667
5864
  /**
6668
- * <p>The configuration information for the customer managed key used for encryption. </p>
6669
- * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
6670
- * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
6671
- * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
6672
- * key to invoke Amazon Q in Connect. </p>
6673
- * <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
6674
- * your instance</a>.</p>
5865
+ * <p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>
6675
5866
  * @public
6676
5867
  */
6677
5868
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
@@ -6742,17 +5933,12 @@ export declare namespace MessageTemplateBodyContentProvider {
6742
5933
  */
6743
5934
  export interface EmailMessageTemplateContentBody {
6744
5935
  /**
6745
- * <p>The message body, in plain text format, to use in email messages that are based on the
6746
- * message template. We recommend using plain text format for email clients that don't render
6747
- * HTML content and clients that are connected to high-latency networks, such as mobile
6748
- * devices.</p>
5936
+ * <p>The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.</p>
6749
5937
  * @public
6750
5938
  */
6751
5939
  plainText?: MessageTemplateBodyContentProvider | undefined;
6752
5940
  /**
6753
- * <p>The message body, in HTML format, to use in email messages that are based on the message
6754
- * template. We recommend using HTML format for email clients that render HTML content. You can
6755
- * include links, formatted text, and more in an HTML message.</p>
5941
+ * <p>The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.</p>
6756
5942
  * @public
6757
5943
  */
6758
5944
  html?: MessageTemplateBodyContentProvider | undefined;
@@ -6894,14 +6080,12 @@ export interface CustomerProfileAttributes {
6894
6080
  */
6895
6081
  accountNumber?: string | undefined;
6896
6082
  /**
6897
- * <p>The customer's email address, which has not been specified as a personal or business
6898
- * address.</p>
6083
+ * <p>The customer's email address, which has not been specified as a personal or business address.</p>
6899
6084
  * @public
6900
6085
  */
6901
6086
  emailAddress?: string | undefined;
6902
6087
  /**
6903
- * <p>The customer's phone number, which has not been specified as a mobile, home, or business
6904
- * number.</p>
6088
+ * <p>The customer's phone number, which has not been specified as a mobile, home, or business number.</p>
6905
6089
  * @public
6906
6090
  */
6907
6091
  phoneNumber?: string | undefined;
@@ -7162,8 +6346,7 @@ export interface CustomerProfileAttributes {
7162
6346
  */
7163
6347
  export interface SystemEndpointAttributes {
7164
6348
  /**
7165
- * <p>The customer's phone number if used with <code>customerEndpoint</code>, or the number the
7166
- * customer dialed to call your contact center if used with <code>systemEndpoint</code>.</p>
6349
+ * <p>The customer's phone number if used with <code>customerEndpoint</code>, or the number the customer dialed to call your contact center if used with <code>systemEndpoint</code>.</p>
7167
6350
  * @public
7168
6351
  */
7169
6352
  address?: string | undefined;
@@ -7221,27 +6404,12 @@ export interface MessageTemplateAttributes {
7221
6404
  */
7222
6405
  export interface GroupingConfiguration {
7223
6406
  /**
7224
- * <p>The criteria used for grouping Amazon Q in Connect users.</p>
7225
- * <p>The following is the list of supported criteria values.</p>
7226
- * <ul>
7227
- * <li>
7228
- * <p>
7229
- * <code>RoutingProfileArn</code>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon
7230
- * Connect routing profile ARN</a>. User should have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html">SearchRoutingProfile</a> and <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</p>
7231
- * </li>
7232
- * </ul>
6407
+ * <p>The criteria used for grouping Amazon Q in Connect users.</p> <p>The following is the list of supported criteria values.</p> <ul> <li> <p> <code>RoutingProfileArn</code>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profile ARN</a>. User should have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html">SearchRoutingProfile</a> and <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</p> </li> </ul>
7233
6408
  * @public
7234
6409
  */
7235
6410
  criteria?: string | undefined;
7236
6411
  /**
7237
- * <p>The list of values that define different groups of Amazon Q in Connect users.</p>
7238
- * <ul>
7239
- * <li>
7240
- * <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to
7241
- * provide a list of ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing
7242
- * profiles</a> as values of this parameter.</p>
7243
- * </li>
7244
- * </ul>
6412
+ * <p>The list of values that define different groups of Amazon Q in Connect users.</p> <ul> <li> <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to provide a list of ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profiles</a> as values of this parameter.</p> </li> </ul>
7245
6413
  * @public
7246
6414
  */
7247
6415
  values?: string[] | undefined;
@@ -7251,8 +6419,7 @@ export interface GroupingConfiguration {
7251
6419
  */
7252
6420
  export interface CreateMessageTemplateRequest {
7253
6421
  /**
7254
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
7255
- * the ARN.</p>
6422
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
7256
6423
  * @public
7257
6424
  */
7258
6425
  knowledgeBaseId: string | undefined;
@@ -7277,18 +6444,12 @@ export interface CreateMessageTemplateRequest {
7277
6444
  */
7278
6445
  channelSubtype: ChannelSubtype | undefined;
7279
6446
  /**
7280
- * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
7281
- * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
7282
- * <code>zh_CN</code>, <code>zh_TW</code>
7283
- * </p>
6447
+ * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>
7284
6448
  * @public
7285
6449
  */
7286
6450
  language?: string | undefined;
7287
6451
  /**
7288
- * <p>An object that specifies the default values to use for variables in the message template.
7289
- * This object contains different categories of key-value pairs. Each key defines a variable or
7290
- * placeholder in the message template. The corresponding value defines the default value for
7291
- * that variable.</p>
6452
+ * <p>An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.</p>
7292
6453
  * @public
7293
6454
  */
7294
6455
  defaultAttributes?: MessageTemplateAttributes | undefined;
@@ -7298,10 +6459,7 @@ export interface CreateMessageTemplateRequest {
7298
6459
  */
7299
6460
  groupingConfiguration?: GroupingConfiguration | undefined;
7300
6461
  /**
7301
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
7302
- * request. If not provided, the Amazon Web Services
7303
- * SDK populates this field. For more information about idempotency, see
7304
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
6462
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
7305
6463
  * @public
7306
6464
  */
7307
6465
  clientToken?: string | undefined;
@@ -7371,8 +6529,7 @@ export interface MessageTemplateData {
7371
6529
  */
7372
6530
  lastModifiedTime: Date | undefined;
7373
6531
  /**
7374
- * <p>The Amazon Resource Name (ARN) of the user who last updated the message template
7375
- * data.</p>
6532
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
7376
6533
  * @public
7377
6534
  */
7378
6535
  lastModifiedBy: string | undefined;
@@ -7387,10 +6544,7 @@ export interface MessageTemplateData {
7387
6544
  */
7388
6545
  description?: string | undefined;
7389
6546
  /**
7390
- * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
7391
- * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
7392
- * <code>zh_CN</code>, <code>zh_TW</code>
7393
- * </p>
6547
+ * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>
7394
6548
  * @public
7395
6549
  */
7396
6550
  language?: string | undefined;
@@ -7400,10 +6554,7 @@ export interface MessageTemplateData {
7400
6554
  */
7401
6555
  groupingConfiguration?: GroupingConfiguration | undefined;
7402
6556
  /**
7403
- * <p>An object that specifies the default values to use for variables in the message template.
7404
- * This object contains different categories of key-value pairs. Each key defines a variable or
7405
- * placeholder in the message template. The corresponding value defines the default value for
7406
- * that variable.</p>
6557
+ * <p>An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.</p>
7407
6558
  * @public
7408
6559
  */
7409
6560
  defaultAttributes?: MessageTemplateAttributes | undefined;
@@ -7413,10 +6564,7 @@ export interface MessageTemplateData {
7413
6564
  */
7414
6565
  attributeTypes?: MessageTemplateAttributeType[] | undefined;
7415
6566
  /**
7416
- * <p>The checksum value of the message template content that is referenced by the
7417
- * <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or
7418
- * <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language,
7419
- * <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
6567
+ * <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
7420
6568
  * @public
7421
6569
  */
7422
6570
  messageTemplateContentSha256: string | undefined;
@@ -7441,14 +6589,12 @@ export interface CreateMessageTemplateResponse {
7441
6589
  */
7442
6590
  export interface CreateMessageTemplateAttachmentRequest {
7443
6591
  /**
7444
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
7445
- * the ARN.</p>
6592
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
7446
6593
  * @public
7447
6594
  */
7448
6595
  knowledgeBaseId: string | undefined;
7449
6596
  /**
7450
- * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
7451
- * any qualifier.</p>
6597
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
7452
6598
  * @public
7453
6599
  */
7454
6600
  messageTemplateId: string | undefined;
@@ -7458,22 +6604,17 @@ export interface CreateMessageTemplateAttachmentRequest {
7458
6604
  */
7459
6605
  contentDisposition: ContentDisposition | undefined;
7460
6606
  /**
7461
- * <p>The name of the attachment file being uploaded. The name should include the file
7462
- * extension.</p>
6607
+ * <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
7463
6608
  * @public
7464
6609
  */
7465
6610
  name: string | undefined;
7466
6611
  /**
7467
- * <p>The body of the attachment file being uploaded. It should be encoded using base64
7468
- * encoding.</p>
6612
+ * <p>The body of the attachment file being uploaded. It should be encoded using base64 encoding.</p>
7469
6613
  * @public
7470
6614
  */
7471
6615
  body: string | undefined;
7472
6616
  /**
7473
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
7474
- * request. If not provided, the Amazon Web Services
7475
- * SDK populates this field. For more information about idempotency, see
7476
- * <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
6617
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
7477
6618
  * @public
7478
6619
  */
7479
6620
  clientToken?: string | undefined;
@@ -7489,8 +6630,7 @@ export interface MessageTemplateAttachment {
7489
6630
  */
7490
6631
  contentDisposition: ContentDisposition | undefined;
7491
6632
  /**
7492
- * <p>The name of the attachment file being uploaded. The name should include the file
7493
- * extension.</p>
6633
+ * <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
7494
6634
  * @public
7495
6635
  */
7496
6636
  name: string | undefined;
@@ -7530,144 +6670,21 @@ export interface CreateMessageTemplateAttachmentResponse {
7530
6670
  */
7531
6671
  export interface CreateMessageTemplateVersionRequest {
7532
6672
  /**
7533
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
7534
- * the ARN.</p>
6673
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
7535
6674
  * @public
7536
6675
  */
7537
6676
  knowledgeBaseId: string | undefined;
7538
6677
  /**
7539
- * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
7540
- * any qualifier.</p>
6678
+ * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
7541
6679
  * @public
7542
6680
  */
7543
6681
  messageTemplateId: string | undefined;
7544
6682
  /**
7545
- * <p>The checksum value of the message template content that is referenced by the
7546
- * <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or
7547
- * <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language,
7548
- * <code>defaultAttributes</code> and <code>Attachments</code> of the message template. If not
7549
- * supplied, the message template version will be created based on the message template content
7550
- * that is referenced by the <code>$LATEST</code> qualifier by default.</p>
6683
+ * <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the <code>$LATEST</code> qualifier by default.</p>
7551
6684
  * @public
7552
6685
  */
7553
6686
  messageTemplateContentSha256?: string | undefined;
7554
6687
  }
7555
- /**
7556
- * <p>The extended data of a message template.</p>
7557
- * @public
7558
- */
7559
- export interface ExtendedMessageTemplateData {
7560
- /**
7561
- * <p>The Amazon Resource Name (ARN) of the message template.</p>
7562
- * @public
7563
- */
7564
- messageTemplateArn: string | undefined;
7565
- /**
7566
- * <p>The identifier of the message template.</p>
7567
- * @public
7568
- */
7569
- messageTemplateId: string | undefined;
7570
- /**
7571
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
7572
- * @public
7573
- */
7574
- knowledgeBaseArn: string | undefined;
7575
- /**
7576
- * <p>The identifier of the knowledge base.</p>
7577
- * @public
7578
- */
7579
- knowledgeBaseId: string | undefined;
7580
- /**
7581
- * <p>The name of the message template.</p>
7582
- * @public
7583
- */
7584
- name: string | undefined;
7585
- /**
7586
- * <p>The channel subtype this message template applies to.</p>
7587
- * @public
7588
- */
7589
- channelSubtype: ChannelSubtype | undefined;
7590
- /**
7591
- * <p>The timestamp when the message template was created.</p>
7592
- * @public
7593
- */
7594
- createdTime: Date | undefined;
7595
- /**
7596
- * <p>The timestamp when the message template data was last modified.</p>
7597
- * @public
7598
- */
7599
- lastModifiedTime: Date | undefined;
7600
- /**
7601
- * <p>The Amazon Resource Name (ARN) of the user who last updated the message template
7602
- * data.</p>
7603
- * @public
7604
- */
7605
- lastModifiedBy: string | undefined;
7606
- /**
7607
- * <p>The content of the message template.</p>
7608
- * @public
7609
- */
7610
- content: MessageTemplateContentProvider | undefined;
7611
- /**
7612
- * <p>The description of the message template.</p>
7613
- * @public
7614
- */
7615
- description?: string | undefined;
7616
- /**
7617
- * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
7618
- * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
7619
- * <code>zh_CN</code>, <code>zh_TW</code>
7620
- * </p>
7621
- * @public
7622
- */
7623
- language?: string | undefined;
7624
- /**
7625
- * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
7626
- * @public
7627
- */
7628
- groupingConfiguration?: GroupingConfiguration | undefined;
7629
- /**
7630
- * <p>An object that specifies the default values to use for variables in the message template.
7631
- * This object contains different categories of key-value pairs. Each key defines a variable or
7632
- * placeholder in the message template. The corresponding value defines the default value for
7633
- * that variable.</p>
7634
- * @public
7635
- */
7636
- defaultAttributes?: MessageTemplateAttributes | undefined;
7637
- /**
7638
- * <p>The types of attributes contain the message template.</p>
7639
- * @public
7640
- */
7641
- attributeTypes?: MessageTemplateAttributeType[] | undefined;
7642
- /**
7643
- * <p>The message template attachments.</p>
7644
- * @public
7645
- */
7646
- attachments?: MessageTemplateAttachment[] | undefined;
7647
- /**
7648
- * <p>Whether the version of the message template is activated.</p>
7649
- * @public
7650
- */
7651
- isActive?: boolean | undefined;
7652
- /**
7653
- * <p>The version number of the message template version.</p>
7654
- * @public
7655
- */
7656
- versionNumber?: number | undefined;
7657
- /**
7658
- * <p>The checksum value of the message template content that is referenced by the
7659
- * <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or
7660
- * <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language,
7661
- * <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
7662
- * @public
7663
- */
7664
- messageTemplateContentSha256: string | undefined;
7665
- /**
7666
- * <p>The tags used to organize, track, or control access for this resource.</p>
7667
- * @public
7668
- */
7669
- tags?: Record<string, string> | undefined;
7670
- }
7671
6688
  /**
7672
6689
  * @internal
7673
6690
  */
@@ -8012,7 +7029,3 @@ export declare const MessageTemplateAttachmentFilterSensitiveLog: (obj: MessageT
8012
7029
  * @internal
8013
7030
  */
8014
7031
  export declare const CreateMessageTemplateAttachmentResponseFilterSensitiveLog: (obj: CreateMessageTemplateAttachmentResponse) => any;
8015
- /**
8016
- * @internal
8017
- */
8018
- export declare const ExtendedMessageTemplateDataFilterSensitiveLog: (obj: ExtendedMessageTemplateData) => any;