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

package/dist-types/models/models_0.d.ts

@@ -1921,6 +1921,107 @@ export interface TagResourceInput {
  */
 export interface TagResourceOutput {
 }
+/**
+ * @public
+ */
+export interface CancelExportTaskInput {
+    /**
+     * <p>The unique identifier of the export task.</p>
+     * @public
+     */
+    taskIdentifier: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ExportFormat: {
+    readonly CSV: "CSV";
+    readonly PARQUET: "PARQUET";
+};
+/**
+ * @public
+ */
+export type ExportFormat = (typeof ExportFormat)[keyof typeof ExportFormat];
+/**
+ * @public
+ * @enum
+ */
+export declare const ParquetType: {
+    readonly COLUMNAR: "COLUMNAR";
+};
+/**
+ * @public
+ */
+export type ParquetType = (typeof ParquetType)[keyof typeof ParquetType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ExportTaskStatus: {
+    readonly CANCELLED: "CANCELLED";
+    readonly CANCELLING: "CANCELLING";
+    readonly DELETED: "DELETED";
+    readonly EXPORTING: "EXPORTING";
+    readonly FAILED: "FAILED";
+    readonly INITIALIZING: "INITIALIZING";
+    readonly SUCCEEDED: "SUCCEEDED";
+};
+/**
+ * @public
+ */
+export type ExportTaskStatus = (typeof ExportTaskStatus)[keyof typeof ExportTaskStatus];
+/**
+ * @public
+ */
+export interface CancelExportTaskOutput {
+    /**
+     * <p>The source graph identifier of the cancelled export task.</p>
+     * @public
+     */
+    graphId: string | undefined;
+    /**
+     * <p>The ARN of the IAM role that will allow the exporting of data to the destination.</p>
+     * @public
+     */
+    roleArn: string | undefined;
+    /**
+     * <p>The unique identifier of the export task.</p>
+     * @public
+     */
+    taskId: string | undefined;
+    /**
+     * <p>The current status of the export task. The status is <code>CANCELLING</code> when the
+     *       export task is cancelled.</p>
+     * @public
+     */
+    status: ExportTaskStatus | undefined;
+    /**
+     * <p>The format of the cancelled export task.</p>
+     * @public
+     */
+    format: ExportFormat | undefined;
+    /**
+     * <p>The Amazon S3 URI of the cancelled export task where data will be exported to.</p>
+     * @public
+     */
+    destination: string | undefined;
+    /**
+     * <p>The KMS key identifier of the cancelled export task.</p>
+     * @public
+     */
+    kmsKeyIdentifier: string | undefined;
+    /**
+     * <p>The parquet type of the cancelled export task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
+    /**
+     * <p>The reason that the export task has this status value.</p>
+     * @public
+     */
+    statusReason?: string | undefined;
+}
 /**
  * @public
  */
@@ -1939,6 +2040,7 @@ export declare const Format: {
     readonly CSV: "CSV";
     readonly NTRIPLES: "NTRIPLES";
     readonly OPEN_CYPHER: "OPEN_CYPHER";
+    readonly PARQUET: "PARQUET";
 };
 /**
  * @public
@@ -1952,6 +2054,7 @@ export declare const ImportTaskStatus: {
     readonly ANALYZING_DATA: "ANALYZING_DATA";
     readonly CANCELLED: "CANCELLED";
     readonly CANCELLING: "CANCELLING";
+    readonly DELETED: "DELETED";
     readonly EXPORTING: "EXPORTING";
     readonly FAILED: "FAILED";
     readonly IMPORTING: "IMPORTING";
@@ -1992,6 +2095,11 @@ export interface CancelImportTaskOutput {
      * @public
      */
     format?: Format | undefined;
+    /**
+     * <p>The parquet type of the cancelled import task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
     /**
      * <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
      * @public
@@ -2171,6 +2279,11 @@ export interface CreateGraphUsingImportTaskInput {
      * @public
      */
     format?: Format | undefined;
+    /**
+     * <p>The parquet type of the import task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
     /**
      * <p>The method to handle blank nodes in the dataset. Currently, only <code>convertToIri</code> is supported,
      *       meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is <code>ntriples</code>.
@@ -2213,6 +2326,11 @@ export interface CreateGraphUsingImportTaskOutput {
      * @public
      */
     format?: Format | undefined;
+    /**
+     * <p>The parquet type of the import task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
     /**
      * <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
      * @public
@@ -2232,6 +2350,179 @@ export interface CreateGraphUsingImportTaskOutput {
      */
     importOptions?: ImportOptions | undefined;
 }
+/**
+ * @public
+ */
+export interface GetExportTaskInput {
+    /**
+     * <p>The unique identifier of the export task.</p>
+     * @public
+     */
+    taskIdentifier: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const MultiValueHandlingType: {
+    readonly PICK_FIRST: "PICK_FIRST";
+    readonly TO_LIST: "TO_LIST";
+};
+/**
+ * @public
+ */
+export type MultiValueHandlingType = (typeof MultiValueHandlingType)[keyof typeof MultiValueHandlingType];
+/**
+ * <p>A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName
+ *        and multiValueHandling.</p>
+ * @public
+ */
+export interface ExportFilterPropertyAttributes {
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    outputType?: string | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    sourcePropertyName?: string | undefined;
+    /**
+     * <p>Specifies how to handle properties that have multiple values. Can be either <code>TO_LIST</code> to export all
+     *       values as a list, or <code>PICK_FIRST</code> to export the first value encountered. If not specified, the default
+     *       value is <code>PICK_FIRST</code>.</p>
+     * @public
+     */
+    multiValueHandling?: MultiValueHandlingType | undefined;
+}
+/**
+ * <p>Specifies whihc properties of that label should be included in the export.</p>
+ * @public
+ */
+export interface ExportFilterElement {
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    properties?: Record<string, ExportFilterPropertyAttributes> | undefined;
+}
+/**
+ * <p>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.</p>
+ * @public
+ */
+export interface ExportFilter {
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    vertexFilter?: Record<string, ExportFilterElement> | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    edgeFilter?: Record<string, ExportFilterElement> | undefined;
+}
+/**
+ * <p>Contains details about the specified export task.</p>
+ * @public
+ */
+export interface ExportTaskDetails {
+    /**
+     * <p>The start time of the export task.</p>
+     * @public
+     */
+    startTime: Date | undefined;
+    /**
+     * <p>The time elapsed, in seconds, since the start time of the export task.</p>
+     * @public
+     */
+    timeElapsedSeconds: number | undefined;
+    /**
+     * <p>The number of progress percentage of the export task.</p>
+     * @public
+     */
+    progressPercentage: number | undefined;
+    /**
+     * <p>The number of exported vertices.</p>
+     * @public
+     */
+    numVerticesWritten?: number | undefined;
+    /**
+     * <p>The number of exported edges.</p>
+     * @public
+     */
+    numEdgesWritten?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface GetExportTaskOutput {
+    /**
+     * <p>The source graph identifier of the export task.</p>
+     * @public
+     */
+    graphId: string | undefined;
+    /**
+     * <p>The ARN of the IAM role that will allow data to be exported to the destination.</p>
+     * @public
+     */
+    roleArn: string | undefined;
+    /**
+     * <p>The unique identifier of the export task.</p>
+     * @public
+     */
+    taskId: string | undefined;
+    /**
+     * <p>The current status of the export task.</p>
+     * @public
+     */
+    status: ExportTaskStatus | undefined;
+    /**
+     * <p>The format of the export task.</p>
+     * @public
+     */
+    format: ExportFormat | undefined;
+    /**
+     * <p>The Amazon S3 URI of the export task where data will be exported.</p>
+     * @public
+     */
+    destination: string | undefined;
+    /**
+     * <p>The KMS key identifier of the export task.</p>
+     * @public
+     */
+    kmsKeyIdentifier: string | undefined;
+    /**
+     * <p>The parquet type of the export task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
+    /**
+     * <p>The reason that the export task has this status value.</p>
+     * @public
+     */
+    statusReason?: string | undefined;
+    /**
+     * <p>The details of the export task.</p>
+     * @public
+     */
+    exportTaskDetails?: ExportTaskDetails | undefined;
+    /**
+     * <p>The export filter of the export task.</p>
+     * @public
+     */
+    exportFilter?: ExportFilter | undefined;
+}
 /**
  * @public
  */
@@ -2316,6 +2607,11 @@ export interface GetImportTaskOutput {
      * @public
      */
     format?: Format | undefined;
+    /**
+     * <p>The parquet type of the import task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
     /**
      * <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
      * @public
@@ -2397,7 +2693,7 @@ export interface GetImportTaskOutput {
      */
     importTaskDetails?: ImportTaskDetails | undefined;
     /**
-     * <p>The number of the current attempt to execute the import task.</p>
+     * <p>The number of the current attempts to execute the import task.</p>
      * @public
      */
     attemptNumber?: number | undefined;
@@ -2407,6 +2703,87 @@ export interface GetImportTaskOutput {
      */
     statusReason?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface ListExportTasksInput {
+    /**
+     * <p>Pagination token used to paginate input.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+    /**
+     * <p>The maximum number of export tasks to return.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+}
+/**
+ * <p>Provides details about an export task.</p>
+ * @public
+ */
+export interface ExportTaskSummary {
+    /**
+     * <p>The source graph identifier of the export task.</p>
+     * @public
+     */
+    graphId: string | undefined;
+    /**
+     * <p>The ARN of the IAM role that will allow the data to be exported to the destination.</p>
+     * @public
+     */
+    roleArn: string | undefined;
+    /**
+     * <p>The unique identifier of the export task.</p>
+     * @public
+     */
+    taskId: string | undefined;
+    /**
+     * <p>The current status of the export task.</p>
+     * @public
+     */
+    status: ExportTaskStatus | undefined;
+    /**
+     * <p>The format of the export task.</p>
+     * @public
+     */
+    format: ExportFormat | undefined;
+    /**
+     * <p>The Amazon S3 URI of the export task where data will be exported to.</p>
+     * @public
+     */
+    destination: string | undefined;
+    /**
+     * <p>The KMS key identifier of the export task.</p>
+     * @public
+     */
+    kmsKeyIdentifier: string | undefined;
+    /**
+     * <p>The parquet type of the export task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
+    /**
+     * <p>The reason that the export task has this status value.</p>
+     * @public
+     */
+    statusReason?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListExportTasksOutput {
+    /**
+     * <p>The requested list of export tasks.</p>
+     * @public
+     */
+    tasks: ExportTaskSummary[] | undefined;
+    /**
+     * <p>Pagination token used to paginate output.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
 /**
  * @public
  */
@@ -2459,6 +2836,11 @@ export interface ImportTaskSummary {
      * @public
      */
     format?: Format | undefined;
+    /**
+     * <p>The parquet type of the import task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
     /**
      * <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
      * @public
@@ -2488,6 +2870,106 @@ export interface ListImportTasksOutput {
      */
     nextToken?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface StartExportTaskInput {
+    /**
+     * <p>The source graph identifier of the export task.</p>
+     * @public
+     */
+    graphIdentifier: string | undefined;
+    /**
+     * <p>The ARN of the IAM role that will allow data to be exported to the destination.</p>
+     * @public
+     */
+    roleArn: string | undefined;
+    /**
+     * <p>The format of the export task.</p>
+     * @public
+     */
+    format: ExportFormat | undefined;
+    /**
+     * <p>The Amazon S3 URI where data will be exported to.</p>
+     * @public
+     */
+    destination: string | undefined;
+    /**
+     * <p>The KMS key identifier of the export task.</p>
+     * @public
+     */
+    kmsKeyIdentifier: string | undefined;
+    /**
+     * <p>The parquet type of the export task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
+    /**
+     * <p>The export filter of the export task.</p>
+     * @public
+     */
+    exportFilter?: ExportFilter | undefined;
+    /**
+     * <p>Tags to be applied to the export task.</p>
+     * @public
+     */
+    tags?: Record<string, string> | undefined;
+}
+/**
+ * @public
+ */
+export interface StartExportTaskOutput {
+    /**
+     * <p>The source graph identifier of the export task.</p>
+     * @public
+     */
+    graphId: string | undefined;
+    /**
+     * <p>The ARN of the IAM role that will allow data to be exported to the destination.</p>
+     * @public
+     */
+    roleArn: string | undefined;
+    /**
+     * <p>The unique identifier of the export task.</p>
+     * @public
+     */
+    taskId: string | undefined;
+    /**
+     * <p>The current status of the export task.</p>
+     * @public
+     */
+    status: ExportTaskStatus | undefined;
+    /**
+     * <p>The format of the export task.</p>
+     * @public
+     */
+    format: ExportFormat | undefined;
+    /**
+     * <p>The Amazon S3 URI of the export task where data will be exported to.</p>
+     * @public
+     */
+    destination: string | undefined;
+    /**
+     * <p>The KMS key identifier of the export task.</p>
+     * @public
+     */
+    kmsKeyIdentifier: string | undefined;
+    /**
+     * <p>The parquet type of the export task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
+    /**
+     * <p>The reason that the export task has this status value.</p>
+     * @public
+     */
+    statusReason?: string | undefined;
+    /**
+     * <p>The export filter of the export task.</p>
+     * @public
+     */
+    exportFilter?: ExportFilter | undefined;
+}
 /**
  * @public
  */
@@ -2515,6 +2997,11 @@ export interface StartImportTaskInput {
      * @public
      */
     format?: Format | undefined;
+    /**
+     * <p>The parquet type of the import task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
     /**
      * <p>The method to handle blank nodes in the dataset. Currently, only <code>convertToIri</code> is supported,
      *       meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is <code>ntriples</code>.
@@ -2559,6 +3046,11 @@ export interface StartImportTaskOutput {
      * @public
      */
     format?: Format | undefined;
+    /**
+     * <p>The parquet type of the import task.</p>
+     * @public
+     */
+    parquetType?: ParquetType | undefined;
     /**
      * <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
      * @public

package/dist-types/pagination/ListExportTasksPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListExportTasksCommandInput, ListExportTasksCommandOutput } from "../commands/ListExportTasksCommand";
+import { NeptuneGraphPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListExportTasks: (config: NeptuneGraphPaginationConfiguration, input: ListExportTasksCommandInput, ...rest: any[]) => Paginator<ListExportTasksCommandOutput>;

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

@@ -1,4 +1,5 @@
 export * from "./Interfaces";
+export * from "./ListExportTasksPaginator";
 export * from "./ListGraphSnapshotsPaginator";
 export * from "./ListGraphsPaginator";
 export * from "./ListImportTasksPaginator";