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

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::EC2::DescribeCarrierGateways;
3 use Moose;
4 has CarrierGatewayIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'CarrierGatewayId' );
5 has DryRun => (is => 'ro', isa => 'Bool');
6 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
7 has MaxResults => (is => 'ro', isa => 'Int');
8 has NextToken => (is => 'ro', isa => 'Str');
9  
10 use MooseX::ClassAttribute;
11  
12 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeCarrierGateways');
13 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeCarrierGatewaysResult');
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::DescribeCarrierGateways - Arguments for method DescribeCarrierGateways on L<Paws::EC2>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeCarrierGateways on the
26 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
27 as arguments to method DescribeCarrierGateways.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCarrierGateways.
30  
31 =head1 SYNOPSIS
32  
33 my $ec2 = Paws->service('EC2');
34 my $DescribeCarrierGatewaysResult = $ec2->DescribeCarrierGateways(
35 CarrierGatewayIds => [ 'MyCarrierGatewayId', ... ], # OPTIONAL
36 DryRun => 1, # OPTIONAL
37 Filters => [
38 {
39 Name => 'MyString', # OPTIONAL
40 Values => [
41 'MyString', ... # OPTIONAL
42 ], # OPTIONAL
43 },
44 ...
45 ], # OPTIONAL
46 MaxResults => 1, # OPTIONAL
47 NextToken => 'MyString', # OPTIONAL
48 );
49  
50 # Results:
51 my $CarrierGateways = $DescribeCarrierGatewaysResult->CarrierGateways;
52 my $NextToken = $DescribeCarrierGatewaysResult->NextToken;
53  
54 # Returns a L<Paws::EC2::DescribeCarrierGatewaysResult> object.
55  
56 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.
57 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeCarrierGateways>
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 CarrierGatewayIds => ArrayRef[Str|Undef]
63  
64 One or more carrier gateway IDs.
65  
66  
67  
68 =head2 DryRun => Bool
69  
70 Checks whether you have the required permissions for the action,
71 without actually making the request, and provides an error response. If
72 you have the required permissions, the error response is
73 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
74  
75  
76  
77 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
78  
79 One or more filters.
80  
81 =over
82  
83 =item *
84  
85 C<carrier-gateway-id> - The ID of the carrier gateway.
86  
87 =item *
88  
89 C<state> - The state of the carrier gateway (C<pending> | C<failed> |
90 C<available> | C<deleting> | C<deleted>).
91  
92 =item *
93  
94 C<owner-id> - The AWS account ID of the owner of the carrier gateway.
95  
96 =item *
97  
98 C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to
99 the resource. Use the tag key in the filter name and the tag value as
100 the filter value. For example, to find all resources that have a tag
101 with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for
102 the filter name and C<TeamA> for the filter value.
103  
104 =item *
105  
106 C<tag-key> - The key of a tag assigned to the resource. Use this filter
107 to find all resources assigned a tag with a specific key, regardless of
108 the tag value.
109  
110 =item *
111  
112 C<vpc-id> - The ID of the VPC associated with the carrier gateway.
113  
114 =back
115  
116  
117  
118  
119 =head2 MaxResults => Int
120  
121 The maximum number of results to return with a single call. To retrieve
122 the remaining results, make another call with the returned C<nextToken>
123 value.
124  
125  
126  
127 =head2 NextToken => Str
128  
129 The token for the next page of results.
130  
131  
132  
133  
134 =head1 SEE ALSO
135  
136 This class forms part of L<Paws>, documenting arguments for method DescribeCarrierGateways in L<Paws::EC2>
137  
138 =head1 BUGS and CONTRIBUTIONS
139  
140 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
141  
142 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
143  
144 =cut
145