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

openapi: 3.1.0
info:
  title: 'Amazon Step Functions Executions #X Amz Target=AWSStepFunctions.DescribeMapRun API'
  description: Amazon Step Functions is a serverless workflow orchestration service that lets you coordinate distributed applications and microservices using visual workflows. This API enables you to create and manage state machines, start and monitor executions, and retrieve execution history.
  version: '2016-11-23'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  termsOfService: https://aws.amazon.com/service-terms/
servers:
- url: https://states.{region}.amazonaws.com
  description: Amazon Step Functions Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: AWS Region
security:
- sigv4Auth: []
tags:
- name: '#X Amz Target=AWSStepFunctions.DescribeMapRun'
paths:
  /#X-Amz-Target=AWSStepFunctions.DescribeMapRun:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: DescribeMapRun
      description: Provides information about a Map Run's configuration, progress, and results. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeMapRunOutput'
              examples:
                DescribeMapRun200Example:
                  summary: Default DescribeMapRun 200
                  x-microcks-default: true
                  value:
                    mapRunArn: arn:aws:service:us-east-1:123456789012:resource/example
                    executionArn: arn:aws:service:us-east-1:123456789012:resource/example
                    status: Active
                    startDate: example-value
                    stopDate: example-value
                    maxConcurrency: example-value
                    toleratedFailurePercentage: example-value
                    toleratedFailureCount: example-value
                    itemCounts: example-value
                    executionCounts: example-value
        '480':
          description: ResourceNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
              examples:
                DescribeMapRun480Example:
                  summary: Default DescribeMapRun 480
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidArn
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArn'
              examples:
                DescribeMapRun481Example:
                  summary: Default DescribeMapRun 481
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeMapRunInput'
            examples:
              DescribeMapRunRequestExample:
                summary: Default DescribeMapRun request
                x-microcks-default: true
                value:
                  mapRunArn: arn:aws:service:us-east-1:123456789012:resource/example
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSStepFunctions.DescribeMapRun
      summary: Amazon Describe Map Run
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSStepFunctions.DescribeMapRun'
components:
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
  schemas:
    UnsignedLong:
      type: integer
      minimum: 0
    InvalidArn: {}
    MapRunStatus:
      type: string
      enum:
      - RUNNING
      - SUCCEEDED
      - FAILED
      - ABORTED
    MapRunItemCounts:
      type: object
      required:
      - pending
      - running
      - succeeded
      - failed
      - timedOut
      - aborted
      - total
      - resultsWritten
      properties:
        pending:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of items to process in child workflow executions that haven't started running yet.
        running:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of items being processed in child workflow executions that are currently in-progress.
        succeeded:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of items processed in child workflow executions that have completed successfully.
        failed:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of items processed in child workflow executions that have failed.
        timedOut:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of items processed in child workflow executions that have timed out.
        aborted:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: 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:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of items processed in all the child workflow executions started by a Map Run.
        resultsWritten:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: Returns the count of items whose results were written by <code>ResultWriter</code>. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html">ResultWriter</a> in the <i>Step Functions Developer Guide</i>.
      description: Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.
    DescribeMapRunInput:
      type: object
      required:
      - mapRunArn
      title: DescribeMapRunInput
      properties:
        mapRunArn:
          allOf:
          - $ref: '#/components/schemas/LongArn'
          - description: The Amazon Resource Name (ARN) that identifies a Map Run.
    ToleratedFailureCount:
      type: integer
      minimum: 0
    LongArn:
      type: string
      minLength: 1
      maxLength: 2000
    MaxConcurrency:
      type: integer
      minimum: 0
    ToleratedFailurePercentage:
      type: number
      format: float
      minimum: 0
      maximum: 100
    MapRunExecutionCounts:
      type: object
      required:
      - pending
      - running
      - succeeded
      - failed
      - timedOut
      - aborted
      - total
      - resultsWritten
      properties:
        pending:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: 'The total number of child workflow executions that were started by a Map Run, but haven''t started executing yet. '
        running:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of child workflow executions that were started by a Map Run and are currently in-progress.
        succeeded:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of child workflow executions that were started by a Map Run and have completed successfully.
        failed:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of child workflow executions that were started by a Map Run, but have failed.
        timedOut:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of child workflow executions that were started by a Map Run and have timed out.
        aborted:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: '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:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: The total number of child workflow executions that were started by a Map Run.
        resultsWritten:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: Returns the count of child workflow executions whose results were written by <code>ResultWriter</code>. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html">ResultWriter</a> in the <i>Step Functions Developer Guide</i>.
      description: Contains details about all of the child workflow executions started by a Map Run.
    DescribeMapRunOutput:
      type: object
      required:
      - mapRunArn
      - executionArn
      - status
      - startDate
      - maxConcurrency
      - toleratedFailurePercentage
      - toleratedFailureCount
      - itemCounts
      - executionCounts
      properties:
        mapRunArn:
          allOf:
          - $ref: '#/components/schemas/LongArn'
          - description: The Amazon Resource Name (ARN) that identifies a Map Run.
        executionArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.
        status:
          allOf:
          - $ref: '#/components/schemas/MapRunStatus'
          - description: The current status of the Map Run.
        startDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date when the Map Run was started.
        stopDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date when the Map Run was stopped.
        maxConcurrency:
          allOf:
          - $ref: '#/components/schemas/MaxConcurrency'
          - description: The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.
        toleratedFailurePercentage:
          allOf:
          - $ref: '#/components/schemas/ToleratedFailurePercentage'
          - description: The maximum percentage of failed child workflow executions before the Map Run fails.
        toleratedFailureCount:
          allOf:
          - $ref: '#/components/schemas/ToleratedFailureCount'
          - description: The maximum number of failed child workflow executions before the Map Run fails.
        itemCounts:
          allOf:
          - $ref: '#/components/schemas/MapRunItemCounts'
          - description: A JSON object that contains information about the total number of items, and the item count for each processing status, such as <code>pending</code> and <code>failed</code>.
        executionCounts:
          allOf:
          - $ref: '#/components/schemas/MapRunExecutionCounts'
          - description: 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 <code>failed</code> and <code>succeeded</code>.
    ResourceNotFound: {}
    Timestamp:
      type: string
      format: date-time
    Arn:
      type: string
      minLength: 1
      maxLength: 256
  securitySchemes:
    sigv4Auth:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication
externalDocs:
  description: Amazon Step Functions API Reference
  url: https://docs.aws.amazon.com/step-functions/latest/apireference/