definitions.md

Definitions

BadRequest

Name	Schema
message optional	string

CancelReason

Name	Schema
reason optional	string

Conflict

Name	Schema
message optional	string

InternalError

Name	Schema
message optional	string

Job

Name	Schema
attempts optional	< JobAttempt > array
container optional	string
createdAt optional	string (date-time)
id optional	string
input optional	string
name optional	string
output optional	string
queue optional	string
startedAt optional	string (date-time)
state optional	string
stateResource optional	StateResource
status optional	JobStatus
statusReason optional	string
stoppedAt optional	string (date-time)

JobAttempt

Name	Schema
containerInstanceARN optional	string
createdAt optional	string (date-time)
exitCode optional	integer
reason optional	string
startedAt optional	string (date-time)
stoppedAt optional	string (date-time)
taskARN optional	string

JobStatus

Type : enum (created, queued, waiting_for_deps, running, succeeded, failed, aborted_deps_failed, aborted_by_user)

Manager

Type : enum (step-functions)

NewStateResource

Name	Schema
name optional	string
namespace optional	string
uri optional	string

NewWorkflowDefinitionRequest

Name	Schema
manager optional	Manager
name optional	string
stateMachine optional	SLStateMachine
version optional	integer

NotFound

Name	Schema
message optional	string

ResolvedByUserWrapper

Name	Schema
isSet optional	boolean
value optional	boolean

SLCatcher

Name	Schema
ErrorEquals optional	< SLErrorEquals > array
Next optional	string
ResultPath optional	string

SLChoice

Name	Schema
And optional	< SLChoice > array
BooleanEquals optional	boolean
IsNull optional	boolean
IsPresent optional	boolean
Next optional	string
Not optional	SLChoice
NumericEquals optional	integer
NumericGreaterThan optional	number
NumericGreaterThanEquals optional	integer
NumericLessThan optional	number
NumericLessThanEquals optional	integer
Or optional	< SLChoice > array
StringEquals optional	string
StringGreaterThan optional	string
StringGreaterThanEquals optional	string
StringLessThan optional	string
StringLessThanEquals optional	string
TimestampEquals optional	string (date-time)
TimestampGreaterThan optional	string (date-time)
TimestampGreaterThanEquals optional	string (date-time)
TimestampLessThan optional	string (date-time)
TimestampLessThanEquals optional	string (date-time)
Variable optional	string

SLErrorEquals

Type : string

SLRetrier

Name	Description	Schema
BackoffRate optional		number
ErrorEquals optional		< SLErrorEquals > array
IntervalSeconds optional		integer
MaxAttempts optional	Minimum value : 0 Maximum value : 2000	integer

SLState

Name	Schema
Branches optional	< SLStateMachine > array
Catch optional	< SLCatcher > array
Cause optional	string
Choices optional	< SLChoice > array
Comment optional	string
Default optional	string
End optional	boolean
Error optional	string
HeartbeatSeconds optional	integer
InputPath optional	string
ItemsPath optional	string
Iterator optional	SLStateMachine
MaxConcurrency optional	integer
Next optional	string
OutputPath optional	string
Resource optional	string
Result optional	string
ResultPath optional	string
Retry optional	< SLRetrier > array
Seconds optional	integer
SecondsPath optional	string
TimeoutSeconds optional	integer
Timestamp optional	string
TimestampPath optional	string
Type optional	SLStateType

SLStateMachine

Name	Schema
Comment optional	string
StartAt optional	string
TimeoutSeconds optional	integer
Version optional	enum (1.0)

SLStateType

Type : enum (Pass, Task, Choice, Wait, Succeed, Fail, Parallel, Map)

StartWorkflowRequest

Name	Description	Schema
idSuffix optional	idSuffix is exclusively used for embedded workflow-manager to append human readable information to the newly created workflow's ID. Workflow IDs are truncated to 80 characters, so some or all of the suffix may be lost	string
input optional		string
namespace optional		string
queue optional		string
workflowDefinition optional		WorkflowDefinitionRef

StateResource

Name	Schema
lastUpdated optional	string (date-time)
name optional	string
namespace optional	string
type optional	StateResourceType
uri optional	string

StateResourceType

Type : enum (JobDefinitionARN, ActivityARN, LambdaFunctionARN, TaskARN)

Workflow

Polymorphism : Composition

Name	Description	Schema
createdAt optional		string (date-time)
id optional		string
input optional		string
jobs optional		< Job > array
lastJob optional		Job
lastUpdated optional		string (date-time)
namespace optional		string
output optional		string
queue optional		string
resolvedByUser optional		boolean
retries optional	workflow-id's of workflows created as retries for this workflow	< string > array
retryFor optional	workflow-id of original workflow in case this is a retry	string
status optional		WorkflowStatus
statusReason optional		string
stoppedAt optional		string (date-time)
workflowDefinition optional		WorkflowDefinition

WorkflowDefinition

Name	Schema
createdAt optional	string (date-time)
id optional	string
manager optional	Manager
name optional	string
stateMachine optional	SLStateMachine
version optional	integer

WorkflowDefinitionOverrides

Name	Schema
StartAt optional	string

WorkflowDefinitionRef

Name	Schema
name optional	string
version optional	integer

WorkflowQuery

Name	Description	Schema
limit optional	Maximum value : 10000	integer
oldestFirst optional		boolean
pageToken optional		string
resolvedByUserWrapper optional	Tracks whether the resolvedByUser query parameter was sent or omitted in the request.	ResolvedByUserWrapper
status optional		WorkflowStatus
summaryOnly optional	Default : false	boolean
workflowDefinitionName required		string

WorkflowStatus

Type : enum (queued, running, failed, succeeded, cancelled)

WorkflowSummary

Name	Description	Schema
createdAt optional		string (date-time)
id optional		string
input optional		string
lastJob optional		Job
lastUpdated optional		string (date-time)
namespace optional		string
queue optional		string
resolvedByUser optional		boolean
retries optional	workflow-id's of workflows created as retries for this workflow	< string > array
retryFor optional	workflow-id of original workflow in case this is a retry	string
status optional		WorkflowStatus
stoppedAt optional		string (date-time)
workflowDefinition optional		WorkflowDefinition