ManageSparqlStatisticsCommand

Suggest an Edit

Manages the generation and use of RDF 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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NeptunedataClient, ManageSparqlStatisticsCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
// const { NeptunedataClient, ManageSparqlStatisticsCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
const client = new NeptunedataClient(config);
const input = { // ManageSparqlStatisticsInput
  mode: "disableAutoCompute" || "enableAutoCompute" || "refresh",
};
const command = new ManageSparqlStatisticsCommand(input);
const response = await client.send(command);
// { // ManageSparqlStatisticsOutput
//   status: "STRING_VALUE", // required
//   payload: { // RefreshStatisticsIdMap
//     statisticsId: "STRING_VALUE",
//   },
// };

ManageSparqlStatisticsCommand Input

See ManageSparqlStatisticsCommandInput for more details

Parameter
Type
Description
mode
StatisticsAutoGenerationMode | undefined

The statistics generation mode. One of: DISABLE_AUTOCOMPUTE, ENABLE_AUTOCOMPUTE, or REFRESH, the last of which manually triggers DFE statistics generation.

ManageSparqlStatisticsCommand Output

See ManageSparqlStatisticsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
status
Required
string | undefined

The HTTP return code of the request. If the request succeeded, the code is 200.

payload
RefreshStatisticsIdMap | undefined

This is only returned for refresh mode.

Throws

Name
Fault
Details
AccessDeniedException
client

Raised in case of an authentication or authorization failure.

BadRequestException
client

Raised when a request is submitted that cannot be processed.

ClientTimeoutException
client

Raised when a request timed out in the client.

ConstraintViolationException
client

Raised when a value in a request field did not satisfy required constraints.

IllegalArgumentException
client

Raised when an argument in a request is not supported.

InvalidArgumentException
client

Raised when an argument in a request has an invalid value.

InvalidParameterException
client

Raised when a parameter value is not valid.

MissingParameterException
client

Raised when a required parameter is missing.

PreconditionsFailedException
client

Raised when a precondition for processing a request is not satisfied.

ReadOnlyViolationException
client

Raised when a request attempts to write to a read-only resource.

StatisticsNotAvailableException
client

Raised when statistics needed to satisfy a request are not available.

TooManyRequestsException
client

Raised when the number of requests being processed exceeds the limit.

UnsupportedOperationException
client

Raised when a request attempts to initiate an operation that is not supported.

NeptunedataServiceException
Base exception class for all service exceptions from Neptunedata service.