Skip to content

Create State Machine

sfn_create_state_machine R Documentation

Creates a state machine

Description

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.

If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to the State Machine.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

create_state_machine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. create_state_machine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

Usage

sfn_create_state_machine(name, definition, roleArn, type,
  loggingConfiguration, tags, tracingConfiguration, publish,
  versionDescription, encryptionConfiguration)

Arguments

name

[required] The name of the state machine.

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

definition

[required] The Amazon States Language definition of the state machine. See Amazon States Language.

roleArn

[required] The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

type

Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.

loggingConfiguration

Defines what execution history events are logged and where they are logged.

By default, the level is set to OFF. For more information see Log Levels in the Step Functions User Guide.

tags

Tags to be added when creating a state machine.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: ⁠_ . : / = + - @⁠.

tracingConfiguration

Selects whether X-Ray tracing is enabled.

publish

Set to true to publish the first version of the state machine during creation. The default is false.

versionDescription

Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.

encryptionConfiguration

Settings to configure server-side encryption.

Value

A list with the following syntax: 

list(
  stateMachineArn = "string",
  creationDate = as.POSIXct(
    "2015-01-01"
  ),
  stateMachineVersionArn = "string"
)

Request syntax

svc$create_state_machine(
  name = "string",
  definition = "string",
  roleArn = "string",
  type = "STANDARD"|"EXPRESS",
  loggingConfiguration = list(
    level = "ALL"|"ERROR"|"FATAL"|"OFF",
    includeExecutionData = TRUE|FALSE,
    destinations = list(
      list(
        cloudWatchLogsLogGroup = list(
          logGroupArn = "string"
        )
      )
    )
  ),
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  tracingConfiguration = list(
    enabled = TRUE|FALSE
  ),
  publish = TRUE|FALSE,
  versionDescription = "string",
  encryptionConfiguration = list(
    kmsKeyId = "string",
    kmsDataKeyReusePeriodSeconds = 123,
    type = "AWS_OWNED_KEY"|"CUSTOMER_MANAGED_KMS_KEY"
  )
)