Skip to main content

fleet_members

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

Overview

Namefleet_members
TypeResource
Idaws.deadline.fleet_members

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
farm_idstringThe farm ID. (pattern: <code>farm-[0-9a-f]{32}</code>)
fleet_idstringThe fleet ID. (pattern: <code>fleet-[0-9a-f]{32}</code>)
identity_store_idstringThe identity store ID. (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_levelstringThe fleet member's membership level. (VIEWER, CONTRIBUTOR, OWNER, MANAGER)
principal_idstringThe principal ID of the fleet 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_typestringThe principal type of the fleet member. (USER, GROUP)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_fleet_membersselectfarm_id, fleet_id, regionnextToken, maxResultsLists fleet members.

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.

NameDatatypeDescription
farm_idstringThe farm ID of the fleet.
fleet_idstringThe fleet ID to include on the list.
regionstringAWS region (default: us-east-1)
maxResultsintegerThe maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextTokenstringThe token for the next set of results, or null to start from the beginning.

SELECT examples

Lists fleet members.

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