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 shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeInstances.
my $ec2 = Paws->service('EC2'); my $DescribeInstancesResult = $ec2->DescribeInstances( DryRun => 1, # OPTIONAL Filters => [ { Name => 'MyString', # OPTIONAL Values => [ 'MyString', ... # OPTIONAL ], # OPTIONAL }, ... ], # OPTIONAL InstanceIds => [ 'MyString', ... # OPTIONAL ], # OPTIONAL MaxResults => 1, # OPTIONAL NextToken => 'MyString', # OPTIONAL ); # Results: my $NextToken = $DescribeInstancesResult->NextToken; my $Reservations = $DescribeInstancesResult->Reservations; # Returns a L<Paws::EC2::DescribeInstancesResult> object.
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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeInstances
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.
DryRunOperation
UnauthorizedOperation
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
affinity
default
host
architecture - The instance architecture (i386 | x86_64 | arm64).
architecture
i386
x86_64
arm64
availability-zone - The Availability Zone of the instance.
availability-zone
block-device-mapping.attach-time - The attach time for an 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 EBS volume is deleted on instance termination.
block-device-mapping.delete-on-termination
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.device-name
/dev/sdh
xvdh
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.status
attaching
attached
detaching
detached
block-device-mapping.volume-id - The volume ID of the 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
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
hibernation-options.configured
true
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
host-id
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 or a Scheduled Instance (spot | scheduled).
instance-lifecycle
spot
scheduled
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes 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 IPv4 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 detailed monitoring is enabled (disabled | enabled).
monitoring-state
disabled
enabled
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.private-ip-address
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.primary
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.public-ip
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.ip-owner-id
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.public-ip
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.ip-owner-id
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.allocation-id
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.association-id
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.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.availability-zone - The Availability Zone for the network interface.
network-interface.availability-zone
network-interface.description - The description of the network interface.
network-interface.description
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.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address
network-interface.mac-address - The MAC address of the network interface.
network-interface.mac-address
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.private-dns-name - The private DNS name of the network interface.
network-interface.private-dns-name
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.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that 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
false
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
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
placement-partition-number - The partition in which the instance is located.
placement-partition-number
platform - The platform. To list only Windows instances, use windows.
platform
windows
private-dns-name - The private IPv4 DNS name of the instance.
private-dns-name
private-ip-address - The private IPv4 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 get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
reservation-id
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-name
/dev/sda1
root-device-type - The type of the root device volume (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 that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
source-dest-check
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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag
Owner
TeamA
tag:Owner
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tag-key
tenancy - The tenancy of an instance (dedicated | default | host).
tenancy
dedicated
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
The instance IDs.
Default: Describes all your instances.
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
NextToken
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.