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.IoTEvents.CreateDetectorModel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a detector model.

Synopsis

Creating a Request

data CreateDetectorModel Source #

See: newCreateDetectorModel smart constructor.

Constructors

CreateDetectorModel'

Fields

detectorModelDescription :: Maybe Text
A brief description of the detector model.
evaluationMethod :: Maybe EvaluationMethod
Information about the order in which events are evaluated and how actions are executed.
key :: Maybe Text
The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.
tags :: Maybe [Tag]
Metadata that can be used to manage the detector model.
detectorModelName :: Text
The name of the detector model.
detectorModelDefinition :: DetectorModelDefinition
Information that defines how the detectors operate.
roleArn :: Text
The ARN of the role that grants permission to AWS IoT Events to perform its operations.

Instances

Instances details

ToJSON CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods toJSON :: CreateDetectorModel -> Value # toEncoding :: CreateDetectorModel -> Encoding # toJSONList :: [CreateDetectorModel] -> Value # toEncodingList :: [CreateDetectorModel] -> Encoding #
ToHeaders CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods toHeaders :: CreateDetectorModel -> [Header] #
ToPath CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods toPath :: CreateDetectorModel -> ByteString #
ToQuery CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods toQuery :: CreateDetectorModel -> QueryString #
AWSRequest CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Associated Types type AWSResponse CreateDetectorModel # Methods request :: (Service -> Service) -> CreateDetectorModel -> Request CreateDetectorModel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDetectorModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDetectorModel))) #
Generic CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Associated Types type Rep CreateDetectorModel :: Type -> Type # Methods from :: CreateDetectorModel -> Rep CreateDetectorModel x # to :: Rep CreateDetectorModel x -> CreateDetectorModel #
Read CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods readsPrec :: Int -> ReadS CreateDetectorModel # readList :: ReadS [CreateDetectorModel] # readPrec :: ReadPrec CreateDetectorModel # readListPrec :: ReadPrec [CreateDetectorModel] #
Show CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods showsPrec :: Int -> CreateDetectorModel -> ShowS # show :: CreateDetectorModel -> String # showList :: [CreateDetectorModel] -> ShowS #
NFData CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods rnf :: CreateDetectorModel -> () #
Eq CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods (==) :: CreateDetectorModel -> CreateDetectorModel -> Bool # (/=) :: CreateDetectorModel -> CreateDetectorModel -> Bool #
Hashable CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods hashWithSalt :: Int -> CreateDetectorModel -> Int # hash :: CreateDetectorModel -> Int #
type AWSResponse CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel type AWSResponse CreateDetectorModel = CreateDetectorModelResponse
type Rep CreateDetectorModel Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel type Rep CreateDetectorModel = D1 ('MetaData "CreateDetectorModel" "Amazonka.IoTEvents.CreateDetectorModel" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "CreateDetectorModel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "detectorModelDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "evaluationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationMethod)) :: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "detectorModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "detectorModelDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DetectorModelDefinition) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateDetectorModel Source #

Arguments

:: Text	`CreateDetectorModel`
-> DetectorModelDefinition	`CreateDetectorModel`
-> Text	`CreateDetectorModel`
-> CreateDetectorModel

Create a value of CreateDetectorModel 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:

CreateDetectorModel, createDetectorModel_detectorModelDescription - A brief description of the detector model.

CreateDetectorModel, createDetectorModel_evaluationMethod - Information about the order in which events are evaluated and how actions are executed.

CreateDetectorModel, createDetectorModel_key - The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.

$sel:tags:CreateDetectorModel', createDetectorModel_tags - Metadata that can be used to manage the detector model.

CreateDetectorModel, createDetectorModel_detectorModelName - The name of the detector model.

CreateDetectorModel, createDetectorModel_detectorModelDefinition - Information that defines how the detectors operate.

CreateDetectorModel, createDetectorModel_roleArn - The ARN of the role that grants permission to AWS IoT Events to perform its operations.

Request Lenses

createDetectorModel_detectorModelDescription :: Lens' CreateDetectorModel (Maybe Text) Source #

A brief description of the detector model.

createDetectorModel_evaluationMethod :: Lens' CreateDetectorModel (Maybe EvaluationMethod) Source #

Information about the order in which events are evaluated and how actions are executed.

createDetectorModel_key :: Lens' CreateDetectorModel (Maybe Text) Source #

The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.

createDetectorModel_tags :: Lens' CreateDetectorModel (Maybe [Tag]) Source #

Metadata that can be used to manage the detector model.

createDetectorModel_detectorModelName :: Lens' CreateDetectorModel Text Source #

The name of the detector model.

createDetectorModel_detectorModelDefinition :: Lens' CreateDetectorModel DetectorModelDefinition Source #

Information that defines how the detectors operate.

createDetectorModel_roleArn :: Lens' CreateDetectorModel Text Source #

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

Destructuring the Response

data CreateDetectorModelResponse Source #

See: newCreateDetectorModelResponse smart constructor.

Constructors

CreateDetectorModelResponse'
Fields detectorModelConfiguration :: Maybe DetectorModelConfiguration Information about how the detector model is configured. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDetectorModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Associated Types type Rep CreateDetectorModelResponse :: Type -> Type # Methods from :: CreateDetectorModelResponse -> Rep CreateDetectorModelResponse x # to :: Rep CreateDetectorModelResponse x -> CreateDetectorModelResponse #
Read CreateDetectorModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods readsPrec :: Int -> ReadS CreateDetectorModelResponse # readList :: ReadS [CreateDetectorModelResponse] # readPrec :: ReadPrec CreateDetectorModelResponse # readListPrec :: ReadPrec [CreateDetectorModelResponse] #
Show CreateDetectorModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods showsPrec :: Int -> CreateDetectorModelResponse -> ShowS # show :: CreateDetectorModelResponse -> String # showList :: [CreateDetectorModelResponse] -> ShowS #
NFData CreateDetectorModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods rnf :: CreateDetectorModelResponse -> () #
Eq CreateDetectorModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel Methods (==) :: CreateDetectorModelResponse -> CreateDetectorModelResponse -> Bool # (/=) :: CreateDetectorModelResponse -> CreateDetectorModelResponse -> Bool #
type Rep CreateDetectorModelResponse Source #
Instance details Defined in Amazonka.IoTEvents.CreateDetectorModel type Rep CreateDetectorModelResponse = D1 ('MetaData "CreateDetectorModelResponse" "Amazonka.IoTEvents.CreateDetectorModel" "amazonka-iotevents-2.0-6xKaLx5KciSK3LEs0FyRYn" 'False) (C1 ('MetaCons "CreateDetectorModelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "detectorModelConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DetectorModelConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDetectorModelResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDetectorModelResponse'`
-> CreateDetectorModelResponse

Create a value of CreateDetectorModelResponse 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:

CreateDetectorModelResponse, createDetectorModelResponse_detectorModelConfiguration - Information about how the detector model is configured.

$sel:httpStatus:CreateDetectorModelResponse', createDetectorModelResponse_httpStatus - The response's http status code.

Response Lenses

createDetectorModelResponse_detectorModelConfiguration :: Lens' CreateDetectorModelResponse (Maybe DetectorModelConfiguration) Source #

Information about how the detector model is configured.

createDetectorModelResponse_httpStatus :: Lens' CreateDetectorModelResponse Int Source #

The response's http status code.