Amazon IoT TwinMaker · JSON Structure

Iot Twinmaker Get Workspace Response Structure

GetWorkspaceResponse schema

Type: object Properties: 7 Required: 6
3D VisualizationDigital TwinIndustrial IoTIoT

GetWorkspaceResponse is a JSON Structure definition published by Amazon IoT TwinMaker, describing 7 properties, of which 6 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

workspaceId arn description s3Location role creationDateTime updateDateTime

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-iot-twinmaker/refs/heads/main/json-structure/iot-twinmaker-get-workspace-response-structure.json",
  "name": "GetWorkspaceResponse",
  "description": "GetWorkspaceResponse schema",
  "type": "object",
  "properties": {
    "workspaceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Id"
        },
        {
          "description": "The ID of the workspace."
        }
      ]
    },
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TwinMakerArn"
        },
        {
          "description": "The ARN of the workspace."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The description of the workspace."
        }
      ]
    },
    "s3Location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Location"
        },
        {
          "description": "The ARN of the S3 bucket where resources associated with the workspace are stored."
        }
      ]
    },
    "role": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleArn"
        },
        {
          "description": "The ARN of the execution role associated with the workspace."
        }
      ]
    },
    "creationDateTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time when the workspace was created."
        }
      ]
    },
    "updateDateTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time when the workspace was last updated."
        }
      ]
    }
  },
  "required": [
    "workspaceId",
    "arn",
    "s3Location",
    "role",
    "creationDateTime",
    "updateDateTime"
  ]
}