Class: Aws::QBusiness::Types::UpdateWebExperienceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The identifier of the Amazon Q Business application attached to the web experience.

Returns:

  • (String) 


9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_configuration ⇒ Types::WebExperienceAuthConfiguration

The authentication configuration of the Amazon Q Business web experience.

Returns:



9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#browser_extension_configuration ⇒ Types::BrowserExtensionConfiguration

The browser extension configuration for an Amazon Q Business web experience.

For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

Returns:



9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#customization_configuration ⇒ Types::CustomizationConfiguration

Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.

Returns:



9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#identity_provider_configuration ⇒ Types::IdentityProviderConfiguration

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Returns:



9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#origins ⇒ Array<String>

Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

* Any values except null submitted as part of this update will replace all previous values.

  • You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

Returns:

  • (Array<String>) 


9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.

Returns:

  • (String) 


9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sample_prompts_control_mode ⇒ String

Determines whether sample prompts are enabled in the web experience for an end user.

Returns:

  • (String) 


9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#subtitle ⇒ String

The subtitle of the Amazon Q Business web experience.

Returns:

  • (String) 


9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the Amazon Q Business web experience.

Returns:

  • (String) 


9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#web_experience_id ⇒ String

The identifier of the Amazon Q Business web experience.

Returns:

  • (String) 


9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#welcome_message ⇒ String

A customized welcome message for an end user in an Amazon Q Business web experience.

Returns:

  • (String) 


9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 9271

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :identity_provider_configuration,
  :origins,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end