Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-robomaker

@aws-sdk/client-robomaker

Description

AWS SDK for JavaScript RoboMaker Client for Node.js, Browser and React Native.

This section provides documentation for the AWS RoboMaker API operations.

Installing

To install the this package, simply type add or install @aws-sdk/client-robomaker using your favorite package manager:

  • npm install @aws-sdk/client-robomaker
  • yarn add @aws-sdk/client-robomaker
  • pnpm add @aws-sdk/client-robomaker

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the RoboMakerClient and the commands you need, for example ListFleetsCommand:

// ES5 example
const { RoboMakerClient, ListFleetsCommand } = require("@aws-sdk/client-robomaker");
// ES6+ example
import { RoboMakerClient, ListFleetsCommand } from "@aws-sdk/client-robomaker";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new RoboMakerClient({ region: "REGION" });

const params = {
/** input parameters */
};
const command = new ListFleetsCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);

Promises can also be called using .catch() and .finally() as follows:

client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
// process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-robomaker";
const client = new AWS.RoboMaker({ region: "REGION" });

// async/await.
try {
const data = await client.listFleets(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listFleets(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listFleets(params, (err, data) => {
// process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-robomaker package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

BatchDeleteWorlds

Command API Reference / Input / Output

BatchDescribeSimulationJob

Command API Reference / Input / Output

CancelDeploymentJob

Command API Reference / Input / Output

CancelSimulationJob

Command API Reference / Input / Output

CancelSimulationJobBatch

Command API Reference / Input / Output

CancelWorldExportJob

Command API Reference / Input / Output

CancelWorldGenerationJob

Command API Reference / Input / Output

CreateDeploymentJob

Command API Reference / Input / Output

CreateFleet

Command API Reference / Input / Output

CreateRobot

Command API Reference / Input / Output

CreateRobotApplication

Command API Reference / Input / Output

CreateRobotApplicationVersion

Command API Reference / Input / Output

CreateSimulationApplication

Command API Reference / Input / Output

CreateSimulationApplicationVersion

Command API Reference / Input / Output

CreateSimulationJob

Command API Reference / Input / Output

CreateWorldExportJob

Command API Reference / Input / Output

CreateWorldGenerationJob

Command API Reference / Input / Output

CreateWorldTemplate

Command API Reference / Input / Output

DeleteFleet

Command API Reference / Input / Output

DeleteRobot

Command API Reference / Input / Output

DeleteRobotApplication

Command API Reference / Input / Output

DeleteSimulationApplication

Command API Reference / Input / Output

DeleteWorldTemplate

Command API Reference / Input / Output

DeregisterRobot

Command API Reference / Input / Output

DescribeDeploymentJob

Command API Reference / Input / Output

DescribeFleet

Command API Reference / Input / Output

DescribeRobot

Command API Reference / Input / Output

DescribeRobotApplication

Command API Reference / Input / Output

DescribeSimulationApplication

Command API Reference / Input / Output

DescribeSimulationJob

Command API Reference / Input / Output

DescribeSimulationJobBatch

Command API Reference / Input / Output

DescribeWorld

Command API Reference / Input / Output

DescribeWorldExportJob

Command API Reference / Input / Output

DescribeWorldGenerationJob

Command API Reference / Input / Output

DescribeWorldTemplate

Command API Reference / Input / Output

GetWorldTemplateBody

Command API Reference / Input / Output

ListDeploymentJobs

Command API Reference / Input / Output

ListFleets

Command API Reference / Input / Output

ListRobotApplications

Command API Reference / Input / Output

ListRobots

Command API Reference / Input / Output

ListSimulationApplications

Command API Reference / Input / Output

ListSimulationJobBatches

Command API Reference / Input / Output

ListSimulationJobs

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListWorldExportJobs

Command API Reference / Input / Output

ListWorldGenerationJobs

Command API Reference / Input / Output

ListWorlds

Command API Reference / Input / Output

ListWorldTemplates

Command API Reference / Input / Output

RegisterRobot

Command API Reference / Input / Output

RestartSimulationJob

Command API Reference / Input / Output

StartSimulationJobBatch

Command API Reference / Input / Output

SyncDeploymentJob

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateRobotApplication

Command API Reference / Input / Output

UpdateSimulationApplication

Command API Reference / Input / Output

UpdateWorldTemplate

Command API Reference / Input / Output