Skip to content
AWS for Query.Farm

aws.stepfunctions.describe_state_machine_for_execution

Example SQL Queries

SELECT * FROM
aws.stepfunctions.describe_state_machine_for_execution
WHERE
"execution_arn" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
execution_arn Required Input Column

The Amazon Resource Name (ARN) of the execution you want state machine information for.

VARCHAR
included_data Input Column

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

definition

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

VARCHAR
encryption_configuration

Settings to configure server-side encryption. 

STRUCT(
    "kms_key_id" VARCHAR,
    "kms_data_key_reuse_period_seconds" BIGINT,
    "type" VARCHAR
)
Show child fields
encryption_configuration.kms_data_key_reuse_period_seconds

Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.

encryption_configuration.kms_key_id

An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

encryption_configuration.type

Encryption type

label

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.

VARCHAR
logging_configuration

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

STRUCT(
    "level" VARCHAR,
    "include_execution_data" BOOLEAN,
    "destinations" STRUCT(
        "cloud_watch_logs_log_group" STRUCT(
            "log_group_arn" VARCHAR
        )
    )[]
)
Show child fields
logging_configuration.destinations[]
Show child fields
logging_configuration.destinations[].cloud_watch_logs_log_group

An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.

Show child fields
logging_configuration.destinations[].cloud_watch_logs_log_group.log_group_arn

The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*

logging_configuration.include_execution_data

Determines whether execution data is included in your log. When set to false, data is excluded.

logging_configuration.level

Defines which category of execution history events are logged.

map_run_arn

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.

VARCHAR
name

The name of the state machine associated with the execution.

VARCHAR
revision_id

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.

VARCHAR
role_arn

The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution. 

VARCHAR
state_machine_arn

The Amazon Resource Name (ARN) of the state machine associated with the execution.

VARCHAR
tracing_configuration

Selects whether X-Ray tracing is enabled.

STRUCT(
    "enabled" BOOLEAN
)
Show child fields
tracing_configuration.enabled

When set to true, X-Ray tracing is enabled.

update_date

The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

TIMESTAMP_S