DescribeSecurityGroupsRequest Class

Container for the parameters to the DescribeSecurityGroups operation. Describes the specified security groups or all of your security groups.

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.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.DescribeSecurityGroupsRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

public class DescribeSecurityGroupsRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeSecurityGroupsRequest type exposes the following members

Constructors

	Name	Description
	DescribeSecurityGroupsRequest()

Properties

Name	Type	Description
Filters	System.Collections.Generic.List<Amazon.EC2.Model.Filter>	Gets and sets the property Filters. The 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 is 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 of a prefix list 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`, a protocol number, or -1 for all protocols). `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 Amazon Web Services 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 is 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 of a prefix list from which a security group rule allows inbound access. `ip-permission.protocol` - The IP protocol for an inbound security group rule (`tcp` \| `udp` \| `icmp`, a protocol number, or -1 for all protocols). `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 Amazon Web Services account that has been referenced in an inbound security group rule. `owner-id` - The Amazon Web Services account ID of the owner of the security group. `tag`: - 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	System.Collections.Generic.List<System.String>	Gets and sets the property GroupIds. The IDs of the security groups. Required for security groups in a nondefault VPC. Default: Describes all of your security groups.
GroupNames	System.Collections.Generic.List<System.String>	Gets and sets the property GroupNames. [EC2-Classic and default VPC only] The names of the security groups. 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 of your security groups.
MaxResults	System.Int32	Gets and sets the property 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.
NextToken	System.String	Gets and sets the property NextToken. The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Examples

This example describes the specified security group.

To describe a security group


var client = new AmazonEC2Client();
var response = client.DescribeSecurityGroups(new DescribeSecurityGroupsRequest 
{
    GroupIds = new List<string> {
        "sg-903004f8"
    }
});

This example describes the security groups that include the specified tag (Purpose=test).

To describe a tagged security group


var client = new AmazonEC2Client();
var response = client.DescribeSecurityGroups(new DescribeSecurityGroupsRequest 
{
    Filters = new List<Filter> {
        new Filter {
            Name = "tag:Purpose",
            Values = new List<string> {
                "test"
            }
        }
    }
});

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5