We are excited to announce our new API Documentation.
Protected
Describes one or more simulation jobs.
Use a bare-bones client and the command you need to make an API call.
import { RoboMakerClient, BatchDescribeSimulationJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import// const { RoboMakerClient, BatchDescribeSimulationJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS importconst client = new RoboMakerClient(config);const input = { // BatchDescribeSimulationJobRequest jobs: [ // Arns // required "STRING_VALUE", ],};const command = new BatchDescribeSimulationJobCommand(input);const response = await client.send(command);// { // BatchDescribeSimulationJobResponse// jobs: [ // SimulationJobs// { // SimulationJob// arn: "STRING_VALUE",// name: "STRING_VALUE",// status: "Pending" || "Preparing" || "Running" || "Restarting" || "Completed" || "Failed" || "RunningFailed" || "Terminating" || "Terminated" || "Canceled",// lastStartedAt: new Date("TIMESTAMP"),// lastUpdatedAt: new Date("TIMESTAMP"),// failureBehavior: "Fail" || "Continue",// failureCode: "InternalServiceError" || "RobotApplicationCrash" || "SimulationApplicationCrash" || "RobotApplicationHealthCheckFailure" || "SimulationApplicationHealthCheckFailure" || "BadPermissionsRobotApplication" || "BadPermissionsSimulationApplication" || "BadPermissionsS3Object" || "BadPermissionsS3Output" || "BadPermissionsCloudwatchLogs" || "SubnetIpLimitExceeded" || "ENILimitExceeded" || "BadPermissionsUserCredentials" || "InvalidBundleRobotApplication" || "InvalidBundleSimulationApplication" || "InvalidS3Resource" || "ThrottlingError" || "LimitExceeded" || "MismatchedEtag" || "RobotApplicationVersionMismatchedEtag" || "SimulationApplicationVersionMismatchedEtag" || "ResourceNotFound" || "RequestThrottled" || "BatchTimedOut" || "BatchCanceled" || "InvalidInput" || "WrongRegionS3Bucket" || "WrongRegionS3Output" || "WrongRegionRobotApplication" || "WrongRegionSimulationApplication" || "UploadContentMismatchError",// failureReason: "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: "UPLOAD_ON_TERMINATE" || "UPLOAD_ROLLING_AUTO_REMOVE", // required// },// ],// useDefaultUploadConfigurations: true || false,// tools: [ // Tools// { // Tool// streamUI: true || false,// name: "STRING_VALUE", // required// command: "STRING_VALUE", // required// streamOutputToCloudWatch: true || false,// exitBehavior: "FAIL" || "RESTART",// },// ],// 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: "UPLOAD_ON_TERMINATE" || "UPLOAD_ROLLING_AUTO_REMOVE", // 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: "FAIL" || "RESTART",// },// ],// useDefaultTools: true || false,// },// ],// dataSources: [ // DataSources// { // DataSource// name: "STRING_VALUE",// s3Bucket: "STRING_VALUE",// s3Keys: [ // S3KeyOutputs// { // S3KeyOutput// s3Key: "STRING_VALUE",// etag: "STRING_VALUE",// },// ],// type: "Prefix" || "Archive" || "File",// destination: "STRING_VALUE",// },// ],// tags: { // TagMap// "<keys>": "STRING_VALUE",// },// vpcConfig: { // VPCConfigResponse// subnets: [ // Subnets// "STRING_VALUE",// ],// securityGroups: [ // SecurityGroups// "STRING_VALUE",// ],// vpcId: "STRING_VALUE",// assignPublicIp: true || false,// },// networkInterface: { // NetworkInterface// networkInterfaceId: "STRING_VALUE",// privateIpAddress: "STRING_VALUE",// publicIpAddress: "STRING_VALUE",// },// compute: { // ComputeResponse// simulationUnitLimit: Number("int"),// computeType: "CPU" || "GPU_AND_CPU",// gpuUnitLimit: Number("int"),// },// },// ],// unprocessedJobs: [ // Arns// "STRING_VALUE",// ],// };
BatchDescribeSimulationJobCommandInput
BatchDescribeSimulationJobCommandOutput
input
response
config
InternalServerException (server fault)
AWS RoboMaker experienced a service issue. Try your call again.
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.
ResourceNotFoundException (client fault)
The specified resource does not exist.
ThrottlingException (client fault)
AWS RoboMaker is temporarily unable to process the request. Try your call again.
RoboMakerServiceException
Base exception class for all service exceptions from RoboMaker service.
Readonly
Static
Describes one or more simulation jobs.
Example
Use a bare-bones client and the command you need to make an API call.
Param
BatchDescribeSimulationJobCommandInput
Returns
BatchDescribeSimulationJobCommandOutput
See
input
shape.response
shape.config
shape.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
ResourceNotFoundException (client fault)
The specified resource does not exist.
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.