- 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.
DeleteInsightCommand
Deletes the insight specified by the InsightArn
.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SecurityHubClient, DeleteInsightCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
// const { SecurityHubClient, DeleteInsightCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
const client = new SecurityHubClient(config);
const input = { // DeleteInsightRequest
InsightArn: "STRING_VALUE", // required
};
const command = new DeleteInsightCommand(input);
const response = await client.send(command);
// { // DeleteInsightResponse
// InsightArn: "STRING_VALUE", // required
// };
Example Usage
Loading code editor
DeleteInsightCommand Input
See DeleteInsightCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
InsightArn Required | string | undefined | The ARN of the insight to delete. |
DeleteInsightCommand Output
See DeleteInsightCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
InsightArn Required | string | undefined | The ARN of the insight that was deleted. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalException | server | Internal server error. |
InvalidAccessException | client | The account doesn't have permission to perform this action. |
InvalidInputException | client | The request was rejected because you supplied an invalid or out-of-range value for an input parameter. |
LimitExceededException | client | The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded. |
ResourceNotFoundException | client | The request was rejected because we can't find the specified resource. |
SecurityHubServiceException | Base exception class for all service exceptions from SecurityHub service. |