NeptuneData / Client / manage_propertygraph_statistics

manage_propertygraph_statistics#

NeptuneData.Client.manage_propertygraph_statistics(**kwargs)#

Manages the generation and use of property graph statistics.

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

Request Syntax

response = client.manage_propertygraph_statistics(
    mode='disableAutoCompute'|'enableAutoCompute'|'refresh'
)

Parameters:

mode (string) – The statistics generation mode. One of: DISABLE_AUTOCOMPUTE, ENABLE_AUTOCOMPUTE, or REFRESH, the last of which manually triggers DFE statistics generation.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string',
    'payload': {
        'statisticsId': 'string'
    }
}

Response Structure

(dict) –
- status (string) –
  
  The HTTP return code of the request. If the request succeeded, the code is 200.
- payload (dict) –
  
  This is only returned for refresh mode.
  - statisticsId (string) –
    
    The ID of the statistics generation run that is currently occurring.

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