# Step Functions Service API

Requests use [`CloudEnvAction`](../../../models.py): `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`

```bash
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`_

```bash
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`

```bash
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`

```bash
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`

```bash
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`

```bash
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`

```bash
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`

```bash
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`

```bash
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`

```bash
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`

```bash
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`

```bash
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`_

```bash
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`

```bash
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`_

```bash
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`

```bash
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`_

```bash
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`_

```bash
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`

```bash
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`

```bash
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`_

```bash
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`_

```bash
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`_

```bash
curl -X POST http://localhost:8000/step \
  -H "Content-Type: application/json" \
  -d @- <<'EOF'
{
  "service": "stepfunctions",
  "operation": "ListTagsForResource",
  "payload": {
    "resourceArn": "example-arn"
  }
}
```

---