entities

Creates, updates, deletes, gets or lists an entities resource.

Overview

Name	entities
Type	Resource
Id	aws.workmail.entities

Fields

The following fields are returned by SELECT queries:

describe_entity

Name	Datatype	Description
entity_id	string	The entity ID under which the entity exists.
name	string	Username, GroupName, or ResourceName based on entity type.
type	string	Entity type. (GROUP, USER, RESOURCE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_entity	select	region		Returns basic details about an entity in WorkMail.

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

describe_entity

Returns basic details about an entity in WorkMail.

SELECT
entity_id,
name,
type
FROM aws.workmail.entities
WHERE region = '{{ region }}' -- required
;