1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package sagemaker
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/sagemaker/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Renders the UI template so that you can preview the worker's experience.
15func (c *Client) RenderUiTemplate(ctx context.Context, params *RenderUiTemplateInput, optFns ...func(*Options)) (*RenderUiTemplateOutput, error) {
16	if params == nil {
17		params = &RenderUiTemplateInput{}
18	}
19
20	result, metadata, err := c.invokeOperation(ctx, "RenderUiTemplate", params, optFns, addOperationRenderUiTemplateMiddlewares)
21	if err != nil {
22		return nil, err
23	}
24
25	out := result.(*RenderUiTemplateOutput)
26	out.ResultMetadata = metadata
27	return out, nil
28}
29
30type RenderUiTemplateInput struct {
31
32	// The Amazon Resource Name (ARN) that has access to the S3 objects that are used
33	// by the template.
34	//
35	// This member is required.
36	RoleArn *string
37
38	// A RenderableTask object containing a representative task to render.
39	//
40	// This member is required.
41	Task *types.RenderableTask
42
43	// The HumanTaskUiArn of the worker UI that you want to render. Do not provide a
44	// HumanTaskUiArn if you use the UiTemplate parameter. See a list of available
45	// Human Ui Amazon Resource Names (ARNs) in UiConfig.
46	HumanTaskUiArn *string
47
48	// A Template object containing the worker UI template to render.
49	UiTemplate *types.UiTemplate
50}
51
52type RenderUiTemplateOutput struct {
53
54	// A list of one or more RenderingError objects if any were encountered while
55	// rendering the template. If there were no errors, the list is empty.
56	//
57	// This member is required.
58	Errors []types.RenderingError
59
60	// A Liquid template that renders the HTML for the worker UI.
61	//
62	// This member is required.
63	RenderedContent *string
64
65	// Metadata pertaining to the operation's result.
66	ResultMetadata middleware.Metadata
67}
68
69func addOperationRenderUiTemplateMiddlewares(stack *middleware.Stack, options Options) (err error) {
70	err = stack.Serialize.Add(&awsAwsjson11_serializeOpRenderUiTemplate{}, middleware.After)
71	if err != nil {
72		return err
73	}
74	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpRenderUiTemplate{}, middleware.After)
75	if err != nil {
76		return err
77	}
78	if err = addSetLoggerMiddleware(stack, options); err != nil {
79		return err
80	}
81	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
82		return err
83	}
84	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
85		return err
86	}
87	if err = addResolveEndpointMiddleware(stack, options); err != nil {
88		return err
89	}
90	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
91		return err
92	}
93	if err = addRetryMiddlewares(stack, options); err != nil {
94		return err
95	}
96	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
97		return err
98	}
99	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
100		return err
101	}
102	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
103		return err
104	}
105	if err = addClientUserAgent(stack); err != nil {
106		return err
107	}
108	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
109		return err
110	}
111	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
112		return err
113	}
114	if err = addOpRenderUiTemplateValidationMiddleware(stack); err != nil {
115		return err
116	}
117	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRenderUiTemplate(options.Region), middleware.Before); err != nil {
118		return err
119	}
120	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
121		return err
122	}
123	if err = addResponseErrorMiddleware(stack); err != nil {
124		return err
125	}
126	if err = addRequestResponseLogging(stack, options); err != nil {
127		return err
128	}
129	return nil
130}
131
132func newServiceMetadataMiddleware_opRenderUiTemplate(region string) *awsmiddleware.RegisterServiceMetadata {
133	return &awsmiddleware.RegisterServiceMetadata{
134		Region:        region,
135		ServiceID:     ServiceID,
136		SigningName:   "sagemaker",
137		OperationName: "RenderUiTemplate",
138	}
139}
140