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[]>
self
(the sender of the request), or all
(public AMIs). Required? | False |
Position? | 3 |
Accept pipeline input? | False |
architecture
- The image architecture (i386
| x86_64
).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
| st1
| sc1
| standard
).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
- String value from an Amazon-maintained list (amazon
| aws-marketplace
| microsoft
) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.owner-id
- The AWS account ID of the image owner.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? | False |
Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
self
(owner is the sender of the request), or an AWS owner alias (valid values are amazon
| aws-marketplace
| microsoft
). Omitting this option returns all images for which you have launch permissions, regardless of ownership. Required? | False |
Position? | 2 |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
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 |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
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 |
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