steps

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

Overview

Name	steps
Type	Resource
Id	aws.deadline.steps

Fields

The following fields are returned by SELECT queries:

get_step

Name	Datatype	Description
name	string	The name of the step.
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
dependency_counts	object	The number of dependencies in the step.
description	string	The description of the step. This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
ended_at	string (date-time)	The date and time the resource ended running.
lifecycle_status	string	The life cycle status of the step. (CREATE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_SUCCEEDED)
lifecycle_status_message	string	A message that describes the lifecycle status of the step.
parameter_space	object	A list of step parameters and the combination expression for the step.
required_capabilities	object	The required capabilities of the step.
started_at	string (date-time)	The date and time the resource started running.
step_id	string	The step ID. (pattern: <code>step-[0-9a-f]{32}</code>)
target_task_run_status	string	The task status with which the job started. (READY, FAILED, SUCCEEDED, CANCELED, SUSPENDED, PENDING)
task_failure_retry_count	integer	The total number of times tasks from the step failed and were retried.
task_run_status	string	The task run status for the job. (PENDING, READY, ASSIGNED, STARTING, SCHEDULED, INTERRUPTING, RUNNING, SUSPENDED, CANCELED, FAILED, SUCCEEDED, NOT_COMPATIBLE)
task_run_status_counts	object	The number of tasks running on the job.
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.

list_steps

Name	Datatype	Description
name	string	The name of the step.
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
dependency_counts	object	The number of dependencies for the step.
ended_at	string (date-time)	The date and time the resource ended running.
lifecycle_status	string	The life cycle status. (CREATE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_SUCCEEDED)
lifecycle_status_message	string	A message that describes the lifecycle of the step.
started_at	string (date-time)	The date and time the resource started running.
step_id	string	The step ID. (pattern: <code>step-[0-9a-f]{32}</code>)
target_task_run_status	string	The task status to update the job's tasks to. (READY, FAILED, SUCCEEDED, CANCELED, SUSPENDED, PENDING)
task_failure_retry_count	integer	The total number of times tasks from the step failed and were retried.
task_run_status	string	The task run status for the job. PENDING–pending and waiting for resources. READY–ready to process. ASSIGNED–assigned and will run next on a worker. SCHEDULED–scheduled to run on a worker. INTERRUPTING–being interrupted. RUNNING–running on a worker. SUSPENDED–the task is suspended. CANCELED–the task has been canceled. FAILED–the task has failed. SUCCEEDED–the task has succeeded. (PENDING, READY, ASSIGNED, STARTING, SCHEDULED, INTERRUPTING, RUNNING, SUSPENDED, CANCELED, FAILED, SUCCEEDED, NOT_COMPATIBLE)
task_run_status_counts	object	The number of tasks running on the job.
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.

search_steps

Name	Datatype	Description
next_item_offset	integer	The next item offset for the search results.
steps	array	The steps in the search.
total_results	integer	The total number of results in the search.

batch_get_step

Name	Datatype	Description
errors	array	A list of errors for steps that could not be retrieved.
steps	array	A list of steps that were successfully retrieved.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_step	select	farm_id, queue_id, job_id, step_id, region		Gets a step.
list_steps	select	farm_id, queue_id, job_id, region	nextToken, maxResults	Lists steps for a job.
search_steps	select	farm_id, region		Searches for steps.
batch_get_step	select	region		Retrieves multiple steps in a single request. This is a batch version of the GetStep API. The result of getting each step is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
update_step	update	farm_id, queue_id, job_id, step_id, region, targetTaskRunStatus	X-Amz-Client-Token	Updates a step.

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 to update.
job_id	string	The job ID to update.
queue_id	string	The queue ID to update.
region	string	AWS region (default: us-east-1)
step_id	string	The step ID to update.
X-Amz-Client-Token	string	The unique token which the server uses to recognize retries of the same request.
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

get_step

Gets a step.

SELECT
name,
created_at,
created_by,
dependency_counts,
description,
ended_at,
lifecycle_status,
lifecycle_status_message,
parameter_space,
required_capabilities,
started_at,
step_id,
target_task_run_status,
task_failure_retry_count,
task_run_status,
task_run_status_counts,
updated_at,
updated_by
FROM aws.deadline.steps
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
;

list_steps

Lists steps for a job.

SELECT
name,
created_at,
created_by,
dependency_counts,
ended_at,
lifecycle_status,
lifecycle_status_message,
started_at,
step_id,
target_task_run_status,
task_failure_retry_count,
task_run_status,
task_run_status_counts,
updated_at,
updated_by
FROM aws.deadline.steps
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 }}'
;

search_steps

Searches for steps.

SELECT
next_item_offset,
steps,
total_results
FROM aws.deadline.steps
WHERE farm_id = '{{ farm_id }}' -- required
AND region = '{{ region }}' -- required
;

batch_get_step

Retrieves multiple steps in a single request. This is a batch version of the GetStep API. The result of getting each step is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

SELECT
errors,
steps
FROM aws.deadline.steps
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_step

Updates a step.

UPDATE aws.deadline.steps
SET 
targetTaskRunStatus = '{{ targetTaskRunStatus }}'
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 targetTaskRunStatus = '{{ targetTaskRunStatus }}' --required
AND `X-Amz-Client-Token` = '{{ X-Amz-Client-Token}}';