flow_permissions

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

Overview

Name	flow_permissions
Type	Resource
Id	aws.quicksight.flow_permissions

Fields

The following fields are returned by SELECT queries:

get_flow_permissions

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the flow you are getting permissions against.
flow_id	string	The unique identifier of the flow with permissions. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
permissions	array	A structure that contains the permissions for the flow.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_flow_permissions	select	aws_account_id, flow_id, region		Get permissions for a flow.
update_flow_permissions	update	aws_account_id, flow_id, region		Updates permissions against principals on a flow.

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
aws_account_id	string	The ID of the Amazon Web Services account that contains the flow you are updating permissions against.
flow_id	string	The unique identifier of the flow to update permissions for.
region	string	AWS region (default: us-east-1)

SELECT examples

get_flow_permissions

Get permissions for a flow.

SELECT
arn,
flow_id,
permissions,
request_id,
status
FROM aws.quicksight.flow_permissions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND flow_id = '{{ flow_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_flow_permissions

Updates permissions against principals on a flow.

UPDATE aws.quicksight.flow_permissions
SET 
GrantPermissions = '{{ GrantPermissions }}',
RevokePermissions = '{{ RevokePermissions }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND flow_id = '{{ flow_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
flow_id,
permissions,
request_id,
status;