job_members
Creates, updates, deletes, gets or lists a job_members resource.
Overview
| Name | job_members |
| Type | Resource |
| Id | aws.deadline.job_members |
Fields
The following fields are returned by SELECT queries:
- list_job_members
| Name | Datatype | Description |
|---|---|---|
farm_id | string | The farm ID. (pattern: <code>farm-[0-9a-f]{32}</code>) |
identity_store_id | string | The 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>) |
job_id | string | The job ID. (pattern: <code>job-[0-9a-f]{32}</code>) |
membership_level | string | The job member's membership level. (VIEWER, CONTRIBUTOR, OWNER, MANAGER) |
principal_id | string | The principal ID of the job 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 job member. (USER, GROUP) |
queue_id | string | The queue ID. (pattern: <code>queue-[0-9a-f]{32}</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_job_members | select | farm_id, queue_id, job_id, region | nextToken, maxResults | Lists members on a job. |
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 of the job to list. |
job_id | string | The job ID to include on the list. |
queue_id | string | The queue ID to include on the list. |
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_job_members
Lists members on a job.
SELECT
farm_id,
identity_store_id,
job_id,
membership_level,
principal_id,
principal_type,
queue_id
FROM aws.deadline.job_members
WHERE farm_id = '{{ farm_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;