File Coverage

blib/lib/Paws/EC2/DescribeNatGateways.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::EC2::DescribeNatGateways;
3 1     1   440 use Moose;
  1         2  
  1         6  
4             has Filter => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]');
5             has MaxResults => (is => 'ro', isa => 'Int');
6             has NatGatewayIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'NatGatewayId' );
7             has NextToken => (is => 'ro', isa => 'Str');
8              
9 1     1   5738 use MooseX::ClassAttribute;
  1         3  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeNatGateways');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeNatGatewaysResult');
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::DescribeNatGateways - Arguments for method DescribeNatGateways on Paws::EC2
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DescribeNatGateways on the
25             Amazon Elastic Compute Cloud service. Use the attributes of this class
26             as arguments to method DescribeNatGateways.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeNatGateways.
29              
30             As an example:
31              
32             $service_obj->DescribeNatGateways(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 Filter => ArrayRef[L<Paws::EC2::Filter>]
40              
41             One or more filters.
42              
43             =over
44              
45             =item *
46              
47             C<nat-gateway-id> - The ID of the NAT gateway.
48              
49             =item *
50              
51             C<state> - The state of the NAT gateway (C<pending> | C<failed> |
52             C<available> | C<deleting> | C<deleted>).
53              
54             =item *
55              
56             C<subnet-id> - The ID of the subnet in which the NAT gateway resides.
57              
58             =item *
59              
60             C<tag>:I<key>=I<value> - The key/value combination of a tag assigned to
61             the resource. Specify the key of the tag in the filter name and the
62             value of the tag in the filter value. For example, for the tag
63             Purpose=X, specify C<tag:Purpose> for the filter name and C<X> for the
64             filter value.
65              
66             =item *
67              
68             C<tag-key> - The key of a tag assigned to the resource. This filter is
69             independent of the C<tag-value> filter. For example, if you use both
70             the filter "tag-key=Purpose" and the filter "tag-value=X", you get any
71             resources assigned both the tag key Purpose (regardless of what the
72             tag's value is), and the tag value X (regardless of what the tag's key
73             is). If you want to list only resources where Purpose is X, see the
74             C<tag>:I<key>=I<value> filter.
75              
76             =item *
77              
78             C<tag-value> - The value of a tag assigned to the resource. This filter
79             is independent of the C<tag-key> filter.
80              
81             =item *
82              
83             C<vpc-id> - The ID of the VPC in which the NAT gateway resides.
84              
85             =back
86              
87              
88              
89              
90             =head2 MaxResults => Int
91              
92             The maximum number of items to return for this request. The request
93             returns a token that you can specify in a subsequent call to get the
94             next set of results.
95              
96             Constraint: If the value specified is greater than 1000, we return only
97             1000 items.
98              
99              
100              
101             =head2 NatGatewayIds => ArrayRef[Str|Undef]
102              
103             One or more NAT gateway IDs.
104              
105              
106              
107             =head2 NextToken => Str
108              
109             The token to retrieve the next page of results.
110              
111              
112              
113              
114             =head1 SEE ALSO
115              
116             This class forms part of L<Paws>, documenting arguments for method DescribeNatGateways in L<Paws::EC2>
117              
118             =head1 BUGS and CONTRIBUTIONS
119              
120             The source code is located here: https://github.com/pplu/aws-sdk-perl
121              
122             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
123              
124             =cut
125