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 AWS Step Functions User Guide.
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<U+2019>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
and TracingConfiguration
. 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.
sfn_create_state_machine(name, definition, roleArn, type,
loggingConfiguration, tags, tracingConfiguration)
[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
[required] The Amazon States Language definition of the state machine. See Amazon States Language.
[required] The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
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.
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 AWS Step Functions User Guide.
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 AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these
symbols: _ . : / = + - @
.
Selects whether AWS X-Ray tracing is enabled.
A list with the following syntax:
list( stateMachineArn = "string", creationDate = as.POSIXct( "2015-01-01" ) )
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 ) )