Amazon RoboMaker · Schema

WorldGenerationJobSummary

Information about a world generator job.

RoboticsSimulation

Properties

Name Type Description
arn object
template object
createdAt object
status object
worldCount object
succeededWorldCount object
failedWorldCount object
View JSON Schema on GitHub

JSON Schema

amazon-robomaker-openapi-world-generation-job-summary-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-robomaker/refs/heads/main/json-schema/amazon-robomaker-openapi-world-generation-job-summary-schema.json",
  "title": "WorldGenerationJobSummary",
  "description": "Information about a world generator job.",
  "type": "object",
  "properties": {
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the world generator job."
        }
      ]
    },
    "template": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (arn) of the world template."
        }
      ]
    },
    "createdAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreatedAt"
        },
        {
          "description": "The time, in milliseconds since the epoch, when the world generator job was created."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorldGenerationJobStatus"
        },
        {
          "description": "<p>The status of the world generator job:</p> <dl> <dt>Pending</dt> <dd> <p>The world generator job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world generator job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world generator job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world generator job failed. See <code>failureCode</code> for more information. </p> </dd> <dt>PartialFailed</dt> <dd> <p>Some worlds did not generate.</p> </dd> <dt>Canceled</dt> <dd> <p>The world generator job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world generator job is being cancelled.</p> </dd> </dl>"
        }
      ]
    },
    "worldCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorldCount"
        },
        {
          "description": "Information about the world count."
        }
      ]
    },
    "succeededWorldCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The number of worlds that were generated."
        }
      ]
    },
    "failedWorldCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The number of worlds that failed."
        }
      ]
    }
  }
}