This package has been deprecated

Author message:

The package @aws-sdk/client-neptune-node has been renamed to @aws-sdk/client-neptune. Please install the renamed package.

@aws-sdk/client-neptune-node

Description

Amazon Neptune

Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.

This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-neptune-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(NeptuneClient) and the commands you need, for example AddRoleToDBClusterCommand:

//JavaScript
const { NeptuneClient } = require("@aws-sdk/client-neptune-node/NeptuneClient");
const {
  AddRoleToDBClusterCommand
} = require("@aws-sdk/client-neptune-node/commands/AddRoleToDBClusterCommand");

//TypeScript
import { NeptuneClient } from "@aws-sdk/client-neptune-node/NeptuneClient";
import { AddRoleToDBClusterCommand } from "@aws-sdk/client-neptune-node/commands/AddRoleToDBClusterCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const neptune = new NeptuneClient({region: 'region'});
//clients can be shared by different commands
const params = {
  DBClusterIdentifier: /**a string value*/,
  RoleArn: /**a string value*/,
};
const addRoleToDBClusterCommand = new AddRoleToDBClusterCommand(params);
neptune.send(addRoleToDBClusterCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await neptune.send(addRoleToDBClusterCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
neptune.send(addRoleToDBClusterCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-neptune-node/Neptune";
const neptune = new AWS.Neptune({ region: "region" });
neptune.addRoleToDBCluster(params, (err, data) => {
  //do something
});

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 neptune.send(addRoleToDBClusterCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-neptune-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

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