Amazon WorkSpaces · Schema
WorkspaceImage
Describes a WorkSpace image.
DesktopEnd User ComputingVirtual DesktopDesktop as a Service
Properties
| Name | Type | Description |
|---|---|---|
| ImageId | object | |
| Name | object | |
| Description | object | |
| OperatingSystem | object | |
| State | object | |
| RequiredTenancy | object | |
| ErrorCode | object | |
| ErrorMessage | object | |
| Created | object | |
| OwnerAccountId | object | |
| Updates | object |
JSON Schema
{
"type": "object",
"properties": {
"ImageId": {
"allOf": [
{
"$ref": "#/components/schemas/WorkspaceImageId"
},
{
"description": "The identifier of the image."
}
]
},
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/WorkspaceImageName"
},
{
"description": "The name of the image."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/WorkspaceImageDescription"
},
{
"description": "The description of the image."
}
]
},
"OperatingSystem": {
"allOf": [
{
"$ref": "#/components/schemas/OperatingSystem"
},
{
"description": "The operating system that the image is running. "
}
]
},
"State": {
"allOf": [
{
"$ref": "#/components/schemas/WorkspaceImageState"
},
{
"description": "The status of the image."
}
]
},
"RequiredTenancy": {
"allOf": [
{
"$ref": "#/components/schemas/WorkspaceImageRequiredTenancy"
},
{
"description": "Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to <code>DEDICATED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html\">Bring Your Own Windows Desktop Images</a>."
}
]
},
"ErrorCode": {
"allOf": [
{
"$ref": "#/components/schemas/WorkspaceImageErrorCode"
},
{
"description": "The error code that is returned for the image."
}
]
},
"ErrorMessage": {
"allOf": [
{
"$ref": "#/components/schemas/Description"
},
{
"description": "The text of the error message that is returned for the image."
}
]
},
"Created": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image."
}
]
},
"OwnerAccountId": {
"allOf": [
{
"$ref": "#/components/schemas/AwsAccount"
},
{
"description": "The identifier of the Amazon Web Services account that owns the image."
}
]
},
"Updates": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateResult"
},
{
"description": "The updates (if any) that are available for the specified image."
}
]
}
},
"description": "Describes a WorkSpace image.",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "WorkspaceImage",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-schema/workspaces-workspace-image-schema.json"
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/workspaces-workspace-image"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.