@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface NeptunedataAsyncClient extends AwsClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CancelGremlinQueryResponse> cancelGremlinQuery(CancelGremlinQueryRequest cancelGremlinQueryRequest)
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.
cancelGremlinQueryRequest - default CompletableFuture<CancelGremlinQueryResponse> cancelGremlinQuery(Consumer<CancelGremlinQueryRequest.Builder> cancelGremlinQueryRequest)
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.
This is a convenience which creates an instance of the CancelGremlinQueryRequest.Builder avoiding the
need to create one manually via CancelGremlinQueryRequest.builder()
cancelGremlinQueryRequest - A Consumer that will call methods on
CancelGremlinQueryRequest.Builder to create a
request.default CompletableFuture<CancelLoaderJobResponse> cancelLoaderJob(CancelLoaderJobRequest cancelLoaderJobRequest)
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..
cancelLoaderJobRequest - default CompletableFuture<CancelLoaderJobResponse> cancelLoaderJob(Consumer<CancelLoaderJobRequest.Builder> cancelLoaderJobRequest)
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..
This is a convenience which creates an instance of the CancelLoaderJobRequest.Builder avoiding the need
to create one manually via CancelLoaderJobRequest.builder()
cancelLoaderJobRequest - A Consumer that will call methods on
CancelLoaderJobRequest.Builder to create a
request.default CompletableFuture<CancelMlDataProcessingJobResponse> cancelMLDataProcessingJob(CancelMlDataProcessingJobRequest cancelMlDataProcessingJobRequest)
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.
cancelMlDataProcessingJobRequest - default CompletableFuture<CancelMlDataProcessingJobResponse> cancelMLDataProcessingJob(Consumer<CancelMlDataProcessingJobRequest.Builder> cancelMlDataProcessingJobRequest)
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.
This is a convenience which creates an instance of the CancelMlDataProcessingJobRequest.Builder avoiding
the need to create one manually via CancelMlDataProcessingJobRequest.builder()
cancelMlDataProcessingJobRequest - A Consumer that will call methods on
CancelMlDataProcessingJobRequest.Builder to
create a request.default CompletableFuture<CancelMlModelTrainingJobResponse> cancelMLModelTrainingJob(CancelMlModelTrainingJobRequest cancelMlModelTrainingJobRequest)
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.
cancelMlModelTrainingJobRequest - default CompletableFuture<CancelMlModelTrainingJobResponse> cancelMLModelTrainingJob(Consumer<CancelMlModelTrainingJobRequest.Builder> cancelMlModelTrainingJobRequest)
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.
This is a convenience which creates an instance of the CancelMlModelTrainingJobRequest.Builder avoiding
the need to create one manually via CancelMlModelTrainingJobRequest.builder()
cancelMlModelTrainingJobRequest - A Consumer that will call methods on
CancelMlModelTrainingJobRequest.Builder to
create a request.default CompletableFuture<CancelMlModelTransformJobResponse> cancelMLModelTransformJob(CancelMlModelTransformJobRequest cancelMlModelTransformJobRequest)
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.
cancelMlModelTransformJobRequest - default CompletableFuture<CancelMlModelTransformJobResponse> cancelMLModelTransformJob(Consumer<CancelMlModelTransformJobRequest.Builder> cancelMlModelTransformJobRequest)
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.
This is a convenience which creates an instance of the CancelMlModelTransformJobRequest.Builder avoiding
the need to create one manually via CancelMlModelTransformJobRequest.builder()
cancelMlModelTransformJobRequest - A Consumer that will call methods on
CancelMlModelTransformJobRequest.Builder to
create a request.default CompletableFuture<CancelOpenCypherQueryResponse> cancelOpenCypherQuery(CancelOpenCypherQueryRequest cancelOpenCypherQueryRequest)
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.
cancelOpenCypherQueryRequest - default CompletableFuture<CancelOpenCypherQueryResponse> cancelOpenCypherQuery(Consumer<CancelOpenCypherQueryRequest.Builder> cancelOpenCypherQueryRequest)
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.
This is a convenience which creates an instance of the CancelOpenCypherQueryRequest.Builder avoiding the
need to create one manually via CancelOpenCypherQueryRequest.builder()
cancelOpenCypherQueryRequest - A Consumer that will call methods on
CancelOpenCypherQueryRequest.Builder to create a
request.default CompletableFuture<CreateMlEndpointResponse> createMLEndpoint(CreateMlEndpointRequest createMlEndpointRequest)
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.
createMlEndpointRequest - default CompletableFuture<CreateMlEndpointResponse> createMLEndpoint(Consumer<CreateMlEndpointRequest.Builder> createMlEndpointRequest)
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.
This is a convenience which creates an instance of the CreateMlEndpointRequest.Builder avoiding the need
to create one manually via CreateMlEndpointRequest.builder()
createMlEndpointRequest - A Consumer that will call methods on
CreateMlEndpointRequest.Builder to create a
request.default CompletableFuture<DeleteMlEndpointResponse> deleteMLEndpoint(DeleteMlEndpointRequest deleteMlEndpointRequest)
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.
deleteMlEndpointRequest - default CompletableFuture<DeleteMlEndpointResponse> deleteMLEndpoint(Consumer<DeleteMlEndpointRequest.Builder> deleteMlEndpointRequest)
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.
This is a convenience which creates an instance of the DeleteMlEndpointRequest.Builder avoiding the need
to create one manually via DeleteMlEndpointRequest.builder()
deleteMlEndpointRequest - A Consumer that will call methods on
DeleteMlEndpointRequest.Builder to create a
request.default CompletableFuture<DeletePropertygraphStatisticsResponse> deletePropertygraphStatistics(DeletePropertygraphStatisticsRequest deletePropertygraphStatisticsRequest)
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.
deletePropertygraphStatisticsRequest - default CompletableFuture<DeletePropertygraphStatisticsResponse> deletePropertygraphStatistics(Consumer<DeletePropertygraphStatisticsRequest.Builder> deletePropertygraphStatisticsRequest)
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.
This is a convenience which creates an instance of the DeletePropertygraphStatisticsRequest.Builder
avoiding the need to create one manually via DeletePropertygraphStatisticsRequest.builder()
deletePropertygraphStatisticsRequest - A Consumer that will call methods on
DeletePropertygraphStatisticsRequest.Builder to
create a request.default CompletableFuture<DeleteSparqlStatisticsResponse> deleteSparqlStatistics(DeleteSparqlStatisticsRequest deleteSparqlStatisticsRequest)
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.
deleteSparqlStatisticsRequest - default CompletableFuture<DeleteSparqlStatisticsResponse> deleteSparqlStatistics(Consumer<DeleteSparqlStatisticsRequest.Builder> deleteSparqlStatisticsRequest)
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.
This is a convenience which creates an instance of the DeleteSparqlStatisticsRequest.Builder avoiding the
need to create one manually via DeleteSparqlStatisticsRequest.builder()
deleteSparqlStatisticsRequest - A Consumer that will call methods on
DeleteSparqlStatisticsRequest.Builder to create
a request.default CompletableFuture<ExecuteFastResetResponse> executeFastReset(ExecuteFastResetRequest executeFastResetRequest)
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.
executeFastResetRequest - default CompletableFuture<ExecuteFastResetResponse> executeFastReset(Consumer<ExecuteFastResetRequest.Builder> executeFastResetRequest)
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.
This is a convenience which creates an instance of the ExecuteFastResetRequest.Builder avoiding the need
to create one manually via ExecuteFastResetRequest.builder()
executeFastResetRequest - A Consumer that will call methods on
ExecuteFastResetRequest.Builder to create a
request.default CompletableFuture<ExecuteGremlinExplainQueryResponse> executeGremlinExplainQuery(ExecuteGremlinExplainQueryRequest executeGremlinExplainQueryRequest)
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).
executeGremlinExplainQueryRequest - default CompletableFuture<ExecuteGremlinExplainQueryResponse> executeGremlinExplainQuery(Consumer<ExecuteGremlinExplainQueryRequest.Builder> executeGremlinExplainQueryRequest)
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).
This is a convenience which creates an instance of the ExecuteGremlinExplainQueryRequest.Builder avoiding
the need to create one manually via ExecuteGremlinExplainQueryRequest.builder()
executeGremlinExplainQueryRequest - A Consumer that will call methods on
ExecuteGremlinExplainQueryRequest.Builder to
create a request.default CompletableFuture<ExecuteGremlinProfileQueryResponse> executeGremlinProfileQuery(ExecuteGremlinProfileQueryRequest executeGremlinProfileQueryRequest)
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).
executeGremlinProfileQueryRequest - default CompletableFuture<ExecuteGremlinProfileQueryResponse> executeGremlinProfileQuery(Consumer<ExecuteGremlinProfileQueryRequest.Builder> executeGremlinProfileQueryRequest)
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).
This is a convenience which creates an instance of the ExecuteGremlinProfileQueryRequest.Builder avoiding
the need to create one manually via ExecuteGremlinProfileQueryRequest.builder()
executeGremlinProfileQueryRequest - A Consumer that will call methods on
ExecuteGremlinProfileQueryRequest.Builder to
create a request.default CompletableFuture<ExecuteGremlinQueryResponse> executeGremlinQuery(ExecuteGremlinQueryRequest executeGremlinQueryRequest)
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).
executeGremlinQueryRequest - default CompletableFuture<ExecuteGremlinQueryResponse> executeGremlinQuery(Consumer<ExecuteGremlinQueryRequest.Builder> executeGremlinQueryRequest)
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).
This is a convenience which creates an instance of the ExecuteGremlinQueryRequest.Builder avoiding the
need to create one manually via ExecuteGremlinQueryRequest.builder()
executeGremlinQueryRequest - A Consumer that will call methods on
ExecuteGremlinQueryRequest.Builder to create a
request.default CompletableFuture<ExecuteOpenCypherExplainQueryResponse> executeOpenCypherExplainQuery(ExecuteOpenCypherExplainQueryRequest executeOpenCypherExplainQueryRequest)
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).
executeOpenCypherExplainQueryRequest - default CompletableFuture<ExecuteOpenCypherExplainQueryResponse> executeOpenCypherExplainQuery(Consumer<ExecuteOpenCypherExplainQueryRequest.Builder> executeOpenCypherExplainQueryRequest)
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).
This is a convenience which creates an instance of the ExecuteOpenCypherExplainQueryRequest.Builder
avoiding the need to create one manually via ExecuteOpenCypherExplainQueryRequest.builder()
executeOpenCypherExplainQueryRequest - A Consumer that will call methods on
ExecuteOpenCypherExplainQueryRequest.Builder to
create a request.default CompletableFuture<ExecuteOpenCypherQueryResponse> executeOpenCypherQuery(ExecuteOpenCypherQueryRequest executeOpenCypherQueryRequest)
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).
executeOpenCypherQueryRequest - default CompletableFuture<ExecuteOpenCypherQueryResponse> executeOpenCypherQuery(Consumer<ExecuteOpenCypherQueryRequest.Builder> executeOpenCypherQueryRequest)
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).
This is a convenience which creates an instance of the ExecuteOpenCypherQueryRequest.Builder avoiding the
need to create one manually via ExecuteOpenCypherQueryRequest.builder()
executeOpenCypherQueryRequest - A Consumer that will call methods on
ExecuteOpenCypherQueryRequest.Builder to create
a request.default CompletableFuture<GetEngineStatusResponse> getEngineStatus(GetEngineStatusRequest getEngineStatusRequest)
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.
getEngineStatusRequest - default CompletableFuture<GetEngineStatusResponse> getEngineStatus(Consumer<GetEngineStatusRequest.Builder> getEngineStatusRequest)
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.
This is a convenience which creates an instance of the GetEngineStatusRequest.Builder avoiding the need
to create one manually via GetEngineStatusRequest.builder()
getEngineStatusRequest - A Consumer that will call methods on
GetEngineStatusRequest.Builder to create a
request.default CompletableFuture<GetGremlinQueryStatusResponse> getGremlinQueryStatus(GetGremlinQueryStatusRequest getGremlinQueryStatusRequest)
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).
getGremlinQueryStatusRequest - default CompletableFuture<GetGremlinQueryStatusResponse> getGremlinQueryStatus(Consumer<GetGremlinQueryStatusRequest.Builder> getGremlinQueryStatusRequest)
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).
This is a convenience which creates an instance of the GetGremlinQueryStatusRequest.Builder avoiding the
need to create one manually via GetGremlinQueryStatusRequest.builder()
getGremlinQueryStatusRequest - A Consumer that will call methods on
GetGremlinQueryStatusRequest.Builder to create a
request.default CompletableFuture<GetLoaderJobStatusResponse> getLoaderJobStatus(GetLoaderJobStatusRequest getLoaderJobStatusRequest)
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..
getLoaderJobStatusRequest - default CompletableFuture<GetLoaderJobStatusResponse> getLoaderJobStatus(Consumer<GetLoaderJobStatusRequest.Builder> getLoaderJobStatusRequest)
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..
This is a convenience which creates an instance of the GetLoaderJobStatusRequest.Builder avoiding the
need to create one manually via GetLoaderJobStatusRequest.builder()
getLoaderJobStatusRequest - A Consumer that will call methods on
GetLoaderJobStatusRequest.Builder to create a
request.default CompletableFuture<GetMlDataProcessingJobResponse> getMLDataProcessingJob(GetMlDataProcessingJobRequest getMlDataProcessingJobRequest)
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.
getMlDataProcessingJobRequest - default CompletableFuture<GetMlDataProcessingJobResponse> getMLDataProcessingJob(Consumer<GetMlDataProcessingJobRequest.Builder> getMlDataProcessingJobRequest)
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.
This is a convenience which creates an instance of the GetMlDataProcessingJobRequest.Builder avoiding the
need to create one manually via GetMlDataProcessingJobRequest.builder()
getMlDataProcessingJobRequest - A Consumer that will call methods on
GetMlDataProcessingJobRequest.Builder to create
a request.default CompletableFuture<GetMlEndpointResponse> getMLEndpoint(GetMlEndpointRequest getMlEndpointRequest)
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.
getMlEndpointRequest - default CompletableFuture<GetMlEndpointResponse> getMLEndpoint(Consumer<GetMlEndpointRequest.Builder> getMlEndpointRequest)
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.
This is a convenience which creates an instance of the GetMlEndpointRequest.Builder avoiding the need to
create one manually via GetMlEndpointRequest.builder()
getMlEndpointRequest - A Consumer that will call methods on
GetMlEndpointRequest.Builder to create a
request.default CompletableFuture<GetMlModelTrainingJobResponse> getMLModelTrainingJob(GetMlModelTrainingJobRequest getMlModelTrainingJobRequest)
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.
getMlModelTrainingJobRequest - default CompletableFuture<GetMlModelTrainingJobResponse> getMLModelTrainingJob(Consumer<GetMlModelTrainingJobRequest.Builder> getMlModelTrainingJobRequest)
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.
This is a convenience which creates an instance of the GetMlModelTrainingJobRequest.Builder avoiding the
need to create one manually via GetMlModelTrainingJobRequest.builder()
getMlModelTrainingJobRequest - A Consumer that will call methods on
GetMlModelTrainingJobRequest.Builder to create a
request.default CompletableFuture<GetMlModelTransformJobResponse> getMLModelTransformJob(GetMlModelTransformJobRequest getMlModelTransformJobRequest)
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.
getMlModelTransformJobRequest - default CompletableFuture<GetMlModelTransformJobResponse> getMLModelTransformJob(Consumer<GetMlModelTransformJobRequest.Builder> getMlModelTransformJobRequest)
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.
This is a convenience which creates an instance of the GetMlModelTransformJobRequest.Builder avoiding the
need to create one manually via GetMlModelTransformJobRequest.builder()
getMlModelTransformJobRequest - A Consumer that will call methods on
GetMlModelTransformJobRequest.Builder to create
a request.default CompletableFuture<GetOpenCypherQueryStatusResponse> getOpenCypherQueryStatus(GetOpenCypherQueryStatusRequest getOpenCypherQueryStatusRequest)
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).
getOpenCypherQueryStatusRequest - default CompletableFuture<GetOpenCypherQueryStatusResponse> getOpenCypherQueryStatus(Consumer<GetOpenCypherQueryStatusRequest.Builder> getOpenCypherQueryStatusRequest)
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).
This is a convenience which creates an instance of the GetOpenCypherQueryStatusRequest.Builder avoiding
the need to create one manually via GetOpenCypherQueryStatusRequest.builder()
getOpenCypherQueryStatusRequest - A Consumer that will call methods on
GetOpenCypherQueryStatusRequest.Builder to
create a request.default CompletableFuture<GetPropertygraphStatisticsResponse> getPropertygraphStatistics(GetPropertygraphStatisticsRequest getPropertygraphStatisticsRequest)
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.
getPropertygraphStatisticsRequest - default CompletableFuture<GetPropertygraphStatisticsResponse> getPropertygraphStatistics(Consumer<GetPropertygraphStatisticsRequest.Builder> getPropertygraphStatisticsRequest)
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.
This is a convenience which creates an instance of the GetPropertygraphStatisticsRequest.Builder avoiding
the need to create one manually via GetPropertygraphStatisticsRequest.builder()
getPropertygraphStatisticsRequest - A Consumer that will call methods on
GetPropertygraphStatisticsRequest.Builder to
create a request.default CompletableFuture<GetPropertygraphStreamResponse> getPropertygraphStream(GetPropertygraphStreamRequest getPropertygraphStreamRequest)
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).
getPropertygraphStreamRequest - default CompletableFuture<GetPropertygraphStreamResponse> getPropertygraphStream(Consumer<GetPropertygraphStreamRequest.Builder> getPropertygraphStreamRequest)
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).
This is a convenience which creates an instance of the GetPropertygraphStreamRequest.Builder avoiding the
need to create one manually via GetPropertygraphStreamRequest.builder()
getPropertygraphStreamRequest - A Consumer that will call methods on
GetPropertygraphStreamRequest.Builder to create
a request.default CompletableFuture<GetPropertygraphSummaryResponse> getPropertygraphSummary(GetPropertygraphSummaryRequest getPropertygraphSummaryRequest)
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.
getPropertygraphSummaryRequest - default CompletableFuture<GetPropertygraphSummaryResponse> getPropertygraphSummary(Consumer<GetPropertygraphSummaryRequest.Builder> getPropertygraphSummaryRequest)
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.
This is a convenience which creates an instance of the GetPropertygraphSummaryRequest.Builder avoiding
the need to create one manually via GetPropertygraphSummaryRequest.builder()
getPropertygraphSummaryRequest - A Consumer that will call methods on
GetPropertygraphSummaryRequest.Builder to create
a request.default CompletableFuture<GetRdfGraphSummaryResponse> getRDFGraphSummary(GetRdfGraphSummaryRequest getRdfGraphSummaryRequest)
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.
getRdfGraphSummaryRequest - default CompletableFuture<GetRdfGraphSummaryResponse> getRDFGraphSummary(Consumer<GetRdfGraphSummaryRequest.Builder> getRdfGraphSummaryRequest)
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.
This is a convenience which creates an instance of the GetRdfGraphSummaryRequest.Builder avoiding the
need to create one manually via GetRdfGraphSummaryRequest.builder()
getRdfGraphSummaryRequest - A Consumer that will call methods on
GetRdfGraphSummaryRequest.Builder to create a
request.default CompletableFuture<GetSparqlStatisticsResponse> getSparqlStatistics(GetSparqlStatisticsRequest getSparqlStatisticsRequest)
Gets RDF statistics (SPARQL).
getSparqlStatisticsRequest - default CompletableFuture<GetSparqlStatisticsResponse> getSparqlStatistics(Consumer<GetSparqlStatisticsRequest.Builder> getSparqlStatisticsRequest)
Gets RDF statistics (SPARQL).
This is a convenience which creates an instance of the GetSparqlStatisticsRequest.Builder avoiding the
need to create one manually via GetSparqlStatisticsRequest.builder()
getSparqlStatisticsRequest - A Consumer that will call methods on
GetSparqlStatisticsRequest.Builder to create a
request.default CompletableFuture<GetSparqlStreamResponse> getSparqlStream(GetSparqlStreamRequest getSparqlStreamRequest)
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).
getSparqlStreamRequest - default CompletableFuture<GetSparqlStreamResponse> getSparqlStream(Consumer<GetSparqlStreamRequest.Builder> getSparqlStreamRequest)
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).
This is a convenience which creates an instance of the GetSparqlStreamRequest.Builder avoiding the need
to create one manually via GetSparqlStreamRequest.builder()
getSparqlStreamRequest - A Consumer that will call methods on
GetSparqlStreamRequest.Builder to create a
request.default CompletableFuture<ListGremlinQueriesResponse> listGremlinQueries(ListGremlinQueriesRequest listGremlinQueriesRequest)
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).
listGremlinQueriesRequest - default CompletableFuture<ListGremlinQueriesResponse> listGremlinQueries(Consumer<ListGremlinQueriesRequest.Builder> listGremlinQueriesRequest)
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).
This is a convenience which creates an instance of the ListGremlinQueriesRequest.Builder avoiding the
need to create one manually via ListGremlinQueriesRequest.builder()
listGremlinQueriesRequest - A Consumer that will call methods on
ListGremlinQueriesRequest.Builder to create a
request.default CompletableFuture<ListLoaderJobsResponse> listLoaderJobs(ListLoaderJobsRequest listLoaderJobsRequest)
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..
listLoaderJobsRequest - default CompletableFuture<ListLoaderJobsResponse> listLoaderJobs(Consumer<ListLoaderJobsRequest.Builder> listLoaderJobsRequest)
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..
This is a convenience which creates an instance of the ListLoaderJobsRequest.Builder avoiding the need to
create one manually via ListLoaderJobsRequest.builder()
listLoaderJobsRequest - A Consumer that will call methods on
ListLoaderJobsRequest.Builder to create a
request.default CompletableFuture<ListMlDataProcessingJobsResponse> listMLDataProcessingJobs(ListMlDataProcessingJobsRequest listMlDataProcessingJobsRequest)
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.
listMlDataProcessingJobsRequest - default CompletableFuture<ListMlDataProcessingJobsResponse> listMLDataProcessingJobs(Consumer<ListMlDataProcessingJobsRequest.Builder> listMlDataProcessingJobsRequest)
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.
This is a convenience which creates an instance of the ListMlDataProcessingJobsRequest.Builder avoiding
the need to create one manually via ListMlDataProcessingJobsRequest.builder()
listMlDataProcessingJobsRequest - A Consumer that will call methods on
ListMlDataProcessingJobsRequest.Builder to
create a request.default CompletableFuture<ListMlEndpointsResponse> listMLEndpoints(ListMlEndpointsRequest listMlEndpointsRequest)
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.
listMlEndpointsRequest - default CompletableFuture<ListMlEndpointsResponse> listMLEndpoints(Consumer<ListMlEndpointsRequest.Builder> listMlEndpointsRequest)
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.
This is a convenience which creates an instance of the ListMlEndpointsRequest.Builder avoiding the need
to create one manually via ListMlEndpointsRequest.builder()
listMlEndpointsRequest - A Consumer that will call methods on
ListMlEndpointsRequest.Builder to create a
request.default CompletableFuture<ListMlModelTrainingJobsResponse> listMLModelTrainingJobs(ListMlModelTrainingJobsRequest listMlModelTrainingJobsRequest)
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.
listMlModelTrainingJobsRequest - default CompletableFuture<ListMlModelTrainingJobsResponse> listMLModelTrainingJobs(Consumer<ListMlModelTrainingJobsRequest.Builder> listMlModelTrainingJobsRequest)
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.
This is a convenience which creates an instance of the ListMlModelTrainingJobsRequest.Builder avoiding
the need to create one manually via ListMlModelTrainingJobsRequest.builder()
listMlModelTrainingJobsRequest - A Consumer that will call methods on
ListMlModelTrainingJobsRequest.Builder to create
a request.default CompletableFuture<ListMlModelTransformJobsResponse> listMLModelTransformJobs(ListMlModelTransformJobsRequest listMlModelTransformJobsRequest)
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.
listMlModelTransformJobsRequest - default CompletableFuture<ListMlModelTransformJobsResponse> listMLModelTransformJobs(Consumer<ListMlModelTransformJobsRequest.Builder> listMlModelTransformJobsRequest)
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.
This is a convenience which creates an instance of the ListMlModelTransformJobsRequest.Builder avoiding
the need to create one manually via ListMlModelTransformJobsRequest.builder()
listMlModelTransformJobsRequest - A Consumer that will call methods on
ListMlModelTransformJobsRequest.Builder to
create a request.default CompletableFuture<ListOpenCypherQueriesResponse> listOpenCypherQueries(ListOpenCypherQueriesRequest listOpenCypherQueriesRequest)
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).
listOpenCypherQueriesRequest - default CompletableFuture<ListOpenCypherQueriesResponse> listOpenCypherQueries(Consumer<ListOpenCypherQueriesRequest.Builder> listOpenCypherQueriesRequest)
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).
This is a convenience which creates an instance of the ListOpenCypherQueriesRequest.Builder avoiding the
need to create one manually via ListOpenCypherQueriesRequest.builder()
listOpenCypherQueriesRequest - A Consumer that will call methods on
ListOpenCypherQueriesRequest.Builder to create a
request.default CompletableFuture<ManagePropertygraphStatisticsResponse> managePropertygraphStatistics(ManagePropertygraphStatisticsRequest managePropertygraphStatisticsRequest)
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.
managePropertygraphStatisticsRequest - default CompletableFuture<ManagePropertygraphStatisticsResponse> managePropertygraphStatistics(Consumer<ManagePropertygraphStatisticsRequest.Builder> managePropertygraphStatisticsRequest)
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.
This is a convenience which creates an instance of the ManagePropertygraphStatisticsRequest.Builder
avoiding the need to create one manually via ManagePropertygraphStatisticsRequest.builder()
managePropertygraphStatisticsRequest - A Consumer that will call methods on
ManagePropertygraphStatisticsRequest.Builder to
create a request.default CompletableFuture<ManageSparqlStatisticsResponse> manageSparqlStatistics(ManageSparqlStatisticsRequest manageSparqlStatisticsRequest)
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.
manageSparqlStatisticsRequest - default CompletableFuture<ManageSparqlStatisticsResponse> manageSparqlStatistics(Consumer<ManageSparqlStatisticsRequest.Builder> manageSparqlStatisticsRequest)
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.
This is a convenience which creates an instance of the ManageSparqlStatisticsRequest.Builder avoiding the
need to create one manually via ManageSparqlStatisticsRequest.builder()
manageSparqlStatisticsRequest - A Consumer that will call methods on
ManageSparqlStatisticsRequest.Builder to create
a request.default CompletableFuture<StartLoaderJobResponse> startLoaderJob(StartLoaderJobRequest startLoaderJobRequest)
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.
startLoaderJobRequest - default CompletableFuture<StartLoaderJobResponse> startLoaderJob(Consumer<StartLoaderJobRequest.Builder> startLoaderJobRequest)
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.
This is a convenience which creates an instance of the StartLoaderJobRequest.Builder avoiding the need to
create one manually via StartLoaderJobRequest.builder()
startLoaderJobRequest - A Consumer that will call methods on
StartLoaderJobRequest.Builder to create a
request.default CompletableFuture<StartMlDataProcessingJobResponse> startMLDataProcessingJob(StartMlDataProcessingJobRequest startMlDataProcessingJobRequest)
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.
startMlDataProcessingJobRequest - default CompletableFuture<StartMlDataProcessingJobResponse> startMLDataProcessingJob(Consumer<StartMlDataProcessingJobRequest.Builder> startMlDataProcessingJobRequest)
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.
This is a convenience which creates an instance of the StartMlDataProcessingJobRequest.Builder avoiding
the need to create one manually via StartMlDataProcessingJobRequest.builder()
startMlDataProcessingJobRequest - A Consumer that will call methods on
StartMlDataProcessingJobRequest.Builder to
create a request.default CompletableFuture<StartMlModelTrainingJobResponse> startMLModelTrainingJob(StartMlModelTrainingJobRequest startMlModelTrainingJobRequest)
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.
startMlModelTrainingJobRequest - default CompletableFuture<StartMlModelTrainingJobResponse> startMLModelTrainingJob(Consumer<StartMlModelTrainingJobRequest.Builder> startMlModelTrainingJobRequest)
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.
This is a convenience which creates an instance of the StartMlModelTrainingJobRequest.Builder avoiding
the need to create one manually via StartMlModelTrainingJobRequest.builder()
startMlModelTrainingJobRequest - A Consumer that will call methods on
StartMlModelTrainingJobRequest.Builder to create
a request.default CompletableFuture<StartMlModelTransformJobResponse> startMLModelTransformJob(StartMlModelTransformJobRequest startMlModelTransformJobRequest)
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.
startMlModelTransformJobRequest - default CompletableFuture<StartMlModelTransformJobResponse> startMLModelTransformJob(Consumer<StartMlModelTransformJobRequest.Builder> startMlModelTransformJobRequest)
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.
This is a convenience which creates an instance of the StartMlModelTransformJobRequest.Builder avoiding
the need to create one manually via StartMlModelTransformJobRequest.builder()
startMlModelTransformJobRequest - A Consumer that will call methods on
StartMlModelTransformJobRequest.Builder to
create a request.default NeptunedataServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic NeptunedataAsyncClient create()
NeptunedataAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static NeptunedataAsyncClientBuilder builder()
NeptunedataAsyncClient.Copyright © 2023. All rights reserved.