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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The identifier of the Amazon Q Business web experience.

• #browser_extension_configuration ⇒ Types::BrowserExtensionConfiguration

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

• #client_token ⇒ String

  A token you provide to identify a request to create an Amazon Q Business web experience.

• #customization_configuration ⇒ Types::CustomizationConfiguration

  Sets 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>

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

Returns:

• (String)

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

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :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.

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

Returns:

• (Types::BrowserExtensionConfiguration)

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

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :browser_extension_configuration,
  :customization_configuration)
  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.

Returns:

• (String)

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

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#customization_configuration ⇒ Types::CustomizationConfiguration

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

Returns:

• (Types::CustomizationConfiguration)

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

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :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 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2769

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#origins ⇒ Array<String>

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

You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

Returns:

• (Array<String>)

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

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :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.

The roleArn parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.

Returns:

• (String)

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

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :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 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2769

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#subtitle ⇒ String

A subtitle to personalize your Amazon Q Business web experience.

Returns:

• (String)

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

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :browser_extension_configuration,
  :customization_configuration)
  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: _ . : / = + - @.

Returns:

• (Array<Types::Tag>)

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

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title for your Amazon Q Business web experience.

Returns:

• (String)

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

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :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)

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

class CreateWebExperienceRequest < Struct.new(
  :application_id,
  :title,
  :subtitle,
  :welcome_message,
  :sample_prompts_control_mode,
  :origins,
  :role_arn,
  :tags,
  :client_token,
  :identity_provider_configuration,
  :browser_extension_configuration,
  :customization_configuration)
  SENSITIVE = []
  include Aws::Structure
end