DescribeImages
GET /?Action=DescribeImages
Description
Describes one or more OMIs you can use.
You can filter the described OMIs using the ImageId.N
, the Owner.N
or the ExecutableBy.N
parameters.
You can also use the Filter.N
parameter to filter the OMIs on the following properties:
-
architecture
: The architecture of the OMI (i386
|x86_64
). -
block-device-mapping.delete-on-termination
: Whether the volume is deleted when terminating the instance. -
block-device-mapping.device-name
: The device name for the volume. -
block-device-mapping.snapshot-id
: The ID of the snapshot used to create the volume. -
block-device-mapping.volume-size
: The size of the volume, in gibibytes (GiB). -
block-device-mapping.volume-type
: The type of volume (standard
|gp2
|io1
). -
description
: The description of the OMI, provided when it was created. -
hypervisor
: The hypervisor type (alwaysxen
). -
image-id
: The ID of the OMI. -
image-type
: The type of OMI (alwaysmachine
for official OMIs). -
is-public
: Whether the OMI has public launch permissions. -
manifest-location
: The location of the OMI manifest. -
name
: The name of the OMI, provided when it was created. -
owner-alias
: The account alias of the owner of the OMI. -
owner-id
: The account ID of the owner of the OMI. -
platform
: The platform. -
product-code.type
: The type of the product code associated with the OMI (Linux/Unix
|Windows
|Linux/Oracle
|Windows 10
). -
root-device-name
: The device name of the root device (for example,/dev/sda1
). -
root-device-type
: The type of root device used by the OMI (alwaysebs
). -
state
: The current state of the OMI (pending
|available
|failed
). -
tag-key
: The key of a tag associated with the resource. -
tag-value
: The value of a tag associated with the resource. -
tag:XXXX
: The value of a tag associated with the resource, whereXXXX
is the key of the tag. -
virtualization-type
: The virtualization type (alwayshvm
).
Note
|
If you exceed the number of identical requests allowed for a configured time period, the |
Body parameter
Required: false
Name: DescribeImagesRequest
Name | Description | Required | Schema | Default | Example |
---|---|---|---|---|---|
ExecutableBy.N |
The account ID of one or more users who have launch permissions for the OMIs. |
false |
string |
||
Filter.N |
One or more filters. Example: |
false |
|||
ImageId.N |
One or more OMI IDs. |
false |
string |
||
Owner.N |
The account ID of one or more owners of OMIs. By default, all the OMIs for which you have launch permissions are described. |
false |
string |
Responses
HTTP Code 200
HTTP Code | Description | Schema |
---|---|---|
200 |
DescribeImagesResult |
Response 200
Name | Description | Required | Schema | Default | Example |
---|---|---|---|---|---|
imagesSet.N |
Information about one or more OMIs. |
false |
|||
requestId |
The ID of the request. |
false |
string |