state_machine_for_executions

Creates, updates, deletes, gets or lists a state_machine_for_executions resource.

Overview

Name	state_machine_for_executions
Type	Resource
Id	aws.stepfunctions.state_machine_for_executions

Fields

The following fields are returned by SELECT queries:

describe_state_machine_for_execution

Name	Datatype	Description
name	string	The name of the state machine associated with the execution.
definition	string	The Amazon States Language definition of the state machine. See Amazon States Language.
encryption_configuration	object	Settings to configure server-side encryption.
label	string	A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
logging_configuration	object	The LoggingConfiguration data type is used to set CloudWatch Logs options.
map_run_arn	string	The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
revision_id	string	The revision identifier for the state machine. The first revision ID when you create the state machine is null. Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.
role_arn	string	The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
state_machine_arn	string	The Amazon Resource Name (ARN) of the state machine associated with the execution.
tracing_configuration	object	Selects whether X-Ray tracing is enabled.
update_date	string (date-time)	The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
variable_references	object	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_state_machine_for_execution	select	region		Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_state_machine_for_execution

Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.

SELECT
name,
definition,
encryption_configuration,
label,
logging_configuration,
map_run_arn,
revision_id,
role_arn,
state_machine_arn,
tracing_configuration,
update_date,
variable_references
FROM aws.stepfunctions.state_machine_for_executions
WHERE region = '{{ region }}' -- required
;