:doc:`NeptuneData <../../neptunedata>` / Client / get_propertygraph_statistics

****************************
get_propertygraph_statistics
****************************



.. py:method:: 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 <https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus>`__ IAM action in that cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/neptunedata-2023-08-01/GetPropertygraphStatistics>`_  


  **Request Syntax**

  ::

    response = client.get_propertygraph_statistics()
  :rtype: 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 <https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors>`__ 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**
  
  *   :py:class:`NeptuneData.Client.exceptions.BadRequestException`

  
  *   :py:class:`NeptuneData.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`NeptuneData.Client.exceptions.StatisticsNotAvailableException`

  
  *   :py:class:`NeptuneData.Client.exceptions.ClientTimeoutException`

  
  *   :py:class:`NeptuneData.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`NeptuneData.Client.exceptions.IllegalArgumentException`

  
  *   :py:class:`NeptuneData.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`NeptuneData.Client.exceptions.UnsupportedOperationException`

  
  *   :py:class:`NeptuneData.Client.exceptions.PreconditionsFailedException`

  
  *   :py:class:`NeptuneData.Client.exceptions.ReadOnlyViolationException`

  
  *   :py:class:`NeptuneData.Client.exceptions.ConstraintViolationException`

  
  *   :py:class:`NeptuneData.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`NeptuneData.Client.exceptions.MissingParameterException`

  