Class: AWS.RoboMaker
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.RoboMaker
- 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.batchDescribeSimulationJob(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
-
new AWS.RoboMaker(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary
-
batchDescribeSimulationJob(params = {}, callback) ⇒ AWS.Request
Describes one or more simulation jobs.
-
cancelSimulationJob(params = {}, callback) ⇒ AWS.Request
Cancels the specified simulation job.
-
createDeploymentJob(params = {}, callback) ⇒ AWS.Request
Deploys a specific version of a robot application to robots in a fleet.
-
createFleet(params = {}, callback) ⇒ AWS.Request
Creates a fleet, a logical group of robots running the same robot application.
-
createRobot(params = {}, callback) ⇒ AWS.Request
Creates a robot.
-
createRobotApplication(params = {}, callback) ⇒ AWS.Request
Creates a robot application.
-
createRobotApplicationVersion(params = {}, callback) ⇒ AWS.Request
Creates a version of a robot application.
-
createSimulationApplication(params = {}, callback) ⇒ AWS.Request
Creates a simulation application.
-
createSimulationApplicationVersion(params = {}, callback) ⇒ AWS.Request
Creates a simulation application with a specific revision id.
-
createSimulationJob(params = {}, callback) ⇒ AWS.Request
Creates a simulation job.
-
deleteFleet(params = {}, callback) ⇒ AWS.Request
Deletes a fleet.
-
deleteRobot(params = {}, callback) ⇒ AWS.Request
Deletes a robot.
-
deleteRobotApplication(params = {}, callback) ⇒ AWS.Request
Deletes a robot application.
-
deleteSimulationApplication(params = {}, callback) ⇒ AWS.Request
Deletes a simulation application.
-
deregisterRobot(params = {}, callback) ⇒ AWS.Request
Deregisters a robot.
-
describeDeploymentJob(params = {}, callback) ⇒ AWS.Request
Describes a deployment job.
-
describeFleet(params = {}, callback) ⇒ AWS.Request
Describes a fleet.
-
describeRobot(params = {}, callback) ⇒ AWS.Request
Describes a robot.
-
describeRobotApplication(params = {}, callback) ⇒ AWS.Request
Describes a robot application.
-
describeSimulationApplication(params = {}, callback) ⇒ AWS.Request
Describes a simulation application.
-
describeSimulationJob(params = {}, callback) ⇒ AWS.Request
Describes a simulation job.
-
listDeploymentJobs(params = {}, callback) ⇒ AWS.Request
Returns a list of deployment jobs for a fleet.
-
listFleets(params = {}, callback) ⇒ AWS.Request
Returns a list of fleets.
-
listRobotApplications(params = {}, callback) ⇒ AWS.Request
Returns a list of robot application.
-
listRobots(params = {}, callback) ⇒ AWS.Request
Returns a list of robots.
-
listSimulationApplications(params = {}, callback) ⇒ AWS.Request
Returns a list of simulation applications.
-
listSimulationJobs(params = {}, callback) ⇒ AWS.Request
Returns a list of simulation jobs.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists all tags on a AWS RoboMaker resource.
-
registerRobot(params = {}, callback) ⇒ AWS.Request
Registers a robot with a fleet.
-
restartSimulationJob(params = {}, callback) ⇒ AWS.Request
Restarts a running simulation job.
-
syncDeploymentJob(params = {}, callback) ⇒ AWS.Request
Syncrhonizes robots in a fleet to the latest deployment.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Adds or edits tags for a AWS RoboMaker resource.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Removes the specified tags from the specified AWS RoboMaker resource.
-
updateRobotApplication(params = {}, callback) ⇒ AWS.Request
Updates a robot application.
-
updateSimulationApplication(params = {}, callback) ⇒ AWS.Request
Updates a simulation application.
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)
—
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'
. -
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.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
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 totrue
. -
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 returns the amount of time to delay in milliseconds. The
base
option will be ignored if this option is supplied.
-
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)
—
whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'
-
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
.
Property Details
Method Details
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. Thedata
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"
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.
"Fail"
"Continue"
failureCode
— (String
)The failure code of the simulation job if it failed.
Possible values include:"InternalServiceError"
"RobotApplicationCrash"
"SimulationApplicationCrash"
"BadPermissionsRobotApplication"
"BadPermissionsSimulationApplication"
"BadPermissionsS3Output"
"BadPermissionsCloudwatchLogs"
"SubnetIpLimitExceeded"
"ENILimitExceeded"
"BadPermissionsUserCredentials"
"InvalidBundleRobotApplication"
"InvalidBundleSimulationApplication"
"RobotApplicationVersionMismatchedEtag"
"SimulationApplicationVersionMismatchedEtag"
"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.
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. See how to specify AWS security credentials for your application.
robotApplications
— (Array<map>
)A list of robot applications.
application
— required — (String
)The application information for the robot application.
applicationVersion
— (String
)The version of the robot application.
launchConfig
— required — (map
)The launch configuration for the robot application.
packageName
— required — (String
)The package name.
launchFile
— required — (String
)The launch file name.
environmentVariables
— (map<String>
)The environment variables for the application launch.
simulationApplications
— (Array<map>
)A list of simulation applications.
application
— required — (String
)The application information for the simulation application.
applicationVersion
— (String
)The version of the simulation application.
launchConfig
— required — (map
)The launch configuration for the simulation application.
packageName
— required — (String
)The package name.
launchFile
— required — (String
)The launch file name.
environmentVariables
— (map<String>
)The environment variables for the application launch.
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.
unprocessedJobs
— (Array<String>
)A list of unprocessed simulation job Amazon Resource Names (ARNs).
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
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.
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',
failureThresholdPercentage: '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.
clientRequestToken
— (String
)Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
If a token is not provided, the SDK will use a version 4 UUID.fleet
— (String
)The Amazon Resource Name (ARN) of the fleet to deploy.
deploymentApplicationConfigs
— (Array<map>
)The deployment application configuration.
application
— required — (String
)The Amazon Resource Name (ARN) of the robot application.
applicationVersion
— required — (String
)The version of the application.
launchConfig
— required — (map
)The launch configuration.
packageName
— required — (String
)The package name.
preLaunchFile
— (String
)The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile
— required — (String
)The launch file name.
postLaunchFile
— (String
)The deployment post-launch file. This file will be executed after the launch file.
environmentVariables
— (map<String>
)An array of key/value pairs specifying environment variables for the robot application
tags
— (map<String>
)A map that contains tag keys and tag values that are attached to the deployment job.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
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"
deploymentApplicationConfigs
— (Array<map>
)The deployment application configuration.
application
— required — (String
)The Amazon Resource Name (ARN) of the robot application.
applicationVersion
— required — (String
)The version of the application.
launchConfig
— required — (map
)The launch configuration.
packageName
— required — (String
)The package name.
preLaunchFile
— (String
)The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile
— required — (String
)The launch file name.
postLaunchFile
— (String
)The deployment post-launch file. This file will be executed after the launch file.
environmentVariables
— (map<String>
)An array of key/value pairs specifying environment variables for the robot application
failureReason
— (String
)The failure reason of the deployment job if it failed.
failureCode
— (String
)The failure code of the simulation job if it failed:
- BadPermissionError
-
AWS Greengrass requires a service-level role permission to access other services. The role must include the
AWSGreengrassResourceAccessRolePolicy
managed policy. - ExtractingBundleFailure
-
The robot application could not be extracted from the bundle.
- FailureThresholdBreached
-
The percentage of robots that could not be updated exceeded the percentage set for the deployment.
- GreengrassDeploymentFailed
-
The robot application could not be deployed to the robot.
- GreengrassGroupVersionDoesNotExist
-
The AWS Greengrass group or version associated with a robot is missing.
- InternalServerError
-
An internal error has occurred. Retry your request, but if the problem persists, contact us with details.
- MissingRobotApplicationArchitecture
-
The robot application does not have a source that matches the architecture of the robot.
- MissingRobotDeploymentResource
-
One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?
- PostLaunchFileFailure
-
The post-launch script failed.
- PreLaunchFileFailure
-
The pre-launch script failed.
- ResourceNotFound
-
One or more deployment resources are missing. For example, do robot application source bundles still exist?
- RobotDeploymentNoResponse
-
There is no response from the robot. It might not be powered on or connected to the internet.
"ResourceNotFound"
"EnvironmentSetupError"
"EtagMismatch"
"FailureThresholdBreached"
"RobotDeploymentNoResponse"
"RobotAgentConnectionTimeout"
"GreengrassDeploymentFailed"
"MissingRobotArchitecture"
"MissingRobotApplicationArchitecture"
"MissingRobotDeploymentResource"
"GreengrassGroupVersionDoesNotExist"
"ExtractingBundleFailure"
"PreLaunchFileFailure"
"PostLaunchFileFailure"
"BadPermissionError"
"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.
tags
— (map<String>
)The list of all tags added to the deployment job.
-
(AWS.Response)
—
Returns:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
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,
version: Kinetic
},
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 used by the robot application.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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. Thedata
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
ands3Key
.architecture
— (String
)The taget processor architecture for the application.
Possible values include:"X86_64"
"ARM64"
"ARMHF"
robotSoftwareSuite
— (map
)The robot software suite used by the robot application.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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.
-
(AWS.Response)
—
Returns:
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. Thedata
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
ands3Key
.architecture
— (String
)The taget processor architecture for the application.
Possible values include:"X86_64"
"ARM64"
"ARMHF"
robotSoftwareSuite
— (map
)The robot software suite used by the robot application.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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.
-
(AWS.Response)
—
Returns:
createSimulationApplication(params = {}, callback) ⇒ AWS.Request
Creates a simulation application.
Service Reference:
Examples:
Calling the createSimulationApplication operation
var params = {
name: 'STRING_VALUE', /* required */
renderingEngine: { /* required */
name: OGRE,
version: 'STRING_VALUE'
},
robotSoftwareSuite: { /* required */
name: ROS,
version: Kinetic
},
simulationSoftwareSuite: { /* required */
name: Gazebo,
version: 'STRING_VALUE'
},
sources: [ /* required */
{
architecture: X86_64 | ARM64 | ARMHF,
s3Bucket: 'STRING_VALUE',
s3Key: 'STRING_VALUE'
},
/* more items */
],
tags: {
'<TagKey>': 'STRING_VALUE',
/* '<TagKey>': ... */
}
};
robomaker.createSimulationApplication(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
name
— (String
)The name of the simulation application.
sources
— (Array<map>
)The sources of the simulation application.
s3Bucket
— (String
)The Amazon S3 bucket name.
s3Key
— (String
)The s3 object key.
architecture
— (String
)The target processor architecture for the application.
Possible values include:"X86_64"
"ARM64"
"ARMHF"
simulationSoftwareSuite
— (map
)The simulation software suite used by the simulation application.
name
— (String
)The name of the simulation software suite.
Possible values include:"Gazebo"
version
— (String
)The version of the simulation software suite.
robotSoftwareSuite
— (map
)The robot software suite of the simulation application.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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. Thedata
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
ands3Key
.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"
version
— (String
)The version of the simulation software suite.
robotSoftwareSuite
— (map
)Information about the robot software suite.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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.
-
(AWS.Response)
—
Returns:
createSimulationApplicationVersion(params = {}, callback) ⇒ AWS.Request
Creates a simulation application with a specific revision id.
Service Reference:
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. Thedata
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
ands3Key
.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"
version
— (String
)The version of the simulation software suite.
robotSoftwareSuite
— (map
)Information about the robot software suite.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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.
-
(AWS.Response)
—
Returns:
createSimulationJob(params = {}, callback) ⇒ AWS.Request
Creates a simulation job.
Service Reference:
Examples:
Calling the createSimulationJob operation
var params = {
iamRole: 'STRING_VALUE', /* required */
maxJobDurationInSeconds: 'NUMBER_VALUE', /* required */
clientRequestToken: 'STRING_VALUE',
failureBehavior: Fail | Continue,
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>': ... */
}
},
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>': ... */
}
},
applicationVersion: 'STRING_VALUE'
},
/* 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.
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 toCompleted
.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.
"Fail"
"Continue"
robotApplications
— (Array<map>
)The robot application to use in the simulation job.
application
— required — (String
)The application information for the robot application.
applicationVersion
— (String
)The version of the robot application.
launchConfig
— required — (map
)The launch configuration for the robot application.
packageName
— required — (String
)The package name.
launchFile
— required — (String
)The launch file name.
environmentVariables
— (map<String>
)The environment variables for the application launch.
simulationApplications
— (Array<map>
)The simulation application to use in the simulation job.
application
— required — (String
)The application information for the simulation application.
applicationVersion
— (String
)The version of the simulation application.
launchConfig
— required — (map
)The launch configuration for the simulation application.
packageName
— required — (String
)The package name.
launchFile
— required — (String
)The launch file name.
environmentVariables
— (map<String>
)The environment variables for the application launch.
tags
— (map<String>
)A map that contains tag keys and tag values that are attached to the simulation job.
vpcConfig
— (map
)If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
subnets
— required — (Array<String>
)A list of one or more subnet IDs in your VPC.
securityGroups
— (Array<String>
)A list of one or more security groups IDs in your VPC.
assignPublicIp
— (Boolean
)A boolean indicating whether to assign a public IP address.
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. Thedata
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"
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.
"InternalServiceError"
"RobotApplicationCrash"
"SimulationApplicationCrash"
"BadPermissionsRobotApplication"
"BadPermissionsSimulationApplication"
"BadPermissionsS3Output"
"BadPermissionsCloudwatchLogs"
"SubnetIpLimitExceeded"
"ENILimitExceeded"
"BadPermissionsUserCredentials"
"InvalidBundleRobotApplication"
"InvalidBundleSimulationApplication"
"RobotApplicationVersionMismatchedEtag"
"SimulationApplicationVersionMismatchedEtag"
"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.
maxJobDurationInSeconds
— (Integer
)The maximum simulation job duration in seconds.
simulationTimeMillis
— (Integer
)The simulation job execution duration in milliseconds.
iamRole
— (String
)The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
robotApplications
— (Array<map>
)The robot application used by the simulation job.
application
— required — (String
)The application information for the robot application.
applicationVersion
— (String
)The version of the robot application.
launchConfig
— required — (map
)The launch configuration for the robot application.
packageName
— required — (String
)The package name.
launchFile
— required — (String
)The launch file name.
environmentVariables
— (map<String>
)The environment variables for the application launch.
simulationApplications
— (Array<map>
)The simulation application used by the simulation job.
application
— required — (String
)The application information for the simulation application.
applicationVersion
— (String
)The version of the simulation application.
launchConfig
— required — (map
)The launch configuration for the simulation application.
packageName
— required — (String
)The package name.
launchFile
— required — (String
)The launch file name.
environmentVariables
— (map<String>
)The environment variables for the application launch.
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.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
describeDeploymentJob(params = {}, callback) ⇒ AWS.Request
Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?]
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. Thedata
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"
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.
deploymentApplicationConfigs
— (Array<map>
)The deployment application configuration.
application
— required — (String
)The Amazon Resource Name (ARN) of the robot application.
applicationVersion
— required — (String
)The version of the application.
launchConfig
— required — (map
)The launch configuration.
packageName
— required — (String
)The package name.
preLaunchFile
— (String
)The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile
— required — (String
)The launch file name.
postLaunchFile
— (String
)The deployment post-launch file. This file will be executed after the launch file.
environmentVariables
— (map<String>
)An array of key/value pairs specifying environment variables for the robot application
failureReason
— (String
)A short description of the reason why the deployment job failed.
failureCode
— (String
)The deployment job failure code.
Possible values include:"ResourceNotFound"
"EnvironmentSetupError"
"EtagMismatch"
"FailureThresholdBreached"
"RobotDeploymentNoResponse"
"RobotAgentConnectionTimeout"
"GreengrassDeploymentFailed"
"MissingRobotArchitecture"
"MissingRobotApplicationArchitecture"
"MissingRobotDeploymentResource"
"GreengrassGroupVersionDoesNotExist"
"ExtractingBundleFailure"
"PreLaunchFileFailure"
"PostLaunchFileFailure"
"BadPermissionError"
"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.
- Downloading/Extracting
-
Downloading and extracting the bundle on the robot.
- Executing pre-launch script(s)
-
Executing pre-launch script(s) if provided.
- Launching
-
Launching the robot application.
- Executing post-launch script(s)
-
Executing post-launch script(s) if provided.
- Finished
-
Deployment is complete.
"Validating"
"DownloadingExtracting"
"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"
"RobotDeploymentNoResponse"
"RobotAgentConnectionTimeout"
"GreengrassDeploymentFailed"
"MissingRobotArchitecture"
"MissingRobotApplicationArchitecture"
"MissingRobotDeploymentResource"
"GreengrassGroupVersionDoesNotExist"
"ExtractingBundleFailure"
"PreLaunchFileFailure"
"PostLaunchFileFailure"
"BadPermissionError"
"InternalServerError"
tags
— (map<String>
)The list of all tags added to the specified deployment job.
-
(AWS.Response)
—
Returns:
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. Thedata
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"
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.
-
(AWS.Response)
—
Returns:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
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. Thedata
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
ands3Key
.architecture
— (String
)The taget processor architecture for the application.
Possible values include:"X86_64"
"ARM64"
"ARMHF"
robotSoftwareSuite
— (map
)The robot software suite used by the robot application.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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.
-
(AWS.Response)
—
Returns:
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. Thedata
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
ands3Key
.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"
version
— (String
)The version of the simulation software suite.
robotSoftwareSuite
— (map
)Information about the robot software suite.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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.
-
(AWS.Response)
—
Returns:
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. Thedata
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"
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.
"InternalServiceError"
"RobotApplicationCrash"
"SimulationApplicationCrash"
"BadPermissionsRobotApplication"
"BadPermissionsSimulationApplication"
"BadPermissionsS3Output"
"BadPermissionsCloudwatchLogs"
"SubnetIpLimitExceeded"
"ENILimitExceeded"
"BadPermissionsUserCredentials"
"InvalidBundleRobotApplication"
"InvalidBundleSimulationApplication"
"RobotApplicationVersionMismatchedEtag"
"SimulationApplicationVersionMismatchedEtag"
"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.
maxJobDurationInSeconds
— (Integer
)The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
simulationTimeMillis
— (Integer
)The simulation job execution duration in milliseconds.
iamRole
— (String
)The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
robotApplications
— (Array<map>
)A list of robot applications.
application
— required — (String
)The application information for the robot application.
applicationVersion
— (String
)The version of the robot application.
launchConfig
— required — (map
)The launch configuration for the robot application.
packageName
— required — (String
)The package name.
launchFile
— required — (String
)The launch file name.
environmentVariables
— (map<String>
)The environment variables for the application launch.
simulationApplications
— (Array<map>
)A list of simulation applications.
application
— required — (String
)The application information for the simulation application.
applicationVersion
— (String
)The version of the simulation application.
launchConfig
— required — (map
)The launch configuration for the simulation application.
packageName
— required — (String
)The package name.
launchFile
— required — (String
)The launch file name.
environmentVariables
— (map<String>
)The environment variables for the application launch.
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.
-
(AWS.Response)
—
Returns:
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
andfleetName
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 statusInProgress
or the statusPending
.name
— (String
)The name of the filter.
values
— (Array<String>
)A list of values.
nextToken
— (String
)The
nextToken
value returned from a previous paginatedListDeploymentJobs
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.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
)The maximum number of deployment job results returned by
ListDeploymentJobs
in paginated output. When this parameter is used,ListDeploymentJobs
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListDeploymentJobs
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListDeploymentJobs
returns up to 100 results and anextToken
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. Thedata
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"
deploymentApplicationConfigs
— (Array<map>
)The deployment application configuration.
application
— required — (String
)The Amazon Resource Name (ARN) of the robot application.
applicationVersion
— required — (String
)The version of the application.
launchConfig
— required — (map
)The launch configuration.
packageName
— required — (String
)The package name.
preLaunchFile
— (String
)The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile
— required — (String
)The launch file name.
postLaunchFile
— (String
)The deployment post-launch file. This file will be executed after the launch file.
environmentVariables
— (map<String>
)An array of key/value pairs specifying environment variables for the robot application
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.
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"
"RobotDeploymentNoResponse"
"RobotAgentConnectionTimeout"
"GreengrassDeploymentFailed"
"MissingRobotArchitecture"
"MissingRobotApplicationArchitecture"
"MissingRobotDeploymentResource"
"GreengrassGroupVersionDoesNotExist"
"ExtractingBundleFailure"
"PreLaunchFileFailure"
"PostLaunchFileFailure"
"BadPermissionError"
"InternalServerError"
createdAt
— (Date
)The time, in milliseconds since the epoch, when the deployment job was created.
nextToken
— (String
)The
nextToken
value to include in a futureListDeploymentJobs
request. When the results of aListDeploymentJobs
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
-
(AWS.Response)
—
Returns:
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
)The
nextToken
value returned from a previous paginatedListFleets
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.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
)The maximum number of deployment job results returned by
ListFleets
in paginated output. When this parameter is used,ListFleets
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListFleets
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListFleets
returns up to 100 results and anextToken
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. Thedata
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"
lastDeploymentJob
— (String
)The Amazon Resource Name (ARN) of the last deployment job.
lastDeploymentTime
— (Date
)The time of the last deployment.
nextToken
— (String
)The
nextToken
value to include in a futureListDeploymentJobs
request. When the results of aListFleets
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
-
(AWS.Response)
—
Returns:
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
)The
nextToken
value returned from a previous paginatedListRobotApplications
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.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
)The maximum number of deployment job results returned by
ListRobotApplications
in paginated output. When this parameter is used,ListRobotApplications
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListRobotApplications
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListRobotApplications
returns up to 100 results and anextToken
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. Thedata
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.
nextToken
— (String
)The
nextToken
value to include in a futureListRobotApplications
request. When the results of aListRobotApplications
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
-
(AWS.Response)
—
Returns:
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
)The
nextToken
value returned from a previous paginatedListRobots
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.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
)The maximum number of deployment job results returned by
ListRobots
in paginated output. When this parameter is used,ListRobots
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListRobots
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListRobots
returns up to 100 results and anextToken
value if applicable.filters
— (Array<map>
)Optional filters to limit results.
The filter names
status
andfleetName
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 statusRegistered
or the statusAvailable
.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. Thedata
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
)The
nextToken
value to include in a futureListRobots
request. When the results of aListRobot
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
-
(AWS.Response)
—
Returns:
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
)The
nextToken
value returned from a previous paginatedListSimulationApplications
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.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
)The maximum number of deployment job results returned by
ListSimulationApplications
in paginated output. When this parameter is used,ListSimulationApplications
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListSimulationApplications
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListSimulationApplications
returns up to 100 results and anextToken
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. Thedata
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.
nextToken
— (String
)The
nextToken
value to include in a futureListSimulationApplications
request. When the results of aListRobot
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
-
(AWS.Response)
—
Returns:
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
)The
nextToken
value returned from a previous paginatedListSimulationJobs
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.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
)The maximum number of deployment job results returned by
ListSimulationJobs
in paginated output. When this parameter is used,ListSimulationJobs
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListSimulationJobs
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListSimulationJobs
returns up to 100 results and anextToken
value if applicable.filters
— (Array<map>
)Optional filters to limit results.
The filter names
status
andsimulationApplicationName
androbotApplicationName
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 statusPreparing
or the statusRunning
.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. Thedata
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.
nextToken
— (String
)The
nextToken
value to include in a futureListSimulationJobs
request. When the results of aListRobot
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:tags
— (map<String>
)The list of all tags added to the specified resource.
-
(AWS.Response)
—
Returns:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
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. Thedata
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"
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.
deploymentApplicationConfigs
— (Array<map>
)Information about the deployment application configurations.
application
— required — (String
)The Amazon Resource Name (ARN) of the robot application.
applicationVersion
— required — (String
)The version of the application.
launchConfig
— required — (map
)The launch configuration.
packageName
— required — (String
)The package name.
preLaunchFile
— (String
)The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile
— required — (String
)The launch file name.
postLaunchFile
— (String
)The deployment post-launch file. This file will be executed after the launch file.
environmentVariables
— (map<String>
)An array of key/value pairs specifying environment variables for the robot application
failureReason
— (String
)The failure reason 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.
"ResourceNotFound"
"EnvironmentSetupError"
"EtagMismatch"
"FailureThresholdBreached"
"RobotDeploymentNoResponse"
"RobotAgentConnectionTimeout"
"GreengrassDeploymentFailed"
"MissingRobotArchitecture"
"MissingRobotApplicationArchitecture"
"MissingRobotDeploymentResource"
"GreengrassGroupVersionDoesNotExist"
"ExtractingBundleFailure"
"PreLaunchFileFailure"
"PostLaunchFileFailure"
"BadPermissionError"
"InternalServerError"
createdAt
— (Date
)The time, in milliseconds since the epoch, when the fleet was created.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
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,
version: Kinetic
},
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 used by the robot application.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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. Thedata
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
ands3Key
.architecture
— (String
)The taget processor architecture for the application.
Possible values include:"X86_64"
"ARM64"
"ARMHF"
robotSoftwareSuite
— (map
)The robot software suite used by the robot application.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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.
-
(AWS.Response)
—
Returns:
updateSimulationApplication(params = {}, callback) ⇒ AWS.Request
Updates a simulation application.
Service Reference:
Examples:
Calling the updateSimulationApplication operation
var params = {
application: 'STRING_VALUE', /* required */
renderingEngine: { /* required */
name: OGRE,
version: 'STRING_VALUE'
},
robotSoftwareSuite: { /* required */
name: ROS,
version: Kinetic
},
simulationSoftwareSuite: { /* required */
name: Gazebo,
version: 'STRING_VALUE'
},
sources: [ /* required */
{
architecture: X86_64 | ARM64 | ARMHF,
s3Bucket: 'STRING_VALUE',
s3Key: 'STRING_VALUE'
},
/* more items */
],
currentRevisionId: '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"
version
— (String
)The version of the simulation software suite.
robotSoftwareSuite
— (map
)Information about the robot software suite.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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. Thedata
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
ands3Key
.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"
version
— (String
)The version of the simulation software suite.
robotSoftwareSuite
— (map
)Information about the robot software suite.
name
— (String
)The name of the robot software suite.
Possible values include:"ROS"
version
— (String
)The version of the robot software suite.
Possible values include:"Kinetic"
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.
-
(AWS.Response)
—
Returns: