ManagePropertygraphStatistics
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
POST /propertygraph/statistics HTTP/1.1
Content-type: application/json
{
"mode": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- mode
-
The statistics generation mode. One of:
DISABLE_AUTOCOMPUTE,ENABLE_AUTOCOMPUTE, orREFRESH, the last of which manually triggers DFE statistics generation.Type: String
Valid Values:
disableAutoCompute | enableAutoCompute | refreshRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"payload": {
"statisticsId": "string"
},
"status": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- payload
-
This is only returned for refresh mode.
Type: RefreshStatisticsIdMap object
- status
-
The HTTP return code of the request. If the request succeeded, the code is 200.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Raised in case of an authentication or authorization failure.
HTTP Status Code: 403
- BadRequestException
-
Raised when a request is submitted that cannot be processed.
HTTP Status Code: 400
- ClientTimeoutException
-
Raised when a request timed out in the client.
HTTP Status Code: 408
- ConstraintViolationException
-
Raised when a value in a request field did not satisfy required constraints.
HTTP Status Code: 400
- IllegalArgumentException
-
Raised when an argument in a request is not supported.
HTTP Status Code: 400
- InvalidArgumentException
-
Raised when an argument in a request has an invalid value.
HTTP Status Code: 400
- InvalidParameterException
-
Raised when a parameter value is not valid.
HTTP Status Code: 400
- MissingParameterException
-
Raised when a required parameter is missing.
HTTP Status Code: 400
- PreconditionsFailedException
-
Raised when a precondition for processing a request is not satisfied.
HTTP Status Code: 400
- ReadOnlyViolationException
-
Raised when a request attempts to write to a read-only resource.
HTTP Status Code: 400
- StatisticsNotAvailableException
-
Raised when statistics needed to satisfy a request are not available.
HTTP Status Code: 400
- TooManyRequestsException
-
Raised when the number of requests being processed exceeds the limit.
HTTP Status Code: 429
- UnsupportedOperationException
-
Raised when a request attempts to initiate an operation that is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
