Skip to content

RenderUiTemplateRequest

Source code in docs_src/capo_sagemaker/types/render_ui_template_request.py 
14
15
16
17
18
19
20
21
22
23
24
class RenderUiTemplateRequest(TypedDict, closed=True):
    ui_template: NotRequired["capo_sagemaker.types.ui_template.UiTemplate"]
    """<p>A <code>Template</code> object containing the worker UI template to render.</p>"""
    task: NotRequired["capo_sagemaker.types.renderable_task.RenderableTask"]
    """<p>A <code>RenderableTask</code> object containing a representative task to render.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.</p>"""
    human_task_ui_arn: NotRequired[
        "capo_sagemaker.types.human_task_ui_arn.HumanTaskUiArn"
    ]
    """<p>The <code>HumanTaskUiArn</code> of the worker UI that you want to render. Do not provide a <code>HumanTaskUiArn</code> if you use the <code>UiTemplate</code> parameter.</p> <p>See a list of available Human Ui Amazon Resource Names (ARNs) in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UiConfig.html">UiConfig</a>.</p>"""

human_task_ui_arn instance-attribute 

human_task_ui_arn: NotRequired[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.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

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

task instance-attribute 

task: NotRequired[RenderableTask]

A RenderableTask object containing a representative task to render.

ui_template instance-attribute 

ui_template: NotRequired[UiTemplate]

A Template object containing the worker UI template to render.