@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonNeptunedata
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonNeptunedata
instead.
The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data operations, including data loading, query execution, data inquiry, and machine learning. It supports the Gremlin and openCypher query languages, and is available in all SDK languages. It automatically signs API requests and greatly simplifies integrating Neptune into your applications.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CancelGremlinQueryResult |
cancelGremlinQuery(CancelGremlinQueryRequest cancelGremlinQueryRequest)
Cancels a Gremlin query.
|
CancelLoaderJobResult |
cancelLoaderJob(CancelLoaderJobRequest cancelLoaderJobRequest)
Cancels a specified load job.
|
CancelMLDataProcessingJobResult |
cancelMLDataProcessingJob(CancelMLDataProcessingJobRequest cancelMLDataProcessingJobRequest)
Cancels a Neptune ML data processing job.
|
CancelMLModelTrainingJobResult |
cancelMLModelTrainingJob(CancelMLModelTrainingJobRequest cancelMLModelTrainingJobRequest)
Cancels a Neptune ML model training job.
|
CancelMLModelTransformJobResult |
cancelMLModelTransformJob(CancelMLModelTransformJobRequest cancelMLModelTransformJobRequest)
Cancels a specified model transform job.
|
CancelOpenCypherQueryResult |
cancelOpenCypherQuery(CancelOpenCypherQueryRequest cancelOpenCypherQueryRequest)
Cancels a specified openCypher query.
|
CreateMLEndpointResult |
createMLEndpoint(CreateMLEndpointRequest createMLEndpointRequest)
Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training
process constructed.
|
DeleteMLEndpointResult |
deleteMLEndpoint(DeleteMLEndpointRequest deleteMLEndpointRequest)
Cancels the creation of a Neptune ML inference endpoint.
|
DeletePropertygraphStatisticsResult |
deletePropertygraphStatistics(DeletePropertygraphStatisticsRequest deletePropertygraphStatisticsRequest)
Deletes statistics for Gremlin and openCypher (property graph) data.
|
DeleteSparqlStatisticsResult |
deleteSparqlStatistics(DeleteSparqlStatisticsRequest deleteSparqlStatisticsRequest)
Deletes SPARQL statistics
|
ExecuteFastResetResult |
executeFastReset(ExecuteFastResetRequest executeFastResetRequest)
The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.
|
ExecuteGremlinExplainQueryResult |
executeGremlinExplainQuery(ExecuteGremlinExplainQueryRequest executeGremlinExplainQueryRequest)
Executes a Gremlin Explain query.
|
ExecuteGremlinProfileQueryResult |
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.
|
ExecuteGremlinQueryResult |
executeGremlinQuery(ExecuteGremlinQueryRequest executeGremlinQueryRequest)
This commands executes a Gremlin query.
|
ExecuteOpenCypherExplainQueryResult |
executeOpenCypherExplainQuery(ExecuteOpenCypherExplainQueryRequest executeOpenCypherExplainQueryRequest)
Executes an openCypher
explain request. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEngineStatusResult |
getEngineStatus(GetEngineStatusRequest getEngineStatusRequest)
Retrieves the status of the graph database on the host.
|
GetGremlinQueryStatusResult |
getGremlinQueryStatus(GetGremlinQueryStatusRequest getGremlinQueryStatusRequest)
Gets the status of a specified Gremlin query.
|
GetMLDataProcessingJobResult |
getMLDataProcessingJob(GetMLDataProcessingJobRequest getMLDataProcessingJobRequest)
Retrieves information about a specified data processing job.
|
GetMLEndpointResult |
getMLEndpoint(GetMLEndpointRequest getMLEndpointRequest)
Retrieves details about an inference endpoint.
|
GetMLModelTrainingJobResult |
getMLModelTrainingJob(GetMLModelTrainingJobRequest getMLModelTrainingJobRequest)
Retrieves information about a Neptune ML model training job.
|
GetMLModelTransformJobResult |
getMLModelTransformJob(GetMLModelTransformJobRequest getMLModelTransformJobRequest)
Gets information about a specified model transform job.
|
GetOpenCypherQueryStatusResult |
getOpenCypherQueryStatus(GetOpenCypherQueryStatusRequest getOpenCypherQueryStatusRequest)
Retrieves the status of a specified openCypher query.
|
GetPropertygraphStatisticsResult |
getPropertygraphStatistics(GetPropertygraphStatisticsRequest getPropertygraphStatisticsRequest)
Gets property graph statistics (Gremlin and openCypher).
|
GetPropertygraphSummaryResult |
getPropertygraphSummary(GetPropertygraphSummaryRequest getPropertygraphSummaryRequest)
Gets a graph summary for a property graph.
|
GetRDFGraphSummaryResult |
getRDFGraphSummary(GetRDFGraphSummaryRequest getRDFGraphSummaryRequest)
Gets a graph summary for an RDF graph.
|
GetSparqlStatisticsResult |
getSparqlStatistics(GetSparqlStatisticsRequest getSparqlStatisticsRequest)
Gets RDF statistics (SPARQL).
|
GetSparqlStreamResult |
getSparqlStream(GetSparqlStreamRequest getSparqlStreamRequest)
Gets a stream for an RDF graph.
|
ListGremlinQueriesResult |
listGremlinQueries(ListGremlinQueriesRequest listGremlinQueriesRequest)
Lists active Gremlin queries.
|
ListLoaderJobsResult |
listLoaderJobs(ListLoaderJobsRequest listLoaderJobsRequest)
Retrieves a list of the
loadIds for all active loader jobs. |
ListMLDataProcessingJobsResult |
listMLDataProcessingJobs(ListMLDataProcessingJobsRequest listMLDataProcessingJobsRequest)
Returns a list of Neptune ML data processing jobs.
|
ListMLEndpointsResult |
listMLEndpoints(ListMLEndpointsRequest listMLEndpointsRequest)
Lists existing inference endpoints.
|
ListMLModelTrainingJobsResult |
listMLModelTrainingJobs(ListMLModelTrainingJobsRequest listMLModelTrainingJobsRequest)
Lists Neptune ML model-training jobs.
|
ListMLModelTransformJobsResult |
listMLModelTransformJobs(ListMLModelTransformJobsRequest listMLModelTransformJobsRequest)
Returns a list of model transform job IDs.
|
ListOpenCypherQueriesResult |
listOpenCypherQueries(ListOpenCypherQueriesRequest listOpenCypherQueriesRequest)
Lists active openCypher queries.
|
ManagePropertygraphStatisticsResult |
managePropertygraphStatistics(ManagePropertygraphStatisticsRequest managePropertygraphStatisticsRequest)
Manages the generation and use of property graph statistics.
|
ManageSparqlStatisticsResult |
manageSparqlStatistics(ManageSparqlStatisticsRequest manageSparqlStatisticsRequest)
Manages the generation and use of RDF graph statistics.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartLoaderJobResult |
startLoaderJob(StartLoaderJobRequest startLoaderJobRequest)
Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance.
|
StartMLDataProcessingJobResult |
startMLDataProcessingJob(StartMLDataProcessingJobRequest startMLDataProcessingJobRequest)
Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training.
|
StartMLModelTrainingJobResult |
startMLModelTrainingJob(StartMLModelTrainingJobRequest startMLModelTrainingJobRequest)
Creates a new Neptune ML model training job.
|
StartMLModelTransformJobResult |
startMLModelTransformJob(StartMLModelTransformJobRequest startMLModelTransformJobRequest)
Creates a new model transform job.
|
static final String ENDPOINT_PREFIX
CancelGremlinQueryResult cancelGremlinQuery(CancelGremlinQueryRequest cancelGremlinQueryRequest)
Cancels a Gremlin query. See Gremlin query cancellation for more information.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelQuery IAM action in that cluster.
cancelGremlinQueryRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.FailureByQueryException
- Raised when a request fails.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ParsingException
- Raised when a parsing issue is encountered.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.TimeLimitExceededException
- Raised when the an operation exceeds the time limit allowed for it.InvalidArgumentException
- Raised when an argument in a request has an invalid value.ConcurrentModificationException
- Raised when a request attempts to modify data that is concurrently being modified by another process.MissingParameterException
- Raised when a required parameter is missing.CancelLoaderJobResult cancelLoaderJob(CancelLoaderJobRequest cancelLoaderJobRequest)
Cancels a specified load job. This is an HTTP DELETE
request. See Neptune Loader
Get-Status API for more information.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelLoaderJob IAM action in that cluster..
cancelLoaderJobRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.BulkLoadIdNotFoundException
- Raised when a specified bulk-load job ID cannot be found.ClientTimeoutException
- Raised when a request timed out in the client.LoadUrlAccessDeniedException
- Raised when access is denied to a specified load URL.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.InternalFailureException
- Raised when the processing of the request failed unexpectedly.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.CancelMLDataProcessingJobResult cancelMLDataProcessingJob(CancelMLDataProcessingJobRequest cancelMLDataProcessingJobRequest)
Cancels a Neptune ML data processing job. See The
dataprocessing
command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLDataProcessingJob IAM action in that cluster.
cancelMLDataProcessingJobRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.CancelMLModelTrainingJobResult cancelMLModelTrainingJob(CancelMLModelTrainingJobRequest cancelMLModelTrainingJobRequest)
Cancels a Neptune ML model training job. See Model
training using the modeltraining
command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLModelTrainingJob IAM action in that cluster.
cancelMLModelTrainingJobRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.CancelMLModelTransformJobResult cancelMLModelTransformJob(CancelMLModelTransformJobRequest cancelMLModelTransformJobRequest)
Cancels a specified model transform job. See Use a trained model to generate new model artifacts.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLModelTransformJob IAM action in that cluster.
cancelMLModelTransformJobRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.CancelOpenCypherQueryResult cancelOpenCypherQuery(CancelOpenCypherQueryRequest cancelOpenCypherQueryRequest)
Cancels a specified openCypher query. See Neptune openCypher status endpoint for more information.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelQuery IAM action in that cluster.
cancelOpenCypherQueryRequest
- InvalidNumericDataException
- Raised when invalid numerical data is encountered when servicing a request.BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.FailureByQueryException
- Raised when a request fails.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ParsingException
- Raised when a parsing issue is encountered.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.TimeLimitExceededException
- Raised when the an operation exceeds the time limit allowed for it.InvalidArgumentException
- Raised when an argument in a request has an invalid value.ConcurrentModificationException
- Raised when a request attempts to modify data that is concurrently being modified by another process.MissingParameterException
- Raised when a required parameter is missing.CreateMLEndpointResult createMLEndpoint(CreateMLEndpointRequest createMLEndpointRequest)
Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed. See Managing inference endpoints using the endpoints command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CreateMLEndpoint IAM action in that cluster.
createMLEndpointRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.DeleteMLEndpointResult deleteMLEndpoint(DeleteMLEndpointRequest deleteMLEndpointRequest)
Cancels the creation of a Neptune ML inference endpoint. See Managing inference endpoints using the endpoints command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteMLEndpoint IAM action in that cluster.
deleteMLEndpointRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.DeletePropertygraphStatisticsResult deletePropertygraphStatistics(DeletePropertygraphStatisticsRequest deletePropertygraphStatisticsRequest)
Deletes statistics for Gremlin and openCypher (property graph) data.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteStatistics IAM action in that cluster.
deletePropertygraphStatisticsRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.StatisticsNotAvailableException
- Raised when statistics needed to satisfy a request are not available.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.DeleteSparqlStatisticsResult deleteSparqlStatistics(DeleteSparqlStatisticsRequest deleteSparqlStatisticsRequest)
Deletes SPARQL statistics
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteStatistics IAM action in that cluster.
deleteSparqlStatisticsRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.StatisticsNotAvailableException
- Raised when statistics needed to satisfy a request are not available.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.ExecuteFastResetResult executeFastReset(ExecuteFastResetRequest executeFastResetRequest)
The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.
Neptune fast reset is a two-step process. First you call ExecuteFastReset
with action
set to initiateDatabaseReset
. This returns a UUID token which you then include when calling
ExecuteFastReset
again with action
set to performDatabaseReset
. See Empty an Amazon
Neptune DB cluster using the fast reset API.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ResetDatabase IAM action in that cluster.
executeFastResetRequest
- InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.ServerShutdownException
- Raised when the server shuts down while processing a request.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.MethodNotAllowedException
- Raised when the HTTP method used by a request is not supported by the endpoint being used.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.ExecuteGremlinExplainQueryResult executeGremlinExplainQuery(ExecuteGremlinExplainQueryRequest executeGremlinExplainQueryRequest)
Executes a Gremlin Explain query.
Amazon Neptune has added a Gremlin feature named explain
that provides is a self-service tool for
understanding the execution approach being taken by the Neptune engine for the query. You invoke it by adding an
explain
parameter to an HTTP call that submits a Gremlin query.
The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tune your query, as explained in Tuning Gremlin queries. You can also use query hints to improve query execution plans.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:
Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).
executeGremlinExplainQueryRequest
- QueryTooLargeException
- Raised when the body of a query is too large.BadRequestException
- Raised when a request is submitted that cannot be processed.QueryLimitExceededException
- Raised when the number of active queries exceeds what the server can process. The query in question can
be retried when the system is less busy.InvalidParameterException
- Raised when a parameter value is not valid.QueryLimitException
- Raised when the size of a query exceeds the system limit.ClientTimeoutException
- Raised when a request timed out in the client.CancelledByUserException
- Raised when a user cancelled a request.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.FailureByQueryException
- Raised when a request fails.MemoryLimitExceededException
- Raised when a request fails because of insufficient memory resources. The request can be retried.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.MalformedQueryException
- Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.ParsingException
- Raised when a parsing issue is encountered.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.TimeLimitExceededException
- Raised when the an operation exceeds the time limit allowed for it.InvalidArgumentException
- Raised when an argument in a request has an invalid value.ConcurrentModificationException
- Raised when a request attempts to modify data that is concurrently being modified by another process.MissingParameterException
- Raised when a required parameter is missing.ExecuteGremlinProfileQueryResult executeGremlinProfileQuery(ExecuteGremlinProfileQueryRequest executeGremlinProfileQueryRequest)
Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See Gremlin profile API in Neptune for details.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster.
Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).
executeGremlinProfileQueryRequest
- QueryTooLargeException
- Raised when the body of a query is too large.BadRequestException
- Raised when a request is submitted that cannot be processed.QueryLimitExceededException
- Raised when the number of active queries exceeds what the server can process. The query in question can
be retried when the system is less busy.InvalidParameterException
- Raised when a parameter value is not valid.QueryLimitException
- Raised when the size of a query exceeds the system limit.ClientTimeoutException
- Raised when a request timed out in the client.CancelledByUserException
- Raised when a user cancelled a request.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.FailureByQueryException
- Raised when a request fails.MemoryLimitExceededException
- Raised when a request fails because of insufficient memory resources. The request can be retried.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.MalformedQueryException
- Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.ParsingException
- Raised when a parsing issue is encountered.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.TimeLimitExceededException
- Raised when the an operation exceeds the time limit allowed for it.InvalidArgumentException
- Raised when an argument in a request has an invalid value.ConcurrentModificationException
- Raised when a request attempts to modify data that is concurrently being modified by another process.MissingParameterException
- Raised when a required parameter is missing.ExecuteGremlinQueryResult executeGremlinQuery(ExecuteGremlinQueryRequest executeGremlinQueryRequest)
This commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under The Graph in the Apache TinkerPop3 documentation. More details can also be found in Accessing a Neptune graph with Gremlin.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the following IAM actions in that cluster, depending on the query:
Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).
executeGremlinQueryRequest
- QueryTooLargeException
- Raised when the body of a query is too large.BadRequestException
- Raised when a request is submitted that cannot be processed.QueryLimitExceededException
- Raised when the number of active queries exceeds what the server can process. The query in question can
be retried when the system is less busy.InvalidParameterException
- Raised when a parameter value is not valid.QueryLimitException
- Raised when the size of a query exceeds the system limit.ClientTimeoutException
- Raised when a request timed out in the client.CancelledByUserException
- Raised when a user cancelled a request.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.FailureByQueryException
- Raised when a request fails.MemoryLimitExceededException
- Raised when a request fails because of insufficient memory resources. The request can be retried.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.MalformedQueryException
- Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.ParsingException
- Raised when a parsing issue is encountered.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.TimeLimitExceededException
- Raised when the an operation exceeds the time limit allowed for it.InvalidArgumentException
- Raised when an argument in a request has an invalid value.ConcurrentModificationException
- Raised when a request attempts to modify data that is concurrently being modified by another process.MissingParameterException
- Raised when a required parameter is missing.ExecuteOpenCypherExplainQueryResult executeOpenCypherExplainQuery(ExecuteOpenCypherExplainQueryRequest executeOpenCypherExplainQueryRequest)
Executes an openCypher explain
request. See The openCypher
explain feature for more information.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster.
Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).
executeOpenCypherExplainQueryRequest
- QueryTooLargeException
- Raised when the body of a query is too large.InvalidNumericDataException
- Raised when invalid numerical data is encountered when servicing a request.BadRequestException
- Raised when a request is submitted that cannot be processed.QueryLimitExceededException
- Raised when the number of active queries exceeds what the server can process. The query in question can
be retried when the system is less busy.InvalidParameterException
- Raised when a parameter value is not valid.QueryLimitException
- Raised when the size of a query exceeds the system limit.ClientTimeoutException
- Raised when a request timed out in the client.CancelledByUserException
- Raised when a user cancelled a request.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.FailureByQueryException
- Raised when a request fails.MemoryLimitExceededException
- Raised when a request fails because of insufficient memory resources. The request can be retried.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.MalformedQueryException
- Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.ParsingException
- Raised when a parsing issue is encountered.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.TimeLimitExceededException
- Raised when the an operation exceeds the time limit allowed for it.InvalidArgumentException
- Raised when an argument in a request has an invalid value.ConcurrentModificationException
- Raised when a request attempts to modify data that is concurrently being modified by another process.MissingParameterException
- Raised when a required parameter is missing.GetEngineStatusResult getEngineStatus(GetEngineStatusRequest getEngineStatusRequest)
Retrieves the status of the graph database on the host.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetEngineStatus IAM action in that cluster.
getEngineStatusRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.InternalFailureException
- Raised when the processing of the request failed unexpectedly.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.GetGremlinQueryStatusResult getGremlinQueryStatus(GetGremlinQueryStatusRequest getGremlinQueryStatusRequest)
Gets the status of a specified Gremlin query.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.
Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).
getGremlinQueryStatusRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.FailureByQueryException
- Raised when a request fails.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ParsingException
- Raised when a parsing issue is encountered.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.TimeLimitExceededException
- Raised when the an operation exceeds the time limit allowed for it.InvalidArgumentException
- Raised when an argument in a request has an invalid value.ConcurrentModificationException
- Raised when a request attempts to modify data that is concurrently being modified by another process.MissingParameterException
- Raised when a required parameter is missing.GetMLDataProcessingJobResult getMLDataProcessingJob(GetMLDataProcessingJobRequest getMLDataProcessingJobRequest)
Retrieves information about a specified data processing job. See The
dataprocessing
command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:neptune-db:GetMLDataProcessingJobStatus IAM action in that cluster.
getMLDataProcessingJobRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.GetMLEndpointResult getMLEndpoint(GetMLEndpointRequest getMLEndpointRequest)
Retrieves details about an inference endpoint. See Managing inference endpoints using the endpoints command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetMLEndpointStatus IAM action in that cluster.
getMLEndpointRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.GetMLModelTrainingJobResult getMLModelTrainingJob(GetMLModelTrainingJobRequest getMLModelTrainingJobRequest)
Retrieves information about a Neptune ML model training job. See Model
training using the modeltraining
command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetMLModelTrainingJobStatus IAM action in that cluster.
getMLModelTrainingJobRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.GetMLModelTransformJobResult getMLModelTransformJob(GetMLModelTransformJobRequest getMLModelTransformJobRequest)
Gets information about a specified model transform job. See Use a trained model to generate new model artifacts.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetMLModelTransformJobStatus IAM action in that cluster.
getMLModelTransformJobRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.GetOpenCypherQueryStatusResult getOpenCypherQueryStatus(GetOpenCypherQueryStatusRequest getOpenCypherQueryStatusRequest)
Retrieves the status of a specified openCypher query.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.
Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).
getOpenCypherQueryStatusRequest
- InvalidNumericDataException
- Raised when invalid numerical data is encountered when servicing a request.BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.FailureByQueryException
- Raised when a request fails.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ParsingException
- Raised when a parsing issue is encountered.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.TimeLimitExceededException
- Raised when the an operation exceeds the time limit allowed for it.InvalidArgumentException
- Raised when an argument in a request has an invalid value.ConcurrentModificationException
- Raised when a request attempts to modify data that is concurrently being modified by another process.MissingParameterException
- Raised when a required parameter is missing.GetPropertygraphStatisticsResult getPropertygraphStatistics(GetPropertygraphStatisticsRequest getPropertygraphStatisticsRequest)
Gets property graph statistics (Gremlin and openCypher).
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStatisticsStatus IAM action in that cluster.
getPropertygraphStatisticsRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.StatisticsNotAvailableException
- Raised when statistics needed to satisfy a request are not available.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.GetPropertygraphSummaryResult getPropertygraphSummary(GetPropertygraphSummaryRequest getPropertygraphSummaryRequest)
Gets a graph summary for a property graph.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetGraphSummary IAM action in that cluster.
getPropertygraphSummaryRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.StatisticsNotAvailableException
- Raised when statistics needed to satisfy a request are not available.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.GetRDFGraphSummaryResult getRDFGraphSummary(GetRDFGraphSummaryRequest getRDFGraphSummaryRequest)
Gets a graph summary for an RDF graph.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetGraphSummary IAM action in that cluster.
getRDFGraphSummaryRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.StatisticsNotAvailableException
- Raised when statistics needed to satisfy a request are not available.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.GetSparqlStatisticsResult getSparqlStatistics(GetSparqlStatisticsRequest getSparqlStatisticsRequest)
Gets RDF statistics (SPARQL).
getSparqlStatisticsRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.StatisticsNotAvailableException
- Raised when statistics needed to satisfy a request are not available.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.GetSparqlStreamResult getSparqlStream(GetSparqlStreamRequest getSparqlStreamRequest)
Gets a stream for an RDF graph.
With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every
change made to your graph data as it happens. GetSparqlStream
lets you collect these change-log
entries for an RDF graph.
The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1
.
See Capturing graph changes in real time using Neptune streams.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStreamRecords IAM action in that cluster.
Note that the neptune-db:QueryLanguage:Sparql IAM condition key can be used in the policy document to restrict the use of SPARQL queries (see Condition keys available in Neptune IAM data-access policy statements).
getSparqlStreamRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.ExpiredStreamException
- Raised when a request attempts to access an stream that has expired.InvalidParameterException
- Raised when a parameter value is not valid.MemoryLimitExceededException
- Raised when a request fails because of insufficient memory resources. The request can be retried.StreamRecordsNotFoundException
- Raised when stream records requested by a query cannot be found.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ThrottlingException
- Raised when the rate of requests exceeds the maximum throughput. Requests can be retried after
encountering this exception.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.ListGremlinQueriesResult listGremlinQueries(ListGremlinQueriesRequest listGremlinQueriesRequest)
Lists active Gremlin queries. See Gremlin query status API for details about the output.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.
Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).
listGremlinQueriesRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.FailureByQueryException
- Raised when a request fails.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ParsingException
- Raised when a parsing issue is encountered.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.TimeLimitExceededException
- Raised when the an operation exceeds the time limit allowed for it.InvalidArgumentException
- Raised when an argument in a request has an invalid value.ConcurrentModificationException
- Raised when a request attempts to modify data that is concurrently being modified by another process.MissingParameterException
- Raised when a required parameter is missing.ListLoaderJobsResult listLoaderJobs(ListLoaderJobsRequest listLoaderJobsRequest)
Retrieves a list of the loadIds
for all active loader jobs.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListLoaderJobs IAM action in that cluster..
listLoaderJobsRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.BulkLoadIdNotFoundException
- Raised when a specified bulk-load job ID cannot be found.InternalFailureException
- Raised when the processing of the request failed unexpectedly.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.LoadUrlAccessDeniedException
- Raised when access is denied to a specified load URL.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.ListMLDataProcessingJobsResult listMLDataProcessingJobs(ListMLDataProcessingJobsRequest listMLDataProcessingJobsRequest)
Returns a list of Neptune ML data processing jobs. See Listing active data-processing jobs using the Neptune ML dataprocessing command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListMLDataProcessingJobs IAM action in that cluster.
listMLDataProcessingJobsRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.ListMLEndpointsResult listMLEndpoints(ListMLEndpointsRequest listMLEndpointsRequest)
Lists existing inference endpoints. See Managing inference endpoints using the endpoints command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListMLEndpoints IAM action in that cluster.
listMLEndpointsRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.ListMLModelTrainingJobsResult listMLModelTrainingJobs(ListMLModelTrainingJobsRequest listMLModelTrainingJobsRequest)
Lists Neptune ML model-training jobs. See Model
training using the modeltraining
command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:neptune-db:ListMLModelTrainingJobs IAM action in that cluster.
listMLModelTrainingJobsRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.ListMLModelTransformJobsResult listMLModelTransformJobs(ListMLModelTransformJobsRequest listMLModelTransformJobsRequest)
Returns a list of model transform job IDs. See Use a trained model to generate new model artifacts.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListMLModelTransformJobs IAM action in that cluster.
listMLModelTransformJobsRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.ListOpenCypherQueriesResult listOpenCypherQueries(ListOpenCypherQueriesRequest listOpenCypherQueriesRequest)
Lists active openCypher queries. See Neptune openCypher status endpoint for more information.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.
Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).
listOpenCypherQueriesRequest
- InvalidNumericDataException
- Raised when invalid numerical data is encountered when servicing a request.BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.FailureByQueryException
- Raised when a request fails.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ParsingException
- Raised when a parsing issue is encountered.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.TimeLimitExceededException
- Raised when the an operation exceeds the time limit allowed for it.InvalidArgumentException
- Raised when an argument in a request has an invalid value.ConcurrentModificationException
- Raised when a request attempts to modify data that is concurrently being modified by another process.MissingParameterException
- Raised when a required parameter is missing.ManagePropertygraphStatisticsResult managePropertygraphStatistics(ManagePropertygraphStatisticsRequest managePropertygraphStatisticsRequest)
Manages the generation and use of property graph statistics.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ManageStatistics IAM action in that cluster.
managePropertygraphStatisticsRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.StatisticsNotAvailableException
- Raised when statistics needed to satisfy a request are not available.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.ManageSparqlStatisticsResult manageSparqlStatistics(ManageSparqlStatisticsRequest manageSparqlStatisticsRequest)
Manages the generation and use of RDF graph statistics.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ManageStatistics IAM action in that cluster.
manageSparqlStatisticsRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.StatisticsNotAvailableException
- Raised when statistics needed to satisfy a request are not available.ClientTimeoutException
- Raised when a request timed out in the client.AccessDeniedException
- Raised in case of an authentication or authorization failure.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ReadOnlyViolationException
- Raised when a request attempts to write to a read-only resource.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.StartLoaderJobResult startLoaderJob(StartLoaderJobRequest startLoaderJobRequest)
Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance. See Using the Amazon Neptune Bulk Loader to Ingest Data.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartLoaderJob IAM action in that cluster.
startLoaderJobRequest
- BadRequestException
- Raised when a request is submitted that cannot be processed.InvalidParameterException
- Raised when a parameter value is not valid.BulkLoadIdNotFoundException
- Raised when a specified bulk-load job ID cannot be found.ClientTimeoutException
- Raised when a request timed out in the client.LoadUrlAccessDeniedException
- Raised when access is denied to a specified load URL.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.InternalFailureException
- Raised when the processing of the request failed unexpectedly.S3Exception
- Raised when there is a problem accessing Amazon S3.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.StartMLDataProcessingJobResult startMLDataProcessingJob(StartMLDataProcessingJobRequest startMLDataProcessingJobRequest)
Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training.
See The
dataprocessing
command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelDataProcessingJob IAM action in that cluster.
startMLDataProcessingJobRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.StartMLModelTrainingJobResult startMLModelTrainingJob(StartMLModelTrainingJobRequest startMLModelTrainingJobRequest)
Creates a new Neptune ML model training job. See Model
training using the modeltraining
command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelTrainingJob IAM action in that cluster.
startMLModelTrainingJobRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.StartMLModelTransformJobResult startMLModelTransformJob(StartMLModelTransformJobRequest startMLModelTransformJobRequest)
Creates a new model transform job. See Use a trained model to generate new model artifacts.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelTransformJob IAM action in that cluster.
startMLModelTransformJobRequest
- UnsupportedOperationException
- Raised when a request attempts to initiate an operation that is not supported.BadRequestException
- Raised when a request is submitted that cannot be processed.MLResourceNotFoundException
- Raised when a specified machine-learning resource could not be found.InvalidParameterException
- Raised when a parameter value is not valid.ClientTimeoutException
- Raised when a request timed out in the client.PreconditionsFailedException
- Raised when a precondition for processing a request is not satisfied.ConstraintViolationException
- Raised when a value in a request field did not satisfy required constraints.InvalidArgumentException
- Raised when an argument in a request has an invalid value.MissingParameterException
- Raised when a required parameter is missing.IllegalArgumentException
- Raised when an argument in a request is not supported.TooManyRequestsException
- Raised when the number of requests being processed exceeds the limit.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.