1
2package Paws::EC2::DescribeImages {
3  use Moose;
4  has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5  has ExecutableUsers => (is => 'ro', isa => 'ArrayRef[Str]', traits => ['NameInRequest'], request_name => 'ExecutableBy' );
6  has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
7  has ImageIds => (is => 'ro', isa => 'ArrayRef[Str]', traits => ['NameInRequest'], request_name => 'ImageId' );
8  has Owners => (is => 'ro', isa => 'ArrayRef[Str]', traits => ['NameInRequest'], request_name => 'Owner' );
9
10  use MooseX::ClassAttribute;
11
12  class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeImages');
13  class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeImagesResult');
14  class_has _result_key => (isa => 'Str', is => 'ro');
15}
161;
17
18### main pod documentation begin ###
19
20=head1 NAME
21
22Paws::EC2::DescribeImages - Arguments for method DescribeImages on Paws::EC2
23
24=head1 DESCRIPTION
25
26This class represents the parameters used for calling the method DescribeImages on the
27Amazon Elastic Compute Cloud service. Use the attributes of this class
28as arguments to method DescribeImages.
29
30You shouln't make instances of this class. Each attribute should be used as a named argument in the call to DescribeImages.
31
32As an example:
33
34  $service_obj->DescribeImages(Att1 => $value1, Att2 => $value2, ...);
35
36Values 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=head2 DryRun => Bool
41
42
43
44Checks whether you have the required permissions for the action,
45without actually making the request, and provides an error response. If
46you have the required permissions, the error response is
47C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
48
49
50
51
52
53
54
55
56
57
58=head2 ExecutableUsers => ArrayRef[Str]
59
60
61
62Scopes the images by users with explicit launch permissions. Specify an
63AWS account ID, C<self> (the sender of the request), or C<all> (public
64AMIs).
65
66
67
68
69
70
71
72
73
74
75=head2 Filters => ArrayRef[Paws::EC2::Filter]
76
77
78
79One or more filters.
80
81=over
82
83=item *
84
85C<architecture> - The image architecture (C<i386> | C<x86_64>).
86
87=item *
88
89C<block-device-mapping.delete-on-termination> - A Boolean value that
90indicates whether the Amazon EBS volume is deleted on instance
91termination.
92
93=item *
94
95C<block-device-mapping.device-name> - The device name for the EBS
96volume (for example, C</dev/sdh>).
97
98=item *
99
100C<block-device-mapping.snapshot-id> - The ID of the snapshot used for
101the EBS volume.
102
103=item *
104
105C<block-device-mapping.volume-size> - The volume size of the EBS
106volume, in GiB.
107
108=item *
109
110C<block-device-mapping.volume-type> - The volume type of the EBS volume
111(C<gp2> | C<standard> | C<io1>).
112
113=item *
114
115C<description> - The description of the image (provided during image
116creation).
117
118=item *
119
120C<hypervisor> - The hypervisor type (C<ovm> | C<xen>).
121
122=item *
123
124C<image-id> - The ID of the image.
125
126=item *
127
128C<image-type> - The image type (C<machine> | C<kernel> | C<ramdisk>).
129
130=item *
131
132C<is-public> - A Boolean that indicates whether the image is public.
133
134=item *
135
136C<kernel-id> - The kernel ID.
137
138=item *
139
140C<manifest-location> - The location of the image manifest.
141
142=item *
143
144C<name> - The name of the AMI (provided during image creation).
145
146=item *
147
148C<owner-alias> - The AWS account alias (for example, C<amazon>).
149
150=item *
151
152C<owner-id> - The AWS account ID of the image owner.
153
154=item *
155
156C<platform> - The platform. To only list Windows-based AMIs, use
157C<windows>.
158
159=item *
160
161C<product-code> - The product code.
162
163=item *
164
165C<product-code.type> - The type of the product code (C<devpay> |
166C<marketplace>).
167
168=item *
169
170C<ramdisk-id> - The RAM disk ID.
171
172=item *
173
174C<root-device-name> - The name of the root device volume (for example,
175C</dev/sda1>).
176
177=item *
178
179C<root-device-type> - The type of the root device volume (C<ebs> |
180C<instance-store>).
181
182=item *
183
184C<state> - The state of the image (C<available> | C<pending> |
185C<failed>).
186
187=item *
188
189C<state-reason-code> - The reason code for the state change.
190
191=item *
192
193C<state-reason-message> - The message for the state change.
194
195=item *
196
197C<tag>:I<key>=I<value> - The key/value combination of a tag assigned to
198the resource.
199
200=item *
201
202C<tag-key> - The key of a tag assigned to the resource. This filter is
203independent of the tag-value filter. For example, if you use both the
204filter "tag-key=Purpose" and the filter "tag-value=X", you get any
205resources assigned both the tag key Purpose (regardless of what the
206tag's value is), and the tag value X (regardless of what the tag's key
207is). If you want to list only resources where Purpose is X, see the
208C<tag>:I<key>=I<value> filter.
209
210=item *
211
212C<tag-value> - The value of a tag assigned to the resource. This filter
213is independent of the C<tag-key> filter.
214
215=item *
216
217C<virtualization-type> - The virtualization type (C<paravirtual> |
218C<hvm>).
219
220=back
221
222
223
224
225
226
227
228
229
230
231=head2 ImageIds => ArrayRef[Str]
232
233
234
235One or more image IDs.
236
237Default: Describes all images available to you.
238
239
240
241
242
243
244
245
246
247
248=head2 Owners => ArrayRef[Str]
249
250
251
252Filters the images by the owner. Specify an AWS account ID, C<amazon>
253(owner is Amazon), C<aws-marketplace> (owner is AWS Marketplace),
254C<self> (owner is the sender of the request). Omitting this option
255returns all images for which you have launch permissions, regardless of
256ownership.
257
258
259
260
261
262
263
264
265
266
267
268
269=head1 SEE ALSO
270
271This class forms part of L<Paws>, documenting arguments for method DescribeImages in L<Paws::EC2>
272
273=head1 BUGS and CONTRIBUTIONS
274
275The source code is located here: https://github.com/pplu/aws-sdk-perl
276
277Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
278
279=cut
280
281