Class: AWS.RoboMaker

Inherits:
AWS.Service show all
Identifier:
robomaker
API Version:
2018-06-29
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This section provides documentation for the AWS RoboMaker API operations.

Sending a Request Using RoboMaker

var robomaker = new AWS.RoboMaker();
robomaker.batchDeleteWorlds(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the RoboMaker object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var robomaker = new AWS.RoboMaker({apiVersion: '2018-06-29'});

You can also set the API version globally in AWS.config.apiVersions using the robomaker service identifier:

AWS.config.apiVersions = {
  robomaker: '2018-06-29',
  // other service API versions
};

var robomaker = new AWS.RoboMaker();

Version:

  • 2018-06-29

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.RoboMaker(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a RoboMaker object

var robomaker = new AWS.RoboMaker({apiVersion: '2018-06-29'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.RoboMaker.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.RoboMaker.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.RoboMaker.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchDeleteWorlds(params = {}, callback) ⇒ AWS.Request

Deletes one or more worlds in a batch operation.

Service Reference:

Examples:

Calling the batchDeleteWorlds operation

var params = {
  worlds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
robomaker.batchDeleteWorlds(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: {})
    • worlds — (Array<String>)

      A list of Amazon Resource Names (arns) that correspond to worlds 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. The data object has the following properties:

      • unprocessedWorlds — (Array<String>)

        A list of unprocessed worlds associated with the call. These worlds were not deleted.

Returns:

  • (AWS.Request)

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

batchDescribeSimulationJob(params = {}, callback) ⇒ AWS.Request

Describes one or more simulation jobs.

Service Reference:

Examples:

Calling the batchDescribeSimulationJob operation

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

          Restart the simulation job in the same host instance.

          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"
          • "BadPermissionsRobotApplication"
          • "BadPermissionsSimulationApplication"
          • "BadPermissionsS3Object"
          • "BadPermissionsS3Output"
          • "BadPermissionsCloudwatchLogs"
          • "SubnetIpLimitExceeded"
          • "ENILimitExceeded"
          • "BadPermissionsUserCredentials"
          • "InvalidBundleRobotApplication"
          • "InvalidBundleSimulationApplication"
          • "InvalidS3Resource"
          • "LimitExceeded"
          • "MismatchedEtag"
          • "RobotApplicationVersionMismatchedEtag"
          • "SimulationApplicationVersionMismatchedEtag"
          • "ResourceNotFound"
          • "RequestThrottled"
          • "BatchTimedOut"
          • "BatchCanceled"
          • "InvalidInput"
          • "WrongRegionS3Bucket"
          • "WrongRegionS3Output"
          • "WrongRegionRobotApplication"
          • "WrongRegionSimulationApplication"
        • 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.

          • recordAllRosTopicsrequired — (Boolean)

            A boolean indicating whether to record all ROS topics.

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

          • applicationrequired — (String)

            The application information for the robot application.

          • applicationVersion — (String)

            The version of the robot application.

          • launchConfigrequired — (map)

            The launch configuration for the robot application.

            • packageNamerequired — (String)

              The package name.

            • launchFilerequired — (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.

                • jobPortrequired — (Integer)

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

                • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

        • simulationApplications — (Array<map>)

          A list of simulation applications.

          • applicationrequired — (String)

            The application information for the simulation application.

          • applicationVersion — (String)

            The version of the simulation application.

          • launchConfigrequired — (map)

            The launch configuration for the simulation application.

            • packageNamerequired — (String)

              The package name.

            • launchFilerequired — (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.

                • jobPortrequired — (Integer)

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

                • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

          • worldConfigs — (Array<map>)

            A list of world configurations.

            • world — (String)

              The world generated by Simulation WorldForge.

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

        • 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 maximim value provided. The default is 15.

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

cancelDeploymentJob(params = {}, callback) ⇒ AWS.Request

Cancels the specified deployment job.

Service Reference:

Examples:

Calling the cancelDeploymentJob operation

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.

cancelSimulationJob(params = {}, callback) ⇒ AWS.Request

Cancels the specified simulation job.

Service Reference:

Examples:

Calling the cancelSimulationJob operation

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.

cancelSimulationJobBatch(params = {}, callback) ⇒ AWS.Request

Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.

Service Reference:

Examples:

Calling the cancelSimulationJobBatch operation

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.

cancelWorldExportJob(params = {}, callback) ⇒ AWS.Request

Cancels the specified export job.

Service Reference:

Examples:

Calling the cancelWorldExportJob operation

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.

cancelWorldGenerationJob(params = {}, callback) ⇒ AWS.Request

Cancels the specified world generator job.

Service Reference:

Examples:

Calling the cancelWorldGenerationJob operation

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.

createDeploymentJob(params = {}, callback) ⇒ AWS.Request

Deploys a specific version of a robot application to robots in a fleet.

The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version.

Note: After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.

Service Reference:

Examples:

Calling the createDeploymentJob operation

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.

        • bucketrequired — (String)

          The bucket containing the object.

        • keyrequired — (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.

      • applicationrequired — (String)

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

      • applicationVersionrequired — (String)

        The version of the application.

      • launchConfigrequired — (map)

        The launch configuration.

        • packageNamerequired — (String)

          The package name.

        • preLaunchFile — (String)

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

        • launchFilerequired — (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.

        • applicationrequired — (String)

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

        • applicationVersionrequired — (String)

          The version of the application.

        • launchConfigrequired — (map)

          The launch configuration.

          • packageNamerequired — (String)

            The package name.

          • preLaunchFile — (String)

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

          • launchFilerequired — (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"
        • "InternalServerError"
      • 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.

          • bucketrequired — (String)

            The bucket containing the object.

          • keyrequired — (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.

createFleet(params = {}, callback) ⇒ AWS.Request

Creates a fleet, a logical group of robots running the same robot application.

Service Reference:

Examples:

Calling the createFleet operation

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.

createRobot(params = {}, callback) ⇒ AWS.Request

Creates a robot.

Service Reference:

Examples:

Calling the createRobot operation

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.

createRobotApplication(params = {}, callback) ⇒ AWS.Request

Creates a robot application.

Service Reference:

Examples:

Calling the createRobotApplication operation

var params = {
  name: 'STRING_VALUE', /* required */
  robotSoftwareSuite: { /* required */
    name: ROS | ROS2,
    version: Kinetic | Melodic | Dashing
  },
  sources: [ /* required */
    {
      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"
      • version — (String)

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

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

      A map that contains tag keys and tag values that are attached to the 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"
        • version — (String)

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

          Possible values include:
          • "Kinetic"
          • "Melodic"
          • "Dashing"
      • 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.

Returns:

  • (AWS.Request)

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

createRobotApplicationVersion(params = {}, callback) ⇒ AWS.Request

Creates a version of a robot application.

Service Reference:

Examples:

Calling the createRobotApplicationVersion operation

var params = {
  application: 'STRING_VALUE', /* required */
  currentRevisionId: 'STRING_VALUE'
};
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.

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"
        • version — (String)

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

          Possible values include:
          • "Kinetic"
          • "Melodic"
          • "Dashing"
      • 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.

Returns:

  • (AWS.Request)

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

createSimulationApplication(params = {}, callback) ⇒ AWS.Request

Creates a simulation application.

Service Reference:

Examples:

Calling the createSimulationApplication operation

var params = {
  name: 'STRING_VALUE', /* required */
  robotSoftwareSuite: { /* required */
    name: ROS | ROS2,
    version: Kinetic | Melodic | Dashing
  },
  simulationSoftwareSuite: { /* required */
    name: Gazebo | RosbagPlay,
    version: 'STRING_VALUE'
  },
  sources: [ /* required */
    {
      architecture: X86_64 | ARM64 | ARMHF,
      s3Bucket: 'STRING_VALUE',
      s3Key: 'STRING_VALUE'
    },
    /* more items */
  ],
  renderingEngine: {
    name: OGRE,
    version: 'STRING_VALUE'
  },
  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"
      • 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"
      • version — (String)

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

        Possible values include:
        • "Kinetic"
        • "Melodic"
        • "Dashing"
    • 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.

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"
        • 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"
        • version — (String)

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

          Possible values include:
          • "Kinetic"
          • "Melodic"
          • "Dashing"
      • 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.

Returns:

  • (AWS.Request)

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

createSimulationApplicationVersion(params = {}, callback) ⇒ AWS.Request

Creates a simulation application with a specific revision id.

Examples:

Calling the createSimulationApplicationVersion operation

var params = {
  application: 'STRING_VALUE', /* required */
  currentRevisionId: 'STRING_VALUE'
};
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.

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"
        • 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"
        • version — (String)

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

          Possible values include:
          • "Kinetic"
          • "Melodic"
          • "Dashing"
      • 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.

Returns:

  • (AWS.Request)

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

createSimulationJob(params = {}, callback) ⇒ AWS.Request

Creates a simulation job.

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

Service Reference:

Examples:

Calling the createSimulationJob operation

var params = {
  iamRole: 'STRING_VALUE', /* required */
  maxJobDurationInSeconds: 'NUMBER_VALUE', /* required */
  clientRequestToken: 'STRING_VALUE',
  compute: {
    simulationUnitLimit: 'NUMBER_VALUE'
  },
  dataSources: [
    {
      name: 'STRING_VALUE', /* required */
      s3Bucket: 'STRING_VALUE', /* required */
      s3Keys: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  failureBehavior: Fail | Continue,
  loggingConfig: {
    recordAllRosTopics: true || false /* required */
  },
  outputLocation: {
    s3Bucket: 'STRING_VALUE',
    s3Prefix: 'STRING_VALUE'
  },
  robotApplications: [
    {
      application: 'STRING_VALUE', /* required */
      launchConfig: { /* required */
        launchFile: 'STRING_VALUE', /* required */
        packageName: 'STRING_VALUE', /* required */
        environmentVariables: {
          '<EnvironmentVariableKey>': 'STRING_VALUE',
          /* '<EnvironmentVariableKey>': ... */
        },
        portForwardingConfig: {
          portMappings: [
            {
              applicationPort: 'NUMBER_VALUE', /* required */
              jobPort: 'NUMBER_VALUE', /* required */
              enableOnPublicIp: true || false
            },
            /* more items */
          ]
        },
        streamUI: true || false
      },
      applicationVersion: 'STRING_VALUE'
    },
    /* more items */
  ],
  simulationApplications: [
    {
      application: 'STRING_VALUE', /* required */
      launchConfig: { /* required */
        launchFile: 'STRING_VALUE', /* required */
        packageName: 'STRING_VALUE', /* required */
        environmentVariables: {
          '<EnvironmentVariableKey>': 'STRING_VALUE',
          /* '<EnvironmentVariableKey>': ... */
        },
        portForwardingConfig: {
          portMappings: [
            {
              applicationPort: 'NUMBER_VALUE', /* required */
              jobPort: 'NUMBER_VALUE', /* required */
              enableOnPublicIp: true || false
            },
            /* more items */
          ]
        },
        streamUI: true || false
      },
      applicationVersion: 'STRING_VALUE',
      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.

      • recordAllRosTopicsrequired — (Boolean)

        A boolean indicating whether to record all ROS topics.

    • 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

      Restart the simulation job in the same host instance.

      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.

      • applicationrequired — (String)

        The application information for the robot application.

      • applicationVersion — (String)

        The version of the robot application.

      • launchConfigrequired — (map)

        The launch configuration for the robot application.

        • packageNamerequired — (String)

          The package name.

        • launchFilerequired — (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.

            • jobPortrequired — (Integer)

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

            • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

    • simulationApplications — (Array<map>)

      The simulation application to use in the simulation job.

      • applicationrequired — (String)

        The application information for the simulation application.

      • applicationVersion — (String)

        The version of the simulation application.

      • launchConfigrequired — (map)

        The launch configuration for the simulation application.

        • packageNamerequired — (String)

          The package name.

        • launchFilerequired — (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.

            • jobPortrequired — (Integer)

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

            • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

      • worldConfigs — (Array<map>)

        A list of world configurations.

        • world — (String)

          The world generated by Simulation WorldForge.

    • 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.
      • namerequired — (String)

        The name of the data source.

      • s3Bucketrequired — (String)

        The S3 bucket where the data files are located.

      • s3Keysrequired — (Array<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 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.

      • subnetsrequired — (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 maximim value provided. The default is 15.

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"
        • "BadPermissionsRobotApplication"
        • "BadPermissionsSimulationApplication"
        • "BadPermissionsS3Object"
        • "BadPermissionsS3Output"
        • "BadPermissionsCloudwatchLogs"
        • "SubnetIpLimitExceeded"
        • "ENILimitExceeded"
        • "BadPermissionsUserCredentials"
        • "InvalidBundleRobotApplication"
        • "InvalidBundleSimulationApplication"
        • "InvalidS3Resource"
        • "LimitExceeded"
        • "MismatchedEtag"
        • "RobotApplicationVersionMismatchedEtag"
        • "SimulationApplicationVersionMismatchedEtag"
        • "ResourceNotFound"
        • "RequestThrottled"
        • "BatchTimedOut"
        • "BatchCanceled"
        • "InvalidInput"
        • "WrongRegionS3Bucket"
        • "WrongRegionS3Output"
        • "WrongRegionRobotApplication"
        • "WrongRegionSimulationApplication"
      • 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.

        • recordAllRosTopicsrequired — (Boolean)

          A boolean indicating whether to record all ROS topics.

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

        • applicationrequired — (String)

          The application information for the robot application.

        • applicationVersion — (String)

          The version of the robot application.

        • launchConfigrequired — (map)

          The launch configuration for the robot application.

          • packageNamerequired — (String)

            The package name.

          • launchFilerequired — (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.

              • jobPortrequired — (Integer)

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

              • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

      • simulationApplications — (Array<map>)

        The simulation application used by the simulation job.

        • applicationrequired — (String)

          The application information for the simulation application.

        • applicationVersion — (String)

          The version of the simulation application.

        • launchConfigrequired — (map)

          The launch configuration for the simulation application.

          • packageNamerequired — (String)

            The package name.

          • launchFilerequired — (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.

              • jobPortrequired — (Integer)

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

              • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

        • worldConfigs — (Array<map>)

          A list of world configurations.

          • world — (String)

            The world generated by Simulation WorldForge.

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

      • 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 maximim value provided. The default is 15.

Returns:

  • (AWS.Request)

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

createWorldExportJob(params = {}, callback) ⇒ AWS.Request

Creates a world export job.

Service Reference:

Examples:

Calling the createWorldExportJob operation

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.

createWorldGenerationJob(params = {}, callback) ⇒ AWS.Request

Creates worlds using the specified template.

Service Reference:

Examples:

Calling the createWorldGenerationJob operation

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.

createWorldTemplate(params = {}, callback) ⇒ AWS.Request

Creates a world template.

Service Reference:

Examples:

Calling the createWorldTemplate operation

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.

      • s3Bucketrequired — (String)

        The Amazon S3 bucket name.

      • s3Keyrequired — (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.

deleteFleet(params = {}, callback) ⇒ AWS.Request

Deletes a fleet.

Service Reference:

Examples:

Calling the deleteFleet operation

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.

deleteRobot(params = {}, callback) ⇒ AWS.Request

Deletes a robot.

Service Reference:

Examples:

Calling the deleteRobot operation

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.

deleteRobotApplication(params = {}, callback) ⇒ AWS.Request

Deletes a robot application.

Service Reference:

Examples:

Calling the deleteRobotApplication operation

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.

deleteSimulationApplication(params = {}, callback) ⇒ AWS.Request

Deletes a simulation application.

Service Reference:

Examples:

Calling the deleteSimulationApplication operation

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.

deleteWorldTemplate(params = {}, callback) ⇒ AWS.Request

Deletes a world template.

Service Reference:

Examples:

Calling the deleteWorldTemplate operation

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.

deregisterRobot(params = {}, callback) ⇒ AWS.Request

Deregisters a robot.

Service Reference:

Examples:

Calling the deregisterRobot operation

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.

describeDeploymentJob(params = {}, callback) ⇒ AWS.Request

Describes a deployment job.

Service Reference:

Examples:

Calling the describeDeploymentJob operation

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.

          • bucketrequired — (String)

            The bucket containing the object.

          • keyrequired — (String)

            The key of the object.

          • etag — (String)

            The etag of the object.

      • deploymentApplicationConfigs — (Array<map>)

        The deployment application configuration.

        • applicationrequired — (String)

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

        • applicationVersionrequired — (String)

          The version of the application.

        • launchConfigrequired — (map)

          The launch configuration.

          • packageNamerequired — (String)

            The package name.

          • preLaunchFile — (String)

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

          • launchFilerequired — (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"
        • "InternalServerError"
      • 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"
          • "InternalServerError"
      • 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.

describeFleet(params = {}, callback) ⇒ AWS.Request

Describes a fleet.

Service Reference:

Examples:

Calling the describeFleet operation

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.

describeRobot(params = {}, callback) ⇒ AWS.Request

Describes a robot.

Service Reference:

Examples:

Calling the describeRobot operation

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.

describeRobotApplication(params = {}, callback) ⇒ AWS.Request

Describes a robot application.

Service Reference:

Examples:

Calling the describeRobotApplication operation

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"
        • version — (String)

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

          Possible values include:
          • "Kinetic"
          • "Melodic"
          • "Dashing"
      • 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.

Returns:

  • (AWS.Request)

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

describeSimulationApplication(params = {}, callback) ⇒ AWS.Request

Describes a simulation application.

Service Reference:

Examples:

Calling the describeSimulationApplication operation

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"
        • 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"
        • version — (String)

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

          Possible values include:
          • "Kinetic"
          • "Melodic"
          • "Dashing"
      • 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.

Returns:

  • (AWS.Request)

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

describeSimulationJob(params = {}, callback) ⇒ AWS.Request

Describes a simulation job.

Service Reference:

Examples:

Calling the describeSimulationJob operation

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"
        • "BadPermissionsRobotApplication"
        • "BadPermissionsSimulationApplication"
        • "BadPermissionsS3Object"
        • "BadPermissionsS3Output"
        • "BadPermissionsCloudwatchLogs"
        • "SubnetIpLimitExceeded"
        • "ENILimitExceeded"
        • "BadPermissionsUserCredentials"
        • "InvalidBundleRobotApplication"
        • "InvalidBundleSimulationApplication"
        • "InvalidS3Resource"
        • "LimitExceeded"
        • "MismatchedEtag"
        • "RobotApplicationVersionMismatchedEtag"
        • "SimulationApplicationVersionMismatchedEtag"
        • "ResourceNotFound"
        • "RequestThrottled"
        • "BatchTimedOut"
        • "BatchCanceled"
        • "InvalidInput"
        • "WrongRegionS3Bucket"
        • "WrongRegionS3Output"
        • "WrongRegionRobotApplication"
        • "WrongRegionSimulationApplication"
      • 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.

        • recordAllRosTopicsrequired — (Boolean)

          A boolean indicating whether to record all ROS topics.

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

        • applicationrequired — (String)

          The application information for the robot application.

        • applicationVersion — (String)

          The version of the robot application.

        • launchConfigrequired — (map)

          The launch configuration for the robot application.

          • packageNamerequired — (String)

            The package name.

          • launchFilerequired — (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.

              • jobPortrequired — (Integer)

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

              • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

      • simulationApplications — (Array<map>)

        A list of simulation applications.

        • applicationrequired — (String)

          The application information for the simulation application.

        • applicationVersion — (String)

          The version of the simulation application.

        • launchConfigrequired — (map)

          The launch configuration for the simulation application.

          • packageNamerequired — (String)

            The package name.

          • launchFilerequired — (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.

              • jobPortrequired — (Integer)

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

              • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

        • worldConfigs — (Array<map>)

          A list of world configurations.

          • world — (String)

            The world generated by Simulation WorldForge.

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

      • 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 maximim value provided. The default is 15.

Returns:

  • (AWS.Request)

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

describeSimulationJobBatch(params = {}, callback) ⇒ AWS.Request

Describes a simulation job batch.

Service Reference:

Examples:

Calling the describeSimulationJobBatch operation

var params = {
  batch: 'STRING_VALUE' /* required */
};
robomaker.describeSimulationJobBatch(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 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 batch.

      • status — (String)

        The status of the batch.

        Pending

        The simulation job batch request is pending.

        InProgress

        The simulation job batch is in progress.

        Failed

        The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

        Completed

        The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

        Canceled

        The simulation batch job was cancelled.

        Canceling

        The simulation batch job is being cancelled.

        Completing

        The simulation batch job is completing.

        TimingOut

        The simulation job batch is timing out.

        If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

        TimedOut

        The simulation batch job timed out.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Completed"
        • "Canceled"
        • "Canceling"
        • "Completing"
        • "TimingOut"
        • "TimedOut"
      • lastUpdatedAt — (Date)

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

      • createdAt — (Date)

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

      • clientRequestToken — (String)

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

      • batchPolicy — (map)

        The batch policy.

        • timeoutInSeconds — (Integer)

          The amount of time, in seconds, to wait for the batch to complete.

          If a batch times out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), they will be moved to the failed list and the batch status will be Failed. If the pending requests were failing for any other reason, the failed pending requests will be moved to the failed list and the batch status will be TimedOut.

        • maxConcurrency — (Integer)

          The number of active simulation jobs create as part of the batch that can be in an active state at the same time.

          Active states include: Pending,Preparing, Running, Restarting, RunningFailed and Terminating. All other states are terminal states.

      • failureCode — (String)

        The failure code of the simulation job batch.

        Possible values include:
        • "InternalServiceError"
      • failureReason — (String)

        The reason the simulation job batch failed.

      • failedRequests — (Array<map>)

        A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

        • request — (map)

          The simulation job 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.

          • loggingConfig — (map)

            The logging configuration.

            • recordAllRosTopicsrequired — (Boolean)

              A boolean indicating whether to record all ROS topics.

          • maxJobDurationInSecondsrequired — (Integer)

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

          • 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

            Restart the simulation job in the same host instance.

            Fail

            Stop the simulation job and terminate the instance.

            Possible values include:
            • "Fail"
            • "Continue"
          • useDefaultApplications — (Boolean)

            Boolean indicating whether to use default simulation tool applications.

          • robotApplications — (Array<map>)

            The robot applications to use in the simulation job.

            • applicationrequired — (String)

              The application information for the robot application.

            • applicationVersion — (String)

              The version of the robot application.

            • launchConfigrequired — (map)

              The launch configuration for the robot application.

              • packageNamerequired — (String)

                The package name.

              • launchFilerequired — (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.

                  • jobPortrequired — (Integer)

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

                  • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

          • simulationApplications — (Array<map>)

            The simulation applications to use in the simulation job.

            • applicationrequired — (String)

              The application information for the simulation application.

            • applicationVersion — (String)

              The version of the simulation application.

            • launchConfigrequired — (map)

              The launch configuration for the simulation application.

              • packageNamerequired — (String)

                The package name.

              • launchFilerequired — (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.

                  • jobPortrequired — (Integer)

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

                  • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

            • worldConfigs — (Array<map>)

              A list of world configurations.

              • world — (String)

                The world generated by Simulation WorldForge.

          • 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.
            • namerequired — (String)

              The name of the data source.

            • s3Bucketrequired — (String)

              The S3 bucket where the data files are located.

            • s3Keysrequired — (Array<String>)

              The list of S3 keys identifying the data source files.

          • 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 two subnet IDs.

            • subnetsrequired — (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 maximim value provided. The default is 15.

          • tags — (map<String>)

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

        • failureReason — (String)

          The failure reason of the simulation job request.

        • failureCode — (String)

          The failure code.

          Possible values include:
          • "InternalServiceError"
          • "RobotApplicationCrash"
          • "SimulationApplicationCrash"
          • "BadPermissionsRobotApplication"
          • "BadPermissionsSimulationApplication"
          • "BadPermissionsS3Object"
          • "BadPermissionsS3Output"
          • "BadPermissionsCloudwatchLogs"
          • "SubnetIpLimitExceeded"
          • "ENILimitExceeded"
          • "BadPermissionsUserCredentials"
          • "InvalidBundleRobotApplication"
          • "InvalidBundleSimulationApplication"
          • "InvalidS3Resource"
          • "LimitExceeded"
          • "MismatchedEtag"
          • "RobotApplicationVersionMismatchedEtag"
          • "SimulationApplicationVersionMismatchedEtag"
          • "ResourceNotFound"
          • "RequestThrottled"
          • "BatchTimedOut"
          • "BatchCanceled"
          • "InvalidInput"
          • "WrongRegionS3Bucket"
          • "WrongRegionS3Output"
          • "WrongRegionRobotApplication"
          • "WrongRegionSimulationApplication"
        • failedAt — (Date)

          The time, in milliseconds since the epoch, when the simulation job batch failed.

      • pendingRequests — (Array<map>)

        A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

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

        • loggingConfig — (map)

          The logging configuration.

          • recordAllRosTopicsrequired — (Boolean)

            A boolean indicating whether to record all ROS topics.

        • maxJobDurationInSecondsrequired — (Integer)

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

        • 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

          Restart the simulation job in the same host instance.

          Fail

          Stop the simulation job and terminate the instance.

          Possible values include:
          • "Fail"
          • "Continue"
        • useDefaultApplications — (Boolean)

          Boolean indicating whether to use default simulation tool applications.

        • robotApplications — (Array<map>)

          The robot applications to use in the simulation job.

          • applicationrequired — (String)

            The application information for the robot application.

          • applicationVersion — (String)

            The version of the robot application.

          • launchConfigrequired — (map)

            The launch configuration for the robot application.

            • packageNamerequired — (String)

              The package name.

            • launchFilerequired — (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.

                • jobPortrequired — (Integer)

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

                • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

        • simulationApplications — (Array<map>)

          The simulation applications to use in the simulation job.

          • applicationrequired — (String)

            The application information for the simulation application.

          • applicationVersion — (String)

            The version of the simulation application.

          • launchConfigrequired — (map)

            The launch configuration for the simulation application.

            • packageNamerequired — (String)

              The package name.

            • launchFilerequired — (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.

                • jobPortrequired — (Integer)

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

                • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

          • worldConfigs — (Array<map>)

            A list of world configurations.

            • world — (String)

              The world generated by Simulation WorldForge.

        • 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.
          • namerequired — (String)

            The name of the data source.

          • s3Bucketrequired — (String)

            The S3 bucket where the data files are located.

          • s3Keysrequired — (Array<String>)

            The list of S3 keys identifying the data source files.

        • 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 two subnet IDs.

          • subnetsrequired — (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 maximim value provided. The default is 15.

        • tags — (map<String>)

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

      • createdRequests — (Array<map>)

        A list of created simulation job summaries.

        • arn — (String)

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

        • lastUpdatedAt — (Date)

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

        • 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"
        • simulationApplicationNames — (Array<String>)

          A list of simulation job simulation application names.

        • robotApplicationNames — (Array<String>)

          A list of simulation job robot application names.

        • dataSourceNames — (Array<String>)

          The names of the data sources.

      • tags — (map<String>)

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

Returns:

  • (AWS.Request)

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

describeWorld(params = {}, callback) ⇒ AWS.Request

Describes a world.

Service Reference:

Examples:

Calling the describeWorld operation

var params = {
  world: 'STRING_VALUE' /* required */
};
robomaker.describeWorld(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: {})
    • world — (String)

      The Amazon Resource Name (arn) of the world you want 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 world.

      • generationJob — (String)

        The Amazon Resource Name (arn) of the world generation job that generated the world.

      • template — (String)

        The world template.

      • createdAt — (Date)

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

      • tags — (map<String>)

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

Returns:

  • (AWS.Request)

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

describeWorldExportJob(params = {}, callback) ⇒ AWS.Request

Describes a world export job.

Service Reference:

Examples:

Calling the describeWorldExportJob operation

var params = {
  job: 'STRING_VALUE' /* required */
};
robomaker.describeWorldExportJob(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 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 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 and failureReason 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.

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

        The reason why the world export job failed.

      • clientRequestToken — (String)

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

      • worlds — (Array<String>)

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

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

describeWorldGenerationJob(params = {}, callback) ⇒ AWS.Request

Describes a world generation job.

Service Reference:

Examples:

Calling the describeWorldGenerationJob operation

var params = {
  job: 'STRING_VALUE' /* required */
};
robomaker.describeWorldGenerationJob(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 generation job 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 world generation job.

      • status — (String)

        The status of the world generation job:

        Pending

        The world generation job request is pending.

        Running

        The world generation job is running.

        Completed

        The world generation job completed.

        Failed

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

        PartialFailed

        Some worlds did not generate.

        Canceled

        The world generation job was cancelled.

        Canceling

        The world generation 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 generation job was created.

      • failureCode — (String)

        The failure code of the world generation 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"
      • failureReason — (String)

        The reason why the world generation job failed.

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

      • finishedWorldsSummary — (map)

        Summary information about finished worlds.

        • finishedCount — (Integer)

          The total number of finished worlds.

        • succeededWorlds — (Array<String>)

          A list of worlds that succeeded.

        • failureSummary — (map)

          Information about worlds that failed.

          • totalFailureCount — (Integer)

            The total number of failures.

          • failures — (Array<map>)

            The worlds that failed.

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

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

              The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason.

            • failureCount — (Integer)

              The number of failed worlds.

      • tags — (map<String>)

        A map that contains tag keys and tag values that are attached to the world generation 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.

describeWorldTemplate(params = {}, callback) ⇒ AWS.Request

Describes a world template.

Service Reference:

Examples:

Calling the describeWorldTemplate operation

var params = {
  template: 'STRING_VALUE' /* required */
};
robomaker.describeWorldTemplate(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 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 world template.

      • clientRequestToken — (String)

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

      • name — (String)

        The name of the world template.

      • createdAt — (Date)

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

      • lastUpdatedAt — (Date)

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

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

getWorldTemplateBody(params = {}, callback) ⇒ AWS.Request

Gets the world template body.

Service Reference:

Examples:

Calling the getWorldTemplateBody operation

var params = {
  generationJob: 'STRING_VALUE',
  template: 'STRING_VALUE'
};
robomaker.getWorldTemplateBody(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.

    • generationJob — (String)

      The Amazon Resource Name (arn) of the world generator 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:

      • templateBody — (String)

        The world template body.

Returns:

  • (AWS.Request)

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

listDeploymentJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

Service Reference:

Examples:

Calling the listDeploymentJobs operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
robomaker.listDeploymentJobs(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: {})
    • filters — (Array<map>)

      Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

      • name — (String)

        The name of the filter.

      • values — (Array<String>)

        A list of values.

    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • maxResults — (Integer)

      When this parameter is used, ListDeploymentJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs returns up to 200 results and a nextToken value if applicable.

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:

      • deploymentJobs — (Array<map>)

        A list of deployment jobs that meet the criteria of the request.

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

          The deployment application configuration.

          • applicationrequired — (String)

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

          • applicationVersionrequired — (String)

            The version of the application.

          • launchConfigrequired — (map)

            The launch configuration.

            • packageNamerequired — (String)

              The package name.

            • preLaunchFile — (String)

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

            • launchFilerequired — (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

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

            • bucketrequired — (String)

              The bucket containing the object.

            • keyrequired — (String)

              The key of the object.

            • etag — (String)

              The etag of the object.

        • 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"
          • "InternalServerError"
        • createdAt — (Date)

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

      • nextToken — (String)

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

listFleets(params = {}, callback) ⇒ AWS.Request

Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.

Service Reference:

Examples:

Calling the listFleets operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
robomaker.listFleets(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: {})
    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

      Note: This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
    • maxResults — (Integer)

      When this parameter is used, ListFleets only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListFleets returns up to 200 results and a nextToken value if applicable.

    • filters — (Array<map>)

      Optional filters to limit results.

      The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

      • name — (String)

        The name of the filter.

      • values — (Array<String>)

        A list of values.

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:

      • fleetDetails — (Array<map>)

        A list of fleet details meeting the request criteria.

        • name — (String)

          The name of the fleet.

        • arn — (String)

          The Amazon Resource Name (ARN) of the fleet.

        • createdAt — (Date)

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

        • lastDeploymentStatus — (String)

          The status of the last fleet 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.

      • nextToken — (String)

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

listRobotApplications(params = {}, callback) ⇒ AWS.Request

Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.

Service Reference:

Examples:

Calling the listRobotApplications operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  versionQualifier: 'STRING_VALUE'
};
robomaker.listRobotApplications(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: {})
    • versionQualifier — (String)

      The version qualifier of the robot application.

    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • maxResults — (Integer)

      When this parameter is used, ListRobotApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.

    • filters — (Array<map>)

      Optional filters to limit results.

      The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

      • name — (String)

        The name of the filter.

      • values — (Array<String>)

        A list of values.

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:

      • robotApplicationSummaries — (Array<map>)

        A list of robot application summaries that meet the criteria of the request.

        • name — (String)

          The name of the robot application.

        • arn — (String)

          The Amazon Resource Name (ARN) of the robot.

        • version — (String)

          The version of the robot application.

        • lastUpdatedAt — (Date)

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

        • robotSoftwareSuite — (map)

          Information about a robot software suite (ROS distribution).

          • name — (String)

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

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

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

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

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

listRobots(params = {}, callback) ⇒ AWS.Request

Returns a list of robots. You can optionally provide filters to retrieve specific robots.

Service Reference:

Examples:

Calling the listRobots operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
robomaker.listRobots(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: {})
    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • maxResults — (Integer)

      When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.

    • filters — (Array<map>)

      Optional filters to limit results.

      The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

      • name — (String)

        The name of the filter.

      • values — (Array<String>)

        A list of values.

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:

      • robots — (Array<map>)

        A list of robots that meet the criteria of the request.

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

      • nextToken — (String)

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

listSimulationApplications(params = {}, callback) ⇒ AWS.Request

Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.

Service Reference:

Examples:

Calling the listSimulationApplications operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  versionQualifier: 'STRING_VALUE'
};
robomaker.listSimulationApplications(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: {})
    • versionQualifier — (String)

      The version qualifier of the simulation application.

    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • maxResults — (Integer)

      When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable.

    • filters — (Array<map>)

      Optional list of filters to limit results.

      The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

      • name — (String)

        The name of the filter.

      • values — (Array<String>)

        A list of values.

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:

      • simulationApplicationSummaries — (Array<map>)

        A list of simulation application summaries that meet the criteria of the request.

        • name — (String)

          The name of the simulation application.

        • arn — (String)

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

        • version — (String)

          The version of the simulation application.

        • lastUpdatedAt — (Date)

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

        • robotSoftwareSuite — (map)

          Information about a robot software suite (ROS distribution).

          • name — (String)

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

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

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

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

          Information about a simulation software suite.

          • name — (String)

            The name of the simulation software suite.

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

            The version of the simulation software suite.

      • nextToken — (String)

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

listSimulationJobBatches(params = {}, callback) ⇒ AWS.Request

Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.

Service Reference:

Examples:

Calling the listSimulationJobBatches operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
robomaker.listSimulationJobBatches(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: {})
    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • maxResults — (Integer)

      When this parameter is used, ListSimulationJobBatches only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobBatches request with the returned nextToken value.

    • filters — (Array<map>)

      Optional filters to limit results.

      • name — (String)

        The name of the filter.

      • values — (Array<String>)

        A list of values.

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:

      • simulationJobBatchSummaries — (Array<map>)

        A list of simulation job batch summaries.

        • arn — (String)

          The Amazon Resource Name (ARN) of the batch.

        • lastUpdatedAt — (Date)

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

        • createdAt — (Date)

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

        • status — (String)

          The status of the simulation job batch.

          Pending

          The simulation job batch request is pending.

          InProgress

          The simulation job batch is in progress.

          Failed

          The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

          Completed

          The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

          Canceled

          The simulation batch job was cancelled.

          Canceling

          The simulation batch job is being cancelled.

          Completing

          The simulation batch job is completing.

          TimingOut

          The simulation job batch is timing out.

          If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

          TimedOut

          The simulation batch job timed out.

          Possible values include:
          • "Pending"
          • "InProgress"
          • "Failed"
          • "Completed"
          • "Canceled"
          • "Canceling"
          • "Completing"
          • "TimingOut"
          • "TimedOut"
        • failedRequestCount — (Integer)

          The number of failed simulation job requests.

        • pendingRequestCount — (Integer)

          The number of pending simulation job requests.

        • createdRequestCount — (Integer)

          The number of created simulation job requests.

      • nextToken — (String)

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

listSimulationJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.

Service Reference:

Examples:

Calling the listSimulationJobs operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
robomaker.listSimulationJobs(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: {})
    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • maxResults — (Integer)

      When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable.

    • filters — (Array<map>)

      Optional filters to limit results.

      The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

      • name — (String)

        The name of the filter.

      • values — (Array<String>)

        A list of values.

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:

      • simulationJobSummaries — (Array<map>)

        A list of simulation job summaries that meet the criteria of the request.

        • arn — (String)

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

        • lastUpdatedAt — (Date)

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

        • 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"
        • simulationApplicationNames — (Array<String>)

          A list of simulation job simulation application names.

        • robotApplicationNames — (Array<String>)

          A list of simulation job robot application names.

        • dataSourceNames — (Array<String>)

          The names of the data sources.

      • nextToken — (String)

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags on a AWS RoboMaker resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
robomaker.listTagsForResource(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: {})
    • resourceArn — (String)

      The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.

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:

      • tags — (map<String>)

        The list of all tags added to the specified resource.

Returns:

  • (AWS.Request)

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

listWorldExportJobs(params = {}, callback) ⇒ AWS.Request

Lists world export jobs.

Service Reference:

Examples:

Calling the listWorldExportJobs operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
robomaker.listWorldExportJobs(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: {})
    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • maxResults — (Integer)

      When this parameter is used, ListWorldExportJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldExportJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldExportJobs returns up to 100 results and a nextToken value if applicable.

    • filters — (Array<map>)

      Optional filters to limit results. You can use generationJobId and templateId.

      • name — (String)

        The name of the filter.

      • values — (Array<String>)

        A list of values.

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:

      • worldExportJobSummaries — (Array<map>)

        Summary information for world export jobs.

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

        • worlds — (Array<String>)

          A list of worlds.

      • nextToken — (String)

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

listWorldGenerationJobs(params = {}, callback) ⇒ AWS.Request

Lists world generator jobs.

Service Reference:

Examples:

Calling the listWorldGenerationJobs operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
robomaker.listWorldGenerationJobs(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: {})
    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGenerationJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • maxResults — (Integer)

      When this parameter is used, ListWorldGeneratorJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldGeneratorJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs returns up to 100 results and a nextToken value if applicable.

    • filters — (Array<map>)

      Optional filters to limit results. You can use status and templateId.

      • name — (String)

        The name of the filter.

      • values — (Array<String>)

        A list of values.

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:

      • worldGenerationJobSummaries — (Array<map>)

        Summary information for world generator jobs.

        • arn — (String)

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

        • template — (String)

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

        • createdAt — (Date)

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

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

          Information about the world count.

          • floorplanCount — (Integer)

            The number of unique floorplans.

          • interiorCountPerFloorplan — (Integer)

            The number of unique interiors per floorplan.

        • succeededWorldCount — (Integer)

          The number of worlds that were generated.

        • failedWorldCount — (Integer)

          The number of worlds that failed.

      • nextToken — (String)

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGeneratorJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

listWorlds(params = {}, callback) ⇒ AWS.Request

Lists worlds.

Service Reference:

Examples:

Calling the listWorlds operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
robomaker.listWorlds(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: {})
    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • maxResults — (Integer)

      When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

    • filters — (Array<map>)

      Optional filters to limit results. You can use status.

      • name — (String)

        The name of the filter.

      • values — (Array<String>)

        A list of values.

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:

      • worldSummaries — (Array<map>)

        Summary information for worlds.

        • arn — (String)

          The Amazon Resource Name (ARN) of the world.

        • createdAt — (Date)

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

        • generationJob — (String)

          The Amazon Resource Name (arn) of the world generation job.

        • template — (String)

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

      • nextToken — (String)

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

listWorldTemplates(params = {}, callback) ⇒ AWS.Request

Lists world templates.

Service Reference:

Examples:

Calling the listWorldTemplates operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
robomaker.listWorldTemplates(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: {})
    • nextToken — (String)

      If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • maxResults — (Integer)

      When this parameter is used, ListWorldTemplates only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldTemplates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates returns up to 100 results and a nextToken value if applicable.

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:

      • templateSummaries — (Array<map>)

        Summary information for templates.

        • arn — (String)

          The Amazon Resource Name (ARN) of the template.

        • createdAt — (Date)

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

        • lastUpdatedAt — (Date)

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

        • name — (String)

          The name of the template.

      • nextToken — (String)

        If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

  • (AWS.Request)

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

registerRobot(params = {}, callback) ⇒ AWS.Request

Registers a robot with a fleet.

Service Reference:

Examples:

Calling the registerRobot operation

var params = {
  fleet: 'STRING_VALUE', /* required */
  robot: 'STRING_VALUE' /* required */
};
robomaker.registerRobot(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 that the robot will join.

      • robot — (String)

        Information about the robot registration.

Returns:

  • (AWS.Request)

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

restartSimulationJob(params = {}, callback) ⇒ AWS.Request

Restarts a running simulation job.

Service Reference:

Examples:

Calling the restartSimulationJob operation

var params = {
  job: 'STRING_VALUE' /* required */
};
robomaker.restartSimulationJob(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.

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.

startSimulationJobBatch(params = {}, callback) ⇒ AWS.Request

Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.

Service Reference:

Examples:

Calling the startSimulationJobBatch operation

var params = {
  createSimulationJobRequests: [ /* required */
    {
      maxJobDurationInSeconds: 'NUMBER_VALUE', /* required */
      compute: {
        simulationUnitLimit: 'NUMBER_VALUE'
      },
      dataSources: [
        {
          name: 'STRING_VALUE', /* required */
          s3Bucket: 'STRING_VALUE', /* required */
          s3Keys: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      failureBehavior: Fail | Continue,
      iamRole: 'STRING_VALUE',
      loggingConfig: {
        recordAllRosTopics: true || false /* required */
      },
      outputLocation: {
        s3Bucket: 'STRING_VALUE',
        s3Prefix: 'STRING_VALUE'
      },
      robotApplications: [
        {
          application: 'STRING_VALUE', /* required */
          launchConfig: { /* required */
            launchFile: 'STRING_VALUE', /* required */
            packageName: 'STRING_VALUE', /* required */
            environmentVariables: {
              '<EnvironmentVariableKey>': 'STRING_VALUE',
              /* '<EnvironmentVariableKey>': ... */
            },
            portForwardingConfig: {
              portMappings: [
                {
                  applicationPort: 'NUMBER_VALUE', /* required */
                  jobPort: 'NUMBER_VALUE', /* required */
                  enableOnPublicIp: true || false
                },
                /* more items */
              ]
            },
            streamUI: true || false
          },
          applicationVersion: 'STRING_VALUE'
        },
        /* more items */
      ],
      simulationApplications: [
        {
          application: 'STRING_VALUE', /* required */
          launchConfig: { /* required */
            launchFile: 'STRING_VALUE', /* required */
            packageName: 'STRING_VALUE', /* required */
            environmentVariables: {
              '<EnvironmentVariableKey>': 'STRING_VALUE',
              /* '<EnvironmentVariableKey>': ... */
            },
            portForwardingConfig: {
              portMappings: [
                {
                  applicationPort: 'NUMBER_VALUE', /* required */
                  jobPort: 'NUMBER_VALUE', /* required */
                  enableOnPublicIp: true || false
                },
                /* more items */
              ]
            },
            streamUI: true || false
          },
          applicationVersion: 'STRING_VALUE',
          worldConfigs: [
            {
              world: 'STRING_VALUE'
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      tags: {
        '<TagKey>': 'STRING_VALUE',
        /* '<TagKey>': ... */
      },
      useDefaultApplications: true || false,
      vpcConfig: {
        subnets: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        assignPublicIp: true || false,
        securityGroups: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* more items */
  ],
  batchPolicy: {
    maxConcurrency: 'NUMBER_VALUE',
    timeoutInSeconds: 'NUMBER_VALUE'
  },
  clientRequestToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
robomaker.startSimulationJobBatch(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.
    • batchPolicy — (map)

      The batch policy.

      • timeoutInSeconds — (Integer)

        The amount of time, in seconds, to wait for the batch to complete.

        If a batch times out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), they will be moved to the failed list and the batch status will be Failed. If the pending requests were failing for any other reason, the failed pending requests will be moved to the failed list and the batch status will be TimedOut.

      • maxConcurrency — (Integer)

        The number of active simulation jobs create as part of the batch that can be in an active state at the same time.

        Active states include: Pending,Preparing, Running, Restarting, RunningFailed and Terminating. All other states are terminal states.

    • createSimulationJobRequests — (Array<map>)

      A list of simulation job requests to create in the batch.

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

      • loggingConfig — (map)

        The logging configuration.

        • recordAllRosTopicsrequired — (Boolean)

          A boolean indicating whether to record all ROS topics.

      • maxJobDurationInSecondsrequired — (Integer)

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

      • 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

        Restart the simulation job in the same host instance.

        Fail

        Stop the simulation job and terminate the instance.

        Possible values include:
        • "Fail"
        • "Continue"
      • useDefaultApplications — (Boolean)

        Boolean indicating whether to use default simulation tool applications.

      • robotApplications — (Array<map>)

        The robot applications to use in the simulation job.

        • applicationrequired — (String)

          The application information for the robot application.

        • applicationVersion — (String)

          The version of the robot application.

        • launchConfigrequired — (map)

          The launch configuration for the robot application.

          • packageNamerequired — (String)

            The package name.

          • launchFilerequired — (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.

              • jobPortrequired — (Integer)

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

              • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

      • simulationApplications — (Array<map>)

        The simulation applications to use in the simulation job.

        • applicationrequired — (String)

          The application information for the simulation application.

        • applicationVersion — (String)

          The version of the simulation application.

        • launchConfigrequired — (map)

          The launch configuration for the simulation application.

          • packageNamerequired — (String)

            The package name.

          • launchFilerequired — (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.

              • jobPortrequired — (Integer)

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

              • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

        • worldConfigs — (Array<map>)

          A list of world configurations.

          • world — (String)

            The world generated by Simulation WorldForge.

      • 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.
        • namerequired — (String)

          The name of the data source.

        • s3Bucketrequired — (String)

          The S3 bucket where the data files are located.

        • s3Keysrequired — (Array<String>)

          The list of S3 keys identifying the data source files.

      • 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 two subnet IDs.

        • subnetsrequired — (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 maximim value provided. The default is 15.

      • tags — (map<String>)

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

    • tags — (map<String>)

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

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

      • status — (String)

        The status of the simulation job batch.

        Pending

        The simulation job batch request is pending.

        InProgress

        The simulation job batch is in progress.

        Failed

        The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

        Completed

        The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

        Canceled

        The simulation batch job was cancelled.

        Canceling

        The simulation batch job is being cancelled.

        Completing

        The simulation batch job is completing.

        TimingOut

        The simulation job batch is timing out.

        If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

        TimedOut

        The simulation batch job timed out.

        Possible values include:
        • "Pending"
        • "InProgress"
        • "Failed"
        • "Completed"
        • "Canceled"
        • "Canceling"
        • "Completing"
        • "TimingOut"
        • "TimedOut"
      • createdAt — (Date)

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

      • clientRequestToken — (String)

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

      • batchPolicy — (map)

        The batch policy.

        • timeoutInSeconds — (Integer)

          The amount of time, in seconds, to wait for the batch to complete.

          If a batch times out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), they will be moved to the failed list and the batch status will be Failed. If the pending requests were failing for any other reason, the failed pending requests will be moved to the failed list and the batch status will be TimedOut.

        • maxConcurrency — (Integer)

          The number of active simulation jobs create as part of the batch that can be in an active state at the same time.

          Active states include: Pending,Preparing, Running, Restarting, RunningFailed and Terminating. All other states are terminal states.

      • failureCode — (String)

        The failure code if the simulation job batch failed.

        Possible values include:
        • "InternalServiceError"
      • failureReason — (String)

        The reason the simulation job batch failed.

      • failedRequests — (Array<map>)

        A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

        • request — (map)

          The simulation job 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.

          • loggingConfig — (map)

            The logging configuration.

            • recordAllRosTopicsrequired — (Boolean)

              A boolean indicating whether to record all ROS topics.

          • maxJobDurationInSecondsrequired — (Integer)

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

          • 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

            Restart the simulation job in the same host instance.

            Fail

            Stop the simulation job and terminate the instance.

            Possible values include:
            • "Fail"
            • "Continue"
          • useDefaultApplications — (Boolean)

            Boolean indicating whether to use default simulation tool applications.

          • robotApplications — (Array<map>)

            The robot applications to use in the simulation job.

            • applicationrequired — (String)

              The application information for the robot application.

            • applicationVersion — (String)

              The version of the robot application.

            • launchConfigrequired — (map)

              The launch configuration for the robot application.

              • packageNamerequired — (String)

                The package name.

              • launchFilerequired — (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.

                  • jobPortrequired — (Integer)

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

                  • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

          • simulationApplications — (Array<map>)

            The simulation applications to use in the simulation job.

            • applicationrequired — (String)

              The application information for the simulation application.

            • applicationVersion — (String)

              The version of the simulation application.

            • launchConfigrequired — (map)

              The launch configuration for the simulation application.

              • packageNamerequired — (String)

                The package name.

              • launchFilerequired — (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.

                  • jobPortrequired — (Integer)

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

                  • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

            • worldConfigs — (Array<map>)

              A list of world configurations.

              • world — (String)

                The world generated by Simulation WorldForge.

          • 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.
            • namerequired — (String)

              The name of the data source.

            • s3Bucketrequired — (String)

              The S3 bucket where the data files are located.

            • s3Keysrequired — (Array<String>)

              The list of S3 keys identifying the data source files.

          • 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 two subnet IDs.

            • subnetsrequired — (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 maximim value provided. The default is 15.

          • tags — (map<String>)

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

        • failureReason — (String)

          The failure reason of the simulation job request.

        • failureCode — (String)

          The failure code.

          Possible values include:
          • "InternalServiceError"
          • "RobotApplicationCrash"
          • "SimulationApplicationCrash"
          • "BadPermissionsRobotApplication"
          • "BadPermissionsSimulationApplication"
          • "BadPermissionsS3Object"
          • "BadPermissionsS3Output"
          • "BadPermissionsCloudwatchLogs"
          • "SubnetIpLimitExceeded"
          • "ENILimitExceeded"
          • "BadPermissionsUserCredentials"
          • "InvalidBundleRobotApplication"
          • "InvalidBundleSimulationApplication"
          • "InvalidS3Resource"
          • "LimitExceeded"
          • "MismatchedEtag"
          • "RobotApplicationVersionMismatchedEtag"
          • "SimulationApplicationVersionMismatchedEtag"
          • "ResourceNotFound"
          • "RequestThrottled"
          • "BatchTimedOut"
          • "BatchCanceled"
          • "InvalidInput"
          • "WrongRegionS3Bucket"
          • "WrongRegionS3Output"
          • "WrongRegionRobotApplication"
          • "WrongRegionSimulationApplication"
        • failedAt — (Date)

          The time, in milliseconds since the epoch, when the simulation job batch failed.

      • pendingRequests — (Array<map>)

        A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

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

        • loggingConfig — (map)

          The logging configuration.

          • recordAllRosTopicsrequired — (Boolean)

            A boolean indicating whether to record all ROS topics.

        • maxJobDurationInSecondsrequired — (Integer)

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

        • 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

          Restart the simulation job in the same host instance.

          Fail

          Stop the simulation job and terminate the instance.

          Possible values include:
          • "Fail"
          • "Continue"
        • useDefaultApplications — (Boolean)

          Boolean indicating whether to use default simulation tool applications.

        • robotApplications — (Array<map>)

          The robot applications to use in the simulation job.

          • applicationrequired — (String)

            The application information for the robot application.

          • applicationVersion — (String)

            The version of the robot application.

          • launchConfigrequired — (map)

            The launch configuration for the robot application.

            • packageNamerequired — (String)

              The package name.

            • launchFilerequired — (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.

                • jobPortrequired — (Integer)

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

                • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

        • simulationApplications — (Array<map>)

          The simulation applications to use in the simulation job.

          • applicationrequired — (String)

            The application information for the simulation application.

          • applicationVersion — (String)

            The version of the simulation application.

          • launchConfigrequired — (map)

            The launch configuration for the simulation application.

            • packageNamerequired — (String)

              The package name.

            • launchFilerequired — (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.

                • jobPortrequired — (Integer)

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

                • applicationPortrequired — (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 luanch the component. It must have a graphical user interface.

          • worldConfigs — (Array<map>)

            A list of world configurations.

            • world — (String)

              The world generated by Simulation WorldForge.

        • 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.
          • namerequired — (String)

            The name of the data source.

          • s3Bucketrequired — (String)

            The S3 bucket where the data files are located.

          • s3Keysrequired — (Array<String>)

            The list of S3 keys identifying the data source files.

        • 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 two subnet IDs.

          • subnetsrequired — (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 maximim value provided. The default is 15.

        • tags — (map<String>)

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

      • createdRequests — (Array<map>)

        A list of created simulation job request summaries.

        • arn — (String)

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

        • lastUpdatedAt — (Date)

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

        • 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"
        • simulationApplicationNames — (Array<String>)

          A list of simulation job simulation application names.

        • robotApplicationNames — (Array<String>)

          A list of simulation job robot application names.

        • dataSourceNames — (Array<String>)

          The names of the data sources.

      • tags — (map<String>)

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

Returns:

  • (AWS.Request)

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

syncDeploymentJob(params = {}, callback) ⇒ AWS.Request

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

Service Reference:

Examples:

Calling the syncDeploymentJob operation

var params = {
  clientRequestToken: 'STRING_VALUE', /* required */
  fleet: 'STRING_VALUE' /* required */
};
robomaker.syncDeploymentJob(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.
    • fleet — (String)

      The target fleet for the synchronization.

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 synchronization request.

      • fleet — (String)

        The Amazon Resource Name (ARN) of the fleet.

      • status — (String)

        The status of the synchronization job.

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

        Information about 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.

          • bucketrequired — (String)

            The bucket containing the object.

          • keyrequired — (String)

            The key of the object.

          • etag — (String)

            The etag of the object.

      • deploymentApplicationConfigs — (Array<map>)

        Information about the deployment application configurations.

        • applicationrequired — (String)

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

        • applicationVersionrequired — (String)

          The version of the application.

        • launchConfigrequired — (map)

          The launch configuration.

          • packageNamerequired — (String)

            The package name.

          • preLaunchFile — (String)

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

          • launchFilerequired — (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 if the job fails.

      • failureCode — (String)

        The failure code if the job fails:

        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:
        • "ResourceNotFound"
        • "EnvironmentSetupError"
        • "EtagMismatch"
        • "FailureThresholdBreached"
        • "RobotDeploymentAborted"
        • "RobotDeploymentNoResponse"
        • "RobotAgentConnectionTimeout"
        • "GreengrassDeploymentFailed"
        • "InvalidGreengrassGroup"
        • "MissingRobotArchitecture"
        • "MissingRobotApplicationArchitecture"
        • "MissingRobotDeploymentResource"
        • "GreengrassGroupVersionDoesNotExist"
        • "LambdaDeleted"
        • "ExtractingBundleFailure"
        • "PreLaunchFileFailure"
        • "PostLaunchFileFailure"
        • "BadPermissionError"
        • "DownloadConditionFailed"
        • "InternalServerError"
      • createdAt — (Date)

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

Returns:

  • (AWS.Request)

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

tagResource(params = {}, callback) ⇒ AWS.Request

Adds or edits tags for a AWS RoboMaker resource.

Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
robomaker.tagResource(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: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.

    • tags — (map<String>)

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

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.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the specified tags from the specified AWS RoboMaker resource.

To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource .

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
robomaker.untagResource(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: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.

    • tagKeys — (Array<String>)

      A map that contains tag keys and tag values that will be unattached from the resource.

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.

updateRobotApplication(params = {}, callback) ⇒ AWS.Request

Updates a robot application.

Service Reference:

Examples:

Calling the updateRobotApplication operation

var params = {
  application: 'STRING_VALUE', /* required */
  robotSoftwareSuite: { /* required */
    name: ROS | ROS2,
    version: Kinetic | Melodic | Dashing
  },
  sources: [ /* required */
    {
      architecture: X86_64 | ARM64 | ARMHF,
      s3Bucket: 'STRING_VALUE',
      s3Key: 'STRING_VALUE'
    },
    /* more items */
  ],
  currentRevisionId: 'STRING_VALUE'
};
robomaker.updateRobotApplication(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.

    • 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 distribution) used by the robot application.

      • name — (String)

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

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

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

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

      The revision id for the 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 updated 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"
        • version — (String)

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

          Possible values include:
          • "Kinetic"
          • "Melodic"
          • "Dashing"
      • 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.

Returns:

  • (AWS.Request)

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

updateSimulationApplication(params = {}, callback) ⇒ AWS.Request

Updates a simulation application.

Service Reference:

Examples:

Calling the updateSimulationApplication operation

var params = {
  application: 'STRING_VALUE', /* required */
  robotSoftwareSuite: { /* required */
    name: ROS | ROS2,
    version: Kinetic | Melodic | Dashing
  },
  simulationSoftwareSuite: { /* required */
    name: Gazebo | RosbagPlay,
    version: 'STRING_VALUE'
  },
  sources: [ /* required */
    {
      architecture: X86_64 | ARM64 | ARMHF,
      s3Bucket: 'STRING_VALUE',
      s3Key: 'STRING_VALUE'
    },
    /* more items */
  ],
  currentRevisionId: 'STRING_VALUE',
  renderingEngine: {
    name: OGRE,
    version: 'STRING_VALUE'
  }
};
robomaker.updateSimulationApplication(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.

    • 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"
      • 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"
      • version — (String)

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

        Possible values include:
        • "Kinetic"
        • "Melodic"
        • "Dashing"
    • 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.

    • currentRevisionId — (String)

      The revision id for the 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 updated simulation application.

      • name — (String)

        The name of the simulation application.

      • version — (String)

        The version of the robot 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"
        • 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"
        • version — (String)

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

          Possible values include:
          • "Kinetic"
          • "Melodic"
          • "Dashing"
      • 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.

Returns:

  • (AWS.Request)

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

updateWorldTemplate(params = {}, callback) ⇒ AWS.Request

Updates a world template.

Service Reference:

Examples:

Calling the updateWorldTemplate operation

var params = {
  template: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE',
  templateBody: 'STRING_VALUE',
  templateLocation: {
    s3Bucket: 'STRING_VALUE', /* required */
    s3Key: 'STRING_VALUE' /* required */
  }
};
robomaker.updateWorldTemplate(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 to update.

    • name — (String)

      The name of the template.

    • templateBody — (String)

      The world template body.

    • templateLocation — (map)

      The location of the world template.

      • s3Bucketrequired — (String)

        The Amazon S3 bucket name.

      • s3Keyrequired — (String)

        The list of S3 keys identifying the data source files.

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.

      • name — (String)

        The name of the world template.

      • createdAt — (Date)

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

      • lastUpdatedAt — (Date)

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

Returns:

  • (AWS.Request)

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