Class: Aws::Neptunedata::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Neptunedata::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb
Overview
An API client for Neptunedata. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Neptunedata::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#cancel_gremlin_query(params = {}) ⇒ Types::CancelGremlinQueryOutput
Cancels a Gremlin query.
-
#cancel_loader_job(params = {}) ⇒ Types::CancelLoaderJobOutput
Cancels a specified load job.
-
#cancel_ml_data_processing_job(params = {}) ⇒ Types::CancelMLDataProcessingJobOutput
Cancels a Neptune ML data processing job.
-
#cancel_ml_model_training_job(params = {}) ⇒ Types::CancelMLModelTrainingJobOutput
Cancels a Neptune ML model training job.
-
#cancel_ml_model_transform_job(params = {}) ⇒ Types::CancelMLModelTransformJobOutput
Cancels a specified model transform job.
-
#cancel_open_cypher_query(params = {}) ⇒ Types::CancelOpenCypherQueryOutput
Cancels a specified openCypher query.
-
#create_ml_endpoint(params = {}) ⇒ Types::CreateMLEndpointOutput
Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed.
-
#delete_ml_endpoint(params = {}) ⇒ Types::DeleteMLEndpointOutput
Cancels the creation of a Neptune ML inference endpoint.
-
#delete_propertygraph_statistics(params = {}) ⇒ Types::DeletePropertygraphStatisticsOutput
Deletes statistics for Gremlin and openCypher (property graph) data.
-
#delete_sparql_statistics(params = {}) ⇒ Types::DeleteSparqlStatisticsOutput
Deletes SPARQL statistics.
-
#execute_fast_reset(params = {}) ⇒ Types::ExecuteFastResetOutput
The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.
-
#execute_gremlin_explain_query(params = {}) ⇒ Types::ExecuteGremlinExplainQueryOutput
Executes a Gremlin Explain query.
-
#execute_gremlin_profile_query(params = {}) ⇒ Types::ExecuteGremlinProfileQueryOutput
Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output.
-
#execute_gremlin_query(params = {}) ⇒ Types::ExecuteGremlinQueryOutput
This commands executes a Gremlin query.
-
#execute_open_cypher_explain_query(params = {}) ⇒ Types::ExecuteOpenCypherExplainQueryOutput
Executes an openCypher
explain
request. -
#execute_open_cypher_query(params = {}) ⇒ Types::ExecuteOpenCypherQueryOutput
Executes an openCypher query.
-
#get_engine_status(params = {}) ⇒ Types::GetEngineStatusOutput
Retrieves the status of the graph database on the host.
-
#get_gremlin_query_status(params = {}) ⇒ Types::GetGremlinQueryStatusOutput
Gets the status of a specified Gremlin query.
-
#get_loader_job_status(params = {}) ⇒ Types::GetLoaderJobStatusOutput
Gets status information about a specified load job.
-
#get_ml_data_processing_job(params = {}) ⇒ Types::GetMLDataProcessingJobOutput
Retrieves information about a specified data processing job.
-
#get_ml_endpoint(params = {}) ⇒ Types::GetMLEndpointOutput
Retrieves details about an inference endpoint.
-
#get_ml_model_training_job(params = {}) ⇒ Types::GetMLModelTrainingJobOutput
Retrieves information about a Neptune ML model training job.
-
#get_ml_model_transform_job(params = {}) ⇒ Types::GetMLModelTransformJobOutput
Gets information about a specified model transform job.
-
#get_open_cypher_query_status(params = {}) ⇒ Types::GetOpenCypherQueryStatusOutput
Retrieves the status of a specified openCypher query.
-
#get_propertygraph_statistics(params = {}) ⇒ Types::GetPropertygraphStatisticsOutput
Gets property graph statistics (Gremlin and openCypher).
-
#get_propertygraph_stream(params = {}) ⇒ Types::GetPropertygraphStreamOutput
Gets a stream for a property graph.
-
#get_propertygraph_summary(params = {}) ⇒ Types::GetPropertygraphSummaryOutput
Gets a graph summary for a property graph.
-
#get_rdf_graph_summary(params = {}) ⇒ Types::GetRDFGraphSummaryOutput
Gets a graph summary for an RDF graph.
-
#get_sparql_statistics(params = {}) ⇒ Types::GetSparqlStatisticsOutput
Gets RDF statistics (SPARQL).
-
#get_sparql_stream(params = {}) ⇒ Types::GetSparqlStreamOutput
Gets a stream for an RDF graph.
-
#list_gremlin_queries(params = {}) ⇒ Types::ListGremlinQueriesOutput
Lists active Gremlin queries.
-
#list_loader_jobs(params = {}) ⇒ Types::ListLoaderJobsOutput
Retrieves a list of the
loadIds
for all active loader jobs. -
#list_ml_data_processing_jobs(params = {}) ⇒ Types::ListMLDataProcessingJobsOutput
Returns a list of Neptune ML data processing jobs.
-
#list_ml_endpoints(params = {}) ⇒ Types::ListMLEndpointsOutput
Lists existing inference endpoints.
-
#list_ml_model_training_jobs(params = {}) ⇒ Types::ListMLModelTrainingJobsOutput
Lists Neptune ML model-training jobs.
-
#list_ml_model_transform_jobs(params = {}) ⇒ Types::ListMLModelTransformJobsOutput
Returns a list of model transform job IDs.
-
#list_open_cypher_queries(params = {}) ⇒ Types::ListOpenCypherQueriesOutput
Lists active openCypher queries.
-
#manage_propertygraph_statistics(params = {}) ⇒ Types::ManagePropertygraphStatisticsOutput
Manages the generation and use of property graph statistics.
-
#manage_sparql_statistics(params = {}) ⇒ Types::ManageSparqlStatisticsOutput
Manages the generation and use of RDF graph statistics.
-
#start_loader_job(params = {}) ⇒ Types::StartLoaderJobOutput
Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance.
-
#start_ml_data_processing_job(params = {}) ⇒ Types::StartMLDataProcessingJobOutput
Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training.
-
#start_ml_model_training_job(params = {}) ⇒ Types::StartMLModelTrainingJobOutput
Creates a new Neptune ML model training job.
-
#start_ml_model_transform_job(params = {}) ⇒ Types::StartMLModelTransformJobOutput
Creates a new model transform job.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
409 410 411 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#cancel_gremlin_query(params = {}) ⇒ Types::CancelGremlinQueryOutput
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.
449 450 451 452 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 449 def cancel_gremlin_query(params = {}, = {}) req = build_request(:cancel_gremlin_query, params) req.send_request() end |
#cancel_loader_job(params = {}) ⇒ Types::CancelLoaderJobOutput
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..
488 489 490 491 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 488 def cancel_loader_job(params = {}, = {}) req = build_request(:cancel_loader_job, params) req.send_request() end |
#cancel_ml_data_processing_job(params = {}) ⇒ Types::CancelMLDataProcessingJobOutput
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.
538 539 540 541 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 538 def cancel_ml_data_processing_job(params = {}, = {}) req = build_request(:cancel_ml_data_processing_job, params) req.send_request() end |
#cancel_ml_model_training_job(params = {}) ⇒ Types::CancelMLModelTrainingJobOutput
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.
588 589 590 591 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 588 def cancel_ml_model_training_job(params = {}, = {}) req = build_request(:cancel_ml_model_training_job, params) req.send_request() end |
#cancel_ml_model_transform_job(params = {}) ⇒ Types::CancelMLModelTransformJobOutput
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.
638 639 640 641 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 638 def cancel_ml_model_transform_job(params = {}, = {}) req = build_request(:cancel_ml_model_transform_job, params) req.send_request() end |
#cancel_open_cypher_query(params = {}) ⇒ Types::CancelOpenCypherQueryOutput
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.
684 685 686 687 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 684 def cancel_open_cypher_query(params = {}, = {}) req = build_request(:cancel_open_cypher_query, params) req.send_request() end |
#create_ml_endpoint(params = {}) ⇒ Types::CreateMLEndpointOutput
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.
778 779 780 781 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 778 def create_ml_endpoint(params = {}, = {}) req = build_request(:create_ml_endpoint, params) req.send_request() end |
#delete_ml_endpoint(params = {}) ⇒ Types::DeleteMLEndpointOutput
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.
828 829 830 831 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 828 def delete_ml_endpoint(params = {}, = {}) req = build_request(:delete_ml_endpoint, params) req.send_request() end |
#delete_propertygraph_statistics(params = {}) ⇒ Types::DeletePropertygraphStatisticsOutput
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.
861 862 863 864 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 861 def delete_propertygraph_statistics(params = {}, = {}) req = build_request(:delete_propertygraph_statistics, params) req.send_request() end |
#delete_sparql_statistics(params = {}) ⇒ Types::DeleteSparqlStatisticsOutput
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.
894 895 896 897 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 894 def delete_sparql_statistics(params = {}, = {}) req = build_request(:delete_sparql_statistics, params) req.send_request() end |
#execute_fast_reset(params = {}) ⇒ Types::ExecuteFastResetOutput
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.
952 953 954 955 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 952 def execute_fast_reset(params = {}, = {}) req = build_request(:execute_fast_reset, params) req.send_request() end |
#execute_gremlin_explain_query(params = {}) ⇒ Types::ExecuteGremlinExplainQueryOutput
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).
1017 1018 1019 1020 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1017 def execute_gremlin_explain_query(params = {}, = {}) req = build_request(:execute_gremlin_explain_query, params) req.send_request() end |
#execute_gremlin_profile_query(params = {}) ⇒ Types::ExecuteGremlinProfileQueryOutput
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).
1091 1092 1093 1094 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1091 def execute_gremlin_profile_query(params = {}, = {}) req = build_request(:execute_gremlin_profile_query, params) req.send_request() end |
#execute_gremlin_query(params = {}) ⇒ Types::ExecuteGremlinQueryOutput
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:
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).
1173 1174 1175 1176 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1173 def execute_gremlin_query(params = {}, = {}) req = build_request(:execute_gremlin_query, params) req.send_request() end |
#execute_open_cypher_explain_query(params = {}) ⇒ Types::ExecuteOpenCypherExplainQueryOutput
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).
1228 1229 1230 1231 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1228 def execute_open_cypher_explain_query(params = {}, = {}) req = build_request(:execute_open_cypher_explain_query, params) req.send_request() end |
#execute_open_cypher_query(params = {}) ⇒ Types::ExecuteOpenCypherQueryOutput
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:
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).
1302 1303 1304 1305 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1302 def execute_open_cypher_query(params = {}, = {}) req = build_request(:execute_open_cypher_query, params) req.send_request() end |
#get_engine_status(params = {}) ⇒ Types::GetEngineStatusOutput
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.
1356 1357 1358 1359 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1356 def get_engine_status(params = {}, = {}) req = build_request(:get_engine_status, params) req.send_request() end |
#get_gremlin_query_status(params = {}) ⇒ Types::GetGremlinQueryStatusOutput
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).
1406 1407 1408 1409 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1406 def get_gremlin_query_status(params = {}, = {}) req = build_request(:get_gremlin_query_status, params) req.send_request() end |
#get_loader_job_status(params = {}) ⇒ Types::GetLoaderJobStatusOutput
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..
1473 1474 1475 1476 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1473 def get_loader_job_status(params = {}, = {}) req = build_request(:get_loader_job_status, params) req.send_request() end |
#get_ml_data_processing_job(params = {}) ⇒ Types::GetMLDataProcessingJobOutput
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.
1528 1529 1530 1531 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1528 def get_ml_data_processing_job(params = {}, = {}) req = build_request(:get_ml_data_processing_job, params) req.send_request() end |
#get_ml_endpoint(params = {}) ⇒ Types::GetMLEndpointOutput
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.
1585 1586 1587 1588 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1585 def get_ml_endpoint(params = {}, = {}) req = build_request(:get_ml_endpoint, params) req.send_request() end |
#get_ml_model_training_job(params = {}) ⇒ Types::GetMLModelTrainingJobOutput
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.
1658 1659 1660 1661 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1658 def get_ml_model_training_job(params = {}, = {}) req = build_request(:get_ml_model_training_job, params) req.send_request() end |
#get_ml_model_transform_job(params = {}) ⇒ Types::GetMLModelTransformJobOutput
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.
1724 1725 1726 1727 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1724 def get_ml_model_transform_job(params = {}, = {}) req = build_request(:get_ml_model_transform_job, params) req.send_request() end |
#get_open_cypher_query_status(params = {}) ⇒ Types::GetOpenCypherQueryStatusOutput
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).
1775 1776 1777 1778 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1775 def get_open_cypher_query_status(params = {}, = {}) req = build_request(:get_open_cypher_query_status, params) req.send_request() end |
#get_propertygraph_statistics(params = {}) ⇒ Types::GetPropertygraphStatisticsOutput
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.
1812 1813 1814 1815 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1812 def get_propertygraph_statistics(params = {}, = {}) req = build_request(:get_propertygraph_statistics, params) req.send_request() end |
#get_propertygraph_stream(params = {}) ⇒ Types::GetPropertygraphStreamOutput
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:
See Condition keys available in Neptune IAM data-access policy statements).
1940 1941 1942 1943 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 1940 def get_propertygraph_stream(params = {}, = {}) req = build_request(:get_propertygraph_stream, params) req.send_request() end |
#get_propertygraph_summary(params = {}) ⇒ Types::GetPropertygraphSummaryOutput
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.
2009 2010 2011 2012 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2009 def get_propertygraph_summary(params = {}, = {}) req = build_request(:get_propertygraph_summary, params) req.send_request() end |
#get_rdf_graph_summary(params = {}) ⇒ Types::GetRDFGraphSummaryOutput
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.
2063 2064 2065 2066 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2063 def get_rdf_graph_summary(params = {}, = {}) req = build_request(:get_rdf_graph_summary, params) req.send_request() end |
#get_sparql_statistics(params = {}) ⇒ Types::GetSparqlStatisticsOutput
Gets RDF statistics (SPARQL).
2091 2092 2093 2094 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2091 def get_sparql_statistics(params = {}, = {}) req = build_request(:get_sparql_statistics, params) req.send_request() end |
#get_sparql_stream(params = {}) ⇒ Types::GetSparqlStreamOutput
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).
2205 2206 2207 2208 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2205 def get_sparql_stream(params = {}, = {}) req = build_request(:get_sparql_stream, params) req.send_request() end |
#list_gremlin_queries(params = {}) ⇒ Types::ListGremlinQueriesOutput
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).
2261 2262 2263 2264 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2261 def list_gremlin_queries(params = {}, = {}) req = build_request(:list_gremlin_queries, params) req.send_request() end |
#list_loader_jobs(params = {}) ⇒ Types::ListLoaderJobsOutput
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..
2308 2309 2310 2311 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2308 def list_loader_jobs(params = {}, = {}) req = build_request(:list_loader_jobs, params) req.send_request() end |
#list_ml_data_processing_jobs(params = {}) ⇒ Types::ListMLDataProcessingJobsOutput
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.
2355 2356 2357 2358 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2355 def list_ml_data_processing_jobs(params = {}, = {}) req = build_request(:list_ml_data_processing_jobs, params) req.send_request() end |
#list_ml_endpoints(params = {}) ⇒ Types::ListMLEndpointsOutput
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.
2402 2403 2404 2405 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2402 def list_ml_endpoints(params = {}, = {}) req = build_request(:list_ml_endpoints, params) req.send_request() end |
#list_ml_model_training_jobs(params = {}) ⇒ Types::ListMLModelTrainingJobsOutput
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.
2450 2451 2452 2453 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2450 def list_ml_model_training_jobs(params = {}, = {}) req = build_request(:list_ml_model_training_jobs, params) req.send_request() end |
#list_ml_model_transform_jobs(params = {}) ⇒ Types::ListMLModelTransformJobsOutput
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.
2497 2498 2499 2500 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2497 def list_ml_model_transform_jobs(params = {}, = {}) req = build_request(:list_ml_model_transform_jobs, params) req.send_request() end |
#list_open_cypher_queries(params = {}) ⇒ Types::ListOpenCypherQueriesOutput
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).
2554 2555 2556 2557 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2554 def list_open_cypher_queries(params = {}, = {}) req = build_request(:list_open_cypher_queries, params) req.send_request() end |
#manage_propertygraph_statistics(params = {}) ⇒ Types::ManagePropertygraphStatisticsOutput
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.
2595 2596 2597 2598 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2595 def manage_propertygraph_statistics(params = {}, = {}) req = build_request(:manage_propertygraph_statistics, params) req.send_request() end |
#manage_sparql_statistics(params = {}) ⇒ Types::ManageSparqlStatisticsOutput
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.
2636 2637 2638 2639 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2636 def manage_sparql_statistics(params = {}, = {}) req = build_request(:manage_sparql_statistics, params) req.send_request() end |
#start_loader_job(params = {}) ⇒ Types::StartLoaderJobOutput
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.
2955 2956 2957 2958 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 2955 def start_loader_job(params = {}, = {}) req = build_request(:start_loader_job, params) req.send_request() end |
#start_ml_data_processing_job(params = {}) ⇒ Types::StartMLDataProcessingJobOutput
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.
3080 3081 3082 3083 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 3080 def start_ml_data_processing_job(params = {}, = {}) req = build_request(:start_ml_data_processing_job, params) req.send_request() end |
#start_ml_model_training_job(params = {}) ⇒ Types::StartMLModelTrainingJobOutput
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.
3223 3224 3225 3226 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 3223 def start_ml_model_training_job(params = {}, = {}) req = build_request(:start_ml_model_training_job, params) req.send_request() end |
#start_ml_model_transform_job(params = {}) ⇒ Types::StartMLModelTransformJobOutput
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.
3343 3344 3345 3346 |
# File 'gems/aws-sdk-neptunedata/lib/aws-sdk-neptunedata/client.rb', line 3343 def start_ml_model_transform_job(params = {}, = {}) req = build_request(:start_ml_model_transform_job, params) req.send_request() end |