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

openapi: 3.2.0
info:
  version: '2016-11-23'
  x-release: v4
  title: 'AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeMa…'
  description: 'Step Functions

    Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.'
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: states
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/states-2016-11-23.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://states.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS SFN multi-region endpoint
- url: https://states.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS SFN multi-region endpoint
- url: http://states.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS SFN endpoint for China (Beijing) and China (Ningxia)
- url: https://states.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS SFN endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
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 Examining Map Run in the Step Functions Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeMapRunOutput'
        '480':
          description: ResourceNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
        '481':
          description: InvalidArn
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArn'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeMapRunInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSStepFunctions.DescribeMapRun
      summary: AWS Step Functions - Describe Map Run
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSStepFunctions.DescribeMapRun'
components:
  schemas:
    ToleratedFailureCount:
      type: integer
      minimum: 0
    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.
    ResourceNotFound: {}
    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>.
    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.
    UnsignedLong:
      type: integer
      minimum: 0
    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.
    Arn:
      type: string
      minLength: 1
      maxLength: 256
    ToleratedFailurePercentage:
      type: number
      format: float
      minimum: 0
      maximum: 100
    MapRunStatus:
      type: string
      enum:
      - RUNNING
      - SUCCEEDED
      - FAILED
      - ABORTED
    MaxConcurrency:
      type: integer
      minimum: 0
    Timestamp:
      type: string
      format: date-time
    InvalidArn: {}
    LongArn:
      type: string
      minLength: 1
      maxLength: 2000
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      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-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/states/
x-hasEquivalentPaths: true