Amazonka.SageMaker.RenderUiTemplate

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

Creating a Request

data RenderUiTemplate

See: newRenderUiTemplate smart constructor.

Constructors

RenderUiTemplate'

Fields

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

• uiTemplate :: Maybe UiTemplate

  A Template object containing the worker UI template to render.

• 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

ToJSON RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

toJSON :: RenderUiTemplate -> Value

toEncoding :: RenderUiTemplate -> Encoding

toJSONList :: [RenderUiTemplate] -> Value

toEncodingList :: [RenderUiTemplate] -> Encoding

ToHeaders RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

toHeaders :: RenderUiTemplate -> [Header]

ToPath RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

toPath :: RenderUiTemplate -> ByteString

ToQuery RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

toQuery :: RenderUiTemplate -> QueryString

AWSRequest RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Associated Types

type AWSResponse RenderUiTemplate

Methods

request :: (Service -> Service) -> RenderUiTemplate -> Request RenderUiTemplate

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RenderUiTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RenderUiTemplate)))

Generic RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Associated Types

type Rep RenderUiTemplate :: Type -> Type

Methods

from :: RenderUiTemplate -> Rep RenderUiTemplate x

to :: Rep RenderUiTemplate x -> RenderUiTemplate

Read RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

readsPrec :: Int -> ReadS RenderUiTemplate

readList :: ReadS [RenderUiTemplate]

readPrec :: ReadPrec RenderUiTemplate

readListPrec :: ReadPrec [RenderUiTemplate]

Show RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

showsPrec :: Int -> RenderUiTemplate -> ShowS

show :: RenderUiTemplate -> String

showList :: [RenderUiTemplate] -> ShowS

NFData RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

rnf :: RenderUiTemplate -> ()

Eq RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

(==) :: RenderUiTemplate -> RenderUiTemplate -> Bool

(/=) :: RenderUiTemplate -> RenderUiTemplate -> Bool

Hashable RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

hashWithSalt :: Int -> RenderUiTemplate -> Int

hash :: RenderUiTemplate -> Int

type AWSResponse RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

type AWSResponse RenderUiTemplate = RenderUiTemplateResponse

type Rep RenderUiTemplate

Defined in Amazonka.SageMaker.RenderUiTemplate

type Rep RenderUiTemplate = D1 ('MetaData "RenderUiTemplate" "Amazonka.SageMaker.RenderUiTemplate" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "RenderUiTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "humanTaskUiArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uiTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UiTemplate))) :*: (S1 ('MetaSel ('Just "task") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RenderableTask) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newRenderUiTemplate

Arguments

:: RenderableTask

RenderUiTemplate

-> Text

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:

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:uiTemplate:RenderUiTemplate', renderUiTemplate_uiTemplate - A Template object containing the worker UI template to render.

RenderUiTemplate, renderUiTemplate_task - A RenderableTask object containing a representative task to render.

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

Request Lenses

renderUiTemplate_humanTaskUiArn :: Lens' RenderUiTemplate (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.

renderUiTemplate_uiTemplate :: Lens' RenderUiTemplate (Maybe UiTemplate)

A Template object containing the worker UI template to render.

renderUiTemplate_task :: Lens' RenderUiTemplate RenderableTask

A RenderableTask object containing a representative task to render.

renderUiTemplate_roleArn :: Lens' RenderUiTemplate Text

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

Destructuring the Response

data RenderUiTemplateResponse

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

Generic RenderUiTemplateResponse

Defined in Amazonka.SageMaker.RenderUiTemplate

Associated Types

type Rep RenderUiTemplateResponse :: Type -> Type

Methods

from :: RenderUiTemplateResponse -> Rep RenderUiTemplateResponse x

to :: Rep RenderUiTemplateResponse x -> RenderUiTemplateResponse

Read RenderUiTemplateResponse

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

readsPrec :: Int -> ReadS RenderUiTemplateResponse

readList :: ReadS [RenderUiTemplateResponse]

readPrec :: ReadPrec RenderUiTemplateResponse

readListPrec :: ReadPrec [RenderUiTemplateResponse]

Show RenderUiTemplateResponse

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

showsPrec :: Int -> RenderUiTemplateResponse -> ShowS

show :: RenderUiTemplateResponse -> String

showList :: [RenderUiTemplateResponse] -> ShowS

NFData RenderUiTemplateResponse

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

rnf :: RenderUiTemplateResponse -> ()

Eq RenderUiTemplateResponse

Defined in Amazonka.SageMaker.RenderUiTemplate

Methods

(==) :: RenderUiTemplateResponse -> RenderUiTemplateResponse -> Bool

(/=) :: RenderUiTemplateResponse -> RenderUiTemplateResponse -> Bool

type Rep RenderUiTemplateResponse

Defined in Amazonka.SageMaker.RenderUiTemplate

type Rep RenderUiTemplateResponse = D1 ('MetaData "RenderUiTemplateResponse" "Amazonka.SageMaker.RenderUiTemplate" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" '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

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

The response's http status code.

renderUiTemplateResponse_renderedContent :: Lens' RenderUiTemplateResponse Text

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

renderUiTemplateResponse_errors :: Lens' RenderUiTemplateResponse [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.