翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# Neptune データプレーンエンジン、高速リセット、および一般構造 API
<a name="data-api-dp-environment-APIs"></a>

**エンジン操作:**
+ [GetEngineStatus (アクション)](#GetEngineStatus)
+ [ExecuteFastReset (アクション)](#ExecuteFastReset)

**エンジン操作構造:**
+ [QueryLanguageVersion (構造)](#QueryLanguageVersion)
+ [FastResetToken (構造)](#FastResetToken)

## GetEngineStatus (アクション)
<a name="GetEngineStatus"></a>

         この 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 でエンコードされた文字列)。

  DB クラスターで実行されている Neptune エンジンのバージョンに設定します。このバージョンのエンジンがリリースされた後に手動でパッチが適用された場合は、バージョン番号の先頭に `Patch-` が付加されます。
+ **dfeQueryEngine** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  DFE エンジンが完全に有効になっている場合は `enabled` に設定し、`useDFE` クエリヒントが `true` に設定されているクエリでのみ DFE エンジンを使用する場合は `viaQueryHint` (デフォルト) に設定します。
+ **features** – キと値のペアのマップ配列。

      各キーは、タイプ `string` の文字列 (UTF-8 でエンコードされた文字列) です。

      各値は、タイプ `document` のドキュメントです (JSON のようなデータモデルで表される、プロトコルに依存しないオープンコンテンツ)。

  DB クラスターで有効になっている機能に関するステータス情報を含みます。
+ **gremlin** – [QueryLanguageVersion](#QueryLanguageVersion) オブジェクト。

  クラスターで使用できる Gremlin クエリ言語に関する情報を含みます。具体的には、エンジンが使用している現在の TinkerPop バージョンを指定するバージョンフィールドを含みます。
+ **labMode** – キと値のペアのマップ配列。

      各キーは、タイプ `string` の文字列 (UTF-8 でエンコードされた文字列) です。

      各値は、タイプ `string` の文字列 (UTF-8 でエンコードされた文字列) です。

  エンジンが使用しているラボモード設定を含みます。
+ **opencypher** – [QueryLanguageVersion](#QueryLanguageVersion) オブジェクト。

  クラスターで使用できる openCypher クエリ言語に関する情報を含みます。具体的には、エンジンが使用している現在の opencypher バージョンを指定するバージョンフィールドを含みます。
+ **role** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  インスタンスがリードレプリカの場合は `reader` に設定し、インスタンスがプライマリインスタンスの場合は `writer` に設定します。
+ **rollingBackTrxCount** - タイプ `integer` の整数 (符号付き 32 ビット整数)。

  ロールバックされるトランザクションがある場合、このフィールドは、そのようなトランザクションの数に設定されます。コメントがない場合、このフィールドは一切表示されません。
+ **rollingBackTrxEarliestStartTime** — タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  ロールバックされる最も早いトランザクションの開始時刻に設定します。ロールバックされるトランザクションがない場合、このフィールドは一切表示されません。
+ **settings** – キと値のペアのマップ配列。

      各キーは、タイプ `string` の文字列 (UTF-8 でエンコードされた文字列) です。

      各値は、タイプ `string` の文字列 (UTF-8 でエンコードされた文字列) です。

  DB クラスターの現在の設定に関する情報を含みます。例えば、現在のクラスタークエリのタイムアウト設定 (`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 (アクション)
<a name="ExecuteFastReset"></a>

         この API の AWS CLI 名は `execute-fast-reset` です。

高速リセット REST API を使用すると、Neptune グラフをすばやく簡単にリセットし、すべてのデータを削除できます。

Neptune 高速リセットは、2 ステップのプロセスです。まず、`action` を `initiateDatabaseReset` に設定して `ExecuteFastReset` を呼び出します。これにより UUID トークンが返され、`action` を `performDatabaseReset` に設定して再び `ExecuteFastReset` を呼び出すときに、このトークンを含めます。「[高速リセット API を使用して Amazon Neptune DB クラスターを空にする](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)

## *エンジン操作構造:*
<a name="data-api-dp-environment-APIs-engine-operation-structures-spacer"></a>

## QueryLanguageVersion (構造)
<a name="QueryLanguageVersion"></a>

クエリ言語バージョンを表す構造。

**フィールド**
+ **version** - これは *必須*です。タイプ `string` の文字列 (UTF-8 でエンコードされた文字列)。

  クエリ言語のバージョン。

## FastResetToken (構造)
<a name="FastResetToken"></a>

高速リセットを開始するために使用される高速リセットトークンを含む構造体。

**フィールド**
+ **token** — これはタイプ `string` の文字列です (UTF-8 でエンコードされた文字列)。

  `initiateDatabaseReset` アクションでデータベースによって生成され、`performDatabaseReset` がデータベースをリセットするために使用する UUID。