amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.Types.HttpAction

Description

 
Synopsis

Documentation

data HttpAction Source #

Send data to an HTTPS endpoint.

See: newHttpAction smart constructor.

Constructors

HttpAction' 

Fields

  • auth :: Maybe HttpAuthorization

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

  • 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.

  • 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
FromJSON HttpAction Source # 
Instance details

Defined in Amazonka.IoT.Types.HttpAction

ToJSON HttpAction Source # 
Instance details

Defined in Amazonka.IoT.Types.HttpAction

Generic HttpAction Source # 
Instance details

Defined in Amazonka.IoT.Types.HttpAction

Associated Types

type Rep HttpAction :: Type -> Type #

Read HttpAction Source # 
Instance details

Defined in Amazonka.IoT.Types.HttpAction

Show HttpAction Source # 
Instance details

Defined in Amazonka.IoT.Types.HttpAction

NFData HttpAction Source # 
Instance details

Defined in Amazonka.IoT.Types.HttpAction

Methods

rnf :: HttpAction -> () #

Eq HttpAction Source # 
Instance details

Defined in Amazonka.IoT.Types.HttpAction

Hashable HttpAction Source # 
Instance details

Defined in Amazonka.IoT.Types.HttpAction

type Rep HttpAction Source # 
Instance details

Defined in Amazonka.IoT.Types.HttpAction

type Rep HttpAction = D1 ('MetaData "HttpAction" "Amazonka.IoT.Types.HttpAction" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "HttpAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "auth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpAuthorization)) :*: S1 ('MetaSel ('Just "confirmationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HttpActionHeader])) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newHttpAction Source #

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:auth:HttpAction', httpAction_auth - The authentication method to use when sending data to an HTTPS endpoint.

$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: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_auth :: Lens' HttpAction (Maybe HttpAuthorization) Source #

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

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_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.