Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeSecurityGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Synopsis

data DescribeSecurityGroups = DescribeSecurityGroups' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- groupIds :: Maybe [Text]
- groupNames :: Maybe [Text]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newDescribeSecurityGroups :: DescribeSecurityGroups
describeSecurityGroups_dryRun :: Lens' DescribeSecurityGroups (Maybe Bool)
describeSecurityGroups_filters :: Lens' DescribeSecurityGroups (Maybe [Filter])
describeSecurityGroups_groupIds :: Lens' DescribeSecurityGroups (Maybe [Text])
describeSecurityGroups_groupNames :: Lens' DescribeSecurityGroups (Maybe [Text])
describeSecurityGroups_maxResults :: Lens' DescribeSecurityGroups (Maybe Natural)
describeSecurityGroups_nextToken :: Lens' DescribeSecurityGroups (Maybe Text)
data DescribeSecurityGroupsResponse = DescribeSecurityGroupsResponse' {
- nextToken :: Maybe Text
- securityGroups :: Maybe [SecurityGroup]
- httpStatus :: Int
}
newDescribeSecurityGroupsResponse :: Int -> DescribeSecurityGroupsResponse
describeSecurityGroupsResponse_nextToken :: Lens' DescribeSecurityGroupsResponse (Maybe Text)
describeSecurityGroupsResponse_securityGroups :: Lens' DescribeSecurityGroupsResponse (Maybe [SecurityGroup])
describeSecurityGroupsResponse_httpStatus :: Lens' DescribeSecurityGroupsResponse Int

Creating a Request

data DescribeSecurityGroups Source #

See: newDescribeSecurityGroups smart constructor.

Constructors

DescribeSecurityGroups'

Fields

dryRun :: Maybe Bool
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.
filters :: Maybe [Filter]
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:<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 :: Maybe [Text]
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
groupNames :: Maybe [Text]
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 :: Maybe Natural
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.
nextToken :: Maybe Text
The token to request the next page of results.

Instances

Instances details

ToHeaders DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods toHeaders :: DescribeSecurityGroups -> [Header] #
ToPath DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods toPath :: DescribeSecurityGroups -> ByteString #
ToQuery DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods toQuery :: DescribeSecurityGroups -> QueryString #
AWSPager DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods page :: DescribeSecurityGroups -> AWSResponse DescribeSecurityGroups -> Maybe DescribeSecurityGroups #
AWSRequest DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Associated Types type AWSResponse DescribeSecurityGroups # Methods request :: (Service -> Service) -> DescribeSecurityGroups -> Request DescribeSecurityGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSecurityGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSecurityGroups))) #
Generic DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Associated Types type Rep DescribeSecurityGroups :: Type -> Type # Methods from :: DescribeSecurityGroups -> Rep DescribeSecurityGroups x # to :: Rep DescribeSecurityGroups x -> DescribeSecurityGroups #
Read DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods readsPrec :: Int -> ReadS DescribeSecurityGroups # readList :: ReadS [DescribeSecurityGroups] # readPrec :: ReadPrec DescribeSecurityGroups # readListPrec :: ReadPrec [DescribeSecurityGroups] #
Show DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods showsPrec :: Int -> DescribeSecurityGroups -> ShowS # show :: DescribeSecurityGroups -> String # showList :: [DescribeSecurityGroups] -> ShowS #
NFData DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods rnf :: DescribeSecurityGroups -> () #
Eq DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods (==) :: DescribeSecurityGroups -> DescribeSecurityGroups -> Bool # (/=) :: DescribeSecurityGroups -> DescribeSecurityGroups -> Bool #
Hashable DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods hashWithSalt :: Int -> DescribeSecurityGroups -> Int # hash :: DescribeSecurityGroups -> Int #
type AWSResponse DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups type AWSResponse DescribeSecurityGroups = DescribeSecurityGroupsResponse
type Rep DescribeSecurityGroups Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups type Rep DescribeSecurityGroups = D1 ('MetaData "DescribeSecurityGroups" "Amazonka.EC2.DescribeSecurityGroups" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSecurityGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "groupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "groupNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeSecurityGroups :: DescribeSecurityGroups Source #

Create a value of DescribeSecurityGroups with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeSecurityGroups', describeSecurityGroups_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.

$sel:filters:DescribeSecurityGroups', describeSecurityGroups_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:<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.

DescribeSecurityGroups, describeSecurityGroups_groupIds - The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all of your security groups.

DescribeSecurityGroups, describeSecurityGroups_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.

$sel:maxResults:DescribeSecurityGroups', describeSecurityGroups_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.

DescribeSecurityGroups, describeSecurityGroups_nextToken - The token to request the next page of results.

Request Lenses

describeSecurityGroups_dryRun :: Lens' DescribeSecurityGroups (Maybe Bool) Source #

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.

describeSecurityGroups_filters :: Lens' DescribeSecurityGroups (Maybe [Filter]) Source #

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

describeSecurityGroups_groupIds :: Lens' DescribeSecurityGroups (Maybe [Text]) Source #

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all of your security groups.

describeSecurityGroups_groupNames :: Lens' DescribeSecurityGroups (Maybe [Text]) Source #

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.

describeSecurityGroups_maxResults :: Lens' DescribeSecurityGroups (Maybe Natural) Source #

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.

describeSecurityGroups_nextToken :: Lens' DescribeSecurityGroups (Maybe Text) Source #

The token to request the next page of results.

Destructuring the Response

data DescribeSecurityGroupsResponse Source #

See: newDescribeSecurityGroupsResponse smart constructor.

Constructors

DescribeSecurityGroupsResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. securityGroups :: Maybe [SecurityGroup] Information about the security groups. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeSecurityGroupsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Associated Types type Rep DescribeSecurityGroupsResponse :: Type -> Type # Methods from :: DescribeSecurityGroupsResponse -> Rep DescribeSecurityGroupsResponse x # to :: Rep DescribeSecurityGroupsResponse x -> DescribeSecurityGroupsResponse #
Read DescribeSecurityGroupsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods readsPrec :: Int -> ReadS DescribeSecurityGroupsResponse # readList :: ReadS [DescribeSecurityGroupsResponse] # readPrec :: ReadPrec DescribeSecurityGroupsResponse # readListPrec :: ReadPrec [DescribeSecurityGroupsResponse] #
Show DescribeSecurityGroupsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods showsPrec :: Int -> DescribeSecurityGroupsResponse -> ShowS # show :: DescribeSecurityGroupsResponse -> String # showList :: [DescribeSecurityGroupsResponse] -> ShowS #
NFData DescribeSecurityGroupsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods rnf :: DescribeSecurityGroupsResponse -> () #
Eq DescribeSecurityGroupsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups Methods (==) :: DescribeSecurityGroupsResponse -> DescribeSecurityGroupsResponse -> Bool # (/=) :: DescribeSecurityGroupsResponse -> DescribeSecurityGroupsResponse -> Bool #
type Rep DescribeSecurityGroupsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSecurityGroups type Rep DescribeSecurityGroupsResponse = D1 ('MetaData "DescribeSecurityGroupsResponse" "Amazonka.EC2.DescribeSecurityGroups" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSecurityGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SecurityGroup])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSecurityGroupsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSecurityGroupsResponse'`
-> DescribeSecurityGroupsResponse

Create a value of DescribeSecurityGroupsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSecurityGroups, describeSecurityGroupsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeSecurityGroupsResponse, describeSecurityGroupsResponse_securityGroups - Information about the security groups.

$sel:httpStatus:DescribeSecurityGroupsResponse', describeSecurityGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeSecurityGroupsResponse_nextToken :: Lens' DescribeSecurityGroupsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describeSecurityGroupsResponse_securityGroups :: Lens' DescribeSecurityGroupsResponse (Maybe [SecurityGroup]) Source #

Information about the security groups.

describeSecurityGroupsResponse_httpStatus :: Lens' DescribeSecurityGroupsResponse Int Source #

The response's http status code.