@aws-sdk/client-neptune-graph 3.511.0 → 3.512.0

package/dist-cjs/index.js

@@ -617,6 +617,7 @@ var se_ExecuteQueryCommand = /* @__PURE__ */ __name(async (input, context) => {
     (0, import_smithy_client.take)(input, {
       explain: [, , `explainMode`],
       language: [],
+      parameters: (_) => se_DocumentValuedMap(_, context),
       planCache: [],
       query: [, , `queryString`],
       queryTimeoutMilliseconds: []
@@ -1550,6 +1551,18 @@ var de_ValidationExceptionRes = /* @__PURE__ */ __name(async (parsedOutput, cont
   });
   return (0, import_smithy_client.decorateServiceException)(exception, parsedOutput.body);
 }, "de_ValidationExceptionRes");
+var se_DocumentValuedMap = /* @__PURE__ */ __name((input, context) => {
+  return Object.entries(input).reduce((acc, [key, value]) => {
+    if (value === null) {
+      return acc;
+    }
+    acc[key] = se_Document(value, context);
+    return acc;
+  }, {});
+}, "se_DocumentValuedMap");
+var se_Document = /* @__PURE__ */ __name((input, context) => {
+  return input;
+}, "se_Document");
 var de_GraphSnapshotSummary = /* @__PURE__ */ __name((output, context) => {
   return (0, import_smithy_client.take)(output, {
     arn: import_smithy_client.expectString,

package/dist-es/protocols/Aws_restJson1.js

@@ -155,6 +155,7 @@ export const se_ExecuteQueryCommand = async (input, context) => {
     body = JSON.stringify(take(input, {
         explain: [, , `explainMode`],
         language: [],
+        parameters: (_) => se_DocumentValuedMap(_, context),
         planCache: [],
         query: [, , `queryString`],
         queryTimeoutMilliseconds: [],
@@ -1079,6 +1080,18 @@ const de_ValidationExceptionRes = async (parsedOutput, context) => {
     });
     return __decorateServiceException(exception, parsedOutput.body);
 };
+const se_DocumentValuedMap = (input, context) => {
+    return Object.entries(input).reduce((acc, [key, value]) => {
+        if (value === null) {
+            return acc;
+        }
+        acc[key] = se_Document(value, context);
+        return acc;
+    }, {});
+};
+const se_Document = (input, context) => {
+    return input;
+};
 const de_GraphSnapshotSummary = (output, context) => {
     return take(output, {
         arn: __expectString,

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

@@ -29,6 +29,21 @@ declare const ExecuteQueryCommand_base: {
  * @public
  * <p>Execute an openCypher query. Currently, the SDK does not support parameterized queries. If you want to make a
  *       parameterized query call, you can use an HTTP request. </p>
+ *          <p>
+ *       When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached
+ *       that allows one of the following IAM actions in that cluster, depending on the query:
+ *     </p>
+ *          <ul>
+ *             <li>
+ *                <p>neptune-graph:ReadDataViaQuery</p>
+ *             </li>
+ *             <li>
+ *                <p>neptune-graph:WriteDataViaQuery</p>
+ *             </li>
+ *             <li>
+ *                <p>neptune-graph:DeleteDataViaQuery</p>
+ *             </li>
+ *          </ul>
  *          <note>
  *             <p>
  *         Non-parametrized queries are not considered for plan caching. You can force plan caching with
@@ -46,6 +61,9 @@ declare const ExecuteQueryCommand_base: {
  *   graphIdentifier: "STRING_VALUE", // required
  *   queryString: "STRING_VALUE", // required
  *   language: "OPEN_CYPHER", // required
+ *   parameters: { // DocumentValuedMap
+ *     "<keys>": "DOCUMENT_VALUE",
+ *   },
  *   planCache: "ENABLED" || "DISABLED" || "AUTO",
  *   explainMode: "STATIC" || "DETAILS",
  *   queryTimeoutMilliseconds: Number("int"),

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

@@ -27,6 +27,12 @@ declare const GetQueryCommand_base: {
 /**
  * @public
  * <p>Retrieves the status of a specified query.</p>
+ *          <note>
+ *             <p>
+ *         When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the
+ *         <code>neptune-graph:GetQueryStatus</code> IAM action attached.
+ *       </p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -1,5 +1,5 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
-import { StreamingBlobTypes } from "@smithy/types";
+import { DocumentType as __DocumentType, StreamingBlobTypes } from "@smithy/types";
 import { NeptuneGraphServiceException as __BaseException } from "./NeptuneGraphServiceException";
 /**
  * @public
@@ -185,6 +185,11 @@ export interface ExecuteQueryInput {
      * <p>The query language the query is written in. Currently only openCypher is supported.</p>
      */
     language: QueryLanguage | undefined;
+    /**
+     * @public
+     * <p>The data parameters the query can use in JSON format. For example: \{"name": "john", "age": 20\}. (optional) </p>
+     */
+    parameters?: Record<string, __DocumentType>;
     /**
      * @public
      * <p>Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query.
@@ -498,7 +503,7 @@ export interface CreateGraphInput {
     tags?: Record<string, string>;
     /**
      * @public
-     * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.
+     * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
      *        (<code>true</code> to enable, or <code>false</code> to disable.</p>
      */
     publicConnectivity?: boolean;
@@ -596,7 +601,7 @@ export interface CreateGraphOutput {
     endpoint?: string;
     /**
      * @public
-     * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.</p>
+     * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.</p>
      */
     publicConnectivity?: boolean;
     /**
@@ -1086,7 +1091,7 @@ export interface RestoreGraphFromSnapshotInput {
     replicaCount?: number;
     /**
      * @public
-     * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.
+     * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
      *       (<code>true</code> to enable, or <code>false</code> to disable).</p>
      */
     publicConnectivity?: boolean;
@@ -1182,7 +1187,7 @@ export interface UpdateGraphInput {
     graphIdentifier: string | undefined;
     /**
      * @public
-     * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.
+     * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
      *       (<code>true</code> to enable, or <code>false</code> to disable.</p>
      */
     publicConnectivity?: boolean;
@@ -2062,7 +2067,7 @@ export interface CreateGraphUsingImportTaskInput {
     tags?: Record<string, string>;
     /**
      * @public
-     * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.
+     * <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
      *        (<code>true</code> to enable, or <code>false</code> to disable).</p>
      */
     publicConnectivity?: boolean;

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

@@ -1,5 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
-import { StreamingBlobTypes } from "@smithy/types";
+import {
+  DocumentType as __DocumentType,
+  StreamingBlobTypes,
+} from "@smithy/types";
 import { NeptuneGraphServiceException as __BaseException } from "./NeptuneGraphServiceException";
 export declare class AccessDeniedException extends __BaseException {
   readonly name: "AccessDeniedException";
@@ -86,6 +89,7 @@ export interface ExecuteQueryInput {
   graphIdentifier: string | undefined;
   queryString: string | undefined;
   language: QueryLanguage | undefined;
+  parameters?: Record<string, __DocumentType>;
   planCache?: PlanCacheType;
   explainMode?: ExplainMode;
   queryTimeoutMilliseconds?: number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-neptune-graph",
   "description": "AWS SDK for JavaScript Neptune Graph Client for Node.js, Browser and React Native",
-  "version": "3.511.0",
+  "version": "3.512.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-neptune-graph",