diff --git a/clients/client-neptune-graph/README.md b/clients/client-neptune-graph/README.md index 6915c43dfa39..2ff958e8e6d9 100644 --- a/clients/client-neptune-graph/README.md +++ b/clients/client-neptune-graph/README.md @@ -205,6 +205,14 @@ see LICENSE for more information. ## Client Commands (Operations List) +
+ +CancelExportTask + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/neptune-graph/command/CancelExportTaskCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/CancelExportTaskCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/CancelExportTaskCommandOutput/) + +
CancelImportTask @@ -284,6 +292,14 @@ ExecuteQuery [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/neptune-graph/command/ExecuteQueryCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/ExecuteQueryCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/ExecuteQueryCommandOutput/) +
+
+ +GetExportTask + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/neptune-graph/command/GetExportTaskCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/GetExportTaskCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/GetExportTaskCommandOutput/) +
@@ -332,6 +348,14 @@ GetQuery [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/neptune-graph/command/GetQueryCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/GetQueryCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/GetQueryCommandOutput/) +
+
+ +ListExportTasks + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/neptune-graph/command/ListExportTasksCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/ListExportTasksCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/ListExportTasksCommandOutput/) +
@@ -396,6 +420,14 @@ RestoreGraphFromSnapshot [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/neptune-graph/command/RestoreGraphFromSnapshotCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/RestoreGraphFromSnapshotCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/RestoreGraphFromSnapshotCommandOutput/) +
+
+ +StartExportTask + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/neptune-graph/command/StartExportTaskCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/StartExportTaskCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-neptune-graph/Interface/StartExportTaskCommandOutput/) +
diff --git a/clients/client-neptune-graph/src/NeptuneGraph.ts b/clients/client-neptune-graph/src/NeptuneGraph.ts index a7bbb1a508ac..278e6f3b70e4 100644 --- a/clients/client-neptune-graph/src/NeptuneGraph.ts +++ b/clients/client-neptune-graph/src/NeptuneGraph.ts @@ -2,6 +2,11 @@ import { createAggregatedClient } from "@smithy/smithy-client"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types"; +import { + CancelExportTaskCommand, + CancelExportTaskCommandInput, + CancelExportTaskCommandOutput, +} from "./commands/CancelExportTaskCommand"; import { CancelImportTaskCommand, CancelImportTaskCommandInput, @@ -40,6 +45,11 @@ import { ExecuteQueryCommandInput, ExecuteQueryCommandOutput, } from "./commands/ExecuteQueryCommand"; +import { + GetExportTaskCommand, + GetExportTaskCommandInput, + GetExportTaskCommandOutput, +} from "./commands/GetExportTaskCommand"; import { GetGraphCommand, GetGraphCommandInput, GetGraphCommandOutput } from "./commands/GetGraphCommand"; import { GetGraphSnapshotCommand, @@ -62,6 +72,11 @@ import { GetPrivateGraphEndpointCommandOutput, } from "./commands/GetPrivateGraphEndpointCommand"; import { GetQueryCommand, GetQueryCommandInput, GetQueryCommandOutput } from "./commands/GetQueryCommand"; +import { + ListExportTasksCommand, + ListExportTasksCommandInput, + ListExportTasksCommandOutput, +} from "./commands/ListExportTasksCommand"; import { ListGraphsCommand, ListGraphsCommandInput, ListGraphsCommandOutput } from "./commands/ListGraphsCommand"; import { ListGraphSnapshotsCommand, @@ -90,6 +105,11 @@ import { RestoreGraphFromSnapshotCommandInput, RestoreGraphFromSnapshotCommandOutput, } from "./commands/RestoreGraphFromSnapshotCommand"; +import { + StartExportTaskCommand, + StartExportTaskCommandInput, + StartExportTaskCommandOutput, +} from "./commands/StartExportTaskCommand"; import { StartImportTaskCommand, StartImportTaskCommandInput, @@ -105,6 +125,7 @@ import { UpdateGraphCommand, UpdateGraphCommandInput, UpdateGraphCommandOutput } import { NeptuneGraphClient, NeptuneGraphClientConfig } from "./NeptuneGraphClient"; const commands = { + CancelExportTaskCommand, CancelImportTaskCommand, CancelQueryCommand, CreateGraphCommand, @@ -115,12 +136,14 @@ const commands = { DeleteGraphSnapshotCommand, DeletePrivateGraphEndpointCommand, ExecuteQueryCommand, + GetExportTaskCommand, GetGraphCommand, GetGraphSnapshotCommand, GetGraphSummaryCommand, GetImportTaskCommand, GetPrivateGraphEndpointCommand, GetQueryCommand, + ListExportTasksCommand, ListGraphsCommand, ListGraphSnapshotsCommand, ListImportTasksCommand, @@ -129,6 +152,7 @@ const commands = { ListTagsForResourceCommand, ResetGraphCommand, RestoreGraphFromSnapshotCommand, + StartExportTaskCommand, StartImportTaskCommand, TagResourceCommand, UntagResourceCommand, @@ -136,6 +160,23 @@ const commands = { }; export interface NeptuneGraph { + /** + * @see {@link CancelExportTaskCommand} + */ + cancelExportTask( + args: CancelExportTaskCommandInput, + options?: __HttpHandlerOptions + ): Promise; + cancelExportTask( + args: CancelExportTaskCommandInput, + cb: (err: any, data?: CancelExportTaskCommandOutput) => void + ): void; + cancelExportTask( + args: CancelExportTaskCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CancelExportTaskCommandOutput) => void + ): void; + /** * @see {@link CancelImportTaskCommand} */ @@ -282,6 +323,17 @@ export interface NeptuneGraph { cb: (err: any, data?: ExecuteQueryCommandOutput) => void ): void; + /** + * @see {@link GetExportTaskCommand} + */ + getExportTask(args: GetExportTaskCommandInput, options?: __HttpHandlerOptions): Promise; + getExportTask(args: GetExportTaskCommandInput, cb: (err: any, data?: GetExportTaskCommandOutput) => void): void; + getExportTask( + args: GetExportTaskCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetExportTaskCommandOutput) => void + ): void; + /** * @see {@link GetGraphCommand} */ @@ -363,6 +415,21 @@ export interface NeptuneGraph { cb: (err: any, data?: GetQueryCommandOutput) => void ): void; + /** + * @see {@link ListExportTasksCommand} + */ + listExportTasks(): Promise; + listExportTasks( + args: ListExportTasksCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listExportTasks(args: ListExportTasksCommandInput, cb: (err: any, data?: ListExportTasksCommandOutput) => void): void; + listExportTasks( + args: ListExportTasksCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListExportTasksCommandOutput) => void + ): void; + /** * @see {@link ListGraphsCommand} */ @@ -481,6 +548,20 @@ export interface NeptuneGraph { cb: (err: any, data?: RestoreGraphFromSnapshotCommandOutput) => void ): void; + /** + * @see {@link StartExportTaskCommand} + */ + startExportTask( + args: StartExportTaskCommandInput, + options?: __HttpHandlerOptions + ): Promise; + startExportTask(args: StartExportTaskCommandInput, cb: (err: any, data?: StartExportTaskCommandOutput) => void): void; + startExportTask( + args: StartExportTaskCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: StartExportTaskCommandOutput) => void + ): void; + /** * @see {@link StartImportTaskCommand} */ diff --git a/clients/client-neptune-graph/src/NeptuneGraphClient.ts b/clients/client-neptune-graph/src/NeptuneGraphClient.ts index 48e4efc80e42..8b7ee412b467 100644 --- a/clients/client-neptune-graph/src/NeptuneGraphClient.ts +++ b/clients/client-neptune-graph/src/NeptuneGraphClient.ts @@ -54,6 +54,7 @@ import { HttpAuthSchemeResolvedConfig, resolveHttpAuthSchemeConfig, } from "./auth/httpAuthSchemeProvider"; +import { CancelExportTaskCommandInput, CancelExportTaskCommandOutput } from "./commands/CancelExportTaskCommand"; import { CancelImportTaskCommandInput, CancelImportTaskCommandOutput } from "./commands/CancelImportTaskCommand"; import { CancelQueryCommandInput, CancelQueryCommandOutput } from "./commands/CancelQueryCommand"; import { CreateGraphCommandInput, CreateGraphCommandOutput } from "./commands/CreateGraphCommand"; @@ -79,6 +80,7 @@ import { DeletePrivateGraphEndpointCommandOutput, } from "./commands/DeletePrivateGraphEndpointCommand"; import { ExecuteQueryCommandInput, ExecuteQueryCommandOutput } from "./commands/ExecuteQueryCommand"; +import { GetExportTaskCommandInput, GetExportTaskCommandOutput } from "./commands/GetExportTaskCommand"; import { GetGraphCommandInput, GetGraphCommandOutput } from "./commands/GetGraphCommand"; import { GetGraphSnapshotCommandInput, GetGraphSnapshotCommandOutput } from "./commands/GetGraphSnapshotCommand"; import { GetGraphSummaryCommandInput, GetGraphSummaryCommandOutput } from "./commands/GetGraphSummaryCommand"; @@ -88,6 +90,7 @@ import { GetPrivateGraphEndpointCommandOutput, } from "./commands/GetPrivateGraphEndpointCommand"; import { GetQueryCommandInput, GetQueryCommandOutput } from "./commands/GetQueryCommand"; +import { ListExportTasksCommandInput, ListExportTasksCommandOutput } from "./commands/ListExportTasksCommand"; import { ListGraphsCommandInput, ListGraphsCommandOutput } from "./commands/ListGraphsCommand"; import { ListGraphSnapshotsCommandInput, ListGraphSnapshotsCommandOutput } from "./commands/ListGraphSnapshotsCommand"; import { ListImportTasksCommandInput, ListImportTasksCommandOutput } from "./commands/ListImportTasksCommand"; @@ -105,6 +108,7 @@ import { RestoreGraphFromSnapshotCommandInput, RestoreGraphFromSnapshotCommandOutput, } from "./commands/RestoreGraphFromSnapshotCommand"; +import { StartExportTaskCommandInput, StartExportTaskCommandOutput } from "./commands/StartExportTaskCommand"; import { StartImportTaskCommandInput, StartImportTaskCommandOutput } from "./commands/StartImportTaskCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; @@ -124,6 +128,7 @@ export { __Client }; * @public */ export type ServiceInputTypes = + | CancelExportTaskCommandInput | CancelImportTaskCommandInput | CancelQueryCommandInput | CreateGraphCommandInput @@ -134,12 +139,14 @@ export type ServiceInputTypes = | DeleteGraphSnapshotCommandInput | DeletePrivateGraphEndpointCommandInput | ExecuteQueryCommandInput + | GetExportTaskCommandInput | GetGraphCommandInput | GetGraphSnapshotCommandInput | GetGraphSummaryCommandInput | GetImportTaskCommandInput | GetPrivateGraphEndpointCommandInput | GetQueryCommandInput + | ListExportTasksCommandInput | ListGraphSnapshotsCommandInput | ListGraphsCommandInput | ListImportTasksCommandInput @@ -148,6 +155,7 @@ export type ServiceInputTypes = | ListTagsForResourceCommandInput | ResetGraphCommandInput | RestoreGraphFromSnapshotCommandInput + | StartExportTaskCommandInput | StartImportTaskCommandInput | TagResourceCommandInput | UntagResourceCommandInput @@ -157,6 +165,7 @@ export type ServiceInputTypes = * @public */ export type ServiceOutputTypes = + | CancelExportTaskCommandOutput | CancelImportTaskCommandOutput | CancelQueryCommandOutput | CreateGraphCommandOutput @@ -167,12 +176,14 @@ export type ServiceOutputTypes = | DeleteGraphSnapshotCommandOutput | DeletePrivateGraphEndpointCommandOutput | ExecuteQueryCommandOutput + | GetExportTaskCommandOutput | GetGraphCommandOutput | GetGraphSnapshotCommandOutput | GetGraphSummaryCommandOutput | GetImportTaskCommandOutput | GetPrivateGraphEndpointCommandOutput | GetQueryCommandOutput + | ListExportTasksCommandOutput | ListGraphSnapshotsCommandOutput | ListGraphsCommandOutput | ListImportTasksCommandOutput @@ -181,6 +192,7 @@ export type ServiceOutputTypes = | ListTagsForResourceCommandOutput | ResetGraphCommandOutput | RestoreGraphFromSnapshotCommandOutput + | StartExportTaskCommandOutput | StartImportTaskCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput diff --git a/clients/client-neptune-graph/src/commands/CancelExportTaskCommand.ts b/clients/client-neptune-graph/src/commands/CancelExportTaskCommand.ts new file mode 100644 index 000000000000..df32612b70f3 --- /dev/null +++ b/clients/client-neptune-graph/src/commands/CancelExportTaskCommand.ts @@ -0,0 +1,118 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CancelExportTaskInput, CancelExportTaskOutput } from "../models/models_0"; +import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient"; +import { de_CancelExportTaskCommand, se_CancelExportTaskCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CancelExportTaskCommand}. + */ +export interface CancelExportTaskCommandInput extends CancelExportTaskInput {} +/** + * @public + * + * The output of {@link CancelExportTaskCommand}. + */ +export interface CancelExportTaskCommandOutput extends CancelExportTaskOutput, __MetadataBearer {} + +/** + *

Cancel the specified export task.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneGraphClient, CancelExportTaskCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import + * // const { NeptuneGraphClient, CancelExportTaskCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import + * const client = new NeptuneGraphClient(config); + * const input = { // CancelExportTaskInput + * taskIdentifier: "STRING_VALUE", // required + * }; + * const command = new CancelExportTaskCommand(input); + * const response = await client.send(command); + * // { // CancelExportTaskOutput + * // 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", + * // }; + * + * ``` + * + * @param CancelExportTaskCommandInput - {@link CancelExportTaskCommandInput} + * @returns {@link CancelExportTaskCommandOutput} + * @see {@link CancelExportTaskCommandInput} for command's `input` shape. + * @see {@link CancelExportTaskCommandOutput} for command's `response` shape. + * @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape. + * + * @throws {@link ConflictException} (client fault) + *

Raised when a conflict is encountered.

+ * + * @throws {@link InternalServerException} (server fault) + *

A failure occurred on the server.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

A specified resource could not be located.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The exception was interrupted by throttling.

+ * + * @throws {@link ValidationException} (client fault) + *

A resource could not be validated.

+ * + * @throws {@link NeptuneGraphServiceException} + *

Base exception class for all service exceptions from NeptuneGraph service.

+ * + * @public + */ +export class CancelExportTaskCommand extends $Command + .classBuilder< + CancelExportTaskCommandInput, + CancelExportTaskCommandOutput, + NeptuneGraphClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + ApiType: { type: "staticContextParams", value: `ControlPlane` }, + }) + .m(function (this: any, Command: any, cs: any, config: NeptuneGraphClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonNeptuneGraph", "CancelExportTask", {}) + .n("NeptuneGraphClient", "CancelExportTaskCommand") + .f(void 0, void 0) + .ser(se_CancelExportTaskCommand) + .de(de_CancelExportTaskCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CancelExportTaskInput; + output: CancelExportTaskOutput; + }; + sdk: { + input: CancelExportTaskCommandInput; + output: CancelExportTaskCommandOutput; + }; + }; +} diff --git a/clients/client-neptune-graph/src/commands/CancelImportTaskCommand.ts b/clients/client-neptune-graph/src/commands/CancelImportTaskCommand.ts index 036c4891c580..000290e5606e 100644 --- a/clients/client-neptune-graph/src/commands/CancelImportTaskCommand.ts +++ b/clients/client-neptune-graph/src/commands/CancelImportTaskCommand.ts @@ -44,9 +44,10 @@ export interface CancelImportTaskCommandOutput extends CancelImportTaskOutput, _ * // 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 * // }; * * ``` diff --git a/clients/client-neptune-graph/src/commands/CreateGraphUsingImportTaskCommand.ts b/clients/client-neptune-graph/src/commands/CreateGraphUsingImportTaskCommand.ts index 3c252905639b..ef5360b670cc 100644 --- a/clients/client-neptune-graph/src/commands/CreateGraphUsingImportTaskCommand.ts +++ b/clients/client-neptune-graph/src/commands/CreateGraphUsingImportTaskCommand.ts @@ -63,7 +63,8 @@ export interface CreateGraphUsingImportTaskCommandOutput extends CreateGraphUsin * minProvisionedMemory: Number("int"), * failOnError: true || false, * source: "STRING_VALUE", // required - * format: "CSV" || "OPEN_CYPHER" || "NTRIPLES", + * format: "CSV" || "OPEN_CYPHER" || "PARQUET" || "NTRIPLES", + * parquetType: "COLUMNAR", * blankNodeHandling: "convertToIri", * roleArn: "STRING_VALUE", // required * }; @@ -73,9 +74,10 @@ export interface CreateGraphUsingImportTaskCommandOutput extends CreateGraphUsin * // 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 diff --git a/clients/client-neptune-graph/src/commands/GetExportTaskCommand.ts b/clients/client-neptune-graph/src/commands/GetExportTaskCommand.ts new file mode 100644 index 000000000000..ac9363f1ad2e --- /dev/null +++ b/clients/client-neptune-graph/src/commands/GetExportTaskCommand.ts @@ -0,0 +1,146 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetExportTaskInput, GetExportTaskOutput } from "../models/models_0"; +import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient"; +import { de_GetExportTaskCommand, se_GetExportTaskCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetExportTaskCommand}. + */ +export interface GetExportTaskCommandInput extends GetExportTaskInput {} +/** + * @public + * + * The output of {@link GetExportTaskCommand}. + */ +export interface GetExportTaskCommandOutput extends GetExportTaskOutput, __MetadataBearer {} + +/** + *

Retrieves a specified export task.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneGraphClient, GetExportTaskCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import + * // const { NeptuneGraphClient, GetExportTaskCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import + * const client = new NeptuneGraphClient(config); + * const input = { // GetExportTaskInput + * taskIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetExportTaskCommand(input); + * const response = await client.send(command); + * // { // GetExportTaskOutput + * // 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", + * // exportTaskDetails: { // ExportTaskDetails + * // startTime: new Date("TIMESTAMP"), // required + * // timeElapsedSeconds: Number("long"), // required + * // progressPercentage: Number("int"), // required + * // numVerticesWritten: Number("long"), + * // numEdgesWritten: Number("long"), + * // }, + * // exportFilter: { // ExportFilter + * // vertexFilter: { // ExportFilterPerLabelMap + * // "": { // ExportFilterElement + * // properties: { // ExportFilterPropertyMap + * // "": { // ExportFilterPropertyAttributes + * // outputType: "STRING_VALUE", + * // sourcePropertyName: "STRING_VALUE", + * // multiValueHandling: "TO_LIST" || "PICK_FIRST", + * // }, + * // }, + * // }, + * // }, + * // edgeFilter: { + * // "": { + * // properties: { + * // "": { + * // outputType: "STRING_VALUE", + * // sourcePropertyName: "STRING_VALUE", + * // multiValueHandling: "TO_LIST" || "PICK_FIRST", + * // }, + * // }, + * // }, + * // }, + * // }, + * // }; + * + * ``` + * + * @param GetExportTaskCommandInput - {@link GetExportTaskCommandInput} + * @returns {@link GetExportTaskCommandOutput} + * @see {@link GetExportTaskCommandInput} for command's `input` shape. + * @see {@link GetExportTaskCommandOutput} for command's `response` shape. + * @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *

A failure occurred on the server.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

A specified resource could not be located.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The exception was interrupted by throttling.

+ * + * @throws {@link ValidationException} (client fault) + *

A resource could not be validated.

+ * + * @throws {@link NeptuneGraphServiceException} + *

Base exception class for all service exceptions from NeptuneGraph service.

+ * + * @public + */ +export class GetExportTaskCommand extends $Command + .classBuilder< + GetExportTaskCommandInput, + GetExportTaskCommandOutput, + NeptuneGraphClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + ApiType: { type: "staticContextParams", value: `ControlPlane` }, + }) + .m(function (this: any, Command: any, cs: any, config: NeptuneGraphClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonNeptuneGraph", "GetExportTask", {}) + .n("NeptuneGraphClient", "GetExportTaskCommand") + .f(void 0, void 0) + .ser(se_GetExportTaskCommand) + .de(de_GetExportTaskCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetExportTaskInput; + output: GetExportTaskOutput; + }; + sdk: { + input: GetExportTaskCommandInput; + output: GetExportTaskCommandOutput; + }; + }; +} diff --git a/clients/client-neptune-graph/src/commands/GetImportTaskCommand.ts b/clients/client-neptune-graph/src/commands/GetImportTaskCommand.ts index 38396d32bd5b..883cdcb398a8 100644 --- a/clients/client-neptune-graph/src/commands/GetImportTaskCommand.ts +++ b/clients/client-neptune-graph/src/commands/GetImportTaskCommand.ts @@ -44,9 +44,10 @@ export interface GetImportTaskCommandOutput extends GetImportTaskOutput, __Metad * // 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 diff --git a/clients/client-neptune-graph/src/commands/ListExportTasksCommand.ts b/clients/client-neptune-graph/src/commands/ListExportTasksCommand.ts new file mode 100644 index 000000000000..d9884d232efd --- /dev/null +++ b/clients/client-neptune-graph/src/commands/ListExportTasksCommand.ts @@ -0,0 +1,121 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListExportTasksInput, ListExportTasksOutput } from "../models/models_0"; +import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient"; +import { de_ListExportTasksCommand, se_ListExportTasksCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListExportTasksCommand}. + */ +export interface ListExportTasksCommandInput extends ListExportTasksInput {} +/** + * @public + * + * The output of {@link ListExportTasksCommand}. + */ +export interface ListExportTasksCommandOutput extends ListExportTasksOutput, __MetadataBearer {} + +/** + *

Retrieves a list of export tasks.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * 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 + * 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", + * // }; + * + * ``` + * + * @param ListExportTasksCommandInput - {@link ListExportTasksCommandInput} + * @returns {@link ListExportTasksCommandOutput} + * @see {@link ListExportTasksCommandInput} for command's `input` shape. + * @see {@link ListExportTasksCommandOutput} for command's `response` shape. + * @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *

A failure occurred on the server.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

A specified resource could not be located.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The exception was interrupted by throttling.

+ * + * @throws {@link ValidationException} (client fault) + *

A resource could not be validated.

+ * + * @throws {@link NeptuneGraphServiceException} + *

Base exception class for all service exceptions from NeptuneGraph service.

+ * + * @public + */ +export class ListExportTasksCommand extends $Command + .classBuilder< + ListExportTasksCommandInput, + ListExportTasksCommandOutput, + NeptuneGraphClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + ApiType: { type: "staticContextParams", value: `ControlPlane` }, + }) + .m(function (this: any, Command: any, cs: any, config: NeptuneGraphClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonNeptuneGraph", "ListExportTasks", {}) + .n("NeptuneGraphClient", "ListExportTasksCommand") + .f(void 0, void 0) + .ser(se_ListExportTasksCommand) + .de(de_ListExportTasksCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListExportTasksInput; + output: ListExportTasksOutput; + }; + sdk: { + input: ListExportTasksCommandInput; + output: ListExportTasksCommandOutput; + }; + }; +} diff --git a/clients/client-neptune-graph/src/commands/ListImportTasksCommand.ts b/clients/client-neptune-graph/src/commands/ListImportTasksCommand.ts index d67c7680d521..447d45c75bc4 100644 --- a/clients/client-neptune-graph/src/commands/ListImportTasksCommand.ts +++ b/clients/client-neptune-graph/src/commands/ListImportTasksCommand.ts @@ -47,9 +47,10 @@ export interface ListImportTasksCommandOutput extends ListImportTasksOutput, __M * // 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 * // }, * // ], * // nextToken: "STRING_VALUE", diff --git a/clients/client-neptune-graph/src/commands/StartExportTaskCommand.ts b/clients/client-neptune-graph/src/commands/StartExportTaskCommand.ts new file mode 100644 index 000000000000..8e61751454dd --- /dev/null +++ b/clients/client-neptune-graph/src/commands/StartExportTaskCommand.ts @@ -0,0 +1,174 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { StartExportTaskInput, StartExportTaskOutput } from "../models/models_0"; +import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient"; +import { de_StartExportTaskCommand, se_StartExportTaskCommand } from "../protocols/Aws_restJson1"; + +/** + * @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 {} + +/** + *

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

+ * @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 + * "": { // ExportFilterElement + * properties: { // ExportFilterPropertyMap + * "": { // ExportFilterPropertyAttributes + * outputType: "STRING_VALUE", + * sourcePropertyName: "STRING_VALUE", + * multiValueHandling: "TO_LIST" || "PICK_FIRST", + * }, + * }, + * }, + * }, + * edgeFilter: { + * "": { + * properties: { + * "": { + * outputType: "STRING_VALUE", + * sourcePropertyName: "STRING_VALUE", + * multiValueHandling: "TO_LIST" || "PICK_FIRST", + * }, + * }, + * }, + * }, + * }, + * tags: { // TagMap + * "": "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 + * // "": { // ExportFilterElement + * // properties: { // ExportFilterPropertyMap + * // "": { // ExportFilterPropertyAttributes + * // outputType: "STRING_VALUE", + * // sourcePropertyName: "STRING_VALUE", + * // multiValueHandling: "TO_LIST" || "PICK_FIRST", + * // }, + * // }, + * // }, + * // }, + * // edgeFilter: { + * // "": { + * // properties: { + * // "": { + * // 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) + *

Raised when a conflict is encountered.

+ * + * @throws {@link InternalServerException} (server fault) + *

A failure occurred on the server.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

A specified resource could not be located.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The exception was interrupted by throttling.

+ * + * @throws {@link ValidationException} (client fault) + *

A resource could not be validated.

+ * + * @throws {@link NeptuneGraphServiceException} + *

Base exception class for all service exceptions from NeptuneGraph service.

+ * + * @public + */ +export class StartExportTaskCommand extends $Command + .classBuilder< + StartExportTaskCommandInput, + StartExportTaskCommandOutput, + NeptuneGraphClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + ApiType: { type: "staticContextParams", value: `ControlPlane` }, + }) + .m(function (this: any, Command: any, cs: any, config: NeptuneGraphClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonNeptuneGraph", "StartExportTask", {}) + .n("NeptuneGraphClient", "StartExportTaskCommand") + .f(void 0, void 0) + .ser(se_StartExportTaskCommand) + .de(de_StartExportTaskCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: StartExportTaskInput; + output: StartExportTaskOutput; + }; + sdk: { + input: StartExportTaskCommandInput; + output: StartExportTaskCommandOutput; + }; + }; +} diff --git a/clients/client-neptune-graph/src/commands/StartImportTaskCommand.ts b/clients/client-neptune-graph/src/commands/StartImportTaskCommand.ts index 1b2aa4ce2a98..7880fc4317d2 100644 --- a/clients/client-neptune-graph/src/commands/StartImportTaskCommand.ts +++ b/clients/client-neptune-graph/src/commands/StartImportTaskCommand.ts @@ -46,7 +46,8 @@ export interface StartImportTaskCommandOutput extends StartImportTaskOutput, __M * }, * 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 @@ -57,9 +58,10 @@ export interface StartImportTaskCommandOutput extends StartImportTaskOutput, __M * // 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 diff --git a/clients/client-neptune-graph/src/commands/index.ts b/clients/client-neptune-graph/src/commands/index.ts index 37fd1d113eb0..9c7a01246e98 100644 --- a/clients/client-neptune-graph/src/commands/index.ts +++ b/clients/client-neptune-graph/src/commands/index.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +export * from "./CancelExportTaskCommand"; export * from "./CancelImportTaskCommand"; export * from "./CancelQueryCommand"; export * from "./CreateGraphCommand"; @@ -9,12 +10,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"; @@ -23,6 +26,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"; diff --git a/clients/client-neptune-graph/src/models/models_0.ts b/clients/client-neptune-graph/src/models/models_0.ts index 8fa20f0b443f..3e2aaf94b156 100644 --- a/clients/client-neptune-graph/src/models/models_0.ts +++ b/clients/client-neptune-graph/src/models/models_0.ts @@ -2278,6 +2278,123 @@ export interface TagResourceInput { */ export interface TagResourceOutput {} +/** + * @public + */ +export interface CancelExportTaskInput { + /** + *

The unique identifier of the export task.

+ * @public + */ + taskIdentifier: string | undefined; +} + +/** + * @public + * @enum + */ +export const ExportFormat = { + CSV: "CSV", + PARQUET: "PARQUET", +} as const; + +/** + * @public + */ +export type ExportFormat = (typeof ExportFormat)[keyof typeof ExportFormat]; + +/** + * @public + * @enum + */ +export const ParquetType = { + COLUMNAR: "COLUMNAR", +} as const; + +/** + * @public + */ +export type ParquetType = (typeof ParquetType)[keyof typeof ParquetType]; + +/** + * @public + * @enum + */ +export const ExportTaskStatus = { + CANCELLED: "CANCELLED", + CANCELLING: "CANCELLING", + DELETED: "DELETED", + EXPORTING: "EXPORTING", + FAILED: "FAILED", + INITIALIZING: "INITIALIZING", + SUCCEEDED: "SUCCEEDED", +} as const; + +/** + * @public + */ +export type ExportTaskStatus = (typeof ExportTaskStatus)[keyof typeof ExportTaskStatus]; + +/** + * @public + */ +export interface CancelExportTaskOutput { + /** + *

The source graph identifier of the cancelled export task.

+ * @public + */ + graphId: string | undefined; + + /** + *

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

+ * @public + */ + roleArn: string | undefined; + + /** + *

The unique identifier of the export task.

+ * @public + */ + taskId: string | undefined; + + /** + *

The current status of the export task. The status is CANCELLING when the + * export task is cancelled.

+ * @public + */ + status: ExportTaskStatus | undefined; + + /** + *

The format of the cancelled export task.

+ * @public + */ + format: ExportFormat | undefined; + + /** + *

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

+ * @public + */ + destination: string | undefined; + + /** + *

The KMS key identifier of the cancelled export task.

+ * @public + */ + kmsKeyIdentifier: string | undefined; + + /** + *

The parquet type of the cancelled export task.

+ * @public + */ + parquetType?: ParquetType | undefined; + + /** + *

The reason that the export task has this status value.

+ * @public + */ + statusReason?: string | undefined; +} + /** * @public */ @@ -2297,6 +2414,7 @@ export const Format = { CSV: "CSV", NTRIPLES: "NTRIPLES", OPEN_CYPHER: "OPEN_CYPHER", + PARQUET: "PARQUET", } as const; /** @@ -2312,6 +2430,7 @@ export const ImportTaskStatus = { ANALYZING_DATA: "ANALYZING_DATA", CANCELLED: "CANCELLED", CANCELLING: "CANCELLING", + DELETED: "DELETED", EXPORTING: "EXPORTING", FAILED: "FAILED", IMPORTING: "IMPORTING", @@ -2358,6 +2477,12 @@ export interface CancelImportTaskOutput { */ format?: Format | undefined; + /** + *

The parquet type of the cancelled import task.

+ * @public + */ + parquetType?: ParquetType | undefined; + /** *

The ARN of the IAM role that will allow access to the data that is to be imported.

* @public @@ -2566,6 +2691,12 @@ export interface CreateGraphUsingImportTaskInput { */ format?: Format | undefined; + /** + *

The parquet type of the import task.

+ * @public + */ + parquetType?: ParquetType | undefined; + /** *

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, * meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. @@ -2614,6 +2745,12 @@ export interface CreateGraphUsingImportTaskOutput { */ format?: Format | undefined; + /** + *

The parquet type of the import task.

+ * @public + */ + parquetType?: ParquetType | undefined; + /** *

The ARN of the IAM role that will allow access to the data that is to be imported.

* @public @@ -2636,6 +2773,204 @@ export interface CreateGraphUsingImportTaskOutput { importOptions?: ImportOptions | undefined; } +/** + * @public + */ +export interface GetExportTaskInput { + /** + *

The unique identifier of the export task.

+ * @public + */ + taskIdentifier: string | undefined; +} + +/** + * @public + * @enum + */ +export const MultiValueHandlingType = { + PICK_FIRST: "PICK_FIRST", + TO_LIST: "TO_LIST", +} as const; + +/** + * @public + */ +export type MultiValueHandlingType = (typeof MultiValueHandlingType)[keyof typeof MultiValueHandlingType]; + +/** + *

A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName + * and multiValueHandling.

+ * @public + */ +export interface ExportFilterPropertyAttributes { + /** + *

Specifies the data type to use for the property in the exported data (e.g. "String", "Int", "Float"). + * If a type is not provided, the export process will determine the type. If a given property is present as multiple + * types (e.g. one vertex has "height" stored as a double, and another edge has it stored as a string), the type + * will be of Any type, otherwise, it will be the type of the property as present in vertices.

+ * @public + */ + outputType?: string | undefined; + + /** + *

The name of the property as it exists in the original graph data. If not provided, it is assumed that the key + * matches the desired sourcePropertyName.

+ * @public + */ + sourcePropertyName?: string | undefined; + + /** + *

Specifies how to handle properties that have multiple values. Can be either TO_LIST to export all + * values as a list, or PICK_FIRST to export the first value encountered. If not specified, the default + * value is PICK_FIRST.

+ * @public + */ + multiValueHandling?: MultiValueHandlingType | undefined; +} + +/** + *

Specifies whihc properties of that label should be included in the export.

+ * @public + */ +export interface ExportFilterElement { + /** + *

Each property is defined by a key-value pair, where the key is the desired output property name (e.g. "name"), + * and the value is an object.

+ * @public + */ + properties?: Record | undefined; +} + +/** + *

This is the top-level field for specifying vertex or edge filters. If the ExportFilter is not provided, + * then all properties for all labels will be exported. If the ExportFilter is provided but is an empty object, + * then no data will be exported.

+ * @public + */ +export interface ExportFilter { + /** + *

Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels + * and properties are included in the export.

+ * @public + */ + vertexFilter?: Record | undefined; + + /** + *

Used to specify filters on a per-label basis for edges. This allows you to control which edge labels + * and properties are included in the export.

+ * @public + */ + edgeFilter?: Record | undefined; +} + +/** + *

Contains details about the specified export task.

+ * @public + */ +export interface ExportTaskDetails { + /** + *

The start time of the export task.

+ * @public + */ + startTime: Date | undefined; + + /** + *

The time elapsed, in seconds, since the start time of the export task.

+ * @public + */ + timeElapsedSeconds: number | undefined; + + /** + *

The number of progress percentage of the export task.

+ * @public + */ + progressPercentage: number | undefined; + + /** + *

The number of exported vertices.

+ * @public + */ + numVerticesWritten?: number | undefined; + + /** + *

The number of exported edges.

+ * @public + */ + numEdgesWritten?: number | undefined; +} + +/** + * @public + */ +export interface GetExportTaskOutput { + /** + *

The source graph identifier of the export task.

+ * @public + */ + graphId: string | undefined; + + /** + *

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

+ * @public + */ + roleArn: string | undefined; + + /** + *

The unique identifier of the export task.

+ * @public + */ + taskId: string | undefined; + + /** + *

The current status of the export task.

+ * @public + */ + status: ExportTaskStatus | undefined; + + /** + *

The format of the export task.

+ * @public + */ + format: ExportFormat | undefined; + + /** + *

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

+ * @public + */ + destination: string | undefined; + + /** + *

The KMS key identifier of the export task.

+ * @public + */ + kmsKeyIdentifier: string | undefined; + + /** + *

The parquet type of the export task.

+ * @public + */ + parquetType?: ParquetType | undefined; + + /** + *

The reason that the export task has this status value.

+ * @public + */ + statusReason?: string | undefined; + + /** + *

The details of the export task.

+ * @public + */ + exportTaskDetails?: ExportTaskDetails | undefined; + + /** + *

The export filter of the export task.

+ * @public + */ + exportFilter?: ExportFilter | undefined; +} + /** * @public */ @@ -2733,6 +3068,12 @@ export interface GetImportTaskOutput { */ format?: Format | undefined; + /** + *

The parquet type of the import task.

+ * @public + */ + parquetType?: ParquetType | undefined; + /** *

The ARN of the IAM role that will allow access to the data that is to be imported.

* @public @@ -2818,7 +3159,7 @@ export interface GetImportTaskOutput { importTaskDetails?: ImportTaskDetails | undefined; /** - *

The number of the current attempt to execute the import task.

+ *

The number of the current attempts to execute the import task.

* @public */ attemptNumber?: number | undefined; @@ -2830,6 +3171,100 @@ export interface GetImportTaskOutput { statusReason?: string | undefined; } +/** + * @public + */ +export interface ListExportTasksInput { + /** + *

Pagination token used to paginate input.

+ * @public + */ + nextToken?: string | undefined; + + /** + *

The maximum number of export tasks to return.

+ * @public + */ + maxResults?: number | undefined; +} + +/** + *

Provides details about an export task.

+ * @public + */ +export interface ExportTaskSummary { + /** + *

The source graph identifier of the export task.

+ * @public + */ + graphId: string | undefined; + + /** + *

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

+ * @public + */ + roleArn: string | undefined; + + /** + *

The unique identifier of the export task.

+ * @public + */ + taskId: string | undefined; + + /** + *

The current status of the export task.

+ * @public + */ + status: ExportTaskStatus | undefined; + + /** + *

The format of the export task.

+ * @public + */ + format: ExportFormat | undefined; + + /** + *

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

+ * @public + */ + destination: string | undefined; + + /** + *

The KMS key identifier of the export task.

+ * @public + */ + kmsKeyIdentifier: string | undefined; + + /** + *

The parquet type of the export task.

+ * @public + */ + parquetType?: ParquetType | undefined; + + /** + *

The reason that the export task has this status value.

+ * @public + */ + statusReason?: string | undefined; +} + +/** + * @public + */ +export interface ListExportTasksOutput { + /** + *

The requested list of export tasks.

+ * @public + */ + tasks: ExportTaskSummary[] | undefined; + + /** + *

Pagination token used to paginate output.

+ * @public + */ + nextToken?: string | undefined; +} + /** * @public */ @@ -2888,6 +3323,12 @@ export interface ImportTaskSummary { */ format?: Format | undefined; + /** + *

The parquet type of the import task.

+ * @public + */ + parquetType?: ParquetType | undefined; + /** *

The ARN of the IAM role that will allow access to the data that is to be imported.

* @public @@ -2921,6 +3362,124 @@ export interface ListImportTasksOutput { nextToken?: string | undefined; } +/** + * @public + */ +export interface StartExportTaskInput { + /** + *

The source graph identifier of the export task.

+ * @public + */ + graphIdentifier: string | undefined; + + /** + *

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

+ * @public + */ + roleArn: string | undefined; + + /** + *

The format of the export task.

+ * @public + */ + format: ExportFormat | undefined; + + /** + *

The Amazon S3 URI where data will be exported to.

+ * @public + */ + destination: string | undefined; + + /** + *

The KMS key identifier of the export task.

+ * @public + */ + kmsKeyIdentifier: string | undefined; + + /** + *

The parquet type of the export task.

+ * @public + */ + parquetType?: ParquetType | undefined; + + /** + *

The export filter of the export task.

+ * @public + */ + exportFilter?: ExportFilter | undefined; + + /** + *

Tags to be applied to the export task.

+ * @public + */ + tags?: Record | undefined; +} + +/** + * @public + */ +export interface StartExportTaskOutput { + /** + *

The source graph identifier of the export task.

+ * @public + */ + graphId: string | undefined; + + /** + *

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

+ * @public + */ + roleArn: string | undefined; + + /** + *

The unique identifier of the export task.

+ * @public + */ + taskId: string | undefined; + + /** + *

The current status of the export task.

+ * @public + */ + status: ExportTaskStatus | undefined; + + /** + *

The format of the export task.

+ * @public + */ + format: ExportFormat | undefined; + + /** + *

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

+ * @public + */ + destination: string | undefined; + + /** + *

The KMS key identifier of the export task.

+ * @public + */ + kmsKeyIdentifier: string | undefined; + + /** + *

The parquet type of the export task.

+ * @public + */ + parquetType?: ParquetType | undefined; + + /** + *

The reason that the export task has this status value.

+ * @public + */ + statusReason?: string | undefined; + + /** + *

The export filter of the export task.

+ * @public + */ + exportFilter?: ExportFilter | undefined; +} + /** * @public */ @@ -2952,6 +3511,12 @@ export interface StartImportTaskInput { */ format?: Format | undefined; + /** + *

The parquet type of the import task.

+ * @public + */ + parquetType?: ParquetType | undefined; + /** *

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, * meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. @@ -3003,6 +3568,12 @@ export interface StartImportTaskOutput { */ format?: Format | undefined; + /** + *

The parquet type of the import task.

+ * @public + */ + parquetType?: ParquetType | undefined; + /** *

The ARN of the IAM role that will allow access to the data that is to be imported.

* @public diff --git a/clients/client-neptune-graph/src/pagination/ListExportTasksPaginator.ts b/clients/client-neptune-graph/src/pagination/ListExportTasksPaginator.ts new file mode 100644 index 000000000000..2e5509d5c2ee --- /dev/null +++ b/clients/client-neptune-graph/src/pagination/ListExportTasksPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListExportTasksCommand, + ListExportTasksCommandInput, + ListExportTasksCommandOutput, +} from "../commands/ListExportTasksCommand"; +import { NeptuneGraphClient } from "../NeptuneGraphClient"; +import { NeptuneGraphPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListExportTasks: ( + config: NeptuneGraphPaginationConfiguration, + input: ListExportTasksCommandInput, + ...rest: any[] +) => Paginator = createPaginator< + NeptuneGraphPaginationConfiguration, + ListExportTasksCommandInput, + ListExportTasksCommandOutput +>(NeptuneGraphClient, ListExportTasksCommand, "nextToken", "nextToken", "maxResults"); diff --git a/clients/client-neptune-graph/src/pagination/index.ts b/clients/client-neptune-graph/src/pagination/index.ts index 5440a11f3c5d..84da649b756b 100644 --- a/clients/client-neptune-graph/src/pagination/index.ts +++ b/clients/client-neptune-graph/src/pagination/index.ts @@ -1,5 +1,6 @@ // smithy-typescript generated code export * from "./Interfaces"; +export * from "./ListExportTasksPaginator"; export * from "./ListGraphSnapshotsPaginator"; export * from "./ListGraphsPaginator"; export * from "./ListImportTasksPaginator"; diff --git a/clients/client-neptune-graph/src/protocols/Aws_restJson1.ts b/clients/client-neptune-graph/src/protocols/Aws_restJson1.ts index 1dae92ea7fd4..23779362a3d5 100644 --- a/clients/client-neptune-graph/src/protocols/Aws_restJson1.ts +++ b/clients/client-neptune-graph/src/protocols/Aws_restJson1.ts @@ -39,6 +39,7 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; +import { CancelExportTaskCommandInput, CancelExportTaskCommandOutput } from "../commands/CancelExportTaskCommand"; import { CancelImportTaskCommandInput, CancelImportTaskCommandOutput } from "../commands/CancelImportTaskCommand"; import { CancelQueryCommandInput, CancelQueryCommandOutput } from "../commands/CancelQueryCommand"; import { CreateGraphCommandInput, CreateGraphCommandOutput } from "../commands/CreateGraphCommand"; @@ -64,6 +65,7 @@ import { DeletePrivateGraphEndpointCommandOutput, } from "../commands/DeletePrivateGraphEndpointCommand"; import { ExecuteQueryCommandInput, ExecuteQueryCommandOutput } from "../commands/ExecuteQueryCommand"; +import { GetExportTaskCommandInput, GetExportTaskCommandOutput } from "../commands/GetExportTaskCommand"; import { GetGraphCommandInput, GetGraphCommandOutput } from "../commands/GetGraphCommand"; import { GetGraphSnapshotCommandInput, GetGraphSnapshotCommandOutput } from "../commands/GetGraphSnapshotCommand"; import { GetGraphSummaryCommandInput, GetGraphSummaryCommandOutput } from "../commands/GetGraphSummaryCommand"; @@ -73,6 +75,7 @@ import { GetPrivateGraphEndpointCommandOutput, } from "../commands/GetPrivateGraphEndpointCommand"; import { GetQueryCommandInput, GetQueryCommandOutput } from "../commands/GetQueryCommand"; +import { ListExportTasksCommandInput, ListExportTasksCommandOutput } from "../commands/ListExportTasksCommand"; import { ListGraphsCommandInput, ListGraphsCommandOutput } from "../commands/ListGraphsCommand"; import { ListGraphSnapshotsCommandInput, ListGraphSnapshotsCommandOutput } from "../commands/ListGraphSnapshotsCommand"; import { ListImportTasksCommandInput, ListImportTasksCommandOutput } from "../commands/ListImportTasksCommand"; @@ -90,6 +93,7 @@ import { RestoreGraphFromSnapshotCommandInput, RestoreGraphFromSnapshotCommandOutput, } from "../commands/RestoreGraphFromSnapshotCommand"; +import { StartExportTaskCommandInput, StartExportTaskCommandOutput } from "../commands/StartExportTaskCommand"; import { StartImportTaskCommandInput, StartImportTaskCommandOutput } from "../commands/StartImportTaskCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand"; @@ -97,6 +101,10 @@ import { UpdateGraphCommandInput, UpdateGraphCommandOutput } from "../commands/U import { AccessDeniedException, ConflictException, + ExportFilter, + ExportFilterElement, + ExportFilterPropertyAttributes, + ExportTaskDetails, GraphSnapshotSummary, ImportOptions, ImportTaskDetails, @@ -111,6 +119,22 @@ import { } from "../models/models_0"; import { NeptuneGraphServiceException as __BaseException } from "../models/NeptuneGraphServiceException"; +/** + * serializeAws_restJson1CancelExportTaskCommand + */ +export const se_CancelExportTaskCommand = async ( + input: CancelExportTaskCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/exporttasks/{taskIdentifier}"); + b.p("taskIdentifier", () => input.taskIdentifier!, "{taskIdentifier}", false); + let body: any; + b.m("DELETE").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1CancelImportTaskCommand */ @@ -234,6 +258,7 @@ export const se_CreateGraphUsingImportTaskCommand = async ( kmsKeyIdentifier: [], maxProvisionedMemory: [], minProvisionedMemory: [], + parquetType: [], publicConnectivity: [], replicaCount: [], roleArn: [], @@ -363,6 +388,22 @@ export const se_ExecuteQueryCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1GetExportTaskCommand + */ +export const se_GetExportTaskCommand = async ( + input: GetExportTaskCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/exporttasks/{taskIdentifier}"); + b.p("taskIdentifier", () => input.taskIdentifier!, "{taskIdentifier}", false); + let body: any; + b.m("GET").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1GetGraphCommand */ @@ -490,6 +531,25 @@ export const se_GetQueryCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1ListExportTasksCommand + */ +export const se_ListExportTasksCommand = async ( + input: ListExportTasksCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/exporttasks"); + const query: any = map({ + [_nT]: [, input[_nT]!], + [_mR]: [() => input.maxResults !== void 0, () => input[_mR]!.toString()], + }); + let body: any; + b.m("GET").h(headers).q(query).b(body); + return b.build(); +}; + /** * serializeAws_restJson1ListGraphsCommand */ @@ -668,6 +728,35 @@ export const se_RestoreGraphFromSnapshotCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1StartExportTaskCommand + */ +export const se_StartExportTaskCommand = async ( + input: StartExportTaskCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/exporttasks"); + let body: any; + body = JSON.stringify( + take(input, { + destination: [], + exportFilter: (_) => _json(_), + format: [], + graphIdentifier: [], + kmsKeyIdentifier: [], + parquetType: [], + roleArn: [], + tags: (_) => _json(_), + }) + ); + b.m("POST").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1StartImportTaskCommand */ @@ -688,6 +777,7 @@ export const se_StartImportTaskCommand = async ( failOnError: [], format: [], importOptions: (_) => _json(_), + parquetType: [], roleArn: [], source: [], }) @@ -763,6 +853,35 @@ export const se_UpdateGraphCommand = async ( return b.build(); }; +/** + * deserializeAws_restJson1CancelExportTaskCommand + */ +export const de_CancelExportTaskCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + destination: __expectString, + format: __expectString, + graphId: __expectString, + kmsKeyIdentifier: __expectString, + parquetType: __expectString, + roleArn: __expectString, + status: __expectString, + statusReason: __expectString, + taskId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1CancelImportTaskCommand */ @@ -780,6 +899,7 @@ export const de_CancelImportTaskCommand = async ( const doc = take(data, { format: __expectString, graphId: __expectString, + parquetType: __expectString, roleArn: __expectString, source: __expectString, status: __expectString, @@ -886,6 +1006,7 @@ export const de_CreateGraphUsingImportTaskCommand = async ( format: __expectString, graphId: __expectString, importOptions: (_) => _json(__expectUnion(_)), + parquetType: __expectString, roleArn: __expectString, source: __expectString, status: __expectString, @@ -1024,6 +1145,37 @@ export const de_ExecuteQueryCommand = async ( return contents; }; +/** + * deserializeAws_restJson1GetExportTaskCommand + */ +export const de_GetExportTaskCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + destination: __expectString, + exportFilter: _json, + exportTaskDetails: (_) => de_ExportTaskDetails(_, context), + format: __expectString, + graphId: __expectString, + kmsKeyIdentifier: __expectString, + parquetType: __expectString, + roleArn: __expectString, + status: __expectString, + statusReason: __expectString, + taskId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1GetGraphCommand */ @@ -1129,6 +1281,7 @@ export const de_GetImportTaskCommand = async ( graphId: __expectString, importOptions: (_) => _json(__expectUnion(_)), importTaskDetails: (_) => de_ImportTaskDetails(_, context), + parquetType: __expectString, roleArn: __expectString, source: __expectString, status: __expectString, @@ -1188,6 +1341,28 @@ export const de_GetQueryCommand = async ( return contents; }; +/** + * deserializeAws_restJson1ListExportTasksCommand + */ +export const de_ListExportTasksCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + nextToken: __expectString, + tasks: _json, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1ListGraphsCommand */ @@ -1388,6 +1563,36 @@ export const de_RestoreGraphFromSnapshotCommand = async ( return contents; }; +/** + * deserializeAws_restJson1StartExportTaskCommand + */ +export const de_StartExportTaskCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 201 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + destination: __expectString, + exportFilter: _json, + format: __expectString, + graphId: __expectString, + kmsKeyIdentifier: __expectString, + parquetType: __expectString, + roleArn: __expectString, + status: __expectString, + statusReason: __expectString, + taskId: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1StartImportTaskCommand */ @@ -1406,6 +1611,7 @@ export const de_StartImportTaskCommand = async ( format: __expectString, graphId: __expectString, importOptions: (_) => _json(__expectUnion(_)), + parquetType: __expectString, roleArn: __expectString, source: __expectString, status: __expectString, @@ -1700,6 +1906,16 @@ const se_DocumentValuedMap = (input: Record, context: __ }, {}); }; +// se_ExportFilter omitted. + +// se_ExportFilterElement omitted. + +// se_ExportFilterPerLabelMap omitted. + +// se_ExportFilterPropertyAttributes omitted. + +// se_ExportFilterPropertyMap omitted. + // se_ImportOptions omitted. // se_NeptuneImportOptions omitted. @@ -1727,6 +1943,33 @@ const se_Document = (input: __DocumentType, context: __SerdeContext): any => { // de_EdgeStructures omitted. +// de_ExportFilter omitted. + +// de_ExportFilterElement omitted. + +// de_ExportFilterPerLabelMap omitted. + +// de_ExportFilterPropertyAttributes omitted. + +// de_ExportFilterPropertyMap omitted. + +/** + * deserializeAws_restJson1ExportTaskDetails + */ +const de_ExportTaskDetails = (output: any, context: __SerdeContext): ExportTaskDetails => { + return take(output, { + numEdgesWritten: __expectLong, + numVerticesWritten: __expectLong, + progressPercentage: __expectInt32, + startTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + timeElapsedSeconds: __expectLong, + }) as any; +}; + +// de_ExportTaskSummary omitted. + +// de_ExportTaskSummaryList omitted. + // de_GraphDataSummary omitted. /** diff --git a/clients/client-neptune-graph/src/waiters/index.ts b/clients/client-neptune-graph/src/waiters/index.ts index 1d305627e3ac..b4291db112e9 100644 --- a/clients/client-neptune-graph/src/waiters/index.ts +++ b/clients/client-neptune-graph/src/waiters/index.ts @@ -1,4 +1,6 @@ +export * from "./waitForExportTaskCancelled"; // smithy-typescript generated code +export * from "./waitForExportTaskSuccessful"; export * from "./waitForGraphAvailable"; export * from "./waitForGraphDeleted"; export * from "./waitForGraphSnapshotAvailable"; diff --git a/clients/client-neptune-graph/src/waiters/waitForExportTaskCancelled.ts b/clients/client-neptune-graph/src/waiters/waitForExportTaskCancelled.ts new file mode 100644 index 000000000000..63ed76e75482 --- /dev/null +++ b/clients/client-neptune-graph/src/waiters/waitForExportTaskCancelled.ts @@ -0,0 +1,56 @@ +// smithy-typescript generated code +import { checkExceptions, createWaiter, WaiterConfiguration, WaiterResult, WaiterState } from "@smithy/util-waiter"; + +import { GetExportTaskCommand, GetExportTaskCommandInput } from "../commands/GetExportTaskCommand"; +import { NeptuneGraphClient } from "../NeptuneGraphClient"; + +const checkState = async (client: NeptuneGraphClient, input: GetExportTaskCommandInput): Promise => { + let reason; + try { + const result: any = await client.send(new GetExportTaskCommand(input)); + reason = result; + try { + const returnComparator = () => { + return result.status != "CANCELLING" && result.status != "CANCELLED"; + }; + if (returnComparator() == true) { + return { state: WaiterState.FAILURE, reason }; + } + } catch (e) {} + try { + const returnComparator = () => { + return result.status; + }; + if (returnComparator() === "CANCELLED") { + return { state: WaiterState.SUCCESS, reason }; + } + } catch (e) {} + } catch (exception) { + reason = exception; + } + return { state: WaiterState.RETRY, reason }; +}; +/** + * Wait until Export Task is Cancelled + * @deprecated Use waitUntilExportTaskCancelled instead. waitForExportTaskCancelled does not throw error in non-success cases. + */ +export const waitForExportTaskCancelled = async ( + params: WaiterConfiguration, + input: GetExportTaskCommandInput +): Promise => { + const serviceDefaults = { minDelay: 60, maxDelay: 3600 }; + return createWaiter({ ...serviceDefaults, ...params }, input, checkState); +}; +/** + * Wait until Export Task is Cancelled + * @param params - Waiter configuration options. + * @param input - The input to GetExportTaskCommand for polling. + */ +export const waitUntilExportTaskCancelled = async ( + params: WaiterConfiguration, + input: GetExportTaskCommandInput +): Promise => { + const serviceDefaults = { minDelay: 60, maxDelay: 3600 }; + const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState); + return checkExceptions(result); +}; diff --git a/clients/client-neptune-graph/src/waiters/waitForExportTaskSuccessful.ts b/clients/client-neptune-graph/src/waiters/waitForExportTaskSuccessful.ts new file mode 100644 index 000000000000..6331863902b8 --- /dev/null +++ b/clients/client-neptune-graph/src/waiters/waitForExportTaskSuccessful.ts @@ -0,0 +1,72 @@ +// smithy-typescript generated code +import { checkExceptions, createWaiter, WaiterConfiguration, WaiterResult, WaiterState } from "@smithy/util-waiter"; + +import { GetExportTaskCommand, GetExportTaskCommandInput } from "../commands/GetExportTaskCommand"; +import { NeptuneGraphClient } from "../NeptuneGraphClient"; + +const checkState = async (client: NeptuneGraphClient, input: GetExportTaskCommandInput): Promise => { + let reason; + try { + const result: any = await client.send(new GetExportTaskCommand(input)); + reason = result; + try { + const returnComparator = () => { + return result.status; + }; + if (returnComparator() === "CANCELLING") { + return { state: WaiterState.FAILURE, reason }; + } + } catch (e) {} + try { + const returnComparator = () => { + return result.status; + }; + if (returnComparator() === "CANCELLED") { + return { state: WaiterState.FAILURE, reason }; + } + } catch (e) {} + try { + const returnComparator = () => { + return result.status; + }; + if (returnComparator() === "FAILED") { + return { state: WaiterState.FAILURE, reason }; + } + } catch (e) {} + try { + const returnComparator = () => { + return result.status; + }; + if (returnComparator() === "SUCCEEDED") { + return { state: WaiterState.SUCCESS, reason }; + } + } catch (e) {} + } catch (exception) { + reason = exception; + } + return { state: WaiterState.RETRY, reason }; +}; +/** + * Wait until Export Task is Successful + * @deprecated Use waitUntilExportTaskSuccessful instead. waitForExportTaskSuccessful does not throw error in non-success cases. + */ +export const waitForExportTaskSuccessful = async ( + params: WaiterConfiguration, + input: GetExportTaskCommandInput +): Promise => { + const serviceDefaults = { minDelay: 60, maxDelay: 28800 }; + return createWaiter({ ...serviceDefaults, ...params }, input, checkState); +}; +/** + * Wait until Export Task is Successful + * @param params - Waiter configuration options. + * @param input - The input to GetExportTaskCommand for polling. + */ +export const waitUntilExportTaskSuccessful = async ( + params: WaiterConfiguration, + input: GetExportTaskCommandInput +): Promise => { + const serviceDefaults = { minDelay: 60, maxDelay: 28800 }; + const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState); + return checkExceptions(result); +}; diff --git a/codegen/sdk-codegen/aws-models/neptune-graph.json b/codegen/sdk-codegen/aws-models/neptune-graph.json index 9625f8ea1355..a2f62ca6dee1 100644 --- a/codegen/sdk-codegen/aws-models/neptune-graph.json +++ b/codegen/sdk-codegen/aws-models/neptune-graph.json @@ -1545,6 +1545,135 @@ } } }, + "com.amazonaws.neptunegraph#CancelExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunegraph#CancelExportTaskInput" + }, + "output": { + "target": "com.amazonaws.neptunegraph#CancelExportTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunegraph#ConflictException" + }, + { + "target": "com.amazonaws.neptunegraph#InternalServerException" + }, + { + "target": "com.amazonaws.neptunegraph#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunegraph#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunegraph#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Cancel the specified export task.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/exporttasks/{taskIdentifier}" + }, + "smithy.rules#staticContextParams": { + "ApiType": { + "value": "ControlPlane" + } + } + } + }, + "com.amazonaws.neptunegraph#CancelExportTaskInput": { + "type": "structure", + "members": { + "taskIdentifier": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#CancelExportTaskOutput": { + "type": "structure", + "members": { + "graphId": { + "target": "com.amazonaws.neptunegraph#GraphId", + "traits": { + "smithy.api#documentation": "

The source graph identifier of the cancelled export task.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.neptunegraph#RoleArn", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "taskId": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.neptunegraph#ExportTaskStatus", + "traits": { + "smithy.api#documentation": "

The current status of the export task. The status is CANCELLING when the \n export task is cancelled.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.neptunegraph#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the cancelled export task.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key identifier of the cancelled export task.

", + "smithy.api#required": {} + } + }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the cancelled export task.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason that the export task has this status value.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.neptunegraph#CancelImportTask": { "type": "operation", "input": { @@ -1630,6 +1759,12 @@ "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the cancelled import task.

" + } + }, "roleArn": { "target": "com.amazonaws.neptunegraph#RoleArn", "traits": { @@ -2198,6 +2333,12 @@ "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format, OPEN_CYPHER, which identifies the openCypher\n load format, or ntriples, which identifies the\n RDF n-triples format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" + } + }, "blankNodeHandling": { "target": "com.amazonaws.neptunegraph#BlankNodeHandling", "traits": { @@ -2245,6 +2386,12 @@ "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format, OPENCYPHER, which identifies the openCypher\n load format, or ntriples, which identifies the\n RDF n-triples format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" + } + }, "roleArn": { "target": "com.amazonaws.neptunegraph#RoleArn", "traits": { @@ -2767,195 +2914,719 @@ "target": "smithy.api#String" } }, - "com.amazonaws.neptunegraph#EdgeProperties": { + "com.amazonaws.neptunegraph#EdgeProperties": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunegraph#EdgeStructure": { + "type": "structure", + "members": { + "count": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of instances of the edge in the graph.

" + } + }, + "edgeProperties": { + "target": "com.amazonaws.neptunegraph#EdgeProperties", + "traits": { + "smithy.api#documentation": "

A list of the properties associated with the edge.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an edge in a Neptune Analytics graph.

" + } + }, + "com.amazonaws.neptunegraph#EdgeStructures": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunegraph#EdgeStructure" + } + }, + "com.amazonaws.neptunegraph#ExecuteQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunegraph#ExecuteQueryInput" + }, + "output": { + "target": "com.amazonaws.neptunegraph#ExecuteQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunegraph#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunegraph#ConflictException" + }, + { + "target": "com.amazonaws.neptunegraph#InternalServerException" + }, + { + "target": "com.amazonaws.neptunegraph#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunegraph#UnprocessableException" + }, + { + "target": "com.amazonaws.neptunegraph#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "

Execute an openCypher query.

\n

\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached \n that allows one of the following IAM actions in that cluster, depending on the query:\n

\n
    \n
  • \n

    neptune-graph:ReadDataViaQuery

    \n
  • \n
  • \n

    neptune-graph:WriteDataViaQuery

    \n
  • \n
  • \n

    neptune-graph:DeleteDataViaQuery

    \n
  • \n
", + "smithy.api#endpoint": { + "hostPrefix": "{graphIdentifier}." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/queries", + "code": 200 + }, + "smithy.rules#staticContextParams": { + "ApiType": { + "value": "DataPlane" + } + } + } + }, + "com.amazonaws.neptunegraph#ExecuteQueryInput": { + "type": "structure", + "members": { + "graphIdentifier": { + "target": "com.amazonaws.neptunegraph#GraphIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Neptune Analytics graph.

", + "smithy.api#hostLabel": {}, + "smithy.api#httpHeader": "graphIdentifier", + "smithy.api#required": {} + } + }, + "queryString": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The query string to be executed.

", + "smithy.api#jsonName": "query", + "smithy.api#required": {} + } + }, + "language": { + "target": "com.amazonaws.neptunegraph#QueryLanguage", + "traits": { + "smithy.api#documentation": "

The query language the query is written in. Currently only openCypher is supported.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.neptunegraph#DocumentValuedMap", + "traits": { + "smithy.api#documentation": "

The data parameters the query can use in JSON format. For example: {\"name\": \"john\", \"age\": 20}. (optional)

" + } + }, + "planCache": { + "target": "com.amazonaws.neptunegraph#PlanCacheType", + "traits": { + "smithy.api#documentation": "

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. \n This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an \n LRU cache with a 5 minute TTL and a capacity of 1000.

" + } + }, + "explainMode": { + "target": "com.amazonaws.neptunegraph#ExplainMode", + "traits": { + "smithy.api#documentation": "

The explain mode parameter returns a query explain instead of the actual query results. A query explain can \n be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions \n flowing etc.

", + "smithy.api#jsonName": "explain" + } + }, + "queryTimeoutMilliseconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Specifies the query timeout duration, in milliseconds. (optional)

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#ExecuteQueryOutput": { + "type": "structure", + "members": { + "payload": { + "target": "com.amazonaws.neptunegraph#QueryResponseBlob", + "traits": { + "smithy.api#documentation": "

The query results.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunegraph#ExplainMode": { + "type": "enum", + "members": { + "STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATIC" + } + }, + "DETAILS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETAILS" + } + } + } + }, + "com.amazonaws.neptunegraph#ExportFilter": { + "type": "structure", + "members": { + "vertexFilter": { + "target": "com.amazonaws.neptunegraph#ExportFilterPerLabelMap", + "traits": { + "smithy.api#documentation": "

Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels \n and properties are included in the export.

" + } + }, + "edgeFilter": { + "target": "com.amazonaws.neptunegraph#ExportFilterPerLabelMap", + "traits": { + "smithy.api#documentation": "

Used to specify filters on a per-label basis for edges. This allows you to control which edge labels \n and properties are included in the export.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This is the top-level field for specifying vertex or edge filters. If the ExportFilter is not provided, \n then all properties for all labels will be exported. If the ExportFilter is provided but is an empty object, \n then no data will be exported.

" + } + }, + "com.amazonaws.neptunegraph#ExportFilterElement": { + "type": "structure", + "members": { + "properties": { + "target": "com.amazonaws.neptunegraph#ExportFilterPropertyMap", + "traits": { + "smithy.api#documentation": "

Each property is defined by a key-value pair, where the key is the desired output property name (e.g. \"name\"), \n and the value is an object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whihc properties of that label should be included in the export.

" + } + }, + "com.amazonaws.neptunegraph#ExportFilterLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.neptunegraph#ExportFilterOutputDataType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(Any|Byte|Short|Int|Long|Float|Double|String|Bool|Boolean|Float\\[\\]|Double\\[\\])$" + } + }, + "com.amazonaws.neptunegraph#ExportFilterOutputPropertyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_]+$" + } + }, + "com.amazonaws.neptunegraph#ExportFilterPerLabelMap": { + "type": "map", + "key": { + "target": "com.amazonaws.neptunegraph#ExportFilterLabel" + }, + "value": { + "target": "com.amazonaws.neptunegraph#ExportFilterElement" + } + }, + "com.amazonaws.neptunegraph#ExportFilterPropertyAttributes": { + "type": "structure", + "members": { + "outputType": { + "target": "com.amazonaws.neptunegraph#ExportFilterOutputDataType", + "traits": { + "smithy.api#documentation": "

Specifies the data type to use for the property in the exported data (e.g. \"String\", \"Int\", \"Float\"). \n If a type is not provided, the export process will determine the type. If a given property is present as multiple \n types (e.g. one vertex has \"height\" stored as a double, and another edge has it stored as a string), the type \n will be of Any type, otherwise, it will be the type of the property as present in vertices.

" + } + }, + "sourcePropertyName": { + "target": "com.amazonaws.neptunegraph#ExportFilterSourcePropertyName", + "traits": { + "smithy.api#documentation": "

The name of the property as it exists in the original graph data. If not provided, it is assumed that the key \n matches the desired sourcePropertyName.

" + } + }, + "multiValueHandling": { + "target": "com.amazonaws.neptunegraph#MultiValueHandlingType", + "traits": { + "smithy.api#default": "PICK_FIRST", + "smithy.api#documentation": "

Specifies how to handle properties that have multiple values. Can be either TO_LIST to export all \n values as a list, or PICK_FIRST to export the first value encountered. If not specified, the default \n value is PICK_FIRST.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName \n and multiValueHandling.

" + } + }, + "com.amazonaws.neptunegraph#ExportFilterPropertyMap": { + "type": "map", + "key": { + "target": "com.amazonaws.neptunegraph#ExportFilterOutputPropertyName" + }, + "value": { + "target": "com.amazonaws.neptunegraph#ExportFilterPropertyAttributes" + } + }, + "com.amazonaws.neptunegraph#ExportFilterSourcePropertyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.neptunegraph#ExportFormat": { + "type": "enum", + "members": { + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + } + }, + "com.amazonaws.neptunegraph#ExportTaskDetails": { + "type": "structure", + "members": { + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the export task.

", + "smithy.api#required": {} + } + }, + "timeElapsedSeconds": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The time elapsed, in seconds, since the start time of the export task.

", + "smithy.api#required": {} + } + }, + "progressPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of progress percentage of the export task.

", + "smithy.api#required": {} + } + }, + "numVerticesWritten": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of exported vertices.

" + } + }, + "numEdgesWritten": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of exported edges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the specified export task.

" + } + }, + "com.amazonaws.neptunegraph#ExportTaskId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^t-[a-z0-9]{10}$" + } + }, + "com.amazonaws.neptunegraph#ExportTaskStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + }, + "EXPORTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPORTING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.neptunegraph#ExportTaskSummary": { + "type": "structure", + "members": { + "graphId": { + "target": "com.amazonaws.neptunegraph#GraphId", + "traits": { + "smithy.api#documentation": "

The source graph identifier of the export task.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.neptunegraph#RoleArn", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "taskId": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.neptunegraph#ExportTaskStatus", + "traits": { + "smithy.api#documentation": "

The current status of the export task.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.neptunegraph#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the export task.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key identifier of the export task.

", + "smithy.api#required": {} + } + }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the export task.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason that the export task has this status value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an export task.

" + } + }, + "com.amazonaws.neptunegraph#ExportTaskSummaryList": { "type": "list", "member": { - "target": "smithy.api#String" + "target": "com.amazonaws.neptunegraph#ExportTaskSummary" } }, - "com.amazonaws.neptunegraph#EdgeStructure": { - "type": "structure", + "com.amazonaws.neptunegraph#Format": { + "type": "enum", "members": { - "count": { - "target": "smithy.api#Long", + "CSV": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The number of instances of the edge in the graph.

" + "smithy.api#enumValue": "CSV" } }, - "edgeProperties": { - "target": "com.amazonaws.neptunegraph#EdgeProperties", + "OPEN_CYPHER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A list of the properties associated with the edge.

" + "smithy.api#enumValue": "OPEN_CYPHER" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "NTRIPLES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NTRIPLES" } } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an edge in a Neptune Analytics graph.

" - } - }, - "com.amazonaws.neptunegraph#EdgeStructures": { - "type": "list", - "member": { - "target": "com.amazonaws.neptunegraph#EdgeStructure" } }, - "com.amazonaws.neptunegraph#ExecuteQuery": { + "com.amazonaws.neptunegraph#GetExportTask": { "type": "operation", "input": { - "target": "com.amazonaws.neptunegraph#ExecuteQueryInput" + "target": "com.amazonaws.neptunegraph#GetExportTaskInput" }, "output": { - "target": "com.amazonaws.neptunegraph#ExecuteQueryOutput" + "target": "com.amazonaws.neptunegraph#GetExportTaskOutput" }, "errors": [ - { - "target": "com.amazonaws.neptunegraph#AccessDeniedException" - }, - { - "target": "com.amazonaws.neptunegraph#ConflictException" - }, { "target": "com.amazonaws.neptunegraph#InternalServerException" }, { - "target": "com.amazonaws.neptunegraph#ThrottlingException" + "target": "com.amazonaws.neptunegraph#ResourceNotFoundException" }, { - "target": "com.amazonaws.neptunegraph#UnprocessableException" + "target": "com.amazonaws.neptunegraph#ThrottlingException" }, { "target": "com.amazonaws.neptunegraph#ValidationException" } ], "traits": { - "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Execute an openCypher query.

\n

\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached \n that allows one of the following IAM actions in that cluster, depending on the query:\n

\n
    \n
  • \n

    neptune-graph:ReadDataViaQuery

    \n
  • \n
  • \n

    neptune-graph:WriteDataViaQuery

    \n
  • \n
  • \n

    neptune-graph:DeleteDataViaQuery

    \n
  • \n
", - "smithy.api#endpoint": { - "hostPrefix": "{graphIdentifier}." - }, + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Retrieves a specified export task.

", "smithy.api#http": { - "method": "POST", - "uri": "/queries", - "code": 200 + "code": 200, + "method": "GET", + "uri": "/exporttasks/{taskIdentifier}" }, + "smithy.api#readonly": {}, "smithy.rules#staticContextParams": { "ApiType": { - "value": "DataPlane" + "value": "ControlPlane" + } + }, + "smithy.waiters#waitable": { + "ExportTaskSuccessful": { + "documentation": "Wait until Export Task is Successful", + "minDelay": 60, + "maxDelay": 28800, + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "CANCELLING", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "CANCELLED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "SUCCEEDED", + "comparator": "stringEquals" + } + } + } + ] + }, + "ExportTaskCancelled": { + "documentation": "Wait until Export Task is Cancelled", + "minDelay": 60, + "maxDelay": 3600, + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "status != 'CANCELLING' && status != 'CANCELLED'", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "CANCELLED", + "comparator": "stringEquals" + } + } + } + ] } } } }, - "com.amazonaws.neptunegraph#ExecuteQueryInput": { + "com.amazonaws.neptunegraph#GetExportTaskInput": { "type": "structure", "members": { - "graphIdentifier": { - "target": "com.amazonaws.neptunegraph#GraphIdentifier", + "taskIdentifier": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Neptune Analytics graph.

", - "smithy.api#hostLabel": {}, - "smithy.api#httpHeader": "graphIdentifier", + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "queryString": { - "target": "smithy.api#String", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#GetExportTaskOutput": { + "type": "structure", + "members": { + "graphId": { + "target": "com.amazonaws.neptunegraph#GraphId", "traits": { - "smithy.api#documentation": "

The query string to be executed.

", - "smithy.api#jsonName": "query", + "smithy.api#documentation": "

The source graph identifier of the export task.

", "smithy.api#required": {} } }, - "language": { - "target": "com.amazonaws.neptunegraph#QueryLanguage", + "roleArn": { + "target": "com.amazonaws.neptunegraph#RoleArn", "traits": { - "smithy.api#documentation": "

The query language the query is written in. Currently only openCypher is supported.

", + "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, - "parameters": { - "target": "com.amazonaws.neptunegraph#DocumentValuedMap", + "taskId": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", "traits": { - "smithy.api#documentation": "

The data parameters the query can use in JSON format. For example: {\"name\": \"john\", \"age\": 20}. (optional)

" + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#required": {} } }, - "planCache": { - "target": "com.amazonaws.neptunegraph#PlanCacheType", + "status": { + "target": "com.amazonaws.neptunegraph#ExportTaskStatus", "traits": { - "smithy.api#documentation": "

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. \n This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an \n LRU cache with a 5 minute TTL and a capacity of 1000.

" + "smithy.api#documentation": "

The current status of the export task.

", + "smithy.api#required": {} } }, - "explainMode": { - "target": "com.amazonaws.neptunegraph#ExplainMode", + "format": { + "target": "com.amazonaws.neptunegraph#ExportFormat", "traits": { - "smithy.api#documentation": "

The explain mode parameter returns a query explain instead of the actual query results. A query explain can \n be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions \n flowing etc.

", - "smithy.api#jsonName": "explain" + "smithy.api#documentation": "

The format of the export task.

", + "smithy.api#required": {} } }, - "queryTimeoutMilliseconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the query timeout duration, in milliseconds. (optional)

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.neptunegraph#ExecuteQueryOutput": { - "type": "structure", - "members": { - "payload": { - "target": "com.amazonaws.neptunegraph#QueryResponseBlob", + "destination": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The query results.

", - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "

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

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.neptunegraph#ExplainMode": { - "type": "enum", - "members": { - "STATIC": { - "target": "smithy.api#Unit", + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", "traits": { - "smithy.api#enumValue": "STATIC" + "smithy.api#documentation": "

The KMS key identifier of the export task.

", + "smithy.api#required": {} } }, - "DETAILS": { - "target": "smithy.api#Unit", + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", "traits": { - "smithy.api#enumValue": "DETAILS" + "smithy.api#documentation": "

The parquet type of the export task.

" } - } - } - }, - "com.amazonaws.neptunegraph#Format": { - "type": "enum", - "members": { - "CSV": { - "target": "smithy.api#Unit", + }, + "statusReason": { + "target": "smithy.api#String", "traits": { - "smithy.api#enumValue": "CSV" + "smithy.api#documentation": "

The reason that the export task has this status value.

" } }, - "OPEN_CYPHER": { - "target": "smithy.api#Unit", + "exportTaskDetails": { + "target": "com.amazonaws.neptunegraph#ExportTaskDetails", "traits": { - "smithy.api#enumValue": "OPEN_CYPHER" + "smithy.api#documentation": "

The details of the export task.

" } }, - "NTRIPLES": { - "target": "smithy.api#Unit", + "exportFilter": { + "target": "com.amazonaws.neptunegraph#ExportFilter", "traits": { - "smithy.api#enumValue": "NTRIPLES" + "smithy.api#documentation": "

The export filter of the export task.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.neptunegraph#GetGraph": { @@ -3605,6 +4276,12 @@ "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" + } + }, "roleArn": { "target": "com.amazonaws.neptunegraph#RoleArn", "traits": { @@ -3634,7 +4311,7 @@ "attemptNumber": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of the current attempt to execute the import task.

" + "smithy.api#documentation": "

The number of the current attempts to execute the import task.

" } }, "statusReason": { @@ -4399,6 +5076,12 @@ "traits": { "smithy.api#enumValue": "CANCELLED" } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } } } }, @@ -4428,7 +5111,13 @@ "format": { "target": "com.amazonaws.neptunegraph#Format", "traits": { - "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" + "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" + } + }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" } }, "roleArn": { @@ -4484,6 +5173,93 @@ "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" } }, + "com.amazonaws.neptunegraph#ListExportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunegraph#ListExportTasksInput" + }, + "output": { + "target": "com.amazonaws.neptunegraph#ListExportTasksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunegraph#InternalServerException" + }, + { + "target": "com.amazonaws.neptunegraph#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunegraph#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunegraph#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Retrieves a list of export tasks.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/exporttasks" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "tasks" + }, + "smithy.api#readonly": {}, + "smithy.rules#staticContextParams": { + "ApiType": { + "value": "ControlPlane" + } + } + } + }, + "com.amazonaws.neptunegraph#ListExportTasksInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.neptunegraph#PaginationToken", + "traits": { + "smithy.api#documentation": "

Pagination token used to paginate input.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.neptunegraph#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of export tasks to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#ListExportTasksOutput": { + "type": "structure", + "members": { + "tasks": { + "target": "com.amazonaws.neptunegraph#ExportTaskSummaryList", + "traits": { + "smithy.api#documentation": "

The requested list of export tasks.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.neptunegraph#PaginationToken", + "traits": { + "smithy.api#documentation": "

Pagination token used to paginate output.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.neptunegraph#ListGraphSnapshots": { "type": "operation", "input": { @@ -5023,6 +5799,23 @@ } } }, + "com.amazonaws.neptunegraph#MultiValueHandlingType": { + "type": "enum", + "members": { + "TO_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO_LIST" + } + }, + "PICK_FIRST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PICK_FIRST" + } + } + } + }, "com.amazonaws.neptunegraph#NeptuneImportOptions": { "type": "structure", "members": { @@ -5124,6 +5917,17 @@ } } }, + "com.amazonaws.neptunegraph#ParquetType": { + "type": "enum", + "members": { + "COLUMNAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMNAR" + } + } + } + }, "com.amazonaws.neptunegraph#PlanCacheType": { "type": "enum", "members": { @@ -5870,6 +6674,190 @@ } } }, + "com.amazonaws.neptunegraph#StartExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunegraph#StartExportTaskInput" + }, + "output": { + "target": "com.amazonaws.neptunegraph#StartExportTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunegraph#ConflictException" + }, + { + "target": "com.amazonaws.neptunegraph#InternalServerException" + }, + { + "target": "com.amazonaws.neptunegraph#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunegraph#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunegraph#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/exporttasks" + }, + "smithy.rules#staticContextParams": { + "ApiType": { + "value": "ControlPlane" + } + } + } + }, + "com.amazonaws.neptunegraph#StartExportTaskInput": { + "type": "structure", + "members": { + "graphIdentifier": { + "target": "com.amazonaws.neptunegraph#GraphIdentifier", + "traits": { + "smithy.api#documentation": "

The source graph identifier of the export task.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.neptunegraph#RoleArn", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.neptunegraph#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the export task.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI where data will be exported to.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key identifier of the export task.

", + "smithy.api#required": {} + } + }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the export task.

" + } + }, + "exportFilter": { + "target": "com.amazonaws.neptunegraph#ExportFilter", + "traits": { + "smithy.api#documentation": "

The export filter of the export task.

" + } + }, + "tags": { + "target": "com.amazonaws.neptunegraph#TagMap", + "traits": { + "smithy.api#documentation": "

Tags to be applied to the export task.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#StartExportTaskOutput": { + "type": "structure", + "members": { + "graphId": { + "target": "com.amazonaws.neptunegraph#GraphId", + "traits": { + "smithy.api#documentation": "

The source graph identifier of the export task.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.neptunegraph#RoleArn", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "taskId": { + "target": "com.amazonaws.neptunegraph#ExportTaskId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the export task.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.neptunegraph#ExportTaskStatus", + "traits": { + "smithy.api#documentation": "

The current status of the export task.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.neptunegraph#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the export task.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#required": {} + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key identifier of the export task.

", + "smithy.api#required": {} + } + }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the export task.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason that the export task has this status value.

" + } + }, + "exportFilter": { + "target": "com.amazonaws.neptunegraph#ExportFilter", + "traits": { + "smithy.api#documentation": "

The export filter of the export task.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.neptunegraph#StartImportTask": { "type": "operation", "input": { @@ -5935,6 +6923,12 @@ "smithy.api#documentation": "

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or \n OPENCYPHER, which identies the openCypher load format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" + } + }, "blankNodeHandling": { "target": "com.amazonaws.neptunegraph#BlankNodeHandling", "traits": { @@ -5990,6 +6984,12 @@ "smithy.api#documentation": "

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or \n OPENCYPHER, which identies the openCypher load format.

" } }, + "parquetType": { + "target": "com.amazonaws.neptunegraph#ParquetType", + "traits": { + "smithy.api#documentation": "

The parquet type of the import task.

" + } + }, "roleArn": { "target": "com.amazonaws.neptunegraph#RoleArn", "traits": { @@ -6153,18 +7153,30 @@ "com.amazonaws.neptunegraph#TaskResource": { "type": "resource", "operations": [ + { + "target": "com.amazonaws.neptunegraph#CancelExportTask" + }, { "target": "com.amazonaws.neptunegraph#CancelImportTask" }, { "target": "com.amazonaws.neptunegraph#CreateGraphUsingImportTask" }, + { + "target": "com.amazonaws.neptunegraph#GetExportTask" + }, { "target": "com.amazonaws.neptunegraph#GetImportTask" }, + { + "target": "com.amazonaws.neptunegraph#ListExportTasks" + }, { "target": "com.amazonaws.neptunegraph#ListImportTasks" }, + { + "target": "com.amazonaws.neptunegraph#StartExportTask" + }, { "target": "com.amazonaws.neptunegraph#StartImportTask" }