q_app_permissions

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

Overview

Name	q_app_permissions
Type	Resource
Id	aws.qapps.q_app_permissions

Fields

The following fields are returned by SELECT queries:

describe_q_app_permissions

Name	Datatype	Description
app_id	string	The unique identifier of the Amazon Q App for which permissions are returned.
permissions	array	The list of permissions granted for the Amazon Q App.
resource_arn	string	The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_q_app_permissions	select	instance-id, appId, region		Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
update_q_app_permissions	update	instance-id, region, appId		Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.

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

SELECT examples

describe_q_app_permissions

Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.

SELECT
app_id,
permissions,
resource_arn
FROM aws.qapps.q_app_permissions
WHERE `instance-id` = '{{ instance-id }}' -- required
AND appId = '{{ appId }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_q_app_permissions

Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.

UPDATE aws.qapps.q_app_permissions
SET 
appId = '{{ appId }}',
grantPermissions = '{{ grantPermissions }}',
revokePermissions = '{{ revokePermissions }}'
WHERE 
`instance-id` = '{{ instance-id }}' --required
AND region = '{{ region }}' --required
AND appId = '{{ appId }}' --required
RETURNING
app_id,
permissions,
resource_arn;