AWS.Neptunedata — AWS SDK for JavaScript (original) (raw)
Property Details
endpoint ⇒ AWS.Endpoint
Returns an Endpoint object representing the endpoint URL for service requests.
Method Details
cancelGremlinQuery(params = {}, callback) ⇒ AWS.Request
Cancels a Gremlin query. See Gremlin query cancellation for more information.
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:CancelQuery IAM action in that cluster.
cancelLoaderJob(params = {}, callback) ⇒ AWS.Request
Cancels a specified load job. This is an HTTP DELETE request. See Neptune Loader Get-Status API for more information.
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:CancelLoaderJob IAM action in that cluster..
cancelMLDataProcessingJob(params = {}, callback) ⇒ AWS.Request
cancelMLModelTrainingJob(params = {}, callback) ⇒ AWS.Request
cancelMLModelTransformJob(params = {}, callback) ⇒ AWS.Request
cancelOpenCypherQuery(params = {}, callback) ⇒ AWS.Request
Cancels a specified openCypher query. See Neptune openCypher status endpoint for more information.
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:CancelQuery IAM action in that cluster.
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. See Managing inference endpoints using the endpoints command.
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:CreateMLEndpoint IAM action in that cluster.
deleteMLEndpoint(params = {}, callback) ⇒ AWS.Request
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. First you call ExecuteFastReset with action set to initiateDatabaseReset. This returns a UUID token which you then include when calling ExecuteFastReset again with action set to performDatabaseReset. See Empty an Amazon Neptune DB cluster using the fast reset API.
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:ResetDatabase IAM action in that cluster.
executeGremlinExplainQuery(params = {}, callback) ⇒ AWS.Request
Executes a Gremlin Explain query.
Amazon Neptune has added a Gremlin feature named explain that provides is a self-service tool for understanding the execution approach being taken by the Neptune engine for the query. You invoke it by adding an explain parameter to an HTTP call that submits a Gremlin query.
The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tune your query, as explained in Tuning Gremlin queries. You can also use query hints to improve query execution plans.
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 one of the following IAM actions in that cluster, depending on the query:
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).
executeGremlinProfileQuery(params = {}, callback) ⇒ AWS.Request
executeGremlinQuery(params = {}, callback) ⇒ AWS.Request
executeOpenCypherExplainQuery(params = {}, callback) ⇒ AWS.Request
executeOpenCypherQuery(params = {}, callback) ⇒ AWS.Request
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
getLoaderJobStatus(params = {}, callback) ⇒ AWS.Request
Gets status information about a specified load job. Neptune keeps track of the most recent 1,024 bulk load jobs, and stores the last 10,000 error details per job.
See Neptune Loader Get-Status API for more information.
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:GetLoaderJobStatus IAM action in that cluster..
getMLDataProcessingJob(params = {}, callback) ⇒ AWS.Request
getMLEndpoint(params = {}, callback) ⇒ AWS.Request
getMLModelTrainingJob(params = {}, callback) ⇒ AWS.Request
getMLModelTransformJob(params = {}, callback) ⇒ AWS.Request
getOpenCypherQueryStatus(params = {}, callback) ⇒ AWS.Request
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
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
listGremlinQueries(params = {}, callback) ⇒ AWS.Request
listLoaderJobs(params = {}, callback) ⇒ AWS.Request
Retrieves a list of the loadIds for 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
listMLEndpoints(params = {}, callback) ⇒ AWS.Request
listMLModelTrainingJobs(params = {}, callback) ⇒ AWS.Request
listMLModelTransformJobs(params = {}, callback) ⇒ AWS.Request
listOpenCypherQueries(params = {}, callback) ⇒ AWS.Request
managePropertygraphStatistics(params = {}, callback) ⇒ AWS.Request
Manages the generation and use of property graph 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:ManageStatistics IAM action in that cluster.
manageSparqlStatistics(params = {}, callback) ⇒ AWS.Request
Manages the generation and use of RDF graph 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:ManageStatistics IAM action in that cluster.
startLoaderJob(params = {}, callback) ⇒ AWS.Request
Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance. See Using the Amazon Neptune Bulk Loader to Ingest 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:StartLoaderJob IAM action in that cluster.
### startMLDataProcessingJob(params = {}, callback) ⇒ AWS.Request
Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training. See The dataprocessing command.
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:StartMLModelDataProcessingJob IAM action in that cluster.