aws-sdk-qbusiness 1.1.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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
@@ -312,8 +341,8 @@ module Aws::QBusiness
312
341
  include Aws::Structure
313
342
  end
314
343
 
315
- # Enables filtering of Amazon Q web experience responses based on
316
- # document attributes or metadata fields.
344
+ # Enables filtering of responses based on document attributes or
345
+ # metadata fields.
317
346
  #
318
347
  # @!attribute [rw] and_all_filters
319
348
  # Performs a logical `AND` operation on all supplied filters.
@@ -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
@@ -1386,8 +1553,35 @@ module Aws::QBusiness
1386
1553
  include Aws::Structure
1387
1554
  end
1388
1555
 
1556
+ # Provides information on boosting `DATE` type document attributes.
1557
+ #
1558
+ # For more information on how boosting document attributes work in
1559
+ # Amazon Q Business, see [Boosting using document attributes][1].
1560
+ #
1561
+ #
1562
+ #
1563
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
1564
+ #
1565
+ # @!attribute [rw] boosting_duration_in_seconds
1566
+ # Specifies the duration, in seconds, of a boost applies to a `DATE`
1567
+ # type document attribute.
1568
+ # @return [Integer]
1569
+ #
1570
+ # @!attribute [rw] boosting_level
1571
+ # Specifies how much a document attribute is boosted.
1572
+ # @return [String]
1573
+ #
1574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DateAttributeBoostingConfiguration AWS API Documentation
1575
+ #
1576
+ class DateAttributeBoostingConfiguration < Struct.new(
1577
+ :boosting_duration_in_seconds,
1578
+ :boosting_level)
1579
+ SENSITIVE = []
1580
+ include Aws::Structure
1581
+ end
1582
+
1389
1583
  # @!attribute [rw] application_id
1390
- # The identifier of the Amazon Q application.
1584
+ # The identifier of the Amazon Q Business application.
1391
1585
  # @return [String]
1392
1586
  #
1393
1587
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteApplicationRequest AWS API Documentation
@@ -1420,13 +1614,13 @@ module Aws::QBusiness
1420
1614
  class DeleteChatControlsConfigurationResponse < Aws::EmptyStructure; end
1421
1615
 
1422
1616
  # @!attribute [rw] application_id
1423
- # The identifier of the Amazon Q application associated with the
1424
- # conversation.
1617
+ # The identifier of the Amazon Q Business application associated with
1618
+ # the conversation.
1425
1619
  # @return [String]
1426
1620
  #
1427
1621
  # @!attribute [rw] conversation_id
1428
- # The identifier of the Amazon Q web experience conversation being
1429
- # deleted.
1622
+ # The identifier of the Amazon Q Business web experience conversation
1623
+ # being deleted.
1430
1624
  # @return [String]
1431
1625
  #
1432
1626
  # @!attribute [rw] user_id
@@ -1448,8 +1642,8 @@ module Aws::QBusiness
1448
1642
  class DeleteConversationResponse < Aws::EmptyStructure; end
1449
1643
 
1450
1644
  # @!attribute [rw] application_id
1451
- # The identifier of the Amazon Q application used with the data source
1452
- # connector.
1645
+ # The identifier of the Amazon Q Business application used with the
1646
+ # data source connector.
1453
1647
  # @return [String]
1454
1648
  #
1455
1649
  # @!attribute [rw] data_source_id
@@ -1474,7 +1668,7 @@ module Aws::QBusiness
1474
1668
  #
1475
1669
  class DeleteDataSourceResponse < Aws::EmptyStructure; end
1476
1670
 
1477
- # A document deleted from an Amazon Q data source connector.
1671
+ # A document deleted from an Amazon Q Business data source connector.
1478
1672
  #
1479
1673
  # @!attribute [rw] document_id
1480
1674
  # The identifier of the deleted document.
@@ -1531,12 +1725,12 @@ module Aws::QBusiness
1531
1725
  class DeleteGroupResponse < Aws::EmptyStructure; end
1532
1726
 
1533
1727
  # @!attribute [rw] application_id
1534
- # The identifier of the Amazon Q application the Amazon Q index is
1535
- # linked to.
1728
+ # The identifier of the Amazon Q Business application the Amazon Q
1729
+ # Business index is linked to.
1536
1730
  # @return [String]
1537
1731
  #
1538
1732
  # @!attribute [rw] index_id
1539
- # The identifier of the Amazon Q index.
1733
+ # The identifier of the Amazon Q Business index.
1540
1734
  # @return [String]
1541
1735
  #
1542
1736
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteIndexRequest AWS API Documentation
@@ -1553,7 +1747,8 @@ module Aws::QBusiness
1553
1747
  class DeleteIndexResponse < Aws::EmptyStructure; end
1554
1748
 
1555
1749
  # @!attribute [rw] application_id
1556
- # The identifier the application attached to the Amazon Q plugin.
1750
+ # The identifier the application attached to the Amazon Q Business
1751
+ # plugin.
1557
1752
  # @return [String]
1558
1753
  #
1559
1754
  # @!attribute [rw] plugin_id
@@ -1574,7 +1769,8 @@ module Aws::QBusiness
1574
1769
  class DeletePluginResponse < Aws::EmptyStructure; end
1575
1770
 
1576
1771
  # @!attribute [rw] application_id
1577
- # The identifier of the Amazon Q application using the retriever.
1772
+ # The identifier of the Amazon Q Business application using the
1773
+ # retriever.
1578
1774
  # @return [String]
1579
1775
  #
1580
1776
  # @!attribute [rw] retriever_id
@@ -1617,12 +1813,13 @@ module Aws::QBusiness
1617
1813
  class DeleteUserResponse < Aws::EmptyStructure; end
1618
1814
 
1619
1815
  # @!attribute [rw] application_id
1620
- # The identifier of the Amazon Q application linked to the Amazon Q
1621
- # web experience.
1816
+ # The identifier of the Amazon Q Business application linked to the
1817
+ # Amazon Q Business web experience.
1622
1818
  # @return [String]
1623
1819
  #
1624
1820
  # @!attribute [rw] web_experience_id
1625
- # The identifier of the Amazon Q web experience being deleted.
1821
+ # The identifier of the Amazon Q Business web experience being
1822
+ # deleted.
1626
1823
  # @return [String]
1627
1824
  #
1628
1825
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteWebExperienceRequest AWS API Documentation
@@ -1638,15 +1835,15 @@ module Aws::QBusiness
1638
1835
  #
1639
1836
  class DeleteWebExperienceResponse < Aws::EmptyStructure; end
1640
1837
 
1641
- # A document in an Amazon Q application.
1838
+ # A document in an Amazon Q Business application.
1642
1839
  #
1643
1840
  # @!attribute [rw] access_configuration
1644
1841
  # Configuration information for access permission to a document.
1645
1842
  # @return [Types::AccessConfiguration]
1646
1843
  #
1647
1844
  # @!attribute [rw] attributes
1648
- # Custom attributes to apply to the document for refining Amazon Q web
1649
- # experience responses.
1845
+ # Custom attributes to apply to the document for refining Amazon Q
1846
+ # Business web experience responses.
1650
1847
  # @return [Array<Types::DocumentAttribute>]
1651
1848
  #
1652
1849
  # @!attribute [rw] content
@@ -1707,8 +1904,72 @@ module Aws::QBusiness
1707
1904
  include Aws::Structure
1708
1905
  end
1709
1906
 
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.
1912
+ #
1913
+ # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
1914
+ # boosting on the console and the API, they must be enabled for search
1915
+ # using the [DocumentAttributeConfiguration][1] object of the
1916
+ # [UpdateIndex][2] API. If you haven't enabled searching on these
1917
+ # attributes, you can't boost attributes of these data types on either
1918
+ # the console or the API.
1919
+ #
1920
+ # </note>
1921
+ #
1922
+ # For more information on how boosting document attributes work in
1923
+ # Amazon Q Business, see [Boosting using document attributes][3].
1924
+ #
1925
+ #
1926
+ #
1927
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html
1928
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html
1929
+ # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
1930
+ #
1931
+ # @note DocumentAttributeBoostingConfiguration is a union - when making an API calls you must set exactly one of the members.
1932
+ #
1933
+ # @note DocumentAttributeBoostingConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DocumentAttributeBoostingConfiguration corresponding to the set member.
1934
+ #
1935
+ # @!attribute [rw] date_configuration
1936
+ # Provides information on boosting `DATE` type document attributes.
1937
+ # @return [Types::DateAttributeBoostingConfiguration]
1938
+ #
1939
+ # @!attribute [rw] number_configuration
1940
+ # Provides information on boosting `NUMBER` type document attributes.
1941
+ # @return [Types::NumberAttributeBoostingConfiguration]
1942
+ #
1943
+ # @!attribute [rw] string_configuration
1944
+ # Provides information on boosting `STRING` type document attributes.
1945
+ # @return [Types::StringAttributeBoostingConfiguration]
1946
+ #
1947
+ # @!attribute [rw] string_list_configuration
1948
+ # Provides information on boosting `STRING_LIST` type document
1949
+ # attributes.
1950
+ # @return [Types::StringListAttributeBoostingConfiguration]
1951
+ #
1952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DocumentAttributeBoostingConfiguration AWS API Documentation
1953
+ #
1954
+ class DocumentAttributeBoostingConfiguration < Struct.new(
1955
+ :date_configuration,
1956
+ :number_configuration,
1957
+ :string_configuration,
1958
+ :string_list_configuration,
1959
+ :unknown)
1960
+ SENSITIVE = []
1961
+ include Aws::Structure
1962
+ include Aws::Structure::Union
1963
+
1964
+ class DateConfiguration < DocumentAttributeBoostingConfiguration; end
1965
+ class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
1966
+ class StringConfiguration < DocumentAttributeBoostingConfiguration; end
1967
+ class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
1968
+ class Unknown < DocumentAttributeBoostingConfiguration; end
1969
+ end
1970
+
1710
1971
  # The condition used for the target document attribute or metadata field
1711
- # when ingesting documents into Amazon Q. You use this with [
1972
+ # when ingesting documents into Amazon Q Business. You use this with [
1712
1973
  # `DocumentAttributeTarget` ][1] to apply the condition.
1713
1974
  #
1714
1975
  # For example, you can create the 'Department' target field and have
@@ -1718,15 +1979,15 @@ module Aws::QBusiness
1718
1979
  # then prefill the target field 'Department' with the target value
1719
1980
  # 'Finance' for the document.
1720
1981
  #
1721
- # Amazon Q can't create a target field if it has not already been
1722
- # created as an index field. After you create your index field, you can
1723
- # create a document metadata field using `DocumentAttributeTarget`.
1724
- # Amazon Q then will map your newly created metadata field to your index
1725
- # 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.
1726
1987
  #
1727
1988
  #
1728
1989
  #
1729
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
1990
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
1730
1991
  #
1731
1992
  # @!attribute [rw] key
1732
1993
  # The identifier of the document attribute used for the condition.
@@ -1735,8 +1996,8 @@ module Aws::QBusiness
1735
1996
  # attribute or metadata field that contains source URIs associated
1736
1997
  # with the documents.
1737
1998
  #
1738
- # Amazon Q currently doesn't support `_document_body` as an attribute
1739
- # key used for the condition.
1999
+ # Amazon Q Business currently doesn't support `_document_body` as an
2000
+ # attribute key used for the condition.
1740
2001
  # @return [String]
1741
2002
  #
1742
2003
  # @!attribute [rw] operator
@@ -1799,7 +2060,7 @@ module Aws::QBusiness
1799
2060
  end
1800
2061
 
1801
2062
  # The target document attribute or metadata field you want to alter when
1802
- # ingesting documents into Amazon Q.
2063
+ # ingesting documents into Amazon Q Business.
1803
2064
  #
1804
2065
  # For example, you can delete all customer identification numbers
1805
2066
  # associated with the documents, stored in the document metadata field
@@ -1808,18 +2069,18 @@ module Aws::QBusiness
1808
2069
  # in the field 'Customer\_ID'. This would scrub personally
1809
2070
  # identifiable information from each document's metadata.
1810
2071
  #
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
- # ][1]. Amazon Q will then map your newly created document attribute to
1815
- # 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.
1816
2077
  #
1817
2078
  # You can also use this with [ `DocumentAttributeCondition` ][2].
1818
2079
  #
1819
2080
  #
1820
2081
  #
1821
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
1822
- # [2]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeCondition.html
2082
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
2083
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html
1823
2084
  #
1824
2085
  # @!attribute [rw] attribute_value_operator
1825
2086
  # `TRUE` to delete the existing target value for your specified target
@@ -1904,9 +2165,9 @@ module Aws::QBusiness
1904
2165
  # The contents of the document. Documents passed to the `blob`
1905
2166
  # parameter must be base64 encoded. Your code might not need to encode
1906
2167
  # the document file bytes if you're using an Amazon Web Services SDK
1907
- # to call Amazon Q APIs. If you are calling the Amazon Q endpoint
1908
- # directly using REST, you must base64 encode the contents before
1909
- # 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.
1910
2171
  # @return [String]
1911
2172
  #
1912
2173
  # @!attribute [rw] s3
@@ -1928,7 +2189,7 @@ module Aws::QBusiness
1928
2189
  class Unknown < DocumentContent; end
1929
2190
  end
1930
2191
 
1931
- # The details of a document within an Amazon Q index.
2192
+ # The details of a document within an Amazon Q Business index.
1932
2193
  #
1933
2194
  # @!attribute [rw] created_at
1934
2195
  # The timestamp for when the document was created.
@@ -1973,20 +2234,20 @@ module Aws::QBusiness
1973
2234
  #
1974
2235
  # @!attribute [rw] inline_configurations
1975
2236
  # Configuration information to alter document attributes or metadata
1976
- # fields and content when ingesting documents into Amazon Q.
2237
+ # fields and content when ingesting documents into Amazon Q Business.
1977
2238
  # @return [Array<Types::InlineDocumentEnrichmentConfiguration>]
1978
2239
  #
1979
2240
  # @!attribute [rw] post_extraction_hook_configuration
1980
2241
  # Provides the configuration information for invoking a Lambda
1981
2242
  # function in Lambda to alter document metadata and content when
1982
- # ingesting documents into Amazon Q.
2243
+ # ingesting documents into Amazon Q Business.
1983
2244
  #
1984
2245
  # You can configure your Lambda function using
1985
2246
  # [PreExtractionHookConfiguration][1] if you want to apply advanced
1986
2247
  # alterations on the original or raw documents.
1987
2248
  #
1988
- # If you want to apply advanced alterations on the Amazon Q structured
1989
- # 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
1990
2251
  # [PostExtractionHookConfiguration][1].
1991
2252
  #
1992
2253
  # You can only invoke one Lambda function. However, this function can
@@ -1996,21 +2257,21 @@ module Aws::QBusiness
1996
2257
  #
1997
2258
  #
1998
2259
  #
1999
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html
2260
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html
2000
2261
  # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
2001
2262
  # @return [Types::HookConfiguration]
2002
2263
  #
2003
2264
  # @!attribute [rw] pre_extraction_hook_configuration
2004
2265
  # Provides the configuration information for invoking a Lambda
2005
2266
  # function in Lambda to alter document metadata and content when
2006
- # ingesting documents into Amazon Q.
2267
+ # ingesting documents into Amazon Q Business.
2007
2268
  #
2008
2269
  # You can configure your Lambda function using
2009
2270
  # [PreExtractionHookConfiguration][1] if you want to apply advanced
2010
2271
  # alterations on the original or raw documents.
2011
2272
  #
2012
- # If you want to apply advanced alterations on the Amazon Q structured
2013
- # 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
2014
2275
  # [PostExtractionHookConfiguration][1].
2015
2276
  #
2016
2277
  # You can only invoke one Lambda function. However, this function can
@@ -2020,7 +2281,7 @@ module Aws::QBusiness
2020
2281
  #
2021
2282
  #
2022
2283
  #
2023
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html
2284
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html
2024
2285
  # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
2025
2286
  # @return [Types::HookConfiguration]
2026
2287
  #
@@ -2034,8 +2295,8 @@ module Aws::QBusiness
2034
2295
  include Aws::Structure
2035
2296
  end
2036
2297
 
2037
- # The identifier of the data source Amazon Q will generate responses
2038
- # from.
2298
+ # The identifier of the data source Amazon Q Business will generate
2299
+ # responses from.
2039
2300
  #
2040
2301
  # @!attribute [rw] data_source_id
2041
2302
  # The identifier of the data source.
@@ -2055,11 +2316,11 @@ module Aws::QBusiness
2055
2316
  end
2056
2317
 
2057
2318
  # Provides the identifier of the KMS key used to encrypt data indexed by
2058
- # Amazon Q. Amazon Q doesn't support asymmetric keys.
2319
+ # Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
2059
2320
  #
2060
2321
  # @!attribute [rw] kms_key_id
2061
- # The identifier of the KMS key. Amazon Q doesn't support asymmetric
2062
- # keys.
2322
+ # The identifier of the KMS key. Amazon Q Business doesn't support
2323
+ # asymmetric keys.
2063
2324
  # @return [String]
2064
2325
  #
2065
2326
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/EncryptionConfiguration AWS API Documentation
@@ -2089,13 +2350,13 @@ module Aws::QBusiness
2089
2350
  include Aws::Structure
2090
2351
  end
2091
2352
 
2092
- # A list of documents that could not be removed from an Amazon Q index.
2093
- # Each entry contains an error message that indicates why the document
2094
- # 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.
2095
2356
  #
2096
2357
  # @!attribute [rw] data_source_id
2097
- # The identifier of the Amazon Q data source connector that contains
2098
- # the failed document.
2358
+ # The identifier of the Amazon Q Business data source connector that
2359
+ # contains the failed document.
2099
2360
  # @return [String]
2100
2361
  #
2101
2362
  # @!attribute [rw] error
@@ -2105,7 +2366,7 @@ module Aws::QBusiness
2105
2366
  #
2106
2367
  # @!attribute [rw] id
2107
2368
  # The identifier of the document that couldn't be removed from the
2108
- # Amazon Q index.
2369
+ # Amazon Q Business index.
2109
2370
  # @return [String]
2110
2371
  #
2111
2372
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/FailedDocument AWS API Documentation
@@ -2119,7 +2380,7 @@ module Aws::QBusiness
2119
2380
  end
2120
2381
 
2121
2382
  # @!attribute [rw] application_id
2122
- # The identifier of the Amazon Q application.
2383
+ # The identifier of the Amazon Q Business application.
2123
2384
  # @return [String]
2124
2385
  #
2125
2386
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplicationRequest AWS API Documentation
@@ -2131,11 +2392,11 @@ module Aws::QBusiness
2131
2392
  end
2132
2393
 
2133
2394
  # @!attribute [rw] application_arn
2134
- # The Amazon Resource Name (ARN) of the Amazon Q application.
2395
+ # The Amazon Resource Name (ARN) of the Amazon Q Business application.
2135
2396
  # @return [String]
2136
2397
  #
2137
2398
  # @!attribute [rw] application_id
2138
- # The identifier of the Amazon Q application.
2399
+ # The identifier of the Amazon Q Business application.
2139
2400
  # @return [String]
2140
2401
  #
2141
2402
  # @!attribute [rw] attachments_configuration
@@ -2144,20 +2405,22 @@ module Aws::QBusiness
2144
2405
  # @return [Types::AppliedAttachmentsConfiguration]
2145
2406
  #
2146
2407
  # @!attribute [rw] created_at
2147
- # 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.
2148
2410
  # @return [Time]
2149
2411
  #
2150
2412
  # @!attribute [rw] description
2151
- # A description for the Amazon Q application.
2413
+ # A description for the Amazon Q Business application.
2152
2414
  # @return [String]
2153
2415
  #
2154
2416
  # @!attribute [rw] display_name
2155
- # The name of the Amazon Q application.
2417
+ # The name of the Amazon Q Business application.
2156
2418
  # @return [String]
2157
2419
  #
2158
2420
  # @!attribute [rw] encryption_configuration
2159
2421
  # The identifier of the Amazon Web Services KMS key that is used to
2160
- # encrypt your data. Amazon Q doesn't support asymmetric keys.
2422
+ # encrypt your data. Amazon Q Business doesn't support asymmetric
2423
+ # keys.
2161
2424
  # @return [Types::EncryptionConfiguration]
2162
2425
  #
2163
2426
  # @!attribute [rw] error
@@ -2166,17 +2429,23 @@ module Aws::QBusiness
2166
2429
  # to fail.
2167
2430
  # @return [Types::ErrorDetail]
2168
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
+ #
2169
2437
  # @!attribute [rw] role_arn
2170
2438
  # The Amazon Resource Name (ARN) of the IAM with permissions to access
2171
2439
  # your CloudWatch logs and metrics.
2172
2440
  # @return [String]
2173
2441
  #
2174
2442
  # @!attribute [rw] status
2175
- # The status of the Amazon Q application.
2443
+ # The status of the Amazon Q Business application.
2176
2444
  # @return [String]
2177
2445
  #
2178
2446
  # @!attribute [rw] updated_at
2179
- # 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.
2180
2449
  # @return [Time]
2181
2450
  #
2182
2451
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplicationResponse AWS API Documentation
@@ -2190,6 +2459,7 @@ module Aws::QBusiness
2190
2459
  :display_name,
2191
2460
  :encryption_configuration,
2192
2461
  :error,
2462
+ :identity_center_application_arn,
2193
2463
  :role_arn,
2194
2464
  :status,
2195
2465
  :updated_at)
@@ -2208,9 +2478,9 @@ module Aws::QBusiness
2208
2478
  #
2209
2479
  # @!attribute [rw] next_token
2210
2480
  # If the `maxResults` response was incomplete because there is more
2211
- # data to retrieve, Amazon Q returns a pagination token in the
2212
- # response. You can use this pagination token to retrieve the next set
2213
- # 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.
2214
2484
  # @return [String]
2215
2485
  #
2216
2486
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatControlsConfigurationRequest AWS API Documentation
@@ -2227,29 +2497,35 @@ module Aws::QBusiness
2227
2497
  # The phrases blocked from chat by your chat control configuration.
2228
2498
  # @return [Types::BlockedPhrasesConfiguration]
2229
2499
  #
2500
+ # @!attribute [rw] creator_mode_configuration
2501
+ # The configuration details for `CREATOR_MODE`.
2502
+ # @return [Types::AppliedCreatorModeConfiguration]
2503
+ #
2230
2504
  # @!attribute [rw] next_token
2231
2505
  # If the `maxResults` response was incomplete because there is more
2232
- # data to retrieve, Amazon Q returns a pagination token in the
2233
- # response. You can use this pagination token to retrieve the next set
2234
- # 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.
2235
2509
  # @return [String]
2236
2510
  #
2237
2511
  # @!attribute [rw] response_scope
2238
- # The response scope configured for a Amazon Q application. This
2239
- # determines whether your application uses its retrieval augmented
2240
- # 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
2241
2515
  # enterprise data, or also uses the large language models (LLM)
2242
2516
  # knowledge to respons to end user questions in chat.
2243
2517
  # @return [String]
2244
2518
  #
2245
2519
  # @!attribute [rw] topic_configurations
2246
- # The topic specific controls configured for a Amazon Q application.
2520
+ # The topic specific controls configured for a Amazon Q Business
2521
+ # application.
2247
2522
  # @return [Array<Types::TopicConfiguration>]
2248
2523
  #
2249
2524
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatControlsConfigurationResponse AWS API Documentation
2250
2525
  #
2251
2526
  class GetChatControlsConfigurationResponse < Struct.new(
2252
2527
  :blocked_phrases,
2528
+ :creator_mode_configuration,
2253
2529
  :next_token,
2254
2530
  :response_scope,
2255
2531
  :topic_configurations)
@@ -2258,7 +2534,7 @@ module Aws::QBusiness
2258
2534
  end
2259
2535
 
2260
2536
  # @!attribute [rw] application_id
2261
- # The identifier of the Amazon Q application.
2537
+ # The identifier of the Amazon Q Business application.
2262
2538
  # @return [String]
2263
2539
  #
2264
2540
  # @!attribute [rw] data_source_id
@@ -2280,7 +2556,7 @@ module Aws::QBusiness
2280
2556
  end
2281
2557
 
2282
2558
  # @!attribute [rw] application_id
2283
- # The identifier of the Amazon Q application.
2559
+ # The identifier of the Amazon Q Business application.
2284
2560
  # @return [String]
2285
2561
  #
2286
2562
  # @!attribute [rw] configuration
@@ -2341,7 +2617,7 @@ module Aws::QBusiness
2341
2617
  # @return [String]
2342
2618
  #
2343
2619
  # @!attribute [rw] sync_schedule
2344
- # The schedule for Amazon Q to update the index.
2620
+ # The schedule for Amazon Q Business to update the index.
2345
2621
  # @return [String]
2346
2622
  #
2347
2623
  # @!attribute [rw] type
@@ -2425,11 +2701,13 @@ module Aws::QBusiness
2425
2701
  end
2426
2702
 
2427
2703
  # @!attribute [rw] application_id
2428
- # 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.
2429
2706
  # @return [String]
2430
2707
  #
2431
2708
  # @!attribute [rw] index_id
2432
- # 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.
2433
2711
  # @return [String]
2434
2712
  #
2435
2713
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetIndexRequest AWS API Documentation
@@ -2442,24 +2720,24 @@ module Aws::QBusiness
2442
2720
  end
2443
2721
 
2444
2722
  # @!attribute [rw] application_id
2445
- # The identifier of the Amazon Q application associated with the
2446
- # index.
2723
+ # The identifier of the Amazon Q Business application associated with
2724
+ # the index.
2447
2725
  # @return [String]
2448
2726
  #
2449
2727
  # @!attribute [rw] capacity_configuration
2450
- # The storage capacity units chosen for your Amazon Q index.
2728
+ # The storage capacity units chosen for your Amazon Q Business index.
2451
2729
  # @return [Types::IndexCapacityConfiguration]
2452
2730
  #
2453
2731
  # @!attribute [rw] created_at
2454
- # The Unix timestamp when the Amazon Q index was created.
2732
+ # The Unix timestamp when the Amazon Q Business index was created.
2455
2733
  # @return [Time]
2456
2734
  #
2457
2735
  # @!attribute [rw] description
2458
- # The description for the Amazon Q index.
2736
+ # The description for the Amazon Q Business index.
2459
2737
  # @return [String]
2460
2738
  #
2461
2739
  # @!attribute [rw] display_name
2462
- # The name of the Amazon Q index.
2740
+ # The name of the Amazon Q Business index.
2463
2741
  # @return [String]
2464
2742
  #
2465
2743
  # @!attribute [rw] document_attribute_configurations
@@ -2479,11 +2757,11 @@ module Aws::QBusiness
2479
2757
  # @return [Types::ErrorDetail]
2480
2758
  #
2481
2759
  # @!attribute [rw] index_arn
2482
- # The Amazon Resource Name (ARN) of the Amazon Q index.
2760
+ # The Amazon Resource Name (ARN) of the Amazon Q Business index.
2483
2761
  # @return [String]
2484
2762
  #
2485
2763
  # @!attribute [rw] index_id
2486
- # The identifier of the Amazon Q index.
2764
+ # The identifier of the Amazon Q Business index.
2487
2765
  # @return [String]
2488
2766
  #
2489
2767
  # @!attribute [rw] index_statistics
@@ -2497,7 +2775,8 @@ module Aws::QBusiness
2497
2775
  # @return [String]
2498
2776
  #
2499
2777
  # @!attribute [rw] updated_at
2500
- # 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.
2501
2780
  # @return [Time]
2502
2781
  #
2503
2782
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetIndexResponse AWS API Documentation
@@ -2541,7 +2820,8 @@ module Aws::QBusiness
2541
2820
  # @return [String]
2542
2821
  #
2543
2822
  # @!attribute [rw] auth_configuration
2544
- # Authentication configuration information for an Amazon Q plugin.
2823
+ # Authentication configuration information for an Amazon Q Business
2824
+ # plugin.
2545
2825
  # @return [Types::PluginAuthConfiguration]
2546
2826
  #
2547
2827
  # @!attribute [rw] created_at
@@ -2595,7 +2875,8 @@ module Aws::QBusiness
2595
2875
  end
2596
2876
 
2597
2877
  # @!attribute [rw] application_id
2598
- # The identifier of the Amazon Q application using the retriever.
2878
+ # The identifier of the Amazon Q Business application using the
2879
+ # retriever.
2599
2880
  # @return [String]
2600
2881
  #
2601
2882
  # @!attribute [rw] retriever_id
@@ -2612,12 +2893,13 @@ module Aws::QBusiness
2612
2893
  end
2613
2894
 
2614
2895
  # @!attribute [rw] application_id
2615
- # The identifier of the Amazon Q application using the retriever.
2896
+ # The identifier of the Amazon Q Business application using the
2897
+ # retriever.
2616
2898
  # @return [String]
2617
2899
  #
2618
2900
  # @!attribute [rw] configuration
2619
2901
  # Provides information on how the retriever used for your Amazon Q
2620
- # application is configured.
2902
+ # Business application is configured.
2621
2903
  # @return [Types::RetrieverConfiguration]
2622
2904
  #
2623
2905
  # @!attribute [rw] created_at
@@ -2701,12 +2983,12 @@ module Aws::QBusiness
2701
2983
  end
2702
2984
 
2703
2985
  # @!attribute [rw] application_id
2704
- # The identifier of the Amazon Q application linked to the web
2705
- # experience.
2986
+ # The identifier of the Amazon Q Business application linked to the
2987
+ # web experience.
2706
2988
  # @return [String]
2707
2989
  #
2708
2990
  # @!attribute [rw] web_experience_id
2709
- # The identifier of the Amazon Q web experience.
2991
+ # The identifier of the Amazon Q Business web experience.
2710
2992
  # @return [String]
2711
2993
  #
2712
2994
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperienceRequest AWS API Documentation
@@ -2719,13 +3001,13 @@ module Aws::QBusiness
2719
3001
  end
2720
3002
 
2721
3003
  # @!attribute [rw] application_id
2722
- # The identifier of the Amazon Q application linked to the web
2723
- # experience.
3004
+ # The identifier of the Amazon Q Business application linked to the
3005
+ # web experience.
2724
3006
  # @return [String]
2725
3007
  #
2726
3008
  # @!attribute [rw] authentication_configuration
2727
- # The authentication configuration information for your Amazon Q web
2728
- # experience.
3009
+ # The authentication configuration information for your Amazon Q
3010
+ # Business web experience.
2729
3011
  # @return [Types::WebExperienceAuthConfiguration]
2730
3012
  #
2731
3013
  # @!attribute [rw] created_at
@@ -2733,7 +3015,7 @@ module Aws::QBusiness
2733
3015
  # @return [Time]
2734
3016
  #
2735
3017
  # @!attribute [rw] default_endpoint
2736
- # The endpoint of your Amazon Q web experience.
3018
+ # The endpoint of your Amazon Q Business web experience.
2737
3019
  # @return [String]
2738
3020
  #
2739
3021
  # @!attribute [rw] error
@@ -2742,24 +3024,29 @@ module Aws::QBusiness
2742
3024
  # connector to fail.
2743
3025
  # @return [Types::ErrorDetail]
2744
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
+ #
2745
3032
  # @!attribute [rw] sample_prompts_control_mode
2746
3033
  # Determines whether sample prompts are enabled in the web experience
2747
3034
  # for an end user.
2748
3035
  # @return [String]
2749
3036
  #
2750
3037
  # @!attribute [rw] status
2751
- # The current status of the Amazon Q web experience. When the `Status`
2752
- # field value is `FAILED`, the `ErrorMessage` field contains a
2753
- # 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
2754
3041
  # fail.
2755
3042
  # @return [String]
2756
3043
  #
2757
3044
  # @!attribute [rw] subtitle
2758
- # The subtitle for your Amazon Q web experience.
3045
+ # The subtitle for your Amazon Q Business web experience.
2759
3046
  # @return [String]
2760
3047
  #
2761
3048
  # @!attribute [rw] title
2762
- # The title for your Amazon Q web experience.
3049
+ # The title for your Amazon Q Business web experience.
2763
3050
  # @return [String]
2764
3051
  #
2765
3052
  # @!attribute [rw] updated_at
@@ -2768,16 +3055,16 @@ module Aws::QBusiness
2768
3055
  #
2769
3056
  # @!attribute [rw] web_experience_arn
2770
3057
  # The Amazon Resource Name (ARN) of the role with the permission to
2771
- # access the Amazon Q web experience and required resources.
3058
+ # access the Amazon Q Business web experience and required resources.
2772
3059
  # @return [String]
2773
3060
  #
2774
3061
  # @!attribute [rw] web_experience_id
2775
- # The identifier of the Amazon Q web experience.
3062
+ # The identifier of the Amazon Q Business web experience.
2776
3063
  # @return [String]
2777
3064
  #
2778
3065
  # @!attribute [rw] welcome_message
2779
- # The customized welcome message for end users of an Amazon Q web
2780
- # experience.
3066
+ # The customized welcome message for end users of an Amazon Q Business
3067
+ # web experience.
2781
3068
  # @return [String]
2782
3069
  #
2783
3070
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperienceResponse AWS API Documentation
@@ -2788,6 +3075,7 @@ module Aws::QBusiness
2788
3075
  :created_at,
2789
3076
  :default_endpoint,
2790
3077
  :error,
3078
+ :role_arn,
2791
3079
  :sample_prompts_control_mode,
2792
3080
  :status,
2793
3081
  :subtitle,
@@ -2801,8 +3089,8 @@ module Aws::QBusiness
2801
3089
  end
2802
3090
 
2803
3091
  # A list of users or sub groups that belong to a group. This is for
2804
- # generating Amazon Q chat results only from document a user has access
2805
- # to.
3092
+ # generating Amazon Q Business chat results only from document a user
3093
+ # has access to.
2806
3094
  #
2807
3095
  # @!attribute [rw] member_groups
2808
3096
  # A list of sub groups that belong to a group. For example, the sub
@@ -2831,7 +3119,8 @@ module Aws::QBusiness
2831
3119
  # @return [Types::ErrorDetail]
2832
3120
  #
2833
3121
  # @!attribute [rw] last_updated_at
2834
- # 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.
2835
3124
  # @return [Time]
2836
3125
  #
2837
3126
  # @!attribute [rw] status
@@ -2864,14 +3153,14 @@ module Aws::QBusiness
2864
3153
 
2865
3154
  # Provides the configuration information for invoking a Lambda function
2866
3155
  # in Lambda to alter document metadata and content when ingesting
2867
- # documents into Amazon Q.
3156
+ # documents into Amazon Q Business.
2868
3157
  #
2869
3158
  # You can configure your Lambda function using
2870
3159
  # [PreExtractionHookConfiguration][1] if you want to apply advanced
2871
3160
  # alterations on the original or raw documents.
2872
3161
  #
2873
- # If you want to apply advanced alterations on the Amazon Q structured
2874
- # 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
2875
3164
  # [PostExtractionHookConfiguration][1].
2876
3165
  #
2877
3166
  # You can only invoke one Lambda function. However, this function can
@@ -2881,15 +3170,15 @@ module Aws::QBusiness
2881
3170
  #
2882
3171
  #
2883
3172
  #
2884
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html
3173
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html
2885
3174
  # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
2886
3175
  #
2887
3176
  # @!attribute [rw] invocation_condition
2888
3177
  # The condition used for when a Lambda function should be invoked.
2889
3178
  #
2890
3179
  # For example, you can specify a condition that if there are empty
2891
- # date-time values, then Amazon Q should invoke a function that
2892
- # inserts the current date-time.
3180
+ # date-time values, then Amazon Q Business should invoke a function
3181
+ # that inserts the current date-time.
2893
3182
  # @return [Types::DocumentAttributeCondition]
2894
3183
  #
2895
3184
  # @!attribute [rw] lambda_arn
@@ -2930,7 +3219,7 @@ module Aws::QBusiness
2930
3219
  include Aws::Structure
2931
3220
  end
2932
3221
 
2933
- # Summary information for your Amazon Q index.
3222
+ # Summary information for your Amazon Q Business index.
2934
3223
  #
2935
3224
  # @!attribute [rw] created_at
2936
3225
  # The Unix timestamp when the index was created.
@@ -2968,7 +3257,8 @@ module Aws::QBusiness
2968
3257
  # Provides information about index capacity configuration.
2969
3258
  #
2970
3259
  # @!attribute [rw] units
2971
- # 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.
2972
3262
  # @return [Integer]
2973
3263
  #
2974
3264
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/IndexCapacityConfiguration AWS API Documentation
@@ -2995,7 +3285,7 @@ module Aws::QBusiness
2995
3285
 
2996
3286
  # Provides the configuration information for applying basic logic to
2997
3287
  # alter document metadata and content when ingesting documents into
2998
- # Amazon Q.
3288
+ # Amazon Q Business.
2999
3289
  #
3000
3290
  # To apply advanced logic, to go beyond what you can do with basic
3001
3291
  # logic, see [ `HookConfiguration` ][1].
@@ -3004,13 +3294,13 @@ module Aws::QBusiness
3004
3294
  #
3005
3295
  #
3006
3296
  #
3007
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_HookConfiguration.html
3297
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html
3008
3298
  # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
3009
3299
  #
3010
3300
  # @!attribute [rw] condition
3011
3301
  # The condition used for the target document attribute or metadata
3012
- # field when ingesting documents into Amazon Q. You use this with [
3013
- # `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.
3014
3304
  #
3015
3305
  # For example, you can create the 'Department' target field and have
3016
3306
  # it prefill department names associated with the documents based on
@@ -3019,15 +3309,15 @@ module Aws::QBusiness
3019
3309
  # then prefill the target field 'Department' with the target value
3020
3310
  # 'Finance' for the document.
3021
3311
  #
3022
- # Amazon Q can't create a target field if it has not already been
3023
- # created as an index field. After you create your index field, you
3024
- # can create a document metadata field using
3025
- # `DocumentAttributeTarget`. Amazon Q then will map your newly created
3026
- # 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.
3027
3317
  #
3028
3318
  #
3029
3319
  #
3030
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
3320
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
3031
3321
  # @return [Types::DocumentAttributeCondition]
3032
3322
  #
3033
3323
  # @!attribute [rw] document_content_operator
@@ -3037,7 +3327,7 @@ module Aws::QBusiness
3037
3327
  #
3038
3328
  # @!attribute [rw] target
3039
3329
  # The target document attribute or metadata field you want to alter
3040
- # when ingesting documents into Amazon Q.
3330
+ # when ingesting documents into Amazon Q Business.
3041
3331
  #
3042
3332
  # For example, you can delete all customer identification numbers
3043
3333
  # associated with the documents, stored in the document metadata field
@@ -3046,18 +3336,18 @@ module Aws::QBusiness
3046
3336
  # customer ID values in the field 'Customer\_ID'. This would scrub
3047
3337
  # personally identifiable information from each document's metadata.
3048
3338
  #
3049
- # Amazon Q can't create a target field if it has not already been
3050
- # created as an index field. After you create your index field, you
3051
- # can create a document metadata field using [
3052
- # `DocumentAttributeTarget` ][1]. Amazon Q will then map your newly
3053
- # 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.
3054
3344
  #
3055
3345
  # You can also use this with [ `DocumentAttributeCondition` ][2].
3056
3346
  #
3057
3347
  #
3058
3348
  #
3059
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
3060
- # [2]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeCondition.html
3349
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
3350
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html
3061
3351
  # @return [Types::DocumentAttributeTarget]
3062
3352
  #
3063
3353
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/InlineDocumentEnrichmentConfiguration AWS API Documentation
@@ -3071,8 +3361,8 @@ module Aws::QBusiness
3071
3361
  end
3072
3362
 
3073
3363
  # An issue occurred with the internal server used for your Amazon Q
3074
- # service. Wait some minutes and try again, or contact [Support][1] for
3075
- # help.
3364
+ # Business service. Wait some minutes and try again, or contact
3365
+ # [Support][1] for help.
3076
3366
  #
3077
3367
  #
3078
3368
  #
@@ -3119,14 +3409,14 @@ module Aws::QBusiness
3119
3409
  end
3120
3410
 
3121
3411
  # @!attribute [rw] max_results
3122
- # The maximum number of Amazon Q applications to return.
3412
+ # The maximum number of Amazon Q Business applications to return.
3123
3413
  # @return [Integer]
3124
3414
  #
3125
3415
  # @!attribute [rw] next_token
3126
3416
  # If the `maxResults` response was incomplete because there is more
3127
- # data to retrieve, Amazon Q returns a pagination token in the
3128
- # response. You can use this pagination token to retrieve the next set
3129
- # 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.
3130
3420
  # @return [String]
3131
3421
  #
3132
3422
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListApplicationsRequest AWS API Documentation
@@ -3140,13 +3430,13 @@ module Aws::QBusiness
3140
3430
 
3141
3431
  # @!attribute [rw] applications
3142
3432
  # An array of summary information on the configuration of one or more
3143
- # Amazon Q applications.
3433
+ # Amazon Q Business applications.
3144
3434
  # @return [Array<Types::Application>]
3145
3435
  #
3146
3436
  # @!attribute [rw] next_token
3147
- # If the response is truncated, Amazon Q returns this token. You can
3148
- # use this token in a subsequent request to retrieve the next set of
3149
- # 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.
3150
3440
  # @return [String]
3151
3441
  #
3152
3442
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListApplicationsResponse AWS API Documentation
@@ -3159,23 +3449,23 @@ module Aws::QBusiness
3159
3449
  end
3160
3450
 
3161
3451
  # @!attribute [rw] application_id
3162
- # The identifier of the Amazon Q application.
3452
+ # The identifier of the Amazon Q Business application.
3163
3453
  # @return [String]
3164
3454
  #
3165
3455
  # @!attribute [rw] max_results
3166
- # The maximum number of Amazon Q conversations to return.
3456
+ # The maximum number of Amazon Q Business conversations to return.
3167
3457
  # @return [Integer]
3168
3458
  #
3169
3459
  # @!attribute [rw] next_token
3170
3460
  # If the `maxResults` response was incomplete because there is more
3171
- # data to retrieve, Amazon Q returns a pagination token in the
3172
- # response. You can use this pagination token to retrieve the next set
3173
- # 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.
3174
3464
  # @return [String]
3175
3465
  #
3176
3466
  # @!attribute [rw] user_id
3177
- # The identifier of the user involved in the Amazon Q web experience
3178
- # conversation.
3467
+ # The identifier of the user involved in the Amazon Q Business web
3468
+ # experience conversation.
3179
3469
  # @return [String]
3180
3470
  #
3181
3471
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListConversationsRequest AWS API Documentation
@@ -3191,12 +3481,13 @@ module Aws::QBusiness
3191
3481
 
3192
3482
  # @!attribute [rw] conversations
3193
3483
  # An array of summary information on the configuration of one or more
3194
- # Amazon Q web experiences.
3484
+ # Amazon Q Business web experiences.
3195
3485
  # @return [Array<Types::Conversation>]
3196
3486
  #
3197
3487
  # @!attribute [rw] next_token
3198
- # If the response is truncated, Amazon Q returns this token, which you
3199
- # 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.
3200
3491
  # @return [String]
3201
3492
  #
3202
3493
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListConversationsResponse AWS API Documentation
@@ -3209,8 +3500,8 @@ module Aws::QBusiness
3209
3500
  end
3210
3501
 
3211
3502
  # @!attribute [rw] application_id
3212
- # The identifier of the Amazon Q application connected to the data
3213
- # source.
3503
+ # The identifier of the Amazon Q Business application connected to the
3504
+ # data source.
3214
3505
  # @return [String]
3215
3506
  #
3216
3507
  # @!attribute [rw] data_source_id
@@ -3222,8 +3513,8 @@ module Aws::QBusiness
3222
3513
  # @return [Time]
3223
3514
  #
3224
3515
  # @!attribute [rw] index_id
3225
- # The identifier of the index used with the Amazon Q data source
3226
- # connector.
3516
+ # The identifier of the index used with the Amazon Q Business data
3517
+ # source connector.
3227
3518
  # @return [String]
3228
3519
  #
3229
3520
  # @!attribute [rw] max_results
@@ -3233,9 +3524,9 @@ module Aws::QBusiness
3233
3524
  #
3234
3525
  # @!attribute [rw] next_token
3235
3526
  # If the `maxResults` response was incpmplete because there is more
3236
- # data to retriever, Amazon Q returns a pagination token in the
3237
- # response. You can use this pagination token to retrieve the next set
3238
- # 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.
3239
3530
  # @return [String]
3240
3531
  #
3241
3532
  # @!attribute [rw] start_time
@@ -3267,9 +3558,9 @@ module Aws::QBusiness
3267
3558
  # @return [Array<Types::DataSourceSyncJob>]
3268
3559
  #
3269
3560
  # @!attribute [rw] next_token
3270
- # If the response is truncated, Amazon Q returns this token. You can
3271
- # use this token in any subsequent request to retrieve the next set of
3272
- # 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.
3273
3564
  # @return [String]
3274
3565
  #
3275
3566
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSourceSyncJobsResponse AWS API Documentation
@@ -3282,8 +3573,8 @@ module Aws::QBusiness
3282
3573
  end
3283
3574
 
3284
3575
  # @!attribute [rw] application_id
3285
- # The identifier of the Amazon Q application linked to the data source
3286
- # connectors.
3576
+ # The identifier of the Amazon Q Business application linked to the
3577
+ # data source connectors.
3287
3578
  # @return [String]
3288
3579
  #
3289
3580
  # @!attribute [rw] index_id
@@ -3297,9 +3588,9 @@ module Aws::QBusiness
3297
3588
  #
3298
3589
  # @!attribute [rw] next_token
3299
3590
  # If the `maxResults` response was incomplete because there is more
3300
- # data to retrieve, Amazon Q returns a pagination token in the
3301
- # response. You can use this pagination token to retrieve the next set
3302
- # 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.
3303
3594
  # @return [String]
3304
3595
  #
3305
3596
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSourcesRequest AWS API Documentation
@@ -3319,9 +3610,9 @@ module Aws::QBusiness
3319
3610
  # @return [Array<Types::DataSource>]
3320
3611
  #
3321
3612
  # @!attribute [rw] next_token
3322
- # If the response is truncated, Amazon Q returns this token. You can
3323
- # use this token in a subsequent request to retrieve the next set of
3324
- # 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.
3325
3616
  # @return [String]
3326
3617
  #
3327
3618
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataSourcesResponse AWS API Documentation
@@ -3351,9 +3642,9 @@ module Aws::QBusiness
3351
3642
  #
3352
3643
  # @!attribute [rw] next_token
3353
3644
  # If the `maxResults` response was incomplete because there is more
3354
- # data to retrieve, Amazon Q returns a pagination token in the
3355
- # response. You can use this pagination token to retrieve the next set
3356
- # 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.
3357
3648
  # @return [String]
3358
3649
  #
3359
3650
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDocumentsRequest AWS API Documentation
@@ -3374,9 +3665,9 @@ module Aws::QBusiness
3374
3665
  #
3375
3666
  # @!attribute [rw] next_token
3376
3667
  # If the `maxResults` response was incomplete because there is more
3377
- # data to retrieve, Amazon Q returns a pagination token in the
3378
- # response. You can use this pagination token to retrieve the next set
3379
- # 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.
3380
3671
  # @return [String]
3381
3672
  #
3382
3673
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDocumentsResponse AWS API Documentation
@@ -3409,9 +3700,9 @@ module Aws::QBusiness
3409
3700
  #
3410
3701
  # @!attribute [rw] next_token
3411
3702
  # If the previous response was incomplete (because there is more data
3412
- # to retrieve), Amazon Q returns a pagination token in the response.
3413
- # You can use this pagination token to retrieve the next set of groups
3414
- # 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.
3415
3706
  # @return [String]
3416
3707
  #
3417
3708
  # @!attribute [rw] updated_earlier_than
@@ -3437,9 +3728,9 @@ module Aws::QBusiness
3437
3728
  # @return [Array<Types::GroupSummary>]
3438
3729
  #
3439
3730
  # @!attribute [rw] next_token
3440
- # If the response is truncated, Amazon Q returns this token that you
3441
- # can use in the subsequent request to retrieve the next set of groups
3442
- # 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.
3443
3734
  # @return [String]
3444
3735
  #
3445
3736
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListGroupsResponse AWS API Documentation
@@ -3452,7 +3743,8 @@ module Aws::QBusiness
3452
3743
  end
3453
3744
 
3454
3745
  # @!attribute [rw] application_id
3455
- # 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.
3456
3748
  # @return [String]
3457
3749
  #
3458
3750
  # @!attribute [rw] max_results
@@ -3461,9 +3753,9 @@ module Aws::QBusiness
3461
3753
  #
3462
3754
  # @!attribute [rw] next_token
3463
3755
  # If the maxResults response was incomplete because there is more data
3464
- # to retrieve, Amazon Q returns a pagination token in the response.
3465
- # You can use this pagination token to retrieve the next set of Amazon
3466
- # 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.
3467
3759
  # @return [String]
3468
3760
  #
3469
3761
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndicesRequest AWS API Documentation
@@ -3481,9 +3773,9 @@ module Aws::QBusiness
3481
3773
  # @return [Array<Types::Index>]
3482
3774
  #
3483
3775
  # @!attribute [rw] next_token
3484
- # If the response is truncated, Amazon Q returns this token that you
3485
- # can use in the subsequent request to retrieve the next set of
3486
- # 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.
3487
3779
  # @return [String]
3488
3780
  #
3489
3781
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndicesResponse AWS API Documentation
@@ -3496,11 +3788,11 @@ module Aws::QBusiness
3496
3788
  end
3497
3789
 
3498
3790
  # @!attribute [rw] application_id
3499
- # The identifier for the Amazon Q application.
3791
+ # The identifier for the Amazon Q Business application.
3500
3792
  # @return [String]
3501
3793
  #
3502
3794
  # @!attribute [rw] conversation_id
3503
- # The identifier of the Amazon Q web experience conversation.
3795
+ # The identifier of the Amazon Q Business web experience conversation.
3504
3796
  # @return [String]
3505
3797
  #
3506
3798
  # @!attribute [rw] max_results
@@ -3509,13 +3801,13 @@ module Aws::QBusiness
3509
3801
  #
3510
3802
  # @!attribute [rw] next_token
3511
3803
  # If the number of retrievers returned exceeds `maxResults`, Amazon Q
3512
- # returns a next token as a pagination token to retrieve the next set
3513
- # of messages.
3804
+ # Business returns a next token as a pagination token to retrieve the
3805
+ # next set of messages.
3514
3806
  # @return [String]
3515
3807
  #
3516
3808
  # @!attribute [rw] user_id
3517
- # The identifier of the user involved in the Amazon Q web experience
3518
- # conversation.
3809
+ # The identifier of the user involved in the Amazon Q Business web
3810
+ # experience conversation.
3519
3811
  # @return [String]
3520
3812
  #
3521
3813
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessagesRequest AWS API Documentation
@@ -3535,8 +3827,9 @@ module Aws::QBusiness
3535
3827
  # @return [Array<Types::Message>]
3536
3828
  #
3537
3829
  # @!attribute [rw] next_token
3538
- # If the response is truncated, Amazon Q returns this token, which you
3539
- # 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.
3540
3833
  # @return [String]
3541
3834
  #
3542
3835
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessagesResponse AWS API Documentation
@@ -3558,9 +3851,9 @@ module Aws::QBusiness
3558
3851
  #
3559
3852
  # @!attribute [rw] next_token
3560
3853
  # If the `maxResults` response was incomplete because there is more
3561
- # data to retrieve, Amazon Q returns a pagination token in the
3562
- # response. You can use this pagination token to retrieve the next set
3563
- # 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.
3564
3857
  # @return [String]
3565
3858
  #
3566
3859
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginsRequest AWS API Documentation
@@ -3575,9 +3868,9 @@ module Aws::QBusiness
3575
3868
 
3576
3869
  # @!attribute [rw] next_token
3577
3870
  # If the `maxResults` response was incomplete because there is more
3578
- # data to retrieve, Amazon Q returns a pagination token in the
3579
- # response. You can use this pagination token to retrieve the next set
3580
- # 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.
3581
3874
  # @return [String]
3582
3875
  #
3583
3876
  # @!attribute [rw] plugins
@@ -3594,7 +3887,8 @@ module Aws::QBusiness
3594
3887
  end
3595
3888
 
3596
3889
  # @!attribute [rw] application_id
3597
- # The identifier of the Amazon Q application using the retriever.
3890
+ # The identifier of the Amazon Q Business application using the
3891
+ # retriever.
3598
3892
  # @return [String]
3599
3893
  #
3600
3894
  # @!attribute [rw] max_results
@@ -3603,8 +3897,8 @@ module Aws::QBusiness
3603
3897
  #
3604
3898
  # @!attribute [rw] next_token
3605
3899
  # If the number of retrievers returned exceeds `maxResults`, Amazon Q
3606
- # returns a next token as a pagination token to retrieve the next set
3607
- # of retrievers.
3900
+ # Business returns a next token as a pagination token to retrieve the
3901
+ # next set of retrievers.
3608
3902
  # @return [String]
3609
3903
  #
3610
3904
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListRetrieversRequest AWS API Documentation
@@ -3618,8 +3912,9 @@ module Aws::QBusiness
3618
3912
  end
3619
3913
 
3620
3914
  # @!attribute [rw] next_token
3621
- # If the response is truncated, Amazon Q returns this token, which you
3622
- # 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.
3623
3918
  # @return [String]
3624
3919
  #
3625
3920
  # @!attribute [rw] retrievers
@@ -3636,8 +3931,8 @@ module Aws::QBusiness
3636
3931
  end
3637
3932
 
3638
3933
  # @!attribute [rw] resource_arn
3639
- # The Amazon Resource Name (ARN) of the Amazon Q application or data
3640
- # 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.
3641
3936
  # @return [String]
3642
3937
  #
3643
3938
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListTagsForResourceRequest AWS API Documentation
@@ -3649,8 +3944,8 @@ module Aws::QBusiness
3649
3944
  end
3650
3945
 
3651
3946
  # @!attribute [rw] tags
3652
- # A list of tags associated with the Amazon Q application or data
3653
- # source.
3947
+ # A list of tags associated with the Amazon Q Business application or
3948
+ # data source.
3654
3949
  # @return [Array<Types::Tag>]
3655
3950
  #
3656
3951
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListTagsForResourceResponse AWS API Documentation
@@ -3662,19 +3957,19 @@ module Aws::QBusiness
3662
3957
  end
3663
3958
 
3664
3959
  # @!attribute [rw] application_id
3665
- # The identifier of the Amazon Q application linked to the listed web
3666
- # experiences.
3960
+ # The identifier of the Amazon Q Business application linked to the
3961
+ # listed web experiences.
3667
3962
  # @return [String]
3668
3963
  #
3669
3964
  # @!attribute [rw] max_results
3670
- # The maximum number of Amazon Q Web Experiences to return.
3965
+ # The maximum number of Amazon Q Business Web Experiences to return.
3671
3966
  # @return [Integer]
3672
3967
  #
3673
3968
  # @!attribute [rw] next_token
3674
3969
  # If the `maxResults` response was incomplete because there is more
3675
- # data to retrieve, Amazon Q returns a pagination token in the
3676
- # response. You can use this pagination token to retrieve the next set
3677
- # 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.
3678
3973
  # @return [String]
3679
3974
  #
3680
3975
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListWebExperiencesRequest AWS API Documentation
@@ -3688,12 +3983,13 @@ module Aws::QBusiness
3688
3983
  end
3689
3984
 
3690
3985
  # @!attribute [rw] next_token
3691
- # If the response is truncated, Amazon Q returns this token, which you
3692
- # 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.
3693
3989
  # @return [String]
3694
3990
  #
3695
3991
  # @!attribute [rw] web_experiences
3696
- # An array of summary information for one or more Amazon Q
3992
+ # An array of summary information for one or more Amazon Q Business
3697
3993
  # experiences.
3698
3994
  # @return [Array<Types::WebExperience>]
3699
3995
  #
@@ -3744,43 +4040,45 @@ module Aws::QBusiness
3744
4040
  include Aws::Structure
3745
4041
  end
3746
4042
 
3747
- # A message in an Amazon Q web experience.
4043
+ # A message in an Amazon Q Business web experience.
3748
4044
  #
3749
4045
  # @!attribute [rw] action_execution
3750
- # Performs an Amazon Q plugin action during a non-streaming chat
3751
- # conversation.
4046
+ # Performs an Amazon Q Business plugin action during a non-streaming
4047
+ # chat conversation.
3752
4048
  # @return [Types::ActionExecution]
3753
4049
  #
3754
4050
  # @!attribute [rw] action_review
3755
- # An output event that Amazon Q returns to an user who wants to
3756
- # perform a plugin action during a non-streaming chat conversation. It
3757
- # contains information about the selected action with a list of
3758
- # 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.
3759
4055
  # @return [Types::ActionReview]
3760
4056
  #
3761
4057
  # @!attribute [rw] attachments
3762
- # 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.
3763
4060
  # @return [Array<Types::AttachmentOutput>]
3764
4061
  #
3765
4062
  # @!attribute [rw] body
3766
- # The content of the Amazon Q web experience message.
4063
+ # The content of the Amazon Q Business web experience message.
3767
4064
  # @return [String]
3768
4065
  #
3769
4066
  # @!attribute [rw] message_id
3770
- # The identifier of the Amazon Q web experience message.
4067
+ # The identifier of the Amazon Q Business web experience message.
3771
4068
  # @return [String]
3772
4069
  #
3773
4070
  # @!attribute [rw] source_attribution
3774
- # The source documents used to generate Amazon Q web experience
3775
- # message.
4071
+ # The source documents used to generate Amazon Q Business web
4072
+ # experience message.
3776
4073
  # @return [Array<Types::SourceAttribution>]
3777
4074
  #
3778
4075
  # @!attribute [rw] time
3779
- # The timestamp of the first Amazon Q web experience message.
4076
+ # The timestamp of the first Amazon Q Business web experience message.
3780
4077
  # @return [Time]
3781
4078
  #
3782
4079
  # @!attribute [rw] type
3783
- # 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.
3784
4082
  # @return [String]
3785
4083
  #
3786
4084
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Message AWS API Documentation
@@ -3829,26 +4127,59 @@ module Aws::QBusiness
3829
4127
  include Aws::Structure
3830
4128
  end
3831
4129
 
3832
- # Configuration information for an Amazon Q index.
4130
+ # Configuration information for an Amazon Q Business index.
4131
+ #
4132
+ # @!attribute [rw] boosting_override
4133
+ # Overrides the default boosts applied by Amazon Q Business to
4134
+ # supported document attribute data types.
4135
+ # @return [Hash<String,Types::DocumentAttributeBoostingConfiguration>]
3833
4136
  #
3834
4137
  # @!attribute [rw] index_id
3835
- # The identifier for the Amazon Q index.
4138
+ # The identifier for the Amazon Q Business index.
3836
4139
  # @return [String]
3837
4140
  #
3838
4141
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/NativeIndexConfiguration AWS API Documentation
3839
4142
  #
3840
4143
  class NativeIndexConfiguration < Struct.new(
4144
+ :boosting_override,
3841
4145
  :index_id)
3842
4146
  SENSITIVE = []
3843
4147
  include Aws::Structure
3844
4148
  end
3845
4149
 
4150
+ # Provides information on boosting `NUMBER` type document attributes.
4151
+ #
4152
+ # For more information on how boosting document attributes work in
4153
+ # Amazon Q Business, see [Boosting using document attributes][1].
4154
+ #
4155
+ #
4156
+ #
4157
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
4158
+ #
4159
+ # @!attribute [rw] boosting_level
4160
+ # Specifies the duration, in seconds, of a boost applies to a `NUMBER`
4161
+ # type document attribute.
4162
+ # @return [String]
4163
+ #
4164
+ # @!attribute [rw] boosting_type
4165
+ # Specifies how much a document attribute is boosted.
4166
+ # @return [String]
4167
+ #
4168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/NumberAttributeBoostingConfiguration AWS API Documentation
4169
+ #
4170
+ class NumberAttributeBoostingConfiguration < Struct.new(
4171
+ :boosting_level,
4172
+ :boosting_type)
4173
+ SENSITIVE = []
4174
+ include Aws::Structure
4175
+ end
4176
+
3846
4177
  # Information about the OAuth 2.0 authentication credential/token used
3847
4178
  # to configure a plugin.
3848
4179
  #
3849
4180
  # @!attribute [rw] role_arn
3850
- # The ARN of an IAM role used by Amazon Q to access the OAuth 2.0
3851
- # 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.
3852
4183
  # @return [String]
3853
4184
  #
3854
4185
  # @!attribute [rw] secret_arn
@@ -3865,7 +4196,7 @@ module Aws::QBusiness
3865
4196
  include Aws::Structure
3866
4197
  end
3867
4198
 
3868
- # Information about an Amazon Q plugin and its configuration.
4199
+ # Information about an Amazon Q Business plugin and its configuration.
3869
4200
  #
3870
4201
  # @!attribute [rw] created_at
3871
4202
  # The timestamp for when the plugin was created.
@@ -3909,7 +4240,8 @@ module Aws::QBusiness
3909
4240
  include Aws::Structure
3910
4241
  end
3911
4242
 
3912
- # Authentication configuration information for an Amazon Q plugin.
4243
+ # Authentication configuration information for an Amazon Q Business
4244
+ # plugin.
3913
4245
  #
3914
4246
  # @note PluginAuthConfiguration is a union - when making an API calls you must set exactly one of the members.
3915
4247
  #
@@ -3940,8 +4272,31 @@ module Aws::QBusiness
3940
4272
  class Unknown < PluginAuthConfiguration; end
3941
4273
  end
3942
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
+
3943
4298
  # Provides user and group information used for filtering documents to
3944
- # use for generating Amazon Q conversation responses.
4299
+ # use for generating Amazon Q Business conversation responses.
3945
4300
  #
3946
4301
  # @note Principal is a union - when making an API calls you must set exactly one of the members.
3947
4302
  #
@@ -4073,8 +4428,8 @@ module Aws::QBusiness
4073
4428
  #
4074
4429
  # @!attribute [rw] group_members
4075
4430
  # A list of users or sub groups that belong to a group. This is for
4076
- # generating Amazon Q chat results only from document a user has
4077
- # access to.
4431
+ # generating Amazon Q Business chat results only from document a user
4432
+ # has access to.
4078
4433
  # @return [Types::GroupMembers]
4079
4434
  #
4080
4435
  # @!attribute [rw] group_name
@@ -4141,11 +4496,12 @@ module Aws::QBusiness
4141
4496
  include Aws::Structure
4142
4497
  end
4143
4498
 
4144
- # Summary information for the retriever used for your Amazon Q
4499
+ # Summary information for the retriever used for your Amazon Q Business
4145
4500
  # application.
4146
4501
  #
4147
4502
  # @!attribute [rw] application_id
4148
- # The identifier of the Amazon Q application using the retriever.
4503
+ # The identifier of the Amazon Q Business application using the
4504
+ # retriever.
4149
4505
  # @return [String]
4150
4506
  #
4151
4507
  # @!attribute [rw] display_name
@@ -4153,7 +4509,8 @@ module Aws::QBusiness
4153
4509
  # @return [String]
4154
4510
  #
4155
4511
  # @!attribute [rw] retriever_id
4156
- # 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.
4157
4514
  # @return [String]
4158
4515
  #
4159
4516
  # @!attribute [rw] status
@@ -4177,7 +4534,7 @@ module Aws::QBusiness
4177
4534
  end
4178
4535
 
4179
4536
  # Provides information on how the retriever used for your Amazon Q
4180
- # application is configured.
4537
+ # Business application is configured.
4181
4538
  #
4182
4539
  # @note RetrieverConfiguration is a union - when making an API calls you must set exactly one of the members.
4183
4540
  #
@@ -4185,12 +4542,12 @@ module Aws::QBusiness
4185
4542
  #
4186
4543
  # @!attribute [rw] kendra_index_configuration
4187
4544
  # Provides information on how the Amazon Kendra index used as a
4188
- # retriever for your Amazon Q application is configured.
4545
+ # retriever for your Amazon Q Business application is configured.
4189
4546
  # @return [Types::KendraIndexConfiguration]
4190
4547
  #
4191
4548
  # @!attribute [rw] native_index_configuration
4192
- # Provides information on how a Amazon Q index used as a retriever for
4193
- # 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.
4194
4551
  # @return [Types::NativeIndexConfiguration]
4195
4552
  #
4196
4553
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/RetrieverConfiguration AWS API Documentation
@@ -4208,8 +4565,8 @@ module Aws::QBusiness
4208
4565
  class Unknown < RetrieverConfiguration; end
4209
4566
  end
4210
4567
 
4211
- # Guardrail rules for an Amazon Q application. Amazon Q supports only
4212
- # 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.
4213
4570
  #
4214
4571
  # @!attribute [rw] excluded_users_and_groups
4215
4572
  # Users and groups to be excluded from a rule.
@@ -4224,7 +4581,7 @@ module Aws::QBusiness
4224
4581
  # @return [Types::RuleConfiguration]
4225
4582
  #
4226
4583
  # @!attribute [rw] rule_type
4227
- # The type fo rule.
4584
+ # The type of rule.
4228
4585
  # @return [String]
4229
4586
  #
4230
4587
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Rule AWS API Documentation
@@ -4245,13 +4602,13 @@ module Aws::QBusiness
4245
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.
4246
4603
  #
4247
4604
  # @!attribute [rw] content_blocker_rule
4248
- # A rule for configuring how Amazon Q responds when it encounters a a
4249
- # blocked topic.
4605
+ # A rule for configuring how Amazon Q Business responds when it
4606
+ # encounters a a blocked topic.
4250
4607
  # @return [Types::ContentBlockerRule]
4251
4608
  #
4252
4609
  # @!attribute [rw] content_retrieval_rule
4253
4610
  # Rules for retrieving content from data sources connected to a Amazon
4254
- # Q application for a specific topic control configuration.
4611
+ # Q Business application for a specific topic control configuration.
4255
4612
  # @return [Types::ContentRetrievalRule]
4256
4613
  #
4257
4614
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/RuleConfiguration AWS API Documentation
@@ -4269,8 +4626,8 @@ module Aws::QBusiness
4269
4626
  class Unknown < RuleConfiguration; end
4270
4627
  end
4271
4628
 
4272
- # Information required for Amazon Q to find a specific file in an Amazon
4273
- # S3 bucket.
4629
+ # Information required for Amazon Q Business to find a specific file in
4630
+ # an Amazon S3 bucket.
4274
4631
  #
4275
4632
  # @!attribute [rw] bucket
4276
4633
  # The name of the S3 bucket that contains the file.
@@ -4290,7 +4647,8 @@ module Aws::QBusiness
4290
4647
  end
4291
4648
 
4292
4649
  # Provides the SAML 2.0 compliant identity provider (IdP) configuration
4293
- # 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.
4294
4652
  #
4295
4653
  # @!attribute [rw] metadata_xml
4296
4654
  # The metadata XML that your IdP generated.
@@ -4298,8 +4656,9 @@ module Aws::QBusiness
4298
4656
  #
4299
4657
  # @!attribute [rw] role_arn
4300
4658
  # The Amazon Resource Name (ARN) of an IAM role assumed by users when
4301
- # they authenticate into their Amazon Q web experience, containing the
4302
- # 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.
4303
4662
  # @return [String]
4304
4663
  #
4305
4664
  # @!attribute [rw] user_group_attribute
@@ -4321,7 +4680,7 @@ module Aws::QBusiness
4321
4680
  include Aws::Structure
4322
4681
  end
4323
4682
 
4324
- # You have exceeded the set limits for your Amazon Q service.
4683
+ # You have exceeded the set limits for your Amazon Q Business service.
4325
4684
  #
4326
4685
  # @!attribute [rw] message
4327
4686
  # The message describing a `ServiceQuotaExceededException`.
@@ -4345,10 +4704,12 @@ module Aws::QBusiness
4345
4704
  include Aws::Structure
4346
4705
  end
4347
4706
 
4348
- # 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.
4349
4709
  #
4350
4710
  # @!attribute [rw] citation_number
4351
- # 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.
4352
4713
  # @return [Integer]
4353
4714
  #
4354
4715
  # @!attribute [rw] snippet
@@ -4363,16 +4724,17 @@ module Aws::QBusiness
4363
4724
  #
4364
4725
  # @!attribute [rw] title
4365
4726
  # The title of the document which is the source for the Amazon Q
4366
- # generated response.
4727
+ # Business generated response.
4367
4728
  # @return [String]
4368
4729
  #
4369
4730
  # @!attribute [rw] updated_at
4370
- # 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.
4371
4733
  # @return [Time]
4372
4734
  #
4373
4735
  # @!attribute [rw] url
4374
4736
  # The URL of the document which is the source for the Amazon Q
4375
- # generated response.
4737
+ # Business generated response.
4376
4738
  # @return [String]
4377
4739
  #
4378
4740
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SourceAttribution AWS API Documentation
@@ -4389,8 +4751,8 @@ module Aws::QBusiness
4389
4751
  end
4390
4752
 
4391
4753
  # @!attribute [rw] application_id
4392
- # The identifier of Amazon Q application the data source is connected
4393
- # to.
4754
+ # The identifier of Amazon Q Business application the data source is
4755
+ # connected to.
4394
4756
  # @return [String]
4395
4757
  #
4396
4758
  # @!attribute [rw] data_source_id
@@ -4424,8 +4786,8 @@ module Aws::QBusiness
4424
4786
  end
4425
4787
 
4426
4788
  # @!attribute [rw] application_id
4427
- # The identifier of the Amazon Q application that the data source is
4428
- # connected to.
4789
+ # The identifier of the Amazon Q Business application that the data
4790
+ # source is connected to.
4429
4791
  # @return [String]
4430
4792
  #
4431
4793
  # @!attribute [rw] data_source_id
@@ -4433,8 +4795,8 @@ module Aws::QBusiness
4433
4795
  # @return [String]
4434
4796
  #
4435
4797
  # @!attribute [rw] index_id
4436
- # The identifier of the index used with the Amazon Q data source
4437
- # connector.
4798
+ # The identifier of the index used with the Amazon Q Business data
4799
+ # source connector.
4438
4800
  # @return [String]
4439
4801
  #
4440
4802
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StopDataSourceSyncJobRequest AWS API Documentation
@@ -4451,13 +4813,84 @@ module Aws::QBusiness
4451
4813
  #
4452
4814
  class StopDataSourceSyncJobResponse < Aws::EmptyStructure; end
4453
4815
 
4816
+ # Provides information on boosting `STRING` type document attributes.
4817
+ #
4818
+ # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
4819
+ # boosting on the console and the API, they must be enabled for search
4820
+ # using the [DocumentAttributeConfiguration][1] object of the
4821
+ # [UpdateIndex][2] API. If you haven't enabled searching on these
4822
+ # attributes, you can't boost attributes of these data types on either
4823
+ # the console or the API.
4824
+ #
4825
+ # </note>
4826
+ #
4827
+ # For more information on how boosting document attributes work in
4828
+ # Amazon Q Business, see [Boosting using document attributes][3].
4829
+ #
4830
+ #
4831
+ #
4832
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html
4833
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html
4834
+ # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
4835
+ #
4836
+ # @!attribute [rw] attribute_value_boosting
4837
+ # Specifies specific values of a `STRING` type document attribute
4838
+ # being boosted.
4839
+ # @return [Hash<String,String>]
4840
+ #
4841
+ # @!attribute [rw] boosting_level
4842
+ # Specifies how much a document attribute is boosted.
4843
+ # @return [String]
4844
+ #
4845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StringAttributeBoostingConfiguration AWS API Documentation
4846
+ #
4847
+ class StringAttributeBoostingConfiguration < Struct.new(
4848
+ :attribute_value_boosting,
4849
+ :boosting_level)
4850
+ SENSITIVE = []
4851
+ include Aws::Structure
4852
+ end
4853
+
4854
+ # Provides information on boosting `STRING_LIST` type document
4855
+ # attributes.
4856
+ #
4857
+ # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
4858
+ # boosting on the console and the API, they must be enabled for search
4859
+ # using the [DocumentAttributeConfiguration][1] object of the
4860
+ # [UpdateIndex][2] API. If you haven't enabled searching on these
4861
+ # attributes, you can't boost attributes of these data types on either
4862
+ # the console or the API.
4863
+ #
4864
+ # </note>
4865
+ #
4866
+ # For more information on how boosting document attributes work in
4867
+ # Amazon Q Business, see [Boosting using document attributes][3].
4868
+ #
4869
+ #
4870
+ #
4871
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html
4872
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html
4873
+ # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
4874
+ #
4875
+ # @!attribute [rw] boosting_level
4876
+ # Specifies how much a document attribute is boosted.
4877
+ # @return [String]
4878
+ #
4879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StringListAttributeBoostingConfiguration AWS API Documentation
4880
+ #
4881
+ class StringListAttributeBoostingConfiguration < Struct.new(
4882
+ :boosting_level)
4883
+ SENSITIVE = []
4884
+ include Aws::Structure
4885
+ end
4886
+
4454
4887
  # A list of key/value pairs that identify an index, FAQ, or data source.
4455
4888
  # Tag keys and values can consist of Unicode letters, digits, white
4456
4889
  # space, and any of the following symbols: \_ . : / = + - @.
4457
4890
  #
4458
4891
  # @!attribute [rw] key
4459
4892
  # The key for the tag. Keys are not case sensitive and must be unique
4460
- # for the Amazon Q application or data source.
4893
+ # for the Amazon Q Business application or data source.
4461
4894
  # @return [String]
4462
4895
  #
4463
4896
  # @!attribute [rw] value
@@ -4475,14 +4908,14 @@ module Aws::QBusiness
4475
4908
  end
4476
4909
 
4477
4910
  # @!attribute [rw] resource_arn
4478
- # The Amazon Resource Name (ARN) of the Amazon Q application or data
4479
- # source to tag.
4911
+ # The Amazon Resource Name (ARN) of the Amazon Q Business application
4912
+ # or data source to tag.
4480
4913
  # @return [String]
4481
4914
  #
4482
4915
  # @!attribute [rw] tags
4483
- # A list of tag keys to add to the Amazon Q application or data
4484
- # source. If a tag already exists, the existing value is replaced with
4485
- # 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.
4486
4919
  # @return [Array<Types::Tag>]
4487
4920
  #
4488
4921
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/TagResourceRequest AWS API Documentation
@@ -4553,12 +4986,13 @@ module Aws::QBusiness
4553
4986
  include Aws::Structure
4554
4987
  end
4555
4988
 
4556
- # The topic specific controls configured for an Amazon Q application.
4989
+ # The topic specific controls configured for an Amazon Q Business
4990
+ # application.
4557
4991
  #
4558
4992
  # @!attribute [rw] description
4559
- # A description for your topic control configuration. Use this outline
4560
- # how the large language model (LLM) should use this topic control
4561
- # configuration.
4993
+ # A description for your topic control configuration. Use this to
4994
+ # outline how the large language model (LLM) should use this topic
4995
+ # control configuration.
4562
4996
  # @return [String]
4563
4997
  #
4564
4998
  # @!attribute [rw] example_chat_messages
@@ -4586,13 +5020,14 @@ module Aws::QBusiness
4586
5020
  end
4587
5021
 
4588
5022
  # @!attribute [rw] resource_arn
4589
- # The Amazon Resource Name (ARN) of the Amazon Q application, or data
4590
- # 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.
4591
5025
  # @return [String]
4592
5026
  #
4593
5027
  # @!attribute [rw] tag_keys
4594
- # A list of tag keys to remove from the Amazon Q application or data
4595
- # 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.
4596
5031
  # @return [Array<String>]
4597
5032
  #
4598
5033
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UntagResourceRequest AWS API Documentation
@@ -4609,7 +5044,7 @@ module Aws::QBusiness
4609
5044
  class UntagResourceResponse < Aws::EmptyStructure; end
4610
5045
 
4611
5046
  # @!attribute [rw] application_id
4612
- # The identifier of the Amazon Q application.
5047
+ # The identifier of the Amazon Q Business application.
4613
5048
  # @return [String]
4614
5049
  #
4615
5050
  # @!attribute [rw] attachments_configuration
@@ -4617,17 +5052,17 @@ module Aws::QBusiness
4617
5052
  # @return [Types::AttachmentsConfiguration]
4618
5053
  #
4619
5054
  # @!attribute [rw] description
4620
- # A description for the Amazon Q application.
5055
+ # A description for the Amazon Q Business application.
4621
5056
  # @return [String]
4622
5057
  #
4623
5058
  # @!attribute [rw] display_name
4624
- # A name for the Amazon Q application.
5059
+ # A name for the Amazon Q Business application.
4625
5060
  # @return [String]
4626
5061
  #
4627
5062
  # @!attribute [rw] role_arn
4628
5063
  # An Amazon Web Services Identity and Access Management (IAM) role
4629
- # that gives Amazon Q permission to access Amazon CloudWatch logs and
4630
- # metrics.
5064
+ # that gives Amazon Q Business permission to access Amazon CloudWatch
5065
+ # logs and metrics.
4631
5066
  # @return [String]
4632
5067
  #
4633
5068
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateApplicationRequest AWS API Documentation
@@ -4657,12 +5092,16 @@ module Aws::QBusiness
4657
5092
  #
4658
5093
  # @!attribute [rw] client_token
4659
5094
  # A token that you provide to identify the request to update a Amazon
4660
- # Q application chat configuration.
5095
+ # Q Business application chat configuration.
4661
5096
  #
4662
5097
  # **A suitable default value is auto-generated.** You should normally
4663
5098
  # not need to pass this option.
4664
5099
  # @return [String]
4665
5100
  #
5101
+ # @!attribute [rw] creator_mode_configuration
5102
+ # The configuration details for `CREATOR_MODE`.
5103
+ # @return [Types::CreatorModeConfiguration]
5104
+ #
4666
5105
  # @!attribute [rw] response_scope
4667
5106
  # The response scope configured for your application. This determines
4668
5107
  # whether your application uses its retrieval augmented generation
@@ -4685,6 +5124,7 @@ module Aws::QBusiness
4685
5124
  :application_id,
4686
5125
  :blocked_phrases_configuration_update,
4687
5126
  :client_token,
5127
+ :creator_mode_configuration,
4688
5128
  :response_scope,
4689
5129
  :topic_configurations_to_create_or_update,
4690
5130
  :topic_configurations_to_delete)
@@ -4697,12 +5137,13 @@ module Aws::QBusiness
4697
5137
  class UpdateChatControlsConfigurationResponse < Aws::EmptyStructure; end
4698
5138
 
4699
5139
  # @!attribute [rw] application_id
4700
- # The identifier of the Amazon Q application the data source is
4701
- # attached to.
5140
+ # The identifier of the Amazon Q Business application the data source
5141
+ # is attached to.
4702
5142
  # @return [String]
4703
5143
  #
4704
5144
  # @!attribute [rw] configuration
4705
- # Provides the configuration information for an Amazon Q data source.
5145
+ # Provides the configuration information for an Amazon Q Business data
5146
+ # source.
4706
5147
  # @return [Hash,Array,String,Numeric,Boolean]
4707
5148
  #
4708
5149
  # @!attribute [rw] data_source_id
@@ -4768,20 +5209,22 @@ module Aws::QBusiness
4768
5209
  class UpdateDataSourceResponse < Aws::EmptyStructure; end
4769
5210
 
4770
5211
  # @!attribute [rw] application_id
4771
- # 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.
4772
5214
  # @return [String]
4773
5215
  #
4774
5216
  # @!attribute [rw] capacity_configuration
4775
5217
  # The storage capacity units you want to provision for your Amazon Q
4776
- # 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.
4777
5220
  # @return [Types::IndexCapacityConfiguration]
4778
5221
  #
4779
5222
  # @!attribute [rw] description
4780
- # The description of the Amazon Q index.
5223
+ # The description of the Amazon Q Business index.
4781
5224
  # @return [String]
4782
5225
  #
4783
5226
  # @!attribute [rw] display_name
4784
- # The name of the Amazon Q index.
5227
+ # The name of the Amazon Q Business index.
4785
5228
  # @return [String]
4786
5229
  #
4787
5230
  # @!attribute [rw] document_attribute_configurations
@@ -4797,7 +5240,7 @@ module Aws::QBusiness
4797
5240
  # @return [Array<Types::DocumentAttributeConfiguration>]
4798
5241
  #
4799
5242
  # @!attribute [rw] index_id
4800
- # The identifier of the Amazon Q index.
5243
+ # The identifier of the Amazon Q Business index.
4801
5244
  # @return [String]
4802
5245
  #
4803
5246
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateIndexRequest AWS API Documentation
@@ -4859,12 +5302,12 @@ module Aws::QBusiness
4859
5302
  class UpdatePluginResponse < Aws::EmptyStructure; end
4860
5303
 
4861
5304
  # @!attribute [rw] application_id
4862
- # The identifier of your Amazon Q application.
5305
+ # The identifier of your Amazon Q Business application.
4863
5306
  # @return [String]
4864
5307
  #
4865
5308
  # @!attribute [rw] configuration
4866
5309
  # Provides information on how the retriever used for your Amazon Q
4867
- # application is configured.
5310
+ # Business application is configured.
4868
5311
  # @return [Types::RetrieverConfiguration]
4869
5312
  #
4870
5313
  # @!attribute [rw] display_name
@@ -4946,12 +5389,13 @@ module Aws::QBusiness
4946
5389
  end
4947
5390
 
4948
5391
  # @!attribute [rw] application_id
4949
- # The identifier of the Amazon Q application attached to the web
4950
- # experience.
5392
+ # The identifier of the Amazon Q Business application attached to the
5393
+ # web experience.
4951
5394
  # @return [String]
4952
5395
  #
4953
5396
  # @!attribute [rw] authentication_configuration
4954
- # The authentication configuration of the Amazon Q web experience.
5397
+ # The authentication configuration of the Amazon Q Business web
5398
+ # experience.
4955
5399
  # @return [Types::WebExperienceAuthConfiguration]
4956
5400
  #
4957
5401
  # @!attribute [rw] sample_prompts_control_mode
@@ -4960,20 +5404,20 @@ module Aws::QBusiness
4960
5404
  # @return [String]
4961
5405
  #
4962
5406
  # @!attribute [rw] subtitle
4963
- # The subtitle of the Amazon Q web experience.
5407
+ # The subtitle of the Amazon Q Business web experience.
4964
5408
  # @return [String]
4965
5409
  #
4966
5410
  # @!attribute [rw] title
4967
- # The title of the Amazon Q web experience.
5411
+ # The title of the Amazon Q Business web experience.
4968
5412
  # @return [String]
4969
5413
  #
4970
5414
  # @!attribute [rw] web_experience_id
4971
- # The identifier of the Amazon Q web experience.
5415
+ # The identifier of the Amazon Q Business web experience.
4972
5416
  # @return [String]
4973
5417
  #
4974
5418
  # @!attribute [rw] welcome_message
4975
- # A customized welcome message for an end user in an Amazon Q web
4976
- # experience.
5419
+ # A customized welcome message for an end user in an Amazon Q Business
5420
+ # web experience.
4977
5421
  # @return [String]
4978
5422
  #
4979
5423
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperienceRequest AWS API Documentation
@@ -4994,7 +5438,7 @@ module Aws::QBusiness
4994
5438
  #
4995
5439
  class UpdateWebExperienceResponse < Aws::EmptyStructure; end
4996
5440
 
4997
- # Aliases attached to a user id within an Amazon Q application.
5441
+ # Aliases attached to a user id within an Amazon Q Business application.
4998
5442
  #
4999
5443
  # @!attribute [rw] data_source_id
5000
5444
  # The identifier of the data source that the user aliases are
@@ -5040,8 +5484,8 @@ module Aws::QBusiness
5040
5484
  include Aws::Structure
5041
5485
  end
5042
5486
 
5043
- # The input doesn't meet the constraints set by the Amazon Q service.
5044
- # 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.
5045
5489
  #
5046
5490
  # @!attribute [rw] fields
5047
5491
  # The input field(s) that failed validation.
@@ -5065,8 +5509,8 @@ module Aws::QBusiness
5065
5509
  include Aws::Structure
5066
5510
  end
5067
5511
 
5068
- # The input failed to meet the constraints specified by Amazon Q in a
5069
- # specified field.
5512
+ # The input failed to meet the constraints specified by Amazon Q
5513
+ # Business in a specified field.
5070
5514
  #
5071
5515
  # @!attribute [rw] message
5072
5516
  # A message about the validation exception.
@@ -5085,27 +5529,29 @@ module Aws::QBusiness
5085
5529
  include Aws::Structure
5086
5530
  end
5087
5531
 
5088
- # Provides information for an Amazon Q web experience.
5532
+ # Provides information for an Amazon Q Business web experience.
5089
5533
  #
5090
5534
  # @!attribute [rw] created_at
5091
- # 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.
5092
5537
  # @return [Time]
5093
5538
  #
5094
5539
  # @!attribute [rw] default_endpoint
5095
- # The endpoint URLs for your Amazon Q web experience. The URLs are
5096
- # 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.
5097
5542
  # @return [String]
5098
5543
  #
5099
5544
  # @!attribute [rw] status
5100
- # The status of your Amazon Q web experience.
5545
+ # The status of your Amazon Q Business web experience.
5101
5546
  # @return [String]
5102
5547
  #
5103
5548
  # @!attribute [rw] updated_at
5104
- # 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.
5105
5551
  # @return [Time]
5106
5552
  #
5107
5553
  # @!attribute [rw] web_experience_id
5108
- # The identifier of your Amazon Q web experience.
5554
+ # The identifier of your Amazon Q Business web experience.
5109
5555
  # @return [String]
5110
5556
  #
5111
5557
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/WebExperience AWS API Documentation
@@ -5121,7 +5567,7 @@ module Aws::QBusiness
5121
5567
  end
5122
5568
 
5123
5569
  # Provides the authorization configuration information needed to deploy
5124
- # a Amazon Q web experience to end users.
5570
+ # a Amazon Q Business web experience to end users.
5125
5571
  #
5126
5572
  # @note WebExperienceAuthConfiguration is a union - when making an API calls you must set exactly one of the members.
5127
5573
  #
@@ -5129,8 +5575,8 @@ module Aws::QBusiness
5129
5575
  #
5130
5576
  # @!attribute [rw] saml_configuration
5131
5577
  # Provides the SAML 2.0 compliant identity provider (IdP)
5132
- # configuration information Amazon Q needs to deploy a Amazon Q web
5133
- # experience.
5578
+ # configuration information Amazon Q Business needs to deploy a Amazon
5579
+ # Q Business web experience.
5134
5580
  # @return [Types::SamlConfiguration]
5135
5581
  #
5136
5582
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/WebExperienceAuthConfiguration AWS API Documentation