ListGraphsCommand

Suggest an Edit

Lists available Neptune Analytics graphs.

Example Syntax

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

import { NeptuneGraphClient, ListGraphsCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
// const { NeptuneGraphClient, ListGraphsCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
const client = new NeptuneGraphClient(config);
const input = { // ListGraphsInput
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListGraphsCommand(input);
const response = await client.send(command);
// { // ListGraphsOutput
//   graphs: [ // GraphSummaryList // required
//     { // GraphSummary
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       arn: "STRING_VALUE", // required
//       status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
//       provisionedMemory: Number("int"),
//       publicConnectivity: true || false,
//       endpoint: "STRING_VALUE",
//       replicaCount: Number("int"),
//       kmsKeyIdentifier: "STRING_VALUE",
//       deletionProtection: true || false,
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListGraphsCommand Input

See ListGraphsCommandInput for more details

Parameter
Type
Description
maxResults
number | undefined

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.

nextToken
string | undefined

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.

ListGraphsCommand Output

See ListGraphsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
graphs
Required
GraphSummary[] | undefined

A list of the graphs.

nextToken
string | undefined

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.

Throws

Name
Fault
Details
InternalServerException
server

A failure occurred on the server.

ResourceNotFoundException
client

A specified resource could not be located.

ThrottlingException
client

The exception was interrupted by throttling.

NeptuneGraphServiceException
Base exception class for all service exceptions from NeptuneGraph service.