Introduction to using Amazon Neptune APIs - Amazon Neptune
Shared IAM actions
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Introduction to using Amazon Neptune APIs

The Amazon Neptune management APIs provide SDK support for creating, managing and deleting Neptune DB clusters and instances, while the Neptune data APIs provide SDK support for loading data into your graph, running queries, getting information about the data in your graph, and running machine-learning operations. These APIs are available in all SDK languages. By automatically signing API requests, they greatly simply integrating Neptune into applications.

This page provides information about how to use these APIs.

IAM Actions with different names than their Neptune data API SDK counterparts

When you're calling a Neptune API methods on a cluster that has IAM authentication enabled, you have to have an IAM policy attached to the user or role making the calls that provides permissions for the actions you want to make. You set those permissions in the policy using corresponding IAM Actions. You can also restrict the actions that can be taken using IAM Condition keys.

Most IAM actions have the same name as the API methods that they correspond to, but some methods in the data API have different names, because some are shared by more than one method. The table below lists data methods and their corresponding IAM actions:

Data API operation name IAM correspondences

CancelGremlinQuery (cancel_gremlin_query)

Action: neptune-db:CancelQuery

CancelLoaderJob (cancel_loader_job)

Action: neptune-db:CancelLoaderJob

CancelMLDataProcessingJob (cancel_ml_data_processing_job)

Action: neptune-db:CancelMLDataProcessingJob

CancelMLModelTrainingJob (cancel_ml_model_training_job)

Action: neptune-db:CancelMLModelTrainingJob

CancelOpenCypherQuery (cancel_open_cypher_query)

Action: neptune-db:CancelQuery

CreateMLEndpoint (create_ml_endpoint)

Action: neptune-db:CreateMLEndpoint

DeleteMLEndpoint (delete_ml_endpoint)

Action: neptune-db:DeleteMLEndpoint

DeletePropertygraphStatistics (delete_propertygraph_statistics)

Action: neptune-db:DeleteStatistics

DeleteSparqlStatistics (delete_sparql_statistics)

Action: neptune-db:DeleteStatistics

ExecuteFastReset execute_fast_reset()

Action: neptune-db:ResetDatabase

ExecuteGremlinExplainQuery (execute_gremlin_explain_query)

Actions:

  • neptune-db:ReadDataViaQuery

  • neptune-db:WriteDataViaQuery

  • neptune-db:DeleteDataViaQuery

Condition key: neptune-db:QueryLanguage:Gremlin

ExecuteGremlinProfileQuery (execute_gremlin_profile_query)

Action: neptune-db:ReadDataViaQuery

Condition key: neptune-db:QueryLanguage:Gremlin

ExecuteGremlinQuery (execute_gremlin_query)

Actions:

  • neptune-db:ReadDataViaQuery

  • neptune-db:WriteDataViaQuery

  • neptune-db:DeleteDataViaQuery

Condition key: neptune-db:QueryLanguage:Gremlin

ExecuteOpenCypherExplainQuery (execute_open_cypher_explain_query)

Action: neptune-db:ReadDataViaQuery

Condition key: neptune-db:QueryLanguage:OpenCypher

ExecuteOpenCypherQuery (execute_open_cypher_query)

Actions:

  • neptune-db:ReadDataViaQuery

  • neptune-db:WriteDataViaQuery

  • neptune-db:DeleteDataViaQuery

Condition key: neptune-db:QueryLanguage:OpenCypher

GetEngineStatus (get_engine_status)

Action: neptune-db:GetEngineStatus

GetGremlinQueryStatus (get_gremlin_query_status)

Action: neptune-db::GetQueryStatus

Condition key: neptune-db:QueryLanguage:Gremlin

GetLoaderJobStatus (get_loader_job_status)

Action: neptune-db:GetLoaderJobStatus

GetMLDataProcessingJob (get_ml_data_processing_job)

Action: neptune-db:GetMLDataProcessingJobStatus

GetMLEndpoint (get_ml_endpoint)

Action: neptune-db:GetMLEndpointStatus

GetMLModelTrainingJob (get_ml_model_training_job)

Action: neptune-db:GetMLModelTrainingJobStatus

GetMLModelTransformJob (get_ml_model_transform_job)

Action: neptune-db:GetMLModelTransformJobStatus

GetOpenCypherQueryStatus (get_open_cypher_query_status)

Action: neptune-db::GetQueryStatus

Condition key: neptune-db:QueryLanguage:OpenCypher

GetPropertygraphStatistics (get_propertygraph_statistics)

Action: neptune-db:GetStatisticsStatus

GetPropertygraphStream (get_propertygraph_stream)

Action: neptune-db:GetStreamRecords

Condition keys:

  • neptune-db:QueryLanguage:Gremlin

  • neptune-db:QueryLanguage:OpenCypher

GetPropertygraphSummary (get_propertygraph_summary)

Action: neptune-db:GetGraphSummary

GetRDFGraphSummary (get_rdf_graph_summary)

Action: neptune-db:GetGraphSummary

GetSparqlStatistics (get_sparql_statistics)

Action: neptune-db:GetStatisticsStatus

GetSparqlStream (get_sparql_stream)

Action: neptune-db::GetStreamRecords

Condition key: neptune-db:QueryLanguage:Sparql

ListGremlinQueries (list_gremlin_queries)

Action: neptune-db::GetQueryStatus

Condition key: neptune-db:QueryLanguage:Gremlin

ListMLEndpoints (list_ml_endpoints)

Action: neptune-db:ListMLEndpoints

ListMLModelTrainingJobs (list_ml_model_training_jobs)

Action: neptune-db:ListMLModelTrainingJobs

ListMLModelTransformJobs (list_ml_model_transform_jobs)

Action: neptune-db:ListMLModelTransformJobs

ListOpenCypherQueries (list_open_cypher_queries)

Action: neptune-db::GetQueryStatus

Condition key: neptune-db:QueryLanguage:OpenCypher

ManagePropertygraphStatistics (manage_propertygraph_statistics)

Action: neptune-db:ManageStatistics

ManageSparqlStatistics (manage_sparql_statistics)

Action: neptune-db:ManageStatistics

StartLoaderJob (start_loader_job)

Action: neptune-db:StartLoaderJob

StartMLModelDataProcessingJob (start_ml_data_processing_job)

Action: neptune-db:StartMLModelDataProcessingJob

StartMLModelTrainingJob (start_ml_model_training_job)

Action: neptune-db:StartMLModelTrainingJob

StartMLModelTransformJob (start_ml_model_transform_job)

Action: neptune-db:StartMLModelTransformJob