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

ListGraphs

Lists available Neptune Analytics graphs.

Request Syntax


GET /graphs?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The total number of records to return in the command's output.

If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 8192.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "graphs": [ 
      { 
         "arn": "string",
         "deletionProtection": boolean,
         "endpoint": "string",
         "id": "string",
         "kmsKeyIdentifier": "string",
         "name": "string",
         "provisionedMemory": number,
         "publicConnectivity": boolean,
         "replicaCount": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

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

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

graphs

A list of the graphs.

Type: Array of GraphSummary objects

nextToken

Pagination token used to paginate output.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Errors

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

InternalServerException

A failure occurred on the server.

HTTP Status Code: 500

ResourceNotFoundException

A specified resource could not be located.

HTTP Status Code: 404

ThrottlingException

The exception was interrupted by throttling.

HTTP Status Code: 429