Skip to content

Describe Security Group Rules

ec2_describe_security_group_rules R Documentation

Describes one or more of your security group rules

Description

Describes one or more of your security group rules.

Usage

ec2_describe_security_group_rules(Filters, SecurityGroupRuleIds, DryRun,
  NextToken, MaxResults)

Arguments

Filters

One or more filters.

  • group-id - The ID of the security group.

  • security-group-rule-id - The ID of the security group rule.

  • tag:\<key\> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

SecurityGroupRuleIds

The IDs of the security group rules.

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.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.

Value

A list with the following syntax: 

list(
  SecurityGroupRules = list(
    list(
      SecurityGroupRuleId = "string",
      GroupId = "string",
      GroupOwnerId = "string",
      IsEgress = TRUE|FALSE,
      IpProtocol = "string",
      FromPort = 123,
      ToPort = 123,
      CidrIpv4 = "string",
      CidrIpv6 = "string",
      PrefixListId = "string",
      ReferencedGroupInfo = list(
        GroupId = "string",
        PeeringStatus = "string",
        UserId = "string",
        VpcId = "string",
        VpcPeeringConnectionId = "string"
      ),
      Description = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_security_group_rules(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  SecurityGroupRuleIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123
)