Skip to content
AWS for Query.Farm

aws.stepfunctions.describe_map_run

Example SQL Queries

SELECT * FROM
aws.stepfunctions.describe_map_run
WHERE
"map_run_arn" = 'VALUE';

Description

Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.

Table Definition

Column NameColumn Data Type
map_run_arn Required Input Column

The Amazon Resource Name (ARN) that identifies a Map Run.

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.

execution_arn

The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.

VARCHAR
execution_counts

A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.

STRUCT(
    "pending" BIGINT,
    "running" BIGINT,
    "succeeded" BIGINT,
    "failed" BIGINT,
    "timed_out" BIGINT,
    "aborted" BIGINT,
    "total" BIGINT,
    "results_written" BIGINT,
    "failures_not_redrivable" BIGINT,
    "pending_redrive" BIGINT
)
Show child fields
execution_counts.aborted

The total number of child workflow executions that were started by a Map Run and were running, but were either stopped by the user or by Step Functions because the Map Run failed.

execution_counts.failed

The total number of child workflow executions that were started by a Map Run, but have failed.

execution_counts.failures_not_redrivable

The number of FAILED, ABORTED, or TIMED_OUT child workflow executions that cannot be redriven because their execution status is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.

execution_counts.pending

The total number of child workflow executions that were started by a Map Run, but haven't started executing yet.

execution_counts.pending_redrive

The number of unsuccessful child workflow executions currently waiting to be redriven. The status of these child workflow executions could be FAILED, ABORTED, or TIMED_OUT in the original execution attempt or a previous redrive attempt.

execution_counts.results_written

Returns the count of child workflow executions whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

execution_counts.running

The total number of child workflow executions that were started by a Map Run and are currently in-progress.

execution_counts.succeeded

The total number of child workflow executions that were started by a Map Run and have completed successfully.

execution_counts.timed_out

The total number of child workflow executions that were started by a Map Run and have timed out.

execution_counts.total

The total number of child workflow executions that were started by a Map Run.

item_counts

A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.

STRUCT(
    "pending" BIGINT,
    "running" BIGINT,
    "succeeded" BIGINT,
    "failed" BIGINT,
    "timed_out" BIGINT,
    "aborted" BIGINT,
    "total" BIGINT,
    "results_written" BIGINT,
    "failures_not_redrivable" BIGINT,
    "pending_redrive" BIGINT
)
Show child fields
item_counts.aborted

The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.

item_counts.failed

The total number of items processed in child workflow executions that have failed.

item_counts.failures_not_redrivable

The number of FAILED, ABORTED, or TIMED_OUT items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.

item_counts.pending

The total number of items to process in child workflow executions that haven't started running yet.

item_counts.pending_redrive

The number of unsuccessful items in child workflow executions currently waiting to be redriven.

item_counts.results_written

Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

item_counts.running

The total number of items being processed in child workflow executions that are currently in-progress.

item_counts.succeeded

The total number of items processed in child workflow executions that have completed successfully.

item_counts.timed_out

The total number of items processed in child workflow executions that have timed out.

item_counts.total

The total number of items processed in all the child workflow executions started by a Map Run.

max_concurrency

The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.

BIGINT
redrive_count

The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the redriveCount is 0. This count is only updated if you successfully redrive a Map Run.

BIGINT
redrive_date

The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null.

TIMESTAMP_S
start_date

The date when the Map Run was started.

TIMESTAMP_S
status

The current status of the Map Run.

VARCHAR
stop_date

The date when the Map Run was stopped.

TIMESTAMP_S
tolerated_failure_count

The maximum number of failed child workflow executions before the Map Run fails.

BIGINT
tolerated_failure_percentage

The maximum percentage of failed child workflow executions before the Map Run fails.

DOUBLE