iotevents/aws.sdk.kotlin.services.iotevents

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createAlarmModel

inline suspend fun IotEventsClient.createAlarmModel(crossinline block: CreateAlarmModelRequest.Builder.() -> Unit): CreateAlarmModelResponse

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.

createDetectorModel

inline suspend fun IotEventsClient.createDetectorModel(crossinline block: CreateDetectorModelRequest.Builder.() -> Unit): CreateDetectorModelResponse

Creates a detector model.

createInput

inline suspend fun IotEventsClient.createInput(crossinline block: CreateInputRequest.Builder.() -> Unit): CreateInputResponse

Creates an input.

deleteAlarmModel

inline suspend fun IotEventsClient.deleteAlarmModel(crossinline block: DeleteAlarmModelRequest.Builder.() -> Unit): DeleteAlarmModelResponse

Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.

deleteDetectorModel

inline suspend fun IotEventsClient.deleteDetectorModel(crossinline block: DeleteDetectorModelRequest.Builder.() -> Unit): DeleteDetectorModelResponse

Deletes a detector model. Any active instances of the detector model are also deleted.

deleteInput

inline suspend fun IotEventsClient.deleteInput(crossinline block: DeleteInputRequest.Builder.() -> Unit): DeleteInputResponse

Deletes an input.

describeAlarmModel

inline suspend fun IotEventsClient.describeAlarmModel(crossinline block: DescribeAlarmModelRequest.Builder.() -> Unit): DescribeAlarmModelResponse

Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.

describeDetectorModel

inline suspend fun IotEventsClient.describeDetectorModel(crossinline block: DescribeDetectorModelRequest.Builder.() -> Unit): DescribeDetectorModelResponse

Describes a detector model. If the version parameter is not specified, information about the latest version is returned.

describeDetectorModelAnalysis

inline suspend fun IotEventsClient.describeDetectorModelAnalysis(crossinline block: DescribeDetectorModelAnalysisRequest.Builder.() -> Unit): DescribeDetectorModelAnalysisResponse

Retrieves runtime information about a detector model analysis.

describeInput

inline suspend fun IotEventsClient.describeInput(crossinline block: DescribeInputRequest.Builder.() -> Unit): DescribeInputResponse

Describes an input.

describeLoggingOptions

inline suspend fun IotEventsClient.describeLoggingOptions(crossinline block: DescribeLoggingOptionsRequest.Builder.() -> Unit): DescribeLoggingOptionsResponse

Retrieves the current settings of the AWS IoT Events logging options.

getDetectorModelAnalysisResults

inline suspend fun IotEventsClient.getDetectorModelAnalysisResults(crossinline block: GetDetectorModelAnalysisResultsRequest.Builder.() -> Unit): GetDetectorModelAnalysisResultsResponse

Retrieves one or more analysis results of the detector model.

listAlarmModels

inline suspend fun IotEventsClient.listAlarmModels(crossinline block: ListAlarmModelsRequest.Builder.() -> Unit): ListAlarmModelsResponse

Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.

listAlarmModelVersions

inline suspend fun IotEventsClient.listAlarmModelVersions(crossinline block: ListAlarmModelVersionsRequest.Builder.() -> Unit): ListAlarmModelVersionsResponse

Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.

listDetectorModels

inline suspend fun IotEventsClient.listDetectorModels(crossinline block: ListDetectorModelsRequest.Builder.() -> Unit): ListDetectorModelsResponse

Lists the detector models you have created. Only the metadata associated with each detector model is returned.

listDetectorModelVersions

inline suspend fun IotEventsClient.listDetectorModelVersions(crossinline block: ListDetectorModelVersionsRequest.Builder.() -> Unit): ListDetectorModelVersionsResponse

Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.

listInputRoutings

inline suspend fun IotEventsClient.listInputRoutings(crossinline block: ListInputRoutingsRequest.Builder.() -> Unit): ListInputRoutingsResponse

Lists one or more input routings.

listInputs

inline suspend fun IotEventsClient.listInputs(crossinline block: ListInputsRequest.Builder.() -> Unit): ListInputsResponse

Lists the inputs you have created.

listTagsForResource

inline suspend fun IotEventsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags (metadata) you have assigned to the resource.

putLoggingOptions

inline suspend fun IotEventsClient.putLoggingOptions(crossinline block: PutLoggingOptionsRequest.Builder.() -> Unit): PutLoggingOptionsResponse

Sets or updates the AWS IoT Events logging options.

startDetectorModelAnalysis

inline suspend fun IotEventsClient.startDetectorModelAnalysis(crossinline block: StartDetectorModelAnalysisRequest.Builder.() -> Unit): StartDetectorModelAnalysisResponse

Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.

tagResource

inline suspend fun IotEventsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

untagResource

inline suspend fun IotEventsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the given tags (metadata) from the resource.

updateAlarmModel

inline suspend fun IotEventsClient.updateAlarmModel(crossinline block: UpdateAlarmModelRequest.Builder.() -> Unit): UpdateAlarmModelResponse

Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.

updateDetectorModel

inline suspend fun IotEventsClient.updateDetectorModel(crossinline block: UpdateDetectorModelRequest.Builder.() -> Unit): UpdateDetectorModelResponse

Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.

updateInput

inline suspend fun IotEventsClient.updateInput(crossinline block: UpdateInputRequest.Builder.() -> Unit): UpdateInputResponse

Updates an input.

withConfig

fun IotEventsClient.withConfig(block: IotEventsClient.Config.Builder.() -> Unit): IotEventsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.