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) 


6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6030

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

#authentication_configuration ⇒ Types::WebExperienceAuthConfiguration

The authentication configuration of the Amazon Q Business web experience.

Returns:



6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6030

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode)
  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) 


6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6030

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode)
  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) 


6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6030

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

#subtitle ⇒ String

The subtitle of the Amazon Q Business web experience.

Returns:

  • (String) 


6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6030

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

#title ⇒ String

The title of the Amazon Q Business web experience.

Returns:

  • (String) 


6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6030

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

#web_experience_id ⇒ String

The identifier of the Amazon Q Business web experience.

Returns:

  • (String) 


6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6030

class UpdateWebExperienceRequest < Struct.new(
  :application_id,
  :web_experience_id,
  :role_arn,
  :authentication_configuration,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode)
  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) 


6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6030

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