IoTEvents class

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.

Constructors

IoTEvents({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createDetectorModel({required DetectorModelDefinition detectorModelDefinition, required String detectorModelName, required String roleArn, String? detectorModelDescription, EvaluationMethod? evaluationMethod, String? key, List<Tag>? tags}) → Future<CreateDetectorModelResponse>
Creates a detector model.
createInput({required InputDefinition inputDefinition, required String inputName, String? inputDescription, List<Tag>? tags}) → Future<CreateInputResponse>
Creates an input.
deleteDetectorModel({required String detectorModelName}) → Future<void>
Deletes a detector model. Any active instances of the detector model are also deleted.
deleteInput({required String inputName}) → Future<void>
Deletes an input.
describeDetectorModel({required String detectorModelName, String? detectorModelVersion}) → Future<DescribeDetectorModelResponse>
Describes a detector model. If the version parameter is not specified, information about the latest version is returned.
describeInput({required String inputName}) → Future<DescribeInputResponse>
Describes an input.
describeLoggingOptions() → Future<DescribeLoggingOptionsResponse>
Retrieves the current settings of the AWS IoT Events logging options.
listDetectorModels({int? maxResults, String? nextToken}) → Future<ListDetectorModelsResponse>
Lists the detector models you have created. Only the metadata associated with each detector model is returned.
listDetectorModelVersions({required String detectorModelName, int? maxResults, String? nextToken}) → Future<ListDetectorModelVersionsResponse>
Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
listInputs({int? maxResults, String? nextToken}) → Future<ListInputsResponse>
Lists the inputs you have created.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists the tags (metadata) you have assigned to the resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putLoggingOptions({required LoggingOptions loggingOptions}) → Future<void>
Sets or updates the AWS IoT Events logging options.
tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes the given tags (metadata) from the resource.
updateDetectorModel({required DetectorModelDefinition detectorModelDefinition, required String detectorModelName, required String roleArn, String? detectorModelDescription, EvaluationMethod? evaluationMethod}) → Future<UpdateDetectorModelResponse>
Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
updateInput({required InputDefinition inputDefinition, required String inputName, String? inputDescription}) → Future<UpdateInputResponse>
Updates an input.

Operators

operator ==(Object other) → bool
The equality operator.
inherited