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 Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the Step Functions Developer Guide .
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: states x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/states-2016-11-23.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://states.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS SFN multi-region endpoint - url: https://states.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS SFN multi-region endpoint - url: http://states.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS SFN endpoint for China (Beijing) and China (Ningxia) - url: https://states.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS SFN endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=AWSStepFunctions.DescribeStateMachineForExecution' paths: /#X-Amz-Target=AWSStepFunctions.DescribeStateMachineForExecution: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: DescribeStateMachineForExecution description:Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.
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.
false, data is excluded.
destinations:
allOf:
- $ref: '#/components/schemas/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.
description: The LoggingConfiguration data type is used to set CloudWatch Logs options.
TracingConfiguration:
type: object
properties:
enabled:
allOf:
- $ref: '#/components/schemas/Enabled'
- description: When set to true, X-Ray tracing is enabled.
description: 'Selects whether or not the state machine''s X-Ray tracing is enabled. Default is false '
IncludeExecutionData:
type: boolean
LogLevel:
type: string
enum:
- ALL
- ERROR
- FATAL
- 'OFF'
Arn:
type: string
minLength: 1
maxLength: 256
LogDestination:
type: object
properties:
cloudWatchLogsLogGroup:
allOf:
- $ref: '#/components/schemas/CloudWatchLogsLogGroup'
- description: An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.
description:
Timestamp:
type: string
format: date-time
DescribeStateMachineForExecutionOutput:
type: object
required:
- stateMachineArn
- name
- definition
- roleArn
- updateDate
properties:
stateMachineArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the state machine associated with the execution.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the state machine associated with the execution.
definition:
allOf:
- $ref: '#/components/schemas/Definition'
- description: The Amazon States Language definition of the state machine. See Amazon States Language.
roleArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 'The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution. '
updateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
loggingConfiguration:
$ref: '#/components/schemas/LoggingConfiguration'
tracingConfiguration:
allOf:
- $ref: '#/components/schemas/TracingConfiguration'
- description: Selects whether X-Ray tracing is enabled.
mapRunArn:
allOf:
- $ref: '#/components/schemas/LongArn'
- description: The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
label:
allOf:
- $ref: '#/components/schemas/MapRunLabel'
- description: A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
Definition:
type: string
minLength: 1
maxLength: 1048576
format: password
CloudWatchLogsLogGroup:
type: object
properties:
logGroupArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 'The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :* '
description:
Name:
type: string
minLength: 1
maxLength: 80
InvalidArn: {}
ExecutionDoesNotExist: {}
LogDestinationList:
type: array
items:
$ref: '#/components/schemas/LogDestination'
parameters:
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/states/
x-hasEquivalentPaths: true