step_consumers

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

Overview

Name	step_consumers
Type	Resource
Id	aws.deadline.step_consumers

Fields

The following fields are returned by SELECT queries:

list_step_consumers

Name	Datatype	Description
status	string	The step consumer status. (RESOLVED, UNRESOLVED)
step_id	string	The step ID. (pattern: <code>step-[0-9a-f]{32}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_step_consumers	select	farm_id, queue_id, job_id, step_id, region	nextToken, maxResults	Lists step consumers.

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 for the list of step consumers.
job_id	string	The job ID for the step consumer.
queue_id	string	The queue ID for the step consumer.
region	string	AWS region (default: us-east-1)
step_id	string	The step ID to include on the list.
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_step_consumers

Lists step consumers.

SELECT
status,
step_id
FROM aws.deadline.step_consumers
WHERE farm_id = '{{ farm_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND job_id = '{{ job_id }}' -- required
AND step_id = '{{ step_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;