Module types

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

Step Functions automatically enables encryption at rest using Amazon Web Services owned keys at no charge. However, KMS charges apply when using a customer managed key. For more information about pricing, see Key Management Service pricing.

For more information on KMS, see What is Key Management Service?

EvaluationFailedEventDetails

Contains details about an evaluation failure that occurred while processing a state, for example, when a JSONata expression throws an error. This event will only be present in state machines that have QueryLanguage set to JSONata, or individual states set to JSONata.

ExecutionAbortedEventDetails

Contains details about an abort of an execution.

ExecutionFailedEventDetails

Contains details about an execution failure event.

ExecutionListItem

Contains details about an execution.

ExecutionRedrivenEventDetails

Contains details about a redriven execution.

ExecutionStartedEventDetails

Contains details about the start of the execution.

ExecutionSucceededEventDetails

Contains details about the successful termination of the execution.

ExecutionTimedOutEventDetails

Contains details about the execution timeout that occurred during the execution.

HistoryEvent

Contains details about the events of an execution.

HistoryEventExecutionDataDetails

Provides details about input or output in an execution history event.

InspectionData

Contains additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information.

InspectionDataRequest

Contains additional details about the state's execution, including its input and output data processing flow, and HTTP request information.

InspectionDataResponse

Contains additional details about the state's execution, including its input and output data processing flow, and HTTP response information. The inspectionLevel request parameter specifies which details are returned.

LambdaFunctionFailedEventDetails

Contains details about a Lambda function that failed during an execution.

LambdaFunctionScheduleFailedEventDetails

Contains details about a failed Lambda function schedule event that occurred during an execution.

LambdaFunctionScheduledEventDetails

Contains details about a Lambda function scheduled during an execution.

LambdaFunctionStartFailedEventDetails

Contains details about a lambda function that failed to start during an execution.

LambdaFunctionSucceededEventDetails

Contains details about a Lambda function that successfully terminated during an execution.

LambdaFunctionTimedOutEventDetails

Contains details about a Lambda function timeout that occurred during an execution.

LogDestination

LoggingConfiguration

The LoggingConfiguration data type is used to set CloudWatch Logs options.

MapIterationEventDetails

Contains details about an iteration of a Map state.

MapRunExecutionCounts

Contains details about all of the child workflow executions started by a Map Run.

MapRunFailedEventDetails

Contains details about a Map Run failure event that occurred during a state machine execution.

MapRunItemCounts

Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.

MapRunListItem

Contains details about a specific Map Run.

MapRunRedrivenEventDetails

Contains details about a Map Run that was redriven.

MapRunStartedEventDetails

Contains details about a Map Run that was started during a state machine execution.

MapStateStartedEventDetails

Details about a Map state that was started.

RoutingConfigurationListItem

Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.

StateEnteredEventDetails

Contains details about a state entered during an execution.

StateExitedEventDetails

Contains details about an exit from a state during an execution.

StateMachineAliasListItem

Contains details about a specific state machine alias.

StateMachineListItem

Contains details about the state machine.

StateMachineVersionListItem

Contains details about a specific state machine version.

Tag

Tags are key-value pairs that can be associated with Step Functions state machines and activities.

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

TaskCredentials

Contains details about the credentials that Step Functions uses for a task.

TaskFailedEventDetails

Contains details about a task failure event.

TaskScheduledEventDetails

Contains details about a task scheduled during an execution.

TaskStartFailedEventDetails

Contains details about a task that failed to start during an execution.

TaskStartedEventDetails

Contains details about the start of a task during an execution.

TaskSubmitFailedEventDetails

Contains details about a task that failed to submit during an execution.

TaskSubmittedEventDetails

Contains details about a task submitted to a resource .

TaskSucceededEventDetails

Contains details about the successful completion of a task state.

TaskTimedOutEventDetails

Contains details about a resource timeout that occurred during an execution.

TracingConfiguration

Selects whether or not the state machine's X-Ray tracing is enabled. Default is false

ValidateStateMachineDefinitionDiagnostic

Describes potential issues found during state machine validation. Rather than raise an exception, validation will return a list of diagnostic elements containing diagnostic information.

The ValidateStateMachineDefinitionlAPI might add new diagnostics in the future, adjust diagnostic codes, or change the message wording. Your automated processes should only rely on the value of the result field value (OK, FAIL). Do not rely on the exact order, count, or wording of diagnostic messages.

List of warning codes

NO_DOLLAR: No .$ on a field that appears to be a JSONPath or Intrinsic Function.
NO_PATH: Field value looks like a path, but field name does not end with 'Path'.
PASS_RESULT_IS_STATIC: Attempt to use a path in the result of a pass state.

List of error codes

INVALID_JSON_DESCRIPTION: JSON syntax problem found.
MISSING_DESCRIPTION: Received a null or empty workflow input.
SCHEMA_VALIDATION_FAILED: Schema validation reported errors.
INVALID_RESOURCE: The value of a Task-state resource field is invalid.
MISSING_END_STATE: The workflow does not have a terminal state.
DUPLICATE_STATE_NAME: The same state name appears more than once.
INVALID_STATE_NAME: The state name does not follow the naming convention.
STATE_MACHINE_NAME_EMPTY: The state machine name has not been specified.
STATE_MACHINE_NAME_INVALID: The state machine name does not follow the naming convention.
STATE_MACHINE_NAME_TOO_LONG: The state name exceeds the allowed length.
STATE_MACHINE_NAME_ALREADY_EXISTS: The state name already exists.
DUPLICATE_LABEL_NAME: A label name appears more than once.
INVALID_LABEL_NAME: You have provided an invalid label name.
MISSING_TRANSITION_TARGET: The value of "Next" field doesn't match a known state name.
TOO_DEEPLY_NESTED: The states are too deeply nested.

Enums§

EncryptionType: When writing a match expression against EncryptionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ExecutionRedriveFilter: When writing a match expression against ExecutionRedriveFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ExecutionRedriveStatus: When writing a match expression against ExecutionRedriveStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ExecutionStatus: When writing a match expression against ExecutionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
HistoryEventType: When writing a match expression against HistoryEventType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
IncludedData: When writing a match expression against IncludedData, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InspectionLevel: When writing a match expression against InspectionLevel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
KmsKeyState: When writing a match expression against KmsKeyState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
LogLevel: When writing a match expression against LogLevel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MapRunStatus: When writing a match expression against MapRunStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
StateMachineStatus: When writing a match expression against StateMachineStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
StateMachineType: When writing a match expression against StateMachineType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SyncExecutionStatus: When writing a match expression against SyncExecutionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TestExecutionStatus: When writing a match expression against TestExecutionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ValidateStateMachineDefinitionResultCode: When writing a match expression against ValidateStateMachineDefinitionResultCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ValidateStateMachineDefinitionSeverity: When writing a match expression against ValidateStateMachineDefinitionSeverity, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ValidationExceptionReason: When writing a match expression against ValidationExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Module types

Module types Copy item path

Modules§

Structs§

Enums§

Module types