- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteDetectorModelCommand
Deletes a detector model. Any active instances of the detector model are also deleted.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTEventsClient, DeleteDetectorModelCommand } from "@aws-sdk/client-iot-events"; // ES Modules import
// const { IoTEventsClient, DeleteDetectorModelCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import
const client = new IoTEventsClient(config);
const input = { // DeleteDetectorModelRequest
detectorModelName: "STRING_VALUE", // required
};
const command = new DeleteDetectorModelCommand(input);
const response = await client.send(command);
// {};
DeleteDetectorModelCommand Input
See DeleteDetectorModelCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
detectorModelNameRequired | string | undefined | The name of the detector model to be deleted. |
DeleteDetectorModelCommand Output
See DeleteDetectorModelCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalFailureException | server | An internal failure occurred. |
| InvalidRequestException | client | The request was invalid. |
| ResourceInUseException | client | The resource is in use. |
| ResourceNotFoundException | client | The resource was not found. |
| ServiceUnavailableException | server | The service is currently unavailable. |
| ThrottlingException | client | The request could not be completed due to throttling. |
| IoTEventsServiceException | Base exception class for all service exceptions from IoTEvents service. |