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

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::UpdateWebExperienceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

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

• #authentication_configuration ⇒ Types::WebExperienceAuthConfiguration

  The authentication configuration of the Amazon Q Business web experience.

• #browser_extension_configuration ⇒ Types::BrowserExtensionConfiguration

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

• #customization_configuration ⇒ Types::CustomizationConfiguration

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

• #identity_provider_configuration ⇒ Types::IdentityProviderConfiguration

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

• #origins ⇒ Array<String>

  Updates the website domain origins that are allowed to embed the Amazon Q Business web experience.

• #role_arn ⇒ String

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

• #sample_prompts_control_mode ⇒ String

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

• #subtitle ⇒ String

  The subtitle of the Amazon Q Business web experience.

• #title ⇒ String

  The title of the Amazon Q Business web experience.

• #web_experience_id ⇒ String

  The identifier of the Amazon Q Business web experience.

• #welcome_message ⇒ String

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

Instance Attribute Details

#application_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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:

• (Types::WebExperienceAuthConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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.

<note markdown=“1”> 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.].

</note>

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html

Returns:

• (Types::BrowserExtensionConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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:

• (Types::CustomizationConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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:

• (Types::IdentityProviderConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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).

<note markdown=“1”> * 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, ‘docs.aws.amazon.com`.

</note>

Returns:

• (Array<String>)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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)

# File 'lib/aws-sdk-qbusiness/types.rb', line 9284

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