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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 62b456dec4529787ac3584b4751473ae9d456f7765f886ad6ea27f29cc8aed44
|
4
|
+
data.tar.gz: 257980094a3be5846bfc719f7db7f6be152c01d2dbb56e7efc2ca3154257e390
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eae31689ddfd86de331d9a2f74c5eb975148906e0fdd08404c0385d8f6e179d6bd9acccd3f132c95c1b961b0f517219be7a817cb1c353e694f708e8dd08b46ae
|
7
|
+
data.tar.gz: b3c811c5836b08e04d2d90b95670fcab2b483e38f97f1b1d09ec3baf3789f593a6d2bdc33f95a10046e74b0985838cf8c5dc8ad0a139b61e1eb59c70646b729e
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.28.0 (2025-02-04)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adds functionality to enable/disable a new Q Business Chat orchestration feature. If enabled, Q Business can orchestrate over datasources and plugins without the need for customers to select specific chat modes.
|
8
|
+
|
9
|
+
1.27.0 (2025-01-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Added APIs to manage QBusiness user subscriptions
|
13
|
+
|
4
14
|
1.26.0 (2025-01-15)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.28.0
|
@@ -481,24 +481,26 @@ module Aws::QBusiness
|
|
481
481
|
|
482
482
|
# @!group API Operations
|
483
483
|
|
484
|
-
# Adds or updates a permission policy for a Q Business
|
485
|
-
# allowing cross-account access for an ISV. This operation
|
486
|
-
# policy statement for the specified Q Business
|
487
|
-
# statement defines the IAM actions that the ISV
|
488
|
-
# on the Q Business application's
|
484
|
+
# Adds or updates a permission policy for a Amazon Q Business
|
485
|
+
# application, allowing cross-account access for an ISV. This operation
|
486
|
+
# creates a new policy statement for the specified Amazon Q Business
|
487
|
+
# application. The policy statement defines the IAM actions that the ISV
|
488
|
+
# is allowed to perform on the Amazon Q Business application's
|
489
|
+
# resources.
|
489
490
|
#
|
490
491
|
# @option params [required, String] :application_id
|
491
|
-
# The unique identifier of the Q Business application.
|
492
|
+
# The unique identifier of the Amazon Q Business application.
|
492
493
|
#
|
493
494
|
# @option params [required, String] :statement_id
|
494
495
|
# A unique identifier for the policy statement.
|
495
496
|
#
|
496
497
|
# @option params [required, Array<String>] :actions
|
497
|
-
# The list of Q Business actions that the ISV is allowed to
|
498
|
+
# The list of Amazon Q Business actions that the ISV is allowed to
|
499
|
+
# perform.
|
498
500
|
#
|
499
501
|
# @option params [required, String] :principal
|
500
|
-
# The Amazon Resource Name
|
501
|
-
#
|
502
|
+
# The Amazon Resource Name of the IAM role for the ISV that is being
|
503
|
+
# granted permission.
|
502
504
|
#
|
503
505
|
# @return [Types::AssociatePermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
504
506
|
#
|
@@ -751,6 +753,45 @@ module Aws::QBusiness
|
|
751
753
|
req.send_request(options)
|
752
754
|
end
|
753
755
|
|
756
|
+
# Unsubscribes a user or a group from their pricing tier in an Amazon Q
|
757
|
+
# Business application. An unsubscribed user or group loses all Amazon Q
|
758
|
+
# Business feature access at the start of next month.
|
759
|
+
#
|
760
|
+
# @option params [required, String] :application_id
|
761
|
+
# The identifier of the Amazon Q Business application for which the
|
762
|
+
# subscription is being cancelled.
|
763
|
+
#
|
764
|
+
# @option params [required, String] :subscription_id
|
765
|
+
# The identifier of the Amazon Q Business subscription being cancelled.
|
766
|
+
#
|
767
|
+
# @return [Types::CancelSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
768
|
+
#
|
769
|
+
# * {Types::CancelSubscriptionResponse#subscription_arn #subscription_arn} => String
|
770
|
+
# * {Types::CancelSubscriptionResponse#current_subscription #current_subscription} => Types::SubscriptionDetails
|
771
|
+
# * {Types::CancelSubscriptionResponse#next_subscription #next_subscription} => Types::SubscriptionDetails
|
772
|
+
#
|
773
|
+
# @example Request syntax with placeholder values
|
774
|
+
#
|
775
|
+
# resp = client.cancel_subscription({
|
776
|
+
# application_id: "ApplicationId", # required
|
777
|
+
# subscription_id: "SubscriptionId", # required
|
778
|
+
# })
|
779
|
+
#
|
780
|
+
# @example Response structure
|
781
|
+
#
|
782
|
+
# resp.subscription_arn #=> String
|
783
|
+
# resp.current_subscription.type #=> String, one of "Q_LITE", "Q_BUSINESS"
|
784
|
+
# resp.next_subscription.type #=> String, one of "Q_LITE", "Q_BUSINESS"
|
785
|
+
#
|
786
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CancelSubscription AWS API Documentation
|
787
|
+
#
|
788
|
+
# @overload cancel_subscription(params = {})
|
789
|
+
# @param [Hash] params ({})
|
790
|
+
def cancel_subscription(params = {}, options = {})
|
791
|
+
req = build_request(:cancel_subscription, params)
|
792
|
+
req.send_request(options)
|
793
|
+
end
|
794
|
+
|
754
795
|
# Starts or continues a non-streaming Amazon Q Business conversation.
|
755
796
|
#
|
756
797
|
# @option params [required, String] :application_id
|
@@ -1168,18 +1209,18 @@ module Aws::QBusiness
|
|
1168
1209
|
req.send_request(options)
|
1169
1210
|
end
|
1170
1211
|
|
1171
|
-
# Creates a new data accessor for an ISV to access data from a Q
|
1212
|
+
# Creates a new data accessor for an ISV to access data from a Amazon Q
|
1172
1213
|
# Business application. The data accessor is an entity that represents
|
1173
|
-
# the ISV's access to the Q Business application's data. It
|
1174
|
-
# the IAM role ARN for the ISV, a friendly name, and a set of
|
1175
|
-
# configurations that define the specific actions the ISV is
|
1176
|
-
# perform and any associated data filters. When the data
|
1177
|
-
# created, an
|
1178
|
-
# manage the ISV's identity and authentication for accessing
|
1179
|
-
# Business application.
|
1214
|
+
# the ISV's access to the Amazon Q Business application's data. It
|
1215
|
+
# includes the IAM role ARN for the ISV, a friendly name, and a set of
|
1216
|
+
# action configurations that define the specific actions the ISV is
|
1217
|
+
# allowed to perform and any associated data filters. When the data
|
1218
|
+
# accessor is created, an IAM Identity Center application is also
|
1219
|
+
# created to manage the ISV's identity and authentication for accessing
|
1220
|
+
# the Amazon Q Business application.
|
1180
1221
|
#
|
1181
1222
|
# @option params [required, String] :application_id
|
1182
|
-
# The unique identifier of the Q Business application.
|
1223
|
+
# The unique identifier of the Amazon Q Business application.
|
1183
1224
|
#
|
1184
1225
|
# @option params [required, String] :principal
|
1185
1226
|
# The Amazon Resource Name (ARN) of the IAM role for the ISV that will
|
@@ -1819,6 +1860,72 @@ module Aws::QBusiness
|
|
1819
1860
|
req.send_request(options)
|
1820
1861
|
end
|
1821
1862
|
|
1863
|
+
# Subscribes an IAM Identity Center user or a group to a pricing tier
|
1864
|
+
# for an Amazon Q Business application.
|
1865
|
+
#
|
1866
|
+
# Amazon Q Business offers two subscription tiers: `Q_LITE` and
|
1867
|
+
# `Q_BUSINESS`. Subscription tier determines feature access for the
|
1868
|
+
# user. For more information on subscriptions and pricing tiers, see
|
1869
|
+
# [Amazon Q Business pricing][1].
|
1870
|
+
#
|
1871
|
+
#
|
1872
|
+
#
|
1873
|
+
# [1]: https://aws.amazon.com/q/business/pricing/
|
1874
|
+
#
|
1875
|
+
# @option params [required, String] :application_id
|
1876
|
+
# The identifier of the Amazon Q Business application the subscription
|
1877
|
+
# should be added to.
|
1878
|
+
#
|
1879
|
+
# @option params [required, Types::SubscriptionPrincipal] :principal
|
1880
|
+
# The IAM Identity Center `UserId` or `GroupId` of a user or group in
|
1881
|
+
# the IAM Identity Center instance connected to the Amazon Q Business
|
1882
|
+
# application.
|
1883
|
+
#
|
1884
|
+
# @option params [required, String] :type
|
1885
|
+
# The type of Amazon Q Business subscription you want to create.
|
1886
|
+
#
|
1887
|
+
# @option params [String] :client_token
|
1888
|
+
# A token that you provide to identify the request to create a
|
1889
|
+
# subscription for your Amazon Q Business application.
|
1890
|
+
#
|
1891
|
+
# **A suitable default value is auto-generated.** You should normally
|
1892
|
+
# not need to pass this option.**
|
1893
|
+
#
|
1894
|
+
# @return [Types::CreateSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1895
|
+
#
|
1896
|
+
# * {Types::CreateSubscriptionResponse#subscription_id #subscription_id} => String
|
1897
|
+
# * {Types::CreateSubscriptionResponse#subscription_arn #subscription_arn} => String
|
1898
|
+
# * {Types::CreateSubscriptionResponse#current_subscription #current_subscription} => Types::SubscriptionDetails
|
1899
|
+
# * {Types::CreateSubscriptionResponse#next_subscription #next_subscription} => Types::SubscriptionDetails
|
1900
|
+
#
|
1901
|
+
# @example Request syntax with placeholder values
|
1902
|
+
#
|
1903
|
+
# resp = client.create_subscription({
|
1904
|
+
# application_id: "ApplicationId", # required
|
1905
|
+
# principal: { # required
|
1906
|
+
# user: "UserIdentifier",
|
1907
|
+
# group: "GroupIdentifier",
|
1908
|
+
# },
|
1909
|
+
# type: "Q_LITE", # required, accepts Q_LITE, Q_BUSINESS
|
1910
|
+
# client_token: "ClientToken",
|
1911
|
+
# })
|
1912
|
+
#
|
1913
|
+
# @example Response structure
|
1914
|
+
#
|
1915
|
+
# resp.subscription_id #=> String
|
1916
|
+
# resp.subscription_arn #=> String
|
1917
|
+
# resp.current_subscription.type #=> String, one of "Q_LITE", "Q_BUSINESS"
|
1918
|
+
# resp.next_subscription.type #=> String, one of "Q_LITE", "Q_BUSINESS"
|
1919
|
+
#
|
1920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateSubscription AWS API Documentation
|
1921
|
+
#
|
1922
|
+
# @overload create_subscription(params = {})
|
1923
|
+
# @param [Hash] params ({})
|
1924
|
+
def create_subscription(params = {}, options = {})
|
1925
|
+
req = build_request(:create_subscription, params)
|
1926
|
+
req.send_request(options)
|
1927
|
+
end
|
1928
|
+
|
1822
1929
|
# Creates a universally unique identifier (UUID) mapped to a list of
|
1823
1930
|
# local user ids within an application.
|
1824
1931
|
#
|
@@ -2077,12 +2184,12 @@ module Aws::QBusiness
|
|
2077
2184
|
end
|
2078
2185
|
|
2079
2186
|
# Deletes a specified data accessor. This operation permanently removes
|
2080
|
-
# the data accessor and its associated
|
2081
|
-
#
|
2082
|
-
#
|
2187
|
+
# the data accessor and its associated IAM Identity Center application.
|
2188
|
+
# Any access granted to the ISV through this data accessor will be
|
2189
|
+
# revoked.
|
2083
2190
|
#
|
2084
2191
|
# @option params [required, String] :application_id
|
2085
|
-
# The unique identifier of the Q Business application.
|
2192
|
+
# The unique identifier of the Amazon Q Business application.
|
2086
2193
|
#
|
2087
2194
|
# @option params [required, String] :data_accessor_id
|
2088
2195
|
# The unique identifier of the data accessor to delete.
|
@@ -2327,13 +2434,13 @@ module Aws::QBusiness
|
|
2327
2434
|
req.send_request(options)
|
2328
2435
|
end
|
2329
2436
|
|
2330
|
-
# Removes a permission policy from a Q Business application,
|
2331
|
-
# the cross-account access that was previously granted to an
|
2332
|
-
# operation deletes the specified policy statement from the
|
2437
|
+
# Removes a permission policy from a Amazon Q Business application,
|
2438
|
+
# revoking the cross-account access that was previously granted to an
|
2439
|
+
# ISV. This operation deletes the specified policy statement from the
|
2333
2440
|
# application's permission policy.
|
2334
2441
|
#
|
2335
2442
|
# @option params [required, String] :application_id
|
2336
|
-
# The unique identifier of the Q Business application.
|
2443
|
+
# The unique identifier of the Amazon Q Business application.
|
2337
2444
|
#
|
2338
2445
|
# @option params [required, String] :statement_id
|
2339
2446
|
# The statement ID of the permission to remove.
|
@@ -2423,8 +2530,8 @@ module Aws::QBusiness
|
|
2423
2530
|
req.send_request(options)
|
2424
2531
|
end
|
2425
2532
|
|
2426
|
-
# Gets information about
|
2427
|
-
#
|
2533
|
+
# Gets information about chat controls configured for an existing Amazon
|
2534
|
+
# Q Business application.
|
2428
2535
|
#
|
2429
2536
|
# @option params [required, String] :application_id
|
2430
2537
|
# The identifier of the application for which the chat controls are
|
@@ -2442,6 +2549,7 @@ module Aws::QBusiness
|
|
2442
2549
|
# @return [Types::GetChatControlsConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2443
2550
|
#
|
2444
2551
|
# * {Types::GetChatControlsConfigurationResponse#response_scope #response_scope} => String
|
2552
|
+
# * {Types::GetChatControlsConfigurationResponse#orchestration_configuration #orchestration_configuration} => Types::AppliedOrchestrationConfiguration
|
2445
2553
|
# * {Types::GetChatControlsConfigurationResponse#blocked_phrases #blocked_phrases} => Types::BlockedPhrasesConfiguration
|
2446
2554
|
# * {Types::GetChatControlsConfigurationResponse#topic_configurations #topic_configurations} => Array<Types::TopicConfiguration>
|
2447
2555
|
# * {Types::GetChatControlsConfigurationResponse#creator_mode_configuration #creator_mode_configuration} => Types::AppliedCreatorModeConfiguration
|
@@ -2460,6 +2568,7 @@ module Aws::QBusiness
|
|
2460
2568
|
# @example Response structure
|
2461
2569
|
#
|
2462
2570
|
# resp.response_scope #=> String, one of "ENTERPRISE_CONTENT_ONLY", "EXTENDED_KNOWLEDGE_ENABLED"
|
2571
|
+
# resp.orchestration_configuration.control #=> String, one of "ENABLED", "DISABLED"
|
2463
2572
|
# resp.blocked_phrases.blocked_phrases #=> Array
|
2464
2573
|
# resp.blocked_phrases.blocked_phrases[0] #=> String
|
2465
2574
|
# resp.blocked_phrases.system_message_override #=> String
|
@@ -2496,13 +2605,13 @@ module Aws::QBusiness
|
|
2496
2605
|
|
2497
2606
|
# Retrieves information about a specified data accessor. This operation
|
2498
2607
|
# returns details about the data accessor, including its display name,
|
2499
|
-
# unique identifier, Amazon Resource Name (ARN), the associated Q
|
2500
|
-
# Business application and
|
2501
|
-
#
|
2502
|
-
#
|
2608
|
+
# unique identifier, Amazon Resource Name (ARN), the associated Amazon Q
|
2609
|
+
# Business application and IAM Identity Center application, the IAM role
|
2610
|
+
# for the ISV, the action configurations, and the timestamps for when
|
2611
|
+
# the data accessor was created and last updated.
|
2503
2612
|
#
|
2504
2613
|
# @option params [required, String] :application_id
|
2505
|
-
# The unique identifier of the Q Business application.
|
2614
|
+
# The unique identifier of the Amazon Q Business application.
|
2506
2615
|
#
|
2507
2616
|
# @option params [required, String] :data_accessor_id
|
2508
2617
|
# The unique identifier of the data accessor to retrieve.
|
@@ -2934,12 +3043,13 @@ module Aws::QBusiness
|
|
2934
3043
|
req.send_request(options)
|
2935
3044
|
end
|
2936
3045
|
|
2937
|
-
# Retrieves the current permission policy for a Q Business
|
2938
|
-
# The policy is returned as a JSON-formatted string and
|
2939
|
-
# actions that are allowed or denied for the
|
3046
|
+
# Retrieves the current permission policy for a Amazon Q Business
|
3047
|
+
# application. The policy is returned as a JSON-formatted string and
|
3048
|
+
# defines the IAM actions that are allowed or denied for the
|
3049
|
+
# application's resources.
|
2940
3050
|
#
|
2941
3051
|
# @option params [required, String] :application_id
|
2942
|
-
# The unique identifier of the Q Business application.
|
3052
|
+
# The unique identifier of the Amazon Q Business application.
|
2943
3053
|
#
|
2944
3054
|
# @return [Types::GetPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2945
3055
|
#
|
@@ -3314,13 +3424,13 @@ module Aws::QBusiness
|
|
3314
3424
|
req.send_request(options)
|
3315
3425
|
end
|
3316
3426
|
|
3317
|
-
# Lists the data accessors for a Q Business application. This
|
3318
|
-
# returns a paginated list of data accessor summaries,
|
3319
|
-
# friendly name, unique identifier, ARN, associated IAM
|
3320
|
-
# creation/update timestamps for each data accessor.
|
3427
|
+
# Lists the data accessors for a Amazon Q Business application. This
|
3428
|
+
# operation returns a paginated list of data accessor summaries,
|
3429
|
+
# including the friendly name, unique identifier, ARN, associated IAM
|
3430
|
+
# role, and creation/update timestamps for each data accessor.
|
3321
3431
|
#
|
3322
3432
|
# @option params [required, String] :application_id
|
3323
|
-
# The unique identifier of the Q Business application.
|
3433
|
+
# The unique identifier of the Amazon Q Business application.
|
3324
3434
|
#
|
3325
3435
|
# @option params [String] :next_token
|
3326
3436
|
# The token for the next set of results. (You received this token from a
|
@@ -3994,6 +4104,56 @@ module Aws::QBusiness
|
|
3994
4104
|
req.send_request(options)
|
3995
4105
|
end
|
3996
4106
|
|
4107
|
+
# Lists all subscriptions created in an Amazon Q Business application.
|
4108
|
+
#
|
4109
|
+
# @option params [required, String] :application_id
|
4110
|
+
# The identifier of the Amazon Q Business application linked to the
|
4111
|
+
# subscription.
|
4112
|
+
#
|
4113
|
+
# @option params [String] :next_token
|
4114
|
+
# If the `maxResults` response was incomplete because there is more data
|
4115
|
+
# to retrieve, Amazon Q Business returns a pagination token in the
|
4116
|
+
# response. You can use this pagination token to retrieve the next set
|
4117
|
+
# of Amazon Q Business subscriptions.
|
4118
|
+
#
|
4119
|
+
# @option params [Integer] :max_results
|
4120
|
+
# The maximum number of Amazon Q Business subscriptions to return.
|
4121
|
+
#
|
4122
|
+
# @return [Types::ListSubscriptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4123
|
+
#
|
4124
|
+
# * {Types::ListSubscriptionsResponse#next_token #next_token} => String
|
4125
|
+
# * {Types::ListSubscriptionsResponse#subscriptions #subscriptions} => Array<Types::Subscription>
|
4126
|
+
#
|
4127
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4128
|
+
#
|
4129
|
+
# @example Request syntax with placeholder values
|
4130
|
+
#
|
4131
|
+
# resp = client.list_subscriptions({
|
4132
|
+
# application_id: "ApplicationId", # required
|
4133
|
+
# next_token: "NextToken",
|
4134
|
+
# max_results: 1,
|
4135
|
+
# })
|
4136
|
+
#
|
4137
|
+
# @example Response structure
|
4138
|
+
#
|
4139
|
+
# resp.next_token #=> String
|
4140
|
+
# resp.subscriptions #=> Array
|
4141
|
+
# resp.subscriptions[0].subscription_id #=> String
|
4142
|
+
# resp.subscriptions[0].subscription_arn #=> String
|
4143
|
+
# resp.subscriptions[0].principal.user #=> String
|
4144
|
+
# resp.subscriptions[0].principal.group #=> String
|
4145
|
+
# resp.subscriptions[0].current_subscription.type #=> String, one of "Q_LITE", "Q_BUSINESS"
|
4146
|
+
# resp.subscriptions[0].next_subscription.type #=> String, one of "Q_LITE", "Q_BUSINESS"
|
4147
|
+
#
|
4148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListSubscriptions AWS API Documentation
|
4149
|
+
#
|
4150
|
+
# @overload list_subscriptions(params = {})
|
4151
|
+
# @param [Hash] params ({})
|
4152
|
+
def list_subscriptions(params = {}, options = {})
|
4153
|
+
req = build_request(:list_subscriptions, params)
|
4154
|
+
req.send_request(options)
|
4155
|
+
end
|
4156
|
+
|
3997
4157
|
# Gets a list of tags associated with a specified resource. Amazon Q
|
3998
4158
|
# Business applications and data sources can have tags associated with
|
3999
4159
|
# them.
|
@@ -4135,6 +4295,13 @@ module Aws::QBusiness
|
|
4135
4295
|
# property group, can see top-secret company documents in their Amazon Q
|
4136
4296
|
# Business chat results.
|
4137
4297
|
#
|
4298
|
+
# There are two options for creating groups, either passing group
|
4299
|
+
# members inline or using an S3 file via the S3PathForGroupMembers
|
4300
|
+
# field. For inline groups, there is a limit of 1000 members per group
|
4301
|
+
# and for provided S3 files there is a limit of 100 thousand members.
|
4302
|
+
# When creating a group using an S3 file, you provide both an S3 file
|
4303
|
+
# and a `RoleArn` for Amazon Q Buisness to access the file.
|
4304
|
+
#
|
4138
4305
|
# @option params [required, String] :application_id
|
4139
4306
|
# The identifier of the application in which the user and group mapping
|
4140
4307
|
# belongs.
|
@@ -4169,9 +4336,7 @@ module Aws::QBusiness
|
|
4169
4336
|
#
|
4170
4337
|
# @option params [String] :role_arn
|
4171
4338
|
# The Amazon Resource Name (ARN) of an IAM role that has access to the
|
4172
|
-
# S3 file that contains your list of users that belong to a group.
|
4173
|
-
# Amazon Resource Name (ARN) of an IAM role that has access to the S3
|
4174
|
-
# file that contains your list of users that belong to a group.
|
4339
|
+
# S3 file that contains your list of users that belong to a group.
|
4175
4340
|
#
|
4176
4341
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4177
4342
|
#
|
@@ -4213,17 +4378,17 @@ module Aws::QBusiness
|
|
4213
4378
|
req.send_request(options)
|
4214
4379
|
end
|
4215
4380
|
|
4216
|
-
# Searches for relevant content in a Q Business application based
|
4217
|
-
# query. This operation takes a search query text, the Q
|
4218
|
-
# application identifier, and optional filters (such as content
|
4219
|
-
# and maximum results) as input. It returns a list of relevant
|
4220
|
-
# items, where each item includes the content text, the unique
|
4221
|
-
# identifier, the document title, the document URI, any
|
4222
|
-
# document attributes, and score attributes indicating the
|
4223
|
-
# level of the relevance.
|
4381
|
+
# Searches for relevant content in a Amazon Q Business application based
|
4382
|
+
# on a query. This operation takes a search query text, the Amazon Q
|
4383
|
+
# Business application identifier, and optional filters (such as content
|
4384
|
+
# source and maximum results) as input. It returns a list of relevant
|
4385
|
+
# content items, where each item includes the content text, the unique
|
4386
|
+
# document identifier, the document title, the document URI, any
|
4387
|
+
# relevant document attributes, and score attributes indicating the
|
4388
|
+
# confidence level of the relevance.
|
4224
4389
|
#
|
4225
4390
|
# @option params [required, String] :application_id
|
4226
|
-
# The unique identifier of the Q Business application to search.
|
4391
|
+
# The unique identifier of the Amazon Q Business application to search.
|
4227
4392
|
#
|
4228
4393
|
# @option params [required, String] :query_text
|
4229
4394
|
# The text to search for.
|
@@ -4598,7 +4763,7 @@ module Aws::QBusiness
|
|
4598
4763
|
req.send_request(options)
|
4599
4764
|
end
|
4600
4765
|
|
4601
|
-
# Updates
|
4766
|
+
# Updates a set of chat controls configured for an existing Amazon Q
|
4602
4767
|
# Business application.
|
4603
4768
|
#
|
4604
4769
|
# @option params [required, String] :application_id
|
@@ -4619,6 +4784,9 @@ module Aws::QBusiness
|
|
4619
4784
|
# uses the large language models (LLM) knowledge to respons to end user
|
4620
4785
|
# questions in chat.
|
4621
4786
|
#
|
4787
|
+
# @option params [Types::OrchestrationConfiguration] :orchestration_configuration
|
4788
|
+
# The chat response orchestration settings for your application.
|
4789
|
+
#
|
4622
4790
|
# @option params [Types::BlockedPhrasesConfigurationUpdate] :blocked_phrases_configuration_update
|
4623
4791
|
# The phrases blocked from chat by your chat control configuration.
|
4624
4792
|
#
|
@@ -4639,6 +4807,9 @@ module Aws::QBusiness
|
|
4639
4807
|
# application_id: "ApplicationId", # required
|
4640
4808
|
# client_token: "ClientToken",
|
4641
4809
|
# response_scope: "ENTERPRISE_CONTENT_ONLY", # accepts ENTERPRISE_CONTENT_ONLY, EXTENDED_KNOWLEDGE_ENABLED
|
4810
|
+
# orchestration_configuration: {
|
4811
|
+
# control: "ENABLED", # required, accepts ENABLED, DISABLED
|
4812
|
+
# },
|
4642
4813
|
# blocked_phrases_configuration_update: {
|
4643
4814
|
# blocked_phrases_to_create_or_update: ["BlockedPhrase"],
|
4644
4815
|
# blocked_phrases_to_delete: ["BlockedPhrase"],
|
@@ -4731,7 +4902,7 @@ module Aws::QBusiness
|
|
4731
4902
|
# the data accessor.
|
4732
4903
|
#
|
4733
4904
|
# @option params [required, String] :application_id
|
4734
|
-
# The unique identifier of the Q Business application.
|
4905
|
+
# The unique identifier of the Amazon Q Business application.
|
4735
4906
|
#
|
4736
4907
|
# @option params [required, String] :data_accessor_id
|
4737
4908
|
# The unique identifier of the data accessor to update.
|
@@ -5191,6 +5362,55 @@ module Aws::QBusiness
|
|
5191
5362
|
req.send_request(options)
|
5192
5363
|
end
|
5193
5364
|
|
5365
|
+
# Updates the pricing tier for an Amazon Q Business subscription.
|
5366
|
+
# Upgrades are instant. Downgrades apply at the start of the next month.
|
5367
|
+
# Subscription tier determines feature access for the user. For more
|
5368
|
+
# information on subscriptions and pricing tiers, see [Amazon Q Business
|
5369
|
+
# pricing][1].
|
5370
|
+
#
|
5371
|
+
#
|
5372
|
+
#
|
5373
|
+
# [1]: https://aws.amazon.com/q/business/pricing/
|
5374
|
+
#
|
5375
|
+
# @option params [required, String] :application_id
|
5376
|
+
# The identifier of the Amazon Q Business application where the
|
5377
|
+
# subscription update should take effect.
|
5378
|
+
#
|
5379
|
+
# @option params [required, String] :subscription_id
|
5380
|
+
# The identifier of the Amazon Q Business subscription to be updated.
|
5381
|
+
#
|
5382
|
+
# @option params [required, String] :type
|
5383
|
+
# The type of the Amazon Q Business subscription to be updated.
|
5384
|
+
#
|
5385
|
+
# @return [Types::UpdateSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5386
|
+
#
|
5387
|
+
# * {Types::UpdateSubscriptionResponse#subscription_arn #subscription_arn} => String
|
5388
|
+
# * {Types::UpdateSubscriptionResponse#current_subscription #current_subscription} => Types::SubscriptionDetails
|
5389
|
+
# * {Types::UpdateSubscriptionResponse#next_subscription #next_subscription} => Types::SubscriptionDetails
|
5390
|
+
#
|
5391
|
+
# @example Request syntax with placeholder values
|
5392
|
+
#
|
5393
|
+
# resp = client.update_subscription({
|
5394
|
+
# application_id: "ApplicationId", # required
|
5395
|
+
# subscription_id: "SubscriptionId", # required
|
5396
|
+
# type: "Q_LITE", # required, accepts Q_LITE, Q_BUSINESS
|
5397
|
+
# })
|
5398
|
+
#
|
5399
|
+
# @example Response structure
|
5400
|
+
#
|
5401
|
+
# resp.subscription_arn #=> String
|
5402
|
+
# resp.current_subscription.type #=> String, one of "Q_LITE", "Q_BUSINESS"
|
5403
|
+
# resp.next_subscription.type #=> String, one of "Q_LITE", "Q_BUSINESS"
|
5404
|
+
#
|
5405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateSubscription AWS API Documentation
|
5406
|
+
#
|
5407
|
+
# @overload update_subscription(params = {})
|
5408
|
+
# @param [Hash] params ({})
|
5409
|
+
def update_subscription(params = {}, options = {})
|
5410
|
+
req = build_request(:update_subscription, params)
|
5411
|
+
req.send_request(options)
|
5412
|
+
end
|
5413
|
+
|
5194
5414
|
# Updates a information associated with a user id.
|
5195
5415
|
#
|
5196
5416
|
# @option params [required, String] :application_id
|
@@ -5390,7 +5610,7 @@ module Aws::QBusiness
|
|
5390
5610
|
tracer: tracer
|
5391
5611
|
)
|
5392
5612
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
5393
|
-
context[:gem_version] = '1.
|
5613
|
+
context[:gem_version] = '1.28.0'
|
5394
5614
|
Seahorse::Client::Request.new(handlers, context)
|
5395
5615
|
end
|
5396
5616
|
|