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.
Get-EC2Image-ImageId <String[]>-Owner <String[]>-ExecutableUser <String[]>-Filter <Filter[]>-Select <String>-PassThru <SwitchParameter>
self
(the sender of the request), or all
(public AMIs). Required? | False |
Position? | 3 |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ExecutableBy, ExecutableUsers |
architecture
- The image architecture (i386
| x86_64
| arm64
).block-device-mapping.delete-on-termination
- A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.block-device-mapping.device-name
- The device name specified in the block device mapping (for example, /dev/sdh
or xvdh
).block-device-mapping.snapshot-id
- The ID of the snapshot used for the EBS volume.block-device-mapping.volume-size
- The volume size of the EBS volume, in GiB.block-device-mapping.volume-type
- The volume type of the EBS volume (gp2
| io1
| io2
| st1
| sc1
| standard
).block-device-mapping.encrypted
- A Boolean that indicates whether the EBS volume is encrypted.description
- The description of the image (provided during image creation).ena-support
- A Boolean that indicates whether enhanced networking with ENA is enabled.hypervisor
- The hypervisor type (ovm
| xen
).image-id
- The ID of the image.image-type
- The image type (machine
| kernel
| ramdisk
).is-public
- A Boolean that indicates whether the image is public.kernel-id
- The kernel ID.manifest-location
- The location of the image manifest.name
- The name of the AMI (provided during image creation).owner-alias
- The owner alias (amazon
| aws-marketplace
). The valid aliases are defined in an Amazon-maintained list. This is not the AWS account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.owner-id
- The AWS account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.platform
- The platform. To only list Windows-based AMIs, use windows
.product-code
- The product code.product-code.type
- The type of the product code (devpay
| marketplace
).ramdisk-id
- The RAM disk ID.root-device-name
- The device name of the root device volume (for example, /dev/sda1
).root-device-type
- The type of the root device volume (ebs
| instance-store
).state
- The state of the image (available
| pending
| failed
).state-reason-code
- The reason code for the state change.state-reason-message
- The message for the state change.sriov-net-support
- A value of simple
indicates that enhanced networking with the Intel 82599 VF interface is enabled.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-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.virtualization-type
- The virtualization type (paravirtual
| hvm
).Required? | False |
Position? | 4 |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Filters |
Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Aliases | ImageIds |
self
, amazon
, and aws-marketplace
. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership. Required? | False |
Position? | 2 |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Owners |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
PS C:\> Get-EC2Image -ImageId ami-12345678
Architecture : x86_64
BlockDeviceMappings : {/dev/xvda}
CreationDate : 2014-10-20T00:56:28.000Z
Description : My image
Hypervisor : xen
ImageId : ami-12345678
ImageLocation : 123456789012/my-image
ImageOwnerAlias :
ImageType : machine
KernelId :
Name : my-image
OwnerId : 123456789012
Platform :
ProductCodes : {}
Public : False
RamdiskId :
RootDeviceName : /dev/xvda
RootDeviceType : ebs
SriovNetSupport : simple
State : available
StateReason :
Tags : {Name}
VirtualizationType : hvmThis example describes the specified AMI.
PS C:\> Get-EC2Image -owner selfThis example describes the AMIs that you own.
PS C:\> Get-EC2Image -Filter @{ Name="platform"; Values="windows" }This example describes the public AMIs that run Microsoft Windows Server.
PS C:\> Get-EC2Image -Region us-west-2This example describes all public AMIs in the 'us-west-2' region.
AWS Tools for PowerShell: 2.x.y.z