Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

Neptune storage usage breakdown

With the GetStorageInfo API, you can get a detailed breakdown of storage usage for your Neptune database, including undo logs, dictionary entries, change-stream data, DFE statistics, property graph schema, other internal metadata tables, and all of the quad indexes – grouped by property graph (PG) and Resource Description Framework (RDF). The response also includes a totalStorageBytesUsed value that sums the reported on-disk components. You can use this information to understand how your storage is distributed, to identify storage bloat, and to establish a baseline before and after an online index rebuild.

Use GetStorageInfo in the following situations:

Prerequisites

Engine version

The GetStorageInfo API requires Neptune engine release 1.5.0.0 or later.

IAM permissions

If your cluster uses IAM authentication, the IAM policy attached to the requesting principal must allow the neptune-db:GetStorageInfo action:

{
  "Effect": "Allow",
  "Action": ["neptune-db:GetStorageInfo"],
  "Resource": "arn:aws:neptune-db:<region>:<account-id>:<cluster-resource-id>/*"
}

For more information about data-plane IAM actions, see IAM actions for data access in Amazon Neptune.

Request

To retrieve storage information, send an HTTP GET request to the /storage/info endpoint. The request takes no body and no query parameters.

AWS CLI

aws neptunedata get-storage-info \
  --endpoint-url https://your-neptune-endpoint:port

For more information, see get-storage-info in the AWS CLI Command Reference.

SDK

import boto3
import json
from botocore.config import Config

client = boto3.client(
    'neptunedata',
    endpoint_url='https://your-neptune-endpoint:port',
    config=Config(read_timeout=None, retries={'total_max_attempts': 1})
)

response = client.get_storage_info()

print(json.dumps(response, indent=2, default=str))

awscurl

awscurl https://your-neptune-endpoint:port/storage/info \
  --region us-east-1 \
  --service neptune-db

Prerequisites

This example assumes that your AWS credentials are configured in your environment. Replace us-east-1 with the Region of your Neptune cluster.

curl

curl -G https://your-neptune-endpoint:port/storage/info

Response

The GetStorageInfo API returns a JSON response that reports the on-disk storage used by each Neptune internal component: the dictionaries, undo logs, change streams, DFE statistics, property graph schema, other internal metadata tables, and each quad index. Neptune reports quad index sizes per data model under PG (property graph) and RDF, and includes an index only when it contains data. Neptune omits the following top-level sections from the response when they are empty: dictionaries.blobs, streams, dfeStatistics, schema, and internals.

The following example shows the response for a property graph cluster. Because this cluster contains only property graph data, the RDF object does not appear in the response.

{
  "totalStorageBytesUsed": 955367424,
  "dictionaries": {
    "total": { "sizeInBytes": 259080192, "count": 653990 },
    "blobs": { "sizeInBytes":  54657024, "count":  22323 }
  },
  "undoLogs":      { "sizeInBytes": 150994944, "listSize": 2290 },
  "streams":       { "sizeInBytes":  77594624, "count": 1238185 },
  "dfeStatistics": { "sizeInBytes":    229376, "count":     813 },
  "schema":        { "sizeInBytes":     65536, "count":     154 },
  "internals":     { "sizeInBytes":    753664, "count":     202 },
  "quads": {
    "PG": {
      "SPOG":  { "sizeInBytes": 177995776, "count": 1222436 },
      "POGS":  { "sizeInBytes":  96534528, "count": 1222436 },
      "GPSO":  { "sizeInBytes":  79036416, "count": 1222436 },
      "OSGP":  { "sizeInBytes": 104071168, "count": 1222436 },
      "PZSOG": { "sizeInBytes":   9011200, "count":   61149 }
    }
  }
}

The response contains the following fields:

Note the following about the response:

Errors

The following table lists the errors that GetStorageInfo can return.