SageMaker / Client / create_human_task_ui

create_human_task_ui#

SageMaker.Client.create_human_task_ui(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_human_task_ui(
    HumanTaskUiName='string',
    UiTemplate={
        'Content': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • HumanTaskUiName (string) –

    [REQUIRED]

    The name of the user interface you are creating.

  • UiTemplate (dict) –

    [REQUIRED]

    The Liquid template for the worker user interface.

    • Content (string) – [REQUIRED]

      The content of the Liquid template for the worker user interface.

  • Tags (list) –

    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.

    • (dict) –

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

      For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique per resource.

      • Value (string) – [REQUIRED]

        The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'HumanTaskUiArn': 'string'
}

Response Structure

  • (dict) –

    • HumanTaskUiArn (string) –

      The Amazon Resource Name (ARN) of the human review workflow user interface you create.

Exceptions

  • SageMaker.Client.exceptions.ResourceLimitExceeded

  • SageMaker.Client.exceptions.ResourceInUse