The #X Amz Target=AWSStepFunctions.DescribeExecution API from Amazon Step Functions — 1 operation(s) for #x amz target=awsstepfunctions.describeexecution.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-step-functions-x-amz-target-awsstepfunctions-describeexecution-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: '2016-11-23'
x-release: v4
title: 'AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeExecution API'
description: <fullname>Step Functions</fullname> <p>Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.</p> <p>You can use Step Functions to build applications from individual components, each of which performs a discrete function, or <i>task</i>, 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.</p> <p>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 <i> <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a> </i>.</p>
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
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.DescribeExecution'
paths:
/#X-Amz-Target=AWSStepFunctions.DescribeExecution:
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: DescribeExecution
description: <p>Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.</p> <p>If you specify a version or alias ARN when you call the <a>StartExecution</a> API action, <code>DescribeExecution</code> returns that ARN.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>Executions of an <code>EXPRESS</code> state machinearen't supported by <code>DescribeExecution</code> unless a Map Run dispatched them.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeExecutionOutput'
examples:
DescribeExecution200Example:
summary: Default DescribeExecution 200
x-microcks-default: true
value:
executionArn: arn:aws:service:us-east-1:123456789012:resource/example
stateMachineArn: arn:aws:service:us-east-1:123456789012:resource/example
name: MyResource
status: Active
startDate: example-value
stopDate: example-value
input: example-value
inputDetails:
included: example-value
output: example-value
outputDetails:
included: example-value
traceHeader: example-value
mapRunArn: arn:aws:service:us-east-1:123456789012:resource/example
error: example-value
cause: example-value
stateMachineVersionArn: arn:aws:service:us-east-1:123456789012:resource/example
stateMachineAliasArn: arn:aws:service:us-east-1:123456789012:resource/example
'480':
description: ExecutionDoesNotExist
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutionDoesNotExist'
examples:
DescribeExecution480Example:
summary: Default DescribeExecution 480
x-microcks-default: true
value: example-value
'481':
description: InvalidArn
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArn'
examples:
DescribeExecution481Example:
summary: Default DescribeExecution 481
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeExecutionInput'
examples:
DescribeExecutionRequestExample:
summary: Default DescribeExecution request
x-microcks-default: true
value:
executionArn: arn:aws:service:us-east-1:123456789012:resource/example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSStepFunctions.DescribeExecution
summary: Amazon Describe Execution
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSStepFunctions.DescribeExecution'
components:
schemas:
Name:
type: string
minLength: 1
maxLength: 80
Timestamp:
type: string
format: date-time
Arn:
type: string
minLength: 1
maxLength: 256
SensitiveCause:
type: string
minLength: 0
maxLength: 32768
format: password
DescribeExecutionOutput:
type: object
required:
- executionArn
- stateMachineArn
- status
- startDate
properties:
executionArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) that identifies the execution.
stateMachineArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the executed stated machine.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: '<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>'
status:
allOf:
- $ref: '#/components/schemas/ExecutionStatus'
- description: The current status of the execution.
startDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the execution is started.
stopDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: If the execution ended, the date the execution stopped.
input:
allOf:
- $ref: '#/components/schemas/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: '#/components/schemas/CloudWatchEventsExecutionDataDetails'
output:
allOf:
- $ref: '#/components/schemas/SensitiveData'
- description: <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p> <note> <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p> </note>
outputDetails:
$ref: '#/components/schemas/CloudWatchEventsExecutionDataDetails'
traceHeader:
allOf:
- $ref: '#/components/schemas/TraceHeader'
- description: The X-Ray trace header that was passed to the execution.
mapRunArn:
allOf:
- $ref: '#/components/schemas/LongArn'
- description: The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
error:
allOf:
- $ref: '#/components/schemas/SensitiveError'
- description: The error string if the state machine execution failed.
cause:
allOf:
- $ref: '#/components/schemas/SensitiveCause'
- description: The cause string if the state machine execution failed.
stateMachineVersionArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: <p>The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p> <p>If you start an execution from a <code>StartExecution</code> request without specifying a state machine version or alias ARN, Step Functions returns a null value.</p>
stateMachineAliasArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: <p>The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, <code>stateMachineARN:PROD</code>.</p> <p>If you start an execution from a <code>StartExecution</code> request with a state machine version ARN, this field will be null.</p>
InvalidArn: {}
TraceHeader:
type: string
pattern: \p{ASCII}*
minLength: 0
maxLength: 256
DescribeExecutionInput:
type: object
required:
- executionArn
title: DescribeExecutionInput
properties:
executionArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the execution to describe.
includedDetails:
type: boolean
SensitiveData:
type: string
maxLength: 262144
format: password
ExecutionStatus:
type: string
enum:
- RUNNING
- SUCCEEDED
- FAILED
- TIMED_OUT
- ABORTED
CloudWatchEventsExecutionDataDetails:
type: object
properties:
included:
allOf:
- $ref: '#/components/schemas/includedDetails'
- description: 'Indicates whether input or output was included in the response. Always <code>true</code> for API calls. '
description: Provides details about execution input or output.
LongArn:
type: string
minLength: 1
maxLength: 2000
SensitiveError:
type: string
minLength: 0
maxLength: 256
format: password
ExecutionDoesNotExist: {}
parameters:
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
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