Class: AWS.Neptunedata
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Neptunedata
- Identifier:
- neptunedata
- API Version:
- 2023-08-01
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
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.
Sending a Request Using Neptunedata
var neptunedata = new AWS.Neptunedata();
neptunedata.cancelGremlinQuery(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Neptunedata object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var neptunedata = new AWS.Neptunedata({apiVersion: '2023-08-01'});
You can also set the API version globally in AWS.config.apiVersions using
the neptunedata service identifier:
AWS.config.apiVersions = {
neptunedata: '2023-08-01',
// other service API versions
};
var neptunedata = new AWS.Neptunedata();
Constructor Summary collapse
-
new AWS.Neptunedata(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
cancelGremlinQuery(params = {}, callback) ⇒ AWS.Request
Cancels a Gremlin query.
-
cancelLoaderJob(params = {}, callback) ⇒ AWS.Request
Cancels a specified load job.
-
cancelMLDataProcessingJob(params = {}, callback) ⇒ AWS.Request
Cancels a Neptune ML data processing job.
-
cancelMLModelTrainingJob(params = {}, callback) ⇒ AWS.Request
Cancels a Neptune ML model training job.
-
cancelMLModelTransformJob(params = {}, callback) ⇒ AWS.Request
Cancels a specified model transform job.
-
cancelOpenCypherQuery(params = {}, callback) ⇒ AWS.Request
Cancels a specified openCypher query.
-
createMLEndpoint(params = {}, callback) ⇒ AWS.Request
Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed.
-
deleteMLEndpoint(params = {}, callback) ⇒ AWS.Request
Cancels the creation of a Neptune ML inference endpoint.
-
deletePropertygraphStatistics(params = {}, callback) ⇒ AWS.Request
Deletes statistics for Gremlin and openCypher (property graph) data.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteStatistics IAM action in that cluster.
. -
deleteSparqlStatistics(params = {}, callback) ⇒ AWS.Request
Deletes SPARQL statistics
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteStatistics IAM action in that cluster.
. -
executeFastReset(params = {}, callback) ⇒ AWS.Request
The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.
Neptune fast reset is a two-step process.
-
executeGremlinExplainQuery(params = {}, callback) ⇒ AWS.Request
Executes a Gremlin Explain query.
Amazon Neptune has added a Gremlin feature named
explainthat provides is a self-service tool for understanding the execution approach being taken by the Neptune engine for the query. -
executeGremlinProfileQuery(params = {}, callback) ⇒ AWS.Request
Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output.
-
executeGremlinQuery(params = {}, callback) ⇒ AWS.Request
This commands executes a Gremlin query.
-
executeOpenCypherExplainQuery(params = {}, callback) ⇒ AWS.Request
Executes an openCypher
explainrequest. -
executeOpenCypherQuery(params = {}, callback) ⇒ AWS.Request
Executes an openCypher query.
-
getEngineStatus(params = {}, callback) ⇒ AWS.Request
Retrieves the status of the graph database on the host.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetEngineStatus IAM action in that cluster.
. -
getGremlinQueryStatus(params = {}, callback) ⇒ AWS.Request
Gets the status of a specified Gremlin query.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.
Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).
. -
getLoaderJobStatus(params = {}, callback) ⇒ AWS.Request
Gets status information about a specified load job.
-
getMLDataProcessingJob(params = {}, callback) ⇒ AWS.Request
Retrieves information about a specified data processing job.
-
getMLEndpoint(params = {}, callback) ⇒ AWS.Request
Retrieves details about an inference endpoint.
-
getMLModelTrainingJob(params = {}, callback) ⇒ AWS.Request
Retrieves information about a Neptune ML model training job.
-
getMLModelTransformJob(params = {}, callback) ⇒ AWS.Request
Gets information about a specified model transform job.
-
getOpenCypherQueryStatus(params = {}, callback) ⇒ AWS.Request
Retrieves the status of a specified openCypher query.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.
Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).
. -
getPropertygraphStatistics(params = {}, callback) ⇒ AWS.Request
Gets property graph statistics (Gremlin and openCypher).
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStatisticsStatus IAM action in that cluster.
. -
getPropertygraphStream(params = {}, callback) ⇒ AWS.Request
Gets a stream for a property graph.
With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens.
-
getPropertygraphSummary(params = {}, callback) ⇒ AWS.Request
Gets a graph summary for a property graph.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetGraphSummary IAM action in that cluster.
. -
getRDFGraphSummary(params = {}, callback) ⇒ AWS.Request
Gets a graph summary for an RDF graph.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetGraphSummary IAM action in that cluster.
. -
getSparqlStatistics(params = {}, callback) ⇒ AWS.Request
Gets RDF statistics (SPARQL).
.
-
getSparqlStream(params = {}, callback) ⇒ AWS.Request
Gets a stream for an RDF graph.
With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens.
-
listGremlinQueries(params = {}, callback) ⇒ AWS.Request
Lists active Gremlin queries.
-
listLoaderJobs(params = {}, callback) ⇒ AWS.Request
Retrieves a list of the
loadIdsfor all active loader jobs.When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListLoaderJobs IAM action in that cluster..
. -
listMLDataProcessingJobs(params = {}, callback) ⇒ AWS.Request
Returns a list of Neptune ML data processing jobs.
-
listMLEndpoints(params = {}, callback) ⇒ AWS.Request
Lists existing inference endpoints.
-
listMLModelTrainingJobs(params = {}, callback) ⇒ AWS.Request
Lists Neptune ML model-training jobs.
-
listMLModelTransformJobs(params = {}, callback) ⇒ AWS.Request
Returns a list of model transform job IDs.
- listOpenCypherQueries(params = {}, callback) ⇒ AWS.Request