DescribeImages#

Description#

Requests the list of available images.

Request Parameters#

  • ExecutableBy.N — Projects in which instances can be launched from an image.

    • Type: Array of strings

    • Valid values: self | all | <project_name>

    • Required: No

  • Filter.N — One or more filters.

    • Type: List of Filter objects

    • Required: No

  • ImageId.N — The image IDs.

    • Type: Array of strings

    • Required: No

  • Owner.N — Owners of the images.

    • Type: Array of strings

    • Valid values: self | k2 | <project_name>

    • Required: No

Supported Filters#

  • description — The description of the image.

  • image-id — The image ID.

  • Name — The name of the image.

  • is-public — A Boolean attribute that indicates whether the image is public.

  • owner-alias — The image owner’s alias (valid values — self, shared, k2).

  • owner-id — The ID of the image owner.

  • platform — The platform (for example, generic, redhat).

  • state — The state of the image (valid values — available, failed, pending).

  • tag:<tag-key> — The key/value a pair of a tag. The tag key is passed in the filter name, while the tag value is used as the filter value.

  • tag-key — The tag key. This filter is used to get all images with the specified tag key and any tag value.

  • type — The type of the image (valid values — backup, regular).

  • virtualization-type — The virtualization type (valid values — hvm | hvm-legacy).

Response Elements#

  • imageSet — Information about the images.

    • Type: List of Image objects

  • requestId — The request ID.

    • Type: String

Examples#

c2-ec2 DescribeImages Owner.1 self ImageId.1 cmi-3CE869E3

c2-ec2 DescribeImages ExecutableBy.1 default@company Filter.1.Name state Filter.1.Value.1 available

c2-ec2 DescribeImages Filter.1.Name tag-key Filter.1.Value.1 "some-key"