GetGraphSummaryCommand

Suggest an Edit

Gets a graph summary for a property graph.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NeptuneGraphClient, GetGraphSummaryCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
// const { NeptuneGraphClient, GetGraphSummaryCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
const client = new NeptuneGraphClient(config);
const input = { // GetGraphSummaryInput
  graphIdentifier: "STRING_VALUE", // required
  mode: "BASIC" || "DETAILED",
};
const command = new GetGraphSummaryCommand(input);
const response = await client.send(command);
// { // GetGraphSummaryOutput
//   version: "STRING_VALUE",
//   lastStatisticsComputationTime: new Date("TIMESTAMP"),
//   graphSummary: { // GraphDataSummary
//     numNodes: Number("long"),
//     numEdges: Number("long"),
//     numNodeLabels: Number("long"),
//     numEdgeLabels: Number("long"),
//     nodeLabels: [ // NodeLabels
//       "STRING_VALUE",
//     ],
//     edgeLabels: [ // EdgeLabels
//       "STRING_VALUE",
//     ],
//     numNodeProperties: Number("long"),
//     numEdgeProperties: Number("long"),
//     nodeProperties: [ // LongValuedMapList
//       { // LongValuedMap
//         "<keys>": Number("long"),
//       },
//     ],
//     edgeProperties: [
//       {
//         "<keys>": Number("long"),
//       },
//     ],
//     totalNodePropertyValues: Number("long"),
//     totalEdgePropertyValues: Number("long"),
//     nodeStructures: [ // NodeStructures
//       { // NodeStructure
//         count: Number("long"),
//         nodeProperties: [ // NodeProperties
//           "STRING_VALUE",
//         ],
//         distinctOutgoingEdgeLabels: [ // OutgoingEdgeLabels
//           "STRING_VALUE",
//         ],
//       },
//     ],
//     edgeStructures: [ // EdgeStructures
//       { // EdgeStructure
//         count: Number("long"),
//         edgeProperties: [ // EdgeProperties
//           "STRING_VALUE",
//         ],
//       },
//     ],
//   },
// };

GetGraphSummaryCommand Input

See GetGraphSummaryCommandInput for more details

Parameter
Type
Description
graphIdentifier
Required
string | undefined

The unique identifier of the Neptune Analytics graph.

mode
GraphSummaryMode | undefined

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

GetGraphSummaryCommand Output

See GetGraphSummaryCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
graphSummary
GraphDataSummary | undefined

The graph summary.

lastStatisticsComputationTime
Date | undefined

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

version
string | undefined

Display the version of this tool.

Throws

Name
Fault
Details
AccessDeniedException
client

Raised in case of an authentication or authorization failure.

InternalServerException
server

A failure occurred on the server.

ResourceNotFoundException
client

A specified resource could not be located.

ThrottlingException
client

The exception was interrupted by throttling.

ValidationException
client

A resource could not be validated.

NeptuneGraphServiceException
Base exception class for all service exceptions from NeptuneGraph service.