- 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.
DeleteSecurityGroupCommand
Deletes a security group.
If you attempt to delete a security group that is associated with an instance or network interface, is referenced by another security group in the same VPC, or has a VPC association, the operation fails with DependencyViolation
.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { EC2Client, DeleteSecurityGroupCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DeleteSecurityGroupCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DeleteSecurityGroupRequest
GroupId: "STRING_VALUE",
GroupName: "STRING_VALUE",
DryRun: true || false,
};
const command = new DeleteSecurityGroupCommand(input);
const response = await client.send(command);
// { // DeleteSecurityGroupResult
// Return: true || false,
// GroupId: "STRING_VALUE",
// };
Example Usage
DeleteSecurityGroupCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
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 |
GroupId | string | undefined | The ID of the security group. |
GroupName | string | undefined | [Default VPC] The name of the security group. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, you must specify the security group ID. |
DeleteSecurityGroupCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
GroupId | string | undefined | The ID of the deleted security group. |
Return | boolean | undefined | Returns |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
EC2ServiceException | Base exception class for all service exceptions from EC2 service. |