

# Amazon Neptune Data API Reference
<a name="data-api"></a>

This chapter documents the Neptune data API operations that you can use to load, access, and maintain the data in your Neptune graph.

The Neptune data API provides SDK support for loading data, running queries, getting information about your data, and running machine-learning operations. It supports the Gremlin and openCypher query languages in Neptune, and is available in all SDK languages. It automatically signs API requests and greatly simplifies integrating Neptune into applications.

**Contents**
+ [Neptune dataplane engine, fast reset, and general structure APIs](data-api-dp-environment-APIs.md)
  + [GetEngineStatus (action)](data-api-dp-environment-APIs.md#GetEngineStatus)
  + [ExecuteFastReset (action)](data-api-dp-environment-APIs.md#ExecuteFastReset)
  + [*Engine operation structures:*](data-api-dp-environment-APIs.md#data-api-dp-environment-APIs-engine-operation-structures-spacer)
  + [QueryLanguageVersion (structure)](data-api-dp-environment-APIs.md#QueryLanguageVersion)
  + [FastResetToken (structure)](data-api-dp-environment-APIs.md#FastResetToken)
+ [Neptune Query APIs](data-api-dp-queries.md)
  + [ExecuteGremlinQuery (action)](data-api-dp-queries.md#ExecuteGremlinQuery)
  + [ExecuteGremlinExplainQuery (action)](data-api-dp-queries.md#ExecuteGremlinExplainQuery)
  + [ExecuteGremlinProfileQuery (action)](data-api-dp-queries.md#ExecuteGremlinProfileQuery)
  + [ListGremlinQueries (action)](data-api-dp-queries.md#ListGremlinQueries)
  + [GetGremlinQueryStatus (action)](data-api-dp-queries.md#GetGremlinQueryStatus)
  + [CancelGremlinQuery (action)](data-api-dp-queries.md#CancelGremlinQuery)
  + [*openCypher query actions:*](data-api-dp-queries.md#data-api-dp-queries-opencypher-query-actions-spacer)
  + [ExecuteOpenCypherQuery (action)](data-api-dp-queries.md#ExecuteOpenCypherQuery)
  + [ExecuteOpenCypherExplainQuery (action)](data-api-dp-queries.md#ExecuteOpenCypherExplainQuery)
  + [ListOpenCypherQueries (action)](data-api-dp-queries.md#ListOpenCypherQueries)
  + [GetOpenCypherQueryStatus (action)](data-api-dp-queries.md#GetOpenCypherQueryStatus)
  + [CancelOpenCypherQuery (action)](data-api-dp-queries.md#CancelOpenCypherQuery)
  + [*Query structures:*](data-api-dp-queries.md#data-api-dp-queries-query-structures-spacer)
  + [QueryEvalStats (structure)](data-api-dp-queries.md#QueryEvalStats)
  + [GremlinQueryStatus (structure)](data-api-dp-queries.md#GremlinQueryStatus)
  + [GremlinQueryStatusAttributes (structure)](data-api-dp-queries.md#GremlinQueryStatusAttributes)
+ [Neptune data plane bulk loader APIs](data-api-dp-loader.md)
  + [StartLoaderJob (action)](data-api-dp-loader.md#StartLoaderJob)
  + [GetLoaderJobStatus (action)](data-api-dp-loader.md#GetLoaderJobStatus)
  + [ListLoaderJobs (action)](data-api-dp-loader.md#ListLoaderJobs)
  + [CancelLoaderJob (action)](data-api-dp-loader.md#CancelLoaderJob)
  + [*Bulk load structure:*](data-api-dp-loader.md#data-api-dp-loader-bulk-load-structure-spacer)
  + [LoaderIdResult (structure)](data-api-dp-loader.md#LoaderIdResult)
+ [Neptune streams dataplane API](data-api-dp-streams.md)
  + [GetPropertygraphStream (action)](data-api-dp-streams.md#GetPropertygraphStream)
  + [*Stream data structures:*](data-api-dp-streams.md#data-api-dp-streams-stream-data-structures-spacer)
  + [PropertygraphRecord (structure)](data-api-dp-streams.md#PropertygraphRecord)
  + [PropertygraphData (structure)](data-api-dp-streams.md#PropertygraphData)
+ [Neptune dataplane statistics and graph summary APIs](data-api-dp-statistics.md)
  + [GetPropertygraphStatistics (action)](data-api-dp-statistics.md#GetPropertygraphStatistics)
  + [ManagePropertygraphStatistics (action)](data-api-dp-statistics.md#ManagePropertygraphStatistics)
  + [DeletePropertygraphStatistics (action)](data-api-dp-statistics.md#DeletePropertygraphStatistics)
  + [GetPropertygraphSummary (action)](data-api-dp-statistics.md#GetPropertygraphSummary)
  + [*Statistics structures:*](data-api-dp-statistics.md#data-api-dp-statistics-statistics-structures-spacer)
  + [Statistics (structure)](data-api-dp-statistics.md#Statistics)
  + [StatisticsSummary (structure)](data-api-dp-statistics.md#StatisticsSummary)
  + [DeleteStatisticsValueMap (structure)](data-api-dp-statistics.md#DeleteStatisticsValueMap)
  + [RefreshStatisticsIdMap (structure)](data-api-dp-statistics.md#RefreshStatisticsIdMap)
  + [NodeStructure (structure)](data-api-dp-statistics.md#NodeStructure)
  + [EdgeStructure (structure)](data-api-dp-statistics.md#EdgeStructure)
  + [SubjectStructure (structure)](data-api-dp-statistics.md#SubjectStructure)
  + [PropertygraphSummaryValueMap (structure)](data-api-dp-statistics.md#PropertygraphSummaryValueMap)
  + [PropertygraphSummary (structure)](data-api-dp-statistics.md#PropertygraphSummary)
+ [Neptune ML data-processing API](data-api-dp-ml-data-processing.md)
  + [StartMLDataProcessingJob (action)](data-api-dp-ml-data-processing.md#StartMLDataProcessingJob)
  + [ListMLDataProcessingJobs (action)](data-api-dp-ml-data-processing.md#ListMLDataProcessingJobs)
  + [GetMLDataProcessingJob (action)](data-api-dp-ml-data-processing.md#GetMLDataProcessingJob)
  + [CancelMLDataProcessingJob (action)](data-api-dp-ml-data-processing.md#CancelMLDataProcessingJob)
  + [*ML general-purpose structures:*](data-api-dp-ml-data-processing.md#data-api-dp-ml-data-processing-ml-general-purpose-structures-spacer)
  + [MlResourceDefinition (structure)](data-api-dp-ml-data-processing.md#MlResourceDefinition)
  + [MlConfigDefinition (structure)](data-api-dp-ml-data-processing.md#MlConfigDefinition)
+ [Neptune ML model training API](data-api-dp-ml-training.md)
  + [StartMLModelTrainingJob (action)](data-api-dp-ml-training.md#StartMLModelTrainingJob)
  + [ListMLModelTrainingJobs (action)](data-api-dp-ml-training.md#ListMLModelTrainingJobs)
  + [GetMLModelTrainingJob (action)](data-api-dp-ml-training.md#GetMLModelTrainingJob)
  + [CancelMLModelTrainingJob (action)](data-api-dp-ml-training.md#CancelMLModelTrainingJob)
  + [*Model training structures:*](data-api-dp-ml-training.md#data-api-dp-ml-training-model-training-structures-spacer)
  + [CustomModelTrainingParameters (structure)](data-api-dp-ml-training.md#CustomModelTrainingParameters)
+ [Neptune ML model transform API](data-api-dp-ml-transform.md)
  + [StartMLModelTransformJob (action)](data-api-dp-ml-transform.md#StartMLModelTransformJob)
  + [ListMLModelTransformJobs (action)](data-api-dp-ml-transform.md#ListMLModelTransformJobs)
  + [GetMLModelTransformJob (action)](data-api-dp-ml-transform.md#GetMLModelTransformJob)
  + [CancelMLModelTransformJob (action)](data-api-dp-ml-transform.md#CancelMLModelTransformJob)
  + [*Model transform structures:*](data-api-dp-ml-transform.md#data-api-dp-ml-transform-model-transform-structures-spacer)
  + [CustomModelTransformParameters (structure)](data-api-dp-ml-transform.md#CustomModelTransformParameters)
+ [Neptune ML inference endpoint API](data-api-dp-inference.md)
  + [CreateMLEndpoint (action)](data-api-dp-inference.md#CreateMLEndpoint)
  + [ListMLEndpoints (action)](data-api-dp-inference.md#ListMLEndpoints)
  + [GetMLEndpoint (action)](data-api-dp-inference.md#GetMLEndpoint)
  + [DeleteMLEndpoint (action)](data-api-dp-inference.md#DeleteMLEndpoint)
+ [Neptune dataplane API Exceptions](data-api-dp-errors.md)
  + [AccessDeniedException (structure)](data-api-dp-errors.md#AccessDeniedException)
  + [BadRequestException (structure)](data-api-dp-errors.md#BadRequestException)
  + [BulkLoadIdNotFoundException (structure)](data-api-dp-errors.md#BulkLoadIdNotFoundException)
  + [CancelledByUserException (structure)](data-api-dp-errors.md#CancelledByUserException)
  + [ClientTimeoutException (structure)](data-api-dp-errors.md#ClientTimeoutException)
  + [ConcurrentModificationException (structure)](data-api-dp-errors.md#ConcurrentModificationException)
  + [ConstraintViolationException (structure)](data-api-dp-errors.md#ConstraintViolationException)
  + [ExpiredStreamException (structure)](data-api-dp-errors.md#ExpiredStreamException)
  + [FailureByQueryException (structure)](data-api-dp-errors.md#FailureByQueryException)
  + [IllegalArgumentException (structure)](data-api-dp-errors.md#IllegalArgumentException)
  + [InternalFailureException (structure)](data-api-dp-errors.md#InternalFailureException)
  + [InvalidArgumentException (structure)](data-api-dp-errors.md#InvalidArgumentException)
  + [InvalidNumericDataException (structure)](data-api-dp-errors.md#InvalidNumericDataException)
  + [InvalidParameterException (structure)](data-api-dp-errors.md#InvalidParameterException)
  + [LoadUrlAccessDeniedException (structure)](data-api-dp-errors.md#LoadUrlAccessDeniedException)
  + [MalformedQueryException (structure)](data-api-dp-errors.md#MalformedQueryException)
  + [MemoryLimitExceededException (structure)](data-api-dp-errors.md#MemoryLimitExceededException)
  + [MethodNotAllowedException (structure)](data-api-dp-errors.md#MethodNotAllowedException)
  + [MissingParameterException (structure)](data-api-dp-errors.md#MissingParameterException)
  + [MLResourceNotFoundException (structure)](data-api-dp-errors.md#MLResourceNotFoundException)
  + [ParsingException (structure)](data-api-dp-errors.md#ParsingException)
  + [PreconditionsFailedException (structure)](data-api-dp-errors.md#PreconditionsFailedException)
  + [QueryLimitExceededException (structure)](data-api-dp-errors.md#QueryLimitExceededException)
  + [QueryLimitException (structure)](data-api-dp-errors.md#QueryLimitException)
  + [QueryTooLargeException (structure)](data-api-dp-errors.md#QueryTooLargeException)
  + [ReadOnlyViolationException (structure)](data-api-dp-errors.md#ReadOnlyViolationException)
  + [S3Exception (structure)](data-api-dp-errors.md#S3Exception)
  + [ServerShutdownException (structure)](data-api-dp-errors.md#ServerShutdownException)
  + [StatisticsNotAvailableException (structure)](data-api-dp-errors.md#StatisticsNotAvailableException)
  + [StreamRecordsNotFoundException (structure)](data-api-dp-errors.md#StreamRecordsNotFoundException)
  + [ThrottlingException (structure)](data-api-dp-errors.md#ThrottlingException)
  + [TimeLimitExceededException (structure)](data-api-dp-errors.md#TimeLimitExceededException)
  + [TooManyRequestsException (structure)](data-api-dp-errors.md#TooManyRequestsException)
  + [UnsupportedOperationException (structure)](data-api-dp-errors.md#UnsupportedOperationException)
  + [UnloadUrlAccessDeniedException (structure)](data-api-dp-errors.md#UnloadUrlAccessDeniedException)