AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the DescribeInstances operation against Amazon Elastic Compute Cloud.

Syntax

Get-EC2Instance
-InstanceId <Object[]>
-Filter <Filter[]>

Description

Returns information about instances that you own. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results. Recently terminated instances might appear in the returned results.This interval is usually less than one hour.

Parameters

-Filter <Filter[]>
A set of filters used to match system-defined properties and user-defined tags associated with the specified instances.Available filters:
  • architecture - The instance architecture (i386 | x86_64).
  • association.public-ip - The address of the Elastic IP address bound to the network interface.
  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
  • association.association-id - The association ID returned when the network interface was associated with an IP address.
  • availability-zone - The Availability Zone of the instance.
  • block-device-mapping.attach-time - The attach time for an Amazon EBS volume mapped to the instance.
  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.
  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
  • block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached).
  • block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.
  • client-token - The idempotency token you provided when you launched the instance.
  • dns-name - The public DNS name of the instance.
  • group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use group-name instead.
  • group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use group-id instead.
  • hypervisor - The hypervisor type of the instance (ovm | xen).
  • image-id - The ID of the image used to launch the instance.
  • instance-id - The ID of the instance.
  • instance-lifecycle - Indicates whether this is a Spot Instance (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-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
  • instance-type - The type of instance (for example, m1.small).
  • instance.group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use instance.group-name instead.
  • instance.group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use instance.group-id instead.
  • ip-address - The public IP address of the instance.
  • kernel-id - The kernel ID.
  • key-name - The name of the key pair used when the instance was launched.
  • 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-time - The time when the instance was launched.
  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).
  • network-interface.description - The description of the network interface.
  • network-interface.subnet-id - The ID of the subnet for the network interface.
  • network-interface.vpc-id - The ID of the VPC for the network interface.
  • network-interface.network-interface-id - The ID of the network interface.
  • network-interface.owner-id - The ID of the owner of the network interface.
  • network-interface.availability-zone - The Availability Zone for the network interface.
  • network-interface.requester-id - The requester ID for the network interface.
  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
  • network-interface.status - The status of the network interface (available) | in-use).
  • network-interface.mac-address - The MAC address of the network interface.
  • network-interface-private-dns-name - The private DNS name of the network interface.
  • network-interface.source-destination-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.group-id - The ID of a security group associated with the network interface.
  • network-interface.group-name - The name of a security group associated with the network interface.
  • network-interface.attachment.attachment-id - The ID of the interface attachment.
  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.
  • network-interface.attachment.device-index - The device index to which the network interface is attached.
  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.
  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.
  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.
  • owner-id - The AWS account ID of the instance owner.
  • placement-group-name - The name of the placement group for the instance.
  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.
  • private-dns-name - The private DNS name of the instance.
  • private-ip-address - The private IP address of the instance.
  • product-code - The product code associated with the AMI used to launch the instance.
  • product-code.type - The type of product code (devpay | marketplace).
  • ramdisk-id - The RAM disk 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.
  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
  • 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.
  • root-device-name - The name of the root device for the instance (for example, /dev/sda1).
  • root-device-type - The type of root device that the instance uses (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.
  • spot-instance-request-id - The ID of the Spot Instance request.
  • state-reason-code - The reason code for the state change.
  • state-reason-message - A message that describes the state change.
  • subnet-id - The ID of the subnet for the instance.
  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.
  • 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-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).
  • vpc-id - The ID of the VPC that the instance is running in.
Required?False
Position?2
Accept pipeline input?False
-InstanceId <Object[]>
Identifies the set of instances to return. You can supply a collection of string instance ids, or a collection of Amazon.EC2.Model.Instance objects. If not specified, instances for all reservations in the region the cmdlet is invoked against are returned.
Required?False
Position?1
Accept pipeline input?True (ByValue, )

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

System.Object[]
You can pipe a Object[] object to this cmdlet for the InstanceId parameter.

Outputs

This cmdlet returns 0 or more Reservation instances. The service response (type Amazon.EC2.Model.DescribeInstancesResponse) is added to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> (Get-EC2Instance -InstanceId i-12345678).Instances

AmiLaunchIndex : 0
Architecture : x86_64
BlockDeviceMappings : {/dev/sda1}
ClientToken : TleEy1448154045270
EbsOptimized : False
Hypervisor : xen
IamInstanceProfile : Amazon.EC2.Model.IamInstanceProfile
ImageId : ami-12345678
InstanceId : i-12345678
InstanceLifecycle :
InstanceType : t2.micro
KernelId :
KeyName : my-key-pair
LaunchTime : 12/4/2015 4:44:40 PM
Monitoring : Amazon.EC2.Model.Monitoring
NetworkInterfaces : {ip-10-0-2-172.us-west-2.compute.internal}
Placement : Amazon.EC2.Model.Placement
Platform : Windows
PrivateDnsName : ip-10-0-2-172.us-west-2.compute.internal
PrivateIpAddress : 10.0.2.172
ProductCodes : {}
PublicDnsName :
PublicIpAddress :
RamdiskId :
RootDeviceName : /dev/sda1
RootDeviceType : ebs
SecurityGroups : {default}
SourceDestCheck : True
SpotInstanceRequestId :
SriovNetSupport :
State : Amazon.EC2.Model.InstanceState
StateReason :
StateTransitionReason :
SubnetId : subnet-12345678
Tags : {Name}
VirtualizationType : hvm
VpcId : vpc-12345678
This example describes the specified instance.

Example 2

PS C:\> Get-EC2Instance

GroupNames : {}
Groups : {}
Instances : {}
OwnerId : 123456789012
RequesterId : 226008221399
ReservationId : r-c5df370c

GroupNames : {}
Groups : {}
Instances : {}
OwnerId : 123456789012
RequesterId : 854251627541
ReservationId : r-63e65bab
...
This example describes all your instances in the current region, grouped by reservation. To see the instance details expand the Instances collection within each reservation object.

Supported Version

AWS Tools for PowerShell: 2.x.y.z