AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . neptune-graph ]

get-graph-summary

Description

Gets a graph summary for a property graph.

See also: AWS API Documentation

Synopsis

  get-graph-summary
--graph-identifier <value>
[--mode <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--graph-identifier (string)

The unique identifier of the Neptune Analytics graph.

--mode (string)

The summary mode can take one of two values: basic (the default), and detailed .

Possible values:

  • BASIC
  • DETAILED

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

version -> (string)

Display the version of this tool.

lastStatisticsComputationTime -> (timestamp)

The timestamp, in ISO 8601 format, of the time at which Neptune Analytics last computed statistics.

graphSummary -> (structure)

The graph summary.

numNodes -> (long)

The number of nodes in the graph.

numEdges -> (long)

The number of edges in the graph.

numNodeLabels -> (long)

The number of distinct node labels in the graph.

numEdgeLabels -> (long)

The number of unique edge labels in the graph.

nodeLabels -> (list)

A list of distinct node labels in the graph.

(string)

edgeLabels -> (list)

A list of the edge labels in the graph.

(string)

numNodeProperties -> (long)

The number of distinct node properties in the graph.

numEdgeProperties -> (long)

The number of edge properties in the graph.

nodeProperties -> (list)

A list of the distinct node properties in the graph, along with the count of nodes where each property is used.

(map)

key -> (string)

value -> (long)

edgeProperties -> (list)

A list of the distinct edge properties in the graph, along with the count of edges where each property is used.

(map)

key -> (string)

value -> (long)

totalNodePropertyValues -> (long)

The total number of usages of all node properties.

totalEdgePropertyValues -> (long)

The total number of usages of all edge properties.

nodeStructures -> (list)

This field is only present when the requested mode is DETAILED. It contains a list of node structures.

(structure)

Information about a node.

count -> (long)

The number of instances of this node.

nodeProperties -> (list)

Properties associated with this node.

(string)

distinctOutgoingEdgeLabels -> (list)

The outgoing edge labels associated with this node.

(string)

edgeStructures -> (list)

This field is only present when the requested mode is DETAILED. It contains a list of edge structures.

(structure)

Contains information about an edge in a Neptune Analytics graph.

count -> (long)

The number of instances of the edge in the graph.

edgeProperties -> (list)

A list of the properties associated with the edge.

(string)