DeleteGatewayCommand

Suggest an Edit

Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTSiteWiseClient, DeleteGatewayCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
// const { IoTSiteWiseClient, DeleteGatewayCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
const client = new IoTSiteWiseClient(config);
const input = { // DeleteGatewayRequest
  gatewayId: "STRING_VALUE", // required
};
const command = new DeleteGatewayCommand(input);
const response = await client.send(command);
// {};

DeleteGatewayCommand Input

See DeleteGatewayCommandInput for more details

Parameter
Type
Description
gatewayId
Required
string | undefined

The ID of the gateway to delete.

DeleteGatewayCommand Output

See DeleteGatewayCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ConflictingOperationException
client

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

InternalFailureException
server

IoT SiteWise can't process your request right now. Try again later.

InvalidRequestException
client

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException
client

The requested resource can't be found.

ThrottlingException
client

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas  in the IoT SiteWise User Guide.

IoTSiteWiseServiceException
Base exception class for all service exceptions from IoTSiteWise service.