groups

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

Overview

Name	groups
Type	Resource
Id	aws.workdocs.groups

Fields

The following fields are returned by SELECT queries:

describe_groups

Name	Datatype	Description
id	string	The ID of the user group. (pattern: <code>[&\w+-.@]+</code>)
name	string	The name of the group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_groups	select	searchQuery, region	Authentication, organizationId, marker, limit	Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

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)
searchQuery	string	A query to describe groups by group name.
Authentication	string	Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
limit	integer	The maximum number of items to return with this call.
marker	string	The marker for the next set of results. (You received this marker from a previous call.)
organizationId	string	The ID of the organization.

SELECT examples

describe_groups

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

SELECT
id,
name
FROM aws.workdocs.groups
WHERE searchQuery = '{{ searchQuery }}' -- required
AND region = '{{ region }}' -- required
AND Authentication = '{{ Authentication }}'
AND organizationId = '{{ organizationId }}'
AND marker = '{{ marker }}'
AND limit = '{{ limit }}'
;