NeptuneData / Client / get_rdf_graph_summary

get_rdf_graph_summary#

NeptuneData.Client.get_rdf_graph_summary(**kwargs)#

Gets a graph summary for an RDF graph.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetGraphSummary IAM action in that cluster.

Request Syntax

response = client.get_rdf_graph_summary(
    mode='basic'|'detailed'
)

Parameters:

mode (string) – Mode can take one of two values: BASIC (the default), and DETAILED.

Return type:

dict

Returns:

Response Syntax

{
    'statusCode': 123,
    'payload': {
        'version': 'string',
        'lastStatisticsComputationTime': datetime(2015, 1, 1),
        'graphSummary': {
            'numDistinctSubjects': 123,
            'numDistinctPredicates': 123,
            'numQuads': 123,
            'numClasses': 123,
            'classes': [
                'string',
            ],
            'predicates': [
                {
                    'string': 123
                },
            ],
            'subjectStructures': [
                {
                    'count': 123,
                    'predicates': [
                        'string',
                    ]
                },
            ]
        }
    }
}

Response Structure

(dict) –
- statusCode (integer) –
  
  The HTTP return code of the request. If the request succeeded, the code is 200.
- payload (dict) –
  
  Payload for an RDF graph summary response
  - version (string) –
    
    The version of this graph summary response.
  - lastStatisticsComputationTime (datetime) –
    
    The timestamp, in ISO 8601 format, of the time at which Neptune last computed statistics.
  - graphSummary (dict) –
    
    The graph summary of an RDF graph. See Graph summary response for an RDF graph.
    - numDistinctSubjects (integer) –
      
      The number of distinct subjects in the graph.
    - numDistinctPredicates (integer) –
      
      The number of distinct predicates in the graph.
    - numQuads (integer) –
      
      The number of quads in the graph.
    - numClasses (integer) –
      
      The number of classes in the graph.
    - classes (list) –
      
      A list of the classes in the graph.
      - (string) –
    - predicates (list) –
      
      “A list of predicates in the graph, along with the predicate counts.
      - (dict) –
        
        (string) –
        
        (integer) –
    - subjectStructures (list) –
      
      This field is only present when the request mode is DETAILED. It contains a list of subject structures.
      - (dict) –
        
        A subject structure.
        
        count (integer) –
        
        Number of occurrences of this specific structure.
        
        predicates (list) –
        
        A list of predicates present in this specific structure.
        
        (string) –

Exceptions

NeptuneData.Client.exceptions.BadRequestException
NeptuneData.Client.exceptions.InvalidParameterException
NeptuneData.Client.exceptions.StatisticsNotAvailableException
NeptuneData.Client.exceptions.ClientTimeoutException
NeptuneData.Client.exceptions.AccessDeniedException
NeptuneData.Client.exceptions.IllegalArgumentException
NeptuneData.Client.exceptions.TooManyRequestsException
NeptuneData.Client.exceptions.UnsupportedOperationException
NeptuneData.Client.exceptions.PreconditionsFailedException
NeptuneData.Client.exceptions.ReadOnlyViolationException
NeptuneData.Client.exceptions.ConstraintViolationException
NeptuneData.Client.exceptions.InvalidArgumentException
NeptuneData.Client.exceptions.MissingParameterException