Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Wisdom.Types.RenderingConfiguration

Description

Synopsis

data RenderingConfiguration = RenderingConfiguration' {
- templateUri :: Maybe Text
}
newRenderingConfiguration :: RenderingConfiguration
renderingConfiguration_templateUri :: Lens' RenderingConfiguration (Maybe Text)

Documentation

data RenderingConfiguration Source #

Information about how to render the content.

See: newRenderingConfiguration smart constructor.

Constructors

RenderingConfiguration'

Fields

templateUri :: Maybe Text
A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:
- Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted
- ServiceNow: number, short_description, sys_mod_count, workflow_state, or active
```
 <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
```

Instances

Instances details

FromJSON RenderingConfiguration Source #
Instance details Defined in Amazonka.Wisdom.Types.RenderingConfiguration Methods parseJSON :: Value -> Parser RenderingConfiguration # parseJSONList :: Value -> Parser [RenderingConfiguration] #
ToJSON RenderingConfiguration Source #
Instance details Defined in Amazonka.Wisdom.Types.RenderingConfiguration Methods toJSON :: RenderingConfiguration -> Value # toEncoding :: RenderingConfiguration -> Encoding # toJSONList :: [RenderingConfiguration] -> Value # toEncodingList :: [RenderingConfiguration] -> Encoding #
Generic RenderingConfiguration Source #
Instance details Defined in Amazonka.Wisdom.Types.RenderingConfiguration Associated Types type Rep RenderingConfiguration :: Type -> Type # Methods from :: RenderingConfiguration -> Rep RenderingConfiguration x # to :: Rep RenderingConfiguration x -> RenderingConfiguration #
Read RenderingConfiguration Source #
Instance details Defined in Amazonka.Wisdom.Types.RenderingConfiguration Methods readsPrec :: Int -> ReadS RenderingConfiguration # readList :: ReadS [RenderingConfiguration] # readPrec :: ReadPrec RenderingConfiguration # readListPrec :: ReadPrec [RenderingConfiguration] #
Show RenderingConfiguration Source #
Instance details Defined in Amazonka.Wisdom.Types.RenderingConfiguration Methods showsPrec :: Int -> RenderingConfiguration -> ShowS # show :: RenderingConfiguration -> String # showList :: [RenderingConfiguration] -> ShowS #
NFData RenderingConfiguration Source #
Instance details Defined in Amazonka.Wisdom.Types.RenderingConfiguration Methods rnf :: RenderingConfiguration -> () #
Eq RenderingConfiguration Source #
Instance details Defined in Amazonka.Wisdom.Types.RenderingConfiguration Methods (==) :: RenderingConfiguration -> RenderingConfiguration -> Bool # (/=) :: RenderingConfiguration -> RenderingConfiguration -> Bool #
Hashable RenderingConfiguration Source #
Instance details Defined in Amazonka.Wisdom.Types.RenderingConfiguration Methods hashWithSalt :: Int -> RenderingConfiguration -> Int # hash :: RenderingConfiguration -> Int #
type Rep RenderingConfiguration Source #
Instance details Defined in Amazonka.Wisdom.Types.RenderingConfiguration type Rep RenderingConfiguration = D1 ('MetaData "RenderingConfiguration" "Amazonka.Wisdom.Types.RenderingConfiguration" "amazonka-wisdom-2.0-D8ZGZ1sJNnDDHDNbH2yubp" 'False) (C1 ('MetaCons "RenderingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "templateUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newRenderingConfiguration :: RenderingConfiguration Source #

Create a value of RenderingConfiguration 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:templateUri:RenderingConfiguration', renderingConfiguration_templateUri - A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:

Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted
ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

 <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </p>

renderingConfiguration_templateUri :: Lens' RenderingConfiguration (Maybe Text) Source #

A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:

Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted
ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

 <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </p>