Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

UpdateSecurityGroupRuleDescriptionsIngress

Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.

You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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.

Type: Boolean

Required: No

GroupId

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

Type: String

Required: No

GroupName

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

Type: String

Required: No

IpPermissions.N

The IP permissions for the security group rule.

Type: Array of IpPermission objects

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

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

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Examples

Example 1

This example updates the description for the security group rule that allows inbound access over port 22 from the 203.0.113.0/16 IPv4 address range. The description 'SSH access from ABC office' replaces any existing description for the rule.

Sample Request

https://ec2.amazonaws.com/?Action=UpdateSecurityGroupRuleDescriptionsIngress
&GroupId=sg-112233
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=22
&IpPermissions.1.ToPort=22
&IpPermissions.1.IpRanges.1.CidrIp=203.0.113.0/16
&IpPermissions.1.IpRanges.1.Description=SSH access from ABC office
&AUTHPARAMS

Sample Response

<UpdateSecurityGroupRuleDescriptionsIngressResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>b4a57536-2e4a-4cbe-82f0-399example</requestId>
    <return>true</return>
</UpdateSecurityGroupRuleDescriptionsIngressResponse>

Example 2

This example removes the description for the specified security group rule.

Sample Request

https://ec2.amazonaws.com/?Action=UpdateSecurityGroupRuleDescriptionsIngress
&GroupId=sg-112233
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=22
&IpPermissions.1.ToPort=22
&IpPermissions.1.IpRanges.1.CidrIp=203.0.113.4/32
&AUTHPARAMS

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: