Spotinst SDK Node.js

A Node.js client library for accessing the Spotinst API.

You can view Spotinst API docs here.

Installation

npm install spotinst-sdk-nodejs --save

Usage

import { Client, config } from 'spotinst-sdk-nodejs';

Create a new Spotinst client, then use the exposed services to access different parts of the Spotinst API.

Authentication

import { Client, config } from 'spotinst-sdk-nodejs';

// Instantiate new client.
const clientOpts = [
  config.setToken('foo'),
  config.setAccount('act-XXXXXX')
];
const client = new Client(...clientOpts);

Callback or Promise?

All methods in the SDK provide both callback based as well as promise based interactions. If you want to use callback just pass it as a last parameter. For example:

client.AwsGroupService.read({id: 'sig-bar'}, (err, groups) => {
  if (err) {
    console.error(err);
    // Do something with err.
    return;
  }

  console.log(groups);
  // Do something with groups.
});

If you prefer to use promises then the code goes like this:

client.AwsGroupService.read({id: 'sig-bar'})
  .then((groups) => {
    console.log(groups);
    // Do something with groups.
  })
  .catch((err) => {
    console.error(err);
    // Do something with err.
  });

ES5

If you prefer to use ES5 syntax instead of ES6 then the code goes like this:

var spotinst = require('spotinst-sdk-nodejs');

// Instantiate new client.
var client = new spotinst.Client(
  spotinst.config.setToken('foo'),
);

client.AwsGroupService.read({id: 'sig-bar'}, (err, groups) => {
  if (err) {
    console.error(err);
    // Do something with err.
    return;
  }

  console.log(groups);
  // Do something with groups.
});

Available Servies

Services and actions are formatted as client.SERVICE.ACTION()

Example:

client.AwsGroupService.list()
  .then((groups) => {
    console.log(groups);
    // do something with groups
  })
  .catch((err) => {
    console.error(err);
    // do something with err
  });

AwsGroupService

Manage Spotinst Elastigroups

Actions:

• create
• read
• list
• update
• delete
• status

AwsGroupRollService

Manage Elastigroups with AWS EMR integration

Actions:

• start
• stop
• list
• read

AwsInstanceService

Manage a single instance within an Elastigroup

Actions:

• read
• detach
• signal

AwsSpotService

Describes a specific Spot Instance Request

Actions:

• read

SubscriptionService

Manage Spotinst Subscriptions

Actions:

• create
• read
• list
• update
• delete

SpectrumService.Event

Manage Spectrum Events

Actions:

• create
• read
• list
• update
• delete

MrScalerAwsService

Manage Elastigroups with AWS EMR integration

Actions:

• create
• read
• list
• update
• delete

Documentation

For a comprehensive list of examples, check out the API documentation.

Contributing

We love pull requests! Please see the contribution guidelines.