Class CreateSimulationJobCommandProtected

Creates a simulation job.

After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.

Example

Use a bare-bones client and the command you need to make an API call.

import { RoboMakerClient, CreateSimulationJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import
// const { RoboMakerClient, CreateSimulationJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import
const client = new RoboMakerClient(config);
const input = { // CreateSimulationJobRequest
  clientRequestToken: "STRING_VALUE",
  outputLocation: { // OutputLocation
    s3Bucket: "STRING_VALUE",
    s3Prefix: "STRING_VALUE",
  },
  loggingConfig: { // LoggingConfig
    recordAllRosTopics: true || false,
  },
  maxJobDurationInSeconds: Number("long"), // required
  iamRole: "STRING_VALUE", // required
  failureBehavior: "STRING_VALUE",
  robotApplications: [ // RobotApplicationConfigs
    { // RobotApplicationConfig
      application: "STRING_VALUE", // required
      applicationVersion: "STRING_VALUE",
      launchConfig: { // LaunchConfig
        packageName: "STRING_VALUE",
        launchFile: "STRING_VALUE",
        environmentVariables: { // EnvironmentVariableMap
          "<keys>": "STRING_VALUE",
        },
        portForwardingConfig: { // PortForwardingConfig
          portMappings: [ // PortMappingList
            { // PortMapping
              jobPort: Number("int"), // required
              applicationPort: Number("int"), // required
              enableOnPublicIp: true || false,
            },
          ],
        },
        streamUI: true || false,
        command: [ // CommandList
          "STRING_VALUE",
        ],
      },
      uploadConfigurations: [ // UploadConfigurations
        { // UploadConfiguration
          name: "STRING_VALUE", // required
          path: "STRING_VALUE", // required
          uploadBehavior: "STRING_VALUE", // required
        },
      ],
      useDefaultUploadConfigurations: true || false,
      tools: [ // Tools
        { // Tool
          streamUI: true || false,
          name: "STRING_VALUE", // required
          command: "STRING_VALUE", // required
          streamOutputToCloudWatch: true || false,
          exitBehavior: "STRING_VALUE",
        },
      ],
      useDefaultTools: true || false,
    },
  ],
  simulationApplications: [ // SimulationApplicationConfigs
    { // SimulationApplicationConfig
      application: "STRING_VALUE", // required
      applicationVersion: "STRING_VALUE",
      launchConfig: {
        packageName: "STRING_VALUE",
        launchFile: "STRING_VALUE",
        environmentVariables: {
          "<keys>": "STRING_VALUE",
        },
        portForwardingConfig: {
          portMappings: [
            {
              jobPort: Number("int"), // required
              applicationPort: Number("int"), // required
              enableOnPublicIp: true || false,
            },
          ],
        },
        streamUI: true || false,
        command: [
          "STRING_VALUE",
        ],
      },
      uploadConfigurations: [
        {
          name: "STRING_VALUE", // required
          path: "STRING_VALUE", // required
          uploadBehavior: "STRING_VALUE", // required
        },
      ],
      worldConfigs: [ // WorldConfigs
        { // WorldConfig
          world: "STRING_VALUE",
        },
      ],
      useDefaultUploadConfigurations: true || false,
      tools: [
        {
          streamUI: true || false,
          name: "STRING_VALUE", // required
          command: "STRING_VALUE", // required
          streamOutputToCloudWatch: true || false,
          exitBehavior: "STRING_VALUE",
        },
      ],
      useDefaultTools: true || false,
    },
  ],
  dataSources: [ // DataSourceConfigs
    { // DataSourceConfig
      name: "STRING_VALUE", // required
      s3Bucket: "STRING_VALUE", // required
      s3Keys: [ // S3KeysOrPrefixes // required
        "STRING_VALUE",
      ],
      type: "STRING_VALUE",
      destination: "STRING_VALUE",
    },
  ],
  tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
  vpcConfig: { // VPCConfig
    subnets: [ // Subnets // required
      "STRING_VALUE",
    ],
    securityGroups: [ // SecurityGroups
      "STRING_VALUE",
    ],
    assignPublicIp: true || false,
  },
  compute: { // Compute
    simulationUnitLimit: Number("int"),
    computeType: "STRING_VALUE",
    gpuUnitLimit: Number("int"),
  },
};
const command = new CreateSimulationJobCommand(input);
const response = await client.send(command);
// { // CreateSimulationJobResponse
//   arn: "STRING_VALUE",
//   status: "STRING_VALUE",
//   lastStartedAt: new Date("TIMESTAMP"),
//   lastUpdatedAt: new Date("TIMESTAMP"),
//   failureBehavior: "STRING_VALUE",
//   failureCode: "STRING_VALUE",
//   clientRequestToken: "STRING_VALUE",
//   outputLocation: { // OutputLocation
//     s3Bucket: "STRING_VALUE",
//     s3Prefix: "STRING_VALUE",
//   },
//   loggingConfig: { // LoggingConfig
//     recordAllRosTopics: true || false,
//   },
//   maxJobDurationInSeconds: Number("long"),
//   simulationTimeMillis: Number("long"),
//   iamRole: "STRING_VALUE",
//   robotApplications: [ // RobotApplicationConfigs
//     { // RobotApplicationConfig
//       application: "STRING_VALUE", // required
//       applicationVersion: "STRING_VALUE",
//       launchConfig: { // LaunchConfig
//         packageName: "STRING_VALUE",
//         launchFile: "STRING_VALUE",
//         environmentVariables: { // EnvironmentVariableMap
//           "<keys>": "STRING_VALUE",
//         },
//         portForwardingConfig: { // PortForwardingConfig
//           portMappings: [ // PortMappingList
//             { // PortMapping
//               jobPort: Number("int"), // required
//               applicationPort: Number("int"), // required
//               enableOnPublicIp: true || false,
//             },
//           ],
//         },
//         streamUI: true || false,
//         command: [ // CommandList
//           "STRING_VALUE",
//         ],
//       },
//       uploadConfigurations: [ // UploadConfigurations
//         { // UploadConfiguration
//           name: "STRING_VALUE", // required
//           path: "STRING_VALUE", // required
//           uploadBehavior: "STRING_VALUE", // required
//         },
//       ],
//       useDefaultUploadConfigurations: true || false,
//       tools: [ // Tools
//         { // Tool
//           streamUI: true || false,
//           name: "STRING_VALUE", // required
//           command: "STRING_VALUE", // required
//           streamOutputToCloudWatch: true || false,
//           exitBehavior: "STRING_VALUE",
//         },
//       ],
//       useDefaultTools: true || false,
//     },
//   ],
//   simulationApplications: [ // SimulationApplicationConfigs
//     { // SimulationApplicationConfig
//       application: "STRING_VALUE", // required
//       applicationVersion: "STRING_VALUE",
//       launchConfig: {
//         packageName: "STRING_VALUE",
//         launchFile: "STRING_VALUE",
//         environmentVariables: {
//           "<keys>": "STRING_VALUE",
//         },
//         portForwardingConfig: {
//           portMappings: [
//             {
//               jobPort: Number("int"), // required
//               applicationPort: Number("int"), // required
//               enableOnPublicIp: true || false,
//             },
//           ],
//         },
//         streamUI: true || false,
//         command: [
//           "STRING_VALUE",
//         ],
//       },
//       uploadConfigurations: [
//         {
//           name: "STRING_VALUE", // required
//           path: "STRING_VALUE", // required
//           uploadBehavior: "STRING_VALUE", // required
//         },
//       ],
//       worldConfigs: [ // WorldConfigs
//         { // WorldConfig
//           world: "STRING_VALUE",
//         },
//       ],
//       useDefaultUploadConfigurations: true || false,
//       tools: [
//         {
//           streamUI: true || false,
//           name: "STRING_VALUE", // required
//           command: "STRING_VALUE", // required
//           streamOutputToCloudWatch: true || false,
//           exitBehavior: "STRING_VALUE",
//         },
//       ],
//       useDefaultTools: true || false,
//     },
//   ],
//   dataSources: [ // DataSources
//     { // DataSource
//       name: "STRING_VALUE",
//       s3Bucket: "STRING_VALUE",
//       s3Keys: [ // S3KeyOutputs
//         { // S3KeyOutput
//           s3Key: "STRING_VALUE",
//           etag: "STRING_VALUE",
//         },
//       ],
//       type: "STRING_VALUE",
//       destination: "STRING_VALUE",
//     },
//   ],
//   tags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
//   vpcConfig: { // VPCConfigResponse
//     subnets: [ // Subnets
//       "STRING_VALUE",
//     ],
//     securityGroups: [ // SecurityGroups
//       "STRING_VALUE",
//     ],
//     vpcId: "STRING_VALUE",
//     assignPublicIp: true || false,
//   },
//   compute: { // ComputeResponse
//     simulationUnitLimit: Number("int"),
//     computeType: "STRING_VALUE",
//     gpuUnitLimit: Number("int"),
//   },
// };

Param

CreateSimulationJobCommandInput

Returns

CreateSimulationJobCommandOutput

See

• CreateSimulationJobCommandInput for command's input shape.
• CreateSimulationJobCommandOutput for command's response shape.
• config for RoboMakerClient's config shape.

Throws

IdempotentParameterMismatchException (client fault)

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

Throws

InternalServerException (server fault)

AWS RoboMaker experienced a service issue. Try your call again.

Throws

InvalidParameterException (client fault)

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

Throws

LimitExceededException (client fault)

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

Throws

ResourceNotFoundException (client fault)

The specified resource does not exist.

Throws

ServiceUnavailableException (server fault)

The request has failed due to a temporary failure of the server.

Throws

ThrottlingException (client fault)

AWS RoboMaker is temporarily unable to process the request. Try your call again.

Throws

RoboMakerServiceException

Base exception class for all service exceptions from RoboMaker service.