groups_for_entities
Creates, updates, deletes, gets or lists a groups_for_entities resource.
Overview
| Name | groups_for_entities |
| Type | Resource |
| Id | aws.workmail.groups_for_entities |
Fields
The following fields are returned by SELECT queries:
- list_groups_for_entity
| Name | Datatype | Description |
|---|---|---|
groups | array | The overview of groups in an organization. |
next_token | string | The token to use to retrieve the next page of results. This value is null when there are no more results to return. (pattern: <code>[\S\s]*|[a-zA-Z0-9/+=]{1,1024}</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_groups_for_entity | select | region | Returns all the groups to which an entity belongs. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_groups_for_entity
Returns all the groups to which an entity belongs.
SELECT
groups,
next_token
FROM aws.workmail.groups_for_entities
WHERE region = '{{ region }}' -- required
;