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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-neptune-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n NeptuneClient\n} = require(\"@aws-sdk/client-neptune-browser/NeptuneClient\");\nconst {\n AddRoleToDBClusterCommand\n} = require(\"@aws-sdk/client-neptune-browser/commands/AddRoleToDBClusterCommand\");\n```\n\n```javascript\n//TypeScript\nimport { NeptuneClient } from \"@aws-sdk/client-neptune-browser/NeptuneClient\";\nimport { AddRoleToDBClusterCommand } from \"@aws-sdk/client-neptune-browser/commands/AddRoleToDBClusterCommand\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst neptune = new NeptuneClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n DBClusterIdentifier: /**a string value*/,\n RoleArn: /**a string value*/,\n};\nconst addRoleToDBClusterCommand = new AddRoleToDBClusterCommand(params);\nneptune.send(addRoleToDBClusterCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await neptune.send(addRoleToDBClusterCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nneptune.send(addRoleToDBClusterCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/@aws-sdk/client-neptune-browser/Neptune\";\nconst neptune = new AWS.Neptune({ region: \"region\" });\nneptune.addRoleToDBCluster(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await neptune.send(addRoleToDBClusterCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-neptune-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-neptune-browser has been renamed to @aws-sdk/client-neptune. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Neptune","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.7","@aws-sdk/query-builder":"^0.1.0-preview.5","@aws-sdk/protocol-query":"^0.1.0-preview.6","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/xml-body-parser":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/query-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.7.1","karma":"^4.1.0","rimraf":"^2.6.2","typedoc":"^0.14.2","puppeteer":"^1.0.0","typescript":"~3.4.0","@types/jest":"^24.0.12","jasmine-core":"^3.4.0","karma-jasmine":"^2.0.1","karma-coverage":"^1.1.1","karma-typescript":"^4.0.0","karma-chrome-launcher":"^3.0.0","@aws-sdk/karma-credential-loader":"^0.1.0-preview.7","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-neptune-browser_0.1.0-preview.3_1568908521192_0.8527688642271911","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-neptune-browser","version":"0.1.0-preview.4","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-neptune-browser@0.1.0-preview.4","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"a8c32f9acf4d89d4b377a517e62d59eb388b0451","tarball":"https://registry.npmjs.org/@aws-sdk/client-neptune-browser/-/client-neptune-browser-0.1.0-preview.4.tgz","fileCount":1968,"integrity":"sha512-oMeJmNqVBOgdPEV74Cp/kRFhcgoX5QzXYV8edRdzQHvTZNKs/THV1lB+t6eCCqBuSqW4n4l+30kGM+ipChDYDA==","signatures":[{"sig":"MEQCIA3g5chodO80oMsKxGun8a3531rbwu2/GUgvARq7B6RmAiAYyh/kHC9Ck8wZO/Yz0KhasQDZVhZt34V+nOzY2yFqzA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1185944,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduNNkCRA9TVsSAnZWagAAIB4P/js2NMbh68RMobVzVPvS\nYxKzzDE3rGPMGJ6EnqiXxaaI6Jt2rT4sXquMyKQPcbQYmnf3tIKggyizPIUj\n8fWglspp55F1+OYfnHygNnBi+aNVbNDTUYzEpPhIIjyA4qRKRJTehWQVbIJb\nw+6syccwhEfCQy6fRpwr+sPreFuCLTrec/tq7aSJLx3mre2E33N0FG+fYKpt\ncP2ciAQ5UgxOjU/OjXqrUn4wwhx1IeOeV+2tlD0p1ILc/ELPSfN+rTcB7B1K\nMNJCaNG2A5CZNVUv+FDjhAANqekKJNC18uChd8ythyyOyZYBurT7tF0r61WG\nek56QXr4kHNDZIJ7tTV2Y357fMarX/hEI084l8JqO8zhkcqaQSSEnBQhEUMR\ngSvxL4xHtqab7UNaiOfIzZDgjFVEjjs6QGAJVK27cpkUN88ABLGRJaaxBKj7\nK2u/jmZbTDOxW4mJaij0CLJg09IdJ4EhXv4Bsmf6WFrSq2A7KPR0In1CgvR3\nxMXPfpeS6zbz4JkI03il7wcnTTBypqBqrLvt0lZa9H+3pWN3sunx+1nWF8V9\nk7n38siHLU+snh1VJI1nem6sKRDpJoLcRcyLTn4T6tKFAlQixZanF+h1I4mg\n8gBp8iroLAR/MtyDGoA7iHdLX1KKfBWHbzPmcoM83ikA8RdRxBtHg5h3deCO\nsFbd\r\n=W8Ln\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-neptune-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-neptune-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-neptune-browser)\n\n## Description\n\nAmazon 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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-neptune-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n NeptuneClient,\n AddRoleToDBClusterCommand\n} = require(\"@aws-sdk/client-neptune-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n NeptuneClient,\n AddRoleToDBClusterCommand\n} from \"@aws-sdk/client-neptune-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst neptune = new NeptuneClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n DBClusterIdentifier: /**a string value*/,\n RoleArn: /**a string value*/,\n};\nconst addRoleToDBClusterCommand = new AddRoleToDBClusterCommand(params);\nneptune.send(addRoleToDBClusterCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await neptune.send(addRoleToDBClusterCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nneptune.send(addRoleToDBClusterCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-neptune-browser\";\nconst neptune = new AWS.Neptune({ region: \"region\" });\nneptune.addRoleToDBCluster(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await neptune.send(addRoleToDBClusterCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-neptune-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-neptune-browser has been renamed to @aws-sdk/client-neptune. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Neptune","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.6","@aws-sdk/core-handler":"^0.1.0-preview.6","@aws-sdk/signature-v4":"^0.1.0-preview.8","@aws-sdk/query-builder":"^0.1.0-preview.6","@aws-sdk/protocol-query":"^0.1.0-preview.7","@aws-sdk/config-resolver":"^0.1.0-preview.6","@aws-sdk/xml-body-parser":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/url-parser-browser":"^0.1.0-preview.6","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.7","@aws-sdk/query-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/stream-collector-browser":"^0.1.0-preview.6","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.6","@aws-sdk/middleware-header-default":"^0.1.0-preview.6"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.7.1","karma":"^4.1.0","rimraf":"^2.6.2","typedoc":"^0.14.2","puppeteer":"^1.0.0","typescript":"~3.4.0","@types/jest":"^24.0.12","jasmine-core":"^3.4.0","karma-jasmine":"^2.0.1","karma-coverage":"^1.1.1","karma-typescript":"^4.0.0","karma-chrome-launcher":"^3.0.0","@aws-sdk/karma-credential-loader":"^0.1.0-preview.8","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-neptune-browser_0.1.0-preview.4_1572393827641_0.9865635486938722","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-neptune-browser","version":"0.1.0-preview.5","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-neptune-browser@0.1.0-preview.5","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"ff9e31cf7968bdf1b17b0692e2c480bdee292b9a","tarball":"https://registry.npmjs.org/@aws-sdk/client-neptune-browser/-/client-neptune-browser-0.1.0-preview.5.tgz","fileCount":1968,"integrity":"sha512-0guXUIlYBonBAEgsswcsx+oV/GyC8neM1TwgXg5QjCc3oMd91eF8HFVbeqU2m5yqKQzfF/NpbDWFvsAZcH2ABQ==","signatures":[{"sig":"MEUCIGy19nw8gymyDuhKFYHuNPxaoTpp4ASDGk4BLJVL6mpiAiEAmZBhT1Ikws4moDwH8eEeq2QPX0b6YYhzUgoocQ4/G7s=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1186188,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueb+CRA9TVsSAnZWagAA9ZYP/RBoDFAcKriE+mnCmrww\nf+Q03Q1dyWNZxGY1Us8ZlSJf4qhJuYjJE8JYPQFnWewN76XGzRBbLRjjBh81\n30mMta+BKBwHWm8n0pTNKyBcjO/HAuruWY+Z8PzpaD4u6GN2dT6gbMxb2bbi\n8CtX7ymrq4rdwDnCZUsoz6XughoEWzHZY/GB5vL0tWc7v/q/TWY5P2UmXWPy\nPSoN4GD/HDlPoPJfgmSm+/Qr4TLbKEqmUZ0UqAni+SOHwhIRGZP0Bxir2G6m\nTFFMh09e4/HjtYJmhVnrt5rkwqo+AQdM1tTaZjrlQZVt7rKjq7HgD3y8mfqg\nTIJpifUByCVK7nBs4irwx9NtSrNY6btqPmA3QKDLNjbUwoFv2DNKYEfqhd9h\nwr4CntZZfdPENu4Sb9FhRO594y3Lh7iksMyb2wLRS+ej3oKtBvKk4QKN/NZb\nTYfWpFuKIaYlHV4eplOFg9p9WqeBVV+r8TP2uKnosFXZ/DS4aoOIGZUoT9JH\nvbxezeR+aH36R+VRGc8dhDzrU/OuZcw5N4jj+haAnTo/+JHhHUGaSiUMQJSm\no5ENkG/Ie11VYFzTDAkVUh9UpF/xQcTboXjJrjwtFlCr633J0O1XXI7Zqvn+\nm39wTjcvzJBNGWTpGG5Q8RnvryclwLgpuXTd3PO4S8V0hvWixVFOX7MRqQWJ\nvSfw\r\n=WvYW\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-neptune-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-neptune-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-neptune-browser)\n\n## Description\n\nAmazon 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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-neptune-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n NeptuneClient,\n AddRoleToDBClusterCommand\n} = require(\"@aws-sdk/client-neptune-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n NeptuneClient,\n AddRoleToDBClusterCommand\n} from \"@aws-sdk/client-neptune-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst neptune = new NeptuneClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n DBClusterIdentifier: /**a string value*/,\n RoleArn: /**a string value*/,\n};\nconst addRoleToDBClusterCommand = new AddRoleToDBClusterCommand(params);\nneptune.send(addRoleToDBClusterCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await neptune.send(addRoleToDBClusterCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nneptune.send(addRoleToDBClusterCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-neptune-browser\";\nconst neptune = new AWS.Neptune({ region: \"region\" });\nneptune.addRoleToDBCluster(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await neptune.send(addRoleToDBClusterCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-neptune-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-neptune-browser has been renamed to @aws-sdk/client-neptune. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Neptune","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.9","@aws-sdk/query-builder":"^0.1.0-preview.7","@aws-sdk/protocol-query":"^0.1.0-preview.8","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/xml-body-parser":"^0.1.0-preview.8","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.8","@aws-sdk/query-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.7.1","karma":"^4.1.0","rimraf":"^2.6.2","typedoc":"^0.14.2","puppeteer":"^1.0.0","typescript":"~3.4.0","@types/jest":"^24.0.12","jasmine-core":"^3.4.0","karma-jasmine":"^2.0.1","karma-coverage":"^1.1.1","karma-typescript":"^4.0.0","karma-chrome-launcher":"^3.0.0","@aws-sdk/karma-credential-loader":"^0.1.0-preview.9","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-neptune-browser_0.1.0-preview.5_1572464381916_0.5725817587773463","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-neptune-browser","version":"0.1.0-preview.6","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-neptune-browser@0.1.0-preview.6","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"06064ffe8df71417048d766d36f07accc9a135af","tarball":"https://registry.npmjs.org/@aws-sdk/client-neptune-browser/-/client-neptune-browser-0.1.0-preview.6.tgz","fileCount":1968,"integrity":"sha512-MQFG1CG+Gsmxp+WKX8hFyEjwZ8ZlTDO2+vNbjOMKYyTVeWZeG+9B2SpwEwopZdT5K9xYqcrX4a+J5S6XV2MgNw==","signatures":[{"sig":"MEQCIELLXrqmbJbrf3ZQwRKW4ZuvvMd2OQraPnVXjmrXw7dqAiBps6PqfRilA/6ZRI4UtR/jI82nHqdeF12p9A4iEyRH2A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1186459,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FV8CRA9TVsSAnZWagAAcRIP/3gXGAApPp7YQ9i7Emry\nH8Q4bYZMncDwoMSZlkQxJa9j21b6IXT3mg34geN+EKe6mbM6OnGUq09EbkS+\nGmJwAen48vQHY+cDL11SewVeVonsC7yNS4p671W+uIhUepkzbwT9FKD2zEKI\nveON+l6+Fa7caveU5dtbvI6oStzkNg/Ax1F2CSQY7FVH8Sj/uFS04pBWfqNp\nz3j/4rkYZSXf5hiG3fQmT5KpEgm5LCW3gFxY1YZTqYMiyBKNDQ/ivjhN1seI\nTeqnRCp8a2abovjXhFhIPGugrkj4bx8R5V5EfpGCvc7bobtKpYEWGSUjeOez\nFYDzZ3C4GiKnNUPHKZqlk9dcYbyeWhZq9Cd+NzP+Kl86ULTpry4pQ/gG0C9G\nQrDFIPqdO1CBd7SLKE7laCOJ/k3AB03E2nLhhUxnbX3WfvFdRb0B3/y6/bn8\nHsC9avW3ADc85LbJxuDN63Cn4eaR/T/Mtsd30mmmsXyRhvRoIWCxjLMdPJZ2\nCZATaqArrogmv5JU07iYeWm9+K7sKwE3CcwWAYOOLdAD+dV3UCFZZNM/0Yfd\n6IEskRZ4+7a1ql3Kdfrr0SP6MzvBj0EfGNr9ufRv08nuu4scI2PheoiiusfP\nkZfsiHzJPp2A0Pxfixyg4fhHSDmw9gSlnOxXxy4c9NJM24tfg7wUfobhrSMq\nGgKN\r\n=8RGh\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-neptune-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-neptune-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-neptune-browser)\n\n## Description\n\nAmazon 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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-neptune-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n NeptuneClient,\n AddRoleToDBClusterCommand\n} = require(\"@aws-sdk/client-neptune-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n NeptuneClient,\n AddRoleToDBClusterCommand\n} from \"@aws-sdk/client-neptune-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst neptune = new NeptuneClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n DBClusterIdentifier: /**a string value*/,\n RoleArn: /**a string value*/,\n};\nconst addRoleToDBClusterCommand = new AddRoleToDBClusterCommand(params);\nneptune.send(addRoleToDBClusterCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await neptune.send(addRoleToDBClusterCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nneptune.send(addRoleToDBClusterCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-neptune-browser\";\nconst neptune = new AWS.Neptune({ region: \"region\" });\nneptune.addRoleToDBCluster(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await neptune.send(addRoleToDBClusterCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-neptune-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-neptune-browser has been renamed to @aws-sdk/client-neptune. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Neptune","directories":{},"_nodeVersion":"10.16.3","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.10","@aws-sdk/query-builder":"^0.1.0-preview.7","@aws-sdk/protocol-query":"^0.1.0-preview.9","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/xml-body-parser":"^0.1.0-preview.9","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.9","@aws-sdk/query-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.7.1","karma":"^4.1.0","rimraf":"^2.6.2","typedoc":"^0.14.2","puppeteer":"^1.0.0","typescript":"~3.4.0","@types/jest":"^24.0.12","jasmine-core":"^3.4.0","karma-jasmine":"^2.0.1","karma-coverage":"^1.1.1","karma-typescript":"^4.0.0","karma-chrome-launcher":"^3.0.0","@aws-sdk/karma-credential-loader":"^0.1.0-preview.10","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-neptune-browser_0.1.0-preview.6_1574196604220_0.8149001112312422","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T18:04:31.867Z","modified":"2025-03-27T18:45:03.705Z","0.1.0-preview.2":"2019-09-09T18:04:32.289Z","0.1.0-preview.3":"2019-09-19T15:55:21.457Z","0.1.0-preview.4":"2019-10-30T00:03:47.914Z","0.1.0-preview.5":"2019-10-30T19:39:42.155Z","0.1.0-preview.6":"2019-11-19T20:50:04.450Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Browser SDK for Amazon Neptune","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}