getGraphSummary method

Future<GetGraphSummaryOutput> getGraphSummary({ required String graphIdentifier, GraphSummaryMode? mode, })

Gets a graph summary for a property graph.

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter graphIdentifier : The unique identifier of the Neptune Analytics graph.

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

Implementation

Future<GetGraphSummaryOutput> getGraphSummary({
  required String graphIdentifier,
  GraphSummaryMode? mode,
}) async {
  final headers = <String, String>{
    'graphIdentifier': graphIdentifier.toString(),
  };
  final $query = <String, List<String>>{
    if (mode != null) 'mode': [mode.value],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/summary',
    queryParams: $query,
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  return GetGraphSummaryOutput.fromJson(response);
}