human_task_uis

Creates, updates, deletes, gets or lists a human_task_uis resource.

Overview

Name	human_task_uis
Type	Resource
Id	aws.sagemaker.human_task_uis

Fields

The following fields are returned by SELECT queries:

describe_human_task_ui

Name	Datatype	Description
creation_time	string (date-time)	The timestamp when the human task user interface was created.
human_task_ui_arn	string	The Amazon Resource Name (ARN) of the human task user interface (worker task template). (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]+:[0-9]{12}:human-task-ui/.</code>)
human_task_ui_name	string	The name of the human task user interface (worker task template). (pattern: <code>[a-z0-9](-[a-z0-9])</code>)
human_task_ui_status	string	The status of the human task user interface (worker task template). Valid values are listed below. (Active, Deleting)
ui_template	object	Container for user interface template information.

list_human_task_uis

Name	Datatype	Description
creation_time	string (date-time)	A timestamp when SageMaker created the human task user interface.
human_task_ui_arn	string	The Amazon Resource Name (ARN) of the human task user interface. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]+:[0-9]{12}:human-task-ui/.</code>)
human_task_ui_name	string	The name of the human task user interface. (pattern: <code>[a-z0-9](-[a-z0-9])</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_human_task_ui	select	region		Returns information about the requested human task user interface (worker task template).
list_human_task_uis	select	region		Returns information about the human task user interfaces in your account.
create_human_task_ui	insert	region, HumanTaskUiName, UiTemplate		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.
delete_human_task_ui	delete	region		Use this operation to delete a human task user interface (worker task template). To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_human_task_ui

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

SELECT
creation_time,
human_task_ui_arn,
human_task_ui_name,
human_task_ui_status,
ui_template
FROM aws.sagemaker.human_task_uis
WHERE region = '{{ region }}' -- required
;

list_human_task_uis

Returns information about the human task user interfaces in your account.

SELECT
creation_time,
human_task_ui_arn,
human_task_ui_name
FROM aws.sagemaker.human_task_uis
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_human_task_ui

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.

INSERT INTO aws.sagemaker.human_task_uis (
HumanTaskUiName,
UiTemplate,
Tags,
region
)
SELECT 
'{{ HumanTaskUiName }}' /* required */,
'{{ UiTemplate }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
human_task_ui_arn
;

Manifest

# Description fields are for documentation purposes
- name: human_task_uis
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the human_task_uis resource.
  - name: HumanTaskUiName
    value: "{{ HumanTaskUiName }}"
    description: |
      The name of the user interface you are creating.
  - name: UiTemplate
    description: |
      The Liquid template for the worker user interface.
    value:
      Content: "{{ Content }}"
  - name: Tags
    description: |
      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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_human_task_ui

Use this operation to delete a human task user interface (worker task template). To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

DELETE FROM aws.sagemaker.human_task_uis
WHERE region = '{{ region }}' --required
;