Neptune データプレーン統計およびグラフサマリー API - Amazon Neptune

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

Neptune データプレーン統計およびグラフサマリー API

プロパティグラフ統計アクション:

統計構造:

GetPropertygraphStatistics (アクション)

        この API の AWS CLI 名は get-propertygraph-statistics です。

プロパティグラフ統計 (Gremlin と openCypher) を取得します。

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

リクエスト
  • リクエストパラメータなし

レスポンス

  • payload – 必須: 統計 オブジェクト。

    プロパティグラフデータの統計。

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

    リクエストの HTTP リターンコード。リクエストが成功した場合、コードは 200 です。よくあるエラーのリストについては、「DFE 統計リクエストの一般的なエラーコード」を参照してください。

ManagePropertygraphStatistics (アクション)

        この API の AWS CLI 名は manage-propertygraph-statistics です。

プロパティグラフ統計の生成と使用を管理します。

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

リクエスト

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

    統計生成モード。DISABLE_AUTOCOMPUTEENABLE_AUTOCOMPUTE、または REFRESH のいずれか。 を指定すると、DFE 統計の生成が手動でトリガーされます。

レスポンス

  • payloadRefreshStatisticsIdMap オブジェクト。

    これは更新モードの場合にのみ返されます。

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

    リクエストの HTTP リターンコード。リクエストが成功した場合、コードは 200 です。

DeletePropertygraphStatistics (アクション)

        この API の AWS CLI 名は delete-propertygraph-statistics です。

Gremlin と openCypher (プロパティグラフ) データの統計を削除します。

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

リクエスト
  • リクエストパラメータなし

レスポンス

  • payloadDeleteStatisticsValueMap オブジェクト。

    削除ペイロード。

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

    キャンセルステータス。

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

    HTTP レスポンスコード: 削除が成功した場合は 200、または削除する統計がない場合は 204。

GetPropertygraphSummary (アクション)

        この API の AWS CLI 名は get-propertygraph-summary です。

プロパティグラフのグラフ概要を取得します。

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

リクエスト

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

    Mode には、BASIC (デフォルト) と DETAILED の 2 つの値のいずれかを指定できます。

レスポンス

  • payloadPropertygraphSummaryValueMap オブジェクト。

    プロパティグラフサマリーレスポンスを含むペイロード。

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

    リクエストの HTTP リターンコード。リクエストが成功した場合、コードは 200 です。

統計構造:

統計 (構造)

統計情報を含みます。DFE エンジンは、Neptune グラフのデータに関する情報を使用して、クエリの実行を計画する際に効果的なトレードオフを行います。この情報は、クエリ計画を導くことができる、いわゆる特性セットと述語統計を含む統計の形式をとります。「Neptune DFE が使用する統計の管理」を参照してください。

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

    DFE 統計情報の生成が有効になっているかどうかを示します。

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

    統計情報の自動生成が有効になっているかどうかを示します。

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

    DFE 統計情報が最近生成された UTC 時刻。

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

    統計情報が無効な場合の問題に関するメモ。

  • signatureInfo - これは StatisticsSummary オブジェクトです。

    以下を含む統計サマリー構造体。

    • signatureCount — すべての特性セットにおけるシグニチャの総数。

    • instanceCount — 特性セットインスタンスの合計数。

    • predicateCount — 一意述語の合計数。

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

    現在の統計生成の実行の ID を報告します。-1 の値は統計が生成されていないことを示します。

StatisticsSummary (構造)

統計で生成された特性セットに関する情報。

フィールド
  • instanceCount - タイプ integer の整数 (符号付き 32 ビット整数)。

    特性セットインスタンスの合計数。

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

    一意述語の合計数。

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

    すべての特性セットにおけるシグニチャの総数。

DeleteStatisticsValueMap (構造)

統計削除のペイロード。

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

    統計の現在のステータス。

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

    現在発生している統計生成の実行の ID。

RefreshStatisticsIdMap (構造)

REFRESH モードの統計。

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

    現在発生している統計生成の実行の ID。

NodeStructure (構造)

ノード構造

フィールド
  • count — タイプ long の長整数 (符号付き 64 ビット整数)。

    この特定の構造を持つノードの数。

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

    この特定の構造に存在する個別の出力エッジラベルのリスト。

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

    この特定の構造に存在するノードプロパティのリスト。

EdgeStructure (構造)

エッジ構造。

フィールド
  • count — タイプ long の長整数 (符号付き 64 ビット整数)。

    この特定の構造を持つエッジの数。

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

    この特定の構造に存在するエッジプロパティのリスト。

SubjectStructure (構造)

サブジェクト構造。

フィールド
  • count — タイプ long の長整数 (符号付き 64 ビット整数)。

    この特定の構造の出現回数。

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

    この特定の構造に存在する述語のリスト。

PropertygraphSummaryValueMap (構造)

プロパティグラフサマリーレスポンスのペイロード。

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

    グラフの要約。

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

    Neptune が最後に統計を計算した時刻のタイムスタンプ(ISO 8601 形式)。

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

    このグラフサマリーレスポンスのバージョン。

PropertygraphSummary (構造)

グラフサマリー API は、ノードおよびエッジラベルとプロパティキーの読み取り専用リストを、ノード、エッジ、プロパティの数とともに返します。「プロパティグラフ (PG) のグラフサマリーレスポンス」を参照してください。

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

    グラフ内の異なるエッジラベルのリスト。

  • edgeProperties — LongValuedMap オブジェクト。キーと値のペアのマップ配列。

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

        各値はタイプ long の長整数です (符号付き 64 ビット整数)。

    グラフ内の個別のエッジプロパティのリストと、各プロパティが使用されるエッジの数です。

  • edgeStructures — これは EdgeStructure オブジェクトの配列です。

    このフィールドは、要求されたモードが DETAILED の場合にのみ表示されます。エッジ構造のリストを含みます。

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

    グラフ内の異なるノードラベルのリスト。

  • nodeProperties — LongValuedMap オブジェクト。キーと値のペアのマップ配列。

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

        各値はタイプ long の長整数です (符号付き 64 ビット整数)。

    グラフ内の異なるノードプロパティの数。

  • nodeStructures — これは 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 ビット整数)。

    すべてのノードプロパティの使用回数の合計。