| 1 | |||
| 2 | package 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|Undef]', 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|Undef]', traits => ['NameInRequest'], request_name => 'ImageId' ); | ||
| 8 | has IncludeDeprecated => (is => 'ro', isa => 'Bool'); | ||
| 9 | has Owners => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'Owner' ); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeImages'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeImagesResult'); | ||
| 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::DescribeImages - Arguments for method DescribeImages on L<Paws::EC2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DescribeImages on the | ||
| 27 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 28 | as arguments to method DescribeImages. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeImages. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ec2 = Paws->service('EC2'); | ||
| 35 | # To describe an AMI | ||
| 36 | # This example describes the specified AMI. | ||
| 37 | my $DescribeImagesResult = | ||
| 38 | $ec2->DescribeImages( 'ImageIds' => ['ami-5731123e'] ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $Images = $DescribeImagesResult->Images; | ||
| 42 | |||
| 43 | # Returns a L<Paws::EC2::DescribeImagesResult> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeImages> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 DryRun => Bool | ||
| 52 | |||
| 53 | Checks whether you have the required permissions for the action, | ||
| 54 | without actually making the request, and provides an error response. If | ||
| 55 | you have the required permissions, the error response is | ||
| 56 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 ExecutableUsers => ArrayRef[Str|Undef] | ||
| 61 | |||
| 62 | Scopes the images by users with explicit launch permissions. Specify an | ||
| 63 | AWS account ID, C<self> (the sender of the request), or C<all> (public | ||
| 64 | AMIs). | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 69 | |||
| 70 | The filters. | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<architecture> - The image architecture (C<i386> | C<x86_64> | | ||
| 77 | C<arm64>). | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<block-device-mapping.delete-on-termination> - A Boolean value that | ||
| 82 | indicates whether the Amazon EBS volume is deleted on instance | ||
| 83 | termination. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<block-device-mapping.device-name> - The device name specified in the | ||
| 88 | block device mapping (for example, C</dev/sdh> or C<xvdh>). | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<block-device-mapping.snapshot-id> - The ID of the snapshot used for | ||
| 93 | the EBS volume. | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<block-device-mapping.volume-size> - The volume size of the EBS | ||
| 98 | volume, in GiB. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | C<block-device-mapping.volume-type> - The volume type of the EBS volume | ||
| 103 | (C<gp2> | C<io1> | C<io2> | C<st1 >| C<sc1> | C<standard>). | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<block-device-mapping.encrypted> - A Boolean that indicates whether | ||
| 108 | the EBS volume is encrypted. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<description> - The description of the image (provided during image | ||
| 113 | creation). | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | C<ena-support> - A Boolean that indicates whether enhanced networking | ||
| 118 | with ENA is enabled. | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | C<hypervisor> - The hypervisor type (C<ovm> | C<xen>). | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | C<image-id> - The ID of the image. | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | C<image-type> - The image type (C<machine> | C<kernel> | C<ramdisk>). | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | C<is-public> - A Boolean that indicates whether the image is public. | ||
| 135 | |||
| 136 | =item * | ||
| 137 | |||
| 138 | C<kernel-id> - The kernel ID. | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | C<manifest-location> - The location of the image manifest. | ||
| 143 | |||
| 144 | =item * | ||
| 145 | |||
| 146 | C<name> - The name of the AMI (provided during image creation). | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | C<owner-alias> - The owner alias (C<amazon> | C<aws-marketplace>). The | ||
| 151 | valid aliases are defined in an Amazon-maintained list. This is not the | ||
| 152 | AWS account alias that can be set using the IAM console. We recommend | ||
| 153 | that you use the B<Owner> request parameter instead of this filter. | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | C<owner-id> - The AWS account ID of the owner. We recommend that you | ||
| 158 | use the B<Owner> request parameter instead of this filter. | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | C<platform> - The platform. To only list Windows-based AMIs, use | ||
| 163 | C<windows>. | ||
| 164 | |||
| 165 | =item * | ||
| 166 | |||
| 167 | C<product-code> - The product code. | ||
| 168 | |||
| 169 | =item * | ||
| 170 | |||
| 171 | C<product-code.type> - The type of the product code (C<devpay> | | ||
| 172 | C<marketplace>). | ||
| 173 | |||
| 174 | =item * | ||
| 175 | |||
| 176 | C<ramdisk-id> - The RAM disk ID. | ||
| 177 | |||
| 178 | =item * | ||
| 179 | |||
| 180 | C<root-device-name> - The device name of the root device volume (for | ||
| 181 | example, C</dev/sda1>). | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | C<root-device-type> - The type of the root device volume (C<ebs> | | ||
| 186 | C<instance-store>). | ||
| 187 | |||
| 188 | =item * | ||
| 189 | |||
| 190 | C<state> - The state of the image (C<available> | C<pending> | | ||
| 191 | C<failed>). | ||
| 192 | |||
| 193 | =item * | ||
| 194 | |||
| 195 | C<state-reason-code> - The reason code for the state change. | ||
| 196 | |||
| 197 | =item * | ||
| 198 | |||
| 199 | C<state-reason-message> - The message for the state change. | ||
| 200 | |||
| 201 | =item * | ||
| 202 | |||
| 203 | C<sriov-net-support> - A value of C<simple> indicates that enhanced | ||
| 204 | networking with the Intel 82599 VF interface is enabled. | ||
| 205 | |||
| 206 | =item * | ||
| 207 | |||
| 208 | C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to | ||
| 209 | the resource. Use the tag key in the filter name and the tag value as | ||
| 210 | the filter value. For example, to find all resources that have a tag | ||
| 211 | with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for | ||
| 212 | the filter name and C<TeamA> for the filter value. | ||
| 213 | |||
| 214 | =item * | ||
| 215 | |||
| 216 | C<tag-key> - The key of a tag assigned to the resource. Use this filter | ||
| 217 | to find all resources assigned a tag with a specific key, regardless of | ||
| 218 | the tag value. | ||
| 219 | |||
| 220 | =item * | ||
| 221 | |||
| 222 | C<virtualization-type> - The virtualization type (C<paravirtual> | | ||
| 223 | C<hvm>). | ||
| 224 | |||
| 225 | =back | ||
| 226 | |||
| 227 | |||
| 228 | |||
| 229 | |||
| 230 | =head2 ImageIds => ArrayRef[Str|Undef] | ||
| 231 | |||
| 232 | The image IDs. | ||
| 233 | |||
| 234 | Default: Describes all images available to you. | ||
| 235 | |||
| 236 | |||
| 237 | |||
| 238 | =head2 IncludeDeprecated => Bool | ||
| 239 | |||
| 240 | If C<true>, all deprecated AMIs are included in the response. If | ||
| 241 | C<false>, no deprecated AMIs are included in the response. If no value | ||
| 242 | is specified, the default value is C<false>. | ||
| 243 | |||
| 244 | If you are the AMI owner, all deprecated AMIs appear in the response | ||
| 245 | regardless of the value (C<true> or C<false>) that you set for this | ||
| 246 | parameter. | ||
| 247 | |||
| 248 | |||
| 249 | |||
| 250 | =head2 Owners => ArrayRef[Str|Undef] | ||
| 251 | |||
| 252 | Scopes the results to images with the specified owners. You can specify | ||
| 253 | a combination of AWS account IDs, C<self>, C<amazon>, and | ||
| 254 | C<aws-marketplace>. If you omit this parameter, the results include all | ||
| 255 | images for which you have launch permissions, regardless of ownership. | ||
| 256 | |||
| 257 | |||
| 258 | |||
| 259 | |||
| 260 | =head1 SEE ALSO | ||
| 261 | |||
| 262 | This class forms part of L<Paws>, documenting arguments for method DescribeImages in L<Paws::EC2> | ||
| 263 | |||
| 264 | =head1 BUGS and CONTRIBUTIONS | ||
| 265 | |||
| 266 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 267 | |||
| 268 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 269 | |||
| 270 | =cut | ||
| 271 |