create_detector_model
¶
create_detector_model(
detector_model_name: DetectorModelName,
detector_model_definition: DetectorModelDefinition,
role_arn: AmazonResourceName,
*,
config_overrides: Optional[IoTEventsClientConfig] = None,
detector_model_description: Optional[DetectorModelDescription] = None,
key: Optional[AttributeJsonPath] = None,
tags: Optional[Tags] = None,
evaluation_method: Optional[EvaluationMethod] = None,
) -> CreateDetectorModelResponse
Creates a detector model.
Parameters:
-
detector_model_name(DetectorModelName) –The name of the detector model.
-
detector_model_definition(DetectorModelDefinition) –Information that defines how the detectors operate.
-
detector_model_description(Optional[DetectorModelDescription], default:None) –A brief description of the detector model.
-
key(Optional[AttributeJsonPath], default:None) –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.
-
role_arn(AmazonResourceName) –The ARN of the role that grants permission to AWS IoT Events to perform its operations.
-
tags(Optional[Tags], default:None) –Metadata that can be used to manage the detector model.
-
evaluation_method(Optional[EvaluationMethod], default:None) –Information about the order in which events are evaluated and how actions are executed.
Raises:
-
InternalFailureException–An internal failure occurred.
-
InvalidRequestException–The request was invalid.
-
LimitExceededException–A limit was exceeded.
-
ResourceAlreadyExistsException–The resource already exists.
-
ResourceInUseException–The resource is in use.
-
ServiceUnavailableException–The service is currently unavailable.
-
ThrottlingException–The request could not be completed due to throttling.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_iot_events/_services/io_t_events.py
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 | |