File Coverage

blib/lib/Paws/EC2/DescribeFpgaImages.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::DescribeFpgaImages;
3 1     1   309 use Moose;
  1         2  
  1         5  
4             has DryRun => (is => 'ro', isa => 'Bool');
5             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
6             has FpgaImageIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'FpgaImageId' );
7             has MaxResults => (is => 'ro', isa => 'Int');
8             has NextToken => (is => 'ro', isa => 'Str');
9             has Owners => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'Owner' );
10              
11 1     1   5395 use MooseX::ClassAttribute;
  1         2  
  1         7  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeFpgaImages');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeFpgaImagesResult');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::EC2::DescribeFpgaImages - Arguments for method DescribeFpgaImages on Paws::EC2
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method DescribeFpgaImages on the
27             Amazon Elastic Compute Cloud service. Use the attributes of this class
28             as arguments to method DescribeFpgaImages.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeFpgaImages.
31              
32             As an example:
33              
34             $service_obj->DescribeFpgaImages(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 DryRun => Bool
42              
43             Checks whether you have the required permissions for the action,
44             without actually making the request, and provides an error response. If
45             you have the required permissions, the error response is
46             C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
47              
48              
49              
50             =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
51              
52             One or more filters.
53              
54             =over
55              
56             =item *
57              
58             C<create-time> - The creation time of the AFI.
59              
60             =item *
61              
62             C<fpga-image-id> - The FPGA image identifier (AFI ID).
63              
64             =item *
65              
66             C<fpga-image-global-id> - The global FPGA image identifier (AGFI ID).
67              
68             =item *
69              
70             C<name> - The name of the AFI.
71              
72             =item *
73              
74             C<owner-id> - The AWS account ID of the AFI owner.
75              
76             =item *
77              
78             C<product-code> - The product code.
79              
80             =item *
81              
82             C<shell-version> - The version of the AWS Shell that was used to create
83             the bitstream.
84              
85             =item *
86              
87             C<state> - The state of the AFI (C<pending> | C<failed> | C<available>
88             | C<unavailable>).
89              
90             =item *
91              
92             C<tag>:I<key>=I<value> - The key/value combination of a tag assigned to
93             the resource. Specify the key of the tag in the filter name and the
94             value of the tag in the filter value. For example, for the tag
95             Purpose=X, specify C<tag:Purpose> for the filter name and C<X> for the
96             filter value.
97              
98             =item *
99              
100             C<tag-key> - The key of a tag assigned to the resource. This filter is
101             independent of the C<tag-value> filter. For example, if you use both
102             the filter "tag-key=Purpose" and the filter "tag-value=X", you get any
103             resources assigned both the tag key Purpose (regardless of what the
104             tag's value is), and the tag value X (regardless of what the tag's key
105             is). If you want to list only resources where Purpose is X, see the
106             C<tag>:I<key>=I<value> filter.
107              
108             =item *
109              
110             C<tag-value> - The value of a tag assigned to the resource. This filter
111             is independent of the C<tag-key> filter.
112              
113             =item *
114              
115             C<update-time> - The time of the most recent update.
116              
117             =back
118              
119              
120              
121              
122             =head2 FpgaImageIds => ArrayRef[Str|Undef]
123              
124             One or more AFI IDs.
125              
126              
127              
128             =head2 MaxResults => Int
129              
130             The maximum number of results to return in a single call.
131              
132              
133              
134             =head2 NextToken => Str
135              
136             The token to retrieve the next page of results.
137              
138              
139              
140             =head2 Owners => ArrayRef[Str|Undef]
141              
142             Filters the AFI by owner. Specify an AWS account ID, C<self> (owner is
143             the sender of the request), or an AWS owner alias (valid values are
144             C<amazon> | C<aws-marketplace>).
145              
146              
147              
148              
149             =head1 SEE ALSO
150              
151             This class forms part of L<Paws>, documenting arguments for method DescribeFpgaImages in L<Paws::EC2>
152              
153             =head1 BUGS and CONTRIBUTIONS
154              
155             The source code is located here: https://github.com/pplu/aws-sdk-perl
156              
157             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
158              
159             =cut
160