group_members

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

Overview

Name	group_members
Type	Resource
Id	aws.workmail.group_members

Fields

The following fields are returned by SELECT queries:

list_group_members

Name	Datatype	Description
disabled_date	string (date-time)	The date indicating when the member was disabled from WorkMail use.
enabled_date	string (date-time)	The date indicating when the member was enabled for WorkMail use.
id	string	The identifier of the member.
name	string	The name of the member.
state	string	The state of the member, which can be ENABLED, DISABLED, or DELETED. (ENABLED, DISABLED, DELETED)
type	string	A member can be a user or group. (GROUP, USER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_group_members	select	region		Returns an overview of the members of a group. Users and groups can be members of a 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
region	string	AWS region (default: us-east-1)

SELECT examples

list_group_members

Returns an overview of the members of a group. Users and groups can be members of a group.

SELECT
disabled_date,
enabled_date,
id,
name,
state,
type
FROM aws.workmail.group_members
WHERE region = '{{ region }}' -- required
;