agent_permissions

Creates, updates, deletes, gets or lists an agent_permissions resource.

Overview

Name	agent_permissions
Type	Resource
Id	aws.quicksight.agent_permissions

Fields

The following fields are returned by SELECT queries:

describe_agent_permissions

Name	Datatype	Description
agent_id	string	The unique identifier for the agent. (pattern: <code>[0-9a-zA-Z-_.+]+</code>)
arn	string	The Amazon Resource Name (ARN) of the agent. (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>)
permissions	array	The resource permissions for the agent.
request_id	string	The Amazon Web Services request ID for this operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_agent_permissions	select	agent_id, aws_account_id, region		Describes the resource permissions for an agent.
update_agent_permissions	update	agent_id, aws_account_id, region		Updates the resource permissions for an agent.

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
agent_id	string	The unique identifier for the agent.
aws_account_id	string	The ID of the Amazon Web Services account that contains the agent.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_agent_permissions

Describes the resource permissions for an agent.

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

UPDATE examples

update_agent_permissions

Updates the resource permissions for an agent.

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