libZSservicesZSamazonka-ioteventsZSamazonka-iotevents
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTEvents.CreateDetectorModel

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.

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

  • evaluationMethod :: Maybe EvaluationMethod

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

  • 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
Eq CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

Read CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

Show CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

Generic CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

Associated Types

type Rep CreateDetectorModel :: Type -> Type #

NFData CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

Methods

rnf :: CreateDetectorModel -> () #

Hashable CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

ToJSON CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

AWSRequest CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

Associated Types

type AWSResponse CreateDetectorModel #

ToHeaders CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

ToPath CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

ToQuery CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

type Rep CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

type Rep CreateDetectorModel = D1 ('MetaData "CreateDetectorModel" "Amazonka.IoTEvents.CreateDetectorModel" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" 'False) (C1 ('MetaCons "CreateDetectorModel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "detectorModelDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "evaluationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationMethod)))) :*: ((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)))))
type AWSResponse CreateDetectorModel Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

newCreateDetectorModel Source #

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:

$sel:detectorModelDescription:CreateDetectorModel', createDetectorModel_detectorModelDescription - A brief description of the detector model.

$sel:key: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:evaluationMethod:CreateDetectorModel', createDetectorModel_evaluationMethod - Information about the order in which events are evaluated and how actions are executed.

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

$sel:detectorModelName:CreateDetectorModel', createDetectorModel_detectorModelName - The name of the detector model.

$sel:detectorModelDefinition:CreateDetectorModel', createDetectorModel_detectorModelDefinition - Information that defines how the detectors operate.

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

Request Lenses

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_evaluationMethod :: Lens' CreateDetectorModel (Maybe EvaluationMethod) Source #

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

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

Metadata that can be used to manage the detector model.

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

Instances

Instances details
Eq CreateDetectorModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

Read CreateDetectorModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

Show CreateDetectorModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

Generic CreateDetectorModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

Associated Types

type Rep CreateDetectorModelResponse :: Type -> Type #

NFData CreateDetectorModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

type Rep CreateDetectorModelResponse Source # 
Instance details

Defined in Amazonka.IoTEvents.CreateDetectorModel

type Rep CreateDetectorModelResponse = D1 ('MetaData "CreateDetectorModelResponse" "Amazonka.IoTEvents.CreateDetectorModel" "libZSservicesZSamazonka-ioteventsZSamazonka-iotevents" '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 #

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:

$sel:detectorModelConfiguration:CreateDetectorModelResponse', createDetectorModelResponse_detectorModelConfiguration - Information about how the detector model is configured.

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

Response Lenses