@aws-sdk/client-neptune-graph 3.693.0 → 3.699.0

package/dist-types/commands/StartExportTaskCommand.d.ts

@@ -0,0 +1,150 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { StartExportTaskInput, StartExportTaskOutput } from "../models/models_0";
+import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartExportTaskCommand}.
+ */
+export interface StartExportTaskCommandInput extends StartExportTaskInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartExportTaskCommand}.
+ */
+export interface StartExportTaskCommandOutput extends StartExportTaskOutput, __MetadataBearer {
+}
+declare const StartExportTaskCommand_base: {
+    new (input: StartExportTaskCommandInput): import("@smithy/smithy-client").CommandImpl<StartExportTaskCommandInput, StartExportTaskCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: StartExportTaskCommandInput): import("@smithy/smithy-client").CommandImpl<StartExportTaskCommandInput, StartExportTaskCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Export data from an existing Neptune Analytics graph to Amazon S3. The graph state should be <code>AVAILABLE</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * 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",
+ * //           },
+ * //         },
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param StartExportTaskCommandInput - {@link StartExportTaskCommandInput}
+ * @returns {@link StartExportTaskCommandOutput}
+ * @see {@link StartExportTaskCommandInput} for command's `input` shape.
+ * @see {@link StartExportTaskCommandOutput} for command's `response` shape.
+ * @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape.
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Raised when a conflict is encountered.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>A failure occurred on the server.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>A specified resource could not be located.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The exception was interrupted by throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>A resource could not be validated.</p>
+ *
+ * @throws {@link NeptuneGraphServiceException}
+ * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
+ *
+ * @public
+ */
+export declare class StartExportTaskCommand extends StartExportTaskCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartExportTaskInput;
+            output: StartExportTaskOutput;
+        };
+        sdk: {
+            input: StartExportTaskCommandInput;
+            output: StartExportTaskCommandOutput;
+        };
+    };
+}

package/dist-types/commands/StartImportTaskCommand.d.ts

@@ -45,7 +45,8 @@ declare const StartImportTaskCommand_base: {
  *   },
  *   failOnError: true || false,
  *   source: "STRING_VALUE", // required
- *   format: "CSV" || "OPEN_CYPHER" || "NTRIPLES",
+ *   format: "CSV" || "OPEN_CYPHER" || "PARQUET" || "NTRIPLES",
+ *   parquetType: "COLUMNAR",
  *   blankNodeHandling: "convertToIri",
  *   graphIdentifier: "STRING_VALUE", // required
  *   roleArn: "STRING_VALUE", // required
@@ -56,9 +57,10 @@ declare const StartImportTaskCommand_base: {
  * //   graphId: "STRING_VALUE",
  * //   taskId: "STRING_VALUE", // required
  * //   source: "STRING_VALUE", // required
- * //   format: "CSV" || "OPEN_CYPHER" || "NTRIPLES",
+ * //   format: "CSV" || "OPEN_CYPHER" || "PARQUET" || "NTRIPLES",
+ * //   parquetType: "COLUMNAR",
  * //   roleArn: "STRING_VALUE", // required
- * //   status: "INITIALIZING" || "EXPORTING" || "ANALYZING_DATA" || "IMPORTING" || "REPROVISIONING" || "ROLLING_BACK" || "SUCCEEDED" || "FAILED" || "CANCELLING" || "CANCELLED", // required
+ * //   status: "INITIALIZING" || "EXPORTING" || "ANALYZING_DATA" || "IMPORTING" || "REPROVISIONING" || "ROLLING_BACK" || "SUCCEEDED" || "FAILED" || "CANCELLING" || "CANCELLED" || "DELETED", // required
  * //   importOptions: { // ImportOptions Union: only one key present
  * //     neptune: { // NeptuneImportOptions
  * //       s3ExportPath: "STRING_VALUE", // required

package/dist-types/commands/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./CancelExportTaskCommand";
 export * from "./CancelImportTaskCommand";
 export * from "./CancelQueryCommand";
 export * from "./CreateGraphCommand";
@@ -8,12 +9,14 @@ export * from "./DeleteGraphCommand";
 export * from "./DeleteGraphSnapshotCommand";
 export * from "./DeletePrivateGraphEndpointCommand";
 export * from "./ExecuteQueryCommand";
+export * from "./GetExportTaskCommand";
 export * from "./GetGraphCommand";
 export * from "./GetGraphSnapshotCommand";
 export * from "./GetGraphSummaryCommand";
 export * from "./GetImportTaskCommand";
 export * from "./GetPrivateGraphEndpointCommand";
 export * from "./GetQueryCommand";
+export * from "./ListExportTasksCommand";
 export * from "./ListGraphSnapshotsCommand";
 export * from "./ListGraphsCommand";
 export * from "./ListImportTasksCommand";
@@ -22,6 +25,7 @@ export * from "./ListQueriesCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ResetGraphCommand";
 export * from "./RestoreGraphFromSnapshotCommand";
+export * from "./StartExportTaskCommand";
 export * from "./StartImportTaskCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";