aws-sdk-qbusiness 1.25.0 → 1.27.0

data/lib/aws-sdk-qbusiness/types.rb

@@ -109,7 +109,7 @@ module Aws::QBusiness
     # Specifies an allowed action and its associated filter configuration.
     #
     # @!attribute [rw] action
-    #   The Q Business action that is allowed.
+    #   The Amazon Q Business action that is allowed.
     #   @return [String]
     #
     # @!attribute [rw] filter_configuration
@@ -512,7 +512,7 @@ module Aws::QBusiness
     end
 
     # @!attribute [rw] application_id
-    #   The unique identifier of the Q Business application.
+    #   The unique identifier of the Amazon Q Business application.
     #   @return [String]
     #
     # @!attribute [rw] statement_id
@@ -520,12 +520,13 @@ module Aws::QBusiness
     #   @return [String]
     #
     # @!attribute [rw] actions
-    #   The list of Q Business actions that the ISV is allowed to perform.
+    #   The list of Amazon Q Business actions that the ISV is allowed to
+    #   perform.
     #   @return [Array<String>]
     #
     # @!attribute [rw] principal
-    #   The Amazon Resource Name (ARN) of the IAM role for the ISV that is
-    #   being granted permission.
+    #   The Amazon Resource Name of the IAM role for the ISV that is being
+    #   granted permission.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AssociatePermissionRequest AWS API Documentation
@@ -1093,6 +1094,48 @@ module Aws::QBusiness
       include Aws::Structure
     end
 
+    # @!attribute [rw] application_id
+    #   The identifier of the Amazon Q Business application for which the
+    #   subscription is being cancelled.
+    #   @return [String]
+    #
+    # @!attribute [rw] subscription_id
+    #   The identifier of the Amazon Q Business subscription being
+    #   cancelled.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CancelSubscriptionRequest AWS API Documentation
+    #
+    class CancelSubscriptionRequest < Struct.new(
+      :application_id,
+      :subscription_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] subscription_arn
+    #   The Amazon Resource Name (ARN) of the Amazon Q Business subscription
+    #   being cancelled.
+    #   @return [String]
+    #
+    # @!attribute [rw] current_subscription
+    #   The type of your current Amazon Q Business subscription.
+    #   @return [Types::SubscriptionDetails]
+    #
+    # @!attribute [rw] next_subscription
+    #   The type of the Amazon Q Business subscription for the next month.
+    #   @return [Types::SubscriptionDetails]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CancelSubscriptionResponse AWS API Documentation
+    #
+    class CancelSubscriptionResponse < Struct.new(
+      :subscription_arn,
+      :current_subscription,
+      :next_subscription)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] application_id
     #   The identifier of the Amazon Q Business application linked to a
     #   streaming Amazon Q Business conversation.
@@ -1681,7 +1724,7 @@ module Aws::QBusiness
     end
 
     # @!attribute [rw] application_id
-    #   The unique identifier of the Q Business application.
+    #   The unique identifier of the Amazon Q Business application.
     #   @return [String]
     #
     # @!attribute [rw] principal
@@ -1728,7 +1771,7 @@ module Aws::QBusiness
     #   @return [String]
     #
     # @!attribute [rw] idc_application_arn
-    #   The Amazon Resource Name (ARN) of the AWS IAM Identity Center
+    #   The Amazon Resource Name (ARN) of the IAM Identity Center
     #   application created for this data accessor.
     #   @return [String]
     #
@@ -2111,6 +2154,68 @@ module Aws::QBusiness
       include Aws::Structure
     end
 
+    # @!attribute [rw] application_id
+    #   The identifier of the Amazon Q Business application the subscription
+    #   should be added to.
+    #   @return [String]
+    #
+    # @!attribute [rw] principal
+    #   The IAM Identity Center `UserId` or `GroupId` of a user or group in
+    #   the IAM Identity Center instance connected to the Amazon Q Business
+    #   application.
+    #   @return [Types::SubscriptionPrincipal]
+    #
+    # @!attribute [rw] type
+    #   The type of Amazon Q Business subscription you want to create.
+    #   @return [String]
+    #
+    # @!attribute [rw] client_token
+    #   A token that you provide to identify the request to create a
+    #   subscription for your Amazon Q Business application.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateSubscriptionRequest AWS API Documentation
+    #
+    class CreateSubscriptionRequest < Struct.new(
+      :application_id,
+      :principal,
+      :type,
+      :client_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] subscription_id
+    #   The identifier of the Amazon Q Business subscription created.
+    #   @return [String]
+    #
+    # @!attribute [rw] subscription_arn
+    #   The Amazon Resource Name (ARN) of the Amazon Q Business subscription
+    #   created.
+    #   @return [String]
+    #
+    # @!attribute [rw] current_subscription
+    #   The type of your current Amazon Q Business subscription.
+    #   @return [Types::SubscriptionDetails]
+    #
+    # @!attribute [rw] next_subscription
+    #   The type of the Amazon Q Business subscription for the next month.
+    #   @return [Types::SubscriptionDetails]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateSubscriptionResponse AWS API Documentation
+    #
+    class CreateSubscriptionResponse < Struct.new(
+      :subscription_id,
+      :subscription_arn,
+      :current_subscription,
+      :next_subscription)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] application_id
     #   The identifier of the application for which the user mapping will be
     #   created.
@@ -2370,8 +2475,8 @@ module Aws::QBusiness
     #   @return [String]
     #
     # @!attribute [rw] idc_application_arn
-    #   The Amazon Resource Name (ARN) of the associated AWS IAM Identity
-    #   Center application.
+    #   The Amazon Resource Name (ARN) of the associated IAM Identity Center
+    #   application.
     #   @return [String]
     #
     # @!attribute [rw] principal
@@ -2649,7 +2754,7 @@ module Aws::QBusiness
     class DeleteConversationResponse < Aws::EmptyStructure; end
 
     # @!attribute [rw] application_id
-    #   The unique identifier of the Q Business application.
+    #   The unique identifier of the Amazon Q Business application.
     #   @return [String]
     #
     # @!attribute [rw] data_accessor_id
@@ -2864,7 +2969,7 @@ module Aws::QBusiness
     class DeleteWebExperienceResponse < Aws::EmptyStructure; end
 
     # @!attribute [rw] application_id
-    #   The unique identifier of the Q Business application.
+    #   The unique identifier of the Amazon Q Business application.
     #   @return [String]
     #
     # @!attribute [rw] statement_id
@@ -3692,7 +3797,7 @@ module Aws::QBusiness
     end
 
     # @!attribute [rw] application_id
-    #   The unique identifier of the Q Business application.
+    #   The unique identifier of the Amazon Q Business application.
     #   @return [String]
     #
     # @!attribute [rw] data_accessor_id
@@ -3721,12 +3826,12 @@ module Aws::QBusiness
     #   @return [String]
     #
     # @!attribute [rw] application_id
-    #   The unique identifier of the Q Business application associated with
-    #   this data accessor.
+    #   The unique identifier of the Amazon Q Business application
+    #   associated with this data accessor.
     #   @return [String]
     #
     # @!attribute [rw] idc_application_arn
-    #   The Amazon Resource Name (ARN) of the AWS IAM Identity Center
+    #   The Amazon Resource Name (ARN) of the IAM Identity Center
     #   application associated with this data accessor.
     #   @return [String]
     #
@@ -4174,7 +4279,7 @@ module Aws::QBusiness
     end
 
     # @!attribute [rw] application_id
-    #   The unique identifier of the Q Business application.
+    #   The unique identifier of the Amazon Q Business application.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetPolicyRequest AWS API Documentation
@@ -4988,7 +5093,7 @@ module Aws::QBusiness
     end
 
     # @!attribute [rw] application_id
-    #   The unique identifier of the Q Business application.
+    #   The unique identifier of the Amazon Q Business application.
     #   @return [String]
     #
     # @!attribute [rw] next_token
@@ -5589,6 +5694,52 @@ module Aws::QBusiness
       include Aws::Structure
     end
 
+    # @!attribute [rw] application_id
+    #   The identifier of the Amazon Q Business application linked to the
+    #   subscription.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   If the `maxResults` response was incomplete because there is more
+    #   data to retrieve, Amazon Q Business returns a pagination token in
+    #   the response. You can use this pagination token to retrieve the next
+    #   set of Amazon Q Business subscriptions.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of Amazon Q Business subscriptions to return.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListSubscriptionsRequest AWS API Documentation
+    #
+    class ListSubscriptionsRequest < Struct.new(
+      :application_id,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   If the response is truncated, Amazon Q Business returns this token.
+    #   You can use this token in a subsequent request to retrieve the next
+    #   set of subscriptions.
+    #   @return [String]
+    #
+    # @!attribute [rw] subscriptions
+    #   An array of summary information on the subscriptions configured for
+    #   an Amazon Q Business application.
+    #   @return [Array<Types::Subscription>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListSubscriptionsResponse AWS API Documentation
+    #
+    class ListSubscriptionsResponse < Struct.new(
+      :next_token,
+      :subscriptions)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] resource_arn
     #   The Amazon Resource Name (ARN) of the Amazon Q Business application
     #   or data source to get a list of tags for.
@@ -6290,9 +6441,7 @@ module Aws::QBusiness
     #
     # @!attribute [rw] role_arn
     #   The Amazon Resource Name (ARN) of an IAM role that has access to the
-    #   S3 file that contains your list of users that belong to a group.The
-    #   Amazon Resource Name (ARN) of an IAM role that has access to the S3
-    #   file that contains your list of users that belong to a group.
+    #   S3 file that contains your list of users that belong to a group.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutGroupRequest AWS API Documentation
@@ -6650,7 +6799,8 @@ module Aws::QBusiness
     end
 
     # @!attribute [rw] application_id
-    #   The unique identifier of the Q Business application to search.
+    #   The unique identifier of the Amazon Q Business application to
+    #   search.
     #   @return [String]
     #
     # @!attribute [rw] query_text
@@ -6927,6 +7077,101 @@ module Aws::QBusiness
       include Aws::Structure
     end
 
+    # Information about an Amazon Q Business subscription.
+    #
+    # Subscriptions are used to provide access for an IAM Identity Center
+    # user or a group to an Amazon Q Business application.
+    #
+    # Amazon Q Business offers two subscription tiers: `Q_LITE` and
+    # `Q_BUSINESS`. Subscription tier determines feature access for the
+    # user. For more information on subscriptions and pricing tiers, see
+    # [Amazon Q Business pricing][1].
+    #
+    #
+    #
+    # [1]: https://aws.amazon.com/q/business/pricing/
+    #
+    # @!attribute [rw] subscription_id
+    #   The identifier of the Amazon Q Business subscription to be updated.
+    #   @return [String]
+    #
+    # @!attribute [rw] subscription_arn
+    #   The Amazon Resource Name (ARN) of the Amazon Q Business subscription
+    #   that was updated.
+    #   @return [String]
+    #
+    # @!attribute [rw] principal
+    #   The IAM Identity Center `UserId` or `GroupId` of a user or group in
+    #   the IAM Identity Center instance connected to the Amazon Q Business
+    #   application.
+    #   @return [Types::SubscriptionPrincipal]
+    #
+    # @!attribute [rw] current_subscription
+    #   The type of your current Amazon Q Business subscription.
+    #   @return [Types::SubscriptionDetails]
+    #
+    # @!attribute [rw] next_subscription
+    #   The type of the Amazon Q Business subscription for the next month.
+    #   @return [Types::SubscriptionDetails]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Subscription AWS API Documentation
+    #
+    class Subscription < Struct.new(
+      :subscription_id,
+      :subscription_arn,
+      :principal,
+      :current_subscription,
+      :next_subscription)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The details of an Amazon Q Business subscription.
+    #
+    # @!attribute [rw] type
+    #   The type of an Amazon Q Business subscription.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SubscriptionDetails AWS API Documentation
+    #
+    class SubscriptionDetails < Struct.new(
+      :type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A user or group in the IAM Identity Center instance connected to the
+    # Amazon Q Business application.
+    #
+    # @note SubscriptionPrincipal is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @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.
+    #
+    # @!attribute [rw] user
+    #   The identifier of a user in the IAM Identity Center instance
+    #   connected to the Amazon Q Business application.
+    #   @return [String]
+    #
+    # @!attribute [rw] group
+    #   The identifier of a group in the IAM Identity Center instance
+    #   connected to the Amazon Q Business application.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/SubscriptionPrincipal AWS API Documentation
+    #
+    class SubscriptionPrincipal < Struct.new(
+      :user,
+      :group,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class User < SubscriptionPrincipal; end
+      class Group < SubscriptionPrincipal; end
+      class Unknown < SubscriptionPrincipal; end
+    end
+
     # A list of key/value pairs that identify an index, FAQ, or data source.
     # Tag keys and values can consist of Unicode letters, digits, white
     # space, and any of the following symbols: \_ . : / = + - @.
@@ -7276,7 +7521,7 @@ module Aws::QBusiness
     class UpdateChatControlsConfigurationResponse < Aws::EmptyStructure; end
 
     # @!attribute [rw] application_id
-    #   The unique identifier of the Q Business application.
+    #   The unique identifier of the Amazon Q Business application.
     #   @return [String]
     #
     # @!attribute [rw] data_accessor_id
@@ -7521,6 +7766,52 @@ module Aws::QBusiness
     #
     class UpdateRetrieverResponse < Aws::EmptyStructure; end
 
+    # @!attribute [rw] application_id
+    #   The identifier of the Amazon Q Business application where the
+    #   subscription update should take effect.
+    #   @return [String]
+    #
+    # @!attribute [rw] subscription_id
+    #   The identifier of the Amazon Q Business subscription to be updated.
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   The type of the Amazon Q Business subscription to be updated.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateSubscriptionRequest AWS API Documentation
+    #
+    class UpdateSubscriptionRequest < Struct.new(
+      :application_id,
+      :subscription_id,
+      :type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] subscription_arn
+    #   The Amazon Resource Name (ARN) of the Amazon Q Business subscription
+    #   that was updated.
+    #   @return [String]
+    #
+    # @!attribute [rw] current_subscription
+    #   The type of your current Amazon Q Business subscription.
+    #   @return [Types::SubscriptionDetails]
+    #
+    # @!attribute [rw] next_subscription
+    #   The type of the Amazon Q Business subscription for the next month.
+    #   @return [Types::SubscriptionDetails]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateSubscriptionResponse AWS API Documentation
+    #
+    class UpdateSubscriptionResponse < Struct.new(
+      :subscription_arn,
+      :current_subscription,
+      :next_subscription)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] application_id
     #   The identifier of the application the user is attached to.
     #   @return [String]

data/lib/aws-sdk-qbusiness.rb

@@ -57,7 +57,7 @@ module Aws::QBusiness
   autoload :AsyncClient, 'aws-sdk-qbusiness/async_client'
   autoload :EventStreams, 'aws-sdk-qbusiness/event_streams'
 
-  GEM_VERSION = '1.25.0'
+  GEM_VERSION = '1.27.0'
 
 end
 

data/sig/client.rbs

@@ -42,7 +42,9 @@ module Aws
                       ?max_attempts: Integer,
                       ?output_event_stream_handler: Proc,
                       ?profile: String,
+                      ?request_checksum_calculation: String,
                       ?request_min_compression_size_bytes: Integer,
+                      ?response_checksum_validation: String,
                       ?retry_backoff: Proc,
                       ?retry_base_delay: Float,
                       ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
@@ -230,6 +232,19 @@ module Aws
                               ) -> _BatchPutDocumentResponseSuccess
                             | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchPutDocumentResponseSuccess
 
+      interface _CancelSubscriptionResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::CancelSubscriptionResponse]
+        def subscription_arn: () -> ::String
+        def current_subscription: () -> Types::SubscriptionDetails
+        def next_subscription: () -> Types::SubscriptionDetails
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#cancel_subscription-instance_method
+      def cancel_subscription: (
+                                 application_id: ::String,
+                                 subscription_id: ::String
+                               ) -> _CancelSubscriptionResponseSuccess
+                             | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelSubscriptionResponseSuccess
+
       interface _ChatResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ChatOutput]
         def output_stream: () -> Types::ChatOutputStream
@@ -721,6 +736,25 @@ module Aws
                             ) -> _CreateRetrieverResponseSuccess
                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRetrieverResponseSuccess
 
+      interface _CreateSubscriptionResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::CreateSubscriptionResponse]
+        def subscription_id: () -> ::String
+        def subscription_arn: () -> ::String
+        def current_subscription: () -> Types::SubscriptionDetails
+        def next_subscription: () -> Types::SubscriptionDetails
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_subscription-instance_method
+      def create_subscription: (
+                                 application_id: ::String,
+                                 principal: {
+                                   user: ::String?,
+                                   group: ::String?
+                                 },
+                                 type: ("Q_LITE" | "Q_BUSINESS"),
+                                 ?client_token: ::String
+                               ) -> _CreateSubscriptionResponseSuccess
+                             | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSubscriptionResponseSuccess
+
       interface _CreateUserResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserResponse]
       end
@@ -1342,6 +1376,19 @@ module Aws
                            ) -> _ListRetrieversResponseSuccess
                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRetrieversResponseSuccess
 
+      interface _ListSubscriptionsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListSubscriptionsResponse]
+        def next_token: () -> ::String
+        def subscriptions: () -> ::Array[Types::Subscription]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#list_subscriptions-instance_method
+      def list_subscriptions: (
+                                application_id: ::String,
+                                ?next_token: ::String,
+                                ?max_results: ::Integer
+                              ) -> _ListSubscriptionsResponseSuccess
+                            | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSubscriptionsResponseSuccess
+
       interface _ListTagsForResourceResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
         def tags: () -> ::Array[Types::Tag]
@@ -1937,6 +1984,20 @@ module Aws
                             ) -> _UpdateRetrieverResponseSuccess
                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateRetrieverResponseSuccess
 
+      interface _UpdateSubscriptionResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::UpdateSubscriptionResponse]
+        def subscription_arn: () -> ::String
+        def current_subscription: () -> Types::SubscriptionDetails
+        def next_subscription: () -> Types::SubscriptionDetails
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#update_subscription-instance_method
+      def update_subscription: (
+                                 application_id: ::String,
+                                 subscription_id: ::String,
+                                 type: ("Q_LITE" | "Q_BUSINESS")
+                               ) -> _UpdateSubscriptionResponseSuccess
+                             | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateSubscriptionResponseSuccess
+
       interface _UpdateUserResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserResponse]
         def user_aliases_added: () -> ::Array[Types::UserAlias]

data/sig/resource.rbs

@@ -42,7 +42,9 @@ module Aws
                         ?max_attempts: Integer,
                         ?output_event_stream_handler: Proc,
                         ?profile: String,
+                        ?request_checksum_calculation: String,
                         ?request_min_compression_size_bytes: Integer,
+                        ?response_checksum_validation: String,
                         ?retry_backoff: Proc,
                         ?retry_base_delay: Float,
                         ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),