NeptuneData / Client / get_propertygraph_statistics

get_propertygraph_statistics#

NeptuneData.Client.get_propertygraph_statistics()#

Gets property graph statistics (Gremlin and openCypher).

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:GetStatisticsStatus IAM action in that cluster.

Request Syntax

response = client.get_propertygraph_statistics()

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string',
    'payload': {
        'autoCompute': True|False,
        'active': True|False,
        'statisticsId': 'string',
        'date': datetime(2015, 1, 1),
        'note': 'string',
        'signatureInfo': {
            'signatureCount': 123,
            'instanceCount': 123,
            'predicateCount': 123
        }
    }
}

Response Structure

(dict) –
- status (string) –
  
  The HTTP return code of the request. If the request succeeded, the code is 200. See Common error codes for DFE statistics request for a list of common errors.
- payload (dict) –
  
  Statistics for property-graph data.
  - autoCompute (boolean) –
    
    Indicates whether or not automatic statistics generation is enabled.
  - active (boolean) –
    
    Indicates whether or not DFE statistics generation is enabled at all.
  - statisticsId (string) –
    
    Reports the ID of the current statistics generation run. A value of -1 indicates that no statistics have been generated.
  - date (datetime) –
    
    The UTC time at which DFE statistics have most recently been generated.
  - note (string) –
    
    A note about problems in the case where statistics are invalid.
  - signatureInfo (dict) –
    
    A StatisticsSummary structure that contains:
    - signatureCount - The total number of signatures across all characteristic sets.
    - instanceCount - The total number of characteristic-set instances.
    - predicateCount - The total number of unique predicates.
    - signatureCount (integer) –
      
      The total number of signatures across all characteristic sets.
    - instanceCount (integer) –
      
      The total number of characteristic-set instances.
    - predicateCount (integer) –
      
      The total number of unique predicates.

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