File Coverage

blib/lib/Paws/EC2/DescribeSecurityGroups.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::EC2::DescribeSecurityGroups;
3 1     1   380 use Moose;
  1     1   2  
  1         6  
  1         542  
  1         4  
  1         9  
4             has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
6             has GroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'GroupId' );
7             has GroupNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'GroupName' );
8              
9 1     1   5411 use MooseX::ClassAttribute;
  1     1   2  
  1         7  
  1         8074  
  1         6  
  1         11  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSecurityGroups');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeSecurityGroupsResult');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::EC2::DescribeSecurityGroups - Arguments for method DescribeSecurityGroups on Paws::EC2
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DescribeSecurityGroups on the
25             Amazon Elastic Compute Cloud service. Use the attributes of this class
26             as arguments to method DescribeSecurityGroups.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSecurityGroups.
29              
30             As an example:
31              
32             $service_obj->DescribeSecurityGroups(Att1 => $value1, Att2 => $value2, ...);
33              
34             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 DryRun => Bool
40              
41             Checks whether you have the required permissions for the action,
42             without actually making the request, and provides an error response. If
43             you have the required permissions, the error response is
44             C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
45              
46              
47              
48             =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
49              
50             One or more filters. If using multiple filters for rules, the results
51             include security groups for which any combination of rules - not
52             necessarily a single rule - match all filters.
53              
54             =over
55              
56             =item *
57              
58             C<description> - The description of the security group.
59              
60             =item *
61              
62             C<egress.ip-permission.prefix-list-id> - The ID (prefix) of the AWS
63             service to which the security group allows access.
64              
65             =item *
66              
67             C<group-id> - The ID of the security group.
68              
69             =item *
70              
71             C<group-name> - The name of the security group.
72              
73             =item *
74              
75             C<ip-permission.cidr> - An IPv4 CIDR range that has been granted
76             permission in a security group rule.
77              
78             =item *
79              
80             C<ip-permission.from-port> - The start of port range for the TCP and
81             UDP protocols, or an ICMP type number.
82              
83             =item *
84              
85             C<ip-permission.group-id> - The ID of a security group that has been
86             granted permission.
87              
88             =item *
89              
90             C<ip-permission.group-name> - The name of a security group that has
91             been granted permission.
92              
93             =item *
94              
95             C<ip-permission.ipv6-cidr> - An IPv6 CIDR range that has been granted
96             permission in a security group rule.
97              
98             =item *
99              
100             C<ip-permission.protocol> - The IP protocol for the permission (C<tcp>
101             | C<udp> | C<icmp> or a protocol number).
102              
103             =item *
104              
105             C<ip-permission.to-port> - The end of port range for the TCP and UDP
106             protocols, or an ICMP code.
107              
108             =item *
109              
110             C<ip-permission.user-id> - The ID of an AWS account that has been
111             granted permission.
112              
113             =item *
114              
115             C<owner-id> - The AWS account ID of the owner of the security group.
116              
117             =item *
118              
119             C<tag-key> - The key of a tag assigned to the security group.
120              
121             =item *
122              
123             C<tag-value> - The value of a tag assigned to the security group.
124              
125             =item *
126              
127             C<vpc-id> - The ID of the VPC specified when the security group was
128             created.
129              
130             =back
131              
132              
133              
134              
135             =head2 GroupIds => ArrayRef[Str|Undef]
136              
137             One or more security group IDs. Required for security groups in a
138             nondefault VPC.
139              
140             Default: Describes all your security groups.
141              
142              
143              
144             =head2 GroupNames => ArrayRef[Str|Undef]
145              
146             [EC2-Classic and default VPC only] One or more security group names.
147             You can specify either the security group name or the security group
148             ID. For security groups in a nondefault VPC, use the C<group-name>
149             filter to describe security groups by name.
150              
151             Default: Describes all your security groups.
152              
153              
154              
155              
156             =head1 SEE ALSO
157              
158             This class forms part of L<Paws>, documenting arguments for method DescribeSecurityGroups in L<Paws::EC2>
159              
160             =head1 BUGS and CONTRIBUTIONS
161              
162             The source code is located here: https://github.com/pplu/aws-sdk-perl
163              
164             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
165              
166             =cut
167