Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StartExecutionCommand

Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, 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.

StartExecution is not idempotent for EXPRESS workflows.

example

Use a bare-bones client and the command you need to make an API call.

import { SFNClient, StartExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import
// const { SFNClient, StartExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
const client = new SFNClient(config);
const command = new StartExecutionCommand(input);
const response = await client.send(command);
see

StartExecutionCommandInput for command's input shape.

see

StartExecutionCommandOutput for command's response shape.

see

config for SFNClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: StartExecutionCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<StartExecutionCommandInput, StartExecutionCommandOutput>

Methods

Static getEndpointParameterInstructions