DeleteSignalCatalogCommand

Deletes a signal catalog.

Example Syntax

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

import { IoTFleetWiseClient, DeleteSignalCatalogCommand } from "@aws-sdk/client-iotfleetwise"; // ES Modules import
// const { IoTFleetWiseClient, DeleteSignalCatalogCommand } = require("@aws-sdk/client-iotfleetwise"); // CommonJS import
const client = new IoTFleetWiseClient(config);
const input = { // DeleteSignalCatalogRequest
  name: "STRING_VALUE", // required
};
const command = new DeleteSignalCatalogCommand(input);
const response = await client.send(command);
// { // DeleteSignalCatalogResponse
//   name: "STRING_VALUE", // required
//   arn: "STRING_VALUE", // required
// };

DeleteSignalCatalogCommand Input

See DeleteSignalCatalogCommandInput for more details

Parameter
Type
Description
name
Required
string | undefined

The name of the signal catalog to delete.

DeleteSignalCatalogCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
arn
Required
string | undefined

The Amazon Resource Name (ARN) of the deleted signal catalog.

name
Required
string | undefined

The name of the deleted signal catalog.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient permission to perform this action.

ConflictException
client

The 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.

InternalServerException
server

The request couldn't be completed because the server temporarily failed.

ThrottlingException
client

The request couldn't be completed due to throttling.

ValidationException
client

The input fails to satisfy the constraints specified by an Amazon Web Services service.

IoTFleetWiseServiceException
Base exception class for all service exceptions from IoTFleetWise service.