@aws-sdk/client-neptune-graph 3.504.0 → 3.507.0

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

@@ -1,5 +1,107 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { StreamingBlobTypes } from "@smithy/types";
 import { NeptuneGraphServiceException as __BaseException } from "./NeptuneGraphServiceException";
+/**
+ * @public
+ * <p>Raised in case of an authentication or authorization failure.</p>
+ */
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface CancelQueryInput {
+    /**
+     * @public
+     * <p>The unique identifier of the Neptune Analytics graph.</p>
+     */
+    graphIdentifier: string | undefined;
+    /**
+     * @public
+     * <p>The unique identifier of the query to cancel.</p>
+     */
+    queryId: string | undefined;
+}
+/**
+ * @public
+ * <p>A failure occurred on the server.</p>
+ */
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    $retryable: {};
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * @public
+ * <p>A specified resource could not be located.</p>
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ * <p>The exception was interrupted by throttling.</p>
+ */
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    $retryable: {
+        throttling: boolean;
+    };
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+/**
+ * @public
+ * @enum
+ */
+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";
+};
+/**
+ * @public
+ */
+export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
+/**
+ * @public
+ * <p>A resource could not be validated.</p>
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @public
+     * <p>The reason that the resource could not be validated.</p>
+     */
+    reason?: ValidationExceptionReason;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
 /**
  * @public
  * @enum
@@ -28,6 +130,343 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ExplainMode: {
+    readonly DETAILS: "DETAILS";
+    readonly STATIC: "STATIC";
+};
+/**
+ * @public
+ */
+export type ExplainMode = (typeof ExplainMode)[keyof typeof ExplainMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const QueryLanguage: {
+    readonly OPEN_CYPHER: "OPEN_CYPHER";
+};
+/**
+ * @public
+ */
+export type QueryLanguage = (typeof QueryLanguage)[keyof typeof QueryLanguage];
+/**
+ * @public
+ * @enum
+ */
+export declare const PlanCacheType: {
+    readonly AUTO: "AUTO";
+    readonly DISABLED: "DISABLED";
+    readonly ENABLED: "ENABLED";
+};
+/**
+ * @public
+ */
+export type PlanCacheType = (typeof PlanCacheType)[keyof typeof PlanCacheType];
+/**
+ * @public
+ */
+export interface ExecuteQueryInput {
+    /**
+     * @public
+     * <p>The unique identifier of the Neptune Analytics graph.</p>
+     */
+    graphIdentifier: string | undefined;
+    /**
+     * @public
+     * <p>The query string to be executed.</p>
+     */
+    queryString: string | undefined;
+    /**
+     * @public
+     * <p>The query language the query is written in. Currently only openCypher is supported.</p>
+     */
+    language: QueryLanguage | undefined;
+    /**
+     * @public
+     * <p>Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query.
+     *       This reduces query latency, and works for both <code>READ</code> and <code>UPDATE</code> queries. The plan cache is an
+     *       LRU cache with a 5 minute TTL and a capacity of 1000.</p>
+     */
+    planCache?: PlanCacheType;
+    /**
+     * @public
+     * <p>The explain mode parameter returns a query explain instead of the actual query results. A query explain can
+     *       be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions
+     *       flowing etc.</p>
+     */
+    explainMode?: ExplainMode;
+    /**
+     * @public
+     * <p>Specifies the query timeout duration, in milliseconds. (optional)</p>
+     */
+    queryTimeoutMilliseconds?: number;
+}
+/**
+ * @public
+ */
+export interface ExecuteQueryOutput {
+    /**
+     * @public
+     * <p>The query results.</p>
+     */
+    payload: StreamingBlobTypes | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const UnprocessableExceptionReason: {
+    readonly INTERNAL_LIMIT_EXCEEDED: "INTERNAL_LIMIT_EXCEEDED";
+    readonly MEMORY_LIMIT_EXCEEDED: "MEMORY_LIMIT_EXCEEDED";
+    readonly PARTITION_FULL: "PARTITION_FULL";
+    readonly QUERY_TIMEOUT: "QUERY_TIMEOUT";
+    readonly STORAGE_LIMIT_EXCEEDED: "STORAGE_LIMIT_EXCEEDED";
+};
+/**
+ * @public
+ */
+export type UnprocessableExceptionReason = (typeof UnprocessableExceptionReason)[keyof typeof UnprocessableExceptionReason];
+/**
+ * @public
+ * <p>Request cannot be processed due to known reasons. Eg. partition full.</p>
+ */
+export declare class UnprocessableException extends __BaseException {
+    readonly name: "UnprocessableException";
+    readonly $fault: "client";
+    /**
+     * @public
+     * <p>The reason for the unprocessable exception.</p>
+     */
+    reason: UnprocessableExceptionReason | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnprocessableException, __BaseException>);
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GraphSummaryMode: {
+    readonly BASIC: "BASIC";
+    readonly DETAILED: "DETAILED";
+};
+/**
+ * @public
+ */
+export type GraphSummaryMode = (typeof GraphSummaryMode)[keyof typeof GraphSummaryMode];
+/**
+ * @public
+ */
+export interface GetGraphSummaryInput {
+    /**
+     * @public
+     * <p>The unique identifier of the Neptune Analytics graph.</p>
+     */
+    graphIdentifier: string | undefined;
+    /**
+     * @public
+     * <p>The summary mode can take one of two values: <code>basic</code> (the default), and
+     *    <code>detailed</code>.</p>
+     */
+    mode?: GraphSummaryMode;
+}
+/**
+ * @public
+ * <p>Contains information about an edge in a Neptune Analytics graph.</p>
+ */
+export interface EdgeStructure {
+    /**
+     * @public
+     * <p>The number of instances of the edge in the graph.</p>
+     */
+    count?: number;
+    /**
+     * @public
+     * <p>A list of the properties associated with the edge.</p>
+     */
+    edgeProperties?: string[];
+}
+/**
+ * @public
+ * <p>Information about a node.</p>
+ */
+export interface NodeStructure {
+    /**
+     * @public
+     * <p>The number of instances of this node.</p>
+     */
+    count?: number;
+    /**
+     * @public
+     * <p>Properties associated with this node.</p>
+     */
+    nodeProperties?: string[];
+    /**
+     * @public
+     * <p>The outgoing edge labels associated with this node.</p>
+     */
+    distinctOutgoingEdgeLabels?: string[];
+}
+/**
+ * @public
+ * <p>Summary information about the graph.</p>
+ */
+export interface GraphDataSummary {
+    /**
+     * @public
+     * <p>The number of nodes in the graph.</p>
+     */
+    numNodes?: number;
+    /**
+     * @public
+     * <p>The number of edges in the graph.</p>
+     */
+    numEdges?: number;
+    /**
+     * @public
+     * <p>The number of distinct node labels in the graph.</p>
+     */
+    numNodeLabels?: number;
+    /**
+     * @public
+     * <p>The number of unique edge labels in the graph.</p>
+     */
+    numEdgeLabels?: number;
+    /**
+     * @public
+     * <p>A list of distinct node labels in the graph.</p>
+     */
+    nodeLabels?: string[];
+    /**
+     * @public
+     * <p>A list of the edge labels in the graph.</p>
+     */
+    edgeLabels?: string[];
+    /**
+     * @public
+     * <p>The number of distinct node properties in the graph.</p>
+     */
+    numNodeProperties?: number;
+    /**
+     * @public
+     * <p>The number of edge properties in the graph.</p>
+     */
+    numEdgeProperties?: number;
+    /**
+     * @public
+     * <p>A list of the distinct node properties in the graph, along with the count of nodes where each property is used.</p>
+     */
+    nodeProperties?: Record<string, number>[];
+    /**
+     * @public
+     * <p>A list of the distinct edge properties in the graph, along with the count of edges
+     *       where each property is used.</p>
+     */
+    edgeProperties?: Record<string, number>[];
+    /**
+     * @public
+     * <p>The total number of usages of all node properties.</p>
+     */
+    totalNodePropertyValues?: number;
+    /**
+     * @public
+     * <p>The total number of usages of all edge properties.</p>
+     */
+    totalEdgePropertyValues?: number;
+    /**
+     * @public
+     * <p>This field is only present when the requested mode is DETAILED. It contains a list of node structures.</p>
+     */
+    nodeStructures?: NodeStructure[];
+    /**
+     * @public
+     * <p>This field is only present when the requested mode is DETAILED. It contains a list of edge structures.</p>
+     */
+    edgeStructures?: EdgeStructure[];
+}
+/**
+ * @public
+ */
+export interface GetGraphSummaryOutput {
+    /**
+     * @public
+     * <p>Display the version of this tool.</p>
+     */
+    version?: string;
+    /**
+     * @public
+     * <p>The timestamp, in ISO 8601 format, of the time at which Neptune Analytics last computed statistics.</p>
+     */
+    lastStatisticsComputationTime?: Date;
+    /**
+     * @public
+     * <p>The graph summary.</p>
+     */
+    graphSummary?: GraphDataSummary;
+}
+/**
+ * @public
+ */
+export interface GetQueryInput {
+    /**
+     * @public
+     * <p>The unique identifier of the Neptune Analytics graph.</p>
+     */
+    graphIdentifier: string | undefined;
+    /**
+     * @public
+     * <p>The ID of the query in question.</p>
+     */
+    queryId: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const QueryState: {
+    readonly CANCELLING: "CANCELLING";
+    readonly RUNNING: "RUNNING";
+    readonly WAITING: "WAITING";
+};
+/**
+ * @public
+ */
+export type QueryState = (typeof QueryState)[keyof typeof QueryState];
+/**
+ * @public
+ */
+export interface GetQueryOutput {
+    /**
+     * @public
+     * <p>The ID of the query in question.</p>
+     */
+    id?: string;
+    /**
+     * @public
+     * <p>The query in question.</p>
+     */
+    queryString?: string;
+    /**
+     * @public
+     * <p>Indicates how long the query waited, in milliseconds.</p>
+     */
+    waited?: number;
+    /**
+     * @public
+     * <p>The number of milliseconds the query has been running.</p>
+     */
+    elapsed?: number;
+    /**
+     * @public
+     * <p>State of the query.</p>
+     */
+    state?: QueryState;
+}
 /**
  * @public
  * <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
@@ -76,7 +515,7 @@ export interface CreateGraphInput {
     vectorSearchConfiguration?: VectorSearchConfiguration;
     /**
      * @public
-     * <p>The number of replicas in other AZs. Min =0, Max = 2, Default =1</p>
+     * <p>The number of replicas in other AZs. Min =0, Max = 2, Default = 1.</p>
      */
     replicaCount?: number;
     /**
@@ -193,19 +632,6 @@ export interface CreateGraphOutput {
      */
     buildNumber?: string;
 }
-/**
- * @public
- * <p>A failure occurred on the server.</p>
- */
-export declare class InternalServerException extends __BaseException {
-    readonly name: "InternalServerException";
-    readonly $fault: "server";
-    $retryable: {};
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
-}
 /**
  * @public
  * <p>A service quota was exceeded.</p>
@@ -238,55 +664,6 @@ export declare class ServiceQuotaExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
-/**
- * @public
- * <p>The exception was interrupted by throttling.</p>
- */
-export declare class ThrottlingException extends __BaseException {
-    readonly name: "ThrottlingException";
-    readonly $fault: "client";
-    $retryable: {
-        throttling: boolean;
-    };
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
-}
-/**
- * @public
- * @enum
- */
-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";
-};
-/**
- * @public
- */
-export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
-/**
- * @public
- * <p>A resource could not be validated</p>
- */
-export declare class ValidationException extends __BaseException {
-    readonly name: "ValidationException";
-    readonly $fault: "client";
-    /**
-     * @public
-     * <p>The reason that the resource could not be validated.</p>
-     */
-    reason?: ValidationExceptionReason;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
-}
 /**
  * @public
  */
@@ -384,18 +761,6 @@ export interface DeleteGraphOutput {
      */
     buildNumber?: string;
 }
-/**
- * @public
- * <p>A specified resource could not be located.</p>
- */
-export declare class ResourceNotFoundException extends __BaseException {
-    readonly name: "ResourceNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
-}
 /**
  * @public
  */
@@ -913,6 +1278,81 @@ export interface UpdateGraphOutput {
      */
     buildNumber?: string;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const QueryStateInput: {
+    readonly ALL: "ALL";
+    readonly CANCELLING: "CANCELLING";
+    readonly RUNNING: "RUNNING";
+    readonly WAITING: "WAITING";
+};
+/**
+ * @public
+ */
+export type QueryStateInput = (typeof QueryStateInput)[keyof typeof QueryStateInput];
+/**
+ * @public
+ */
+export interface ListQueriesInput {
+    /**
+     * @public
+     * <p>The unique identifier of the Neptune Analytics graph.</p>
+     */
+    graphIdentifier: string | undefined;
+    /**
+     * @public
+     * <p>The maximum number of results to be fetched by the API.</p>
+     */
+    maxResults: number | undefined;
+    /**
+     * @public
+     * <p>Filtered list of queries based on state.</p>
+     */
+    state?: QueryStateInput;
+}
+/**
+ * @public
+ * <p>Details of the query listed.</p>
+ */
+export interface QuerySummary {
+    /**
+     * @public
+     * <p>A string representation of the id of the query.</p>
+     */
+    id?: string;
+    /**
+     * @public
+     * <p>The actual query text. The <code>queryString</code> may be truncated if the actual query string is too long.</p>
+     */
+    queryString?: string;
+    /**
+     * @public
+     * <p>The amount of time, in milliseconds, the query has waited in the queue before being picked up by a worker thread.</p>
+     */
+    waited?: number;
+    /**
+     * @public
+     * <p>The running time of the query, in milliseconds.</p>
+     */
+    elapsed?: number;
+    /**
+     * @public
+     * <p>State of the query.</p>
+     */
+    state?: QueryState;
+}
+/**
+ * @public
+ */
+export interface ListQueriesOutput {
+    /**
+     * @public
+     * <p>A list of current openCypher queries.</p>
+     */
+    queries: QuerySummary[] | undefined;
+}
 /**
  * @public
  */
@@ -1517,7 +1957,7 @@ export interface CancelImportTaskOutput {
     /**
      * @public
      * <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
-     *       or can point to a Neptune database endpoint or snapshot</p>
+     *       or can point to a Neptune database endpoint or snapshot.</p>
      */
     source: string | undefined;
     /**
@@ -1568,7 +2008,7 @@ export interface NeptuneImportOptions {
      * @public
      * <p>Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by
      *           default. They are imported if <i>preserveEdgeIds</i> is set to true, and ids are stored as
-     *           properties on the relationships with the property name neptuneEdgeId.</p>
+     *           properties on the relationships with the property name <i>neptuneEdgeId</i>.</p>
      */
     preserveEdgeIds?: boolean;
 }
@@ -1623,7 +2063,7 @@ export interface CreateGraphUsingImportTaskInput {
     /**
      * @public
      * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.
-     *        (<code>true</code> to enable, or <code>false</code> to disable.</p>
+     *        (<code>true</code> to enable, or <code>false</code> to disable).</p>
      */
     publicConnectivity?: boolean;
     /**
@@ -2019,3 +2459,7 @@ export interface UntagResourceInput {
  */
 export interface UntagResourceOutput {
 }
+/**
+ * @internal
+ */
+export declare const ExecuteQueryOutputFilterSensitiveLog: (obj: ExecuteQueryOutput) => any;