q_app_session_metadatas

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

Overview

Name	q_app_session_metadatas
Type	Resource
Id	aws.qapps.q_app_session_metadatas

Fields

The following fields are returned by SELECT queries:

get_q_app_session_metadata

Name	Datatype	Description
session_arn	string	The Amazon Resource Name (ARN) of the Q App session.
session_id	string	The unique identifier of the Q App session. (pattern: <code>[\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}</code>)
session_name	string	The name of the Q App session.
session_owner	boolean	Indicates whether the current user is the owner of the Q App session.
sharing_configuration	object	The sharing configuration of the Q App data collection session.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_q_app_session_metadata	select	instance-id, sessionId, region		Retrieves the current configuration of a Q App session.
update_q_app_session_metadata	update	instance-id, region, sessionId, sharingConfiguration		Updates the configuration metadata of a session for a given Q App sessionId.

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
instance-id	string	The unique identifier of the Amazon Q Business application environment instance.
region	string	AWS region (default: us-east-1)
sessionId	string	The unique identifier of the Q App session.

SELECT examples

get_q_app_session_metadata

Retrieves the current configuration of a Q App session.

SELECT
session_arn,
session_id,
session_name,
session_owner,
sharing_configuration
FROM aws.qapps.q_app_session_metadatas
WHERE `instance-id` = '{{ instance-id }}' -- required
AND sessionId = '{{ sessionId }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_q_app_session_metadata

Updates the configuration metadata of a session for a given Q App sessionId.

UPDATE aws.qapps.q_app_session_metadatas
SET 
sessionId = '{{ sessionId }}',
sessionName = '{{ sessionName }}',
sharingConfiguration = '{{ sharingConfiguration }}'
WHERE 
`instance-id` = '{{ instance-id }}' --required
AND region = '{{ region }}' --required
AND sessionId = '{{ sessionId }}' --required
AND sharingConfiguration = '{{ sharingConfiguration }}' --required
RETURNING
session_arn,
session_id,
session_name,
sharing_configuration;