Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.RenderUiTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Renders the UI template so that you can preview the worker's experience.

Synopsis

data RenderUiTemplate = RenderUiTemplate' {
- uiTemplate :: Maybe UiTemplate
- humanTaskUiArn :: Maybe Text
- task :: RenderableTask
- roleArn :: Text
}
newRenderUiTemplate :: RenderableTask -> Text -> RenderUiTemplate
renderUiTemplate_uiTemplate :: Lens' RenderUiTemplate (Maybe UiTemplate)
renderUiTemplate_humanTaskUiArn :: Lens' RenderUiTemplate (Maybe Text)
renderUiTemplate_task :: Lens' RenderUiTemplate RenderableTask
renderUiTemplate_roleArn :: Lens' RenderUiTemplate Text
data RenderUiTemplateResponse = RenderUiTemplateResponse' {
- httpStatus :: Int
- renderedContent :: Text
- errors :: [RenderingError]
}
newRenderUiTemplateResponse :: Int -> Text -> RenderUiTemplateResponse
renderUiTemplateResponse_httpStatus :: Lens' RenderUiTemplateResponse Int
renderUiTemplateResponse_renderedContent :: Lens' RenderUiTemplateResponse Text
renderUiTemplateResponse_errors :: Lens' RenderUiTemplateResponse [RenderingError]

Creating a Request

data RenderUiTemplate Source #

See: newRenderUiTemplate smart constructor.

Constructors

RenderUiTemplate'

Fields

uiTemplate :: Maybe UiTemplate
A Template object containing the worker UI template to render.
humanTaskUiArn :: Maybe Text
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.
task :: RenderableTask
A RenderableTask object containing a representative task to render.
roleArn :: Text
The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

Instances

Instances details

Eq RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods (==) :: RenderUiTemplate -> RenderUiTemplate -> Bool # (/=) :: RenderUiTemplate -> RenderUiTemplate -> Bool #
Read RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods readsPrec :: Int -> ReadS RenderUiTemplate # readList :: ReadS [RenderUiTemplate] # readPrec :: ReadPrec RenderUiTemplate # readListPrec :: ReadPrec [RenderUiTemplate] #
Show RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods showsPrec :: Int -> RenderUiTemplate -> ShowS # show :: RenderUiTemplate -> String # showList :: [RenderUiTemplate] -> ShowS #
Generic RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Associated Types type Rep RenderUiTemplate :: Type -> Type # Methods from :: RenderUiTemplate -> Rep RenderUiTemplate x # to :: Rep RenderUiTemplate x -> RenderUiTemplate #
NFData RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods rnf :: RenderUiTemplate -> () #
Hashable RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods hashWithSalt :: Int -> RenderUiTemplate -> Int # hash :: RenderUiTemplate -> Int #
ToJSON RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods toJSON :: RenderUiTemplate -> Value # toEncoding :: RenderUiTemplate -> Encoding # toJSONList :: [RenderUiTemplate] -> Value # toEncodingList :: [RenderUiTemplate] -> Encoding #
AWSRequest RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Associated Types type AWSResponse RenderUiTemplate # Methods request :: RenderUiTemplate -> Request RenderUiTemplate # response :: MonadResource m => Logger -> Service -> Proxy RenderUiTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RenderUiTemplate))) #
ToHeaders RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods toHeaders :: RenderUiTemplate -> [Header] #
ToPath RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods toPath :: RenderUiTemplate -> ByteString #
ToQuery RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods toQuery :: RenderUiTemplate -> QueryString #
type Rep RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate type Rep RenderUiTemplate = D1 ('MetaData "RenderUiTemplate" "Amazonka.SageMaker.RenderUiTemplate" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "RenderUiTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "uiTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UiTemplate)) :: S1 ('MetaSel ('Just "humanTaskUiArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "task") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RenderableTask) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse RenderUiTemplate Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate type AWSResponse RenderUiTemplate = RenderUiTemplateResponse

newRenderUiTemplate Source #

Arguments

:: RenderableTask	`$sel:task:RenderUiTemplate'`
-> Text	`$sel:roleArn:RenderUiTemplate'`
-> RenderUiTemplate

Create a value of RenderUiTemplate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:uiTemplate:RenderUiTemplate', renderUiTemplate_uiTemplate - A Template object containing the worker UI template to render.

$sel:humanTaskUiArn:RenderUiTemplate', renderUiTemplate_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.

$sel:task:RenderUiTemplate', renderUiTemplate_task - A RenderableTask object containing a representative task to render.

$sel:roleArn:RenderUiTemplate', renderUiTemplate_roleArn - The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

Request Lenses

renderUiTemplate_uiTemplate :: Lens' RenderUiTemplate (Maybe UiTemplate) Source #

A Template object containing the worker UI template to render.

renderUiTemplate_humanTaskUiArn :: Lens' RenderUiTemplate (Maybe Text) Source #

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.

renderUiTemplate_task :: Lens' RenderUiTemplate RenderableTask Source #

A RenderableTask object containing a representative task to render.

renderUiTemplate_roleArn :: Lens' RenderUiTemplate Text Source #

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

Destructuring the Response

data RenderUiTemplateResponse Source #

See: newRenderUiTemplateResponse smart constructor.

Constructors

RenderUiTemplateResponse'
Fields httpStatus :: Int The response's http status code. renderedContent :: Text A Liquid template that renders the HTML for the worker UI. errors :: [RenderingError] 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.

Instances

Instances details

Eq RenderUiTemplateResponse Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods (==) :: RenderUiTemplateResponse -> RenderUiTemplateResponse -> Bool # (/=) :: RenderUiTemplateResponse -> RenderUiTemplateResponse -> Bool #
Read RenderUiTemplateResponse Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods readsPrec :: Int -> ReadS RenderUiTemplateResponse # readList :: ReadS [RenderUiTemplateResponse] # readPrec :: ReadPrec RenderUiTemplateResponse # readListPrec :: ReadPrec [RenderUiTemplateResponse] #
Show RenderUiTemplateResponse Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods showsPrec :: Int -> RenderUiTemplateResponse -> ShowS # show :: RenderUiTemplateResponse -> String # showList :: [RenderUiTemplateResponse] -> ShowS #
Generic RenderUiTemplateResponse Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Associated Types type Rep RenderUiTemplateResponse :: Type -> Type # Methods from :: RenderUiTemplateResponse -> Rep RenderUiTemplateResponse x # to :: Rep RenderUiTemplateResponse x -> RenderUiTemplateResponse #
NFData RenderUiTemplateResponse Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate Methods rnf :: RenderUiTemplateResponse -> () #
type Rep RenderUiTemplateResponse Source #
Instance details Defined in Amazonka.SageMaker.RenderUiTemplate type Rep RenderUiTemplateResponse = D1 ('MetaData "RenderUiTemplateResponse" "Amazonka.SageMaker.RenderUiTemplate" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "RenderUiTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "renderedContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RenderingError]))))

newRenderUiTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:RenderUiTemplateResponse'`
-> Text	`$sel:renderedContent:RenderUiTemplateResponse'`
-> RenderUiTemplateResponse

Create a value of RenderUiTemplateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:RenderUiTemplateResponse', renderUiTemplateResponse_httpStatus - The response's http status code.

$sel:renderedContent:RenderUiTemplateResponse', renderUiTemplateResponse_renderedContent - A Liquid template that renders the HTML for the worker UI.

$sel:errors:RenderUiTemplateResponse', renderUiTemplateResponse_errors - 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.

Response Lenses

renderUiTemplateResponse_httpStatus :: Lens' RenderUiTemplateResponse Int Source #

The response's http status code.

renderUiTemplateResponse_renderedContent :: Lens' RenderUiTemplateResponse Text Source #

A Liquid template that renders the HTML for the worker UI.

renderUiTemplateResponse_errors :: Lens' RenderUiTemplateResponse [RenderingError] Source #

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.