Amazon Augmented AI Human Loops API

Operations for creating and managing human review loops

GitHub OpenAPI
Business capability
Artificial Intelligence Management BC-610.60

Operations 5

DELETE /human-loops/{HumanLoopName} Delete Human Loop #
GET /human-loops/{HumanLoopName} Describe Human Loop #
GET /human-loops List Human Loops #
POST /human-loops Start Human Loop #
POST /human-loops/stop Stop Human Loop #

Specifications

Examples

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-augmented-ai:amazon-augmented-ai-human-loops-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-augmented-ai-human-loops-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Augmented AI Runtime Human Loops API
  version: '2019-11-07'
  description: Generated from AWS's published Smithy model for Amazon Augmented AI Runtime. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://a2i-runtime.sagemaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /human-loops/{HumanLoopName}:
    delete:
      operationId: DeleteHumanLoop
      summary: Delete Human Loop
      description: Deletes the specified human loop for a flow definition. If the human loop was deleted, this operation will
        return a ResourceNotFoundException.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteHumanLoopResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteHumanLoopRequest'
      tags:
      - Human Loops
    get:
      operationId: DescribeHumanLoop
      summary: Describe Human Loop
      description: Returns information about the specified human loop. If the human loop was deleted, this operation will
        return a ResourceNotFoundException error.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeHumanLoopResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeHumanLoopRequest'
      tags:
      - Human Loops
  /human-loops:
    get:
      operationId: ListHumanLoops
      summary: List Human Loops
      description: Returns information about human loops, given the specified parameters. If a human loop was deleted, it
        will not be included.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListHumanLoopsResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListHumanLoopsRequest'
      tags:
      - Human Loops
    post:
      operationId: StartHumanLoop
      summary: Start Human Loop
      description: Starts a human loop, provided that at least one activation condition is met.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartHumanLoopResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartHumanLoopRequest'
      tags:
      - Human Loops
  /human-loops/stop:
    post:
      operationId: StopHumanLoop
      summary: Stop Human Loop
      description: Stops the specified human loop.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopHumanLoopResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopHumanLoopRequest'
      tags:
      - Human Loops
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: sagemaker
  schemas:
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    DeleteHumanLoopRequest:
      type: object
      properties:
        HumanLoopName:
          type: string
          description: The name of the human loop that you want to delete.
      required:
      - HumanLoopName
    DeleteHumanLoopResponse:
      type: object
      properties: {}
    DescribeHumanLoopRequest:
      type: object
      properties:
        HumanLoopName:
          type: string
          description: The name of the human loop that you want information about.
      required:
      - HumanLoopName
    DescribeHumanLoopResponse:
      type: object
      properties:
        CreationTime:
          type: string
          format: date-time
          description: The creation time when Amazon Augmented AI created the human loop.
        FailureReason:
          type: string
          description: The reason why a human loop failed. The failure reason is returned when the status of the human loop
            is Failed.
        FailureCode:
          type: string
          description: 'A failure code that identifies the type of failure. Possible values: ValidationError, Expired, InternalError'
        HumanLoopStatus:
          type: string
          enum:
          - InProgress
          - Failed
          - Completed
          - Stopped
          - Stopping
          description: The status of the human loop.
        HumanLoopName:
          type: string
          description: 'The name of the human loop. The name must be lowercase, unique within the Region in your account,
            and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).'
        HumanLoopArn:
          type: string
          description: The Amazon Resource Name (ARN) of the human loop.
        FlowDefinitionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow definition.
        HumanLoopOutput:
          $ref: '#/components/schemas/HumanLoopOutput'
      required:
      - CreationTime
      - HumanLoopStatus
      - HumanLoopName
      - HumanLoopArn
      - FlowDefinitionArn
    HumanLoopDataAttributes:
      type: object
      properties:
        ContentClassifiers:
          type: array
          items:
            type: string
            enum:
            - FreeOfPersonallyIdentifiableInformation
            - FreeOfAdultContent
          description: Declares that your content is free of personally identifiable information or adult content. Amazon
            SageMaker can restrict the Amazon Mechanical Turk workers who can view your task based on this information.
      required:
      - ContentClassifiers
    HumanLoopInput:
      type: object
      properties:
        InputContent:
          type: string
          description: Serialized input from the human loop. The input must be a string representation of a file in JSON format.
      required:
      - InputContent
    HumanLoopOutput:
      type: object
      properties:
        OutputS3Uri:
          type: string
          description: The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output.
      required:
      - OutputS3Uri
    HumanLoopSummary:
      type: object
      properties:
        HumanLoopName:
          type: string
          description: The name of the human loop.
        HumanLoopStatus:
          type: string
          enum:
          - InProgress
          - Failed
          - Completed
          - Stopped
          - Stopping
          description: The status of the human loop.
        CreationTime:
          type: string
          format: date-time
          description: When Amazon Augmented AI created the human loop.
        FailureReason:
          type: string
          description: The reason why the human loop failed. A failure reason is returned when the status of the human loop
            is Failed.
        FlowDefinitionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow definition used to configure the human loop.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ListHumanLoopsRequest:
      type: object
      properties:
        CreationTimeAfter:
          type: string
          format: date-time
          description: (Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For
            example, 2020-02-24.
        CreationTimeBefore:
          type: string
          format: date-time
          description: (Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format.
            For example, 2020-02-24.
        FlowDefinitionArn:
          type: string
          description: The Amazon Resource Name (ARN) of a flow definition.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: 'Optional. The order for displaying results. Valid values: Ascending and Descending.'
        NextToken:
          type: string
          description: A token to display the next page of results.
        MaxResults:
          type: integer
          description: The total number of items to return. If the total number of available items is more than the value
            specified in MaxResults, then a NextToken is returned in the output. You can use this token to display the next
            page of results.
      required:
      - FlowDefinitionArn
    ListHumanLoopsResponse:
      type: object
      properties:
        HumanLoopSummaries:
          type: array
          items:
            $ref: '#/components/schemas/HumanLoopSummary'
          description: An array of objects that contain information about the human loops.
        NextToken:
          type: string
          description: A token to display the next page of results.
      required:
      - HumanLoopSummaries
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    StartHumanLoopRequest:
      type: object
      properties:
        HumanLoopName:
          type: string
          description: The name of the human loop.
        FlowDefinitionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow definition associated with this human loop.
        HumanLoopInput:
          $ref: '#/components/schemas/HumanLoopInput'
        DataAttributes:
          $ref: '#/components/schemas/HumanLoopDataAttributes'
      required:
      - HumanLoopName
      - FlowDefinitionArn
      - HumanLoopInput
    StartHumanLoopResponse:
      type: object
      properties:
        HumanLoopArn:
          type: string
          description: The Amazon Resource Name (ARN) of the human loop.
    StopHumanLoopRequest:
      type: object
      properties:
        HumanLoopName:
          type: string
          description: The name of the human loop that you want to stop.
      required:
      - HumanLoopName
    StopHumanLoopResponse:
      type: object
      properties: {}
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    ValidationException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/sagemaker-a2i-runtime/service/2019-11-07/sagemaker-a2i-runtime-2019-11-07.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)