web_experiences

Creates, updates, deletes or gets a web_experience resource or lists web_experiences in a region

Overview

Name	web_experiences
Type	Resource
Description	Definition of AWS::QBusiness::WebExperience Resource Type
Id	aws.qbusiness.web_experiences

Fields

Name	Datatype	Description
application_id	string
created_at	string
default_endpoint	string
role_arn	string
sample_prompts_control_mode	string
status	string
subtitle	string
tags	array
title	string
updated_at	string
web_experience_arn	string
web_experience_id	string
welcome_message	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ApplicationId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all web_experiences in a region.

SELECT
region,
application_id,
created_at,
default_endpoint,
role_arn,
sample_prompts_control_mode,
status,
subtitle,
tags,
title,
updated_at,
web_experience_arn,
web_experience_id,
welcome_message
FROM aws.qbusiness.web_experiences
WHERE region = 'us-east-1';

Gets all properties from an individual web_experience.

SELECT
region,
application_id,
created_at,
default_endpoint,
role_arn,
sample_prompts_control_mode,
status,
subtitle,
tags,
title,
updated_at,
web_experience_arn,
web_experience_id,
welcome_message
FROM aws.qbusiness.web_experiences
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationId>|<WebExperienceId>';

INSERT example

Use the following StackQL query and manifest file to create a new web_experience resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.qbusiness.web_experiences (
 ApplicationId,
 region
)
SELECT 
'{{ ApplicationId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.qbusiness.web_experiences (
 ApplicationId,
 RoleArn,
 SamplePromptsControlMode,
 Subtitle,
 Tags,
 Title,
 WelcomeMessage,
 region
)
SELECT 
 '{{ ApplicationId }}',
 '{{ RoleArn }}',
 '{{ SamplePromptsControlMode }}',
 '{{ Subtitle }}',
 '{{ Tags }}',
 '{{ Title }}',
 '{{ WelcomeMessage }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: web_experience
    props:
      - name: ApplicationId
        value: '{{ ApplicationId }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: SamplePromptsControlMode
        value: '{{ SamplePromptsControlMode }}'
      - name: Subtitle
        value: '{{ Subtitle }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Title
        value: '{{ Title }}'
      - name: WelcomeMessage
        value: '{{ WelcomeMessage }}'

DELETE example

/*+ delete */
DELETE FROM aws.qbusiness.web_experiences
WHERE data__Identifier = '<ApplicationId|WebExperienceId>'
AND region = 'us-east-1';

Permissions

To operate on the web_experiences resource, the following permissions are required:

Create

iam:PassRole,
qbusiness:CreateWebExperience,
qbusiness:GetWebExperience,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
sso:PutApplicationGrant,
sso:UpdateApplication

Read

qbusiness:GetWebExperience,
qbusiness:ListTagsForResource

Update

iam:PassRole,
qbusiness:GetWebExperience,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UntagResource,
qbusiness:UpdateWebExperience,
sso:PutApplicationGrant,
sso:UpdateApplication

Delete

qbusiness:DeleteWebExperience,
qbusiness:GetWebExperience

List

qbusiness:ListWebExperiences