SFN / Client / describe_map_run

describe_map_run#

SFN.Client.describe_map_run(**kwargs)#

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.

Request Syntax

response = client.describe_map_run(
    mapRunArn='string'
)

Parameters:

mapRunArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'mapRunArn': 'string',
    'executionArn': 'string',
    'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'ABORTED',
    'startDate': datetime(2015, 1, 1),
    'stopDate': datetime(2015, 1, 1),
    'maxConcurrency': 123,
    'toleratedFailurePercentage': ...,
    'toleratedFailureCount': 123,
    'itemCounts': {
        'pending': 123,
        'running': 123,
        'succeeded': 123,
        'failed': 123,
        'timedOut': 123,
        'aborted': 123,
        'total': 123,
        'resultsWritten': 123,
        'failuresNotRedrivable': 123,
        'pendingRedrive': 123
    },
    'executionCounts': {
        'pending': 123,
        'running': 123,
        'succeeded': 123,
        'failed': 123,
        'timedOut': 123,
        'aborted': 123,
        'total': 123,
        'resultsWritten': 123,
        'failuresNotRedrivable': 123,
        'pendingRedrive': 123
    },
    'redriveCount': 123,
    'redriveDate': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- mapRunArn (string) –
  
  The Amazon Resource Name (ARN) that identifies a Map Run.
- executionArn (string) –
  
  The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.
- status (string) –
  
  The current status of the Map Run.
- startDate (datetime) –
  
  The date when the Map Run was started.
- stopDate (datetime) –
  
  The date when the Map Run was stopped.
- maxConcurrency (integer) –
  
  The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.
- toleratedFailurePercentage (float) –
  
  The maximum percentage of failed child workflow executions before the Map Run fails.
- toleratedFailureCount (integer) –
  
  The maximum number of failed child workflow executions before the Map Run fails.
- itemCounts (dict) –
  
  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.
  - pending (integer) –
    
    The total number of items to process in child workflow executions that haven’t started running yet.
  - running (integer) –
    
    The total number of items being processed in child workflow executions that are currently in-progress.
  - succeeded (integer) –
    
    The total number of items processed in child workflow executions that have completed successfully.
  - failed (integer) –
    
    The total number of items processed in child workflow executions that have failed.
  - timedOut (integer) –
    
    The total number of items processed in child workflow executions that have timed out.
  - aborted (integer) –
    
    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.
  - total (integer) –
    
    The total number of items processed in all the child workflow executions started by a Map Run.
  - resultsWritten (integer) –
    
    Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.
  - failuresNotRedrivable (integer) –
    
    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.
  - pendingRedrive (integer) –
    
    The number of unsuccessful items in child workflow executions currently waiting to be redriven.
- executionCounts (dict) –
  
  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.
  - pending (integer) –
    
    The total number of child workflow executions that were started by a Map Run, but haven’t started executing yet.
  - running (integer) –
    
    The total number of child workflow executions that were started by a Map Run and are currently in-progress.
  - succeeded (integer) –
    
    The total number of child workflow executions that were started by a Map Run and have completed successfully.
  - failed (integer) –
    
    The total number of child workflow executions that were started by a Map Run, but have failed.
  - timedOut (integer) –
    
    The total number of child workflow executions that were started by a Map Run and have timed out.
  - aborted (integer) –
    
    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.
  - total (integer) –
    
    The total number of child workflow executions that were started by a Map Run.
  - resultsWritten (integer) –
    
    Returns the count of child workflow executions whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.
  - failuresNotRedrivable (integer) –
    
    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.
  - pendingRedrive (integer) –
    
    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.
- redriveCount (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.
- redriveDate (datetime) –
  
  The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null.

Exceptions

SFN.Client.exceptions.ResourceNotFound
SFN.Client.exceptions.InvalidArn