The #X Amz Target=AWSStepFunctions.ListExecutions API from Amazon Step Functions — 1 operation(s) for #x amz target=awsstepfunctions.listexecutions.
openapi: 3.1.0
info:
title: 'Amazon Step Functions Executions #X Amz Target=AWSStepFunctions.ListExecutions API'
description: Amazon Step Functions is a serverless workflow orchestration service that lets you coordinate distributed applications and microservices using visual workflows. This API enables you to create and manage state machines, start and monitor executions, and retrieve execution history.
version: '2016-11-23'
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
termsOfService: https://aws.amazon.com/service-terms/
servers:
- url: https://states.{region}.amazonaws.com
description: Amazon Step Functions Regional Endpoint
variables:
region:
default: us-east-1
description: AWS Region
security:
- sigv4Auth: []
tags:
- name: '#X Amz Target=AWSStepFunctions.ListExecutions'
paths:
/#X-Amz-Target=AWSStepFunctions.ListExecutions:
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: ListExecutions
description: <p>Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.</p> <p>You can also provide a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> ARN or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a> ARN to list the executions associated with a specific alias or version.</p> <p>Results are sorted by time, with the most recent execution first.</p> <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> 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 <i>HTTP 400 InvalidToken</i> error.</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>This API action is not supported by <code>EXPRESS</code> state machines.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListExecutionsOutput'
examples:
ListExecutions200Example:
summary: Default ListExecutions 200
x-microcks-default: true
value:
executions: example-value
nextToken: example-value
'480':
description: InvalidArn
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArn'
examples:
ListExecutions480Example:
summary: Default ListExecutions 480
x-microcks-default: true
value: example-value
'481':
description: InvalidToken
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidToken'
examples:
ListExecutions481Example:
summary: Default ListExecutions 481
x-microcks-default: true
value: example-value
'482':
description: StateMachineDoesNotExist
content:
application/json:
schema:
$ref: '#/components/schemas/StateMachineDoesNotExist'
examples:
ListExecutions482Example:
summary: Default ListExecutions 482
x-microcks-default: true
value: example-value
'483':
description: StateMachineTypeNotSupported
content:
application/json:
schema:
$ref: '#/components/schemas/StateMachineTypeNotSupported'
examples:
ListExecutions483Example:
summary: Default ListExecutions 483
x-microcks-default: true
value: example-value
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListExecutions484Example:
summary: Default ListExecutions 484
x-microcks-default: true
value: example-value
'485':
description: ResourceNotFound
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
examples:
ListExecutions485Example:
summary: Default ListExecutions 485
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListExecutionsInput'
examples:
ListExecutionsRequestExample:
summary: Default ListExecutions request
x-microcks-default: true
value:
stateMachineArn: arn:aws:service:us-east-1:123456789012:resource/example
statusFilter: Active
maxResults: example-value
nextToken: example-value
mapRunArn: arn:aws:service:us-east-1:123456789012:resource/example
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSStepFunctions.ListExecutions
summary: Amazon List Executions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSStepFunctions.ListExecutions'
components:
schemas:
ExecutionListItem:
type: object
required:
- executionArn
- stateMachineArn
- name
- 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 state machine that ran the execution.
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 started.
stopDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: If the execution already ended, the date the execution stopped.
mapRunArn:
allOf:
- $ref: '#/components/schemas/LongArn'
- description: The Amazon Resource Name (ARN) of a Map Run. This field is returned only if <code>mapRunArn</code> was specified in the <code>ListExecutions</code> API action. If <code>stateMachineArn</code> was specified in <code>ListExecutions</code>, the <code>mapRunArn</code> isn't returned.
itemCount:
allOf:
- $ref: '#/components/schemas/UnsignedInteger'
- description: The total number of items processed in a child workflow execution. This field is returned only if <code>mapRunArn</code> was specified in the <code>ListExecutions</code> API action. If <code>stateMachineArn</code> was specified in <code>ListExecutions</code>, the <code>itemCount</code> field isn't returned.
stateMachineVersionArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: <p>The Amazon Resource Name (ARN) of the state machine version associated with the execution.</p> <p>If the state machine execution was started with an unqualified ARN, it returns null.</p> <p>If the execution was started using a <code>stateMachineAliasArn</code>, both the <code>stateMachineAliasArn</code> and <code>stateMachineVersionArn</code> parameters contain the respective values.</p>
stateMachineAliasArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: <p>The Amazon Resource Name (ARN) of the state machine alias used to start an execution.</p> <p>If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.</p>
description: Contains details about an execution.
ExecutionList:
type: array
items:
$ref: '#/components/schemas/ExecutionListItem'
UnsignedInteger:
type: integer
minimum: 0
PageSize:
type: integer
minimum: 0
maximum: 1000
Name:
type: string
minLength: 1
maxLength: 80
ValidationException: {}
StateMachineTypeNotSupported: {}
ExecutionStatus:
type: string
enum:
- RUNNING
- SUCCEEDED
- FAILED
- TIMED_OUT
- ABORTED
InvalidToken: {}
InvalidArn: {}
ListExecutionsPageToken:
type: string
minLength: 1
maxLength: 3096
ListExecutionsOutput:
type: object
required:
- executions
properties:
executions:
allOf:
- $ref: '#/components/schemas/ExecutionList'
- description: The list of matching executions.
nextToken:
allOf:
- $ref: '#/components/schemas/ListExecutionsPageToken'
- description: If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> 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 <i>HTTP 400 InvalidToken</i> error.
LongArn:
type: string
minLength: 1
maxLength: 2000
ListExecutionsInput:
type: object
title: ListExecutionsInput
properties:
stateMachineArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: <p>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</p> <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p> <p>You can also return a list of executions associated with a specific <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, by specifying an alias ARN or a version ARN in the <code>stateMachineArn</code> parameter.</p>
statusFilter:
allOf:
- $ref: '#/components/schemas/ExecutionStatus'
- description: If specified, only list the executions whose current execution status matches the given filter.
maxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> 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.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
nextToken:
allOf:
- $ref: '#/components/schemas/ListExecutionsPageToken'
- description: If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> 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 <i>HTTP 400 InvalidToken</i> error.
mapRunArn:
allOf:
- $ref: '#/components/schemas/LongArn'
- description: <p>The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the <code>mapRunArn</code> field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>.</p> <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p>
StateMachineDoesNotExist: {}
ResourceNotFound: {}
Timestamp:
type: string
format: date-time
Arn:
type: string
minLength: 1
maxLength: 256
parameters:
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
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-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
securitySchemes:
sigv4Auth:
type: apiKey
name: Authorization
in: header
description: AWS Signature Version 4 authentication
externalDocs:
description: Amazon Step Functions API Reference
url: https://docs.aws.amazon.com/step-functions/latest/apireference/