- 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.
DeleteTrafficMirrorFilterCommand
Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { EC2Client, DeleteTrafficMirrorFilterCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DeleteTrafficMirrorFilterCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DeleteTrafficMirrorFilterRequest
TrafficMirrorFilterId: "STRING_VALUE", // required
DryRun: true || false,
};
const command = new DeleteTrafficMirrorFilterCommand(input);
const response = await client.send(command);
// { // DeleteTrafficMirrorFilterResult
// TrafficMirrorFilterId: "STRING_VALUE",
// };
DeleteTrafficMirrorFilterCommand Input
See DeleteTrafficMirrorFilterCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
TrafficMirrorFilterIdRequired | string | undefined | The ID of the Traffic Mirror filter. |
DryRun | boolean | undefined | Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
DeleteTrafficMirrorFilterCommand Output
See DeleteTrafficMirrorFilterCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
TrafficMirrorFilterId | string | undefined | The ID of the Traffic Mirror filter. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| EC2ServiceException | Base exception class for all service exceptions from EC2 service. |