Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]



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.


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


--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:


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:


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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.


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.


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.