AWS Step Functions

1 AWS step FunctionsAPI ReferenceAPI Version 2016-11-23 AWS step Functions API ReferenceAWS step Functions : API ReferenceCopyright 2019 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored step Functions API ReferenceTable of ContentsWelcome .. 1 Actions .. 2 CreateActivity .. 3 Request Syntax .. 3 Request Parameters .. 3 Response Syntax .. 3 Response Elements .. 3 Errors .. 4 See Also.. 4 CreateStateMachine .. 5 Request Syntax .. 5 Request Parameters .. 5 Response Syntax .. 6 Response Elements.

2 6 Errors .. 6 See Also.. 7 DeleteActivity .. 8 Request Syntax .. 8 Request Parameters .. 8 Response Elements .. 8 Errors .. 8 See Also.. 8 DeleteStateMachine.. 10 Request Syntax .. 10 Request Parameters .. 10 Response Elements .. 10 Errors .. 10 See Also.. 10 DescribeActivity .. 12 Request Syntax .. 12 Request Parameters .. 12 Response Syntax .. 12 Response Elements .. 12 Errors .. 13 See Also.. 13 DescribeExecution .. 14 Request Syntax .. 14 Request Parameters .. 14 Response Syntax .. 14 Response Elements .. 14 Errors .. 16 See Also.. 16 DescribeStateMachine.. 17 Request Syntax .. 17 Request Parameters .. 17 Response Syntax .. 17 Response Elements .. 17 Errors .. 18 See Also.. 19 DescribeStateMachineForExecution .. 20 Request Syntax .. 20 Request Parameters .. 20 Response Syntax .. 20 Response Elements .. 20 API Version 2016-11-23iiiAWS step Functions API ReferenceErrors.

3 21 See Also.. 21 GetActivityTask .. 23 Request Syntax .. 23 Request Parameters .. 23 Response Syntax .. 23 Response Elements .. 24 Errors .. 24 See Also.. 24 GetExecutionHistory .. 26 Request Syntax .. 26 Request Parameters .. 26 Response Syntax .. 27 Response Elements .. 29 Errors .. 29 Example.. 30 See Also.. 30 ListActivities .. 32 Request Syntax .. 32 Request Parameters .. 32 Response Syntax .. 32 Response Elements .. 33 Errors .. 33 See Also.. 33 ListExecutions .. 35 Request Syntax .. 35 Request Parameters .. 35 Response Syntax .. 36 Response Elements .. 36 Errors .. 37 See Also.. 37 ListStateMachines.. 38 Request Syntax .. 38 Request Parameters .. 38 Response Syntax .. 38 Response Elements .. 39 Errors .. 39 See Also.. 39 ListTagsForResource .. 41 Request Syntax .. 41 Request Parameters .. 41 Response Syntax.

4 41 Response Elements .. 41 Errors .. 41 See Also.. 42 SendTaskFailure .. 43 Request Syntax .. 43 Request Parameters .. 43 Response Elements .. 43 Errors .. 43 See Also.. 44 SendTaskHeartbeat .. 45 Request Syntax .. 45 Request Parameters .. 45 Response Elements .. 45 Errors .. 45 See Also.. 46 API Version 2016-11-23ivAWS step Functions API ReferenceSendTaskSuccess .. 47 Request Syntax .. 47 Request Parameters .. 47 Response Elements .. 47 Errors .. 47 See Also.. 48 StartExecution .. 49 Request Syntax .. 49 Request Parameters .. 49 Response Syntax .. 50 Response Elements .. 50 Errors .. 50 See Also.. 51 StopExecution .. 52 Request Syntax .. 52 Request Parameters .. 52 Response Syntax .. 52 Response Elements .. 53 Errors .. 53 See Also.. 53 TagResource .. 54 Request Syntax .. 54 Request Parameters .. 54 Response Elements.

5 54 Errors .. 54 See Also.. 55 UntagResource .. 56 Request Syntax .. 56 Request Parameters .. 56 Response Elements .. 56 Errors .. 56 See Also.. 57 UpdateStateMachine.. 58 Request Syntax .. 58 Request Parameters .. 58 Response Syntax .. 58 Response Elements .. 59 Errors .. 59 See Also.. 59 Data Types .. 61 ActivityFailedEventDetails .. 62 Contents.. 62 See Also.. 62 ActivityListItem.. 63 Contents.. 63 See Also.. 63 ActivityScheduledEventDetails .. 64 Contents.. 64 See Also.. 64 ActivityScheduleFailedEventDetails .. 65 Contents.. 65 See Also.. 65 ActivityStartedEventDetails .. 66 Contents.. 66 See Also.. 66 ActivitySucceededEventDetails .. 67 Contents.. 67 API Version 2016-11-23vAWS step Functions API ReferenceSee Also.. 67 ActivityTimedOutEventDetails .. 68 Contents.. 68 See Also.. 68 ExecutionAbortedEventDetails .. 69 Contents.

6 69 See Also.. 69 ExecutionFailedEventDetails .. 70 Contents.. 70 See Also.. 70 ExecutionListItem.. 71 Contents.. 71 See Also.. 72 ExecutionStartedEventDetails .. 73 Contents.. 73 See Also.. 73 ExecutionSucceededEventDetails .. 74 Contents.. 74 See Also.. 74 ExecutionTimedOutEventDetails .. 75 Contents.. 75 See Also.. 75 HistoryEvent .. 76 Contents.. 76 See Also.. 79 LambdaFunctionFailedEventDetails .. 80 Contents.. 80 See Also.. 80 LambdaFunctionScheduledEventDetails .. 81 Contents.. 81 See Also.. 81 LambdaFunctionScheduleFailedEventDetails .. 82 Contents.. 82 See Also.. 82 LambdaFunctionStartFailedEventDetails .. 83 Contents.. 83 See Also.. 83 LambdaFunctionSucceededEventDetails .. 84 Contents.. 84 See Also.. 84 LambdaFunctionTimedOutEventDetails .. 85 Contents.. 85 See Also.. 85 StateEnteredEventDetails .. 86 Contents.. 86 See Also.

7 86 StateExitedEventDetails .. 87 Contents.. 87 See Also.. 87 StateMachineListItem.. 88 Contents.. 88 See Also.. 88 Tag .. 89 Contents.. 89 See Also.. 89 TaskFailedEventDetails .. 90 Contents.. 90 API Version 2016-11-23viAWS step Functions API ReferenceSee Also.. 90 TaskScheduledEventDetails .. 91 Contents.. 91 See Also.. 91 TaskStartedEventDetails .. 93 Contents.. 93 See Also.. 93 TaskStartFailedEventDetails .. 94 Contents.. 94 See Also.. 94 TaskSubmitFailedEventDetails .. 95 Contents.. 95 See Also.. 95 TaskSubmittedEventDetails .. 96 Contents.. 96 See Also.. 96 TaskSucceededEventDetails .. 97 Contents.. 97 See Also.. 97 TaskTimedOutEventDetails .. 98 Contents.. 98 See Also.. 98 Common Parameters .. 99 Common Errors .. 101 API Version 2016-11-23viiAWS step Functions API ReferenceWelcomeAWS step Functions is a service that lets you coordinate the components of distributed applications andmicroservices using visual can use step Functions to build applications from individual components, each of which performs adiscrete function, or task, allowing you to scale and change applications quickly.

8 step Functions providesa console that helps visualize the components of your application as a series of steps. step Functionsautomatically triggers and tracks each step , and retries steps when there are errors, so your applicationexecutes predictably and in the right order every time. step Functions logs the state of each step , so youcan quickly diagnose and debug any Functions manages operations and underlying infrastructure to ensure your application is availableat any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You canaccess and use step Functions using the console, the AWS SDKs, or an HTTP API. For more informationabout step Functions , see the AWS step Functions Developer Guide .This document was last published on February 21, Version 2016-11-231 AWS step Functions API ReferenceActionsThe following actions are supported: CreateActivity (p.)

9 3) CreateStateMachine (p. 5) DeleteActivity (p. 8) DeleteStateMachine (p. 10) DescribeActivity (p. 12) DescribeExecution (p. 14) DescribeStateMachine (p. 17) DescribeStateMachineForExecution (p. 20) GetActivityTask (p. 23) GetExecutionHistory (p. 26) ListActivities (p. 32) ListExecutions (p. 35) ListStateMachines (p. 38) ListTagsForResource (p. 41) SendTaskFailure (p. 43) SendTaskHeartbeat (p. 45) SendTaskSuccess (p. 47) StartExecution (p. 49) StopExecution (p. 52) TagResource (p. 54) UntagResource (p. 56) UpdateStateMachine (p. 58)API Version 2016-11-232 AWS step Functions API ReferenceCreateActivityCreateActivityCre ates an activity. An activity is a task that you write in any programming language and host onany machine that has access to AWS step Functions . Activities must poll step Functions using theGetActivityTask API action and respond using SendTask* API actions. This function lets StepFunctions know the existence of your activity and returns an identifier for use in a state machine andwhen polling from the operation is eventually consistent.

10 The results are best effort and may not reflect veryrecent updates and Syntax{ "name": "string"}Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 99).The request accepts the following data in JSON (p. 3)The name of the activity to create. This name must be unique for your AWS account and region for90 days. For more information, see Limits Related to State Machine Executions in the AWS StepFunctions Developer name must not contain: whitespace brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ : / control characters (U+0000-001F, U+007F-009F)Type: StringLength Constraints: Minimum length of 1. Maximum length of : YesResponse Syntax{ "activityArn": "string", "creationDate": number}Response ElementsIf the action is successful, the service sends back an HTTP 200 Version 2016-11-233 AWS step Functions API ReferenceErrorsThe following data is returned in JSON format by the (p.)