paws.compute (version 0.1.0)

ec2_describe_security_groups: Describes one or more of your security groups

Description

Describes one or more of your security groups.

Usage

ec2_describe_security_groups(Filters, GroupIds, GroupNames, DryRun,
  NextToken, MaxResults)

Arguments

Filters

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

• description - The description of the security group.

• egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

• egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

• egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

• egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

• egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

• egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which a security group rule allows outbound access.

• egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp \| udp \| icmp or a protocol number).

• egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

• egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

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

• group-name - The name of the security group.

• ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

• ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

• ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

• ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

• ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

• ip-permission.prefix-list-id - The ID (prefix) of the AWS service from which a security group rule allows inbound access.

• ip-permission.protocol - The IP protocol for an inbound security group rule (tcp \| udp \| icmp or a protocol number).

• ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

• ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

• owner-id - The AWS account ID of the owner of the security group.

• 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.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC specified when the security group was created.

GroupIds

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

GroupNames

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

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 to request the next page of results.

MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.

Request syntax

svc$describe_security_groups(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  GroupIds = list(
    "string"
  ),
  GroupNames = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123
)

Details

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

Examples

# NOT RUN {
# This example describes the specified security group.
# }
# NOT RUN {
svc$describe_security_groups(
  GroupIds = list(
    "sg-903004f8"
  )
)
# }
# NOT RUN {
# This example describes the security groups that include the specified
# tag (Purpose=test).
# }
# NOT RUN {
svc$describe_security_groups(
  Filters = list(
    list(
      Name = "tag:Purpose",
      Values = list(
        "test"
      )
    )
  )
)
# }
# NOT RUN {
# }