- 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.
DeleteDimensionCommand
Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTClient, DeleteDimensionCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, DeleteDimensionCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // DeleteDimensionRequest
name: "STRING_VALUE", // required
};
const command = new DeleteDimensionCommand(input);
const response = await client.send(command);
// {};
DeleteDimensionCommand Input
See DeleteDimensionCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
nameRequired | string | undefined | The unique identifier for the dimension that you want to delete. |
DeleteDimensionCommand Output
See DeleteDimensionCommandOutput 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 unexpected error has occurred. |
| InvalidRequestException | client | The request is not valid. |
| ThrottlingException | client | The rate exceeds the limit. |
| IoTServiceException | Base exception class for all service exceptions from IoT service. |