Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.Types.HttpAction

Description

Synopsis

data HttpAction = HttpAction' {
- confirmationUrl :: Maybe Text
- auth :: Maybe HttpAuthorization
- headers :: Maybe [HttpActionHeader]
- url :: Text
}
newHttpAction :: Text -> HttpAction
httpAction_confirmationUrl :: Lens' HttpAction (Maybe Text)
httpAction_auth :: Lens' HttpAction (Maybe HttpAuthorization)
httpAction_headers :: Lens' HttpAction (Maybe [HttpActionHeader])
httpAction_url :: Lens' HttpAction Text

Documentation

data HttpAction Source #

Send data to an HTTPS endpoint.

See: newHttpAction smart constructor.

Constructors

HttpAction'

Fields

confirmationUrl :: Maybe Text
The URL to which IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
auth :: Maybe HttpAuthorization
The authentication method to use when sending data to an HTTPS endpoint.
headers :: Maybe [HttpActionHeader]
The HTTP headers to send with the message data.
url :: Text
The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.

Instances

Instances details

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

newHttpAction Source #

Arguments

:: Text	`$sel:url:HttpAction'`
-> HttpAction

Create a value of HttpAction 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:confirmationUrl:HttpAction', httpAction_confirmationUrl - The URL to which IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

$sel:auth:HttpAction', httpAction_auth - The authentication method to use when sending data to an HTTPS endpoint.

$sel:headers:HttpAction', httpAction_headers - The HTTP headers to send with the message data.

$sel:url:HttpAction', httpAction_url - The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.

httpAction_confirmationUrl :: Lens' HttpAction (Maybe Text) Source #

The URL to which IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

httpAction_auth :: Lens' HttpAction (Maybe HttpAuthorization) Source #

The authentication method to use when sending data to an HTTPS endpoint.

httpAction_headers :: Lens' HttpAction (Maybe [HttpActionHeader]) Source #

The HTTP headers to send with the message data.

httpAction_url :: Lens' HttpAction Text Source #

The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.