AWS neptune documentation change
Summary
Reorganized and updated documentation for Neptune notebook magics, adding new %degreeDistribution magic and rearranging existing magic sections.
Security assessment
The changes are purely documentation reorganization and addition of a new visualization feature (%degreeDistribution). There is no mention of security vulnerabilities, security fixes, or security features. The changes are routine documentation updates.
Diff
diff --git a/neptune/latest/userguide/notebooks-magics.md b/neptune/latest/userguide/notebooks-magics.md index ed4e14aca..d6413cc87 100644 --- a//neptune/latest/userguide/notebooks-magics.md +++ b//neptune/latest/userguide/notebooks-magics.md @@ -5 +5 @@ -Variable injectionCommon query arguments%seed%load%load_ids%load_status%reset_graph%cancel_load%status%get_graph%gremlin_status%opencypher_status, or %oc_status%sparql_status%stream_viewer%graph_notebook_config%graph_notebook_host%graph_notebook_version%graph_notebook_service%graph_notebook_vis_options%statistics%summary%%graph_notebook_config%%sparql%%gremlin%%opencypher, or %%oc%%graph_notebook_vis_options%neptune_ml%%neptune_ml +Variable injectionCommon query arguments%seed%load%load_ids%load_status%cancel_load%status%gremlin_status%opencypher_status, or %oc_status%stream_viewer%sparql_status%graph_notebook_config%graph_notebook_host%graph_notebook_version%graph_notebook_service%graph_notebook_vis_options%statistics%summary%reset_graph%get_graph%degreeDistribution%%sparql%%gremlin%%opencypher, or %%oc%%graph_notebook_config%%graph_notebook_vis_options%neptune_ml%%neptune_ml @@ -50,0 +51,2 @@ _Line magics_ are commands preceded by a single percent sign (`%`). They only ta + * %degreeDistribution + @@ -204,13 +205,0 @@ The line magic looks like this: -## The `%reset_graph` line magic - -The `%reset_graph` (or `%_graph_reset`) line magic executes a [ResetGraph](https://docs.aws.amazon.com//neptune-analytics/latest/apiref/API_ResetGraph.html) call against the Neptune Analytics endpoint. It accepts the following optional line input: - - * -ns or --no-skip-snapshot - If present, a final graph snapshot will be created before the graph data is deleted. - - * \--silent – If present, no output is displayed after the reset call is submitted. - - * \--store-to – Used to specify a variable to which to store the ResetGraph response. - - - - @@ -235,4 +223,0 @@ For Neptune DB hosts, status information will be fetched from the [health status -## The `%get_graph` line magic - -The `%get_graph` line magic retrieves information about a graph via the [GetGraph API](https://docs.aws.amazon.com//neptune-analytics/latest/apiref/API_GetGraph.html). This magic is functionally identical to %status when used with Neptune Analytics. - @@ -266,4 +250,0 @@ Retrieves query status for an opencypher query. This line magic takes the follow -## The `%sparql_status` line magic - -Retrieves [SPARQL query status information](./sparql-api-status.html). - @@ -284,0 +266,4 @@ The `%stream_viewer` line magic is fully supported only on engine versions 1.0.5 +## The `%sparql_status` line magic + +Retrieves [SPARQL query status information](./sparql-api-status.html). + @@ -373 +358 @@ If not supplied, the default is the `basic` summary display mode. -## The `%%graph_notebook_config` cell magic +## The `%reset_graph` line magic @@ -375 +360,26 @@ If not supplied, the default is the `basic` summary display mode. -The `%%graph_notebook_config` cell magic uses a JSON object containing configuration information to modify the settings that the notebook is using to communicate with Neptune, if possible. The configuration takes the same form returned by the %graph_notebook_config line magic. +The `%reset_graph` (or `%_graph_reset`) line magic executes a [ResetGraph](https://docs.aws.amazon.com//neptune-analytics/latest/apiref/API_ResetGraph.html) call against the Neptune Analytics endpoint. It accepts the following optional line input: + + * -ns or --no-skip-snapshot - If present, a final graph snapshot will be created before the graph data is deleted. + + * \--silent – If present, no output is displayed after the reset call is submitted. + + * \--store-to – Used to specify a variable to which to store the ResetGraph response. + + + + +## The `%get_graph` line magic + +The `%get_graph` line magic retrieves information about a graph via the [GetGraph API](https://docs.aws.amazon.com//neptune-analytics/latest/apiref/API_GetGraph.html). This magic is functionally identical to %status when used with Neptune Analytics. + +## The `%degreeDistribution` line magic + +The `%degreeDistribution` line magic creates an interactive histogram visualizing the degree distribution of vertices in a graph. The histogram displays the number of vertices (y-axis) that have a specific degree (x-axis). It is available only with Neptune Analytics. + +It accepts the following parameters, which can also be chosen in the dropdown menu: + + * **`--traversalDirection`** – Specifies which degree to analyze. Must be one of: `"both"` (default), `"inbound"`, or `"outbound"`. + + * **`--vertexLabels`** – Filter vertices by the provided labels (for example, `airport country`). The default is an empty list. + + * **`--edgeLabels`** – Filter edges by the provided labels (for example, `route`). The default is an empty list. @@ -377 +386,0 @@ The `%%graph_notebook_config` cell magic uses a JSON object containing configura -For example: @@ -380,9 +388,0 @@ For example: - %%graph_notebook_config - { - "host": "my-new-cluster-endpoint.amazon.com", - "port": 8182, - "auth_mode": "DEFAULT", - "load_from_s3_arn": "", - "ssl": true, - "aws_region": "us-east-1" - } @@ -511,0 +512,17 @@ The `%%opencypher` cell magic (which also has the abbreviated `%%oc` form), issu +## The `%%graph_notebook_config` cell magic + +The `%%graph_notebook_config` cell magic uses a JSON object containing configuration information to modify the settings that the notebook is using to communicate with Neptune, if possible. The configuration takes the same form returned by the %graph_notebook_config line magic. + +For example: + + + %%graph_notebook_config + { + "host": "my-new-cluster-endpoint.amazon.com", + "port": 8182, + "auth_mode": "DEFAULT", + "load_from_s3_arn": "", + "ssl": true, + "aws_region": "us-east-1" + } +