@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface NeptunedataClient extends AwsClient
builder() method.
The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data operations, including data loading, query execution, data inquiry, and machine learning. It supports the Gremlin and openCypher query languages, and is available in all SDK languages. It automatically signs API requests and greatly simplifies integrating Neptune into your applications.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static NeptunedataClientBuilder |
builder()
Create a builder that can be used to configure and create a
NeptunedataClient. |
default CancelGremlinQueryResponse |
cancelGremlinQuery(CancelGremlinQueryRequest cancelGremlinQueryRequest)
Cancels a Gremlin query.
|
default CancelGremlinQueryResponse |
cancelGremlinQuery(Consumer<CancelGremlinQueryRequest.Builder> cancelGremlinQueryRequest)
Cancels a Gremlin query.
|
default CancelLoaderJobResponse |
cancelLoaderJob(CancelLoaderJobRequest cancelLoaderJobRequest)
Cancels a specified load job.
|
default CancelLoaderJobResponse |
cancelLoaderJob(Consumer<CancelLoaderJobRequest.Builder> cancelLoaderJobRequest)
Cancels a specified load job.
|
default CancelMlDataProcessingJobResponse |
cancelMLDataProcessingJob(CancelMlDataProcessingJobRequest cancelMlDataProcessingJobRequest)
Cancels a Neptune ML data processing job.
|
default CancelMlDataProcessingJobResponse |
cancelMLDataProcessingJob(Consumer<CancelMlDataProcessingJobRequest.Builder> cancelMlDataProcessingJobRequest)
Cancels a Neptune ML data processing job.
|
default CancelMlModelTrainingJobResponse |
cancelMLModelTrainingJob(CancelMlModelTrainingJobRequest cancelMlModelTrainingJobRequest)
Cancels a Neptune ML model training job.
|
default CancelMlModelTrainingJobResponse |
cancelMLModelTrainingJob(Consumer<CancelMlModelTrainingJobRequest.Builder> cancelMlModelTrainingJobRequest)
Cancels a Neptune ML model training job.
|
default CancelMlModelTransformJobResponse |
cancelMLModelTransformJob(CancelMlModelTransformJobRequest cancelMlModelTransformJobRequest)
Cancels a specified model transform job.
|
default CancelMlModelTransformJobResponse |
cancelMLModelTransformJob(Consumer<CancelMlModelTransformJobRequest.Builder> cancelMlModelTransformJobRequest)
Cancels a specified model transform job.
|
default CancelOpenCypherQueryResponse |
cancelOpenCypherQuery(CancelOpenCypherQueryRequest cancelOpenCypherQueryRequest)
Cancels a specified openCypher query.
|
default CancelOpenCypherQueryResponse |
cancelOpenCypherQuery(Consumer<CancelOpenCypherQueryRequest.Builder> cancelOpenCypherQueryRequest)
Cancels a specified openCypher query.
|
static NeptunedataClient |
create()
Create a
NeptunedataClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateMlEndpointResponse |
createMLEndpoint(Consumer<CreateMlEndpointRequest.Builder> createMlEndpointRequest)
Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training
process constructed.
|
default CreateMlEndpointResponse |
createMLEndpoint(CreateMlEndpointRequest createMlEndpointRequest)
Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training
process constructed.
|
default DeleteMlEndpointResponse |
deleteMLEndpoint(Consumer<DeleteMlEndpointRequest.Builder> deleteMlEndpointRequest)
Cancels the creation of a Neptune ML inference endpoint.
|
default DeleteMlEndpointResponse |
deleteMLEndpoint(DeleteMlEndpointRequest deleteMlEndpointRequest)
Cancels the creation of a Neptune ML inference endpoint.
|
default DeletePropertygraphStatisticsResponse |
deletePropertygraphStatistics(Consumer<DeletePropertygraphStatisticsRequest.Builder> deletePropertygraphStatisticsRequest)
Deletes statistics for Gremlin and openCypher (property graph) data.
|
default DeletePropertygraphStatisticsResponse |
deletePropertygraphStatistics(DeletePropertygraphStatisticsRequest deletePropertygraphStatisticsRequest)
Deletes statistics for Gremlin and openCypher (property graph) data.
|
default DeleteSparqlStatisticsResponse |
deleteSparqlStatistics(Consumer<DeleteSparqlStatisticsRequest.Builder> deleteSparqlStatisticsRequest)
Deletes SPARQL statistics
|
default DeleteSparqlStatisticsResponse |
deleteSparqlStatistics(DeleteSparqlStatisticsRequest deleteSparqlStatisticsRequest)
Deletes SPARQL statistics
|
default ExecuteFastResetResponse |
executeFastReset(Consumer<ExecuteFastResetRequest.Builder> executeFastResetRequest)
The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.
|
default ExecuteFastResetResponse |
executeFastReset(ExecuteFastResetRequest executeFastResetRequest)
The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.
|
default ExecuteGremlinExplainQueryResponse |
executeGremlinExplainQuery(Consumer<ExecuteGremlinExplainQueryRequest.Builder> executeGremlinExplainQueryRequest)
Executes a Gremlin Explain query.
|
default ExecuteGremlinExplainQueryResponse |
executeGremlinExplainQuery(ExecuteGremlinExplainQueryRequest executeGremlinExplainQueryRequest)
Executes a Gremlin Explain query.
|
default ExecuteGremlinProfileQueryResponse |
executeGremlinProfileQuery(Consumer<ExecuteGremlinProfileQueryRequest.Builder> executeGremlinProfileQueryRequest)
Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and
produces a profile report as output.
|
default ExecuteGremlinProfileQueryResponse |
executeGremlinProfileQuery(ExecuteGremlinProfileQueryRequest executeGremlinProfileQueryRequest)
Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and
produces a profile report as output.
|
default ExecuteGremlinQueryResponse |
executeGremlinQuery(Consumer<ExecuteGremlinQueryRequest.Builder> executeGremlinQueryRequest)
This commands executes a Gremlin query.
|
default ExecuteGremlinQueryResponse |
executeGremlinQuery(ExecuteGremlinQueryRequest executeGremlinQueryRequest)
This commands executes a Gremlin query.
|
default ExecuteOpenCypherExplainQueryResponse |
executeOpenCypherExplainQuery(Consumer<ExecuteOpenCypherExplainQueryRequest.Builder> executeOpenCypherExplainQueryRequest)
Executes an openCypher
explain request. |
default ExecuteOpenCypherExplainQueryResponse |
executeOpenCypherExplainQuery(ExecuteOpenCypherExplainQueryRequest executeOpenCypherExplainQueryRequest)
Executes an openCypher
explain request. |
default ExecuteOpenCypherQueryResponse |
executeOpenCypherQuery(Consumer<ExecuteOpenCypherQueryRequest.Builder> executeOpenCypherQueryRequest)
Executes an openCypher query.
|
default ExecuteOpenCypherQueryResponse |
executeOpenCypherQuery(ExecuteOpenCypherQueryRequest executeOpenCypherQueryRequest)
Executes an openCypher query.
|
default GetEngineStatusResponse |
getEngineStatus(Consumer<GetEngineStatusRequest.Builder> getEngineStatusRequest)
Retrieves the status of the graph database on the host.
|
default GetEngineStatusResponse |
getEngineStatus(GetEngineStatusRequest getEngineStatusRequest)
Retrieves the status of the graph database on the host.
|
default GetGremlinQueryStatusResponse |
getGremlinQueryStatus(Consumer<GetGremlinQueryStatusRequest.Builder> getGremlinQueryStatusRequest)
Gets the status of a specified Gremlin query.
|
default GetGremlinQueryStatusResponse |
getGremlinQueryStatus(GetGremlinQueryStatusRequest getGremlinQueryStatusRequest)
Gets the status of a specified Gremlin query.
|
default GetLoaderJobStatusResponse |
getLoaderJobStatus(Consumer<GetLoaderJobStatusRequest.Builder> getLoaderJobStatusRequest)
Gets status information about a specified load job.
|
default GetLoaderJobStatusResponse |
getLoaderJobStatus(GetLoaderJobStatusRequest getLoaderJobStatusRequest)
Gets status information about a specified load job.
|
default GetMlDataProcessingJobResponse |
getMLDataProcessingJob(Consumer<GetMlDataProcessingJobRequest.Builder> getMlDataProcessingJobRequest)
Retrieves information about a specified data processing job.
|
default GetMlDataProcessingJobResponse |
getMLDataProcessingJob(GetMlDataProcessingJobRequest getMlDataProcessingJobRequest)
Retrieves information about a specified data processing job.
|
default GetMlEndpointResponse |
getMLEndpoint(Consumer<GetMlEndpointRequest.Builder> getMlEndpointRequest)
Retrieves details about an inference endpoint.
|
default GetMlEndpointResponse |
getMLEndpoint(GetMlEndpointRequest getMlEndpointRequest)
Retrieves details about an inference endpoint.
|
default GetMlModelTrainingJobResponse |
getMLModelTrainingJob(Consumer<GetMlModelTrainingJobRequest.Builder> getMlModelTrainingJobRequest)
Retrieves information about a Neptune ML model training job.
|
default GetMlModelTrainingJobResponse |
getMLModelTrainingJob(GetMlModelTrainingJobRequest getMlModelTrainingJobRequest)
Retrieves information about a Neptune ML model training job.
|
default GetMlModelTransformJobResponse |
getMLModelTransformJob(Consumer<GetMlModelTransformJobRequest.Builder> getMlModelTransformJobRequest)
Gets information about a specified model transform job.
|
default GetMlModelTransformJobResponse |
getMLModelTransformJob(GetMlModelTransformJobRequest getMlModelTransformJobRequest)
Gets information about a specified model transform job.
|
default GetOpenCypherQueryStatusResponse |
getOpenCypherQueryStatus(Consumer<GetOpenCypherQueryStatusRequest.Builder> getOpenCypherQueryStatusRequest)
Retrieves the status of a specified openCypher query.
|
default GetOpenCypherQueryStatusResponse |
getOpenCypherQueryStatus(GetOpenCypherQueryStatusRequest getOpenCypherQueryStatusRequest)
Retrieves the status of a specified openCypher query.
|
default GetPropertygraphStatisticsResponse |
getPropertygraphStatistics(Consumer<GetPropertygraphStatisticsRequest.Builder> getPropertygraphStatisticsRequest)
Gets property graph statistics (Gremlin and openCypher).
|
default GetPropertygraphStatisticsResponse |
getPropertygraphStatistics(GetPropertygraphStatisticsRequest getPropertygraphStatisticsRequest)
Gets property graph statistics (Gremlin and openCypher).
|
default GetPropertygraphStreamResponse |
getPropertygraphStream(Consumer<GetPropertygraphStreamRequest.Builder> getPropertygraphStreamRequest)
Gets a stream for a property graph.
|
default GetPropertygraphStreamResponse |
getPropertygraphStream(GetPropertygraphStreamRequest getPropertygraphStreamRequest)
Gets a stream for a property graph.
|
default GetPropertygraphSummaryResponse |
getPropertygraphSummary(Consumer<GetPropertygraphSummaryRequest.Builder> getPropertygraphSummaryRequest)
Gets a graph summary for a property graph.
|
default GetPropertygraphSummaryResponse |
getPropertygraphSummary(GetPropertygraphSummaryRequest getPropertygraphSummaryRequest)
Gets a graph summary for a property graph.
|
default GetRdfGraphSummaryResponse |
getRDFGraphSummary(Consumer<GetRdfGraphSummaryRequest.Builder> getRdfGraphSummaryRequest)
Gets a graph summary for an RDF graph.
|
default GetRdfGraphSummaryResponse |
getRDFGraphSummary(GetRdfGraphSummaryRequest getRdfGraphSummaryRequest)
Gets a graph summary for an RDF graph.
|
default GetSparqlStatisticsResponse |
getSparqlStatistics(Consumer<GetSparqlStatisticsRequest.Builder> getSparqlStatisticsRequest)
Gets RDF statistics (SPARQL).
|
default GetSparqlStatisticsResponse |
getSparqlStatistics(GetSparqlStatisticsRequest getSparqlStatisticsRequest)
Gets RDF statistics (SPARQL).
|
default GetSparqlStreamResponse |
getSparqlStream(Consumer<GetSparqlStreamRequest.Builder> getSparqlStreamRequest)
Gets a stream for an RDF graph.
|
default GetSparqlStreamResponse |
getSparqlStream(GetSparqlStreamRequest getSparqlStreamRequest)
Gets a stream for an RDF graph.
|
default ListGremlinQueriesResponse |
listGremlinQueries(Consumer<ListGremlinQueriesRequest.Builder> listGremlinQueriesRequest)
Lists active Gremlin queries.
|
default ListGremlinQueriesResponse |
listGremlinQueries(ListGremlinQueriesRequest listGremlinQueriesRequest)
Lists active Gremlin queries.
|
default ListLoaderJobsResponse |
listLoaderJobs(Consumer<ListLoaderJobsRequest.Builder> listLoaderJobsRequest)
Retrieves a list of the
loadIds for all active loader jobs. |
default ListLoaderJobsResponse |
listLoaderJobs(ListLoaderJobsRequest listLoaderJobsRequest)
Retrieves a list of the
loadIds for all active loader jobs. |
default ListMlDataProcessingJobsResponse |
listMLDataProcessingJobs(Consumer<ListMlDataProcessingJobsRequest.Builder> listMlDataProcessingJobsRequest)
Returns a list of Neptune ML data processing jobs.
|
default ListMlDataProcessingJobsResponse |
listMLDataProcessingJobs(ListMlDataProcessingJobsRequest listMlDataProcessingJobsRequest)
Returns a list of Neptune ML data processing jobs.
|
default ListMlEndpointsResponse |
listMLEndpoints(Consumer<ListMlEndpointsRequest.Builder> listMlEndpointsRequest)
Lists existing inference endpoints.
|
default ListMlEndpointsResponse |
listMLEndpoints(ListMlEndpointsRequest listMlEndpointsRequest)
Lists existing inference endpoints.
|
default ListMlModelTrainingJobsResponse |
listMLModelTrainingJobs(Consumer<ListMlModelTrainingJobsRequest.Builder> listMlModelTrainingJobsRequest)
Lists Neptune ML model-training jobs.
|
default ListMlModelTrainingJobsResponse |
listMLModelTrainingJobs(ListMlModelTrainingJobsRequest listMlModelTrainingJobsRequest)
Lists Neptune ML model-training jobs.
|
default ListMlModelTransformJobsResponse |
listMLModelTransformJobs(Consumer<ListMlModelTransformJobsRequest.Builder> listMlModelTransformJobsRequest)
Returns a list of model transform job IDs.
|
default ListMlModelTransformJobsResponse |
listMLModelTransformJobs(ListMlModelTransformJobsRequest listMlModelTransformJobsRequest)
Returns a list of model transform job IDs.
|
default ListOpenCypherQueriesResponse |
listOpenCypherQueries(Consumer<ListOpenCypherQueriesRequest.Builder> listOpenCypherQueriesRequest)
Lists active openCypher queries.
|
default ListOpenCypherQueriesResponse |
listOpenCypherQueries(ListOpenCypherQueriesRequest listOpenCypherQueriesRequest)
Lists active openCypher queries.
|
default ManagePropertygraphStatisticsResponse |
managePropertygraphStatistics(Consumer<ManagePropertygraphStatisticsRequest.Builder> managePropertygraphStatisticsRequest)
Manages the generation and use of property graph statistics.
|
default ManagePropertygraphStatisticsResponse |
managePropertygraphStatistics(ManagePropertygraphStatisticsRequest managePropertygraphStatisticsRequest)
Manages the generation and use of property graph statistics.
|
default ManageSparqlStatisticsResponse |
manageSparqlStatistics(Consumer<ManageSparqlStatisticsRequest.Builder> manageSparqlStatisticsRequest)
Manages the generation and use of RDF graph statistics.
|
default ManageSparqlStatisticsResponse |
manageSparqlStatistics(ManageSparqlStatisticsRequest manageSparqlStatisticsRequest)
Manages the generation and use of RDF graph statistics.
|
default NeptunedataServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartLoaderJobResponse |
startLoaderJob(Consumer<StartLoaderJobRequest.Builder> startLoaderJobRequest)
Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance.
|
default StartLoaderJobResponse |
startLoaderJob(StartLoaderJobRequest startLoaderJobRequest)
Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance.
|
default StartMlDataProcessingJobResponse |
startMLDataProcessingJob(Consumer<StartMlDataProcessingJobRequest.Builder> startMlDataProcessingJobRequest)
Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training.
|
default StartMlDataProcessingJobResponse |
startMLDataProcessingJob(StartMlDataProcessingJobRequest startMlDataProcessingJobRequest)
Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training.
|
default StartMlModelTrainingJobResponse |
startMLModelTrainingJob(Consumer<StartMlModelTrainingJobRequest.Builder> startMlModelTrainingJobRequest)
Creates a new Neptune ML model training job.
|
default StartMlModelTrainingJobResponse |
startMLModelTrainingJob(StartMlModelTrainingJobRequest startMlModelTrainingJobRequest)
Creates a new Neptune ML model training job.
|
default StartMlModelTransformJobResponse |
startMLModelTransformJob(Consumer<StartMlModelTransformJobRequest.Builder> startMlModelTransformJobRequest)
Creates a new model transform job.
|
default StartMlModelTransformJobResponse |
startMLModelTransformJob(StartMlModelTransformJobRequest startMlModelTransformJobRequest)
Creates a new model transform job.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via CancelGremlinQueryRequest.builder()
cancelGremlinQueryRequest - A Consumer that will call methods on
CancelGremlinQueryRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 DELETE request. See Neptune Loader
Get-Status API for more information.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelLoaderJob IAM action in that cluster..
This is a convenience which creates an instance of the CancelLoaderJobRequest.Builder avoiding the need
to create one manually via CancelLoaderJobRequest.builder()
cancelLoaderJobRequest - A Consumer that will call methods on
CancelLoaderJobRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
dataprocessing command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLDataProcessingJob IAM action in that cluster.
This is a convenience which creates an instance of the CancelMlDataProcessingJobRequest.Builder avoiding
the need to create one manually via CancelMlDataProcessingJobRequest.builder()
cancelMlDataProcessingJobRequest - A Consumer that will call methods on
CancelMlDataProcessingJobRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 modeltraining command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLModelTrainingJob IAM action in that cluster.
This is a convenience which creates an instance of the CancelMlModelTrainingJobRequest.Builder avoiding
the need to create one manually via CancelMlModelTrainingJobRequest.builder()
cancelMlModelTrainingJobRequest - A Consumer that will call methods on
CancelMlModelTrainingJobRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via CancelMlModelTransformJobRequest.builder()
cancelMlModelTransformJobRequest - A Consumer that will call methods on
CancelMlModelTransformJobRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via CancelOpenCypherQueryRequest.builder()
cancelOpenCypherQueryRequest - A Consumer that will call methods on
CancelOpenCypherQueryRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via CreateMlEndpointRequest.builder()
createMlEndpointRequest - A Consumer that will call methods on
CreateMlEndpointRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DeleteMlEndpointRequest.builder()
deleteMlEndpointRequest - A Consumer that will call methods on
DeleteMlEndpointRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DeletePropertygraphStatisticsRequest.builder()
deletePropertygraphStatisticsRequest - A Consumer that will call methods on
DeletePropertygraphStatisticsRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DeleteSparqlStatisticsRequest.builder()
deleteSparqlStatisticsRequest - A Consumer that will call methods on
DeleteSparqlStatisticsRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 ExecuteFastReset with action
set to initiateDatabaseReset. This returns a UUID token which you then include when calling
ExecuteFastReset again with action set to performDatabaseReset. See Empty an Amazon
Neptune DB cluster using the fast reset API.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ResetDatabase IAM action in that cluster.
This is a convenience which creates an instance of the ExecuteFastResetRequest.Builder avoiding the need
to create one manually via ExecuteFastResetRequest.builder()
executeFastResetRequest - A Consumer that will call methods on
ExecuteFastResetRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 explain that provides is a self-service tool for
understanding the execution approach being taken by the Neptune engine for the query. You invoke it by adding an
explain parameter to an HTTP call that submits a Gremlin query.
The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tune your query, as explained in Tuning Gremlin queries. You can also use query hints to improve query execution plans.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:
Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).
This is a convenience which creates an instance of the ExecuteGremlinExplainQueryRequest.Builder avoiding
the need to create one manually via ExecuteGremlinExplainQueryRequest.builder()
executeGremlinExplainQueryRequest - A Consumer that will call methods on
ExecuteGremlinExplainQueryRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via ExecuteGremlinProfileQueryRequest.builder()
executeGremlinProfileQueryRequest - A Consumer that will call methods on
ExecuteGremlinProfileQueryRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ExecuteGremlinQueryRequest.builder()
executeGremlinQueryRequest - A Consumer that will call methods on
ExecuteGremlinQueryRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 explain request. See The openCypher
explain feature for more information.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster.
Note that the neptune-db:QueryLanguage:Opencypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).
This is a convenience which creates an instance of the ExecuteOpenCypherExplainQueryRequest.Builder
avoiding the need to create one manually via ExecuteOpenCypherExplainQueryRequest.builder()
executeOpenCypherExplainQueryRequest - A Consumer that will call methods on
ExecuteOpenCypherExplainQueryRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
executeOpenCypherQueryRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ExecuteOpenCypherQueryRequest.builder()
executeOpenCypherQueryRequest - A Consumer that will call methods on
ExecuteOpenCypherQueryRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via GetEngineStatusRequest.builder()
getEngineStatusRequest - A Consumer that will call methods on
GetEngineStatusRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via GetGremlinQueryStatusRequest.builder()
getGremlinQueryStatusRequest - A Consumer that will call methods on
GetGremlinQueryStatusRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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..
getLoaderJobStatusRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via GetLoaderJobStatusRequest.builder()
getLoaderJobStatusRequest - A Consumer that will call methods on
GetLoaderJobStatusRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
dataprocessing command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:neptune-db:GetMLDataProcessingJobStatus IAM action in that cluster.
This is a convenience which creates an instance of the GetMlDataProcessingJobRequest.Builder avoiding the
need to create one manually via GetMlDataProcessingJobRequest.builder()
getMlDataProcessingJobRequest - A Consumer that will call methods on
GetMlDataProcessingJobRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via GetMlEndpointRequest.builder()
getMlEndpointRequest - A Consumer that will call methods on
GetMlEndpointRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 modeltraining command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetMLModelTrainingJobStatus IAM action in that cluster.
This is a convenience which creates an instance of the GetMlModelTrainingJobRequest.Builder avoiding the
need to create one manually via GetMlModelTrainingJobRequest.builder()
getMlModelTrainingJobRequest - A Consumer that will call methods on
GetMlModelTrainingJobRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via GetMlModelTransformJobRequest.builder()
getMlModelTransformJobRequest - A Consumer that will call methods on
GetMlModelTransformJobRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via GetOpenCypherQueryStatusRequest.builder()
getOpenCypherQueryStatusRequest - A Consumer that will call methods on
GetOpenCypherQueryStatusRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via GetPropertygraphStatisticsRequest.builder()
getPropertygraphStatisticsRequest - A Consumer that will call methods on
GetPropertygraphStatisticsRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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. GetPropertygraphStream lets you collect these
change-log entries for a property graph.
The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.
See Capturing graph changes in real time using Neptune streams.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStreamRecords IAM action in that cluster.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the following IAM actions, depending on the query:
Note that you can restrict property-graph queries using the following IAM context keys:
See Condition keys available in Neptune IAM data-access policy statements).
getPropertygraphStreamRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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. GetPropertygraphStream lets you collect these
change-log entries for a property graph.
The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.
See Capturing graph changes in real time using Neptune streams.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStreamRecords IAM action in that cluster.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the following IAM actions, depending on the query:
Note that you can restrict property-graph queries using the following IAM context keys:
See Condition keys available in Neptune IAM data-access policy statements).
This is a convenience which creates an instance of the GetPropertygraphStreamRequest.Builder avoiding the
need to create one manually via GetPropertygraphStreamRequest.builder()
getPropertygraphStreamRequest - A Consumer that will call methods on
GetPropertygraphStreamRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via GetPropertygraphSummaryRequest.builder()
getPropertygraphSummaryRequest - A Consumer that will call methods on
GetPropertygraphSummaryRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via GetRdfGraphSummaryRequest.builder()
getRdfGraphSummaryRequest - A Consumer that will call methods on
GetRdfGraphSummaryRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via GetSparqlStatisticsRequest.builder()
getSparqlStatisticsRequest - A Consumer that will call methods on
GetSparqlStatisticsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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. GetSparqlStream lets you collect these change-log
entries for an RDF graph.
The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.
See Capturing graph changes in real time using Neptune streams.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStreamRecords IAM action in that cluster.
Note that the neptune-db:QueryLanguage:Sparql IAM condition key can be used in the policy document to restrict the use of SPARQL queries (see Condition keys available in Neptune IAM data-access policy statements).
This is a convenience which creates an instance of the GetSparqlStreamRequest.Builder avoiding the need
to create one manually via GetSparqlStreamRequest.builder()
getSparqlStreamRequest - A Consumer that will call methods on
GetSparqlStreamRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListGremlinQueriesRequest.builder()
listGremlinQueriesRequest - A Consumer that will call methods on
ListGremlinQueriesRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 loadIds for all active loader jobs.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListLoaderJobs IAM action in that cluster..
This is a convenience which creates an instance of the ListLoaderJobsRequest.Builder avoiding the need to
create one manually via ListLoaderJobsRequest.builder()
listLoaderJobsRequest - A Consumer that will call methods on
ListLoaderJobsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via ListMlDataProcessingJobsRequest.builder()
listMlDataProcessingJobsRequest - A Consumer that will call methods on
ListMlDataProcessingJobsRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via ListMlEndpointsRequest.builder()
listMlEndpointsRequest - A Consumer that will call methods on
ListMlEndpointsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 modeltraining command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:neptune-db:ListMLModelTrainingJobs IAM action in that cluster.
This is a convenience which creates an instance of the ListMlModelTrainingJobsRequest.Builder avoiding
the need to create one manually via ListMlModelTrainingJobsRequest.builder()
listMlModelTrainingJobsRequest - A Consumer that will call methods on
ListMlModelTrainingJobsRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via ListMlModelTransformJobsRequest.builder()
listMlModelTransformJobsRequest - A Consumer that will call methods on
ListMlModelTransformJobsRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListOpenCypherQueriesRequest.builder()
listOpenCypherQueriesRequest - A Consumer that will call methods on
ListOpenCypherQueriesRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via ManagePropertygraphStatisticsRequest.builder()
managePropertygraphStatisticsRequest - A Consumer that will call methods on
ManagePropertygraphStatisticsRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ManageSparqlStatisticsRequest.builder()
manageSparqlStatisticsRequest - A Consumer that will call methods on
ManageSparqlStatisticsRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via StartLoaderJobRequest.builder()
startLoaderJobRequest - A Consumer that will call methods on
StartLoaderJobRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
dataprocessing command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelDataProcessingJob IAM action in that cluster.
This is a convenience which creates an instance of the StartMlDataProcessingJobRequest.Builder avoiding
the need to create one manually via StartMlDataProcessingJobRequest.builder()
startMlDataProcessingJobRequest - A Consumer that will call methods on
StartMlDataProcessingJobRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 modeltraining command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelTrainingJob IAM action in that cluster.
This is a convenience which creates an instance of the StartMlModelTrainingJobRequest.Builder avoiding
the need to create one manually via StartMlModelTrainingJobRequest.builder()
startMlModelTrainingJobRequest - A Consumer that will call methods on
StartMlModelTrainingJobRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via StartMlModelTransformJobRequest.builder()
startMlModelTransformJobRequest - A Consumer that will call methods on
StartMlModelTransformJobRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.NeptunedataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic NeptunedataClient create()
NeptunedataClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static NeptunedataClientBuilder builder()
NeptunedataClient.static ServiceMetadata serviceMetadata()
default NeptunedataServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.