diff --git a/clients/client-neptune-graph/src/commands/ExecuteQueryCommand.ts b/clients/client-neptune-graph/src/commands/ExecuteQueryCommand.ts index a01afdd34424..29a7e2f9035f 100644 --- a/clients/client-neptune-graph/src/commands/ExecuteQueryCommand.ts +++ b/clients/client-neptune-graph/src/commands/ExecuteQueryCommand.ts @@ -32,6 +32,21 @@ export interface ExecuteQueryCommandOutput extends OmitExecute 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.

+ *

+ * 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: + *

+ * * *

* Non-parametrized queries are not considered for plan caching. You can force plan caching with @@ -49,6 +64,9 @@ export interface ExecuteQueryCommandOutput extends Omit": "DOCUMENT_VALUE", + * }, * planCache: "ENABLED" || "DISABLED" || "AUTO", * explainMode: "STATIC" || "DETAILS", * queryTimeoutMilliseconds: Number("int"), diff --git a/clients/client-neptune-graph/src/commands/GetQueryCommand.ts b/clients/client-neptune-graph/src/commands/GetQueryCommand.ts index 39e49f771f2b..6296ea98ecc3 100644 --- a/clients/client-neptune-graph/src/commands/GetQueryCommand.ts +++ b/clients/client-neptune-graph/src/commands/GetQueryCommand.ts @@ -29,6 +29,12 @@ export interface GetQueryCommandOutput extends GetQueryOutput, __MetadataBearer /** * @public *

Retrieves the status of a specified query.

+ * + *

+ * When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the + * neptune-graph:GetQueryStatus IAM action attached. + *

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-neptune-graph/src/models/models_0.ts b/clients/client-neptune-graph/src/models/models_0.ts index 706215eddb31..634ca79ed564 100644 --- a/clients/client-neptune-graph/src/models/models_0.ts +++ b/clients/client-neptune-graph/src/models/models_0.ts @@ -1,7 +1,7 @@ // smithy-typescript generated code 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"; @@ -256,6 +256,12 @@ export interface ExecuteQueryInput { */ language: QueryLanguage | undefined; + /** + * @public + *

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

+ */ + parameters?: Record; + /** * @public *

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. @@ -624,7 +630,7 @@ export interface CreateGraphInput { /** * @public - *

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated. + *

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. * (true to enable, or false to disable.

*/ publicConnectivity?: boolean; @@ -738,7 +744,7 @@ export interface CreateGraphOutput { /** * @public - *

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.

+ *

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.

*/ publicConnectivity?: boolean; @@ -1321,7 +1327,7 @@ export interface RestoreGraphFromSnapshotInput { /** * @public - *

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated. + *

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. * (true to enable, or false to disable).

*/ publicConnectivity?: boolean; @@ -1434,7 +1440,7 @@ export interface UpdateGraphInput { /** * @public - *

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated. + *

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. * (true to enable, or false to disable.

*/ publicConnectivity?: boolean; @@ -2443,7 +2449,7 @@ export interface CreateGraphUsingImportTaskInput { /** * @public - *

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated. + *

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. * (true to enable, or false to disable).

*/ publicConnectivity?: boolean; diff --git a/clients/client-neptune-graph/src/protocols/Aws_restJson1.ts b/clients/client-neptune-graph/src/protocols/Aws_restJson1.ts index 61cc6d6cd270..9a8590a7cc78 100644 --- a/clients/client-neptune-graph/src/protocols/Aws_restJson1.ts +++ b/clients/client-neptune-graph/src/protocols/Aws_restJson1.ts @@ -26,6 +26,7 @@ import { withBaseException, } from "@smithy/smithy-client"; import { + DocumentType as __DocumentType, Endpoint as __Endpoint, ResponseMetadata as __ResponseMetadata, SdkStreamSerdeContext as __SdkStreamSerdeContext, @@ -332,6 +333,7 @@ export const se_ExecuteQueryCommand = async ( take(input, { explain: [, , `explainMode`], language: [], + parameters: (_) => se_DocumentValuedMap(_, context), planCache: [], query: [, , `queryString`], queryTimeoutMilliseconds: [], @@ -1625,6 +1627,19 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont return __decorateServiceException(exception, parsedOutput.body); }; +/** + * serializeAws_restJson1DocumentValuedMap + */ +const se_DocumentValuedMap = (input: Record, context: __SerdeContext): any => { + return Object.entries(input).reduce((acc: Record, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + acc[key] = se_Document(value, context); + return acc; + }, {}); +}; + // se_ImportOptions omitted. // se_NeptuneImportOptions omitted. @@ -1637,6 +1652,13 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont // se_VectorSearchConfiguration omitted. +/** + * serializeAws_restJson1Document + */ +const se_Document = (input: __DocumentType, context: __SerdeContext): any => { + return input; +}; + // de_EdgeLabels omitted. // de_EdgeProperties omitted. diff --git a/codegen/sdk-codegen/aws-models/neptune-graph.json b/codegen/sdk-codegen/aws-models/neptune-graph.json index 0713dfcb6444..3cb4731ea73f 100644 --- a/codegen/sdk-codegen/aws-models/neptune-graph.json +++ b/codegen/sdk-codegen/aws-models/neptune-graph.json @@ -1800,7 +1800,7 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.\n (true to enable, or false to disable.

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable.

" } }, "kmsKeyIdentifier": { @@ -1896,7 +1896,7 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.

" } }, "vectorSearchConfiguration": { @@ -2123,7 +2123,7 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.\n (true to enable, or false to disable).

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable).

" } }, "kmsKeyIdentifier": { @@ -2735,6 +2735,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.neptunegraph#DocumentValuedMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#Document" + } + }, "com.amazonaws.neptunegraph#EdgeLabels": { "type": "list", "member": { @@ -2803,7 +2812,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Execute an openCypher query. Currently, the SDK does not support parameterized queries. If you want to make a \n parameterized query call, you can use an HTTP request.

\n \n

\n Non-parametrized queries are not considered for plan caching. You can force plan caching with \n planCache=enabled. The plan cache will be reused only for the same exact query. Slight variations \n in the query will not be able to reuse the query plan cache.\n

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

Execute an openCypher query. Currently, the SDK does not support parameterized queries. If you want to make a \n parameterized query call, you can use an HTTP request.

\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
\n \n

\n Non-parametrized queries are not considered for plan caching. You can force plan caching with \n planCache=enabled. The plan cache will be reused only for the same exact query. Slight variations \n in the query will not be able to reuse the query plan cache.\n

\n ", "smithy.api#endpoint": { "hostPrefix": "{graphIdentifier}." }, @@ -2846,6 +2855,12 @@ "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": { @@ -3796,7 +3811,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Retrieves the status of a specified query.

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

Retrieves the status of a specified query.

\n \n

\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the \n neptune-graph:GetQueryStatus IAM action attached.\n

\n ", "smithy.api#endpoint": { "hostPrefix": "{graphIdentifier}." }, @@ -5587,7 +5602,7 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.\n (true to enable, or false to disable).

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable).

" } } }, @@ -6181,7 +6196,7 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.\n (true to enable, or false to disable.

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable.

" } }, "provisionedMemory": {