[ aws . robomaker ]

create-robot-application

Description

Creates a robot application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-robot-application
--name <value>
[--sources <value>]
--robot-software-suite <value>
[--tags <value>]
[--environment <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the robot application.

--sources (list)

The sources of the robot application.

(structure)

Information about a source configuration.

s3Bucket -> (string)

The Amazon S3 bucket name.

s3Key -> (string)

The s3 object key.

architecture -> (string)

The target processor architecture for the application.

Shorthand Syntax:

s3Bucket=string,s3Key=string,architecture=string ...

JSON Syntax:

[
  {
    "s3Bucket": "string",
    "s3Key": "string",
    "architecture": "X86_64"|"ARM64"|"ARMHF"
  }
  ...
]

--robot-software-suite (structure)

The robot software suite (ROS distribuition) used by the robot application.

name -> (string)

The name of the robot software suite (ROS distribution).

version -> (string)

The version of the robot software suite (ROS distribution).

Shorthand Syntax:

name=string,version=string

JSON Syntax:

{
  "name": "ROS"|"ROS2"|"General",
  "version": "Kinetic"|"Melodic"|"Dashing"|"Foxy"
}

--tags (map)

A map that contains tag keys and tag values that are attached to the robot application.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--environment (structure)

The object that contains that URI of the Docker image that you use for your robot application.

uri -> (string)

The Docker image URI for either your robot or simulation applications.

Shorthand Syntax:

uri=string

JSON Syntax:

{
  "uri": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a robot application

This example creates a robot application.

Command:

aws robomaker create-robot-application --name MyRobotApplication --sources s3Bucket=my-bucket,s3Key=my-robot-application.tar.gz,architecture=X86_64 --robot-software-suite name=ROS,version=Kinetic

Output:

{
  "arn": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551201873931",
  "name": "MyRobotApplication",
  "version": "$LATEST",
  "sources": [
      {
          "s3Bucket": "my-bucket",
          "s3Key": "my-robot-application.tar.gz",
          "architecture": "ARMHF"
      }
  ],
  "robotSoftwareSuite": {
      "name": "ROS",
      "version": "Kinetic"
  },
  "lastUpdatedAt": 1551201873.0,
  "revisionId": "1f3cb539-9239-4841-a656-d3efcffa07e1",
  "tags": {}
}

Output

arn -> (string)

The Amazon Resource Name (ARN) of the robot application.

name -> (string)

The name of the robot application.

version -> (string)

The version of the robot application.

sources -> (list)

The sources of the robot application.

(structure)

Information about a source.

s3Bucket -> (string)

The s3 bucket name.

s3Key -> (string)

The s3 object key.

etag -> (string)

A hash of the object specified by s3Bucket and s3Key .

architecture -> (string)

The taget processor architecture for the application.

robotSoftwareSuite -> (structure)

The robot software suite (ROS distribution) used by the robot application.

name -> (string)

The name of the robot software suite (ROS distribution).

version -> (string)

The version of the robot software suite (ROS distribution).

lastUpdatedAt -> (timestamp)

The time, in milliseconds since the epoch, when the robot application was last updated.

revisionId -> (string)

The revision id of the robot application.

tags -> (map)

The list of all tags added to the robot application.

key -> (string)

value -> (string)

environment -> (structure)

An object that contains the Docker image URI used to a create your robot application.

uri -> (string)

The Docker image URI for either your robot or simulation applications.