Learn R Programming

paws.application.integration (version 0.1.11)

sfn_start_execution: Starts a state machine execution

Description

Starts a state machine execution.

start_execution is idempotent. If start_execution 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.

Usage

sfn_start_execution(stateMachineArn, name, input, traceHeader)

Arguments

stateMachineArn

[required] The Amazon Resource Name (ARN) of the state machine to execute.

name

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters \" # % \ ^ | ~ \` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

[ ]: R:%20

input

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

traceHeader

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Value

A list with the following syntax:

list(
  executionArn = "string",
  startDate = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$start_execution(
  stateMachineArn = "string",
  name = "string",
  input = "string",
  traceHeader = "string"
)