Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ 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>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--ui-template (structure)

A Template object containing the worker UI template to render.

Shorthand Syntax:


JSON Syntax:

  "Content": "string"

--task (structure)

A RenderableTask object containing a representative task to render.

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.

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