Amazon EC2 Image Builder · JSON Structure

Ec2 Image Builder List Images Request Structure

ListImagesRequest schema from EC2 Image Builder

Type: object Properties: 6
Amazon Web ServicesAutomationContainer ImagesEC2Image BuildingVirtual Machine Images

ListImagesRequest is a JSON Structure definition published by Amazon EC2 Image Builder, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

owner filters byName maxResults nextToken includeDeprecated

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-image-builder/refs/heads/main/json-structure/ec2-image-builder-list-images-request-structure.json",
  "name": "ListImagesRequest",
  "description": "ListImagesRequest schema from EC2 Image Builder",
  "type": "object",
  "properties": {
    "owner": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Ownership"
        },
        {
          "description": "The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers."
        }
      ]
    },
    "filters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterList"
        },
        {
          "description": "<p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>name</code> </p> </li> <li> <p> <code>osVersion</code> </p> </li> <li> <p> <code>platform</code> </p> </li> <li> <p> <code>type</code> </p> </li> <li> <p> <code>version</code> </p> </li> </ul>"
        }
      ]
    },
    "byName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Requests a list of images with a specific recipe name."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RestrictedInteger"
        },
        {
          "description": "The maximum items to return in a request."
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaginationToken"
        },
        {
          "description": "A token to specify where to start paginating. This is the NextToken from a previously truncated response."
        }
      ]
    },
    "includeDeprecated": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NullableBoolean"
        },
        {
          "description": "Includes deprecated images in the response list."
        }
      ]
    }
  }
}