aws-sdk-qbusiness 1.23.0 → 1.24.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/async_client.rb +2 -2
- data/lib/aws-sdk-qbusiness/client.rb +932 -9
- data/lib/aws-sdk-qbusiness/client_api.rb +449 -0
- data/lib/aws-sdk-qbusiness/types.rb +910 -16
- data/lib/aws-sdk-qbusiness.rb +2 -2
- data/sig/client.rbs +432 -6
- data/sig/types.rbs +264 -8
- metadata +2 -2
@@ -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,6 +511,46 @@ module Aws::QBusiness
|
|
434
511
|
include Aws::Structure
|
435
512
|
end
|
436
513
|
|
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
|
+
|
437
554
|
# An attachment in an Amazon Q Business conversation.
|
438
555
|
#
|
439
556
|
# @!attribute [rw] attachment_id
|
@@ -1347,6 +1464,27 @@ module Aws::QBusiness
|
|
1347
1464
|
include Aws::Structure
|
1348
1465
|
end
|
1349
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
|
+
|
1350
1488
|
# A conversation in an Amazon Q Business application.
|
1351
1489
|
#
|
1352
1490
|
# @!attribute [rw] conversation_id
|
@@ -1492,6 +1630,18 @@ module Aws::QBusiness
|
|
1492
1630
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html
|
1493
1631
|
# @return [Types::PersonalizationConfiguration]
|
1494
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
|
+
#
|
1495
1645
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateApplicationRequest AWS API Documentation
|
1496
1646
|
#
|
1497
1647
|
class CreateApplicationRequest < Struct.new(
|
@@ -1507,7 +1657,8 @@ module Aws::QBusiness
|
|
1507
1657
|
:client_token,
|
1508
1658
|
:attachments_configuration,
|
1509
1659
|
:q_apps_configuration,
|
1510
|
-
:personalization_configuration
|
1660
|
+
:personalization_configuration,
|
1661
|
+
:quick_sight_configuration)
|
1511
1662
|
SENSITIVE = []
|
1512
1663
|
include Aws::Structure
|
1513
1664
|
end
|
@@ -1529,6 +1680,72 @@ module Aws::QBusiness
|
|
1529
1680
|
include Aws::Structure
|
1530
1681
|
end
|
1531
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
|
+
|
1532
1749
|
# @!attribute [rw] application_id
|
1533
1750
|
# The identifier of the Amazon Q Business application the data source
|
1534
1751
|
# will be attached to.
|
@@ -2012,6 +2229,11 @@ module Aws::QBusiness
|
|
2012
2229
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html
|
2013
2230
|
# @return [Types::BrowserExtensionConfiguration]
|
2014
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
|
+
#
|
2015
2237
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateWebExperienceRequest AWS API Documentation
|
2016
2238
|
#
|
2017
2239
|
class CreateWebExperienceRequest < Struct.new(
|
@@ -2025,7 +2247,8 @@ module Aws::QBusiness
|
|
2025
2247
|
:tags,
|
2026
2248
|
:client_token,
|
2027
2249
|
:identity_provider_configuration,
|
2028
|
-
:browser_extension_configuration
|
2250
|
+
:browser_extension_configuration,
|
2251
|
+
:customization_configuration)
|
2029
2252
|
SENSITIVE = []
|
2030
2253
|
include Aws::Structure
|
2031
2254
|
end
|
@@ -2097,6 +2320,87 @@ module Aws::QBusiness
|
|
2097
2320
|
include Aws::Structure
|
2098
2321
|
end
|
2099
2322
|
|
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.
|
2326
|
+
#
|
2327
|
+
# @!attribute [rw] custom_css_url
|
2328
|
+
# Provides the URL where the custom CSS file is hosted for an Amazon Q
|
2329
|
+
# web experience.
|
2330
|
+
# @return [String]
|
2331
|
+
#
|
2332
|
+
# @!attribute [rw] logo_url
|
2333
|
+
# Provides the URL where the custom logo file is hosted for an Amazon
|
2334
|
+
# Q web experience.
|
2335
|
+
# @return [String]
|
2336
|
+
#
|
2337
|
+
# @!attribute [rw] font_url
|
2338
|
+
# Provides the URL where the custom font file is hosted for an Amazon
|
2339
|
+
# Q web experience.
|
2340
|
+
# @return [String]
|
2341
|
+
#
|
2342
|
+
# @!attribute [rw] favicon_url
|
2343
|
+
# Provides the URL where the custom favicon file is hosted for an
|
2344
|
+
# Amazon Q web experience.
|
2345
|
+
# @return [String]
|
2346
|
+
#
|
2347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CustomizationConfiguration AWS API Documentation
|
2348
|
+
#
|
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
|
+
|
2100
2404
|
# A data source in an Amazon Q Business application.
|
2101
2405
|
#
|
2102
2406
|
# @!attribute [rw] display_name
|
@@ -2344,6 +2648,27 @@ module Aws::QBusiness
|
|
2344
2648
|
#
|
2345
2649
|
class DeleteConversationResponse < Aws::EmptyStructure; end
|
2346
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
|
+
|
2347
2672
|
# @!attribute [rw] application_id
|
2348
2673
|
# The identifier of the Amazon Q Business application used with the
|
2349
2674
|
# data source connector.
|
@@ -2538,6 +2863,27 @@ module Aws::QBusiness
|
|
2538
2863
|
#
|
2539
2864
|
class DeleteWebExperienceResponse < Aws::EmptyStructure; end
|
2540
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
|
+
|
2541
2887
|
# A document in an Amazon Q Business application.
|
2542
2888
|
#
|
2543
2889
|
# @!attribute [rw] id
|
@@ -3248,6 +3594,11 @@ module Aws::QBusiness
|
|
3248
3594
|
# The OIDC client ID for a Amazon Q Business application.
|
3249
3595
|
# @return [Array<String>]
|
3250
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
|
+
#
|
3251
3602
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetApplicationResponse AWS API Documentation
|
3252
3603
|
#
|
3253
3604
|
class GetApplicationResponse < Struct.new(
|
@@ -3268,7 +3619,8 @@ module Aws::QBusiness
|
|
3268
3619
|
:q_apps_configuration,
|
3269
3620
|
:personalization_configuration,
|
3270
3621
|
:auto_subscription_configuration,
|
3271
|
-
:client_ids_for_oidc
|
3622
|
+
:client_ids_for_oidc,
|
3623
|
+
:quick_sight_configuration)
|
3272
3624
|
SENSITIVE = []
|
3273
3625
|
include Aws::Structure
|
3274
3626
|
end
|
@@ -3339,6 +3691,79 @@ module Aws::QBusiness
|
|
3339
3691
|
include Aws::Structure
|
3340
3692
|
end
|
3341
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
|
+
|
3342
3767
|
# @!attribute [rw] application_id
|
3343
3768
|
# The identifier of the Amazon Q Business application.
|
3344
3769
|
# @return [String]
|
@@ -3748,6 +4173,30 @@ module Aws::QBusiness
|
|
3748
4173
|
include Aws::Structure
|
3749
4174
|
end
|
3750
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
|
+
|
3751
4200
|
# @!attribute [rw] application_id
|
3752
4201
|
# The identifier of the Amazon Q Business application using the
|
3753
4202
|
# retriever.
|
@@ -3961,6 +4410,11 @@ module Aws::QBusiness
|
|
3961
4410
|
# experience.
|
3962
4411
|
# @return [Types::BrowserExtensionConfiguration]
|
3963
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
|
+
#
|
3964
4418
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperienceResponse AWS API Documentation
|
3965
4419
|
#
|
3966
4420
|
class GetWebExperienceResponse < Struct.new(
|
@@ -3980,7 +4434,8 @@ module Aws::QBusiness
|
|
3980
4434
|
:identity_provider_configuration,
|
3981
4435
|
:authentication_configuration,
|
3982
4436
|
:error,
|
3983
|
-
:browser_extension_configuration
|
4437
|
+
:browser_extension_configuration,
|
4438
|
+
:customization_configuration)
|
3984
4439
|
SENSITIVE = []
|
3985
4440
|
include Aws::Structure
|
3986
4441
|
end
|
@@ -4121,16 +4576,38 @@ module Aws::QBusiness
|
|
4121
4576
|
include Aws::Structure
|
4122
4577
|
end
|
4123
4578
|
|
4124
|
-
#
|
4125
|
-
#
|
4579
|
+
# Information about the IAM Identity Center Application used to
|
4580
|
+
# configure authentication for a plugin.
|
4126
4581
|
#
|
4127
|
-
#
|
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]
|
4128
4586
|
#
|
4129
|
-
#
|
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]
|
4130
4591
|
#
|
4131
|
-
#
|
4132
|
-
#
|
4133
|
-
|
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
|
+
|
4601
|
+
# Provides information about the identity provider (IdP) used to
|
4602
|
+
# authenticate end users of an Amazon Q Business web experience.
|
4603
|
+
#
|
4604
|
+
# @note IdentityProviderConfiguration is a union - when making an API calls you must set exactly one of the members.
|
4605
|
+
#
|
4606
|
+
# @note IdentityProviderConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IdentityProviderConfiguration corresponding to the set member.
|
4607
|
+
#
|
4608
|
+
# @!attribute [rw] saml_configuration
|
4609
|
+
# Information about the SAML 2.0-compliant identity provider (IdP)
|
4610
|
+
# used to authenticate end users of an Amazon Q Business web
|
4134
4611
|
# experience.
|
4135
4612
|
# @return [Types::SamlProviderConfiguration]
|
4136
4613
|
#
|
@@ -4510,6 +4987,47 @@ module Aws::QBusiness
|
|
4510
4987
|
include Aws::Structure
|
4511
4988
|
end
|
4512
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
|
+
|
4513
5031
|
# @!attribute [rw] data_source_id
|
4514
5032
|
# The identifier of the data source connector.
|
4515
5033
|
# @return [String]
|
@@ -4852,6 +5370,136 @@ module Aws::QBusiness
|
|
4852
5370
|
include Aws::Structure
|
4853
5371
|
end
|
4854
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.
|
5390
|
+
# @return [Integer]
|
5391
|
+
#
|
5392
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginActionsRequest AWS API Documentation
|
5393
|
+
#
|
5394
|
+
class ListPluginActionsRequest < Struct.new(
|
5395
|
+
:application_id,
|
5396
|
+
:plugin_id,
|
5397
|
+
:next_token,
|
5398
|
+
:max_results)
|
5399
|
+
SENSITIVE = []
|
5400
|
+
include Aws::Structure
|
5401
|
+
end
|
5402
|
+
|
5403
|
+
# @!attribute [rw] next_token
|
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.
|
5407
|
+
# @return [String]
|
5408
|
+
#
|
5409
|
+
# @!attribute [rw] items
|
5410
|
+
# An array of information on one or more plugin actions.
|
5411
|
+
# @return [Array<Types::ActionSummary>]
|
5412
|
+
#
|
5413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginActionsResponse AWS API Documentation
|
5414
|
+
#
|
5415
|
+
class ListPluginActionsResponse < Struct.new(
|
5416
|
+
:next_token,
|
5417
|
+
:items)
|
5418
|
+
SENSITIVE = []
|
5419
|
+
include Aws::Structure
|
5420
|
+
end
|
5421
|
+
|
5422
|
+
# @!attribute [rw] plugin_type
|
5423
|
+
# The type of the plugin.
|
5424
|
+
# @return [String]
|
5425
|
+
#
|
5426
|
+
# @!attribute [rw] next_token
|
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.
|
5430
|
+
# @return [String]
|
5431
|
+
#
|
5432
|
+
# @!attribute [rw] max_results
|
5433
|
+
# The maximum number of plugins to return.
|
5434
|
+
# @return [Integer]
|
5435
|
+
#
|
5436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginTypeActionsRequest AWS API Documentation
|
5437
|
+
#
|
5438
|
+
class ListPluginTypeActionsRequest < Struct.new(
|
5439
|
+
:plugin_type,
|
5440
|
+
:next_token,
|
5441
|
+
:max_results)
|
5442
|
+
SENSITIVE = []
|
5443
|
+
include Aws::Structure
|
5444
|
+
end
|
5445
|
+
|
5446
|
+
# @!attribute [rw] next_token
|
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.
|
5450
|
+
# @return [String]
|
5451
|
+
#
|
5452
|
+
# @!attribute [rw] items
|
5453
|
+
# An array of information on one or more plugins.
|
5454
|
+
# @return [Array<Types::ActionSummary>]
|
5455
|
+
#
|
5456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginTypeActionsResponse AWS API Documentation
|
5457
|
+
#
|
5458
|
+
class ListPluginTypeActionsResponse < Struct.new(
|
5459
|
+
:next_token,
|
5460
|
+
:items)
|
5461
|
+
SENSITIVE = []
|
5462
|
+
include Aws::Structure
|
5463
|
+
end
|
5464
|
+
|
5465
|
+
# @!attribute [rw] next_token
|
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.
|
5469
|
+
# @return [String]
|
5470
|
+
#
|
5471
|
+
# @!attribute [rw] max_results
|
5472
|
+
# The maximum number of plugin metadata items to return.
|
5473
|
+
# @return [Integer]
|
5474
|
+
#
|
5475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginTypeMetadataRequest AWS API Documentation
|
5476
|
+
#
|
5477
|
+
class ListPluginTypeMetadataRequest < Struct.new(
|
5478
|
+
:next_token,
|
5479
|
+
:max_results)
|
5480
|
+
SENSITIVE = []
|
5481
|
+
include Aws::Structure
|
5482
|
+
end
|
5483
|
+
|
5484
|
+
# @!attribute [rw] next_token
|
5485
|
+
# If the response is truncated, Amazon Q Business returns this token,
|
5486
|
+
# which you can use in a later request to list the next set of plugin
|
5487
|
+
# metadata.
|
5488
|
+
# @return [String]
|
5489
|
+
#
|
5490
|
+
# @!attribute [rw] items
|
5491
|
+
# An array of information on plugin metadata.
|
5492
|
+
# @return [Array<Types::PluginTypeMetadataSummary>]
|
5493
|
+
#
|
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)
|
5499
|
+
SENSITIVE = []
|
5500
|
+
include Aws::Structure
|
5501
|
+
end
|
5502
|
+
|
4855
5503
|
# @!attribute [rw] application_id
|
4856
5504
|
# The identifier of the application the plugin is attached to.
|
4857
5505
|
# @return [String]
|
@@ -5279,11 +5927,24 @@ module Aws::QBusiness
|
|
5279
5927
|
# 2.0 authentication credentials stored in a Secrets Manager secret.
|
5280
5928
|
# @return [String]
|
5281
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
|
+
#
|
5282
5941
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/OAuth2ClientCredentialConfiguration AWS API Documentation
|
5283
5942
|
#
|
5284
5943
|
class OAuth2ClientCredentialConfiguration < Struct.new(
|
5285
5944
|
:secret_arn,
|
5286
|
-
:role_arn
|
5945
|
+
:role_arn,
|
5946
|
+
:authorization_url,
|
5947
|
+
:token_url)
|
5287
5948
|
SENSITIVE = []
|
5288
5949
|
include Aws::Structure
|
5289
5950
|
end
|
@@ -5402,12 +6063,18 @@ module Aws::QBusiness
|
|
5402
6063
|
# authentication.
|
5403
6064
|
# @return [Types::NoAuthConfiguration]
|
5404
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
|
+
#
|
5405
6071
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PluginAuthConfiguration AWS API Documentation
|
5406
6072
|
#
|
5407
6073
|
class PluginAuthConfiguration < Struct.new(
|
5408
6074
|
:basic_auth_configuration,
|
5409
6075
|
:o_auth_2_client_credential_configuration,
|
5410
6076
|
:no_auth_configuration,
|
6077
|
+
:idc_auth_configuration,
|
5411
6078
|
:unknown)
|
5412
6079
|
SENSITIVE = []
|
5413
6080
|
include Aws::Structure
|
@@ -5416,6 +6083,7 @@ module Aws::QBusiness
|
|
5416
6083
|
class BasicAuthConfiguration < PluginAuthConfiguration; end
|
5417
6084
|
class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
|
5418
6085
|
class NoAuthConfiguration < PluginAuthConfiguration; end
|
6086
|
+
class IdcAuthConfiguration < PluginAuthConfiguration; end
|
5419
6087
|
class Unknown < PluginAuthConfiguration; end
|
5420
6088
|
end
|
5421
6089
|
|
@@ -5442,6 +6110,31 @@ module Aws::QBusiness
|
|
5442
6110
|
include Aws::Structure
|
5443
6111
|
end
|
5444
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
|
+
|
5445
6138
|
# Provides user and group information used for filtering documents to
|
5446
6139
|
# use for generating Amazon Q Business conversation responses.
|
5447
6140
|
#
|
@@ -5635,8 +6328,76 @@ module Aws::QBusiness
|
|
5635
6328
|
include Aws::Structure
|
5636
6329
|
end
|
5637
6330
|
|
5638
|
-
# The
|
5639
|
-
#
|
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.
|
5640
6401
|
#
|
5641
6402
|
# @!attribute [rw] message
|
5642
6403
|
# The message describing a `ResourceNotFoundException`.
|
@@ -5729,6 +6490,20 @@ module Aws::QBusiness
|
|
5729
6490
|
class Unknown < RetrieverConfiguration; end
|
5730
6491
|
end
|
5731
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
|
+
|
5732
6507
|
# Guardrail rules for an Amazon Q Business application. Amazon Q
|
5733
6508
|
# Business supports only one rule at a time.
|
5734
6509
|
#
|
@@ -5860,6 +6635,87 @@ module Aws::QBusiness
|
|
5860
6635
|
include Aws::Structure
|
5861
6636
|
end
|
5862
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
|
+
|
5863
6719
|
# You have exceeded the set limits for your Amazon Q Business service.
|
5864
6720
|
#
|
5865
6721
|
# @!attribute [rw] message
|
@@ -6429,6 +7285,38 @@ module Aws::QBusiness
|
|
6429
7285
|
#
|
6430
7286
|
class UpdateChatControlsConfigurationResponse < Aws::EmptyStructure; end
|
6431
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
|
+
|
6432
7320
|
# @!attribute [rw] application_id
|
6433
7321
|
# The identifier of the Amazon Q Business application the data source
|
6434
7322
|
# is attached to.
|
@@ -6763,6 +7651,11 @@ module Aws::QBusiness
|
|
6763
7651
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html
|
6764
7652
|
# @return [Types::BrowserExtensionConfiguration]
|
6765
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
|
+
#
|
6766
7659
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperienceRequest AWS API Documentation
|
6767
7660
|
#
|
6768
7661
|
class UpdateWebExperienceRequest < Struct.new(
|
@@ -6776,7 +7669,8 @@ module Aws::QBusiness
|
|
6776
7669
|
:sample_prompts_control_mode,
|
6777
7670
|
:identity_provider_configuration,
|
6778
7671
|
:origins,
|
6779
|
-
:browser_extension_configuration
|
7672
|
+
:browser_extension_configuration,
|
7673
|
+
:customization_configuration)
|
6780
7674
|
SENSITIVE = []
|
6781
7675
|
include Aws::Structure
|
6782
7676
|
end
|