Amazon RoboMaker · JSON Structure

Amazon Robomaker Openapi Describe Simulation Job Batch Response Structure

DescribeSimulationJobBatchResponse schema from openapi

Type: object Properties: 12
RoboticsSimulation

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

Properties

arn status lastUpdatedAt createdAt clientRequestToken batchPolicy failureCode failureReason failedRequests pendingRequests createdRequests 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-robomaker/refs/heads/main/json-structure/amazon-robomaker-openapi-describe-simulation-job-batch-response-structure.json",
  "description": "DescribeSimulationJobBatchResponse schema from openapi",
  "type": "object",
  "properties": {
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the batch."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SimulationJobBatchStatus"
        },
        {
          "description": "<p>The status of the batch.</p> <dl> <dt>Pending</dt> <dd> <p>The simulation job batch request is pending.</p> </dd> <dt>InProgress</dt> <dd> <p>The simulation job batch is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like <code>InternalServiceError</code>). See <code>failureCode</code> and <code>failureReason</code> for more information.</p> </dd> <dt>Completed</dt> <dd> <p>The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to <code>InternalServiceError</code> and (2) when all created simulation jobs have reached a terminal state (for example, <code>Completed</code> or <code>Failed</code>). </p> </dd> <dt>Canceled</dt> <dd> <p>The simulation batch job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The simulation batch job is being cancelled.</p> </dd> <dt>Completing</dt> <dd> <p>The simulation batch job is completing.</p> </dd> <dt>TimingOut</dt> <dd> <p>The simulation job batch is timing out.</p> <p>If a batch timing out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), the batch status will be <code>Failed</code>. If there are no such failing request, the batch status will be <code>TimedOut</code>. </p> </dd> <dt>TimedOut</dt> <dd> <p>The simulation batch job timed out.</p> </dd> </dl>"
        }
      ]
    },
    "lastUpdatedAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LastUpdatedAt"
        },
        {
          "description": "The time, in milliseconds since the epoch, when the simulation job batch was last updated."
        }
      ]
    },
    "createdAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreatedAt"
        },
        {
          "description": "The time, in milliseconds since the epoch, when the simulation job batch was created."
        }
      ]
    },
    "clientRequestToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientRequestToken"
        },
        {
          "description": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request."
        }
      ]
    },
    "batchPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchPolicy"
        },
        {
          "description": "The batch policy."
        }
      ]
    },
    "failureCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SimulationJobBatchErrorCode"
        },
        {
          "description": "The failure code of the simulation job batch."
        }
      ]
    },
    "failureReason": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenericString"
        },
        {
          "description": "The reason the simulation job batch failed."
        }
      ]
    },
    "failedRequests": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FailedCreateSimulationJobRequests"
        },
        {
          "description": "A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID. "
        }
      ]
    },
    "pendingRequests": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateSimulationJobRequests"
        },
        {
          "description": "A list of pending simulation job requests. These requests have not yet been created into simulation jobs."
        }
      ]
    },
    "createdRequests": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SimulationJobSummaries"
        },
        {
          "description": "A list of created simulation job summaries."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "A map that contains tag keys and tag values that are attached to the simulation job batch."
        }
      ]
    }
  },
  "name": "DescribeSimulationJobBatchResponse"
}