Table of Contents
A low-level client representing AWS Step Functions (SFN):
import boto3
client = boto3.client('stepfunctions')
These are the available methods:
Check if an operation can be paginated.
Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.
See also: AWS API Documentation
Request Syntax
response = client.create_activity(
name='string'
)
[REQUIRED]
The name of the activity to create. This name must be unique for your AWS account and region 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:
{
'activityArn': 'string',
'creationDate': datetime(2015, 1, 1)
}
Response Structure
The Amazon Resource Name (ARN) that identifies the created activity.
The date the activity is created.
Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language.
See also: AWS API Documentation
Request Syntax
response = client.create_state_machine(
name='string',
definition='string',
roleArn='string'
)
[REQUIRED]
The name of the state machine.
A name must not contain:
[REQUIRED]
The Amazon States Language definition of the state machine. See Amazon States Language .
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
dict
Response Syntax
{
'stateMachineArn': 'string',
'creationDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
stateMachineArn (string) --
The Amazon Resource Name (ARN) that identifies the created state machine.
creationDate (datetime) --
The date the state machine is created.
Deletes an activity.
See also: AWS API Documentation
Request Syntax
response = client.delete_activity(
activityArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the activity to delete.
{}
Response Structure
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition.
Note
The state machine itself is deleted after all executions are completed or deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_state_machine(
stateMachineArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the state machine to delete.
{}
Response Structure
Describes an activity.
Note
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
See also: AWS API Documentation
Request Syntax
response = client.describe_activity(
activityArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the activity to describe.
{
'activityArn': 'string',
'name': 'string',
'creationDate': datetime(2015, 1, 1)
}
Response Structure
The Amazon Resource Name (ARN) that identifies the activity.
The name of the activity.
A name must not contain:
The date the activity is created.
Describes an execution.
Note
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
See also: AWS API Documentation
Request Syntax
response = client.describe_execution(
executionArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the execution to describe.
{
'executionArn': 'string',
'stateMachineArn': 'string',
'name': 'string',
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
'startDate': datetime(2015, 1, 1),
'stopDate': datetime(2015, 1, 1),
'input': 'string',
'output': 'string'
}
Response Structure
The Amazon Resource Name (ARN) that identifies the execution.
The Amazon Resource Name (ARN) of the executed stated machine.
The name of the execution.
A name must not contain:
The current status of the execution.
The date the execution is started.
If the execution has already ended, the date the execution stopped.
The string that contains the JSON input data of the execution.
The JSON output data of the execution.
Note
This field is set only if the execution succeeds. If the execution fails, this field is null.
Describes a state machine.
Note
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
See also: AWS API Documentation
Request Syntax
response = client.describe_state_machine(
stateMachineArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the state machine to describe.
{
'stateMachineArn': 'string',
'name': 'string',
'status': 'ACTIVE'|'DELETING',
'definition': 'string',
'roleArn': 'string',
'creationDate': datetime(2015, 1, 1)
}
Response Structure
The Amazon Resource Name (ARN) that identifies the state machine.
The name of the state machine.
A name must not contain:
The current status of the state machine.
The Amazon States Language definition of the state machine. See Amazon States Language .
The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)
The date the state machine is created.
Describes the state machine associated with a specific execution.
Note
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
See also: AWS API Documentation
Request Syntax
response = client.describe_state_machine_for_execution(
executionArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the execution you want state machine information for.
{
'stateMachineArn': 'string',
'name': 'string',
'definition': 'string',
'roleArn': 'string',
'updateDate': datetime(2015, 1, 1)
}
Response Structure
The Amazon Resource Name (ARN) of the state machine associated with the execution.
The name of the state machine associated with the execution.
The Amazon States Language definition of the state machine. See Amazon States Language .
The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
Generate a presigned url given a client, its method, and arguments
The presigned url
Used by workers to retrieve a task (with the specified activity ARN) which has been 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 returns a taskToken with a null string.
Warning
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).
Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.get_activity_task(
activityArn='string',
workerName='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity .)
dict
Response Syntax
{
'taskToken': 'string',
'input': 'string'
}
Response Structure
(dict) --
taskToken (string) --
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 (string) --
The string that contains the JSON input data for the task.
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.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_execution_history(
executionArn='string',
maxResults=123,
reverseOrder=True|False,
nextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the execution.
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.
dict
Response Syntax
{
'events': [
{
'timestamp': datetime(2015, 1, 1),
'type': 'ActivityFailed'|'ActivityScheduleFailed'|'ActivityScheduled'|'ActivityStarted'|'ActivitySucceeded'|'ActivityTimedOut'|'ChoiceStateEntered'|'ChoiceStateExited'|'TaskFailed'|'TaskScheduled'|'TaskStartFailed'|'TaskStarted'|'TaskSubmitFailed'|'TaskSubmitted'|'TaskSucceeded'|'TaskTimedOut'|'ExecutionFailed'|'ExecutionStarted'|'ExecutionSucceeded'|'ExecutionAborted'|'ExecutionTimedOut'|'FailStateEntered'|'LambdaFunctionFailed'|'LambdaFunctionScheduleFailed'|'LambdaFunctionScheduled'|'LambdaFunctionStartFailed'|'LambdaFunctionStarted'|'LambdaFunctionSucceeded'|'LambdaFunctionTimedOut'|'SucceedStateEntered'|'SucceedStateExited'|'TaskStateAborted'|'TaskStateEntered'|'TaskStateExited'|'PassStateEntered'|'PassStateExited'|'ParallelStateAborted'|'ParallelStateEntered'|'ParallelStateExited'|'ParallelStateFailed'|'ParallelStateStarted'|'ParallelStateSucceeded'|'WaitStateAborted'|'WaitStateEntered'|'WaitStateExited',
'id': 123,
'previousEventId': 123,
'activityFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'activityScheduleFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'activityScheduledEventDetails': {
'resource': 'string',
'input': 'string',
'timeoutInSeconds': 123,
'heartbeatInSeconds': 123
},
'activityStartedEventDetails': {
'workerName': 'string'
},
'activitySucceededEventDetails': {
'output': 'string'
},
'activityTimedOutEventDetails': {
'error': 'string',
'cause': 'string'
},
'taskFailedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'taskScheduledEventDetails': {
'resourceType': 'string',
'resource': 'string',
'region': 'string',
'parameters': 'string',
'timeoutInSeconds': 123
},
'taskStartFailedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'taskStartedEventDetails': {
'resourceType': 'string',
'resource': 'string'
},
'taskSubmitFailedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'taskSubmittedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'output': 'string'
},
'taskSucceededEventDetails': {
'resourceType': 'string',
'resource': 'string',
'output': 'string'
},
'taskTimedOutEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'executionFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'executionStartedEventDetails': {
'input': 'string',
'roleArn': 'string'
},
'executionSucceededEventDetails': {
'output': 'string'
},
'executionAbortedEventDetails': {
'error': 'string',
'cause': 'string'
},
'executionTimedOutEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionScheduleFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionScheduledEventDetails': {
'resource': 'string',
'input': 'string',
'timeoutInSeconds': 123
},
'lambdaFunctionStartFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionSucceededEventDetails': {
'output': 'string'
},
'lambdaFunctionTimedOutEventDetails': {
'error': 'string',
'cause': 'string'
},
'stateEnteredEventDetails': {
'name': 'string',
'input': 'string'
},
'stateExitedEventDetails': {
'name': 'string',
'output': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
events (list) --
The list of events that occurred in the execution.
(dict) --
Contains details about the events of an execution.
timestamp (datetime) --
The date and time the event occurred.
type (string) --
The type of the event.
id (integer) --
The id of the event. Events are numbered sequentially, starting at one.
previousEventId (integer) --
The id of the previous event.
activityFailedEventDetails (dict) --
Contains details about an activity that failed during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
activityScheduleFailedEventDetails (dict) --
Contains details about an activity schedule event that failed during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
activityScheduledEventDetails (dict) --
Contains details about an activity scheduled during an execution.
resource (string) --
The Amazon Resource Name (ARN) of the scheduled activity.
input (string) --
The JSON data input to the activity task.
timeoutInSeconds (integer) --
The maximum allowed duration of the activity task.
heartbeatInSeconds (integer) --
The maximum allowed duration between two heartbeats for the activity task.
activityStartedEventDetails (dict) --
Contains details about the start of an activity during an execution.
workerName (string) --
The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask .
activitySucceededEventDetails (dict) --
Contains details about an activity that successfully terminated during an execution.
output (string) --
The JSON data output by the activity task.
activityTimedOutEventDetails (dict) --
Contains details about an activity timeout that occurred during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
taskFailedEventDetails (dict) --
Contains details about a task failure event.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
taskScheduledEventDetails (dict) --
Contains details about a task scheduled during an execution.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
region (string) --
The region of the scheduled task
parameters (string) --
The JSON data passed to the resource referenced in a task state.
timeoutInSeconds (integer) --
The maximum allowed duration of the task.
taskStartFailedEventDetails (dict) --
Contains details about a task that failed to start during an execution.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
taskStartedEventDetails (dict) --
Contains details about the start of a task during an execution.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
taskSubmitFailedEventDetails (dict) --
Contains details about a task that failed to submit during an execution.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
taskSubmittedEventDetails (dict) --
Contains details about a task submitted to a resource .
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
output (string) --
The response from a resource when a task has started.
taskSucceededEventDetails (dict) --
Contains details about the successful completion of a task state.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
output (string) --
The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task.
taskTimedOutEventDetails (dict) --
Contains details about a resource timeout that occurred during an execution.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionFailedEventDetails (dict) --
Contains details about an execution failure event.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionStartedEventDetails (dict) --
Contains details about the start of the execution.
input (string) --
The JSON data input to the execution.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.
executionSucceededEventDetails (dict) --
Contains details about the successful termination of the execution.
output (string) --
The JSON data output by the execution.
executionAbortedEventDetails (dict) --
Contains details about an abort of an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionTimedOutEventDetails (dict) --
Contains details about the execution timeout that occurred during the execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
lambdaFunctionFailedEventDetails (dict) --
Contains details about a lambda function that failed during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionScheduleFailedEventDetails (dict) --
Contains details about a failed lambda function schedule event that occurred during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionScheduledEventDetails (dict) --
Contains details about a lambda function scheduled during an execution.
resource (string) --
The Amazon Resource Name (ARN) of the scheduled lambda function.
input (string) --
The JSON data input to the lambda function.
timeoutInSeconds (integer) --
The maximum allowed duration of the lambda function.
lambdaFunctionStartFailedEventDetails (dict) --
Contains details about a lambda function that failed to start during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionSucceededEventDetails (dict) --
Contains details about a lambda function that terminated successfully during an execution.
output (string) --
The JSON data output by the lambda function.
lambdaFunctionTimedOutEventDetails (dict) --
Contains details about a lambda function timeout that occurred during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
stateEnteredEventDetails (dict) --
Contains details about a state entered during an execution.
name (string) --
The name of the state.
input (string) --
The string that contains the JSON input data for the state.
stateExitedEventDetails (dict) --
Contains details about an exit from a state during an execution.
name (string) --
The name of the state.
A name must not contain:
output (string) --
The JSON output data of the state.
nextToken (string) --
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.
Create a paginator for an operation.
Returns an object that can wait for some condition.
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.
Note
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
See also: AWS API Documentation
Request Syntax
response = client.list_activities(
maxResults=123,
nextToken='string'
)
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.
dict
Response Syntax
{
'activities': [
{
'activityArn': 'string',
'name': 'string',
'creationDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
activities (list) --
The list of activities.
(dict) --
Contains details about an activity.
activityArn (string) --
The Amazon Resource Name (ARN) that identifies the activity.
name (string) --
The name of the activity.
A name must not contain:
creationDate (datetime) --
The date the activity is created.
nextToken (string) --
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.
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.
See also: AWS API Documentation
Request Syntax
response = client.list_executions(
stateMachineArn='string',
statusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the state machine whose executions is listed.
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.
dict
Response Syntax
{
'executions': [
{
'executionArn': 'string',
'stateMachineArn': 'string',
'name': 'string',
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
'startDate': datetime(2015, 1, 1),
'stopDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
executions (list) --
The list of matching executions.
(dict) --
Contains details about an execution.
executionArn (string) --
The Amazon Resource Name (ARN) that identifies the execution.
stateMachineArn (string) --
The Amazon Resource Name (ARN) of the executed state machine.
name (string) --
The name of the execution.
A name must not contain:
status (string) --
The current status of the execution.
startDate (datetime) --
The date the execution started.
stopDate (datetime) --
If the execution already ended, the date the execution stopped.
nextToken (string) --
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.
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.
Note
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
See also: AWS API Documentation
Request Syntax
response = client.list_state_machines(
maxResults=123,
nextToken='string'
)
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.
dict
Response Syntax
{
'stateMachines': [
{
'stateMachineArn': 'string',
'name': 'string',
'creationDate': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
stateMachines (list) --
(dict) --
Contains details about the state machine.
stateMachineArn (string) --
The Amazon Resource Name (ARN) that identifies the state machine.
name (string) --
The name of the state machine.
A name must not contain:
creationDate (datetime) --
The date the state machine is created.
nextToken (string) --
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.
List tags for a given resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
{
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
An array of tags associated with the resource.
Tags are key-value pairs that can be associated with Step Functions state machines and activities.
The key of a tag.
The value of a tag.
Used by workers to report that the task identified by the taskToken failed.
See also: AWS API Documentation
Request Syntax
response = client.send_task_failure(
taskToken='string',
error='string',
cause='string'
)
[REQUIRED]
The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).
dict
Response Syntax
{}
Response Structure
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 contains an ActivityTimedOut event.
Note
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.
Note
This operation is only useful for long-lived tasks to report the liveliness of the task.
See also: AWS API Documentation
Request Syntax
response = client.send_task_heartbeat(
taskToken='string'
)
[REQUIRED]
The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTaskOutput$taskToken ).
{}
Response Structure
Used by workers to report that the task identified by the taskToken completed successfully.
See also: AWS API Documentation
Request Syntax
response = client.send_task_success(
taskToken='string',
output='string'
)
[REQUIRED]
The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTaskOutput$taskToken ).
[REQUIRED]
The JSON output of the task.
dict
Response Syntax
{}
Response Structure
Starts a state machine execution.
Note
StartExecution is idempotent. 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.
See also: AWS API Documentation
Request Syntax
response = client.start_execution(
stateMachineArn='string',
name='string',
input='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the state machine to execute.
The name of the execution. This name must be unique for your AWS account and region 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:
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": "{}"
dict
Response Syntax
{
'executionArn': 'string',
'startDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
executionArn (string) --
The Amazon Resource Name (ARN) that identifies the execution.
startDate (datetime) --
The date the execution is started.
Stops an execution.
See also: AWS API Documentation
Request Syntax
response = client.stop_execution(
executionArn='string',
error='string',
cause='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the execution to stop.
dict
Response Syntax
{
'stopDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
stopDate (datetime) --
The date the execution is stopped.
Add a tag to a Step Functions resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
[REQUIRED]
The list of tags to add to a resource.
Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @ .
Tags are key-value pairs that can be associated with Step Functions state machines and activities.
The key of a tag.
The value of a tag.
dict
Response Syntax
{}
Response Structure
Remove a tag from a Step Functions resource
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
[REQUIRED]
The list of tags to remove from the resource.
dict
Response Syntax
{}
Response Structure
Updates an existing state machine by modifying its definition and/or roleArn . Running executions will continue to use the previous definition and roleArn . You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
Note
All StartExecution calls within a few seconds will use the updated definition and roleArn . Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn .
See also: AWS API Documentation
Request Syntax
response = client.update_state_machine(
stateMachineArn='string',
definition='string',
roleArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the state machine.
dict
Response Syntax
{
'updateDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
updateDate (datetime) --
The date and time the state machine was updated.
The available paginators are:
paginator = client.get_paginator('get_execution_history')
Creates an iterator that will paginate through responses from SFN.Client.get_execution_history().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
executionArn='string',
reverseOrder=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the execution.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'events': [
{
'timestamp': datetime(2015, 1, 1),
'type': 'ActivityFailed'|'ActivityScheduleFailed'|'ActivityScheduled'|'ActivityStarted'|'ActivitySucceeded'|'ActivityTimedOut'|'ChoiceStateEntered'|'ChoiceStateExited'|'TaskFailed'|'TaskScheduled'|'TaskStartFailed'|'TaskStarted'|'TaskSubmitFailed'|'TaskSubmitted'|'TaskSucceeded'|'TaskTimedOut'|'ExecutionFailed'|'ExecutionStarted'|'ExecutionSucceeded'|'ExecutionAborted'|'ExecutionTimedOut'|'FailStateEntered'|'LambdaFunctionFailed'|'LambdaFunctionScheduleFailed'|'LambdaFunctionScheduled'|'LambdaFunctionStartFailed'|'LambdaFunctionStarted'|'LambdaFunctionSucceeded'|'LambdaFunctionTimedOut'|'SucceedStateEntered'|'SucceedStateExited'|'TaskStateAborted'|'TaskStateEntered'|'TaskStateExited'|'PassStateEntered'|'PassStateExited'|'ParallelStateAborted'|'ParallelStateEntered'|'ParallelStateExited'|'ParallelStateFailed'|'ParallelStateStarted'|'ParallelStateSucceeded'|'WaitStateAborted'|'WaitStateEntered'|'WaitStateExited',
'id': 123,
'previousEventId': 123,
'activityFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'activityScheduleFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'activityScheduledEventDetails': {
'resource': 'string',
'input': 'string',
'timeoutInSeconds': 123,
'heartbeatInSeconds': 123
},
'activityStartedEventDetails': {
'workerName': 'string'
},
'activitySucceededEventDetails': {
'output': 'string'
},
'activityTimedOutEventDetails': {
'error': 'string',
'cause': 'string'
},
'taskFailedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'taskScheduledEventDetails': {
'resourceType': 'string',
'resource': 'string',
'region': 'string',
'parameters': 'string',
'timeoutInSeconds': 123
},
'taskStartFailedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'taskStartedEventDetails': {
'resourceType': 'string',
'resource': 'string'
},
'taskSubmitFailedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'taskSubmittedEventDetails': {
'resourceType': 'string',
'resource': 'string',
'output': 'string'
},
'taskSucceededEventDetails': {
'resourceType': 'string',
'resource': 'string',
'output': 'string'
},
'taskTimedOutEventDetails': {
'resourceType': 'string',
'resource': 'string',
'error': 'string',
'cause': 'string'
},
'executionFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'executionStartedEventDetails': {
'input': 'string',
'roleArn': 'string'
},
'executionSucceededEventDetails': {
'output': 'string'
},
'executionAbortedEventDetails': {
'error': 'string',
'cause': 'string'
},
'executionTimedOutEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionScheduleFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionScheduledEventDetails': {
'resource': 'string',
'input': 'string',
'timeoutInSeconds': 123
},
'lambdaFunctionStartFailedEventDetails': {
'error': 'string',
'cause': 'string'
},
'lambdaFunctionSucceededEventDetails': {
'output': 'string'
},
'lambdaFunctionTimedOutEventDetails': {
'error': 'string',
'cause': 'string'
},
'stateEnteredEventDetails': {
'name': 'string',
'input': 'string'
},
'stateExitedEventDetails': {
'name': 'string',
'output': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
events (list) --
The list of events that occurred in the execution.
(dict) --
Contains details about the events of an execution.
timestamp (datetime) --
The date and time the event occurred.
type (string) --
The type of the event.
id (integer) --
The id of the event. Events are numbered sequentially, starting at one.
previousEventId (integer) --
The id of the previous event.
activityFailedEventDetails (dict) --
Contains details about an activity that failed during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
activityScheduleFailedEventDetails (dict) --
Contains details about an activity schedule event that failed during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
activityScheduledEventDetails (dict) --
Contains details about an activity scheduled during an execution.
resource (string) --
The Amazon Resource Name (ARN) of the scheduled activity.
input (string) --
The JSON data input to the activity task.
timeoutInSeconds (integer) --
The maximum allowed duration of the activity task.
heartbeatInSeconds (integer) --
The maximum allowed duration between two heartbeats for the activity task.
activityStartedEventDetails (dict) --
Contains details about the start of an activity during an execution.
workerName (string) --
The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask .
activitySucceededEventDetails (dict) --
Contains details about an activity that successfully terminated during an execution.
output (string) --
The JSON data output by the activity task.
activityTimedOutEventDetails (dict) --
Contains details about an activity timeout that occurred during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
taskFailedEventDetails (dict) --
Contains details about a task failure event.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
taskScheduledEventDetails (dict) --
Contains details about a task scheduled during an execution.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
region (string) --
The region of the scheduled task
parameters (string) --
The JSON data passed to the resource referenced in a task state.
timeoutInSeconds (integer) --
The maximum allowed duration of the task.
taskStartFailedEventDetails (dict) --
Contains details about a task that failed to start during an execution.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
taskStartedEventDetails (dict) --
Contains details about the start of a task during an execution.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
taskSubmitFailedEventDetails (dict) --
Contains details about a task that failed to submit during an execution.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
taskSubmittedEventDetails (dict) --
Contains details about a task submitted to a resource .
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
output (string) --
The response from a resource when a task has started.
taskSucceededEventDetails (dict) --
Contains details about the successful completion of a task state.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
output (string) --
The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task.
taskTimedOutEventDetails (dict) --
Contains details about a resource timeout that occurred during an execution.
resourceType (string) --
The action of the resource called by a task state.
resource (string) --
The service name of the resource in a task state.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionFailedEventDetails (dict) --
Contains details about an execution failure event.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionStartedEventDetails (dict) --
Contains details about the start of the execution.
input (string) --
The JSON data input to the execution.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.
executionSucceededEventDetails (dict) --
Contains details about the successful termination of the execution.
output (string) --
The JSON data output by the execution.
executionAbortedEventDetails (dict) --
Contains details about an abort of an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
executionTimedOutEventDetails (dict) --
Contains details about the execution timeout that occurred during the execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
lambdaFunctionFailedEventDetails (dict) --
Contains details about a lambda function that failed during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionScheduleFailedEventDetails (dict) --
Contains details about a failed lambda function schedule event that occurred during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionScheduledEventDetails (dict) --
Contains details about a lambda function scheduled during an execution.
resource (string) --
The Amazon Resource Name (ARN) of the scheduled lambda function.
input (string) --
The JSON data input to the lambda function.
timeoutInSeconds (integer) --
The maximum allowed duration of the lambda function.
lambdaFunctionStartFailedEventDetails (dict) --
Contains details about a lambda function that failed to start during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the failure.
lambdaFunctionSucceededEventDetails (dict) --
Contains details about a lambda function that terminated successfully during an execution.
output (string) --
The JSON data output by the lambda function.
lambdaFunctionTimedOutEventDetails (dict) --
Contains details about a lambda function timeout that occurred during an execution.
error (string) --
The error code of the failure.
cause (string) --
A more detailed explanation of the cause of the timeout.
stateEnteredEventDetails (dict) --
Contains details about a state entered during an execution.
name (string) --
The name of the state.
input (string) --
The string that contains the JSON input data for the state.
stateExitedEventDetails (dict) --
Contains details about an exit from a state during an execution.
name (string) --
The name of the state.
A name must not contain:
output (string) --
The JSON output data of the state.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_activities')
Creates an iterator that will paginate through responses from SFN.Client.list_activities().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'activities': [
{
'activityArn': 'string',
'name': 'string',
'creationDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
The list of activities.
Contains details about an activity.
The Amazon Resource Name (ARN) that identifies the activity.
The name of the activity.
A name must not contain:
The date the activity is created.
A token to resume pagination.
paginator = client.get_paginator('list_executions')
Creates an iterator that will paginate through responses from SFN.Client.list_executions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
stateMachineArn='string',
statusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the state machine whose executions is listed.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'executions': [
{
'executionArn': 'string',
'stateMachineArn': 'string',
'name': 'string',
'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
'startDate': datetime(2015, 1, 1),
'stopDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
executions (list) --
The list of matching executions.
(dict) --
Contains details about an execution.
executionArn (string) --
The Amazon Resource Name (ARN) that identifies the execution.
stateMachineArn (string) --
The Amazon Resource Name (ARN) of the executed state machine.
name (string) --
The name of the execution.
A name must not contain:
status (string) --
The current status of the execution.
startDate (datetime) --
The date the execution started.
stopDate (datetime) --
If the execution already ended, the date the execution stopped.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_state_machines')
Creates an iterator that will paginate through responses from SFN.Client.list_state_machines().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'stateMachines': [
{
'stateMachineArn': 'string',
'name': 'string',
'creationDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
Contains details about the state machine.
The Amazon Resource Name (ARN) that identifies the state machine.
The name of the state machine.
A name must not contain:
The date the state machine is created.
A token to resume pagination.