user_groups

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

Overview

Name	user_groups
Type	Resource
Id	aws.quicksight.user_groups

Fields

The following fields are returned by SELECT queries:

list_user_groups

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the group.
description	string	The group description.
group_name	string	The name of the group. (pattern: <code>[\u0020-\u00FF]+</code>)
principal_id	string	The principal ID of the group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_user_groups	select	user_name, aws_account_id, namespace, region	next-token, max-results	Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.

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 Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
namespace	string	The namespace. Currently, you should set this to default.
region	string	AWS region (default: us-east-1)
user_name	string	The Amazon Quick Sight user name that you want to list group memberships for.
max-results	integer	The maximum number of results to return from this request.
next-token	string	A pagination token that can be used in a subsequent request.

SELECT examples

list_user_groups

Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.

SELECT
arn,
description,
group_name,
principal_id
FROM aws.quicksight.user_groups
WHERE user_name = '{{ user_name }}' -- required
AND aws_account_id = '{{ aws_account_id }}' -- required
AND namespace = '{{ namespace }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;