Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
Type: objectProperties: 3Required: 3
RoboticsSimulation
UploadConfiguration is a JSON Structure definition published by Amazon RoboMaker, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$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-upload-configuration-structure.json",
"description": "Provides upload configuration information. Files are uploaded from the simulation job to a location you specify. ",
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/Name"
},
{
"description": "<p>A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path. </p> <p> For example, if your simulation output location is <code>s3://my-bucket</code> and your upload configuration name is <code>robot-test</code>, your files will be uploaded to <code>s3://my-bucket/<simid>/<runid>/robot-test</code>. </p>"
}
]
},
"path": {
"allOf": [
{
"$ref": "#/components/schemas/Path"
},
{
"description": " Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of <code>**</code> as a <i>super asterisk</i>. For example, specifying <code>/var/log/**.log</code> causes all .log files in the <code>/var/log</code> directory tree to be collected. For more examples, see <a href=\"https://github.com/gobwas/glob\">Glob Library</a>. "
}
]
},
"uploadBehavior": {
"allOf": [
{
"$ref": "#/components/schemas/UploadBehavior"
},
{
"description": "<p>Specifies when to upload the files:</p> <dl> <dt>UPLOAD_ON_TERMINATE</dt> <dd> <p>Matching files are uploaded once the simulation enters the <code>TERMINATING</code> state. Matching files are not uploaded until all of your code (including tools) have stopped. </p> <p>If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.</p> </dd> <dt>UPLOAD_ROLLING_AUTO_REMOVE</dt> <dd> <p>Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped. </p> </dd> </dl>"
}
]
}
},
"required": [
"name",
"path",
"uploadBehavior"
],
"name": "UploadConfiguration"
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.