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

The #X Amz Target=AWSStepFunctions.UpdateMapRun API from Amazon Step Functions — 1 operation(s) for #x amz target=awsstepfunctions.updatemaprun.

OpenAPI Specification

amazon-step-functions-x-amz-target-awsstepfunctions-updatemaprun-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: 'Amazon Step Functions Executions #X Amz Target=AWSStepFunctions.UpdateMapRun 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.UpdateMapRun'
paths:
  /#X-Amz-Target=AWSStepFunctions.UpdateMapRun:
    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: UpdateMapRun
      description: Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMapRunOutput'
              examples:
                UpdateMapRun200Example:
                  summary: Default UpdateMapRun 200
                  x-microcks-default: true
                  value: {}
        '480':
          description: ResourceNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
              examples:
                UpdateMapRun480Example:
                  summary: Default UpdateMapRun 480
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidArn
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArn'
              examples:
                UpdateMapRun481Example:
                  summary: Default UpdateMapRun 481
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                UpdateMapRun482Example:
                  summary: Default UpdateMapRun 482
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMapRunInput'
            examples:
              UpdateMapRunRequestExample:
                summary: Default UpdateMapRun request
                x-microcks-default: true
                value:
                  mapRunArn: arn:aws:service:us-east-1:123456789012:resource/example
                  maxConcurrency: example-value
                  toleratedFailurePercentage: example-value
                  toleratedFailureCount: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSStepFunctions.UpdateMapRun
      summary: Amazon Update Map Run
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSStepFunctions.UpdateMapRun'
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      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-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      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-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    ValidationException: {}
    ToleratedFailureCount:
      type: integer
      minimum: 0
    LongArn:
      type: string
      minLength: 1
      maxLength: 2000
    ResourceNotFound: {}
    InvalidArn: {}
    MaxConcurrency:
      type: integer
      minimum: 0
    ToleratedFailurePercentage:
      type: number
      format: float
      minimum: 0
      maximum: 100
    UpdateMapRunOutput:
      type: object
      properties: {}
    UpdateMapRunInput:
      type: object
      required:
      - mapRunArn
      title: UpdateMapRunInput
      properties:
        mapRunArn:
          allOf:
          - $ref: '#/components/schemas/LongArn'
          - description: The Amazon Resource Name (ARN) of a Map Run.
        maxConcurrency:
          allOf:
          - $ref: '#/components/schemas/MaxConcurrency'
          - description: The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.
        toleratedFailurePercentage:
          allOf:
          - $ref: '#/components/schemas/ToleratedFailurePercentage'
          - description: The maximum percentage of failed items before the Map Run fails.
        toleratedFailureCount:
          allOf:
          - $ref: '#/components/schemas/ToleratedFailureCount'
          - description: The maximum number of failed items before the Map Run fails.
  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/