DescribeStateMachineResponse

Gets and sets the property CreationDate.

The date the state machine is created.

For a state machine version, creationDate is the date the version was created.

Gets and sets the property Definition.

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

If called with includedData = METADATA_ONLY, the returned definition will be {}.

Gets and sets the property Description.

The description of the state machine version.

Gets and sets the property EncryptionConfiguration.

Settings to configure server-side encryption.

Gets and sets the property Label.

A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

Gets and sets the property LoggingConfiguration.

Gets and sets the property Name.

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 _.

Gets and sets the property RevisionId.

The revision identifier for the state machine.

Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn.

Gets and sets the property RoleArn.

The 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.)

Gets and sets the property StateMachineArn.

The 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, stateMachineARN:1.

Gets and sets the property Status.

The current status of the state machine.

Gets and sets the property TracingConfiguration.

Selects whether X-Ray tracing is enabled.

Gets and sets the property Type.

The type of the state machine (STANDARD or EXPRESS).

Gets and sets the property VariableReferences.

A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.