AWS CLI Command Reference

[ aws . neptunedata ]

get-storage-info

Description

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

Synopsis

  get-storage-info
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

totalStorageBytesUsed -> (long)

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

quads -> (structure)

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

RDF -> (structure)

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

SPOG -> (structure)

Size and count information for the SPOG quad index.

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

POGS -> (structure)

Size and count information for the POGS quad index.

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

GPSO -> (structure)

Size and count information for the GPSO quad index.

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

OSGP -> (structure)

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 -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

PZSOG -> (structure)

Size and count information for the PZSOG quad index.

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

PG -> (structure)

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

SPOG -> (structure)

Size and count information for the SPOG quad index.

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

POGS -> (structure)

Size and count information for the POGS quad index.

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

GPSO -> (structure)

Size and count information for the GPSO quad index.

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

OSGP -> (structure)

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 -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

PZSOG -> (structure)

Size and count information for the PZSOG quad index.

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

dictionaries -> (structure)

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 -> (structure)

The total size and entry count across all dictionary entries.

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

blobs -> (structure)

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

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

undoLogs -> (structure)

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 -> (long) [required]

The total size of the undo logs in bytes.

listSize -> (long) [required]

The number of entries in the undo log list.

streams -> (structure)

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

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

dfeStatistics -> (structure)

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

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

schema -> (structure)

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

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.

internals -> (structure)

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

sizeInBytes -> (long) [required]

Storage size in bytes.

count -> (long) [required]

The number of entries.
© Copyright 2026, Amazon Web Services. Created using Sphinx.