blib/lib/Paws/EC2/DescribeSubnets.pm

filter: Statementstmt 100% 15 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 17 / 17 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/EC2/DescribeSpotPriceHistoryResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeSubnetsResult.pm »
1  
2 package Paws::EC2::DescribeSubnets;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5 1 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
6 1 has MaxResults => (is => 'ro', isa => 'Int');
7 1 has NextToken => (is => 'ro', isa => 'Str');
8 1 has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'SubnetId' );
9  
10 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSubnets');
13 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeSubnetsResult');
14 1 class_has _result_key => (isa => 'Str', is => 'ro');
15 1 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::EC2::DescribeSubnets - Arguments for method DescribeSubnets on L<Paws::EC2>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeSubnets on the
26 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
27 as arguments to method DescribeSubnets.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSubnets.
30  
31 =head1 SYNOPSIS
32  
33 my $ec2 = Paws->service('EC2');
34 # To describe the subnets for a VPC
35 # This example describes the subnets for the specified VPC.
36 my $DescribeSubnetsResult = $ec2->DescribeSubnets(
37 'Filters' => [
38  
39 {
40 'Name' => 'vpc-id',
41 'Values' => ['vpc-a01106c2']
42 }
43 ]
44 );
45  
46 # Results:
47 my $Subnets = $DescribeSubnetsResult->Subnets;
48  
49 # Returns a L<Paws::EC2::DescribeSubnetsResult> object.
50  
51 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.
52 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeSubnets>
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 DryRun => Bool
58  
59 Checks whether you have the required permissions for the action,
60 without actually making the request, and provides an error response. If
61 you have the required permissions, the error response is
62 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
63  
64  
65  
66 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
67  
68 One or more filters.
69  
70 =over
71  
72 =item *
73  
74 C<availability-zone> - The Availability Zone for the subnet. You can
75 also use C<availabilityZone> as the filter name.
76  
77 =item *
78  
79 C<availability-zone-id> - The ID of the Availability Zone for the
80 subnet. You can also use C<availabilityZoneId> as the filter name.
81  
82 =item *
83  
84 C<available-ip-address-count> - The number of IPv4 addresses in the
85 subnet that are available.
86  
87 =item *
88  
89 C<cidr-block> - The IPv4 CIDR block of the subnet. The CIDR block you
90 specify must exactly match the subnet's CIDR block for information to
91 be returned for the subnet. You can also use C<cidr> or C<cidrBlock> as
92 the filter names.
93  
94 =item *
95  
96 C<default-for-az> - Indicates whether this is the default subnet for
97 the Availability Zone. You can also use C<defaultForAz> as the filter
98 name.
99  
100 =item *
101  
102 C<ipv6-cidr-block-association.ipv6-cidr-block> - An IPv6 CIDR block
103 associated with the subnet.
104  
105 =item *
106  
107 C<ipv6-cidr-block-association.association-id> - An association ID for
108 an IPv6 CIDR block associated with the subnet.
109  
110 =item *
111  
112 C<ipv6-cidr-block-association.state> - The state of an IPv6 CIDR block
113 associated with the subnet.
114  
115 =item *
116  
117 C<outpost-arn> - The Amazon Resource Name (ARN) of the Outpost.
118  
119 =item *
120  
121 C<owner-id> - The ID of the AWS account that owns the subnet.
122  
123 =item *
124  
125 C<state> - The state of the subnet (C<pending> | C<available>).
126  
127 =item *
128  
129 C<subnet-arn> - The Amazon Resource Name (ARN) of the subnet.
130  
131 =item *
132  
133 C<subnet-id> - The ID of the subnet.
134  
135 =item *
136  
137 C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to
138 the resource. Use the tag key in the filter name and the tag value as
139 the filter value. For example, to find all resources that have a tag
140 with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for
141 the filter name and C<TeamA> for the filter value.
142  
143 =item *
144  
145 C<tag-key> - The key of a tag assigned to the resource. Use this filter
146 to find all resources assigned a tag with a specific key, regardless of
147 the tag value.
148  
149 =item *
150  
151 C<vpc-id> - The ID of the VPC for the subnet.
152  
153 =back
154  
155  
156  
157  
158 =head2 MaxResults => Int
159  
160 The maximum number of results to return with a single call. To retrieve
161 the remaining results, make another call with the returned C<nextToken>
162 value.
163  
164  
165  
166 =head2 NextToken => Str
167  
168 The token for the next page of results.
169  
170  
171  
172 =head2 SubnetIds => ArrayRef[Str|Undef]
173  
174 One or more subnet IDs.
175  
176 Default: Describes all your subnets.
177  
178  
179  
180  
181 =head1 SEE ALSO
182  
183 This class forms part of L<Paws>, documenting arguments for method DescribeSubnets in L<Paws::EC2>
184  
185 =head1 BUGS and CONTRIBUTIONS
186  
187 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
188  
189 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
190  
191 =cut
192  
« blib/lib/Paws/EC2/DescribeSpotPriceHistoryResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeSubnetsResult.pm »