Step Functions Service API
Requests use CloudEnvAction: service, operation, and payload (boto3 parameters for the operation).
Operations are enforced by IAM as stepfunctions:<OperationName> (see adapter).
Operations
CreateStateMachine
Boto3 client method: create_state_machine
Other boto3 parameters (optional): encryptionConfiguration, loggingConfiguration, publish, tags, tracingConfiguration, type, versionDescription
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "CreateStateMachine",
"payload": {
"name": "example-name",
"definition": "example-definition",
"roleArn": "example-arn"
}
}
DeleteStateMachine
Boto3 client method: delete_state_machine
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "DeleteStateMachine",
"payload": {
"stateMachineArn": "example-arn"
}
}
DescribeStateMachine
Boto3 client method: describe_state_machine
Other boto3 parameters (optional): includedData
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "DescribeStateMachine",
"payload": {
"stateMachineArn": "example-arn"
}
}
UpdateStateMachine
Boto3 client method: update_state_machine
Other boto3 parameters (optional): definition, encryptionConfiguration, loggingConfiguration, publish, roleArn, tracingConfiguration, versionDescription
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "UpdateStateMachine",
"payload": {
"stateMachineArn": "example-arn"
}
}
ListStateMachines
Boto3 client method: list_state_machines
Other boto3 parameters (optional): maxResults, nextToken
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "ListStateMachines",
"payload": {}
}
StartExecution
Boto3 client method: start_execution
Other boto3 parameters (optional): input, name, traceHeader
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "StartExecution",
"payload": {
"stateMachineArn": "example-arn"
}
}
StartSyncExecution
Boto3 client method: start_sync_execution
Other boto3 parameters (optional): includedData, input, name, traceHeader
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "StartSyncExecution",
"payload": {
"stateMachineArn": "example-arn"
}
}
StopExecution
Boto3 client method: stop_execution
Other boto3 parameters (optional): cause, error
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "StopExecution",
"payload": {
"executionArn": "example-arn"
}
}
DescribeExecution
Boto3 client method: describe_execution
Other boto3 parameters (optional): includedData
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "DescribeExecution",
"payload": {
"executionArn": "example-arn"
}
}
DescribeStateMachineForExecution
Boto3 client method: describe_state_machine_for_execution
Other boto3 parameters (optional): includedData
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "DescribeStateMachineForExecution",
"payload": {
"executionArn": "example-arn"
}
}
ListExecutions
Boto3 client method: list_executions
Other boto3 parameters (optional): mapRunArn, maxResults, nextToken, redriveFilter, stateMachineArn, statusFilter
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "ListExecutions",
"payload": {}
}
GetExecutionHistory
Boto3 client method: get_execution_history
Other boto3 parameters (optional): includeExecutionData, maxResults, nextToken, reverseOrder
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "GetExecutionHistory",
"payload": {
"executionArn": "example-arn"
}
}
SendTaskSuccess
Boto3 client method: send_task_success
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "SendTaskSuccess",
"payload": {
"taskToken": "example-tasktoken",
"output": "example-sensitivedata"
}
}
SendTaskFailure
Boto3 client method: send_task_failure
Other boto3 parameters (optional): cause, error
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "SendTaskFailure",
"payload": {
"taskToken": "example-tasktoken"
}
}
SendTaskHeartbeat
Boto3 client method: send_task_heartbeat
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "SendTaskHeartbeat",
"payload": {
"taskToken": "example-tasktoken"
}
}
CreateActivity
Boto3 client method: create_activity
Other boto3 parameters (optional): encryptionConfiguration, tags
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "CreateActivity",
"payload": {
"name": "example-name"
}
}
DeleteActivity
Boto3 client method: delete_activity
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "DeleteActivity",
"payload": {
"activityArn": "example-arn"
}
}
DescribeActivity
Boto3 client method: describe_activity
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "DescribeActivity",
"payload": {
"activityArn": "example-arn"
}
}
ListActivities
Boto3 client method: list_activities
Other boto3 parameters (optional): maxResults, nextToken
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "ListActivities",
"payload": {}
}
GetActivityTask
Boto3 client method: get_activity_task
Other boto3 parameters (optional): workerName
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "GetActivityTask",
"payload": {
"activityArn": "example-arn"
}
}
TagResource
Boto3 client method: tag_resource
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "TagResource",
"payload": {
"resourceArn": "example-arn",
"tags": [
{}
]
}
}
UntagResource
Boto3 client method: untag_resource
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "UntagResource",
"payload": {
"resourceArn": "example-arn",
"tagKeys": [
"example-tagkey"
]
}
}
ListTagsForResource
Boto3 client method: list_tags_for_resource
curl -X POST http://localhost:8000/step \
-H "Content-Type: application/json" \
-d @- <<'EOF'
{
"service": "stepfunctions",
"operation": "ListTagsForResource",
"payload": {
"resourceArn": "example-arn"
}
}