aws-sdk-qbusiness 1.2.0 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -66,12 +66,13 @@ module Aws::QBusiness
66
66
  include Aws::Structure
67
67
  end
68
68
 
69
- # Performs an Amazon Q plugin action during a non-streaming chat
70
- # conversation.
69
+ # Performs an Amazon Q Business plugin action during a non-streaming
70
+ # chat conversation.
71
71
  #
72
72
  # @!attribute [rw] payload
73
73
  # A mapping of field names to the field values in input that an end
74
- # user provides to Amazon Q requests to perform their plugin action.
74
+ # user provides to Amazon Q Business requests to perform their plugin
75
+ # action.
75
76
  # @return [Hash<String,Types::ActionExecutionPayloadField>]
76
77
  #
77
78
  # @!attribute [rw] payload_field_name_separator
@@ -108,14 +109,14 @@ module Aws::QBusiness
108
109
  include Aws::Structure
109
110
  end
110
111
 
111
- # An output event that Amazon Q returns to an user who wants to perform
112
- # a plugin action during a non-streaming chat conversation. It contains
113
- # information about the selected action with a list of possible user
114
- # input fields, some pre-populated by Amazon Q.
112
+ # An output event that Amazon Q Business returns to an user who wants to
113
+ # perform a plugin action during a non-streaming chat conversation. It
114
+ # contains information about the selected action with a list of possible
115
+ # user input fields, some pre-populated by Amazon Q Business.
115
116
  #
116
117
  # @!attribute [rw] payload
117
- # Field values that an end user needs to provide to Amazon Q for
118
- # Amazon Q to perform the requested plugin action.
118
+ # Field values that an end user needs to provide to Amazon Q Business
119
+ # for Amazon Q Business to perform the requested plugin action.
119
120
  # @return [Hash<String,Types::ActionReviewPayloadField>]
120
121
  #
121
122
  # @!attribute [rw] payload_field_name_separator
@@ -146,8 +147,8 @@ module Aws::QBusiness
146
147
  #
147
148
  # @!attribute [rw] allowed_values
148
149
  # Information about the field values that an end user can use to
149
- # provide to Amazon Q for Amazon Q to perform the requested plugin
150
- # action.
150
+ # provide to Amazon Q Business for Amazon Q Business to perform the
151
+ # requested plugin action.
151
152
  # @return [Array<Types::ActionReviewPayloadFieldAllowedValue>]
152
153
  #
153
154
  # @!attribute [rw] display_name
@@ -184,7 +185,8 @@ module Aws::QBusiness
184
185
  end
185
186
 
186
187
  # Information about the field values that an end user can use to provide
187
- # to Amazon Q for Amazon Q to perform the requested plugin action.
188
+ # to Amazon Q Business for Amazon Q Business to perform the requested
189
+ # plugin action.
188
190
  #
189
191
  # @!attribute [rw] display_value
190
192
  # The name of the field.
@@ -203,27 +205,29 @@ module Aws::QBusiness
203
205
  include Aws::Structure
204
206
  end
205
207
 
206
- # Summary information for an Amazon Q application.
208
+ # Summary information for an Amazon Q Business application.
207
209
  #
208
210
  # @!attribute [rw] application_id
209
- # The identifier for the Amazon Q application.
211
+ # The identifier for the Amazon Q Business application.
210
212
  # @return [String]
211
213
  #
212
214
  # @!attribute [rw] created_at
213
- # The Unix timestamp when the Amazon Q application was created.
215
+ # The Unix timestamp when the Amazon Q Business application was
216
+ # created.
214
217
  # @return [Time]
215
218
  #
216
219
  # @!attribute [rw] display_name
217
- # The name of the Amazon Q application.
220
+ # The name of the Amazon Q Business application.
218
221
  # @return [String]
219
222
  #
220
223
  # @!attribute [rw] status
221
- # The status of the Amazon Q application. The application is ready to
222
- # use when the status is `ACTIVE`.
224
+ # The status of the Amazon Q Business application. The application is
225
+ # ready to use when the status is `ACTIVE`.
223
226
  # @return [String]
224
227
  #
225
228
  # @!attribute [rw] updated_at
226
- # The Unix timestamp when the Amazon Q application was last updated.
229
+ # The Unix timestamp when the Amazon Q Business application was last
230
+ # updated.
227
231
  # @return [Time]
228
232
  #
229
233
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Application AWS API Documentation
@@ -254,6 +258,31 @@ module Aws::QBusiness
254
258
  include Aws::Structure
255
259
  end
256
260
 
261
+ # The creator mode specific admin controls configured for an Amazon Q
262
+ # Business application. Determines whether an end user can generate
263
+ # LLM-only responses when they use the web experience.
264
+ #
265
+ # For more information, see [Admin controls and guardrails][1] and
266
+ # [Conversation settings][2].
267
+ #
268
+ #
269
+ #
270
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html
271
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope
272
+ #
273
+ # @!attribute [rw] creator_mode_control
274
+ # Information about whether creator mode is enabled or disabled for an
275
+ # Amazon Q Business application.
276
+ # @return [String]
277
+ #
278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AppliedCreatorModeConfiguration AWS API Documentation
279
+ #
280
+ class AppliedCreatorModeConfiguration < Struct.new(
281
+ :creator_mode_control)
282
+ SENSITIVE = []
283
+ include Aws::Structure
284
+ end
285
+
257
286
  # A file directly uploaded into a web experience chat.
258
287
  #
259
288
  # @!attribute [rw] data
@@ -321,41 +350,74 @@ module Aws::QBusiness
321
350
  #
322
351
  # @!attribute [rw] contains_all
323
352
  # Returns `true` when a document contains all the specified document
324
- # attributes or metadata fields.
353
+ # attributes or metadata fields. Supported for the following [document
354
+ # attribute value types][1]: `stringListValue`.
355
+ #
356
+ #
357
+ #
358
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
325
359
  # @return [Types::DocumentAttribute]
326
360
  #
327
361
  # @!attribute [rw] contains_any
328
362
  # Returns `true` when a document contains any of the specified
329
- # document attributes or metadata fields.
363
+ # document attributes or metadata fields. Supported for the following
364
+ # [document attribute value types][1]: `dateValue`, `longValue`,
365
+ # `stringListValue` and `stringValue`.
366
+ #
367
+ #
368
+ #
369
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
330
370
  # @return [Types::DocumentAttribute]
331
371
  #
332
372
  # @!attribute [rw] equals_to
333
373
  # Performs an equals operation on two document attributes or metadata
334
- # fields.
374
+ # fields. Supported for the following [document attribute value
375
+ # types][1]: `dateValue`, `longValue`, `stringListValue` and
376
+ # `stringValue`.
377
+ #
378
+ #
379
+ #
380
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
335
381
  # @return [Types::DocumentAttribute]
336
382
  #
337
383
  # @!attribute [rw] greater_than
338
384
  # Performs a greater than operation on two document attributes or
339
- # metadata fields. Use with a document attribute of type `Date` or
340
- # `Long`.
385
+ # metadata fields. Supported for the following [document attribute
386
+ # value types][1]: `dateValue` and `longValue`.
387
+ #
388
+ #
389
+ #
390
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
341
391
  # @return [Types::DocumentAttribute]
342
392
  #
343
393
  # @!attribute [rw] greater_than_or_equals
344
394
  # Performs a greater or equals than operation on two document
345
- # attributes or metadata fields. Use with a document attribute of type
346
- # `Date` or `Long`.
395
+ # attributes or metadata fields. Supported for the following [document
396
+ # attribute value types][1]: `dateValue` and `longValue`.
397
+ #
398
+ #
399
+ #
400
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
347
401
  # @return [Types::DocumentAttribute]
348
402
  #
349
403
  # @!attribute [rw] less_than
350
404
  # Performs a less than operation on two document attributes or
351
- # metadata fields. Use with a document attribute of type `Date` or
352
- # `Long`.
405
+ # metadata fields. Supported for the following [document attribute
406
+ # value types][1]: `dateValue` and `longValue`.
407
+ #
408
+ #
409
+ #
410
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
353
411
  # @return [Types::DocumentAttribute]
354
412
  #
355
413
  # @!attribute [rw] less_than_or_equals
356
414
  # Performs a less than or equals operation on two document attributes
357
- # or metadata fields. Use with a document attribute of type `Date` or
358
- # `Long`.
415
+ # or metadata fields.Supported for the following [document attribute
416
+ # value type][1]: `dateValue` and `longValue`.
417
+ #
418
+ #
419
+ #
420
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
359
421
  # @return [Types::DocumentAttribute]
360
422
  #
361
423
  # @!attribute [rw] not_filter
@@ -387,7 +449,7 @@ module Aws::QBusiness
387
449
  # configure a plugin.
388
450
  #
389
451
  # @!attribute [rw] role_arn
390
- # The ARN of an IAM role used by Amazon Q to access the basic
452
+ # The ARN of an IAM role used by Amazon Q Business to access the basic
391
453
  # authentication credentials stored in a Secrets Manager secret.
392
454
  # @return [String]
393
455
  #
@@ -406,7 +468,7 @@ module Aws::QBusiness
406
468
  end
407
469
 
408
470
  # @!attribute [rw] application_id
409
- # The identifier of the Amazon Q application.
471
+ # The identifier of the Amazon Q Business application.
410
472
  # @return [String]
411
473
  #
412
474
  # @!attribute [rw] data_source_sync_id
@@ -415,12 +477,12 @@ module Aws::QBusiness
415
477
  # @return [String]
416
478
  #
417
479
  # @!attribute [rw] documents
418
- # Documents deleted from the Amazon Q index.
480
+ # Documents deleted from the Amazon Q Business index.
419
481
  # @return [Array<Types::DeleteDocument>]
420
482
  #
421
483
  # @!attribute [rw] index_id
422
- # The identifier of the Amazon Q index that contains the documents to
423
- # delete.
484
+ # The identifier of the Amazon Q Business index that contains the
485
+ # documents to delete.
424
486
  # @return [String]
425
487
  #
426
488
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BatchDeleteDocumentRequest AWS API Documentation
@@ -436,8 +498,8 @@ module Aws::QBusiness
436
498
 
437
499
  # @!attribute [rw] failed_documents
438
500
  # A list of documents that couldn't be removed from the Amazon Q
439
- # index. Each entry contains an error message that indicates why the
440
- # document couldn't be removed from the index.
501
+ # Business index. Each entry contains an error message that indicates
502
+ # why the document couldn't be removed from the index.
441
503
  # @return [Array<Types::FailedDocument>]
442
504
  #
443
505
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BatchDeleteDocumentResponse AWS API Documentation
@@ -449,7 +511,7 @@ module Aws::QBusiness
449
511
  end
450
512
 
451
513
  # @!attribute [rw] application_id
452
- # The identifier of the Amazon Q application.
514
+ # The identifier of the Amazon Q Business application.
453
515
  # @return [String]
454
516
  #
455
517
  # @!attribute [rw] data_source_sync_id
@@ -462,7 +524,8 @@ module Aws::QBusiness
462
524
  # @return [Array<Types::Document>]
463
525
  #
464
526
  # @!attribute [rw] index_id
465
- # The identifier of the Amazon Q index to add the documents to.
527
+ # The identifier of the Amazon Q Business index to add the documents
528
+ # to.
466
529
  # @return [String]
467
530
  #
468
531
  # @!attribute [rw] role_arn
@@ -483,8 +546,8 @@ module Aws::QBusiness
483
546
  end
484
547
 
485
548
  # @!attribute [rw] failed_documents
486
- # A list of documents that were not added to the Amazon Q index
487
- # because the document failed a validation check. Each document
549
+ # A list of documents that were not added to the Amazon Q Business
550
+ # index because the document failed a validation check. Each document
488
551
  # contains an error message that indicates why the document couldn't
489
552
  # be added to the index.
490
553
  # @return [Array<Types::FailedDocument>]
@@ -501,7 +564,8 @@ module Aws::QBusiness
501
564
  # control configuration.
502
565
  #
503
566
  # @!attribute [rw] blocked_phrases
504
- # A list of phrases blocked from a Amazon Q web experience chat.
567
+ # A list of phrases blocked from a Amazon Q Business web experience
568
+ # chat.
505
569
  # @return [Array<String>]
506
570
  #
507
571
  # @!attribute [rw] system_message_override
@@ -518,15 +582,16 @@ module Aws::QBusiness
518
582
  include Aws::Structure
519
583
  end
520
584
 
521
- # Updates a blocked phrases configuration in your Amazon Q application.
585
+ # Updates a blocked phrases configuration in your Amazon Q Business
586
+ # application.
522
587
  #
523
588
  # @!attribute [rw] blocked_phrases_to_create_or_update
524
589
  # Creates or updates a blocked phrases configuration in your Amazon Q
525
- # application.
590
+ # Business application.
526
591
  # @return [Array<String>]
527
592
  #
528
593
  # @!attribute [rw] blocked_phrases_to_delete
529
- # Deletes a blocked phrases configuration in your Amazon Q
594
+ # Deletes a blocked phrases configuration in your Amazon Q Business
530
595
  # application.
531
596
  # @return [Array<String>]
532
597
  #
@@ -545,13 +610,43 @@ module Aws::QBusiness
545
610
  include Aws::Structure
546
611
  end
547
612
 
613
+ # Configuration information for Amazon Q Business conversation modes.
614
+ #
615
+ # For more information, see [Admin controls and guardrails][1] and
616
+ # [Conversation settings][2].
617
+ #
618
+ #
619
+ #
620
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html
621
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope
622
+ #
623
+ # @note ChatModeConfiguration is a union - when making an API calls you must set exactly one of the members.
624
+ #
625
+ # @!attribute [rw] plugin_configuration
626
+ # Configuration information required to invoke chat in `PLUGIN_MODE`.
627
+ # @return [Types::PluginConfiguration]
628
+ #
629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ChatModeConfiguration AWS API Documentation
630
+ #
631
+ class ChatModeConfiguration < Struct.new(
632
+ :plugin_configuration,
633
+ :unknown)
634
+ SENSITIVE = []
635
+ include Aws::Structure
636
+ include Aws::Structure::Union
637
+
638
+ class PluginConfiguration < ChatModeConfiguration; end
639
+ class Unknown < ChatModeConfiguration; end
640
+ end
641
+
548
642
  # @!attribute [rw] action_execution
549
- # A request from an end user to perform an Amazon Q plugin action.
643
+ # A request from an end user to perform an Amazon Q Business plugin
644
+ # action.
550
645
  # @return [Types::ActionExecution]
551
646
  #
552
647
  # @!attribute [rw] application_id
553
- # The identifier of the Amazon Q application linked to the Amazon Q
554
- # conversation.
648
+ # The identifier of the Amazon Q Business application linked to the
649
+ # Amazon Q Business conversation.
555
650
  # @return [String]
556
651
  #
557
652
  # @!attribute [rw] attachments
@@ -560,10 +655,39 @@ module Aws::QBusiness
560
655
  # @return [Array<Types::AttachmentInput>]
561
656
  #
562
657
  # @!attribute [rw] attribute_filter
563
- # Enables filtering of Amazon Q web experience responses based on
564
- # document attributes or metadata fields.
658
+ # Enables filtering of Amazon Q Business web experience responses
659
+ # based on document attributes or metadata fields.
565
660
  # @return [Types::AttributeFilter]
566
661
  #
662
+ # @!attribute [rw] chat_mode
663
+ # The chat modes available in an Amazon Q Business web experience.
664
+ #
665
+ # * `RETRIEVAL_MODE` - The default chat mode for an Amazon Q Business
666
+ # application. When this mode is enabled, Amazon Q Business
667
+ # generates responses only from data sources connected to an Amazon
668
+ # Q Business application.
669
+ #
670
+ # * `CREATOR_MODE` - By selecting this mode, users can choose to
671
+ # generate responses only from the LLM knowledge, without consulting
672
+ # connected data sources, for a chat request.
673
+ #
674
+ # * `PLUGIN_MODE` - By selecting this mode, users can choose to use
675
+ # plugins in chat.
676
+ #
677
+ # For more information, see [Admin controls and guardrails][1],
678
+ # [Plugins][2], and [Conversation settings][3].
679
+ #
680
+ #
681
+ #
682
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html
683
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html
684
+ # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope
685
+ # @return [String]
686
+ #
687
+ # @!attribute [rw] chat_mode_configuration
688
+ # The chat mode configuration for an Amazon Q Business application.
689
+ # @return [Types::ChatModeConfiguration]
690
+ #
567
691
  # @!attribute [rw] client_token
568
692
  # A token that you provide to identify a chat request.
569
693
  #
@@ -572,7 +696,7 @@ module Aws::QBusiness
572
696
  # @return [String]
573
697
  #
574
698
  # @!attribute [rw] conversation_id
575
- # The identifier of the Amazon Q conversation.
699
+ # The identifier of the Amazon Q Business conversation.
576
700
  # @return [String]
577
701
  #
578
702
  # @!attribute [rw] parent_message_id
@@ -599,6 +723,8 @@ module Aws::QBusiness
599
723
  :application_id,
600
724
  :attachments,
601
725
  :attribute_filter,
726
+ :chat_mode,
727
+ :chat_mode_configuration,
602
728
  :client_token,
603
729
  :conversation_id,
604
730
  :parent_message_id,
@@ -610,12 +736,13 @@ module Aws::QBusiness
610
736
  end
611
737
 
612
738
  # @!attribute [rw] action_review
613
- # A request from Amazon Q to the end user for information Amazon Q
614
- # needs to successfully complete a requested plugin action.
739
+ # A request from Amazon Q Business to the end user for information
740
+ # Amazon Q Business needs to successfully complete a requested plugin
741
+ # action.
615
742
  # @return [Types::ActionReview]
616
743
  #
617
744
  # @!attribute [rw] conversation_id
618
- # The identifier of the Amazon Q conversation.
745
+ # The identifier of the Amazon Q Business conversation.
619
746
  # @return [String]
620
747
  #
621
748
  # @!attribute [rw] failed_attachments
@@ -631,13 +758,13 @@ module Aws::QBusiness
631
758
  # @return [String]
632
759
  #
633
760
  # @!attribute [rw] system_message_id
634
- # The identifier of an Amazon Q AI generated message within the
635
- # conversation.
761
+ # The identifier of an Amazon Q Business AI generated message within
762
+ # the conversation.
636
763
  # @return [String]
637
764
  #
638
765
  # @!attribute [rw] user_message_id
639
- # The identifier of an Amazon Q end user text input message within the
640
- # conversation.
766
+ # The identifier of an Amazon Q Business end user text input message
767
+ # within the conversation.
641
768
  # @return [String]
642
769
  #
643
770
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ChatSyncOutput AWS API Documentation
@@ -680,10 +807,10 @@ module Aws::QBusiness
680
807
  include Aws::Structure
681
808
  end
682
809
 
683
- # A rule for configuring how Amazon Q responds when it encounters a a
684
- # blocked topic. You can configure a custom message to inform your end
685
- # users that they have asked about a restricted topic and suggest any
686
- # next steps they should take.
810
+ # A rule for configuring how Amazon Q Business responds when it
811
+ # encounters a a blocked topic. You can configure a custom message to
812
+ # inform your end users that they have asked about a restricted topic
813
+ # and suggest any next steps they should take.
687
814
  #
688
815
  # @!attribute [rw] system_message_override
689
816
  # The configured custom message displayed to an end user informing
@@ -699,11 +826,11 @@ module Aws::QBusiness
699
826
  end
700
827
 
701
828
  # Rules for retrieving content from data sources connected to a Amazon Q
702
- # application for a specific topic control configuration.
829
+ # Business application for a specific topic control configuration.
703
830
  #
704
831
  # @!attribute [rw] eligible_data_sources
705
- # Specifies data sources in a Amazon Q application to use for content
706
- # generation.
832
+ # Specifies data sources in a Amazon Q Business application to use for
833
+ # content generation.
707
834
  # @return [Array<Types::EligibleDataSource>]
708
835
  #
709
836
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ContentRetrievalRule AWS API Documentation
@@ -714,10 +841,10 @@ module Aws::QBusiness
714
841
  include Aws::Structure
715
842
  end
716
843
 
717
- # A conversation in an Amazon Q application.
844
+ # A conversation in an Amazon Q Business application.
718
845
  #
719
846
  # @!attribute [rw] conversation_id
720
- # The identifier of the Amazon Q conversation.
847
+ # The identifier of the Amazon Q Business conversation.
721
848
  # @return [String]
722
849
  #
723
850
  # @!attribute [rw] start_time
@@ -744,25 +871,31 @@ module Aws::QBusiness
744
871
  #
745
872
  # @!attribute [rw] client_token
746
873
  # A token that you provide to identify the request to create your
747
- # Amazon Q application.
874
+ # Amazon Q Business application.
748
875
  #
749
876
  # **A suitable default value is auto-generated.** You should normally
750
877
  # not need to pass this option.
751
878
  # @return [String]
752
879
  #
753
880
  # @!attribute [rw] description
754
- # A description for the Amazon Q application.
881
+ # A description for the Amazon Q Business application.
755
882
  # @return [String]
756
883
  #
757
884
  # @!attribute [rw] display_name
758
- # A name for the Amazon Q application.
885
+ # A name for the Amazon Q Business application.
759
886
  # @return [String]
760
887
  #
761
888
  # @!attribute [rw] encryption_configuration
762
889
  # The identifier of the KMS key that is used to encrypt your data.
763
- # Amazon Q doesn't support asymmetric keys.
890
+ # Amazon Q Business doesn't support asymmetric keys.
764
891
  # @return [Types::EncryptionConfiguration]
765
892
  #
893
+ # @!attribute [rw] identity_center_instance_arn
894
+ # The Amazon Resource Name (ARN) of the IAM Identity Center instance
895
+ # you are either creating for—or connecting to—your Amazon Q Business
896
+ # application.
897
+ # @return [String]
898
+ #
766
899
  # @!attribute [rw] role_arn
767
900
  # The Amazon Resource Name (ARN) of an IAM role with permissions to
768
901
  # access your Amazon CloudWatch logs and metrics.
@@ -770,10 +903,10 @@ module Aws::QBusiness
770
903
  #
771
904
  # @!attribute [rw] tags
772
905
  # A list of key-value pairs that identify or categorize your Amazon Q
773
- # application. You can also use tags to help control access to the
774
- # application. Tag keys and values can consist of Unicode letters,
775
- # digits, white space, and any of the following symbols: \_ . : / = +
776
- # - @.
906
+ # Business application. You can also use tags to help control access
907
+ # to the application. Tag keys and values can consist of Unicode
908
+ # letters, digits, white space, and any of the following symbols: \_ .
909
+ # \: / = + - @.
777
910
  # @return [Array<Types::Tag>]
778
911
  #
779
912
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateApplicationRequest AWS API Documentation
@@ -784,6 +917,7 @@ module Aws::QBusiness
784
917
  :description,
785
918
  :display_name,
786
919
  :encryption_configuration,
920
+ :identity_center_instance_arn,
787
921
  :role_arn,
788
922
  :tags)
789
923
  SENSITIVE = []
@@ -791,11 +925,11 @@ module Aws::QBusiness
791
925
  end
792
926
 
793
927
  # @!attribute [rw] application_arn
794
- # The Amazon Resource Name (ARN) of the Amazon Q application.
928
+ # The Amazon Resource Name (ARN) of the Amazon Q Business application.
795
929
  # @return [String]
796
930
  #
797
931
  # @!attribute [rw] application_id
798
- # The identifier of the Amazon Q application.
932
+ # The identifier of the Amazon Q Business application.
799
933
  # @return [String]
800
934
  #
801
935
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateApplicationResponse AWS API Documentation
@@ -808,8 +942,8 @@ module Aws::QBusiness
808
942
  end
809
943
 
810
944
  # @!attribute [rw] application_id
811
- # The identifier of the Amazon Q application the data source will be
812
- # attached to.
945
+ # The identifier of the Amazon Q Business application the data source
946
+ # will be attached to.
813
947
  # @return [String]
814
948
  #
815
949
  # @!attribute [rw] client_token
@@ -828,7 +962,7 @@ module Aws::QBusiness
828
962
  #
829
963
  #
830
964
  #
831
- # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html.html
965
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
832
966
  # @return [Hash,Array,String,Numeric,Boolean]
833
967
  #
834
968
  # @!attribute [rw] description
@@ -861,9 +995,9 @@ module Aws::QBusiness
861
995
  # @return [String]
862
996
  #
863
997
  # @!attribute [rw] sync_schedule
864
- # Sets the frequency for Amazon Q to check the documents in your data
865
- # source repository and update your index. If you don't set a
866
- # schedule, Amazon Q won't periodically update the index.
998
+ # Sets the frequency for Amazon Q Business to check the documents in
999
+ # your data source repository and update your index. If you don't set
1000
+ # a schedule, Amazon Q Business won't periodically update the index.
867
1001
  #
868
1002
  # Specify a `cron-` format schedule string or an empty string to
869
1003
  # indicate that the index is updated on demand. You can't specify the
@@ -882,7 +1016,7 @@ module Aws::QBusiness
882
1016
  # @!attribute [rw] vpc_configuration
883
1017
  # Configuration information for an Amazon VPC (Virtual Private Cloud)
884
1018
  # to connect to your data source. For more information, see [Using
885
- # Amazon VPC with Amazon Q connectors][1].
1019
+ # Amazon VPC with Amazon Q Business connectors][1].
886
1020
  #
887
1021
  #
888
1022
  #
@@ -909,7 +1043,7 @@ module Aws::QBusiness
909
1043
 
910
1044
  # @!attribute [rw] data_source_arn
911
1045
  # The Amazon Resource Name (ARN) of a data source in an Amazon Q
912
- # application.
1046
+ # Business application.
913
1047
  # @return [String]
914
1048
  #
915
1049
  # @!attribute [rw] data_source_id
@@ -926,7 +1060,7 @@ module Aws::QBusiness
926
1060
  end
927
1061
 
928
1062
  # @!attribute [rw] application_id
929
- # The identifier of the Amazon Q application using the index.
1063
+ # The identifier of the Amazon Q Business application using the index.
930
1064
  # @return [String]
931
1065
  #
932
1066
  # @!attribute [rw] capacity_configuration
@@ -944,11 +1078,11 @@ module Aws::QBusiness
944
1078
  # @return [String]
945
1079
  #
946
1080
  # @!attribute [rw] description
947
- # A description for the Amazon Q index.
1081
+ # A description for the Amazon Q Business index.
948
1082
  # @return [String]
949
1083
  #
950
1084
  # @!attribute [rw] display_name
951
- # A name for the Amazon Q index.
1085
+ # A name for the Amazon Q Business index.
952
1086
  # @return [String]
953
1087
  #
954
1088
  # @!attribute [rw] tags
@@ -972,11 +1106,11 @@ module Aws::QBusiness
972
1106
  end
973
1107
 
974
1108
  # @!attribute [rw] index_arn
975
- # The Amazon Resource Name (ARN) of an Amazon Q index.
1109
+ # The Amazon Resource Name (ARN) of an Amazon Q Business index.
976
1110
  # @return [String]
977
1111
  #
978
1112
  # @!attribute [rw] index_id
979
- # The identifier for the Amazon Q index.
1113
+ # The identifier for the Amazon Q Business index.
980
1114
  # @return [String]
981
1115
  #
982
1116
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateIndexResponse AWS API Documentation
@@ -993,12 +1127,13 @@ module Aws::QBusiness
993
1127
  # @return [String]
994
1128
  #
995
1129
  # @!attribute [rw] auth_configuration
996
- # Authentication configuration information for an Amazon Q plugin.
1130
+ # Authentication configuration information for an Amazon Q Business
1131
+ # plugin.
997
1132
  # @return [Types::PluginAuthConfiguration]
998
1133
  #
999
1134
  # @!attribute [rw] client_token
1000
1135
  # A token that you provide to identify the request to create your
1001
- # Amazon Q plugin.
1136
+ # Amazon Q Business plugin.
1002
1137
  #
1003
1138
  # **A suitable default value is auto-generated.** You should normally
1004
1139
  # not need to pass this option.
@@ -1056,12 +1191,12 @@ module Aws::QBusiness
1056
1191
  end
1057
1192
 
1058
1193
  # @!attribute [rw] application_id
1059
- # The identifier of your Amazon Q application.
1194
+ # The identifier of your Amazon Q Business application.
1060
1195
  # @return [String]
1061
1196
  #
1062
1197
  # @!attribute [rw] client_token
1063
1198
  # A token that you provide to identify the request to create your
1064
- # Amazon Q application retriever.
1199
+ # Amazon Q Business application retriever.
1065
1200
  #
1066
1201
  # **A suitable default value is auto-generated.** You should normally
1067
1202
  # not need to pass this option.
@@ -1069,7 +1204,7 @@ module Aws::QBusiness
1069
1204
  #
1070
1205
  # @!attribute [rw] configuration
1071
1206
  # Provides information on how the retriever used for your Amazon Q
1072
- # application is configured.
1207
+ # Business application is configured.
1073
1208
  # @return [Types::RetrieverConfiguration]
1074
1209
  #
1075
1210
  # @!attribute [rw] display_name
@@ -1077,7 +1212,7 @@ module Aws::QBusiness
1077
1212
  # @return [String]
1078
1213
  #
1079
1214
  # @!attribute [rw] role_arn
1080
- # The ARN of an IAM role used by Amazon Q to access the basic
1215
+ # The ARN of an IAM role used by Amazon Q Business to access the basic
1081
1216
  # authentication credentials stored in a Secrets Manager secret.
1082
1217
  # @return [String]
1083
1218
  #
@@ -1131,7 +1266,7 @@ module Aws::QBusiness
1131
1266
  #
1132
1267
  # @!attribute [rw] client_token
1133
1268
  # A token that you provide to identify the request to create your
1134
- # Amazon Q user mapping.
1269
+ # Amazon Q Business user mapping.
1135
1270
  #
1136
1271
  # **A suitable default value is auto-generated.** You should normally
1137
1272
  # not need to pass this option.
@@ -1161,41 +1296,46 @@ module Aws::QBusiness
1161
1296
  class CreateUserResponse < Aws::EmptyStructure; end
1162
1297
 
1163
1298
  # @!attribute [rw] application_id
1164
- # The identifier of the Amazon Q web experience.
1299
+ # The identifier of the Amazon Q Business web experience.
1165
1300
  # @return [String]
1166
1301
  #
1167
1302
  # @!attribute [rw] client_token
1168
- # A token you provide to identify a request to create an Amazon Q web
1169
- # experience.
1303
+ # A token you provide to identify a request to create an Amazon Q
1304
+ # Business web experience.
1170
1305
  #
1171
1306
  # **A suitable default value is auto-generated.** You should normally
1172
1307
  # not need to pass this option.
1173
1308
  # @return [String]
1174
1309
  #
1310
+ # @!attribute [rw] role_arn
1311
+ # The Amazon Resource Name (ARN) of the service role attached to your
1312
+ # web experience.
1313
+ # @return [String]
1314
+ #
1175
1315
  # @!attribute [rw] sample_prompts_control_mode
1176
1316
  # Determines whether sample prompts are enabled in the web experience
1177
1317
  # for an end user.
1178
1318
  # @return [String]
1179
1319
  #
1180
1320
  # @!attribute [rw] subtitle
1181
- # A subtitle to personalize your Amazon Q web experience.
1321
+ # A subtitle to personalize your Amazon Q Business web experience.
1182
1322
  # @return [String]
1183
1323
  #
1184
1324
  # @!attribute [rw] tags
1185
1325
  # A list of key-value pairs that identify or categorize your Amazon Q
1186
- # web experience. You can also use tags to help control access to the
1187
- # web experience. Tag keys and values can consist of Unicode letters,
1188
- # digits, white space, and any of the following symbols: \_ . : / = +
1189
- # - @.
1326
+ # Business web experience. You can also use tags to help control
1327
+ # access to the web experience. Tag keys and values can consist of
1328
+ # Unicode letters, digits, white space, and any of the following
1329
+ # symbols: \_ . : / = + - @.
1190
1330
  # @return [Array<Types::Tag>]
1191
1331
  #
1192
1332
  # @!attribute [rw] title
1193
- # The title for your Amazon Q web experience.
1333
+ # The title for your Amazon Q Business web experience.
1194
1334
  # @return [String]
1195
1335
  #
1196
1336
  # @!attribute [rw] welcome_message
1197
- # The customized welcome message for end users of an Amazon Q web
1198
- # experience.
1337
+ # The customized welcome message for end users of an Amazon Q Business
1338
+ # web experience.
1199
1339
  # @return [String]
1200
1340
  #
1201
1341
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateWebExperienceRequest AWS API Documentation
@@ -1203,6 +1343,7 @@ module Aws::QBusiness
1203
1343
  class CreateWebExperienceRequest < Struct.new(
1204
1344
  :application_id,
1205
1345
  :client_token,
1346
+ :role_arn,
1206
1347
  :sample_prompts_control_mode,
1207
1348
  :subtitle,
1208
1349
  :tags,
@@ -1213,11 +1354,12 @@ module Aws::QBusiness
1213
1354
  end
1214
1355
 
1215
1356
  # @!attribute [rw] web_experience_arn
1216
- # The Amazon Resource Name (ARN) of an Amazon Q web experience.
1357
+ # The Amazon Resource Name (ARN) of an Amazon Q Business web
1358
+ # experience.
1217
1359
  # @return [String]
1218
1360
  #
1219
1361
  # @!attribute [rw] web_experience_id
1220
- # The identifier of the Amazon Q web experience.
1362
+ # The identifier of the Amazon Q Business web experience.
1221
1363
  # @return [String]
1222
1364
  #
1223
1365
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateWebExperienceResponse AWS API Documentation
@@ -1229,30 +1371,55 @@ module Aws::QBusiness
1229
1371
  include Aws::Structure
1230
1372
  end
1231
1373
 
1232
- # A data source in an Amazon Q application.
1374
+ # Configuration information required to invoke chat in `CREATOR_MODE`.
1375
+ #
1376
+ # For more information, see [Admin controls and guardrails][1] and
1377
+ # [Conversation settings][2].
1378
+ #
1379
+ #
1380
+ #
1381
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html
1382
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope
1383
+ #
1384
+ # @!attribute [rw] creator_mode_control
1385
+ # Status information about whether `CREATOR_MODE` has been enabled or
1386
+ # disabled. The default status is `DISABLED`.
1387
+ # @return [String]
1388
+ #
1389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreatorModeConfiguration AWS API Documentation
1390
+ #
1391
+ class CreatorModeConfiguration < Struct.new(
1392
+ :creator_mode_control)
1393
+ SENSITIVE = []
1394
+ include Aws::Structure
1395
+ end
1396
+
1397
+ # A data source in an Amazon Q Business application.
1233
1398
  #
1234
1399
  # @!attribute [rw] created_at
1235
- # The Unix timestamp when the Amazon Q data source was created.
1400
+ # The Unix timestamp when the Amazon Q Business data source was
1401
+ # created.
1236
1402
  # @return [Time]
1237
1403
  #
1238
1404
  # @!attribute [rw] data_source_id
1239
- # The identifier of the Amazon Q data source.
1405
+ # The identifier of the Amazon Q Business data source.
1240
1406
  # @return [String]
1241
1407
  #
1242
1408
  # @!attribute [rw] display_name
1243
- # The name of the Amazon Q data source.
1409
+ # The name of the Amazon Q Business data source.
1244
1410
  # @return [String]
1245
1411
  #
1246
1412
  # @!attribute [rw] status
1247
- # The status of the Amazon Q data source.
1413
+ # The status of the Amazon Q Business data source.
1248
1414
  # @return [String]
1249
1415
  #
1250
1416
  # @!attribute [rw] type
1251
- # The type of the Amazon Q data source.
1417
+ # The type of the Amazon Q Business data source.
1252
1418
  # @return [String]
1253
1419
  #
1254
1420
  # @!attribute [rw] updated_at
1255
- # The Unix timestamp when the Amazon Q data source was last updated.
1421
+ # The Unix timestamp when the Amazon Q Business data source was last
1422
+ # updated.
1256
1423
  # @return [Time]
1257
1424
  #
1258
1425
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DataSource AWS API Documentation
@@ -1268,7 +1435,7 @@ module Aws::QBusiness
1268
1435
  include Aws::Structure
1269
1436
  end
1270
1437
 
1271
- # Provides information about an Amazon Q data source connector
1438
+ # Provides information about an Amazon Q Business data source connector
1272
1439
  # synchronization job.
1273
1440
  #
1274
1441
  # @!attribute [rw] data_source_error_code
@@ -1322,8 +1489,8 @@ module Aws::QBusiness
1322
1489
  include Aws::Structure
1323
1490
  end
1324
1491
 
1325
- # Maps a batch delete document request to a specific Amazon Q data
1326
- # source connector sync job.
1492
+ # Maps a batch delete document request to a specific Amazon Q Business
1493
+ # data source connector sync job.
1327
1494
  #
1328
1495
  # @!attribute [rw] documents_added
1329
1496
  # The current count of documents added from the data source during the
@@ -1367,8 +1534,8 @@ module Aws::QBusiness
1367
1534
  #
1368
1535
  # @!attribute [rw] security_group_ids
1369
1536
  # A list of identifiers of security groups within your Amazon VPC. The
1370
- # security groups should enable Amazon Q to connect to the data
1371
- # source.
1537
+ # security groups should enable Amazon Q Business to connect to the
1538
+ # data source.
1372
1539
  # @return [Array<String>]
1373
1540
  #
1374
1541
  # @!attribute [rw] subnet_ids
@@ -1389,7 +1556,7 @@ module Aws::QBusiness
1389
1556
  # Provides information on boosting `DATE` type document attributes.
1390
1557
  #
1391
1558
  # For more information on how boosting document attributes work in
1392
- # Amazon Q, see [Boosting using document attributes][1].
1559
+ # Amazon Q Business, see [Boosting using document attributes][1].
1393
1560
  #
1394
1561
  #
1395
1562
  #
@@ -1414,7 +1581,7 @@ module Aws::QBusiness
1414
1581
  end
1415
1582
 
1416
1583
  # @!attribute [rw] application_id
1417
- # The identifier of the Amazon Q application.
1584
+ # The identifier of the Amazon Q Business application.
1418
1585
  # @return [String]
1419
1586
  #
1420
1587
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteApplicationRequest AWS API Documentation
@@ -1447,13 +1614,13 @@ module Aws::QBusiness
1447
1614
  class DeleteChatControlsConfigurationResponse < Aws::EmptyStructure; end
1448
1615
 
1449
1616
  # @!attribute [rw] application_id
1450
- # The identifier of the Amazon Q application associated with the
1451
- # conversation.
1617
+ # The identifier of the Amazon Q Business application associated with
1618
+ # the conversation.
1452
1619
  # @return [String]
1453
1620
  #
1454
1621
  # @!attribute [rw] conversation_id
1455
- # The identifier of the Amazon Q web experience conversation being
1456
- # deleted.
1622
+ # The identifier of the Amazon Q Business web experience conversation
1623
+ # being deleted.
1457
1624
  # @return [String]
1458
1625
  #
1459
1626
  # @!attribute [rw] user_id
@@ -1475,8 +1642,8 @@ module Aws::QBusiness
1475
1642
  class DeleteConversationResponse < Aws::EmptyStructure; end
1476
1643
 
1477
1644
  # @!attribute [rw] application_id
1478
- # The identifier of the Amazon Q application used with the data source
1479
- # connector.
1645
+ # The identifier of the Amazon Q Business application used with the
1646
+ # data source connector.
1480
1647
  # @return [String]
1481
1648
  #
1482
1649
  # @!attribute [rw] data_source_id
@@ -1501,7 +1668,7 @@ module Aws::QBusiness
1501
1668
  #
1502
1669
  class DeleteDataSourceResponse < Aws::EmptyStructure; end
1503
1670
 
1504
- # A document deleted from an Amazon Q data source connector.
1671
+ # A document deleted from an Amazon Q Business data source connector.
1505
1672
  #
1506
1673
  # @!attribute [rw] document_id
1507
1674
  # The identifier of the deleted document.
@@ -1558,12 +1725,12 @@ module Aws::QBusiness
1558
1725
  class DeleteGroupResponse < Aws::EmptyStructure; end
1559
1726
 
1560
1727
  # @!attribute [rw] application_id
1561
- # The identifier of the Amazon Q application the Amazon Q index is
1562
- # linked to.
1728
+ # The identifier of the Amazon Q Business application the Amazon Q
1729
+ # Business index is linked to.
1563
1730
  # @return [String]
1564
1731
  #
1565
1732
  # @!attribute [rw] index_id
1566
- # The identifier of the Amazon Q index.
1733
+ # The identifier of the Amazon Q Business index.
1567
1734
  # @return [String]
1568
1735
  #
1569
1736
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteIndexRequest AWS API Documentation
@@ -1580,7 +1747,8 @@ module Aws::QBusiness
1580
1747
  class DeleteIndexResponse < Aws::EmptyStructure; end
1581
1748
 
1582
1749
  # @!attribute [rw] application_id
1583
- # The identifier the application attached to the Amazon Q plugin.
1750
+ # The identifier the application attached to the Amazon Q Business
1751
+ # plugin.
1584
1752
  # @return [String]
1585
1753
  #
1586
1754
  # @!attribute [rw] plugin_id
@@ -1601,7 +1769,8 @@ module Aws::QBusiness
1601
1769
  class DeletePluginResponse < Aws::EmptyStructure; end
1602
1770
 
1603
1771
  # @!attribute [rw] application_id
1604
- # The identifier of the Amazon Q application using the retriever.
1772
+ # The identifier of the Amazon Q Business application using the
1773
+ # retriever.
1605
1774
  # @return [String]
1606
1775
  #
1607
1776
  # @!attribute [rw] retriever_id
@@ -1644,12 +1813,13 @@ module Aws::QBusiness
1644
1813
  class DeleteUserResponse < Aws::EmptyStructure; end
1645
1814
 
1646
1815
  # @!attribute [rw] application_id
1647
- # The identifier of the Amazon Q application linked to the Amazon Q
1648
- # web experience.
1816
+ # The identifier of the Amazon Q Business application linked to the
1817
+ # Amazon Q Business web experience.
1649
1818
  # @return [String]
1650
1819
  #
1651
1820
  # @!attribute [rw] web_experience_id
1652
- # The identifier of the Amazon Q web experience being deleted.
1821
+ # The identifier of the Amazon Q Business web experience being
1822
+ # deleted.
1653
1823
  # @return [String]
1654
1824
  #
1655
1825
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteWebExperienceRequest AWS API Documentation
@@ -1665,15 +1835,15 @@ module Aws::QBusiness
1665
1835
  #
1666
1836
  class DeleteWebExperienceResponse < Aws::EmptyStructure; end
1667
1837
 
1668
- # A document in an Amazon Q application.
1838
+ # A document in an Amazon Q Business application.
1669
1839
  #
1670
1840
  # @!attribute [rw] access_configuration
1671
1841
  # Configuration information for access permission to a document.
1672
1842
  # @return [Types::AccessConfiguration]
1673
1843
  #
1674
1844
  # @!attribute [rw] attributes
1675
- # Custom attributes to apply to the document for refining Amazon Q web
1676
- # experience responses.
1845
+ # Custom attributes to apply to the document for refining Amazon Q
1846
+ # Business web experience responses.
1677
1847
  # @return [Array<Types::DocumentAttribute>]
1678
1848
  #
1679
1849
  # @!attribute [rw] content
@@ -1734,10 +1904,11 @@ module Aws::QBusiness
1734
1904
  include Aws::Structure
1735
1905
  end
1736
1906
 
1737
- # Provides information on boosting supported Amazon Q document attribute
1738
- # types. When an end user chat query matches document attributes that
1739
- # have been boosted, Amazon Q prioritizes generating responses from
1740
- # content that matches the boosted document attributes.
1907
+ # Provides information on boosting supported Amazon Q Business document
1908
+ # attribute types. When an end user chat query matches document
1909
+ # attributes that have been boosted, Amazon Q Business prioritizes
1910
+ # generating responses from content that matches the boosted document
1911
+ # attributes.
1741
1912
  #
1742
1913
  # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
1743
1914
  # boosting on the console and the API, they must be enabled for search
@@ -1749,7 +1920,7 @@ module Aws::QBusiness
1749
1920
  # </note>
1750
1921
  #
1751
1922
  # For more information on how boosting document attributes work in
1752
- # Amazon Q, see [Boosting using document attributes][3].
1923
+ # Amazon Q Business, see [Boosting using document attributes][3].
1753
1924
  #
1754
1925
  #
1755
1926
  #
@@ -1798,7 +1969,7 @@ module Aws::QBusiness
1798
1969
  end
1799
1970
 
1800
1971
  # The condition used for the target document attribute or metadata field
1801
- # when ingesting documents into Amazon Q. You use this with [
1972
+ # when ingesting documents into Amazon Q Business. You use this with [
1802
1973
  # `DocumentAttributeTarget` ][1] to apply the condition.
1803
1974
  #
1804
1975
  # For example, you can create the 'Department' target field and have
@@ -1808,11 +1979,11 @@ module Aws::QBusiness
1808
1979
  # then prefill the target field 'Department' with the target value
1809
1980
  # 'Finance' for the document.
1810
1981
  #
1811
- # Amazon Q can't create a target field if it has not already been
1812
- # created as an index field. After you create your index field, you can
1813
- # create a document metadata field using `DocumentAttributeTarget`.
1814
- # Amazon Q then will map your newly created metadata field to your index
1815
- # field.
1982
+ # Amazon Q Business can't create a target field if it has not already
1983
+ # been created as an index field. After you create your index field, you
1984
+ # can create a document metadata field using `DocumentAttributeTarget`.
1985
+ # Amazon Q Business then will map your newly created metadata field to
1986
+ # your index field.
1816
1987
  #
1817
1988
  #
1818
1989
  #
@@ -1825,8 +1996,8 @@ module Aws::QBusiness
1825
1996
  # attribute or metadata field that contains source URIs associated
1826
1997
  # with the documents.
1827
1998
  #
1828
- # Amazon Q currently doesn't support `_document_body` as an attribute
1829
- # key used for the condition.
1999
+ # Amazon Q Business currently doesn't support `_document_body` as an
2000
+ # attribute key used for the condition.
1830
2001
  # @return [String]
1831
2002
  #
1832
2003
  # @!attribute [rw] operator
@@ -1889,7 +2060,7 @@ module Aws::QBusiness
1889
2060
  end
1890
2061
 
1891
2062
  # The target document attribute or metadata field you want to alter when
1892
- # ingesting documents into Amazon Q.
2063
+ # ingesting documents into Amazon Q Business.
1893
2064
  #
1894
2065
  # For example, you can delete all customer identification numbers
1895
2066
  # associated with the documents, stored in the document metadata field
@@ -1898,11 +2069,11 @@ module Aws::QBusiness
1898
2069
  # in the field 'Customer\_ID'. This would scrub personally
1899
2070
  # identifiable information from each document's metadata.
1900
2071
  #
1901
- # Amazon Q can't create a target field if it has not already been
1902
- # created as an index field. After you create your index field, you can
1903
- # create a document metadata field using [ `DocumentAttributeTarget`
1904
- # ][1]. Amazon Q will then map your newly created document attribute to
1905
- # your index field.
2072
+ # Amazon Q Business can't create a target field if it has not already
2073
+ # been created as an index field. After you create your index field, you
2074
+ # can create a document metadata field using [ `DocumentAttributeTarget`
2075
+ # ][1]. Amazon Q Business will then map your newly created document
2076
+ # attribute to your index field.
1906
2077
  #
1907
2078
  # You can also use this with [ `DocumentAttributeCondition` ][2].
1908
2079
  #
@@ -1994,9 +2165,9 @@ module Aws::QBusiness
1994
2165
  # The contents of the document. Documents passed to the `blob`
1995
2166
  # parameter must be base64 encoded. Your code might not need to encode
1996
2167
  # the document file bytes if you're using an Amazon Web Services SDK
1997
- # to call Amazon Q APIs. If you are calling the Amazon Q endpoint
1998
- # directly using REST, you must base64 encode the contents before
1999
- # sending.
2168
+ # to call Amazon Q Business APIs. If you are calling the Amazon Q
2169
+ # Business endpoint directly using REST, you must base64 encode the
2170
+ # contents before sending.
2000
2171
  # @return [String]
2001
2172
  #
2002
2173
  # @!attribute [rw] s3
@@ -2018,7 +2189,7 @@ module Aws::QBusiness
2018
2189
  class Unknown < DocumentContent; end
2019
2190
  end
2020
2191
 
2021
- # The details of a document within an Amazon Q index.
2192
+ # The details of a document within an Amazon Q Business index.
2022
2193
  #
2023
2194
  # @!attribute [rw] created_at
2024
2195
  # The timestamp for when the document was created.
@@ -2063,20 +2234,20 @@ module Aws::QBusiness
2063
2234
  #
2064
2235
  # @!attribute [rw] inline_configurations
2065
2236
  # Configuration information to alter document attributes or metadata
2066
- # fields and content when ingesting documents into Amazon Q.
2237
+ # fields and content when ingesting documents into Amazon Q Business.
2067
2238
  # @return [Array<Types::InlineDocumentEnrichmentConfiguration>]
2068
2239
  #
2069
2240
  # @!attribute [rw] post_extraction_hook_configuration
2070
2241
  # Provides the configuration information for invoking a Lambda
2071
2242
  # function in Lambda to alter document metadata and content when
2072
- # ingesting documents into Amazon Q.
2243
+ # ingesting documents into Amazon Q Business.
2073
2244
  #
2074
2245
  # You can configure your Lambda function using
2075
2246
  # [PreExtractionHookConfiguration][1] if you want to apply advanced
2076
2247
  # alterations on the original or raw documents.
2077
2248
  #
2078
- # If you want to apply advanced alterations on the Amazon Q structured
2079
- # documents, you must configure your Lambda function using
2249
+ # If you want to apply advanced alterations on the Amazon Q Business
2250
+ # structured documents, you must configure your Lambda function using
2080
2251
  # [PostExtractionHookConfiguration][1].
2081
2252
  #
2082
2253
  # You can only invoke one Lambda function. However, this function can
@@ -2093,14 +2264,14 @@ module Aws::QBusiness
2093
2264
  # @!attribute [rw] pre_extraction_hook_configuration
2094
2265
  # Provides the configuration information for invoking a Lambda
2095
2266
  # function in Lambda to alter document metadata and content when
2096
- # ingesting documents into Amazon Q.
2267
+ # ingesting documents into Amazon Q Business.
2097
2268
  #
2098
2269
  # You can configure your Lambda function using
2099
2270
  # [PreExtractionHookConfiguration][1] if you want to apply advanced
2100
2271
  # alterations on the original or raw documents.
2101
2272
  #
2102
- # If you want to apply advanced alterations on the Amazon Q structured
2103
- # documents, you must configure your Lambda function using
2273
+ # If you want to apply advanced alterations on the Amazon Q Business
2274
+ # structured documents, you must configure your Lambda function using
2104
2275
  # [PostExtractionHookConfiguration][1].
2105
2276
  #
2106
2277
  # You can only invoke one Lambda function. However, this function can
@@ -2124,8 +2295,8 @@ module Aws::QBusiness
2124
2295
  include Aws::Structure
2125
2296
  end
2126
2297
 
2127
- # The identifier of the data source Amazon Q will generate responses
2128
- # from.
2298
+ # The identifier of the data source Amazon Q Business will generate
2299
+ # responses from.
2129
2300
  #
2130
2301
  # @!attribute [rw] data_source_id
2131
2302
  # The identifier of the data source.
@@ -2145,11 +2316,11 @@ module Aws::QBusiness
2145
2316
  end
2146
2317
 
2147
2318
  # Provides the identifier of the KMS key used to encrypt data indexed by
2148
- # Amazon Q. Amazon Q doesn't support asymmetric keys.
2319
+ # Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
2149
2320
  #
2150
2321
  # @!attribute [rw] kms_key_id
2151
- # The identifier of the KMS key. Amazon Q doesn't support asymmetric
2152
- # keys.
2322
+ # The identifier of the KMS key. Amazon Q Business doesn't support
2323
+ # asymmetric keys.
2153
2324
  # @return [String]
2154
2325
  #
2155
2326
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/EncryptionConfiguration AWS API Documentation
@@ -2179,13 +2350,13 @@ module Aws::QBusiness
2179
2350
  include Aws::Structure
2180
2351
  end
2181
2352
 
2182
- # A list of documents that could not be removed from an Amazon Q index.
2183
- # Each entry contains an error message that indicates why the document
2184
- # couldn't be removed from the index.
2353
+ # A list of documents that could not be removed from an Amazon Q
2354
+ # Business index. Each entry contains an error message that indicates
2355
+ # why the document couldn't be removed from the index.
2185
2356
  #
2186
2357
  # @!attribute [rw] data_source_id
2187
- # The identifier of the Amazon Q data source connector that contains
2188
- # the failed document.
2358
+ # The identifier of the Amazon Q Business data source connector that
2359
+ # contains the failed document.
2189
2360
  # @return [String]
2190
2361
  #
2191
2362
  # @!attribute [rw] error
@@ -2195,7 +2366,7 @@ module Aws::QBusiness
2195
2366
  #
2196
2367
  # @!attribute [rw] id
2197
2368
  # The identifier of the document that couldn't be removed from the
2198
- # Amazon Q index.
2369
+ # Amazon Q Business index.
2199
2370
  # @return [String]
2200
2371
  #
2201
2372
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/FailedDocument AWS API Documentation
@@ -2209,7 +2380,7 @@ module Aws::QBusiness
2209
2380
  end
2210
2381
 
2211
2382
  # @!attribute [rw] application_id
2212
- # The identifier of the Amazon Q application.
2383
+ # The identifier of the Amazon Q Business application.
2213
2384
  # @return [String]
2214
2385
  #
2215
2386
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplicationRequest AWS API Documentation
@@ -2221,11 +2392,11 @@ module Aws::QBusiness
2221
2392
  end
2222
2393
 
2223
2394
  # @!attribute [rw] application_arn
2224
- # The Amazon Resource Name (ARN) of the Amazon Q application.
2395
+ # The Amazon Resource Name (ARN) of the Amazon Q Business application.
2225
2396
  # @return [String]
2226
2397
  #
2227
2398
  # @!attribute [rw] application_id
2228
- # The identifier of the Amazon Q application.
2399
+ # The identifier of the Amazon Q Business application.
2229
2400
  # @return [String]
2230
2401
  #
2231
2402
  # @!attribute [rw] attachments_configuration
@@ -2234,20 +2405,22 @@ module Aws::QBusiness
2234
2405
  # @return [Types::AppliedAttachmentsConfiguration]
2235
2406
  #
2236
2407
  # @!attribute [rw] created_at
2237
- # The Unix timestamp when the Amazon Q application was last updated.
2408
+ # The Unix timestamp when the Amazon Q Business application was last
2409
+ # updated.
2238
2410
  # @return [Time]
2239
2411
  #
2240
2412
  # @!attribute [rw] description
2241
- # A description for the Amazon Q application.
2413
+ # A description for the Amazon Q Business application.
2242
2414
  # @return [String]
2243
2415
  #
2244
2416
  # @!attribute [rw] display_name
2245
- # The name of the Amazon Q application.
2417
+ # The name of the Amazon Q Business application.
2246
2418
  # @return [String]
2247
2419
  #
2248
2420
  # @!attribute [rw] encryption_configuration
2249
2421
  # The identifier of the Amazon Web Services KMS key that is used to
2250
- # encrypt your data. Amazon Q doesn't support asymmetric keys.
2422
+ # encrypt your data. Amazon Q Business doesn't support asymmetric
2423
+ # keys.
2251
2424
  # @return [Types::EncryptionConfiguration]
2252
2425
  #
2253
2426
  # @!attribute [rw] error
@@ -2256,17 +2429,23 @@ module Aws::QBusiness
2256
2429
  # to fail.
2257
2430
  # @return [Types::ErrorDetail]
2258
2431
  #
2432
+ # @!attribute [rw] identity_center_application_arn
2433
+ # The Amazon Resource Name (ARN) of the AWS IAM Identity Center
2434
+ # instance attached to your Amazon Q Business application.
2435
+ # @return [String]
2436
+ #
2259
2437
  # @!attribute [rw] role_arn
2260
2438
  # The Amazon Resource Name (ARN) of the IAM with permissions to access
2261
2439
  # your CloudWatch logs and metrics.
2262
2440
  # @return [String]
2263
2441
  #
2264
2442
  # @!attribute [rw] status
2265
- # The status of the Amazon Q application.
2443
+ # The status of the Amazon Q Business application.
2266
2444
  # @return [String]
2267
2445
  #
2268
2446
  # @!attribute [rw] updated_at
2269
- # The Unix timestamp when the Amazon Q application was last updated.
2447
+ # The Unix timestamp when the Amazon Q Business application was last
2448
+ # updated.
2270
2449
  # @return [Time]
2271
2450
  #
2272
2451
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplicationResponse AWS API Documentation
@@ -2280,6 +2459,7 @@ module Aws::QBusiness
2280
2459
  :display_name,
2281
2460
  :encryption_configuration,
2282
2461
  :error,
2462
+ :identity_center_application_arn,
2283
2463
  :role_arn,
2284
2464
  :status,
2285
2465
  :updated_at)
@@ -2298,9 +2478,9 @@ module Aws::QBusiness
2298
2478
  #
2299
2479
  # @!attribute [rw] next_token
2300
2480
  # If the `maxResults` response was incomplete because there is more
2301
- # data to retrieve, Amazon Q returns a pagination token in the
2302
- # response. You can use this pagination token to retrieve the next set
2303
- # of Amazon Q chat controls configured.
2481
+ # data to retrieve, Amazon Q Business returns a pagination token in
2482
+ # the response. You can use this pagination token to retrieve the next
2483
+ # set of Amazon Q Business chat controls configured.
2304
2484
  # @return [String]
2305
2485
  #
2306
2486
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatControlsConfigurationRequest AWS API Documentation
@@ -2317,29 +2497,35 @@ module Aws::QBusiness
2317
2497
  # The phrases blocked from chat by your chat control configuration.
2318
2498
  # @return [Types::BlockedPhrasesConfiguration]
2319
2499
  #
2500
+ # @!attribute [rw] creator_mode_configuration
2501
+ # The configuration details for `CREATOR_MODE`.
2502
+ # @return [Types::AppliedCreatorModeConfiguration]
2503
+ #
2320
2504
  # @!attribute [rw] next_token
2321
2505
  # If the `maxResults` response was incomplete because there is more
2322
- # data to retrieve, Amazon Q returns a pagination token in the
2323
- # response. You can use this pagination token to retrieve the next set
2324
- # of Amazon Q chat controls configured.
2506
+ # data to retrieve, Amazon Q Business returns a pagination token in
2507
+ # the response. You can use this pagination token to retrieve the next
2508
+ # set of Amazon Q Business chat controls configured.
2325
2509
  # @return [String]
2326
2510
  #
2327
2511
  # @!attribute [rw] response_scope
2328
- # The response scope configured for a Amazon Q application. This
2329
- # determines whether your application uses its retrieval augmented
2330
- # generation (RAG) system to generate answers only from your
2512
+ # The response scope configured for a Amazon Q Business application.
2513
+ # This determines whether your application uses its retrieval
2514
+ # augmented generation (RAG) system to generate answers only from your
2331
2515
  # enterprise data, or also uses the large language models (LLM)
2332
2516
  # knowledge to respons to end user questions in chat.
2333
2517
  # @return [String]
2334
2518
  #
2335
2519
  # @!attribute [rw] topic_configurations
2336
- # The topic specific controls configured for a Amazon Q application.
2520
+ # The topic specific controls configured for a Amazon Q Business
2521
+ # application.
2337
2522
  # @return [Array<Types::TopicConfiguration>]
2338
2523
  #
2339
2524
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatControlsConfigurationResponse AWS API Documentation
2340
2525
  #
2341
2526
  class GetChatControlsConfigurationResponse < Struct.new(
2342
2527
  :blocked_phrases,
2528
+ :creator_mode_configuration,
2343
2529
  :next_token,
2344
2530
  :response_scope,
2345
2531
  :topic_configurations)
@@ -2348,7 +2534,7 @@ module Aws::QBusiness
2348
2534
  end
2349
2535
 
2350
2536
  # @!attribute [rw] application_id
2351
- # The identifier of the Amazon Q application.
2537
+ # The identifier of the Amazon Q Business application.
2352
2538
  # @return [String]
2353
2539
  #
2354
2540
  # @!attribute [rw] data_source_id
@@ -2370,7 +2556,7 @@ module Aws::QBusiness
2370
2556
  end
2371
2557
 
2372
2558
  # @!attribute [rw] application_id
2373
- # The identifier of the Amazon Q application.
2559
+ # The identifier of the Amazon Q Business application.
2374
2560
  # @return [String]
2375
2561
  #
2376
2562
  # @!attribute [rw] configuration
@@ -2431,7 +2617,7 @@ module Aws::QBusiness
2431
2617
  # @return [String]
2432
2618
  #
2433
2619
  # @!attribute [rw] sync_schedule
2434
- # The schedule for Amazon Q to update the index.
2620
+ # The schedule for Amazon Q Business to update the index.
2435
2621
  # @return [String]
2436
2622
  #
2437
2623
  # @!attribute [rw] type
@@ -2515,11 +2701,13 @@ module Aws::QBusiness
2515
2701
  end
2516
2702
 
2517
2703
  # @!attribute [rw] application_id
2518
- # The identifier of the Amazon Q application connected to the index.
2704
+ # The identifier of the Amazon Q Business application connected to the
2705
+ # index.
2519
2706
  # @return [String]
2520
2707
  #
2521
2708
  # @!attribute [rw] index_id
2522
- # The identifier of the Amazon Q index you want information on.
2709
+ # The identifier of the Amazon Q Business index you want information
2710
+ # on.
2523
2711
  # @return [String]
2524
2712
  #
2525
2713
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetIndexRequest AWS API Documentation
@@ -2532,24 +2720,24 @@ module Aws::QBusiness
2532
2720
  end
2533
2721
 
2534
2722
  # @!attribute [rw] application_id
2535
- # The identifier of the Amazon Q application associated with the
2536
- # index.
2723
+ # The identifier of the Amazon Q Business application associated with
2724
+ # the index.
2537
2725
  # @return [String]
2538
2726
  #
2539
2727
  # @!attribute [rw] capacity_configuration
2540
- # The storage capacity units chosen for your Amazon Q index.
2728
+ # The storage capacity units chosen for your Amazon Q Business index.
2541
2729
  # @return [Types::IndexCapacityConfiguration]
2542
2730
  #
2543
2731
  # @!attribute [rw] created_at
2544
- # The Unix timestamp when the Amazon Q index was created.
2732
+ # The Unix timestamp when the Amazon Q Business index was created.
2545
2733
  # @return [Time]
2546
2734
  #
2547
2735
  # @!attribute [rw] description
2548
- # The description for the Amazon Q index.
2736
+ # The description for the Amazon Q Business index.
2549
2737
  # @return [String]
2550
2738
  #
2551
2739
  # @!attribute [rw] display_name
2552
- # The name of the Amazon Q index.
2740
+ # The name of the Amazon Q Business index.
2553
2741
  # @return [String]
2554
2742
  #
2555
2743
  # @!attribute [rw] document_attribute_configurations
@@ -2569,11 +2757,11 @@ module Aws::QBusiness
2569
2757
  # @return [Types::ErrorDetail]
2570
2758
  #
2571
2759
  # @!attribute [rw] index_arn
2572
- # The Amazon Resource Name (ARN) of the Amazon Q index.
2760
+ # The Amazon Resource Name (ARN) of the Amazon Q Business index.
2573
2761
  # @return [String]
2574
2762
  #
2575
2763
  # @!attribute [rw] index_id
2576
- # The identifier of the Amazon Q index.
2764
+ # The identifier of the Amazon Q Business index.
2577
2765
  # @return [String]
2578
2766
  #
2579
2767
  # @!attribute [rw] index_statistics
@@ -2587,7 +2775,8 @@ module Aws::QBusiness
2587
2775
  # @return [String]
2588
2776
  #
2589
2777
  # @!attribute [rw] updated_at
2590
- # The Unix timestamp when the Amazon Q index was last updated.
2778
+ # The Unix timestamp when the Amazon Q Business index was last
2779
+ # updated.
2591
2780
  # @return [Time]
2592
2781
  #
2593
2782
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetIndexResponse AWS API Documentation
@@ -2631,7 +2820,8 @@ module Aws::QBusiness
2631
2820
  # @return [String]
2632
2821
  #
2633
2822
  # @!attribute [rw] auth_configuration
2634
- # Authentication configuration information for an Amazon Q plugin.
2823
+ # Authentication configuration information for an Amazon Q Business
2824
+ # plugin.
2635
2825
  # @return [Types::PluginAuthConfiguration]
2636
2826
  #
2637
2827
  # @!attribute [rw] created_at
@@ -2685,7 +2875,8 @@ module Aws::QBusiness
2685
2875
  end
2686
2876
 
2687
2877
  # @!attribute [rw] application_id
2688
- # The identifier of the Amazon Q application using the retriever.
2878
+ # The identifier of the Amazon Q Business application using the
2879
+ # retriever.
2689
2880
  # @return [String]
2690
2881
  #
2691
2882
  # @!attribute [rw] retriever_id
@@ -2702,12 +2893,13 @@ module Aws::QBusiness
2702
2893
  end
2703
2894
 
2704
2895
  # @!attribute [rw] application_id
2705
- # The identifier of the Amazon Q application using the retriever.
2896
+ # The identifier of the Amazon Q Business application using the
2897
+ # retriever.
2706
2898
  # @return [String]
2707
2899
  #
2708
2900
  # @!attribute [rw] configuration
2709
2901
  # Provides information on how the retriever used for your Amazon Q
2710
- # application is configured.
2902
+ # Business application is configured.
2711
2903
  # @return [Types::RetrieverConfiguration]
2712
2904
  #
2713
2905
  # @!attribute [rw] created_at
@@ -2791,12 +2983,12 @@ module Aws::QBusiness
2791
2983
  end
2792
2984
 
2793
2985
  # @!attribute [rw] application_id
2794
- # The identifier of the Amazon Q application linked to the web
2795
- # experience.
2986
+ # The identifier of the Amazon Q Business application linked to the
2987
+ # web experience.
2796
2988
  # @return [String]
2797
2989
  #
2798
2990
  # @!attribute [rw] web_experience_id
2799
- # The identifier of the Amazon Q web experience.
2991
+ # The identifier of the Amazon Q Business web experience.
2800
2992
  # @return [String]
2801
2993
  #
2802
2994
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperienceRequest AWS API Documentation
@@ -2809,13 +3001,13 @@ module Aws::QBusiness
2809
3001
  end
2810
3002
 
2811
3003
  # @!attribute [rw] application_id
2812
- # The identifier of the Amazon Q application linked to the web
2813
- # experience.
3004
+ # The identifier of the Amazon Q Business application linked to the
3005
+ # web experience.
2814
3006
  # @return [String]
2815
3007
  #
2816
3008
  # @!attribute [rw] authentication_configuration
2817
- # The authentication configuration information for your Amazon Q web
2818
- # experience.
3009
+ # The authentication configuration information for your Amazon Q
3010
+ # Business web experience.
2819
3011
  # @return [Types::WebExperienceAuthConfiguration]
2820
3012
  #
2821
3013
  # @!attribute [rw] created_at
@@ -2823,7 +3015,7 @@ module Aws::QBusiness
2823
3015
  # @return [Time]
2824
3016
  #
2825
3017
  # @!attribute [rw] default_endpoint
2826
- # The endpoint of your Amazon Q web experience.
3018
+ # The endpoint of your Amazon Q Business web experience.
2827
3019
  # @return [String]
2828
3020
  #
2829
3021
  # @!attribute [rw] error
@@ -2832,24 +3024,29 @@ module Aws::QBusiness
2832
3024
  # connector to fail.
2833
3025
  # @return [Types::ErrorDetail]
2834
3026
  #
3027
+ # @!attribute [rw] role_arn
3028
+ # The Amazon Resource Name (ARN) of the service role attached to your
3029
+ # web experience.
3030
+ # @return [String]
3031
+ #
2835
3032
  # @!attribute [rw] sample_prompts_control_mode
2836
3033
  # Determines whether sample prompts are enabled in the web experience
2837
3034
  # for an end user.
2838
3035
  # @return [String]
2839
3036
  #
2840
3037
  # @!attribute [rw] status
2841
- # The current status of the Amazon Q web experience. When the `Status`
2842
- # field value is `FAILED`, the `ErrorMessage` field contains a
2843
- # description of the error that caused the data source connector to
3038
+ # The current status of the Amazon Q Business web experience. When the
3039
+ # `Status` field value is `FAILED`, the `ErrorMessage` field contains
3040
+ # a description of the error that caused the data source connector to
2844
3041
  # fail.
2845
3042
  # @return [String]
2846
3043
  #
2847
3044
  # @!attribute [rw] subtitle
2848
- # The subtitle for your Amazon Q web experience.
3045
+ # The subtitle for your Amazon Q Business web experience.
2849
3046
  # @return [String]
2850
3047
  #
2851
3048
  # @!attribute [rw] title
2852
- # The title for your Amazon Q web experience.
3049
+ # The title for your Amazon Q Business web experience.
2853
3050
  # @return [String]
2854
3051
  #
2855
3052
  # @!attribute [rw] updated_at
@@ -2858,16 +3055,16 @@ module Aws::QBusiness
2858
3055
  #
2859
3056
  # @!attribute [rw] web_experience_arn
2860
3057
  # The Amazon Resource Name (ARN) of the role with the permission to
2861
- # access the Amazon Q web experience and required resources.
3058
+ # access the Amazon Q Business web experience and required resources.
2862
3059
  # @return [String]
2863
3060
  #
2864
3061
  # @!attribute [rw] web_experience_id
2865
- # The identifier of the Amazon Q web experience.
3062
+ # The identifier of the Amazon Q Business web experience.
2866
3063
  # @return [String]
2867
3064
  #
2868
3065
  # @!attribute [rw] welcome_message
2869
- # The customized welcome message for end users of an Amazon Q web
2870
- # experience.
3066
+ # The customized welcome message for end users of an Amazon Q Business
3067
+ # web experience.
2871
3068
  # @return [String]
2872
3069
  #
2873
3070
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperienceResponse AWS API Documentation
@@ -2878,6 +3075,7 @@ module Aws::QBusiness
2878
3075
  :created_at,
2879
3076
  :default_endpoint,
2880
3077
  :error,
3078
+ :role_arn,
2881
3079
  :sample_prompts_control_mode,
2882
3080
  :status,
2883
3081
  :subtitle,
@@ -2891,8 +3089,8 @@ module Aws::QBusiness
2891
3089
  end
2892
3090
 
2893
3091
  # A list of users or sub groups that belong to a group. This is for
2894
- # generating Amazon Q chat results only from document a user has access
2895
- # to.
3092
+ # generating Amazon Q Business chat results only from document a user
3093
+ # has access to.
2896
3094
  #
2897
3095
  # @!attribute [rw] member_groups
2898
3096
  # A list of sub groups that belong to a group. For example, the sub
@@ -2921,7 +3119,8 @@ module Aws::QBusiness
2921
3119
  # @return [Types::ErrorDetail]
2922
3120
  #
2923
3121
  # @!attribute [rw] last_updated_at
2924
- # The Unix timestamp when the Amazon Q application was last updated.
3122
+ # The Unix timestamp when the Amazon Q Business application was last
3123
+ # updated.
2925
3124
  # @return [Time]
2926
3125
  #
2927
3126
  # @!attribute [rw] status
@@ -2954,14 +3153,14 @@ module Aws::QBusiness
2954
3153
 
2955
3154
  # Provides the configuration information for invoking a Lambda function
2956
3155
  # in Lambda to alter document metadata and content when ingesting
2957
- # documents into Amazon Q.
3156
+ # documents into Amazon Q Business.
2958
3157
  #
2959
3158
  # You can configure your Lambda function using
2960
3159
  # [PreExtractionHookConfiguration][1] if you want to apply advanced
2961
3160
  # alterations on the original or raw documents.
2962
3161
  #
2963
- # If you want to apply advanced alterations on the Amazon Q structured
2964
- # documents, you must configure your Lambda function using
3162
+ # If you want to apply advanced alterations on the Amazon Q Business
3163
+ # structured documents, you must configure your Lambda function using
2965
3164
  # [PostExtractionHookConfiguration][1].
2966
3165
  #
2967
3166
  # You can only invoke one Lambda function. However, this function can
@@ -2978,8 +3177,8 @@ module Aws::QBusiness
2978
3177
  # The condition used for when a Lambda function should be invoked.
2979
3178
  #
2980
3179
  # For example, you can specify a condition that if there are empty
2981
- # date-time values, then Amazon Q should invoke a function that
2982
- # inserts the current date-time.
3180
+ # date-time values, then Amazon Q Business should invoke a function
3181
+ # that inserts the current date-time.
2983
3182
  # @return [Types::DocumentAttributeCondition]
2984
3183
  #
2985
3184
  # @!attribute [rw] lambda_arn
@@ -3020,7 +3219,7 @@ module Aws::QBusiness
3020
3219
  include Aws::Structure
3021
3220
  end
3022
3221
 
3023
- # Summary information for your Amazon Q index.
3222
+ # Summary information for your Amazon Q Business index.
3024
3223
  #
3025
3224
  # @!attribute [rw] created_at
3026
3225
  # The Unix timestamp when the index was created.
@@ -3058,7 +3257,8 @@ module Aws::QBusiness
3058
3257
  # Provides information about index capacity configuration.
3059
3258
  #
3060
3259
  # @!attribute [rw] units
3061
- # The number of storage units configured for an Amazon Q index.
3260
+ # The number of storage units configured for an Amazon Q Business
3261
+ # index.
3062
3262
  # @return [Integer]
3063
3263
  #
3064
3264
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/IndexCapacityConfiguration AWS API Documentation
@@ -3085,7 +3285,7 @@ module Aws::QBusiness
3085
3285
 
3086
3286
  # Provides the configuration information for applying basic logic to
3087
3287
  # alter document metadata and content when ingesting documents into
3088
- # Amazon Q.
3288
+ # Amazon Q Business.
3089
3289
  #
3090
3290
  # To apply advanced logic, to go beyond what you can do with basic
3091
3291
  # logic, see [ `HookConfiguration` ][1].
@@ -3099,8 +3299,8 @@ module Aws::QBusiness
3099
3299
  #
3100
3300
  # @!attribute [rw] condition
3101
3301
  # The condition used for the target document attribute or metadata
3102
- # field when ingesting documents into Amazon Q. You use this with [
3103
- # `DocumentAttributeTarget` ][1] to apply the condition.
3302
+ # field when ingesting documents into Amazon Q Business. You use this
3303
+ # with [ `DocumentAttributeTarget` ][1] to apply the condition.
3104
3304
  #
3105
3305
  # For example, you can create the 'Department' target field and have
3106
3306
  # it prefill department names associated with the documents based on
@@ -3109,11 +3309,11 @@ module Aws::QBusiness
3109
3309
  # then prefill the target field 'Department' with the target value
3110
3310
  # 'Finance' for the document.
3111
3311
  #
3112
- # Amazon Q can't create a target field if it has not already been
3113
- # created as an index field. After you create your index field, you
3114
- # can create a document metadata field using
3115
- # `DocumentAttributeTarget`. Amazon Q then will map your newly created
3116
- # metadata field to your index field.
3312
+ # Amazon Q Business can't create a target field if it has not already
3313
+ # been created as an index field. After you create your index field,
3314
+ # you can create a document metadata field using
3315
+ # `DocumentAttributeTarget`. Amazon Q Business then will map your
3316
+ # newly created metadata field to your index field.
3117
3317
  #
3118
3318
  #
3119
3319
  #
@@ -3127,7 +3327,7 @@ module Aws::QBusiness
3127
3327
  #
3128
3328
  # @!attribute [rw] target
3129
3329
  # The target document attribute or metadata field you want to alter
3130
- # when ingesting documents into Amazon Q.
3330
+ # when ingesting documents into Amazon Q Business.
3131
3331
  #
3132
3332
  # For example, you can delete all customer identification numbers
3133
3333
  # associated with the documents, stored in the document metadata field
@@ -3136,11 +3336,11 @@ module Aws::QBusiness
3136
3336
  # customer ID values in the field 'Customer\_ID'. This would scrub
3137
3337
  # personally identifiable information from each document's metadata.
3138
3338
  #
3139
- # Amazon Q can't create a target field if it has not already been
3140
- # created as an index field. After you create your index field, you
3141
- # can create a document metadata field using [
3142
- # `DocumentAttributeTarget` ][1]. Amazon Q will then map your newly
3143
- # created document attribute to your index field.
3339
+ # Amazon Q Business can't create a target field if it has not already
3340
+ # been created as an index field. After you create your index field,
3341
+ # you can create a document metadata field using [
3342
+ # `DocumentAttributeTarget` ][1]. Amazon Q Business will then map your
3343
+ # newly created document attribute to your index field.
3144
3344
  #
3145
3345
  # You can also use this with [ `DocumentAttributeCondition` ][2].
3146
3346
  #
@@ -3161,8 +3361,8 @@ module Aws::QBusiness
3161
3361
  end
3162
3362
 
3163
3363
  # An issue occurred with the internal server used for your Amazon Q
3164
- # service. Wait some minutes and try again, or contact [Support][1] for
3165
- # help.
3364
+ # Business service. Wait some minutes and try again, or contact
3365
+ # [Support][1] for help.
3166
3366
  #
3167
3367
  #
3168
3368
  #
@@ -3209,14 +3409,14 @@ module Aws::QBusiness
3209
3409
  end
3210
3410
 
3211
3411
  # @!attribute [rw] max_results
3212
- # The maximum number of Amazon Q applications to return.
3412
+ # The maximum number of Amazon Q Business applications to return.
3213
3413
  # @return [Integer]
3214
3414
  #
3215
3415
  # @!attribute [rw] next_token
3216
3416
  # If the `maxResults` response was incomplete because there is more
3217
- # data to retrieve, Amazon Q returns a pagination token in the
3218
- # response. You can use this pagination token to retrieve the next set
3219
- # of Amazon Q applications.
3417
+ # data to retrieve, Amazon Q Business returns a pagination token in
3418
+ # the response. You can use this pagination token to retrieve the next
3419
+ # set of Amazon Q Business applications.
3220
3420
  # @return [String]
3221
3421
  #
3222
3422
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListApplicationsRequest AWS API Documentation
@@ -3230,13 +3430,13 @@ module Aws::QBusiness
3230
3430
 
3231
3431
  # @!attribute [rw] applications
3232
3432
  # An array of summary information on the configuration of one or more
3233
- # Amazon Q applications.
3433
+ # Amazon Q Business applications.
3234
3434
  # @return [Array<Types::Application>]
3235
3435
  #
3236
3436
  # @!attribute [rw] next_token
3237
- # If the response is truncated, Amazon Q returns this token. You can
3238
- # use this token in a subsequent request to retrieve the next set of
3239
- # applications.
3437
+ # If the response is truncated, Amazon Q Business returns this token.
3438
+ # You can use this token in a subsequent request to retrieve the next
3439
+ # set of applications.
3240
3440
  # @return [String]
3241
3441
  #
3242
3442
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListApplicationsResponse AWS API Documentation
@@ -3249,23 +3449,23 @@ module Aws::QBusiness
3249
3449
  end
3250
3450
 
3251
3451
  # @!attribute [rw] application_id
3252
- # The identifier of the Amazon Q application.
3452
+ # The identifier of the Amazon Q Business application.
3253
3453
  # @return [String]
3254
3454
  #
3255
3455
  # @!attribute [rw] max_results
3256
- # The maximum number of Amazon Q conversations to return.
3456
+ # The maximum number of Amazon Q Business conversations to return.
3257
3457
  # @return [Integer]
3258
3458
  #
3259
3459
  # @!attribute [rw] next_token
3260
3460
  # If the `maxResults` response was incomplete because there is more
3261
- # data to retrieve, Amazon Q returns a pagination token in the
3262
- # response. You can use this pagination token to retrieve the next set
3263
- # of Amazon Q conversations.
3461
+ # data to retrieve, Amazon Q Business returns a pagination token in
3462
+ # the response. You can use this pagination token to retrieve the next
3463
+ # set of Amazon Q Business conversations.
3264
3464
  # @return [String]
3265
3465
  #
3266
3466
  # @!attribute [rw] user_id
3267
- # The identifier of the user involved in the Amazon Q web experience
3268
- # conversation.
3467
+ # The identifier of the user involved in the Amazon Q Business web
3468
+ # experience conversation.
3269
3469
  # @return [String]
3270
3470
  #
3271
3471
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListConversationsRequest AWS API Documentation
@@ -3281,12 +3481,13 @@ module Aws::QBusiness
3281
3481
 
3282
3482
  # @!attribute [rw] conversations
3283
3483
  # An array of summary information on the configuration of one or more
3284
- # Amazon Q web experiences.
3484
+ # Amazon Q Business web experiences.
3285
3485
  # @return [Array<Types::Conversation>]
3286
3486
  #
3287
3487
  # @!attribute [rw] next_token
3288
- # If the response is truncated, Amazon Q returns this token, which you
3289
- # can use in a later request to list the next set of messages.
3488
+ # If the response is truncated, Amazon Q Business returns this token,
3489
+ # which you can use in a later request to list the next set of
3490
+ # messages.
3290
3491
  # @return [String]
3291
3492
  #
3292
3493
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListConversationsResponse AWS API Documentation
@@ -3299,8 +3500,8 @@ module Aws::QBusiness
3299
3500
  end
3300
3501
 
3301
3502
  # @!attribute [rw] application_id
3302
- # The identifier of the Amazon Q application connected to the data
3303
- # source.
3503
+ # The identifier of the Amazon Q Business application connected to the
3504
+ # data source.
3304
3505
  # @return [String]
3305
3506
  #
3306
3507
  # @!attribute [rw] data_source_id
@@ -3312,8 +3513,8 @@ module Aws::QBusiness
3312
3513
  # @return [Time]
3313
3514
  #
3314
3515
  # @!attribute [rw] index_id
3315
- # The identifier of the index used with the Amazon Q data source
3316
- # connector.
3516
+ # The identifier of the index used with the Amazon Q Business data
3517
+ # source connector.
3317
3518
  # @return [String]
3318
3519
  #
3319
3520
  # @!attribute [rw] max_results
@@ -3323,9 +3524,9 @@ module Aws::QBusiness
3323
3524
  #
3324
3525
  # @!attribute [rw] next_token
3325
3526
  # If the `maxResults` response was incpmplete because there is more
3326
- # data to retriever, Amazon Q returns a pagination token in the
3327
- # response. You can use this pagination token to retrieve the next set
3328
- # of responses.
3527
+ # data to retriever, Amazon Q Business returns a pagination token in
3528
+ # the response. You can use this pagination token to retrieve the next
3529
+ # set of responses.
3329
3530
  # @return [String]
3330
3531
  #
3331
3532
  # @!attribute [rw] start_time
@@ -3357,9 +3558,9 @@ module Aws::QBusiness
3357
3558
  # @return [Array<Types::DataSourceSyncJob>]
3358
3559
  #
3359
3560
  # @!attribute [rw] next_token
3360
- # If the response is truncated, Amazon Q returns this token. You can
3361
- # use this token in any subsequent request to retrieve the next set of
3362
- # jobs.
3561
+ # If the response is truncated, Amazon Q Business returns this token.
3562
+ # You can use this token in any subsequent request to retrieve the
3563
+ # next set of jobs.
3363
3564
  # @return [String]
3364
3565
  #
3365
3566
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSourceSyncJobsResponse AWS API Documentation
@@ -3372,8 +3573,8 @@ module Aws::QBusiness
3372
3573
  end
3373
3574
 
3374
3575
  # @!attribute [rw] application_id
3375
- # The identifier of the Amazon Q application linked to the data source
3376
- # connectors.
3576
+ # The identifier of the Amazon Q Business application linked to the
3577
+ # data source connectors.
3377
3578
  # @return [String]
3378
3579
  #
3379
3580
  # @!attribute [rw] index_id
@@ -3387,9 +3588,9 @@ module Aws::QBusiness
3387
3588
  #
3388
3589
  # @!attribute [rw] next_token
3389
3590
  # If the `maxResults` response was incomplete because there is more
3390
- # data to retrieve, Amazon Q returns a pagination token in the
3391
- # response. You can use this pagination token to retrieve the next set
3392
- # of Amazon Q data source connectors.
3591
+ # data to retrieve, Amazon Q Business returns a pagination token in
3592
+ # the response. You can use this pagination token to retrieve the next
3593
+ # set of Amazon Q Business data source connectors.
3393
3594
  # @return [String]
3394
3595
  #
3395
3596
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSourcesRequest AWS API Documentation
@@ -3409,9 +3610,9 @@ module Aws::QBusiness
3409
3610
  # @return [Array<Types::DataSource>]
3410
3611
  #
3411
3612
  # @!attribute [rw] next_token
3412
- # If the response is truncated, Amazon Q returns this token. You can
3413
- # use this token in a subsequent request to retrieve the next set of
3414
- # data source connectors.
3613
+ # If the response is truncated, Amazon Q Business returns this token.
3614
+ # You can use this token in a subsequent request to retrieve the next
3615
+ # set of data source connectors.
3415
3616
  # @return [String]
3416
3617
  #
3417
3618
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSourcesResponse AWS API Documentation
@@ -3441,9 +3642,9 @@ module Aws::QBusiness
3441
3642
  #
3442
3643
  # @!attribute [rw] next_token
3443
3644
  # If the `maxResults` response was incomplete because there is more
3444
- # data to retrieve, Amazon Q returns a pagination token in the
3445
- # response. You can use this pagination token to retrieve the next set
3446
- # of documents.
3645
+ # data to retrieve, Amazon Q Business returns a pagination token in
3646
+ # the response. You can use this pagination token to retrieve the next
3647
+ # set of documents.
3447
3648
  # @return [String]
3448
3649
  #
3449
3650
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDocumentsRequest AWS API Documentation
@@ -3464,9 +3665,9 @@ module Aws::QBusiness
3464
3665
  #
3465
3666
  # @!attribute [rw] next_token
3466
3667
  # If the `maxResults` response was incomplete because there is more
3467
- # data to retrieve, Amazon Q returns a pagination token in the
3468
- # response. You can use this pagination token to retrieve the next set
3469
- # of documents.
3668
+ # data to retrieve, Amazon Q Business returns a pagination token in
3669
+ # the response. You can use this pagination token to retrieve the next
3670
+ # set of documents.
3470
3671
  # @return [String]
3471
3672
  #
3472
3673
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDocumentsResponse AWS API Documentation
@@ -3499,9 +3700,9 @@ module Aws::QBusiness
3499
3700
  #
3500
3701
  # @!attribute [rw] next_token
3501
3702
  # If the previous response was incomplete (because there is more data
3502
- # to retrieve), Amazon Q returns a pagination token in the response.
3503
- # You can use this pagination token to retrieve the next set of groups
3504
- # that are mapped to users.
3703
+ # to retrieve), Amazon Q Business returns a pagination token in the
3704
+ # response. You can use this pagination token to retrieve the next set
3705
+ # of groups that are mapped to users.
3505
3706
  # @return [String]
3506
3707
  #
3507
3708
  # @!attribute [rw] updated_earlier_than
@@ -3527,9 +3728,9 @@ module Aws::QBusiness
3527
3728
  # @return [Array<Types::GroupSummary>]
3528
3729
  #
3529
3730
  # @!attribute [rw] next_token
3530
- # If the response is truncated, Amazon Q returns this token that you
3531
- # can use in the subsequent request to retrieve the next set of groups
3532
- # that are mapped to users.
3731
+ # If the response is truncated, Amazon Q Business returns this token
3732
+ # that you can use in the subsequent request to retrieve the next set
3733
+ # of groups that are mapped to users.
3533
3734
  # @return [String]
3534
3735
  #
3535
3736
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListGroupsResponse AWS API Documentation
@@ -3542,7 +3743,8 @@ module Aws::QBusiness
3542
3743
  end
3543
3744
 
3544
3745
  # @!attribute [rw] application_id
3545
- # The identifier of the Amazon Q application connected to the index.
3746
+ # The identifier of the Amazon Q Business application connected to the
3747
+ # index.
3546
3748
  # @return [String]
3547
3749
  #
3548
3750
  # @!attribute [rw] max_results
@@ -3551,9 +3753,9 @@ module Aws::QBusiness
3551
3753
  #
3552
3754
  # @!attribute [rw] next_token
3553
3755
  # If the maxResults response was incomplete because there is more data
3554
- # to retrieve, Amazon Q returns a pagination token in the response.
3555
- # You can use this pagination token to retrieve the next set of Amazon
3556
- # Q indices.
3756
+ # to retrieve, Amazon Q Business returns a pagination token in the
3757
+ # response. You can use this pagination token to retrieve the next set
3758
+ # of Amazon Q Business indices.
3557
3759
  # @return [String]
3558
3760
  #
3559
3761
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndicesRequest AWS API Documentation
@@ -3571,9 +3773,9 @@ module Aws::QBusiness
3571
3773
  # @return [Array<Types::Index>]
3572
3774
  #
3573
3775
  # @!attribute [rw] next_token
3574
- # If the response is truncated, Amazon Q returns this token that you
3575
- # can use in the subsequent request to retrieve the next set of
3576
- # indexes.
3776
+ # If the response is truncated, Amazon Q Business returns this token
3777
+ # that you can use in the subsequent request to retrieve the next set
3778
+ # of indexes.
3577
3779
  # @return [String]
3578
3780
  #
3579
3781
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndicesResponse AWS API Documentation
@@ -3586,11 +3788,11 @@ module Aws::QBusiness
3586
3788
  end
3587
3789
 
3588
3790
  # @!attribute [rw] application_id
3589
- # The identifier for the Amazon Q application.
3791
+ # The identifier for the Amazon Q Business application.
3590
3792
  # @return [String]
3591
3793
  #
3592
3794
  # @!attribute [rw] conversation_id
3593
- # The identifier of the Amazon Q web experience conversation.
3795
+ # The identifier of the Amazon Q Business web experience conversation.
3594
3796
  # @return [String]
3595
3797
  #
3596
3798
  # @!attribute [rw] max_results
@@ -3599,13 +3801,13 @@ module Aws::QBusiness
3599
3801
  #
3600
3802
  # @!attribute [rw] next_token
3601
3803
  # If the number of retrievers returned exceeds `maxResults`, Amazon Q
3602
- # returns a next token as a pagination token to retrieve the next set
3603
- # of messages.
3804
+ # Business returns a next token as a pagination token to retrieve the
3805
+ # next set of messages.
3604
3806
  # @return [String]
3605
3807
  #
3606
3808
  # @!attribute [rw] user_id
3607
- # The identifier of the user involved in the Amazon Q web experience
3608
- # conversation.
3809
+ # The identifier of the user involved in the Amazon Q Business web
3810
+ # experience conversation.
3609
3811
  # @return [String]
3610
3812
  #
3611
3813
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessagesRequest AWS API Documentation
@@ -3625,8 +3827,9 @@ module Aws::QBusiness
3625
3827
  # @return [Array<Types::Message>]
3626
3828
  #
3627
3829
  # @!attribute [rw] next_token
3628
- # If the response is truncated, Amazon Q returns this token, which you
3629
- # can use in a later request to list the next set of messages.
3830
+ # If the response is truncated, Amazon Q Business returns this token,
3831
+ # which you can use in a later request to list the next set of
3832
+ # messages.
3630
3833
  # @return [String]
3631
3834
  #
3632
3835
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessagesResponse AWS API Documentation
@@ -3648,9 +3851,9 @@ module Aws::QBusiness
3648
3851
  #
3649
3852
  # @!attribute [rw] next_token
3650
3853
  # If the `maxResults` response was incomplete because there is more
3651
- # data to retrieve, Amazon Q returns a pagination token in the
3652
- # response. You can use this pagination token to retrieve the next set
3653
- # of plugins.
3854
+ # data to retrieve, Amazon Q Business returns a pagination token in
3855
+ # the response. You can use this pagination token to retrieve the next
3856
+ # set of plugins.
3654
3857
  # @return [String]
3655
3858
  #
3656
3859
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginsRequest AWS API Documentation
@@ -3665,9 +3868,9 @@ module Aws::QBusiness
3665
3868
 
3666
3869
  # @!attribute [rw] next_token
3667
3870
  # If the `maxResults` response was incomplete because there is more
3668
- # data to retrieve, Amazon Q returns a pagination token in the
3669
- # response. You can use this pagination token to retrieve the next set
3670
- # of plugins.
3871
+ # data to retrieve, Amazon Q Business returns a pagination token in
3872
+ # the response. You can use this pagination token to retrieve the next
3873
+ # set of plugins.
3671
3874
  # @return [String]
3672
3875
  #
3673
3876
  # @!attribute [rw] plugins
@@ -3684,7 +3887,8 @@ module Aws::QBusiness
3684
3887
  end
3685
3888
 
3686
3889
  # @!attribute [rw] application_id
3687
- # The identifier of the Amazon Q application using the retriever.
3890
+ # The identifier of the Amazon Q Business application using the
3891
+ # retriever.
3688
3892
  # @return [String]
3689
3893
  #
3690
3894
  # @!attribute [rw] max_results
@@ -3693,8 +3897,8 @@ module Aws::QBusiness
3693
3897
  #
3694
3898
  # @!attribute [rw] next_token
3695
3899
  # If the number of retrievers returned exceeds `maxResults`, Amazon Q
3696
- # returns a next token as a pagination token to retrieve the next set
3697
- # of retrievers.
3900
+ # Business returns a next token as a pagination token to retrieve the
3901
+ # next set of retrievers.
3698
3902
  # @return [String]
3699
3903
  #
3700
3904
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListRetrieversRequest AWS API Documentation
@@ -3708,8 +3912,9 @@ module Aws::QBusiness
3708
3912
  end
3709
3913
 
3710
3914
  # @!attribute [rw] next_token
3711
- # If the response is truncated, Amazon Q returns this token, which you
3712
- # can use in a later request to list the next set of retrievers.
3915
+ # If the response is truncated, Amazon Q Business returns this token,
3916
+ # which you can use in a later request to list the next set of
3917
+ # retrievers.
3713
3918
  # @return [String]
3714
3919
  #
3715
3920
  # @!attribute [rw] retrievers
@@ -3726,8 +3931,8 @@ module Aws::QBusiness
3726
3931
  end
3727
3932
 
3728
3933
  # @!attribute [rw] resource_arn
3729
- # The Amazon Resource Name (ARN) of the Amazon Q application or data
3730
- # source to get a list of tags for.
3934
+ # The Amazon Resource Name (ARN) of the Amazon Q Business application
3935
+ # or data source to get a list of tags for.
3731
3936
  # @return [String]
3732
3937
  #
3733
3938
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListTagsForResourceRequest AWS API Documentation
@@ -3739,8 +3944,8 @@ module Aws::QBusiness
3739
3944
  end
3740
3945
 
3741
3946
  # @!attribute [rw] tags
3742
- # A list of tags associated with the Amazon Q application or data
3743
- # source.
3947
+ # A list of tags associated with the Amazon Q Business application or
3948
+ # data source.
3744
3949
  # @return [Array<Types::Tag>]
3745
3950
  #
3746
3951
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListTagsForResourceResponse AWS API Documentation
@@ -3752,19 +3957,19 @@ module Aws::QBusiness
3752
3957
  end
3753
3958
 
3754
3959
  # @!attribute [rw] application_id
3755
- # The identifier of the Amazon Q application linked to the listed web
3756
- # experiences.
3960
+ # The identifier of the Amazon Q Business application linked to the
3961
+ # listed web experiences.
3757
3962
  # @return [String]
3758
3963
  #
3759
3964
  # @!attribute [rw] max_results
3760
- # The maximum number of Amazon Q Web Experiences to return.
3965
+ # The maximum number of Amazon Q Business Web Experiences to return.
3761
3966
  # @return [Integer]
3762
3967
  #
3763
3968
  # @!attribute [rw] next_token
3764
3969
  # If the `maxResults` response was incomplete because there is more
3765
- # data to retrieve, Amazon Q returns a pagination token in the
3766
- # response. You can use this pagination token to retrieve the next set
3767
- # of Amazon Q conversations.
3970
+ # data to retrieve, Amazon Q Business returns a pagination token in
3971
+ # the response. You can use this pagination token to retrieve the next
3972
+ # set of Amazon Q Business conversations.
3768
3973
  # @return [String]
3769
3974
  #
3770
3975
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListWebExperiencesRequest AWS API Documentation
@@ -3778,12 +3983,13 @@ module Aws::QBusiness
3778
3983
  end
3779
3984
 
3780
3985
  # @!attribute [rw] next_token
3781
- # If the response is truncated, Amazon Q returns this token, which you
3782
- # can use in a later request to list the next set of messages.
3986
+ # If the response is truncated, Amazon Q Business returns this token,
3987
+ # which you can use in a later request to list the next set of
3988
+ # messages.
3783
3989
  # @return [String]
3784
3990
  #
3785
3991
  # @!attribute [rw] web_experiences
3786
- # An array of summary information for one or more Amazon Q
3992
+ # An array of summary information for one or more Amazon Q Business
3787
3993
  # experiences.
3788
3994
  # @return [Array<Types::WebExperience>]
3789
3995
  #
@@ -3834,43 +4040,45 @@ module Aws::QBusiness
3834
4040
  include Aws::Structure
3835
4041
  end
3836
4042
 
3837
- # A message in an Amazon Q web experience.
4043
+ # A message in an Amazon Q Business web experience.
3838
4044
  #
3839
4045
  # @!attribute [rw] action_execution
3840
- # Performs an Amazon Q plugin action during a non-streaming chat
3841
- # conversation.
4046
+ # Performs an Amazon Q Business plugin action during a non-streaming
4047
+ # chat conversation.
3842
4048
  # @return [Types::ActionExecution]
3843
4049
  #
3844
4050
  # @!attribute [rw] action_review
3845
- # An output event that Amazon Q returns to an user who wants to
3846
- # perform a plugin action during a non-streaming chat conversation. It
3847
- # contains information about the selected action with a list of
3848
- # possible user input fields, some pre-populated by Amazon Q.
4051
+ # An output event that Amazon Q Business returns to an user who wants
4052
+ # to perform a plugin action during a non-streaming chat conversation.
4053
+ # It contains information about the selected action with a list of
4054
+ # possible user input fields, some pre-populated by Amazon Q Business.
3849
4055
  # @return [Types::ActionReview]
3850
4056
  #
3851
4057
  # @!attribute [rw] attachments
3852
- # A file directly uploaded into an Amazon Q web experience chat.
4058
+ # A file directly uploaded into an Amazon Q Business web experience
4059
+ # chat.
3853
4060
  # @return [Array<Types::AttachmentOutput>]
3854
4061
  #
3855
4062
  # @!attribute [rw] body
3856
- # The content of the Amazon Q web experience message.
4063
+ # The content of the Amazon Q Business web experience message.
3857
4064
  # @return [String]
3858
4065
  #
3859
4066
  # @!attribute [rw] message_id
3860
- # The identifier of the Amazon Q web experience message.
4067
+ # The identifier of the Amazon Q Business web experience message.
3861
4068
  # @return [String]
3862
4069
  #
3863
4070
  # @!attribute [rw] source_attribution
3864
- # The source documents used to generate Amazon Q web experience
3865
- # message.
4071
+ # The source documents used to generate Amazon Q Business web
4072
+ # experience message.
3866
4073
  # @return [Array<Types::SourceAttribution>]
3867
4074
  #
3868
4075
  # @!attribute [rw] time
3869
- # The timestamp of the first Amazon Q web experience message.
4076
+ # The timestamp of the first Amazon Q Business web experience message.
3870
4077
  # @return [Time]
3871
4078
  #
3872
4079
  # @!attribute [rw] type
3873
- # The type of Amazon Q message, whether `HUMAN` or `AI` generated.
4080
+ # The type of Amazon Q Business message, whether `HUMAN` or `AI`
4081
+ # generated.
3874
4082
  # @return [String]
3875
4083
  #
3876
4084
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Message AWS API Documentation
@@ -3919,15 +4127,15 @@ module Aws::QBusiness
3919
4127
  include Aws::Structure
3920
4128
  end
3921
4129
 
3922
- # Configuration information for an Amazon Q index.
4130
+ # Configuration information for an Amazon Q Business index.
3923
4131
  #
3924
4132
  # @!attribute [rw] boosting_override
3925
- # Overrides the default boosts applied by Amazon Q to supported
3926
- # document attribute data types.
4133
+ # Overrides the default boosts applied by Amazon Q Business to
4134
+ # supported document attribute data types.
3927
4135
  # @return [Hash<String,Types::DocumentAttributeBoostingConfiguration>]
3928
4136
  #
3929
4137
  # @!attribute [rw] index_id
3930
- # The identifier for the Amazon Q index.
4138
+ # The identifier for the Amazon Q Business index.
3931
4139
  # @return [String]
3932
4140
  #
3933
4141
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/NativeIndexConfiguration AWS API Documentation
@@ -3942,7 +4150,7 @@ module Aws::QBusiness
3942
4150
  # Provides information on boosting `NUMBER` type document attributes.
3943
4151
  #
3944
4152
  # For more information on how boosting document attributes work in
3945
- # Amazon Q, see [Boosting using document attributes][1].
4153
+ # Amazon Q Business, see [Boosting using document attributes][1].
3946
4154
  #
3947
4155
  #
3948
4156
  #
@@ -3970,8 +4178,8 @@ module Aws::QBusiness
3970
4178
  # to configure a plugin.
3971
4179
  #
3972
4180
  # @!attribute [rw] role_arn
3973
- # The ARN of an IAM role used by Amazon Q to access the OAuth 2.0
3974
- # authentication credentials stored in a Secrets Manager secret.
4181
+ # The ARN of an IAM role used by Amazon Q Business to access the OAuth
4182
+ # 2.0 authentication credentials stored in a Secrets Manager secret.
3975
4183
  # @return [String]
3976
4184
  #
3977
4185
  # @!attribute [rw] secret_arn
@@ -3988,7 +4196,7 @@ module Aws::QBusiness
3988
4196
  include Aws::Structure
3989
4197
  end
3990
4198
 
3991
- # Information about an Amazon Q plugin and its configuration.
4199
+ # Information about an Amazon Q Business plugin and its configuration.
3992
4200
  #
3993
4201
  # @!attribute [rw] created_at
3994
4202
  # The timestamp for when the plugin was created.
@@ -4032,7 +4240,8 @@ module Aws::QBusiness
4032
4240
  include Aws::Structure
4033
4241
  end
4034
4242
 
4035
- # Authentication configuration information for an Amazon Q plugin.
4243
+ # Authentication configuration information for an Amazon Q Business
4244
+ # plugin.
4036
4245
  #
4037
4246
  # @note PluginAuthConfiguration is a union - when making an API calls you must set exactly one of the members.
4038
4247
  #
@@ -4063,8 +4272,31 @@ module Aws::QBusiness
4063
4272
  class Unknown < PluginAuthConfiguration; end
4064
4273
  end
4065
4274
 
4275
+ # Configuration information required to invoke chat in `PLUGIN_MODE`.
4276
+ #
4277
+ # For more information, see [Admin controls and guardrails][1],
4278
+ # [Plugins][2], and [Conversation settings][3].
4279
+ #
4280
+ #
4281
+ #
4282
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html
4283
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html
4284
+ # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope
4285
+ #
4286
+ # @!attribute [rw] plugin_id
4287
+ # The identifier of the plugin you want to use.
4288
+ # @return [String]
4289
+ #
4290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PluginConfiguration AWS API Documentation
4291
+ #
4292
+ class PluginConfiguration < Struct.new(
4293
+ :plugin_id)
4294
+ SENSITIVE = []
4295
+ include Aws::Structure
4296
+ end
4297
+
4066
4298
  # Provides user and group information used for filtering documents to
4067
- # use for generating Amazon Q conversation responses.
4299
+ # use for generating Amazon Q Business conversation responses.
4068
4300
  #
4069
4301
  # @note Principal is a union - when making an API calls you must set exactly one of the members.
4070
4302
  #
@@ -4196,8 +4428,8 @@ module Aws::QBusiness
4196
4428
  #
4197
4429
  # @!attribute [rw] group_members
4198
4430
  # A list of users or sub groups that belong to a group. This is for
4199
- # generating Amazon Q chat results only from document a user has
4200
- # access to.
4431
+ # generating Amazon Q Business chat results only from document a user
4432
+ # has access to.
4201
4433
  # @return [Types::GroupMembers]
4202
4434
  #
4203
4435
  # @!attribute [rw] group_name
@@ -4264,11 +4496,12 @@ module Aws::QBusiness
4264
4496
  include Aws::Structure
4265
4497
  end
4266
4498
 
4267
- # Summary information for the retriever used for your Amazon Q
4499
+ # Summary information for the retriever used for your Amazon Q Business
4268
4500
  # application.
4269
4501
  #
4270
4502
  # @!attribute [rw] application_id
4271
- # The identifier of the Amazon Q application using the retriever.
4503
+ # The identifier of the Amazon Q Business application using the
4504
+ # retriever.
4272
4505
  # @return [String]
4273
4506
  #
4274
4507
  # @!attribute [rw] display_name
@@ -4276,7 +4509,8 @@ module Aws::QBusiness
4276
4509
  # @return [String]
4277
4510
  #
4278
4511
  # @!attribute [rw] retriever_id
4279
- # The identifier of the retriever used by your Amazon Q application.
4512
+ # The identifier of the retriever used by your Amazon Q Business
4513
+ # application.
4280
4514
  # @return [String]
4281
4515
  #
4282
4516
  # @!attribute [rw] status
@@ -4300,7 +4534,7 @@ module Aws::QBusiness
4300
4534
  end
4301
4535
 
4302
4536
  # Provides information on how the retriever used for your Amazon Q
4303
- # application is configured.
4537
+ # Business application is configured.
4304
4538
  #
4305
4539
  # @note RetrieverConfiguration is a union - when making an API calls you must set exactly one of the members.
4306
4540
  #
@@ -4308,12 +4542,12 @@ module Aws::QBusiness
4308
4542
  #
4309
4543
  # @!attribute [rw] kendra_index_configuration
4310
4544
  # Provides information on how the Amazon Kendra index used as a
4311
- # retriever for your Amazon Q application is configured.
4545
+ # retriever for your Amazon Q Business application is configured.
4312
4546
  # @return [Types::KendraIndexConfiguration]
4313
4547
  #
4314
4548
  # @!attribute [rw] native_index_configuration
4315
- # Provides information on how a Amazon Q index used as a retriever for
4316
- # your Amazon Q application is configured.
4549
+ # Provides information on how a Amazon Q Business index used as a
4550
+ # retriever for your Amazon Q Business application is configured.
4317
4551
  # @return [Types::NativeIndexConfiguration]
4318
4552
  #
4319
4553
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/RetrieverConfiguration AWS API Documentation
@@ -4331,8 +4565,8 @@ module Aws::QBusiness
4331
4565
  class Unknown < RetrieverConfiguration; end
4332
4566
  end
4333
4567
 
4334
- # Guardrail rules for an Amazon Q application. Amazon Q supports only
4335
- # one rule at a time.
4568
+ # Guardrail rules for an Amazon Q Business application. Amazon Q
4569
+ # Business supports only one rule at a time.
4336
4570
  #
4337
4571
  # @!attribute [rw] excluded_users_and_groups
4338
4572
  # Users and groups to be excluded from a rule.
@@ -4368,13 +4602,13 @@ module Aws::QBusiness
4368
4602
  # @note RuleConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleConfiguration corresponding to the set member.
4369
4603
  #
4370
4604
  # @!attribute [rw] content_blocker_rule
4371
- # A rule for configuring how Amazon Q responds when it encounters a a
4372
- # blocked topic.
4605
+ # A rule for configuring how Amazon Q Business responds when it
4606
+ # encounters a a blocked topic.
4373
4607
  # @return [Types::ContentBlockerRule]
4374
4608
  #
4375
4609
  # @!attribute [rw] content_retrieval_rule
4376
4610
  # Rules for retrieving content from data sources connected to a Amazon
4377
- # Q application for a specific topic control configuration.
4611
+ # Q Business application for a specific topic control configuration.
4378
4612
  # @return [Types::ContentRetrievalRule]
4379
4613
  #
4380
4614
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/RuleConfiguration AWS API Documentation
@@ -4392,8 +4626,8 @@ module Aws::QBusiness
4392
4626
  class Unknown < RuleConfiguration; end
4393
4627
  end
4394
4628
 
4395
- # Information required for Amazon Q to find a specific file in an Amazon
4396
- # S3 bucket.
4629
+ # Information required for Amazon Q Business to find a specific file in
4630
+ # an Amazon S3 bucket.
4397
4631
  #
4398
4632
  # @!attribute [rw] bucket
4399
4633
  # The name of the S3 bucket that contains the file.
@@ -4413,7 +4647,8 @@ module Aws::QBusiness
4413
4647
  end
4414
4648
 
4415
4649
  # Provides the SAML 2.0 compliant identity provider (IdP) configuration
4416
- # information Amazon Q needs to deploy a Amazon Q web experience.
4650
+ # information Amazon Q Business needs to deploy a Amazon Q Business web
4651
+ # experience.
4417
4652
  #
4418
4653
  # @!attribute [rw] metadata_xml
4419
4654
  # The metadata XML that your IdP generated.
@@ -4421,8 +4656,9 @@ module Aws::QBusiness
4421
4656
  #
4422
4657
  # @!attribute [rw] role_arn
4423
4658
  # The Amazon Resource Name (ARN) of an IAM role assumed by users when
4424
- # they authenticate into their Amazon Q web experience, containing the
4425
- # relevant Amazon Q permissions for conversing with Amazon Q.
4659
+ # they authenticate into their Amazon Q Business web experience,
4660
+ # containing the relevant Amazon Q Business permissions for conversing
4661
+ # with Amazon Q Business.
4426
4662
  # @return [String]
4427
4663
  #
4428
4664
  # @!attribute [rw] user_group_attribute
@@ -4444,7 +4680,7 @@ module Aws::QBusiness
4444
4680
  include Aws::Structure
4445
4681
  end
4446
4682
 
4447
- # You have exceeded the set limits for your Amazon Q service.
4683
+ # You have exceeded the set limits for your Amazon Q Business service.
4448
4684
  #
4449
4685
  # @!attribute [rw] message
4450
4686
  # The message describing a `ServiceQuotaExceededException`.
@@ -4468,10 +4704,12 @@ module Aws::QBusiness
4468
4704
  include Aws::Structure
4469
4705
  end
4470
4706
 
4471
- # The documents used to generate an Amazon Q web experience response.
4707
+ # The documents used to generate an Amazon Q Business web experience
4708
+ # response.
4472
4709
  #
4473
4710
  # @!attribute [rw] citation_number
4474
- # The number attached to a citation in an Amazon Q generated response.
4711
+ # The number attached to a citation in an Amazon Q Business generated
4712
+ # response.
4475
4713
  # @return [Integer]
4476
4714
  #
4477
4715
  # @!attribute [rw] snippet
@@ -4486,16 +4724,17 @@ module Aws::QBusiness
4486
4724
  #
4487
4725
  # @!attribute [rw] title
4488
4726
  # The title of the document which is the source for the Amazon Q
4489
- # generated response.
4727
+ # Business generated response.
4490
4728
  # @return [String]
4491
4729
  #
4492
4730
  # @!attribute [rw] updated_at
4493
- # The Unix timestamp when the Amazon Q application was last updated.
4731
+ # The Unix timestamp when the Amazon Q Business application was last
4732
+ # updated.
4494
4733
  # @return [Time]
4495
4734
  #
4496
4735
  # @!attribute [rw] url
4497
4736
  # The URL of the document which is the source for the Amazon Q
4498
- # generated response.
4737
+ # Business generated response.
4499
4738
  # @return [String]
4500
4739
  #
4501
4740
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SourceAttribution AWS API Documentation
@@ -4512,8 +4751,8 @@ module Aws::QBusiness
4512
4751
  end
4513
4752
 
4514
4753
  # @!attribute [rw] application_id
4515
- # The identifier of Amazon Q application the data source is connected
4516
- # to.
4754
+ # The identifier of Amazon Q Business application the data source is
4755
+ # connected to.
4517
4756
  # @return [String]
4518
4757
  #
4519
4758
  # @!attribute [rw] data_source_id
@@ -4547,8 +4786,8 @@ module Aws::QBusiness
4547
4786
  end
4548
4787
 
4549
4788
  # @!attribute [rw] application_id
4550
- # The identifier of the Amazon Q application that the data source is
4551
- # connected to.
4789
+ # The identifier of the Amazon Q Business application that the data
4790
+ # source is connected to.
4552
4791
  # @return [String]
4553
4792
  #
4554
4793
  # @!attribute [rw] data_source_id
@@ -4556,8 +4795,8 @@ module Aws::QBusiness
4556
4795
  # @return [String]
4557
4796
  #
4558
4797
  # @!attribute [rw] index_id
4559
- # The identifier of the index used with the Amazon Q data source
4560
- # connector.
4798
+ # The identifier of the index used with the Amazon Q Business data
4799
+ # source connector.
4561
4800
  # @return [String]
4562
4801
  #
4563
4802
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StopDataSourceSyncJobRequest AWS API Documentation
@@ -4586,7 +4825,7 @@ module Aws::QBusiness
4586
4825
  # </note>
4587
4826
  #
4588
4827
  # For more information on how boosting document attributes work in
4589
- # Amazon Q, see [Boosting using document attributes][3].
4828
+ # Amazon Q Business, see [Boosting using document attributes][3].
4590
4829
  #
4591
4830
  #
4592
4831
  #
@@ -4625,7 +4864,7 @@ module Aws::QBusiness
4625
4864
  # </note>
4626
4865
  #
4627
4866
  # For more information on how boosting document attributes work in
4628
- # Amazon Q, see [Boosting using document attributes][3].
4867
+ # Amazon Q Business, see [Boosting using document attributes][3].
4629
4868
  #
4630
4869
  #
4631
4870
  #
@@ -4651,7 +4890,7 @@ module Aws::QBusiness
4651
4890
  #
4652
4891
  # @!attribute [rw] key
4653
4892
  # The key for the tag. Keys are not case sensitive and must be unique
4654
- # for the Amazon Q application or data source.
4893
+ # for the Amazon Q Business application or data source.
4655
4894
  # @return [String]
4656
4895
  #
4657
4896
  # @!attribute [rw] value
@@ -4669,14 +4908,14 @@ module Aws::QBusiness
4669
4908
  end
4670
4909
 
4671
4910
  # @!attribute [rw] resource_arn
4672
- # The Amazon Resource Name (ARN) of the Amazon Q application or data
4673
- # source to tag.
4911
+ # The Amazon Resource Name (ARN) of the Amazon Q Business application
4912
+ # or data source to tag.
4674
4913
  # @return [String]
4675
4914
  #
4676
4915
  # @!attribute [rw] tags
4677
- # A list of tag keys to add to the Amazon Q application or data
4678
- # source. If a tag already exists, the existing value is replaced with
4679
- # the new value.
4916
+ # A list of tag keys to add to the Amazon Q Business application or
4917
+ # data source. If a tag already exists, the existing value is replaced
4918
+ # with the new value.
4680
4919
  # @return [Array<Types::Tag>]
4681
4920
  #
4682
4921
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/TagResourceRequest AWS API Documentation
@@ -4747,7 +4986,8 @@ module Aws::QBusiness
4747
4986
  include Aws::Structure
4748
4987
  end
4749
4988
 
4750
- # The topic specific controls configured for an Amazon Q application.
4989
+ # The topic specific controls configured for an Amazon Q Business
4990
+ # application.
4751
4991
  #
4752
4992
  # @!attribute [rw] description
4753
4993
  # A description for your topic control configuration. Use this to
@@ -4780,13 +5020,14 @@ module Aws::QBusiness
4780
5020
  end
4781
5021
 
4782
5022
  # @!attribute [rw] resource_arn
4783
- # The Amazon Resource Name (ARN) of the Amazon Q application, or data
4784
- # source to remove the tag from.
5023
+ # The Amazon Resource Name (ARN) of the Amazon Q Business application,
5024
+ # or data source to remove the tag from.
4785
5025
  # @return [String]
4786
5026
  #
4787
5027
  # @!attribute [rw] tag_keys
4788
- # A list of tag keys to remove from the Amazon Q application or data
4789
- # source. If a tag key does not exist on the resource, it is ignored.
5028
+ # A list of tag keys to remove from the Amazon Q Business application
5029
+ # or data source. If a tag key does not exist on the resource, it is
5030
+ # ignored.
4790
5031
  # @return [Array<String>]
4791
5032
  #
4792
5033
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UntagResourceRequest AWS API Documentation
@@ -4803,7 +5044,7 @@ module Aws::QBusiness
4803
5044
  class UntagResourceResponse < Aws::EmptyStructure; end
4804
5045
 
4805
5046
  # @!attribute [rw] application_id
4806
- # The identifier of the Amazon Q application.
5047
+ # The identifier of the Amazon Q Business application.
4807
5048
  # @return [String]
4808
5049
  #
4809
5050
  # @!attribute [rw] attachments_configuration
@@ -4811,17 +5052,17 @@ module Aws::QBusiness
4811
5052
  # @return [Types::AttachmentsConfiguration]
4812
5053
  #
4813
5054
  # @!attribute [rw] description
4814
- # A description for the Amazon Q application.
5055
+ # A description for the Amazon Q Business application.
4815
5056
  # @return [String]
4816
5057
  #
4817
5058
  # @!attribute [rw] display_name
4818
- # A name for the Amazon Q application.
5059
+ # A name for the Amazon Q Business application.
4819
5060
  # @return [String]
4820
5061
  #
4821
5062
  # @!attribute [rw] role_arn
4822
5063
  # An Amazon Web Services Identity and Access Management (IAM) role
4823
- # that gives Amazon Q permission to access Amazon CloudWatch logs and
4824
- # metrics.
5064
+ # that gives Amazon Q Business permission to access Amazon CloudWatch
5065
+ # logs and metrics.
4825
5066
  # @return [String]
4826
5067
  #
4827
5068
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateApplicationRequest AWS API Documentation
@@ -4851,12 +5092,16 @@ module Aws::QBusiness
4851
5092
  #
4852
5093
  # @!attribute [rw] client_token
4853
5094
  # A token that you provide to identify the request to update a Amazon
4854
- # Q application chat configuration.
5095
+ # Q Business application chat configuration.
4855
5096
  #
4856
5097
  # **A suitable default value is auto-generated.** You should normally
4857
5098
  # not need to pass this option.
4858
5099
  # @return [String]
4859
5100
  #
5101
+ # @!attribute [rw] creator_mode_configuration
5102
+ # The configuration details for `CREATOR_MODE`.
5103
+ # @return [Types::CreatorModeConfiguration]
5104
+ #
4860
5105
  # @!attribute [rw] response_scope
4861
5106
  # The response scope configured for your application. This determines
4862
5107
  # whether your application uses its retrieval augmented generation
@@ -4879,6 +5124,7 @@ module Aws::QBusiness
4879
5124
  :application_id,
4880
5125
  :blocked_phrases_configuration_update,
4881
5126
  :client_token,
5127
+ :creator_mode_configuration,
4882
5128
  :response_scope,
4883
5129
  :topic_configurations_to_create_or_update,
4884
5130
  :topic_configurations_to_delete)
@@ -4891,12 +5137,13 @@ module Aws::QBusiness
4891
5137
  class UpdateChatControlsConfigurationResponse < Aws::EmptyStructure; end
4892
5138
 
4893
5139
  # @!attribute [rw] application_id
4894
- # The identifier of the Amazon Q application the data source is
4895
- # attached to.
5140
+ # The identifier of the Amazon Q Business application the data source
5141
+ # is attached to.
4896
5142
  # @return [String]
4897
5143
  #
4898
5144
  # @!attribute [rw] configuration
4899
- # Provides the configuration information for an Amazon Q data source.
5145
+ # Provides the configuration information for an Amazon Q Business data
5146
+ # source.
4900
5147
  # @return [Hash,Array,String,Numeric,Boolean]
4901
5148
  #
4902
5149
  # @!attribute [rw] data_source_id
@@ -4962,20 +5209,22 @@ module Aws::QBusiness
4962
5209
  class UpdateDataSourceResponse < Aws::EmptyStructure; end
4963
5210
 
4964
5211
  # @!attribute [rw] application_id
4965
- # The identifier of the Amazon Q application connected to the index.
5212
+ # The identifier of the Amazon Q Business application connected to the
5213
+ # index.
4966
5214
  # @return [String]
4967
5215
  #
4968
5216
  # @!attribute [rw] capacity_configuration
4969
5217
  # The storage capacity units you want to provision for your Amazon Q
4970
- # index. You can add and remove capacity to fit your usage needs.
5218
+ # Business index. You can add and remove capacity to fit your usage
5219
+ # needs.
4971
5220
  # @return [Types::IndexCapacityConfiguration]
4972
5221
  #
4973
5222
  # @!attribute [rw] description
4974
- # The description of the Amazon Q index.
5223
+ # The description of the Amazon Q Business index.
4975
5224
  # @return [String]
4976
5225
  #
4977
5226
  # @!attribute [rw] display_name
4978
- # The name of the Amazon Q index.
5227
+ # The name of the Amazon Q Business index.
4979
5228
  # @return [String]
4980
5229
  #
4981
5230
  # @!attribute [rw] document_attribute_configurations
@@ -4991,7 +5240,7 @@ module Aws::QBusiness
4991
5240
  # @return [Array<Types::DocumentAttributeConfiguration>]
4992
5241
  #
4993
5242
  # @!attribute [rw] index_id
4994
- # The identifier of the Amazon Q index.
5243
+ # The identifier of the Amazon Q Business index.
4995
5244
  # @return [String]
4996
5245
  #
4997
5246
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateIndexRequest AWS API Documentation
@@ -5053,12 +5302,12 @@ module Aws::QBusiness
5053
5302
  class UpdatePluginResponse < Aws::EmptyStructure; end
5054
5303
 
5055
5304
  # @!attribute [rw] application_id
5056
- # The identifier of your Amazon Q application.
5305
+ # The identifier of your Amazon Q Business application.
5057
5306
  # @return [String]
5058
5307
  #
5059
5308
  # @!attribute [rw] configuration
5060
5309
  # Provides information on how the retriever used for your Amazon Q
5061
- # application is configured.
5310
+ # Business application is configured.
5062
5311
  # @return [Types::RetrieverConfiguration]
5063
5312
  #
5064
5313
  # @!attribute [rw] display_name
@@ -5140,12 +5389,13 @@ module Aws::QBusiness
5140
5389
  end
5141
5390
 
5142
5391
  # @!attribute [rw] application_id
5143
- # The identifier of the Amazon Q application attached to the web
5144
- # experience.
5392
+ # The identifier of the Amazon Q Business application attached to the
5393
+ # web experience.
5145
5394
  # @return [String]
5146
5395
  #
5147
5396
  # @!attribute [rw] authentication_configuration
5148
- # The authentication configuration of the Amazon Q web experience.
5397
+ # The authentication configuration of the Amazon Q Business web
5398
+ # experience.
5149
5399
  # @return [Types::WebExperienceAuthConfiguration]
5150
5400
  #
5151
5401
  # @!attribute [rw] sample_prompts_control_mode
@@ -5154,20 +5404,20 @@ module Aws::QBusiness
5154
5404
  # @return [String]
5155
5405
  #
5156
5406
  # @!attribute [rw] subtitle
5157
- # The subtitle of the Amazon Q web experience.
5407
+ # The subtitle of the Amazon Q Business web experience.
5158
5408
  # @return [String]
5159
5409
  #
5160
5410
  # @!attribute [rw] title
5161
- # The title of the Amazon Q web experience.
5411
+ # The title of the Amazon Q Business web experience.
5162
5412
  # @return [String]
5163
5413
  #
5164
5414
  # @!attribute [rw] web_experience_id
5165
- # The identifier of the Amazon Q web experience.
5415
+ # The identifier of the Amazon Q Business web experience.
5166
5416
  # @return [String]
5167
5417
  #
5168
5418
  # @!attribute [rw] welcome_message
5169
- # A customized welcome message for an end user in an Amazon Q web
5170
- # experience.
5419
+ # A customized welcome message for an end user in an Amazon Q Business
5420
+ # web experience.
5171
5421
  # @return [String]
5172
5422
  #
5173
5423
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperienceRequest AWS API Documentation
@@ -5188,7 +5438,7 @@ module Aws::QBusiness
5188
5438
  #
5189
5439
  class UpdateWebExperienceResponse < Aws::EmptyStructure; end
5190
5440
 
5191
- # Aliases attached to a user id within an Amazon Q application.
5441
+ # Aliases attached to a user id within an Amazon Q Business application.
5192
5442
  #
5193
5443
  # @!attribute [rw] data_source_id
5194
5444
  # The identifier of the data source that the user aliases are
@@ -5234,8 +5484,8 @@ module Aws::QBusiness
5234
5484
  include Aws::Structure
5235
5485
  end
5236
5486
 
5237
- # The input doesn't meet the constraints set by the Amazon Q service.
5238
- # Provide the correct input and try again.
5487
+ # The input doesn't meet the constraints set by the Amazon Q Business
5488
+ # service. Provide the correct input and try again.
5239
5489
  #
5240
5490
  # @!attribute [rw] fields
5241
5491
  # The input field(s) that failed validation.
@@ -5259,8 +5509,8 @@ module Aws::QBusiness
5259
5509
  include Aws::Structure
5260
5510
  end
5261
5511
 
5262
- # The input failed to meet the constraints specified by Amazon Q in a
5263
- # specified field.
5512
+ # The input failed to meet the constraints specified by Amazon Q
5513
+ # Business in a specified field.
5264
5514
  #
5265
5515
  # @!attribute [rw] message
5266
5516
  # A message about the validation exception.
@@ -5279,27 +5529,29 @@ module Aws::QBusiness
5279
5529
  include Aws::Structure
5280
5530
  end
5281
5531
 
5282
- # Provides information for an Amazon Q web experience.
5532
+ # Provides information for an Amazon Q Business web experience.
5283
5533
  #
5284
5534
  # @!attribute [rw] created_at
5285
- # The Unix timestamp when the Amazon Q application was last updated.
5535
+ # The Unix timestamp when the Amazon Q Business application was last
5536
+ # updated.
5286
5537
  # @return [Time]
5287
5538
  #
5288
5539
  # @!attribute [rw] default_endpoint
5289
- # The endpoint URLs for your Amazon Q web experience. The URLs are
5290
- # unique and fully hosted by Amazon Web Services.
5540
+ # The endpoint URLs for your Amazon Q Business web experience. The
5541
+ # URLs are unique and fully hosted by Amazon Web Services.
5291
5542
  # @return [String]
5292
5543
  #
5293
5544
  # @!attribute [rw] status
5294
- # The status of your Amazon Q web experience.
5545
+ # The status of your Amazon Q Business web experience.
5295
5546
  # @return [String]
5296
5547
  #
5297
5548
  # @!attribute [rw] updated_at
5298
- # The Unix timestamp when your Amazon Q web experience was updated.
5549
+ # The Unix timestamp when your Amazon Q Business web experience was
5550
+ # updated.
5299
5551
  # @return [Time]
5300
5552
  #
5301
5553
  # @!attribute [rw] web_experience_id
5302
- # The identifier of your Amazon Q web experience.
5554
+ # The identifier of your Amazon Q Business web experience.
5303
5555
  # @return [String]
5304
5556
  #
5305
5557
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/WebExperience AWS API Documentation
@@ -5315,7 +5567,7 @@ module Aws::QBusiness
5315
5567
  end
5316
5568
 
5317
5569
  # Provides the authorization configuration information needed to deploy
5318
- # a Amazon Q web experience to end users.
5570
+ # a Amazon Q Business web experience to end users.
5319
5571
  #
5320
5572
  # @note WebExperienceAuthConfiguration is a union - when making an API calls you must set exactly one of the members.
5321
5573
  #
@@ -5323,8 +5575,8 @@ module Aws::QBusiness
5323
5575
  #
5324
5576
  # @!attribute [rw] saml_configuration
5325
5577
  # Provides the SAML 2.0 compliant identity provider (IdP)
5326
- # configuration information Amazon Q needs to deploy a Amazon Q web
5327
- # experience.
5578
+ # configuration information Amazon Q Business needs to deploy a Amazon
5579
+ # Q Business web experience.
5328
5580
  # @return [Types::SamlConfiguration]
5329
5581
  #
5330
5582
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/WebExperienceAuthConfiguration AWS API Documentation