Amazon Augmented AI Runtime
<p>Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning application
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"info": {
"version": "2019-11-07",
"x-release": "v4",
"title": "Amazon Augmented AI Runtime",
"description": "<p>Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning application. When an AI application can't evaluate data with a high degree of confidence, human reviewers can take over. This human review is called a human review workflow. To create and start a human review workflow, you need three resources: a <i>worker task template</i>, a <i>flow definition</i>, and a <i>human loop</i>.</p> <p>For information about these resources and prerequisites for using Amazon A2I, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-getting-started.html\">Get Started with Amazon Augmented AI</a> in the Amazon SageMaker Developer Guide.</p> <p>This API reference includes information about API actions and data types that you can use to interact with Amazon A2I programmatically. Use this guide to:</p> <ul> <li> <p>Start a human loop with the <code>StartHumanLoop</code> operation when using Amazon A2I with a <i>custom task type</i>. To learn more about the difference between custom and built-in task types, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-task-types-general.html\">Use Task Types </a>. To learn how to start a human loop using this API, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-start-human-loop.html#a2i-instructions-starthumanloop\">Create and Start a Human Loop for a Custom Task Type </a> in the Amazon SageMaker Developer Guide.</p> </li> <li> <p>Manage your human loops. You can list all human loops that you have created, describe individual human loops, and stop and delete human loops. To learn more, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-monitor-humanloop-results.html\">Monitor and Manage Your Human Loop </a> in the Amazon SageMaker Developer Guide.</p> </li> </ul> <p>Amazon A2I integrates APIs from various AWS services to create and start human review workflows for those services. To learn how Amazon A2I uses these APIs, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-api-references.html\">Use APIs in Amazon A2I</a> in the Amazon SageMaker Developer Guide.</p>",
"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": "sagemaker-a2i-runtime",
"x-aws-signingName": "sagemaker",
"x-origin": [
{
"contentType": "application/json",
"url": "https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/sagemaker-a2i-runtime-2019-11-07.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
},
"externalDocs": {
"description": "Amazon Web Services documentation",
"url": "https://docs.aws.amazon.com/sagemaker/"
},
"servers": [
{
"url": "http://a2i-runtime.sagemaker.{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 Amazon Augmented AI Runtime multi-region endpoint"
},
{
"url": "https://a2i-runtime.sagemaker.{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 Amazon Augmented AI Runtime multi-region endpoint"
},
{
"url": "http://a2i-runtime.sagemaker.{region}.amazonaws.com.cn",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"cn-north-1",
"cn-northwest-1"
],
"default": "cn-north-1"
}
},
"description": "The Amazon Augmented AI Runtime endpoint for China (Beijing) and China (Ningxia)"
},
{
"url": "https://a2i-runtime.sagemaker.{region}.amazonaws.com.cn",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"cn-north-1",
"cn-northwest-1"
],
"default": "cn-north-1"
}
},
"description": "The Amazon Augmented AI Runtime endpoint for China (Beijing) and China (Ningxia)"
}
],
"x-hasEquivalentPaths": true,
"paths": {
"/human-loops/{HumanLoopName}": {
"delete": {
"operationId": "DeleteHumanLoop",
"description": "<p>Deletes the specified human loop for a flow definition.</p> <p>If the human loop was deleted, this operation will return a <code>ResourceNotFoundException</code>. </p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteHumanLoopResponse"
}
}
}
},
"480": {
"description": "ValidationException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationException"
}
}
}
},
"481": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"482": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
},
"483": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
}
},
"parameters": [
{
"name": "HumanLoopName",
"in": "path",
"required": true,
"description": "The name of the human loop that you want to delete.",
"schema": {
"type": "string",
"pattern": "^[a-z0-9](-*[a-z0-9])*$",
"minLength": 1,
"maxLength": 63
}
}
]
},
"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"
}
],
"get": {
"operationId": "DescribeHumanLoop",
"description": "Returns information about the specified human loop. If the human loop was deleted, this operation will return a <code>ResourceNotFoundException</code> error. ",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DescribeHumanLoopResponse"
}
}
}
},
"480": {
"description": "ValidationException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationException"
}
}
}
},
"481": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"482": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
},
"483": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
}
},
"parameters": [
{
"name": "HumanLoopName",
"in": "path",
"required": true,
"description": "The name of the human loop that you want information about.",
"schema": {
"type": "string",
"pattern": "^[a-z0-9](-*[a-z0-9])*$",
"minLength": 1,
"maxLength": 63
}
}
]
}
},
"/human-loops#FlowDefinitionArn": {
"get": {
"operationId": "ListHumanLoops",
"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"
}
}
}
},
"480": {
"description": "ValidationException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationException"
}
}
}
},
"481": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"482": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
},
"483": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
}
},
"parameters": [
{
"name": "CreationTimeAfter",
"in": "query",
"required": false,
"description": "(Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, <code>2020-02-24</code>.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "CreationTimeBefore",
"in": "query",
"required": false,
"description": "(Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, <code>2020-02-24</code>.",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "FlowDefinitionArn",
"in": "query",
"required": true,
"description": "The Amazon Resource Name (ARN) of a flow definition.",
"schema": {
"type": "string",
"pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:flow-definition/.*",
"maxLength": 1024
}
},
{
"name": "SortOrder",
"in": "query",
"required": false,
"description": "Optional. The order for displaying results. Valid values: <code>Ascending</code> and <code>Descending</code>.",
"schema": {
"type": "string",
"enum": [
"Ascending",
"Descending"
]
}
},
{
"name": "NextToken",
"in": "query",
"required": false,
"description": "A token to display the next page of results.",
"schema": {
"type": "string",
"pattern": ".*",
"maxLength": 8192
}
},
{
"name": "MaxResults",
"in": "query",
"required": false,
"description": "The total number of items to return. If the total number of available items is more than the value specified in <code>MaxResults</code>, then a <code>NextToken</code> is returned in the output. You can use this token to display the next page of results. ",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
]
},
"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"
}
]
},
"/human-loops": {
"post": {
"operationId": "StartHumanLoop",
"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"
}
}
}
},
"480": {
"description": "ValidationException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationException"
}
}
}
},
"481": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
},
"482": {
"description": "ServiceQuotaExceededException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceQuotaExceededException"
}
}
}
},
"483": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"484": {
"description": "ConflictException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictException"
}
}
}
}
},
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"HumanLoopName",
"FlowDefinitionArn",
"HumanLoopInput"
],
"properties": {
"HumanLoopName": {
"description": "The name of the human loop.",
"type": "string",
"pattern": "^[a-z0-9](-*[a-z0-9])*$",
"minLength": 1,
"maxLength": 63
},
"FlowDefinitionArn": {
"description": "The Amazon Resource Name (ARN) of the flow definition associated with this human loop.",
"type": "string",
"pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:flow-definition/.*",
"maxLength": 1024
},
"HumanLoopInput": {
"description": "An object containing the human loop input in JSON format.",
"type": "object",
"properties": {
"InputContent": {
"allOf": [
{
"$ref": "#/components/schemas/InputContent"
},
{
"description": "Serialized input from the human loop. The input must be a string representation of a file in JSON format."
}
]
}
}
},
"DataAttributes": {
"description": "Attributes of the data specified by the customer. Use these to describe the data to be labeled.",
"type": "object",
"properties": {
"ContentClassifiers": {
"allOf": [
{
"$ref": "#/components/schemas/ContentClassifiers"
},
{
"description": "<p>Declares that your content is free of personally identifiable information or adult content.</p> <p>Amazon SageMaker can restrict the Amazon Mechanical Turk workers who can view your task based on this information.</p>"
}
]
}
}
}
}
}
}
}
}
},
"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"
}
]
},
"/human-loops/stop": {
"post": {
"operationId": "StopHumanLoop",
"description": "Stops the specified human loop.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StopHumanLoopResponse"
}
}
}
},
"480": {
"description": "ValidationException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationException"
}
}
}
},
"481": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"482": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
},
"483": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
}
},
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"HumanLoopName"
],
"properties": {
"HumanLoopName": {
"description": "The name of the human loop that you want to stop.",
"type": "string",
"pattern": "^[a-z0-9](-*[a-z0-9])*$",
"minLength": 1,
"maxLength": 63
}
}
}
}
}
}
},
"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"
}
]
}
},
"components": {
"parameters": {
"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-Algorithm": {
"name": "X-Amz-Algorithm",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Credential": {
"name": "X-Amz-Credential",
"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-Signature": {
"name": "X-Amz-Signature",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-SignedHeaders": {
"name": "X-Amz-SignedHeaders",
"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"
}
},
"schemas": {
"DeleteHumanLoopResponse": {
"type": "object",
"properties": {}
},
"ValidationException": {},
"ResourceNotFoundException": {},
"ThrottlingException": {},
"InternalServerException": {},
"DescribeHumanLoopResponse": {
"type": "object",
"required": [
"CreationTime",
"HumanLoopStatus",
"HumanLoopName",
"HumanLoopArn",
"FlowDefinitionArn"
],
"properties": {
"CreationTime": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The creation time when Amazon Augmented AI created the human loop."
}
]
},
"FailureReason": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The reason why a human loop failed. The failure reason is returned when the status of the human loop is <code>Failed</code>."
}
]
},
"FailureCode": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "<p>A failure code that identifies the type of failure.</p> <p>Possible values: <code>ValidationError</code>, <code>Expired</code>, <code>InternalError</code> </p>"
}
]
},
"HumanLoopStatus": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopStatus"
},
{
"description": "The status of the human loop. "
}
]
},
"HumanLoopName": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopName"
},
{
"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": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopArn"
},
{
"description": "The Amazon Resource Name (ARN) of the human loop."
}
]
},
"FlowDefinitionArn": {
"allOf": [
{
"$ref": "#/components/schemas/FlowDefinitionArn"
},
{
"description": "The Amazon Resource Name (ARN) of the flow definition."
}
]
},
"HumanLoopOutput": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopOutput"
},
{
"description": "An object that contains information about the output of the human loop."
}
]
}
}
},
"ListHumanLoopsResponse": {
"type": "object",
"required": [
"HumanLoopSummaries"
],
"properties": {
"HumanLoopSummaries": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopSummaries"
},
{
"description": "An array of objects that contain information about the human loops."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/NextToken"
},
{
"description": "A token to display the next page of results."
}
]
}
}
},
"StartHumanLoopResponse": {
"type": "object",
"properties": {
"HumanLoopArn": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopArn"
},
{
"description": "The Amazon Resource Name (ARN) of the human loop."
}
]
}
}
},
"InputContent": {
"type": "string",
"maxLength": 3145728
},
"ContentClassifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContentClassifier"
},
"maxItems": 256
},
"ServiceQuotaExceededException": {},
"ConflictException": {},
"StopHumanLoopResponse": {
"type": "object",
"properties": {}
},
"ContentClassifier": {
"type": "string",
"enum": [
"FreeOfPersonallyIdentifiableInformation",
"FreeOfAdultContent"
]
},
"HumanLoopName": {
"type": "string",
"pattern": "^[a-z0-9](-*[a-z0-9])*$",
"minLength": 1,
"maxLength": 63
},
"DeleteHumanLoopRequest": {
"type": "object",
"title": "DeleteHumanLoopRequest",
"properties": {}
},
"DescribeHumanLoopRequest": {
"type": "object",
"title": "DescribeHumanLoopRequest",
"properties": {}
},
"Timestamp": {
"type": "string",
"format": "date-time"
},
"String": {
"type": "string"
},
"HumanLoopStatus": {
"type": "string",
"enum": [
"InProgress",
"Failed",
"Completed",
"Stopped",
"Stopping"
]
},
"HumanLoopArn": {
"type": "string",
"pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:human-loop/.*",
"maxLength": 1024
},
"FlowDefinitionArn": {
"type": "string",
"pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:flow-definition/.*",
"maxLength": 1024
},
"HumanLoopOutput": {
"type": "object",
"required": [
"OutputS3Uri"
],
"properties": {
"OutputS3Uri": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output."
}
]
}
},
"description": "Information about where the human output will be stored."
},
"FailureReason": {
"type": "string",
"maxLength": 1024
},
"HumanLoopDataAttributes": {
"type": "object",
"required": [
"ContentClassifiers"
],
"properties": {
"ContentClassifiers": {
"allOf": [
{
"$ref": "#/components/schemas/ContentClassifiers"
},
{
"description": "<p>Declares that your content is free of personally identifiable information or adult content.</p> <p>Amazon SageMaker can restrict the Amazon Mechanical Turk workers who can view your task based on this information.</p>"
}
]
}
},
"description": "Attributes of the data specified by the customer. Use these to describe the data to be labeled."
},
"HumanLoopInput": {
"type": "object",
"required": [
"InputContent"
],
"properties": {
"InputContent": {
"allOf": [
{
"$ref": "#/components/schemas/InputContent"
},
{
"description": "Serialized input from the human loop. The input must be a string representation of a file in JSON format."
}
]
}
},
"description": "An object containing the human loop input in JSON format."
},
"HumanLoopSummary": {
"type": "object",
"properties": {
"HumanLoopName": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopName"
},
{
"description": "The name of the human loop."
}
]
},
"HumanLoopStatus": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopStatus"
},
{
"description": "The status of the human loop. "
}
]
},
"CreationTime": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "When Amazon Augmented AI created the human loop."
}
]
},
"FailureReason": {
"allOf": [
{
"$ref": "#/components/schemas/FailureReason"
},
{
"description": "The reason why the human loop failed. A failure reason is returned when the status of the human loop is <code>Failed</code>."
}
]
},
"FlowDefinitionArn": {
"allOf": [
{
"$ref": "#/components/schemas/FlowDefinitionArn"
},
{
"description": "The Amazon Resource Name (ARN) of the flow definition used to configure the human loop."
}
]
}
},
"description": "Summary information about the human loop."
},
"HumanLoopSummaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HumanLoopSummary"
}
},
"SortOrder": {
"type": "string",
"enum": [
"Ascending",
"Descending"
]
},
"NextToken": {
"type": "string",
"pattern": ".*",
"maxLength": 8192
},
"MaxResults": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"ListHumanLoopsRequest": {
"type": "object",
"title": "ListHumanLoopsRequest",
"properties": {}
},
"StartHumanLoopRequest": {
"type": "object",
"required": [
"HumanLoopName",
"FlowDefinitionArn",
"HumanLoopInput"
],
"title": "StartHumanLoopRequest",
"properties": {
"HumanLoopName": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopName"
},
{
"description": "The name of the human loop."
}
]
},
"FlowDefinitionArn": {
"allOf": [
{
"$ref": "#/components/schemas/FlowDefinitionArn"
},
{
"description": "The Amazon Resource Name (ARN) of the flow definition associated with this human loop."
}
]
},
"HumanLoopInput": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopInput"
},
{
"description": "An object that contains information about the human loop."
}
]
},
"DataAttributes": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopDataAttributes"
},
{
"description": "Attributes of the specified data. Use <code>DataAttributes</code> to specify if your data is free of personally identifiable information and/or free of adult content."
}
]
}
}
},
"StopHumanLoopRequest": {
"type": "object",
"required": [
"HumanLoopName"
],
"title": "StopHumanLoopRequest",
"properties": {
"HumanLoopName": {
"allOf": [
{
"$ref": "#/components/schemas/HumanLoopName"
},
{
"description": "The name of the human loop that you want to stop."
}
]
}
}
}
}
},
"security": [
{
"hmac": []
}
]
}