aws-sdk-qbusiness 1.26.0 → 1.28.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/async_client.rb +1 -1
- data/lib/aws-sdk-qbusiness/client.rb +277 -57
- data/lib/aws-sdk-qbusiness/client_api.rb +149 -0
- data/lib/aws-sdk-qbusiness/types.rb +383 -22
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/client.rbs +63 -0
- data/sig/types.rbs +96 -0
- metadata +2 -2
@@ -109,7 +109,7 @@ module Aws::QBusiness
|
|
109
109
|
# Specifies an allowed action and its associated filter configuration.
|
110
110
|
#
|
111
111
|
# @!attribute [rw] action
|
112
|
-
# The Q Business action that is allowed.
|
112
|
+
# The Amazon Q Business action that is allowed.
|
113
113
|
# @return [String]
|
114
114
|
#
|
115
115
|
# @!attribute [rw] filter_configuration
|
@@ -511,8 +511,32 @@ module Aws::QBusiness
|
|
511
511
|
include Aws::Structure
|
512
512
|
end
|
513
513
|
|
514
|
+
# The chat orchestration specific admin controls configured for an
|
515
|
+
# Amazon Q Business application. Determines whether Amazon Q Business
|
516
|
+
# automatically routes chat requests across configured plugins and data
|
517
|
+
# sources in your Amazon Q Business application.
|
518
|
+
#
|
519
|
+
# For more information, see [Chat orchestration settings][1].
|
520
|
+
#
|
521
|
+
#
|
522
|
+
#
|
523
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails-global-controls.html#guardrails-global-orchestration
|
524
|
+
#
|
525
|
+
# @!attribute [rw] control
|
526
|
+
# Information about whether chat orchestration is enabled or disabled
|
527
|
+
# for an Amazon Q Business application.
|
528
|
+
# @return [String]
|
529
|
+
#
|
530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AppliedOrchestrationConfiguration AWS API Documentation
|
531
|
+
#
|
532
|
+
class AppliedOrchestrationConfiguration < Struct.new(
|
533
|
+
:control)
|
534
|
+
SENSITIVE = []
|
535
|
+
include Aws::Structure
|
536
|
+
end
|
537
|
+
|
514
538
|
# @!attribute [rw] application_id
|
515
|
-
# The unique identifier of the Q Business application.
|
539
|
+
# The unique identifier of the Amazon Q Business application.
|
516
540
|
# @return [String]
|
517
541
|
#
|
518
542
|
# @!attribute [rw] statement_id
|
@@ -520,12 +544,13 @@ module Aws::QBusiness
|
|
520
544
|
# @return [String]
|
521
545
|
#
|
522
546
|
# @!attribute [rw] actions
|
523
|
-
# The list of Q Business actions that the ISV is allowed to
|
547
|
+
# The list of Amazon Q Business actions that the ISV is allowed to
|
548
|
+
# perform.
|
524
549
|
# @return [Array<String>]
|
525
550
|
#
|
526
551
|
# @!attribute [rw] principal
|
527
|
-
# The Amazon Resource Name
|
528
|
-
#
|
552
|
+
# The Amazon Resource Name of the IAM role for the ISV that is being
|
553
|
+
# granted permission.
|
529
554
|
# @return [String]
|
530
555
|
#
|
531
556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AssociatePermissionRequest AWS API Documentation
|
@@ -1093,6 +1118,48 @@ module Aws::QBusiness
|
|
1093
1118
|
include Aws::Structure
|
1094
1119
|
end
|
1095
1120
|
|
1121
|
+
# @!attribute [rw] application_id
|
1122
|
+
# The identifier of the Amazon Q Business application for which the
|
1123
|
+
# subscription is being cancelled.
|
1124
|
+
# @return [String]
|
1125
|
+
#
|
1126
|
+
# @!attribute [rw] subscription_id
|
1127
|
+
# The identifier of the Amazon Q Business subscription being
|
1128
|
+
# cancelled.
|
1129
|
+
# @return [String]
|
1130
|
+
#
|
1131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CancelSubscriptionRequest AWS API Documentation
|
1132
|
+
#
|
1133
|
+
class CancelSubscriptionRequest < Struct.new(
|
1134
|
+
:application_id,
|
1135
|
+
:subscription_id)
|
1136
|
+
SENSITIVE = []
|
1137
|
+
include Aws::Structure
|
1138
|
+
end
|
1139
|
+
|
1140
|
+
# @!attribute [rw] subscription_arn
|
1141
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business subscription
|
1142
|
+
# being cancelled.
|
1143
|
+
# @return [String]
|
1144
|
+
#
|
1145
|
+
# @!attribute [rw] current_subscription
|
1146
|
+
# The type of your current Amazon Q Business subscription.
|
1147
|
+
# @return [Types::SubscriptionDetails]
|
1148
|
+
#
|
1149
|
+
# @!attribute [rw] next_subscription
|
1150
|
+
# The type of the Amazon Q Business subscription for the next month.
|
1151
|
+
# @return [Types::SubscriptionDetails]
|
1152
|
+
#
|
1153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CancelSubscriptionResponse AWS API Documentation
|
1154
|
+
#
|
1155
|
+
class CancelSubscriptionResponse < Struct.new(
|
1156
|
+
:subscription_arn,
|
1157
|
+
:current_subscription,
|
1158
|
+
:next_subscription)
|
1159
|
+
SENSITIVE = []
|
1160
|
+
include Aws::Structure
|
1161
|
+
end
|
1162
|
+
|
1096
1163
|
# @!attribute [rw] application_id
|
1097
1164
|
# The identifier of the Amazon Q Business application linked to a
|
1098
1165
|
# streaming Amazon Q Business conversation.
|
@@ -1681,7 +1748,7 @@ module Aws::QBusiness
|
|
1681
1748
|
end
|
1682
1749
|
|
1683
1750
|
# @!attribute [rw] application_id
|
1684
|
-
# The unique identifier of the Q Business application.
|
1751
|
+
# The unique identifier of the Amazon Q Business application.
|
1685
1752
|
# @return [String]
|
1686
1753
|
#
|
1687
1754
|
# @!attribute [rw] principal
|
@@ -1728,7 +1795,7 @@ module Aws::QBusiness
|
|
1728
1795
|
# @return [String]
|
1729
1796
|
#
|
1730
1797
|
# @!attribute [rw] idc_application_arn
|
1731
|
-
# The Amazon Resource Name (ARN) of the
|
1798
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center
|
1732
1799
|
# application created for this data accessor.
|
1733
1800
|
# @return [String]
|
1734
1801
|
#
|
@@ -2111,6 +2178,68 @@ module Aws::QBusiness
|
|
2111
2178
|
include Aws::Structure
|
2112
2179
|
end
|
2113
2180
|
|
2181
|
+
# @!attribute [rw] application_id
|
2182
|
+
# The identifier of the Amazon Q Business application the subscription
|
2183
|
+
# should be added to.
|
2184
|
+
# @return [String]
|
2185
|
+
#
|
2186
|
+
# @!attribute [rw] principal
|
2187
|
+
# The IAM Identity Center `UserId` or `GroupId` of a user or group in
|
2188
|
+
# the IAM Identity Center instance connected to the Amazon Q Business
|
2189
|
+
# application.
|
2190
|
+
# @return [Types::SubscriptionPrincipal]
|
2191
|
+
#
|
2192
|
+
# @!attribute [rw] type
|
2193
|
+
# The type of Amazon Q Business subscription you want to create.
|
2194
|
+
# @return [String]
|
2195
|
+
#
|
2196
|
+
# @!attribute [rw] client_token
|
2197
|
+
# A token that you provide to identify the request to create a
|
2198
|
+
# subscription for your Amazon Q Business application.
|
2199
|
+
#
|
2200
|
+
# **A suitable default value is auto-generated.** You should normally
|
2201
|
+
# not need to pass this option.
|
2202
|
+
# @return [String]
|
2203
|
+
#
|
2204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateSubscriptionRequest AWS API Documentation
|
2205
|
+
#
|
2206
|
+
class CreateSubscriptionRequest < Struct.new(
|
2207
|
+
:application_id,
|
2208
|
+
:principal,
|
2209
|
+
:type,
|
2210
|
+
:client_token)
|
2211
|
+
SENSITIVE = []
|
2212
|
+
include Aws::Structure
|
2213
|
+
end
|
2214
|
+
|
2215
|
+
# @!attribute [rw] subscription_id
|
2216
|
+
# The identifier of the Amazon Q Business subscription created.
|
2217
|
+
# @return [String]
|
2218
|
+
#
|
2219
|
+
# @!attribute [rw] subscription_arn
|
2220
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business subscription
|
2221
|
+
# created.
|
2222
|
+
# @return [String]
|
2223
|
+
#
|
2224
|
+
# @!attribute [rw] current_subscription
|
2225
|
+
# The type of your current Amazon Q Business subscription.
|
2226
|
+
# @return [Types::SubscriptionDetails]
|
2227
|
+
#
|
2228
|
+
# @!attribute [rw] next_subscription
|
2229
|
+
# The type of the Amazon Q Business subscription for the next month.
|
2230
|
+
# @return [Types::SubscriptionDetails]
|
2231
|
+
#
|
2232
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateSubscriptionResponse AWS API Documentation
|
2233
|
+
#
|
2234
|
+
class CreateSubscriptionResponse < Struct.new(
|
2235
|
+
:subscription_id,
|
2236
|
+
:subscription_arn,
|
2237
|
+
:current_subscription,
|
2238
|
+
:next_subscription)
|
2239
|
+
SENSITIVE = []
|
2240
|
+
include Aws::Structure
|
2241
|
+
end
|
2242
|
+
|
2114
2243
|
# @!attribute [rw] application_id
|
2115
2244
|
# The identifier of the application for which the user mapping will be
|
2116
2245
|
# created.
|
@@ -2370,8 +2499,8 @@ module Aws::QBusiness
|
|
2370
2499
|
# @return [String]
|
2371
2500
|
#
|
2372
2501
|
# @!attribute [rw] idc_application_arn
|
2373
|
-
# The Amazon Resource Name (ARN) of the associated
|
2374
|
-
#
|
2502
|
+
# The Amazon Resource Name (ARN) of the associated IAM Identity Center
|
2503
|
+
# application.
|
2375
2504
|
# @return [String]
|
2376
2505
|
#
|
2377
2506
|
# @!attribute [rw] principal
|
@@ -2649,7 +2778,7 @@ module Aws::QBusiness
|
|
2649
2778
|
class DeleteConversationResponse < Aws::EmptyStructure; end
|
2650
2779
|
|
2651
2780
|
# @!attribute [rw] application_id
|
2652
|
-
# The unique identifier of the Q Business application.
|
2781
|
+
# The unique identifier of the Amazon Q Business application.
|
2653
2782
|
# @return [String]
|
2654
2783
|
#
|
2655
2784
|
# @!attribute [rw] data_accessor_id
|
@@ -2864,7 +2993,7 @@ module Aws::QBusiness
|
|
2864
2993
|
class DeleteWebExperienceResponse < Aws::EmptyStructure; end
|
2865
2994
|
|
2866
2995
|
# @!attribute [rw] application_id
|
2867
|
-
# The unique identifier of the Q Business application.
|
2996
|
+
# The unique identifier of the Amazon Q Business application.
|
2868
2997
|
# @return [String]
|
2869
2998
|
#
|
2870
2999
|
# @!attribute [rw] statement_id
|
@@ -3659,6 +3788,20 @@ module Aws::QBusiness
|
|
3659
3788
|
# knowledge to respons to end user questions in chat.
|
3660
3789
|
# @return [String]
|
3661
3790
|
#
|
3791
|
+
# @!attribute [rw] orchestration_configuration
|
3792
|
+
# The chat response orchestration settings for your application.
|
3793
|
+
#
|
3794
|
+
# <note markdown="1"> Chat orchestration is optimized to work for English language
|
3795
|
+
# content. For more details on language support in Amazon Q Business,
|
3796
|
+
# see [Supported languages][1].
|
3797
|
+
#
|
3798
|
+
# </note>
|
3799
|
+
#
|
3800
|
+
#
|
3801
|
+
#
|
3802
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html
|
3803
|
+
# @return [Types::AppliedOrchestrationConfiguration]
|
3804
|
+
#
|
3662
3805
|
# @!attribute [rw] blocked_phrases
|
3663
3806
|
# The phrases blocked from chat by your chat control configuration.
|
3664
3807
|
# @return [Types::BlockedPhrasesConfiguration]
|
@@ -3683,6 +3826,7 @@ module Aws::QBusiness
|
|
3683
3826
|
#
|
3684
3827
|
class GetChatControlsConfigurationResponse < Struct.new(
|
3685
3828
|
:response_scope,
|
3829
|
+
:orchestration_configuration,
|
3686
3830
|
:blocked_phrases,
|
3687
3831
|
:topic_configurations,
|
3688
3832
|
:creator_mode_configuration,
|
@@ -3692,7 +3836,7 @@ module Aws::QBusiness
|
|
3692
3836
|
end
|
3693
3837
|
|
3694
3838
|
# @!attribute [rw] application_id
|
3695
|
-
# The unique identifier of the Q Business application.
|
3839
|
+
# The unique identifier of the Amazon Q Business application.
|
3696
3840
|
# @return [String]
|
3697
3841
|
#
|
3698
3842
|
# @!attribute [rw] data_accessor_id
|
@@ -3721,12 +3865,12 @@ module Aws::QBusiness
|
|
3721
3865
|
# @return [String]
|
3722
3866
|
#
|
3723
3867
|
# @!attribute [rw] application_id
|
3724
|
-
# The unique identifier of the Q Business application
|
3725
|
-
# this data accessor.
|
3868
|
+
# The unique identifier of the Amazon Q Business application
|
3869
|
+
# associated with this data accessor.
|
3726
3870
|
# @return [String]
|
3727
3871
|
#
|
3728
3872
|
# @!attribute [rw] idc_application_arn
|
3729
|
-
# The Amazon Resource Name (ARN) of the
|
3873
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center
|
3730
3874
|
# application associated with this data accessor.
|
3731
3875
|
# @return [String]
|
3732
3876
|
#
|
@@ -4174,7 +4318,7 @@ module Aws::QBusiness
|
|
4174
4318
|
end
|
4175
4319
|
|
4176
4320
|
# @!attribute [rw] application_id
|
4177
|
-
# The unique identifier of the Q Business application.
|
4321
|
+
# The unique identifier of the Amazon Q Business application.
|
4178
4322
|
# @return [String]
|
4179
4323
|
#
|
4180
4324
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetPolicyRequest AWS API Documentation
|
@@ -4988,7 +5132,7 @@ module Aws::QBusiness
|
|
4988
5132
|
end
|
4989
5133
|
|
4990
5134
|
# @!attribute [rw] application_id
|
4991
|
-
# The unique identifier of the Q Business application.
|
5135
|
+
# The unique identifier of the Amazon Q Business application.
|
4992
5136
|
# @return [String]
|
4993
5137
|
#
|
4994
5138
|
# @!attribute [rw] next_token
|
@@ -5589,6 +5733,52 @@ module Aws::QBusiness
|
|
5589
5733
|
include Aws::Structure
|
5590
5734
|
end
|
5591
5735
|
|
5736
|
+
# @!attribute [rw] application_id
|
5737
|
+
# The identifier of the Amazon Q Business application linked to the
|
5738
|
+
# subscription.
|
5739
|
+
# @return [String]
|
5740
|
+
#
|
5741
|
+
# @!attribute [rw] next_token
|
5742
|
+
# If the `maxResults` response was incomplete because there is more
|
5743
|
+
# data to retrieve, Amazon Q Business returns a pagination token in
|
5744
|
+
# the response. You can use this pagination token to retrieve the next
|
5745
|
+
# set of Amazon Q Business subscriptions.
|
5746
|
+
# @return [String]
|
5747
|
+
#
|
5748
|
+
# @!attribute [rw] max_results
|
5749
|
+
# The maximum number of Amazon Q Business subscriptions to return.
|
5750
|
+
# @return [Integer]
|
5751
|
+
#
|
5752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListSubscriptionsRequest AWS API Documentation
|
5753
|
+
#
|
5754
|
+
class ListSubscriptionsRequest < Struct.new(
|
5755
|
+
:application_id,
|
5756
|
+
:next_token,
|
5757
|
+
:max_results)
|
5758
|
+
SENSITIVE = []
|
5759
|
+
include Aws::Structure
|
5760
|
+
end
|
5761
|
+
|
5762
|
+
# @!attribute [rw] next_token
|
5763
|
+
# If the response is truncated, Amazon Q Business returns this token.
|
5764
|
+
# You can use this token in a subsequent request to retrieve the next
|
5765
|
+
# set of subscriptions.
|
5766
|
+
# @return [String]
|
5767
|
+
#
|
5768
|
+
# @!attribute [rw] subscriptions
|
5769
|
+
# An array of summary information on the subscriptions configured for
|
5770
|
+
# an Amazon Q Business application.
|
5771
|
+
# @return [Array<Types::Subscription>]
|
5772
|
+
#
|
5773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListSubscriptionsResponse AWS API Documentation
|
5774
|
+
#
|
5775
|
+
class ListSubscriptionsResponse < Struct.new(
|
5776
|
+
:next_token,
|
5777
|
+
:subscriptions)
|
5778
|
+
SENSITIVE = []
|
5779
|
+
include Aws::Structure
|
5780
|
+
end
|
5781
|
+
|
5592
5782
|
# @!attribute [rw] resource_arn
|
5593
5783
|
# The Amazon Resource Name (ARN) of the Amazon Q Business application
|
5594
5784
|
# or data source to get a list of tags for.
|
@@ -5971,6 +6161,32 @@ module Aws::QBusiness
|
|
5971
6161
|
include Aws::Structure
|
5972
6162
|
end
|
5973
6163
|
|
6164
|
+
# Configuration information required to enable chat orchestration for
|
6165
|
+
# your Amazon Q Business application.
|
6166
|
+
#
|
6167
|
+
# <note markdown="1"> Chat orchestration is optimized to work for English language content.
|
6168
|
+
# For more details on language support in Amazon Q Business, see
|
6169
|
+
# [Supported languages][1].
|
6170
|
+
#
|
6171
|
+
# </note>
|
6172
|
+
#
|
6173
|
+
#
|
6174
|
+
#
|
6175
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html
|
6176
|
+
#
|
6177
|
+
# @!attribute [rw] control
|
6178
|
+
# Status information about whether chat orchestration is activated or
|
6179
|
+
# deactivated for your Amazon Q Business application.
|
6180
|
+
# @return [String]
|
6181
|
+
#
|
6182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/OrchestrationConfiguration AWS API Documentation
|
6183
|
+
#
|
6184
|
+
class OrchestrationConfiguration < Struct.new(
|
6185
|
+
:control)
|
6186
|
+
SENSITIVE = []
|
6187
|
+
include Aws::Structure
|
6188
|
+
end
|
6189
|
+
|
5974
6190
|
# Configuration information about chat response personalization. For
|
5975
6191
|
# more information, see [Personalizing chat responses][1].
|
5976
6192
|
#
|
@@ -6290,9 +6506,7 @@ module Aws::QBusiness
|
|
6290
6506
|
#
|
6291
6507
|
# @!attribute [rw] role_arn
|
6292
6508
|
# The Amazon Resource Name (ARN) of an IAM role that has access to the
|
6293
|
-
# S3 file that contains your list of users that belong to a group.
|
6294
|
-
# Amazon Resource Name (ARN) of an IAM role that has access to the S3
|
6295
|
-
# file that contains your list of users that belong to a group.
|
6509
|
+
# S3 file that contains your list of users that belong to a group.
|
6296
6510
|
# @return [String]
|
6297
6511
|
#
|
6298
6512
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutGroupRequest AWS API Documentation
|
@@ -6650,7 +6864,8 @@ module Aws::QBusiness
|
|
6650
6864
|
end
|
6651
6865
|
|
6652
6866
|
# @!attribute [rw] application_id
|
6653
|
-
# The unique identifier of the Q Business application to
|
6867
|
+
# The unique identifier of the Amazon Q Business application to
|
6868
|
+
# search.
|
6654
6869
|
# @return [String]
|
6655
6870
|
#
|
6656
6871
|
# @!attribute [rw] query_text
|
@@ -6927,6 +7142,101 @@ module Aws::QBusiness
|
|
6927
7142
|
include Aws::Structure
|
6928
7143
|
end
|
6929
7144
|
|
7145
|
+
# Information about an Amazon Q Business subscription.
|
7146
|
+
#
|
7147
|
+
# Subscriptions are used to provide access for an IAM Identity Center
|
7148
|
+
# user or a group to an Amazon Q Business application.
|
7149
|
+
#
|
7150
|
+
# Amazon Q Business offers two subscription tiers: `Q_LITE` and
|
7151
|
+
# `Q_BUSINESS`. Subscription tier determines feature access for the
|
7152
|
+
# user. For more information on subscriptions and pricing tiers, see
|
7153
|
+
# [Amazon Q Business pricing][1].
|
7154
|
+
#
|
7155
|
+
#
|
7156
|
+
#
|
7157
|
+
# [1]: https://aws.amazon.com/q/business/pricing/
|
7158
|
+
#
|
7159
|
+
# @!attribute [rw] subscription_id
|
7160
|
+
# The identifier of the Amazon Q Business subscription to be updated.
|
7161
|
+
# @return [String]
|
7162
|
+
#
|
7163
|
+
# @!attribute [rw] subscription_arn
|
7164
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business subscription
|
7165
|
+
# that was updated.
|
7166
|
+
# @return [String]
|
7167
|
+
#
|
7168
|
+
# @!attribute [rw] principal
|
7169
|
+
# The IAM Identity Center `UserId` or `GroupId` of a user or group in
|
7170
|
+
# the IAM Identity Center instance connected to the Amazon Q Business
|
7171
|
+
# application.
|
7172
|
+
# @return [Types::SubscriptionPrincipal]
|
7173
|
+
#
|
7174
|
+
# @!attribute [rw] current_subscription
|
7175
|
+
# The type of your current Amazon Q Business subscription.
|
7176
|
+
# @return [Types::SubscriptionDetails]
|
7177
|
+
#
|
7178
|
+
# @!attribute [rw] next_subscription
|
7179
|
+
# The type of the Amazon Q Business subscription for the next month.
|
7180
|
+
# @return [Types::SubscriptionDetails]
|
7181
|
+
#
|
7182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Subscription AWS API Documentation
|
7183
|
+
#
|
7184
|
+
class Subscription < Struct.new(
|
7185
|
+
:subscription_id,
|
7186
|
+
:subscription_arn,
|
7187
|
+
:principal,
|
7188
|
+
:current_subscription,
|
7189
|
+
:next_subscription)
|
7190
|
+
SENSITIVE = []
|
7191
|
+
include Aws::Structure
|
7192
|
+
end
|
7193
|
+
|
7194
|
+
# The details of an Amazon Q Business subscription.
|
7195
|
+
#
|
7196
|
+
# @!attribute [rw] type
|
7197
|
+
# The type of an Amazon Q Business subscription.
|
7198
|
+
# @return [String]
|
7199
|
+
#
|
7200
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SubscriptionDetails AWS API Documentation
|
7201
|
+
#
|
7202
|
+
class SubscriptionDetails < Struct.new(
|
7203
|
+
:type)
|
7204
|
+
SENSITIVE = []
|
7205
|
+
include Aws::Structure
|
7206
|
+
end
|
7207
|
+
|
7208
|
+
# A user or group in the IAM Identity Center instance connected to the
|
7209
|
+
# Amazon Q Business application.
|
7210
|
+
#
|
7211
|
+
# @note SubscriptionPrincipal is a union - when making an API calls you must set exactly one of the members.
|
7212
|
+
#
|
7213
|
+
# @note SubscriptionPrincipal is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of SubscriptionPrincipal corresponding to the set member.
|
7214
|
+
#
|
7215
|
+
# @!attribute [rw] user
|
7216
|
+
# The identifier of a user in the IAM Identity Center instance
|
7217
|
+
# connected to the Amazon Q Business application.
|
7218
|
+
# @return [String]
|
7219
|
+
#
|
7220
|
+
# @!attribute [rw] group
|
7221
|
+
# The identifier of a group in the IAM Identity Center instance
|
7222
|
+
# connected to the Amazon Q Business application.
|
7223
|
+
# @return [String]
|
7224
|
+
#
|
7225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SubscriptionPrincipal AWS API Documentation
|
7226
|
+
#
|
7227
|
+
class SubscriptionPrincipal < Struct.new(
|
7228
|
+
:user,
|
7229
|
+
:group,
|
7230
|
+
:unknown)
|
7231
|
+
SENSITIVE = []
|
7232
|
+
include Aws::Structure
|
7233
|
+
include Aws::Structure::Union
|
7234
|
+
|
7235
|
+
class User < SubscriptionPrincipal; end
|
7236
|
+
class Group < SubscriptionPrincipal; end
|
7237
|
+
class Unknown < SubscriptionPrincipal; end
|
7238
|
+
end
|
7239
|
+
|
6930
7240
|
# A list of key/value pairs that identify an index, FAQ, or data source.
|
6931
7241
|
# Tag keys and values can consist of Unicode letters, digits, white
|
6932
7242
|
# space, and any of the following symbols: \_ . : / = + - @.
|
@@ -7241,6 +7551,10 @@ module Aws::QBusiness
|
|
7241
7551
|
# end user questions in chat.
|
7242
7552
|
# @return [String]
|
7243
7553
|
#
|
7554
|
+
# @!attribute [rw] orchestration_configuration
|
7555
|
+
# The chat response orchestration settings for your application.
|
7556
|
+
# @return [Types::OrchestrationConfiguration]
|
7557
|
+
#
|
7244
7558
|
# @!attribute [rw] blocked_phrases_configuration_update
|
7245
7559
|
# The phrases blocked from chat by your chat control configuration.
|
7246
7560
|
# @return [Types::BlockedPhrasesConfigurationUpdate]
|
@@ -7263,6 +7577,7 @@ module Aws::QBusiness
|
|
7263
7577
|
:application_id,
|
7264
7578
|
:client_token,
|
7265
7579
|
:response_scope,
|
7580
|
+
:orchestration_configuration,
|
7266
7581
|
:blocked_phrases_configuration_update,
|
7267
7582
|
:topic_configurations_to_create_or_update,
|
7268
7583
|
:topic_configurations_to_delete,
|
@@ -7276,7 +7591,7 @@ module Aws::QBusiness
|
|
7276
7591
|
class UpdateChatControlsConfigurationResponse < Aws::EmptyStructure; end
|
7277
7592
|
|
7278
7593
|
# @!attribute [rw] application_id
|
7279
|
-
# The unique identifier of the Q Business application.
|
7594
|
+
# The unique identifier of the Amazon Q Business application.
|
7280
7595
|
# @return [String]
|
7281
7596
|
#
|
7282
7597
|
# @!attribute [rw] data_accessor_id
|
@@ -7521,6 +7836,52 @@ module Aws::QBusiness
|
|
7521
7836
|
#
|
7522
7837
|
class UpdateRetrieverResponse < Aws::EmptyStructure; end
|
7523
7838
|
|
7839
|
+
# @!attribute [rw] application_id
|
7840
|
+
# The identifier of the Amazon Q Business application where the
|
7841
|
+
# subscription update should take effect.
|
7842
|
+
# @return [String]
|
7843
|
+
#
|
7844
|
+
# @!attribute [rw] subscription_id
|
7845
|
+
# The identifier of the Amazon Q Business subscription to be updated.
|
7846
|
+
# @return [String]
|
7847
|
+
#
|
7848
|
+
# @!attribute [rw] type
|
7849
|
+
# The type of the Amazon Q Business subscription to be updated.
|
7850
|
+
# @return [String]
|
7851
|
+
#
|
7852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateSubscriptionRequest AWS API Documentation
|
7853
|
+
#
|
7854
|
+
class UpdateSubscriptionRequest < Struct.new(
|
7855
|
+
:application_id,
|
7856
|
+
:subscription_id,
|
7857
|
+
:type)
|
7858
|
+
SENSITIVE = []
|
7859
|
+
include Aws::Structure
|
7860
|
+
end
|
7861
|
+
|
7862
|
+
# @!attribute [rw] subscription_arn
|
7863
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business subscription
|
7864
|
+
# that was updated.
|
7865
|
+
# @return [String]
|
7866
|
+
#
|
7867
|
+
# @!attribute [rw] current_subscription
|
7868
|
+
# The type of your current Amazon Q Business subscription.
|
7869
|
+
# @return [Types::SubscriptionDetails]
|
7870
|
+
#
|
7871
|
+
# @!attribute [rw] next_subscription
|
7872
|
+
# The type of the Amazon Q Business subscription for the next month.
|
7873
|
+
# @return [Types::SubscriptionDetails]
|
7874
|
+
#
|
7875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateSubscriptionResponse AWS API Documentation
|
7876
|
+
#
|
7877
|
+
class UpdateSubscriptionResponse < Struct.new(
|
7878
|
+
:subscription_arn,
|
7879
|
+
:current_subscription,
|
7880
|
+
:next_subscription)
|
7881
|
+
SENSITIVE = []
|
7882
|
+
include Aws::Structure
|
7883
|
+
end
|
7884
|
+
|
7524
7885
|
# @!attribute [rw] application_id
|
7525
7886
|
# The identifier of the application the user is attached to.
|
7526
7887
|
# @return [String]
|
data/lib/aws-sdk-qbusiness.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -232,6 +232,19 @@ module Aws
|
|
232
232
|
) -> _BatchPutDocumentResponseSuccess
|
233
233
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchPutDocumentResponseSuccess
|
234
234
|
|
235
|
+
interface _CancelSubscriptionResponseSuccess
|
236
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CancelSubscriptionResponse]
|
237
|
+
def subscription_arn: () -> ::String
|
238
|
+
def current_subscription: () -> Types::SubscriptionDetails
|
239
|
+
def next_subscription: () -> Types::SubscriptionDetails
|
240
|
+
end
|
241
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#cancel_subscription-instance_method
|
242
|
+
def cancel_subscription: (
|
243
|
+
application_id: ::String,
|
244
|
+
subscription_id: ::String
|
245
|
+
) -> _CancelSubscriptionResponseSuccess
|
246
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelSubscriptionResponseSuccess
|
247
|
+
|
235
248
|
interface _ChatResponseSuccess
|
236
249
|
include ::Seahorse::Client::_ResponseSuccess[Types::ChatOutput]
|
237
250
|
def output_stream: () -> Types::ChatOutputStream
|
@@ -723,6 +736,25 @@ module Aws
|
|
723
736
|
) -> _CreateRetrieverResponseSuccess
|
724
737
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRetrieverResponseSuccess
|
725
738
|
|
739
|
+
interface _CreateSubscriptionResponseSuccess
|
740
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateSubscriptionResponse]
|
741
|
+
def subscription_id: () -> ::String
|
742
|
+
def subscription_arn: () -> ::String
|
743
|
+
def current_subscription: () -> Types::SubscriptionDetails
|
744
|
+
def next_subscription: () -> Types::SubscriptionDetails
|
745
|
+
end
|
746
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_subscription-instance_method
|
747
|
+
def create_subscription: (
|
748
|
+
application_id: ::String,
|
749
|
+
principal: {
|
750
|
+
user: ::String?,
|
751
|
+
group: ::String?
|
752
|
+
},
|
753
|
+
type: ("Q_LITE" | "Q_BUSINESS"),
|
754
|
+
?client_token: ::String
|
755
|
+
) -> _CreateSubscriptionResponseSuccess
|
756
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSubscriptionResponseSuccess
|
757
|
+
|
726
758
|
interface _CreateUserResponseSuccess
|
727
759
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserResponse]
|
728
760
|
end
|
@@ -935,6 +967,7 @@ module Aws
|
|
935
967
|
interface _GetChatControlsConfigurationResponseSuccess
|
936
968
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetChatControlsConfigurationResponse]
|
937
969
|
def response_scope: () -> ("ENTERPRISE_CONTENT_ONLY" | "EXTENDED_KNOWLEDGE_ENABLED")
|
970
|
+
def orchestration_configuration: () -> Types::AppliedOrchestrationConfiguration
|
938
971
|
def blocked_phrases: () -> Types::BlockedPhrasesConfiguration
|
939
972
|
def topic_configurations: () -> ::Array[Types::TopicConfiguration]
|
940
973
|
def creator_mode_configuration: () -> Types::AppliedCreatorModeConfiguration
|
@@ -1344,6 +1377,19 @@ module Aws
|
|
1344
1377
|
) -> _ListRetrieversResponseSuccess
|
1345
1378
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRetrieversResponseSuccess
|
1346
1379
|
|
1380
|
+
interface _ListSubscriptionsResponseSuccess
|
1381
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSubscriptionsResponse]
|
1382
|
+
def next_token: () -> ::String
|
1383
|
+
def subscriptions: () -> ::Array[Types::Subscription]
|
1384
|
+
end
|
1385
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_subscriptions-instance_method
|
1386
|
+
def list_subscriptions: (
|
1387
|
+
application_id: ::String,
|
1388
|
+
?next_token: ::String,
|
1389
|
+
?max_results: ::Integer
|
1390
|
+
) -> _ListSubscriptionsResponseSuccess
|
1391
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSubscriptionsResponseSuccess
|
1392
|
+
|
1347
1393
|
interface _ListTagsForResourceResponseSuccess
|
1348
1394
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
1349
1395
|
def tags: () -> ::Array[Types::Tag]
|
@@ -1588,6 +1634,9 @@ module Aws
|
|
1588
1634
|
application_id: ::String,
|
1589
1635
|
?client_token: ::String,
|
1590
1636
|
?response_scope: ("ENTERPRISE_CONTENT_ONLY" | "EXTENDED_KNOWLEDGE_ENABLED"),
|
1637
|
+
?orchestration_configuration: {
|
1638
|
+
control: ("ENABLED" | "DISABLED")
|
1639
|
+
},
|
1591
1640
|
?blocked_phrases_configuration_update: {
|
1592
1641
|
blocked_phrases_to_create_or_update: Array[::String]?,
|
1593
1642
|
blocked_phrases_to_delete: Array[::String]?,
|
@@ -1939,6 +1988,20 @@ module Aws
|
|
1939
1988
|
) -> _UpdateRetrieverResponseSuccess
|
1940
1989
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateRetrieverResponseSuccess
|
1941
1990
|
|
1991
|
+
interface _UpdateSubscriptionResponseSuccess
|
1992
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateSubscriptionResponse]
|
1993
|
+
def subscription_arn: () -> ::String
|
1994
|
+
def current_subscription: () -> Types::SubscriptionDetails
|
1995
|
+
def next_subscription: () -> Types::SubscriptionDetails
|
1996
|
+
end
|
1997
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_subscription-instance_method
|
1998
|
+
def update_subscription: (
|
1999
|
+
application_id: ::String,
|
2000
|
+
subscription_id: ::String,
|
2001
|
+
type: ("Q_LITE" | "Q_BUSINESS")
|
2002
|
+
) -> _UpdateSubscriptionResponseSuccess
|
2003
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateSubscriptionResponseSuccess
|
2004
|
+
|
1942
2005
|
interface _UpdateUserResponseSuccess
|
1943
2006
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserResponse]
|
1944
2007
|
def user_aliases_added: () -> ::Array[Types::UserAlias]
|