Skip to content

/AWS1/IF_SFN=>CREATESTATEMACHINE()

About CreateStateMachine

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.

CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine'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.

Method Signature

METHODS /AWS1/IF_SFN~CREATESTATEMACHINE
  IMPORTING
    !IV_NAME TYPE /AWS1/SFNNAME OPTIONAL
    !IV_DEFINITION TYPE /AWS1/SFNDEFINITION OPTIONAL
    !IV_ROLEARN TYPE /AWS1/SFNARN OPTIONAL
    !IV_TYPE TYPE /AWS1/SFNSTATEMACHINETYPE OPTIONAL
    !IO_LOGGINGCONFIGURATION TYPE REF TO /AWS1/CL_SFNLOGGINGCONF OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_SFNTAG=>TT_TAGLIST OPTIONAL
    !IO_TRACINGCONFIGURATION TYPE REF TO /AWS1/CL_SFNTRACINGCONF OPTIONAL
    !IV_PUBLISH TYPE /AWS1/SFNPUBLISH OPTIONAL
    !IV_VERSIONDESCRIPTION TYPE /AWS1/SFNVERSIONDESCRIPTION OPTIONAL
    !IO_ENCRYPTIONCONFIGURATION TYPE REF TO /AWS1/CL_SFNENCRYPTIONCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sfncrestatemachineout
  RAISING
    /AWS1/CX_SFNCONFLICTEXCEPTION
    /AWS1/CX_SFNINVALIDARN
    /AWS1/CX_SFNINVALIDDEFINITION
    /AWS1/CX_SFNINVALIDENCCONF
    /AWS1/CX_SFNINVALIDLOGGINGCONF
    /AWS1/CX_SFNINVALIDNAME
    /AWS1/CX_SFNINVALIDTRACINGCONF
    /AWS1/CX_SFNKMSACCESSDENIEDEX
    /AWS1/CX_SFNKMSTHROTTLINGEX
    /AWS1/CX_SFNSTATEMACHINEALREX
    /AWS1/CX_SFNSTATEMACHINEDELE00
    /AWS1/CX_SFNSTATEMACHINELMTE00
    /AWS1/CX_SFNSTATEMACHINETYPE00
    /AWS1/CX_SFNTOOMANYTAGS
    /AWS1/CX_SFNVALIDATIONEX
    /AWS1/CX_SFNCLIENTEXC
    /AWS1/CX_SFNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/SFNNAME /AWS1/SFNNAME

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, U+FFFE-FFFF)

  • surrogates (U+D800-DFFF)

  • invalid characters ( U+10FFFF)

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

iv_definition TYPE /AWS1/SFNDEFINITION /AWS1/SFNDEFINITION

The Amazon States Language definition of the state machine. See Amazon States Language.

iv_rolearn TYPE /AWS1/SFNARN /AWS1/SFNARN

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

Optional arguments:

iv_type TYPE /AWS1/SFNSTATEMACHINETYPE /AWS1/SFNSTATEMACHINETYPE

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.

io_loggingconfiguration TYPE REF TO /AWS1/CL_SFNLOGGINGCONF /AWS1/CL_SFNLOGGINGCONF

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.

it_tags TYPE /AWS1/CL_SFNTAG=>TT_TAGLIST TT_TAGLIST

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: _ . : / = + - @.

io_tracingconfiguration TYPE REF TO /AWS1/CL_SFNTRACINGCONF /AWS1/CL_SFNTRACINGCONF

Selects whether X-Ray tracing is enabled.

iv_publish TYPE /AWS1/SFNPUBLISH /AWS1/SFNPUBLISH

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

iv_versiondescription TYPE /AWS1/SFNVERSIONDESCRIPTION /AWS1/SFNVERSIONDESCRIPTION

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.

io_encryptionconfiguration TYPE REF TO /AWS1/CL_SFNENCRYPTIONCONF /AWS1/CL_SFNENCRYPTIONCONF

Settings to configure server-side encryption.

RETURNING

oo_output TYPE REF TO /aws1/cl_sfncrestatemachineout /AWS1/CL_SFNCRESTATEMACHINEOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createstatemachine(
  io_encryptionconfiguration = new /aws1/cl_sfnencryptionconf(
    iv_kmsdatakeyreuseperseconds = 123
    iv_kmskeyid = |string|
    iv_type = |string|
  )
  io_loggingconfiguration = new /aws1/cl_sfnloggingconf(
    it_destinations = VALUE /aws1/cl_sfnlogdestination=>tt_logdestinationlist(
      ( new /aws1/cl_sfnlogdestination( new /aws1/cl_sfncloudwatchlogslo00( |string| ) ) )
    )
    iv_includeexecutiondata = ABAP_TRUE
    iv_level = |string|
  )
  io_tracingconfiguration = new /aws1/cl_sfntracingconf( ABAP_TRUE )
  it_tags = VALUE /aws1/cl_sfntag=>tt_taglist(
    (
      new /aws1/cl_sfntag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_definition = |string|
  iv_name = |string|
  iv_publish = ABAP_TRUE
  iv_rolearn = |string|
  iv_type = |string|
  iv_versiondescription = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_statemachinearn( ).
  lv_timestamp = lo_result->get_creationdate( ).
  lv_arn = lo_result->get_statemachineversionarn( ).
ENDIF.