Step Function

This table represents the Step Function resource from Amazon Web Services.

aws.step_function

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
creation_datecoretimestampThe date the state machine is created. For a state machine version, <code>creationDate</code> is the date the version was created.
definitioncorestringThe Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>. If called with <code>includedData = METADATA_ONLY</code>, the returned definition will be <code>{}</code>.
descriptioncorestringThe description of the state machine version.
encryption_configurationcorejsonSettings to configure server-side encryption.
labelcorestringA user-defined or an auto-generated string that identifies a <code>Map</code> state. This parameter is present only if the <code>stateMachineArn</code> specified in input is a qualified state machine ARN.
logging_configurationcorejson
namecorestringThe name of the state machine. A name must <i>not</i> contain: <ul> <li> white space </li> <li> brackets <code>&lt; &gt; { } [ ]</code> </li> <li> wildcard characters <code>? *</code> </li> <li> special characters <code>" # % \ ^ | ~ ` $ &amp; , ; : /</code> </li> <li> control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>) </li> </ul> To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
revision_idcorestringThe revision identifier for the state machine. Use the <code>revisionId</code> parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as <code>definition</code> and <code>roleArn</code>.
role_arncorestringThe Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)
state_machine_arncorestringThe Amazon Resource Name (ARN) that identifies the state machine. If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.
statuscorestringThe current status of the state machine.
tagscorehstore
tracing_configurationcorejsonSelects whether X-Ray tracing is enabled.
typecorestringThe <code>type</code> of the state machine (<code>STANDARD</code> or <code>EXPRESS</code>).
variable_referencescorestringA map of <b>state name</b> to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.