@aws-sdk/client-neptune-graph 3.474.0

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

@@ -0,0 +1,494 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { NeptuneGraphServiceException as __BaseException } from "./NeptuneGraphServiceException";
+export declare const ConflictExceptionReason: {
+  readonly CONCURRENT_MODIFICATION: "CONCURRENT_MODIFICATION";
+};
+export type ConflictExceptionReason =
+  (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
+export declare class ConflictException extends __BaseException {
+  readonly name: "ConflictException";
+  readonly $fault: "client";
+  reason?: ConflictExceptionReason;
+  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+export interface VectorSearchConfiguration {
+  dimension: number | undefined;
+}
+export interface CreateGraphInput {
+  graphName: string | undefined;
+  tags?: Record<string, string>;
+  publicConnectivity?: boolean;
+  kmsKeyIdentifier?: string;
+  vectorSearchConfiguration?: VectorSearchConfiguration;
+  replicaCount?: number;
+  deletionProtection?: boolean;
+  provisionedMemory: number | undefined;
+}
+export declare const GraphStatus: {
+  readonly AVAILABLE: "AVAILABLE";
+  readonly CREATING: "CREATING";
+  readonly DELETING: "DELETING";
+  readonly FAILED: "FAILED";
+  readonly RESETTING: "RESETTING";
+  readonly SNAPSHOTTING: "SNAPSHOTTING";
+  readonly UPDATING: "UPDATING";
+};
+export type GraphStatus = (typeof GraphStatus)[keyof typeof GraphStatus];
+export interface CreateGraphOutput {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  status?: GraphStatus;
+  statusReason?: string;
+  createTime?: Date;
+  provisionedMemory?: number;
+  endpoint?: string;
+  publicConnectivity?: boolean;
+  vectorSearchConfiguration?: VectorSearchConfiguration;
+  replicaCount?: number;
+  kmsKeyIdentifier?: string;
+  sourceSnapshotId?: string;
+  deletionProtection?: boolean;
+  buildNumber?: string;
+}
+export declare class InternalServerException extends __BaseException {
+  readonly name: "InternalServerException";
+  readonly $fault: "server";
+  $retryable: {};
+  constructor(
+    opts: __ExceptionOptionType<InternalServerException, __BaseException>
+  );
+}
+export declare class ServiceQuotaExceededException extends __BaseException {
+  readonly name: "ServiceQuotaExceededException";
+  readonly $fault: "client";
+  resourceId?: string;
+  resourceType?: string;
+  serviceCode?: string;
+  quotaCode?: string;
+  constructor(
+    opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
+  );
+}
+export declare class ThrottlingException extends __BaseException {
+  readonly name: "ThrottlingException";
+  readonly $fault: "client";
+  $retryable: {
+    throttling: boolean;
+  };
+  constructor(
+    opts: __ExceptionOptionType<ThrottlingException, __BaseException>
+  );
+}
+export declare const ValidationExceptionReason: {
+  readonly BAD_REQUEST: "BAD_REQUEST";
+  readonly CONSTRAINT_VIOLATION: "CONSTRAINT_VIOLATION";
+  readonly ILLEGAL_ARGUMENT: "ILLEGAL_ARGUMENT";
+  readonly MALFORMED_QUERY: "MALFORMED_QUERY";
+  readonly QUERY_CANCELLED: "QUERY_CANCELLED";
+  readonly QUERY_TOO_LARGE: "QUERY_TOO_LARGE";
+  readonly UNSUPPORTED_OPERATION: "UNSUPPORTED_OPERATION";
+};
+export type ValidationExceptionReason =
+  (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
+export declare class ValidationException extends __BaseException {
+  readonly name: "ValidationException";
+  readonly $fault: "client";
+  reason?: ValidationExceptionReason;
+  constructor(
+    opts: __ExceptionOptionType<ValidationException, __BaseException>
+  );
+}
+export interface DeleteGraphInput {
+  graphIdentifier: string | undefined;
+  skipSnapshot: boolean | undefined;
+}
+export interface DeleteGraphOutput {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  status?: GraphStatus;
+  statusReason?: string;
+  createTime?: Date;
+  provisionedMemory?: number;
+  endpoint?: string;
+  publicConnectivity?: boolean;
+  vectorSearchConfiguration?: VectorSearchConfiguration;
+  replicaCount?: number;
+  kmsKeyIdentifier?: string;
+  sourceSnapshotId?: string;
+  deletionProtection?: boolean;
+  buildNumber?: string;
+}
+export declare class ResourceNotFoundException extends __BaseException {
+  readonly name: "ResourceNotFoundException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
+  );
+}
+export interface GetGraphInput {
+  graphIdentifier: string | undefined;
+}
+export interface GetGraphOutput {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  status?: GraphStatus;
+  statusReason?: string;
+  createTime?: Date;
+  provisionedMemory?: number;
+  endpoint?: string;
+  publicConnectivity?: boolean;
+  vectorSearchConfiguration?: VectorSearchConfiguration;
+  replicaCount?: number;
+  kmsKeyIdentifier?: string;
+  sourceSnapshotId?: string;
+  deletionProtection?: boolean;
+  buildNumber?: string;
+}
+export interface ListGraphsInput {
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface GraphSummary {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  status?: GraphStatus;
+  provisionedMemory?: number;
+  publicConnectivity?: boolean;
+  endpoint?: string;
+  replicaCount?: number;
+  kmsKeyIdentifier?: string;
+  deletionProtection?: boolean;
+}
+export interface ListGraphsOutput {
+  graphs: GraphSummary[] | undefined;
+  nextToken?: string;
+}
+export interface ResetGraphInput {
+  graphIdentifier: string | undefined;
+  skipSnapshot: boolean | undefined;
+}
+export interface ResetGraphOutput {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  status?: GraphStatus;
+  statusReason?: string;
+  createTime?: Date;
+  provisionedMemory?: number;
+  endpoint?: string;
+  publicConnectivity?: boolean;
+  vectorSearchConfiguration?: VectorSearchConfiguration;
+  replicaCount?: number;
+  kmsKeyIdentifier?: string;
+  sourceSnapshotId?: string;
+  deletionProtection?: boolean;
+  buildNumber?: string;
+}
+export interface RestoreGraphFromSnapshotInput {
+  snapshotIdentifier: string | undefined;
+  graphName: string | undefined;
+  provisionedMemory?: number;
+  deletionProtection?: boolean;
+  tags?: Record<string, string>;
+  replicaCount?: number;
+  publicConnectivity?: boolean;
+}
+export interface RestoreGraphFromSnapshotOutput {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  status?: GraphStatus;
+  statusReason?: string;
+  createTime?: Date;
+  provisionedMemory?: number;
+  endpoint?: string;
+  publicConnectivity?: boolean;
+  vectorSearchConfiguration?: VectorSearchConfiguration;
+  replicaCount?: number;
+  kmsKeyIdentifier?: string;
+  sourceSnapshotId?: string;
+  deletionProtection?: boolean;
+  buildNumber?: string;
+}
+export interface UpdateGraphInput {
+  graphIdentifier: string | undefined;
+  publicConnectivity?: boolean;
+  provisionedMemory?: number;
+  deletionProtection?: boolean;
+}
+export interface UpdateGraphOutput {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  status?: GraphStatus;
+  statusReason?: string;
+  createTime?: Date;
+  provisionedMemory?: number;
+  endpoint?: string;
+  publicConnectivity?: boolean;
+  vectorSearchConfiguration?: VectorSearchConfiguration;
+  replicaCount?: number;
+  kmsKeyIdentifier?: string;
+  sourceSnapshotId?: string;
+  deletionProtection?: boolean;
+  buildNumber?: string;
+}
+export interface ListTagsForResourceInput {
+  resourceArn: string | undefined;
+}
+export interface ListTagsForResourceOutput {
+  tags?: Record<string, string>;
+}
+export interface CreatePrivateGraphEndpointInput {
+  graphIdentifier: string | undefined;
+  vpcId?: string;
+  subnetIds?: string[];
+  vpcSecurityGroupIds?: string[];
+}
+export declare const PrivateGraphEndpointStatus: {
+  readonly AVAILABLE: "AVAILABLE";
+  readonly CREATING: "CREATING";
+  readonly DELETING: "DELETING";
+  readonly FAILED: "FAILED";
+};
+export type PrivateGraphEndpointStatus =
+  (typeof PrivateGraphEndpointStatus)[keyof typeof PrivateGraphEndpointStatus];
+export interface CreatePrivateGraphEndpointOutput {
+  vpcId: string | undefined;
+  subnetIds: string[] | undefined;
+  status: PrivateGraphEndpointStatus | undefined;
+  vpcEndpointId?: string;
+}
+export interface DeletePrivateGraphEndpointInput {
+  graphIdentifier: string | undefined;
+  vpcId: string | undefined;
+}
+export interface DeletePrivateGraphEndpointOutput {
+  vpcId: string | undefined;
+  subnetIds: string[] | undefined;
+  status: PrivateGraphEndpointStatus | undefined;
+  vpcEndpointId?: string;
+}
+export interface GetPrivateGraphEndpointInput {
+  graphIdentifier: string | undefined;
+  vpcId: string | undefined;
+}
+export interface GetPrivateGraphEndpointOutput {
+  vpcId: string | undefined;
+  subnetIds: string[] | undefined;
+  status: PrivateGraphEndpointStatus | undefined;
+  vpcEndpointId?: string;
+}
+export interface ListPrivateGraphEndpointsInput {
+  graphIdentifier: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface PrivateGraphEndpointSummary {
+  vpcId: string | undefined;
+  subnetIds: string[] | undefined;
+  status: PrivateGraphEndpointStatus | undefined;
+  vpcEndpointId?: string;
+}
+export interface ListPrivateGraphEndpointsOutput {
+  privateGraphEndpoints: PrivateGraphEndpointSummary[] | undefined;
+  nextToken?: string;
+}
+export interface CreateGraphSnapshotInput {
+  graphIdentifier: string | undefined;
+  snapshotName: string | undefined;
+  tags?: Record<string, string>;
+}
+export declare const SnapshotStatus: {
+  readonly AVAILABLE: "AVAILABLE";
+  readonly CREATING: "CREATING";
+  readonly DELETING: "DELETING";
+  readonly FAILED: "FAILED";
+};
+export type SnapshotStatus =
+  (typeof SnapshotStatus)[keyof typeof SnapshotStatus];
+export interface CreateGraphSnapshotOutput {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  sourceGraphId?: string;
+  snapshotCreateTime?: Date;
+  status?: SnapshotStatus;
+  kmsKeyIdentifier?: string;
+}
+export interface DeleteGraphSnapshotInput {
+  snapshotIdentifier: string | undefined;
+}
+export interface DeleteGraphSnapshotOutput {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  sourceGraphId?: string;
+  snapshotCreateTime?: Date;
+  status?: SnapshotStatus;
+  kmsKeyIdentifier?: string;
+}
+export interface GetGraphSnapshotInput {
+  snapshotIdentifier: string | undefined;
+}
+export interface GetGraphSnapshotOutput {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  sourceGraphId?: string;
+  snapshotCreateTime?: Date;
+  status?: SnapshotStatus;
+  kmsKeyIdentifier?: string;
+}
+export interface ListGraphSnapshotsInput {
+  graphIdentifier?: string;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface GraphSnapshotSummary {
+  id: string | undefined;
+  name: string | undefined;
+  arn: string | undefined;
+  sourceGraphId?: string;
+  snapshotCreateTime?: Date;
+  status?: SnapshotStatus;
+  kmsKeyIdentifier?: string;
+}
+export interface ListGraphSnapshotsOutput {
+  graphSnapshots: GraphSnapshotSummary[] | undefined;
+  nextToken?: string;
+}
+export interface TagResourceInput {
+  resourceArn: string | undefined;
+  tags: Record<string, string> | undefined;
+}
+export interface TagResourceOutput {}
+export interface CancelImportTaskInput {
+  taskIdentifier: string | undefined;
+}
+export declare const Format: {
+  readonly CSV: "CSV";
+  readonly OPEN_CYPHER: "OPEN_CYPHER";
+};
+export type Format = (typeof Format)[keyof typeof Format];
+export declare const ImportTaskStatus: {
+  readonly ANALYZING_DATA: "ANALYZING_DATA";
+  readonly CANCELLED: "CANCELLED";
+  readonly CANCELLING: "CANCELLING";
+  readonly EXPORTING: "EXPORTING";
+  readonly FAILED: "FAILED";
+  readonly IMPORTING: "IMPORTING";
+  readonly INITIALIZING: "INITIALIZING";
+  readonly REPROVISIONING: "REPROVISIONING";
+  readonly ROLLING_BACK: "ROLLING_BACK";
+  readonly SUCCEEDED: "SUCCEEDED";
+};
+export type ImportTaskStatus =
+  (typeof ImportTaskStatus)[keyof typeof ImportTaskStatus];
+export interface CancelImportTaskOutput {
+  graphId?: string;
+  taskId: string | undefined;
+  source: string | undefined;
+  format?: Format;
+  roleArn: string | undefined;
+  status: ImportTaskStatus | undefined;
+}
+export interface NeptuneImportOptions {
+  s3ExportPath: string | undefined;
+  s3ExportKmsKeyId: string | undefined;
+  preserveDefaultVertexLabels?: boolean;
+  preserveEdgeIds?: boolean;
+}
+export type ImportOptions =
+  | ImportOptions.NeptuneMember
+  | ImportOptions.$UnknownMember;
+export declare namespace ImportOptions {
+  interface NeptuneMember {
+    neptune: NeptuneImportOptions;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    neptune?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    neptune: (value: NeptuneImportOptions) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: ImportOptions, visitor: Visitor<T>) => T;
+}
+export interface CreateGraphUsingImportTaskInput {
+  graphName: string | undefined;
+  tags?: Record<string, string>;
+  publicConnectivity?: boolean;
+  kmsKeyIdentifier?: string;
+  vectorSearchConfiguration?: VectorSearchConfiguration;
+  replicaCount?: number;
+  deletionProtection?: boolean;
+  importOptions?: ImportOptions;
+  maxProvisionedMemory?: number;
+  minProvisionedMemory?: number;
+  failOnError?: boolean;
+  source: string | undefined;
+  format?: Format;
+  roleArn: string | undefined;
+}
+export interface CreateGraphUsingImportTaskOutput {
+  graphId?: string;
+  taskId: string | undefined;
+  source: string | undefined;
+  format?: Format;
+  roleArn: string | undefined;
+  status: ImportTaskStatus | undefined;
+  importOptions?: ImportOptions;
+}
+export interface GetImportTaskInput {
+  taskIdentifier: string | undefined;
+}
+export interface ImportTaskDetails {
+  status: string | undefined;
+  startTime: Date | undefined;
+  timeElapsedSeconds: number | undefined;
+  progressPercentage: number | undefined;
+  errorCount: number | undefined;
+  errorDetails?: string;
+  statementCount: number | undefined;
+  dictionaryEntryCount: number | undefined;
+}
+export interface GetImportTaskOutput {
+  graphId?: string;
+  taskId: string | undefined;
+  source: string | undefined;
+  format?: Format;
+  roleArn: string | undefined;
+  status: ImportTaskStatus | undefined;
+  importOptions?: ImportOptions;
+  importTaskDetails?: ImportTaskDetails;
+  attemptNumber?: number;
+  statusReason?: string;
+}
+export interface ListImportTasksInput {
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface ImportTaskSummary {
+  graphId?: string;
+  taskId: string | undefined;
+  source: string | undefined;
+  format?: Format;
+  roleArn: string | undefined;
+  status: ImportTaskStatus | undefined;
+}
+export interface ListImportTasksOutput {
+  tasks: ImportTaskSummary[] | undefined;
+  nextToken?: string;
+}
+export interface UntagResourceInput {
+  resourceArn: string | undefined;
+  tagKeys: string[] | undefined;
+}
+export interface UntagResourceOutput {}

package/dist-types/ts3.4/pagination/Interfaces.d.ts

@@ -0,0 +1,6 @@
+import { PaginationConfiguration } from "@smithy/types";
+import { NeptuneGraphClient } from "../NeptuneGraphClient";
+export interface NeptuneGraphPaginationConfiguration
+  extends PaginationConfiguration {
+  client: NeptuneGraphClient;
+}

package/dist-types/ts3.4/pagination/ListGraphSnapshotsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListGraphSnapshotsCommandInput,
+  ListGraphSnapshotsCommandOutput,
+} from "../commands/ListGraphSnapshotsCommand";
+import { NeptuneGraphPaginationConfiguration } from "./Interfaces";
+export declare function paginateListGraphSnapshots(
+  config: NeptuneGraphPaginationConfiguration,
+  input: ListGraphSnapshotsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListGraphSnapshotsCommandOutput>;

package/dist-types/ts3.4/pagination/ListGraphsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListGraphsCommandInput,
+  ListGraphsCommandOutput,
+} from "../commands/ListGraphsCommand";
+import { NeptuneGraphPaginationConfiguration } from "./Interfaces";
+export declare function paginateListGraphs(
+  config: NeptuneGraphPaginationConfiguration,
+  input: ListGraphsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListGraphsCommandOutput>;

package/dist-types/ts3.4/pagination/ListImportTasksPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListImportTasksCommandInput,
+  ListImportTasksCommandOutput,
+} from "../commands/ListImportTasksCommand";
+import { NeptuneGraphPaginationConfiguration } from "./Interfaces";
+export declare function paginateListImportTasks(
+  config: NeptuneGraphPaginationConfiguration,
+  input: ListImportTasksCommandInput,
+  ...additionalArguments: any
+): Paginator<ListImportTasksCommandOutput>;

package/dist-types/ts3.4/pagination/ListPrivateGraphEndpointsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListPrivateGraphEndpointsCommandInput,
+  ListPrivateGraphEndpointsCommandOutput,
+} from "../commands/ListPrivateGraphEndpointsCommand";
+import { NeptuneGraphPaginationConfiguration } from "./Interfaces";
+export declare function paginateListPrivateGraphEndpoints(
+  config: NeptuneGraphPaginationConfiguration,
+  input: ListPrivateGraphEndpointsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListPrivateGraphEndpointsCommandOutput>;

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

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