Amazon RoboMaker · JSON Structure

Amazon Robomaker Openapi World Failure Structure

Information about a failed world.

Type: object Properties: 3
RoboticsSimulation

WorldFailure is a JSON Structure definition published by Amazon RoboMaker, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

failureCode sampleFailureReason failureCount

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-robomaker/refs/heads/main/json-structure/amazon-robomaker-openapi-world-failure-structure.json",
  "description": "Information about a failed world.",
  "type": "object",
  "properties": {
    "failureCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorldGenerationJobErrorCode"
        },
        {
          "description": "<p>The failure code of the world export job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>LimitExceeded</dt> <dd> <p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p> </dd> <dt>ResourceNotFound</dt> <dd> <p>The specified resource could not be found. </p> </dd> <dt>RequestThrottled</dt> <dd> <p>The request was throttled.</p> </dd> <dt>InvalidInput</dt> <dd> <p>An input parameter in the request is not valid.</p> </dd> </dl>"
        }
      ]
    },
    "sampleFailureReason": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "The sample reason why the world failed. World errors are aggregated. A sample is used as the <code>sampleFailureReason</code>. "
        }
      ]
    },
    "failureCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The number of failed worlds."
        }
      ]
    }
  },
  "name": "WorldFailure"
}