Skip to content

Describe Map Run

sfn_describe_map_run R Documentation

Provides information about a Map Run's configuration, progress, and results

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.

Usage

sfn_describe_map_run(mapRunArn)

Arguments

mapRunArn

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

Value

A list with the following syntax:

list(
  mapRunArn = "string",
  executionArn = "string",
  status = "RUNNING"|"SUCCEEDED"|"FAILED"|"ABORTED",
  startDate = as.POSIXct(
    "2015-01-01"
  ),
  stopDate = as.POSIXct(
    "2015-01-01"
  ),
  maxConcurrency = 123,
  toleratedFailurePercentage = 123.0,
  toleratedFailureCount = 123,
  itemCounts = list(
    pending = 123,
    running = 123,
    succeeded = 123,
    failed = 123,
    timedOut = 123,
    aborted = 123,
    total = 123,
    resultsWritten = 123,
    failuresNotRedrivable = 123,
    pendingRedrive = 123
  ),
  executionCounts = list(
    pending = 123,
    running = 123,
    succeeded = 123,
    failed = 123,
    timedOut = 123,
    aborted = 123,
    total = 123,
    resultsWritten = 123,
    failuresNotRedrivable = 123,
    pendingRedrive = 123
  ),
  redriveCount = 123,
  redriveDate = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$describe_map_run(
  mapRunArn = "string"
)