DescribeHumanTaskUi - Amazon SageMaker (original) (raw)

Returns information about the requested human task user interface (worker task template).

Request Syntax

{
   "HumanTaskUiName": "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 human task user interface (worker task template) you want information about.

Type: String

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

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

Required: Yes

Response Syntax

{
   "CreationTime": number,
   "HumanTaskUiArn": "string",
   "HumanTaskUiName": "string",
   "HumanTaskUiStatus": "string",
   "UiTemplate": { 
      "ContentSha256": "string",
      "Url": "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.

CreationTime

The timestamp when the human task user interface was created.

Type: Timestamp

HumanTaskUiArn

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

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

HumanTaskUiName

The name of the human task user interface (worker task template).

Type: String

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

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

HumanTaskUiStatus

The status of the human task user interface (worker task template). Valid values are listed below.

Type: String

Valid Values: Active | Deleting

UiTemplate

Container for user interface template information.

Type: UiTemplateInfo object

Errors

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

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: