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.CloudWatchEvents.Types.HttpParameters

Description

Synopsis

Documentation

data HttpParameters Source #

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

See: newHttpParameters smart constructor.

Constructors

HttpParameters'

Fields

headerParameters :: Maybe (HashMap Text Text)
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
pathParameterValues :: Maybe [Text]
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
queryStringParameters :: Maybe (HashMap Text Text)
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

Instances

Instances details

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

newHttpParameters :: HttpParameters Source #

Create a value of HttpParameters 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:headerParameters:HttpParameters', httpParameters_headerParameters - The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

$sel:pathParameterValues:HttpParameters', httpParameters_pathParameterValues - The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").

$sel:queryStringParameters:HttpParameters', httpParameters_queryStringParameters - The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

httpParameters_headerParameters :: Lens' HttpParameters (Maybe (HashMap Text Text)) Source #

The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

httpParameters_pathParameterValues :: Lens' HttpParameters (Maybe [Text]) Source #

The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").

httpParameters_queryStringParameters :: Lens' HttpParameters (Maybe (HashMap Text Text)) Source #

The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.