ListComponentsRequest

ListComponentsRequest schema from EC2 Image Builder

Amazon Web ServicesAutomationContainer ImagesEC2Image BuildingVirtual Machine Images

Properties

Name Type Description
owner object
filters object
byName object
maxResults object
nextToken object
View JSON Schema on GitHub

JSON Schema

ec2-image-builder-list-components-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-image-builder/refs/heads/main/json-schema/ec2-image-builder-list-components-request-schema.json",
  "title": "ListComponentsRequest",
  "description": "ListComponentsRequest schema from EC2 Image Builder",
  "type": "object",
  "properties": {
    "owner": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Ownership"
        },
        {
          "description": "Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, third party components, or components that other accounts have shared with you."
        }
      ]
    },
    "filters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterList"
        },
        {
          "description": "<p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>description</code> </p> </li> <li> <p> <code>name</code> </p> </li> <li> <p> <code>platform</code> </p> </li> <li> <p> <code>supportedOsVersion</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": "Returns the list of components for the specified 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."
        }
      ]
    }
  }
}