The #X Amz Target=AWSStepFunctions.StartExecution API from Amazon Step Functions — 1 operation(s) for #x amz target=awsstepfunctions.startexecution.
openapi: 3.1.0
info:
title: 'Amazon Step Functions Executions #X Amz Target=AWSStepFunctions.StartExecution 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.StartExecution'
paths:
/#X-Amz-Target=AWSStepFunctions.StartExecution:
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: StartExecution
description: <p>Starts a state machine execution.</p> <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p> <p>The following are some examples of qualified and unqualified state machine ARNs:</p> <ul> <li> <p>The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <code>ValidationException</code>.</p> </note> </li> <li> <p>The following qualified state machine ARN refers to an alias named <code>PROD</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.</p> </note> </li> <li> <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code> </p> </li> </ul> <p>If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.</p> <p>To start executions of a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, call <code>StartExecution</code> and provide the version ARN or the ARN of an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> that points to the version.</p> <note> <p> <code>StartExecution</code> is idempotent for <code>STANDARD</code> workflows. For a <code>STANDARD</code> workflow, if you call <code>StartExecution</code> with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a <code>400 ExecutionAlreadyExists</code> error. You can reuse names after 90 days. </p> <p> <code>StartExecution</code> isn't idempotent for <code>EXPRESS</code> workflows. </p> </note>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartExecutionOutput'
examples:
StartExecution200Example:
summary: Default StartExecution 200
x-microcks-default: true
value:
executionArn: arn:aws:service:us-east-1:123456789012:resource/example
startDate: example-value
'480':
description: ExecutionLimitExceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutionLimitExceeded'
examples:
StartExecution480Example:
summary: Default StartExecution 480
x-microcks-default: true
value: example-value
'481':
description: ExecutionAlreadyExists
content:
application/json:
schema:
$ref: '#/components/schemas/ExecutionAlreadyExists'
examples:
StartExecution481Example:
summary: Default StartExecution 481
x-microcks-default: true
value: example-value
'482':
description: InvalidArn
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArn'
examples:
StartExecution482Example:
summary: Default StartExecution 482
x-microcks-default: true
value: example-value
'483':
description: InvalidExecutionInput
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidExecutionInput'
examples:
StartExecution483Example:
summary: Default StartExecution 483
x-microcks-default: true
value: example-value
'484':
description: InvalidName
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidName'
examples:
StartExecution484Example:
summary: Default StartExecution 484
x-microcks-default: true
value: example-value
'485':
description: StateMachineDoesNotExist
content:
application/json:
schema:
$ref: '#/components/schemas/StateMachineDoesNotExist'
examples:
StartExecution485Example:
summary: Default StartExecution 485
x-microcks-default: true
value: example-value
'486':
description: StateMachineDeleting
content:
application/json:
schema:
$ref: '#/components/schemas/StateMachineDeleting'
examples:
StartExecution486Example:
summary: Default StartExecution 486
x-microcks-default: true
value: example-value
'487':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
StartExecution487Example:
summary: Default StartExecution 487
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartExecutionInput'
examples:
StartExecutionRequestExample:
summary: Default StartExecution request
x-microcks-default: true
value:
stateMachineArn: arn:aws:service:us-east-1:123456789012:resource/example
name: MyResource
input: example-value
traceHeader: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSStepFunctions.StartExecution
summary: Amazon Start Execution
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSStepFunctions.StartExecution'
components:
schemas:
StartExecutionOutput:
type: object
required:
- executionArn
- startDate
properties:
executionArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) that identifies the execution.
startDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the execution is started.
InvalidExecutionInput: {}
Name:
type: string
minLength: 1
maxLength: 80
ValidationException: {}
InvalidArn: {}
SensitiveData:
type: string
maxLength: 262144
format: password
TraceHeader:
type: string
pattern: \p{ASCII}*
minLength: 0
maxLength: 256
ExecutionLimitExceeded: {}
StateMachineDeleting: {}
StartExecutionInput:
type: object
required:
- stateMachineArn
title: StartExecutionInput
properties:
stateMachineArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: <p>The Amazon Resource Name (ARN) of the state machine to execute.</p> <p>The <code>stateMachineArn</code> parameter accepts one of the following inputs:</p> <ul> <li> <p> <b>An unqualified state machine ARN</b> – Refers to a state machine ARN that isn't qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code> </p> <p>Step Functions doesn't associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.</p> </li> <li> <p> <b>A state machine version ARN</b> – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10. </p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10</code> </p> <p>Step Functions doesn't associate executions that you start with a version ARN with any aliases that point to that version.</p> </li> <li> <p> <b>A state machine alias ARN</b> – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named <code>PROD</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code> </p> <p>Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.</p> </li> </ul>
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: '<p>Optional name of the execution. This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions"> Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</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>'
input:
allOf:
- $ref: '#/components/schemas/SensitiveData'
- description: '<p>The string that contains the JSON input data for the execution, for example:</p> <p> <code>"input": "{\"first_name\" : \"test\"}"</code> </p> <note> <p>If you don''t include any JSON input data, you still must include the two braces, for example: <code>"input": "{}"</code> </p> </note> <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>'
traceHeader:
allOf:
- $ref: '#/components/schemas/TraceHeader'
- description: Passes the X-Ray trace header. The trace header can also be passed in the request payload.
StateMachineDoesNotExist: {}
ExecutionAlreadyExists: {}
InvalidName: {}
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/