StartExportTaskCommand

Suggest an Edit

Export data from an existing Neptune Analytics graph to Amazon S3. The graph state should be AVAILABLE.

Example Syntax

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

import { NeptuneGraphClient, StartExportTaskCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
// const { NeptuneGraphClient, StartExportTaskCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
const client = new NeptuneGraphClient(config);
const input = { // StartExportTaskInput
  graphIdentifier: "STRING_VALUE", // required
  roleArn: "STRING_VALUE", // required
  format: "PARQUET" || "CSV", // required
  destination: "STRING_VALUE", // required
  kmsKeyIdentifier: "STRING_VALUE", // required
  parquetType: "COLUMNAR",
  exportFilter: { // ExportFilter
    vertexFilter: { // ExportFilterPerLabelMap
      "<keys>": { // ExportFilterElement
        properties: { // ExportFilterPropertyMap
          "<keys>": { // ExportFilterPropertyAttributes
            outputType: "STRING_VALUE",
            sourcePropertyName: "STRING_VALUE",
            multiValueHandling: "TO_LIST" || "PICK_FIRST",
          },
        },
      },
    },
    edgeFilter: {
      "<keys>": {
        properties: {
          "<keys>": {
            outputType: "STRING_VALUE",
            sourcePropertyName: "STRING_VALUE",
            multiValueHandling: "TO_LIST" || "PICK_FIRST",
          },
        },
      },
    },
  },
  tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new StartExportTaskCommand(input);
const response = await client.send(command);
// { // StartExportTaskOutput
//   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",
//   exportFilter: { // ExportFilter
//     vertexFilter: { // ExportFilterPerLabelMap
//       "<keys>": { // ExportFilterElement
//         properties: { // ExportFilterPropertyMap
//           "<keys>": { // ExportFilterPropertyAttributes
//             outputType: "STRING_VALUE",
//             sourcePropertyName: "STRING_VALUE",
//             multiValueHandling: "TO_LIST" || "PICK_FIRST",
//           },
//         },
//       },
//     },
//     edgeFilter: {
//       "<keys>": {
//         properties: {
//           "<keys>": {
//             outputType: "STRING_VALUE",
//             sourcePropertyName: "STRING_VALUE",
//             multiValueHandling: "TO_LIST" || "PICK_FIRST",
//           },
//         },
//       },
//     },
//   },
// };

StartExportTaskCommand Input

See StartExportTaskCommandInput for more details

Parameter
Type
Description
destination
Required
string | undefined

The Amazon S3 URI where data will be exported to.

format
Required
ExportFormat | undefined

The format of the export task.

graphIdentifier
Required
string | undefined

The source graph identifier of the export task.

kmsKeyIdentifier
Required
string | undefined

The KMS key identifier of the export task.

roleArn
Required
string | undefined

The ARN of the IAM role that will allow data to be exported to the destination.

exportFilter
ExportFilter | undefined

The export filter of the export task.

parquetType
ParquetType | undefined

The parquet type of the export task.

tags
Record<string, string> | undefined

Tags to be applied to the export task.

StartExportTaskCommand Output

See StartExportTaskCommandOutput for details

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

The Amazon S3 URI of the export task where data will be exported to.

format
Required
ExportFormat | undefined

The format of the export task.

graphId
Required
string | undefined

The source graph identifier of the export task.

kmsKeyIdentifier
Required
string | undefined

The KMS key identifier of the export task.

roleArn
Required
string | undefined

The ARN of the IAM role that will allow data to be exported to the destination.

status
Required
ExportTaskStatus | undefined

The current status of the export task.

taskId
Required
string | undefined

The unique identifier of the export task.

exportFilter
ExportFilter | undefined

The export filter of the export task.

parquetType
ParquetType | undefined

The parquet type of the export task.

statusReason
string | undefined

The reason that the export task has this status value.

Throws

Name
Fault
Details
ConflictException
client

Raised when a conflict is encountered.

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.