本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# Amazon Neptune 数据 API 参考
本章记录了 Neptune 数据 API 操作，您可以使用这些操作来加载、访问和维护 Neptune 图形中的数据。
Neptune 数据 API 为加载数据、运行查询、获取有关数据的信息以及运行机器学习操作提供 SDK 支持。它支持 Neptune 中的 Gremlin 和 openCypher 查询语言，并可用于所有 SDK 语言中。它自动签署 API 请求，极大地简化了将 Neptune 集成到应用程序中的过程。
**Contents**
+ [Neptune 数据平面引擎、快速重置和通用结构 API](data-api-dp-environment-APIs.md)
+ [GetEngineStatus（操作）](data-api-dp-environment-APIs.md#GetEngineStatus)
+ [ExecuteFastReset（操作）](data-api-dp-environment-APIs.md#ExecuteFastReset)
+ [*引擎操作结构：*](data-api-dp-environment-APIs.md#data-api-dp-environment-APIs-engine-operation-structures-spacer)
+ [QueryLanguageVersion（结构）](data-api-dp-environment-APIs.md#QueryLanguageVersion)
+ [FastResetToken（结构）](data-api-dp-environment-APIs.md#FastResetToken)
+ [Neptune 查询 API](data-api-dp-queries.md)
+ [ExecuteGremlinQuery（操作）](data-api-dp-queries.md#ExecuteGremlinQuery)
+ [ExecuteGremlinExplainQuery（操作）](data-api-dp-queries.md#ExecuteGremlinExplainQuery)
+ [ExecuteGremlinProfileQuery（操作）](data-api-dp-queries.md#ExecuteGremlinProfileQuery)
+ [ListGremlinQueries（操作）](data-api-dp-queries.md#ListGremlinQueries)
+ [GetGremlinQueryStatus（操作）](data-api-dp-queries.md#GetGremlinQueryStatus)
+ [CancelGremlinQuery（操作）](data-api-dp-queries.md#CancelGremlinQuery)
+ [*openCypher 查询操作：*](data-api-dp-queries.md#data-api-dp-queries-opencypher-query-actions-spacer)
+ [ExecuteOpenCypherQuery（操作）](data-api-dp-queries.md#ExecuteOpenCypherQuery)
+ [ExecuteOpenCypherExplainQuery（操作）](data-api-dp-queries.md#ExecuteOpenCypherExplainQuery)
+ [ListOpenCypherQueries（操作）](data-api-dp-queries.md#ListOpenCypherQueries)
+ [GetOpenCypherQueryStatus（操作）](data-api-dp-queries.md#GetOpenCypherQueryStatus)
+ [CancelOpenCypherQuery（操作）](data-api-dp-queries.md#CancelOpenCypherQuery)
+ [*查询结构：*](data-api-dp-queries.md#data-api-dp-queries-query-structures-spacer)
+ [QueryEvalStats（结构）](data-api-dp-queries.md#QueryEvalStats)
+ [GremlinQueryStatus（结构）](data-api-dp-queries.md#GremlinQueryStatus)
+ [GremlinQueryStatusAttributes（结构）](data-api-dp-queries.md#GremlinQueryStatusAttributes)
+ [Neptune 数据面板批量加载程序 API](data-api-dp-loader.md)
+ [StartLoaderJob（操作）](data-api-dp-loader.md#StartLoaderJob)
+ [GetLoaderJobStatus（操作）](data-api-dp-loader.md#GetLoaderJobStatus)
+ [ListLoaderJobs（操作）](data-api-dp-loader.md#ListLoaderJobs)
+ [CancelLoaderJob（操作）](data-api-dp-loader.md#CancelLoaderJob)
+ [*批量加载结构：*](data-api-dp-loader.md#data-api-dp-loader-bulk-load-structure-spacer)
+ [LoaderIdResult（结构）](data-api-dp-loader.md#LoaderIdResult)
+ [Neptune 流数据面板 API](data-api-dp-streams.md)
+ [GetPropertygraphStream（操作）](data-api-dp-streams.md#GetPropertygraphStream)
+ [*流数据结构：*](data-api-dp-streams.md#data-api-dp-streams-stream-data-structures-spacer)
+ [PropertygraphRecord（结构）](data-api-dp-streams.md#PropertygraphRecord)
+ [PropertygraphData（结构）](data-api-dp-streams.md#PropertygraphData)
+ [Neptune 数据面板统计数据和图形摘要 API](data-api-dp-statistics.md)
+ [GetPropertygraphStatistics（操作）](data-api-dp-statistics.md#GetPropertygraphStatistics)
+ [ManagePropertygraphStatistics（操作）](data-api-dp-statistics.md#ManagePropertygraphStatistics)
+ [DeletePropertygraphStatistics（操作）](data-api-dp-statistics.md#DeletePropertygraphStatistics)
+ [GetPropertygraphSummary（操作）](data-api-dp-statistics.md#GetPropertygraphSummary)
+ [*统计数据结构：*](data-api-dp-statistics.md#data-api-dp-statistics-statistics-structures-spacer)
+ [Statistics（结构）](data-api-dp-statistics.md#Statistics)
+ [StatisticsSummary（结构）](data-api-dp-statistics.md#StatisticsSummary)
+ [DeleteStatisticsValueMap（结构）](data-api-dp-statistics.md#DeleteStatisticsValueMap)
+ [RefreshStatisticsIdMap（结构）](data-api-dp-statistics.md#RefreshStatisticsIdMap)
+ [NodeStructure（结构）](data-api-dp-statistics.md#NodeStructure)
+ [EdgeStructure（结构）](data-api-dp-statistics.md#EdgeStructure)
+ [SubjectStructure（结构）](data-api-dp-statistics.md#SubjectStructure)
+ [PropertygraphSummaryValueMap（结构）](data-api-dp-statistics.md#PropertygraphSummaryValueMap)
+ [PropertygraphSummary（结构）](data-api-dp-statistics.md#PropertygraphSummary)
+ [Neptune ML 数据处理 API](data-api-dp-ml-data-processing.md)
+ [StartMLDataProcessingJob（操作）](data-api-dp-ml-data-processing.md#StartMLDataProcessingJob)
+ [ListMLDataProcessingJobs（操作）](data-api-dp-ml-data-processing.md#ListMLDataProcessingJobs)
+ [GetMLDataProcessingJob（操作）](data-api-dp-ml-data-processing.md#GetMLDataProcessingJob)
+ [CancelMLDataProcessingJob（操作）](data-api-dp-ml-data-processing.md#CancelMLDataProcessingJob)
+ [*ML 通用结构：*](data-api-dp-ml-data-processing.md#data-api-dp-ml-data-processing-ml-general-purpose-structures-spacer)
+ [MlResourceDefinition（结构）](data-api-dp-ml-data-processing.md#MlResourceDefinition)
+ [MlConfigDefinition（结构）](data-api-dp-ml-data-processing.md#MlConfigDefinition)
+ [Neptune ML 模型训练 API](data-api-dp-ml-training.md)
+ [StartMLModelTrainingJob（操作）](data-api-dp-ml-training.md#StartMLModelTrainingJob)
+ [ListMLModelTrainingJobs（操作）](data-api-dp-ml-training.md#ListMLModelTrainingJobs)
+ [GetMLModelTrainingJob（操作）](data-api-dp-ml-training.md#GetMLModelTrainingJob)
+ [CancelMLModelTrainingJob（操作）](data-api-dp-ml-training.md#CancelMLModelTrainingJob)
+ [*模型训练结构：*](data-api-dp-ml-training.md#data-api-dp-ml-training-model-training-structures-spacer)
+ [CustomModelTrainingParameters（结构）](data-api-dp-ml-training.md#CustomModelTrainingParameters)
+ [Neptune ML 学习模型转换 API](data-api-dp-ml-transform.md)
+ [StartMLModelTransformJob（操作）](data-api-dp-ml-transform.md#StartMLModelTransformJob)
+ [ListMLModelTransformJobs（操作）](data-api-dp-ml-transform.md#ListMLModelTransformJobs)
+ [GetMLModelTransformJob（操作）](data-api-dp-ml-transform.md#GetMLModelTransformJob)
+ [CancelMLModelTransformJob（操作）](data-api-dp-ml-transform.md#CancelMLModelTransformJob)
+ [*模型转换结构：*](data-api-dp-ml-transform.md#data-api-dp-ml-transform-model-transform-structures-spacer)
+ [CustomModelTransformParameters（结构）](data-api-dp-ml-transform.md#CustomModelTransformParameters)
+ [Neptune ML 推理端点 API](data-api-dp-inference.md)
+ [CreateMLEndpoint（操作）](data-api-dp-inference.md#CreateMLEndpoint)
+ [ListMLEndpoints（操作）](data-api-dp-inference.md#ListMLEndpoints)
+ [GetMLEndpoint（操作）](data-api-dp-inference.md#GetMLEndpoint)
+ [DeleteMLEndpoint（操作）](data-api-dp-inference.md#DeleteMLEndpoint)
+ [Neptune 数据面板 API 异常](data-api-dp-errors.md)
+ [AccessDeniedException（结构）](data-api-dp-errors.md#AccessDeniedException)
+ [BadRequestException（结构）](data-api-dp-errors.md#BadRequestException)
+ [BulkLoadIdNotFoundException（结构）](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [CancelledByUserException（结构）](data-api-dp-errors.md#CancelledByUserException)
+ [ClientTimeoutException（结构）](data-api-dp-errors.md#ClientTimeoutException)
+ [ConcurrentModificationException（结构）](data-api-dp-errors.md#ConcurrentModificationException)
+ [ConstraintViolationException（结构）](data-api-dp-errors.md#ConstraintViolationException)
+ [ExpiredStreamException（结构）](data-api-dp-errors.md#ExpiredStreamException)
+ [FailureByQueryException（结构）](data-api-dp-errors.md#FailureByQueryException)
+ [IllegalArgumentException（结构）](data-api-dp-errors.md#IllegalArgumentException)
+ [InternalFailureException（结构）](data-api-dp-errors.md#InternalFailureException)
+ [InvalidArgumentException（结构）](data-api-dp-errors.md#InvalidArgumentException)
+ [InvalidNumericDataException（结构）](data-api-dp-errors.md#InvalidNumericDataException)
+ [InvalidParameterException（结构）](data-api-dp-errors.md#InvalidParameterException)
+ [LoadUrlAccessDeniedException（结构）](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [MalformedQueryException（结构）](data-api-dp-errors.md#MalformedQueryException)
+ [MemoryLimitExceededException（结构）](data-api-dp-errors.md#MemoryLimitExceededException)
+ [MethodNotAllowedException（结构）](data-api-dp-errors.md#MethodNotAllowedException)
+ [MissingParameterException（结构）](data-api-dp-errors.md#MissingParameterException)
+ [MLResourceNotFoundException（结构）](data-api-dp-errors.md#MLResourceNotFoundException)
+ [ParsingException（结构）](data-api-dp-errors.md#ParsingException)
+ [PreconditionsFailedException（结构）](data-api-dp-errors.md#PreconditionsFailedException)
+ [QueryLimitExceededException（结构）](data-api-dp-errors.md#QueryLimitExceededException)
+ [QueryLimitException（结构）](data-api-dp-errors.md#QueryLimitException)
+ [QueryTooLargeException（结构）](data-api-dp-errors.md#QueryTooLargeException)
+ [ReadOnlyViolationException（结构）](data-api-dp-errors.md#ReadOnlyViolationException)
+ [S3Exception（结构）](data-api-dp-errors.md#S3Exception)
+ [ServerShutdownException（结构）](data-api-dp-errors.md#ServerShutdownException)
+ [StatisticsNotAvailableException（结构）](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [StreamRecordsNotFoundException（结构）](data-api-dp-errors.md#StreamRecordsNotFoundException)
+ [ThrottlingException（结构）](data-api-dp-errors.md#ThrottlingException)
+ [TimeLimitExceededException（结构）](data-api-dp-errors.md#TimeLimitExceededException)
+ [TooManyRequestsException（结构）](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException（结构）](data-api-dp-errors.md#UnsupportedOperationException)
+ [UnloadUrlAccessDeniedException（结构）](data-api-dp-errors.md#UnloadUrlAccessDeniedException)
# Neptune 数据平面引擎、快速重置和通用结构 API
**引擎操作：**
+ [GetEngineStatus（操作）](#GetEngineStatus)
+ [ExecuteFastReset（操作）](#ExecuteFastReset)
**引擎操作结构：**
+ [QueryLanguageVersion（结构）](#QueryLanguageVersion)
+ [FastResetToken（结构）](#FastResetToken)
## GetEngineStatus（操作）
此 API 的 AWS CLI 名称为：`get-engine-status`。
检索主机上图形数据库的状态。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetEngineStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus) IAM 操作的策略。
**请求**
+ *无请求参数。*
**响应**
+ **dbEngineVersion** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
设置为在数据库集群上运行的 Neptune 引擎版本。如果此引擎版本发布以来已手动安装补丁程序，则版本号添加前缀 `Patch-`。
+ **dfeQueryEngine** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
如果 DFE 引擎已完全启用，则设置为 `enabled`；或者如果 DFE 引擎仅用于 `useDFE` 查询提示设置为 `true` 的查询，则设置为 `viaQueryHint`（默认值）。
+ **features** – 它是键值对的映射数组，其中：
每个键都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
每个值都是一个文档，类型为：`document`（由类似 JSON 的数据模型表示的与协议无关的开放内容）。
包含有关在您的数据库集群上启用的特征的状态信息。
+ **gremlin** – 一个 [QueryLanguageVersion](#QueryLanguageVersion) 对象。
包含有关您的集群上可用的 Gremlin 查询语言的信息。具体而言，它包含一个版本字段，用于指定引擎正在使用的当前 TinkerPop 版本。
+ **labMode** – 它是键值对的映射数组，其中：
每个键都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
每个值都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
包含引擎正在使用的实验室模式设置。
+ **opencypher** – 一个 [QueryLanguageVersion](#QueryLanguageVersion) 对象。
包含有关您的集群上可用的 openCypher 查询语言的信息。具体而言，它包含一个版本字段，用于指定引擎正在使用的当前 OperCypher 版本。
+ **role** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
如果实例为只读副本，则设置为 `reader`；如果实例为主实例，则设置为 `writer`。
+ **rollingBackTrxCount** – 一个整数，类型为：`integer`（带符号的 32 位整数）。
如果有事务正在回滚，则此字段将设置为此类事务的数量。如果没有，则该字段根本不会出现。
+ **rollingBackTrxEarliestStartTime** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
设置为正在回滚的最早事务的开始时间。如果没有回滚任何事务，则该字段根本不会出现。
+ **settings** – 它是键值对的映射数组，其中：
每个键都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
每个值都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
包含有关数据库集群上的当前设置的信息。例如，包含当前集群查询超时设置（`clusterQueryTimeoutInMs`）。
+ **sparql** – 一个 [QueryLanguageVersion](#QueryLanguageVersion) 对象。
包含有关您的集群上可用的 SPARQL 查询语言的信息。具体而言，它包含一个版本字段，用于指定引擎正在使用的当前 SPARQL 版本。
+ **startTime** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
设置为当前服务器进程启动的 UTC 时间。
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
如果实例没有遇到问题，则设置为 `healthy`。如果实例从崩溃中恢复或者进行了重启，并且最近一次服务器关闭时仍有活动的事务在运行，则状态设置为 `recovery`。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## ExecuteFastReset（操作）
此 API 的 AWS CLI 名称为：`execute-fast-reset`。
快速重置 REST API 允许您快速轻松地重置 Neptune 图形，同时移除其所有数据。
Neptune 快速重置是一个两步过程。首先，在 `action` 设置为 `initiateDatabaseReset` 的情况下调用 `ExecuteFastReset`。这将返回一个 UUID 令牌，然后在 `action` 设置为 `performDatabaseReset` 的情况下再次调用 `ExecuteFastReset` 时包含该令牌。请参阅[使用快速重置 API 清空 Amazon Neptune 数据库集群](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:ResetDatabase](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase) IAM 操作的策略。
**请求**
+ **action**（在 CLI 中：`--action`）– *必需：*一个操作，类型为：`string`（UTF-8 编码的字符串）。
快速重置操作。下列值之一：
+ **`initiateDatabaseReset`** – 此操作会生成实际执行快速重置所需的唯一令牌。
+ **`performDatabaseReset`** – 此操作使用 `initiateDatabaseReset` 操作生成的令牌来实际执行快速重置。
+ **token**（在 CLI 中：`--token`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
用于启动重置的快速重置令牌。
**响应**
+ **payload** – 一个 [FastResetToken](#FastResetToken) 对象。
`payload` 仅由 `initiateDatabaseReset` 操作返回，并包含用于 `performDatabaseReset` 操作以实现重置的唯一令牌。
+ **status** – *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
`status` 仅针对 `performDatabaseReset` 操作返回，表示快速重置请求是否被接受。
**错误**
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [ServerShutdownException](data-api-dp-errors.md#ServerShutdownException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MethodNotAllowedException](data-api-dp-errors.md#MethodNotAllowedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## *引擎操作结构：*
## QueryLanguageVersion（结构）
用于表达查询语言版本的结构。
**Fields**
+ **version** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
查询语言的版本。
## FastResetToken（结构）
包含用于启动快速重置的快速重置令牌的结构。
**Fields**
+ **token** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
由数据库在 `initiateDatabaseReset` 操作中生成的 UUID，然后 `performDatabaseReset` 使用它来重置数据库。
# Neptune 查询 API
**Gremlin 查询操作：**
+ [ExecuteGremlinQuery（操作）](#ExecuteGremlinQuery)
+ [ExecuteGremlinExplainQuery（操作）](#ExecuteGremlinExplainQuery)
+ [ExecuteGremlinProfileQuery（操作）](#ExecuteGremlinProfileQuery)
+ [ListGremlinQueries（操作）](#ListGremlinQueries)
+ [GetGremlinQueryStatus（操作）](#GetGremlinQueryStatus)
+ [CancelGremlinQuery（操作）](#CancelGremlinQuery)
**openCypher 查询操作：**
+ [ExecuteOpenCypherQuery（操作）](#ExecuteOpenCypherQuery)
+ [ExecuteOpenCypherExplainQuery（操作）](#ExecuteOpenCypherExplainQuery)
+ [ListOpenCypherQueries（操作）](#ListOpenCypherQueries)
+ [GetOpenCypherQueryStatus（操作）](#GetOpenCypherQueryStatus)
+ [CancelOpenCypherQuery（操作）](#CancelOpenCypherQuery)
**查询结构：**
+ [QueryEvalStats（结构）](#QueryEvalStats)
+ [GremlinQueryStatus（结构）](#GremlinQueryStatus)
+ [GremlinQueryStatusAttributes（结构）](#GremlinQueryStatusAttributes)
## ExecuteGremlinQuery（操作）
此 API 的 AWS CLI 名称为：`execute-gremlin-query`。
此命令执行一个 Gremlin 查询。Amazon Neptune 与 Apache TinkerPop3 和 Gremlin 兼容，因此，您可以使用 Gremlin 遍历语言来查询图形，正如 Apache TinkerPop3 文档的[图形](https://tinkerpop.apache.org/docs/current/reference/#graph)中所述。更多详细信息也可以在[使用 Gremlin 访问 Neptune 图形](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html)中找到。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加一个策略，该策略允许在该集群中执行以下 IAM 操作之一，具体取决于查询：
+ [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptune-db:WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptune-db:DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
请注意，可以在策略文档中使用 [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 条件键来限制 Gremlin 查询的使用（请参阅 [Neptune IAM 数据访问策略声明中提供的条件键](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)）。
**请求**
+ **gremlinQuery**（在 CLI 中：`--gremlin-query`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
使用此 API，您可以像使用 HTTP 端点一样以字符串格式运行 Gremlin 查询。该接口与您的数据库集群使用的任何 Gremlin 版本兼容（请参阅 [Tinkerpop 客户端部分](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest)以确定您的引擎版本支持哪些 Gremlin 版本）。
+ **serializer**（在 CLI 中：`--serializer`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
如果不为 null，则在以该参数指定的格式序列化的响应消息中返回查询结果。有关当前支持的格式列表，请参阅 TinkerPop 文档中的 [GraphSON](https://tinkerpop.apache.org/docs/current/reference/#_graphson) 部分。
**响应**
+ **meta** – 文档，类型为：`document`（由类似 JSON 的数据模型表示的与协议无关的开放内容）。
有关 Gremlin 查询的元数据。
+ **requestId** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Gremlin 查询的唯一标识符。
+ **result** – 文档，类型为：`document`（由类似 JSON 的数据模型表示的与协议无关的开放内容）。
来自服务器的 Gremlin 查询输出。
+ **status** – 一个 [GremlinQueryStatusAttributes](#GremlinQueryStatusAttributes) 对象。
Gremlin 查询的状态。
**错误**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ExecuteGremlinExplainQuery（操作）
此 API 的 AWS CLI 名称为：`execute-gremlin-explain-query`。
执行 Gremlin Explain 查询。
Amazon Neptune 添加了一项名为 `explain` 的 Gremlin 特征，该特征提供了一种自助服务工具，用于了解 Neptune 引擎为查询所采用的执行方法。您可以通过将 `explain` 参数添加到提交 Gremlin 查询的 HTTP 调用来调用它。
Explain 特征提供了有关查询执行计划的逻辑结构的信息。您可以使用这些信息来识别潜在的评估和执行瓶颈，并调整查询，如[调试 Gremlin 查询](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html)中所述。您还可以使用查询提示来改进查询执行计划。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加一个策略，该策略允许在该集群中执行以下 IAM 操作之一，具体取决于查询：
+ [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptune-db:WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptune-db:DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
请注意，可以在策略文档中使用 [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 条件键来限制 Gremlin 查询的使用（请参阅 [Neptune IAM 数据访问策略声明中提供的条件键](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)）。
**请求**
+ **gremlinQuery**（在 CLI 中：`--gremlin-query`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Gremlin explain 查询字符串。
**响应**
+ **output** – 一个 ReportAsText，类型为：`blob`（未解释的二进制数据块）。
包含 Gremlin explain 结果的文本 blob，如[调整 Gremlin 查询](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html)中所述。
**错误**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ExecuteGremlinProfileQuery（操作）
此 API 的 AWS CLI 名称为：`execute-gremlin-profile-query`。
执行 Gremlin Profile 查询，该查询运行指定的遍历，收集有关运行的各种指标，并生成分析报告作为输出。有关详细信息，请参阅 [Neptune 中的 Gremlin profile API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) IAM 操作的策略。
请注意，可以在策略文档中使用 [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 条件键来限制 Gremlin 查询的使用（请参阅 [Neptune IAM 数据访问策略声明中提供的条件键](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)）。
**请求**
+ **chop**（在 CLI 中：`--chop`）– 一个整数，类型为：`integer`（带符号的 32 位整数）。
如果不为零，结果字符串将在该字符数处截断。如果设置为零，字符串将包含所有结果。
+ **gremlinQuery**（在 CLI 中：`--gremlin-query`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要分析的 Gremlin 查询字符串。
+ **indexOps**（在 CLI 中：`--index-ops`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果此标志设置为 `TRUE`，则结果包含在查询执行和序列化期间发生的所有索引操作的详细报告。
+ **results**（在 CLI 中：`--results`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果此标志设置为 `TRUE`，则收集查询结果并在分析报告中显示。如果为 `FALSE`，则仅显示结果计数。
+ **serializer**（在 CLI 中：`--serializer`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
如果不为空，则在以该参数指定的格式序列化的响应消息中返回收集的结果。有关更多信息，请参阅 [Neptune 中的 Gremlin profile API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html)。
**响应**
+ **output** – 一个 ReportAsText，类型为：`blob`（未解释的二进制数据块）。
包含 Gremlin Profile 结果的文本 blob。有关详细信息，请参阅 [Neptune 中的 Gremlin profile API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html)。
**错误**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ListGremlinQueries（操作）
此 API 的 AWS CLI 名称为：`list-gremlin-queries`。
列出活动的 Gremlin 查询。有关输出的详细信息，请参阅 [Gremlin 查询状态 API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) IAM 操作的策略。
请注意，可以在策略文档中使用 [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 条件键来限制 Gremlin 查询的使用（请参阅 [Neptune IAM 数据访问策略声明中提供的条件键](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)）。
**请求**
+ **includeWaiting**（在 CLI 中：`--include-waiting`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果设置为 `TRUE`，则返回的列表包括等待的查询。默认值为 `FALSE`；
**响应**
+ **acceptedQueryCount** – 一个整数，类型为：`integer`（带符号的 32 位整数）。
已接受但尚未完成的查询数，包括队列中的查询。
+ **queries** – [GremlinQueryStatus](#GremlinQueryStatus) 对象的数组。
当前查询的列表。
+ **runningQueryCount** – 一个整数，类型为：`integer`（带符号的 32 位整数）。
当前正在运行的 Gremlin 查询的数量。
**错误**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## GetGremlinQueryStatus（操作）
此 API 的 AWS CLI 名称为：`get-gremlin-query-status`。
获取指定的 Gremlin 查询的状态。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) IAM 操作的策略。
请注意，可以在策略文档中使用 [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 条件键来限制 Gremlin 查询的使用（请参阅 [Neptune IAM 数据访问策略声明中提供的条件键](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)）。
**请求**
+ **queryId**（在 CLI 中：`--query-id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
标识 Gremlin 查询的唯一标识符。
**响应**
+ **queryEvalStats** – 一个 [QueryEvalStats](#QueryEvalStats) 对象。
Gremlin 查询的评估状态。
+ **queryId** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
正在返回其状态的查询的 ID。
+ **queryString** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Gremlin 查询字符串。
**错误**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## CancelGremlinQuery（操作）
此 API 的 AWS CLI 名称为：`cancel-gremlin-query`。
取消 Gremlin 查询。有关更多信息，请参阅 [Gremlin 查询取消](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:CancelQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) IAM 操作的策略。
**请求**
+ **queryId**（在 CLI 中：`--query-id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
标识要取消的查询的唯一标识符。
**响应**
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
取消的状态
**错误**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## *openCypher 查询操作：*
## ExecuteOpenCypherQuery（操作）
此 API 的 AWS CLI 名称为：`execute-open-cypher-query`。
执行 openCypher 查询。有关更多信息，请参阅[使用 openCypher 访问 Neptune 图形](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html)。
Neptune 支持使用 openCypher 构建图形应用程序，openCypher 是目前使用图形数据库的开发人员最常用的查询语言之一。开发人员、业务分析师和数据科学家都喜欢 openCypher 的声明式、受 SQL 启发的语法，因为它为查询属性图提供了一种熟悉的结构。
openCypher 语言最初由 Neo4j 开发，然后于 2015 年开源，并在 Apache 2 开源许可证下为 [openCypher 项目](https://opencypher.org/)做出了贡献。
请注意，在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加一个策略，该策略允许在该集群中执行以下 IAM 操作之一，具体取决于查询：
+ [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery)
+ [neptune-db:WriteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery)
+ [neptune-db:DeleteDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery)
另请注意，可以在策略文档中使用 [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 条件键来限制 openCypher 查询的使用（请参阅 [Neptune IAM 数据访问策略声明中提供的条件键](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)）。
**请求**
+ **openCypherQuery**（在 CLI 中：`--open-cypher-query`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要执行的 openCypher 查询字符串。
+ **parameters**（在 CLI 中：`--parameters`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
用于查询执行的 openCypher 查询参数。有关更多信息，请参阅 [openCypher 参数化查询示例](https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html)。
**响应**
+ **results** – *必需：*文档，类型为：`document`（由类似 JSON 的数据模型表示的与协议无关的开放内容）。
openCypher 查询结果。
**错误**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ExecuteOpenCypherExplainQuery（操作）
此 API 的 AWS CLI 名称为：`execute-open-cypher-explain-query`。
执行 openCypher `explain` 请求。有关更多信息，请参阅 [openCypher explain 特征](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:ReadDataViaQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) IAM 操作的策略。
请注意，可以在策略文档中使用 [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 条件键来限制 openCypher 查询的使用（请参阅 [Neptune IAM 数据访问策略声明中提供的条件键](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)）。
**请求**
+ **explainMode**（在 CLI 中：`--explain-mode`）– *必需：*OpenCypherExplainMode，类型为：`string`（UTF-8 编码的字符串）。
openCypher `explain` 模式。可以为以下值之一：`static`、`dynamic` 或 `details`。
+ **openCypherQuery**（在 CLI 中：`--open-cypher-query`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
openCypher 查询字符串。
+ **parameters**（在 CLI 中：`--parameters`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
openCypher 查询参数。
**响应**
+ **results** – *必需：*Blob，类型为：`blob`（未解释的二进制数据块）。
一个包含 openCypher `explain` 结果的文本 blob。
**错误**
+ [QueryTooLargeException](data-api-dp-errors.md#QueryTooLargeException)
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [QueryLimitExceededException](data-api-dp-errors.md#QueryLimitExceededException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [QueryLimitException](data-api-dp-errors.md#QueryLimitException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [CancelledByUserException](data-api-dp-errors.md#CancelledByUserException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MalformedQueryException](data-api-dp-errors.md#MalformedQueryException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## ListOpenCypherQueries（操作）
此 API 的 AWS CLI 名称为：`list-open-cypher-queries`。
列出活动的 openCypher 查询。有关更多信息，请参阅 [Neptune openCypher 状态端点](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) IAM 操作的策略。
请注意，可以在策略文档中使用 [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 条件键来限制 openCypher 查询的使用（请参阅 [Neptune IAM 数据访问策略声明中提供的条件键](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)）。
**请求**
+ **includeWaiting**（在 CLI 中：`--include-waiting`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果设置为 `TRUE` 且其它参数不存在，则会导致为等待的查询和正在运行的查询返回状态信息。
**响应**
+ **acceptedQueryCount** – 一个整数，类型为：`integer`（带符号的 32 位整数）。
已接受但尚未完成的查询数，包括队列中的查询。
+ **queries** – [GremlinQueryStatus](#GremlinQueryStatus) 对象的数组。
当前 openCypher 查询的列表。
+ **runningQueryCount** – 一个整数，类型为：`integer`（带符号的 32 位整数）。
当前正在运行的 openCypher 查询的数量。
**错误**
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## GetOpenCypherQueryStatus（操作）
此 API 的 AWS CLI 名称为：`get-open-cypher-query-status`。
检索指定的 openCypher 查询的状态。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetQueryStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) IAM 操作的策略。
请注意，可以在策略文档中使用 [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) IAM 条件键来限制 openCypher 查询的使用（请参阅 [Neptune IAM 数据访问策略声明中提供的条件键](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)）。
**请求**
+ **queryId**（在 CLI 中：`--query-id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要检索其查询状态的 openCypher 查询的唯一 ID。
**响应**
+ **queryEvalStats** – 一个 [QueryEvalStats](#QueryEvalStats) 对象。
openCypher 查询评估状态。
+ **queryId** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
正在返回其状态的查询的唯一 ID。
+ **queryString** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
openCypher 查询字符串。
**错误**
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## CancelOpenCypherQuery（操作）
此 API 的 AWS CLI 名称为：`cancel-open-cypher-query`。
取消指定的 openCypher 查询。有关更多信息，请参阅 [Neptune openCypher 状态端点](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:CancelQuery](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) IAM 操作的策略。
**请求**
+ **queryId**（在 CLI 中：`--query-id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要取消的 openCypher 查询的唯一ID。
+ **silent**（在 CLI 中：`--silent`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果设置为 `TRUE`，则会导致以静默方式取消 openCypher 查询。
**响应**
+ **payload** - 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
openCypher 查询的取消有效负载。
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
openCypher 查询的取消状态。
**错误**
+ [InvalidNumericDataException](data-api-dp-errors.md#InvalidNumericDataException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [FailureByQueryException](data-api-dp-errors.md#FailureByQueryException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ParsingException](data-api-dp-errors.md#ParsingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [TimeLimitExceededException](data-api-dp-errors.md#TimeLimitExceededException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [ConcurrentModificationException](data-api-dp-errors.md#ConcurrentModificationException)
## *查询结构：*
## QueryEvalStats（结构）
用于捕获查询统计数据的结构，例如正在运行、接受或等待的查询数量及其详细信息。
**Fields**
+ **cancelled** - 这是一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果查询已取消，则设置为 `TRUE`，否则设置为 FALSE。
+ **elapsed** – 这是一个整数，类型为：`integer`（带符号的 32 位整数）。
到目前为止，查询已运行的毫秒数。
+ **subqueries** – 这是一个文档，类型为：`document`（由类似 JSON 的数据模型表示的与协议无关的开放内容）。
此查询中的子查询数。
+ **waited** – 这是一个整数，类型为：`integer`（带符号的 32 位整数）。
表示查询等待了多长时间（以毫秒为单位）。
## GremlinQueryStatus（结构）
捕获 Gremlin 查询的状态（请参阅 [Gremlin 查询状态 API](https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html) 页面）。
**Fields**
+ **queryEvalStats** –这是一个 [QueryEvalStats](#QueryEvalStats) 对象。
Gremlin 查询的查询统计信息。
+ **queryId** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Gremlin 查询的 ID。
+ **queryString** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Gremlin 查询的查询字符串。
## GremlinQueryStatusAttributes（结构）
包含 Gremlin 查询的状态组件。
**Fields**
+ **attributes** – 这是一个文档，类型为：`document`（由类似 JSON 的数据模型表示的与协议无关的开放内容）。
Gremlin 查询状态的属性。
+ **code** – 这是一个整数，类型为：`integer`（带符号的 32 位整数）。
从 Gremlin 查询请求返回的 HTTP 响应代码。
+ **message** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
状态消息。
# Neptune 数据面板批量加载程序 API
**批量加载操作：**
+ [StartLoaderJob（操作）](#StartLoaderJob)
+ [GetLoaderJobStatus（操作）](#GetLoaderJobStatus)
+ [ListLoaderJobs（操作）](#ListLoaderJobs)
+ [CancelLoaderJob（操作）](#CancelLoaderJob)
**批量加载结构：**
+ [LoaderIdResult（结构）](#LoaderIdResult)
## StartLoaderJob（操作）
此 API 的 AWS CLI 名称为：`start-loader-job`。
启动 Neptune 批量加载程序任务，以将数据从 Amazon S3 桶加载到 Neptune 数据库实例中。请参阅[使用 Amazon Neptune 批量加载程序摄取数据](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:StartLoaderJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startloaderjob) IAM 操作的策略。
**请求**
+ **dependencies**（在 CLI 中：`--dependencies`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
这是一个可选参数，可以使排队的加载请求取决于队列中的一个或多个先前任务的成功完成。
Neptune 可以一次对多达 64 个加载请求进行排队，前提是它们的 `queueRequest` 参数设置为 `"TRUE"`。`dependencies` 参数允许您使此类排队请求的执行取决于成功完成队列中的一个或多个指定的先前请求。
例如，如果加载 `Job-A` 和 `Job-B` 彼此独立，但加载 `Job-C` 在开始之前要求先完成 `Job-A` 和 `Job-B`，请按以下方式进行操作：
1. 不分顺序接连提交 `load-job-A` 和 `load-job-B`，并保存它们的加载 ID。
1. 提交 `load-job-C`，并在其 `dependencies` 字段中填入前两个作业的加载 ID：
**Example**
```
"dependencies" : ["(job_A_load_id)", "(job_B_load_id)"]
```
由于 `dependencies` 参数，批量加载程序在 `Job-C` 和 `Job-A` 成功完成前将不会启动 `Job-B`。如果其中任何一个作业失败，则不会执行作业 C，并将其状态设置为 `LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED`。
您可以通过这种方式设置多个依赖关系级别，这样，一个作业的失败将导致所有直接或间接依赖于该作业的请求被取消。
+ **failOnError**（在 CLI 中：`--fail-on-error`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
**`failOnError`** – 用于在出错时切换为完全停止的标志。
*允许的值*：`"TRUE"`、`"FALSE"`。
*默认值*：`"TRUE"`。
如果此参数设置为 `"FALSE"`，则加载程序尝试加载指定位置中的所有数据并跳过任何出错的条目。
将此参数设置为 `"TRUE"` 时，加载程序会在遇到错误时立即停止。截至该点加载的数据仍然存在。
+ **format**（在 CLI 中：`--format`）– *必需：*格式，类型为：`string`（UTF-8 编码的字符串）。
数据的格式。有关 Neptune `Loader` 命令的数据格式的更多信息，请参阅[加载数据格式](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html)。
**允许值**
+ **`csv`** 适用于 [Gremlin CSV 数据格式](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html)。
+ **`opencypher`** 适用于 [openCypher CSV 数据格式](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html)。
+ **`ntriples`** 适用于 [N-Triples RDF 数据格式](https://www.w3.org/TR/n-triples/)。
+ **`nquads`** 适用于 [N-Quads RDF 数据格式](https://www.w3.org/TR/n-quads/)。
+ **`rdfxml`** 适用于 [RDF\$1XML RDF 数据](https://www.w3.org/TR/rdf-syntax-grammar/)格式。
+ **`turtle`** 适用于 [Turtle RDF 数据格式](https://www.w3.org/TR/turtle/)。
+ **iamRoleArn**（在 CLI 中：`--iam-role-arn`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Neptune 数据库实例为访问 S3 桶而代入的 IAM 角色的 Amazon 资源名称 (ARN)。此处提供的 IAM 角色 ARN 应附加到数据库集群（请参阅[向 Amazon Neptune 集群添加 IAM 角色](https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html)）。
+ **mode**（在 CLI 中：`--mode`）– 一种模式，类型为：`string`（UTF-8 编码的字符串）。
加载作业模式。
*允许的值*：`RESUME`、`NEW`、`AUTO`
*默认值*：`AUTO`。
****
+ `RESUME` – 在 RESUME 模式下，加载程序查找来自此源的先前加载，如果找到一个加载，则恢复该加载任务。如果未找到之前的加载作业，则加载程序将停止。
加载程序将避免重新加载之前作业中已成功加载的文件。它仅尝试处理失败的文件。如果您从 Neptune 集群中删除了之前加载的数据，则此模式下不加载该数据。如果之前的加载任务成功加载了来自同一源的所有文件，则不会重新加载任何文件，并且加载程序返回成功。
+ `NEW` – 在 NEW 模式下，将创建新的加载请求而不管任何之前的加载。您可以使用此模式在从 Neptune 集群删除之前加载的数据之后从源重新加载数据，或加载同一个源处可用的新数据。
+ `AUTO` – 在 AUTO 模式下，加载程序查找来自此同一个源的先前加载任务，如果找到一个加载任务，则恢复该任务，如同在 `RESUME` 模式中一样。
如果加载程序没有找到来自同一源的先前加载作业，则会从源加载所有数据，就像在 `NEW` 模式中一样。
+ **parallelism**（在 CLI 中：`--parallelism`）– 并行度，类型为：`string`（UTF-8 编码的字符串）。
可以设置可选 `parallelism` 参数以减少批量加载过程使用的线程数。
*允许的值*：、、
+ `LOW` – 所使用的线程数是可用 vCPU 数除以 8。
+ `MEDIUM` – 所使用的线程数是可用 vCPU 数除以 2。
+ `HIGH` – 所使用的线程数与可用 vCPU 数相同。
+ `OVERSUBSCRIBE` – 所使用的线程数是可用 vCPU 数乘以 2。如果使用此值，则批量加载程序将占用所有可用资源。
但是，这并不意味着 `OVERSUBSCRIBE` 设置会导致 100% 的 CPU 利用率。由于负载操作受到 I/O 限制，因此预期的最高 CPU 利用率在 60% 到 70% 之间。
*默认值*：`HIGH`
在加载 openCypher 数据时，`parallelism` 设置有时会导致线程之间出现死锁。发生这种情况时，Neptune 会返回 `LOAD_DATA_DEADLOCK` 错误。通常，您可以通过将 `parallelism` 设为较低的设置并重试加载命令来解决此问题。
+ **parserConfiguration**（在 CLI 中：`--parser-configuration`）– 它是键值对的映射数组，其中：
每个键都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
每个值都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
**`parserConfiguration`** – 具有额外解析程序配置值的可选对象。每个子参数也是可选的：
****
+ **`namedGraphUri`** – 未指定任何图形时所有 RDF 格式的默认图形（适用于非 quads 格式和无图形的 NQUAD 条目）。
默认值为 `https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph`。
+ **`baseUri`** – RDF/XML 和 Turtle 格式的基本 URI。
默认值为 `https://aws.amazon.com/neptune/default`。
+ **`allowEmptyStrings`** – 加载 CSV 数据时，Gremlin 用户需要能够将空字符串值 ("") 作为节点和边缘属性传递。如果 `allowEmptyStrings` 设置为 `false`（默认值），则此类空字符串将视为 null 且不会加载。
如果 `allowEmptyStrings` 设置为 `true`，则加载程序会将空字符串视为有效的属性值并相应地加载它们。
+ **queueRequest**（在 CLI 中：`--queue-request`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
这是一个可选的标志参数，用于指示是否可以对加载请求进行排队。
您不必等到一个加载任务完成就可以发出下一个任务，因为 Neptune 可以一次对多达 64 个任务进行排队，前提是它们的 `queueRequest` 参数都设置为 `"TRUE"`。任务的队列顺序将为先进先出 (FIFO)。
如果省略 `queueRequest` 参数或将其设置为 `"FALSE"`，则如果另一个加载作业已在运行，该加载请求将失败。
*允许的值*：`"TRUE"`、`"FALSE"`。
*默认值*：`"FALSE"`。
+ **s3BucketRegion**（在 CLI 中：`--s-3-bucket-region`）– *必需：*一个 S3BucketRegion，类型为：`string`（UTF-8 编码的字符串）。
S3 桶的 Amazon 区域。这必须与数据库集群的 Amazon 区域相匹配。
+ **source**（在 CLI 中：`--source`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
`source` 参数接受标识单个文件、多个文件、一个文件夹或多个文件夹的 S3 URI。Neptune 将每个数据文件加载到任何指定的文件夹中。
URI 可以采用以下任意格式。
+ `s3://(bucket_name)/(object-key-name)`
+ `https://s3.amazonaws.com/(bucket_name)/(object-key-name)`
+ `https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)`
URI 的 `object-key-name` 元素等同于 S3 [ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) API 调用中的[前缀](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters)参数。它可以识别指定的 S3 桶中名称以该前缀开头的所有对象。可以是单个文件或文件夹，也可以是多个文件和/或文件夹。
指定的一个或多个文件夹可以包含多个顶点文件和多个边缘文件。
+ **updateSingleCardinalityProperties**（在 CLI 中：`--update-single-cardinality-properties`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
`updateSingleCardinalityProperties` 是一个可选参数，用于控制批量加载程序如何处理单基数顶点或边缘属性的新值。加载 openCypher 数据时不支持这样做。
*允许的值*：`"TRUE"`、`"FALSE"`。
*默认值*：`"FALSE"`。
默认情况下，或者当 `updateSingleCardinalityProperties` 被显式设置为 `"FALSE"` 时，加载程序将新值视为错误，因为它违反了单个基数。
另一方面，当 `updateSingleCardinalityProperties` 设置为 `"TRUE"` 时，批量加载程序会用新值替换现有值。如果在要加载的源文件中提供了多个边缘或单基数顶点属性值，则批量加载结束时的最终值可以是这些新值中的任何一个值。加载程序仅保证现有值已被其中一个新值替换。
+ **userProvidedEdgeIds**（在 CLI 中：`--user-provided-edge-ids`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
只有在加载包含关系 ID 的 openCypher 数据时，才需要此参数。当加载数据中显式提供 openCypher 关系 ID 时，必须包含此参数并将它设置为 `True`（推荐）。
如果 `userProvidedEdgeIds` 不存在或设置为 `True`，则加载过程中的每个关系文件中都必须存在 `:ID` 列。
如果 `userProvidedEdgeIds` 存在且设置为 `False`，则加载中的关系文件**不得**包含 `:ID` 列。相反，Neptune 加载程序会自动为每个关系生成一个 ID。
显式提供关系 ID 非常有用，这样加载程序就可以在 CSV 数据中的错误得到修复后恢复加载，而不必重新加载任何已经加载的关系。如果没有显式分配关系 ID，当必须更正任何关系文件时，加载程序将无法恢复失败的加载，而是必须重新加载所有关系。
**响应**
+ **payload** – *必需：*它是键值对的映射数组，其中：
每个键都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
每个值都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
包含为加载操作提供标识符的 `loadId` 名称/值对。
+ **status** – *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
HTTP 返回代码，指示加载任务的状态。
**错误**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [S3Exception](data-api-dp-errors.md#S3Exception)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## GetLoaderJobStatus（操作）
此 API 的 AWS CLI 名称为：`get-loader-job-status`。
获取有关指定的加载任务的状态信息。Neptune 跟踪最近的 1024 个批量加载任务，并且存储每个任务的最后 10000 个错误详细信息。
有关更多信息，请参阅 [Neptune 加载程序获取状态 API](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetLoaderJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getloaderjobstatus) IAM 操作的策略。
**请求**
+ **details**（在 CLI 中：`--details`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
表示是否要包括总体状态之外的详细信息的标志（`TRUE` 或 `FALSE`；默认为 `FALSE`）。
+ **errors**（在 CLI 中：`--errors`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
指示是否包含遇到的错误列表的标志（`TRUE` 或 `FALSE`；默认为 `FALSE`）。
将对错误的列表进行分页。`page` 和 `errorsPerPage` 参数允许浏览所有错误。
+ **errorsPerPage**（在 CLI 中：`--errors-per-page`）– PositiveInteger，类型为：`integer`（带符号的 32 位整数），至少为 1。
每页返回的错误数（正整数；默认为 `10`）。仅当 `errors` 参数设置为 `TRUE` 时才有效。
+ **loadId**（在 CLI 中：`--load-id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要获取其状态的加载任务的加载 ID。
+ **page**（在 CLI 中：`--page`）– PositiveInteger，类型为：`integer`（带符号的 32 位整数），至少为 1。
错误页码（正整数；默认为 `1`）。仅当 `errors` 参数设置为 `TRUE` 时才有效。
**响应**
+ **payload** – *必需：*文档，类型为：`document`（由类似 JSON 的数据模型表示的与协议无关的开放内容）。
有关加载任务的状态信息，其布局可能如下所示：
**Example**
```
{
"status" : "200 OK",
"payload" : {
"feedCount" : [
{
"LOAD_FAILED" : (number)
}
],
"overallStatus" : {
"fullUri" : "s3://(bucket)/(key)",
"runNumber" : (number),
"retryNumber" : (number),
"status" : "(string)",
"totalTimeSpent" : (number),
"startTime" : (number),
"totalRecords" : (number),
"totalDuplicates" : (number),
"parsingErrors" : (number),
"datatypeMismatchErrors" : (number),
"insertErrors" : (number),
},
"failedFeeds" : [
{
"fullUri" : "s3://(bucket)/(key)",
"runNumber" : (number),
"retryNumber" : (number),
"status" : "(string)",
"totalTimeSpent" : (number),
"startTime" : (number),
"totalRecords" : (number),
"totalDuplicates" : (number),
"parsingErrors" : (number),
"datatypeMismatchErrors" : (number),
"insertErrors" : (number),
}
],
"errors" : {
"startIndex" : (number),
"endIndex" : (number),
"loadId" : "(string),
"errorLogs" : [ ]
}
}
}
```
+ **status** – *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
请求的 HTTP 响应代码。
**错误**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## ListLoaderJobs（操作）
此 API 的 AWS CLI 名称为：`list-loader-jobs`。
检索所有活动加载程序任务的 `loadIds` 列表。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:ListLoaderJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listloaderjobs) IAM 操作的策略。
**请求**
+ **includeQueuedLoads**（在 CLI 中：`--include-queued-loads`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
一个可选参数，可用于在请求加载 ID 列表时排除排队加载请求的加载 ID，方法是将该参数设置为 `FALSE`。默认值为 `TRUE`。
+ **limit**（在 CLI 中：`--limit`）– ListLoaderJobsInputLimitInteger，类型为：`integer`（带符号的 32 位整数），不小于 1 或大于 100。
要列出的加载 ID 的数量。必须是大于零且不大于 `100`（这是默认值）的正整数。
**响应**
+ **payload** – *必填：*一个 [LoaderIdResult](#LoaderIdResult) 对象。
请求的任务 ID 列表。
+ **status** – *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回任务列表请求的状态。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## CancelLoaderJob（操作）
此 API 的 AWS CLI 名称为：`cancel-loader-job`。
取消指定的加载任务。这是一个 HTTP `DELETE` 请求。有关更多信息，请参阅 [Neptune 加载程序获取状态 API](https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:CancelLoaderJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelloaderjob) IAM 操作的策略。
**请求**
+ **loadId**（在 CLI 中：`--load-id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要删除的加载任务的 ID。
**响应**
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
取消状态。
**错误**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [BulkLoadIdNotFoundException](data-api-dp-errors.md#BulkLoadIdNotFoundException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [LoadUrlAccessDeniedException](data-api-dp-errors.md#LoadUrlAccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## *批量加载结构：*
## LoaderIdResult（结构）
包含加载 ID 的列表。
**Fields**
+ **loadIds** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
加载 ID 的列表。
# Neptune 流数据面板 API
**流访问操作：**
+ [GetPropertygraphStream（操作）](#GetPropertygraphStream)
**流数据结构：**
+ [PropertygraphRecord（结构）](#PropertygraphRecord)
+ [PropertygraphData（结构）](#PropertygraphData)
## GetPropertygraphStream（操作）
此 API 的 AWS CLI 名称为：`get-propertygraph-stream`。
获取属性图的流。
借助 Neptune Streams 特征，您可以生成完整的更改日志条目序列，以即时记录对图形数据所做的每一个更改。`GetPropertygraphStream` 使您可以为属性图收集这些更改日志条目。
需要在您的 Neptune 数据库集群上启用 Neptune 流特征。要启用流，请将 [neptune\$1streams](https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams) 数据库集群参数设置为 `1`。
请参阅[使用 Neptune Streams 实时捕获图形更改](https://docs.aws.amazon.com/neptune/latest/userguide/streams.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetStreamRecords](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords) IAM 操作的策略。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加一个策略，该策略允许执行以下 IAM 操作之一，具体取决于查询：
请注意，您可以使用以下 IAM 上下文键限制属性图查询：
+ [neptune-db:QueryLanguage:Gremlin](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys)
+ [neptune-db:QueryLanguage:OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys)
请参阅 [Neptune IAM 数据访问策略语句中提供的条件键](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)。
**请求**
+ **commitNum**（在 CLI 中：`--commit-num`）– 长整型，类型为：`long`（带符号的 64 位整数）。
从更改日志流中读取的起始记录的提交编号。当 `iteratorType` 为 `AT_SEQUENCE_NUMBER` 或 `AFTER_SEQUENCE_NUMBER` 时，此参数为必需的，当 `iteratorType` 为 `TRIM_HORIZON` 或 `LATEST` 时，忽略此参数。
+ **encoding**（在 CLI 中：`--encoding`）– 一种编码，类型为：`string`（UTF-8 编码的字符串）。
如果设置为 TRUE，Neptune 将使用 gzip 编码压缩响应。
+ **iteratorType**（在 CLI 中：`--iterator-type`）– IteratorType，类型为：`string`（UTF-8 编码的字符串）。
可以是以下值之一：
+ `AT_SEQUENCE_NUMBER` – 指示读取应该从由 `commitNum` 和 `opNum` 参数共同指定的事件序列号开始。
+ `AFTER_SEQUENCE_NUMBER` – 指示读取应该从紧接在由 `commitNum` 和 `opNum` 参数共同指定的事件序列号之后的事件序列号开始。
+ `TRIM_HORIZON` – 指示读取应该从系统中最后一条未剪裁的记录开始，该记录是更改日志流中时间最久的未过期（尚未删除）记录。
+ `LATEST` – 指示读取应该从系统中最近的记录开始，该记录是更改日志流中最新的未过期（尚未删除）记录。
+ **limit**（在 CLI 中：`--limit`）– GetPropertygraphStreamInputLimitLong，类型为：`long`（有符号的 64 位整数），不小于 1 或大于 100000。
指定要返回的最大记录数。响应还受 10 MB 大小的限制，该大小限制不能修改，并且优先级高于 `limit` 参数中指定的记录数。如果达到了 10 MB 限制，响应中将包含一条超出阈值记录。
`limit` 的范围为 1 到 100000，默认值为 10。
+ **opNum**（在 CLI 中：`--op-num`）– 长整型，类型为：`long`（带符号的 64 位整数）。
从更改日志流数据中开始读取的指定提交中的操作序列号。默认值为 `1`。
**响应**
+ **format** – *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回的更改记录的序列化格式。目前，唯一支持的值是 `PG_JSON`。
+ **lastEventId** – *必需：*它是键值对的映射数组，其中：
每个键都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
每个值都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
流响应中最后一次更改的序列标识符。
事件 ID 由两个字段组成：`commitNum`，标识更改图形的事务；`opNum`，标识该事务中的特定操作：
**Example**
```
"eventId": {
"commitNum": 12,
"opNum": 1
}
```
+ **lastTrxTimestampInMillis** – *必需：*长整型，类型为：`long`（带符号的 64 位整数）。
请求提交事务的时间（使用 Unix 纪元时间表示，单位为毫秒）。
+ **records** – *必填：*[PropertygraphRecord](#PropertygraphRecord) 对象的数组。
包含在响应中的序列化更改日志流记录的数组。
+ **totalRecords** – *必需：*一个整数，类型为：`integer`（带符号的 32 位整数）。
响应中的记录总数。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [ExpiredStreamException](data-api-dp-errors.md#ExpiredStreamException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [StreamRecordsNotFoundException](data-api-dp-errors.md#StreamRecordsNotFoundException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ThrottlingException](data-api-dp-errors.md#ThrottlingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## *流数据结构：*
## PropertygraphRecord（结构）
属性图记录的结构。
**Fields**
+ **commitTimestampInMillis** – 这是*必需的：*长整型，类型为：`long`（带符号的 64 位整数）。
请求提交事务的时间（使用 Unix 纪元时间表示，单位为毫秒）。
+ **data** – 这是*必需的：*一个 [PropertygraphData](#PropertygraphData) 对象。
序列化的 Gremlin 或 openCypher 更改记录。
+ **eventId** – 这是*必需的：*它是键值对的映射数组，其中：
每个键都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
每个值都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
流更改记录的序列标识符。
+ **isLastOp** - 这是一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
仅当此操作是其事务中的最后一个操作时才存在。如果存在，则设置为 true。它有助于确保整个事务都被消耗掉。
+ **op** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
造成更改的操作。
## PropertygraphData（结构）
Gremlin 或 openCypher 更改记录。
**Fields**
+ **from** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
如果这是一个边缘（类型 = `e`），则为相应的 `from` 顶点或源节点的 ID。
+ **id** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Gremlin 或 openCypher 元素的 ID。
+ **key** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
属性名称。对于元素标签，这是 `label`。
+ **to** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
如果这是一个边缘（类型 = `e`），则为相应的 `to` 顶点或目标节点的 ID。
+ **type** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Gremlin 或 openCypher 元素的类型。必须为以下值之一：
+ **`v1`** - Gremlin 的顶点标签或 openCypher 的节点标签。
+ **`vp`** - Gremlin 的顶点属性或 openCypher 的节点属性。
+ **`e`** - Gremlin 的边缘和边缘标签，或 openCypher 的关系和关系类型。
+ **`ep`** - Gremlin 的边缘属性或 openCypher 的关系属性。
+ **value** – 这是*必需的：*文档，类型为：`document`（由类似 JSON 的数据模型表示的与协议无关的开放内容）。
这是一个 JSON 对象，其中包含值本身的值字段和该值的 JSON 数据类型的数据类型字段：
**Example**
```
"value": {
"value": "(the new value"),
"dataType": "(the JSON datatypenew value")
}
```
# Neptune 数据面板统计数据和图形摘要 API
**属性图统计数据操作：**
+ [GetPropertygraphStatistics（操作）](#GetPropertygraphStatistics)
+ [ManagePropertygraphStatistics（操作）](#ManagePropertygraphStatistics)
+ [DeletePropertygraphStatistics（操作）](#DeletePropertygraphStatistics)
+ [GetPropertygraphSummary（操作）](#GetPropertygraphSummary)
**统计数据结构：**
+ [Statistics（结构）](#Statistics)
+ [StatisticsSummary（结构）](#StatisticsSummary)
+ [DeleteStatisticsValueMap（结构）](#DeleteStatisticsValueMap)
+ [RefreshStatisticsIdMap（结构）](#RefreshStatisticsIdMap)
+ [NodeStructure（结构）](#NodeStructure)
+ [EdgeStructure（结构）](#EdgeStructure)
+ [SubjectStructure（结构）](#SubjectStructure)
+ [PropertygraphSummaryValueMap（结构）](#PropertygraphSummaryValueMap)
+ [PropertygraphSummary（结构）](#PropertygraphSummary)
## GetPropertygraphStatistics（操作）
此 API 的 AWS CLI 名称为：`get-propertygraph-statistics`。
获取属性图统计数据（Gremlin 和 openCypher）。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetStatisticsStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus) IAM 操作的策略。
**请求**
+ *无请求参数。*
**响应**
+ **payload** – *必填：*一个 [统计数据](#Statistics) 对象。
属性图数据的统计数据。
+ **status** – *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
请求的 HTTP 返回代码。如果请求成功，则代码为 200。有关常见错误的列表，请参阅 [DFE 统计数据请求的常见错误代码](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors)。
**错误**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## ManagePropertygraphStatistics（操作）
此 API 的 AWS CLI 名称为：`manage-propertygraph-statistics`。
管理属性图统计数据的生成和使用。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:ManageStatistics](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics) IAM 操作的策略。
**请求**
+ **mode**（在 CLI 中：`--mode`）– StatisticsAutoGenerationMode，类型为：`string`（UTF-8 编码的字符串）。
统计数据生成模式。其中之一：`DISABLE_AUTOCOMPUTE`、`ENABLE_AUTOCOMPUTE` 或 `REFRESH`，最后一个模式手动触发 DFE 统计数据生成。
**响应**
+ **payload** – 一个 [RefreshStatisticsIdMap](#RefreshStatisticsIdMap) 对象。
这仅在刷新模式下才会返回。
+ **status** – *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
请求的 HTTP 返回代码。如果请求成功，则代码为 200。
**错误**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## DeletePropertygraphStatistics（操作）
此 API 的 AWS CLI 名称为：`delete-propertygraph-statistics`。
删除 Gremlin 和 openCypher（属性图）数据的统计数据。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:DeleteStatistics](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics) IAM 操作的策略。
**请求**
+ *无请求参数。*
**响应**
+ **payload** – 一个 [DeleteStatisticsValueMap](#DeleteStatisticsValueMap) 对象。
删除有效负载。
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
取消状态。
+ **statusCode** – 一个整数，类型为：`integer`（带符号的 32 位整数）。
HTTP 响应代码：如果删除成功，则为 200；如果没有要删除的统计数据，则为 204。
**错误**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## GetPropertygraphSummary（操作）
此 API 的 AWS CLI 名称为：`get-propertygraph-summary`。
获取属性图的图形摘要。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetGraphSummary](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary) IAM 操作的策略。
**请求**
+ **mode**（在 CLI 中：`--mode`）– GraphSummaryType，类型为：`string`（UTF-8 编码的字符串）。
模式可以取两个值之一：`BASIC`（默认）和 `DETAILED`。
**响应**
+ **payload** – 一个 [PropertygraphSummaryValueMap](#PropertygraphSummaryValueMap) 对象。
包含属性图摘要响应的有效负载。
+ **statusCode** – 一个整数，类型为：`integer`（带符号的 32 位整数）。
请求的 HTTP 返回代码。如果请求成功，则代码为 200。
**错误**
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [StatisticsNotAvailableException](data-api-dp-errors.md#StatisticsNotAvailableException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
## *统计数据结构：*
## Statistics（结构）
包含统计信息。在计划查询执行时，DFE 引擎使用有关 Neptune 图形中数据的信息来进行有效的权衡。这些信息采用统计数据的形式，包括可以指导查询计划的所谓特性集和谓词统计数据。请参阅[管理 Neptune DFE 要使用的统计数据](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html)。
**Fields**
+ **active** - 这是一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
表示是否启用了 DFE 统计数据生成。
+ **autoCompute** - 这是一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
表示是否启用了自动统计数据生成。
+ **date** – 这是 SyntheticTimestamp\$1date\$1time，类型为：`string`（UTF-8 编码的字符串）。
最近生成 DFE 统计数据的 UTC 时间。
+ **note** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
有关统计数据无效时出现的问题的注释。
+ **signatureInfo** –这是一个 [StatisticsSummary](#StatisticsSummary) 对象。
包含以下内容的 StatisticsSummary 结构：
+ `signatureCount` - 所有特性集中的签名总数。
+ `instanceCount` – 特性集实例的总数。
+ `predicateCount` – 唯一谓词的总数。
+ **statisticsId** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
报告当前统计数据生成运行的 ID。值为 -1 表示未生成任何统计数据。
## StatisticsSummary（结构）
有关统计数据中生成的特性集的信息。
**Fields**
+ **instanceCount** – 这是一个整数，类型为：`integer`（带符号的 32 位整数）。
特性集实例的总数。
+ **predicateCount** – 这是一个整数，类型为：`integer`（带符号的 32 位整数）。
唯一谓词的总数。
+ **signatureCount** – 这是一个整数，类型为：`integer`（带符号的 32 位整数）。
所有特性集中的签名总数。
## DeleteStatisticsValueMap（结构）
DeleteStatistics 的有效负载。
**Fields**
+ **active** - 这是一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
统计数据的当前状态。
+ **statisticsId** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
当前正在运行的统计数据生成运行的 ID。
## RefreshStatisticsIdMap（结构）
`REFRESH` 模式的统计数据。
**Fields**
+ **statisticsId** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
当前正在运行的统计数据生成运行的 ID。
## NodeStructure（结构）
节点结构。
**Fields**
+ **count** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
具有此特定结构的节点数量。
+ **distinctOutgoingEdgeLabels** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
此特定结构中存在的不同传出边缘标签列表。
+ **nodeProperties** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
此特定结构中存在的节点属性的列表。
## EdgeStructure（结构）
边缘结构。
**Fields**
+ **count** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
具有此特定结构的边缘数量。
+ **edgeProperties** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
此特定结构中存在的边缘属性的列表。
## SubjectStructure（结构）
主题结构。
**Fields**
+ **count** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
此特定结构的出现次数。
+ **predicates** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
此特定结构中存在的谓词的列表。
## PropertygraphSummaryValueMap（结构）
属性图摘要响应的有效负载。
**Fields**
+ **graphSummary** –这是一个 [PropertygraphSummary](#PropertygraphSummary) 对象。
图形摘要。
+ **lastStatisticsComputationTime** – 这是 SyntheticTimestamp\$1date\$1time，类型为：`string`（UTF-8 编码的字符串）。
Neptune 上次计算统计数据的时间戳，采用 ISO 8601 格式。
+ **version** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
此图形摘要响应的版本。
## PropertygraphSummary（结构）
图形摘要 API 会返回节点和边缘标签以及属性键的只读列表，以及节点、边缘和属性的计数。请参阅[属性图 (PG) 的图形摘要响应](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response)。
**Fields**
+ **edgeLabels** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
图形中不同边缘标签的列表。
+ **edgeProperties** – 这是 LongValuedMap 对象。它是一个键值对的映射数组，其中：
每个键都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
每个值都是长整型，类型为：`long`（有符号的 64 位整数）。
图形中不同边缘属性的列表以及使用每个属性的边缘计数。
+ **edgeStructures** – 这是 [EdgeStructure](#EdgeStructure) 对象数组。
仅当请求的模式为 `DETAILED` 时，此字段才会出现。它包含边缘结构列表。
+ **nodeLabels** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
图形中不同节点标签的列表。
+ **nodeProperties** – 这是 LongValuedMap 对象。它是一个键值对的映射数组，其中：
每个键都是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
每个值都是长整型，类型为：`long`（有符号的 64 位整数）。
图形中不同节点属性的数量。
+ **nodeStructures** – 这是 [NodeStructure](#NodeStructure) 对象数组。
仅当请求的模式为 `DETAILED` 时，此字段才会出现。它包含节点结构的列表。
+ **numEdgeLabels** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
图形中不同边缘标签的数量。
+ **numEdgeProperties** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
图形中不同边缘属性的数量。
+ **numEdges** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
图形中的边缘数。
+ **numNodeLabels** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
图形中不同节点标签的数量。
+ **numNodeProperties** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
图形中不同节点属性的列表，以及使用每个属性的节点计数。
+ **numNodes** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
图形中的节点数。
+ **totalEdgePropertyValues** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
所有边缘属性的总使用次数。
+ **totalNodePropertyValues** – 这是长整型，类型为：`long`（有符号的 64 位整数）。
所有节点属性的总使用次数。
# Neptune ML 数据处理 API
**数据处理操作：**
+ [StartMLDataProcessingJob（操作）](#StartMLDataProcessingJob)
+ [ListMLDataProcessingJobs（操作）](#ListMLDataProcessingJobs)
+ [GetMLDataProcessingJob（操作）](#GetMLDataProcessingJob)
+ [CancelMLDataProcessingJob（操作）](#CancelMLDataProcessingJob)
**ML 通用结构：**
+ [MlResourceDefinition（结构）](#MlResourceDefinition)
+ [MlConfigDefinition（结构）](#MlConfigDefinition)
## StartMLDataProcessingJob（操作）
此 API 的 AWS CLI 名称为：`start-ml-data-processing-job`。
创建新的 Neptune ML 数据处理任务，用于处理从 Neptune 导出的用于训练的图形数据。请参阅 [`dataprocessing` 命令](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:StartMLModelDataProcessingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeldataprocessingjob) IAM 操作的策略。
**请求**
+ **configFileName**（在 CLI 中：`--config-file-name`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述如何加载导出的图形数据进行训练的数据规范文件。该文件由 Neptune 导出工具包自动生成。默认值为 `training-data-configuration.json`。
+ **id**（在 CLI 中：`--id`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
新任务的唯一标识符。默认值为自动生成的 UUID。
+ **inputDataS3Location**（在 CLI 中：`--input-data-s3-location`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
您希望 SageMaker 下载运行数据处理任务所需数据的 Amazon S3 位置的 URI。
+ **modelType**（在 CLI 中：`--model-type`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Neptune ML 当前支持的两种模型类型之一：异构图模型 (`heterogeneous`) 和知识图谱 (`kge`)。默认值为“无”。如果未指定，Neptune ML 会根据数据自动选择模型类型。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
SageMaker 可以代表您执行任务的 IAM 角色的 Amazon 资源名称 (ARN)。必须将其列在您的数据库集群参数组中，否则将发生错误。
+ **previousDataProcessingJobId**（在 CLI 中：`--previous-data-processing-job-id`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
在较早版本的数据上运行的已完成数据处理任务的任务 ID。
+ **processedDataS3Location**（在 CLI 中：`--processed-data-s3-location`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
您希望 SageMaker 保存数据处理任务结果的 Amazon S3 位置的 URI。
+ **processingInstanceType**（在 CLI 中：`--processing-instance-type`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
数据处理期间使用的机器学习实例的类型。它的内存应该足够大，可以容纳处理后的数据集。默认为最小的 ml.r5 类型，其内存比磁盘上导出的图形数据大小大十倍。
+ **processingInstanceVolumeSizeInGB**（在 CLI 中：`--processing-instance-volume-size-in-gb`）– 一个整数，类型为：`integer`（带符号的 32 位整数）。
处理实例的磁盘卷大小。输入数据和处理后的数据都存储在磁盘上，因此卷大小必须足够大，以容纳两个数据集。默认值是 0。如果未指定或为 0，则 Neptune ML 会根据数据大小自动选择卷大小。
+ **processingTimeOutInSeconds**（在 CLI 中：`--processing-time-out-in-seconds`）– 一个整数，类型为：`integer`（带符号的 32 位整数）。
数据处理任务的超时（以秒为单位）。默认值为 86400（1 天）。
+ **s3OutputEncryptionKMSKey**（在 CLI 中：`--s-3-output-encryption-kms-key`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
SageMaker 用于加密处理任务的输出的 Amazon Key Management Service（Amazon KMS）密钥。默认值为“无”。
+ **sagemakerIamRoleArn**（在 CLI 中：`--sagemaker-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
用于执行 SageMaker 的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
+ **securityGroupIds**（在 CLI 中：`--security-group-ids`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
VPC 安全组 ID。默认值为 None (无)。
+ **subnets**（在 CLI 中：`--subnets`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Neptune VPC 中子网的 ID。默认值为 None (无)。
+ **volumeEncryptionKMSKey**（在 CLI 中：`--volume-encryption-kms-key`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Amazon Key Management Service (Amazon KMS) 密钥，SageMaker 使用它来加密连接到运行训练任务的 ML 计算实例的存储卷上的数据。默认值为 None (无)。
**响应**
+ **arn** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
数据处理任务的 ARN。
+ **creationTimeInMillis** – 长整型，类型为：`long`（有符号的 64 位整数）。
创建新的处理任务所花费的时间，以毫秒为单位。
+ **id** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
新数据处理任务的唯一 ID。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## ListMLDataProcessingJobs（操作）
此 API 的 AWS CLI 名称为：`list-ml-data-processing-jobs`。
返回 Neptune ML 数据处理任务的列表。请参阅[使用 Neptune ML 数据处理命令列出处于活动状态的数据处理任务](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html#machine-learning-api-dataprocessing-list-jobs)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:ListMLDataProcessingJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmldataprocessingjobs) IAM 操作的策略。
**请求**
+ **maxItems**（在 CLI 中：`--max-items`）– ListMLDataProcessingJobsInputMaxItemsInteger，类型为：`integer`（带符号的 32 位整数），不小于 1 或大于 1024。
要返回的最大项目数（从 1 到 1024；默认值为 10）。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **ids** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
列出数据处理任务 ID 的页面。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## GetMLDataProcessingJob（操作）
此 API 的 AWS CLI 名称为：`get-ml-data-processing-job`。
检索有关指定的数据处理任务的信息。请参阅 [`dataprocessing` 命令](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:neptune-db:GetMLDataProcessingJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmldataprocessingjobstatus) IAM 操作的策略。
**请求**
+ **id**（在 CLI 中：`--id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要检索的数据处理任务的唯一标识符。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **id** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
此数据处理任务的唯一标识符。
+ **processingJob** – 一个 [MlResourceDefinition](#MlResourceDefinition) 对象。
数据处理任务的定义。
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
数据处理任务的状态。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## CancelMLDataProcessingJob（操作）
此 API 的 AWS CLI 名称为：`cancel-ml-data-processing-job`。
取消 Neptune ML 数据处理任务。请参阅 [`dataprocessing` 命令](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:CancelMLDataProcessingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob) IAM 操作的策略。
**请求**
+ **clean**（在 CLI 中：`--clean`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果设置为 `TRUE`，则此标志指定在任务停止时应删除所有 Neptune ML S3 构件。默认值为 `FALSE`。
+ **id**（在 CLI 中：`--id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
数据处理任务的唯一标识符。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
取消请求的状态。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## *ML 通用结构：*
## MlResourceDefinition（结构）
定义 Neptune ML 资源。
**Fields**
+ **arn** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
资源 ARN。
+ **cloudwatchLogUrl** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
资源的 CloudWatch 日志 URL。
+ **failureReason** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
发生故障时的故障原因。
+ **name** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
资源名称。
+ **outputLocation** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
输出位置。
+ **status** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
资源状态。
## MlConfigDefinition（结构）
包含 Neptune ML 配置。
**Fields**
+ **arn** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
配置的 ARN。
+ **name** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
配置名称。
# Neptune ML 模型训练 API
**模型训练操作：**
+ [StartMLModelTrainingJob（操作）](#StartMLModelTrainingJob)
+ [ListMLModelTrainingJobs（操作）](#ListMLModelTrainingJobs)
+ [GetMLModelTrainingJob（操作）](#GetMLModelTrainingJob)
+ [CancelMLModelTrainingJob（操作）](#CancelMLModelTrainingJob)
**模型训练结构：**
+ [CustomModelTrainingParameters（结构）](#CustomModelTrainingParameters)
## StartMLModelTrainingJob（操作）
此 API 的 AWS CLI 名称为：`start-ml-model-training-job`。
创建新的 Neptune ML 模型训练任务。请参阅[使用 `modeltraining` 命令进行模型训练](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:StartMLModelTrainingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltrainingjob) IAM 操作的策略。
**请求**
+ **baseProcessingInstanceType**（在 CLI 中：`--base-processing-instance-type`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
用于准备和管理机器学习模型训练的机器学习实例的类型。这是根据用于处理训练数据和模型的内存要求选择的 CPU 实例。
+ **customModelTrainingParameters**（在 CLI 中：`--custom-model-training-parameters`） – [CustomModelTrainingParameters](#CustomModelTrainingParameters) 对象。
自定义模型训练的配置。这是 JSON 对象。
+ **dataProcessingJobId**（在 CLI 中：`--data-processing-job-id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
已完成的数据处理任务的任务 ID，该任务已创建训练将使用的数据。
+ **enableManagedSpotTraining**（在 CLI 中：`--enable-managed-spot-training`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
使用 Amazon Elastic Compute Cloud 竞价型实例优化训练机器学习模型的成本。默认值为 `False`。
+ **id**（在 CLI 中：`--id`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
新任务的唯一标识符。默认值为自动生成的 UUID。
+ **maxHPONumberOfTrainingJobs**（在 CLI 中：`--max-hpo-number-of-training-jobs`）– 一个整数，类型为：`integer`（带符号的 32 位整数）。
超参数调整任务要启动的最大训练任务总数。默认值为 2。Neptune ML 会自动调整机器学习模型的超参数。要获得性能良好的模型，请至少使用 10 个任务（换句话说，将 `maxHPONumberOfTrainingJobs` 设置为 10）。通常，调整次数越多，结果越好。
+ **maxHPOParallelTrainingJobs**（在 CLI 中：`--max-hpo-parallel-training-jobs`）– 一个整数，类型为：`integer`（带符号的 32 位整数）。
为超参数调整任务启动的最大并行训练任务数。默认值为 2。您可以运行的并行任务数量受训练实例上可用资源的限制。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
+ **previousModelTrainingJobId**（在 CLI 中：`--previous-model-training-job-id`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
已完成的模型训练任务的任务 ID，您要根据更新的数据以递增方式更新该任务。
+ **s3OutputEncryptionKMSKey**（在 CLI 中：`--s-3-output-encryption-kms-key`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
SageMaker 用于加密处理任务的输出的 Amazon Key Management Service (KMS) 密钥。默认值为“无”。
+ **sagemakerIamRoleArn**（在 CLI 中：`--sagemaker-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
用于 SageMaker 执行的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
+ **securityGroupIds**（在 CLI 中：`--security-group-ids`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
VPC 安全组 ID。默认值为 None (无)。
+ **subnets**（在 CLI 中：`--subnets`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Neptune VPC 中子网的 ID。默认值为 None (无)。
+ **trainingInstanceType**（在 CLI 中：`--training-instance-type`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
用于模型训练的 ML 实例的类型。所有 Neptune ML 模型都支持 CPU、GPU 和多 GPU 训练。默认值为 `ml.p3.2xlarge`。为训练选择正确的实例类型取决于任务类型、图形大小和预算。
+ **trainingInstanceVolumeSizeInGB**（在 CLI 中：`--training-instance-volume-size-in-gb`）– 一个整数，类型为：`integer`（带符号的 32 位整数）。
训练实例的磁盘卷大小。输入数据和输出模型都存储在磁盘上，因此卷大小必须足够大，以容纳两个数据集。默认值是 0。如果未指定或为 0，Neptune ML 会根据数据处理步骤中生成的建议选择磁盘卷大小。
+ **trainingTimeOutInSeconds**（在 CLI 中：`--training-time-out-in-seconds`）– 一个整数，类型为：`integer`（带符号的 32 位整数）。
训练任务的超时（以秒为单位）。默认值为 86400（1 天）。
+ **trainModelS3Location**（在 CLI 中：`--train-model-s3-location`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Amazon S3 中要存储模型构件的位置。
+ **volumeEncryptionKMSKey**（在 CLI 中：`--volume-encryption-kms-key`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Amazon Key Management Service (KMS) 密钥，SageMaker 使用它来加密连接到运行训练任务的 ML 计算实例的存储卷上的数据。默认值为 None (无)。
**响应**
+ **arn** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
新模型训练任务的 ARN。
+ **creationTimeInMillis** – 长整型，类型为：`long`（有符号的 64 位整数）。
模型训练任务创建时间，以毫秒为单位。
+ **id** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
新模型训练任务的唯一 ID。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## ListMLModelTrainingJobs（操作）
此 API 的 AWS CLI 名称为：`list-ml-model-training-jobs`。
列出 Neptune ML 模型训练任务。请参阅[使用 `modeltraining` 命令进行模型训练](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:neptune-db:ListMLModelTrainingJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#neptune-db:listmlmodeltrainingjobs) IAM 操作的策略。
**请求**
+ **maxItems**（在 CLI 中：`--max-items`）– ListMLModelTrainingJobsInputMaxItemsInteger，类型为：`integer`（带符号的 32 位整数），不小于 1 或大于 1024。
要返回的最大项目数（从 1 到 1024；默认值为 10）。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **ids** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
模型训练任务 ID 列表的页面。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## GetMLModelTrainingJob（操作）
此 API 的 AWS CLI 名称为：`get-ml-model-training-job`。
检索有关 Neptune ML 模型训练任务的信息。请参阅[使用 `modeltraining` 命令进行模型训练](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetMLModelTrainingJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltrainingjobstatus) IAM 操作的策略。
**请求**
+ **id**（在 CLI 中：`--id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要检索的模型训练任务的唯一标识符。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **hpoJob** – 一个 [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 对象。
HPO 任务。
+ **id** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
此模型训练任务的唯一标识符。
+ **mlModels** – [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition) 对象的数组。
正在使用的机器学习模型的配置列表。
+ **modelTransformJob** – 一个 [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 对象。
模型转换任务。
+ **processingJob** – 一个 [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 对象。
数据处理任务。
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
模型训练任务的状态。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## CancelMLModelTrainingJob（操作）
此 API 的 AWS CLI 名称为：`cancel-ml-model-training-job`。
取消 Neptune ML 模型训练任务。请参阅[使用 `modeltraining` 命令进行模型训练](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:CancelMLModelTrainingJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltrainingjob) IAM 操作的策略。
**请求**
+ **clean**（在 CLI 中：`--clean`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果设置为 `TRUE`，则此标志指定在任务停止时应删除所有 Amazon S3 构件。默认值为 `FALSE`。
+ **id**（在 CLI 中：`--id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要取消的模型训练任务的唯一标识符。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
取消的状态。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## *模型训练结构：*
## CustomModelTrainingParameters（结构）
包含自定义模型训练参数。请参阅 [Neptune ML 中的自定义模型](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.html)。
**Fields**
+ **sourceS3DirectoryPath** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
实现您的模型的 Python 模块所在的 Amazon S3 位置的路径。这必须指向有效的现有 Amazon S3 位置，其中至少包含训练脚本、转换脚本和 `model-hpo-configuration.json` 文件。
+ **trainingEntryPointScript** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
执行模型训练并将超参数作为命令行参数（包括固定的超参数）的脚本模块中入口点的名称。默认值为 `training.py`。
+ **transformEntryPointScript** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
脚本模块中入口点的名称，该脚本应在确定超参数搜索中的最佳模型之后运行，以计算模型部署所需的模型构件。它应该能够在没有命令行参数的情况下运行。默认值为 `transform.py`。
# Neptune ML 学习模型转换 API
**模型转换操作：**
+ [StartMLModelTransformJob（操作）](#StartMLModelTransformJob)
+ [ListMLModelTransformJobs（操作）](#ListMLModelTransformJobs)
+ [GetMLModelTransformJob（操作）](#GetMLModelTransformJob)
+ [CancelMLModelTransformJob（操作）](#CancelMLModelTransformJob)
**模型转换结构：**
+ [CustomModelTransformParameters（结构）](#CustomModelTransformParameters)
## StartMLModelTransformJob（操作）
此 API 的 AWS CLI 名称为：`start-ml-model-transform-job`。
创建新的模型转换任务。请参阅[使用经过训练的模型生成新的模型构件](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:StartMLModelTransformJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltransformjob) IAM 操作的策略。
**请求**
+ **baseProcessingInstanceType**（在 CLI 中：`--base-processing-instance-type`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
用于准备和管理机器学习模型训练的机器学习实例的类型。这是根据用于处理训练数据和模型的内存要求选择的 ML 计算实例。
+ **baseProcessingInstanceVolumeSizeInGB**（在 CLI 中：`--base-processing-instance-volume-size-in-gb`）– 一个整数，类型为：`integer`（带符号的 32 位整数）。
训练实例的磁盘卷大小（以 GB 为单位）。默认值是 0。输入数据和输出模型都存储在磁盘上，因此卷大小必须足够大，以容纳两个数据集。如果未指定或为 0，Neptune ML 会根据数据处理步骤中生成的建议选择磁盘卷大小。
+ **customModelTransformParameters**（在 CLI 中：`--custom-model-transform-parameters`） – [CustomModelTransformParameters](#CustomModelTransformParameters) 对象。
使用自定义模型进行模型转换的配置信息。`customModelTransformParameters` 对象包含以下字段，这些字段的值必须与训练任务中保存的模型参数兼容：
+ **dataProcessingJobId**（在 CLI 中：`--data-processing-job-id`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
已完成的数据处理任务的任务 ID。您必须包含 `dataProcessingJobId` 和 `mlModelTrainingJobId` 或 `trainingJobName`。
+ **id**（在 CLI 中：`--id`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
新任务的唯一标识符。默认值为自动生成的 UUID。
+ **mlModelTrainingJobId**（在 CLI 中：`--ml-model-training-job-id`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
已完成的模型训练任务的任务 ID。您必须包含 `dataProcessingJobId` 和 `mlModelTrainingJobId` 或 `trainingJobName`。
+ **modelTransformOutputS3Location**（在 CLI 中：`--model-transform-output-s3-location`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Amazon S3 中要存储模型构件的位置。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
+ **s3OutputEncryptionKMSKey**（在 CLI 中：`--s-3-output-encryption-kms-key`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
SageMaker 用于加密处理任务的输出的 Amazon Key Management Service (KMS) 密钥。默认值为“无”。
+ **sagemakerIamRoleArn**（在 CLI 中：`--sagemaker-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
用于执行 SageMaker 的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
+ **securityGroupIds**（在 CLI 中：`--security-group-ids`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
VPC 安全组 ID。默认值为 None (无)。
+ **subnets**（在 CLI 中：`--subnets`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Neptune VPC 中子网的 ID。默认值为 None (无)。
+ **trainingJobName**（在 CLI 中：`--training-job-name`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
已完成的 SageMaker 训练任务的名称。您必须包含 `dataProcessingJobId` 和 `mlModelTrainingJobId` 或 `trainingJobName`。
+ **volumeEncryptionKMSKey**（在 CLI 中：`--volume-encryption-kms-key`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Amazon Key Management Service (KMS) 密钥，SageMaker 使用它来加密连接到运行训练任务的 ML 计算实例的存储卷上的数据。默认值为 None (无)。
**响应**
+ **arn** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
模型转换任务的 ARN。
+ **creationTimeInMillis** – 长整型，类型为：`long`（有符号的 64 位整数）。
模型转换任务的创建时间，以毫秒为单位。
+ **id** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
新模型转换任务的唯一 ID。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## ListMLModelTransformJobs（操作）
此 API 的 AWS CLI 名称为：`list-ml-model-transform-jobs`。
返回模型转换任务 ID 的列表。请参阅[使用经过训练的模型生成新的模型构件](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:ListMLModelTransformJobs](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlmodeltransformjobs) IAM 操作的策略。
**请求**
+ **maxItems**（在 CLI 中：`--max-items`）– ListMLModelTransformJobsInputMaxItemsInteger，类型为：`integer`（带符号的 32 位整数），不小于 1 或大于 1024。
要返回的最大项目数（从 1 到 1024；默认值为 10）。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **ids** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
模型转换 ID 列表中的一页。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## GetMLModelTransformJob（操作）
此 API 的 AWS CLI 名称为：`get-ml-model-transform-job`。
获取有关指定的模型转换任务的信息。请参阅[使用经过训练的模型生成新的模型构件](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetMLModelTransformJobStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltransformjobstatus) IAM 操作的策略。
**请求**
+ **id**（在 CLI 中：`--id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要检索的模型转换的唯一标识符。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **baseProcessingJob** – 一个 [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 对象。
基础数据处理任务。
+ **id** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要检索的模型转换任务的唯一标识符。
+ **models** – [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition) 对象的数组。
所用模型的配置信息列表。
+ **remoteModelTransformJob** – 一个 [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 对象。
远程模型转换任务。
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
模型转换任务的状态。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## CancelMLModelTransformJob（操作）
此 API 的 AWS CLI 名称为：`cancel-ml-model-transform-job`。
取消指定的模型转换任务。请参阅[使用经过训练的模型生成新的模型构件](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:CancelMLModelTransformJob](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob) IAM 操作的策略。
**请求**
+ **clean**（在 CLI 中：`--clean`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果将此标志设置为 `TRUE`，则应在任务停止时删除所有 Neptune ML S3 构件。默认值为 `FALSE`。
+ **id**（在 CLI 中：`--id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
要取消的模型转换任务的唯一 ID。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
取消的状态。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## *模型转换结构：*
## CustomModelTransformParameters（结构）
包含自定义模型转换参数。请参阅[使用经过训练的模型生成新的模型构件](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html)。
**Fields**
+ **sourceS3DirectoryPath** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
实现您的模型的 Python 模块所在的 Amazon S3 位置的路径。这必须指向有效的现有 Amazon S3 位置，其中至少包含训练脚本、转换脚本和 `model-hpo-configuration.json` 文件。
+ **transformEntryPointScript** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。
脚本模块中入口点的名称，该脚本应在确定超参数搜索中的最佳模型之后运行，以计算模型部署所需的模型构件。它应该能够在没有命令行参数的情况下运行。默认值为 `transform.py`。
# Neptune ML 推理端点 API
**推理端点操作：**
+ [CreateMLEndpoint（操作）](#CreateMLEndpoint)
+ [ListMLEndpoints（操作）](#ListMLEndpoints)
+ [GetMLEndpoint（操作）](#GetMLEndpoint)
+ [DeleteMLEndpoint（操作）](#DeleteMLEndpoint)
## CreateMLEndpoint（操作）
此 API 的 AWS CLI 名称为：`create-ml-endpoint`。
创建新的 Neptune ML 推理端点，此推理端点允许您查询模型训练过程构造的一个特定模型。请参阅[使用端点命令管理推理端点](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:CreateMLEndpoint](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#createmlendpoint) IAM 操作的策略。
**请求**
+ **id**（在 CLI 中：`--id`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
新推理端点的唯一标识符。默认为自动生成的带有时间戳的名称。
+ **instanceCount**（在 CLI 中：`--instance-count`）– 一个整数，类型为：`integer`（带符号的 32 位整数）。
部署到端点以进行预测的最少 Amazon EC2 实例数量。默认值为 1
+ **instanceType**（在 CLI 中：`--instance-type`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
用于在线服务的 Neptune ML 实例的类型。默认值为 `ml.m5.xlarge`。为推理端点选择 ML 实例取决于任务类型、图形大小和预算。
+ **mlModelTrainingJobId**（在 CLI 中：`--ml-model-training-job-id`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
已完成的模型训练任务的任务 ID，该任务创建了推理端点将指向的模型。您必须提供 `mlModelTrainingJobId` 或 `mlModelTransformJobId`。
+ **mlModelTransformJobId**（在 CLI 中：`--ml-model-transform-job-id`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
已完成的模型转换任务的任务 ID。您必须提供 `mlModelTrainingJobId` 或 `mlModelTransformJobId`。
+ **modelName**（在 CLI 中：`--model-name`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
用于训练的模型类型。默认情况下，Neptune ML 模型是根据数据处理中使用的 `modelType` 自动生成的，但您可以在此处指定不同的模型类型。默认情况下，`rgcn` 用于异构图形，`kge` 用于知识图谱。对于异构图，唯一有效值为 `rgcn`。知识图谱的有效值为：`kge`、`transe`、`distmult` 和 `rotate`。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将引发错误。
+ **update**（在 CLI 中：`--update`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果设置为 `true`，则 `update` 表示这是更新请求。默认值为 `false`。您必须提供 `mlModelTrainingJobId` 或 `mlModelTransformJobId`。
+ **volumeEncryptionKMSKey**（在 CLI 中：`--volume-encryption-kms-key`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
Amazon Key Management Service (Amazon KMS) 密钥，SageMaker 使用它来加密连接到运行训练任务的 ML 计算实例的存储卷上的数据。默认值为 None (无)。
**响应**
+ **arn** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
新推理端点的 ARN。
+ **creationTimeInMillis** – 长整型，类型为：`long`（有符号的 64 位整数）。
端点创建时间，以毫秒为单位。
+ **id** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
新推理端点的唯一 ID。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## ListMLEndpoints（操作）
此 API 的 AWS CLI 名称为：`list-ml-endpoints`。
列出现有的推理端点。请参阅[使用端点命令管理推理端点](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:ListMLEndpoints](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlendpoints) IAM 操作的策略。
**请求**
+ **maxItems**（在 CLI 中：`--max-items`）– ListMLEndpointsInputMaxItemsInteger，类型为：`integer`（带符号的 32 位整数），不小于 1 或大于 1024。
要返回的最大项目数（从 1 到 1024；默认值为 10）。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **ids** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
推理端点 ID 列表中的一页。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## GetMLEndpoint（操作）
此 API 的 AWS CLI 名称为：`get-ml-endpoint`。
检索有关推理端点的详细信息。请参阅[使用端点命令管理推理端点](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:GetMLEndpointStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlendpointstatus) IAM 操作的策略。
**请求**
+ **id**（在 CLI 中：`--id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
推理端点的唯一标识符。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将发生错误。
**响应**
+ **endpoint** – 一个 [MlResourceDefinition](data-api-dp-ml-data-processing.md#MlResourceDefinition) 对象。
端点定义。
+ **endpointConfig** – 一个 [MlConfigDefinition](data-api-dp-ml-data-processing.md#MlConfigDefinition) 对象。
端点配置。
+ **id** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
推理端点的唯一标识符。
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
推理端点的状态。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
## DeleteMLEndpoint（操作）
此 API 的 AWS CLI 名称为：`delete-ml-endpoint`。
取消创建 Neptune ML 推理端点。请参阅[使用端点命令管理推理端点](https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html)。
在启用了 IAM 身份验证的 Neptune 集群中调用此操作时，发出请求的 IAM 用户或角色必须附加允许在该集群中执行 [neptune-db:DeleteMLEndpoint](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint) IAM 操作的策略。
**请求**
+ **clean**（在 CLI 中：`--clean`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。
如果将此标志设置为 `TRUE`，则应在任务停止时删除所有 Neptune ML S3 构件。默认值为 `FALSE`。
+ **id**（在 CLI 中：`--id`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
推理端点的唯一标识符。
+ **neptuneIamRoleArn**（在 CLI 中：`--neptune-iam-role-arn`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中，否则将引发错误。
**响应**
+ **status** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。
取消的状态。
**错误**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [BadRequestException](data-api-dp-errors.md#BadRequestException)
+ [MLResourceNotFoundException](data-api-dp-errors.md#MLResourceNotFoundException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
# Neptune 数据面板 API 异常
**异常：**
+ [AccessDeniedException（结构）](#AccessDeniedException)
+ [BadRequestException（结构）](#BadRequestException)
+ [BulkLoadIdNotFoundException（结构）](#BulkLoadIdNotFoundException)
+ [CancelledByUserException（结构）](#CancelledByUserException)
+ [ClientTimeoutException（结构）](#ClientTimeoutException)
+ [ConcurrentModificationException（结构）](#ConcurrentModificationException)
+ [ConstraintViolationException（结构）](#ConstraintViolationException)
+ [ExpiredStreamException（结构）](#ExpiredStreamException)
+ [FailureByQueryException（结构）](#FailureByQueryException)
+ [IllegalArgumentException（结构）](#IllegalArgumentException)
+ [InternalFailureException（结构）](#InternalFailureException)
+ [InvalidArgumentException（结构）](#InvalidArgumentException)
+ [InvalidNumericDataException（结构）](#InvalidNumericDataException)
+ [InvalidParameterException（结构）](#InvalidParameterException)
+ [LoadUrlAccessDeniedException（结构）](#LoadUrlAccessDeniedException)
+ [MalformedQueryException（结构）](#MalformedQueryException)
+ [MemoryLimitExceededException（结构）](#MemoryLimitExceededException)
+ [MethodNotAllowedException（结构）](#MethodNotAllowedException)
+ [MissingParameterException（结构）](#MissingParameterException)
+ [MLResourceNotFoundException（结构）](#MLResourceNotFoundException)
+ [ParsingException（结构）](#ParsingException)
+ [PreconditionsFailedException（结构）](#PreconditionsFailedException)
+ [QueryLimitExceededException（结构）](#QueryLimitExceededException)
+ [QueryLimitException（结构）](#QueryLimitException)
+ [QueryTooLargeException（结构）](#QueryTooLargeException)
+ [ReadOnlyViolationException（结构）](#ReadOnlyViolationException)
+ [S3Exception（结构）](#S3Exception)
+ [ServerShutdownException（结构）](#ServerShutdownException)
+ [StatisticsNotAvailableException（结构）](#StatisticsNotAvailableException)
+ [StreamRecordsNotFoundException（结构）](#StreamRecordsNotFoundException)
+ [ThrottlingException（结构）](#ThrottlingException)
+ [TimeLimitExceededException（结构）](#TimeLimitExceededException)
+ [TooManyRequestsException（结构）](#TooManyRequestsException)
+ [UnsupportedOperationException（结构）](#UnsupportedOperationException)
+ [UnloadUrlAccessDeniedException（结构）](#UnloadUrlAccessDeniedException)
## AccessDeniedException（结构）
在身份验证或授权失败时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## BadRequestException（结构）
当提交了无法处理的请求时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
不正确的请求的 ID。
## BulkLoadIdNotFoundException（结构）
当找不到指定的批量加载任务 ID 时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
找不到的批量加载任务 ID
## CancelledByUserException（结构）
当用户取消请求时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## ClientTimeoutException（结构）
当客户端中的请求发生超时时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## ConcurrentModificationException（结构）
当请求尝试修改其它进程同时修改的数据时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## ConstraintViolationException（结构）
当请求字段中的值不满足所需的约束条件时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## ExpiredStreamException（结构）
当请求尝试访问已过期的流时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## FailureByQueryException（结构）
请求失败时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## IllegalArgumentException（结构）
不支持请求中的参数时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## InternalFailureException（结构）
请求处理意外失败时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## InvalidArgumentException（结构）
当请求中的参数具有无效值时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## InvalidNumericDataException（结构）
在为请求提供服务时遇到无效的数值数据时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## InvalidParameterException（结构）
当参数值无效时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
包含无效参数的请求的 ID。
## LoadUrlAccessDeniedException（结构）
当拒绝访问指定的加载 URL 时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## MalformedQueryException（结构）
当提交的查询语法不正确或未通过额外验证时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
格式错误的查询请求的 ID。
## MemoryLimitExceededException（结构）
当请求因内存资源不足而失败时引发。可以重试该请求。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
失败的请求的 ID。
## MethodNotAllowedException（结构）
当所使用的端点不支持请求使用的 HTTP 方法时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## MissingParameterException（结构）
缺少必需的参数时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
缺少参数的请求的 ID。
## MLResourceNotFoundException（结构）
当找不到指定的机器学习资源时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## ParsingException（结构）
遇到解析问题时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## PreconditionsFailedException（结构）
当处理请求的先决条件未得到满足时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## QueryLimitExceededException（结构）
当活动查询的数量超过服务器可以处理的数量时引发。当系统不太繁忙时，可以重试有问题的查询。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
超出限制的请求的 ID。
## QueryLimitException（结构）
当查询大小超过系统限制时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
超出限制的请求的 ID。
## QueryTooLargeException（结构）
当查询的正文太大时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
过大的请求的 ID。
## ReadOnlyViolationException（结构）
当请求尝试写入只读资源时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
缺少参数的请求的 ID。
## S3Exception（结构）
在访问 Amazon S3 而出现问题时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## ServerShutdownException（结构）
当服务器在处理请求时关闭时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## StatisticsNotAvailableException（结构）
当满足请求所需的统计数据不可用时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## StreamRecordsNotFoundException（结构）
当找不到查询所请求的流记录时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## ThrottlingException（结构）
当请求的速率超出吞吐量上限时引发。遇到此异常后可以重试请求。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
由于此原因而无法处理的请求的 ID。
## TimeLimitExceededException（结构）
当操作超过允许的时间限制时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
由于此原因而无法处理的请求的 ID。
## TooManyRequestsException（结构）
当正在处理的请求数量超过限制时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
由于此原因而无法处理的请求的 ID。
## UnsupportedOperationException（结构）
当请求尝试启动不支持的操作时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。
## UnloadUrlAccessDeniedException（结构）
当被拒绝访问作为卸载目标的 URL 时引发。
**Fields**
+ **code** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
返回 HTTP 状态代码，带有异常。
+ **detailedMessage** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
描述问题的详细消息。
+ **requestId** – 这是*必需的：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。
相关请求的 ID。