Paws::EC2::DescribeInstances - Arguments for method DescribeInstances on Paws::EC2
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.
One or more filters.
architecture - The instance architecture (i386 | x86_64).
architecture
i386
x86_64
availability-zone - The Availability Zone of the instance.
availability-zone
block-device-mapping.attach-time - The attach time for an Amazon EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.attach-time
2010-09-15T17:15:20.000Z
block-device-mapping.delete-on-termination - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.delete-on-termination
block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh or xvdh).
block-device-mapping.device-name
/dev/sdh
xvdh
block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached).
block-device-mapping.status
attaching
attached
detaching
detached
block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.
block-device-mapping.volume-id
client-token - The idempotency token you provided when you launched the instance.
client-token
dns-name - The public DNS name of the instance.
dns-name
group-id - The ID of the security group for the instance. EC2-Classic only.
group-id
group-name - The name of the security group for the instance. EC2-Classic only.
group-name
hypervisor - The hypervisor type of the instance (ovm | xen).
hypervisor
ovm
xen
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.arn
image-id - The ID of the image used to launch the instance.
image-id
instance-id - The ID of the instance.
instance-id
instance-lifecycle - Indicates whether this is a Spot Instance (spot).
instance-lifecycle
spot
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).
instance-state-code
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-state-name
pending
running
shutting-down
terminated
stopping
stopped
instance-type - The type of instance (for example, t2.micro).
instance-type
t2.micro
instance.group-id - The ID of the security group for the instance.
instance.group-id
instance.group-name - The name of the security group for the instance.
instance.group-name
ip-address - The public IP address of the instance.
ip-address
kernel-id - The kernel ID.
kernel-id
key-name - The name of the key pair used when the instance was launched.
key-name
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).
launch-index
launch-time - The time when the instance was launched.
launch-time
monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).
monitoring-state
disabled
enabled
owner-id - The AWS account ID of the instance owner.
owner-id
placement-group-name - The name of the placement group for the instance.
placement-group-name
platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.
platform
windows
private-dns-name - The private DNS name of the instance.
private-dns-name
private-ip-address - The private IP address of the instance.
private-ip-address
product-code - The product code associated with the AMI used to launch the instance.
product-code
product-code.type - The type of product code (devpay | marketplace).
product-code.type
devpay
marketplace
ramdisk-id - The RAM disk ID.
ramdisk-id
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.
reason
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
requester-id
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.
reservation-id
root-device-name - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).
root-device-name
/dev/sda1
/dev/xvda
root-device-type - The type of root device that the instance uses (ebs | instance-store).
root-device-type
ebs
instance-store
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.
source-dest-check
true
false
spot-instance-request-id - The ID of the Spot Instance request.
spot-instance-request-id
state-reason-code - The reason code for the state change.
state-reason-code
state-reason-message - A message that describes the state change.
state-reason-message
subnet-id - The ID of the subnet for the instance.
subnet-id
tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.
tag
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.
tag-key
tag-value
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
tenancy - The tenancy of an instance (dedicated | default).
tenancy
dedicated
default
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
virtualization-type
paravirtual
hvm
vpc-id - The ID of the VPC that the instance is running in.
vpc-id
network-interface.description - The description of the network interface.
network-interface.description
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.subnet-id
network-interface.vpc-id - The ID of the VPC for the network interface.
network-interface.vpc-id
network-interface.network-interface.id - The ID of the network interface.
network-interface.network-interface.id
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.owner-id
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.availability-zone
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-id
network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
network-interface.requester-managed
network-interface.status - The status of the network interface (available) | in-use).
network-interface.status
available
in-use
network-interface.mac-address - The MAC address of the network interface.
network-interface.mac-address
network-interface-private-dns-name - The private DNS name of the network interface.
network-interface-private-dns-name
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.
network-interface.source-dest-check
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-id
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.group-name
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.attachment-id
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-id
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id
network-interface.addresses.private-ip-address - The private IP address associated with the network interface.
network-interface.addresses.private-ip-address
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.device-index
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.status
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.attach-time
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.delete-on-termination
network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.
network-interface.addresses.primary
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.
network-interface.addresses.association.public-ip
network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.
network-interface.addresses.association.ip-owner-id
association.public-ip - The address of the Elastic IP address bound to the network interface.
association.public-ip
association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
association.ip-owner-id
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
association.allocation-id
association.association-id - The association ID returned when the network interface was associated with an IP address.
association.association-id
One or more instance IDs.
Default: Describes all your instances.
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
MaxResults
The token to request the next page of results.
This class forms part of Paws, documenting arguments for method DescribeInstances in Paws::EC2
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
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.