group_memberships

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

Overview

Name	group_memberships
Type	Resource
Id	aws.quicksight.group_memberships

Fields

The following fields are returned by SELECT queries:

describe_group_membership

Name	Datatype	Description
group_member	object	A member of an Quick Sight group. Currently, group members must be users. Groups can't be members of another group. .
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

list_group_memberships

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the group member (user).
member_name	string	The name of the group member (user). (pattern: <code>[\u0020-\u00FF]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_group_membership	select	member_name, group_name, aws_account_id, namespace, region		Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.
list_group_memberships	select	group_name, aws_account_id, namespace, region	next-token, max-results	Lists member users in a group.
create_group_membership	insert	member_name, group_name, aws_account_id, namespace, region		Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
delete_group_membership	delete	member_name, group_name, aws_account_id, namespace, region		Removes a user from a group so that the user is no longer a member of the group.

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 the user from.
member_name	string	The name of the user that you want to delete from the group membership.
namespace	string	The namespace of the group that you want to remove a user from.
region	string	AWS region (default: us-east-1)
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

describe_group_membership

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

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

list_group_memberships

Lists member users in a group.

SELECT
arn,
member_name
FROM aws.quicksight.group_memberships
WHERE group_name = '{{ group_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 }}'
;

INSERT examples

create_group_membership

Adds an Amazon Quick Sight user to an Amazon Quick Sight group.

INSERT INTO aws.quicksight.group_memberships (
member_name,
group_name,
aws_account_id,
namespace,
region
)
SELECT 
'{{ member_name }}',
'{{ group_name }}',
'{{ aws_account_id }}',
'{{ namespace }}',
'{{ region }}'
RETURNING
group_member,
request_id,
status
;

Manifest

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

DELETE examples

delete_group_membership

Removes a user from a group so that the user is no longer a member of the group.

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