workflow_runs

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

Overview

Name	workflow_runs
Type	Resource
Id	aws.codecatalyst.workflow_runs

Fields

The following fields are returned by SELECT queries:

get_workflow_run

Name	Datatype	Description
id	string	The ID of the workflow run. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
end_time	string (date-time)	The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
last_updated_time	string (date-time)	The date and time the workflow run status was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
project_name	string	The name of the project in the space. (pattern: <code>[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*</code>)
space_name	string	The name of the space. (pattern: <code>[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*</code>)
start_time	string (date-time)	The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
status	string	The status of the workflow run. (SUCCEEDED, FAILED, STOPPED, SUPERSEDED, CANCELLED, NOT_RUN, VALIDATING, PROVISIONING, IN_PROGRESS, STOPPING, ABANDONED)
status_reasons	array	Information about the reasons for the status of the workflow run.
workflow_id	string	The ID of the workflow. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)

list_workflow_runs

Name	Datatype	Description
id	string	The system-generated unique ID of the workflow run. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
end_time	string (date-time)	The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
last_updated_time	string (date-time)	The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339
start_time	string (date-time)	The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
status	string	The status of the workflow run. (SUCCEEDED, FAILED, STOPPED, SUPERSEDED, CANCELLED, NOT_RUN, VALIDATING, PROVISIONING, IN_PROGRESS, STOPPING, ABANDONED)
status_reasons	array	The reasons for the workflow run status.
workflow_id	string	The system-generated unique ID of the workflow. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
workflow_name	string	The name of the workflow.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow_run	select	space_name, id, project_name, region		Returns information about a specified run of a workflow.
list_workflow_runs	select	space_name, project_name, region	workflowId, nextToken, maxResults	Retrieves a list of workflow runs of a specified workflow.

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
id	string	The ID of the workflow run. To retrieve a list of workflow run IDs, use ListWorkflowRuns.
project_name	string	The name of the project in the space.
region	string	AWS region (default: us-east-1)
space_name	string	The name of the space.
maxResults	integer	The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
nextToken	string	A token returned from a call to this API to indicate the next batch of results to return, if any.
workflowId	string	The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

SELECT examples

get_workflow_run

Returns information about a specified run of a workflow.

SELECT
id,
end_time,
last_updated_time,
project_name,
space_name,
start_time,
status,
status_reasons,
workflow_id
FROM aws.codecatalyst.workflow_runs
WHERE space_name = '{{ space_name }}' -- required
AND id = '{{ id }}' -- required
AND project_name = '{{ project_name }}' -- required
AND region = '{{ region }}' -- required
;

list_workflow_runs

Retrieves a list of workflow runs of a specified workflow.

SELECT
id,
end_time,
last_updated_time,
start_time,
status,
status_reasons,
workflow_id,
workflow_name
FROM aws.codecatalyst.workflow_runs
WHERE space_name = '{{ space_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND region = '{{ region }}' -- required
AND workflowId = '{{ workflowId }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;