codegen-resources.service-2.json Maven / Gradle / Ivy
Show all versions of stepfunctions Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-11-23",
"endpointPrefix":"states",
"jsonVersion":"1.0",
"protocol":"json",
"serviceAbbreviation":"AWS SFN",
"serviceFullName":"AWS Step Functions",
"signatureVersion":"v4",
"targetPrefix":"AWSStepFunctions",
"uid":"states-2016-11-23"
},
"operations":{
"CreateActivity":{
"name":"CreateActivity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateActivityInput"},
"output":{"shape":"CreateActivityOutput"},
"errors":[
{"shape":"ActivityLimitExceeded"},
{"shape":"InvalidName"}
],
"documentation":"Creates an activity.
",
"idempotent":true
},
"CreateStateMachine":{
"name":"CreateStateMachine",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateStateMachineInput"},
"output":{"shape":"CreateStateMachineOutput"},
"errors":[
{"shape":"InvalidArn"},
{"shape":"InvalidDefinition"},
{"shape":"InvalidName"},
{"shape":"StateMachineAlreadyExists"},
{"shape":"StateMachineDeleting"},
{"shape":"StateMachineLimitExceeded"}
],
"documentation":"Creates a state machine.
",
"idempotent":true
},
"DeleteActivity":{
"name":"DeleteActivity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteActivityInput"},
"output":{"shape":"DeleteActivityOutput"},
"errors":[
{"shape":"InvalidArn"}
],
"documentation":"Deletes an activity.
"
},
"DeleteStateMachine":{
"name":"DeleteStateMachine",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteStateMachineInput"},
"output":{"shape":"DeleteStateMachineOutput"},
"errors":[
{"shape":"InvalidArn"}
],
"documentation":"Deletes a state machine. This is an asynchronous operation-- it sets the state machine's status to \"DELETING\" and begins the delete process.
"
},
"DescribeActivity":{
"name":"DescribeActivity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeActivityInput"},
"output":{"shape":"DescribeActivityOutput"},
"errors":[
{"shape":"ActivityDoesNotExist"},
{"shape":"InvalidArn"}
],
"documentation":"Describes an activity.
"
},
"DescribeExecution":{
"name":"DescribeExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeExecutionInput"},
"output":{"shape":"DescribeExecutionOutput"},
"errors":[
{"shape":"ExecutionDoesNotExist"},
{"shape":"InvalidArn"}
],
"documentation":"Describes an execution.
"
},
"DescribeStateMachine":{
"name":"DescribeStateMachine",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStateMachineInput"},
"output":{"shape":"DescribeStateMachineOutput"},
"errors":[
{"shape":"InvalidArn"},
{"shape":"StateMachineDoesNotExist"}
],
"documentation":"Describes a state machine.
"
},
"GetActivityTask":{
"name":"GetActivityTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetActivityTaskInput"},
"output":{"shape":"GetActivityTaskOutput"},
"errors":[
{"shape":"ActivityDoesNotExist"},
{"shape":"ActivityWorkerLimitExceeded"},
{"shape":"InvalidArn"}
],
"documentation":"Used by workers to retrieve a task (with the specified activity ARN) scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result, that is, the taskToken returned is an empty string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
"
},
"GetExecutionHistory":{
"name":"GetExecutionHistory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetExecutionHistoryInput"},
"output":{"shape":"GetExecutionHistoryOutput"},
"errors":[
{"shape":"ExecutionDoesNotExist"},
{"shape":"InvalidArn"},
{"shape":"InvalidToken"}
],
"documentation":"Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.
"
},
"ListActivities":{
"name":"ListActivities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListActivitiesInput"},
"output":{"shape":"ListActivitiesOutput"},
"errors":[
{"shape":"InvalidToken"}
],
"documentation":"Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.
"
},
"ListExecutions":{
"name":"ListExecutions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListExecutionsInput"},
"output":{"shape":"ListExecutionsOutput"},
"errors":[
{"shape":"InvalidArn"},
{"shape":"InvalidToken"},
{"shape":"StateMachineDoesNotExist"}
],
"documentation":"Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.
"
},
"ListStateMachines":{
"name":"ListStateMachines",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListStateMachinesInput"},
"output":{"shape":"ListStateMachinesOutput"},
"errors":[
{"shape":"InvalidToken"}
],
"documentation":"Lists the existing state machines. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.
"
},
"SendTaskFailure":{
"name":"SendTaskFailure",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SendTaskFailureInput"},
"output":{"shape":"SendTaskFailureOutput"},
"errors":[
{"shape":"TaskDoesNotExist"},
{"shape":"InvalidToken"},
{"shape":"TaskTimedOut"}
],
"documentation":"Used by workers to report that the task identified by the taskToken failed.
"
},
"SendTaskHeartbeat":{
"name":"SendTaskHeartbeat",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SendTaskHeartbeatInput"},
"output":{"shape":"SendTaskHeartbeatOutput"},
"errors":[
{"shape":"TaskDoesNotExist"},
{"shape":"InvalidToken"},
{"shape":"TaskTimedOut"}
],
"documentation":"Used by workers to report to the service that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition. This action does not in itself create an event in the execution history. However, if the task times out, the execution history will contain an ActivityTimedOut event.
The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.
This operation is only useful for long-lived tasks to report the liveliness of the task.
"
},
"SendTaskSuccess":{
"name":"SendTaskSuccess",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SendTaskSuccessInput"},
"output":{"shape":"SendTaskSuccessOutput"},
"errors":[
{"shape":"TaskDoesNotExist"},
{"shape":"InvalidOutput"},
{"shape":"InvalidToken"},
{"shape":"TaskTimedOut"}
],
"documentation":"Used by workers to report that the task identified by the taskToken completed successfully.
"
},
"StartExecution":{
"name":"StartExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartExecutionInput"},
"output":{"shape":"StartExecutionOutput"},
"errors":[
{"shape":"ExecutionLimitExceeded"},
{"shape":"ExecutionAlreadyExists"},
{"shape":"InvalidArn"},
{"shape":"InvalidExecutionInput"},
{"shape":"InvalidName"},
{"shape":"StateMachineDoesNotExist"},
{"shape":"StateMachineDeleting"}
],
"documentation":"Starts a state machine execution.
",
"idempotent":true
},
"StopExecution":{
"name":"StopExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopExecutionInput"},
"output":{"shape":"StopExecutionOutput"},
"errors":[
{"shape":"ExecutionDoesNotExist"},
{"shape":"InvalidArn"}
],
"documentation":"Stops an execution.
"
}
},
"shapes":{
"ActivityDoesNotExist":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The specified activity does not exist.
",
"exception":true
},
"ActivityFailedEventDetails":{
"type":"structure",
"members":{
"error":{
"shape":"Error",
"documentation":"The error code of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the failure.
"
}
}
},
"ActivityLimitExceeded":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
",
"exception":true
},
"ActivityList":{
"type":"list",
"member":{"shape":"ActivityListItem"}
},
"ActivityListItem":{
"type":"structure",
"required":[
"activityArn",
"name",
"creationDate"
],
"members":{
"activityArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) that identifies the activity.
"
},
"name":{
"shape":"Name",
"documentation":"The name of the activity.
"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"The date the activity was created.
"
}
}
},
"ActivityScheduleFailedEventDetails":{
"type":"structure",
"members":{
"error":{
"shape":"Error",
"documentation":"The error code of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the failure.
"
}
}
},
"ActivityScheduledEventDetails":{
"type":"structure",
"required":["resource"],
"members":{
"resource":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the scheduled activity.
"
},
"input":{
"shape":"Data",
"documentation":"The JSON data input to the activity task.
"
},
"timeoutInSeconds":{
"shape":"TimeoutInSeconds",
"documentation":"The maximum allowed duration of the activity task.
",
"box":true
},
"heartbeatInSeconds":{
"shape":"TimeoutInSeconds",
"documentation":"The maximum allowed duration between two heartbeats for the activity task.
",
"box":true
}
}
},
"ActivityStartedEventDetails":{
"type":"structure",
"members":{
"workerName":{
"shape":"Identity",
"documentation":"The name of the worker that the task was assigned to. These names are provided by the workers when calling GetActivityTask.
"
}
}
},
"ActivitySucceededEventDetails":{
"type":"structure",
"members":{
"output":{
"shape":"Data",
"documentation":"The JSON data output by the activity task.
"
}
}
},
"ActivityTimedOutEventDetails":{
"type":"structure",
"members":{
"error":{
"shape":"Error",
"documentation":"The error code of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the timeout.
"
}
}
},
"ActivityWorkerLimitExceeded":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The maximum number of workers concurrently polling for activity tasks has been reached.
",
"exception":true
},
"Arn":{
"type":"string",
"max":256,
"min":1
},
"Cause":{
"type":"string",
"max":32768,
"min":0
},
"CreateActivityInput":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"Name",
"documentation":"The name of the activity to create. This name must be unique for your AWS account and region.
"
}
}
},
"CreateActivityOutput":{
"type":"structure",
"required":[
"activityArn",
"creationDate"
],
"members":{
"activityArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) that identifies the created activity.
"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"The date the activity was created.
"
}
}
},
"CreateStateMachineInput":{
"type":"structure",
"required":[
"name",
"definition",
"roleArn"
],
"members":{
"name":{
"shape":"Name",
"documentation":"The name of the state machine. This name must be unique for your AWS account and region.
"
},
"definition":{
"shape":"Definition",
"documentation":"The Amazon States Language definition of the state machine.
"
},
"roleArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
"
}
}
},
"CreateStateMachineOutput":{
"type":"structure",
"required":[
"stateMachineArn",
"creationDate"
],
"members":{
"stateMachineArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) that identifies the created state machine.
"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"The date the state machine was created.
"
}
}
},
"Data":{
"type":"string",
"max":32768
},
"Definition":{
"type":"string",
"max":1048576,
"min":1
},
"DeleteActivityInput":{
"type":"structure",
"required":["activityArn"],
"members":{
"activityArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the activity to delete.
"
}
}
},
"DeleteActivityOutput":{
"type":"structure",
"members":{
}
},
"DeleteStateMachineInput":{
"type":"structure",
"required":["stateMachineArn"],
"members":{
"stateMachineArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the state machine to delete.
"
}
}
},
"DeleteStateMachineOutput":{
"type":"structure",
"members":{
}
},
"DescribeActivityInput":{
"type":"structure",
"required":["activityArn"],
"members":{
"activityArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the activity to describe.
"
}
}
},
"DescribeActivityOutput":{
"type":"structure",
"required":[
"activityArn",
"name",
"creationDate"
],
"members":{
"activityArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) that identifies the activity.
"
},
"name":{
"shape":"Name",
"documentation":"The name of the activity.
"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"The date the activity was created.
"
}
}
},
"DescribeExecutionInput":{
"type":"structure",
"required":["executionArn"],
"members":{
"executionArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the execution to describe.
"
}
}
},
"DescribeExecutionOutput":{
"type":"structure",
"required":[
"executionArn",
"stateMachineArn",
"status",
"startDate",
"input"
],
"members":{
"executionArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) that identifies the execution.
"
},
"stateMachineArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the executed stated machine.
"
},
"name":{
"shape":"Name",
"documentation":"The name of the execution.
"
},
"status":{
"shape":"ExecutionStatus",
"documentation":"The current status of the execution.
"
},
"startDate":{
"shape":"Timestamp",
"documentation":"The date the execution was started.
"
},
"stopDate":{
"shape":"Timestamp",
"documentation":"If the execution has already ended, the date the execution stopped.
"
},
"input":{
"shape":"Data",
"documentation":"The JSON input data of the execution.
"
},
"output":{
"shape":"Data",
"documentation":"The JSON output data of the execution.
"
}
}
},
"DescribeStateMachineInput":{
"type":"structure",
"required":["stateMachineArn"],
"members":{
"stateMachineArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the state machine to describe.
"
}
}
},
"DescribeStateMachineOutput":{
"type":"structure",
"required":[
"stateMachineArn",
"name",
"definition",
"roleArn",
"creationDate"
],
"members":{
"stateMachineArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) that identifies the state machine.
"
},
"name":{
"shape":"Name",
"documentation":"The name of the state machine.
"
},
"status":{
"shape":"StateMachineStatus",
"documentation":"The current status of the state machine.
"
},
"definition":{
"shape":"Definition",
"documentation":"The Amazon States Language definition of the state machine.
"
},
"roleArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the IAM role used for executing this state machine.
"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"The date the state machine was created.
"
}
}
},
"Error":{
"type":"string",
"max":256,
"min":0
},
"ErrorMessage":{"type":"string"},
"EventId":{"type":"long"},
"ExecutionAbortedEventDetails":{
"type":"structure",
"members":{
"error":{
"shape":"Error",
"documentation":"The error code of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the failure.
"
}
}
},
"ExecutionAlreadyExists":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"An execution with the same name already exists.
",
"exception":true
},
"ExecutionDoesNotExist":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The specified execution does not exist.
",
"exception":true
},
"ExecutionFailedEventDetails":{
"type":"structure",
"members":{
"error":{
"shape":"Error",
"documentation":"The error code of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the failure.
"
}
}
},
"ExecutionLimitExceeded":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
",
"exception":true
},
"ExecutionList":{
"type":"list",
"member":{"shape":"ExecutionListItem"}
},
"ExecutionListItem":{
"type":"structure",
"required":[
"executionArn",
"stateMachineArn",
"name",
"status",
"startDate"
],
"members":{
"executionArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) that identifies the execution.
"
},
"stateMachineArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the executed state machine.
"
},
"name":{
"shape":"Name",
"documentation":"The name of the execution.
"
},
"status":{
"shape":"ExecutionStatus",
"documentation":"The current status of the execution.
"
},
"startDate":{
"shape":"Timestamp",
"documentation":"The date the execution started.
"
},
"stopDate":{
"shape":"Timestamp",
"documentation":"If the execution already ended, the date the execution stopped.
"
}
}
},
"ExecutionStartedEventDetails":{
"type":"structure",
"members":{
"input":{
"shape":"Data",
"documentation":"The JSON data input to the execution.
"
},
"roleArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.
"
}
}
},
"ExecutionStatus":{
"type":"string",
"enum":[
"RUNNING",
"SUCCEEDED",
"FAILED",
"TIMED_OUT",
"ABORTED"
]
},
"ExecutionSucceededEventDetails":{
"type":"structure",
"members":{
"output":{
"shape":"Data",
"documentation":"The JSON data output by the execution.
"
}
}
},
"ExecutionTimedOutEventDetails":{
"type":"structure",
"members":{
"error":{
"shape":"Error",
"documentation":"The error code of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the timeout.
"
}
}
},
"GetActivityTaskInput":{
"type":"structure",
"required":["activityArn"],
"members":{
"activityArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the activity to retrieve tasks from.
"
},
"workerName":{
"shape":"Name",
"documentation":"An arbitrary name may be provided in order to identify the worker that the task is assigned to. This name will be used when it is logged in the execution history.
"
}
}
},
"GetActivityTaskOutput":{
"type":"structure",
"members":{
"taskToken":{
"shape":"TaskToken",
"documentation":"A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.
"
},
"input":{
"shape":"Data",
"documentation":"The JSON input data for the task.
"
}
}
},
"GetExecutionHistoryInput":{
"type":"structure",
"required":["executionArn"],
"members":{
"executionArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the execution.
"
},
"maxResults":{
"shape":"PageSize",
"documentation":"The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
"
},
"reverseOrder":{
"shape":"ReverseOrder",
"documentation":"Lists events in descending order of their timeStamp.
"
},
"nextToken":{
"shape":"PageToken",
"documentation":"If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
"
}
}
},
"GetExecutionHistoryOutput":{
"type":"structure",
"required":["events"],
"members":{
"events":{
"shape":"HistoryEventList",
"documentation":"The list of events that occurred in the execution.
"
},
"nextToken":{
"shape":"PageToken",
"documentation":"If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
"
}
}
},
"HistoryEvent":{
"type":"structure",
"required":[
"timestamp",
"type",
"id"
],
"members":{
"timestamp":{
"shape":"Timestamp",
"documentation":"The date the event occured.
"
},
"type":{
"shape":"HistoryEventType",
"documentation":"The type of the event.
"
},
"id":{
"shape":"EventId",
"documentation":"The id of the event. Events are numbered sequentially, starting at one.
"
},
"previousEventId":{
"shape":"EventId",
"documentation":"The id of the previous event.
"
},
"activityFailedEventDetails":{"shape":"ActivityFailedEventDetails"},
"activityScheduleFailedEventDetails":{"shape":"ActivityScheduleFailedEventDetails"},
"activityScheduledEventDetails":{"shape":"ActivityScheduledEventDetails"},
"activityStartedEventDetails":{"shape":"ActivityStartedEventDetails"},
"activitySucceededEventDetails":{"shape":"ActivitySucceededEventDetails"},
"activityTimedOutEventDetails":{"shape":"ActivityTimedOutEventDetails"},
"executionFailedEventDetails":{"shape":"ExecutionFailedEventDetails"},
"executionStartedEventDetails":{"shape":"ExecutionStartedEventDetails"},
"executionSucceededEventDetails":{"shape":"ExecutionSucceededEventDetails"},
"executionAbortedEventDetails":{"shape":"ExecutionAbortedEventDetails"},
"executionTimedOutEventDetails":{"shape":"ExecutionTimedOutEventDetails"},
"lambdaFunctionFailedEventDetails":{"shape":"LambdaFunctionFailedEventDetails"},
"lambdaFunctionScheduleFailedEventDetails":{"shape":"LambdaFunctionScheduleFailedEventDetails"},
"lambdaFunctionScheduledEventDetails":{"shape":"LambdaFunctionScheduledEventDetails"},
"lambdaFunctionStartFailedEventDetails":{"shape":"LambdaFunctionStartFailedEventDetails"},
"lambdaFunctionSucceededEventDetails":{"shape":"LambdaFunctionSucceededEventDetails"},
"lambdaFunctionTimedOutEventDetails":{"shape":"LambdaFunctionTimedOutEventDetails"},
"stateEnteredEventDetails":{"shape":"StateEnteredEventDetails"},
"stateExitedEventDetails":{"shape":"StateExitedEventDetails"}
}
},
"HistoryEventList":{
"type":"list",
"member":{"shape":"HistoryEvent"}
},
"HistoryEventType":{
"type":"string",
"enum":[
"ActivityFailed",
"ActivityScheduleFailed",
"ActivityScheduled",
"ActivityStarted",
"ActivitySucceeded",
"ActivityTimedOut",
"ChoiceStateEntered",
"ChoiceStateExited",
"ExecutionFailed",
"ExecutionStarted",
"ExecutionSucceeded",
"ExecutionAborted",
"ExecutionTimedOut",
"FailStateEntered",
"LambdaFunctionFailed",
"LambdaFunctionScheduleFailed",
"LambdaFunctionScheduled",
"LambdaFunctionStartFailed",
"LambdaFunctionStarted",
"LambdaFunctionSucceeded",
"LambdaFunctionTimedOut",
"SucceedStateEntered",
"SucceedStateExited",
"TaskStateEntered",
"TaskStateExited",
"PassStateEntered",
"PassStateExited",
"ParallelStateEntered",
"ParallelStateExited",
"WaitStateEntered",
"WaitStateExited"
]
},
"Identity":{
"type":"string",
"max":256
},
"InvalidArn":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The provided Amazon Resource Name (ARN) is invalid.
",
"exception":true
},
"InvalidDefinition":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The provided Amazon States Language definition is invalid.
",
"exception":true
},
"InvalidExecutionInput":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The provided JSON input data is invalid.
",
"exception":true
},
"InvalidName":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The provided name is invalid.
",
"exception":true
},
"InvalidOutput":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The provided JSON output data is invalid.
",
"exception":true
},
"InvalidToken":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The provided token is invalid.
",
"exception":true
},
"LambdaFunctionFailedEventDetails":{
"type":"structure",
"members":{
"error":{
"shape":"Error",
"documentation":"The error code of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the failure.
"
}
}
},
"LambdaFunctionScheduleFailedEventDetails":{
"type":"structure",
"members":{
"error":{
"shape":"Error",
"documentation":"The error code of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the failure.
"
}
}
},
"LambdaFunctionScheduledEventDetails":{
"type":"structure",
"required":["resource"],
"members":{
"resource":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the scheduled lambda function.
"
},
"input":{
"shape":"Data",
"documentation":"The JSON data input to the lambda function.
"
},
"timeoutInSeconds":{
"shape":"TimeoutInSeconds",
"documentation":"The maximum allowed duration of the lambda function.
",
"box":true
}
}
},
"LambdaFunctionStartFailedEventDetails":{
"type":"structure",
"members":{
"error":{
"shape":"Error",
"documentation":"The error code of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the failure.
"
}
}
},
"LambdaFunctionSucceededEventDetails":{
"type":"structure",
"members":{
"output":{
"shape":"Data",
"documentation":"The JSON data output by the lambda function.
"
}
}
},
"LambdaFunctionTimedOutEventDetails":{
"type":"structure",
"members":{
"error":{
"shape":"Error",
"documentation":"The error code of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the timeout.
"
}
}
},
"ListActivitiesInput":{
"type":"structure",
"members":{
"maxResults":{
"shape":"PageSize",
"documentation":"The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
"
},
"nextToken":{
"shape":"PageToken",
"documentation":"If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
"
}
}
},
"ListActivitiesOutput":{
"type":"structure",
"required":["activities"],
"members":{
"activities":{
"shape":"ActivityList",
"documentation":"The list of activities.
"
},
"nextToken":{
"shape":"PageToken",
"documentation":"If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
"
}
}
},
"ListExecutionsInput":{
"type":"structure",
"required":["stateMachineArn"],
"members":{
"stateMachineArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the state machine whose executions will be listed.
"
},
"statusFilter":{
"shape":"ExecutionStatus",
"documentation":"If specified, only list the executions whose current execution status matches the given filter.
"
},
"maxResults":{
"shape":"PageSize",
"documentation":"The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
"
},
"nextToken":{
"shape":"PageToken",
"documentation":"If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
"
}
}
},
"ListExecutionsOutput":{
"type":"structure",
"required":["executions"],
"members":{
"executions":{
"shape":"ExecutionList",
"documentation":"The list of matching executions.
"
},
"nextToken":{
"shape":"PageToken",
"documentation":"If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
"
}
}
},
"ListStateMachinesInput":{
"type":"structure",
"members":{
"maxResults":{
"shape":"PageSize",
"documentation":"The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
"
},
"nextToken":{
"shape":"PageToken",
"documentation":"If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
"
}
}
},
"ListStateMachinesOutput":{
"type":"structure",
"required":["stateMachines"],
"members":{
"stateMachines":{"shape":"StateMachineList"},
"nextToken":{
"shape":"PageToken",
"documentation":"If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.
The configured maxResults determines how many results can be returned in a single call.
"
}
}
},
"Name":{
"type":"string",
"max":80,
"min":1
},
"PageSize":{
"type":"integer",
"max":1000,
"min":0
},
"PageToken":{
"type":"string",
"max":1024,
"min":1
},
"ReverseOrder":{"type":"boolean"},
"SendTaskFailureInput":{
"type":"structure",
"required":["taskToken"],
"members":{
"taskToken":{
"shape":"TaskToken",
"documentation":"The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).
"
},
"error":{
"shape":"Error",
"documentation":"An arbitrary error code that identifies the cause of the failure.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the failure.
"
}
}
},
"SendTaskFailureOutput":{
"type":"structure",
"members":{
}
},
"SendTaskHeartbeatInput":{
"type":"structure",
"required":["taskToken"],
"members":{
"taskToken":{
"shape":"TaskToken",
"documentation":"The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).
"
}
}
},
"SendTaskHeartbeatOutput":{
"type":"structure",
"members":{
}
},
"SendTaskSuccessInput":{
"type":"structure",
"required":[
"taskToken",
"output"
],
"members":{
"taskToken":{
"shape":"TaskToken",
"documentation":"The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).
"
},
"output":{
"shape":"Data",
"documentation":"The JSON output of the task.
"
}
}
},
"SendTaskSuccessOutput":{
"type":"structure",
"members":{
}
},
"StartExecutionInput":{
"type":"structure",
"required":["stateMachineArn"],
"members":{
"stateMachineArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the state machine to execute.
"
},
"name":{
"shape":"Name",
"documentation":"The name of the execution. This name must be unique for your AWS account and region.
"
},
"input":{
"shape":"Data",
"documentation":"The JSON input data for the execution.
"
}
}
},
"StartExecutionOutput":{
"type":"structure",
"required":[
"executionArn",
"startDate"
],
"members":{
"executionArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) that identifies the execution.
"
},
"startDate":{
"shape":"Timestamp",
"documentation":"The date the execution was started.
"
}
}
},
"StateEnteredEventDetails":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"Name",
"documentation":"The name of the state.
"
},
"input":{
"shape":"Data",
"documentation":"The JSON input data to the state.
"
}
}
},
"StateExitedEventDetails":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"Name",
"documentation":"The name of the state.
"
},
"output":{
"shape":"Data",
"documentation":"The JSON output data of the state.
"
}
}
},
"StateMachineAlreadyExists":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"A state machine with the same name but a different definition or role ARN already exists.
",
"exception":true
},
"StateMachineDeleting":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The specified state machine is being deleted.
",
"exception":true
},
"StateMachineDoesNotExist":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The specified state machine does not exist.
",
"exception":true
},
"StateMachineLimitExceeded":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.
",
"exception":true
},
"StateMachineList":{
"type":"list",
"member":{"shape":"StateMachineListItem"}
},
"StateMachineListItem":{
"type":"structure",
"required":[
"stateMachineArn",
"name",
"creationDate"
],
"members":{
"stateMachineArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) that identifies the state machine.
"
},
"name":{
"shape":"Name",
"documentation":"The name of the state machine.
"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"The date the state machine was created.
"
}
}
},
"StateMachineStatus":{
"type":"string",
"enum":[
"ACTIVE",
"DELETING"
]
},
"StopExecutionInput":{
"type":"structure",
"required":["executionArn"],
"members":{
"executionArn":{
"shape":"Arn",
"documentation":"The Amazon Resource Name (ARN) of the execution to stop.
"
},
"error":{
"shape":"Error",
"documentation":"An arbitrary error code that identifies the cause of the termination.
"
},
"cause":{
"shape":"Cause",
"documentation":"A more detailed explanation of the cause of the termination.
"
}
}
},
"StopExecutionOutput":{
"type":"structure",
"required":["stopDate"],
"members":{
"stopDate":{
"shape":"Timestamp",
"documentation":"The date the execution was stopped.
"
}
}
},
"TaskDoesNotExist":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"exception":true
},
"TaskTimedOut":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"exception":true
},
"TaskToken":{
"type":"string",
"max":1024,
"min":1
},
"TimeoutInSeconds":{"type":"long"},
"Timestamp":{"type":"timestamp"}
},
"documentation":"AWS Step Functions AWS Step Functions is a web service that enables you to coordinate the components of distributed applications and microservices using visual workflows. You build applications from individual components that each perform a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a graphical console to visualize the components of your application as a series of steps. It automatically triggers and tracks each step, and retries when there are errors, so your application executes in order and as expected, every time. Step Functions logs the state of each step, so when things do go wrong, you can diagnose and debug problems quickly.
Step Functions manages the operations and underlying infrastructure for you to ensure your application is available at any scale. You can run tasks on the AWS cloud, on your own servers, or an any system that has access to AWS. Step Functions can be accessed and used with the Step Functions console, the AWS SDKs (included with your Beta release invitation email), or an HTTP API (the subject of this document).
"
}