View Source AWS.Neptunedata (aws-elixir v1.0.0)

Neptune Data API

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.

Summary

Functions

Cancels a Neptune ML data processing job.

Cancels a Neptune ML model training job.

Cancels a specified model transform job.

Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed.

Cancels the creation of a Neptune ML inference endpoint.

Deletes statistics for Gremlin and openCypher (property graph) data.

The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.

Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output.

This commands executes a Gremlin query.

Executes an openCypher explain request.

Retrieves the status of the graph database on the host.

Gets the status of a specified Gremlin query.

Retrieves information about a specified data processing job.

Retrieves details about an inference endpoint.

Retrieves information about a Neptune ML model training job.

Gets information about a specified model transform job.

Retrieves the status of a specified openCypher query.

Gets property graph statistics (Gremlin and openCypher).

Gets a graph summary for a property graph.

Gets a graph summary for an RDF graph.

Gets RDF statistics (SPARQL).

Retrieves a list of the loadIds for all active loader jobs.

Manages the generation and use of property graph statistics.

Manages the generation and use of RDF graph statistics.

Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance.

Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training.

Creates a new Neptune ML model training job.

Functions

Link to this function

cancel_gremlin_query(client, query_id, input, options \\ [])

View Source

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.

Link to this function

cancel_loader_job(client, load_id, input, options \\ [])

View Source

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..

Link to this function

cancel_ml_data_processing_job(client, id, input, options \\ [])

View Source

Cancels a Neptune ML data processing job.

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:CancelMLDataProcessingJob IAM action in that cluster.

Link to this function

cancel_ml_model_training_job(client, id, input, options \\ [])

View Source

Cancels a Neptune ML model training job.

See Model training using the modeltraining 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:CancelMLModelTrainingJob IAM action in that cluster.

Link to this function

cancel_ml_model_transform_job(client, id, input, options \\ [])

View Source

Cancels a specified model transform job.

See Use a trained model to generate new model artifacts.

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:CancelMLModelTransformJob IAM action in that cluster.

Link to this function

cancel_open_cypher_query(client, query_id, input, options \\ [])

View Source

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.

Link to this function

create_ml_endpoint(client, input, options \\ [])

View Source

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.

Link to this function

delete_ml_endpoint(client, id, input, options \\ [])

View Source

Cancels the creation of a Neptune ML inference endpoint.

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:DeleteMLEndpoint IAM action in that cluster.

Link to this function

delete_propertygraph_statistics(client, input, options \\ [])

View Source

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.

Link to this function

delete_sparql_statistics(client, input, options \\ [])

View Source

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.

Link to this function

execute_fast_reset(client, input, options \\ [])

View Source

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.

Link to this function

execute_gremlin_explain_query(client, input, options \\ [])

View Source

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:

*

neptune-db:ReadDataViaQuery

*

neptune-db:WriteDataViaQuery

*

neptune-db:DeleteDataViaQuery

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).

Link to this function

execute_gremlin_profile_query(client, input, options \\ [])

View Source

Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output.

See Gremlin profile API in Neptune for details.

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:ReadDataViaQuery 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).

Link to this function

execute_gremlin_query(client, input, options \\ [])

View Source

This commands executes a Gremlin query.

Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under The Graph in the Apache TinkerPop3 documentation. More details can also be found in Accessing a Neptune graph with Gremlin.

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 enables one of the following IAM actions in that cluster, depending on the query:

*

neptune-db:ReadDataViaQuery

*

neptune-db:WriteDataViaQuery

*

neptune-db:DeleteDataViaQuery

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).

Link to this function

execute_open_cypher_explain_query(client, input, options \\ [])

View Source

Executes an openCypher explain request.

See The openCypher explain feature 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:ReadDataViaQuery 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).

Link to this function

execute_open_cypher_query(client, input, options \\ [])

View Source

Executes an openCypher query.

See Accessing the Neptune Graph with openCypher for more information.

Neptune supports building graph applications using openCypher, which is currently one of the most popular query languages among developers working with graph databases. Developers, business analysts, and data scientists like openCypher's declarative, SQL-inspired syntax because it provides a familiar structure in which to querying property graphs.

The openCypher language was originally developed by Neo4j, then open-sourced in 2015 and contributed to the openCypher project under an Apache 2 open-source license.

Note that 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:

*

neptune-db:ReadDataViaQuery

*

neptune-db:WriteDataViaQuery

*

neptune-db:DeleteDataViaQuery

Note also 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).

Link to this function

get_engine_status(client, options \\ [])

View Source

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.

Link to this function

get_gremlin_query_status(client, query_id, options \\ [])

View Source

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).

Link to this function

get_loader_job_status(client, load_id, details \\ nil, errors \\ nil, errors_per_page \\ nil, page \\ nil, options \\ [])

View Source

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..

Link to this function

get_ml_data_processing_job(client, id, neptune_iam_role_arn \\ nil, options \\ [])

View Source

Retrieves information about a specified data processing job.

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:neptune-db:GetMLDataProcessingJobStatus IAM action in that cluster.

Link to this function

get_ml_endpoint(client, id, neptune_iam_role_arn \\ nil, options \\ [])

View Source

Retrieves details about an inference endpoint.

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:GetMLEndpointStatus IAM action in that cluster.

Link to this function

get_ml_model_training_job(client, id, neptune_iam_role_arn \\ nil, options \\ [])

View Source

Retrieves information about a Neptune ML model training job.

See Model training using the modeltraining 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:GetMLModelTrainingJobStatus IAM action in that cluster.

Link to this function

get_ml_model_transform_job(client, id, neptune_iam_role_arn \\ nil, options \\ [])

View Source

Gets information about a specified model transform job.

See Use a trained model to generate new model artifacts.

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:GetMLModelTransformJobStatus IAM action in that cluster.

Link to this function

get_open_cypher_query_status(client, query_id, options \\ [])

View Source

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).

Link to this function

get_propertygraph_statistics(client, options \\ [])

View Source

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.

Link to this function

get_propertygraph_stream(client, commit_num \\ nil, iterator_type \\ nil, limit \\ nil, op_num \\ nil, encoding \\ nil, options \\ [])

View Source

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. GetPropertygraphStream lets you collect these change-log entries for a property graph.

The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.

See Capturing graph changes in real time using Neptune streams.

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:GetStreamRecords IAM action in that cluster.

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 enables one of the following IAM actions, depending on the query:

Note that you can restrict property-graph queries using the following IAM context keys:

*

neptune-db:QueryLanguage:Gremlin

*

neptune-db:QueryLanguage:OpenCypher

See Condition keys available in Neptune IAM data-access policy statements).

Link to this function

get_propertygraph_summary(client, mode \\ nil, options \\ [])

View Source

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.

Link to this function

get_r_d_f_graph_summary(client, mode \\ nil, options \\ [])

View Source

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.

Link to this function

get_sparql_statistics(client, options \\ [])

View Source

Gets RDF statistics (SPARQL).

Link to this function

get_sparql_stream(client, commit_num \\ nil, iterator_type \\ nil, limit \\ nil, op_num \\ nil, encoding \\ nil, options \\ [])

View Source

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. GetSparqlStream lets you collect these change-log entries for an RDF graph.

The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.

See Capturing graph changes in real time using Neptune streams.

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:GetStreamRecords IAM action in that cluster.

Note that the neptune-db:QueryLanguage:Sparql IAM condition key can be used in the policy document to restrict the use of SPARQL queries (see Condition keys available in Neptune IAM data-access policy statements).

Link to this function

list_gremlin_queries(client, include_waiting \\ nil, options \\ [])

View Source

Lists active Gremlin queries.

See Gremlin query status API for details about the output.

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).

Link to this function

list_loader_jobs(client, include_queued_loads \\ nil, limit \\ nil, options \\ [])

View Source

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..

Link to this function

list_ml_data_processing_jobs(client, max_items \\ nil, neptune_iam_role_arn \\ nil, options \\ [])

View Source

Returns a list of Neptune ML data processing jobs.

See Listing active data-processing jobs using the Neptune ML 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:ListMLDataProcessingJobs IAM action in that cluster.

Link to this function

list_ml_endpoints(client, max_items \\ nil, neptune_iam_role_arn \\ nil, options \\ [])

View Source

Lists existing inference endpoints.

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:ListMLEndpoints IAM action in that cluster.

Link to this function

list_ml_model_training_jobs(client, max_items \\ nil, neptune_iam_role_arn \\ nil, options \\ [])

View Source

Lists Neptune ML model-training jobs.

See Model training using the modeltraining 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:neptune-db:ListMLModelTrainingJobs IAM action in that cluster.

Link to this function

list_ml_model_transform_jobs(client, max_items \\ nil, neptune_iam_role_arn \\ nil, options \\ [])

View Source

Returns a list of model transform job IDs.

See Use a trained model to generate new model artifacts.

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:ListMLModelTransformJobs IAM action in that cluster.

Link to this function

list_open_cypher_queries(client, include_waiting \\ nil, options \\ [])

View Source

Lists active openCypher queries.

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: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).

Link to this function

manage_propertygraph_statistics(client, input, options \\ [])

View Source

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.

Link to this function

manage_sparql_statistics(client, input, options \\ [])

View Source

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.

Link to this function

start_loader_job(client, input, options \\ [])

View Source

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.

Link to this function

start_ml_data_processing_job(client, input, options \\ [])

View Source

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.

Link to this function

start_ml_model_training_job(client, input, options \\ [])

View Source

Creates a new Neptune ML model training job.

See Model training using the modeltraining 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:StartMLModelTrainingJob IAM action in that cluster.

Link to this function

start_ml_model_transform_job(client, input, options \\ [])

View Source

Creates a new model transform job.

See Use a trained model to generate new model artifacts.

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:StartMLModelTransformJob IAM action in that cluster.