farm_members

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

Overview

Name	farm_members
Type	Resource
Id	aws.deadline.farm_members

Fields

The following fields are returned by SELECT queries:

list_farm_members

Name	Datatype	Description
farm_id	string	The farm ID of the farm member. (pattern: <code>farm-[0-9a-f]{32}</code>)
identity_store_id	string	The identity store ID of the farm member. (pattern: <code>d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
membership_level	string	The farm member's membership level. (VIEWER, CONTRIBUTOR, OWNER, MANAGER)
principal_id	string	The principal ID of the farm member. (pattern: <code>([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}</code>)
principal_type	string	The principal type of the farm member. (USER, GROUP)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_farm_members	select	farm_id, region	nextToken, maxResults	Lists the members of a farm.

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
farm_id	string	The farm ID.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.

SELECT examples

list_farm_members

Lists the members of a farm.

SELECT
farm_id,
identity_store_id,
membership_level,
principal_id,
principal_type
FROM aws.deadline.farm_members
WHERE farm_id = '{{ farm_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;