CreateHumanTaskUi
Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
Request Syntax
{
"HumanTaskUiName": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"UiTemplate": {
"Content": "string
"
}
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- HumanTaskUiName
-
The name of the user interface you are creating.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-z0-9](-*[a-z0-9])*
Required: Yes
- Tags
-
An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- UiTemplate
-
The Liquid template for the worker user interface.
Type: UiTemplate object
Required: Yes
Response Syntax
{
"HumanTaskUiArn": "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.
- HumanTaskUiArn
-
The Amazon Resource Name (ARN) of the human review workflow user interface you create.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]+:[0-9]{12}:human-task-ui/.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceInUse
-
Resource being accessed is in use.
HTTP Status Code: 400
- ResourceLimitExceeded
-
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: