aws-sdk-qbusiness 1.22.0 → 1.24.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -106,6 +106,25 @@ module Aws::QBusiness
106
106
  include Aws::Structure
107
107
  end
108
108
 
109
+ # Specifies an allowed action and its associated filter configuration.
110
+ #
111
+ # @!attribute [rw] action
112
+ # The Q Business action that is allowed.
113
+ # @return [String]
114
+ #
115
+ # @!attribute [rw] filter_configuration
116
+ # The filter configuration for the action, if any.
117
+ # @return [Types::ActionFilterConfiguration]
118
+ #
119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ActionConfiguration AWS API Documentation
120
+ #
121
+ class ActionConfiguration < Struct.new(
122
+ :action,
123
+ :filter_configuration)
124
+ SENSITIVE = []
125
+ include Aws::Structure
126
+ end
127
+
109
128
  # Performs an Amazon Q Business plugin action during a non-streaming
110
129
  # chat conversation.
111
130
  #
@@ -179,6 +198,21 @@ module Aws::QBusiness
179
198
  include Aws::Structure
180
199
  end
181
200
 
201
+ # Specifies filters to apply to an allowed action.
202
+ #
203
+ # @!attribute [rw] document_attribute_filter
204
+ # Enables filtering of responses based on document attributes or
205
+ # metadata fields.
206
+ # @return [Types::AttributeFilter]
207
+ #
208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ActionFilterConfiguration AWS API Documentation
209
+ #
210
+ class ActionFilterConfiguration < Struct.new(
211
+ :document_attribute_filter)
212
+ SENSITIVE = []
213
+ include Aws::Structure
214
+ end
215
+
182
216
  # An output event that Amazon Q Business returns to an user who wants to
183
217
  # perform a plugin action during a non-streaming chat conversation. It
184
218
  # contains information about the selected action with a list of possible
@@ -350,6 +384,43 @@ module Aws::QBusiness
350
384
  include Aws::Structure
351
385
  end
352
386
 
387
+ # Summary information for an Amazon Q Business plugin action.
388
+ #
389
+ # @!attribute [rw] action_identifier
390
+ # The identifier of an Amazon Q Business plugin action.
391
+ # @return [String]
392
+ #
393
+ # @!attribute [rw] display_name
394
+ # The display name assigned by Amazon Q Business to a plugin action.
395
+ # You can't modify this value.
396
+ # @return [String]
397
+ #
398
+ # @!attribute [rw] instruction_example
399
+ # An Amazon Q Business suggested prompt and end user can use to invoke
400
+ # a plugin action. This value can be modified and sent as input to
401
+ # initiate an action. For example:
402
+ #
403
+ # * Create a Jira task
404
+ #
405
+ # * Create a chat assistant task to find the root cause of a specific
406
+ # incident
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] description
410
+ # The description of an Amazon Q Business plugin action.
411
+ # @return [String]
412
+ #
413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ActionSummary AWS API Documentation
414
+ #
415
+ class ActionSummary < Struct.new(
416
+ :action_identifier,
417
+ :display_name,
418
+ :instruction_example,
419
+ :description)
420
+ SENSITIVE = []
421
+ include Aws::Structure
422
+ end
423
+
353
424
  # Summary information for an Amazon Q Business application.
354
425
  #
355
426
  # @!attribute [rw] display_name
@@ -380,6 +451,11 @@ module Aws::QBusiness
380
451
  # application.
381
452
  # @return [String]
382
453
  #
454
+ # @!attribute [rw] quick_sight_configuration
455
+ # The Amazon QuickSight configuration for an Amazon Q Business
456
+ # application that uses QuickSight as the identity provider.
457
+ # @return [Types::QuickSightConfiguration]
458
+ #
383
459
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Application AWS API Documentation
384
460
  #
385
461
  class Application < Struct.new(
@@ -388,7 +464,8 @@ module Aws::QBusiness
388
464
  :created_at,
389
465
  :updated_at,
390
466
  :status,
391
- :identity_type)
467
+ :identity_type,
468
+ :quick_sight_configuration)
392
469
  SENSITIVE = []
393
470
  include Aws::Structure
394
471
  end
@@ -434,21 +511,131 @@ module Aws::QBusiness
434
511
  include Aws::Structure
435
512
  end
436
513
 
437
- # A file directly uploaded into a web experience chat.
514
+ # @!attribute [rw] application_id
515
+ # The unique identifier of the Q Business application.
516
+ # @return [String]
517
+ #
518
+ # @!attribute [rw] statement_id
519
+ # A unique identifier for the policy statement.
520
+ # @return [String]
521
+ #
522
+ # @!attribute [rw] actions
523
+ # The list of Q Business actions that the ISV is allowed to perform.
524
+ # @return [Array<String>]
525
+ #
526
+ # @!attribute [rw] principal
527
+ # The Amazon Resource Name (ARN) of the IAM role for the ISV that is
528
+ # being granted permission.
529
+ # @return [String]
530
+ #
531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AssociatePermissionRequest AWS API Documentation
532
+ #
533
+ class AssociatePermissionRequest < Struct.new(
534
+ :application_id,
535
+ :statement_id,
536
+ :actions,
537
+ :principal)
538
+ SENSITIVE = []
539
+ include Aws::Structure
540
+ end
541
+
542
+ # @!attribute [rw] statement
543
+ # The JSON representation of the added permission statement.
544
+ # @return [String]
545
+ #
546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AssociatePermissionResponse AWS API Documentation
547
+ #
548
+ class AssociatePermissionResponse < Struct.new(
549
+ :statement)
550
+ SENSITIVE = []
551
+ include Aws::Structure
552
+ end
553
+
554
+ # An attachment in an Amazon Q Business conversation.
555
+ #
556
+ # @!attribute [rw] attachment_id
557
+ # The identifier of the Amazon Q Business attachment.
558
+ # @return [String]
559
+ #
560
+ # @!attribute [rw] conversation_id
561
+ # The identifier of the Amazon Q Business conversation the attachment
562
+ # is associated with.
563
+ # @return [String]
438
564
  #
439
565
  # @!attribute [rw] name
440
- # The name of the file.
566
+ # Filename of the Amazon Q Business attachment.
567
+ # @return [String]
568
+ #
569
+ # @!attribute [rw] copy_from
570
+ # A CopyFromSource containing a reference to the original source of
571
+ # the Amazon Q Business attachment.
572
+ # @return [Types::CopyFromSource]
573
+ #
574
+ # @!attribute [rw] file_type
575
+ # Filetype of the Amazon Q Business attachment.
576
+ # @return [String]
577
+ #
578
+ # @!attribute [rw] file_size
579
+ # Size in bytes of the Amazon Q Business attachment.
580
+ # @return [Integer]
581
+ #
582
+ # @!attribute [rw] md5chksum
583
+ # MD5 checksum of the Amazon Q Business attachment contents.
584
+ # @return [String]
585
+ #
586
+ # @!attribute [rw] created_at
587
+ # The Unix timestamp when the Amazon Q Business attachment was
588
+ # created.
589
+ # @return [Time]
590
+ #
591
+ # @!attribute [rw] status
592
+ # AttachmentStatus of the Amazon Q Business attachment.
441
593
  # @return [String]
442
594
  #
595
+ # @!attribute [rw] error
596
+ # ErrorDetail providing information about a Amazon Q Business
597
+ # attachment error.
598
+ # @return [Types::ErrorDetail]
599
+ #
600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Attachment AWS API Documentation
601
+ #
602
+ class Attachment < Struct.new(
603
+ :attachment_id,
604
+ :conversation_id,
605
+ :name,
606
+ :copy_from,
607
+ :file_type,
608
+ :file_size,
609
+ :md5chksum,
610
+ :created_at,
611
+ :status,
612
+ :error)
613
+ SENSITIVE = []
614
+ include Aws::Structure
615
+ end
616
+
617
+ # This is either a file directly uploaded into a web experience chat or
618
+ # a reference to an existing attachment that is part of a web experience
619
+ # chat.
620
+ #
443
621
  # @!attribute [rw] data
444
- # The data contained within the uploaded file.
622
+ # The contents of the attachment.
445
623
  # @return [String]
446
624
  #
625
+ # @!attribute [rw] name
626
+ # The filename of the attachment.
627
+ # @return [String]
628
+ #
629
+ # @!attribute [rw] copy_from
630
+ # A reference to an existing attachment.
631
+ # @return [Types::CopyFromSource]
632
+ #
447
633
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AttachmentInput AWS API Documentation
448
634
  #
449
635
  class AttachmentInput < Struct.new(
636
+ :data,
450
637
  :name,
451
- :data)
638
+ :copy_from)
452
639
  SENSITIVE = []
453
640
  include Aws::Structure
454
641
  end
@@ -457,7 +644,9 @@ module Aws::QBusiness
457
644
  # into their web experience chat.
458
645
  #
459
646
  # @!attribute [rw] attachment
460
- # A file directly uploaded into a web experience chat.
647
+ # This is either a file directly uploaded into a web experience chat
648
+ # or a reference to an existing attachment that is part of a web
649
+ # experience chat.
461
650
  # @return [Types::AttachmentInput]
462
651
  #
463
652
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AttachmentInputEvent AWS API Documentation
@@ -483,12 +672,22 @@ module Aws::QBusiness
483
672
  # An error associated with a file uploaded during chat.
484
673
  # @return [Types::ErrorDetail]
485
674
  #
675
+ # @!attribute [rw] attachment_id
676
+ # The unique identifier of the Amazon Q Business attachment.
677
+ # @return [String]
678
+ #
679
+ # @!attribute [rw] conversation_id
680
+ # The unique identifier of the Amazon Q Business conversation.
681
+ # @return [String]
682
+ #
486
683
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AttachmentOutput AWS API Documentation
487
684
  #
488
685
  class AttachmentOutput < Struct.new(
489
686
  :name,
490
687
  :status,
491
- :error)
688
+ :error,
689
+ :attachment_id,
690
+ :conversation_id)
492
691
  SENSITIVE = []
493
692
  include Aws::Structure
494
693
  end
@@ -870,6 +1069,30 @@ module Aws::QBusiness
870
1069
  include Aws::Structure
871
1070
  end
872
1071
 
1072
+ # The container for browser extension configuration for an Amazon Q
1073
+ # Business web experience.
1074
+ #
1075
+ # @!attribute [rw] enabled_browser_extensions
1076
+ # Specify the browser extensions allowed for your Amazon Q web
1077
+ # experience.
1078
+ #
1079
+ # * `CHROME` — Enables the extension for Chromium-based browsers
1080
+ # (Google Chrome, Microsoft Edge, Opera, etc.).
1081
+ #
1082
+ # * `FIREFOX` — Enables the extension for Mozilla Firefox.
1083
+ #
1084
+ # * `CHROME` and `FIREFOX` — Enable the extension for Chromium-based
1085
+ # browsers and Mozilla Firefox.
1086
+ # @return [Array<String>]
1087
+ #
1088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BrowserExtensionConfiguration AWS API Documentation
1089
+ #
1090
+ class BrowserExtensionConfiguration < Struct.new(
1091
+ :enabled_browser_extensions)
1092
+ SENSITIVE = []
1093
+ include Aws::Structure
1094
+ end
1095
+
873
1096
  # @!attribute [rw] application_id
874
1097
  # The identifier of the Amazon Q Business application linked to a
875
1098
  # streaming Amazon Q Business conversation.
@@ -1006,22 +1229,34 @@ module Aws::QBusiness
1006
1229
  # @return [Types::AttributeFilter]
1007
1230
  #
1008
1231
  # @!attribute [rw] chat_mode
1009
- # The chat modes available to an Amazon Q Business end user.
1232
+ # The `chatMode` parameter determines the chat modes available to
1233
+ # Amazon Q Business users:
1234
+ #
1235
+ # * `RETRIEVAL_MODE` - If you choose this mode, Amazon Q generates
1236
+ # responses solely from the data sources connected and indexed by
1237
+ # the application. If an answer is not found in the data sources or
1238
+ # there are no data sources available, Amazon Q will respond with a
1239
+ # "*No Answer Found*" message, unless LLM knowledge has been
1240
+ # enabled. In that case, Amazon Q will generate a response from the
1241
+ # LLM knowledge
1242
+ #
1243
+ # * `CREATOR_MODE` - By selecting this mode, you can choose to
1244
+ # generate responses only from the LLM knowledge. You can also
1245
+ # attach files and have Amazon Q generate a response based on the
1246
+ # data in those files. If the attached files do not contain an
1247
+ # answer for the query, Amazon Q will automatically fall back to
1248
+ # generating a response from the LLM knowledge.
1010
1249
  #
1011
- # * `RETRIEVAL_MODE` - The default chat mode for an Amazon Q Business
1012
- # application. When this mode is enabled, Amazon Q Business
1013
- # generates responses only from data sources connected to an Amazon
1014
- # Q Business application.
1250
+ # * `PLUGIN_MODE` - By selecting this mode, users can choose to use
1251
+ # plugins in chat to get their responses.
1015
1252
  #
1016
- # * `CREATOR_MODE` - By selecting this mode, users can choose to
1017
- # generate responses only from the LLM knowledge, without consulting
1018
- # connected data sources, for a chat request.
1253
+ # <note markdown="1"> If none of the modes are selected, Amazon Q will only respond using
1254
+ # the information from the attached files.
1019
1255
  #
1020
- # * `PLUGIN_MODE` - By selecting this mode, users can choose to use
1021
- # plugins in chat.
1256
+ # </note>
1022
1257
  #
1023
1258
  # For more information, see [Admin controls and guardrails][1],
1024
- # [Plugins][2], and [Conversation settings][3].
1259
+ # [Plugins][2], and [Response sources][3].
1025
1260
  #
1026
1261
  #
1027
1262
  #
@@ -1170,7 +1405,7 @@ module Aws::QBusiness
1170
1405
  end
1171
1406
 
1172
1407
  # You are trying to perform an action that conflicts with the current
1173
- # status of your resource. Fix any inconsistences with your resources
1408
+ # status of your resource. Fix any inconsistencies with your resources
1174
1409
  # and try again.
1175
1410
  #
1176
1411
  # @!attribute [rw] message
@@ -1229,6 +1464,27 @@ module Aws::QBusiness
1229
1464
  include Aws::Structure
1230
1465
  end
1231
1466
 
1467
+ # Specifies the source of content to search in.
1468
+ #
1469
+ # @note ContentSource is a union - when making an API calls you must set exactly one of the members.
1470
+ #
1471
+ # @!attribute [rw] retriever
1472
+ # The retriever to use as the content source.
1473
+ # @return [Types::RetrieverContentSource]
1474
+ #
1475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ContentSource AWS API Documentation
1476
+ #
1477
+ class ContentSource < Struct.new(
1478
+ :retriever,
1479
+ :unknown)
1480
+ SENSITIVE = []
1481
+ include Aws::Structure
1482
+ include Aws::Structure::Union
1483
+
1484
+ class Retriever < ContentSource; end
1485
+ class Unknown < ContentSource; end
1486
+ end
1487
+
1232
1488
  # A conversation in an Amazon Q Business application.
1233
1489
  #
1234
1490
  # @!attribute [rw] conversation_id
@@ -1253,6 +1509,49 @@ module Aws::QBusiness
1253
1509
  include Aws::Structure
1254
1510
  end
1255
1511
 
1512
+ # The source reference for an existing attachment in an existing
1513
+ # conversation.
1514
+ #
1515
+ # @!attribute [rw] conversation_id
1516
+ # The unique identifier of the Amazon Q Business conversation.
1517
+ # @return [String]
1518
+ #
1519
+ # @!attribute [rw] attachment_id
1520
+ # The unique identifier of the Amazon Q Business attachment.
1521
+ # @return [String]
1522
+ #
1523
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ConversationSource AWS API Documentation
1524
+ #
1525
+ class ConversationSource < Struct.new(
1526
+ :conversation_id,
1527
+ :attachment_id)
1528
+ SENSITIVE = []
1529
+ include Aws::Structure
1530
+ end
1531
+
1532
+ # The source reference for an existing attachment.
1533
+ #
1534
+ # @note CopyFromSource is a union - when making an API calls you must set exactly one of the members.
1535
+ #
1536
+ # @note CopyFromSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CopyFromSource corresponding to the set member.
1537
+ #
1538
+ # @!attribute [rw] conversation
1539
+ # A reference to an attachment in an existing conversation.
1540
+ # @return [Types::ConversationSource]
1541
+ #
1542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CopyFromSource AWS API Documentation
1543
+ #
1544
+ class CopyFromSource < Struct.new(
1545
+ :conversation,
1546
+ :unknown)
1547
+ SENSITIVE = []
1548
+ include Aws::Structure
1549
+ include Aws::Structure::Union
1550
+
1551
+ class Conversation < CopyFromSource; end
1552
+ class Unknown < CopyFromSource; end
1553
+ end
1554
+
1256
1555
  # @!attribute [rw] display_name
1257
1556
  # A name for the Amazon Q Business application.
1258
1557
  # @return [String]
@@ -1331,6 +1630,18 @@ module Aws::QBusiness
1331
1630
  # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html
1332
1631
  # @return [Types::PersonalizationConfiguration]
1333
1632
  #
1633
+ # @!attribute [rw] quick_sight_configuration
1634
+ # The Amazon QuickSight configuration for an Amazon Q Business
1635
+ # application that uses QuickSight for authentication. This
1636
+ # configuration is required if your application uses QuickSight as the
1637
+ # identity provider. For more information, see [Creating an Amazon
1638
+ # QuickSight integrated application][1].
1639
+ #
1640
+ #
1641
+ #
1642
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html
1643
+ # @return [Types::QuickSightConfiguration]
1644
+ #
1334
1645
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateApplicationRequest AWS API Documentation
1335
1646
  #
1336
1647
  class CreateApplicationRequest < Struct.new(
@@ -1346,7 +1657,8 @@ module Aws::QBusiness
1346
1657
  :client_token,
1347
1658
  :attachments_configuration,
1348
1659
  :q_apps_configuration,
1349
- :personalization_configuration)
1660
+ :personalization_configuration,
1661
+ :quick_sight_configuration)
1350
1662
  SENSITIVE = []
1351
1663
  include Aws::Structure
1352
1664
  end
@@ -1368,6 +1680,72 @@ module Aws::QBusiness
1368
1680
  include Aws::Structure
1369
1681
  end
1370
1682
 
1683
+ # @!attribute [rw] application_id
1684
+ # The unique identifier of the Q Business application.
1685
+ # @return [String]
1686
+ #
1687
+ # @!attribute [rw] principal
1688
+ # The Amazon Resource Name (ARN) of the IAM role for the ISV that will
1689
+ # be accessing the data.
1690
+ # @return [String]
1691
+ #
1692
+ # @!attribute [rw] action_configurations
1693
+ # A list of action configurations specifying the allowed actions and
1694
+ # any associated filters.
1695
+ # @return [Array<Types::ActionConfiguration>]
1696
+ #
1697
+ # @!attribute [rw] client_token
1698
+ # A unique, case-sensitive identifier you provide to ensure
1699
+ # idempotency of the request.
1700
+ #
1701
+ # **A suitable default value is auto-generated.** You should normally
1702
+ # not need to pass this option.
1703
+ # @return [String]
1704
+ #
1705
+ # @!attribute [rw] display_name
1706
+ # A friendly name for the data accessor.
1707
+ # @return [String]
1708
+ #
1709
+ # @!attribute [rw] tags
1710
+ # The tags to associate with the data accessor.
1711
+ # @return [Array<Types::Tag>]
1712
+ #
1713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateDataAccessorRequest AWS API Documentation
1714
+ #
1715
+ class CreateDataAccessorRequest < Struct.new(
1716
+ :application_id,
1717
+ :principal,
1718
+ :action_configurations,
1719
+ :client_token,
1720
+ :display_name,
1721
+ :tags)
1722
+ SENSITIVE = [:display_name]
1723
+ include Aws::Structure
1724
+ end
1725
+
1726
+ # @!attribute [rw] data_accessor_id
1727
+ # The unique identifier of the created data accessor.
1728
+ # @return [String]
1729
+ #
1730
+ # @!attribute [rw] idc_application_arn
1731
+ # The Amazon Resource Name (ARN) of the AWS IAM Identity Center
1732
+ # application created for this data accessor.
1733
+ # @return [String]
1734
+ #
1735
+ # @!attribute [rw] data_accessor_arn
1736
+ # The Amazon Resource Name (ARN) of the created data accessor.
1737
+ # @return [String]
1738
+ #
1739
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateDataAccessorResponse AWS API Documentation
1740
+ #
1741
+ class CreateDataAccessorResponse < Struct.new(
1742
+ :data_accessor_id,
1743
+ :idc_application_arn,
1744
+ :data_accessor_arn)
1745
+ SENSITIVE = []
1746
+ include Aws::Structure
1747
+ end
1748
+
1371
1749
  # @!attribute [rw] application_id
1372
1750
  # The identifier of the Amazon Q Business application the data source
1373
1751
  # will be attached to.
@@ -1470,6 +1848,11 @@ module Aws::QBusiness
1470
1848
  # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
1471
1849
  # @return [Types::DocumentEnrichmentConfiguration]
1472
1850
  #
1851
+ # @!attribute [rw] media_extraction_configuration
1852
+ # The configuration for extracting information from media in documents
1853
+ # during ingestion.
1854
+ # @return [Types::MediaExtractionConfiguration]
1855
+ #
1473
1856
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateDataSourceRequest AWS API Documentation
1474
1857
  #
1475
1858
  class CreateDataSourceRequest < Struct.new(
@@ -1483,7 +1866,8 @@ module Aws::QBusiness
1483
1866
  :sync_schedule,
1484
1867
  :role_arn,
1485
1868
  :client_token,
1486
- :document_enrichment_configuration)
1869
+ :document_enrichment_configuration,
1870
+ :media_extraction_configuration)
1487
1871
  SENSITIVE = []
1488
1872
  include Aws::Structure
1489
1873
  end
@@ -1514,6 +1898,10 @@ module Aws::QBusiness
1514
1898
  # A name for the Amazon Q Business index.
1515
1899
  # @return [String]
1516
1900
  #
1901
+ # @!attribute [rw] description
1902
+ # A description for the Amazon Q Business index.
1903
+ # @return [String]
1904
+ #
1517
1905
  # @!attribute [rw] type
1518
1906
  # The index type that's suitable for your needs. For more information
1519
1907
  # on what's included in each type of index, see [Amazon Q Business
@@ -1524,10 +1912,6 @@ module Aws::QBusiness
1524
1912
  # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers
1525
1913
  # @return [String]
1526
1914
  #
1527
- # @!attribute [rw] description
1528
- # A description for the Amazon Q Business index.
1529
- # @return [String]
1530
- #
1531
1915
  # @!attribute [rw] tags
1532
1916
  # A list of key-value pairs that identify or categorize the index. You
1533
1917
  # can also use tags to help control access to the index. Tag keys and
@@ -1554,8 +1938,8 @@ module Aws::QBusiness
1554
1938
  class CreateIndexRequest < Struct.new(
1555
1939
  :application_id,
1556
1940
  :display_name,
1557
- :type,
1558
1941
  :description,
1942
+ :type,
1559
1943
  :tags,
1560
1944
  :capacity_configuration,
1561
1945
  :client_token)
@@ -1828,6 +2212,28 @@ module Aws::QBusiness
1828
2212
  # end users of an Amazon Q Business web experience.
1829
2213
  # @return [Types::IdentityProviderConfiguration]
1830
2214
  #
2215
+ # @!attribute [rw] browser_extension_configuration
2216
+ # The browser extension configuration for an Amazon Q Business web
2217
+ # experience.
2218
+ #
2219
+ # <note markdown="1"> For Amazon Q Business application using external OIDC-compliant
2220
+ # identity providers (IdPs). The IdP administrator must add the
2221
+ # browser extension sign-in redirect URLs to the IdP application. For
2222
+ # more information, see [Configure external OIDC identity provider for
2223
+ # your browser extensions.][1].
2224
+ #
2225
+ # </note>
2226
+ #
2227
+ #
2228
+ #
2229
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html
2230
+ # @return [Types::BrowserExtensionConfiguration]
2231
+ #
2232
+ # @!attribute [rw] customization_configuration
2233
+ # Sets the custom logo, favicon, font, and color used in the Amazon Q
2234
+ # web experience.
2235
+ # @return [Types::CustomizationConfiguration]
2236
+ #
1831
2237
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateWebExperienceRequest AWS API Documentation
1832
2238
  #
1833
2239
  class CreateWebExperienceRequest < Struct.new(
@@ -1840,7 +2246,9 @@ module Aws::QBusiness
1840
2246
  :role_arn,
1841
2247
  :tags,
1842
2248
  :client_token,
1843
- :identity_provider_configuration)
2249
+ :identity_provider_configuration,
2250
+ :browser_extension_configuration,
2251
+ :customization_configuration)
1844
2252
  SENSITIVE = []
1845
2253
  include Aws::Structure
1846
2254
  end
@@ -1912,39 +2320,120 @@ module Aws::QBusiness
1912
2320
  include Aws::Structure
1913
2321
  end
1914
2322
 
1915
- # A data source in an Amazon Q Business application.
2323
+ # Contains the configuration information to customize the logo, font,
2324
+ # and color of an Amazon Q Business web experience with individual files
2325
+ # for each property or a CSS file for them all.
1916
2326
  #
1917
- # @!attribute [rw] display_name
1918
- # The name of the Amazon Q Business data source.
2327
+ # @!attribute [rw] custom_css_url
2328
+ # Provides the URL where the custom CSS file is hosted for an Amazon Q
2329
+ # web experience.
1919
2330
  # @return [String]
1920
2331
  #
1921
- # @!attribute [rw] data_source_id
1922
- # The identifier of the Amazon Q Business data source.
2332
+ # @!attribute [rw] logo_url
2333
+ # Provides the URL where the custom logo file is hosted for an Amazon
2334
+ # Q web experience.
1923
2335
  # @return [String]
1924
2336
  #
1925
- # @!attribute [rw] type
1926
- # The type of the Amazon Q Business data source.
2337
+ # @!attribute [rw] font_url
2338
+ # Provides the URL where the custom font file is hosted for an Amazon
2339
+ # Q web experience.
1927
2340
  # @return [String]
1928
2341
  #
1929
- # @!attribute [rw] created_at
1930
- # The Unix timestamp when the Amazon Q Business data source was
1931
- # created.
1932
- # @return [Time]
1933
- #
1934
- # @!attribute [rw] updated_at
1935
- # The Unix timestamp when the Amazon Q Business data source was last
1936
- # updated.
1937
- # @return [Time]
1938
- #
1939
- # @!attribute [rw] status
1940
- # The status of the Amazon Q Business data source.
2342
+ # @!attribute [rw] favicon_url
2343
+ # Provides the URL where the custom favicon file is hosted for an
2344
+ # Amazon Q web experience.
1941
2345
  # @return [String]
1942
2346
  #
1943
- # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DataSource AWS API Documentation
2347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CustomizationConfiguration AWS API Documentation
1944
2348
  #
1945
- class DataSource < Struct.new(
1946
- :display_name,
1947
- :data_source_id,
2349
+ class CustomizationConfiguration < Struct.new(
2350
+ :custom_css_url,
2351
+ :logo_url,
2352
+ :font_url,
2353
+ :favicon_url)
2354
+ SENSITIVE = []
2355
+ include Aws::Structure
2356
+ end
2357
+
2358
+ # Provides summary information about a data accessor.
2359
+ #
2360
+ # @!attribute [rw] display_name
2361
+ # The friendly name of the data accessor.
2362
+ # @return [String]
2363
+ #
2364
+ # @!attribute [rw] data_accessor_id
2365
+ # The unique identifier of the data accessor.
2366
+ # @return [String]
2367
+ #
2368
+ # @!attribute [rw] data_accessor_arn
2369
+ # The Amazon Resource Name (ARN) of the data accessor.
2370
+ # @return [String]
2371
+ #
2372
+ # @!attribute [rw] idc_application_arn
2373
+ # The Amazon Resource Name (ARN) of the associated AWS IAM Identity
2374
+ # Center application.
2375
+ # @return [String]
2376
+ #
2377
+ # @!attribute [rw] principal
2378
+ # The Amazon Resource Name (ARN) of the IAM role for the ISV
2379
+ # associated with this data accessor.
2380
+ # @return [String]
2381
+ #
2382
+ # @!attribute [rw] created_at
2383
+ # The timestamp when the data accessor was created.
2384
+ # @return [Time]
2385
+ #
2386
+ # @!attribute [rw] updated_at
2387
+ # The timestamp when the data accessor was last updated.
2388
+ # @return [Time]
2389
+ #
2390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DataAccessor AWS API Documentation
2391
+ #
2392
+ class DataAccessor < Struct.new(
2393
+ :display_name,
2394
+ :data_accessor_id,
2395
+ :data_accessor_arn,
2396
+ :idc_application_arn,
2397
+ :principal,
2398
+ :created_at,
2399
+ :updated_at)
2400
+ SENSITIVE = [:display_name]
2401
+ include Aws::Structure
2402
+ end
2403
+
2404
+ # A data source in an Amazon Q Business application.
2405
+ #
2406
+ # @!attribute [rw] display_name
2407
+ # The name of the Amazon Q Business data source.
2408
+ # @return [String]
2409
+ #
2410
+ # @!attribute [rw] data_source_id
2411
+ # The identifier of the Amazon Q Business data source.
2412
+ # @return [String]
2413
+ #
2414
+ # @!attribute [rw] type
2415
+ # The type of the Amazon Q Business data source.
2416
+ # @return [String]
2417
+ #
2418
+ # @!attribute [rw] created_at
2419
+ # The Unix timestamp when the Amazon Q Business data source was
2420
+ # created.
2421
+ # @return [Time]
2422
+ #
2423
+ # @!attribute [rw] updated_at
2424
+ # The Unix timestamp when the Amazon Q Business data source was last
2425
+ # updated.
2426
+ # @return [Time]
2427
+ #
2428
+ # @!attribute [rw] status
2429
+ # The status of the Amazon Q Business data source.
2430
+ # @return [String]
2431
+ #
2432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DataSource AWS API Documentation
2433
+ #
2434
+ class DataSource < Struct.new(
2435
+ :display_name,
2436
+ :data_source_id,
1948
2437
  :type,
1949
2438
  :created_at,
1950
2439
  :updated_at,
@@ -2159,6 +2648,27 @@ module Aws::QBusiness
2159
2648
  #
2160
2649
  class DeleteConversationResponse < Aws::EmptyStructure; end
2161
2650
 
2651
+ # @!attribute [rw] application_id
2652
+ # The unique identifier of the Q Business application.
2653
+ # @return [String]
2654
+ #
2655
+ # @!attribute [rw] data_accessor_id
2656
+ # The unique identifier of the data accessor to delete.
2657
+ # @return [String]
2658
+ #
2659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteDataAccessorRequest AWS API Documentation
2660
+ #
2661
+ class DeleteDataAccessorRequest < Struct.new(
2662
+ :application_id,
2663
+ :data_accessor_id)
2664
+ SENSITIVE = []
2665
+ include Aws::Structure
2666
+ end
2667
+
2668
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteDataAccessorResponse AWS API Documentation
2669
+ #
2670
+ class DeleteDataAccessorResponse < Aws::EmptyStructure; end
2671
+
2162
2672
  # @!attribute [rw] application_id
2163
2673
  # The identifier of the Amazon Q Business application used with the
2164
2674
  # data source connector.
@@ -2353,6 +2863,27 @@ module Aws::QBusiness
2353
2863
  #
2354
2864
  class DeleteWebExperienceResponse < Aws::EmptyStructure; end
2355
2865
 
2866
+ # @!attribute [rw] application_id
2867
+ # The unique identifier of the Q Business application.
2868
+ # @return [String]
2869
+ #
2870
+ # @!attribute [rw] statement_id
2871
+ # The statement ID of the permission to remove.
2872
+ # @return [String]
2873
+ #
2874
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DisassociatePermissionRequest AWS API Documentation
2875
+ #
2876
+ class DisassociatePermissionRequest < Struct.new(
2877
+ :application_id,
2878
+ :statement_id)
2879
+ SENSITIVE = []
2880
+ include Aws::Structure
2881
+ end
2882
+
2883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DisassociatePermissionResponse AWS API Documentation
2884
+ #
2885
+ class DisassociatePermissionResponse < Aws::EmptyStructure; end
2886
+
2356
2887
  # A document in an Amazon Q Business application.
2357
2888
  #
2358
2889
  # @!attribute [rw] id
@@ -2389,6 +2920,11 @@ module Aws::QBusiness
2389
2920
  # content during the document ingestion process.
2390
2921
  # @return [Types::DocumentEnrichmentConfiguration]
2391
2922
  #
2923
+ # @!attribute [rw] media_extraction_configuration
2924
+ # The configuration for extracting information from media in the
2925
+ # document.
2926
+ # @return [Types::MediaExtractionConfiguration]
2927
+ #
2392
2928
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Document AWS API Documentation
2393
2929
  #
2394
2930
  class Document < Struct.new(
@@ -2398,7 +2934,8 @@ module Aws::QBusiness
2398
2934
  :content_type,
2399
2935
  :title,
2400
2936
  :access_configuration,
2401
- :document_enrichment_configuration)
2937
+ :document_enrichment_configuration,
2938
+ :media_extraction_configuration)
2402
2939
  SENSITIVE = []
2403
2940
  include Aws::Structure
2404
2941
  end
@@ -2859,14 +3396,14 @@ module Aws::QBusiness
2859
3396
  include Aws::Structure
2860
3397
  end
2861
3398
 
2862
- # Provides information about a data source sync error.
3399
+ # Provides information about a Amazon Q Business request error.
2863
3400
  #
2864
3401
  # @!attribute [rw] error_message
2865
- # The message explaining the data source sync error.
3402
+ # The message explaining the Amazon Q Business request error.
2866
3403
  # @return [String]
2867
3404
  #
2868
3405
  # @!attribute [rw] error_code
2869
- # The code associated with the data source sync error.
3406
+ # The code associated with the Amazon Q Business request error.
2870
3407
  # @return [String]
2871
3408
  #
2872
3409
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ErrorDetail AWS API Documentation
@@ -2878,6 +3415,21 @@ module Aws::QBusiness
2878
3415
  include Aws::Structure
2879
3416
  end
2880
3417
 
3418
+ # An external resource that you configured with your application is
3419
+ # returning errors and preventing this operation from succeeding. Fix
3420
+ # those errors and try again.
3421
+ #
3422
+ # @!attribute [rw] message
3423
+ # @return [String]
3424
+ #
3425
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ExternalResourceException AWS API Documentation
3426
+ #
3427
+ class ExternalResourceException < Struct.new(
3428
+ :message)
3429
+ SENSITIVE = []
3430
+ include Aws::Structure
3431
+ end
3432
+
2881
3433
  # A failed file upload during web experience chat.
2882
3434
  #
2883
3435
  # @!attribute [rw] conversation_id
@@ -3042,6 +3594,11 @@ module Aws::QBusiness
3042
3594
  # The OIDC client ID for a Amazon Q Business application.
3043
3595
  # @return [Array<String>]
3044
3596
  #
3597
+ # @!attribute [rw] quick_sight_configuration
3598
+ # The Amazon QuickSight authentication configuration for the Amazon Q
3599
+ # Business application.
3600
+ # @return [Types::QuickSightConfiguration]
3601
+ #
3045
3602
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplicationResponse AWS API Documentation
3046
3603
  #
3047
3604
  class GetApplicationResponse < Struct.new(
@@ -3062,7 +3619,8 @@ module Aws::QBusiness
3062
3619
  :q_apps_configuration,
3063
3620
  :personalization_configuration,
3064
3621
  :auto_subscription_configuration,
3065
- :client_ids_for_oidc)
3622
+ :client_ids_for_oidc,
3623
+ :quick_sight_configuration)
3066
3624
  SENSITIVE = []
3067
3625
  include Aws::Structure
3068
3626
  end
@@ -3133,6 +3691,79 @@ module Aws::QBusiness
3133
3691
  include Aws::Structure
3134
3692
  end
3135
3693
 
3694
+ # @!attribute [rw] application_id
3695
+ # The unique identifier of the Q Business application.
3696
+ # @return [String]
3697
+ #
3698
+ # @!attribute [rw] data_accessor_id
3699
+ # The unique identifier of the data accessor to retrieve.
3700
+ # @return [String]
3701
+ #
3702
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDataAccessorRequest AWS API Documentation
3703
+ #
3704
+ class GetDataAccessorRequest < Struct.new(
3705
+ :application_id,
3706
+ :data_accessor_id)
3707
+ SENSITIVE = []
3708
+ include Aws::Structure
3709
+ end
3710
+
3711
+ # @!attribute [rw] display_name
3712
+ # The friendly name of the data accessor.
3713
+ # @return [String]
3714
+ #
3715
+ # @!attribute [rw] data_accessor_id
3716
+ # The unique identifier of the data accessor.
3717
+ # @return [String]
3718
+ #
3719
+ # @!attribute [rw] data_accessor_arn
3720
+ # The Amazon Resource Name (ARN) of the data accessor.
3721
+ # @return [String]
3722
+ #
3723
+ # @!attribute [rw] application_id
3724
+ # The unique identifier of the Q Business application associated with
3725
+ # this data accessor.
3726
+ # @return [String]
3727
+ #
3728
+ # @!attribute [rw] idc_application_arn
3729
+ # The Amazon Resource Name (ARN) of the AWS IAM Identity Center
3730
+ # application associated with this data accessor.
3731
+ # @return [String]
3732
+ #
3733
+ # @!attribute [rw] principal
3734
+ # The Amazon Resource Name (ARN) of the IAM role for the ISV
3735
+ # associated with this data accessor.
3736
+ # @return [String]
3737
+ #
3738
+ # @!attribute [rw] action_configurations
3739
+ # The list of action configurations specifying the allowed actions and
3740
+ # any associated filters.
3741
+ # @return [Array<Types::ActionConfiguration>]
3742
+ #
3743
+ # @!attribute [rw] created_at
3744
+ # The timestamp when the data accessor was created.
3745
+ # @return [Time]
3746
+ #
3747
+ # @!attribute [rw] updated_at
3748
+ # The timestamp when the data accessor was last updated.
3749
+ # @return [Time]
3750
+ #
3751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDataAccessorResponse AWS API Documentation
3752
+ #
3753
+ class GetDataAccessorResponse < Struct.new(
3754
+ :display_name,
3755
+ :data_accessor_id,
3756
+ :data_accessor_arn,
3757
+ :application_id,
3758
+ :idc_application_arn,
3759
+ :principal,
3760
+ :action_configurations,
3761
+ :created_at,
3762
+ :updated_at)
3763
+ SENSITIVE = [:display_name]
3764
+ include Aws::Structure
3765
+ end
3766
+
3136
3767
  # @!attribute [rw] application_id
3137
3768
  # The identifier of the Amazon Q Business application.
3138
3769
  # @return [String]
@@ -3233,6 +3864,11 @@ module Aws::QBusiness
3233
3864
  # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
3234
3865
  # @return [Types::DocumentEnrichmentConfiguration]
3235
3866
  #
3867
+ # @!attribute [rw] media_extraction_configuration
3868
+ # The configuration for extracting information from media in documents
3869
+ # for the data source.
3870
+ # @return [Types::MediaExtractionConfiguration]
3871
+ #
3236
3872
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDataSourceResponse AWS API Documentation
3237
3873
  #
3238
3874
  class GetDataSourceResponse < Struct.new(
@@ -3251,7 +3887,8 @@ module Aws::QBusiness
3251
3887
  :sync_schedule,
3252
3888
  :role_arn,
3253
3889
  :error,
3254
- :document_enrichment_configuration)
3890
+ :document_enrichment_configuration,
3891
+ :media_extraction_configuration)
3255
3892
  SENSITIVE = []
3256
3893
  include Aws::Structure
3257
3894
  end
@@ -3332,10 +3969,6 @@ module Aws::QBusiness
3332
3969
  # The name of the Amazon Q Business index.
3333
3970
  # @return [String]
3334
3971
  #
3335
- # @!attribute [rw] type
3336
- # The type of index attached to your Amazon Q Business application.
3337
- # @return [String]
3338
- #
3339
3972
  # @!attribute [rw] index_arn
3340
3973
  # The Amazon Resource Name (ARN) of the Amazon Q Business index.
3341
3974
  # @return [String]
@@ -3346,6 +3979,10 @@ module Aws::QBusiness
3346
3979
  # `ErrorMessage` field contains a message that explains why.
3347
3980
  # @return [String]
3348
3981
  #
3982
+ # @!attribute [rw] type
3983
+ # The type of index attached to your Amazon Q Business application.
3984
+ # @return [String]
3985
+ #
3349
3986
  # @!attribute [rw] description
3350
3987
  # The description for the Amazon Q Business index.
3351
3988
  # @return [String]
@@ -3389,9 +4026,9 @@ module Aws::QBusiness
3389
4026
  :application_id,
3390
4027
  :index_id,
3391
4028
  :display_name,
3392
- :type,
3393
4029
  :index_arn,
3394
4030
  :status,
4031
+ :type,
3395
4032
  :description,
3396
4033
  :created_at,
3397
4034
  :updated_at,
@@ -3403,6 +4040,53 @@ module Aws::QBusiness
3403
4040
  include Aws::Structure
3404
4041
  end
3405
4042
 
4043
+ # @!attribute [rw] application_id
4044
+ # The identifier of the Amazon Q Business which contains the media
4045
+ # object.
4046
+ # @return [String]
4047
+ #
4048
+ # @!attribute [rw] conversation_id
4049
+ # The identifier of the Amazon Q Business conversation.
4050
+ # @return [String]
4051
+ #
4052
+ # @!attribute [rw] message_id
4053
+ # The identifier of the Amazon Q Business message.
4054
+ # @return [String]
4055
+ #
4056
+ # @!attribute [rw] media_id
4057
+ # The identifier of the media object. You can find this in the
4058
+ # `sourceAttributions` returned by the `Chat`, `ChatSync`, and
4059
+ # `ListMessages` API responses.
4060
+ # @return [String]
4061
+ #
4062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetMediaRequest AWS API Documentation
4063
+ #
4064
+ class GetMediaRequest < Struct.new(
4065
+ :application_id,
4066
+ :conversation_id,
4067
+ :message_id,
4068
+ :media_id)
4069
+ SENSITIVE = []
4070
+ include Aws::Structure
4071
+ end
4072
+
4073
+ # @!attribute [rw] media_bytes
4074
+ # The base64-encoded bytes of the media object.
4075
+ # @return [String]
4076
+ #
4077
+ # @!attribute [rw] media_mime_type
4078
+ # The MIME type of the media object (image/png).
4079
+ # @return [String]
4080
+ #
4081
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetMediaResponse AWS API Documentation
4082
+ #
4083
+ class GetMediaResponse < Struct.new(
4084
+ :media_bytes,
4085
+ :media_mime_type)
4086
+ SENSITIVE = []
4087
+ include Aws::Structure
4088
+ end
4089
+
3406
4090
  # @!attribute [rw] application_id
3407
4091
  # The identifier of the application which contains the plugin.
3408
4092
  # @return [String]
@@ -3489,6 +4173,30 @@ module Aws::QBusiness
3489
4173
  include Aws::Structure
3490
4174
  end
3491
4175
 
4176
+ # @!attribute [rw] application_id
4177
+ # The unique identifier of the Q Business application.
4178
+ # @return [String]
4179
+ #
4180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetPolicyRequest AWS API Documentation
4181
+ #
4182
+ class GetPolicyRequest < Struct.new(
4183
+ :application_id)
4184
+ SENSITIVE = []
4185
+ include Aws::Structure
4186
+ end
4187
+
4188
+ # @!attribute [rw] policy
4189
+ # The JSON representation of the permission policy.
4190
+ # @return [String]
4191
+ #
4192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetPolicyResponse AWS API Documentation
4193
+ #
4194
+ class GetPolicyResponse < Struct.new(
4195
+ :policy)
4196
+ SENSITIVE = []
4197
+ include Aws::Structure
4198
+ end
4199
+
3492
4200
  # @!attribute [rw] application_id
3493
4201
  # The identifier of the Amazon Q Business application using the
3494
4202
  # retriever.
@@ -3697,6 +4405,16 @@ module Aws::QBusiness
3697
4405
  # connector to fail.
3698
4406
  # @return [Types::ErrorDetail]
3699
4407
  #
4408
+ # @!attribute [rw] browser_extension_configuration
4409
+ # The browser extension configuration for an Amazon Q Business web
4410
+ # experience.
4411
+ # @return [Types::BrowserExtensionConfiguration]
4412
+ #
4413
+ # @!attribute [rw] customization_configuration
4414
+ # Gets the custom logo, favicon, font, and color used in the Amazon Q
4415
+ # web experience.
4416
+ # @return [Types::CustomizationConfiguration]
4417
+ #
3700
4418
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperienceResponse AWS API Documentation
3701
4419
  #
3702
4420
  class GetWebExperienceResponse < Struct.new(
@@ -3715,7 +4433,9 @@ module Aws::QBusiness
3715
4433
  :role_arn,
3716
4434
  :identity_provider_configuration,
3717
4435
  :authentication_configuration,
3718
- :error)
4436
+ :error,
4437
+ :browser_extension_configuration,
4438
+ :customization_configuration)
3719
4439
  SENSITIVE = []
3720
4440
  include Aws::Structure
3721
4441
  end
@@ -3856,6 +4576,28 @@ module Aws::QBusiness
3856
4576
  include Aws::Structure
3857
4577
  end
3858
4578
 
4579
+ # Information about the IAM Identity Center Application used to
4580
+ # configure authentication for a plugin.
4581
+ #
4582
+ # @!attribute [rw] idc_application_arn
4583
+ # The Amazon Resource Name (ARN) of the IAM Identity Center
4584
+ # Application used to configure authentication.
4585
+ # @return [String]
4586
+ #
4587
+ # @!attribute [rw] role_arn
4588
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
4589
+ # perform actions on Amazon Web Services services on your behalf.
4590
+ # @return [String]
4591
+ #
4592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/IdcAuthConfiguration AWS API Documentation
4593
+ #
4594
+ class IdcAuthConfiguration < Struct.new(
4595
+ :idc_application_arn,
4596
+ :role_arn)
4597
+ SENSITIVE = []
4598
+ include Aws::Structure
4599
+ end
4600
+
3859
4601
  # Provides information about the identity provider (IdP) used to
3860
4602
  # authenticate end users of an Amazon Q Business web experience.
3861
4603
  #
@@ -3889,6 +4631,27 @@ module Aws::QBusiness
3889
4631
  class Unknown < IdentityProviderConfiguration; end
3890
4632
  end
3891
4633
 
4634
+ # The configuration for extracting semantic meaning from images in
4635
+ # documents. For more information, see [Extracting semantic meaning from
4636
+ # images and visuals][1].
4637
+ #
4638
+ #
4639
+ #
4640
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html
4641
+ #
4642
+ # @!attribute [rw] image_extraction_status
4643
+ # Specify whether to extract semantic meaning from images and visuals
4644
+ # from documents.
4645
+ # @return [String]
4646
+ #
4647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ImageExtractionConfiguration AWS API Documentation
4648
+ #
4649
+ class ImageExtractionConfiguration < Struct.new(
4650
+ :image_extraction_status)
4651
+ SENSITIVE = []
4652
+ include Aws::Structure
4653
+ end
4654
+
3892
4655
  # Summary information for your Amazon Q Business index.
3893
4656
  #
3894
4657
  # @!attribute [rw] display_name
@@ -4118,6 +4881,61 @@ module Aws::QBusiness
4118
4881
  include Aws::Structure
4119
4882
  end
4120
4883
 
4884
+ # @!attribute [rw] application_id
4885
+ # The unique identifier for the Amazon Q Business application.
4886
+ # @return [String]
4887
+ #
4888
+ # @!attribute [rw] conversation_id
4889
+ # The unique identifier of the Amazon Q Business web experience
4890
+ # conversation.
4891
+ # @return [String]
4892
+ #
4893
+ # @!attribute [rw] user_id
4894
+ # The unique identifier of the user involved in the Amazon Q Business
4895
+ # web experience conversation.
4896
+ # @return [String]
4897
+ #
4898
+ # @!attribute [rw] next_token
4899
+ # If the number of attachments returned exceeds `maxResults`, Amazon Q
4900
+ # Business returns a next token as a pagination token to retrieve the
4901
+ # next set of attachments.
4902
+ # @return [String]
4903
+ #
4904
+ # @!attribute [rw] max_results
4905
+ # The maximum number of attachements to return.
4906
+ # @return [Integer]
4907
+ #
4908
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListAttachmentsRequest AWS API Documentation
4909
+ #
4910
+ class ListAttachmentsRequest < Struct.new(
4911
+ :application_id,
4912
+ :conversation_id,
4913
+ :user_id,
4914
+ :next_token,
4915
+ :max_results)
4916
+ SENSITIVE = []
4917
+ include Aws::Structure
4918
+ end
4919
+
4920
+ # @!attribute [rw] attachments
4921
+ # An array of information on one or more attachments.
4922
+ # @return [Array<Types::Attachment>]
4923
+ #
4924
+ # @!attribute [rw] next_token
4925
+ # If the response is truncated, Amazon Q Business returns this token,
4926
+ # which you can use in a later request to list the next set of
4927
+ # attachments.
4928
+ # @return [String]
4929
+ #
4930
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListAttachmentsResponse AWS API Documentation
4931
+ #
4932
+ class ListAttachmentsResponse < Struct.new(
4933
+ :attachments,
4934
+ :next_token)
4935
+ SENSITIVE = []
4936
+ include Aws::Structure
4937
+ end
4938
+
4121
4939
  # @!attribute [rw] application_id
4122
4940
  # The identifier of the Amazon Q Business application.
4123
4941
  # @return [String]
@@ -4169,6 +4987,47 @@ module Aws::QBusiness
4169
4987
  include Aws::Structure
4170
4988
  end
4171
4989
 
4990
+ # @!attribute [rw] application_id
4991
+ # The unique identifier of the Q Business application.
4992
+ # @return [String]
4993
+ #
4994
+ # @!attribute [rw] next_token
4995
+ # The token for the next set of results. (You received this token from
4996
+ # a previous call.)
4997
+ # @return [String]
4998
+ #
4999
+ # @!attribute [rw] max_results
5000
+ # The maximum number of results to return in a single call.
5001
+ # @return [Integer]
5002
+ #
5003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataAccessorsRequest AWS API Documentation
5004
+ #
5005
+ class ListDataAccessorsRequest < Struct.new(
5006
+ :application_id,
5007
+ :next_token,
5008
+ :max_results)
5009
+ SENSITIVE = []
5010
+ include Aws::Structure
5011
+ end
5012
+
5013
+ # @!attribute [rw] data_accessors
5014
+ # The list of data accessors.
5015
+ # @return [Array<Types::DataAccessor>]
5016
+ #
5017
+ # @!attribute [rw] next_token
5018
+ # The token to use to retrieve the next set of results, if there are
5019
+ # any.
5020
+ # @return [String]
5021
+ #
5022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListDataAccessorsResponse AWS API Documentation
5023
+ #
5024
+ class ListDataAccessorsResponse < Struct.new(
5025
+ :data_accessors,
5026
+ :next_token)
5027
+ SENSITIVE = []
5028
+ include Aws::Structure
5029
+ end
5030
+
4172
5031
  # @!attribute [rw] data_source_id
4173
5032
  # The identifier of the data source connector.
4174
5033
  # @return [String]
@@ -4377,16 +5236,164 @@ module Aws::QBusiness
4377
5236
  # @return [String]
4378
5237
  #
4379
5238
  # @!attribute [rw] max_results
4380
- # The maximum number of returned groups that are mapped to users.
5239
+ # The maximum number of returned groups that are mapped to users.
5240
+ # @return [Integer]
5241
+ #
5242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListGroupsRequest AWS API Documentation
5243
+ #
5244
+ class ListGroupsRequest < Struct.new(
5245
+ :application_id,
5246
+ :index_id,
5247
+ :updated_earlier_than,
5248
+ :data_source_id,
5249
+ :next_token,
5250
+ :max_results)
5251
+ SENSITIVE = []
5252
+ include Aws::Structure
5253
+ end
5254
+
5255
+ # @!attribute [rw] next_token
5256
+ # If the response is truncated, Amazon Q Business returns this token
5257
+ # that you can use in the subsequent request to retrieve the next set
5258
+ # of groups that are mapped to users.
5259
+ # @return [String]
5260
+ #
5261
+ # @!attribute [rw] items
5262
+ # Summary information for list of groups that are mapped to users.
5263
+ # @return [Array<Types::GroupSummary>]
5264
+ #
5265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListGroupsResponse AWS API Documentation
5266
+ #
5267
+ class ListGroupsResponse < Struct.new(
5268
+ :next_token,
5269
+ :items)
5270
+ SENSITIVE = []
5271
+ include Aws::Structure
5272
+ end
5273
+
5274
+ # @!attribute [rw] application_id
5275
+ # The identifier of the Amazon Q Business application connected to the
5276
+ # index.
5277
+ # @return [String]
5278
+ #
5279
+ # @!attribute [rw] next_token
5280
+ # If the maxResults response was incomplete because there is more data
5281
+ # to retrieve, Amazon Q Business returns a pagination token in the
5282
+ # response. You can use this pagination token to retrieve the next set
5283
+ # of Amazon Q Business indices.
5284
+ # @return [String]
5285
+ #
5286
+ # @!attribute [rw] max_results
5287
+ # The maximum number of indices to return.
5288
+ # @return [Integer]
5289
+ #
5290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndicesRequest AWS API Documentation
5291
+ #
5292
+ class ListIndicesRequest < Struct.new(
5293
+ :application_id,
5294
+ :next_token,
5295
+ :max_results)
5296
+ SENSITIVE = []
5297
+ include Aws::Structure
5298
+ end
5299
+
5300
+ # @!attribute [rw] next_token
5301
+ # If the response is truncated, Amazon Q Business returns this token
5302
+ # that you can use in the subsequent request to retrieve the next set
5303
+ # of indexes.
5304
+ # @return [String]
5305
+ #
5306
+ # @!attribute [rw] indices
5307
+ # An array of information on the items in one or more indexes.
5308
+ # @return [Array<Types::Index>]
5309
+ #
5310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndicesResponse AWS API Documentation
5311
+ #
5312
+ class ListIndicesResponse < Struct.new(
5313
+ :next_token,
5314
+ :indices)
5315
+ SENSITIVE = []
5316
+ include Aws::Structure
5317
+ end
5318
+
5319
+ # @!attribute [rw] conversation_id
5320
+ # The identifier of the Amazon Q Business web experience conversation.
5321
+ # @return [String]
5322
+ #
5323
+ # @!attribute [rw] application_id
5324
+ # The identifier for the Amazon Q Business application.
5325
+ # @return [String]
5326
+ #
5327
+ # @!attribute [rw] user_id
5328
+ # The identifier of the user involved in the Amazon Q Business web
5329
+ # experience conversation.
5330
+ # @return [String]
5331
+ #
5332
+ # @!attribute [rw] next_token
5333
+ # If the number of messages returned exceeds `maxResults`, Amazon Q
5334
+ # Business returns a next token as a pagination token to retrieve the
5335
+ # next set of messages.
5336
+ # @return [String]
5337
+ #
5338
+ # @!attribute [rw] max_results
5339
+ # The maximum number of messages to return.
5340
+ # @return [Integer]
5341
+ #
5342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessagesRequest AWS API Documentation
5343
+ #
5344
+ class ListMessagesRequest < Struct.new(
5345
+ :conversation_id,
5346
+ :application_id,
5347
+ :user_id,
5348
+ :next_token,
5349
+ :max_results)
5350
+ SENSITIVE = []
5351
+ include Aws::Structure
5352
+ end
5353
+
5354
+ # @!attribute [rw] messages
5355
+ # An array of information on one or more messages.
5356
+ # @return [Array<Types::Message>]
5357
+ #
5358
+ # @!attribute [rw] next_token
5359
+ # If the response is truncated, Amazon Q Business returns this token,
5360
+ # which you can use in a later request to list the next set of
5361
+ # messages.
5362
+ # @return [String]
5363
+ #
5364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessagesResponse AWS API Documentation
5365
+ #
5366
+ class ListMessagesResponse < Struct.new(
5367
+ :messages,
5368
+ :next_token)
5369
+ SENSITIVE = []
5370
+ include Aws::Structure
5371
+ end
5372
+
5373
+ # @!attribute [rw] application_id
5374
+ # The identifier of the Amazon Q Business application the plugin is
5375
+ # attached to.
5376
+ # @return [String]
5377
+ #
5378
+ # @!attribute [rw] plugin_id
5379
+ # The identifier of the Amazon Q Business plugin.
5380
+ # @return [String]
5381
+ #
5382
+ # @!attribute [rw] next_token
5383
+ # If the number of plugin actions returned exceeds `maxResults`,
5384
+ # Amazon Q Business returns a next token as a pagination token to
5385
+ # retrieve the next set of plugin actions.
5386
+ # @return [String]
5387
+ #
5388
+ # @!attribute [rw] max_results
5389
+ # The maximum number of plugin actions to return.
4381
5390
  # @return [Integer]
4382
5391
  #
4383
- # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListGroupsRequest AWS API Documentation
5392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginActionsRequest AWS API Documentation
4384
5393
  #
4385
- class ListGroupsRequest < Struct.new(
5394
+ class ListPluginActionsRequest < Struct.new(
4386
5395
  :application_id,
4387
- :index_id,
4388
- :updated_earlier_than,
4389
- :data_source_id,
5396
+ :plugin_id,
4390
5397
  :next_token,
4391
5398
  :max_results)
4392
5399
  SENSITIVE = []
@@ -4394,44 +5401,42 @@ module Aws::QBusiness
4394
5401
  end
4395
5402
 
4396
5403
  # @!attribute [rw] next_token
4397
- # If the response is truncated, Amazon Q Business returns this token
4398
- # that you can use in the subsequent request to retrieve the next set
4399
- # of groups that are mapped to users.
5404
+ # If the response is truncated, Amazon Q Business returns this token,
5405
+ # which you can use in a later request to list the next set of plugin
5406
+ # actions.
4400
5407
  # @return [String]
4401
5408
  #
4402
5409
  # @!attribute [rw] items
4403
- # Summary information for list of groups that are mapped to users.
4404
- # @return [Array<Types::GroupSummary>]
5410
+ # An array of information on one or more plugin actions.
5411
+ # @return [Array<Types::ActionSummary>]
4405
5412
  #
4406
- # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListGroupsResponse AWS API Documentation
5413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginActionsResponse AWS API Documentation
4407
5414
  #
4408
- class ListGroupsResponse < Struct.new(
5415
+ class ListPluginActionsResponse < Struct.new(
4409
5416
  :next_token,
4410
5417
  :items)
4411
5418
  SENSITIVE = []
4412
5419
  include Aws::Structure
4413
5420
  end
4414
5421
 
4415
- # @!attribute [rw] application_id
4416
- # The identifier of the Amazon Q Business application connected to the
4417
- # index.
5422
+ # @!attribute [rw] plugin_type
5423
+ # The type of the plugin.
4418
5424
  # @return [String]
4419
5425
  #
4420
5426
  # @!attribute [rw] next_token
4421
- # If the maxResults response was incomplete because there is more data
4422
- # to retrieve, Amazon Q Business returns a pagination token in the
4423
- # response. You can use this pagination token to retrieve the next set
4424
- # of Amazon Q Business indices.
5427
+ # If the number of plugins returned exceeds `maxResults`, Amazon Q
5428
+ # Business returns a next token as a pagination token to retrieve the
5429
+ # next set of plugins.
4425
5430
  # @return [String]
4426
5431
  #
4427
5432
  # @!attribute [rw] max_results
4428
- # The maximum number of indices to return.
5433
+ # The maximum number of plugins to return.
4429
5434
  # @return [Integer]
4430
5435
  #
4431
- # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndicesRequest AWS API Documentation
5436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginTypeActionsRequest AWS API Documentation
4432
5437
  #
4433
- class ListIndicesRequest < Struct.new(
4434
- :application_id,
5438
+ class ListPluginTypeActionsRequest < Struct.new(
5439
+ :plugin_type,
4435
5440
  :next_token,
4436
5441
  :max_results)
4437
5442
  SENSITIVE = []
@@ -4439,74 +5444,58 @@ module Aws::QBusiness
4439
5444
  end
4440
5445
 
4441
5446
  # @!attribute [rw] next_token
4442
- # If the response is truncated, Amazon Q Business returns this token
4443
- # that you can use in the subsequent request to retrieve the next set
4444
- # of indexes.
5447
+ # If the response is truncated, Amazon Q Business returns this token,
5448
+ # which you can use in a later request to list the next set of
5449
+ # plugins.
4445
5450
  # @return [String]
4446
5451
  #
4447
- # @!attribute [rw] indices
4448
- # An array of information on the items in one or more indexes.
4449
- # @return [Array<Types::Index>]
5452
+ # @!attribute [rw] items
5453
+ # An array of information on one or more plugins.
5454
+ # @return [Array<Types::ActionSummary>]
4450
5455
  #
4451
- # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListIndicesResponse AWS API Documentation
5456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginTypeActionsResponse AWS API Documentation
4452
5457
  #
4453
- class ListIndicesResponse < Struct.new(
5458
+ class ListPluginTypeActionsResponse < Struct.new(
4454
5459
  :next_token,
4455
- :indices)
5460
+ :items)
4456
5461
  SENSITIVE = []
4457
5462
  include Aws::Structure
4458
5463
  end
4459
5464
 
4460
- # @!attribute [rw] conversation_id
4461
- # The identifier of the Amazon Q Business web experience conversation.
4462
- # @return [String]
4463
- #
4464
- # @!attribute [rw] application_id
4465
- # The identifier for the Amazon Q Business application.
4466
- # @return [String]
4467
- #
4468
- # @!attribute [rw] user_id
4469
- # The identifier of the user involved in the Amazon Q Business web
4470
- # experience conversation.
4471
- # @return [String]
4472
- #
4473
5465
  # @!attribute [rw] next_token
4474
- # If the number of retrievers returned exceeds `maxResults`, Amazon Q
4475
- # Business returns a next token as a pagination token to retrieve the
4476
- # next set of messages.
5466
+ # If the metadata returned exceeds `maxResults`, Amazon Q Business
5467
+ # returns a next token as a pagination token to retrieve the next set
5468
+ # of metadata.
4477
5469
  # @return [String]
4478
5470
  #
4479
5471
  # @!attribute [rw] max_results
4480
- # The maximum number of messages to return.
5472
+ # The maximum number of plugin metadata items to return.
4481
5473
  # @return [Integer]
4482
5474
  #
4483
- # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessagesRequest AWS API Documentation
5475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginTypeMetadataRequest AWS API Documentation
4484
5476
  #
4485
- class ListMessagesRequest < Struct.new(
4486
- :conversation_id,
4487
- :application_id,
4488
- :user_id,
5477
+ class ListPluginTypeMetadataRequest < Struct.new(
4489
5478
  :next_token,
4490
5479
  :max_results)
4491
5480
  SENSITIVE = []
4492
5481
  include Aws::Structure
4493
5482
  end
4494
5483
 
4495
- # @!attribute [rw] messages
4496
- # An array of information on one or more messages.
4497
- # @return [Array<Types::Message>]
4498
- #
4499
5484
  # @!attribute [rw] next_token
4500
5485
  # If the response is truncated, Amazon Q Business returns this token,
4501
- # which you can use in a later request to list the next set of
4502
- # messages.
5486
+ # which you can use in a later request to list the next set of plugin
5487
+ # metadata.
4503
5488
  # @return [String]
4504
5489
  #
4505
- # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListMessagesResponse AWS API Documentation
5490
+ # @!attribute [rw] items
5491
+ # An array of information on plugin metadata.
5492
+ # @return [Array<Types::PluginTypeMetadataSummary>]
4506
5493
  #
4507
- class ListMessagesResponse < Struct.new(
4508
- :messages,
4509
- :next_token)
5494
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginTypeMetadataResponse AWS API Documentation
5495
+ #
5496
+ class ListPluginTypeMetadataResponse < Struct.new(
5497
+ :next_token,
5498
+ :items)
4510
5499
  SENSITIVE = []
4511
5500
  include Aws::Structure
4512
5501
  end
@@ -4672,6 +5661,39 @@ module Aws::QBusiness
4672
5661
  include Aws::Structure
4673
5662
  end
4674
5663
 
5664
+ # The configuration for extracting information from media in documents.
5665
+ #
5666
+ # @!attribute [rw] image_extraction_configuration
5667
+ # The configuration for extracting semantic meaning from images in
5668
+ # documents. For more information, see [Extracting semantic meaning
5669
+ # from images and visuals][1].
5670
+ #
5671
+ #
5672
+ #
5673
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html
5674
+ # @return [Types::ImageExtractionConfiguration]
5675
+ #
5676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/MediaExtractionConfiguration AWS API Documentation
5677
+ #
5678
+ class MediaExtractionConfiguration < Struct.new(
5679
+ :image_extraction_configuration)
5680
+ SENSITIVE = []
5681
+ include Aws::Structure
5682
+ end
5683
+
5684
+ # The requested media object is too large to be returned.
5685
+ #
5686
+ # @!attribute [rw] message
5687
+ # @return [String]
5688
+ #
5689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/MediaTooLargeException AWS API Documentation
5690
+ #
5691
+ class MediaTooLargeException < Struct.new(
5692
+ :message)
5693
+ SENSITIVE = []
5694
+ include Aws::Structure
5695
+ end
5696
+
4675
5697
  # The sub groups that belong to a group.
4676
5698
  #
4677
5699
  # @!attribute [rw] group_name
@@ -4905,11 +5927,24 @@ module Aws::QBusiness
4905
5927
  # 2.0 authentication credentials stored in a Secrets Manager secret.
4906
5928
  # @return [String]
4907
5929
  #
5930
+ # @!attribute [rw] authorization_url
5931
+ # The redirect URL required by the OAuth 2.0 protocol for Amazon Q
5932
+ # Business to authenticate a plugin user through a third party
5933
+ # authentication server.
5934
+ # @return [String]
5935
+ #
5936
+ # @!attribute [rw] token_url
5937
+ # The URL required by the OAuth 2.0 protocol to exchange an end user
5938
+ # authorization code for an access token.
5939
+ # @return [String]
5940
+ #
4908
5941
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/OAuth2ClientCredentialConfiguration AWS API Documentation
4909
5942
  #
4910
5943
  class OAuth2ClientCredentialConfiguration < Struct.new(
4911
5944
  :secret_arn,
4912
- :role_arn)
5945
+ :role_arn,
5946
+ :authorization_url,
5947
+ :token_url)
4913
5948
  SENSITIVE = []
4914
5949
  include Aws::Structure
4915
5950
  end
@@ -5028,12 +6063,18 @@ module Aws::QBusiness
5028
6063
  # authentication.
5029
6064
  # @return [Types::NoAuthConfiguration]
5030
6065
  #
6066
+ # @!attribute [rw] idc_auth_configuration
6067
+ # Information about the IAM Identity Center Application used to
6068
+ # configure authentication for a plugin.
6069
+ # @return [Types::IdcAuthConfiguration]
6070
+ #
5031
6071
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PluginAuthConfiguration AWS API Documentation
5032
6072
  #
5033
6073
  class PluginAuthConfiguration < Struct.new(
5034
6074
  :basic_auth_configuration,
5035
6075
  :o_auth_2_client_credential_configuration,
5036
6076
  :no_auth_configuration,
6077
+ :idc_auth_configuration,
5037
6078
  :unknown)
5038
6079
  SENSITIVE = []
5039
6080
  include Aws::Structure
@@ -5042,6 +6083,7 @@ module Aws::QBusiness
5042
6083
  class BasicAuthConfiguration < PluginAuthConfiguration; end
5043
6084
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
5044
6085
  class NoAuthConfiguration < PluginAuthConfiguration; end
6086
+ class IdcAuthConfiguration < PluginAuthConfiguration; end
5045
6087
  class Unknown < PluginAuthConfiguration; end
5046
6088
  end
5047
6089
 
@@ -5068,6 +6110,31 @@ module Aws::QBusiness
5068
6110
  include Aws::Structure
5069
6111
  end
5070
6112
 
6113
+ # Summary metadata information for a Amazon Q Business plugin.
6114
+ #
6115
+ # @!attribute [rw] type
6116
+ # The type of the plugin.
6117
+ # @return [String]
6118
+ #
6119
+ # @!attribute [rw] category
6120
+ # The category of the plugin type.
6121
+ # @return [String]
6122
+ #
6123
+ # @!attribute [rw] description
6124
+ # The description assigned by Amazon Q Business to a plugin. You
6125
+ # can't modify this value.
6126
+ # @return [String]
6127
+ #
6128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PluginTypeMetadataSummary AWS API Documentation
6129
+ #
6130
+ class PluginTypeMetadataSummary < Struct.new(
6131
+ :type,
6132
+ :category,
6133
+ :description)
6134
+ SENSITIVE = []
6135
+ include Aws::Structure
6136
+ end
6137
+
5071
6138
  # Provides user and group information used for filtering documents to
5072
6139
  # use for generating Amazon Q Business conversation responses.
5073
6140
  #
@@ -5261,8 +6328,76 @@ module Aws::QBusiness
5261
6328
  include Aws::Structure
5262
6329
  end
5263
6330
 
5264
- # The resource you want to use doesn’t exist. Make sure you have
5265
- # provided the correct resource and try again.
6331
+ # The Amazon QuickSight configuration for an Amazon Q Business
6332
+ # application that uses QuickSight as the identity provider. For more
6333
+ # information, see [Creating an Amazon QuickSight integrated
6334
+ # application][1].
6335
+ #
6336
+ #
6337
+ #
6338
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html
6339
+ #
6340
+ # @!attribute [rw] client_namespace
6341
+ # The Amazon QuickSight namespace that is used as the identity
6342
+ # provider. For more information about QuickSight namespaces, see
6343
+ # [Namespace operations][1].
6344
+ #
6345
+ #
6346
+ #
6347
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html
6348
+ # @return [String]
6349
+ #
6350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/QuickSightConfiguration AWS API Documentation
6351
+ #
6352
+ class QuickSightConfiguration < Struct.new(
6353
+ :client_namespace)
6354
+ SENSITIVE = []
6355
+ include Aws::Structure
6356
+ end
6357
+
6358
+ # Represents a piece of content that is relevant to a search query.
6359
+ #
6360
+ # @!attribute [rw] content
6361
+ # The actual content of the relevant item.
6362
+ # @return [String]
6363
+ #
6364
+ # @!attribute [rw] document_id
6365
+ # The unique identifier of the document containing the relevant
6366
+ # content.
6367
+ # @return [String]
6368
+ #
6369
+ # @!attribute [rw] document_title
6370
+ # The title of the document containing the relevant content.
6371
+ # @return [String]
6372
+ #
6373
+ # @!attribute [rw] document_uri
6374
+ # The URI of the document containing the relevant content.
6375
+ # @return [String]
6376
+ #
6377
+ # @!attribute [rw] document_attributes
6378
+ # Additional attributes of the document containing the relevant
6379
+ # content.
6380
+ # @return [Array<Types::DocumentAttribute>]
6381
+ #
6382
+ # @!attribute [rw] score_attributes
6383
+ # Attributes related to the relevance score of the content.
6384
+ # @return [Types::ScoreAttributes]
6385
+ #
6386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/RelevantContent AWS API Documentation
6387
+ #
6388
+ class RelevantContent < Struct.new(
6389
+ :content,
6390
+ :document_id,
6391
+ :document_title,
6392
+ :document_uri,
6393
+ :document_attributes,
6394
+ :score_attributes)
6395
+ SENSITIVE = []
6396
+ include Aws::Structure
6397
+ end
6398
+
6399
+ # The application or plugin resource you want to use doesn’t exist. Make
6400
+ # sure you have provided the correct resource and try again.
5266
6401
  #
5267
6402
  # @!attribute [rw] message
5268
6403
  # The message describing a `ResourceNotFoundException`.
@@ -5355,6 +6490,20 @@ module Aws::QBusiness
5355
6490
  class Unknown < RetrieverConfiguration; end
5356
6491
  end
5357
6492
 
6493
+ # Specifies a retriever as the content source for a search.
6494
+ #
6495
+ # @!attribute [rw] retriever_id
6496
+ # The unique identifier of the retriever to use as the content source.
6497
+ # @return [String]
6498
+ #
6499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/RetrieverContentSource AWS API Documentation
6500
+ #
6501
+ class RetrieverContentSource < Struct.new(
6502
+ :retriever_id)
6503
+ SENSITIVE = []
6504
+ include Aws::Structure
6505
+ end
6506
+
5358
6507
  # Guardrail rules for an Amazon Q Business application. Amazon Q
5359
6508
  # Business supports only one rule at a time.
5360
6509
  #
@@ -5486,6 +6635,87 @@ module Aws::QBusiness
5486
6635
  include Aws::Structure
5487
6636
  end
5488
6637
 
6638
+ # Provides information about the relevance score of content.
6639
+ #
6640
+ # @!attribute [rw] score_confidence
6641
+ # The confidence level of the relevance score.
6642
+ # @return [String]
6643
+ #
6644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ScoreAttributes AWS API Documentation
6645
+ #
6646
+ class ScoreAttributes < Struct.new(
6647
+ :score_confidence)
6648
+ SENSITIVE = []
6649
+ include Aws::Structure
6650
+ end
6651
+
6652
+ # @!attribute [rw] application_id
6653
+ # The unique identifier of the Q Business application to search.
6654
+ # @return [String]
6655
+ #
6656
+ # @!attribute [rw] user_id
6657
+ # The ID of the user performing the search. Used for access control.
6658
+ # @return [String]
6659
+ #
6660
+ # @!attribute [rw] user_groups
6661
+ # The groups the user belongs to. Used for access control.
6662
+ # @return [Array<String>]
6663
+ #
6664
+ # @!attribute [rw] query_text
6665
+ # The text to search for.
6666
+ # @return [String]
6667
+ #
6668
+ # @!attribute [rw] content_source
6669
+ # The source of content to search in.
6670
+ # @return [Types::ContentSource]
6671
+ #
6672
+ # @!attribute [rw] attribute_filter
6673
+ # Enables filtering of responses based on document attributes or
6674
+ # metadata fields.
6675
+ # @return [Types::AttributeFilter]
6676
+ #
6677
+ # @!attribute [rw] max_results
6678
+ # The maximum number of results to return.
6679
+ # @return [Integer]
6680
+ #
6681
+ # @!attribute [rw] next_token
6682
+ # The token for the next set of results. (You received this token from
6683
+ # a previous call.)
6684
+ # @return [String]
6685
+ #
6686
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SearchRelevantContentRequest AWS API Documentation
6687
+ #
6688
+ class SearchRelevantContentRequest < Struct.new(
6689
+ :application_id,
6690
+ :user_id,
6691
+ :user_groups,
6692
+ :query_text,
6693
+ :content_source,
6694
+ :attribute_filter,
6695
+ :max_results,
6696
+ :next_token)
6697
+ SENSITIVE = []
6698
+ include Aws::Structure
6699
+ end
6700
+
6701
+ # @!attribute [rw] relevant_content
6702
+ # The list of relevant content items found.
6703
+ # @return [Array<Types::RelevantContent>]
6704
+ #
6705
+ # @!attribute [rw] next_token
6706
+ # The token to use to retrieve the next set of results, if there are
6707
+ # any.
6708
+ # @return [String]
6709
+ #
6710
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SearchRelevantContentResponse AWS API Documentation
6711
+ #
6712
+ class SearchRelevantContentResponse < Struct.new(
6713
+ :relevant_content,
6714
+ :next_token)
6715
+ SENSITIVE = []
6716
+ include Aws::Structure
6717
+ end
6718
+
5489
6719
  # You have exceeded the set limits for your Amazon Q Business service.
5490
6720
  #
5491
6721
  # @!attribute [rw] message
@@ -5839,12 +7069,24 @@ module Aws::QBusiness
5839
7069
  # citation text segment in an Amazon Q Business chat response.
5840
7070
  # @return [Types::SnippetExcerpt]
5841
7071
  #
7072
+ # @!attribute [rw] media_id
7073
+ # The identifier of the media object associated with the text segment
7074
+ # in the source attribution.
7075
+ # @return [String]
7076
+ #
7077
+ # @!attribute [rw] media_mime_type
7078
+ # The MIME type (image/png) of the media object associated with the
7079
+ # text segment in the source attribution.
7080
+ # @return [String]
7081
+ #
5842
7082
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/TextSegment AWS API Documentation
5843
7083
  #
5844
7084
  class TextSegment < Struct.new(
5845
7085
  :begin_offset,
5846
7086
  :end_offset,
5847
- :snippet_excerpt)
7087
+ :snippet_excerpt,
7088
+ :media_id,
7089
+ :media_mime_type)
5848
7090
  SENSITIVE = []
5849
7091
  include Aws::Structure
5850
7092
  end
@@ -6043,6 +7285,38 @@ module Aws::QBusiness
6043
7285
  #
6044
7286
  class UpdateChatControlsConfigurationResponse < Aws::EmptyStructure; end
6045
7287
 
7288
+ # @!attribute [rw] application_id
7289
+ # The unique identifier of the Q Business application.
7290
+ # @return [String]
7291
+ #
7292
+ # @!attribute [rw] data_accessor_id
7293
+ # The unique identifier of the data accessor to update.
7294
+ # @return [String]
7295
+ #
7296
+ # @!attribute [rw] action_configurations
7297
+ # The updated list of action configurations specifying the allowed
7298
+ # actions and any associated filters.
7299
+ # @return [Array<Types::ActionConfiguration>]
7300
+ #
7301
+ # @!attribute [rw] display_name
7302
+ # The updated friendly name for the data accessor.
7303
+ # @return [String]
7304
+ #
7305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateDataAccessorRequest AWS API Documentation
7306
+ #
7307
+ class UpdateDataAccessorRequest < Struct.new(
7308
+ :application_id,
7309
+ :data_accessor_id,
7310
+ :action_configurations,
7311
+ :display_name)
7312
+ SENSITIVE = [:display_name]
7313
+ include Aws::Structure
7314
+ end
7315
+
7316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateDataAccessorResponse AWS API Documentation
7317
+ #
7318
+ class UpdateDataAccessorResponse < Aws::EmptyStructure; end
7319
+
6046
7320
  # @!attribute [rw] application_id
6047
7321
  # The identifier of the Amazon Q Business application the data source
6048
7322
  # is attached to.
@@ -6094,6 +7368,11 @@ module Aws::QBusiness
6094
7368
  # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
6095
7369
  # @return [Types::DocumentEnrichmentConfiguration]
6096
7370
  #
7371
+ # @!attribute [rw] media_extraction_configuration
7372
+ # The configuration for extracting information from media in documents
7373
+ # for your data source.
7374
+ # @return [Types::MediaExtractionConfiguration]
7375
+ #
6097
7376
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateDataSourceRequest AWS API Documentation
6098
7377
  #
6099
7378
  class UpdateDataSourceRequest < Struct.new(
@@ -6106,7 +7385,8 @@ module Aws::QBusiness
6106
7385
  :description,
6107
7386
  :sync_schedule,
6108
7387
  :role_arn,
6109
- :document_enrichment_configuration)
7388
+ :document_enrichment_configuration,
7389
+ :media_extraction_configuration)
6110
7390
  SENSITIVE = []
6111
7391
  include Aws::Structure
6112
7392
  end
@@ -6354,6 +7634,28 @@ module Aws::QBusiness
6354
7634
  # <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
6355
7635
  # @return [Array<String>]
6356
7636
  #
7637
+ # @!attribute [rw] browser_extension_configuration
7638
+ # The browser extension configuration for an Amazon Q Business web
7639
+ # experience.
7640
+ #
7641
+ # <note markdown="1"> For Amazon Q Business application using external OIDC-compliant
7642
+ # identity providers (IdPs). The IdP administrator must add the
7643
+ # browser extension sign-in redirect URLs to the IdP application. For
7644
+ # more information, see [Configure external OIDC identity provider for
7645
+ # your browser extensions.][1].
7646
+ #
7647
+ # </note>
7648
+ #
7649
+ #
7650
+ #
7651
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html
7652
+ # @return [Types::BrowserExtensionConfiguration]
7653
+ #
7654
+ # @!attribute [rw] customization_configuration
7655
+ # Updates the custom logo, favicon, font, and color used in the Amazon
7656
+ # Q web experience.
7657
+ # @return [Types::CustomizationConfiguration]
7658
+ #
6357
7659
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperienceRequest AWS API Documentation
6358
7660
  #
6359
7661
  class UpdateWebExperienceRequest < Struct.new(
@@ -6366,7 +7668,9 @@ module Aws::QBusiness
6366
7668
  :welcome_message,
6367
7669
  :sample_prompts_control_mode,
6368
7670
  :identity_provider_configuration,
6369
- :origins)
7671
+ :origins,
7672
+ :browser_extension_configuration,
7673
+ :customization_configuration)
6370
7674
  SENSITIVE = []
6371
7675
  include Aws::Structure
6372
7676
  end