GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PAWS::EC2::DESCRIBEINSTANCES (3)

.ds Aq ’

NAME

Paws::EC2::DescribeInstances - Arguments for method DescribeInstances on Paws::EC2

CONTENTS

DESCRIPTION

This class represents the parameters used for calling the method DescribeInstances on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method DescribeInstances.

You shouln’t make instances of this class. Each attribute should be used as a named argument in the call to DescribeInstances.

As an example:



  $service_obj->DescribeInstances(Att1 => $value1, Att2 => $value2, ...);



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.

ATTRIBUTES

    DryRun => Bool

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    Filters => ArrayRef[Paws::EC2::Filter]

One or more filters.
o architecture - The instance architecture (i386 | x86_64).
o availability-zone - The Availability Zone of the instance.
o block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
o block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
o block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).
o block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
o block-device-mapping.volume-id - The volume ID of the EBS volume.
o client-token - The idempotency token you provided when you launched the instance.
o dns-name - The public DNS name of the instance.
o group-id - The ID of the security group for the instance. EC2-Classic only.
o group-name - The name of the security group for the instance. EC2-Classic only.
o hypervisor - The hypervisor type of the instance (ovm | xen).
o iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
o image-id - The ID of the image used to launch the instance.
o instance-id - The ID of the instance.
o instance-lifecycle - Indicates whether this is a Spot Instance (spot).
o instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
o instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
o instance-type - The type of instance (for example, t2.micro).
o instance.group-id - The ID of the security group for the instance.
o instance.group-name - The name of the security group for the instance.
o ip-address - The public IP address of the instance.
o kernel-id - The kernel ID.
o key-name - The name of the key pair used when the instance was launched.
o launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
o launch-time - The time when the instance was launched.
o monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).
o owner-id - The AWS account ID of the instance owner.
o placement-group-name - The name of the placement group for the instance.
o platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.
o private-dns-name - The private DNS name of the instance.
o private-ip-address - The private IP address of the instance.
o product-code - The product code associated with the AMI used to launch the instance.
o product-code.type - The type of product code (devpay | marketplace).
o ramdisk-id - The RAM disk ID.
o reason - The reason for the current state of the instance (for example, shows User Initiated [date] when you stop or terminate the instance). Similar to the state-reason-code filter.
o requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
o reservation-id - The ID of the instance’s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you’ll get one reservation ID. If you launch ten instances using the same launch request, you’ll also get one reservation ID.
o root-device-name - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).
o root-device-type - The type of root device that the instance uses (ebs | instance-store).
o source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
o spot-instance-request-id - The ID of the Spot Instance request.
o state-reason-code - The reason code for the state change.
o state-reason-message - A message that describes the state change.
o subnet-id - The ID of the subnet for the instance.
o tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag’s key.
o tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter tag-key=Purpose and the filter tag-value=X, you get any resources assigned both the tag key Purpose (regardless of what the tag’s value is), and the tag value X (regardless of what the tag’s key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
o tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
o tenancy - The tenancy of an instance (dedicated | default).
o virtualization-type - The virtualization type of the instance (paravirtual | hvm).
o vpc-id - The ID of the VPC that the instance is running in.
o network-interface.description - The description of the network interface.
o network-interface.subnet-id - The ID of the subnet for the network interface.
o network-interface.vpc-id - The ID of the VPC for the network interface.
o network-interface.network-interface.id - The ID of the network interface.
o network-interface.owner-id - The ID of the owner of the network interface.
o network-interface.availability-zone - The Availability Zone for the network interface.
o network-interface.requester-id - The requester ID for the network interface.
o network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
o network-interface.status - The status of the network interface (available) | in-use).
o network-interface.mac-address - The MAC address of the network interface.
o network-interface-private-dns-name - The private DNS name of the network interface.
o network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
o network-interface.group-id - The ID of a security group associated with the network interface.
o network-interface.group-name - The name of a security group associated with the network interface.
o network-interface.attachment.attachment-id - The ID of the interface attachment.
o network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
o network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
o network-interface.addresses.private-ip-address - The private IP address associated with the network interface.
o network-interface.attachment.device-index - The device index to which the network interface is attached.
o network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
o network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
o network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
o network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.
o network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.
o network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.
o association.public-ip - The address of the Elastic IP address bound to the network interface.
o association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
o association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
o association.association-id - The association ID returned when the network interface was associated with an IP address.

    InstanceIds => ArrayRef[Str]

One or more instance IDs.

Default: Describes all your instances.

    MaxResults => Int

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

    NextToken => Str

The token to request the next page of results.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeInstances in Paws::EC2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PAWS::EC2::DESCRIBEINSTANCES (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.