aws-sdk-qbusiness 1.17.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eba54c316519e372438b600883b80f8b3240cfb0f5834297b1f769478e8b09bd
-  data.tar.gz: 227daa497e5ed37c1c22fc12b170cf60c75b9c61ffa3ede29ff2854f64d5558b
+  metadata.gz: 4d449e856674c09cd6c3d73d8b4c0c5e6386a31b4449db2df7c7daaf4e2318fc
+  data.tar.gz: 2c7cb63444349ddd0e124a3da7c6c786531d5a4625eec4c1a7f75fc9599f36ea
 SHA512:
-  metadata.gz: 3bd22f3db529815bd17ac6d8405d1978e270bf72854fd7b4a770b61e44e47b480c62b3838b0bf1b11655dab5599245df70d699dffad51567a43fd289868584f3
-  data.tar.gz: 9467188c10d3d0ebecba01021e0c26cad6a744fe3c361fdc792bf1501561132e0abc15992bfd9a5c77b8b9401a3d5db478ab2bf4c44d983ea9101b56e4b545ed
+  metadata.gz: 86dbf25992382f02f73bfd046bfb1b3353b705c07f1bce95f63dfb90c5fa23b36d9dec2f5675783f977886fc21b2b649c5df39e76571c838c02459869b716f07
+  data.tar.gz: df8f23078529382f17a649ad4ca7a178bb9552e5127cf7ff02f290be1aad5e9f9bb8b82f266fed38e09ac84856a4b4aaee05f38a0e8428721925d82ad4504328

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.19.0 (2024-10-15)
+------------------
+
+* Feature - Amazon Q Business now supports embedding the Amazon Q Business web experience on third-party websites.
+
+1.18.0 (2024-09-24)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.17.0 (2024-09-23)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.17.0
+1.19.0

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

@@ -372,7 +372,7 @@ module Aws::QBusiness
     #   The identifier of the user attached to the chat input.
     #
     # @option params [Array<String>] :user_groups
-    #   The groups that a user associated with the chat input belongs to.
+    #   The group names that a user associated with the chat input belongs to.
     #
     # @option params [String] :conversation_id
     #   The identifier of the Amazon Q Business conversation.
@@ -603,7 +603,7 @@ module Aws::QBusiness
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-qbusiness'
-      context[:gem_version] = '1.17.0'
+      context[:gem_version] = '1.19.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -37,8 +37,6 @@ require 'aws-sdk-core/plugins/sign.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 require 'aws-sdk-core/plugins/event_stream_configuration.rb'
 
-Aws::Plugins::GlobalConfiguration.add_identifier(:qbusiness)
-
 module Aws::QBusiness
   # An API client for QBusiness.  To construct a client, you need to configure a `:region` and `:credentials`.
   #
@@ -690,7 +688,7 @@ module Aws::QBusiness
     #   The identifier of the user attached to the chat input.
     #
     # @option params [Array<String>] :user_groups
-    #   The groups that a user associated with the chat input belongs to.
+    #   The group names that a user associated with the chat input belongs to.
     #
     # @option params [String] :user_message
     #   A end user message in a conversation.
@@ -941,7 +939,13 @@ module Aws::QBusiness
     #
     # @option params [String] :role_arn
     #   The Amazon Resource Name (ARN) of an IAM role with permissions to
-    #   access your Amazon CloudWatch logs and metrics.
+    #   access your Amazon CloudWatch logs and metrics. If this property is
+    #   not specified, Amazon Q Business will create a [service linked role
+    #   (SLR)][1] and use it as the application's role.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions
     #
     # @option params [String] :identity_type
     #   The authentication type being used by a Amazon Q Business application.
@@ -1590,6 +1594,15 @@ module Aws::QBusiness
     #   Determines whether sample prompts are enabled in the web experience
     #   for an end user.
     #
+    # @option params [Array<String>] :origins
+    #   Sets the website domain origins that are allowed to embed the Amazon Q
+    #   Business web experience.      The <i>domain origin</i> refers to the
+    #   base URL for accessing a website including the protocol
+    #   (<code>http/https</code>), the domain name, and the port number (if
+    #   specified). </p> <note> <p>You must only submit a <i>base URL</i> and
+    #   not a full path. For example,
+    #   <code>https://docs.aws.amazon.com</code>.</p> </note>
+    #
     # @option params [String] :role_arn
     #   The Amazon Resource Name (ARN) of the service role attached to your
     #   web experience.
@@ -1632,6 +1645,7 @@ module Aws::QBusiness
     #     subtitle: "WebExperienceSubtitle",
     #     welcome_message: "WebExperienceWelcomeMessage",
     #     sample_prompts_control_mode: "ENABLED", # accepts ENABLED, DISABLED
+    #     origins: ["Origin"],
     #     role_arn: "RoleArn",
     #     tags: [
     #       {
@@ -2498,6 +2512,7 @@ module Aws::QBusiness
     #   * {Types::GetWebExperienceResponse#subtitle #subtitle} => String
     #   * {Types::GetWebExperienceResponse#welcome_message #welcome_message} => String
     #   * {Types::GetWebExperienceResponse#sample_prompts_control_mode #sample_prompts_control_mode} => String
+    #   * {Types::GetWebExperienceResponse#origins #origins} => Array&lt;String&gt;
     #   * {Types::GetWebExperienceResponse#role_arn #role_arn} => String
     #   * {Types::GetWebExperienceResponse#identity_provider_configuration #identity_provider_configuration} => Types::IdentityProviderConfiguration
     #   * {Types::GetWebExperienceResponse#authentication_configuration #authentication_configuration} => Types::WebExperienceAuthConfiguration
@@ -2523,6 +2538,8 @@ module Aws::QBusiness
     #   resp.subtitle #=> String
     #   resp.welcome_message #=> String
     #   resp.sample_prompts_control_mode #=> String, one of "ENABLED", "DISABLED"
+    #   resp.origins #=> Array
+    #   resp.origins[0] #=> String
     #   resp.role_arn #=> String
     #   resp.identity_provider_configuration.saml_configuration.authentication_url #=> String
     #   resp.identity_provider_configuration.open_id_connect_configuration.secrets_arn #=> String
@@ -4099,6 +4116,17 @@ module Aws::QBusiness
     #   Information about the identity provider (IdP) used to authenticate end
     #   users of an Amazon Q Business web experience.
     #
+    # @option params [Array<String>] :origins
+    #   Updates the website domain origins that are allowed to embed the
+    #   Amazon Q Business web experience.      The <i>domain origin</i> refers
+    #   to the <i>base URL</i> for accessing a website including the protocol
+    #   (<code>http/https</code>), the domain name, and the port number (if
+    #   specified).</p> <note> <ul> <li> <p>Any values except
+    #   <code>null</code> submitted as part of this update will replace all
+    #   previous values.</p> </li> <li> <p>You must only submit a <i>base
+    #   URL</i> and not a full path. For example,
+    #   <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -4128,6 +4156,7 @@ module Aws::QBusiness
     #         secrets_role: "RoleArn", # required
     #       },
     #     },
+    #     origins: ["Origin"],
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperience AWS API Documentation
@@ -4157,7 +4186,7 @@ module Aws::QBusiness
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-qbusiness'
-      context[:gem_version] = '1.17.0'
+      context[:gem_version] = '1.19.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -303,6 +303,7 @@ module Aws::QBusiness
     NumberAttributeBoostingType = Shapes::StringShape.new(name: 'NumberAttributeBoostingType')
     OAuth2ClientCredentialConfiguration = Shapes::StructureShape.new(name: 'OAuth2ClientCredentialConfiguration')
     OpenIDConnectProviderConfiguration = Shapes::StructureShape.new(name: 'OpenIDConnectProviderConfiguration')
+    Origin = Shapes::StringShape.new(name: 'Origin')
     Payload = Shapes::StringShape.new(name: 'Payload')
     PersonalizationConfiguration = Shapes::StructureShape.new(name: 'PersonalizationConfiguration')
     PersonalizationControlMode = Shapes::StringShape.new(name: 'PersonalizationControlMode')
@@ -427,6 +428,7 @@ module Aws::QBusiness
     WebExperienceArn = Shapes::StringShape.new(name: 'WebExperienceArn')
     WebExperienceAuthConfiguration = Shapes::UnionShape.new(name: 'WebExperienceAuthConfiguration')
     WebExperienceId = Shapes::StringShape.new(name: 'WebExperienceId')
+    WebExperienceOrigins = Shapes::ListShape.new(name: 'WebExperienceOrigins')
     WebExperienceSamplePromptsControlMode = Shapes::StringShape.new(name: 'WebExperienceSamplePromptsControlMode')
     WebExperienceStatus = Shapes::StringShape.new(name: 'WebExperienceStatus')
     WebExperienceSubtitle = Shapes::StringShape.new(name: 'WebExperienceSubtitle')
@@ -786,6 +788,7 @@ module Aws::QBusiness
     CreateWebExperienceRequest.add_member(:subtitle, Shapes::ShapeRef.new(shape: WebExperienceSubtitle, location_name: "subtitle"))
     CreateWebExperienceRequest.add_member(:welcome_message, Shapes::ShapeRef.new(shape: WebExperienceWelcomeMessage, location_name: "welcomeMessage"))
     CreateWebExperienceRequest.add_member(:sample_prompts_control_mode, Shapes::ShapeRef.new(shape: WebExperienceSamplePromptsControlMode, location_name: "samplePromptsControlMode"))
+    CreateWebExperienceRequest.add_member(:origins, Shapes::ShapeRef.new(shape: WebExperienceOrigins, location_name: "origins"))
     CreateWebExperienceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
     CreateWebExperienceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags"))
     CreateWebExperienceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
@@ -1167,6 +1170,7 @@ module Aws::QBusiness
     GetWebExperienceResponse.add_member(:subtitle, Shapes::ShapeRef.new(shape: WebExperienceSubtitle, location_name: "subtitle"))
     GetWebExperienceResponse.add_member(:welcome_message, Shapes::ShapeRef.new(shape: WebExperienceWelcomeMessage, location_name: "welcomeMessage"))
     GetWebExperienceResponse.add_member(:sample_prompts_control_mode, Shapes::ShapeRef.new(shape: WebExperienceSamplePromptsControlMode, location_name: "samplePromptsControlMode"))
+    GetWebExperienceResponse.add_member(:origins, Shapes::ShapeRef.new(shape: WebExperienceOrigins, location_name: "origins"))
     GetWebExperienceResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
     GetWebExperienceResponse.add_member(:identity_provider_configuration, Shapes::ShapeRef.new(shape: IdentityProviderConfiguration, location_name: "identityProviderConfiguration"))
     GetWebExperienceResponse.add_member(:authentication_configuration, Shapes::ShapeRef.new(shape: WebExperienceAuthConfiguration, deprecated: true, location_name: "authenticationConfiguration", metadata: {"deprecatedMessage"=>"Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management."}))
@@ -1713,6 +1717,7 @@ module Aws::QBusiness
     UpdateWebExperienceRequest.add_member(:welcome_message, Shapes::ShapeRef.new(shape: WebExperienceWelcomeMessage, location_name: "welcomeMessage"))
     UpdateWebExperienceRequest.add_member(:sample_prompts_control_mode, Shapes::ShapeRef.new(shape: WebExperienceSamplePromptsControlMode, location_name: "samplePromptsControlMode"))
     UpdateWebExperienceRequest.add_member(:identity_provider_configuration, Shapes::ShapeRef.new(shape: IdentityProviderConfiguration, location_name: "identityProviderConfiguration"))
+    UpdateWebExperienceRequest.add_member(:origins, Shapes::ShapeRef.new(shape: WebExperienceOrigins, location_name: "origins"))
     UpdateWebExperienceRequest.struct_class = Types::UpdateWebExperienceRequest
 
     UpdateWebExperienceResponse.struct_class = Types::UpdateWebExperienceResponse
@@ -1756,6 +1761,8 @@ module Aws::QBusiness
     WebExperienceAuthConfiguration.add_member_subclass(:unknown, Types::WebExperienceAuthConfiguration::Unknown)
     WebExperienceAuthConfiguration.struct_class = Types::WebExperienceAuthConfiguration
 
+    WebExperienceOrigins.member = Shapes::ShapeRef.new(shape: Origin)
+
     WebExperiences.member = Shapes::ShapeRef.new(shape: WebExperience)
 
 

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

@@ -874,7 +874,8 @@ module Aws::QBusiness
     #   @return [String]
     #
     # @!attribute [rw] user_groups
-    #   The groups that a user associated with the chat input belongs to.
+    #   The group names that a user associated with the chat input belongs
+    #   to.
     #   @return [Array<String>]
     #
     # @!attribute [rw] conversation_id
@@ -962,7 +963,8 @@ module Aws::QBusiness
     #   @return [String]
     #
     # @!attribute [rw] user_groups
-    #   The groups that a user associated with the chat input belongs to.
+    #   The group names that a user associated with the chat input belongs
+    #   to.
     #   @return [Array<String>]
     #
     # @!attribute [rw] user_message
@@ -1251,7 +1253,13 @@ module Aws::QBusiness
     #
     # @!attribute [rw] role_arn
     #   The Amazon Resource Name (ARN) of an IAM role with permissions to
-    #   access your Amazon CloudWatch logs and metrics.
+    #   access your Amazon CloudWatch logs and metrics. If this property is
+    #   not specified, Amazon Q Business will create a [service linked role
+    #   (SLR)][1] and use it as the application's role.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions
     #   @return [String]
     #
     # @!attribute [rw] identity_type
@@ -1771,6 +1779,16 @@ module Aws::QBusiness
     #   for an end user.
     #   @return [String]
     #
+    # @!attribute [rw] origins
+    #   Sets the website domain origins that are allowed to embed the Amazon
+    #   Q Business web experience.      The <i>domain origin</i> refers to
+    #   the base URL for accessing a website including the protocol
+    #   (<code>http/https</code>), the domain name, and the port number (if
+    #   specified). </p> <note> <p>You must only submit a <i>base URL</i>
+    #   and not a full path. For example,
+    #   <code>https://docs.aws.amazon.com</code>.</p> </note>
+    #   @return [Array<String>]
+    #
     # @!attribute [rw] role_arn
     #   The Amazon Resource Name (ARN) of the service role attached to your
     #   web experience.
@@ -1812,6 +1830,7 @@ module Aws::QBusiness
       :subtitle,
       :welcome_message,
       :sample_prompts_control_mode,
+      :origins,
       :role_arn,
       :tags,
       :client_token,
@@ -3643,6 +3662,14 @@ module Aws::QBusiness
     #   for an end user.
     #   @return [String]
     #
+    # @!attribute [rw] origins
+    #   Gets the website domain origins that are allowed to embed the Amazon
+    #   Q Business web experience.      The <i>domain origin</i> refers to
+    #   the base URL for accessing a website including the protocol
+    #   (<code>http/https</code>), the domain name, and the port number (if
+    #   specified). </p>
+    #   @return [Array<String>]
+    #
     # @!attribute [rw] role_arn
     #   The Amazon Resource Name (ARN) of the service role attached to your
     #   web experience.
@@ -3678,6 +3705,7 @@ module Aws::QBusiness
       :subtitle,
       :welcome_message,
       :sample_prompts_control_mode,
+      :origins,
       :role_arn,
       :identity_provider_configuration,
       :authentication_configuration,
@@ -5198,7 +5226,7 @@ module Aws::QBusiness
     #
     class PutGroupResponse < Aws::EmptyStructure; end
 
-    # Configuration information about Amazon Q Apps. (preview feature)
+    # Configuration information about Amazon Q Apps.
     #
     # @!attribute [rw] q_apps_control_mode
     #   Status information about whether end users can create and use Amazon
@@ -6294,6 +6322,18 @@ module Aws::QBusiness
     #   end users of an Amazon Q Business web experience.
     #   @return [Types::IdentityProviderConfiguration]
     #
+    # @!attribute [rw] origins
+    #   Updates the website domain origins that are allowed to embed the
+    #   Amazon Q Business web experience.      The <i>domain origin</i>
+    #   refers to the <i>base URL</i> for accessing a website including the
+    #   protocol (<code>http/https</code>), the domain name, and the port
+    #   number (if specified).</p> <note> <ul> <li> <p>Any values except
+    #   <code>null</code> submitted as part of this update will replace all
+    #   previous values.</p> </li> <li> <p>You must only submit a <i>base
+    #   URL</i> and not a full path. For example,
+    #   <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperienceRequest AWS API Documentation
     #
     class UpdateWebExperienceRequest < Struct.new(
@@ -6305,7 +6345,8 @@ module Aws::QBusiness
       :subtitle,
       :welcome_message,
       :sample_prompts_control_mode,
-      :identity_provider_configuration)
+      :identity_provider_configuration,
+      :origins)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -6340,15 +6381,15 @@ module Aws::QBusiness
       include Aws::Structure
     end
 
-    # Provides information about users and groups associated with a topic
-    # control rule.
+    # Provides information about users and group names associated with a
+    # topic control rule.
     #
     # @!attribute [rw] user_ids
     #   The user ids associated with a topic control rule.
     #   @return [Array<String>]
     #
     # @!attribute [rw] user_groups
-    #   The user groups associated with a topic control rule.
+    #   The user group names associated with a topic control rule.
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UsersAndGroups AWS API Documentation

data/lib/aws-sdk-qbusiness.rb

@@ -11,6 +11,8 @@
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
+Aws::Plugins::GlobalConfiguration.add_identifier(:qbusiness)
+
 # This module provides support for QBusiness. This module is available in the
 # `aws-sdk-qbusiness` gem.
 #
@@ -55,7 +57,7 @@ module Aws::QBusiness
   autoload :AsyncClient, 'aws-sdk-qbusiness/async_client'
   autoload :EventStreams, 'aws-sdk-qbusiness/event_streams'
 
-  GEM_VERSION = '1.17.0'
+  GEM_VERSION = '1.19.0'
 
 end
 

data/sig/client.rbs

@@ -613,6 +613,7 @@ module Aws
                                    ?subtitle: ::String,
                                    ?welcome_message: ::String,
                                    ?sample_prompts_control_mode: ("ENABLED" | "DISABLED"),
+                                   ?origins: Array[::String],
                                    ?role_arn: ::String,
                                    ?tags: Array[
                                      {
@@ -905,6 +906,7 @@ module Aws
         def subtitle: () -> ::String
         def welcome_message: () -> ::String
         def sample_prompts_control_mode: () -> ("ENABLED" | "DISABLED")
+        def origins: () -> ::Array[::String]
         def role_arn: () -> ::String
         def identity_provider_configuration: () -> Types::IdentityProviderConfiguration
         def authentication_configuration: () -> Types::WebExperienceAuthConfiguration
@@ -1512,7 +1514,8 @@ module Aws
                                        secrets_arn: ::String,
                                        secrets_role: ::String
                                      }?
-                                   }
+                                   },
+                                   ?origins: Array[::String]
                                  ) -> _UpdateWebExperienceResponseSuccess
                                | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateWebExperienceResponseSuccess
     end

data/sig/types.rbs

@@ -431,6 +431,7 @@ module Aws::QBusiness
       attr_accessor subtitle: ::String
       attr_accessor welcome_message: ::String
       attr_accessor sample_prompts_control_mode: ("ENABLED" | "DISABLED")
+      attr_accessor origins: ::Array[::String]
       attr_accessor role_arn: ::String
       attr_accessor tags: ::Array[Types::Tag]
       attr_accessor client_token: ::String
@@ -919,6 +920,7 @@ module Aws::QBusiness
       attr_accessor subtitle: ::String
       attr_accessor welcome_message: ::String
       attr_accessor sample_prompts_control_mode: ("ENABLED" | "DISABLED")
+      attr_accessor origins: ::Array[::String]
       attr_accessor role_arn: ::String
       attr_accessor identity_provider_configuration: Types::IdentityProviderConfiguration
       attr_accessor authentication_configuration: Types::WebExperienceAuthConfiguration
@@ -1639,6 +1641,7 @@ module Aws::QBusiness
       attr_accessor welcome_message: ::String
       attr_accessor sample_prompts_control_mode: ("ENABLED" | "DISABLED")
       attr_accessor identity_provider_configuration: Types::IdentityProviderConfiguration
+      attr_accessor origins: ::Array[::String]
       SENSITIVE: []
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-qbusiness
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-23 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core