Class: Aws::QBusiness::Types::CreateWebExperienceRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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 web experience.

Returns:

  • (String) 


2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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.

<note markdown=“1”> 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.].

</note>

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html

Returns:



2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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) 


2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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:



2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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:



2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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). </p> <note> <p>You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.</p> </note>

Returns:

  • (Array<String>) 


2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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.

<note markdown=“1”> You must provide this value if you’re using IAM Identity Center to manage end user access to your application. If you’re using legacy identity management to manage user access, you don’t need to provide this value.

</note>

Returns:

  • (String) 


2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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) 


2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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) 


2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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:



2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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) 


2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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) 


2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2239

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