Class: Aws::QBusiness::Types::GetWebExperienceResponse

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 linked to the web experience.

Returns:

  • (String) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_configuration ⇒ Types::WebExperienceAuthConfiguration

The authentication configuration information for your Amazon Q Business web experience.

Returns:



5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :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.

Returns:



5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The Unix timestamp when the Amazon Q Business web experience was last created.

Returns:

  • (Time) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#customization_configuration ⇒ Types::CustomizationConfiguration

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

Returns:



5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#default_endpoint ⇒ String

The endpoint of your Amazon Q Business web experience.

Returns:

  • (String) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  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.

Returns:



5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :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:



5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#origins ⇒ Array<String>

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

Returns:

  • (Array<String>) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the service role attached to your web experience.

Returns:

  • (String) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :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) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  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.

Returns:

  • (String) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#subtitle ⇒ String

The subtitle for your Amazon Q Business web experience.

Returns:

  • (String) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title for your Amazon Q Business web experience.

Returns:

  • (String) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The Unix timestamp when the Amazon Q Business web experience was last updated.

Returns:

  • (Time) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  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.

Returns:

  • (String) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :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) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#welcome_message ⇒ String

The customized welcome message for end users of an Amazon Q Business web experience.

Returns:

  • (String) 


5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5410

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,
  :origins,
  :role_arn,
  :identity_provider_configuration,
  :authentication_configuration,
  :error,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end