blib/lib/Paws/EC2/DescribeNatGateways.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::EC2::DescribeNatGateways;
3 use Moose;
4 has DryRun => (is => 'ro', isa => 'Bool');
5 has Filter => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]');
6 has MaxResults => (is => 'ro', isa => 'Int');
7 has NatGatewayIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'NatGatewayId' );
8 has NextToken => (is => 'ro', isa => 'Str');
9  
10 use MooseX::ClassAttribute;
11  
12 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeNatGateways');
13 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeNatGatewaysResult');
14 class_has _result_key => (isa => 'Str', is => 'ro');
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::EC2::DescribeNatGateways - Arguments for method DescribeNatGateways on L<Paws::EC2>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeNatGateways on the
26 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
27 as arguments to method DescribeNatGateways.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeNatGateways.
30  
31 =head1 SYNOPSIS
32  
33 my $ec2 = Paws->service('EC2');
34 # To describe a NAT gateway
35 # This example describes the NAT gateway for the specified VPC.
36 my $DescribeNatGatewaysResult = $ec2->DescribeNatGateways(
37 'Filter' => [
38  
39 {
40 'Name' => 'vpc-id',
41 'Values' => ['vpc-1a2b3c4d']
42 }
43 ]
44 );
45  
46 # Results:
47 my $NatGateways = $DescribeNatGatewaysResult->NatGateways;
48  
49 # Returns a L<Paws::EC2::DescribeNatGatewaysResult> 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/DescribeNatGateways>
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 Filter => ArrayRef[L<Paws::EC2::Filter>]
67  
68 One or more filters.
69  
70 =over
71  
72 =item *
73  
74 C<nat-gateway-id> - The ID of the NAT gateway.
75  
76 =item *
77  
78 C<state> - The state of the NAT gateway (C<pending> | C<failed> |
79 C<available> | C<deleting> | C<deleted>).
80  
81 =item *
82  
83 C<subnet-id> - The ID of the subnet in which the NAT gateway resides.
84  
85 =item *
86  
87 C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to
88 the resource. Use the tag key in the filter name and the tag value as
89 the filter value. For example, to find all resources that have a tag
90 with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for
91 the filter name and C<TeamA> for the filter value.
92  
93 =item *
94  
95 C<tag-key> - The key of a tag assigned to the resource. Use this filter
96 to find all resources assigned a tag with a specific key, regardless of
97 the tag value.
98  
99 =item *
100  
101 C<vpc-id> - The ID of the VPC in which the NAT gateway resides.
102  
103 =back
104  
105  
106  
107  
108 =head2 MaxResults => Int
109  
110 The maximum number of results to return with a single call. To retrieve
111 the remaining results, make another call with the returned C<nextToken>
112 value.
113  
114  
115  
116 =head2 NatGatewayIds => ArrayRef[Str|Undef]
117  
118 One or more NAT gateway IDs.
119  
120  
121  
122 =head2 NextToken => Str
123  
124 The token for the next page of results.
125  
126  
127  
128  
129 =head1 SEE ALSO
130  
131 This class forms part of L<Paws>, documenting arguments for method DescribeNatGateways in L<Paws::EC2>
132  
133 =head1 BUGS and CONTRIBUTIONS
134  
135 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
136  
137 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
138  
139 =cut
140