Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartHumanLoop

Starts a human loop, provided that at least one activation condition is met.

Request Syntax


POST /human-loops HTTP/1.1
Content-type: application/json

{
   "DataAttributes": { 
      "ContentClassifiers": [ "string" ]
   },
   "FlowDefinitionArn": "string",
   "HumanLoopInput": { 
      "InputContent": "string"
   },
   "HumanLoopName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DataAttributes

Attributes of the specified data. Use DataAttributes to specify if your data is free of personally identifiable information and/or free of adult content.

Type: HumanLoopDataAttributes object

Required: No

FlowDefinitionArn

The Amazon Resource Name (ARN) of the flow definition associated with this human loop.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:flow-definition/.*

Required: Yes

HumanLoopInput

An object that contains information about the human loop.

Type: HumanLoopInput object

Required: Yes

HumanLoopName

The name of the human loop.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-z0-9](-*[a-z0-9])*$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "HumanLoopArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

HumanLoopArn

The Amazon Resource Name (ARN) of the human loop.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:human-loop/.*

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

Your request has the same name as another active human loop but has different input data. You cannot start two human loops with the same name and different input data.

HTTP Status Code: 409

InternalServerException

We couldn't process your request because of an issue with the server. Try again later.

HTTP Status Code: 500

ServiceQuotaExceededException

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account. For a list of Amazon A2I service quotes, see Amazon Augmented AI Service Quotes. Delete some resources or request an increase in your service quota. You can request a quota increase using Service Quotas or the AWS Support Center. To request an increase, see AWS Service Quotas in the AWS General Reference.

HTTP Status Code: 402

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429

ValidationException

The request isn't valid. Check the syntax and try again.

HTTP Status Code: 400