AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .
", "license": { "name": "Apache 2.0 License", "url": "http://www.apache.org/licenses/" }, "termsOfService": "https://aws.amazon.com/service-terms/", "title": "AWS Step Functions", "version": "2016-11-23", "x-apiClientRegistration": { "url": "https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct" }, "x-apisguru-categories": [ "cloud" ], "x-logo": { "backgroundColor": "#FFFFFF", "url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png" }, "x-origin": [ { "contentType": "application/json", "converter": { "url": "https://github.com/mermade/aws2openapi", "version": "1.0.0" }, "url": "https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/states-2016-11-23.normal.json", "x-apisguru-driver": "external" } ], "x-preferred": true, "x-providerName": "amazonaws.com", "x-release": "v4", "x-serviceName": "states", "x-datafire": { "name": "amazonaws_states", "type": "openapi" } }, "host": "states.us-east-1.amazonaws.com", "basePath": "/", "schemes": [ "http" ], "paths": { "/#X-Amz-Target=AWSStepFunctions.CreateActivity": { "parameters": [ { "in": "header", "name": "X-Amz-Content-Sha256", "required": false, "type": "string" }, { "in": "header", "name": "X-Amz-Date", "required": false, "type": "string" }, { "in": "header", "name": "X-Amz-Algorithm", "required": false, "type": "string" }, { "in": "header", "name": "X-Amz-Credential", "required": false, "type": "string" }, { "in": "header", "name": "X-Amz-Security-Token", "required": false, "type": "string" }, { "in": "header", "name": "X-Amz-Signature", "required": false, "type": "string" }, { "in": "header", "name": "X-Amz-SignedHeaders", "required": false, "type": "string" } ], "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "enum": [ "AWSStepFunctions.CreateActivity" ], "in": "header", "name": "X-Amz-Target", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateActivityInput" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CreateActivityOutput" } }, "480": { "description": "ActivityLimitExceeded", "schema": { "$ref": "#/definitions/ActivityLimitExceeded" } }, "481": { "description": "InvalidName", "schema": { "$ref": "#/definitions/InvalidName" } }, "482": { "description": "TooManyTags", "schema": { "$ref": "#/definitions/TooManyTags" } } }, "description": "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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.
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. For more information, see Amazon States Language in the AWS Step Functions User Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration and TracingConfiguration. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
For EXPRESSstate machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Describes an execution.
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.
Describes a state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Describes the state machine associated with a specific execution.
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.
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.
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.
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.
This API action is not supported by EXPRESS state machines.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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.
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.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
taskToken failed.",
"operationId": "SendTaskFailure"
}
},
"/#X-Amz-Target=AWSStepFunctions.SendTaskHeartbeat": {
"parameters": [
{
"in": "header",
"name": "X-Amz-Content-Sha256",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-Date",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-Algorithm",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-Credential",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-Security-Token",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-Signature",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-SignedHeaders",
"required": false,
"type": "string"
}
],
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"enum": [
"AWSStepFunctions.SendTaskHeartbeat"
],
"in": "header",
"name": "X-Amz-Target",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/SendTaskHeartbeatInput"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/SendTaskHeartbeatOutput"
}
},
"480": {
"description": "TaskDoesNotExist",
"schema": {
"$ref": "#/definitions/TaskDoesNotExist"
}
},
"481": {
"description": "InvalidToken",
"schema": {
"$ref": "#/definitions/InvalidToken"
}
},
"482": {
"description": "TaskTimedOut",
"schema": {
"$ref": "#/definitions/TaskTimedOut"
}
}
},
"description": "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.
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. Use HeartbeatSeconds to configure the timeout interval for heartbeats.
taskToken completed successfully.",
"operationId": "SendTaskSuccess"
}
},
"/#X-Amz-Target=AWSStepFunctions.StartExecution": {
"parameters": [
{
"in": "header",
"name": "X-Amz-Content-Sha256",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-Date",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-Algorithm",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-Credential",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-Security-Token",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-Signature",
"required": false,
"type": "string"
},
{
"in": "header",
"name": "X-Amz-SignedHeaders",
"required": false,
"type": "string"
}
],
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"enum": [
"AWSStepFunctions.StartExecution"
],
"in": "header",
"name": "X-Amz-Target",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StartExecutionInput"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/StartExecutionOutput"
}
},
"480": {
"description": "ExecutionLimitExceeded",
"schema": {
"$ref": "#/definitions/ExecutionLimitExceeded"
}
},
"481": {
"description": "ExecutionAlreadyExists",
"schema": {
"$ref": "#/definitions/ExecutionAlreadyExists"
}
},
"482": {
"description": "InvalidArn",
"schema": {
"$ref": "#/definitions/InvalidArn"
}
},
"483": {
"description": "InvalidExecutionInput",
"schema": {
"$ref": "#/definitions/InvalidExecutionInput"
}
},
"484": {
"description": "InvalidName",
"schema": {
"$ref": "#/definitions/InvalidName"
}
},
"485": {
"description": "StateMachineDoesNotExist",
"schema": {
"$ref": "#/definitions/StateMachineDoesNotExist"
}
},
"486": {
"description": "StateMachineDeleting",
"schema": {
"$ref": "#/definitions/StateMachineDeleting"
}
}
},
"description": "Starts a state machine execution.
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.
Stops an execution.
This API action is not supported by EXPRESS state machines.
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. 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.
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.
The name of the activity.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
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 _.
" } ] } }, "required": [ "activityArn", "name", "creationDate" ], "type": "object" }, "ActivityScheduleFailedEventDetails": { "description": "Contains details about an activity schedule failure that occurred during an execution.", "properties": { "cause": { "allOf": [ { "$ref": "#/definitions/SensitiveCause" }, { "description": "A more detailed explanation of the cause of the failure." } ] }, "error": { "allOf": [ { "$ref": "#/definitions/SensitiveError" }, { "description": "The error code of the failure." } ] } }, "type": "object" }, "ActivityScheduledEventDetails": { "description": "Contains details about an activity scheduled during an execution.", "properties": { "heartbeatInSeconds": { "allOf": [ { "$ref": "#/definitions/TimeoutInSeconds" }, { "description": "The maximum allowed duration between two heartbeats for the activity task." } ] }, "input": { "allOf": [ { "$ref": "#/definitions/SensitiveData" }, { "description": "The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding." } ] }, "inputDetails": { "allOf": [ { "$ref": "#/definitions/HistoryEventExecutionDataDetails" }, { "description": "Contains details about the input for an execution history event." } ] }, "resource": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) of the scheduled activity." } ] }, "timeoutInSeconds": { "allOf": [ { "$ref": "#/definitions/TimeoutInSeconds" }, { "description": "The maximum allowed duration of the activity task." } ] } }, "required": [ "resource" ], "type": "object" }, "ActivityStartedEventDetails": { "description": "Contains details about the start of an activity during an execution.", "properties": { "workerName": { "allOf": [ { "$ref": "#/definitions/Identity" }, { "description": "The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask." } ] } }, "type": "object" }, "ActivitySucceededEventDetails": { "description": "Contains details about an activity that successfully terminated during an execution.", "properties": { "output": { "allOf": [ { "$ref": "#/definitions/SensitiveData" }, { "description": "The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding." } ] }, "outputDetails": { "allOf": [ { "$ref": "#/definitions/HistoryEventExecutionDataDetails" }, { "description": "Contains details about the output of an execution history event." } ] } }, "type": "object" }, "ActivityTimedOutEventDetails": { "description": "Contains details about an activity timeout that occurred during an execution.", "properties": { "cause": { "allOf": [ { "$ref": "#/definitions/SensitiveCause" }, { "description": "A more detailed explanation of the cause of the timeout." } ] }, "error": { "allOf": [ { "$ref": "#/definitions/SensitiveError" }, { "description": "The error code of the failure." } ] } }, "type": "object" }, "ActivityWorkerLimitExceeded": {}, "Arn": { "maxLength": 256, "minLength": 1, "type": "string" }, "BilledDuration": { "minimum": 0, "type": "integer" }, "BilledMemoryUsed": { "minimum": 0, "type": "integer" }, "BillingDetails": { "description": "An object that describes workflow billing details.", "properties": { "billedDurationInMilliseconds": { "allOf": [ { "$ref": "#/definitions/BilledDuration" }, { "description": "Billed duration of your workflow, in milliseconds." } ] }, "billedMemoryUsedInMB": { "allOf": [ { "$ref": "#/definitions/BilledMemoryUsed" }, { "description": "Billed memory consumption of your workflow, in MB." } ] } }, "type": "object" }, "CloudWatchEventsExecutionDataDetails": { "description": "Provides details about execution input or output.", "properties": { "included": { "allOf": [ { "$ref": "#/definitions/includedDetails" }, { "description": "Indicates whether input or output was included in the response. Alwaystrue for API calls. "
}
]
}
},
"type": "object"
},
"CloudWatchLogsLogGroup": {
"description": "",
"properties": {
"logGroupArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :* "
}
]
}
},
"type": "object"
},
"ConnectorParameters": {
"format": "password",
"maxLength": 262144,
"minLength": 0,
"type": "string"
},
"CreateActivityInput": {
"properties": {
"tags": {
"allOf": [
{
"$ref": "#/definitions/TagList"
},
{
"description": "The list of tags to add to a resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
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:
white space
brackets < > { } [ ]
wildcard characters ? *
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 _.
" } ] } }, "required": [ "name" ], "title": "CreateActivityInput", "type": "object" }, "CreateActivityOutput": { "properties": { "activityArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) that identifies the created activity." } ] }, "creationDate": { "allOf": [ { "$ref": "#/definitions/Timestamp" }, { "description": "The date the activity is created." } ] } }, "required": [ "activityArn", "creationDate" ], "type": "object" }, "CreateStateMachineInput": { "properties": { "tags": { "allOf": [ { "$ref": "#/definitions/TagList" }, { "description": "Tags to be added when creating a state machine.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
Defines what execution history events are logged and where they are logged.
By default, the level is set to OFF. For more information see Log Levels in the AWS Step Functions User Guide.
The name of the state machine.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
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 _.
" } ] }, "roleArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) of the IAM role to use for this state machine." } ] }, "tracingConfiguration": { "allOf": [ { "$ref": "#/definitions/TracingConfiguration" }, { "description": "Selects whether AWS X-Ray tracing is enabled." } ] }, "type": { "allOf": [ { "$ref": "#/definitions/StateMachineType" }, { "description": "Determines whether a Standard or Express state machine is created. The default isSTANDARD. You cannot update the type of a state machine once it has been created."
}
]
}
},
"required": [
"name",
"definition",
"roleArn"
],
"title": "CreateStateMachineInput",
"type": "object"
},
"CreateStateMachineOutput": {
"properties": {
"creationDate": {
"allOf": [
{
"$ref": "#/definitions/Timestamp"
},
{
"description": "The date the state machine is created."
}
]
},
"stateMachineArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) that identifies the created state machine."
}
]
}
},
"required": [
"stateMachineArn",
"creationDate"
],
"type": "object"
},
"Definition": {
"format": "password",
"maxLength": 1048576,
"minLength": 1,
"type": "string"
},
"DeleteActivityInput": {
"properties": {
"activityArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) of the activity to delete."
}
]
}
},
"required": [
"activityArn"
],
"title": "DeleteActivityInput",
"type": "object"
},
"DeleteActivityOutput": {
"properties": {},
"type": "object"
},
"DeleteStateMachineInput": {
"properties": {
"stateMachineArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) of the state machine to delete."
}
]
}
},
"required": [
"stateMachineArn"
],
"title": "DeleteStateMachineInput",
"type": "object"
},
"DeleteStateMachineOutput": {
"properties": {},
"type": "object"
},
"DescribeActivityInput": {
"properties": {
"activityArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) of the activity to describe."
}
]
}
},
"required": [
"activityArn"
],
"title": "DescribeActivityInput",
"type": "object"
},
"DescribeActivityOutput": {
"properties": {
"activityArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) that identifies the activity."
}
]
},
"creationDate": {
"allOf": [
{
"$ref": "#/definitions/Timestamp"
},
{
"description": "The date the activity is created."
}
]
},
"name": {
"allOf": [
{
"$ref": "#/definitions/Name"
},
{
"description": "The name of the activity.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
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 _.
" } ] } }, "required": [ "activityArn", "name", "creationDate" ], "type": "object" }, "DescribeExecutionInput": { "properties": { "executionArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) of the execution to describe." } ] } }, "required": [ "executionArn" ], "title": "DescribeExecutionInput", "type": "object" }, "DescribeExecutionOutput": { "properties": { "executionArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) that identifies the execution." } ] }, "input": { "allOf": [ { "$ref": "#/definitions/SensitiveData" }, { "description": "The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding." } ] }, "inputDetails": { "$ref": "#/definitions/CloudWatchEventsExecutionDataDetails" }, "name": { "allOf": [ { "$ref": "#/definitions/Name" }, { "description": "The name of the execution.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
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 _.
" } ] }, "output": { "allOf": [ { "$ref": "#/definitions/SensitiveData" }, { "description": "The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
The name of the state machine.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
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 _.
" } ] }, "roleArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "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.)" } ] }, "stateMachineArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) that identifies the state machine." } ] }, "status": { "allOf": [ { "$ref": "#/definitions/StateMachineStatus" }, { "description": "The current status of the state machine." } ] }, "tracingConfiguration": { "allOf": [ { "$ref": "#/definitions/TracingConfiguration" }, { "description": "Selects whether AWS X-Ray tracing is enabled." } ] }, "type": { "allOf": [ { "$ref": "#/definitions/StateMachineType" }, { "description": "Thetype of the state machine (STANDARD or EXPRESS)."
}
]
}
},
"required": [
"stateMachineArn",
"name",
"definition",
"roleArn",
"type",
"creationDate"
],
"type": "object"
},
"Enabled": {
"type": "boolean"
},
"EventId": {
"type": "integer"
},
"ExecutionAbortedEventDetails": {
"description": "Contains details about an abort of an execution.",
"properties": {
"cause": {
"allOf": [
{
"$ref": "#/definitions/SensitiveCause"
},
{
"description": "A more detailed explanation of the cause of the failure."
}
]
},
"error": {
"allOf": [
{
"$ref": "#/definitions/SensitiveError"
},
{
"description": "The error code of the failure."
}
]
}
},
"type": "object"
},
"ExecutionAlreadyExists": {},
"ExecutionDoesNotExist": {},
"ExecutionFailedEventDetails": {
"description": "Contains details about an execution failure event.",
"properties": {
"cause": {
"allOf": [
{
"$ref": "#/definitions/SensitiveCause"
},
{
"description": "A more detailed explanation of the cause of the failure."
}
]
},
"error": {
"allOf": [
{
"$ref": "#/definitions/SensitiveError"
},
{
"description": "The error code of the failure."
}
]
}
},
"type": "object"
},
"ExecutionLimitExceeded": {},
"ExecutionList": {
"items": {
"$ref": "#/definitions/ExecutionListItem"
},
"type": "array"
},
"ExecutionListItem": {
"description": "Contains details about an execution.",
"properties": {
"executionArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) that identifies the execution."
}
]
},
"name": {
"allOf": [
{
"$ref": "#/definitions/Name"
},
{
"description": "The name of the execution.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
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 _.
" } ] }, "startDate": { "allOf": [ { "$ref": "#/definitions/Timestamp" }, { "description": "The date the execution started." } ] }, "stateMachineArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) of the executed state machine." } ] }, "status": { "allOf": [ { "$ref": "#/definitions/ExecutionStatus" }, { "description": "The current status of the execution." } ] }, "stopDate": { "allOf": [ { "$ref": "#/definitions/Timestamp" }, { "description": "If the execution already ended, the date the execution stopped." } ] } }, "required": [ "executionArn", "stateMachineArn", "name", "status", "startDate" ], "type": "object" }, "ExecutionStartedEventDetails": { "description": "Contains details about the start of the execution.", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/SensitiveData" }, { "description": "The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding." } ] }, "inputDetails": { "allOf": [ { "$ref": "#/definitions/HistoryEventExecutionDataDetails" }, { "description": "Contains details about the input for an execution history event." } ] }, "roleArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks." } ] } }, "type": "object" }, "ExecutionStatus": { "enum": [ "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "ABORTED" ], "type": "string" }, "ExecutionSucceededEventDetails": { "description": "Contains details about the successful termination of the execution.", "properties": { "output": { "allOf": [ { "$ref": "#/definitions/SensitiveData" }, { "description": "The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding." } ] }, "outputDetails": { "allOf": [ { "$ref": "#/definitions/HistoryEventExecutionDataDetails" }, { "description": "Contains details about the output of an execution history event." } ] } }, "type": "object" }, "ExecutionTimedOutEventDetails": { "description": "Contains details about the execution timeout that occurred during the execution.", "properties": { "cause": { "allOf": [ { "$ref": "#/definitions/SensitiveCause" }, { "description": "A more detailed explanation of the cause of the timeout." } ] }, "error": { "allOf": [ { "$ref": "#/definitions/SensitiveError" }, { "description": "The error code of the failure." } ] } }, "type": "object" }, "GetActivityTaskInput": { "properties": { "activityArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)" } ] }, "workerName": { "allOf": [ { "$ref": "#/definitions/Name" }, { "description": "You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history." } ] } }, "required": [ "activityArn" ], "title": "GetActivityTaskInput", "type": "object" }, "GetActivityTaskOutput": { "properties": { "input": { "allOf": [ { "$ref": "#/definitions/SensitiveDataJobInput" }, { "description": "The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding." } ] }, "taskToken": { "allOf": [ { "$ref": "#/definitions/TaskToken" }, { "description": "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." } ] } }, "type": "object" }, "GetExecutionHistoryInput": { "properties": { "executionArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) of the execution." } ] }, "includeExecutionData": { "allOf": [ { "$ref": "#/definitions/IncludeExecutionDataGetExecutionHistory" }, { "description": "You can select whether execution data (input or output of a history event) is returned. The default istrue."
}
]
},
"maxResults": {
"allOf": [
{
"$ref": "#/definitions/PageSize"
},
{
"description": "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.
" } ] }, "nextToken": { "allOf": [ { "$ref": "#/definitions/PageToken" }, { "description": "IfnextToken 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."
}
]
},
"reverseOrder": {
"allOf": [
{
"$ref": "#/definitions/ReverseOrder"
},
{
"description": "Lists events in descending order of their timeStamp."
}
]
}
},
"required": [
"executionArn"
],
"title": "GetExecutionHistoryInput",
"type": "object"
},
"GetExecutionHistoryOutput": {
"properties": {
"events": {
"allOf": [
{
"$ref": "#/definitions/HistoryEventList"
},
{
"description": "The list of events that occurred in the execution."
}
]
},
"nextToken": {
"allOf": [
{
"$ref": "#/definitions/PageToken"
},
{
"description": "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."
}
]
}
},
"required": [
"events"
],
"type": "object"
},
"HistoryEvent": {
"description": "Contains details about the events of an execution.",
"properties": {
"activityFailedEventDetails": {
"$ref": "#/definitions/ActivityFailedEventDetails"
},
"activityScheduleFailedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/ActivityScheduleFailedEventDetails"
},
{
"description": "Contains details about an activity schedule event that failed during an execution."
}
]
},
"activityScheduledEventDetails": {
"$ref": "#/definitions/ActivityScheduledEventDetails"
},
"activityStartedEventDetails": {
"$ref": "#/definitions/ActivityStartedEventDetails"
},
"activitySucceededEventDetails": {
"$ref": "#/definitions/ActivitySucceededEventDetails"
},
"activityTimedOutEventDetails": {
"$ref": "#/definitions/ActivityTimedOutEventDetails"
},
"executionAbortedEventDetails": {
"$ref": "#/definitions/ExecutionAbortedEventDetails"
},
"executionFailedEventDetails": {
"$ref": "#/definitions/ExecutionFailedEventDetails"
},
"executionStartedEventDetails": {
"$ref": "#/definitions/ExecutionStartedEventDetails"
},
"executionSucceededEventDetails": {
"$ref": "#/definitions/ExecutionSucceededEventDetails"
},
"executionTimedOutEventDetails": {
"$ref": "#/definitions/ExecutionTimedOutEventDetails"
},
"id": {
"allOf": [
{
"$ref": "#/definitions/EventId"
},
{
"description": "The id of the event. Events are numbered sequentially, starting at one."
}
]
},
"lambdaFunctionFailedEventDetails": {
"$ref": "#/definitions/LambdaFunctionFailedEventDetails"
},
"lambdaFunctionScheduleFailedEventDetails": {
"$ref": "#/definitions/LambdaFunctionScheduleFailedEventDetails"
},
"lambdaFunctionScheduledEventDetails": {
"$ref": "#/definitions/LambdaFunctionScheduledEventDetails"
},
"lambdaFunctionStartFailedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/LambdaFunctionStartFailedEventDetails"
},
{
"description": "Contains details about a lambda function that failed to start during an execution."
}
]
},
"lambdaFunctionSucceededEventDetails": {
"allOf": [
{
"$ref": "#/definitions/LambdaFunctionSucceededEventDetails"
},
{
"description": "Contains details about a lambda function that terminated successfully during an execution."
}
]
},
"lambdaFunctionTimedOutEventDetails": {
"$ref": "#/definitions/LambdaFunctionTimedOutEventDetails"
},
"mapIterationAbortedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/MapIterationEventDetails"
},
{
"description": "Contains details about an iteration of a Map state that was aborted."
}
]
},
"mapIterationFailedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/MapIterationEventDetails"
},
{
"description": "Contains details about an iteration of a Map state that failed."
}
]
},
"mapIterationStartedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/MapIterationEventDetails"
},
{
"description": "Contains details about an iteration of a Map state that was started."
}
]
},
"mapIterationSucceededEventDetails": {
"allOf": [
{
"$ref": "#/definitions/MapIterationEventDetails"
},
{
"description": "Contains details about an iteration of a Map state that succeeded."
}
]
},
"mapStateStartedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/MapStateStartedEventDetails"
},
{
"description": "Contains details about Map state that was started."
}
]
},
"previousEventId": {
"allOf": [
{
"$ref": "#/definitions/EventId"
},
{
"description": "The id of the previous event."
}
]
},
"stateEnteredEventDetails": {
"$ref": "#/definitions/StateEnteredEventDetails"
},
"stateExitedEventDetails": {
"$ref": "#/definitions/StateExitedEventDetails"
},
"taskFailedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/TaskFailedEventDetails"
},
{
"description": "Contains details about the failure of a task."
}
]
},
"taskScheduledEventDetails": {
"allOf": [
{
"$ref": "#/definitions/TaskScheduledEventDetails"
},
{
"description": "Contains details about a task that was scheduled."
}
]
},
"taskStartFailedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/TaskStartFailedEventDetails"
},
{
"description": "Contains details about a task that failed to start."
}
]
},
"taskStartedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/TaskStartedEventDetails"
},
{
"description": "Contains details about a task that was started."
}
]
},
"taskSubmitFailedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/TaskSubmitFailedEventDetails"
},
{
"description": "Contains details about a task that where the submit failed."
}
]
},
"taskSubmittedEventDetails": {
"allOf": [
{
"$ref": "#/definitions/TaskSubmittedEventDetails"
},
{
"description": "Contains details about a submitted task."
}
]
},
"taskSucceededEventDetails": {
"allOf": [
{
"$ref": "#/definitions/TaskSucceededEventDetails"
},
{
"description": "Contains details about a task that succeeded."
}
]
},
"taskTimedOutEventDetails": {
"allOf": [
{
"$ref": "#/definitions/TaskTimedOutEventDetails"
},
{
"description": "Contains details about a task that timed out."
}
]
},
"timestamp": {
"allOf": [
{
"$ref": "#/definitions/Timestamp"
},
{
"description": "The date and time the event occurred."
}
]
},
"type": {
"allOf": [
{
"$ref": "#/definitions/HistoryEventType"
},
{
"description": "The type of the event."
}
]
}
},
"required": [
"timestamp",
"type",
"id"
],
"type": "object"
},
"HistoryEventExecutionDataDetails": {
"description": "Provides details about input or output in an execution history event.",
"properties": {
"truncated": {
"allOf": [
{
"$ref": "#/definitions/truncated"
},
{
"description": "Indicates whether input or output was truncated in the response. Always false for API calls."
}
]
}
},
"type": "object"
},
"HistoryEventList": {
"description": "Contains details about the events that occurred during an execution.",
"items": {
"$ref": "#/definitions/HistoryEvent"
},
"type": "array"
},
"HistoryEventType": {
"enum": [
"ActivityFailed",
"ActivityScheduled",
"ActivityScheduleFailed",
"ActivityStarted",
"ActivitySucceeded",
"ActivityTimedOut",
"ChoiceStateEntered",
"ChoiceStateExited",
"ExecutionAborted",
"ExecutionFailed",
"ExecutionStarted",
"ExecutionSucceeded",
"ExecutionTimedOut",
"FailStateEntered",
"LambdaFunctionFailed",
"LambdaFunctionScheduled",
"LambdaFunctionScheduleFailed",
"LambdaFunctionStarted",
"LambdaFunctionStartFailed",
"LambdaFunctionSucceeded",
"LambdaFunctionTimedOut",
"MapIterationAborted",
"MapIterationFailed",
"MapIterationStarted",
"MapIterationSucceeded",
"MapStateAborted",
"MapStateEntered",
"MapStateExited",
"MapStateFailed",
"MapStateStarted",
"MapStateSucceeded",
"ParallelStateAborted",
"ParallelStateEntered",
"ParallelStateExited",
"ParallelStateFailed",
"ParallelStateStarted",
"ParallelStateSucceeded",
"PassStateEntered",
"PassStateExited",
"SucceedStateEntered",
"SucceedStateExited",
"TaskFailed",
"TaskScheduled",
"TaskStarted",
"TaskStartFailed",
"TaskStateAborted",
"TaskStateEntered",
"TaskStateExited",
"TaskSubmitFailed",
"TaskSubmitted",
"TaskSucceeded",
"TaskTimedOut",
"WaitStateAborted",
"WaitStateEntered",
"WaitStateExited"
],
"type": "string"
},
"Identity": {
"maxLength": 256,
"type": "string"
},
"IncludeExecutionData": {
"type": "boolean"
},
"IncludeExecutionDataGetExecutionHistory": {
"type": "boolean"
},
"InvalidArn": {},
"InvalidDefinition": {},
"InvalidExecutionInput": {},
"InvalidLoggingConfiguration": {},
"InvalidName": {},
"InvalidOutput": {},
"InvalidToken": {},
"InvalidTracingConfiguration": {},
"LambdaFunctionFailedEventDetails": {
"description": "Contains details about a lambda function that failed during an execution.",
"properties": {
"cause": {
"allOf": [
{
"$ref": "#/definitions/SensitiveCause"
},
{
"description": "A more detailed explanation of the cause of the failure."
}
]
},
"error": {
"allOf": [
{
"$ref": "#/definitions/SensitiveError"
},
{
"description": "The error code of the failure."
}
]
}
},
"type": "object"
},
"LambdaFunctionScheduleFailedEventDetails": {
"description": "Contains details about a failed lambda function schedule event that occurred during an execution.",
"properties": {
"cause": {
"allOf": [
{
"$ref": "#/definitions/SensitiveCause"
},
{
"description": "A more detailed explanation of the cause of the failure."
}
]
},
"error": {
"allOf": [
{
"$ref": "#/definitions/SensitiveError"
},
{
"description": "The error code of the failure."
}
]
}
},
"type": "object"
},
"LambdaFunctionScheduledEventDetails": {
"description": "Contains details about a lambda function scheduled during an execution.",
"properties": {
"input": {
"allOf": [
{
"$ref": "#/definitions/SensitiveData"
},
{
"description": "The JSON data input to the lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding."
}
]
},
"inputDetails": {
"allOf": [
{
"$ref": "#/definitions/HistoryEventExecutionDataDetails"
},
{
"description": "Contains details about input for an execution history event."
}
]
},
"resource": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) of the scheduled lambda function."
}
]
},
"timeoutInSeconds": {
"allOf": [
{
"$ref": "#/definitions/TimeoutInSeconds"
},
{
"description": "The maximum allowed duration of the lambda function."
}
]
}
},
"required": [
"resource"
],
"type": "object"
},
"LambdaFunctionStartFailedEventDetails": {
"description": "Contains details about a lambda function that failed to start during an execution.",
"properties": {
"cause": {
"allOf": [
{
"$ref": "#/definitions/SensitiveCause"
},
{
"description": "A more detailed explanation of the cause of the failure."
}
]
},
"error": {
"allOf": [
{
"$ref": "#/definitions/SensitiveError"
},
{
"description": "The error code of the failure."
}
]
}
},
"type": "object"
},
"LambdaFunctionSucceededEventDetails": {
"description": "Contains details about a lambda function that successfully terminated during an execution.",
"properties": {
"output": {
"allOf": [
{
"$ref": "#/definitions/SensitiveData"
},
{
"description": "The JSON data output by the lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding."
}
]
},
"outputDetails": {
"allOf": [
{
"$ref": "#/definitions/HistoryEventExecutionDataDetails"
},
{
"description": "Contains details about the output of an execution history event."
}
]
}
},
"type": "object"
},
"LambdaFunctionTimedOutEventDetails": {
"description": "Contains details about a lambda function timeout that occurred during an execution.",
"properties": {
"cause": {
"allOf": [
{
"$ref": "#/definitions/SensitiveCause"
},
{
"description": "A more detailed explanation of the cause of the timeout."
}
]
},
"error": {
"allOf": [
{
"$ref": "#/definitions/SensitiveError"
},
{
"description": "The error code of the failure."
}
]
}
},
"type": "object"
},
"ListActivitiesInput": {
"properties": {
"maxResults": {
"allOf": [
{
"$ref": "#/definitions/PageSize"
},
{
"description": "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.
" } ] }, "nextToken": { "allOf": [ { "$ref": "#/definitions/PageToken" }, { "description": "IfnextToken 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."
}
]
}
},
"title": "ListActivitiesInput",
"type": "object"
},
"ListActivitiesOutput": {
"properties": {
"activities": {
"allOf": [
{
"$ref": "#/definitions/ActivityList"
},
{
"description": "The list of activities."
}
]
},
"nextToken": {
"allOf": [
{
"$ref": "#/definitions/PageToken"
},
{
"description": "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."
}
]
}
},
"required": [
"activities"
],
"type": "object"
},
"ListExecutionsInput": {
"properties": {
"maxResults": {
"allOf": [
{
"$ref": "#/definitions/PageSize"
},
{
"description": "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.
" } ] }, "nextToken": { "allOf": [ { "$ref": "#/definitions/ListExecutionsPageToken" }, { "description": "IfnextToken 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."
}
]
},
"stateMachineArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) of the state machine whose executions is listed."
}
]
},
"statusFilter": {
"allOf": [
{
"$ref": "#/definitions/ExecutionStatus"
},
{
"description": "If specified, only list the executions whose current execution status matches the given filter."
}
]
}
},
"required": [
"stateMachineArn"
],
"title": "ListExecutionsInput",
"type": "object"
},
"ListExecutionsOutput": {
"properties": {
"executions": {
"allOf": [
{
"$ref": "#/definitions/ExecutionList"
},
{
"description": "The list of matching executions."
}
]
},
"nextToken": {
"allOf": [
{
"$ref": "#/definitions/ListExecutionsPageToken"
},
{
"description": "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."
}
]
}
},
"required": [
"executions"
],
"type": "object"
},
"ListExecutionsPageToken": {
"maxLength": 3096,
"minLength": 1,
"type": "string"
},
"ListStateMachinesInput": {
"properties": {
"maxResults": {
"allOf": [
{
"$ref": "#/definitions/PageSize"
},
{
"description": "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.
" } ] }, "nextToken": { "allOf": [ { "$ref": "#/definitions/PageToken" }, { "description": "IfnextToken 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."
}
]
}
},
"title": "ListStateMachinesInput",
"type": "object"
},
"ListStateMachinesOutput": {
"properties": {
"nextToken": {
"allOf": [
{
"$ref": "#/definitions/PageToken"
},
{
"description": "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."
}
]
},
"stateMachines": {
"$ref": "#/definitions/StateMachineList"
}
},
"required": [
"stateMachines"
],
"type": "object"
},
"ListTagsForResourceInput": {
"properties": {
"resourceArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) for the Step Functions state machine or activity."
}
]
}
},
"required": [
"resourceArn"
],
"title": "ListTagsForResourceInput",
"type": "object"
},
"ListTagsForResourceOutput": {
"properties": {
"tags": {
"allOf": [
{
"$ref": "#/definitions/TagList"
},
{
"description": "An array of tags associated with the resource."
}
]
}
},
"type": "object"
},
"LogDestination": {
"description": "",
"properties": {
"cloudWatchLogsLogGroup": {
"allOf": [
{
"$ref": "#/definitions/CloudWatchLogsLogGroup"
},
{
"description": "An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide."
}
]
}
},
"type": "object"
},
"LogDestinationList": {
"items": {
"$ref": "#/definitions/LogDestination"
},
"type": "array"
},
"LogLevel": {
"enum": [
"ALL",
"ERROR",
"FATAL",
"OFF"
],
"type": "string"
},
"LoggingConfiguration": {
"description": "The LoggingConfiguration data type is used to set CloudWatch Logs options.",
"properties": {
"destinations": {
"allOf": [
{
"$ref": "#/definitions/LogDestinationList"
},
{
"description": "An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF."
}
]
},
"includeExecutionData": {
"allOf": [
{
"$ref": "#/definitions/IncludeExecutionData"
},
{
"description": "Determines whether execution data is included in your log. When set to false, data is excluded."
}
]
},
"level": {
"allOf": [
{
"$ref": "#/definitions/LogLevel"
},
{
"description": "Defines which category of execution history events are logged."
}
]
}
},
"type": "object"
},
"MapIterationEventDetails": {
"description": "Contains details about an iteration of a Map state.",
"properties": {
"index": {
"allOf": [
{
"$ref": "#/definitions/UnsignedInteger"
},
{
"description": "The index of the array belonging to the Map state iteration."
}
]
},
"name": {
"allOf": [
{
"$ref": "#/definitions/Name"
},
{
"description": "The name of the iteration’s parent Map state."
}
]
}
},
"type": "object"
},
"MapStateStartedEventDetails": {
"description": "Details about a Map state that was started.",
"properties": {
"length": {
"allOf": [
{
"$ref": "#/definitions/UnsignedInteger"
},
{
"description": "The size of the array for Map state iterations."
}
]
}
},
"type": "object"
},
"MissingRequiredParameter": {},
"Name": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"PageSize": {
"maximum": 1000,
"minimum": 0,
"type": "integer"
},
"PageToken": {
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
"ResourceNotFound": {},
"ReverseOrder": {
"type": "boolean"
},
"SendTaskFailureInput": {
"properties": {
"cause": {
"allOf": [
{
"$ref": "#/definitions/SensitiveCause"
},
{
"description": "A more detailed explanation of the cause of the failure."
}
]
},
"error": {
"allOf": [
{
"$ref": "#/definitions/SensitiveError"
},
{
"description": "The error code of the failure."
}
]
},
"taskToken": {
"allOf": [
{
"$ref": "#/definitions/TaskToken"
},
{
"description": "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 GetActivityTaskOutput$taskToken."
}
]
}
},
"required": [
"taskToken"
],
"title": "SendTaskFailureInput",
"type": "object"
},
"SendTaskFailureOutput": {
"properties": {},
"type": "object"
},
"SendTaskHeartbeatInput": {
"properties": {
"taskToken": {
"allOf": [
{
"$ref": "#/definitions/TaskToken"
},
{
"description": "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 GetActivityTaskOutput$taskToken."
}
]
}
},
"required": [
"taskToken"
],
"title": "SendTaskHeartbeatInput",
"type": "object"
},
"SendTaskHeartbeatOutput": {
"properties": {},
"type": "object"
},
"SendTaskSuccessInput": {
"properties": {
"output": {
"allOf": [
{
"$ref": "#/definitions/SensitiveData"
},
{
"description": "The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding."
}
]
},
"taskToken": {
"allOf": [
{
"$ref": "#/definitions/TaskToken"
},
{
"description": "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 GetActivityTaskOutput$taskToken."
}
]
}
},
"required": [
"taskToken",
"output"
],
"title": "SendTaskSuccessInput",
"type": "object"
},
"SendTaskSuccessOutput": {
"properties": {},
"type": "object"
},
"SensitiveCause": {
"format": "password",
"maxLength": 32768,
"minLength": 0,
"type": "string"
},
"SensitiveData": {
"format": "password",
"maxLength": 262144,
"type": "string"
},
"SensitiveDataJobInput": {
"format": "password",
"maxLength": 262144,
"type": "string"
},
"SensitiveError": {
"format": "password",
"maxLength": 256,
"minLength": 0,
"type": "string"
},
"StartExecutionInput": {
"properties": {
"input": {
"allOf": [
{
"$ref": "#/definitions/SensitiveData"
},
{
"description": "The string that contains the JSON input data for the execution, for example:
\"input\": \"{\\\"first_name\\\" : \\\"test\\\"}\"
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.
" } ] }, "name": { "allOf": [ { "$ref": "#/definitions/Name" }, { "description": "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 ? *
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 _.
" } ] }, "stateMachineArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) of the state machine to execute." } ] }, "traceHeader": { "allOf": [ { "$ref": "#/definitions/TraceHeader" }, { "description": "Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload." } ] } }, "required": [ "stateMachineArn" ], "title": "StartExecutionInput", "type": "object" }, "StartExecutionOutput": { "properties": { "executionArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) that identifies the execution." } ] }, "startDate": { "allOf": [ { "$ref": "#/definitions/Timestamp" }, { "description": "The date the execution is started." } ] } }, "required": [ "executionArn", "startDate" ], "type": "object" }, "StartSyncExecutionInput": { "properties": { "input": { "allOf": [ { "$ref": "#/definitions/SensitiveData" }, { "description": "The string that contains the JSON input data for the execution, for example:
\"input\": \"{\\\"first_name\\\" : \\\"test\\\"}\"
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.
" } ] }, "name": { "allOf": [ { "$ref": "#/definitions/Name" }, { "description": "The name of the execution." } ] }, "stateMachineArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) of the state machine to execute." } ] }, "traceHeader": { "allOf": [ { "$ref": "#/definitions/TraceHeader" }, { "description": "Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload." } ] } }, "required": [ "stateMachineArn" ], "title": "StartSyncExecutionInput", "type": "object" }, "StartSyncExecutionOutput": { "properties": { "billingDetails": { "allOf": [ { "$ref": "#/definitions/BillingDetails" }, { "description": "An object that describes workflow billing details, including billed duration and memory use." } ] }, "cause": { "allOf": [ { "$ref": "#/definitions/SensitiveCause" }, { "description": "A more detailed explanation of the cause of the failure." } ] }, "error": { "allOf": [ { "$ref": "#/definitions/SensitiveError" }, { "description": "The error code of the failure." } ] }, "executionArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) that identifies the execution." } ] }, "input": { "allOf": [ { "$ref": "#/definitions/SensitiveData" }, { "description": "The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding." } ] }, "inputDetails": { "$ref": "#/definitions/CloudWatchEventsExecutionDataDetails" }, "name": { "allOf": [ { "$ref": "#/definitions/Name" }, { "description": "The name of the execution." } ] }, "output": { "allOf": [ { "$ref": "#/definitions/SensitiveData" }, { "description": "The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
The name of the state.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
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 _.
" } ] }, "output": { "allOf": [ { "$ref": "#/definitions/SensitiveData" }, { "description": "The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding." } ] }, "outputDetails": { "allOf": [ { "$ref": "#/definitions/HistoryEventExecutionDataDetails" }, { "description": "Contains details about the output of an execution history event." } ] } }, "required": [ "name" ], "type": "object" }, "StateMachineAlreadyExists": {}, "StateMachineDeleting": {}, "StateMachineDoesNotExist": {}, "StateMachineLimitExceeded": {}, "StateMachineList": { "items": { "$ref": "#/definitions/StateMachineListItem" }, "type": "array" }, "StateMachineListItem": { "description": "Contains details about the state machine.", "properties": { "creationDate": { "allOf": [ { "$ref": "#/definitions/Timestamp" }, { "description": "The date the state machine is created." } ] }, "name": { "allOf": [ { "$ref": "#/definitions/Name" }, { "description": "The name of the state machine.
A name must not contain:
white space
brackets < > { } [ ]
wildcard characters ? *
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 _.
" } ] }, "stateMachineArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) that identifies the state machine." } ] }, "type": { "allOf": [ { "$ref": "#/definitions/StateMachineType" }, { "description": "" } ] } }, "required": [ "stateMachineArn", "name", "type", "creationDate" ], "type": "object" }, "StateMachineStatus": { "enum": [ "ACTIVE", "DELETING" ], "type": "string" }, "StateMachineType": { "enum": [ "STANDARD", "EXPRESS" ], "type": "string" }, "StateMachineTypeNotSupported": {}, "StopExecutionInput": { "properties": { "cause": { "allOf": [ { "$ref": "#/definitions/SensitiveCause" }, { "description": "A more detailed explanation of the cause of the failure." } ] }, "error": { "allOf": [ { "$ref": "#/definitions/SensitiveError" }, { "description": "The error code of the failure." } ] }, "executionArn": { "allOf": [ { "$ref": "#/definitions/Arn" }, { "description": "The Amazon Resource Name (ARN) of the execution to stop." } ] } }, "required": [ "executionArn" ], "title": "StopExecutionInput", "type": "object" }, "StopExecutionOutput": { "properties": { "stopDate": { "allOf": [ { "$ref": "#/definitions/Timestamp" }, { "description": "The date the execution is stopped." } ] } }, "required": [ "stopDate" ], "type": "object" }, "SyncExecutionStatus": { "enum": [ "SUCCEEDED", "FAILED", "TIMED_OUT" ], "type": "string" }, "Tag": { "description": "Tags are key-value pairs that can be associated with Step Functions state machines and activities.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
The list of tags to add to a resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
false ",
"properties": {
"enabled": {
"allOf": [
{
"$ref": "#/definitions/Enabled"
},
{
"description": "When set to true, AWS X-Ray tracing is enabled."
}
]
}
},
"type": "object"
},
"UnsignedInteger": {
"minimum": 0,
"type": "integer"
},
"UntagResourceInput": {
"properties": {
"resourceArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) for the Step Functions state machine or activity."
}
]
},
"tagKeys": {
"allOf": [
{
"$ref": "#/definitions/TagKeyList"
},
{
"description": "The list of tags to remove from the resource."
}
]
}
},
"required": [
"resourceArn",
"tagKeys"
],
"title": "UntagResourceInput",
"type": "object"
},
"UntagResourceOutput": {
"properties": {},
"type": "object"
},
"UpdateStateMachineInput": {
"properties": {
"definition": {
"allOf": [
{
"$ref": "#/definitions/Definition"
},
{
"description": "The Amazon States Language definition of the state machine. See Amazon States Language."
}
]
},
"loggingConfiguration": {
"allOf": [
{
"$ref": "#/definitions/LoggingConfiguration"
},
{
"description": "The LoggingConfiguration data type is used to set CloudWatch Logs options."
}
]
},
"roleArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) of the IAM role of the state machine."
}
]
},
"stateMachineArn": {
"allOf": [
{
"$ref": "#/definitions/Arn"
},
{
"description": "The Amazon Resource Name (ARN) of the state machine."
}
]
},
"tracingConfiguration": {
"allOf": [
{
"$ref": "#/definitions/TracingConfiguration"
},
{
"description": "Selects whether AWS X-Ray tracing is enabled."
}
]
}
},
"required": [
"stateMachineArn"
],
"title": "UpdateStateMachineInput",
"type": "object"
},
"UpdateStateMachineOutput": {
"properties": {
"updateDate": {
"allOf": [
{
"$ref": "#/definitions/Timestamp"
},
{
"description": "The date and time the state machine was updated."
}
]
}
},
"required": [
"updateDate"
],
"type": "object"
},
"includedDetails": {
"type": "boolean"
},
"truncated": {
"type": "boolean"
}
},
"securityDefinitions": {
"hmac": {
"description": "Amazon Signature authorization v4",
"in": "header",
"name": "Authorization",
"type": "apiKey",
"x-amazon-apigateway-authtype": "awsSigv4"
}
},
"security": [
{
"hmac": []
}
],
"externalDocs": {
"description": "Amazon Web Services documentation",
"url": "https://docs.aws.amazon.com/states/"
},
"x-components": {
"parameters": {
"X-Amz-Algorithm": {
"in": "header",
"name": "X-Amz-Algorithm",
"required": false,
"type": "string"
},
"X-Amz-Content-Sha256": {
"in": "header",
"name": "X-Amz-Content-Sha256",
"required": false,
"type": "string"
},
"X-Amz-Credential": {
"in": "header",
"name": "X-Amz-Credential",
"required": false,
"type": "string"
},
"X-Amz-Date": {
"in": "header",
"name": "X-Amz-Date",
"required": false,
"type": "string"
},
"X-Amz-Security-Token": {
"in": "header",
"name": "X-Amz-Security-Token",
"required": false,
"type": "string"
},
"X-Amz-Signature": {
"in": "header",
"name": "X-Amz-Signature",
"required": false,
"type": "string"
},
"X-Amz-SignedHeaders": {
"in": "header",
"name": "X-Amz-SignedHeaders",
"required": false,
"type": "string"
}
}
},
"x-hasEquivalentPaths": true
}