[ aws . sagemaker ]

render-ui-template

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  render-ui-template
[--ui-template <value>]
--task <value>
--role-arn <value>
[--human-task-ui-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--ui-template (structure)

A Template object containing the worker UI template to render.

Content -> (string)

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

Shorthand Syntax:

Content=string

JSON Syntax:

{
  "Content": "string"
}

--task (structure)

A RenderableTask object containing a representative task to render.

Input -> (string)

A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input . For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as "text": "sample text" .

Shorthand Syntax:

Input=string

JSON Syntax:

{
  "Input": "string"
}

--role-arn (string)

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

--human-task-ui-arn (string)

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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

RenderedContent -> (string)

A Liquid template that renders the HTML for the worker UI.

Errors -> (list)

A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

(structure)

A description of an error that occurred while rendering the template.

Code -> (string)

A unique identifier for a specific class of errors.

Message -> (string)

A human-readable message describing the error.