Skip to content

Renders the UI template so that you can preview the worker's experience

Description

Renders the UI template so that you can preview the worker's experience.

Usage

sagemaker_render_ui_template(UiTemplate, Task, RoleArn, HumanTaskUiArn)

Arguments

  • UiTemplate

    A Template object containing the worker UI template to render.

  • Task

    [required] A RenderableTask object containing a representative task to render.

  • RoleArn

    [required] The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

  • HumanTaskUiArn

    The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

    See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

Value

A list with the following syntax:

list(
  RenderedContent = "string",
  Errors = list(
    list(
      Code = "string",
      Message = "string"
    )
  )
)

Request syntax

svc$render_ui_template(
  UiTemplate = list(
    Content = "string"
  ),
  Task = list(
    Input = "string"
  ),
  RoleArn = "string",
  HumanTaskUiArn = "string"
)