See Also
] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListActivities
ListActivities
Lists the existing activities.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
NoteThis operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Request Syntax
{ "maxResults": number, "nextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 122).
The request accepts the following data in JSON format.
maxResults (p. 36)
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No nextToken (p. 36)
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
Response Syntax
{
Response Elements
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
activities (p. 36) The list of activities.
Type: Array of ActivityListItem (p. 74) objects nextToken (p. 36)
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 124).
InvalidToken
The provided token is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
See Also
• AWS SDK for Ruby V3
ListExecutions
ListExecutions
Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Note
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
Request Syntax
{ "maxResults": number, "nextToken": "string", "stateMachineArn": "string", "statusFilter": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 122).
The request accepts the following data in JSON format.
maxResults (p. 39)
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No nextToken (p. 39)
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3096.
Response Syntax
Required: No stateMachineArn (p. 39)
The Amazon Resource Name (ARN) of the state machine whose executions is listed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes statusFilter (p. 39)
If specified, only list the executions whose current execution status matches the given filter.
Type: String
Valid Values: RUNNING | SUCCEEDED | FAILED | TIMED_OUT | ABORTED Required: No
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
executions (p. 40)
The list of matching executions.
Type: Array of ExecutionListItem (p. 86) objects nextToken (p. 40)
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3096.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 124).
InvalidArn
The provided Amazon Resource Name (ARN) is invalid.
HTTP Status Code: 400 InvalidToken
The provided token is invalid.
HTTP Status Code: 400 StateMachineDoesNotExist
The specified state machine does not exist.
HTTP Status Code: 400 StateMachineTypeNotSupported
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListStateMachines
ListStateMachines
Lists the existing state machines.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
NoteThis operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Request Syntax
{ "maxResults": number, "nextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 122).
The request accepts the following data in JSON format.
maxResults (p. 42)
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No nextToken (p. 42)
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
Response Syntax
{
Response Elements
"nextToken": "string", "stateMachines": [
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
nextToken (p. 42)
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
stateMachines (p. 42)
Type: Array of StateMachineListItem (p. 109) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 124).
InvalidToken
The provided token is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
See Also
ListTagsForResource
ListTagsForResource
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
Request Syntax
{ "resourceArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 122).
The request accepts the following data in JSON format.
resourceArn (p. 45)
The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
Response Syntax
{ "tags": [ {
"key": "string", "value": "string"
} ]}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
tags (p. 45)
An array of tags associated with the resource.
Type: Array of Tag (p. 111) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 124).
See Also
InvalidArn
The provided Amazon Resource Name (ARN) is invalid.
HTTP Status Code: 400 ResourceNotFound
Could not find the referenced resource. Only state machine and activity ARNs are supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
SendTaskFailure
SendTaskFailure
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
Request Syntax
{
"cause": "string", "error": "string", "taskToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 122).
The request accepts the following data in JSON format.
cause (p. 47)
A more detailed explanation of the cause of the failure.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 32768.
Required: No error (p. 47)
The error code of the failure.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No taskToken (p. 47)
The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTask:taskToken (p. 27).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 124).
InvalidToken
The provided token is invalid.
HTTP Status Code: 400 TaskDoesNotExist
HTTP Status Code: 400 TaskTimedOut
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
SendTaskHeartbeat
SendTaskHeartbeat
Used by activity workers and task states using the callback pattern to report to Step Functions 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 (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern.
NoteThe 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 (p. 49) requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.
Request Syntax
{ "taskToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 122).
The request accepts the following data in JSON format.
taskToken (p. 49)
The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTask:taskToken (p. 27).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 124).
InvalidToken
The provided token is invalid.
HTTP Status Code: 400 TaskDoesNotExist
HTTP Status Code: 400
See Also
TaskTimedOut
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
SendTaskSuccess
SendTaskSuccess
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
Request Syntax
{ "output": "string", "taskToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 122).
The request accepts the following data in JSON format.
output (p. 51)
The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
Type: String
Length Constraints: Maximum length of 262144.
Required: Yes taskToken (p. 51)
The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTask:taskToken (p. 27).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 124).
InvalidOutput
The provided JSON output data is invalid.
HTTP Status Code: 400
See Also
InvalidToken
The provided token is invalid.
HTTP Status Code: 400 TaskDoesNotExist
HTTP Status Code: 400 TaskTimedOut
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
StartExecution
StartExecution
Starts a state machine execution.
Note
StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
StartExecution is not idempotent for EXPRESS workflows.
Request Syntax
{ "input": "string", "name": "string",
"stateMachineArn": "string", "traceHeader": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 122).
The request accepts the following data in JSON format.
input (p. 53)
The string that contains the JSON input data for the execution, for example:
"input": "{\"first_name\" : \"test\"}"
Note
If you don't include any JSON input data, you still must include the two braces, for example:
"input": "{}"
Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
Type: String
Length Constraints: Maximum length of 262144.
Required: No name (p. 53)
The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
A name must not contain:
• white space
• brackets < > { } [ ]
• wildcard characters ? *
Response Syntax
• special characters " # % \ ^ | ~ ` $ & , ; : /
• control characters (U+0000-001F, U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
Required: No stateMachineArn (p. 53)
The Amazon Resource Name (ARN) of the state machine to execute.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes traceHeader (p. 53)
Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: \p{ASCII}*
Required: No
Response Syntax
{
"executionArn": "string", "startDate": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
executionArn (p. 54)
The Amazon Resource Name (ARN) that identifies the execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
startDate (p. 54)
The date the execution is started.
Type: Timestamp
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 124).
ExecutionAlreadyExists
The execution has the same name as another execution (but a different input).
NoteExecutions with the same name and input are considered idempotent.
HTTP Status Code: 400 ExecutionLimitExceeded
The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
HTTP Status Code: 400 InvalidArn
The provided Amazon Resource Name (ARN) is invalid.
HTTP Status Code: 400 InvalidExecutionInput
The provided JSON input data is invalid.
HTTP Status Code: 400 InvalidName
The provided name is invalid.
HTTP Status Code: 400 StateMachineDeleting
The specified state machine is being deleted.
HTTP Status Code: 400 StateMachineDoesNotExist
The specified state machine does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
See Also
• AWS SDK for Python
• AWS SDK for Ruby V3
StartSyncExecution
StartSyncExecution
Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.
Note
StartSyncExecution will return a 200 OK response, even if your execution fails, because
StartSyncExecution will return a 200 OK response, even if your execution fails, because