- 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.
DeleteDeviceCommand
Deletes a device.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PanoramaClient, DeleteDeviceCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, DeleteDeviceCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // DeleteDeviceRequest
DeviceId: "STRING_VALUE", // required
};
const command = new DeleteDeviceCommand(input);
const response = await client.send(command);
// { // DeleteDeviceResponse
// DeviceId: "STRING_VALUE",
// };
DeleteDeviceCommand Input
See DeleteDeviceCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
DeviceIdRequired | string | undefined | The device's ID. |
DeleteDeviceCommand Output
See DeleteDeviceCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
DeviceId | string | undefined | The device's ID. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | The requestor does not have permission to access the target action or resource. |
| ConflictException | client | The target resource is in use. |
| InternalServerException | server | An internal error occurred. |
| ResourceNotFoundException | client | The target resource was not found. |
| ValidationException | client | The request contains an invalid parameter value. |
| PanoramaServiceException | Base exception class for all service exceptions from Panorama service. |