Amazon IoT TwinMaker · JSON Structure

Iot Twinmaker Create Workspace Request Structure

CreateWorkspaceRequest schema

Type: object Properties: 4 Required: 2
3D VisualizationDigital TwinIndustrial IoTIoT

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

Properties

description s3Location role tags

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-create-workspace-request-structure.json",
  "name": "CreateWorkspaceRequest",
  "description": "CreateWorkspaceRequest schema",
  "type": "object",
  "properties": {
    "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."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "Metadata that you can use to manage the workspace"
        }
      ]
    }
  },
  "required": [
    "s3Location",
    "role"
  ]
}