NeptuneData / Client / get_storage_info

get_storage_info

NeptuneData.Client.get_storage_info()

Retrieves storage information for the Neptune database instance, including approximate total storage used and per-category size and entry counts. Storage categories include:

  • Quad indexes - the indexes that store graph data, for both RDF (SPARQL) and Property Graph (Gremlin/openCypher) models.

  • Dictionaries - the term dictionaries, including total dictionary storage and the portion used by blob (large value) entries.

  • Undo logs - the undo logs, reported as a total size and the number of entries in the undo log list.

  • Streams - the change-log streams.

  • Schema - the schema.

  • DFE statistics - the DFE engine statistics.

  • System metadata - internal system metadata.

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

See also: AWS API Documentation

Request Syntax

response = client.get_storage_info()
Return type:

dict

Returns:

Response Syntax

{
    'totalStorageBytesUsed': 123,
    'quads': {
        'RDF': {
            'SPOG': {
                'sizeInBytes': 123,
                'count': 123
            },
            'POGS': {
                'sizeInBytes': 123,
                'count': 123
            },
            'GPSO': {
                'sizeInBytes': 123,
                'count': 123
            },
            'OSGP': {
                'sizeInBytes': 123,
                'count': 123
            },
            'PZSOG': {
                'sizeInBytes': 123,
                'count': 123
            }
        },
        'PG': {
            'SPOG': {
                'sizeInBytes': 123,
                'count': 123
            },
            'POGS': {
                'sizeInBytes': 123,
                'count': 123
            },
            'GPSO': {
                'sizeInBytes': 123,
                'count': 123
            },
            'OSGP': {
                'sizeInBytes': 123,
                'count': 123
            },
            'PZSOG': {
                'sizeInBytes': 123,
                'count': 123
            }
        }
    },
    'dictionaries': {
        'total': {
            'sizeInBytes': 123,
            'count': 123
        },
        'blobs': {
            'sizeInBytes': 123,
            'count': 123
        }
    },
    'undoLogs': {
        'sizeInBytes': 123,
        'listSize': 123
    },
    'streams': {
        'sizeInBytes': 123,
        'count': 123
    },
    'dfeStatistics': {
        'sizeInBytes': 123,
        'count': 123
    },
    'schema': {
        'sizeInBytes': 123,
        'count': 123
    },
    'internals': {
        'sizeInBytes': 123,
        'count': 123
    }
}

Response Structure

  • (dict) –

    • totalStorageBytesUsed (integer) –

      The approximate total amount of storage used by the Neptune database instance, in bytes.

    • quads (dict) –

      Contains information about the quad indexes, including counts and sizes for both RDF (SPARQL) and Property Graph (Gremlin/openCypher) data.

      • RDF (dict) –

        Contains quad index information for the RDF (SPARQL) data model.

        • SPOG (dict) –

          Size and count information for the SPOG quad index.

          • sizeInBytes (integer) –

            Storage size in bytes.

          • count (integer) –

            The number of entries.

        • POGS (dict) –

          Size and count information for the POGS quad index.

          • sizeInBytes (integer) –

            Storage size in bytes.

          • count (integer) –

            The number of entries.

        • GPSO (dict) –

          Size and count information for the GPSO quad index.

          • sizeInBytes (integer) –

            Storage size in bytes.

          • count (integer) –

            The number of entries.

        • OSGP (dict) –

          Size and count information for the OSGP quad index. This index is optional. For details on how to enable it and evaluate the benefits and costs, see Neptune Data Model.

          • sizeInBytes (integer) –

            Storage size in bytes.

          • count (integer) –

            The number of entries.

        • PZSOG (dict) –

          Size and count information for the PZSOG quad index.

          • sizeInBytes (integer) –

            Storage size in bytes.

          • count (integer) –

            The number of entries.

      • PG (dict) –

        Contains quad index information for the Property Graph (Gremlin/openCypher) data model.

        • SPOG (dict) –

          Size and count information for the SPOG quad index.

          • sizeInBytes (integer) –

            Storage size in bytes.

          • count (integer) –

            The number of entries.

        • POGS (dict) –

          Size and count information for the POGS quad index.

          • sizeInBytes (integer) –

            Storage size in bytes.

          • count (integer) –

            The number of entries.

        • GPSO (dict) –

          Size and count information for the GPSO quad index.

          • sizeInBytes (integer) –

            Storage size in bytes.

          • count (integer) –

            The number of entries.

        • OSGP (dict) –

          Size and count information for the OSGP quad index. This index is optional. For details on how to enable it and evaluate the benefits and costs, see Neptune Data Model.

          • sizeInBytes (integer) –

            Storage size in bytes.

          • count (integer) –

            The number of entries.

        • PZSOG (dict) –

          Size and count information for the PZSOG quad index.

          • sizeInBytes (integer) –

            Storage size in bytes.

          • count (integer) –

            The number of entries.

    • dictionaries (dict) –

      Contains information about the dictionaries, including total dictionary storage and the portion used by blob entries. For additional details on the storage of the Neptune dictionary, see Neptune Storage Billing.

      • total (dict) –

        The total size and entry count across all dictionary entries.

        • sizeInBytes (integer) –

          Storage size in bytes.

        • count (integer) –

          The number of entries.

      • blobs (dict) –

        The size and entry count for the blob (large value) dictionary entries.

        • sizeInBytes (integer) –

          Storage size in bytes.

        • count (integer) –

          The number of entries.

    • undoLogs (dict) –

      Contains information about the undo logs. The sizeInBytes field represents the total size of the undo logs in bytes, and the listSize field represents the number of entries in the undo log list.

      • sizeInBytes (integer) –

        The total size of the undo logs in bytes.

      • listSize (integer) –

        The number of entries in the undo log list.

    • streams (dict) –

      Contains storage metrics for the Neptune change-log streams, including size in bytes and entry count.

      • sizeInBytes (integer) –

        Storage size in bytes.

      • count (integer) –

        The number of entries.

    • dfeStatistics (dict) –

      Contains storage metrics for the Neptune DFE engine statistics, including size in bytes and entry count.

      • sizeInBytes (integer) –

        Storage size in bytes.

      • count (integer) –

        The number of entries.

    • schema (dict) –

      Contains storage metrics for the Neptune schema, including size in bytes and entry count.

      • sizeInBytes (integer) –

        Storage size in bytes.

      • count (integer) –

        The number of entries.

    • internals (dict) –

      Contains storage metrics for Neptune system metadata, including size in bytes and entry count.

      • sizeInBytes (integer) –

        Storage size in bytes.

      • count (integer) –

        The number of entries.

Exceptions