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.Pipes.Types.PipeEnrichmentParameters

Description

Documentation

data PipeEnrichmentParameters Source #

The parameters required to set up enrichment on your pipe.

See: newPipeEnrichmentParameters smart constructor.

Constructors

PipeEnrichmentParameters'

Fields

httpParameters :: Maybe PipeEnrichmentHttpParameters
Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
inputTemplate :: Maybe (Sensitive Text)
Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

Instances

Instances details

FromJSON PipeEnrichmentParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeEnrichmentParameters Methods parseJSON :: Value -> Parser PipeEnrichmentParameters # parseJSONList :: Value -> Parser [PipeEnrichmentParameters] #
ToJSON PipeEnrichmentParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeEnrichmentParameters Methods toJSON :: PipeEnrichmentParameters -> Value # toEncoding :: PipeEnrichmentParameters -> Encoding # toJSONList :: [PipeEnrichmentParameters] -> Value # toEncodingList :: [PipeEnrichmentParameters] -> Encoding #
Generic PipeEnrichmentParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeEnrichmentParameters Associated Types type Rep PipeEnrichmentParameters :: Type -> Type # Methods from :: PipeEnrichmentParameters -> Rep PipeEnrichmentParameters x # to :: Rep PipeEnrichmentParameters x -> PipeEnrichmentParameters #
Show PipeEnrichmentParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeEnrichmentParameters Methods showsPrec :: Int -> PipeEnrichmentParameters -> ShowS # show :: PipeEnrichmentParameters -> String # showList :: [PipeEnrichmentParameters] -> ShowS #
NFData PipeEnrichmentParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeEnrichmentParameters Methods rnf :: PipeEnrichmentParameters -> () #
Eq PipeEnrichmentParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeEnrichmentParameters Methods (==) :: PipeEnrichmentParameters -> PipeEnrichmentParameters -> Bool # (/=) :: PipeEnrichmentParameters -> PipeEnrichmentParameters -> Bool #
Hashable PipeEnrichmentParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeEnrichmentParameters Methods hashWithSalt :: Int -> PipeEnrichmentParameters -> Int # hash :: PipeEnrichmentParameters -> Int #
type Rep PipeEnrichmentParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeEnrichmentParameters type Rep PipeEnrichmentParameters = D1 ('MetaData "PipeEnrichmentParameters" "Amazonka.Pipes.Types.PipeEnrichmentParameters" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "PipeEnrichmentParameters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipeEnrichmentHttpParameters)) :*: S1 ('MetaSel ('Just "inputTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))

newPipeEnrichmentParameters :: PipeEnrichmentParameters Source #

Create a value of PipeEnrichmentParameters 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:httpParameters:PipeEnrichmentParameters', pipeEnrichmentParameters_httpParameters - Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

$sel:inputTemplate:PipeEnrichmentParameters', pipeEnrichmentParameters_inputTemplate - Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

pipeEnrichmentParameters_httpParameters :: Lens' PipeEnrichmentParameters (Maybe PipeEnrichmentHttpParameters) Source #

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

pipeEnrichmentParameters_inputTemplate :: Lens' PipeEnrichmentParameters (Maybe Text) Source #

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.