Amazon RoboMaker · JSON Structure

Amazon Robomaker Openapi Describe Simulation Job Response Structure

DescribeSimulationJobResponse schema from openapi

Type: object Properties: 21
RoboticsSimulation

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

Properties

arn name status lastStartedAt lastUpdatedAt failureBehavior failureCode failureReason clientRequestToken outputLocation loggingConfig maxJobDurationInSeconds simulationTimeMillis iamRole robotApplications simulationApplications dataSources tags vpcConfig networkInterface compute

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-describe-simulation-job-response-structure.json",
  "description": "DescribeSimulationJobResponse schema from openapi",
  "type": "object",
  "properties": {
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the simulation job."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the simulation job."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SimulationJobStatus"
        },
        {
          "description": "The status of the simulation job."
        }
      ]
    },
    "lastStartedAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LastStartedAt"
        },
        {
          "description": "The time, in milliseconds since the epoch, when the simulation job was last started."
        }
      ]
    },
    "lastUpdatedAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LastUpdatedAt"
        },
        {
          "description": "The time, in milliseconds since the epoch, when the simulation job was last updated."
        }
      ]
    },
    "failureBehavior": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FailureBehavior"
        },
        {
          "description": "The failure behavior for the simulation job."
        }
      ]
    },
    "failureCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SimulationJobErrorCode"
        },
        {
          "description": "<p>The failure code of the simulation job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>RobotApplicationCrash</dt> <dd> <p>Robot application exited abnormally.</p> </dd> <dt>SimulationApplicationCrash</dt> <dd> <p> Simulation application exited abnormally.</p> </dd> <dt>BadPermissionsRobotApplication</dt> <dd> <p>Robot application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsSimulationApplication</dt> <dd> <p>Simulation application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsS3Output</dt> <dd> <p>Unable to publish outputs to customer-provided S3 bucket.</p> </dd> <dt>BadPermissionsCloudwatchLogs</dt> <dd> <p>Unable to publish logs to customer-provided CloudWatch Logs resource.</p> </dd> <dt>SubnetIpLimitExceeded</dt> <dd> <p>Subnet IP limit exceeded.</p> </dd> <dt>ENILimitExceeded</dt> <dd> <p>ENI limit exceeded.</p> </dd> <dt>BadPermissionsUserCredentials</dt> <dd> <p>Unable to use the Role provided.</p> </dd> <dt>InvalidBundleRobotApplication</dt> <dd> <p>Robot bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>InvalidBundleSimulationApplication</dt> <dd> <p>Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>RobotApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for RobotApplication does not match value during version creation.</p> </dd> <dt>SimulationApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for SimulationApplication does not match value during version creation.</p> </dd> </dl>"
        }
      ]
    },
    "failureReason": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "Details about why the simulation job failed. For more information about troubleshooting, see <a href=\"https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html\">Troubleshooting</a>."
        }
      ]
    },
    "clientRequestToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientRequestToken"
        },
        {
          "description": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request."
        }
      ]
    },
    "outputLocation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OutputLocation"
        },
        {
          "description": "Location for output files generated by the simulation job."
        }
      ]
    },
    "loggingConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoggingConfig"
        },
        {
          "description": "The logging configuration."
        }
      ]
    },
    "maxJobDurationInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobDuration"
        },
        {
          "description": "The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less."
        }
      ]
    },
    "simulationTimeMillis": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SimulationTimeMillis"
        },
        {
          "description": "The simulation job execution duration in milliseconds."
        }
      ]
    },
    "iamRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IamRole"
        },
        {
          "description": "The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf."
        }
      ]
    },
    "robotApplications": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RobotApplicationConfigs"
        },
        {
          "description": "A list of robot applications."
        }
      ]
    },
    "simulationApplications": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SimulationApplicationConfigs"
        },
        {
          "description": "A list of simulation applications."
        }
      ]
    },
    "dataSources": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataSources"
        },
        {
          "description": "The data sources for the simulation job."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "The list of all tags added to the specified simulation job."
        }
      ]
    },
    "vpcConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VPCConfigResponse"
        },
        {
          "description": "The VPC configuration."
        }
      ]
    },
    "networkInterface": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NetworkInterface"
        },
        {
          "description": "The network interface information for the simulation job."
        }
      ]
    },
    "compute": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComputeResponse"
        },
        {
          "description": "Compute information for the simulation job."
        }
      ]
    }
  },
  "name": "DescribeSimulationJobResponse"
}