Amazon RoboMaker · JSON Structure

Amazon Robomaker Openapi Data Source Structure

Information about a data source.

Type: object Properties: 5
RoboticsSimulation

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

Properties

name s3Bucket s3Keys type destination

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-data-source-structure.json",
  "description": "Information about a data source.",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the data source."
        }
      ]
    },
    "s3Bucket": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Bucket"
        },
        {
          "description": "The S3 bucket where the data files are located."
        }
      ]
    },
    "s3Keys": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3KeyOutputs"
        },
        {
          "description": "The list of S3 keys identifying the data source files."
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataSourceType"
        },
        {
          "description": "<p>The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.</p> <p>If you don't specify a field, the default value is <code>File</code>.</p>"
        }
      ]
    },
    "destination": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Path"
        },
        {
          "description": "<p>The location where your files are mounted in the container image.</p> <p>If you've specified the <code>type</code> of the data source as an <code>Archive</code>, you must provide an Amazon S3 object key to your archive. The object key must point to either a <code>.zip</code> or <code>.tar.gz</code> file.</p> <p>If you've specified the <code>type</code> of the data source as a <code>Prefix</code>, you provide the Amazon S3 prefix that points to the files that you are using for your data source.</p> <p>If you've specified the <code>type</code> of the data source as a <code>File</code>, you provide the Amazon S3 path to the file that you're using as your data source.</p>"
        }
      ]
    }
  },
  "name": "DataSource"
}