users_by_permission_groups
Creates, updates, deletes, gets or lists a users_by_permission_groups resource.
Overview
| Name | users_by_permission_groups |
| Type | Resource |
| Id | aws.finspace_data.users_by_permission_groups |
Fields
The following fields are returned by SELECT queries:
- list_users_by_permission_group
| Name | Datatype | Description |
|---|---|---|
next_token | string | A token that indicates where a results page should begin. |
users | array | Lists details of all users in a specific permission group. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_users_by_permission_group | select | permission_group_id, maxResults, region | nextToken | Lists details of all the users in a specific permission 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 |
|---|---|---|
maxResults | integer | The maximum number of results per page. |
permission_group_id | string | The unique identifier for the permission group. |
region | string | AWS region (default: us-east-1) |
nextToken | string | A token that indicates where a results page should begin. |
SELECT examples
- list_users_by_permission_group
Lists details of all the users in a specific permission group.
SELECT
next_token,
users
FROM aws.finspace_data.users_by_permission_groups
WHERE permission_group_id = '{{ permission_group_id }}' -- required
AND maxResults = '{{ maxResults }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
;