ModifySecurityGroupRulesCommand

Modifies the rules of a security group.

Example Syntax

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

import { EC2Client, ModifySecurityGroupRulesCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, ModifySecurityGroupRulesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // ModifySecurityGroupRulesRequest
  GroupId: "STRING_VALUE", // required
  SecurityGroupRules: [ // SecurityGroupRuleUpdateList // required
    { // SecurityGroupRuleUpdate
      SecurityGroupRuleId: "STRING_VALUE", // required
      SecurityGroupRule: { // SecurityGroupRuleRequest
        IpProtocol: "STRING_VALUE",
        FromPort: Number("int"),
        ToPort: Number("int"),
        CidrIpv4: "STRING_VALUE",
        CidrIpv6: "STRING_VALUE",
        PrefixListId: "STRING_VALUE",
        ReferencedGroupId: "STRING_VALUE",
        Description: "STRING_VALUE",
      },
    },
  ],
  DryRun: true || false,
};
const command = new ModifySecurityGroupRulesCommand(input);
const response = await client.send(command);
// { // ModifySecurityGroupRulesResult
//   Return: true || false,
// };

ModifySecurityGroupRulesCommand Input

Parameter
Type
Description
GroupId
Required
string | undefined

The ID of the security group.

SecurityGroupRules
Required
SecurityGroupRuleUpdate[] | undefined

Information about the security group properties to update.

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

ModifySecurityGroupRulesCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Return
boolean | undefined

Returns true if the request succeeds; otherwise, returns an error.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.