Class: Aws::QBusiness::Types::CreateWebExperienceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::QBusiness::Types::CreateWebExperienceRequest
- Defined in:
- gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#application_id ⇒ String
The identifier of the Amazon Q Business web experience.
-
#client_token ⇒ String
A token you provide to identify a request to create an Amazon Q Business web experience.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the service role attached to your web experience.
-
#sample_prompts_control_mode ⇒ String
Determines whether sample prompts are enabled in the web experience for an end user.
-
#subtitle ⇒ String
A subtitle to personalize your Amazon Q Business web experience.
-
#tags ⇒ Array<Types::Tag>
A list of key-value pairs that identify or categorize your Amazon Q Business web experience.
-
#title ⇒ String
The title for your Amazon Q Business web experience.
-
#welcome_message ⇒ String
The customized welcome message for end users of an Amazon Q Business web experience.
Instance Attribute Details
#application_id ⇒ String
The identifier of the Amazon Q Business web experience.
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1715 class CreateWebExperienceRequest < Struct.new( :application_id, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |
#client_token ⇒ String
A token you provide to identify a request to create an Amazon Q Business web experience.
A suitable default value is auto-generated. You should normally not need to pass this option.
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1715 class CreateWebExperienceRequest < Struct.new( :application_id, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the service role attached to your web experience.
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1715 class CreateWebExperienceRequest < Struct.new( :application_id, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |
#sample_prompts_control_mode ⇒ String
Determines whether sample prompts are enabled in the web experience for an end user.
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1715 class CreateWebExperienceRequest < Struct.new( :application_id, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |
#subtitle ⇒ String
A subtitle to personalize your Amazon Q Business web experience.
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1715 class CreateWebExperienceRequest < Struct.new( :application_id, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1715 class CreateWebExperienceRequest < Struct.new( :application_id, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |
#title ⇒ String
The title for your Amazon Q Business web experience.
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1715 class CreateWebExperienceRequest < Struct.new( :application_id, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |
#welcome_message ⇒ String
The customized welcome message for end users of an Amazon Q Business web experience.
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1715 class CreateWebExperienceRequest < Struct.new( :application_id, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :tags, :client_token) SENSITIVE = [] include Aws::Structure end |