propertygraph_statistics
Creates, updates, deletes, gets or lists a propertygraph_statistics resource.
Overview
| Name | propertygraph_statistics |
| Type | Resource |
| Id | aws.neptunedata.propertygraph_statistics |
Fields
The following fields are returned by SELECT queries:
- get_propertygraph_statistics
| Name | Datatype | Description |
|---|---|---|
payload | object | Statistics for property-graph data. |
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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_propertygraph_statistics | select | region | 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. | |
delete_propertygraph_statistics | delete | region | Deletes statistics for Gremlin and openCypher (property graph) data. 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:DeleteStatistics IAM action in that cluster. | |
manage_propertygraph_statistics | exec | region | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- 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.
SELECT
payload,
status
FROM aws.neptunedata.propertygraph_statistics
WHERE region = '{{ region }}' -- required
;
DELETE examples
- delete_propertygraph_statistics
Deletes statistics for Gremlin and openCypher (property graph) data. 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:DeleteStatistics IAM action in that cluster.
DELETE FROM aws.neptunedata.propertygraph_statistics
WHERE region = '{{ region }}' --required
;
Lifecycle Methods
- manage_propertygraph_statistics
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.
EXEC aws.neptunedata.propertygraph_statistics.manage_propertygraph_statistics
@region='{{ region }}' --required
@@json=
'{
"mode": "{{ mode }}"
}'
;