Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

iaesdk

IBM66Apache-2.02.5.0TypeScript support: included

IBM Analytics Engine Node SDK

ibm

readme

Build Status semantic-release

IBM Cloud Analytics Engine Node.js SDK

Node.js client library to interact with various IBM Analytics Engine APIs.

Table of Contents

Overview

The IBM Cloud iaesdk Node.js SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name Import Path
IBM Analytics Engine v2 iaesdk/ibm-analytics-engine-api/v2
IBM Analytics Engine v3 iaesdk/ibm-analytics-engine-api/v3

NOTE:

IBM Analytics Engine v2 is for the classic plans : Lite, Standard Hourly and Standard monthly. The classic plans are now deprecated.

IBM Analytics Engine v3 is for the Standard Serverless Spark plan

Prerequisites

  • You need an IBM Cloud account.
  • Node.js >=14: This SDK is tested with Node.js versions 14 and up. It may work on previous versions but this is not officially supported.

Installation

npm install iaesdk

Using the SDK

For general SDK usage information, please see this link

In setting client options programatically to instantiate the class, provide the following two values:

  1. IAM API Key
  2. Service URLs

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at dW Answers or Stack Overflow.

Issues

If you encounter an issue with the SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible someone has already encountered this issue.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

This project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.

changelog

2.5.0 (2023-11-17)

Bug Fixes

Features

  • add support for time based application list filters (dadb28c)

2.4.0 (2023-05-24)

Features

  • add support for application list pagination (87c2d75)

2.3.0 (2023-03-23)

Bug Fixes

  • remove unused config from travis (903fc5a)
  • remove unused config from travis (11afa05)

Features

  • add new sdk method to update instance home credentials (3a54f1e)

2.2.0 (2023-01-05)

Features

  • add spark history server api (0c33c3a)

2.1.0 (2022-11-24)

Features

  • add new sdk methods and updated existing ones (74dda34)

2.0.0 (2022-09-08)

Features

  • add sdk methods for v3 api and update dependencies (f740ba2)

BREAKING CHANGES

  • Minimum supported nodejs version

The minimum supported version of nodejs is now v14.

Signed-off-by: Subin Shekhar subinpc@gmail.com

1.1.1 (2021-09-07)

Bug Fixes

  • analytics engine: fixed Spark application submit path and payload (#25) (d586050)

1.1.0 (2021-08-17)

Bug Fixes

Features

  • analytics engine v3 feature changes (6c5cd16)
  • analytics engine v3 feature changes (b1cb904)
  • analytics engine v3 feature changes (f7be010)
  • analytics engine v3 feature changes (e19751a)
  • analytics engine v3 feature changes (39feb3b)
  • analytics engine v3 feature changes (432f5da)
  • analytics engine v3 feature changes (a8c4c93)

1.0.2 (2020-05-23)

Bug Fixes

  • Readme: add build details to readme (01c52db)
  • Readme: fix title in Readme (4521862)

1.0.1 (2020-05-23)

Bug Fixes

  • Readme: fix version in Readme (2d41e98)

1.0.0 (2020-05-23)

Features

  • whitelist api: Adding whitelisting apis to modify clusters with private endpoints (f374da0)