- 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.
DeleteThingCommand
Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
Requires permission to access the DeleteThing action.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTClient, DeleteThingCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, DeleteThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // DeleteThingRequest
thingName: "STRING_VALUE", // required
expectedVersion: Number("long"),
};
const command = new DeleteThingCommand(input);
const response = await client.send(command);
// {};
DeleteThingCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
thingNameRequired | string | undefined | The name of the thing to delete. |
expectedVersion | number | undefined | The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the |
DeleteThingCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalFailureException | server | An unexpected error has occurred. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource does not exist. |
| ServiceUnavailableException | server | The service is temporarily unavailable. |
| ThrottlingException | client | The rate exceeds the limit. |
| UnauthorizedException | client | You are not authorized to perform this operation. |
| VersionConflictException | client | An exception thrown when the version of an entity specified with the |
| IoTServiceException | Base exception class for all service exceptions from IoT service. |