GetGraphSummary
Gets a graph summary for a property graph.
Request Syntax
GET /summary?mode=mode HTTP/1.1
graphIdentifier: graphIdentifier
URI Request Parameters
The request uses the following URI parameters.
- graphIdentifier
-
The unique identifier of the Neptune Analytics graph.
Pattern:
g-[a-z0-9]{10}Required: Yes
- mode
-
The summary mode can take one of two values:
basic(the default), anddetailed.Valid Values:
BASIC | DETAILED
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"graphSummary": {
"edgeLabels": [ "string" ],
"edgeProperties": [
{
"string" : number
}
],
"edgeStructures": [
{
"count": number,
"edgeProperties": [ "string" ]
}
],
"nodeLabels": [ "string" ],
"nodeProperties": [
{
"string" : number
}
],
"nodeStructures": [
{
"count": number,
"distinctOutgoingEdgeLabels": [ "string" ],
"nodeProperties": [ "string" ]
}
],
"numEdgeLabels": number,
"numEdgeProperties": number,
"numEdges": number,
"numNodeLabels": number,
"numNodeProperties": number,
"numNodes": number,
"totalEdgePropertyValues": number,
"totalNodePropertyValues": number
},
"lastStatisticsComputationTime": "string",
"version": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- graphSummary
-
The graph summary.
Type: GraphDataSummary object
- lastStatisticsComputationTime
-
The timestamp, in ISO 8601 format, of the time at which Neptune Analytics last computed statistics.
Type: Timestamp
- version
-
Display the version of this tool.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Raised in case of an authentication or authorization failure.
HTTP Status Code: 403
- InternalServerException
-
A failure occurred on the server.
HTTP Status Code: 500
- ResourceNotFoundException
-
A specified resource could not be located.
HTTP Status Code: 404
- ThrottlingException
-
The exception was interrupted by throttling.
HTTP Status Code: 429
- ValidationException
-
A resource could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
