Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetRDFGraphSummary

Gets a graph summary for an RDF graph.

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

Request Syntax


GET /rdf/statistics/summary?mode=mode HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

mode

Mode can take one of two values: BASIC (the default), and DETAILED.

Valid Values: basic | detailed

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 statusCode
Content-type: application/json

{
   "payload": { 
      "graphSummary": { 
         "classes": [ "string" ],
         "numClasses": number,
         "numDistinctPredicates": number,
         "numDistinctSubjects": number,
         "numQuads": number,
         "predicates": [ 
            { 
               "string" : number 
            }
         ],
         "subjectStructures": [ 
            { 
               "count": number,
               "predicates": [ "string" ]
            }
         ]
      },
      "lastStatisticsComputationTime": "string",
      "version": "string"
   }
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

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

The following data is returned in JSON format by the service.

payload

Payload for an RDF graph summary response

Type: RDFGraphSummaryValueMap object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Raised in case of an authentication or authorization failure.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 403

BadRequestException

Raised when a request is submitted that cannot be processed.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the bad request.

HTTP Status Code: 400

ClientTimeoutException

Raised when a request timed out in the client.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 408

ConstraintViolationException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400

IllegalArgumentException

Raised when an argument in a request is not supported.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400

InvalidArgumentException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400

InvalidParameterException

Raised when a parameter value is not valid.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request that includes an invalid parameter.

HTTP Status Code: 400

MissingParameterException

Raised when a required parameter is missing.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in which the parameter is missing.

HTTP Status Code: 400

PreconditionsFailedException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400

ReadOnlyViolationException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in which the parameter is missing.

HTTP Status Code: 400

StatisticsNotAvailableException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400

TooManyRequestsException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request that could not be processed for this reason.

HTTP Status Code: 429

UnsupportedOperationException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400