NeptunedataClient

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.

Properties

Link copied to clipboard
abstract override val config: NeptunedataClient.Config

NeptunedataClient's configuration

Functions

Link copied to clipboard

Cancels a Gremlin query. See Gremlin query cancellation for more information.

Link copied to clipboard

Cancels a specified load job. This is an HTTP DELETE request. See Neptune Loader Get-Status API for more information.

Link copied to clipboard

Cancels a Neptune ML data processing job. See dataprocessing command.

Link copied to clipboard

Cancels a Neptune ML model training job. See modeltraining command.

Link copied to clipboard

Cancels a specified openCypher query. See Neptune openCypher status endpoint for more information.

Link copied to clipboard
abstract suspend fun createMlEndpoint(input: CreateMlEndpointRequest = CreateMlEndpointRequest { }): CreateMlEndpointResponse

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.

Link copied to clipboard

Cancels the creation of a Neptune ML inference endpoint. See Managing inference endpoints using the endpoints command.

Link copied to clipboard
abstract suspend fun deletePropertygraphStatistics(input: DeletePropertygraphStatisticsRequest = DeletePropertygraphStatisticsRequest { }): DeletePropertygraphStatisticsResponse

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

Link copied to clipboard
abstract suspend fun deleteSparqlStatistics(input: DeleteSparqlStatisticsRequest = DeleteSparqlStatisticsRequest { }): DeleteSparqlStatisticsResponse

Deletes SPARQL statistics

Link copied to clipboard

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

Link copied to clipboard

Executes a Gremlin Explain query.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Executes an openCypher explain request. See The openCypher explain feature for more information.

Link copied to clipboard

Executes an openCypher query. See Accessing the Neptune Graph with openCypher for more information.

Link copied to clipboard
abstract suspend fun getEngineStatus(input: GetEngineStatusRequest = GetEngineStatusRequest { }): GetEngineStatusResponse

Retrieves the status of the graph database on the host.

Link copied to clipboard

Gets the status of a specified Gremlin query.

Link copied to clipboard

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.

Link copied to clipboard

Retrieves information about a specified data processing job. See dataprocessing command.

Link copied to clipboard

Retrieves details about an inference endpoint. See Managing inference endpoints using the endpoints command.

Link copied to clipboard

Retrieves information about a Neptune ML model training job. See modeltraining command.

Link copied to clipboard

Gets information about a specified model transform job. See Use a trained model to generate new model artifacts.

Link copied to clipboard

Retrieves the status of a specified openCypher query.

Link copied to clipboard
abstract suspend fun getPropertygraphStatistics(input: GetPropertygraphStatisticsRequest = GetPropertygraphStatisticsRequest { }): GetPropertygraphStatisticsResponse

Gets property graph statistics (Gremlin and openCypher).

Link copied to clipboard
abstract suspend fun getPropertygraphStream(input: GetPropertygraphStreamRequest = GetPropertygraphStreamRequest { }): GetPropertygraphStreamResponse

Gets a stream for a property graph.

Link copied to clipboard
abstract suspend fun getPropertygraphSummary(input: GetPropertygraphSummaryRequest = GetPropertygraphSummaryRequest { }): GetPropertygraphSummaryResponse

Gets a graph summary for a property graph.

Link copied to clipboard
abstract suspend fun getRdfGraphSummary(input: GetRdfGraphSummaryRequest = GetRdfGraphSummaryRequest { }): GetRdfGraphSummaryResponse

Gets a graph summary for an RDF graph.

Link copied to clipboard
abstract suspend fun getSparqlStatistics(input: GetSparqlStatisticsRequest = GetSparqlStatisticsRequest { }): GetSparqlStatisticsResponse

Gets RDF statistics (SPARQL).

Link copied to clipboard
abstract suspend fun getSparqlStream(input: GetSparqlStreamRequest = GetSparqlStreamRequest { }): GetSparqlStreamResponse

Gets a stream for an RDF graph.

Link copied to clipboard
abstract suspend fun listGremlinQueries(input: ListGremlinQueriesRequest = ListGremlinQueriesRequest { }): ListGremlinQueriesResponse

Lists active Gremlin queries. See Gremlin query status API for details about the output.

Link copied to clipboard
abstract suspend fun listLoaderJobs(input: ListLoaderJobsRequest = ListLoaderJobsRequest { }): ListLoaderJobsResponse

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

Link copied to clipboard
abstract suspend fun listMlDataProcessingJobs(input: ListMlDataProcessingJobsRequest = ListMlDataProcessingJobsRequest { }): ListMlDataProcessingJobsResponse

Returns a list of Neptune ML data processing jobs. See Listing active data-processing jobs using the Neptune ML dataprocessing command.

Link copied to clipboard
abstract suspend fun listMlEndpoints(input: ListMlEndpointsRequest = ListMlEndpointsRequest { }): ListMlEndpointsResponse

Lists existing inference endpoints. See Managing inference endpoints using the endpoints command.

Link copied to clipboard
abstract suspend fun listMlModelTrainingJobs(input: ListMlModelTrainingJobsRequest = ListMlModelTrainingJobsRequest { }): ListMlModelTrainingJobsResponse

Lists Neptune ML model-training jobs. See modeltraining command.

Link copied to clipboard
abstract suspend fun listMlModelTransformJobs(input: ListMlModelTransformJobsRequest = ListMlModelTransformJobsRequest { }): ListMlModelTransformJobsResponse

Returns a list of model transform job IDs. See Use a trained model to generate new model artifacts.

Link copied to clipboard
abstract suspend fun listOpenCypherQueries(input: ListOpenCypherQueriesRequest = ListOpenCypherQueriesRequest { }): ListOpenCypherQueriesResponse

Lists active openCypher queries. See Neptune openCypher status endpoint for more information.

Link copied to clipboard
abstract suspend fun managePropertygraphStatistics(input: ManagePropertygraphStatisticsRequest = ManagePropertygraphStatisticsRequest { }): ManagePropertygraphStatisticsResponse

Manages the generation and use of property graph statistics.

Link copied to clipboard
abstract suspend fun manageSparqlStatistics(input: ManageSparqlStatisticsRequest = ManageSparqlStatisticsRequest { }): ManageSparqlStatisticsResponse

Manages the generation and use of RDF graph statistics.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Creates a new Neptune ML model training job. See modeltraining command.

Inherited functions

Link copied to clipboard

Cancels a Gremlin query. See Gremlin query cancellation for more information.

Link copied to clipboard

Cancels a specified load job. This is an HTTP DELETE request. See Neptune Loader Get-Status API for more information.

Link copied to clipboard

Cancels a Neptune ML data processing job. See dataprocessing command.

Link copied to clipboard

Cancels a Neptune ML model training job. See modeltraining command.

Link copied to clipboard

Cancels a specified openCypher query. See Neptune openCypher status endpoint for more information.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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.

Link copied to clipboard

Cancels the creation of a Neptune ML inference endpoint. See Managing inference endpoints using the endpoints command.

Link copied to clipboard

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

Link copied to clipboard

Deletes SPARQL statistics

Link copied to clipboard

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

Link copied to clipboard

Executes a Gremlin Explain query.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Executes an openCypher explain request. See The openCypher explain feature for more information.

Link copied to clipboard

Executes an openCypher query. See Accessing the Neptune Graph with openCypher for more information.

Link copied to clipboard

Retrieves the status of the graph database on the host.

Link copied to clipboard

Gets the status of a specified Gremlin query.

Link copied to clipboard

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.

Link copied to clipboard

Retrieves information about a specified data processing job. See dataprocessing command.

Link copied to clipboard

Retrieves details about an inference endpoint. See Managing inference endpoints using the endpoints command.

Link copied to clipboard

Retrieves information about a Neptune ML model training job. See modeltraining command.

Link copied to clipboard

Gets information about a specified model transform job. See Use a trained model to generate new model artifacts.

Link copied to clipboard

Retrieves the status of a specified openCypher query.

Link copied to clipboard

Gets property graph statistics (Gremlin and openCypher).

Link copied to clipboard

Gets a stream for a property graph.

Link copied to clipboard

Gets a graph summary for a property graph.

Link copied to clipboard

Gets a graph summary for an RDF graph.

Link copied to clipboard

Gets RDF statistics (SPARQL).

Link copied to clipboard

Gets a stream for an RDF graph.

Link copied to clipboard

Lists active Gremlin queries. See Gremlin query status API for details about the output.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Lists Neptune ML model-training jobs. See modeltraining command.

Link copied to clipboard

Lists active openCypher queries. See Neptune openCypher status endpoint for more information.

Link copied to clipboard

Manages the generation and use of property graph statistics.

Link copied to clipboard

Manages the generation and use of RDF graph statistics.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Creates a new Neptune ML model training job. See modeltraining command.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.