SageMaker / Client / describe_human_task_ui

describe_human_task_ui#

SageMaker.Client.describe_human_task_ui(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_human_task_ui(
    HumanTaskUiName='string'
)
Parameters:

HumanTaskUiName (string) –

[REQUIRED]

The name of the human task user interface (worker task template) you want information about.

Return type:

dict

Returns:

Response Syntax

{
    'HumanTaskUiArn': 'string',
    'HumanTaskUiName': 'string',
    'HumanTaskUiStatus': 'Active'|'Deleting',
    'CreationTime': datetime(2015, 1, 1),
    'UiTemplate': {
        'Url': 'string',
        'ContentSha256': 'string'
    }
}

Response Structure

  • (dict) –

    • HumanTaskUiArn (string) –

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

    • HumanTaskUiName (string) –

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

    • HumanTaskUiStatus (string) –

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

    • CreationTime (datetime) –

      The timestamp when the human task user interface was created.

    • UiTemplate (dict) –

      Container for user interface template information.

      • Url (string) –

        The URL for the user interface template.

      • ContentSha256 (string) –

        The SHA-256 digest of the contents of the template.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound