Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeMapRun API

The #X Amz Target=AWSStepFunctions.DescribeMapRun API from AWS Step Functions — 1 operation(s) for #x amz target=awsstepfunctions.describemaprun.

AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeMapRun API is one of 26 APIs that AWS Step Functions publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #X Amz Target=AWSStepFunctions.DescribeMapRun. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 1 operation across 1 path, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 2016-11-23.

Requests are made against 4 base URLs: http://states.{region}.amazonaws.com, https://states.{region}.amazonaws.com, http://states.{region}.amazonaws.com.cn, https://states.{region}.amazonaws.com.cn.

1 operations 1 paths 14 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2016-11-23
Base URL
https://states.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeMapRun API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

#X Amz Target=AWSStepFunctions.DescribeMapRun 1
POST
/#X-Amz-Target=AWSStepFunctions.DescribeMapRun
AWS Step Functions - Describe Map Run
DescribeMapRun 8 params body → 200480481

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are DescribeMapRunOutput (10 properties), MapRunItemCounts (8 properties), MapRunExecutionCounts (8 properties), DescribeMapRunInput (1 property). Each schema is shown below with its type and property counts.

MapRunItemCounts
object
Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.
8 properties 8 required
MapRunExecutionCounts
object
Contains details about all of the child workflow executions started by a Map Run.
8 properties 8 required
ToleratedFailureCount
integer
UnsignedLong
integer
LongArn
string
ResourceNotFound
DescribeMapRunInput
object
1 property 1 required
MaxConcurrency
integer
Arn
string
Timestamp
string
InvalidArn
DescribeMapRunOutput
object
10 properties 9 required
ToleratedFailurePercentage
number
MapRunStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-step-functions-x-amz-target-awsstepfunctions-describemaprun-api-openapi.yml Raw ↑

Other APIs AWS Step Functions publishes across the network.

AWS Step Functions #X Amz Target=AWSStepFunctions.CreateActivity API
AWS Step Functions #X Amz Target=AWSStepFunctions.CreateStateMachine API
AWS Step Functions #X Amz Target=AWSStepFunctions.DeleteActivity API
AWS Step Functions #X Amz Target=AWSStepFunctions.DeleteStateMachine API
AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeActivity API
AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeExecution API
AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeStateMachine API
AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeStateMachineForExecution API
AWS Step Functions #X Amz Target=AWSStepFunctions.GetActivityTask API
AWS Step Functions #X Amz Target=AWSStepFunctions.GetExecutionHistory API
AWS Step Functions #X Amz Target=AWSStepFunctions.ListActivities API
AWS Step Functions #X Amz Target=AWSStepFunctions.ListExecutions API