Interface NeptunedataClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic NeptunedataClientBuilderbuilder()Create a builder that can be used to configure and create aNeptunedataClient.default CancelGremlinQueryResponsecancelGremlinQuery(Consumer<CancelGremlinQueryRequest.Builder> cancelGremlinQueryRequest) Cancels a Gremlin query.default CancelGremlinQueryResponsecancelGremlinQuery(CancelGremlinQueryRequest cancelGremlinQueryRequest) Cancels a Gremlin query.default CancelLoaderJobResponsecancelLoaderJob(Consumer<CancelLoaderJobRequest.Builder> cancelLoaderJobRequest) Cancels a specified load job.default CancelLoaderJobResponsecancelLoaderJob(CancelLoaderJobRequest cancelLoaderJobRequest) Cancels a specified load job.cancelMLDataProcessingJob(Consumer<CancelMlDataProcessingJobRequest.Builder> cancelMlDataProcessingJobRequest) Cancels a Neptune ML data processing job.cancelMLDataProcessingJob(CancelMlDataProcessingJobRequest cancelMlDataProcessingJobRequest) Cancels a Neptune ML data processing job.default CancelMlModelTrainingJobResponsecancelMLModelTrainingJob(Consumer<CancelMlModelTrainingJobRequest.Builder> cancelMlModelTrainingJobRequest) Cancels a Neptune ML model training job.default CancelMlModelTrainingJobResponsecancelMLModelTrainingJob(CancelMlModelTrainingJobRequest cancelMlModelTrainingJobRequest) Cancels a Neptune ML model training job.cancelMLModelTransformJob(Consumer<CancelMlModelTransformJobRequest.Builder> cancelMlModelTransformJobRequest) Cancels a specified model transform job.cancelMLModelTransformJob(CancelMlModelTransformJobRequest cancelMlModelTransformJobRequest) Cancels a specified model transform job.default CancelOpenCypherQueryResponsecancelOpenCypherQuery(Consumer<CancelOpenCypherQueryRequest.Builder> cancelOpenCypherQueryRequest) Cancels a specified openCypher query.default CancelOpenCypherQueryResponsecancelOpenCypherQuery(CancelOpenCypherQueryRequest cancelOpenCypherQueryRequest) Cancels a specified openCypher query.static NeptunedataClientcreate()Create aNeptunedataClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateMlEndpointResponsecreateMLEndpoint(Consumer<CreateMlEndpointRequest.Builder> createMlEndpointRequest) Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed.default CreateMlEndpointResponsecreateMLEndpoint(CreateMlEndpointRequest createMlEndpointRequest) Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed.default DeleteMlEndpointResponsedeleteMLEndpoint(Consumer<DeleteMlEndpointRequest.Builder> deleteMlEndpointRequest) Cancels the creation of a Neptune ML inference endpoint.default DeleteMlEndpointResponsedeleteMLEndpoint(DeleteMlEndpointRequest deleteMlEndpointRequest) Cancels the creation of a Neptune ML inference endpoint.deletePropertygraphStatistics(Consumer<DeletePropertygraphStatisticsRequest.Builder> deletePropertygraphStatisticsRequest) Deletes statistics for Gremlin and openCypher (property graph) data.deletePropertygraphStatistics(DeletePropertygraphStatisticsRequest deletePropertygraphStatisticsRequest) Deletes statistics for Gremlin and openCypher (property graph) data.default DeleteSparqlStatisticsResponsedeleteSparqlStatistics(Consumer<DeleteSparqlStatisticsRequest.Builder> deleteSparqlStatisticsRequest) Deletes SPARQL statisticsdefault DeleteSparqlStatisticsResponsedeleteSparqlStatistics(DeleteSparqlStatisticsRequest deleteSparqlStatisticsRequest) Deletes SPARQL statisticsdefault ExecuteFastResetResponseexecuteFastReset(Consumer<ExecuteFastResetRequest.Builder> executeFastResetRequest) The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.default ExecuteFastResetResponseexecuteFastReset(ExecuteFastResetRequest executeFastResetRequest) The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.executeGremlinExplainQuery(Consumer<ExecuteGremlinExplainQueryRequest.Builder> executeGremlinExplainQueryRequest) Executes a Gremlin Explain query.executeGremlinExplainQuery(ExecuteGremlinExplainQueryRequest executeGremlinExplainQueryRequest) Executes a Gremlin Explain query.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.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.default ExecuteGremlinQueryResponseexecuteGremlinQuery(Consumer<ExecuteGremlinQueryRequest.Builder> executeGremlinQueryRequest) This commands executes a Gremlin query.default ExecuteGremlinQueryResponseexecuteGremlinQuery(ExecuteGremlinQueryRequest executeGremlinQueryRequest) This commands executes a Gremlin query.executeOpenCypherExplainQuery(Consumer<ExecuteOpenCypherExplainQueryRequest.Builder> executeOpenCypherExplainQueryRequest) Executes an openCypherexplainrequest.executeOpenCypherExplainQuery(ExecuteOpenCypherExplainQueryRequest executeOpenCypherExplainQueryRequest) Executes an openCypherexplainrequest.default ExecuteOpenCypherQueryResponseexecuteOpenCypherQuery(Consumer<ExecuteOpenCypherQueryRequest.Builder> executeOpenCypherQueryRequest) Executes an openCypher query.default ExecuteOpenCypherQueryResponseexecuteOpenCypherQuery(ExecuteOpenCypherQueryRequest executeOpenCypherQueryRequest) Executes an openCypher query.default GetEngineStatusResponsegetEngineStatus(Consumer<GetEngineStatusRequest.Builder> getEngineStatusRequest) Retrieves the status of the graph database on the host.default GetEngineStatusResponsegetEngineStatus(GetEngineStatusRequest getEngineStatusRequest) Retrieves the status of the graph database on the host.default GetGremlinQueryStatusResponsegetGremlinQueryStatus(Consumer<GetGremlinQueryStatusRequest.Builder> getGremlinQueryStatusRequest) Gets the status of a specified Gremlin query.default GetGremlinQueryStatusResponsegetGremlinQueryStatus(GetGremlinQueryStatusRequest getGremlinQueryStatusRequest) Gets the status of a specified Gremlin query.default GetLoaderJobStatusResponsegetLoaderJobStatus(Consumer<GetLoaderJobStatusRequest.Builder> getLoaderJobStatusRequest) Gets status information about a specified load job.default GetLoaderJobStatusResponsegetLoaderJobStatus(GetLoaderJobStatusRequest getLoaderJobStatusRequest) Gets status information about a specified load job.default GetMlDataProcessingJobResponsegetMLDataProcessingJob(Consumer<GetMlDataProcessingJobRequest.Builder> getMlDataProcessingJobRequest) Retrieves information about a specified data processing job.default GetMlDataProcessingJobResponsegetMLDataProcessingJob(GetMlDataProcessingJobRequest getMlDataProcessingJobRequest) Retrieves information about a specified data processing job.default GetMlEndpointResponsegetMLEndpoint(Consumer<GetMlEndpointRequest.Builder> getMlEndpointRequest) Retrieves details about an inference endpoint.default GetMlEndpointResponsegetMLEndpoint(GetMlEndpointRequest getMlEndpointRequest) Retrieves details about an inference endpoint.default GetMlModelTrainingJobResponsegetMLModelTrainingJob(Consumer<GetMlModelTrainingJobRequest.Builder> getMlModelTrainingJobRequest) Retrieves information about a Neptune ML model training job.default GetMlModelTrainingJobResponsegetMLModelTrainingJob(GetMlModelTrainingJobRequest getMlModelTrainingJobRequest) Retrieves information about a Neptune ML model training job.default GetMlModelTransformJobResponsegetMLModelTransformJob(Consumer<GetMlModelTransformJobRequest.Builder> getMlModelTransformJobRequest) Gets information about a specified model transform job.default GetMlModelTransformJobResponsegetMLModelTransformJob(GetMlModelTransformJobRequest getMlModelTransformJobRequest) Gets information about a specified model transform job.default GetOpenCypherQueryStatusResponsegetOpenCypherQueryStatus(Consumer<GetOpenCypherQueryStatusRequest.Builder> getOpenCypherQueryStatusRequest) Retrieves the status of a specified openCypher query.default GetOpenCypherQueryStatusResponsegetOpenCypherQueryStatus(GetOpenCypherQueryStatusRequest getOpenCypherQueryStatusRequest) Retrieves the status of a specified openCypher query.getPropertygraphStatistics(Consumer<GetPropertygraphStatisticsRequest.Builder> getPropertygraphStatisticsRequest) Gets property graph statistics (Gremlin and openCypher).getPropertygraphStatistics(GetPropertygraphStatisticsRequest getPropertygraphStatisticsRequest) Gets property graph statistics (Gremlin and openCypher).default GetPropertygraphStreamResponsegetPropertygraphStream(Consumer<GetPropertygraphStreamRequest.Builder> getPropertygraphStreamRequest) Gets a stream for a property graph.default GetPropertygraphStreamResponsegetPropertygraphStream(GetPropertygraphStreamRequest getPropertygraphStreamRequest) Gets a stream for a property graph.default GetPropertygraphSummaryResponsegetPropertygraphSummary(Consumer<GetPropertygraphSummaryRequest.Builder> getPropertygraphSummaryRequest) Gets a graph summary for a property graph.default GetPropertygraphSummaryResponsegetPropertygraphSummary(GetPropertygraphSummaryRequest getPropertygraphSummaryRequest) Gets a graph summary for a property graph.default GetRdfGraphSummaryResponsegetRDFGraphSummary(Consumer<GetRdfGraphSummaryRequest.Builder> getRdfGraphSummaryRequest) Gets a graph summary for an RDF graph.default GetRdfGraphSummaryResponsegetRDFGraphSummary(GetRdfGraphSummaryRequest getRdfGraphSummaryRequest) Gets a graph summary for an RDF graph.default GetSparqlStatisticsResponsegetSparqlStatistics(Consumer<GetSparqlStatisticsRequest.Builder> getSparqlStatisticsRequest) Gets RDF statistics (SPARQL).default GetSparqlStatisticsResponsegetSparqlStatistics(GetSparqlStatisticsRequest getSparqlStatisticsRequest) Gets RDF statistics (SPARQL).default GetSparqlStreamResponsegetSparqlStream(Consumer<GetSparqlStreamRequest.Builder> getSparqlStreamRequest) Gets a stream for an RDF graph.default GetSparqlStreamResponsegetSparqlStream(GetSparqlStreamRequest getSparqlStreamRequest) Gets a stream for an RDF graph.default ListGremlinQueriesResponselistGremlinQueries(Consumer<ListGremlinQueriesRequest.Builder> listGremlinQueriesRequest) Lists active Gremlin queries.default ListGremlinQueriesResponselistGremlinQueries(ListGremlinQueriesRequest listGremlinQueriesRequest) Lists active Gremlin queries.default ListLoaderJobsResponselistLoaderJobs(Consumer<ListLoaderJobsRequest.Builder> listLoaderJobsRequest) Retrieves a list of theloadIdsfor all active loader jobs.default ListLoaderJobsResponselistLoaderJobs(ListLoaderJobsRequest listLoaderJobsRequest) Retrieves a list of theloadIdsfor all active loader jobs.default ListMlDataProcessingJobsResponselistMLDataProcessingJobs(Consumer<ListMlDataProcessingJobsRequest.Builder> listMlDataProcessingJobsRequest) Returns a list of Neptune ML data processing jobs.default ListMlDataProcessingJobsResponselistMLDataProcessingJobs(ListMlDataProcessingJobsRequest listMlDataProcessingJobsRequest) Returns a list of Neptune ML data processing jobs.default ListMlEndpointsResponselistMLEndpoints(Consumer<ListMlEndpointsRequest.Builder> listMlEndpointsRequest) Lists existing inference endpoints.default ListMlEndpointsResponselistMLEndpoints(ListMlEndpointsRequest listMlEndpointsRequest) Lists existing inference endpoints.default ListMlModelTrainingJobsResponselistMLModelTrainingJobs(Consumer<ListMlModelTrainingJobsRequest.Builder> listMlModelTrainingJobsRequest) Lists Neptune ML model-training jobs.default ListMlModelTrainingJobsResponselistMLModelTrainingJobs(ListMlModelTrainingJobsRequest listMlModelTrainingJobsRequest) Lists Neptune ML model-training jobs.default ListMlModelTransformJobsResponselistMLModelTransformJobs(Consumer<ListMlModelTransformJobsRequest.Builder> listMlModelTransformJobsRequest) Returns a list of model transform job IDs.default ListMlModelTransformJobsResponselistMLModelTransformJobs(ListMlModelTransformJobsRequest listMlModelTransformJobsRequest) Returns a list of model transform job IDs.default ListOpenCypherQueriesResponselistOpenCypherQueries(Consumer<ListOpenCypherQueriesRequest.Builder> listOpenCypherQueriesRequest) Lists active openCypher queries.default ListOpenCypherQueriesResponselistOpenCypherQueries(ListOpenCypherQueriesRequest listOpenCypherQueriesRequest) Lists active openCypher queries.managePropertygraphStatistics(Consumer<ManagePropertygraphStatisticsRequest.Builder> managePropertygraphStatisticsRequest) Manages the generation and use of property graph statistics.managePropertygraphStatistics(ManagePropertygraphStatisticsRequest managePropertygraphStatisticsRequest) Manages the generation and use of property graph statistics.default ManageSparqlStatisticsResponsemanageSparqlStatistics(Consumer<ManageSparqlStatisticsRequest.Builder> manageSparqlStatisticsRequest) Manages the generation and use of RDF graph statistics.default ManageSparqlStatisticsResponsemanageSparqlStatistics(ManageSparqlStatisticsRequest manageSparqlStatisticsRequest) Manages the generation and use of RDF graph statistics.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault StartLoaderJobResponsestartLoaderJob(Consumer<StartLoaderJobRequest.Builder> startLoaderJobRequest) Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance.default StartLoaderJobResponsestartLoaderJob(StartLoaderJobRequest startLoaderJobRequest) Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance.default StartMlDataProcessingJobResponsestartMLDataProcessingJob(Consumer<StartMlDataProcessingJobRequest.Builder> startMlDataProcessingJobRequest) Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training.default StartMlDataProcessingJobResponsestartMLDataProcessingJob(StartMlDataProcessingJobRequest startMlDataProcessingJobRequest) Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training.default StartMlModelTrainingJobResponsestartMLModelTrainingJob(Consumer<StartMlModelTrainingJobRequest.Builder> startMlModelTrainingJobRequest) Creates a new Neptune ML model training job.default StartMlModelTrainingJobResponsestartMLModelTrainingJob(StartMlModelTrainingJobRequest startMlModelTrainingJobRequest) Creates a new Neptune ML model training job.default StartMlModelTransformJobResponsestartMLModelTransformJob(Consumer<StartMlModelTransformJobRequest.Builder> startMlModelTransformJobRequest) Creates a new model transform job.default StartMlModelTransformJobResponsestartMLModelTransformJob(StartMlModelTransformJobRequest startMlModelTransformJobRequest) Creates a new model transform job.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
cancelGremlinQuery
default CancelGremlinQueryResponse cancelGremlinQuery(CancelGremlinQueryRequest cancelGremlinQueryRequest) throws BadRequestException, InvalidParameterException, ClientTimeoutException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
cancelGremlinQueryRequest-- Returns:
- Result of the CancelGremlinQuery operation returned by the service.
- See Also:
-
cancelGremlinQuery
default CancelGremlinQueryResponse cancelGremlinQuery(Consumer<CancelGremlinQueryRequest.Builder> cancelGremlinQueryRequest) throws BadRequestException, InvalidParameterException, ClientTimeoutException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaCancelGremlinQueryRequest.builder()- Parameters:
cancelGremlinQueryRequest- AConsumerthat will call methods onCancelGremlinQueryRequest.Builderto create a request.- Returns:
- Result of the CancelGremlinQuery operation returned by the service.
- See Also:
-
cancelLoaderJob
default CancelLoaderJobResponse cancelLoaderJob(CancelLoaderJobRequest cancelLoaderJobRequest) throws BadRequestException, InvalidParameterException, BulkLoadIdNotFoundException, ClientTimeoutException, LoadUrlAccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, InternalFailureException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException Cancels a specified load job. This is an HTTP
DELETErequest. 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..
- Parameters:
cancelLoaderJobRequest-- Returns:
- Result of the CancelLoaderJob operation returned by the service.
- See Also:
-
cancelLoaderJob
default CancelLoaderJobResponse cancelLoaderJob(Consumer<CancelLoaderJobRequest.Builder> cancelLoaderJobRequest) throws BadRequestException, InvalidParameterException, BulkLoadIdNotFoundException, ClientTimeoutException, LoadUrlAccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, InternalFailureException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException Cancels a specified load job. This is an HTTP
DELETErequest. 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.Builderavoiding the need to create one manually viaCancelLoaderJobRequest.builder()- Parameters:
cancelLoaderJobRequest- AConsumerthat will call methods onCancelLoaderJobRequest.Builderto create a request.- Returns:
- Result of the CancelLoaderJob operation returned by the service.
- See Also:
-
cancelMLDataProcessingJob
default CancelMlDataProcessingJobResponse cancelMLDataProcessingJob(CancelMlDataProcessingJobRequest cancelMlDataProcessingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Cancels a Neptune ML data processing job. See The
dataprocessingcommand.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.
- Parameters:
cancelMlDataProcessingJobRequest-- Returns:
- Result of the CancelMLDataProcessingJob operation returned by the service.
- See Also:
-
cancelMLDataProcessingJob
default CancelMlDataProcessingJobResponse cancelMLDataProcessingJob(Consumer<CancelMlDataProcessingJobRequest.Builder> cancelMlDataProcessingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Cancels a Neptune ML data processing job. See The
dataprocessingcommand.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.Builderavoiding the need to create one manually viaCancelMlDataProcessingJobRequest.builder()- Parameters:
cancelMlDataProcessingJobRequest- AConsumerthat will call methods onCancelMlDataProcessingJobRequest.Builderto create a request.- Returns:
- Result of the CancelMLDataProcessingJob operation returned by the service.
- See Also:
-
cancelMLModelTrainingJob
default CancelMlModelTrainingJobResponse cancelMLModelTrainingJob(CancelMlModelTrainingJobRequest cancelMlModelTrainingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Cancels a Neptune ML model training job. See Model training using the
modeltrainingcommand.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.
- Parameters:
cancelMlModelTrainingJobRequest-- Returns:
- Result of the CancelMLModelTrainingJob operation returned by the service.
- See Also:
-
cancelMLModelTrainingJob
default CancelMlModelTrainingJobResponse cancelMLModelTrainingJob(Consumer<CancelMlModelTrainingJobRequest.Builder> cancelMlModelTrainingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Cancels a Neptune ML model training job. See Model training using the
modeltrainingcommand.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.Builderavoiding the need to create one manually viaCancelMlModelTrainingJobRequest.builder()- Parameters:
cancelMlModelTrainingJobRequest- AConsumerthat will call methods onCancelMlModelTrainingJobRequest.Builderto create a request.- Returns:
- Result of the CancelMLModelTrainingJob operation returned by the service.
- See Also:
-
cancelMLModelTransformJob
default CancelMlModelTransformJobResponse cancelMLModelTransformJob(CancelMlModelTransformJobRequest cancelMlModelTransformJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
cancelMlModelTransformJobRequest-- Returns:
- Result of the CancelMLModelTransformJob operation returned by the service.
- See Also:
-
cancelMLModelTransformJob
default CancelMlModelTransformJobResponse cancelMLModelTransformJob(Consumer<CancelMlModelTransformJobRequest.Builder> cancelMlModelTransformJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaCancelMlModelTransformJobRequest.builder()- Parameters:
cancelMlModelTransformJobRequest- AConsumerthat will call methods onCancelMlModelTransformJobRequest.Builderto create a request.- Returns:
- Result of the CancelMLModelTransformJob operation returned by the service.
- See Also:
-
cancelOpenCypherQuery
default CancelOpenCypherQueryResponse cancelOpenCypherQuery(CancelOpenCypherQueryRequest cancelOpenCypherQueryRequest) throws InvalidNumericDataException, BadRequestException, InvalidParameterException, ClientTimeoutException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
cancelOpenCypherQueryRequest-- Returns:
- Result of the CancelOpenCypherQuery operation returned by the service.
- See Also:
-
cancelOpenCypherQuery
default CancelOpenCypherQueryResponse cancelOpenCypherQuery(Consumer<CancelOpenCypherQueryRequest.Builder> cancelOpenCypherQueryRequest) throws InvalidNumericDataException, BadRequestException, InvalidParameterException, ClientTimeoutException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaCancelOpenCypherQueryRequest.builder()- Parameters:
cancelOpenCypherQueryRequest- AConsumerthat will call methods onCancelOpenCypherQueryRequest.Builderto create a request.- Returns:
- Result of the CancelOpenCypherQuery operation returned by the service.
- See Also:
-
createMLEndpoint
default CreateMlEndpointResponse createMLEndpoint(CreateMlEndpointRequest createMlEndpointRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
createMlEndpointRequest-- Returns:
- Result of the CreateMLEndpoint operation returned by the service.
- See Also:
-
createMLEndpoint
default CreateMlEndpointResponse createMLEndpoint(Consumer<CreateMlEndpointRequest.Builder> createMlEndpointRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaCreateMlEndpointRequest.builder()- Parameters:
createMlEndpointRequest- AConsumerthat will call methods onCreateMlEndpointRequest.Builderto create a request.- Returns:
- Result of the CreateMLEndpoint operation returned by the service.
- See Also:
-
deleteMLEndpoint
default DeleteMlEndpointResponse deleteMLEndpoint(DeleteMlEndpointRequest deleteMlEndpointRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
deleteMlEndpointRequest-- Returns:
- Result of the DeleteMLEndpoint operation returned by the service.
- See Also:
-
deleteMLEndpoint
default DeleteMlEndpointResponse deleteMLEndpoint(Consumer<DeleteMlEndpointRequest.Builder> deleteMlEndpointRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaDeleteMlEndpointRequest.builder()- Parameters:
deleteMlEndpointRequest- AConsumerthat will call methods onDeleteMlEndpointRequest.Builderto create a request.- Returns:
- Result of the DeleteMLEndpoint operation returned by the service.
- See Also:
-
deletePropertygraphStatistics
default DeletePropertygraphStatisticsResponse deletePropertygraphStatistics(DeletePropertygraphStatisticsRequest deletePropertygraphStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
deletePropertygraphStatisticsRequest-- Returns:
- Result of the DeletePropertygraphStatistics operation returned by the service.
- See Also:
-
deletePropertygraphStatistics
default DeletePropertygraphStatisticsResponse deletePropertygraphStatistics(Consumer<DeletePropertygraphStatisticsRequest.Builder> deletePropertygraphStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaDeletePropertygraphStatisticsRequest.builder()- Parameters:
deletePropertygraphStatisticsRequest- AConsumerthat will call methods onDeletePropertygraphStatisticsRequest.Builderto create a request.- Returns:
- Result of the DeletePropertygraphStatistics operation returned by the service.
- See Also:
-
deleteSparqlStatistics
default DeleteSparqlStatisticsResponse deleteSparqlStatistics(DeleteSparqlStatisticsRequest deleteSparqlStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
deleteSparqlStatisticsRequest-- Returns:
- Result of the DeleteSparqlStatistics operation returned by the service.
- See Also:
-
deleteSparqlStatistics
default DeleteSparqlStatisticsResponse deleteSparqlStatistics(Consumer<DeleteSparqlStatisticsRequest.Builder> deleteSparqlStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaDeleteSparqlStatisticsRequest.builder()- Parameters:
deleteSparqlStatisticsRequest- AConsumerthat will call methods onDeleteSparqlStatisticsRequest.Builderto create a request.- Returns:
- Result of the DeleteSparqlStatistics operation returned by the service.
- See Also:
-
executeFastReset
default ExecuteFastResetResponse executeFastReset(ExecuteFastResetRequest executeFastResetRequest) throws InvalidParameterException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, ServerShutdownException, PreconditionsFailedException, MethodNotAllowedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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
ExecuteFastResetwithactionset toinitiateDatabaseReset. This returns a UUID token which you then include when callingExecuteFastResetagain withactionset toperformDatabaseReset. 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.
- Parameters:
executeFastResetRequest-- Returns:
- Result of the ExecuteFastReset operation returned by the service.
- See Also:
-
executeFastReset
default ExecuteFastResetResponse executeFastReset(Consumer<ExecuteFastResetRequest.Builder> executeFastResetRequest) throws InvalidParameterException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, ServerShutdownException, PreconditionsFailedException, MethodNotAllowedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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
ExecuteFastResetwithactionset toinitiateDatabaseReset. This returns a UUID token which you then include when callingExecuteFastResetagain withactionset toperformDatabaseReset. 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.Builderavoiding the need to create one manually viaExecuteFastResetRequest.builder()- Parameters:
executeFastResetRequest- AConsumerthat will call methods onExecuteFastResetRequest.Builderto create a request.- Returns:
- Result of the ExecuteFastReset operation returned by the service.
- See Also:
-
executeGremlinExplainQuery
default ExecuteGremlinExplainQueryResponse executeGremlinExplainQuery(ExecuteGremlinExplainQueryRequest executeGremlinExplainQueryRequest) throws QueryTooLargeException, BadRequestException, QueryLimitExceededException, InvalidParameterException, QueryLimitException, ClientTimeoutException, CancelledByUserException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, MemoryLimitExceededException, PreconditionsFailedException, MalformedQueryException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException Executes a Gremlin Explain query.
Amazon Neptune has added a Gremlin feature named
explainthat 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 anexplainparameter 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).
- Parameters:
executeGremlinExplainQueryRequest-- Returns:
- Result of the ExecuteGremlinExplainQuery operation returned by the service.
- See Also:
-
executeGremlinExplainQuery
default ExecuteGremlinExplainQueryResponse executeGremlinExplainQuery(Consumer<ExecuteGremlinExplainQueryRequest.Builder> executeGremlinExplainQueryRequest) throws QueryTooLargeException, BadRequestException, QueryLimitExceededException, InvalidParameterException, QueryLimitException, ClientTimeoutException, CancelledByUserException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, MemoryLimitExceededException, PreconditionsFailedException, MalformedQueryException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException Executes a Gremlin Explain query.
Amazon Neptune has added a Gremlin feature named
explainthat 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 anexplainparameter 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.Builderavoiding the need to create one manually viaExecuteGremlinExplainQueryRequest.builder()- Parameters:
executeGremlinExplainQueryRequest- AConsumerthat will call methods onExecuteGremlinExplainQueryRequest.Builderto create a request.- Returns:
- Result of the ExecuteGremlinExplainQuery operation returned by the service.
- See Also:
-
executeGremlinProfileQuery
default ExecuteGremlinProfileQueryResponse executeGremlinProfileQuery(ExecuteGremlinProfileQueryRequest executeGremlinProfileQueryRequest) throws QueryTooLargeException, BadRequestException, QueryLimitExceededException, InvalidParameterException, QueryLimitException, ClientTimeoutException, CancelledByUserException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, MemoryLimitExceededException, PreconditionsFailedException, MalformedQueryException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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).
- Parameters:
executeGremlinProfileQueryRequest-- Returns:
- Result of the ExecuteGremlinProfileQuery operation returned by the service.
- See Also:
-
executeGremlinProfileQuery
default ExecuteGremlinProfileQueryResponse executeGremlinProfileQuery(Consumer<ExecuteGremlinProfileQueryRequest.Builder> executeGremlinProfileQueryRequest) throws QueryTooLargeException, BadRequestException, QueryLimitExceededException, InvalidParameterException, QueryLimitException, ClientTimeoutException, CancelledByUserException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, MemoryLimitExceededException, PreconditionsFailedException, MalformedQueryException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaExecuteGremlinProfileQueryRequest.builder()- Parameters:
executeGremlinProfileQueryRequest- AConsumerthat will call methods onExecuteGremlinProfileQueryRequest.Builderto create a request.- Returns:
- Result of the ExecuteGremlinProfileQuery operation returned by the service.
- See Also:
-
executeGremlinQuery
default ExecuteGremlinQueryResponse executeGremlinQuery(ExecuteGremlinQueryRequest executeGremlinQueryRequest) throws QueryTooLargeException, BadRequestException, QueryLimitExceededException, InvalidParameterException, QueryLimitException, ClientTimeoutException, CancelledByUserException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, MemoryLimitExceededException, PreconditionsFailedException, MalformedQueryException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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).
- Parameters:
executeGremlinQueryRequest-- Returns:
- Result of the ExecuteGremlinQuery operation returned by the service.
- See Also:
-
executeGremlinQuery
default ExecuteGremlinQueryResponse executeGremlinQuery(Consumer<ExecuteGremlinQueryRequest.Builder> executeGremlinQueryRequest) throws QueryTooLargeException, BadRequestException, QueryLimitExceededException, InvalidParameterException, QueryLimitException, ClientTimeoutException, CancelledByUserException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, MemoryLimitExceededException, PreconditionsFailedException, MalformedQueryException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaExecuteGremlinQueryRequest.builder()- Parameters:
executeGremlinQueryRequest- AConsumerthat will call methods onExecuteGremlinQueryRequest.Builderto create a request.- Returns:
- Result of the ExecuteGremlinQuery operation returned by the service.
- See Also:
-
executeOpenCypherExplainQuery
default ExecuteOpenCypherExplainQueryResponse executeOpenCypherExplainQuery(ExecuteOpenCypherExplainQueryRequest executeOpenCypherExplainQueryRequest) throws QueryTooLargeException, InvalidNumericDataException, BadRequestException, QueryLimitExceededException, InvalidParameterException, QueryLimitException, ClientTimeoutException, CancelledByUserException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, MemoryLimitExceededException, PreconditionsFailedException, MalformedQueryException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException Executes an openCypher
explainrequest. 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).
- Parameters:
executeOpenCypherExplainQueryRequest-- Returns:
- Result of the ExecuteOpenCypherExplainQuery operation returned by the service.
- See Also:
-
executeOpenCypherExplainQuery
default ExecuteOpenCypherExplainQueryResponse executeOpenCypherExplainQuery(Consumer<ExecuteOpenCypherExplainQueryRequest.Builder> executeOpenCypherExplainQueryRequest) throws QueryTooLargeException, InvalidNumericDataException, BadRequestException, QueryLimitExceededException, InvalidParameterException, QueryLimitException, ClientTimeoutException, CancelledByUserException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, MemoryLimitExceededException, PreconditionsFailedException, MalformedQueryException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException Executes an openCypher
explainrequest. 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.Builderavoiding the need to create one manually viaExecuteOpenCypherExplainQueryRequest.builder()- Parameters:
executeOpenCypherExplainQueryRequest- AConsumerthat will call methods onExecuteOpenCypherExplainQueryRequest.Builderto create a request.- Returns:
- Result of the ExecuteOpenCypherExplainQuery operation returned by the service.
- See Also:
-
executeOpenCypherQuery
default ExecuteOpenCypherQueryResponse executeOpenCypherQuery(ExecuteOpenCypherQueryRequest executeOpenCypherQueryRequest) throws QueryTooLargeException, InvalidNumericDataException, BadRequestException, QueryLimitExceededException, InvalidParameterException, QueryLimitException, ClientTimeoutException, CancelledByUserException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, MemoryLimitExceededException, PreconditionsFailedException, MalformedQueryException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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).
- Parameters:
executeOpenCypherQueryRequest-- Returns:
- Result of the ExecuteOpenCypherQuery operation returned by the service.
- See Also:
-
executeOpenCypherQuery
default ExecuteOpenCypherQueryResponse executeOpenCypherQuery(Consumer<ExecuteOpenCypherQueryRequest.Builder> executeOpenCypherQueryRequest) throws QueryTooLargeException, InvalidNumericDataException, BadRequestException, QueryLimitExceededException, InvalidParameterException, QueryLimitException, ClientTimeoutException, CancelledByUserException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, MemoryLimitExceededException, PreconditionsFailedException, MalformedQueryException, ParsingException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaExecuteOpenCypherQueryRequest.builder()- Parameters:
executeOpenCypherQueryRequest- AConsumerthat will call methods onExecuteOpenCypherQueryRequest.Builderto create a request.- Returns:
- Result of the ExecuteOpenCypherQuery operation returned by the service.
- See Also:
-
getEngineStatus
default GetEngineStatusResponse getEngineStatus(GetEngineStatusRequest getEngineStatusRequest) throws UnsupportedOperationException, InternalFailureException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
getEngineStatusRequest-- Returns:
- Result of the GetEngineStatus operation returned by the service.
- See Also:
-
getEngineStatus
default GetEngineStatusResponse getEngineStatus(Consumer<GetEngineStatusRequest.Builder> getEngineStatusRequest) throws UnsupportedOperationException, InternalFailureException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaGetEngineStatusRequest.builder()- Parameters:
getEngineStatusRequest- AConsumerthat will call methods onGetEngineStatusRequest.Builderto create a request.- Returns:
- Result of the GetEngineStatus operation returned by the service.
- See Also:
-
getGremlinQueryStatus
default GetGremlinQueryStatusResponse getGremlinQueryStatus(GetGremlinQueryStatusRequest getGremlinQueryStatusRequest) throws BadRequestException, InvalidParameterException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ReadOnlyViolationException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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).
- Parameters:
getGremlinQueryStatusRequest-- Returns:
- Result of the GetGremlinQueryStatus operation returned by the service.
- See Also:
-
getGremlinQueryStatus
default GetGremlinQueryStatusResponse getGremlinQueryStatus(Consumer<GetGremlinQueryStatusRequest.Builder> getGremlinQueryStatusRequest) throws BadRequestException, InvalidParameterException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ReadOnlyViolationException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaGetGremlinQueryStatusRequest.builder()- Parameters:
getGremlinQueryStatusRequest- AConsumerthat will call methods onGetGremlinQueryStatusRequest.Builderto create a request.- Returns:
- Result of the GetGremlinQueryStatus operation returned by the service.
- See Also:
-
getLoaderJobStatus
default GetLoaderJobStatusResponse getLoaderJobStatus(GetLoaderJobStatusRequest getLoaderJobStatusRequest) throws BadRequestException, InvalidParameterException, BulkLoadIdNotFoundException, ClientTimeoutException, LoadUrlAccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, InternalFailureException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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..
- Parameters:
getLoaderJobStatusRequest-- Returns:
- Result of the GetLoaderJobStatus operation returned by the service.
- See Also:
-
getLoaderJobStatus
default GetLoaderJobStatusResponse getLoaderJobStatus(Consumer<GetLoaderJobStatusRequest.Builder> getLoaderJobStatusRequest) throws BadRequestException, InvalidParameterException, BulkLoadIdNotFoundException, ClientTimeoutException, LoadUrlAccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, InternalFailureException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaGetLoaderJobStatusRequest.builder()- Parameters:
getLoaderJobStatusRequest- AConsumerthat will call methods onGetLoaderJobStatusRequest.Builderto create a request.- Returns:
- Result of the GetLoaderJobStatus operation returned by the service.
- See Also:
-
getMLDataProcessingJob
default GetMlDataProcessingJobResponse getMLDataProcessingJob(GetMlDataProcessingJobRequest getMlDataProcessingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Retrieves information about a specified data processing job. See The
dataprocessingcommand.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.
- Parameters:
getMlDataProcessingJobRequest-- Returns:
- Result of the GetMLDataProcessingJob operation returned by the service.
- See Also:
-
getMLDataProcessingJob
default GetMlDataProcessingJobResponse getMLDataProcessingJob(Consumer<GetMlDataProcessingJobRequest.Builder> getMlDataProcessingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Retrieves information about a specified data processing job. See The
dataprocessingcommand.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.Builderavoiding the need to create one manually viaGetMlDataProcessingJobRequest.builder()- Parameters:
getMlDataProcessingJobRequest- AConsumerthat will call methods onGetMlDataProcessingJobRequest.Builderto create a request.- Returns:
- Result of the GetMLDataProcessingJob operation returned by the service.
- See Also:
-
getMLEndpoint
default GetMlEndpointResponse getMLEndpoint(GetMlEndpointRequest getMlEndpointRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
getMlEndpointRequest-- Returns:
- Result of the GetMLEndpoint operation returned by the service.
- See Also:
-
getMLEndpoint
default GetMlEndpointResponse getMLEndpoint(Consumer<GetMlEndpointRequest.Builder> getMlEndpointRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaGetMlEndpointRequest.builder()- Parameters:
getMlEndpointRequest- AConsumerthat will call methods onGetMlEndpointRequest.Builderto create a request.- Returns:
- Result of the GetMLEndpoint operation returned by the service.
- See Also:
-
getMLModelTrainingJob
default GetMlModelTrainingJobResponse getMLModelTrainingJob(GetMlModelTrainingJobRequest getMlModelTrainingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Retrieves information about a Neptune ML model training job. See Model training using the
modeltrainingcommand.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.
- Parameters:
getMlModelTrainingJobRequest-- Returns:
- Result of the GetMLModelTrainingJob operation returned by the service.
- See Also:
-
getMLModelTrainingJob
default GetMlModelTrainingJobResponse getMLModelTrainingJob(Consumer<GetMlModelTrainingJobRequest.Builder> getMlModelTrainingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Retrieves information about a Neptune ML model training job. See Model training using the
modeltrainingcommand.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.Builderavoiding the need to create one manually viaGetMlModelTrainingJobRequest.builder()- Parameters:
getMlModelTrainingJobRequest- AConsumerthat will call methods onGetMlModelTrainingJobRequest.Builderto create a request.- Returns:
- Result of the GetMLModelTrainingJob operation returned by the service.
- See Also:
-
getMLModelTransformJob
default GetMlModelTransformJobResponse getMLModelTransformJob(GetMlModelTransformJobRequest getMlModelTransformJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
getMlModelTransformJobRequest-- Returns:
- Result of the GetMLModelTransformJob operation returned by the service.
- See Also:
-
getMLModelTransformJob
default GetMlModelTransformJobResponse getMLModelTransformJob(Consumer<GetMlModelTransformJobRequest.Builder> getMlModelTransformJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaGetMlModelTransformJobRequest.builder()- Parameters:
getMlModelTransformJobRequest- AConsumerthat will call methods onGetMlModelTransformJobRequest.Builderto create a request.- Returns:
- Result of the GetMLModelTransformJob operation returned by the service.
- See Also:
-
getOpenCypherQueryStatus
default GetOpenCypherQueryStatusResponse getOpenCypherQueryStatus(GetOpenCypherQueryStatusRequest getOpenCypherQueryStatusRequest) throws InvalidNumericDataException, BadRequestException, InvalidParameterException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ReadOnlyViolationException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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).
- Parameters:
getOpenCypherQueryStatusRequest-- Returns:
- Result of the GetOpenCypherQueryStatus operation returned by the service.
- See Also:
-
getOpenCypherQueryStatus
default GetOpenCypherQueryStatusResponse getOpenCypherQueryStatus(Consumer<GetOpenCypherQueryStatusRequest.Builder> getOpenCypherQueryStatusRequest) throws InvalidNumericDataException, BadRequestException, InvalidParameterException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ReadOnlyViolationException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaGetOpenCypherQueryStatusRequest.builder()- Parameters:
getOpenCypherQueryStatusRequest- AConsumerthat will call methods onGetOpenCypherQueryStatusRequest.Builderto create a request.- Returns:
- Result of the GetOpenCypherQueryStatus operation returned by the service.
- See Also:
-
getPropertygraphStatistics
default GetPropertygraphStatisticsResponse getPropertygraphStatistics(GetPropertygraphStatisticsRequest getPropertygraphStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
getPropertygraphStatisticsRequest-- Returns:
- Result of the GetPropertygraphStatistics operation returned by the service.
- See Also:
-
getPropertygraphStatistics
default GetPropertygraphStatisticsResponse getPropertygraphStatistics(Consumer<GetPropertygraphStatisticsRequest.Builder> getPropertygraphStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaGetPropertygraphStatisticsRequest.builder()- Parameters:
getPropertygraphStatisticsRequest- AConsumerthat will call methods onGetPropertygraphStatisticsRequest.Builderto create a request.- Returns:
- Result of the GetPropertygraphStatistics operation returned by the service.
- See Also:
-
getPropertygraphStream
default GetPropertygraphStreamResponse getPropertygraphStream(GetPropertygraphStreamRequest getPropertygraphStreamRequest) throws UnsupportedOperationException, ExpiredStreamException, InvalidParameterException, MemoryLimitExceededException, StreamRecordsNotFoundException, ClientTimeoutException, PreconditionsFailedException, ThrottlingException, ConstraintViolationException, InvalidArgumentException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
GetPropertygraphStreamlets 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).
- Parameters:
getPropertygraphStreamRequest-- Returns:
- Result of the GetPropertygraphStream operation returned by the service.
- See Also:
-
getPropertygraphStream
default GetPropertygraphStreamResponse getPropertygraphStream(Consumer<GetPropertygraphStreamRequest.Builder> getPropertygraphStreamRequest) throws UnsupportedOperationException, ExpiredStreamException, InvalidParameterException, MemoryLimitExceededException, StreamRecordsNotFoundException, ClientTimeoutException, PreconditionsFailedException, ThrottlingException, ConstraintViolationException, InvalidArgumentException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
GetPropertygraphStreamlets 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.Builderavoiding the need to create one manually viaGetPropertygraphStreamRequest.builder()- Parameters:
getPropertygraphStreamRequest- AConsumerthat will call methods onGetPropertygraphStreamRequest.Builderto create a request.- Returns:
- Result of the GetPropertygraphStream operation returned by the service.
- See Also:
-
getPropertygraphSummary
default GetPropertygraphSummaryResponse getPropertygraphSummary(GetPropertygraphSummaryRequest getPropertygraphSummaryRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
getPropertygraphSummaryRequest-- Returns:
- Result of the GetPropertygraphSummary operation returned by the service.
- See Also:
-
getPropertygraphSummary
default GetPropertygraphSummaryResponse getPropertygraphSummary(Consumer<GetPropertygraphSummaryRequest.Builder> getPropertygraphSummaryRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaGetPropertygraphSummaryRequest.builder()- Parameters:
getPropertygraphSummaryRequest- AConsumerthat will call methods onGetPropertygraphSummaryRequest.Builderto create a request.- Returns:
- Result of the GetPropertygraphSummary operation returned by the service.
- See Also:
-
getRDFGraphSummary
default GetRdfGraphSummaryResponse getRDFGraphSummary(GetRdfGraphSummaryRequest getRdfGraphSummaryRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
getRdfGraphSummaryRequest-- Returns:
- Result of the GetRDFGraphSummary operation returned by the service.
- See Also:
-
getRDFGraphSummary
default GetRdfGraphSummaryResponse getRDFGraphSummary(Consumer<GetRdfGraphSummaryRequest.Builder> getRdfGraphSummaryRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaGetRdfGraphSummaryRequest.builder()- Parameters:
getRdfGraphSummaryRequest- AConsumerthat will call methods onGetRdfGraphSummaryRequest.Builderto create a request.- Returns:
- Result of the GetRDFGraphSummary operation returned by the service.
- See Also:
-
getSparqlStatistics
default GetSparqlStatisticsResponse getSparqlStatistics(GetSparqlStatisticsRequest getSparqlStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException Gets RDF statistics (SPARQL).
- Parameters:
getSparqlStatisticsRequest-- Returns:
- Result of the GetSparqlStatistics operation returned by the service.
- See Also:
-
getSparqlStatistics
default GetSparqlStatisticsResponse getSparqlStatistics(Consumer<GetSparqlStatisticsRequest.Builder> getSparqlStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException Gets RDF statistics (SPARQL).
This is a convenience which creates an instance of the
GetSparqlStatisticsRequest.Builderavoiding the need to create one manually viaGetSparqlStatisticsRequest.builder()- Parameters:
getSparqlStatisticsRequest- AConsumerthat will call methods onGetSparqlStatisticsRequest.Builderto create a request.- Returns:
- Result of the GetSparqlStatistics operation returned by the service.
- See Also:
-
getSparqlStream
default GetSparqlStreamResponse getSparqlStream(GetSparqlStreamRequest getSparqlStreamRequest) throws UnsupportedOperationException, ExpiredStreamException, InvalidParameterException, MemoryLimitExceededException, StreamRecordsNotFoundException, ClientTimeoutException, PreconditionsFailedException, ThrottlingException, ConstraintViolationException, InvalidArgumentException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
GetSparqlStreamlets 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).
- Parameters:
getSparqlStreamRequest-- Returns:
- Result of the GetSparqlStream operation returned by the service.
- See Also:
-
getSparqlStream
default GetSparqlStreamResponse getSparqlStream(Consumer<GetSparqlStreamRequest.Builder> getSparqlStreamRequest) throws UnsupportedOperationException, ExpiredStreamException, InvalidParameterException, MemoryLimitExceededException, StreamRecordsNotFoundException, ClientTimeoutException, PreconditionsFailedException, ThrottlingException, ConstraintViolationException, InvalidArgumentException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
GetSparqlStreamlets 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.Builderavoiding the need to create one manually viaGetSparqlStreamRequest.builder()- Parameters:
getSparqlStreamRequest- AConsumerthat will call methods onGetSparqlStreamRequest.Builderto create a request.- Returns:
- Result of the GetSparqlStream operation returned by the service.
- See Also:
-
listGremlinQueries
default ListGremlinQueriesResponse listGremlinQueries(ListGremlinQueriesRequest listGremlinQueriesRequest) throws BadRequestException, InvalidParameterException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ReadOnlyViolationException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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).
- Parameters:
listGremlinQueriesRequest-- Returns:
- Result of the ListGremlinQueries operation returned by the service.
- See Also:
-
listGremlinQueries
default ListGremlinQueriesResponse listGremlinQueries(Consumer<ListGremlinQueriesRequest.Builder> listGremlinQueriesRequest) throws BadRequestException, InvalidParameterException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ReadOnlyViolationException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaListGremlinQueriesRequest.builder()- Parameters:
listGremlinQueriesRequest- AConsumerthat will call methods onListGremlinQueriesRequest.Builderto create a request.- Returns:
- Result of the ListGremlinQueries operation returned by the service.
- See Also:
-
listLoaderJobs
default ListLoaderJobsResponse listLoaderJobs(ListLoaderJobsRequest listLoaderJobsRequest) throws UnsupportedOperationException, BadRequestException, InvalidParameterException, BulkLoadIdNotFoundException, InternalFailureException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, LoadUrlAccessDeniedException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Retrieves a list of the
loadIdsfor 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..
- Parameters:
listLoaderJobsRequest-- Returns:
- Result of the ListLoaderJobs operation returned by the service.
- See Also:
-
listLoaderJobs
default ListLoaderJobsResponse listLoaderJobs(Consumer<ListLoaderJobsRequest.Builder> listLoaderJobsRequest) throws UnsupportedOperationException, BadRequestException, InvalidParameterException, BulkLoadIdNotFoundException, InternalFailureException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, LoadUrlAccessDeniedException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Retrieves a list of the
loadIdsfor 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.Builderavoiding the need to create one manually viaListLoaderJobsRequest.builder()- Parameters:
listLoaderJobsRequest- AConsumerthat will call methods onListLoaderJobsRequest.Builderto create a request.- Returns:
- Result of the ListLoaderJobs operation returned by the service.
- See Also:
-
listMLDataProcessingJobs
default ListMlDataProcessingJobsResponse listMLDataProcessingJobs(ListMlDataProcessingJobsRequest listMlDataProcessingJobsRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
listMlDataProcessingJobsRequest-- Returns:
- Result of the ListMLDataProcessingJobs operation returned by the service.
- See Also:
-
listMLDataProcessingJobs
default ListMlDataProcessingJobsResponse listMLDataProcessingJobs(Consumer<ListMlDataProcessingJobsRequest.Builder> listMlDataProcessingJobsRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaListMlDataProcessingJobsRequest.builder()- Parameters:
listMlDataProcessingJobsRequest- AConsumerthat will call methods onListMlDataProcessingJobsRequest.Builderto create a request.- Returns:
- Result of the ListMLDataProcessingJobs operation returned by the service.
- See Also:
-
listMLEndpoints
default ListMlEndpointsResponse listMLEndpoints(ListMlEndpointsRequest listMlEndpointsRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
listMlEndpointsRequest-- Returns:
- Result of the ListMLEndpoints operation returned by the service.
- See Also:
-
listMLEndpoints
default ListMlEndpointsResponse listMLEndpoints(Consumer<ListMlEndpointsRequest.Builder> listMlEndpointsRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaListMlEndpointsRequest.builder()- Parameters:
listMlEndpointsRequest- AConsumerthat will call methods onListMlEndpointsRequest.Builderto create a request.- Returns:
- Result of the ListMLEndpoints operation returned by the service.
- See Also:
-
listMLModelTrainingJobs
default ListMlModelTrainingJobsResponse listMLModelTrainingJobs(ListMlModelTrainingJobsRequest listMlModelTrainingJobsRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Lists Neptune ML model-training jobs. See Model training using the
modeltrainingcommand.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.
- Parameters:
listMlModelTrainingJobsRequest-- Returns:
- Result of the ListMLModelTrainingJobs operation returned by the service.
- See Also:
-
listMLModelTrainingJobs
default ListMlModelTrainingJobsResponse listMLModelTrainingJobs(Consumer<ListMlModelTrainingJobsRequest.Builder> listMlModelTrainingJobsRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Lists Neptune ML model-training jobs. See Model training using the
modeltrainingcommand.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.Builderavoiding the need to create one manually viaListMlModelTrainingJobsRequest.builder()- Parameters:
listMlModelTrainingJobsRequest- AConsumerthat will call methods onListMlModelTrainingJobsRequest.Builderto create a request.- Returns:
- Result of the ListMLModelTrainingJobs operation returned by the service.
- See Also:
-
listMLModelTransformJobs
default ListMlModelTransformJobsResponse listMLModelTransformJobs(ListMlModelTransformJobsRequest listMlModelTransformJobsRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
listMlModelTransformJobsRequest-- Returns:
- Result of the ListMLModelTransformJobs operation returned by the service.
- See Also:
-
listMLModelTransformJobs
default ListMlModelTransformJobsResponse listMLModelTransformJobs(Consumer<ListMlModelTransformJobsRequest.Builder> listMlModelTransformJobsRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaListMlModelTransformJobsRequest.builder()- Parameters:
listMlModelTransformJobsRequest- AConsumerthat will call methods onListMlModelTransformJobsRequest.Builderto create a request.- Returns:
- Result of the ListMLModelTransformJobs operation returned by the service.
- See Also:
-
listOpenCypherQueries
default ListOpenCypherQueriesResponse listOpenCypherQueries(ListOpenCypherQueriesRequest listOpenCypherQueriesRequest) throws InvalidNumericDataException, BadRequestException, InvalidParameterException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ReadOnlyViolationException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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).
- Parameters:
listOpenCypherQueriesRequest-- Returns:
- Result of the ListOpenCypherQueries operation returned by the service.
- See Also:
-
listOpenCypherQueries
default ListOpenCypherQueriesResponse listOpenCypherQueries(Consumer<ListOpenCypherQueriesRequest.Builder> listOpenCypherQueriesRequest) throws InvalidNumericDataException, BadRequestException, InvalidParameterException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, FailureByQueryException, PreconditionsFailedException, ParsingException, ReadOnlyViolationException, ConstraintViolationException, TimeLimitExceededException, InvalidArgumentException, ConcurrentModificationException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaListOpenCypherQueriesRequest.builder()- Parameters:
listOpenCypherQueriesRequest- AConsumerthat will call methods onListOpenCypherQueriesRequest.Builderto create a request.- Returns:
- Result of the ListOpenCypherQueries operation returned by the service.
- See Also:
-
managePropertygraphStatistics
default ManagePropertygraphStatisticsResponse managePropertygraphStatistics(ManagePropertygraphStatisticsRequest managePropertygraphStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
managePropertygraphStatisticsRequest-- Returns:
- Result of the ManagePropertygraphStatistics operation returned by the service.
- See Also:
-
managePropertygraphStatistics
default ManagePropertygraphStatisticsResponse managePropertygraphStatistics(Consumer<ManagePropertygraphStatisticsRequest.Builder> managePropertygraphStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaManagePropertygraphStatisticsRequest.builder()- Parameters:
managePropertygraphStatisticsRequest- AConsumerthat will call methods onManagePropertygraphStatisticsRequest.Builderto create a request.- Returns:
- Result of the ManagePropertygraphStatistics operation returned by the service.
- See Also:
-
manageSparqlStatistics
default ManageSparqlStatisticsResponse manageSparqlStatistics(ManageSparqlStatisticsRequest manageSparqlStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
manageSparqlStatisticsRequest-- Returns:
- Result of the ManageSparqlStatistics operation returned by the service.
- See Also:
-
manageSparqlStatistics
default ManageSparqlStatisticsResponse manageSparqlStatistics(Consumer<ManageSparqlStatisticsRequest.Builder> manageSparqlStatisticsRequest) throws BadRequestException, InvalidParameterException, StatisticsNotAvailableException, ClientTimeoutException, AccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, PreconditionsFailedException, ReadOnlyViolationException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaManageSparqlStatisticsRequest.builder()- Parameters:
manageSparqlStatisticsRequest- AConsumerthat will call methods onManageSparqlStatisticsRequest.Builderto create a request.- Returns:
- Result of the ManageSparqlStatistics operation returned by the service.
- See Also:
-
startLoaderJob
default StartLoaderJobResponse startLoaderJob(StartLoaderJobRequest startLoaderJobRequest) throws BadRequestException, InvalidParameterException, BulkLoadIdNotFoundException, ClientTimeoutException, LoadUrlAccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, InternalFailureException, S3Exception, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
startLoaderJobRequest-- Returns:
- Result of the StartLoaderJob operation returned by the service.
- See Also:
-
startLoaderJob
default StartLoaderJobResponse startLoaderJob(Consumer<StartLoaderJobRequest.Builder> startLoaderJobRequest) throws BadRequestException, InvalidParameterException, BulkLoadIdNotFoundException, ClientTimeoutException, LoadUrlAccessDeniedException, IllegalArgumentException, TooManyRequestsException, UnsupportedOperationException, InternalFailureException, S3Exception, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaStartLoaderJobRequest.builder()- Parameters:
startLoaderJobRequest- AConsumerthat will call methods onStartLoaderJobRequest.Builderto create a request.- Returns:
- Result of the StartLoaderJob operation returned by the service.
- See Also:
-
startMLDataProcessingJob
default StartMlDataProcessingJobResponse startMLDataProcessingJob(StartMlDataProcessingJobRequest startMlDataProcessingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training. See The
dataprocessingcommand.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.
- Parameters:
startMlDataProcessingJobRequest-- Returns:
- Result of the StartMLDataProcessingJob operation returned by the service.
- See Also:
-
startMLDataProcessingJob
default StartMlDataProcessingJobResponse startMLDataProcessingJob(Consumer<StartMlDataProcessingJobRequest.Builder> startMlDataProcessingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training. See The
dataprocessingcommand.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.Builderavoiding the need to create one manually viaStartMlDataProcessingJobRequest.builder()- Parameters:
startMlDataProcessingJobRequest- AConsumerthat will call methods onStartMlDataProcessingJobRequest.Builderto create a request.- Returns:
- Result of the StartMLDataProcessingJob operation returned by the service.
- See Also:
-
startMLModelTrainingJob
default StartMlModelTrainingJobResponse startMLModelTrainingJob(StartMlModelTrainingJobRequest startMlModelTrainingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Creates a new Neptune ML model training job. See Model training using the
modeltrainingcommand.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.
- Parameters:
startMlModelTrainingJobRequest-- Returns:
- Result of the StartMLModelTrainingJob operation returned by the service.
- See Also:
-
startMLModelTrainingJob
default StartMlModelTrainingJobResponse startMLModelTrainingJob(Consumer<StartMlModelTrainingJobRequest.Builder> startMlModelTrainingJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException Creates a new Neptune ML model training job. See Model training using the
modeltrainingcommand.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.Builderavoiding the need to create one manually viaStartMlModelTrainingJobRequest.builder()- Parameters:
startMlModelTrainingJobRequest- AConsumerthat will call methods onStartMlModelTrainingJobRequest.Builderto create a request.- Returns:
- Result of the StartMLModelTrainingJob operation returned by the service.
- See Also:
-
startMLModelTransformJob
default StartMlModelTransformJobResponse startMLModelTransformJob(StartMlModelTransformJobRequest startMlModelTransformJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.
- Parameters:
startMlModelTransformJobRequest-- Returns:
- Result of the StartMLModelTransformJob operation returned by the service.
- See Also:
-
startMLModelTransformJob
default StartMlModelTransformJobResponse startMLModelTransformJob(Consumer<StartMlModelTransformJobRequest.Builder> startMlModelTransformJobRequest) throws UnsupportedOperationException, BadRequestException, MlResourceNotFoundException, InvalidParameterException, ClientTimeoutException, PreconditionsFailedException, ConstraintViolationException, InvalidArgumentException, MissingParameterException, IllegalArgumentException, TooManyRequestsException, AwsServiceException, SdkClientException, NeptunedataException 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.Builderavoiding the need to create one manually viaStartMlModelTransformJobRequest.builder()- Parameters:
startMlModelTransformJobRequest- AConsumerthat will call methods onStartMlModelTransformJobRequest.Builderto create a request.- Returns:
- Result of the StartMLModelTransformJob operation returned by the service.
- See Also:
-
create
Create aNeptunedataClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aNeptunedataClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-