@aws-sdk/client-neptunedata 3.431.0 → 3.433.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 (46) hide show
  1. package/dist-cjs/endpoint/ruleset.js +3 -3
  2. package/dist-es/endpoint/ruleset.js +3 -3
  3. package/dist-types/commands/CancelGremlinQueryCommand.d.ts +4 -0
  4. package/dist-types/commands/CancelLoaderJobCommand.d.ts +5 -2
  5. package/dist-types/commands/CancelMLDataProcessingJobCommand.d.ts +4 -0
  6. package/dist-types/commands/CancelMLModelTrainingJobCommand.d.ts +4 -0
  7. package/dist-types/commands/CancelMLModelTransformJobCommand.d.ts +4 -0
  8. package/dist-types/commands/CancelOpenCypherQueryCommand.d.ts +4 -0
  9. package/dist-types/commands/CreateMLEndpointCommand.d.ts +4 -0
  10. package/dist-types/commands/DeleteMLEndpointCommand.d.ts +4 -0
  11. package/dist-types/commands/DeletePropertygraphStatisticsCommand.d.ts +4 -0
  12. package/dist-types/commands/DeleteSparqlStatisticsCommand.d.ts +4 -0
  13. package/dist-types/commands/ExecuteFastResetCommand.d.ts +4 -0
  14. package/dist-types/commands/ExecuteGremlinExplainQueryCommand.d.ts +25 -0
  15. package/dist-types/commands/ExecuteGremlinProfileQueryCommand.d.ts +8 -0
  16. package/dist-types/commands/ExecuteGremlinQueryCommand.d.ts +25 -0
  17. package/dist-types/commands/ExecuteOpenCypherExplainQueryCommand.d.ts +8 -0
  18. package/dist-types/commands/ExecuteOpenCypherQueryCommand.d.ts +25 -0
  19. package/dist-types/commands/GetEngineStatusCommand.d.ts +5 -1
  20. package/dist-types/commands/GetGremlinQueryStatusCommand.d.ts +8 -0
  21. package/dist-types/commands/GetLoaderJobStatusCommand.d.ts +4 -0
  22. package/dist-types/commands/GetMLDataProcessingJobCommand.d.ts +4 -0
  23. package/dist-types/commands/GetMLEndpointCommand.d.ts +4 -0
  24. package/dist-types/commands/GetMLModelTrainingJobCommand.d.ts +4 -0
  25. package/dist-types/commands/GetMLModelTransformJobCommand.d.ts +4 -0
  26. package/dist-types/commands/GetOpenCypherQueryStatusCommand.d.ts +8 -0
  27. package/dist-types/commands/GetPropertygraphStatisticsCommand.d.ts +4 -0
  28. package/dist-types/commands/GetPropertygraphStreamCommand.d.ts +25 -1
  29. package/dist-types/commands/GetPropertygraphSummaryCommand.d.ts +4 -0
  30. package/dist-types/commands/GetRDFGraphSummaryCommand.d.ts +4 -0
  31. package/dist-types/commands/GetSparqlStreamCommand.d.ts +8 -0
  32. package/dist-types/commands/ListGremlinQueriesCommand.d.ts +8 -0
  33. package/dist-types/commands/ListLoaderJobsCommand.d.ts +4 -0
  34. package/dist-types/commands/ListMLDataProcessingJobsCommand.d.ts +4 -0
  35. package/dist-types/commands/ListMLEndpointsCommand.d.ts +4 -0
  36. package/dist-types/commands/ListMLModelTrainingJobsCommand.d.ts +4 -0
  37. package/dist-types/commands/ListMLModelTransformJobsCommand.d.ts +4 -0
  38. package/dist-types/commands/ListOpenCypherQueriesCommand.d.ts +8 -0
  39. package/dist-types/commands/ManagePropertygraphStatisticsCommand.d.ts +4 -0
  40. package/dist-types/commands/ManageSparqlStatisticsCommand.d.ts +4 -0
  41. package/dist-types/commands/StartLoaderJobCommand.d.ts +4 -0
  42. package/dist-types/commands/StartMLDataProcessingJobCommand.d.ts +4 -0
  43. package/dist-types/commands/StartMLModelTrainingJobCommand.d.ts +4 -0
  44. package/dist-types/commands/StartMLModelTransformJobCommand.d.ts +4 -0
  45. package/dist-types/models/models_0.d.ts +7 -3
  46. package/package.json +32 -32
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ruleSet = void 0;
4
- const q = "required", r = "fn", s = "argv", t = "ref";
5
- const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
6
- const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://neptune-db-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://neptune-db-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://neptune-db.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://neptune-db.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
4
+ const s = "required", t = "fn", u = "argv", v = "ref";
5
+ const a = true, b = "isSet", c = "booleanEquals", d = "error", e = "endpoint", f = "tree", g = "PartitionResult", h = { [s]: false, "type": "String" }, i = { [s]: true, "default": false, "type": "Boolean" }, j = { [v]: "Endpoint" }, k = { [t]: c, [u]: [{ [v]: "UseFIPS" }, true] }, l = { [t]: c, [u]: [{ [v]: "UseDualStack" }, true] }, m = {}, n = { [t]: "getAttr", [u]: [{ [v]: g }, "supportsFIPS"] }, o = { [t]: c, [u]: [true, { [t]: "getAttr", [u]: [{ [v]: g }, "supportsDualStack"] }] }, p = [k], q = [l], r = [{ [v]: "Region" }];
6
+ const _data = { version: "1.0", parameters: { Region: h, UseDualStack: i, UseFIPS: i, Endpoint: h }, rules: [{ conditions: [{ [t]: b, [u]: [j] }], rules: [{ conditions: p, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: d }, { rules: [{ conditions: q, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: d }, { endpoint: { url: j, properties: m, headers: m }, type: e }], type: f }], type: f }, { rules: [{ conditions: [{ [t]: b, [u]: r }], rules: [{ conditions: [{ [t]: "aws.partition", [u]: r, assign: g }], rules: [{ conditions: [k, l], rules: [{ conditions: [{ [t]: c, [u]: [a, n] }, o], rules: [{ rules: [{ endpoint: { url: "https://neptune-db-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: d }], type: f }, { conditions: p, rules: [{ conditions: [{ [t]: c, [u]: [n, a] }], rules: [{ rules: [{ endpoint: { url: "https://neptune-db-fips.{Region}.{PartitionResult#dnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }, { error: "FIPS is enabled but this partition does not support FIPS", type: d }], type: f }, { conditions: q, rules: [{ conditions: [o], rules: [{ rules: [{ endpoint: { url: "https://neptune-db.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }, { error: "DualStack is enabled but this partition does not support DualStack", type: d }], type: f }, { rules: [{ endpoint: { url: "https://neptune-db.{Region}.{PartitionResult#dnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }], type: f }, { error: "Invalid Configuration: Missing Region", type: d }], type: f }] };
7
7
  exports.ruleSet = _data;
@@ -1,4 +1,4 @@
1
- const q = "required", r = "fn", s = "argv", t = "ref";
2
- const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
3
- const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://neptune-db-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://neptune-db-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://neptune-db.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://neptune-db.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
1
+ const s = "required", t = "fn", u = "argv", v = "ref";
2
+ const a = true, b = "isSet", c = "booleanEquals", d = "error", e = "endpoint", f = "tree", g = "PartitionResult", h = { [s]: false, "type": "String" }, i = { [s]: true, "default": false, "type": "Boolean" }, j = { [v]: "Endpoint" }, k = { [t]: c, [u]: [{ [v]: "UseFIPS" }, true] }, l = { [t]: c, [u]: [{ [v]: "UseDualStack" }, true] }, m = {}, n = { [t]: "getAttr", [u]: [{ [v]: g }, "supportsFIPS"] }, o = { [t]: c, [u]: [true, { [t]: "getAttr", [u]: [{ [v]: g }, "supportsDualStack"] }] }, p = [k], q = [l], r = [{ [v]: "Region" }];
3
+ const _data = { version: "1.0", parameters: { Region: h, UseDualStack: i, UseFIPS: i, Endpoint: h }, rules: [{ conditions: [{ [t]: b, [u]: [j] }], rules: [{ conditions: p, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: d }, { rules: [{ conditions: q, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: d }, { endpoint: { url: j, properties: m, headers: m }, type: e }], type: f }], type: f }, { rules: [{ conditions: [{ [t]: b, [u]: r }], rules: [{ conditions: [{ [t]: "aws.partition", [u]: r, assign: g }], rules: [{ conditions: [k, l], rules: [{ conditions: [{ [t]: c, [u]: [a, n] }, o], rules: [{ rules: [{ endpoint: { url: "https://neptune-db-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: d }], type: f }, { conditions: p, rules: [{ conditions: [{ [t]: c, [u]: [n, a] }], rules: [{ rules: [{ endpoint: { url: "https://neptune-db-fips.{Region}.{PartitionResult#dnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }, { error: "FIPS is enabled but this partition does not support FIPS", type: d }], type: f }, { conditions: q, rules: [{ conditions: [o], rules: [{ rules: [{ endpoint: { url: "https://neptune-db.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }, { error: "DualStack is enabled but this partition does not support DualStack", type: d }], type: f }, { rules: [{ endpoint: { url: "https://neptune-db.{Region}.{PartitionResult#dnsSuffix}", properties: m, headers: m }, type: e }], type: f }], type: f }], type: f }, { error: "Invalid Configuration: Missing Region", type: d }], type: f }] };
4
4
  export const ruleSet = _data;
@@ -25,6 +25,10 @@ export interface CancelGremlinQueryCommandOutput extends CancelGremlinQueryOutpu
25
25
  * @public
26
26
  * <p>Cancels a Gremlin query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html">Gremlin
27
27
  * query cancellation</a> for more information.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * 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>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -24,9 +24,12 @@ export interface CancelLoaderJobCommandOutput extends CancelLoaderJobOutput, __M
24
24
  /**
25
25
  * @public
26
26
  * <p>Cancels a specified load job. This is an HTTP <code>DELETE</code>
27
- * request.</p>
28
- * <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune
27
+ * request. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune
29
28
  * Loader Get-Status API</a> for more information.</p>
29
+ * <p>When invoking this operation in a Neptune cluster that has IAM
30
+ * authentication enabled, the IAM user or role making the request must
31
+ * 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>
32
+ * IAM action in that cluster..</p>
30
33
  * @example
31
34
  * Use a bare-bones client and the command you need to make an API call.
32
35
  * ```javascript
@@ -25,6 +25,10 @@ export interface CancelMLDataProcessingJobCommandOutput extends CancelMLDataProc
25
25
  * @public
26
26
  * <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
27
27
  * <code>dataprocessing</code> command</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * 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>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface CancelMLModelTrainingJobCommandOutput extends CancelMLModelTrai
25
25
  * @public
26
26
  * <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
27
27
  * training using the <code>modeltraining</code> command</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * 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>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface CancelMLModelTransformJobCommandOutput extends CancelMLModelTra
25
25
  * @public
26
26
  * <p>Cancels a specified model transform job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use
27
27
  * a trained model to generate new model artifacts</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * 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>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface CancelOpenCypherQueryCommandOutput extends CancelOpenCypherQuer
25
25
  * @public
26
26
  * <p>Cancels a specified openCypher query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html">Neptune
27
27
  * openCypher status endpoint</a> for more information.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * 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>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -27,6 +27,10 @@ export interface CreateMLEndpointCommandOutput extends CreateMLEndpointOutput, _
27
27
  * one specific model that the model-training process constructed. See
28
28
  * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing
29
29
  * inference endpoints using the endpoints command</a>.</p>
30
+ * <p>When invoking this operation in a Neptune cluster that has IAM
31
+ * authentication enabled, the IAM user or role making the request must
32
+ * 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>
33
+ * IAM action in that cluster.</p>
30
34
  * @example
31
35
  * Use a bare-bones client and the command you need to make an API call.
32
36
  * ```javascript
@@ -26,6 +26,10 @@ export interface DeleteMLEndpointCommandOutput extends DeleteMLEndpointOutput, _
26
26
  * <p>Cancels the creation of a Neptune ML inference endpoint. See
27
27
  * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing
28
28
  * inference endpoints using the endpoints command</a>.</p>
29
+ * <p>When invoking this operation in a Neptune cluster that has IAM
30
+ * authentication enabled, the IAM user or role making the request must
31
+ * 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>
32
+ * IAM action in that cluster.</p>
29
33
  * @example
30
34
  * Use a bare-bones client and the command you need to make an API call.
31
35
  * ```javascript
@@ -25,6 +25,10 @@ export interface DeletePropertygraphStatisticsCommandOutput extends DeleteProper
25
25
  * @public
26
26
  * <p>Deletes statistics for Gremlin and openCypher (property graph)
27
27
  * data.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * 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>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -24,6 +24,10 @@ export interface DeleteSparqlStatisticsCommandOutput extends DeleteSparqlStatist
24
24
  /**
25
25
  * @public
26
26
  * <p>Deletes SPARQL statistics</p>
27
+ * <p>When invoking this operation in a Neptune cluster that has IAM
28
+ * authentication enabled, the IAM user or role making the request must
29
+ * 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>
30
+ * IAM action in that cluster.</p>
27
31
  * @example
28
32
  * Use a bare-bones client and the command you need to make an API call.
29
33
  * ```javascript
@@ -30,6 +30,10 @@ export interface ExecuteFastResetCommandOutput extends ExecuteFastResetOutput, _
30
30
  * UUID token which you then include when calling <code>ExecuteFastReset</code> again
31
31
  * 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
32
32
  * DB cluster using the fast reset API</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#resetdatabase">neptune-db:ResetDatabase</a>
36
+ * IAM action in that cluster.</p>
33
37
  * @example
34
38
  * Use a bare-bones client and the command you need to make an API call.
35
39
  * ```javascript
@@ -42,6 +42,31 @@ export interface ExecuteGremlinExplainQueryCommandOutput extends ExecuteGremlinE
42
42
  * as explained in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html">Tuning
43
43
  * Gremlin queries</a>. You can also use query hints to improve
44
44
  * query execution plans.</p>
45
+ * <p>When invoking this operation in a Neptune cluster that has IAM
46
+ * authentication enabled, the IAM user or role making the request must
47
+ * have a policy attached that allows one of the following IAM actions
48
+ * in that cluster, depending on the query:</p>
49
+ * <ul>
50
+ * <li>
51
+ * <p>
52
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
53
+ * </p>
54
+ * </li>
55
+ * <li>
56
+ * <p>
57
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a>
58
+ * </p>
59
+ * </li>
60
+ * <li>
61
+ * <p>
62
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a>
63
+ * </p>
64
+ * </li>
65
+ * </ul>
66
+ * <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>
67
+ * IAM condition key can be used in the policy document to restrict the use of
68
+ * Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
69
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
45
70
  * @example
46
71
  * Use a bare-bones client and the command you need to make an API call.
47
72
  * ```javascript
@@ -34,6 +34,14 @@ export interface ExecuteGremlinProfileQueryCommandOutput extends ExecuteGremlinP
34
34
  * collects various metrics about the run, and produces a profile report
35
35
  * as output. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile
36
36
  * API in Neptune</a> for details.</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#readdataviaquery">neptune-db:ReadDataViaQuery</a>
40
+ * IAM action in that cluster.</p>
41
+ * <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>
42
+ * IAM condition key can be used in the policy document to restrict the use of
43
+ * Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
44
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
37
45
  * @example
38
46
  * Use a bare-bones client and the command you need to make an API call.
39
47
  * ```javascript
@@ -29,6 +29,31 @@ export interface ExecuteGremlinQueryCommandOutput extends ExecuteGremlinQueryOut
29
29
  * Graph</a> in the Apache TinkerPop3 documentation.
30
30
  * More details can also be found in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html">Accessing a
31
31
  * Neptune graph with Gremlin</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 enables one of the following IAM actions
35
+ * in that cluster, depending on the query:</p>
36
+ * <ul>
37
+ * <li>
38
+ * <p>
39
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
40
+ * </p>
41
+ * </li>
42
+ * <li>
43
+ * <p>
44
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a>
45
+ * </p>
46
+ * </li>
47
+ * <li>
48
+ * <p>
49
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a>
50
+ * </p>
51
+ * </li>
52
+ * </ul>
53
+ * <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>
54
+ * IAM condition key can be used in the policy document to restrict the use of
55
+ * Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
56
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
32
57
  * @example
33
58
  * Use a bare-bones client and the command you need to make an API call.
34
59
  * ```javascript
@@ -33,6 +33,14 @@ export interface ExecuteOpenCypherExplainQueryCommandOutput extends ExecuteOpenC
33
33
  * <p>Executes an openCypher <code>explain</code> request. See
34
34
  * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html">The
35
35
  * openCypher explain feature</a> for more information.</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 allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
39
+ * IAM action in that cluster.</p>
40
+ * <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>
41
+ * IAM condition key can be used in the policy document to restrict the use of
42
+ * openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
43
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
36
44
  * @example
37
45
  * Use a bare-bones client and the command you need to make an API call.
38
46
  * ```javascript
@@ -34,6 +34,31 @@ export interface ExecuteOpenCypherQueryCommandOutput extends ExecuteOpenCypherQu
34
34
  * <p>The openCypher language was originally developed by Neo4j, then
35
35
  * open-sourced in 2015 and contributed to the <a href="https://opencypher.org/">openCypher project</a> under an Apache
36
36
  * 2 open-source license.</p>
37
+ * <p>Note that 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 one of the following IAM actions
40
+ * in that cluster, depending on the query:</p>
41
+ * <ul>
42
+ * <li>
43
+ * <p>
44
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
45
+ * </p>
46
+ * </li>
47
+ * <li>
48
+ * <p>
49
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a>
50
+ * </p>
51
+ * </li>
52
+ * <li>
53
+ * <p>
54
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a>
55
+ * </p>
56
+ * </li>
57
+ * </ul>
58
+ * <p>Note also 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>
59
+ * IAM condition key can be used in the policy document to restrict the use of
60
+ * openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
61
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
37
62
  * @example
38
63
  * Use a bare-bones client and the command you need to make an API call.
39
64
  * ```javascript
@@ -23,7 +23,11 @@ export interface GetEngineStatusCommandOutput extends GetEngineStatusOutput, __M
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Check the status of the graph database on the host.</p>
26
+ * <p>Retrieves the status of the graph database on the host.</p>
27
+ * <p>When invoking this operation in a Neptune cluster that has IAM
28
+ * authentication enabled, the IAM user or role making the request must
29
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus">neptune-db:GetEngineStatus</a>
30
+ * IAM action in that cluster.</p>
27
31
  * @example
28
32
  * Use a bare-bones client and the command you need to make an API call.
29
33
  * ```javascript
@@ -24,6 +24,14 @@ export interface GetGremlinQueryStatusCommandOutput extends GetGremlinQueryStatu
24
24
  /**
25
25
  * @public
26
26
  * <p>Gets the status of a specified Gremlin query.</p>
27
+ * <p>When invoking this operation in a Neptune cluster that has IAM
28
+ * authentication enabled, the IAM user or role making the request must
29
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus">neptune-db:GetQueryStatus</a>
30
+ * IAM action in that cluster.</p>
31
+ * <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>
32
+ * IAM condition key can be used in the policy document to restrict the use of
33
+ * Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
34
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
27
35
  * @example
28
36
  * Use a bare-bones client and the command you need to make an API call.
29
37
  * ```javascript
@@ -28,6 +28,10 @@ export interface GetLoaderJobStatusCommandOutput extends GetLoaderJobStatusOutpu
28
28
  * and stores the last 10,000 error details per job.</p>
29
29
  * <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune
30
30
  * Loader Get-Status API</a> for more information.</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#getloaderjobstatus">neptune-db:GetLoaderJobStatus</a>
34
+ * IAM action in that cluster..</p>
31
35
  * @example
32
36
  * Use a bare-bones client and the command you need to make an API call.
33
37
  * ```javascript
@@ -25,6 +25,10 @@ export interface GetMLDataProcessingJobCommandOutput extends GetMLDataProcessing
25
25
  * @public
26
26
  * <p>Retrieves information about a specified data processing job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html">The
27
27
  * <code>dataprocessing</code> command</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmldataprocessingjobstatus">neptune-db:neptune-db:GetMLDataProcessingJobStatus</a>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface GetMLEndpointCommandOutput extends GetMLEndpointOutput, __Metad
25
25
  * @public
26
26
  * <p>Retrieves details about an inference endpoint. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing
27
27
  * inference endpoints using the endpoints command</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlendpointstatus">neptune-db:GetMLEndpointStatus</a>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface GetMLModelTrainingJobCommandOutput extends GetMLModelTrainingJo
25
25
  * @public
26
26
  * <p>Retrieves information about a Neptune ML model training job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html">Model
27
27
  * training using the <code>modeltraining</code> command</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltrainingjobstatus">neptune-db:GetMLModelTrainingJobStatus</a>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface GetMLModelTransformJobCommandOutput extends GetMLModelTransform
25
25
  * @public
26
26
  * <p>Gets information about a specified model transform job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use
27
27
  * a trained model to generate new model artifacts</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltransformjobstatus">neptune-db:GetMLModelTransformJobStatus</a>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -24,6 +24,14 @@ export interface GetOpenCypherQueryStatusCommandOutput extends GetOpenCypherQuer
24
24
  /**
25
25
  * @public
26
26
  * <p>Retrieves the status of a specified openCypher query.</p>
27
+ * <p>When invoking this operation in a Neptune cluster that has IAM
28
+ * authentication enabled, the IAM user or role making the request must
29
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus">neptune-db:GetQueryStatus</a>
30
+ * IAM action in that cluster.</p>
31
+ * <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>
32
+ * IAM condition key can be used in the policy document to restrict the use of
33
+ * openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
34
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
27
35
  * @example
28
36
  * Use a bare-bones client and the command you need to make an API call.
29
37
  * ```javascript
@@ -24,6 +24,10 @@ export interface GetPropertygraphStatisticsCommandOutput extends GetPropertygrap
24
24
  /**
25
25
  * @public
26
26
  * <p>Gets property graph statistics (Gremlin and openCypher).</p>
27
+ * <p>When invoking this operation in a Neptune cluster that has IAM
28
+ * authentication enabled, the IAM user or role making the request must
29
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus">neptune-db:GetStatisticsStatus</a>
30
+ * IAM action in that cluster.</p>
27
31
  * @example
28
32
  * Use a bare-bones client and the command you need to make an API call.
29
33
  * ```javascript
@@ -32,7 +32,31 @@ export interface GetPropertygraphStreamCommandOutput extends GetPropertygraphStr
32
32
  * DBcluster. To enable streams, set the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams">neptune_streams</a>
33
33
  * DB cluster parameter to <code>1</code>.</p>
34
34
  * <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams.html">Capturing
35
- * graph changes in real time using Neptune streams</a>.</p>
35
+ * graph changes in real time using Neptune streams</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 allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords">neptune-db:GetStreamRecords</a>
39
+ * IAM action in that cluster.</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 enables one of the following IAM actions,
43
+ * depending on the query:</p>
44
+ * <p>Note that you can restrict property-graph queries using the
45
+ * following IAM context keys:</p>
46
+ * <ul>
47
+ * <li>
48
+ * <p>
49
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a>
50
+ * </p>
51
+ * </li>
52
+ * <li>
53
+ * <p>
54
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Opencypher</a>
55
+ * </p>
56
+ * </li>
57
+ * </ul>
58
+ * <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
59
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
36
60
  * @example
37
61
  * Use a bare-bones client and the command you need to make an API call.
38
62
  * ```javascript
@@ -24,6 +24,10 @@ export interface GetPropertygraphSummaryCommandOutput extends GetPropertygraphSu
24
24
  /**
25
25
  * @public
26
26
  * <p>Gets a graph summary for a property graph.</p>
27
+ * <p>When invoking this operation in a Neptune cluster that has IAM
28
+ * authentication enabled, the IAM user or role making the request must
29
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary">neptune-db:GetGraphSummary</a>
30
+ * IAM action in that cluster.</p>
27
31
  * @example
28
32
  * Use a bare-bones client and the command you need to make an API call.
29
33
  * ```javascript
@@ -24,6 +24,10 @@ export interface GetRDFGraphSummaryCommandOutput extends GetRDFGraphSummaryOutpu
24
24
  /**
25
25
  * @public
26
26
  * <p>Gets a graph summary for an RDF graph.</p>
27
+ * <p>When invoking this operation in a Neptune cluster that has IAM
28
+ * authentication enabled, the IAM user or role making the request must
29
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary">neptune-db:GetGraphSummary</a>
30
+ * IAM action in that cluster.</p>
27
31
  * @example
28
32
  * Use a bare-bones client and the command you need to make an API call.
29
33
  * ```javascript
@@ -33,6 +33,14 @@ export interface GetSparqlStreamCommandOutput extends GetSparqlStreamOutput, __M
33
33
  * DB cluster parameter to <code>1</code>.</p>
34
34
  * <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams.html">Capturing
35
35
  * graph changes in real time using Neptune streams</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 allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords">neptune-db:GetStreamRecords</a>
39
+ * IAM action in that cluster.</p>
40
+ * <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:Sparql</a>
41
+ * IAM condition key can be used in the policy document to restrict the use of
42
+ * SPARQL queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
43
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
36
44
  * @example
37
45
  * Use a bare-bones client and the command you need to make an API call.
38
46
  * ```javascript
@@ -25,6 +25,14 @@ export interface ListGremlinQueriesCommandOutput extends ListGremlinQueriesOutpu
25
25
  * @public
26
26
  * <p>Lists active Gremlin queries. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html">Gremlin query
27
27
  * status API</a> for details about the output.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus">neptune-db:GetQueryStatus</a>
31
+ * IAM action in that cluster.</p>
32
+ * <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>
33
+ * IAM condition key can be used in the policy document to restrict the use of
34
+ * Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
35
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
28
36
  * @example
29
37
  * Use a bare-bones client and the command you need to make an API call.
30
38
  * ```javascript
@@ -25,6 +25,10 @@ export interface ListLoaderJobsCommandOutput extends ListLoaderJobsOutput, __Met
25
25
  * @public
26
26
  * <p>Retrieves a list of the <code>loadIds</code> for all active
27
27
  * loader jobs.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listloaderjobs">neptune-db:ListLoaderJobs</a>
31
+ * IAM action in that cluster..</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface ListMLDataProcessingJobsCommandOutput extends ListMLDataProcess
25
25
  * @public
26
26
  * <p>Returns a list of Neptune ML data processing jobs. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html#machine-learning-api-dataprocessing-list-jobs">Listing
27
27
  * active data-processing jobs using the Neptune ML dataprocessing command</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmldataprocessingjobs">neptune-db:ListMLDataProcessingJobs</a>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface ListMLEndpointsCommandOutput extends ListMLEndpointsOutput, __M
25
25
  * @public
26
26
  * <p>Lists existing inference endpoints. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing
27
27
  * inference endpoints using the endpoints command</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlendpoints">neptune-db:ListMLEndpoints</a>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface ListMLModelTrainingJobsCommandOutput extends ListMLModelTrainin
25
25
  * @public
26
26
  * <p>Lists Neptune ML model-training jobs. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html">Model
27
27
  * training using the <code>modeltraining</code> command</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#neptune-db:listmlmodeltrainingjobs">neptune-db:neptune-db:ListMLModelTrainingJobs</a>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface ListMLModelTransformJobsCommandOutput extends ListMLModelTransf
25
25
  * @public
26
26
  * <p>Returns a list of model transform job IDs. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use
27
27
  * a trained model to generate new model artifacts</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlmodeltransformjobs">neptune-db:ListMLModelTransformJobs</a>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,14 @@ export interface ListOpenCypherQueriesCommandOutput extends ListOpenCypherQuerie
25
25
  * @public
26
26
  * <p>Lists active openCypher queries. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html">Neptune
27
27
  * openCypher status endpoint</a> for more information.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus">neptune-db:GetQueryStatus</a>
31
+ * IAM action in that cluster.</p>
32
+ * <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>
33
+ * IAM condition key can be used in the policy document to restrict the use of
34
+ * openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
35
+ * keys available in Neptune IAM data-access policy statements</a>).</p>
28
36
  * @example
29
37
  * Use a bare-bones client and the command you need to make an API call.
30
38
  * ```javascript
@@ -24,6 +24,10 @@ export interface ManagePropertygraphStatisticsCommandOutput extends ManageProper
24
24
  /**
25
25
  * @public
26
26
  * <p>Manages the generation and use of property graph statistics.</p>
27
+ * <p>When invoking this operation in a Neptune cluster that has IAM
28
+ * authentication enabled, the IAM user or role making the request must
29
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics">neptune-db:ManageStatistics</a>
30
+ * IAM action in that cluster.</p>
27
31
  * @example
28
32
  * Use a bare-bones client and the command you need to make an API call.
29
33
  * ```javascript
@@ -24,6 +24,10 @@ export interface ManageSparqlStatisticsCommandOutput extends ManageSparqlStatist
24
24
  /**
25
25
  * @public
26
26
  * <p>Manages the generation and use of RDF graph statistics.</p>
27
+ * <p>When invoking this operation in a Neptune cluster that has IAM
28
+ * authentication enabled, the IAM user or role making the request must
29
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics">neptune-db:ManageStatistics</a>
30
+ * IAM action in that cluster.</p>
27
31
  * @example
28
32
  * Use a bare-bones client and the command you need to make an API call.
29
33
  * ```javascript
@@ -26,6 +26,10 @@ export interface StartLoaderJobCommandOutput extends StartLoaderJobOutput, __Met
26
26
  * <p>Starts a Neptune bulk loader job to load data from an Amazon S3
27
27
  * bucket into a Neptune DB instance. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load.html">Using the Amazon Neptune
28
28
  * Bulk Loader to Ingest Data</a>.</p>
29
+ * <p>When invoking this operation in a Neptune cluster that has IAM
30
+ * authentication enabled, the IAM user or role making the request must
31
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startloaderjob">neptune-db:StartLoaderJob</a>
32
+ * IAM action in that cluster.</p>
29
33
  * @example
30
34
  * Use a bare-bones client and the command you need to make an API call.
31
35
  * ```javascript
@@ -26,6 +26,10 @@ export interface StartMLDataProcessingJobCommandOutput extends StartMLDataProces
26
26
  * <p>Creates a new Neptune ML data processing job for processing the
27
27
  * graph data exported from Neptune for training. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html">The
28
28
  * <code>dataprocessing</code> command</a>.</p>
29
+ * <p>When invoking this operation in a Neptune cluster that has IAM
30
+ * authentication enabled, the IAM user or role making the request must
31
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeldataprocessingjob">neptune-db:StartMLModelDataProcessingJob</a>
32
+ * IAM action in that cluster.</p>
29
33
  * @example
30
34
  * Use a bare-bones client and the command you need to make an API call.
31
35
  * ```javascript
@@ -25,6 +25,10 @@ export interface StartMLModelTrainingJobCommandOutput extends StartMLModelTraini
25
25
  * @public
26
26
  * <p>Creates a new Neptune ML model training job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html">Model
27
27
  * training using the <code>modeltraining</code> command</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltrainingjob">neptune-db:StartMLModelTrainingJob</a>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -25,6 +25,10 @@ export interface StartMLModelTransformJobCommandOutput extends StartMLModelTrans
25
25
  * @public
26
26
  * <p>Creates a new model transform job. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use
27
27
  * a trained model to generate new model artifacts</a>.</p>
28
+ * <p>When invoking this operation in a Neptune cluster that has IAM
29
+ * authentication enabled, the IAM user or role making the request must
30
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltransformjob">neptune-db:StartMLModelTransformJob</a>
31
+ * IAM action in that cluster.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -2030,7 +2030,7 @@ export interface GetPropertygraphStatisticsOutput {
2030
2030
  /**
2031
2031
  * @public
2032
2032
  * <p>The HTTP return code of the request. If the request succeeded,
2033
- * the code is 200. See <a href="docs.aws.amazon.comneptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors">Common
2033
+ * the code is 200. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors">Common
2034
2034
  * error codes for DFE statistics request</a> for a list of common errors.</p>
2035
2035
  */
2036
2036
  status: string | undefined;
@@ -2624,7 +2624,7 @@ export interface RDFGraphSummaryValueMap {
2624
2624
  lastStatisticsComputationTime?: Date;
2625
2625
  /**
2626
2626
  * @public
2627
- * <p>The graph summary of an RDF graph. See <a href="https://docs.aws.amazon.com/neptune-graph-summary.html#neptune-graph-summary-rdf-response">Graph
2627
+ * <p>The graph summary of an RDF graph. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-rdf-response">Graph
2628
2628
  * summary response for an RDF graph</a>.</p>
2629
2629
  */
2630
2630
  graphSummary?: RDFGraphSummary;
@@ -2652,8 +2652,12 @@ export interface GetSparqlStatisticsOutput {
2652
2652
  /**
2653
2653
  * @public
2654
2654
  * <p>The HTTP return code of the request. If the request succeeded,
2655
- * the code is 200. See <a href="docs.aws.amazon.comneptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors">Common
2655
+ * the code is 200. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors">Common
2656
2656
  * error codes for DFE statistics request</a> for a list of common errors.</p>
2657
+ * <p>When invoking this operation in a Neptune cluster that has IAM
2658
+ * authentication enabled, the IAM user or role making the request must
2659
+ * have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus">neptune-db:GetStatisticsStatus</a>
2660
+ * IAM action in that cluster.</p>
2657
2661
  */
2658
2662
  status: string | undefined;
2659
2663
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-neptunedata",
3
3
  "description": "AWS SDK for JavaScript Neptunedata Client for Node.js, Browser and React Native",
4
- "version": "3.431.0",
4
+ "version": "3.433.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,40 +21,40 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.431.0",
25
- "@aws-sdk/credential-provider-node": "3.431.0",
26
- "@aws-sdk/middleware-host-header": "3.431.0",
27
- "@aws-sdk/middleware-logger": "3.428.0",
28
- "@aws-sdk/middleware-recursion-detection": "3.428.0",
29
- "@aws-sdk/middleware-signing": "3.428.0",
30
- "@aws-sdk/middleware-user-agent": "3.428.0",
31
- "@aws-sdk/region-config-resolver": "3.430.0",
32
- "@aws-sdk/types": "3.428.0",
33
- "@aws-sdk/util-endpoints": "3.428.0",
34
- "@aws-sdk/util-user-agent-browser": "3.428.0",
35
- "@aws-sdk/util-user-agent-node": "3.430.0",
36
- "@smithy/config-resolver": "^2.0.15",
37
- "@smithy/fetch-http-handler": "^2.2.3",
38
- "@smithy/hash-node": "^2.0.11",
39
- "@smithy/invalid-dependency": "^2.0.11",
40
- "@smithy/middleware-content-length": "^2.0.13",
41
- "@smithy/middleware-endpoint": "^2.1.2",
42
- "@smithy/middleware-retry": "^2.0.17",
43
- "@smithy/middleware-serde": "^2.0.11",
44
- "@smithy/middleware-stack": "^2.0.5",
45
- "@smithy/node-config-provider": "^2.1.2",
46
- "@smithy/node-http-handler": "^2.1.7",
47
- "@smithy/protocol-http": "^3.0.7",
48
- "@smithy/smithy-client": "^2.1.11",
49
- "@smithy/types": "^2.3.5",
50
- "@smithy/url-parser": "^2.0.11",
24
+ "@aws-sdk/client-sts": "3.433.0",
25
+ "@aws-sdk/credential-provider-node": "3.433.0",
26
+ "@aws-sdk/middleware-host-header": "3.433.0",
27
+ "@aws-sdk/middleware-logger": "3.433.0",
28
+ "@aws-sdk/middleware-recursion-detection": "3.433.0",
29
+ "@aws-sdk/middleware-signing": "3.433.0",
30
+ "@aws-sdk/middleware-user-agent": "3.433.0",
31
+ "@aws-sdk/region-config-resolver": "3.433.0",
32
+ "@aws-sdk/types": "3.433.0",
33
+ "@aws-sdk/util-endpoints": "3.433.0",
34
+ "@aws-sdk/util-user-agent-browser": "3.433.0",
35
+ "@aws-sdk/util-user-agent-node": "3.433.0",
36
+ "@smithy/config-resolver": "^2.0.16",
37
+ "@smithy/fetch-http-handler": "^2.2.4",
38
+ "@smithy/hash-node": "^2.0.12",
39
+ "@smithy/invalid-dependency": "^2.0.12",
40
+ "@smithy/middleware-content-length": "^2.0.14",
41
+ "@smithy/middleware-endpoint": "^2.1.3",
42
+ "@smithy/middleware-retry": "^2.0.18",
43
+ "@smithy/middleware-serde": "^2.0.12",
44
+ "@smithy/middleware-stack": "^2.0.6",
45
+ "@smithy/node-config-provider": "^2.1.3",
46
+ "@smithy/node-http-handler": "^2.1.8",
47
+ "@smithy/protocol-http": "^3.0.8",
48
+ "@smithy/smithy-client": "^2.1.12",
49
+ "@smithy/types": "^2.4.0",
50
+ "@smithy/url-parser": "^2.0.12",
51
51
  "@smithy/util-base64": "^2.0.0",
52
52
  "@smithy/util-body-length-browser": "^2.0.0",
53
53
  "@smithy/util-body-length-node": "^2.1.0",
54
- "@smithy/util-defaults-mode-browser": "^2.0.15",
55
- "@smithy/util-defaults-mode-node": "^2.0.20",
56
- "@smithy/util-retry": "^2.0.4",
57
- "@smithy/util-stream": "^2.0.16",
54
+ "@smithy/util-defaults-mode-browser": "^2.0.16",
55
+ "@smithy/util-defaults-mode-node": "^2.0.21",
56
+ "@smithy/util-retry": "^2.0.5",
57
+ "@smithy/util-stream": "^2.0.17",
58
58
  "@smithy/util-utf8": "^2.0.0",
59
59
  "tslib": "^2.5.0"
60
60
  },