web_experiences

Creates, updates, deletes, gets or lists a web_experiences resource.

Overview

Name	`web_experiences`
Type	Resource
Id	`aws.qbusiness.web_experiences`

Fields

The following fields are returned by SELECT queries:

get_web_experience
list_web_experiences

Name	Datatype	Description
`application_id`	`string`	The identifier of the Amazon Q Business application linked to the web experience. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
`authentication_configuration`	`object`	The authentication configuration information for your Amazon Q Business web experience.
`browser_extension_configuration`	`object`	The container for browser extension configuration for an Amazon Q Business web experience.
`created_at`	`string (date-time)`	The Unix timestamp when the Amazon Q Business web experience was last created.
`customization_configuration`	`object`	Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
`default_endpoint`	`string`	The endpoint of your Amazon Q Business web experience. (pattern: <code>(https?\|ftp\|file)://([^\s]*)</code>)
`error`	`object`	Provides information about a Amazon Q Business request error.
`identity_provider_configuration`	`object`	Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
`origins`	`array`	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).
`role_arn`	`string`	The Amazon Resource Name (ARN) of the service role attached to your web experience. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
`sample_prompts_control_mode`	`string`	Determines whether sample prompts are enabled in the web experience for an end user. (ENABLED, DISABLED)
`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. (CREATING, ACTIVE, DELETING, FAILED, PENDING_AUTH_CONFIG)
`subtitle`	`string`	The subtitle for your Amazon Q Business web experience. (pattern: <code>[\s\S]*</code>)
`title_`	`string`	The title for your Amazon Q Business web experience. (pattern: <code>[\s\S]*</code>)
`updated_at`	`string (date-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. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
`web_experience_id`	`string`	The identifier of the Amazon Q Business web experience. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]*</code>)
`welcome_message`	`string`	The customized welcome message for end users of an Amazon Q Business web experience.

Name	Datatype	Description
`created_at`	`string (date-time)`	The Unix timestamp when the Amazon Q Business application was last updated.
`default_endpoint`	`string`	The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services. (pattern: <code>(https?\|ftp\|file)://([^\s]*)</code>)
`status`	`string`	The status of your Amazon Q Business web experience. (CREATING, ACTIVE, DELETING, FAILED, PENDING_AUTH_CONFIG)
`updated_at`	`string (date-time)`	The Unix timestamp when your Amazon Q Business web experience was updated.
`web_experience_id`	`string`	The identifier of your Amazon Q Business web experience. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_web_experience`	`select`	`application_id`, `web_experience_id`, `region`		Gets information about an existing Amazon Q Business web experience.
`list_web_experiences`	`select`	`application_id`, `region`	`nextToken`, `maxResults`	Lists one or more Amazon Q Business Web Experiences.
`create_anonymous_web_experience_url`	`insert`	`application_id`, `web_experience_id`, `region`		Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.
`create_web_experience`	`insert`	`application_id`, `region`		Creates an Amazon Q Business web experience.
`update_web_experience`	`update`	`application_id`, `web_experience_id`, `region`		Updates an Amazon Q Business web experience.
`delete_web_experience`	`delete`	`application_id`, `web_experience_id`, `region`		Deletes an Amazon Q Business web experience.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`application_id`	`string`	The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.
`region`	`string`	AWS region (default: us-east-1)
`web_experience_id`	`string`	The identifier of the Amazon Q Business web experience being deleted.
`maxResults`	`integer`	The maximum number of Amazon Q Business Web Experiences to return.
`nextToken`	`string`	If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.

`SELECT` examples

get_web_experience
list_web_experiences

Gets information about an existing Amazon Q Business web experience.

SELECT
application_id,
authentication_configuration,
browser_extension_configuration,
created_at,
customization_configuration,
default_endpoint,
error,
identity_provider_configuration,
origins,
role_arn,
sample_prompts_control_mode,
status,
subtitle,
title_,
updated_at,
web_experience_arn,
web_experience_id,
welcome_message
FROM aws.qbusiness.web_experiences
WHERE application_id = '{{ application_id }}' -- required
AND web_experience_id = '{{ web_experience_id }}' -- required
AND region = '{{ region }}' -- required
;

Lists one or more Amazon Q Business Web Experiences.

SELECT
created_at,
default_endpoint,
status,
updated_at,
web_experience_id
FROM aws.qbusiness.web_experiences
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

`INSERT` examples

create_anonymous_web_experience_url
create_web_experience
Manifest

Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.

INSERT INTO aws.qbusiness.web_experiences (
sessionDurationInMinutes,
application_id,
web_experience_id,
region
)
SELECT 
{{ sessionDurationInMinutes }},
'{{ application_id }}',
'{{ web_experience_id }}',
'{{ region }}'
RETURNING
anonymous_url
;

Creates an Amazon Q Business web experience.

INSERT INTO aws.qbusiness.web_experiences (
title,
subtitle,
welcomeMessage,
samplePromptsControlMode,
origins,
roleArn,
tags,
clientToken,
identityProviderConfiguration,
browserExtensionConfiguration,
customizationConfiguration,
application_id,
region
)
SELECT 
'{{ title }}',
'{{ subtitle }}',
'{{ welcomeMessage }}',
'{{ samplePromptsControlMode }}',
'{{ origins }}',
'{{ roleArn }}',
'{{ tags }}',
'{{ clientToken }}',
'{{ identityProviderConfiguration }}',
'{{ browserExtensionConfiguration }}',
'{{ customizationConfiguration }}',
'{{ application_id }}',
'{{ region }}'
RETURNING
web_experience_arn,
web_experience_id
;

# Description fields are for documentation purposes
- name: web_experiences
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the web_experiences resource.
  - name: web_experience_id
    value: "{{ web_experience_id }}"
    description: Required parameter for the web_experiences resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the web_experiences resource.
  - name: sessionDurationInMinutes
    value: {{ sessionDurationInMinutes }}
  - name: title
    value: "{{ title }}"
  - name: subtitle
    value: "{{ subtitle }}"
  - name: welcomeMessage
    value: "{{ welcomeMessage }}"
  - name: samplePromptsControlMode
    value: "{{ samplePromptsControlMode }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: origins
    value:
      - "{{ origins }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: identityProviderConfiguration
    description: |
      Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
    value:
      samlConfiguration:
        authenticationUrl: "{{ authenticationUrl }}"
      openIDConnectConfiguration:
        secretsArn: "{{ secretsArn }}"
        secretsRole: "{{ secretsRole }}"
  - name: browserExtensionConfiguration
    description: |
      The container for browser extension configuration for an Amazon Q Business web experience.
    value:
      enabledBrowserExtensions:
        - "{{ enabledBrowserExtensions }}"
  - name: customizationConfiguration
    description: |
      Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
    value:
      customCSSUrl: "{{ customCSSUrl }}"
      logoUrl: "{{ logoUrl }}"
      fontUrl: "{{ fontUrl }}"
      faviconUrl: "{{ faviconUrl }}"

`UPDATE` examples

update_web_experience

Updates an Amazon Q Business web experience.

UPDATE aws.qbusiness.web_experiences
SET 
roleArn = '{{ roleArn }}',
authenticationConfiguration = '{{ authenticationConfiguration }}',
title = '{{ title }}',
subtitle = '{{ subtitle }}',
welcomeMessage = '{{ welcomeMessage }}',
samplePromptsControlMode = '{{ samplePromptsControlMode }}',
identityProviderConfiguration = '{{ identityProviderConfiguration }}',
origins = '{{ origins }}',
browserExtensionConfiguration = '{{ browserExtensionConfiguration }}',
customizationConfiguration = '{{ customizationConfiguration }}'
WHERE 
application_id = '{{ application_id }}' --required
AND web_experience_id = '{{ web_experience_id }}' --required
AND region = '{{ region }}' --required;

`DELETE` examples

delete_web_experience

Deletes an Amazon Q Business web experience.

DELETE FROM aws.qbusiness.web_experiences
WHERE application_id = '{{ application_id }}' --required
AND web_experience_id = '{{ web_experience_id }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​