groups

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

Overview

Name	groups
Type	Resource
Id	aws.quicksight.groups

Fields

The following fields are returned by SELECT queries:

describe_group

Name	Datatype	Description
group	object	A group in Quick Sight consists of a set of users. You can use groups to make it easier to manage access and security.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

search_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.

list_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
describe_group	select	group_name, aws_account_id, namespace, region		Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).
search_groups	select	aws_account_id, namespace, region	next-token, max-results	Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.
list_groups	select	aws_account_id, namespace, region	next-token, max-results	Lists all user groups in Amazon Quick Sight.
create_group	insert	aws_account_id, namespace, region, GroupName		Use the CreateGroup operation to create a group in Quick Sight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support. The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object.
update_group	update	group_name, aws_account_id, namespace, region		Changes a group description.
delete_group	delete	group_name, aws_account_id, namespace, region		Removes a user group from Amazon Quick Sight.

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

SELECT examples

describe_group

Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).

SELECT
group,
request_id,
status
FROM aws.quicksight.groups
WHERE group_name = '{{ group_name }}' -- required
AND aws_account_id = '{{ aws_account_id }}' -- required
AND namespace = '{{ namespace }}' -- required
AND region = '{{ region }}' -- required
;

search_groups

Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.

SELECT
arn,
description,
group_name,
principal_id
FROM aws.quicksight.groups
WHERE 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 }}'
;

list_groups

Lists all user groups in Amazon Quick Sight.

SELECT
arn,
description,
group_name,
principal_id
FROM aws.quicksight.groups
WHERE 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 }}'
;

INSERT examples

create_group

Use the CreateGroup operation to create a group in Quick Sight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support. The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object.

INSERT INTO aws.quicksight.groups (
GroupName,
Description,
aws_account_id,
namespace,
region
)
SELECT 
'{{ GroupName }}' /* required */,
'{{ Description }}',
'{{ aws_account_id }}',
'{{ namespace }}',
'{{ region }}'
RETURNING
group,
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: groups
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the groups resource.
  - name: namespace
    value: "{{ namespace }}"
    description: Required parameter for the groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the groups resource.
  - name: GroupName
    value: "{{ GroupName }}"
  - name: Description
    value: "{{ Description }}"

UPDATE examples

update_group

Changes a group description.

UPDATE aws.quicksight.groups
SET 
Description = '{{ Description }}'
WHERE 
group_name = '{{ group_name }}' --required
AND aws_account_id = '{{ aws_account_id }}' --required
AND namespace = '{{ namespace }}' --required
AND region = '{{ region }}' --required
RETURNING
group,
request_id,
status;

DELETE examples

delete_group

Removes a user group from Amazon Quick Sight.

DELETE FROM aws.quicksight.groups
WHERE group_name = '{{ group_name }}' --required
AND aws_account_id = '{{ aws_account_id }}' --required
AND namespace = '{{ namespace }}' --required
AND region = '{{ region }}' --required
;