AWS SDK for JavaScript Neptunedata Client for Node.js, Browser and React Native
npm install @aws-sdk/client-neptunedataAWS SDK for JavaScript Neptunedata Client for Node.js, Browser and React Native.
The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data operations, including data loading, query execution, data inquiry, and machine learning. It supports the Gremlin and openCypher query languages, and is available in all SDK languages. It automatically signs API requests and greatly simplifies integrating Neptune into your applications.
npm install @aws-sdk/client-neptunedatayarn add @aws-sdk/client-neptunedatapnpm add @aws-sdk/client-neptunedataThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the NeptunedataClient and
the commands you need, for example ListLoaderJobsCommand:
``js`
// ES5 example
const { NeptunedataClient, ListLoaderJobsCommand } = require("@aws-sdk/client-neptunedata");
`ts`
// ES6+ example
import { NeptunedataClient, ListLoaderJobsCommand } from "@aws-sdk/client-neptunedata";
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.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new NeptunedataClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListLoaderJobsCommand(params);
`
#### Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
`js`
// 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.
`js`
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
`js`
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.
`js`
// 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
`ts
import * as AWS from "@aws-sdk/client-neptunedata";
const client = new AWS.Neptunedata({ region: "REGION" });
// async/await.
try {
const data = await client.listLoaderJobs(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listLoaderJobs(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listLoaderJobs(params, (err, data) => {
// process err and data.
});
`
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
`js`
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;
* }
*/
}
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.
- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-neptunedata` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
CancelGremlinQuery
Command API Reference / Input / Output
CancelLoaderJob
Command API Reference / Input / Output
CancelMLDataProcessingJob
Command API Reference / Input / Output
CancelMLModelTrainingJob
Command API Reference / Input / Output
CancelMLModelTransformJob
Command API Reference / Input / Output
CancelOpenCypherQuery
Command API Reference / Input / Output
CreateMLEndpoint
Command API Reference / Input / Output
DeleteMLEndpoint
Command API Reference / Input / Output
DeletePropertygraphStatistics
Command API Reference / Input / Output
DeleteSparqlStatistics
Command API Reference / Input / Output
ExecuteFastReset
Command API Reference / Input / Output
ExecuteGremlinExplainQuery
Command API Reference / Input / Output
ExecuteGremlinProfileQuery
Command API Reference / Input / Output
ExecuteGremlinQuery
Command API Reference / Input / Output
ExecuteOpenCypherExplainQuery
Command API Reference / Input / Output
ExecuteOpenCypherQuery
Command API Reference / Input / Output
GetEngineStatus
Command API Reference / Input / Output
GetGremlinQueryStatus
Command API Reference / Input / Output
GetLoaderJobStatus
Command API Reference / Input / Output
GetMLDataProcessingJob
Command API Reference / Input / Output
GetMLEndpoint
Command API Reference / Input / Output
GetMLModelTrainingJob
Command API Reference / Input / Output
GetMLModelTransformJob
Command API Reference / Input / Output
GetOpenCypherQueryStatus
Command API Reference / Input / Output
GetPropertygraphStatistics
Command API Reference / Input / Output
GetPropertygraphStream
Command API Reference / Input / Output
GetPropertygraphSummary
Command API Reference / Input / Output
GetRDFGraphSummary
Command API Reference / Input / Output
GetSparqlStatistics
Command API Reference / Input / Output
GetSparqlStream
Command API Reference / Input / Output
ListGremlinQueries
Command API Reference / Input / Output
ListLoaderJobs
Command API Reference / Input / Output
ListMLDataProcessingJobs
Command API Reference / Input / Output
ListMLEndpoints
Command API Reference / Input / Output
ListMLModelTrainingJobs
Command API Reference / Input / Output
ListMLModelTransformJobs
Command API Reference / Input / Output
ListOpenCypherQueries
Command API Reference / Input / Output
ManagePropertygraphStatistics
Command API Reference / Input / Output
ManageSparqlStatistics
Command API Reference / Input / Output
StartLoaderJob
Command API Reference / Input / Output
StartMLDataProcessingJob
Command API Reference / Input / Output
StartMLModelTrainingJob
Command API Reference / Input / Output
StartMLModelTransformJob