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.IoT.Types.DocumentParameter

Description

Documentation

data DocumentParameter Source #

A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

See: newDocumentParameter smart constructor.

Constructors

DocumentParameter'

Fields

description :: Maybe Text
Description of the map field containing the patterns that need to be replaced in a managed template job document schema.
example :: Maybe Text
An example illustrating a pattern that need to be replaced in a managed template job document schema.
key :: Maybe Text
Key of the map field containing the patterns that need to be replaced in a managed template job document schema.
optional :: Maybe Bool
Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.
regex :: Maybe Text
A regular expression of the patterns that need to be replaced in a managed template job document schema.

Instances

Instances details

FromJSON DocumentParameter Source #
Instance details Defined in Amazonka.IoT.Types.DocumentParameter Methods parseJSON :: Value -> Parser DocumentParameter # parseJSONList :: Value -> Parser [DocumentParameter] #
Generic DocumentParameter Source #
Instance details Defined in Amazonka.IoT.Types.DocumentParameter Associated Types type Rep DocumentParameter :: Type -> Type # Methods from :: DocumentParameter -> Rep DocumentParameter x # to :: Rep DocumentParameter x -> DocumentParameter #
Read DocumentParameter Source #
Instance details Defined in Amazonka.IoT.Types.DocumentParameter Methods readsPrec :: Int -> ReadS DocumentParameter # readList :: ReadS [DocumentParameter] # readPrec :: ReadPrec DocumentParameter # readListPrec :: ReadPrec [DocumentParameter] #
Show DocumentParameter Source #
Instance details Defined in Amazonka.IoT.Types.DocumentParameter Methods showsPrec :: Int -> DocumentParameter -> ShowS # show :: DocumentParameter -> String # showList :: [DocumentParameter] -> ShowS #
NFData DocumentParameter Source #
Instance details Defined in Amazonka.IoT.Types.DocumentParameter Methods rnf :: DocumentParameter -> () #
Eq DocumentParameter Source #
Instance details Defined in Amazonka.IoT.Types.DocumentParameter Methods (==) :: DocumentParameter -> DocumentParameter -> Bool # (/=) :: DocumentParameter -> DocumentParameter -> Bool #
Hashable DocumentParameter Source #
Instance details Defined in Amazonka.IoT.Types.DocumentParameter Methods hashWithSalt :: Int -> DocumentParameter -> Int # hash :: DocumentParameter -> Int #
type Rep DocumentParameter Source #
Instance details Defined in Amazonka.IoT.Types.DocumentParameter type Rep DocumentParameter = D1 ('MetaData "DocumentParameter" "Amazonka.IoT.Types.DocumentParameter" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DocumentParameter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "example") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "optional") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "regex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDocumentParameter :: DocumentParameter Source #

Create a value of DocumentParameter 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:description:DocumentParameter', documentParameter_description - Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

$sel:example:DocumentParameter', documentParameter_example - An example illustrating a pattern that need to be replaced in a managed template job document schema.

$sel:key:DocumentParameter', documentParameter_key - Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

$sel:optional:DocumentParameter', documentParameter_optional - Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

$sel:regex:DocumentParameter', documentParameter_regex - A regular expression of the patterns that need to be replaced in a managed template job document schema.

documentParameter_description :: Lens' DocumentParameter (Maybe Text) Source #

Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

documentParameter_example :: Lens' DocumentParameter (Maybe Text) Source #

An example illustrating a pattern that need to be replaced in a managed template job document schema.

documentParameter_key :: Lens' DocumentParameter (Maybe Text) Source #

Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

documentParameter_optional :: Lens' DocumentParameter (Maybe Bool) Source #

Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

documentParameter_regex :: Lens' DocumentParameter (Maybe Text) Source #

A regular expression of the patterns that need to be replaced in a managed template job document schema.