Cookie の設定を選択する

当社は、当社のサイトおよびサービスを提供するために必要な必須 Cookie および類似のツールを使用しています。当社は、パフォーマンス Cookie を使用して匿名の統計情報を収集することで、お客様が当社のサイトをどのように利用しているかを把握し、改善に役立てています。必須 Cookie は無効化できませんが、[カスタマイズ] または [拒否] をクリックしてパフォーマンス Cookie を拒否することはできます。

お客様が同意した場合、AWS および承認された第三者は、Cookie を使用して便利なサイト機能を提供したり、お客様の選択を記憶したり、関連する広告を含む関連コンテンツを表示したりします。すべての必須ではない Cookie を受け入れるか拒否するには、[受け入れる] または [拒否] をクリックしてください。より詳細な選択を行うには、[カスタマイズ] をクリックしてください。

Neptune クエリ API

フォーカスモード
Neptune クエリ API - Amazon Neptune

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

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

Gremlin クエリアクション:

openCypher クエリアクション:

クエリ構造:

ExecuteGremlinQuery (アクション)

        この API AWS の CLI 名は ですexecute-gremlin-query

このコマンドは Gremlin クエリを実行します。Amazon Neptune は Apache TinkerPop3 および Gremlin と互換性があるため、Apache TinkerPop3 ドキュメントの「グラフ」で述べられているように、Gremlin トラバーサル言語を使用してグラフにクエリを実行できます。詳細は、「Gremlin による Neptune グラフへのアクセス」にも記載されています。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、クエリに応じて、そのクラスターで以下の IAM アクションを許可するポリシーがアタッチされている必要があります。

neptune-db:QueryLanguage:Gremlin IAM 条件キーをポリシードキュメントで使用して、Gremlin クエリの使用を制限できることに注意してください (「Neptune IAM データアクセスポリシーステートメントで利用可能な条件キー」を参照)。

リクエスト

  • gremlinQuery (CLI では: --gremlin-query) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この API を使用すると、HTTP エンドポイントを使用する場合と同様に、Gremlin クエリを文字列形式で実行できます。このインターフェイスは、DB クラスターが使用しているすべての Gremlin バージョンと互換性があります (エンジンバージョンがサポートしている Gremlin リリースを特定するには、「Tinkerpop クライアントセクション」を参照してください)。

  • serializer (CLI では: --serializer) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    null 以外の場合、クエリ結果は、このパラメータで指定された形式でシリアル化されたレスポンスメッセージで返されます。現在サポートされているフォーマットのリストについては、TinkerPop ドキュメントの「GraphSON」セクションを参照してください。

レスポンス

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

    Gremlin クエリに関するメタデータ。

  • requestId — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    Gremlin クエリの一意識別子。

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

    サーバーからの Gremlin クエリ出力。

  • statusGremlinQueryStatusAttributes オブジェクト。

    Gremlin クエリのステータス。

ExecuteGremlinExplainQuery (アクション)

        この API AWS の CLI 名は ですexecute-gremlin-explain-query

Gremlin 説明クエリを実行します。

Amazon Neptune は、explain という名前の Gremlin 機能を追加しました。これは、Neptune エンジンがクエリのために使用する実行アプローチを理解するために役立つセルフサービスツールです。この機能を呼び出すには、Gremlin クエリを送信する HTTP コールに explain パラメータを追加します。

説明機能は、クエリ実行プランの論理構造に関する情報を提供します。この情報を使用して潜在的な評価と実行障害を明らかにし、「Gremlin クエリの調整」で説明されているように、クエリを調整できます。また、クエリに関するヒントを使用して、クエリ実行プランを改善できます。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、クエリに応じて、そのクラスターで以下の IAM アクションを許可するポリシーがアタッチされている必要があります。

neptune-db:QueryLanguage:Gremlin IAM 条件キーをポリシードキュメントで使用して、Gremlin クエリの使用を制限できることに注意してください (「Neptune IAM データアクセスポリシーステートメントで利用可能な条件キー」を参照)。

リクエスト

  • gremlinQuery (CLI では: --gremlin-query) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    Gremlin の説明クエリ文字列。

レスポンス

  • output — タイプ blob の ReportAsText (未解釈のバイナリデータのブロック)。

    Gremlin クエリの調整」で説明されているように、Gremlin の説明結果を含むテキストブロブ。

ExecuteGremlinProfileQuery (アクション)

        この API AWS の CLI 名は ですexecute-gremlin-profile-query

Gremlin プロファイルクエリを実行します。これは、指定されたトラバーサルを実行し、実行に関するさまざまなメトリクスを収集して、出力としてプロファイルレポートを生成します。詳細については、「Neptune での Gremlin プロファイル API」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:ReadDataViaQuery IAM アクションを許可するポリシーがアタッチされている必要があります。

neptune-db:QueryLanguage:Gremlin IAM 条件キーをポリシードキュメントで使用して、Gremlin クエリの使用を制限できることに注意してください (「Neptune IAM データアクセスポリシーステートメントで利用可能な条件キー」を参照)。

リクエスト

  • chop (CLI では: --chop) — タイプ integer の整数 (符号付き 32 ビット整数)。

    ゼロ以外の場合、結果の文字列はその文字数で切り捨てられます。ゼロに設定すると、文字列にはすべての結果が含まれます。

  • gremlinQuery (CLI では: --gremlin-query) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    プロファイリングする Gremlin クエリ文字列。

  • indexOps (CLI では: --index-ops) — タイプ boolean のブール値 (ブール値 (真または偽) の値)。

    このフラグが TRUE に設定された場合、結果には、クエリの実行およびシリアル化中に行われたすべてのインデックス操作の詳細レポートが含まれます。

  • results (CLI では: --results) — タイプ boolean のブール値 (ブール値 (真または偽) の値)。

    このフラグが TRUE に設定された場合、クエリ結果が収集され、プロファイルレポートの一部として表示されます。FALSE の場合、結果カウントのみが表示されます。

  • serializer (CLI では: --serializer) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    null 以外の場合、収集された結果は、このパラメータで指定された形式でシリアル化されたレスポンスメッセージで返されます。詳細については、「Neptune での Gremlin プロファイル API」を参照してください。

レスポンス

  • output — タイプ blob の ReportAsText (未解釈のバイナリデータのブロック)。

    Gremlin プロファイルの結果を含むテキストブロブ。詳細については、「Neptune での Gremlin プロファイル API」を参照してください。

ListGremlinQueries (アクション)

        この API AWS の CLI 名は ですlist-gremlin-queries

アクティブな Gremlin クエリを一覧表示します。出力の詳細については、「Gremlin クエリステータス API」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:GetQueryStatus IAM アクションを許可するポリシーがアタッチされている必要があります。

neptune-db:QueryLanguage:Gremlin IAM 条件キーをポリシードキュメントで使用して、Gremlin クエリの使用を制限できることに注意してください (「Neptune IAM データアクセスポリシーステートメントで利用可能な条件キー」を参照)。

リクエスト

  • includeWaiting (CLI では: --include-waiting) — タイプ boolean のブール値 (ブール値 (真または偽) の値)。

    TRUE に設定された場合、返されるリストには待機中のクエリが含まれます。デフォルトは ですFALSE

レスポンス

  • acceptedQueryCount - タイプ integer の整数 (符号付き 32 ビット整数)。

    受け入れられながらもまだ完了していないクエリの数 (キュー内のクエリを含む)。

  • queriesGremlinQueryStatus オブジェクトの配列。

    現在の SPARQL クエリのリスト。

  • runningQueryCount - タイプ integer の整数 (符号付き 32 ビット整数)。

    現在実行されている Gremlin クエリの数。

GetGremlinQueryStatus (アクション)

        この API AWS の CLI 名は ですget-gremlin-query-status

指定された Gremlin クエリのステータスを取得します。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:GetQueryStatus IAM アクションを許可するポリシーがアタッチされている必要があります。

neptune-db:QueryLanguage:Gremlin IAM 条件キーをポリシードキュメントで使用して、Gremlin クエリの使用を制限できることに注意してください (「Neptune IAM データアクセスポリシーステートメントで利用可能な条件キー」を参照)。

リクエスト

  • queryId (CLI では: --query-id) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    Gremlin クエリを識別する一意識別子。

レスポンス

  • queryEvalStatsQueryEvalStats オブジェクト。

    Gremlin クエリの評価ステータス。

  • queryId — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    ステータスが返されるクエリの ID。

  • queryString — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    Gremlin クエリ文字列。

CancelGremlinQuery (アクション)

        この API AWS の CLI 名は ですcancel-gremlin-query

Gremlin クエリをキャンセルします。詳細については、「Gremlin クエリのキャンセル」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:CancelQuery IAM アクションを許可するポリシーがアタッチされている必要があります。

リクエスト

  • queryId (CLI では: --query-id) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    キャンセルされるクエリを識別する一意識別子。

レスポンス

  • status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    キャンセルのステータス。

openCypher クエリアクション:

ExecuteOpenCypherQuery (アクション)

        この API AWS の CLI 名は ですexecute-open-cypher-query

openCypher クエリを実行します。詳細については、「openCypher による Neptune グラフへのアクセス」を参照してください。

Neptune は、openCypher を使用したグラフアプリケーションの構築をサポートしています。これは、現在、グラフデータベースを操作する開発者にとって最も人気のあるクエリ言語の 1 つです。開発者、ビジネスアナリスト、データサイエンティストは、openCypher の SQL の影響が大きい宣言型構文を好みます。これは、プロパティグラフのクエリによく使用される構造を備えているためです。

openCypher 言語は、当初は Neo4J によって開発され、その後、2015 年にオープンソース化され、Apache 2 オープンソースライセンスの下で openCypher プロジェクトに貢献しました。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、クエリに応じて、そのクラスターで以下の IAM アクションを許可するポリシーがアタッチされている必要があります。

また、neptune-db:QueryLanguage:OpenCypher IAM 条件キーをポリシードキュメントで使用して、openCypher クエリの使用を制限できることにも注意してください (「Neptune IAM データアクセスポリシーステートメントで利用可能な条件キー」を参照)。

リクエスト

  • openCypherQuery (CLI では: --open-cypher-query) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    実行される openCypher クエリ文字列。

  • parameters (CLI では: --parameters) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    クエリを実行するための openCypher クエリパラメータ。詳細については、「openCypher パラメーター化クエリの例」を参照してください。

レスポンス

  • results - 必須: タイプ document のドキュメント (JSON のようなデータモデルで表される、プロトコルに依存しないオープンコンテンツ)。

    openCypher クエリ結果。

ExecuteOpenCypherExplainQuery (アクション)

        この API AWS の CLI 名は ですexecute-open-cypher-explain-query

openCypher explain リクエストを実行します。詳細については、[openCypher の説明機能」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:ReadDataViaQuery IAM アクションを許可するポリシーがアタッチされている必要があります。

また、neptune-db:QueryLanguage:OpenCypher IAM 条件キーをポリシードキュメントで使用して、openCypher クエリの使用を制限できることにも注意してください (「Neptune IAM データアクセスポリシーステートメントで利用可能な条件キー」を参照)。

リクエスト

  • explainMode (CLI では: --explain-mode) — 必須: string タイプの OpenCypherExplainMode (UTF-8 でエンコードされた文字列)。

    openCypher explain モード。staticdynamic、または details のいずれか。

  • openCypherQuery (CLI では: --open-cypher-query) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    openCypher クエリ文字列。

  • parameters (CLI では: --parameters) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    openCypher クエリパラメータ。

レスポンス

  • results必須: タイプ blob のブロブ (未解釈のバイナリデータのブロック)。

    openCypher explain の結果を含むテキストブロブ。

ListOpenCypherQueries (アクション)

        この API AWS の CLI 名は ですlist-open-cypher-queries

アクティブな openCypher クエリを一覧表示します。詳細については、「Neptune openCypher ステータスエンドポイント」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:GetQueryStatus IAM アクションを許可するポリシーがアタッチされている必要があります。

また、neptune-db:QueryLanguage:OpenCypher IAM 条件キーをポリシードキュメントで使用して、openCypher クエリの使用を制限できることにも注意してください (「Neptune IAM データアクセスポリシーステートメントで利用可能な条件キー」を参照)。

リクエスト

  • includeWaiting (CLI では: --include-waiting) — タイプ boolean のブール値 (ブール値 (真または偽) の値)。

    TRUE に設定され、他のパラメータが存在しないときには、待機中のクエリと実行中のクエリのステータス情報が返されます。

レスポンス

  • acceptedQueryCount - タイプ integer の整数 (符号付き 32 ビット整数)。

    受け入れられながらもまだ完了していないクエリの数 (キュー内のクエリを含む)。

  • queriesGremlinQueryStatus オブジェクトの配列。

    現在の openCypher クエリのリスト。

  • runningQueryCount - タイプ integer の整数 (符号付き 32 ビット整数)。

    現在実行中の openCypher クエリの数。

GetOpenCypherQueryStatus (アクション)

        この API AWS の CLI 名は ですget-open-cypher-query-status

指定された openCypher クエリのステータスを取得します。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:GetQueryStatus IAM アクションを許可するポリシーがアタッチされている必要があります。

また、neptune-db:QueryLanguage:OpenCypher IAM 条件キーをポリシードキュメントで使用して、openCypher クエリの使用を制限できることにも注意してください (「Neptune IAM データアクセスポリシーステートメントで利用可能な条件キー」を参照)。

リクエスト

  • queryId (CLI では: --query-id) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    クエリのステータスを取得する openCypher クエリの一意 ID。

レスポンス

  • queryEvalStatsQueryEvalStats オブジェクト。

    openCypher クエリの評価ステータス。

  • queryId — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    ステータスが返されるクエリの一意 ID。

  • queryString — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    openCypher クエリ文字列。

CancelOpenCypherQuery (アクション)

        この API AWS の CLI 名は ですcancel-open-cypher-query

指定された openCypher クエリをキャンセルします。詳細については、「Neptune openCypher ステータスエンドポイント」を参照してください。

IAM 認証が有効になっている Neptune クラスターでこの操作を呼び出すときには、リクエストを行う IAM ユーザーまたはロールに、そのクラスターで neptune-db:CancelQuery IAM アクションを許可するポリシーがアタッチされている必要があります。

リクエスト

  • queryId (CLI では: --query-id) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    キャンセルする openCypher クエリの一意 ID。

  • silent (CLI では: --silent) — タイプ boolean のブール値 (ブール値 (真または偽) の値)。

    TRUE に設定された場合、openCypher クエリのキャンセルは予告なしに行われます。

レスポンス

  • payload - タイプ boolean のブール値 (ブール値 (真または偽))。

    openCypher クエリのキャンセルペイロード。

  • status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    openCypher クエリのキャンセルステータス。

クエリ構造:

QueryEvalStats (構造)

実行中、承認済み、または待機中のクエリの数とその詳細など、クエリ統計をキャプチャする構造。

フィールド
  • cancelled - これはタイプ boolean のブール値です (ブール値 (真または偽))。

    クエリがキャンセルされた場合は TRUE に設定され、それ以外の場合は FALSE に設定されます。

  • elapsed - タイプ integer の整数 (符号付き 32 ビット整数)。

    これまでクエリが実行されていた時間 (マイクロ秒)。

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

    このクエリのサブクエリの数。

  • waited - タイプ integer の整数 (符号付き 32 ビット整数)。

    クエリが待機していた時間をミリ秒単位で示します。

GremlinQueryStatus (構造)

Gremlin クエリのステータスをキャプチャします (「Gremlin クエリステータス API」ページを参照)。

フィールド
  • queryEvalStats - これは QueryEvalStats オブジェクトです。

    Gremlin クエリのクエリ統計。

  • queryId — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    Gremlin クエリの ID。

  • queryString — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    Gremlin クエリのクエリ文字列。

GremlinQueryStatusAttributes (構造)

Gremlin クエリのステータスコンポーネントを含みます。

フィールド
  • attributes - タイプ document のドキュメント (JSON のようなデータモデルで表される、プロトコルに依存しないオープンコンテンツ)。

    Gremlin クエリステータスの属性。

  • code - タイプ integer の整数 (符号付き 32 ビット整数)。

    Gremlin クエリリクエストから返された HTTP レスポンスコード。

  • message — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    ステータスメッセージ。

プライバシーサイト規約Cookie の設定
© 2025, Amazon Web Services, Inc. or its affiliates.All rights reserved.