map_runs

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

Overview

Name	map_runs
Type	Resource
Id	aws.stepfunctions.map_runs

Fields

The following fields are returned by SELECT queries:

describe_map_run

Name	Datatype	Description
execution_arn	string	The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.
execution_counts	object	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.
item_counts	object	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.
map_run_arn	string	The Amazon Resource Name (ARN) that identifies a Map Run.
max_concurrency	integer	The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.
redrive_count	integer	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.
redrive_date	string (date-time)	The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null.
start_date	string (date-time)	The date when the Map Run was started.
status	string	The current status of the Map Run. (RUNNING, SUCCEEDED, FAILED, ABORTED)
stop_date	string (date-time)	The date when the Map Run was stopped.
tolerated_failure_count	integer (int64)	The maximum number of failed child workflow executions before the Map Run fails.
tolerated_failure_percentage	number (float)	The maximum percentage of failed child workflow executions before the Map Run fails.

list_map_runs

Name	Datatype	Description
execution_arn	string	The executionArn of the execution from which the Map Run was started.
map_run_arn	string	The Amazon Resource Name (ARN) of the Map Run.
start_date	string (date-time)	The date on which the Map Run started.
state_machine_arn	string	The Amazon Resource Name (ARN) of the executed state machine.
stop_date	string (date-time)	The date on which the Map Run stopped.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_map_run	select	region		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.
list_map_runs	select	region		Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.
update_map_run	update	region, mapRunArn		Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.

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_map_run

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.

SELECT
execution_arn,
execution_counts,
item_counts,
map_run_arn,
max_concurrency,
redrive_count,
redrive_date,
start_date,
status,
stop_date,
tolerated_failure_count,
tolerated_failure_percentage
FROM aws.stepfunctions.map_runs
WHERE region = '{{ region }}' -- required
;

list_map_runs

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

SELECT
execution_arn,
map_run_arn,
start_date,
state_machine_arn,
stop_date
FROM aws.stepfunctions.map_runs
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_map_run

Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.

UPDATE aws.stepfunctions.map_runs
SET 
mapRunArn = '{{ mapRunArn }}',
maxConcurrency = {{ maxConcurrency }},
toleratedFailurePercentage = {{ toleratedFailurePercentage }},
toleratedFailureCount = {{ toleratedFailureCount }}
WHERE 
region = '{{ region }}' --required
AND mapRunArn = '{{ mapRunArn }}' --required;