Class: AWS.RoboMaker

var params = {
  jobs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
robomaker.batchDescribeSimulationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobs — (Array<String>)

    A list of Amazon Resource Names (ARNs) of simulation jobs to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • jobs — (Array<map>)

      A list of simulation jobs.

      • arn — (String)

        The Amazon Resource Name (ARN) of the simulation job.

      • name — (String)

        The name of the simulation job.

      • status — (String)

        Status of the simulation job.

        Possible values include:
        • "Pending"
        • "Preparing"
        • "Running"
        • "Restarting"
        • "Completed"
        • "Failed"
        • "RunningFailed"
        • "Terminating"
        • "Terminated"
        • "Canceled"
      • lastStartedAt — (Date)

        The time, in milliseconds since the epoch, when the simulation job was last started.

      • lastUpdatedAt — (Date)

        The time, in milliseconds since the epoch, when the simulation job was last updated.

      • failureBehavior — (String)

        The failure behavior the simulation job.

        Continue

        Leaves the host running for its maximum timeout duration after a 4XX error code.

        Fail

        Stop the simulation job and terminate the instance.

        Possible values include:
        • "Fail"
        • "Continue"
      • failureCode — (String)

        The failure code of the simulation job if it failed.

        Possible values include:
        • "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)

        The reason why the simulation job failed.

      • clientRequestToken — (String)

        A unique identifier for this SimulationJob request.

      • outputLocation — (map)

        Location for output files generated by the simulation job.

        • s3Bucket — (String)

          The S3 bucket for output.

        • s3Prefix — (String)

          The S3 folder in the s3Bucket where output files will be placed.

      • loggingConfig — (map)

        The logging configuration.

        • recordAllRosTopics — (Boolean)

          A boolean indicating whether to record all ROS topics.

          This API is no longer supported and will throw an error if used.

      • maxJobDurationInSeconds — (Integer)

        The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

      • simulationTimeMillis — (Integer)

        The simulation job execution duration in milliseconds.

      • iamRole — (String)

        The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

      • robotApplications — (Array<map>)

        A list of robot applications.

        • application — required — (String)

          The application information for the robot application.

        • applicationVersion — (String)

          The version of the robot application.

        • launchConfig — required — (map)

          The launch configuration for the robot application.

          • packageName — (String)

            The package name.

          • launchFile — (String)

            The launch file name.

          • environmentVariables — (map<String>)

            The environment variables for the application launch.

          • portForwardingConfig — (map)

            The port forwarding configuration.

            • portMappings — (Array<map>)

              The port mappings for the configuration.

              • jobPort — required — (Integer)

                The port number on the simulation job instance to use as a remote connection point.

              • applicationPort — required — (Integer)

                The port number on the application.

              • enableOnPublicIp — (Boolean)

                A Boolean indicating whether to enable this port mapping on public IP.

          • streamUI — (Boolean)

            Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

          • command — (Array<String>)

            If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

            If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

        • uploadConfigurations — (Array<map>)

          The upload configurations for the robot application.

          • name — required — (String)

            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.

            For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

          • path — required — (String)

            Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

          • uploadBehavior — required — (String)

            Specifies when to upload the files:

            UPLOAD_ON_TERMINATE

            Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

            If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

            UPLOAD_ROLLING_AUTO_REMOVE

            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.

            Possible values include:
            • "UPLOAD_ON_TERMINATE"
            • "UPLOAD_ROLLING_AUTO_REMOVE"
        • useDefaultUploadConfigurations — (Boolean)

          A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

          If you set this value, you must specify an outputLocation.

          This API is no longer supported and will throw an error if used.

        • tools — (Array<map>)

          Information about tools configured for the robot application.

          • streamUI — (Boolean)

            Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

          • name — required — (String)

            The name of the tool.

          • command — required — (String)

            Command-line arguments for the tool. It must include the tool executable name.

          • streamOutputToCloudWatch — (Boolean)

            Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

          • exitBehavior — (String)

            Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

            Possible values include:
            • "FAIL"
            • "RESTART"
        • useDefaultTools — (Boolean)

          A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

          This API is no longer supported and will throw an error if used.

      • simulationApplications — (Array<map>)

        A list of simulation applications.

        • application — required — (String)

          The application information for the simulation application.

        • applicationVersion — (String)

          The version of the simulation application.

        • launchConfig — required — (map)

          The launch configuration for the simulation application.

          • packageName — (String)

            The package name.

          • launchFile — (String)

            The launch file name.

          • environmentVariables — (map<String>)

            The environment variables for the application launch.

          • portForwardingConfig — (map)

            The port forwarding configuration.

            • portMappings — (Array<map>)

              The port mappings for the configuration.

              • jobPort — required — (Integer)

                The port number on the simulation job instance to use as a remote connection point.

              • applicationPort — required — (Integer)

                The port number on the application.

              • enableOnPublicIp — (Boolean)

                A Boolean indicating whether to enable this port mapping on public IP.

          • streamUI — (Boolean)

            Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

          • command — (Array<String>)

            If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

            If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

        • uploadConfigurations — (Array<map>)

          Information about upload configurations for the simulation application.

          • name — required — (String)

            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.

            For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

          • path — required — (String)

            Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

          • uploadBehavior — required — (String)

            Specifies when to upload the files:

            UPLOAD_ON_TERMINATE

            Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

            If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

            UPLOAD_ROLLING_AUTO_REMOVE

            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.

            Possible values include:
            • "UPLOAD_ON_TERMINATE"
            • "UPLOAD_ROLLING_AUTO_REMOVE"
        • worldConfigs — (Array<map>)

          A list of world configurations.

          • world — (String)

            The world generated by Simulation WorldForge.

        • useDefaultUploadConfigurations — (Boolean)

          A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

          If you set this value, you must specify an outputLocation.

          This API is no longer supported and will throw an error if used.

        • tools — (Array<map>)

          Information about tools configured for the simulation application.

          • streamUI — (Boolean)

            Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

          • name — required — (String)

            The name of the tool.

          • command — required — (String)

            Command-line arguments for the tool. It must include the tool executable name.

          • streamOutputToCloudWatch — (Boolean)

            Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

          • exitBehavior — (String)

            Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

            Possible values include:
            • "FAIL"
            • "RESTART"
        • useDefaultTools — (Boolean)

          A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

          This API is no longer supported and will throw an error if used.

      • dataSources — (Array<map>)

        The data sources for the simulation job.

        • name — (String)

          The name of the data source.

        • s3Bucket — (String)

          The S3 bucket where the data files are located.

        • s3Keys — (Array<map>)

          The list of S3 keys identifying the data source files.

          • s3Key — (String)

            The S3 key.

          • etag — (String)

            The etag for the object.

        • type — (String)

          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.

          If you don't specify a field, the default value is File.

          Possible values include:
          • "Prefix"
          • "Archive"
          • "File"
        • destination — (String)

          The location where your files are mounted in the container image.

          If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

          If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

          If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

      • tags — (map<String>)

        A map that contains tag keys and tag values that are attached to the simulation job.

      • vpcConfig — (map)

        VPC configuration information.

        • subnets — (Array<String>)

          A list of subnet IDs associated with the simulation job.

        • securityGroups — (Array<String>)

          A list of security group IDs associated with the simulation job.

        • vpcId — (String)

          The VPC ID associated with your simulation job.

        • assignPublicIp — (Boolean)

          A boolean indicating if a public IP was assigned.

      • networkInterface — (map)

        Information about a network interface.

        • networkInterfaceId — (String)

          The ID of the network interface.

        • privateIpAddress — (String)

          The IPv4 address of the network interface within the subnet.

        • publicIpAddress — (String)

          The IPv4 public address of the network interface.

      • compute — (map)

        Compute information for the simulation job

        • simulationUnitLimit — (Integer)

          The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.

        • computeType — (String)

          Compute type response information for the simulation job.

          Possible values include:
          • "CPU"
          • "GPU_AND_CPU"
        • gpuUnitLimit — (Integer)

          Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.

    • unprocessedJobs — (Array<String>)

      A list of unprocessed simulation job Amazon Resource Names (ARNs).

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  job: 'STRING_VALUE' /* required */
};
robomaker.cancelDeploymentJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • job — (String)

    The deployment job ARN to cancel.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  job: 'STRING_VALUE' /* required */
};
robomaker.cancelSimulationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • job — (String)

    The simulation job ARN to cancel.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  batch: 'STRING_VALUE' /* required */
};
robomaker.cancelSimulationJobBatch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • batch — (String)

    The id of the batch to cancel.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  job: 'STRING_VALUE' /* required */
};
robomaker.cancelWorldExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • job — (String)

    The Amazon Resource Name (arn) of the world export job to cancel.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  job: 'STRING_VALUE' /* required */
};
robomaker.cancelWorldGenerationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • job — (String)

    The Amazon Resource Name (arn) of the world generator job to cancel.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clientRequestToken: 'STRING_VALUE', /* required */
  deploymentApplicationConfigs: [ /* required */
    {
      application: 'STRING_VALUE', /* required */
      applicationVersion: 'STRING_VALUE', /* required */
      launchConfig: { /* required */
        launchFile: 'STRING_VALUE', /* required */
        packageName: 'STRING_VALUE', /* required */
        environmentVariables: {
          '<EnvironmentVariableKey>': 'STRING_VALUE',
          /* '<EnvironmentVariableKey>': ... */
        },
        postLaunchFile: 'STRING_VALUE',
        preLaunchFile: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  fleet: 'STRING_VALUE', /* required */
  deploymentConfig: {
    concurrentDeploymentPercentage: 'NUMBER_VALUE',
    downloadConditionFile: {
      bucket: 'STRING_VALUE', /* required */
      key: 'STRING_VALUE', /* required */
      etag: 'STRING_VALUE'
    },
    failureThresholdPercentage: 'NUMBER_VALUE',
    robotDeploymentTimeoutInSeconds: 'NUMBER_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
robomaker.createDeploymentJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • deploymentConfig — (map)

    The requested deployment configuration.

    • concurrentDeploymentPercentage — (Integer)

      The percentage of robots receiving the deployment at the same time.

    • failureThresholdPercentage — (Integer)

      The percentage of deployments that need to fail before stopping deployment.

    • robotDeploymentTimeoutInSeconds — (Integer)

      The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.

    • downloadConditionFile — (map)

      The download condition file.

      • bucket — required — (String)

        The bucket containing the object.

      • key — required — (String)

        The key of the object.

      • etag — (String)

        The etag of the object.

  • clientRequestToken — (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • fleet — (String)

    The Amazon Resource Name (ARN) of the fleet to deploy.

  • deploymentApplicationConfigs — (Array<map>)

    The deployment application configuration.

    • application — required — (String)

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

    • applicationVersion — required — (String)

      The version of the application.

    • launchConfig — required — (map)

      The launch configuration.

      • packageName — required — (String)

        The package name.

      • preLaunchFile — (String)

        The deployment pre-launch file. This file will be executed prior to the launch file.

      • launchFile — required — (String)

        The launch file name.

      • postLaunchFile — (String)

        The deployment post-launch file. This file will be executed after the launch file.

      • environmentVariables — (map<String>)

        An array of key/value pairs specifying environment variables for the robot application

  • tags — (map<String>)

    A map that contains tag keys and tag values that are attached to the deployment job.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Amazon Resource Name (ARN) of the deployment job.

    • fleet — (String)

      The target fleet for the deployment job.

    • status — (String)

      The status of the deployment job.

      Possible values include:
      • "Pending"
      • "Preparing"
      • "InProgress"
      • "Failed"
      • "Succeeded"
      • "Canceled"
    • deploymentApplicationConfigs — (Array<map>)

      The deployment application configuration.

      • application — required — (String)

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

      • applicationVersion — required — (String)

        The version of the application.

      • launchConfig — required — (map)

        The launch configuration.

        • packageName — required — (String)

          The package name.

        • preLaunchFile — (String)

          The deployment pre-launch file. This file will be executed prior to the launch file.

        • launchFile — required — (String)

          The launch file name.

        • postLaunchFile — (String)

          The deployment post-launch file. This file will be executed after the launch file.

        • environmentVariables — (map<String>)

          An array of key/value pairs specifying environment variables for the robot application

    • failureReason — (String)

      The failure reason of the deployment job if it failed.

    • failureCode — (String)

      The failure code of the simulation job if it failed:

      BadPermissionError

      AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.

      ExtractingBundleFailure

      The robot application could not be extracted from the bundle.

      FailureThresholdBreached

      The percentage of robots that could not be updated exceeded the percentage set for the deployment.

      GreengrassDeploymentFailed

      The robot application could not be deployed to the robot.

      GreengrassGroupVersionDoesNotExist

      The AWS Greengrass group or version associated with a robot is missing.

      InternalServerError

      An internal error has occurred. Retry your request, but if the problem persists, contact us with details.

      MissingRobotApplicationArchitecture

      The robot application does not have a source that matches the architecture of the robot.

      MissingRobotDeploymentResource

      One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?

      PostLaunchFileFailure

      The post-launch script failed.

      PreLaunchFileFailure

      The pre-launch script failed.

      ResourceNotFound

      One or more deployment resources are missing. For example, do robot application source bundles still exist?

      RobotDeploymentNoResponse

      There is no response from the robot. It might not be powered on or connected to the internet.

      Possible values include:
      • "ResourceNotFound"
      • "EnvironmentSetupError"
      • "EtagMismatch"
      • "FailureThresholdBreached"
      • "RobotDeploymentAborted"
      • "RobotDeploymentNoResponse"
      • "RobotAgentConnectionTimeout"
      • "GreengrassDeploymentFailed"
      • "InvalidGreengrassGroup"
      • "MissingRobotArchitecture"
      • "MissingRobotApplicationArchitecture"
      • "MissingRobotDeploymentResource"
      • "GreengrassGroupVersionDoesNotExist"
      • "LambdaDeleted"
      • "ExtractingBundleFailure"
      • "PreLaunchFileFailure"
      • "PostLaunchFileFailure"
      • "BadPermissionError"
      • "DownloadConditionFailed"
      • "BadLambdaAssociated"
      • "InternalServerError"
      • "RobotApplicationDoesNotExist"
      • "DeploymentFleetDoesNotExist"
      • "FleetDeploymentTimeout"
    • createdAt — (Date)

      The time, in milliseconds since the epoch, when the fleet was created.

    • deploymentConfig — (map)

      The deployment configuration.

      • concurrentDeploymentPercentage — (Integer)

        The percentage of robots receiving the deployment at the same time.

      • failureThresholdPercentage — (Integer)

        The percentage of deployments that need to fail before stopping deployment.

      • robotDeploymentTimeoutInSeconds — (Integer)

        The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.

      • downloadConditionFile — (map)

        The download condition file.

        • bucket — required — (String)

          The bucket containing the object.

        • key — required — (String)

          The key of the object.

        • etag — (String)

          The etag of the object.

    • tags — (map<String>)

      The list of all tags added to the deployment job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
robomaker.createFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the fleet.

  • tags — (map<String>)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Amazon Resource Name (ARN) of the fleet.

    • name — (String)

      The name of the fleet.

    • createdAt — (Date)

      The time, in milliseconds since the epoch, when the fleet was created.

    • tags — (map<String>)

      The list of all tags added to the fleet.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  architecture: X86_64 | ARM64 | ARMHF, /* required */
  greengrassGroupId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
robomaker.createRobot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name for the robot.

  • architecture — (String)

    The target architecture of the robot.

    Possible values include:
    • "X86_64"
    • "ARM64"
    • "ARMHF"
  • greengrassGroupId — (String)

    The Greengrass group id.

  • tags — (map<String>)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Amazon Resource Name (ARN) of the robot.

    • name — (String)

      The name of the robot.

    • createdAt — (Date)

      The time, in milliseconds since the epoch, when the robot was created.

    • greengrassGroupId — (String)

      The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.

    • architecture — (String)

      The target architecture of the robot.

      Possible values include:
      • "X86_64"
      • "ARM64"
      • "ARMHF"
    • tags — (map<String>)

      The list of all tags added to the robot.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  robotSoftwareSuite: { /* required */
    name: ROS | ROS2 | General,
    version: Kinetic | Melodic | Dashing | Foxy
  },
  environment: {
    uri: 'STRING_VALUE'
  },
  sources: [
    {
      architecture: X86_64 | ARM64 | ARMHF,
      s3Bucket: 'STRING_VALUE',
      s3Key: 'STRING_VALUE'
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
robomaker.createRobotApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the robot application.

  • sources — (Array<map>)

    The sources of the robot application.

    • s3Bucket — (String)

      The Amazon S3 bucket name.

    • s3Key — (String)

      The s3 object key.

    • architecture — (String)

      The target processor architecture for the application.

      Possible values include:
      • "X86_64"
      • "ARM64"
      • "ARMHF"
  • robotSoftwareSuite — (map)

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

    • name — (String)

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

      Possible values include:
      • "ROS"
      • "ROS2"
      • "General"
    • version — (String)

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

      Possible values include:
      • "Kinetic"
      • "Melodic"
      • "Dashing"
      • "Foxy"
  • tags — (map<String>)

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

  • environment — (map)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Array<map>)

      The sources of the robot application.

      • 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.

        Possible values include:
        • "X86_64"
        • "ARM64"
        • "ARMHF"
    • robotSoftwareSuite — (map)

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

      • name — (String)

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

        Possible values include:
        • "ROS"
        • "ROS2"
        • "General"
      • version — (String)

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

        Possible values include:
        • "Kinetic"
        • "Melodic"
        • "Dashing"
        • "Foxy"
    • lastUpdatedAt — (Date)

      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<String>)

      The list of all tags added to the robot application.

    • environment — (map)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  currentRevisionId: 'STRING_VALUE',
  imageDigest: 'STRING_VALUE',
  s3Etags: [
    'STRING_VALUE',
    /* more items */
  ]
};
robomaker.createRobotApplicationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The application information for the robot application.

  • currentRevisionId — (String)

    The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created.

  • s3Etags — (Array<String>)

    The Amazon S3 identifier for the zip file bundle that you use for your robot application.

  • imageDigest — (String)

    A SHA256 identifier for the Docker image that you use for your robot application.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Array<map>)

      The sources of the robot application.

      • 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.

        Possible values include:
        • "X86_64"
        • "ARM64"
        • "ARMHF"
    • robotSoftwareSuite — (map)

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

      • name — (String)

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

        Possible values include:
        • "ROS"
        • "ROS2"
        • "General"
      • version — (String)

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

        Possible values include:
        • "Kinetic"
        • "Melodic"
        • "Dashing"
        • "Foxy"
    • lastUpdatedAt — (Date)

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

    • revisionId — (String)

      The revision id of the robot application.

    • environment — (map)

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

      • uri — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  robotSoftwareSuite: { /* required */
    name: ROS | ROS2 | General,
    version: Kinetic | Melodic | Dashing | Foxy
  },
  simulationSoftwareSuite: { /* required */
    name: Gazebo | RosbagPlay | SimulationRuntime,
    version: 'STRING_VALUE'
  },
  environment: {
    uri: 'STRING_VALUE'
  },
  renderingEngine: {
    name: OGRE,
    version: 'STRING_VALUE'
  },
  sources: [
    {
      architecture: X86_64 | ARM64 | ARMHF,
      s3Bucket: 'STRING_VALUE',
      s3Key: 'STRING_VALUE'
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
robomaker.createSimulationApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the simulation application.

  • sources — (Array<map>)

    The sources of the simulation application.

    • s3Bucket — (String)

      The Amazon S3 bucket name.

    • s3Key — (String)

      The s3 object key.

    • architecture — (String)

      The target processor architecture for the application.

      Possible values include:
      • "X86_64"
      • "ARM64"
      • "ARMHF"
  • simulationSoftwareSuite — (map)

    The simulation software suite used by the simulation application.

    • name — (String)

      The name of the simulation software suite.

      Possible values include:
      • "Gazebo"
      • "RosbagPlay"
      • "SimulationRuntime"
    • version — (String)

      The version of the simulation software suite.

  • robotSoftwareSuite — (map)

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

    • name — (String)

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

      Possible values include:
      • "ROS"
      • "ROS2"
      • "General"
    • version — (String)

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

      Possible values include:
      • "Kinetic"
      • "Melodic"
      • "Dashing"
      • "Foxy"
  • renderingEngine — (map)

    The rendering engine for the simulation application.

    • name — (String)

      The name of the rendering engine.

      Possible values include:
      • "OGRE"
    • version — (String)

      The version of the rendering engine.

  • tags — (map<String>)

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

  • environment — (map)

    The object that contains the Docker image URI used to create your simulation application.

    • uri — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

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

    • name — (String)

      The name of the simulation application.

    • version — (String)

      The version of the simulation application.

    • sources — (Array<map>)

      The sources of the simulation application.

      • 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.

        Possible values include:
        • "X86_64"
        • "ARM64"
        • "ARMHF"
    • simulationSoftwareSuite — (map)

      The simulation software suite used by the simulation application.

      • name — (String)

        The name of the simulation software suite.

        Possible values include:
        • "Gazebo"
        • "RosbagPlay"
        • "SimulationRuntime"
      • version — (String)

        The version of the simulation software suite.

    • robotSoftwareSuite — (map)

      Information about the robot software suite (ROS distribution).

      • name — (String)

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

        Possible values include:
        • "ROS"
        • "ROS2"
        • "General"
      • version — (String)

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

        Possible values include:
        • "Kinetic"
        • "Melodic"
        • "Dashing"
        • "Foxy"
    • renderingEngine — (map)

      The rendering engine for the simulation application.

      • name — (String)

        The name of the rendering engine.

        Possible values include:
        • "OGRE"
      • version — (String)

        The version of the rendering engine.

    • lastUpdatedAt — (Date)

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

    • revisionId — (String)

      The revision id of the simulation application.

    • tags — (map<String>)

      The list of all tags added to the simulation application.

    • environment — (map)

      The object that contains the Docker image URI that you used to create your simulation application.

      • uri — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  currentRevisionId: 'STRING_VALUE',
  imageDigest: 'STRING_VALUE',
  s3Etags: [
    'STRING_VALUE',
    /* more items */
  ]
};
robomaker.createSimulationApplicationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The application information for the simulation application.

  • currentRevisionId — (String)

    The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created.

  • s3Etags — (Array<String>)

    The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application.

  • imageDigest — (String)

    The SHA256 digest used to identify the Docker image URI used to created the simulation application.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

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

    • name — (String)

      The name of the simulation application.

    • version — (String)

      The version of the simulation application.

    • sources — (Array<map>)

      The sources of the simulation application.

      • 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.

        Possible values include:
        • "X86_64"
        • "ARM64"
        • "ARMHF"
    • simulationSoftwareSuite — (map)

      The simulation software suite used by the simulation application.

      • name — (String)

        The name of the simulation software suite.

        Possible values include:
        • "Gazebo"
        • "RosbagPlay"
        • "SimulationRuntime"
      • version — (String)

        The version of the simulation software suite.

    • robotSoftwareSuite — (map)

      Information about the robot software suite (ROS distribution).

      • name — (String)

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

        Possible values include:
        • "ROS"
        • "ROS2"
        • "General"
      • version — (String)

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

        Possible values include:
        • "Kinetic"
        • "Melodic"
        • "Dashing"
        • "Foxy"
    • renderingEngine — (map)

      The rendering engine for the simulation application.

      • name — (String)

        The name of the rendering engine.

        Possible values include:
        • "OGRE"
      • version — (String)

        The version of the rendering engine.

    • lastUpdatedAt — (Date)

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

    • revisionId — (String)

      The revision ID of the simulation application.

    • environment — (map)

      The object that contains the Docker image URI used to create the simulation application.

      • uri — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  iamRole: 'STRING_VALUE', /* required */
  maxJobDurationInSeconds: 'NUMBER_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE',
  compute: {
    computeType: CPU | GPU_AND_CPU,
    gpuUnitLimit: 'NUMBER_VALUE',
    simulationUnitLimit: 'NUMBER_VALUE'
  },
  dataSources: [
    {
      name: 'STRING_VALUE', /* required */
      s3Bucket: 'STRING_VALUE', /* required */
      s3Keys: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      destination: 'STRING_VALUE',
      type: Prefix | Archive | File
    },
    /* more items */
  ],
  failureBehavior: Fail | Continue,
  loggingConfig: {
    recordAllRosTopics: true || false
  },
  outputLocation: {
    s3Bucket: 'STRING_VALUE',
    s3Prefix: 'STRING_VALUE'
  },
  robotApplications: [
    {
      application: 'STRING_VALUE', /* required */
      launchConfig: { /* required */
        command: [
          'STRING_VALUE',
          /* more items */
        ],
        environmentVariables: {
          '<EnvironmentVariableKey>': 'STRING_VALUE',
          /* '<EnvironmentVariableKey>': ... */
        },
        launchFile: 'STRING_VALUE',
        packageName: 'STRING_VALUE',
        portForwardingConfig: {
          portMappings: [
            {
              applicationPort: 'NUMBER_VALUE', /* required */
              jobPort: 'NUMBER_VALUE', /* required */
              enableOnPublicIp: true || false
            },
            /* more items */
          ]
        },
        streamUI: true || false
      },
      applicationVersion: 'STRING_VALUE',
      tools: [
        {
          command: 'STRING_VALUE', /* required */
          name: 'STRING_VALUE', /* required */
          exitBehavior: FAIL | RESTART,
          streamOutputToCloudWatch: true || false,
          streamUI: true || false
        },
        /* more items */
      ],
      uploadConfigurations: [
        {
          name: 'STRING_VALUE', /* required */
          path: 'STRING_VALUE', /* required */
          uploadBehavior: UPLOAD_ON_TERMINATE | UPLOAD_ROLLING_AUTO_REMOVE /* required */
        },
        /* more items */
      ],
      useDefaultTools: true || false,
      useDefaultUploadConfigurations: true || false
    },
    /* more items */
  ],
  simulationApplications: [
    {
      application: 'STRING_VALUE', /* required */
      launchConfig: { /* required */
        command: [
          'STRING_VALUE',
          /* more items */
        ],
        environmentVariables: {
          '<EnvironmentVariableKey>': 'STRING_VALUE',
          /* '<EnvironmentVariableKey>': ... */
        },
        launchFile: 'STRING_VALUE',
        packageName: 'STRING_VALUE',
        portForwardingConfig: {
          portMappings: [
            {
              applicationPort: 'NUMBER_VALUE', /* required */
              jobPort: 'NUMBER_VALUE', /* required */
              enableOnPublicIp: true || false
            },
            /* more items */
          ]
        },
        streamUI: true || false
      },
      applicationVersion: 'STRING_VALUE',
      tools: [
        {
          command: 'STRING_VALUE', /* required */
          name: 'STRING_VALUE', /* required */
          exitBehavior: FAIL | RESTART,
          streamOutputToCloudWatch: true || false,
          streamUI: true || false
        },
        /* more items */
      ],
      uploadConfigurations: [
        {
          name: 'STRING_VALUE', /* required */
          path: 'STRING_VALUE', /* required */
          uploadBehavior: UPLOAD_ON_TERMINATE | UPLOAD_ROLLING_AUTO_REMOVE /* required */
        },
        /* more items */
      ],
      useDefaultTools: true || false,
      useDefaultUploadConfigurations: true || false,
      worldConfigs: [
        {
          world: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  vpcConfig: {
    subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    assignPublicIp: true || false,
    securityGroups: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
robomaker.createSimulationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientRequestToken — (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • outputLocation — (map)

    Location for output files generated by the simulation job.

    • s3Bucket — (String)

      The S3 bucket for output.

    • s3Prefix — (String)

      The S3 folder in the s3Bucket where output files will be placed.

  • loggingConfig — (map)

    The logging configuration.

    • recordAllRosTopics — (Boolean)

      A boolean indicating whether to record all ROS topics.

      This API is no longer supported and will throw an error if used.

  • maxJobDurationInSeconds — (Integer)

    The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed.

  • iamRole — (String)

    The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

  • failureBehavior — (String)

    The failure behavior the simulation job.

    Continue

    Leaves the instance running for its maximum timeout duration after a 4XX error code.

    Fail

    Stop the simulation job and terminate the instance.

    Possible values include:
    • "Fail"
    • "Continue"
  • robotApplications — (Array<map>)

    The robot application to use in the simulation job.

    • application — required — (String)

      The application information for the robot application.

    • applicationVersion — (String)

      The version of the robot application.

    • launchConfig — required — (map)

      The launch configuration for the robot application.

      • packageName — (String)

        The package name.

      • launchFile — (String)

        The launch file name.

      • environmentVariables — (map<String>)

        The environment variables for the application launch.

      • portForwardingConfig — (map)

        The port forwarding configuration.

        • portMappings — (Array<map>)

          The port mappings for the configuration.

          • jobPort — required — (Integer)

            The port number on the simulation job instance to use as a remote connection point.

          • applicationPort — required — (Integer)

            The port number on the application.

          • enableOnPublicIp — (Boolean)

            A Boolean indicating whether to enable this port mapping on public IP.

      • streamUI — (Boolean)

        Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

      • command — (Array<String>)

        If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

        If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

    • uploadConfigurations — (Array<map>)

      The upload configurations for the robot application.

      • name — required — (String)

        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.

        For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

      • path — required — (String)

        Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

      • uploadBehavior — required — (String)

        Specifies when to upload the files:

        UPLOAD_ON_TERMINATE

        Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

        If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

        UPLOAD_ROLLING_AUTO_REMOVE

        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.

        Possible values include:
        • "UPLOAD_ON_TERMINATE"
        • "UPLOAD_ROLLING_AUTO_REMOVE"
    • useDefaultUploadConfigurations — (Boolean)

      A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

      If you set this value, you must specify an outputLocation.

      This API is no longer supported and will throw an error if used.

    • tools — (Array<map>)

      Information about tools configured for the robot application.

      • streamUI — (Boolean)

        Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

      • name — required — (String)

        The name of the tool.

      • command — required — (String)

        Command-line arguments for the tool. It must include the tool executable name.

      • streamOutputToCloudWatch — (Boolean)

        Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

      • exitBehavior — (String)

        Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

        Possible values include:
        • "FAIL"
        • "RESTART"
    • useDefaultTools — (Boolean)

      A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

      This API is no longer supported and will throw an error if used.

  • simulationApplications — (Array<map>)

    The simulation application to use in the simulation job.

    • application — required — (String)

      The application information for the simulation application.

    • applicationVersion — (String)

      The version of the simulation application.

    • launchConfig — required — (map)

      The launch configuration for the simulation application.

      • packageName — (String)

        The package name.

      • launchFile — (String)

        The launch file name.

      • environmentVariables — (map<String>)

        The environment variables for the application launch.

      • portForwardingConfig — (map)

        The port forwarding configuration.

        • portMappings — (Array<map>)

          The port mappings for the configuration.

          • jobPort — required — (Integer)

            The port number on the simulation job instance to use as a remote connection point.

          • applicationPort — required — (Integer)

            The port number on the application.

          • enableOnPublicIp — (Boolean)

            A Boolean indicating whether to enable this port mapping on public IP.

      • streamUI — (Boolean)

        Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

      • command — (Array<String>)

        If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

        If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

    • uploadConfigurations — (Array<map>)

      Information about upload configurations for the simulation application.

      • name — required — (String)

        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.

        For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

      • path — required — (String)

        Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

      • uploadBehavior — required — (String)

        Specifies when to upload the files:

        UPLOAD_ON_TERMINATE

        Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

        If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

        UPLOAD_ROLLING_AUTO_REMOVE

        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.

        Possible values include:
        • "UPLOAD_ON_TERMINATE"
        • "UPLOAD_ROLLING_AUTO_REMOVE"
    • worldConfigs — (Array<map>)

      A list of world configurations.

      • world — (String)

        The world generated by Simulation WorldForge.

    • useDefaultUploadConfigurations — (Boolean)

      A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

      If you set this value, you must specify an outputLocation.

      This API is no longer supported and will throw an error if used.

    • tools — (Array<map>)

      Information about tools configured for the simulation application.

      • streamUI — (Boolean)

        Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

      • name — required — (String)

        The name of the tool.

      • command — required — (String)

        Command-line arguments for the tool. It must include the tool executable name.

      • streamOutputToCloudWatch — (Boolean)

        Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

      • exitBehavior — (String)

        Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

        Possible values include:
        • "FAIL"
        • "RESTART"
    • useDefaultTools — (Boolean)

      A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

      This API is no longer supported and will throw an error if used.

  • dataSources — (Array<map>)

    Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

    Note: There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.
    • name — required — (String)

      The name of the data source.

    • s3Bucket — required — (String)

      The S3 bucket where the data files are located.

    • s3Keys — required — (Array<String>)

      The list of S3 keys identifying the data source files.

    • type — (String)

      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.

      If you don't specify a field, the default value is File.

      Possible values include:
      • "Prefix"
      • "Archive"
      • "File"
    • destination — (String)

      The location where your files are mounted in the container image.

      If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

      If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

      If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

  • tags — (map<String>)

    A map that contains tag keys and tag values that are attached to the simulation job.

  • vpcConfig — (map)

    If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

    • subnets — required — (Array<String>)

      A list of one or more subnet IDs in your VPC.

    • securityGroups — (Array<String>)

      A list of one or more security groups IDs in your VPC.

    • assignPublicIp — (Boolean)

      A boolean indicating whether to assign a public IP address.

  • compute — (map)

    Compute information for the simulation job.

    • simulationUnitLimit — (Integer)

      The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.

    • computeType — (String)

      Compute type information for the simulation job.

      Possible values include:
      • "CPU"
      • "GPU_AND_CPU"
    • gpuUnitLimit — (Integer)

      Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Amazon Resource Name (ARN) of the simulation job.

    • status — (String)

      The status of the simulation job.

      Possible values include:
      • "Pending"
      • "Preparing"
      • "Running"
      • "Restarting"
      • "Completed"
      • "Failed"
      • "RunningFailed"
      • "Terminating"
      • "Terminated"
      • "Canceled"
    • lastStartedAt — (Date)

      The time, in milliseconds since the epoch, when the simulation job was last started.

    • lastUpdatedAt — (Date)

      The time, in milliseconds since the epoch, when the simulation job was last updated.

    • failureBehavior — (String)

      the failure behavior for the simulation job.

      Possible values include:
      • "Fail"
      • "Continue"
    • failureCode — (String)

      The failure code of the simulation job if it failed:

      InternalServiceError

      Internal service error.

      RobotApplicationCrash

      Robot application exited abnormally.

      SimulationApplicationCrash

      Simulation application exited abnormally.

      BadPermissionsRobotApplication

      Robot application bundle could not be downloaded.

      BadPermissionsSimulationApplication

      Simulation application bundle could not be downloaded.

      BadPermissionsS3Output

      Unable to publish outputs to customer-provided S3 bucket.

      BadPermissionsCloudwatchLogs

      Unable to publish logs to customer-provided CloudWatch Logs resource.

      SubnetIpLimitExceeded

      Subnet IP limit exceeded.

      ENILimitExceeded

      ENI limit exceeded.

      BadPermissionsUserCredentials

      Unable to use the Role provided.

      InvalidBundleRobotApplication

      Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

      InvalidBundleSimulationApplication

      Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

      RobotApplicationVersionMismatchedEtag

      Etag for RobotApplication does not match value during version creation.

      SimulationApplicationVersionMismatchedEtag

      Etag for SimulationApplication does not match value during version creation.

      Possible values include:
      • "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"
    • clientRequestToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • outputLocation — (map)

      Simulation job output files location.

      • s3Bucket — (String)

        The S3 bucket for output.

      • s3Prefix — (String)

        The S3 folder in the s3Bucket where output files will be placed.

    • loggingConfig — (map)

      The logging configuration.

      • recordAllRosTopics — (Boolean)

        A boolean indicating whether to record all ROS topics.

        This API is no longer supported and will throw an error if used.

    • maxJobDurationInSeconds — (Integer)

      The maximum simulation job duration in seconds.

    • simulationTimeMillis — (Integer)

      The simulation job execution duration in milliseconds.

    • iamRole — (String)

      The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.

    • robotApplications — (Array<map>)

      The robot application used by the simulation job.

      • application — required — (String)

        The application information for the robot application.

      • applicationVersion — (String)

        The version of the robot application.

      • launchConfig — required — (map)

        The launch configuration for the robot application.

        • packageName — (String)

          The package name.

        • launchFile — (String)

          The launch file name.

        • environmentVariables — (map<String>)

          The environment variables for the application launch.

        • portForwardingConfig — (map)

          The port forwarding configuration.

          • portMappings — (Array<map>)

            The port mappings for the configuration.

            • jobPort — required — (Integer)

              The port number on the simulation job instance to use as a remote connection point.

            • applicationPort — required — (Integer)

              The port number on the application.

            • enableOnPublicIp — (Boolean)

              A Boolean indicating whether to enable this port mapping on public IP.

        • streamUI — (Boolean)

          Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

        • command — (Array<String>)

          If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

          If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

      • uploadConfigurations — (Array<map>)

        The upload configurations for the robot application.

        • name — required — (String)

          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.

          For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

        • path — required — (String)

          Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

        • uploadBehavior — required — (String)

          Specifies when to upload the files:

          UPLOAD_ON_TERMINATE

          Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

          If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

          UPLOAD_ROLLING_AUTO_REMOVE

          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.

          Possible values include:
          • "UPLOAD_ON_TERMINATE"
          • "UPLOAD_ROLLING_AUTO_REMOVE"
      • useDefaultUploadConfigurations — (Boolean)

        A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

        If you set this value, you must specify an outputLocation.

        This API is no longer supported and will throw an error if used.

      • tools — (Array<map>)

        Information about tools configured for the robot application.

        • streamUI — (Boolean)

          Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

        • name — required — (String)

          The name of the tool.

        • command — required — (String)

          Command-line arguments for the tool. It must include the tool executable name.

        • streamOutputToCloudWatch — (Boolean)

          Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

        • exitBehavior — (String)

          Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

          Possible values include:
          • "FAIL"
          • "RESTART"
      • useDefaultTools — (Boolean)

        A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

        This API is no longer supported and will throw an error if used.

    • simulationApplications — (Array<map>)

      The simulation application used by the simulation job.

      • application — required — (String)

        The application information for the simulation application.

      • applicationVersion — (String)

        The version of the simulation application.

      • launchConfig — required — (map)

        The launch configuration for the simulation application.

        • packageName — (String)

          The package name.

        • launchFile — (String)

          The launch file name.

        • environmentVariables — (map<String>)

          The environment variables for the application launch.

        • portForwardingConfig — (map)

          The port forwarding configuration.

          • portMappings — (Array<map>)

            The port mappings for the configuration.

            • jobPort — required — (Integer)

              The port number on the simulation job instance to use as a remote connection point.

            • applicationPort — required — (Integer)

              The port number on the application.

            • enableOnPublicIp — (Boolean)

              A Boolean indicating whether to enable this port mapping on public IP.

        • streamUI — (Boolean)

          Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

        • command — (Array<String>)

          If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

          If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

      • uploadConfigurations — (Array<map>)

        Information about upload configurations for the simulation application.

        • name — required — (String)

          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.

          For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

        • path — required — (String)

          Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

        • uploadBehavior — required — (String)

          Specifies when to upload the files:

          UPLOAD_ON_TERMINATE

          Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

          If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

          UPLOAD_ROLLING_AUTO_REMOVE

          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.

          Possible values include:
          • "UPLOAD_ON_TERMINATE"
          • "UPLOAD_ROLLING_AUTO_REMOVE"
      • worldConfigs — (Array<map>)

        A list of world configurations.

        • world — (String)

          The world generated by Simulation WorldForge.

      • useDefaultUploadConfigurations — (Boolean)

        A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

        If you set this value, you must specify an outputLocation.

        This API is no longer supported and will throw an error if used.

      • tools — (Array<map>)

        Information about tools configured for the simulation application.

        • streamUI — (Boolean)

          Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

        • name — required — (String)

          The name of the tool.

        • command — required — (String)

          Command-line arguments for the tool. It must include the tool executable name.

        • streamOutputToCloudWatch — (Boolean)

          Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

        • exitBehavior — (String)

          Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

          Possible values include:
          • "FAIL"
          • "RESTART"
      • useDefaultTools — (Boolean)

        A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

        This API is no longer supported and will throw an error if used.

    • dataSources — (Array<map>)

      The data sources for the simulation job.

      • name — (String)

        The name of the data source.

      • s3Bucket — (String)

        The S3 bucket where the data files are located.

      • s3Keys — (Array<map>)

        The list of S3 keys identifying the data source files.

        • s3Key — (String)

          The S3 key.

        • etag — (String)

          The etag for the object.

      • type — (String)

        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.

        If you don't specify a field, the default value is File.

        Possible values include:
        • "Prefix"
        • "Archive"
        • "File"
      • destination — (String)

        The location where your files are mounted in the container image.

        If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

        If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

        If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

    • tags — (map<String>)

      The list of all tags added to the simulation job.

    • vpcConfig — (map)

      Information about the vpc configuration.

      • subnets — (Array<String>)

        A list of subnet IDs associated with the simulation job.

      • securityGroups — (Array<String>)

        A list of security group IDs associated with the simulation job.

      • vpcId — (String)

        The VPC ID associated with your simulation job.

      • assignPublicIp — (Boolean)

        A boolean indicating if a public IP was assigned.

    • compute — (map)

      Compute information for the simulation job.

      • simulationUnitLimit — (Integer)

        The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.

      • computeType — (String)

        Compute type response information for the simulation job.

        Possible values include:
        • "CPU"
        • "GPU_AND_CPU"
      • gpuUnitLimit — (Integer)

        Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  iamRole: 'STRING_VALUE', /* required */
  outputLocation: { /* required */
    s3Bucket: 'STRING_VALUE',
    s3Prefix: 'STRING_VALUE'
  },
  worlds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  clientRequestToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
robomaker.createWorldExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientRequestToken — (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • worlds — (Array<String>)

    A list of Amazon Resource Names (arns) that correspond to worlds to export.

  • outputLocation — (map)

    The output location.

    • s3Bucket — (String)

      The S3 bucket for output.

    • s3Prefix — (String)

      The S3 folder in the s3Bucket where output files will be placed.

  • iamRole — (String)

    The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

  • tags — (map<String>)

    A map that contains tag keys and tag values that are attached to the world export job.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Amazon Resource Name (ARN) of the world export job.

    • status — (String)

      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

      The world export job failed. See failureCode for more information.

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

      Possible values include:
      • "Pending"
      • "Running"
      • "Completed"
      • "Failed"
      • "Canceling"
      • "Canceled"
    • createdAt — (Date)

      The time, in milliseconds since the epoch, when the world export job was created.

    • failureCode — (String)

      The failure code of the world export job if it failed:

      InternalServiceError

      Internal service error.

      LimitExceeded

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

      ResourceNotFound

      The specified resource could not be found.

      RequestThrottled

      The request was throttled.

      InvalidInput

      An input parameter in the request is not valid.

      AllWorldGenerationFailed

      All of the worlds in the world generation job failed. This can happen if your worldCount is greater than 50 or less than 1.

      For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.

      Possible values include:
      • "InternalServiceError"
      • "LimitExceeded"
      • "ResourceNotFound"
      • "RequestThrottled"
      • "InvalidInput"
      • "AccessDenied"
    • clientRequestToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • outputLocation — (map)

      The output location.

      • s3Bucket — (String)

        The S3 bucket for output.

      • s3Prefix — (String)

        The S3 folder in the s3Bucket where output files will be placed.

    • iamRole — (String)

      The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

    • tags — (map<String>)

      A map that contains tag keys and tag values that are attached to the world export job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  template: 'STRING_VALUE', /* required */
  worldCount: { /* required */
    floorplanCount: 'NUMBER_VALUE',
    interiorCountPerFloorplan: 'NUMBER_VALUE'
  },
  clientRequestToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  worldTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
robomaker.createWorldGenerationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientRequestToken — (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • template — (String)

    The Amazon Resource Name (arn) of the world template describing the worlds you want to create.

  • worldCount — (map)

    Information about the world count.

    • floorplanCount — (Integer)

      The number of unique floorplans.

    • interiorCountPerFloorplan — (Integer)

      The number of unique interiors per floorplan.

  • tags — (map<String>)

    A map that contains tag keys and tag values that are attached to the world generator job.

  • worldTags — (map<String>)

    A map that contains tag keys and tag values that are attached to the generated worlds.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Amazon Resource Name (ARN) of the world generator job.

    • status — (String)

      The status of the world generator job.

      Pending

      The world generator job request is pending.

      Running

      The world generator job is running.

      Completed

      The world generator job completed.

      Failed

      The world generator job failed. See failureCode for more information.

      PartialFailed

      Some worlds did not generate.

      Canceled

      The world generator job was cancelled.

      Canceling

      The world generator job is being cancelled.

      Possible values include:
      • "Pending"
      • "Running"
      • "Completed"
      • "Failed"
      • "PartialFailed"
      • "Canceling"
      • "Canceled"
    • createdAt — (Date)

      The time, in milliseconds since the epoch, when the world generator job was created.

    • failureCode — (String)

      The failure code of the world generator job if it failed:

      InternalServiceError

      Internal service error.

      LimitExceeded

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

      ResourceNotFound

      The specified resource could not be found.

      RequestThrottled

      The request was throttled.

      InvalidInput

      An input parameter in the request is not valid.

      Possible values include:
      • "InternalServiceError"
      • "LimitExceeded"
      • "ResourceNotFound"
      • "RequestThrottled"
      • "InvalidInput"
      • "AllWorldGenerationFailed"
    • clientRequestToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • template — (String)

      The Amazon Resource Name (arn) of the world template.

    • worldCount — (map)

      Information about the world count.

      • floorplanCount — (Integer)

        The number of unique floorplans.

      • interiorCountPerFloorplan — (Integer)

        The number of unique interiors per floorplan.

    • tags — (map<String>)

      A map that contains tag keys and tag values that are attached to the world generator job.

    • worldTags — (map<String>)

      A map that contains tag keys and tag values that are attached to the generated worlds.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clientRequestToken: 'STRING_VALUE',
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  templateBody: 'STRING_VALUE',
  templateLocation: {
    s3Bucket: 'STRING_VALUE', /* required */
    s3Key: 'STRING_VALUE' /* required */
  }
};
robomaker.createWorldTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clientRequestToken — (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  • name — (String)

    The name of the world template.

  • templateBody — (String)

    The world template body.

  • templateLocation — (map)

    The location of the world template.

    • s3Bucket — required — (String)

      The Amazon S3 bucket name.

    • s3Key — required — (String)

      The list of S3 keys identifying the data source files.

  • tags — (map<String>)

    A map that contains tag keys and tag values that are attached to the world template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Amazon Resource Name (ARN) of the world template.

    • clientRequestToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • createdAt — (Date)

      The time, in milliseconds since the epoch, when the world template was created.

    • name — (String)

      The name of the world template.

    • tags — (map<String>)

      A map that contains tag keys and tag values that are attached to the world template.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  fleet: 'STRING_VALUE' /* required */
};
robomaker.deleteFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • fleet — (String)

    The Amazon Resource Name (ARN) of the fleet.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  robot: 'STRING_VALUE' /* required */
};
robomaker.deleteRobot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • robot — (String)

    The Amazon Resource Name (ARN) of the robot.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  applicationVersion: 'STRING_VALUE'
};
robomaker.deleteRobotApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

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

  • applicationVersion — (String)

    The version of the robot application to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  applicationVersion: 'STRING_VALUE'
};
robomaker.deleteSimulationApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The application information for the simulation application to delete.

  • applicationVersion — (String)

    The version of the simulation application to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  template: 'STRING_VALUE' /* required */
};
robomaker.deleteWorldTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • template — (String)

    The Amazon Resource Name (arn) of the world template you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  fleet: 'STRING_VALUE', /* required */
  robot: 'STRING_VALUE' /* required */
};
robomaker.deregisterRobot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • fleet — (String)

    The Amazon Resource Name (ARN) of the fleet.

  • robot — (String)

    The Amazon Resource Name (ARN) of the robot.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • fleet — (String)

      The Amazon Resource Name (ARN) of the fleet.

    • robot — (String)

      The Amazon Resource Name (ARN) of the robot.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  job: 'STRING_VALUE' /* required */
};
robomaker.describeDeploymentJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • job — (String)

    The Amazon Resource Name (ARN) of the deployment job.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Amazon Resource Name (ARN) of the deployment job.

    • fleet — (String)

      The Amazon Resource Name (ARN) of the fleet.

    • status — (String)

      The status of the deployment job.

      Possible values include:
      • "Pending"
      • "Preparing"
      • "InProgress"
      • "Failed"
      • "Succeeded"
      • "Canceled"
    • deploymentConfig — (map)

      The deployment configuration.

      • concurrentDeploymentPercentage — (Integer)

        The percentage of robots receiving the deployment at the same time.

      • failureThresholdPercentage — (Integer)

        The percentage of deployments that need to fail before stopping deployment.

      • robotDeploymentTimeoutInSeconds — (Integer)

        The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.

      • downloadConditionFile — (map)

        The download condition file.

        • bucket — required — (String)

          The bucket containing the object.

        • key — required — (String)

          The key of the object.

        • etag — (String)

          The etag of the object.

    • deploymentApplicationConfigs — (Array<map>)

      The deployment application configuration.

      • application — required — (String)

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

      • applicationVersion — required — (String)

        The version of the application.

      • launchConfig — required — (map)

        The launch configuration.

        • packageName — required — (String)

          The package name.

        • preLaunchFile — (String)

          The deployment pre-launch file. This file will be executed prior to the launch file.

        • launchFile — required — (String)

          The launch file name.

        • postLaunchFile — (String)

          The deployment post-launch file. This file will be executed after the launch file.

        • environmentVariables — (map<String>)

          An array of key/value pairs specifying environment variables for the robot application

    • failureReason — (String)

      A short description of the reason why the deployment job failed.

    • failureCode — (String)

      The deployment job failure code.

      Possible values include:
      • "ResourceNotFound"
      • "EnvironmentSetupError"
      • "EtagMismatch"
      • "FailureThresholdBreached"
      • "RobotDeploymentAborted"
      • "RobotDeploymentNoResponse"
      • "RobotAgentConnectionTimeout"
      • "GreengrassDeploymentFailed"
      • "InvalidGreengrassGroup"
      • "MissingRobotArchitecture"
      • "MissingRobotApplicationArchitecture"
      • "MissingRobotDeploymentResource"
      • "GreengrassGroupVersionDoesNotExist"
      • "LambdaDeleted"
      • "ExtractingBundleFailure"
      • "PreLaunchFileFailure"
      • "PostLaunchFileFailure"
      • "BadPermissionError"
      • "DownloadConditionFailed"
      • "BadLambdaAssociated"
      • "InternalServerError"
      • "RobotApplicationDoesNotExist"
      • "DeploymentFleetDoesNotExist"
      • "FleetDeploymentTimeout"
    • createdAt — (Date)

      The time, in milliseconds since the epoch, when the deployment job was created.

    • robotDeploymentSummary — (Array<map>)

      A list of robot deployment summaries.

      • arn — (String)

        The robot deployment Amazon Resource Name (ARN).

      • deploymentStartTime — (Date)

        The time, in milliseconds since the epoch, when the deployment was started.

      • deploymentFinishTime — (Date)

        The time, in milliseconds since the epoch, when the deployment finished.

      • status — (String)

        The status of the robot deployment.

        Possible values include:
        • "Available"
        • "Registered"
        • "PendingNewDeployment"
        • "Deploying"
        • "Failed"
        • "InSync"
        • "NoResponse"
      • progressDetail — (map)

        Information about how the deployment is progressing.

        • currentProgress — (String)

          The current progress status.

          Validating

          Validating the deployment.

          DownloadingExtracting

          Downloading and extracting the bundle on the robot.

          ExecutingPreLaunch

          Executing pre-launch script(s) if provided.

          Launching

          Launching the robot application.

          ExecutingPostLaunch

          Executing post-launch script(s) if provided.

          Finished

          Deployment is complete.

          Possible values include:
          • "Validating"
          • "DownloadingExtracting"
          • "ExecutingDownloadCondition"
          • "ExecutingPreLaunch"
          • "Launching"
          • "ExecutingPostLaunch"
          • "Finished"
        • percentDone — (Float)

          Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

        • estimatedTimeRemainingSeconds — (Integer)

          Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

        • targetResource — (String)

          The Amazon Resource Name (ARN) of the deployment job.

      • failureReason — (String)

        A short description of the reason why the robot deployment failed.

      • failureCode — (String)

        The robot deployment failure code.

        Possible values include:
        • "ResourceNotFound"
        • "EnvironmentSetupError"
        • "EtagMismatch"
        • "FailureThresholdBreached"
        • "RobotDeploymentAborted"
        • "RobotDeploymentNoResponse"
        • "RobotAgentConnectionTimeout"
        • "GreengrassDeploymentFailed"
        • "InvalidGreengrassGroup"
        • "MissingRobotArchitecture"
        • "MissingRobotApplicationArchitecture"
        • "MissingRobotDeploymentResource"
        • "GreengrassGroupVersionDoesNotExist"
        • "LambdaDeleted"
        • "ExtractingBundleFailure"
        • "PreLaunchFileFailure"
        • "PostLaunchFileFailure"
        • "BadPermissionError"
        • "DownloadConditionFailed"
        • "BadLambdaAssociated"
        • "InternalServerError"
        • "RobotApplicationDoesNotExist"
        • "DeploymentFleetDoesNotExist"
        • "FleetDeploymentTimeout"
    • tags — (map<String>)

      The list of all tags added to the specified deployment job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  fleet: 'STRING_VALUE' /* required */
};
robomaker.describeFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • fleet — (String)

    The Amazon Resource Name (ARN) of the fleet.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • name — (String)

      The name of the fleet.

    • arn — (String)

      The Amazon Resource Name (ARN) of the fleet.

    • robots — (Array<map>)

      A list of robots.

      • arn — (String)

        The Amazon Resource Name (ARN) of the robot.

      • name — (String)

        The name of the robot.

      • fleetArn — (String)

        The Amazon Resource Name (ARN) of the fleet.

      • status — (String)

        The status of the robot.

        Possible values include:
        • "Available"
        • "Registered"
        • "PendingNewDeployment"
        • "Deploying"
        • "Failed"
        • "InSync"
        • "NoResponse"
      • greenGrassGroupId — (String)

        The Greengrass group associated with the robot.

      • createdAt — (Date)

        The time, in milliseconds since the epoch, when the robot was created.

      • architecture — (String)

        The architecture of the robot.

        Possible values include:
        • "X86_64"
        • "ARM64"
        • "ARMHF"
      • lastDeploymentJob — (String)

        The Amazon Resource Name (ARN) of the last deployment job.

      • lastDeploymentTime — (Date)

        The time of the last deployment.

    • createdAt — (Date)

      The time, in milliseconds since the epoch, when the fleet was created.

    • lastDeploymentStatus — (String)

      The status of the last deployment.

      Possible values include:
      • "Pending"
      • "Preparing"
      • "InProgress"
      • "Failed"
      • "Succeeded"
      • "Canceled"
    • lastDeploymentJob — (String)

      The Amazon Resource Name (ARN) of the last deployment job.

    • lastDeploymentTime — (Date)

      The time of the last deployment.

    • tags — (map<String>)

      The list of all tags added to the specified fleet.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  robot: 'STRING_VALUE' /* required */
};
robomaker.describeRobot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • robot — (String)

    The Amazon Resource Name (ARN) of the robot to be described.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Amazon Resource Name (ARN) of the robot.

    • name — (String)

      The name of the robot.

    • fleetArn — (String)

      The Amazon Resource Name (ARN) of the fleet.

    • status — (String)

      The status of the fleet.

      Possible values include:
      • "Available"
      • "Registered"
      • "PendingNewDeployment"
      • "Deploying"
      • "Failed"
      • "InSync"
      • "NoResponse"
    • greengrassGroupId — (String)

      The Greengrass group id.

    • createdAt — (Date)

      The time, in milliseconds since the epoch, when the robot was created.

    • architecture — (String)

      The target architecture of the robot application.

      Possible values include:
      • "X86_64"
      • "ARM64"
      • "ARMHF"
    • lastDeploymentJob — (String)

      The Amazon Resource Name (ARN) of the last deployment job.

    • lastDeploymentTime — (Date)

      The time of the last deployment job.

    • tags — (map<String>)

      The list of all tags added to the specified robot.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  applicationVersion: 'STRING_VALUE'
};
robomaker.describeRobotApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

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

  • applicationVersion — (String)

    The version of the robot application to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Array<map>)

      The sources of the robot application.

      • 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.

        Possible values include:
        • "X86_64"
        • "ARM64"
        • "ARMHF"
    • robotSoftwareSuite — (map)

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

      • name — (String)

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

        Possible values include:
        • "ROS"
        • "ROS2"
        • "General"
      • version — (String)

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

        Possible values include:
        • "Kinetic"
        • "Melodic"
        • "Dashing"
        • "Foxy"
    • revisionId — (String)

      The revision id of the robot application.

    • lastUpdatedAt — (Date)

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

    • tags — (map<String>)

      The list of all tags added to the specified robot application.

    • environment — (map)

      The object that contains the Docker image URI used to create the robot application.

      • uri — (String)

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

    • imageDigest — (String)

      A SHA256 identifier for the Docker image that you use for your robot application.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  applicationVersion: 'STRING_VALUE'
};
robomaker.describeSimulationApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The application information for the simulation application.

  • applicationVersion — (String)

    The version of the simulation application to describe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

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

    • name — (String)

      The name of the simulation application.

    • version — (String)

      The version of the simulation application.

    • sources — (Array<map>)

      The sources of the simulation application.

      • 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.

        Possible values include:
        • "X86_64"
        • "ARM64"
        • "ARMHF"
    • simulationSoftwareSuite — (map)

      The simulation software suite used by the simulation application.

      • name — (String)

        The name of the simulation software suite.

        Possible values include:
        • "Gazebo"
        • "RosbagPlay"
        • "SimulationRuntime"
      • version — (String)

        The version of the simulation software suite.

    • robotSoftwareSuite — (map)

      Information about the robot software suite (ROS distribution).

      • name — (String)

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

        Possible values include:
        • "ROS"
        • "ROS2"
        • "General"
      • version — (String)

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

        Possible values include:
        • "Kinetic"
        • "Melodic"
        • "Dashing"
        • "Foxy"
    • renderingEngine — (map)

      The rendering engine for the simulation application.

      • name — (String)

        The name of the rendering engine.

        Possible values include:
        • "OGRE"
      • version — (String)

        The version of the rendering engine.

    • revisionId — (String)

      The revision id of the simulation application.

    • lastUpdatedAt — (Date)

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

    • tags — (map<String>)

      The list of all tags added to the specified simulation application.

    • environment — (map)

      The object that contains the Docker image URI used to create the simulation application.

      • uri — (String)

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

    • imageDigest — (String)

      A SHA256 identifier for the Docker image that you use for your simulation application.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  job: 'STRING_VALUE' /* required */
};
robomaker.describeSimulationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • job — (String)

    The Amazon Resource Name (ARN) of the simulation job to be described.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Amazon Resource Name (ARN) of the simulation job.

    • name — (String)

      The name of the simulation job.

    • status — (String)

      The status of the simulation job.

      Possible values include:
      • "Pending"
      • "Preparing"
      • "Running"
      • "Restarting"
      • "Completed"
      • "Failed"
      • "RunningFailed"
      • "Terminating"
      • "Terminated"
      • "Canceled"
    • lastStartedAt — (Date)

      The time, in milliseconds since the epoch, when the simulation job was last started.

    • lastUpdatedAt — (Date)

      The time, in milliseconds since the epoch, when the simulation job was last updated.

    • failureBehavior — (String)

      The failure behavior for the simulation job.

      Possible values include:
      • "Fail"
      • "Continue"
    • failureCode — (String)

      The failure code of the simulation job if it failed:

      InternalServiceError

      Internal service error.

      RobotApplicationCrash

      Robot application exited abnormally.

      SimulationApplicationCrash

      Simulation application exited abnormally.

      BadPermissionsRobotApplication

      Robot application bundle could not be downloaded.

      BadPermissionsSimulationApplication

      Simulation application bundle could not be downloaded.

      BadPermissionsS3Output

      Unable to publish outputs to customer-provided S3 bucket.

      BadPermissionsCloudwatchLogs

      Unable to publish logs to customer-provided CloudWatch Logs resource.

      SubnetIpLimitExceeded

      Subnet IP limit exceeded.

      ENILimitExceeded

      ENI limit exceeded.

      BadPermissionsUserCredentials

      Unable to use the Role provided.

      InvalidBundleRobotApplication

      Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

      InvalidBundleSimulationApplication

      Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

      RobotApplicationVersionMismatchedEtag

      Etag for RobotApplication does not match value during version creation.

      SimulationApplicationVersionMismatchedEtag

      Etag for SimulationApplication does not match value during version creation.

      Possible values include:
      • "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)

      Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.

    • clientRequestToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • outputLocation — (map)

      Location for output files generated by the simulation job.

      • s3Bucket — (String)

        The S3 bucket for output.

      • s3Prefix — (String)

        The S3 folder in the s3Bucket where output files will be placed.

    • loggingConfig — (map)

      The logging configuration.

      • recordAllRosTopics — (Boolean)

        A boolean indicating whether to record all ROS topics.

        This API is no longer supported and will throw an error if used.

    • maxJobDurationInSeconds — (Integer)

      The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.

    • simulationTimeMillis — (Integer)

      The simulation job execution duration in milliseconds.

    • iamRole — (String)

      The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.

    • robotApplications — (Array<map>)

      A list of robot applications.

      • application — required — (String)

        The application information for the robot application.

      • applicationVersion — (String)

        The version of the robot application.

      • launchConfig — required — (map)

        The launch configuration for the robot application.

        • packageName — (String)

          The package name.

        • launchFile — (String)

          The launch file name.

        • environmentVariables — (map<String>)

          The environment variables for the application launch.

        • portForwardingConfig — (map)

          The port forwarding configuration.

          • portMappings — (Array<map>)

            The port mappings for the configuration.

            • jobPort — required — (Integer)

              The port number on the simulation job instance to use as a remote connection point.

            • applicationPort — required — (Integer)

              The port number on the application.

            • enableOnPublicIp — (Boolean)

              A Boolean indicating whether to enable this port mapping on public IP.

        • streamUI — (Boolean)

          Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

        • command — (Array<String>)

          If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

          If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

      • uploadConfigurations — (Array<map>)

        The upload configurations for the robot application.

        • name — required — (String)

          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.

          For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

        • path — required — (String)

          Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

        • uploadBehavior — required — (String)

          Specifies when to upload the files:

          UPLOAD_ON_TERMINATE

          Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

          If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

          UPLOAD_ROLLING_AUTO_REMOVE

          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.

          Possible values include:
          • "UPLOAD_ON_TERMINATE"
          • "UPLOAD_ROLLING_AUTO_REMOVE"
      • useDefaultUploadConfigurations — (Boolean)

        A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

        If you set this value, you must specify an outputLocation.

        This API is no longer supported and will throw an error if used.

      • tools — (Array<map>)

        Information about tools configured for the robot application.

        • streamUI — (Boolean)

          Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

        • name — required — (String)

          The name of the tool.

        • command — required — (String)

          Command-line arguments for the tool. It must include the tool executable name.

        • streamOutputToCloudWatch — (Boolean)

          Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

        • exitBehavior — (String)

          Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

          Possible values include:
          • "FAIL"
          • "RESTART"
      • useDefaultTools — (Boolean)

        A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

        This API is no longer supported and will throw an error if used.

    • simulationApplications — (Array<map>)

      A list of simulation applications.

      • application — required — (String)

        The application information for the simulation application.

      • applicationVersion — (String)

        The version of the simulation application.

      • launchConfig — required — (map)

        The launch configuration for the simulation application.

        • packageName — (String)

          The package name.

        • launchFile — (String)

          The launch file name.

        • environmentVariables — (map<String>)

          The environment variables for the application launch.

        • portForwardingConfig — (map)

          The port forwarding configuration.

          • portMappings — (Array<map>)

            The port mappings for the configuration.

            • jobPort — required — (Integer)

              The port number on the simulation job instance to use as a remote connection point.

            • applicationPort — required — (Integer)

              The port number on the application.

            • enableOnPublicIp — (Boolean)

              A Boolean indicating whether to enable this port mapping on public IP.

        • streamUI — (Boolean)

          Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

        • command — (Array<String>)

          If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

          If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

      • uploadConfigurations — (Array<map>)

        Information about upload configurations for the simulation application.

        • name — required — (String)

          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.

          For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

        • path — required — (String)

          Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

        • uploadBehavior — required — (String)

          Specifies when to upload the files:

          UPLOAD_ON_TERMINATE

          Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

          If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

          UPLOAD_ROLLING_AUTO_REMOVE

          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.

          Possible values include:
          • "UPLOAD_ON_TERMINATE"
          • "UPLOAD_ROLLING_AUTO_REMOVE"
      • worldConfigs — (Array<map>)

        A list of world configurations.

        • world — (String)

          The world generated by Simulation WorldForge.

      • useDefaultUploadConfigurations — (Boolean)

        A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

        If you set this value, you must specify an outputLocation.

        This API is no longer supported and will throw an error if used.

      • tools — (Array<map>)

        Information about tools configured for the simulation application.

        • streamUI — (Boolean)

          Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

        • name — required — (String)

          The name of the tool.

        • command — required — (String)

          Command-line arguments for the tool. It must include the tool executable name.

        • streamOutputToCloudWatch — (Boolean)

          Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

        • exitBehavior — (String)

          Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

          Possible values include:
          • "FAIL"
          • "RESTART"
      • useDefaultTools — (Boolean)

        A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

        This API is no longer supported and will throw an error if used.

    • dataSources — (Array<map>)

      The data sources for the simulation job.

      • name — (String)

        The name of the data source.

      • s3Bucket — (String)

        The S3 bucket where the data files are located.

      • s3Keys — (Array<map>)

        The list of S3 keys identifying the data source files.

        • s3Key — (String)

          The S3 key.

        • etag — (String)

          The etag for the object.

      • type — (String)

        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.

        If you don't specify a field, the default value is File.

        Possible values include:
        • "Prefix"
        • "Archive"
        • "File"
      • destination — (String)

        The location where your files are mounted in the container image.

        If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

        If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

        If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

    • tags — (map<String>)

      The list of all tags added to the specified simulation job.

    • vpcConfig — (map)

      The VPC configuration.

      • subnets — (Array<String>)

        A list of subnet IDs associated with the simulation job.

      • securityGroups — (Array<String>)

        A list of security group IDs associated with the simulation job.

      • vpcId — (String)

        The VPC ID associated with your simulation job.

      • assignPublicIp — (Boolean)

        A boolean indicating if a public IP was assigned.

    • networkInterface — (map)

      The network interface information for the simulation job.

      • networkInterfaceId — (String)

        The ID of the network interface.

      • privateIpAddress — (String)

        The IPv4 address of the network interface within the subnet.

      • publicIpAddress — (String)

        The IPv4 public address of the network interface.

    • compute — (map)

      Compute information for the simulation job.

      • simulationUnitLimit — (Integer)

        The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.

      • computeType — (String)

        Compute type response information for the simulation job.

        Possible values include:
        • "CPU"
        • "GPU_AND_CPU"
      • gpuUnitLimit — (Integer)

        Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.