aws_sdk_sagemaker/client/
render_ui_template.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`RenderUiTemplate`](crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`ui_template(UiTemplate)`](crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder::ui_template) / [`set_ui_template(Option<UiTemplate>)`](crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder::set_ui_template):<br>required: **false**<br><p>A <code>Template</code> object containing the worker UI template to render.</p><br>
7    ///   - [`task(RenderableTask)`](crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder::task) / [`set_task(Option<RenderableTask>)`](crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder::set_task):<br>required: **true**<br><p>A <code>RenderableTask</code> object containing a representative task to render.</p><br>
8    ///   - [`role_arn(impl Into<String>)`](crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder::set_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.</p><br>
9    ///   - [`human_task_ui_arn(impl Into<String>)`](crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder::human_task_ui_arn) / [`set_human_task_ui_arn(Option<String>)`](crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder::set_human_task_ui_arn):<br>required: **false**<br><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><br>
10    /// - On success, responds with [`RenderUiTemplateOutput`](crate::operation::render_ui_template::RenderUiTemplateOutput) with field(s):
11    ///   - [`rendered_content(Option<String>)`](crate::operation::render_ui_template::RenderUiTemplateOutput::rendered_content): <p>A Liquid template that renders the HTML for the worker UI.</p>
12    ///   - [`errors(Option<Vec::<RenderingError>>)`](crate::operation::render_ui_template::RenderUiTemplateOutput::errors): <p>A list of one or more <code>RenderingError</code> objects if any were encountered while rendering the template. If there were no errors, the list is empty.</p>
13    /// - On failure, responds with [`SdkError<RenderUiTemplateError>`](crate::operation::render_ui_template::RenderUiTemplateError)
14    pub fn render_ui_template(&self) -> crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder {
15        crate::operation::render_ui_template::builders::RenderUiTemplateFluentBuilder::new(self.handle.clone())
16    }
17}