@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonNeptunedata extends Object implements AmazonNeptunedata
AmazonNeptunedata. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic CancelGremlinQueryResult cancelGremlinQuery(CancelGremlinQueryRequest request)
AmazonNeptunedataCancels 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.
cancelGremlinQuery in interface AmazonNeptunedatapublic CancelLoaderJobResult cancelLoaderJob(CancelLoaderJobRequest request)
AmazonNeptunedata
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..
cancelLoaderJob in interface AmazonNeptunedatapublic CancelMLDataProcessingJobResult cancelMLDataProcessingJob(CancelMLDataProcessingJobRequest request)
AmazonNeptunedata
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.
cancelMLDataProcessingJob in interface AmazonNeptunedatapublic CancelMLModelTrainingJobResult cancelMLModelTrainingJob(CancelMLModelTrainingJobRequest request)
AmazonNeptunedata
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.
cancelMLModelTrainingJob in interface AmazonNeptunedatapublic CancelMLModelTransformJobResult cancelMLModelTransformJob(CancelMLModelTransformJobRequest request)
AmazonNeptunedataCancels 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.
cancelMLModelTransformJob in interface AmazonNeptunedatapublic CancelOpenCypherQueryResult cancelOpenCypherQuery(CancelOpenCypherQueryRequest request)
AmazonNeptunedataCancels 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.
cancelOpenCypherQuery in interface AmazonNeptunedatapublic CreateMLEndpointResult createMLEndpoint(CreateMLEndpointRequest request)
AmazonNeptunedataCreates 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.
createMLEndpoint in interface AmazonNeptunedatapublic DeleteMLEndpointResult deleteMLEndpoint(DeleteMLEndpointRequest request)
AmazonNeptunedataCancels 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.
deleteMLEndpoint in interface AmazonNeptunedatapublic DeletePropertygraphStatisticsResult deletePropertygraphStatistics(DeletePropertygraphStatisticsRequest request)
AmazonNeptunedataDeletes 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.
deletePropertygraphStatistics in interface AmazonNeptunedatapublic DeleteSparqlStatisticsResult deleteSparqlStatistics(DeleteSparqlStatisticsRequest request)
AmazonNeptunedataDeletes 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.
deleteSparqlStatistics in interface AmazonNeptunedatapublic ExecuteFastResetResult executeFastReset(ExecuteFastResetRequest request)
AmazonNeptunedataThe 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.
executeFastReset in interface AmazonNeptunedatapublic ExecuteGremlinExplainQueryResult executeGremlinExplainQuery(ExecuteGremlinExplainQueryRequest request)
AmazonNeptunedataExecutes 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).
executeGremlinExplainQuery in interface AmazonNeptunedatapublic ExecuteGremlinProfileQueryResult executeGremlinProfileQuery(ExecuteGremlinProfileQueryRequest request)
AmazonNeptunedataExecutes 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).
executeGremlinProfileQuery in interface AmazonNeptunedatapublic ExecuteGremlinQueryResult executeGremlinQuery(ExecuteGremlinQueryRequest request)
AmazonNeptunedataThis 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).
executeGremlinQuery in interface AmazonNeptunedatapublic ExecuteOpenCypherExplainQueryResult executeOpenCypherExplainQuery(ExecuteOpenCypherExplainQueryRequest request)
AmazonNeptunedata
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).
executeOpenCypherExplainQuery in interface AmazonNeptunedatapublic GetEngineStatusResult getEngineStatus(GetEngineStatusRequest request)
AmazonNeptunedataRetrieves 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.
getEngineStatus in interface AmazonNeptunedatapublic GetGremlinQueryStatusResult getGremlinQueryStatus(GetGremlinQueryStatusRequest request)
AmazonNeptunedataGets 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).
getGremlinQueryStatus in interface AmazonNeptunedatapublic GetMLDataProcessingJobResult getMLDataProcessingJob(GetMLDataProcessingJobRequest request)
AmazonNeptunedata
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.
getMLDataProcessingJob in interface AmazonNeptunedatapublic GetMLEndpointResult getMLEndpoint(GetMLEndpointRequest request)
AmazonNeptunedataRetrieves 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.
getMLEndpoint in interface AmazonNeptunedatapublic GetMLModelTrainingJobResult getMLModelTrainingJob(GetMLModelTrainingJobRequest request)
AmazonNeptunedata
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.
getMLModelTrainingJob in interface AmazonNeptunedatapublic GetMLModelTransformJobResult getMLModelTransformJob(GetMLModelTransformJobRequest request)
AmazonNeptunedataGets 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.
getMLModelTransformJob in interface AmazonNeptunedatapublic GetOpenCypherQueryStatusResult getOpenCypherQueryStatus(GetOpenCypherQueryStatusRequest request)
AmazonNeptunedataRetrieves 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).
getOpenCypherQueryStatus in interface AmazonNeptunedatapublic GetPropertygraphStatisticsResult getPropertygraphStatistics(GetPropertygraphStatisticsRequest request)
AmazonNeptunedataGets 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.
getPropertygraphStatistics in interface AmazonNeptunedatapublic GetPropertygraphSummaryResult getPropertygraphSummary(GetPropertygraphSummaryRequest request)
AmazonNeptunedataGets 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.
getPropertygraphSummary in interface AmazonNeptunedatapublic GetRDFGraphSummaryResult getRDFGraphSummary(GetRDFGraphSummaryRequest request)
AmazonNeptunedataGets 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.
getRDFGraphSummary in interface AmazonNeptunedatapublic GetSparqlStatisticsResult getSparqlStatistics(GetSparqlStatisticsRequest request)
AmazonNeptunedataGets RDF statistics (SPARQL).
getSparqlStatistics in interface AmazonNeptunedatapublic GetSparqlStreamResult getSparqlStream(GetSparqlStreamRequest request)
AmazonNeptunedataGets 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).
getSparqlStream in interface AmazonNeptunedatapublic ListGremlinQueriesResult listGremlinQueries(ListGremlinQueriesRequest request)
AmazonNeptunedataLists 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).
listGremlinQueries in interface AmazonNeptunedatapublic ListLoaderJobsResult listLoaderJobs(ListLoaderJobsRequest request)
AmazonNeptunedata
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..
listLoaderJobs in interface AmazonNeptunedatapublic ListMLDataProcessingJobsResult listMLDataProcessingJobs(ListMLDataProcessingJobsRequest request)
AmazonNeptunedataReturns 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.
listMLDataProcessingJobs in interface AmazonNeptunedatapublic ListMLEndpointsResult listMLEndpoints(ListMLEndpointsRequest request)
AmazonNeptunedataLists 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.
listMLEndpoints in interface AmazonNeptunedatapublic ListMLModelTrainingJobsResult listMLModelTrainingJobs(ListMLModelTrainingJobsRequest request)
AmazonNeptunedata
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.
listMLModelTrainingJobs in interface AmazonNeptunedatapublic ListMLModelTransformJobsResult listMLModelTransformJobs(ListMLModelTransformJobsRequest request)
AmazonNeptunedataReturns 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.
listMLModelTransformJobs in interface AmazonNeptunedatapublic ListOpenCypherQueriesResult listOpenCypherQueries(ListOpenCypherQueriesRequest request)
AmazonNeptunedataLists 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).
listOpenCypherQueries in interface AmazonNeptunedatapublic ManagePropertygraphStatisticsResult managePropertygraphStatistics(ManagePropertygraphStatisticsRequest request)
AmazonNeptunedataManages 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.
managePropertygraphStatistics in interface AmazonNeptunedatapublic ManageSparqlStatisticsResult manageSparqlStatistics(ManageSparqlStatisticsRequest request)
AmazonNeptunedataManages 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.
manageSparqlStatistics in interface AmazonNeptunedatapublic StartLoaderJobResult startLoaderJob(StartLoaderJobRequest request)
AmazonNeptunedataStarts 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.
startLoaderJob in interface AmazonNeptunedatapublic StartMLDataProcessingJobResult startMLDataProcessingJob(StartMLDataProcessingJobRequest request)
AmazonNeptunedata
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.
startMLDataProcessingJob in interface AmazonNeptunedatapublic StartMLModelTrainingJobResult startMLModelTrainingJob(StartMLModelTrainingJobRequest request)
AmazonNeptunedata
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.
startMLModelTrainingJob in interface AmazonNeptunedatapublic StartMLModelTransformJobResult startMLModelTransformJob(StartMLModelTransformJobRequest request)
AmazonNeptunedataCreates 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.
startMLModelTransformJob in interface AmazonNeptunedatapublic void shutdown()
AmazonNeptunedatashutdown in interface AmazonNeptunedatapublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonNeptunedataResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonNeptunedatarequest - The originally executed request.