Class: Aws::QBusiness::Types::GetWebExperienceResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::QBusiness::Types::GetWebExperienceResponse
- 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 application linked to the web experience.
-
#authentication_configuration ⇒ Types::WebExperienceAuthConfiguration
The authentication configuration information for your Amazon Q Business web experience.
-
#created_at ⇒ Time
The Unix timestamp when the Amazon Q Business web experience was last created.
-
#default_endpoint ⇒ String
The endpoint of your Amazon Q Business web experience.
-
#error ⇒ Types::ErrorDetail
When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail. -
#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.
-
#status ⇒ String
The current status of the Amazon Q Business web experience.
-
#subtitle ⇒ String
The subtitle for your Amazon Q Business web experience.
-
#title ⇒ String
The title for your Amazon Q Business web experience.
-
#updated_at ⇒ Time
The Unix timestamp when the Amazon Q Business web experience was last updated.
-
#web_experience_arn ⇒ String
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
-
#web_experience_id ⇒ String
The identifier of the 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 application linked to the web experience.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#authentication_configuration ⇒ Types::WebExperienceAuthConfiguration
The authentication configuration information for your Amazon Q Business web experience.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#created_at ⇒ Time
The Unix timestamp when the Amazon Q Business web experience was last created.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#default_endpoint ⇒ String
The endpoint of your Amazon Q Business web experience.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#error ⇒ Types::ErrorDetail
When the Status
field value is FAILED
, the ErrorMessage
field
contains a description of the error that caused the data source
connector to fail.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the service role attached to your web experience.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#sample_prompts_control_mode ⇒ String
Determines whether sample prompts are enabled in the web experience for an end user.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The current status of the Amazon Q Business web experience. When the
Status
field value is FAILED
, the ErrorMessage
field contains
a description of the error that caused the data source connector to
fail.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#subtitle ⇒ String
The subtitle for your Amazon Q Business web experience.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#title ⇒ String
The title for your Amazon Q Business web experience.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#updated_at ⇒ Time
The Unix timestamp when the Amazon Q Business web experience was last updated.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#web_experience_arn ⇒ String
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#web_experience_id ⇒ String
The identifier of the Amazon Q Business web experience.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |
#welcome_message ⇒ String
The customized welcome message for end users of an Amazon Q Business web experience.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3530 class GetWebExperienceResponse < Struct.new( :application_id, :web_experience_id, :web_experience_arn, :default_endpoint, :status, :created_at, :updated_at, :title, :subtitle, :welcome_message, :sample_prompts_control_mode, :role_arn, :authentication_configuration, :error) SENSITIVE = [] include Aws::Structure end |