@aws-sdk/client-neptunedata 3.848.0 → 3.855.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/README.md +1 -7
  2. package/dist-cjs/index.js +13 -0
  3. package/dist-es/models/models_0.js +13 -0
  4. package/dist-types/Neptunedata.d.ts +1 -6
  5. package/dist-types/NeptunedataClient.d.ts +1 -6
  6. package/dist-types/commands/CancelGremlinQueryCommand.d.ts +2 -8
  7. package/dist-types/commands/CancelLoaderJobCommand.d.ts +1 -7
  8. package/dist-types/commands/CancelMLDataProcessingJobCommand.d.ts +1 -6
  9. package/dist-types/commands/CancelMLModelTrainingJobCommand.d.ts +1 -6
  10. package/dist-types/commands/CancelMLModelTransformJobCommand.d.ts +1 -6
  11. package/dist-types/commands/CancelOpenCypherQueryCommand.d.ts +2 -8
  12. package/dist-types/commands/CreateMLEndpointCommand.d.ts +1 -8
  13. package/dist-types/commands/DeleteMLEndpointCommand.d.ts +1 -7
  14. package/dist-types/commands/DeletePropertygraphStatisticsCommand.d.ts +1 -6
  15. package/dist-types/commands/DeleteSparqlStatisticsCommand.d.ts +1 -5
  16. package/dist-types/commands/ExecuteFastResetCommand.d.ts +2 -13
  17. package/dist-types/commands/ExecuteGremlinExplainQueryCommand.d.ts +5 -45
  18. package/dist-types/commands/ExecuteGremlinProfileQueryCommand.d.ts +5 -20
  19. package/dist-types/commands/ExecuteGremlinQueryCommand.d.ts +5 -39
  20. package/dist-types/commands/ExecuteOpenCypherExplainQueryCommand.d.ts +5 -19
  21. package/dist-types/commands/ExecuteOpenCypherQueryCommand.d.ts +5 -44
  22. package/dist-types/commands/GetEngineStatusCommand.d.ts +1 -5
  23. package/dist-types/commands/GetGremlinQueryStatusCommand.d.ts +2 -11
  24. package/dist-types/commands/GetLoaderJobStatusCommand.d.ts +1 -9
  25. package/dist-types/commands/GetMLDataProcessingJobCommand.d.ts +1 -6
  26. package/dist-types/commands/GetMLEndpointCommand.d.ts +1 -6
  27. package/dist-types/commands/GetMLModelTrainingJobCommand.d.ts +1 -6
  28. package/dist-types/commands/GetMLModelTransformJobCommand.d.ts +1 -6
  29. package/dist-types/commands/GetOpenCypherQueryStatusCommand.d.ts +2 -11
  30. package/dist-types/commands/GetPropertygraphStatisticsCommand.d.ts +1 -5
  31. package/dist-types/commands/GetPropertygraphStreamCommand.d.ts +3 -38
  32. package/dist-types/commands/GetPropertygraphSummaryCommand.d.ts +1 -5
  33. package/dist-types/commands/GetRDFGraphSummaryCommand.d.ts +1 -5
  34. package/dist-types/commands/GetSparqlStreamCommand.d.ts +3 -22
  35. package/dist-types/commands/ListGremlinQueriesCommand.d.ts +2 -12
  36. package/dist-types/commands/ListLoaderJobsCommand.d.ts +1 -6
  37. package/dist-types/commands/ListMLDataProcessingJobsCommand.d.ts +1 -6
  38. package/dist-types/commands/ListMLEndpointsCommand.d.ts +1 -6
  39. package/dist-types/commands/ListMLModelTrainingJobsCommand.d.ts +1 -6
  40. package/dist-types/commands/ListMLModelTransformJobsCommand.d.ts +1 -6
  41. package/dist-types/commands/ListOpenCypherQueriesCommand.d.ts +2 -12
  42. package/dist-types/commands/ManagePropertygraphStatisticsCommand.d.ts +1 -5
  43. package/dist-types/commands/ManageSparqlStatisticsCommand.d.ts +1 -5
  44. package/dist-types/commands/StartLoaderJobCommand.d.ts +2 -8
  45. package/dist-types/commands/StartMLDataProcessingJobCommand.d.ts +1 -7
  46. package/dist-types/commands/StartMLModelTrainingJobCommand.d.ts +1 -6
  47. package/dist-types/commands/StartMLModelTransformJobCommand.d.ts +1 -6
  48. package/dist-types/index.d.ts +1 -6
  49. package/dist-types/models/models_0.d.ts +189 -868
  50. package/dist-types/ts3.4/models/models_0.d.ts +13 -0
  51. package/package.json +5 -5
package/README.md CHANGED
@@ -6,13 +6,7 @@
6
6
 
7
7
  AWS SDK for JavaScript Neptunedata Client for Node.js, Browser and React Native.
8
8
 
9
- <fullname>Neptune Data API</fullname>
10
-
11
- <p>The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data
12
- operations, including data loading, query execution, data inquiry, and machine learning.
13
- It supports the Gremlin and openCypher query languages, and is
14
- available in all SDK languages. It automatically signs API requests and greatly simplifies
15
- integrating Neptune into your applications.</p>
9
+ <fullname>Neptune Data API</fullname> <p>The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data operations, including data loading, query execution, data inquiry, and machine learning. It supports the Gremlin and openCypher query languages, and is available in all SDK languages. It automatically signs API requests and greatly simplifies integrating Neptune into your applications.</p>
16
10
 
17
11
  ## Installing
18
12
 
package/dist-cjs/index.js CHANGED
@@ -1569,20 +1569,33 @@ var Parallelism = {
1569
1569
  var S3BucketRegion = {
1570
1570
  AF_SOUTH_1: "af-south-1",
1571
1571
  AP_EAST_1: "ap-east-1",
1572
+ AP_EAST_2: "ap-east-2",
1572
1573
  AP_NORTHEAST_1: "ap-northeast-1",
1573
1574
  AP_NORTHEAST_2: "ap-northeast-2",
1575
+ AP_NORTHEAST_3: "ap-northeast-3",
1574
1576
  AP_SOUTHEAST_1: "ap-southeast-1",
1575
1577
  AP_SOUTHEAST_2: "ap-southeast-2",
1578
+ AP_SOUTHEAST_3: "ap-southeast-3",
1579
+ AP_SOUTHEAST_4: "ap-southeast-4",
1580
+ AP_SOUTHEAST_5: "ap-southeast-5",
1581
+ AP_SOUTHEAST_7: "ap-southeast-7",
1576
1582
  AP_SOUTH_1: "ap-south-1",
1583
+ AP_SOUTH_2: "ap-south-2",
1577
1584
  CA_CENTRAL_1: "ca-central-1",
1585
+ CA_WEST_1: "ca-west-1",
1578
1586
  CN_NORTHWEST_1: "cn-northwest-1",
1579
1587
  CN_NORTH_1: "cn-north-1",
1580
1588
  EU_CENTRAL_1: "eu-central-1",
1589
+ EU_CENTRAL_2: "eu-central-2",
1581
1590
  EU_NORTH_1: "eu-north-1",
1591
+ EU_SOUTH_2: "eu-south-2",
1582
1592
  EU_WEST_1: "eu-west-1",
1583
1593
  EU_WEST_2: "eu-west-2",
1584
1594
  EU_WEST_3: "eu-west-3",
1595
+ IL_CENTRAL_1: "il-central-1",
1596
+ ME_CENTRAL_1: "me-central-1",
1585
1597
  ME_SOUTH_1: "me-south-1",
1598
+ MX_CENTRAL_1: "mx-central-1",
1586
1599
  SA_EAST_1: "sa-east-1",
1587
1600
  US_EAST_1: "us-east-1",
1588
1601
  US_EAST_2: "us-east-2",
@@ -671,20 +671,33 @@ export const Parallelism = {
671
671
  export const S3BucketRegion = {
672
672
  AF_SOUTH_1: "af-south-1",
673
673
  AP_EAST_1: "ap-east-1",
674
+ AP_EAST_2: "ap-east-2",
674
675
  AP_NORTHEAST_1: "ap-northeast-1",
675
676
  AP_NORTHEAST_2: "ap-northeast-2",
677
+ AP_NORTHEAST_3: "ap-northeast-3",
676
678
  AP_SOUTHEAST_1: "ap-southeast-1",
677
679
  AP_SOUTHEAST_2: "ap-southeast-2",
680
+ AP_SOUTHEAST_3: "ap-southeast-3",
681
+ AP_SOUTHEAST_4: "ap-southeast-4",
682
+ AP_SOUTHEAST_5: "ap-southeast-5",
683
+ AP_SOUTHEAST_7: "ap-southeast-7",
678
684
  AP_SOUTH_1: "ap-south-1",
685
+ AP_SOUTH_2: "ap-south-2",
679
686
  CA_CENTRAL_1: "ca-central-1",
687
+ CA_WEST_1: "ca-west-1",
680
688
  CN_NORTHWEST_1: "cn-northwest-1",
681
689
  CN_NORTH_1: "cn-north-1",
682
690
  EU_CENTRAL_1: "eu-central-1",
691
+ EU_CENTRAL_2: "eu-central-2",
683
692
  EU_NORTH_1: "eu-north-1",
693
+ EU_SOUTH_2: "eu-south-2",
684
694
  EU_WEST_1: "eu-west-1",
685
695
  EU_WEST_2: "eu-west-2",
686
696
  EU_WEST_3: "eu-west-3",
697
+ IL_CENTRAL_1: "il-central-1",
698
+ ME_CENTRAL_1: "me-central-1",
687
699
  ME_SOUTH_1: "me-south-1",
700
+ MX_CENTRAL_1: "mx-central-1",
688
701
  SA_EAST_1: "sa-east-1",
689
702
  US_EAST_1: "us-east-1",
690
703
  US_EAST_2: "us-east-2",
@@ -323,12 +323,7 @@ export interface Neptunedata {
323
323
  startMLModelTransformJob(args: StartMLModelTransformJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMLModelTransformJobCommandOutput) => void): void;
324
324
  }
325
325
  /**
326
- * <fullname>Neptune Data API</fullname>
327
- * <p>The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data
328
- * operations, including data loading, query execution, data inquiry, and machine learning.
329
- * It supports the Gremlin and openCypher query languages, and is
330
- * available in all SDK languages. It automatically signs API requests and greatly simplifies
331
- * integrating Neptune into your applications.</p>
326
+ * <fullname>Neptune Data API</fullname> <p>The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data operations, including data loading, query execution, data inquiry, and machine learning. It supports the Gremlin and openCypher query languages, and is available in all SDK languages. It automatically signs API requests and greatly simplifies integrating Neptune into your applications.</p>
332
327
  * @public
333
328
  */
334
329
  export declare class Neptunedata extends NeptunedataClient implements Neptunedata {
@@ -212,12 +212,7 @@ export type NeptunedataClientResolvedConfigType = __SmithyResolvedConfiguration<
212
212
  export interface NeptunedataClientResolvedConfig extends NeptunedataClientResolvedConfigType {
213
213
  }
214
214
  /**
215
- * <fullname>Neptune Data API</fullname>
216
- * <p>The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data
217
- * operations, including data loading, query execution, data inquiry, and machine learning.
218
- * It supports the Gremlin and openCypher query languages, and is
219
- * available in all SDK languages. It automatically signs API requests and greatly simplifies
220
- * integrating Neptune into your applications.</p>
215
+ * <fullname>Neptune Data API</fullname> <p>The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data operations, including data loading, query execution, data inquiry, and machine learning. It supports the Gremlin and openCypher query languages, and is available in all SDK languages. It automatically signs API requests and greatly simplifies integrating Neptune into your applications.</p>
221
216
  * @public
222
217
  */
223
218
  export declare class NeptunedataClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, NeptunedataClientResolvedConfig> {
@@ -27,12 +27,7 @@ declare const CancelGremlinQueryCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancels a Gremlin query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html">Gremlin
31
- * query cancellation</a> for more information.</p>
32
- * <p>When invoking this operation in a Neptune cluster that has IAM
33
- * authentication enabled, the IAM user or role making the request must
34
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery">neptune-db:CancelQuery</a>
35
- * IAM action in that cluster.</p>
30
+ * <p>Cancels a Gremlin query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html">Gremlin query cancellation</a> for more information.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery">neptune-db:CancelQuery</a> IAM action in that cluster.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -63,8 +58,7 @@ declare const CancelGremlinQueryCommand_base: {
63
58
  * <p>Raised when a request timed out in the client.</p>
64
59
  *
65
60
  * @throws {@link ConcurrentModificationException} (server fault)
66
- * <p>Raised when a request attempts to modify data that is concurrently being
67
- * modified by another process.</p>
61
+ * <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
68
62
  *
69
63
  * @throws {@link ConstraintViolationException} (client fault)
70
64
  * <p>Raised when a value in a request field did not satisfy required constraints.</p>
@@ -27,13 +27,7 @@ declare const CancelLoaderJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancels a specified load job. This is an HTTP <code>DELETE</code>
31
- * request. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune
32
- * Loader Get-Status API</a> for more information.</p>
33
- * <p>When invoking this operation in a Neptune cluster that has IAM
34
- * authentication enabled, the IAM user or role making the request must
35
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelloaderjob">neptune-db:CancelLoaderJob</a>
36
- * IAM action in that cluster..</p>
30
+ * <p>Cancels a specified load job. This is an HTTP <code>DELETE</code> request. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune Loader Get-Status API</a> for more information.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelloaderjob">neptune-db:CancelLoaderJob</a> IAM action in that cluster..</p>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -27,12 +27,7 @@ declare const CancelMLDataProcessingJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancels a Neptune ML data processing job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html">The
31
- * <code>dataprocessing</code> command</a>.</p>
32
- * <p>When invoking this operation in a Neptune cluster that has IAM
33
- * authentication enabled, the IAM user or role making the request must
34
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob">neptune-db:CancelMLDataProcessingJob</a>
35
- * IAM action in that cluster.</p>
30
+ * <p>Cancels a Neptune ML data processing job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html">The <code>dataprocessing</code> command</a>.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob">neptune-db:CancelMLDataProcessingJob</a> IAM action in that cluster.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -27,12 +27,7 @@ declare const CancelMLModelTrainingJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancels a Neptune ML model training job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html">Model
31
- * training using the <code>modeltraining</code> command</a>.</p>
32
- * <p>When invoking this operation in a Neptune cluster that has IAM
33
- * authentication enabled, the IAM user or role making the request must
34
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltrainingjob">neptune-db:CancelMLModelTrainingJob</a>
35
- * IAM action in that cluster.</p>
30
+ * <p>Cancels a Neptune ML model training job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html">Model training using the <code>modeltraining</code> command</a>.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltrainingjob">neptune-db:CancelMLModelTrainingJob</a> IAM action in that cluster.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -27,12 +27,7 @@ declare const CancelMLModelTransformJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancels a specified model transform job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use
31
- * a trained model to generate new model artifacts</a>.</p>
32
- * <p>When invoking this operation in a Neptune cluster that has IAM
33
- * authentication enabled, the IAM user or role making the request must
34
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob">neptune-db:CancelMLModelTransformJob</a>
35
- * IAM action in that cluster.</p>
30
+ * <p>Cancels a specified model transform job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use a trained model to generate new model artifacts</a>.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob">neptune-db:CancelMLModelTransformJob</a> IAM action in that cluster.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -27,12 +27,7 @@ declare const CancelOpenCypherQueryCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancels a specified openCypher query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html">Neptune
31
- * openCypher status endpoint</a> for more information.</p>
32
- * <p>When invoking this operation in a Neptune cluster that has IAM
33
- * authentication enabled, the IAM user or role making the request must
34
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery">neptune-db:CancelQuery</a>
35
- * IAM action in that cluster.</p>
30
+ * <p>Cancels a specified openCypher query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html">Neptune openCypher status endpoint</a> for more information.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery">neptune-db:CancelQuery</a> IAM action in that cluster.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -65,8 +60,7 @@ declare const CancelOpenCypherQueryCommand_base: {
65
60
  * <p>Raised when a request timed out in the client.</p>
66
61
  *
67
62
  * @throws {@link ConcurrentModificationException} (server fault)
68
- * <p>Raised when a request attempts to modify data that is concurrently being
69
- * modified by another process.</p>
63
+ * <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
70
64
  *
71
65
  * @throws {@link ConstraintViolationException} (client fault)
72
66
  * <p>Raised when a value in a request field did not satisfy required constraints.</p>
@@ -27,14 +27,7 @@ declare const CreateMLEndpointCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new Neptune ML inference endpoint that lets you query
31
- * one specific model that the model-training process constructed. See
32
- * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing
33
- * inference endpoints using the endpoints command</a>.</p>
34
- * <p>When invoking this operation in a Neptune cluster that has IAM
35
- * authentication enabled, the IAM user or role making the request must
36
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#createmlendpoint">neptune-db:CreateMLEndpoint</a>
37
- * IAM action in that cluster.</p>
30
+ * <p>Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing inference endpoints using the endpoints command</a>.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#createmlendpoint">neptune-db:CreateMLEndpoint</a> IAM action in that cluster.</p>
38
31
  * @example
39
32
  * Use a bare-bones client and the command you need to make an API call.
40
33
  * ```javascript
@@ -27,13 +27,7 @@ declare const DeleteMLEndpointCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancels the creation of a Neptune ML inference endpoint. See
31
- * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing
32
- * inference endpoints using the endpoints command</a>.</p>
33
- * <p>When invoking this operation in a Neptune cluster that has IAM
34
- * authentication enabled, the IAM user or role making the request must
35
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint">neptune-db:DeleteMLEndpoint</a>
36
- * IAM action in that cluster.</p>
30
+ * <p>Cancels the creation of a Neptune ML inference endpoint. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing inference endpoints using the endpoints command</a>.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint">neptune-db:DeleteMLEndpoint</a> IAM action in that cluster.</p>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -27,12 +27,7 @@ declare const DeletePropertygraphStatisticsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes statistics for Gremlin and openCypher (property graph)
31
- * data.</p>
32
- * <p>When invoking this operation in a Neptune cluster that has IAM
33
- * authentication enabled, the IAM user or role making the request must
34
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics">neptune-db:DeleteStatistics</a>
35
- * IAM action in that cluster.</p>
30
+ * <p>Deletes statistics for Gremlin and openCypher (property graph) data.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics">neptune-db:DeleteStatistics</a> IAM action in that cluster.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -27,11 +27,7 @@ declare const DeleteSparqlStatisticsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes SPARQL statistics</p>
31
- * <p>When invoking this operation in a Neptune cluster that has IAM
32
- * authentication enabled, the IAM user or role making the request must
33
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics">neptune-db:DeleteStatistics</a>
34
- * IAM action in that cluster.</p>
30
+ * <p>Deletes SPARQL statistics</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics">neptune-db:DeleteStatistics</a> IAM action in that cluster.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -27,17 +27,7 @@ declare const ExecuteFastResetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>The fast reset REST API lets you reset a Neptune graph quicky
31
- * and easily, removing all of its data.</p>
32
- * <p>Neptune fast reset is a two-step process. First you call <code>ExecuteFastReset</code>
33
- * with <code>action</code> set to <code>initiateDatabaseReset</code>. This returns a
34
- * UUID token which you then include when calling <code>ExecuteFastReset</code> again
35
- * with <code>action</code> set to <code>performDatabaseReset</code>. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html">Empty an Amazon Neptune
36
- * DB cluster using the fast reset API</a>.</p>
37
- * <p>When invoking this operation in a Neptune cluster that has IAM
38
- * authentication enabled, the IAM user or role making the request must
39
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase">neptune-db:ResetDatabase</a>
40
- * IAM action in that cluster.</p>
30
+ * <p>The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.</p> <p>Neptune fast reset is a two-step process. First you call <code>ExecuteFastReset</code> with <code>action</code> set to <code>initiateDatabaseReset</code>. This returns a UUID token which you then include when calling <code>ExecuteFastReset</code> again with <code>action</code> set to <code>performDatabaseReset</code>. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html">Empty an Amazon Neptune DB cluster using the fast reset API</a>.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase">neptune-db:ResetDatabase</a> IAM action in that cluster.</p>
41
31
  * @example
42
32
  * Use a bare-bones client and the command you need to make an API call.
43
33
  * ```javascript
@@ -84,8 +74,7 @@ declare const ExecuteFastResetCommand_base: {
84
74
  * <p>Raised when a parameter value is not valid.</p>
85
75
  *
86
76
  * @throws {@link MethodNotAllowedException} (client fault)
87
- * <p>Raised when the HTTP method used by a request is not supported by the endpoint
88
- * being used.</p>
77
+ * <p>Raised when the HTTP method used by a request is not supported by the endpoint being used.</p>
89
78
  *
90
79
  * @throws {@link MissingParameterException} (client fault)
91
80
  * <p>Raised when a required parameter is missing.</p>
@@ -34,43 +34,7 @@ declare const ExecuteGremlinExplainQueryCommand_base: {
34
34
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
35
35
  };
36
36
  /**
37
- * <p>Executes a Gremlin Explain query.</p>
38
- * <p>Amazon Neptune has added a Gremlin feature named <code>explain</code>
39
- * that provides is a self-service tool for understanding the execution
40
- * approach being taken by the Neptune engine for the query. You invoke
41
- * it by adding an <code>explain</code> parameter to an HTTP call that
42
- * submits a Gremlin query.</p>
43
- * <p>The explain feature provides information about the logical structure
44
- * of query execution plans. You can use this information to identify
45
- * potential evaluation and execution bottlenecks and to tune your query,
46
- * as explained in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html">Tuning
47
- * Gremlin queries</a>. You can also use query hints to improve
48
- * query execution plans.</p>
49
- * <p>When invoking this operation in a Neptune cluster that has IAM
50
- * authentication enabled, the IAM user or role making the request must
51
- * have a policy attached that allows one of the following IAM actions
52
- * in that cluster, depending on the query:</p>
53
- * <ul>
54
- * <li>
55
- * <p>
56
- * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
57
- * </p>
58
- * </li>
59
- * <li>
60
- * <p>
61
- * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a>
62
- * </p>
63
- * </li>
64
- * <li>
65
- * <p>
66
- * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a>
67
- * </p>
68
- * </li>
69
- * </ul>
70
- * <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a>
71
- * IAM condition key can be used in the policy document to restrict the use of
72
- * Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
73
- * keys available in Neptune IAM data-access policy statements</a>).</p>
37
+ * <p>Executes a Gremlin Explain query.</p> <p>Amazon Neptune has added a Gremlin feature named <code>explain</code> that provides is a self-service tool for understanding the execution approach being taken by the Neptune engine for the query. You invoke it by adding an <code>explain</code> parameter to an HTTP call that submits a Gremlin query.</p> <p>The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tune your query, as explained in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html">Tuning Gremlin queries</a>. You can also use query hints to improve query execution plans.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, 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> <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a> </p> </li> </ul> <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a> IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>).</p>
74
38
  * @example
75
39
  * Use a bare-bones client and the command you need to make an API call.
76
40
  * ```javascript
@@ -104,8 +68,7 @@ declare const ExecuteGremlinExplainQueryCommand_base: {
104
68
  * <p>Raised when a request timed out in the client.</p>
105
69
  *
106
70
  * @throws {@link ConcurrentModificationException} (server fault)
107
- * <p>Raised when a request attempts to modify data that is concurrently being
108
- * modified by another process.</p>
71
+ * <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
109
72
  *
110
73
  * @throws {@link ConstraintViolationException} (client fault)
111
74
  * <p>Raised when a value in a request field did not satisfy required constraints.</p>
@@ -123,12 +86,10 @@ declare const ExecuteGremlinExplainQueryCommand_base: {
123
86
  * <p>Raised when a parameter value is not valid.</p>
124
87
  *
125
88
  * @throws {@link MalformedQueryException} (client fault)
126
- * <p>Raised when a query is submitted that is syntactically incorrect or does not
127
- * pass additional validation.</p>
89
+ * <p>Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.</p>
128
90
  *
129
91
  * @throws {@link MemoryLimitExceededException} (server fault)
130
- * <p>Raised when a request fails because of insufficient memory resources. The
131
- * request can be retried.</p>
92
+ * <p>Raised when a request fails because of insufficient memory resources. The request can be retried.</p>
132
93
  *
133
94
  * @throws {@link MissingParameterException} (client fault)
134
95
  * <p>Raised when a required parameter is missing.</p>
@@ -140,8 +101,7 @@ declare const ExecuteGremlinExplainQueryCommand_base: {
140
101
  * <p>Raised when a precondition for processing a request is not satisfied.</p>
141
102
  *
142
103
  * @throws {@link QueryLimitExceededException} (server fault)
143
- * <p>Raised when the number of active queries exceeds what the server can process.
144
- * The query in question can be retried when the system is less busy.</p>
104
+ * <p>Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.</p>
145
105
  *
146
106
  * @throws {@link QueryLimitException} (client fault)
147
107
  * <p>Raised when the size of a query exceeds the system limit.</p>
@@ -34,18 +34,7 @@ declare const ExecuteGremlinProfileQueryCommand_base: {
34
34
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
35
35
  };
36
36
  /**
37
- * <p>Executes a Gremlin Profile query, which runs a specified traversal,
38
- * collects various metrics about the run, and produces a profile report
39
- * as output. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile
40
- * API in Neptune</a> for details.</p>
41
- * <p>When invoking this operation in a Neptune cluster that has IAM
42
- * authentication enabled, the IAM user or role making the request must
43
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
44
- * IAM action in that cluster.</p>
45
- * <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a>
46
- * IAM condition key can be used in the policy document to restrict the use of
47
- * Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
48
- * keys available in Neptune IAM data-access policy statements</a>).</p>
37
+ * <p>Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile API in Neptune</a> for details.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a> IAM action in that cluster.</p> <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a> IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>).</p>
49
38
  * @example
50
39
  * Use a bare-bones client and the command you need to make an API call.
51
40
  * ```javascript
@@ -83,8 +72,7 @@ declare const ExecuteGremlinProfileQueryCommand_base: {
83
72
  * <p>Raised when a request timed out in the client.</p>
84
73
  *
85
74
  * @throws {@link ConcurrentModificationException} (server fault)
86
- * <p>Raised when a request attempts to modify data that is concurrently being
87
- * modified by another process.</p>
75
+ * <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
88
76
  *
89
77
  * @throws {@link ConstraintViolationException} (client fault)
90
78
  * <p>Raised when a value in a request field did not satisfy required constraints.</p>
@@ -102,12 +90,10 @@ declare const ExecuteGremlinProfileQueryCommand_base: {
102
90
  * <p>Raised when a parameter value is not valid.</p>
103
91
  *
104
92
  * @throws {@link MalformedQueryException} (client fault)
105
- * <p>Raised when a query is submitted that is syntactically incorrect or does not
106
- * pass additional validation.</p>
93
+ * <p>Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.</p>
107
94
  *
108
95
  * @throws {@link MemoryLimitExceededException} (server fault)
109
- * <p>Raised when a request fails because of insufficient memory resources. The
110
- * request can be retried.</p>
96
+ * <p>Raised when a request fails because of insufficient memory resources. The request can be retried.</p>
111
97
  *
112
98
  * @throws {@link MissingParameterException} (client fault)
113
99
  * <p>Raised when a required parameter is missing.</p>
@@ -119,8 +105,7 @@ declare const ExecuteGremlinProfileQueryCommand_base: {
119
105
  * <p>Raised when a precondition for processing a request is not satisfied.</p>
120
106
  *
121
107
  * @throws {@link QueryLimitExceededException} (server fault)
122
- * <p>Raised when the number of active queries exceeds what the server can process.
123
- * The query in question can be retried when the system is less busy.</p>
108
+ * <p>Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.</p>
124
109
  *
125
110
  * @throws {@link QueryLimitException} (client fault)
126
111
  * <p>Raised when the size of a query exceeds the system limit.</p>
@@ -27,37 +27,7 @@ declare const ExecuteGremlinQueryCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>This commands executes a Gremlin query. Amazon Neptune is compatible
31
- * with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal
32
- * language to query the graph, as described under <a href="https://tinkerpop.apache.org/docs/current/reference/#graph">The
33
- * Graph</a> in the Apache TinkerPop3 documentation.
34
- * More details can also be found in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html">Accessing a
35
- * Neptune graph with Gremlin</a>.</p>
36
- * <p>When invoking this operation in a Neptune cluster that has IAM
37
- * authentication enabled, the IAM user or role making the request must
38
- * have a policy attached that enables one of the following IAM actions
39
- * in that cluster, depending on the query:</p>
40
- * <ul>
41
- * <li>
42
- * <p>
43
- * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
44
- * </p>
45
- * </li>
46
- * <li>
47
- * <p>
48
- * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a>
49
- * </p>
50
- * </li>
51
- * <li>
52
- * <p>
53
- * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a>
54
- * </p>
55
- * </li>
56
- * </ul>
57
- * <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a>
58
- * IAM condition key can be used in the policy document to restrict the use of
59
- * Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
60
- * keys available in Neptune IAM data-access policy statements</a>).</p>
30
+ * <p>This commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under <a href="https://tinkerpop.apache.org/docs/current/reference/#graph">The Graph</a> in the Apache TinkerPop3 documentation. More details can also be found in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html">Accessing a Neptune graph with Gremlin</a>.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the following IAM actions in that cluster, depending on the query:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a> </p> </li> </ul> <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a> IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>).</p>
61
31
  * @example
62
32
  * Use a bare-bones client and the command you need to make an API call.
63
33
  * ```javascript
@@ -99,8 +69,7 @@ declare const ExecuteGremlinQueryCommand_base: {
99
69
  * <p>Raised when a request timed out in the client.</p>
100
70
  *
101
71
  * @throws {@link ConcurrentModificationException} (server fault)
102
- * <p>Raised when a request attempts to modify data that is concurrently being
103
- * modified by another process.</p>
72
+ * <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
104
73
  *
105
74
  * @throws {@link ConstraintViolationException} (client fault)
106
75
  * <p>Raised when a value in a request field did not satisfy required constraints.</p>
@@ -118,12 +87,10 @@ declare const ExecuteGremlinQueryCommand_base: {
118
87
  * <p>Raised when a parameter value is not valid.</p>
119
88
  *
120
89
  * @throws {@link MalformedQueryException} (client fault)
121
- * <p>Raised when a query is submitted that is syntactically incorrect or does not
122
- * pass additional validation.</p>
90
+ * <p>Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.</p>
123
91
  *
124
92
  * @throws {@link MemoryLimitExceededException} (server fault)
125
- * <p>Raised when a request fails because of insufficient memory resources. The
126
- * request can be retried.</p>
93
+ * <p>Raised when a request fails because of insufficient memory resources. The request can be retried.</p>
127
94
  *
128
95
  * @throws {@link MissingParameterException} (client fault)
129
96
  * <p>Raised when a required parameter is missing.</p>
@@ -135,8 +102,7 @@ declare const ExecuteGremlinQueryCommand_base: {
135
102
  * <p>Raised when a precondition for processing a request is not satisfied.</p>
136
103
  *
137
104
  * @throws {@link QueryLimitExceededException} (server fault)
138
- * <p>Raised when the number of active queries exceeds what the server can process.
139
- * The query in question can be retried when the system is less busy.</p>
105
+ * <p>Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.</p>
140
106
  *
141
107
  * @throws {@link QueryLimitException} (client fault)
142
108
  * <p>Raised when the size of a query exceeds the system limit.</p>
@@ -34,17 +34,7 @@ declare const ExecuteOpenCypherExplainQueryCommand_base: {
34
34
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
35
35
  };
36
36
  /**
37
- * <p>Executes an openCypher <code>explain</code> request. See
38
- * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html">The
39
- * openCypher explain feature</a> for more information.</p>
40
- * <p>When invoking this operation in a Neptune cluster that has IAM
41
- * authentication enabled, the IAM user or role making the request must
42
- * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
43
- * IAM action in that cluster.</p>
44
- * <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:OpenCypher</a>
45
- * IAM condition key can be used in the policy document to restrict the use of
46
- * openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
47
- * keys available in Neptune IAM data-access policy statements</a>).</p>
37
+ * <p>Executes an openCypher <code>explain</code> request. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html">The openCypher explain feature</a> for more information.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a> IAM action in that cluster.</p> <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:OpenCypher</a> IAM condition key can be used in the policy document to restrict the use of openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>).</p>
48
38
  * @example
49
39
  * Use a bare-bones client and the command you need to make an API call.
50
40
  * ```javascript
@@ -80,8 +70,7 @@ declare const ExecuteOpenCypherExplainQueryCommand_base: {
80
70
  * <p>Raised when a request timed out in the client.</p>
81
71
  *
82
72
  * @throws {@link ConcurrentModificationException} (server fault)
83
- * <p>Raised when a request attempts to modify data that is concurrently being
84
- * modified by another process.</p>
73
+ * <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
85
74
  *
86
75
  * @throws {@link ConstraintViolationException} (client fault)
87
76
  * <p>Raised when a value in a request field did not satisfy required constraints.</p>
@@ -102,12 +91,10 @@ declare const ExecuteOpenCypherExplainQueryCommand_base: {
102
91
  * <p>Raised when a parameter value is not valid.</p>
103
92
  *
104
93
  * @throws {@link MalformedQueryException} (client fault)
105
- * <p>Raised when a query is submitted that is syntactically incorrect or does not
106
- * pass additional validation.</p>
94
+ * <p>Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.</p>
107
95
  *
108
96
  * @throws {@link MemoryLimitExceededException} (server fault)
109
- * <p>Raised when a request fails because of insufficient memory resources. The
110
- * request can be retried.</p>
97
+ * <p>Raised when a request fails because of insufficient memory resources. The request can be retried.</p>
111
98
  *
112
99
  * @throws {@link MissingParameterException} (client fault)
113
100
  * <p>Raised when a required parameter is missing.</p>
@@ -119,8 +106,7 @@ declare const ExecuteOpenCypherExplainQueryCommand_base: {
119
106
  * <p>Raised when a precondition for processing a request is not satisfied.</p>
120
107
  *
121
108
  * @throws {@link QueryLimitExceededException} (server fault)
122
- * <p>Raised when the number of active queries exceeds what the server can process.
123
- * The query in question can be retried when the system is less busy.</p>
109
+ * <p>Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.</p>
124
110
  *
125
111
  * @throws {@link QueryLimitException} (client fault)
126
112
  * <p>Raised when the size of a query exceeds the system limit.</p>