- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListExportTasksCommand
Retrieves a list of export tasks.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { NeptuneGraphClient, ListExportTasksCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
// const { NeptuneGraphClient, ListExportTasksCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
const client = new NeptuneGraphClient(config);
const input = { // ListExportTasksInput
graphIdentifier: "STRING_VALUE",
nextToken: "STRING_VALUE",
maxResults: Number("int"),
};
const command = new ListExportTasksCommand(input);
const response = await client.send(command);
// { // ListExportTasksOutput
// tasks: [ // ExportTaskSummaryList // required
// { // ExportTaskSummary
// graphId: "STRING_VALUE", // required
// roleArn: "STRING_VALUE", // required
// taskId: "STRING_VALUE", // required
// status: "INITIALIZING" || "EXPORTING" || "SUCCEEDED" || "FAILED" || "CANCELLING" || "CANCELLED" || "DELETED", // required
// format: "PARQUET" || "CSV", // required
// destination: "STRING_VALUE", // required
// kmsKeyIdentifier: "STRING_VALUE", // required
// parquetType: "COLUMNAR",
// statusReason: "STRING_VALUE",
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListExportTasksCommand Input
See ListExportTasksCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
graphIdentifier | string | undefined | The unique identifier of the Neptune Analytics graph. |
maxResults | number | undefined | The maximum number of export tasks to return. |
nextToken | string | undefined | Pagination token used to paginate input. |
ListExportTasksCommand Output
See ListExportTasksCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
tasks Required | ExportTaskSummary[] | undefined | The requested list of export tasks. |
nextToken | string | undefined | Pagination token used to paginate output. |
Throws
Name | Fault | Details |
---|
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. |
ValidationException | client | A resource could not be validated. |
NeptuneGraphServiceException | Base exception class for all service exceptions from NeptuneGraph service. |