aws-sdk-qbusiness 1.26.0 → 1.27.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 +1 -1
- data/lib/aws-sdk-qbusiness/client.rb +266 -54
- data/lib/aws-sdk-qbusiness/client_api.rb +138 -0
- data/lib/aws-sdk-qbusiness/types.rb +313 -22
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/client.rbs +59 -0
- data/sig/types.rbs +84 -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
|
@@ -512,7 +512,7 @@ module Aws::QBusiness
|
|
512
512
|
end
|
513
513
|
|
514
514
|
# @!attribute [rw] application_id
|
515
|
-
# The unique identifier of the Q Business application.
|
515
|
+
# The unique identifier of the Amazon Q Business application.
|
516
516
|
# @return [String]
|
517
517
|
#
|
518
518
|
# @!attribute [rw] statement_id
|
@@ -520,12 +520,13 @@ module Aws::QBusiness
|
|
520
520
|
# @return [String]
|
521
521
|
#
|
522
522
|
# @!attribute [rw] actions
|
523
|
-
# The list of Q Business actions that the ISV is allowed to
|
523
|
+
# The list of Amazon Q Business actions that the ISV is allowed to
|
524
|
+
# perform.
|
524
525
|
# @return [Array<String>]
|
525
526
|
#
|
526
527
|
# @!attribute [rw] principal
|
527
|
-
# The Amazon Resource Name
|
528
|
-
#
|
528
|
+
# The Amazon Resource Name of the IAM role for the ISV that is being
|
529
|
+
# granted permission.
|
529
530
|
# @return [String]
|
530
531
|
#
|
531
532
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AssociatePermissionRequest AWS API Documentation
|
@@ -1093,6 +1094,48 @@ module Aws::QBusiness
|
|
1093
1094
|
include Aws::Structure
|
1094
1095
|
end
|
1095
1096
|
|
1097
|
+
# @!attribute [rw] application_id
|
1098
|
+
# The identifier of the Amazon Q Business application for which the
|
1099
|
+
# subscription is being cancelled.
|
1100
|
+
# @return [String]
|
1101
|
+
#
|
1102
|
+
# @!attribute [rw] subscription_id
|
1103
|
+
# The identifier of the Amazon Q Business subscription being
|
1104
|
+
# cancelled.
|
1105
|
+
# @return [String]
|
1106
|
+
#
|
1107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CancelSubscriptionRequest AWS API Documentation
|
1108
|
+
#
|
1109
|
+
class CancelSubscriptionRequest < Struct.new(
|
1110
|
+
:application_id,
|
1111
|
+
:subscription_id)
|
1112
|
+
SENSITIVE = []
|
1113
|
+
include Aws::Structure
|
1114
|
+
end
|
1115
|
+
|
1116
|
+
# @!attribute [rw] subscription_arn
|
1117
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business subscription
|
1118
|
+
# being cancelled.
|
1119
|
+
# @return [String]
|
1120
|
+
#
|
1121
|
+
# @!attribute [rw] current_subscription
|
1122
|
+
# The type of your current Amazon Q Business subscription.
|
1123
|
+
# @return [Types::SubscriptionDetails]
|
1124
|
+
#
|
1125
|
+
# @!attribute [rw] next_subscription
|
1126
|
+
# The type of the Amazon Q Business subscription for the next month.
|
1127
|
+
# @return [Types::SubscriptionDetails]
|
1128
|
+
#
|
1129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CancelSubscriptionResponse AWS API Documentation
|
1130
|
+
#
|
1131
|
+
class CancelSubscriptionResponse < Struct.new(
|
1132
|
+
:subscription_arn,
|
1133
|
+
:current_subscription,
|
1134
|
+
:next_subscription)
|
1135
|
+
SENSITIVE = []
|
1136
|
+
include Aws::Structure
|
1137
|
+
end
|
1138
|
+
|
1096
1139
|
# @!attribute [rw] application_id
|
1097
1140
|
# The identifier of the Amazon Q Business application linked to a
|
1098
1141
|
# streaming Amazon Q Business conversation.
|
@@ -1681,7 +1724,7 @@ module Aws::QBusiness
|
|
1681
1724
|
end
|
1682
1725
|
|
1683
1726
|
# @!attribute [rw] application_id
|
1684
|
-
# The unique identifier of the Q Business application.
|
1727
|
+
# The unique identifier of the Amazon Q Business application.
|
1685
1728
|
# @return [String]
|
1686
1729
|
#
|
1687
1730
|
# @!attribute [rw] principal
|
@@ -1728,7 +1771,7 @@ module Aws::QBusiness
|
|
1728
1771
|
# @return [String]
|
1729
1772
|
#
|
1730
1773
|
# @!attribute [rw] idc_application_arn
|
1731
|
-
# The Amazon Resource Name (ARN) of the
|
1774
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center
|
1732
1775
|
# application created for this data accessor.
|
1733
1776
|
# @return [String]
|
1734
1777
|
#
|
@@ -2111,6 +2154,68 @@ module Aws::QBusiness
|
|
2111
2154
|
include Aws::Structure
|
2112
2155
|
end
|
2113
2156
|
|
2157
|
+
# @!attribute [rw] application_id
|
2158
|
+
# The identifier of the Amazon Q Business application the subscription
|
2159
|
+
# should be added to.
|
2160
|
+
# @return [String]
|
2161
|
+
#
|
2162
|
+
# @!attribute [rw] principal
|
2163
|
+
# The IAM Identity Center `UserId` or `GroupId` of a user or group in
|
2164
|
+
# the IAM Identity Center instance connected to the Amazon Q Business
|
2165
|
+
# application.
|
2166
|
+
# @return [Types::SubscriptionPrincipal]
|
2167
|
+
#
|
2168
|
+
# @!attribute [rw] type
|
2169
|
+
# The type of Amazon Q Business subscription you want to create.
|
2170
|
+
# @return [String]
|
2171
|
+
#
|
2172
|
+
# @!attribute [rw] client_token
|
2173
|
+
# A token that you provide to identify the request to create a
|
2174
|
+
# subscription for your Amazon Q Business application.
|
2175
|
+
#
|
2176
|
+
# **A suitable default value is auto-generated.** You should normally
|
2177
|
+
# not need to pass this option.
|
2178
|
+
# @return [String]
|
2179
|
+
#
|
2180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateSubscriptionRequest AWS API Documentation
|
2181
|
+
#
|
2182
|
+
class CreateSubscriptionRequest < Struct.new(
|
2183
|
+
:application_id,
|
2184
|
+
:principal,
|
2185
|
+
:type,
|
2186
|
+
:client_token)
|
2187
|
+
SENSITIVE = []
|
2188
|
+
include Aws::Structure
|
2189
|
+
end
|
2190
|
+
|
2191
|
+
# @!attribute [rw] subscription_id
|
2192
|
+
# The identifier of the Amazon Q Business subscription created.
|
2193
|
+
# @return [String]
|
2194
|
+
#
|
2195
|
+
# @!attribute [rw] subscription_arn
|
2196
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business subscription
|
2197
|
+
# created.
|
2198
|
+
# @return [String]
|
2199
|
+
#
|
2200
|
+
# @!attribute [rw] current_subscription
|
2201
|
+
# The type of your current Amazon Q Business subscription.
|
2202
|
+
# @return [Types::SubscriptionDetails]
|
2203
|
+
#
|
2204
|
+
# @!attribute [rw] next_subscription
|
2205
|
+
# The type of the Amazon Q Business subscription for the next month.
|
2206
|
+
# @return [Types::SubscriptionDetails]
|
2207
|
+
#
|
2208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateSubscriptionResponse AWS API Documentation
|
2209
|
+
#
|
2210
|
+
class CreateSubscriptionResponse < Struct.new(
|
2211
|
+
:subscription_id,
|
2212
|
+
:subscription_arn,
|
2213
|
+
:current_subscription,
|
2214
|
+
:next_subscription)
|
2215
|
+
SENSITIVE = []
|
2216
|
+
include Aws::Structure
|
2217
|
+
end
|
2218
|
+
|
2114
2219
|
# @!attribute [rw] application_id
|
2115
2220
|
# The identifier of the application for which the user mapping will be
|
2116
2221
|
# created.
|
@@ -2370,8 +2475,8 @@ module Aws::QBusiness
|
|
2370
2475
|
# @return [String]
|
2371
2476
|
#
|
2372
2477
|
# @!attribute [rw] idc_application_arn
|
2373
|
-
# The Amazon Resource Name (ARN) of the associated
|
2374
|
-
#
|
2478
|
+
# The Amazon Resource Name (ARN) of the associated IAM Identity Center
|
2479
|
+
# application.
|
2375
2480
|
# @return [String]
|
2376
2481
|
#
|
2377
2482
|
# @!attribute [rw] principal
|
@@ -2649,7 +2754,7 @@ module Aws::QBusiness
|
|
2649
2754
|
class DeleteConversationResponse < Aws::EmptyStructure; end
|
2650
2755
|
|
2651
2756
|
# @!attribute [rw] application_id
|
2652
|
-
# The unique identifier of the Q Business application.
|
2757
|
+
# The unique identifier of the Amazon Q Business application.
|
2653
2758
|
# @return [String]
|
2654
2759
|
#
|
2655
2760
|
# @!attribute [rw] data_accessor_id
|
@@ -2864,7 +2969,7 @@ module Aws::QBusiness
|
|
2864
2969
|
class DeleteWebExperienceResponse < Aws::EmptyStructure; end
|
2865
2970
|
|
2866
2971
|
# @!attribute [rw] application_id
|
2867
|
-
# The unique identifier of the Q Business application.
|
2972
|
+
# The unique identifier of the Amazon Q Business application.
|
2868
2973
|
# @return [String]
|
2869
2974
|
#
|
2870
2975
|
# @!attribute [rw] statement_id
|
@@ -3692,7 +3797,7 @@ module Aws::QBusiness
|
|
3692
3797
|
end
|
3693
3798
|
|
3694
3799
|
# @!attribute [rw] application_id
|
3695
|
-
# The unique identifier of the Q Business application.
|
3800
|
+
# The unique identifier of the Amazon Q Business application.
|
3696
3801
|
# @return [String]
|
3697
3802
|
#
|
3698
3803
|
# @!attribute [rw] data_accessor_id
|
@@ -3721,12 +3826,12 @@ module Aws::QBusiness
|
|
3721
3826
|
# @return [String]
|
3722
3827
|
#
|
3723
3828
|
# @!attribute [rw] application_id
|
3724
|
-
# The unique identifier of the Q Business application
|
3725
|
-
# this data accessor.
|
3829
|
+
# The unique identifier of the Amazon Q Business application
|
3830
|
+
# associated with this data accessor.
|
3726
3831
|
# @return [String]
|
3727
3832
|
#
|
3728
3833
|
# @!attribute [rw] idc_application_arn
|
3729
|
-
# The Amazon Resource Name (ARN) of the
|
3834
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center
|
3730
3835
|
# application associated with this data accessor.
|
3731
3836
|
# @return [String]
|
3732
3837
|
#
|
@@ -4174,7 +4279,7 @@ module Aws::QBusiness
|
|
4174
4279
|
end
|
4175
4280
|
|
4176
4281
|
# @!attribute [rw] application_id
|
4177
|
-
# The unique identifier of the Q Business application.
|
4282
|
+
# The unique identifier of the Amazon Q Business application.
|
4178
4283
|
# @return [String]
|
4179
4284
|
#
|
4180
4285
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetPolicyRequest AWS API Documentation
|
@@ -4988,7 +5093,7 @@ module Aws::QBusiness
|
|
4988
5093
|
end
|
4989
5094
|
|
4990
5095
|
# @!attribute [rw] application_id
|
4991
|
-
# The unique identifier of the Q Business application.
|
5096
|
+
# The unique identifier of the Amazon Q Business application.
|
4992
5097
|
# @return [String]
|
4993
5098
|
#
|
4994
5099
|
# @!attribute [rw] next_token
|
@@ -5589,6 +5694,52 @@ module Aws::QBusiness
|
|
5589
5694
|
include Aws::Structure
|
5590
5695
|
end
|
5591
5696
|
|
5697
|
+
# @!attribute [rw] application_id
|
5698
|
+
# The identifier of the Amazon Q Business application linked to the
|
5699
|
+
# subscription.
|
5700
|
+
# @return [String]
|
5701
|
+
#
|
5702
|
+
# @!attribute [rw] next_token
|
5703
|
+
# If the `maxResults` response was incomplete because there is more
|
5704
|
+
# data to retrieve, Amazon Q Business returns a pagination token in
|
5705
|
+
# the response. You can use this pagination token to retrieve the next
|
5706
|
+
# set of Amazon Q Business subscriptions.
|
5707
|
+
# @return [String]
|
5708
|
+
#
|
5709
|
+
# @!attribute [rw] max_results
|
5710
|
+
# The maximum number of Amazon Q Business subscriptions to return.
|
5711
|
+
# @return [Integer]
|
5712
|
+
#
|
5713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListSubscriptionsRequest AWS API Documentation
|
5714
|
+
#
|
5715
|
+
class ListSubscriptionsRequest < Struct.new(
|
5716
|
+
:application_id,
|
5717
|
+
:next_token,
|
5718
|
+
:max_results)
|
5719
|
+
SENSITIVE = []
|
5720
|
+
include Aws::Structure
|
5721
|
+
end
|
5722
|
+
|
5723
|
+
# @!attribute [rw] next_token
|
5724
|
+
# If the response is truncated, Amazon Q Business returns this token.
|
5725
|
+
# You can use this token in a subsequent request to retrieve the next
|
5726
|
+
# set of subscriptions.
|
5727
|
+
# @return [String]
|
5728
|
+
#
|
5729
|
+
# @!attribute [rw] subscriptions
|
5730
|
+
# An array of summary information on the subscriptions configured for
|
5731
|
+
# an Amazon Q Business application.
|
5732
|
+
# @return [Array<Types::Subscription>]
|
5733
|
+
#
|
5734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListSubscriptionsResponse AWS API Documentation
|
5735
|
+
#
|
5736
|
+
class ListSubscriptionsResponse < Struct.new(
|
5737
|
+
:next_token,
|
5738
|
+
:subscriptions)
|
5739
|
+
SENSITIVE = []
|
5740
|
+
include Aws::Structure
|
5741
|
+
end
|
5742
|
+
|
5592
5743
|
# @!attribute [rw] resource_arn
|
5593
5744
|
# The Amazon Resource Name (ARN) of the Amazon Q Business application
|
5594
5745
|
# or data source to get a list of tags for.
|
@@ -6290,9 +6441,7 @@ module Aws::QBusiness
|
|
6290
6441
|
#
|
6291
6442
|
# @!attribute [rw] role_arn
|
6292
6443
|
# 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.
|
6444
|
+
# S3 file that contains your list of users that belong to a group.
|
6296
6445
|
# @return [String]
|
6297
6446
|
#
|
6298
6447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutGroupRequest AWS API Documentation
|
@@ -6650,7 +6799,8 @@ module Aws::QBusiness
|
|
6650
6799
|
end
|
6651
6800
|
|
6652
6801
|
# @!attribute [rw] application_id
|
6653
|
-
# The unique identifier of the Q Business application to
|
6802
|
+
# The unique identifier of the Amazon Q Business application to
|
6803
|
+
# search.
|
6654
6804
|
# @return [String]
|
6655
6805
|
#
|
6656
6806
|
# @!attribute [rw] query_text
|
@@ -6927,6 +7077,101 @@ module Aws::QBusiness
|
|
6927
7077
|
include Aws::Structure
|
6928
7078
|
end
|
6929
7079
|
|
7080
|
+
# Information about an Amazon Q Business subscription.
|
7081
|
+
#
|
7082
|
+
# Subscriptions are used to provide access for an IAM Identity Center
|
7083
|
+
# user or a group to an Amazon Q Business application.
|
7084
|
+
#
|
7085
|
+
# Amazon Q Business offers two subscription tiers: `Q_LITE` and
|
7086
|
+
# `Q_BUSINESS`. Subscription tier determines feature access for the
|
7087
|
+
# user. For more information on subscriptions and pricing tiers, see
|
7088
|
+
# [Amazon Q Business pricing][1].
|
7089
|
+
#
|
7090
|
+
#
|
7091
|
+
#
|
7092
|
+
# [1]: https://aws.amazon.com/q/business/pricing/
|
7093
|
+
#
|
7094
|
+
# @!attribute [rw] subscription_id
|
7095
|
+
# The identifier of the Amazon Q Business subscription to be updated.
|
7096
|
+
# @return [String]
|
7097
|
+
#
|
7098
|
+
# @!attribute [rw] subscription_arn
|
7099
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business subscription
|
7100
|
+
# that was updated.
|
7101
|
+
# @return [String]
|
7102
|
+
#
|
7103
|
+
# @!attribute [rw] principal
|
7104
|
+
# The IAM Identity Center `UserId` or `GroupId` of a user or group in
|
7105
|
+
# the IAM Identity Center instance connected to the Amazon Q Business
|
7106
|
+
# application.
|
7107
|
+
# @return [Types::SubscriptionPrincipal]
|
7108
|
+
#
|
7109
|
+
# @!attribute [rw] current_subscription
|
7110
|
+
# The type of your current Amazon Q Business subscription.
|
7111
|
+
# @return [Types::SubscriptionDetails]
|
7112
|
+
#
|
7113
|
+
# @!attribute [rw] next_subscription
|
7114
|
+
# The type of the Amazon Q Business subscription for the next month.
|
7115
|
+
# @return [Types::SubscriptionDetails]
|
7116
|
+
#
|
7117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Subscription AWS API Documentation
|
7118
|
+
#
|
7119
|
+
class Subscription < Struct.new(
|
7120
|
+
:subscription_id,
|
7121
|
+
:subscription_arn,
|
7122
|
+
:principal,
|
7123
|
+
:current_subscription,
|
7124
|
+
:next_subscription)
|
7125
|
+
SENSITIVE = []
|
7126
|
+
include Aws::Structure
|
7127
|
+
end
|
7128
|
+
|
7129
|
+
# The details of an Amazon Q Business subscription.
|
7130
|
+
#
|
7131
|
+
# @!attribute [rw] type
|
7132
|
+
# The type of an Amazon Q Business subscription.
|
7133
|
+
# @return [String]
|
7134
|
+
#
|
7135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SubscriptionDetails AWS API Documentation
|
7136
|
+
#
|
7137
|
+
class SubscriptionDetails < Struct.new(
|
7138
|
+
:type)
|
7139
|
+
SENSITIVE = []
|
7140
|
+
include Aws::Structure
|
7141
|
+
end
|
7142
|
+
|
7143
|
+
# A user or group in the IAM Identity Center instance connected to the
|
7144
|
+
# Amazon Q Business application.
|
7145
|
+
#
|
7146
|
+
# @note SubscriptionPrincipal is a union - when making an API calls you must set exactly one of the members.
|
7147
|
+
#
|
7148
|
+
# @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.
|
7149
|
+
#
|
7150
|
+
# @!attribute [rw] user
|
7151
|
+
# The identifier of a user in the IAM Identity Center instance
|
7152
|
+
# connected to the Amazon Q Business application.
|
7153
|
+
# @return [String]
|
7154
|
+
#
|
7155
|
+
# @!attribute [rw] group
|
7156
|
+
# The identifier of a group in the IAM Identity Center instance
|
7157
|
+
# connected to the Amazon Q Business application.
|
7158
|
+
# @return [String]
|
7159
|
+
#
|
7160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SubscriptionPrincipal AWS API Documentation
|
7161
|
+
#
|
7162
|
+
class SubscriptionPrincipal < Struct.new(
|
7163
|
+
:user,
|
7164
|
+
:group,
|
7165
|
+
:unknown)
|
7166
|
+
SENSITIVE = []
|
7167
|
+
include Aws::Structure
|
7168
|
+
include Aws::Structure::Union
|
7169
|
+
|
7170
|
+
class User < SubscriptionPrincipal; end
|
7171
|
+
class Group < SubscriptionPrincipal; end
|
7172
|
+
class Unknown < SubscriptionPrincipal; end
|
7173
|
+
end
|
7174
|
+
|
6930
7175
|
# A list of key/value pairs that identify an index, FAQ, or data source.
|
6931
7176
|
# Tag keys and values can consist of Unicode letters, digits, white
|
6932
7177
|
# space, and any of the following symbols: \_ . : / = + - @.
|
@@ -7276,7 +7521,7 @@ module Aws::QBusiness
|
|
7276
7521
|
class UpdateChatControlsConfigurationResponse < Aws::EmptyStructure; end
|
7277
7522
|
|
7278
7523
|
# @!attribute [rw] application_id
|
7279
|
-
# The unique identifier of the Q Business application.
|
7524
|
+
# The unique identifier of the Amazon Q Business application.
|
7280
7525
|
# @return [String]
|
7281
7526
|
#
|
7282
7527
|
# @!attribute [rw] data_accessor_id
|
@@ -7521,6 +7766,52 @@ module Aws::QBusiness
|
|
7521
7766
|
#
|
7522
7767
|
class UpdateRetrieverResponse < Aws::EmptyStructure; end
|
7523
7768
|
|
7769
|
+
# @!attribute [rw] application_id
|
7770
|
+
# The identifier of the Amazon Q Business application where the
|
7771
|
+
# subscription update should take effect.
|
7772
|
+
# @return [String]
|
7773
|
+
#
|
7774
|
+
# @!attribute [rw] subscription_id
|
7775
|
+
# The identifier of the Amazon Q Business subscription to be updated.
|
7776
|
+
# @return [String]
|
7777
|
+
#
|
7778
|
+
# @!attribute [rw] type
|
7779
|
+
# The type of the Amazon Q Business subscription to be updated.
|
7780
|
+
# @return [String]
|
7781
|
+
#
|
7782
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateSubscriptionRequest AWS API Documentation
|
7783
|
+
#
|
7784
|
+
class UpdateSubscriptionRequest < Struct.new(
|
7785
|
+
:application_id,
|
7786
|
+
:subscription_id,
|
7787
|
+
:type)
|
7788
|
+
SENSITIVE = []
|
7789
|
+
include Aws::Structure
|
7790
|
+
end
|
7791
|
+
|
7792
|
+
# @!attribute [rw] subscription_arn
|
7793
|
+
# The Amazon Resource Name (ARN) of the Amazon Q Business subscription
|
7794
|
+
# that was updated.
|
7795
|
+
# @return [String]
|
7796
|
+
#
|
7797
|
+
# @!attribute [rw] current_subscription
|
7798
|
+
# The type of your current Amazon Q Business subscription.
|
7799
|
+
# @return [Types::SubscriptionDetails]
|
7800
|
+
#
|
7801
|
+
# @!attribute [rw] next_subscription
|
7802
|
+
# The type of the Amazon Q Business subscription for the next month.
|
7803
|
+
# @return [Types::SubscriptionDetails]
|
7804
|
+
#
|
7805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateSubscriptionResponse AWS API Documentation
|
7806
|
+
#
|
7807
|
+
class UpdateSubscriptionResponse < Struct.new(
|
7808
|
+
:subscription_arn,
|
7809
|
+
:current_subscription,
|
7810
|
+
:next_subscription)
|
7811
|
+
SENSITIVE = []
|
7812
|
+
include Aws::Structure
|
7813
|
+
end
|
7814
|
+
|
7524
7815
|
# @!attribute [rw] application_id
|
7525
7816
|
# The identifier of the application the user is attached to.
|
7526
7817
|
# @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
|
@@ -1344,6 +1376,19 @@ module Aws
|
|
1344
1376
|
) -> _ListRetrieversResponseSuccess
|
1345
1377
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRetrieversResponseSuccess
|
1346
1378
|
|
1379
|
+
interface _ListSubscriptionsResponseSuccess
|
1380
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSubscriptionsResponse]
|
1381
|
+
def next_token: () -> ::String
|
1382
|
+
def subscriptions: () -> ::Array[Types::Subscription]
|
1383
|
+
end
|
1384
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_subscriptions-instance_method
|
1385
|
+
def list_subscriptions: (
|
1386
|
+
application_id: ::String,
|
1387
|
+
?next_token: ::String,
|
1388
|
+
?max_results: ::Integer
|
1389
|
+
) -> _ListSubscriptionsResponseSuccess
|
1390
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSubscriptionsResponseSuccess
|
1391
|
+
|
1347
1392
|
interface _ListTagsForResourceResponseSuccess
|
1348
1393
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
1349
1394
|
def tags: () -> ::Array[Types::Tag]
|
@@ -1939,6 +1984,20 @@ module Aws
|
|
1939
1984
|
) -> _UpdateRetrieverResponseSuccess
|
1940
1985
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateRetrieverResponseSuccess
|
1941
1986
|
|
1987
|
+
interface _UpdateSubscriptionResponseSuccess
|
1988
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateSubscriptionResponse]
|
1989
|
+
def subscription_arn: () -> ::String
|
1990
|
+
def current_subscription: () -> Types::SubscriptionDetails
|
1991
|
+
def next_subscription: () -> Types::SubscriptionDetails
|
1992
|
+
end
|
1993
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_subscription-instance_method
|
1994
|
+
def update_subscription: (
|
1995
|
+
application_id: ::String,
|
1996
|
+
subscription_id: ::String,
|
1997
|
+
type: ("Q_LITE" | "Q_BUSINESS")
|
1998
|
+
) -> _UpdateSubscriptionResponseSuccess
|
1999
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateSubscriptionResponseSuccess
|
2000
|
+
|
1942
2001
|
interface _UpdateUserResponseSuccess
|
1943
2002
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserResponse]
|
1944
2003
|
def user_aliases_added: () -> ::Array[Types::UserAlias]
|
data/sig/types.rbs
CHANGED
@@ -285,6 +285,19 @@ module Aws::QBusiness
|
|
285
285
|
SENSITIVE: []
|
286
286
|
end
|
287
287
|
|
288
|
+
class CancelSubscriptionRequest
|
289
|
+
attr_accessor application_id: ::String
|
290
|
+
attr_accessor subscription_id: ::String
|
291
|
+
SENSITIVE: []
|
292
|
+
end
|
293
|
+
|
294
|
+
class CancelSubscriptionResponse
|
295
|
+
attr_accessor subscription_arn: ::String
|
296
|
+
attr_accessor current_subscription: Types::SubscriptionDetails
|
297
|
+
attr_accessor next_subscription: Types::SubscriptionDetails
|
298
|
+
SENSITIVE: []
|
299
|
+
end
|
300
|
+
|
288
301
|
class ChatInput
|
289
302
|
attr_accessor application_id: ::String
|
290
303
|
attr_accessor user_id: ::String
|
@@ -517,6 +530,22 @@ module Aws::QBusiness
|
|
517
530
|
SENSITIVE: []
|
518
531
|
end
|
519
532
|
|
533
|
+
class CreateSubscriptionRequest
|
534
|
+
attr_accessor application_id: ::String
|
535
|
+
attr_accessor principal: Types::SubscriptionPrincipal
|
536
|
+
attr_accessor type: ("Q_LITE" | "Q_BUSINESS")
|
537
|
+
attr_accessor client_token: ::String
|
538
|
+
SENSITIVE: []
|
539
|
+
end
|
540
|
+
|
541
|
+
class CreateSubscriptionResponse
|
542
|
+
attr_accessor subscription_id: ::String
|
543
|
+
attr_accessor subscription_arn: ::String
|
544
|
+
attr_accessor current_subscription: Types::SubscriptionDetails
|
545
|
+
attr_accessor next_subscription: Types::SubscriptionDetails
|
546
|
+
SENSITIVE: []
|
547
|
+
end
|
548
|
+
|
520
549
|
class CreateUserRequest
|
521
550
|
attr_accessor application_id: ::String
|
522
551
|
attr_accessor user_id: ::String
|
@@ -1426,6 +1455,19 @@ module Aws::QBusiness
|
|
1426
1455
|
SENSITIVE: []
|
1427
1456
|
end
|
1428
1457
|
|
1458
|
+
class ListSubscriptionsRequest
|
1459
|
+
attr_accessor application_id: ::String
|
1460
|
+
attr_accessor next_token: ::String
|
1461
|
+
attr_accessor max_results: ::Integer
|
1462
|
+
SENSITIVE: []
|
1463
|
+
end
|
1464
|
+
|
1465
|
+
class ListSubscriptionsResponse
|
1466
|
+
attr_accessor next_token: ::String
|
1467
|
+
attr_accessor subscriptions: ::Array[Types::Subscription]
|
1468
|
+
SENSITIVE: []
|
1469
|
+
end
|
1470
|
+
|
1429
1471
|
class ListTagsForResourceRequest
|
1430
1472
|
attr_accessor resource_arn: ::String
|
1431
1473
|
SENSITIVE: []
|
@@ -1803,6 +1845,34 @@ module Aws::QBusiness
|
|
1803
1845
|
SENSITIVE: []
|
1804
1846
|
end
|
1805
1847
|
|
1848
|
+
class Subscription
|
1849
|
+
attr_accessor subscription_id: ::String
|
1850
|
+
attr_accessor subscription_arn: ::String
|
1851
|
+
attr_accessor principal: Types::SubscriptionPrincipal
|
1852
|
+
attr_accessor current_subscription: Types::SubscriptionDetails
|
1853
|
+
attr_accessor next_subscription: Types::SubscriptionDetails
|
1854
|
+
SENSITIVE: []
|
1855
|
+
end
|
1856
|
+
|
1857
|
+
class SubscriptionDetails
|
1858
|
+
attr_accessor type: ("Q_LITE" | "Q_BUSINESS")
|
1859
|
+
SENSITIVE: []
|
1860
|
+
end
|
1861
|
+
|
1862
|
+
class SubscriptionPrincipal
|
1863
|
+
attr_accessor user: ::String
|
1864
|
+
attr_accessor group: ::String
|
1865
|
+
attr_accessor unknown: untyped
|
1866
|
+
SENSITIVE: []
|
1867
|
+
|
1868
|
+
class User < SubscriptionPrincipal
|
1869
|
+
end
|
1870
|
+
class Group < SubscriptionPrincipal
|
1871
|
+
end
|
1872
|
+
class Unknown < SubscriptionPrincipal
|
1873
|
+
end
|
1874
|
+
end
|
1875
|
+
|
1806
1876
|
class Tag
|
1807
1877
|
attr_accessor key: ::String
|
1808
1878
|
attr_accessor value: ::String
|
@@ -1968,6 +2038,20 @@ module Aws::QBusiness
|
|
1968
2038
|
class UpdateRetrieverResponse < Aws::EmptyStructure
|
1969
2039
|
end
|
1970
2040
|
|
2041
|
+
class UpdateSubscriptionRequest
|
2042
|
+
attr_accessor application_id: ::String
|
2043
|
+
attr_accessor subscription_id: ::String
|
2044
|
+
attr_accessor type: ("Q_LITE" | "Q_BUSINESS")
|
2045
|
+
SENSITIVE: []
|
2046
|
+
end
|
2047
|
+
|
2048
|
+
class UpdateSubscriptionResponse
|
2049
|
+
attr_accessor subscription_arn: ::String
|
2050
|
+
attr_accessor current_subscription: Types::SubscriptionDetails
|
2051
|
+
attr_accessor next_subscription: Types::SubscriptionDetails
|
2052
|
+
SENSITIVE: []
|
2053
|
+
end
|
2054
|
+
|
1971
2055
|
class UpdateUserRequest
|
1972
2056
|
attr_accessor application_id: ::String
|
1973
2057
|
attr_accessor user_id: ::String
|