« blib/lib/Paws/EC2/DescribeInstanceStatusResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeInstancesResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeInstances; | ||
| 3 | 4 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 4 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | |
| 5 | 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | |
| 6 | 4 | has InstanceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'InstanceId' ); | |
| 7 | 4 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | |
| 8 | 4 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | |
| 9 | |||
| 10 | 4 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 11 | |||
| 12 | 4 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeInstances'); | |
| 13 | 4 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeInstancesResult'); | |
| 14 | 4 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 15 | 4 | 1; | |
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EC2::DescribeInstances - Arguments for method DescribeInstances on L<Paws::EC2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeInstances on the | ||
| 26 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeInstances. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeInstances. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ec2 = Paws->service('EC2'); | ||
| 34 | # To describe an Amazon EC2 instance | ||
| 35 | # This example describes the specified instance. | ||
| 36 | my $DescribeInstancesResult = | ||
| 37 | $ec2->DescribeInstances( 'InstanceIds' => ['i-1234567890abcdef0'] ); | ||
| 38 | |||
| 39 | # To describe the instances with a specific instance type | ||
| 40 | # This example describes the instances with the t2.micro instance type. | ||
| 41 | my $DescribeInstancesResult = $ec2->DescribeInstances( | ||
| 42 | 'Filters' => [ | ||
| 43 | |||
| 44 | { | ||
| 45 | 'Name' => 'instance-type', | ||
| 46 | 'Values' => ['t2.micro'] | ||
| 47 | } | ||
| 48 | ] | ||
| 49 | ); | ||
| 50 | |||
| 51 | # To describe the instances with a specific tag | ||
| 52 | # This example describes the instances with the Purpose=test tag. | ||
| 53 | my $DescribeInstancesResult = $ec2->DescribeInstances( | ||
| 54 | 'Filters' => [ | ||
| 55 | |||
| 56 | { | ||
| 57 | 'Name' => 'tag:Purpose', | ||
| 58 | 'Values' => ['test'] | ||
| 59 | } | ||
| 60 | ] | ||
| 61 | ); | ||
| 62 | |||
| 63 | |||
| 64 | 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. | ||
| 65 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeInstances> | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 DryRun => Bool | ||
| 71 | |||
| 72 | Checks whether you have the required permissions for the action, | ||
| 73 | without actually making the request, and provides an error response. If | ||
| 74 | you have the required permissions, the error response is | ||
| 75 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 80 | |||
| 81 | The filters. | ||
| 82 | |||
| 83 | =over | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<affinity> - The affinity setting for an instance running on a | ||
| 88 | Dedicated Host (C<default> | C<host>). | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<architecture> - The instance architecture (C<i386> | C<x86_64> | | ||
| 93 | C<arm64>). | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<availability-zone> - The Availability Zone of the instance. | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | C<block-device-mapping.attach-time> - The attach time for an EBS volume | ||
| 102 | mapped to the instance, for example, C<2010-09-15T17:15:20.000Z>. | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | C<block-device-mapping.delete-on-termination> - A Boolean that | ||
| 107 | indicates whether the EBS volume is deleted on instance termination. | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | C<block-device-mapping.device-name> - The device name specified in the | ||
| 112 | block device mapping (for example, C</dev/sdh> or C<xvdh>). | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | C<block-device-mapping.status> - The status for the EBS volume | ||
| 117 | (C<attaching> | C<attached> | C<detaching> | C<detached>). | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | C<block-device-mapping.volume-id> - The volume ID of the EBS volume. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | C<client-token> - The idempotency token you provided when you launched | ||
| 126 | the instance. | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | C<dns-name> - The public DNS name of the instance. | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | C<group-id> - The ID of the security group for the instance. | ||
| 135 | EC2-Classic only. | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | C<group-name> - The name of the security group for the instance. | ||
| 140 | EC2-Classic only. | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | C<hibernation-options.configured> - A Boolean that indicates whether | ||
| 145 | the instance is enabled for hibernation. A value of C<true> means that | ||
| 146 | the instance is enabled for hibernation. | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | C<host-id> - The ID of the Dedicated Host on which the instance is | ||
| 151 | running, if applicable. | ||
| 152 | |||
| 153 | =item * | ||
| 154 | |||
| 155 | C<hypervisor> - The hypervisor type of the instance (C<ovm> | C<xen>). | ||
| 156 | The value C<xen> is used for both Xen and Nitro hypervisors. | ||
| 157 | |||
| 158 | =item * | ||
| 159 | |||
| 160 | C<iam-instance-profile.arn> - The instance profile associated with the | ||
| 161 | instance. Specified as an ARN. | ||
| 162 | |||
| 163 | =item * | ||
| 164 | |||
| 165 | C<image-id> - The ID of the image used to launch the instance. | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | C<instance-id> - The ID of the instance. | ||
| 170 | |||
| 171 | =item * | ||
| 172 | |||
| 173 | C<instance-lifecycle> - Indicates whether this is a Spot Instance or a | ||
| 174 | Scheduled Instance (C<spot> | C<scheduled>). | ||
| 175 | |||
| 176 | =item * | ||
| 177 | |||
| 178 | C<instance-state-code> - The state of the instance, as a 16-bit | ||
| 179 | unsigned integer. The high byte is used for internal purposes and | ||
| 180 | should be ignored. The low byte is set based on the state represented. | ||
| 181 | The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 | ||
| 182 | (terminated), 64 (stopping), and 80 (stopped). | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | C<instance-state-name> - The state of the instance (C<pending> | | ||
| 187 | C<running> | C<shutting-down> | C<terminated> | C<stopping> | | ||
| 188 | C<stopped>). | ||
| 189 | |||
| 190 | =item * | ||
| 191 | |||
| 192 | C<instance-type> - The type of instance (for example, C<t2.micro>). | ||
| 193 | |||
| 194 | =item * | ||
| 195 | |||
| 196 | C<instance.group-id> - The ID of the security group for the instance. | ||
| 197 | |||
| 198 | =item * | ||
| 199 | |||
| 200 | C<instance.group-name> - The name of the security group for the | ||
| 201 | instance. | ||
| 202 | |||
| 203 | =item * | ||
| 204 | |||
| 205 | C<ip-address> - The public IPv4 address of the instance. | ||
| 206 | |||
| 207 | =item * | ||
| 208 | |||
| 209 | C<kernel-id> - The kernel ID. | ||
| 210 | |||
| 211 | =item * | ||
| 212 | |||
| 213 | C<key-name> - The name of the key pair used when the instance was | ||
| 214 | launched. | ||
| 215 | |||
| 216 | =item * | ||
| 217 | |||
| 218 | C<launch-index> - When launching multiple instances, this is the index | ||
| 219 | for the instance in the launch group (for example, 0, 1, 2, and so on). | ||
| 220 | |||
| 221 | =item * | ||
| 222 | |||
| 223 | C<launch-time> - The time when the instance was launched. | ||
| 224 | |||
| 225 | =item * | ||
| 226 | |||
| 227 | C<metadata-options.http-tokens> - The metadata request authorization | ||
| 228 | state (C<optional> | C<required>) | ||
| 229 | |||
| 230 | =item * | ||
| 231 | |||
| 232 | C<metadata-options.http-put-response-hop-limit> - The http metadata | ||
| 233 | request put response hop limit (integer, possible values C<1> to C<64>) | ||
| 234 | |||
| 235 | =item * | ||
| 236 | |||
| 237 | C<metadata-options.http-endpoint> - Enable or disable metadata access | ||
| 238 | on http endpoint (C<enabled> | C<disabled>) | ||
| 239 | |||
| 240 | =item * | ||
| 241 | |||
| 242 | C<monitoring-state> - Indicates whether detailed monitoring is enabled | ||
| 243 | (C<disabled> | C<enabled>). | ||
| 244 | |||
| 245 | =item * | ||
| 246 | |||
| 247 | C<network-interface.addresses.private-ip-address> - The private IPv4 | ||
| 248 | address associated with the network interface. | ||
| 249 | |||
| 250 | =item * | ||
| 251 | |||
| 252 | C<network-interface.addresses.primary> - Specifies whether the IPv4 | ||
| 253 | address of the network interface is the primary private IPv4 address. | ||
| 254 | |||
| 255 | =item * | ||
| 256 | |||
| 257 | C<network-interface.addresses.association.public-ip> - The ID of the | ||
| 258 | association of an Elastic IP address (IPv4) with a network interface. | ||
| 259 | |||
| 260 | =item * | ||
| 261 | |||
| 262 | C<network-interface.addresses.association.ip-owner-id> - The owner ID | ||
| 263 | of the private IPv4 address associated with the network interface. | ||
| 264 | |||
| 265 | =item * | ||
| 266 | |||
| 267 | C<network-interface.association.public-ip> - The address of the Elastic | ||
| 268 | IP address (IPv4) bound to the network interface. | ||
| 269 | |||
| 270 | =item * | ||
| 271 | |||
| 272 | C<network-interface.association.ip-owner-id> - The owner of the Elastic | ||
| 273 | IP address (IPv4) associated with the network interface. | ||
| 274 | |||
| 275 | =item * | ||
| 276 | |||
| 277 | C<network-interface.association.allocation-id> - The allocation ID | ||
| 278 | returned when you allocated the Elastic IP address (IPv4) for your | ||
| 279 | network interface. | ||
| 280 | |||
| 281 | =item * | ||
| 282 | |||
| 283 | C<network-interface.association.association-id> - The association ID | ||
| 284 | returned when the network interface was associated with an IPv4 | ||
| 285 | address. | ||
| 286 | |||
| 287 | =item * | ||
| 288 | |||
| 289 | C<network-interface.attachment.attachment-id> - The ID of the interface | ||
| 290 | attachment. | ||
| 291 | |||
| 292 | =item * | ||
| 293 | |||
| 294 | C<network-interface.attachment.instance-id> - The ID of the instance to | ||
| 295 | which the network interface is attached. | ||
| 296 | |||
| 297 | =item * | ||
| 298 | |||
| 299 | C<network-interface.attachment.instance-owner-id> - The owner ID of the | ||
| 300 | instance to which the network interface is attached. | ||
| 301 | |||
| 302 | =item * | ||
| 303 | |||
| 304 | C<network-interface.attachment.device-index> - The device index to | ||
| 305 | which the network interface is attached. | ||
| 306 | |||
| 307 | =item * | ||
| 308 | |||
| 309 | C<network-interface.attachment.status> - The status of the attachment | ||
| 310 | (C<attaching> | C<attached> | C<detaching> | C<detached>). | ||
| 311 | |||
| 312 | =item * | ||
| 313 | |||
| 314 | C<network-interface.attachment.attach-time> - The time that the network | ||
| 315 | interface was attached to an instance. | ||
| 316 | |||
| 317 | =item * | ||
| 318 | |||
| 319 | C<network-interface.attachment.delete-on-termination> - Specifies | ||
| 320 | whether the attachment is deleted when an instance is terminated. | ||
| 321 | |||
| 322 | =item * | ||
| 323 | |||
| 324 | C<network-interface.availability-zone> - The Availability Zone for the | ||
| 325 | network interface. | ||
| 326 | |||
| 327 | =item * | ||
| 328 | |||
| 329 | C<network-interface.description> - The description of the network | ||
| 330 | interface. | ||
| 331 | |||
| 332 | =item * | ||
| 333 | |||
| 334 | C<network-interface.group-id> - The ID of a security group associated | ||
| 335 | with the network interface. | ||
| 336 | |||
| 337 | =item * | ||
| 338 | |||
| 339 | C<network-interface.group-name> - The name of a security group | ||
| 340 | associated with the network interface. | ||
| 341 | |||
| 342 | =item * | ||
| 343 | |||
| 344 | C<network-interface.ipv6-addresses.ipv6-address> - The IPv6 address | ||
| 345 | associated with the network interface. | ||
| 346 | |||
| 347 | =item * | ||
| 348 | |||
| 349 | C<network-interface.mac-address> - The MAC address of the network | ||
| 350 | interface. | ||
| 351 | |||
| 352 | =item * | ||
| 353 | |||
| 354 | C<network-interface.network-interface-id> - The ID of the network | ||
| 355 | interface. | ||
| 356 | |||
| 357 | =item * | ||
| 358 | |||
| 359 | C<network-interface.owner-id> - The ID of the owner of the network | ||
| 360 | interface. | ||
| 361 | |||
| 362 | =item * | ||
| 363 | |||
| 364 | C<network-interface.private-dns-name> - The private DNS name of the | ||
| 365 | network interface. | ||
| 366 | |||
| 367 | =item * | ||
| 368 | |||
| 369 | C<network-interface.requester-id> - The requester ID for the network | ||
| 370 | interface. | ||
| 371 | |||
| 372 | =item * | ||
| 373 | |||
| 374 | C<network-interface.requester-managed> - Indicates whether the network | ||
| 375 | interface is being managed by Amazon Web Services. | ||
| 376 | |||
| 377 | =item * | ||
| 378 | |||
| 379 | C<network-interface.status> - The status of the network interface | ||
| 380 | (C<available>) | C<in-use>). | ||
| 381 | |||
| 382 | =item * | ||
| 383 | |||
| 384 | C<network-interface.source-dest-check> - Whether the network interface | ||
| 385 | performs source/destination checking. A value of C<true> means that | ||
| 386 | checking is enabled, and C<false> means that checking is disabled. The | ||
| 387 | value must be C<false> for the network interface to perform network | ||
| 388 | address translation (NAT) in your VPC. | ||
| 389 | |||
| 390 | =item * | ||
| 391 | |||
| 392 | C<network-interface.subnet-id> - The ID of the subnet for the network | ||
| 393 | interface. | ||
| 394 | |||
| 395 | =item * | ||
| 396 | |||
| 397 | C<network-interface.vpc-id> - The ID of the VPC for the network | ||
| 398 | interface. | ||
| 399 | |||
| 400 | =item * | ||
| 401 | |||
| 402 | C<outpost-arn> - The Amazon Resource Name (ARN) of the Outpost. | ||
| 403 | |||
| 404 | =item * | ||
| 405 | |||
| 406 | C<owner-id> - The account ID of the instance owner. | ||
| 407 | |||
| 408 | =item * | ||
| 409 | |||
| 410 | C<placement-group-name> - The name of the placement group for the | ||
| 411 | instance. | ||
| 412 | |||
| 413 | =item * | ||
| 414 | |||
| 415 | C<placement-partition-number> - The partition in which the instance is | ||
| 416 | located. | ||
| 417 | |||
| 418 | =item * | ||
| 419 | |||
| 420 | C<platform> - The platform. To list only Windows instances, use | ||
| 421 | C<windows>. | ||
| 422 | |||
| 423 | =item * | ||
| 424 | |||
| 425 | C<private-dns-name> - The private IPv4 DNS name of the instance. | ||
| 426 | |||
| 427 | =item * | ||
| 428 | |||
| 429 | C<private-ip-address> - The private IPv4 address of the instance. | ||
| 430 | |||
| 431 | =item * | ||
| 432 | |||
| 433 | C<product-code> - The product code associated with the AMI used to | ||
| 434 | launch the instance. | ||
| 435 | |||
| 436 | =item * | ||
| 437 | |||
| 438 | C<product-code.type> - The type of product code (C<devpay> | | ||
| 439 | C<marketplace>). | ||
| 440 | |||
| 441 | =item * | ||
| 442 | |||
| 443 | C<ramdisk-id> - The RAM disk ID. | ||
| 444 | |||
| 445 | =item * | ||
| 446 | |||
| 447 | C<reason> - The reason for the current state of the instance (for | ||
| 448 | example, shows "User Initiated [date]" when you stop or terminate the | ||
| 449 | instance). Similar to the state-reason-code filter. | ||
| 450 | |||
| 451 | =item * | ||
| 452 | |||
| 453 | C<requester-id> - The ID of the entity that launched the instance on | ||
| 454 | your behalf (for example, Management Console, Auto Scaling, and so on). | ||
| 455 | |||
| 456 | =item * | ||
| 457 | |||
| 458 | C<reservation-id> - The ID of the instance's reservation. A reservation | ||
| 459 | ID is created any time you launch an instance. A reservation ID has a | ||
| 460 | one-to-one relationship with an instance launch request, but can be | ||
| 461 | associated with more than one instance if you launch multiple instances | ||
| 462 | using the same launch request. For example, if you launch one instance, | ||
| 463 | you get one reservation ID. If you launch ten instances using the same | ||
| 464 | launch request, you also get one reservation ID. | ||
| 465 | |||
| 466 | =item * | ||
| 467 | |||
| 468 | C<root-device-name> - The device name of the root device volume (for | ||
| 469 | example, C</dev/sda1>). | ||
| 470 | |||
| 471 | =item * | ||
| 472 | |||
| 473 | C<root-device-type> - The type of the root device volume (C<ebs> | | ||
| 474 | C<instance-store>). | ||
| 475 | |||
| 476 | =item * | ||
| 477 | |||
| 478 | C<source-dest-check> - Indicates whether the instance performs | ||
| 479 | source/destination checking. A value of C<true> means that checking is | ||
| 480 | enabled, and C<false> means that checking is disabled. The value must | ||
| 481 | be C<false> for the instance to perform network address translation | ||
| 482 | (NAT) in your VPC. | ||
| 483 | |||
| 484 | =item * | ||
| 485 | |||
| 486 | C<spot-instance-request-id> - The ID of the Spot Instance request. | ||
| 487 | |||
| 488 | =item * | ||
| 489 | |||
| 490 | C<state-reason-code> - The reason code for the state change. | ||
| 491 | |||
| 492 | =item * | ||
| 493 | |||
| 494 | C<state-reason-message> - A message that describes the state change. | ||
| 495 | |||
| 496 | =item * | ||
| 497 | |||
| 498 | C<subnet-id> - The ID of the subnet for the instance. | ||
| 499 | |||
| 500 | =item * | ||
| 501 | |||
| 502 | C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to | ||
| 503 | the resource. Use the tag key in the filter name and the tag value as | ||
| 504 | the filter value. For example, to find all resources that have a tag | ||
| 505 | with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for | ||
| 506 | the filter name and C<TeamA> for the filter value. | ||
| 507 | |||
| 508 | =item * | ||
| 509 | |||
| 510 | C<tag-key> - The key of a tag assigned to the resource. Use this filter | ||
| 511 | to find all resources that have a tag with a specific key, regardless | ||
| 512 | of the tag value. | ||
| 513 | |||
| 514 | =item * | ||
| 515 | |||
| 516 | C<tenancy> - The tenancy of an instance (C<dedicated> | C<default> | | ||
| 517 | C<host>). | ||
| 518 | |||
| 519 | =item * | ||
| 520 | |||
| 521 | C<virtualization-type> - The virtualization type of the instance | ||
| 522 | (C<paravirtual> | C<hvm>). | ||
| 523 | |||
| 524 | =item * | ||
| 525 | |||
| 526 | C<vpc-id> - The ID of the VPC that the instance is running in. | ||
| 527 | |||
| 528 | =back | ||
| 529 | |||
| 530 | |||
| 531 | |||
| 532 | |||
| 533 | =head2 InstanceIds => ArrayRef[Str|Undef] | ||
| 534 | |||
| 535 | The instance IDs. | ||
| 536 | |||
| 537 | Default: Describes all your instances. | ||
| 538 | |||
| 539 | |||
| 540 | |||
| 541 | =head2 MaxResults => Int | ||
| 542 | |||
| 543 | The maximum number of results to return in a single call. To retrieve | ||
| 544 | the remaining results, make another call with the returned C<NextToken> | ||
| 545 | value. This value can be between 5 and 1000. You cannot specify this | ||
| 546 | parameter and the instance IDs parameter in the same call. | ||
| 547 | |||
| 548 | |||
| 549 | |||
| 550 | =head2 NextToken => Str | ||
| 551 | |||
| 552 | The token to request the next page of results. | ||
| 553 | |||
| 554 | |||
| 555 | |||
| 556 | |||
| 557 | =head1 SEE ALSO | ||
| 558 | |||
| 559 | This class forms part of L<Paws>, documenting arguments for method DescribeInstances in L<Paws::EC2> | ||
| 560 | |||
| 561 | =head1 BUGS and CONTRIBUTIONS | ||
| 562 | |||
| 563 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 564 | |||
| 565 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 566 | |||
| 567 | =cut | ||
| 568 | |||