@aws-sdk/client-neptunedata 3.848.0 → 3.851.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.
- package/README.md +1 -7
- package/dist-cjs/index.js +13 -0
- package/dist-es/models/models_0.js +13 -0
- package/dist-types/Neptunedata.d.ts +1 -6
- package/dist-types/NeptunedataClient.d.ts +1 -6
- package/dist-types/commands/CancelGremlinQueryCommand.d.ts +2 -8
- package/dist-types/commands/CancelLoaderJobCommand.d.ts +1 -7
- package/dist-types/commands/CancelMLDataProcessingJobCommand.d.ts +1 -6
- package/dist-types/commands/CancelMLModelTrainingJobCommand.d.ts +1 -6
- package/dist-types/commands/CancelMLModelTransformJobCommand.d.ts +1 -6
- package/dist-types/commands/CancelOpenCypherQueryCommand.d.ts +2 -8
- package/dist-types/commands/CreateMLEndpointCommand.d.ts +1 -8
- package/dist-types/commands/DeleteMLEndpointCommand.d.ts +1 -7
- package/dist-types/commands/DeletePropertygraphStatisticsCommand.d.ts +1 -6
- package/dist-types/commands/DeleteSparqlStatisticsCommand.d.ts +1 -5
- package/dist-types/commands/ExecuteFastResetCommand.d.ts +2 -13
- package/dist-types/commands/ExecuteGremlinExplainQueryCommand.d.ts +5 -45
- package/dist-types/commands/ExecuteGremlinProfileQueryCommand.d.ts +5 -20
- package/dist-types/commands/ExecuteGremlinQueryCommand.d.ts +5 -39
- package/dist-types/commands/ExecuteOpenCypherExplainQueryCommand.d.ts +5 -19
- package/dist-types/commands/ExecuteOpenCypherQueryCommand.d.ts +5 -44
- package/dist-types/commands/GetEngineStatusCommand.d.ts +1 -5
- package/dist-types/commands/GetGremlinQueryStatusCommand.d.ts +2 -11
- package/dist-types/commands/GetLoaderJobStatusCommand.d.ts +1 -9
- package/dist-types/commands/GetMLDataProcessingJobCommand.d.ts +1 -6
- package/dist-types/commands/GetMLEndpointCommand.d.ts +1 -6
- package/dist-types/commands/GetMLModelTrainingJobCommand.d.ts +1 -6
- package/dist-types/commands/GetMLModelTransformJobCommand.d.ts +1 -6
- package/dist-types/commands/GetOpenCypherQueryStatusCommand.d.ts +2 -11
- package/dist-types/commands/GetPropertygraphStatisticsCommand.d.ts +1 -5
- package/dist-types/commands/GetPropertygraphStreamCommand.d.ts +3 -38
- package/dist-types/commands/GetPropertygraphSummaryCommand.d.ts +1 -5
- package/dist-types/commands/GetRDFGraphSummaryCommand.d.ts +1 -5
- package/dist-types/commands/GetSparqlStreamCommand.d.ts +3 -22
- package/dist-types/commands/ListGremlinQueriesCommand.d.ts +2 -12
- package/dist-types/commands/ListLoaderJobsCommand.d.ts +1 -6
- package/dist-types/commands/ListMLDataProcessingJobsCommand.d.ts +1 -6
- package/dist-types/commands/ListMLEndpointsCommand.d.ts +1 -6
- package/dist-types/commands/ListMLModelTrainingJobsCommand.d.ts +1 -6
- package/dist-types/commands/ListMLModelTransformJobsCommand.d.ts +1 -6
- package/dist-types/commands/ListOpenCypherQueriesCommand.d.ts +2 -12
- package/dist-types/commands/ManagePropertygraphStatisticsCommand.d.ts +1 -5
- package/dist-types/commands/ManageSparqlStatisticsCommand.d.ts +1 -5
- package/dist-types/commands/StartLoaderJobCommand.d.ts +2 -8
- package/dist-types/commands/StartMLDataProcessingJobCommand.d.ts +1 -7
- package/dist-types/commands/StartMLModelTrainingJobCommand.d.ts +1 -6
- package/dist-types/commands/StartMLModelTransformJobCommand.d.ts +1 -6
- package/dist-types/index.d.ts +1 -6
- package/dist-types/models/models_0.d.ts +189 -868
- package/dist-types/ts3.4/models/models_0.d.ts +13 -0
- package/package.json +1 -1
|
@@ -27,42 +27,7 @@ declare const ExecuteOpenCypherQueryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Executes an openCypher query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html">Accessing
|
|
31
|
-
* the Neptune Graph with openCypher</a> for more information.</p>
|
|
32
|
-
* <p>Neptune supports building graph applications using openCypher,
|
|
33
|
-
* which is currently one of the most popular query languages among
|
|
34
|
-
* developers working with graph databases. Developers, business analysts,
|
|
35
|
-
* and data scientists like openCypher's declarative, SQL-inspired syntax
|
|
36
|
-
* because it provides a familiar structure in which to querying property
|
|
37
|
-
* graphs.</p>
|
|
38
|
-
* <p>The openCypher language was originally developed by Neo4j, then
|
|
39
|
-
* open-sourced in 2015 and contributed to the <a href="https://opencypher.org/">openCypher project</a> under an Apache
|
|
40
|
-
* 2 open-source license.</p>
|
|
41
|
-
* <p>Note that 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 one of the following IAM actions
|
|
44
|
-
* in that cluster, depending on the query:</p>
|
|
45
|
-
* <ul>
|
|
46
|
-
* <li>
|
|
47
|
-
* <p>
|
|
48
|
-
* <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery">neptune-db:ReadDataViaQuery</a>
|
|
49
|
-
* </p>
|
|
50
|
-
* </li>
|
|
51
|
-
* <li>
|
|
52
|
-
* <p>
|
|
53
|
-
* <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery">neptune-db:WriteDataViaQuery</a>
|
|
54
|
-
* </p>
|
|
55
|
-
* </li>
|
|
56
|
-
* <li>
|
|
57
|
-
* <p>
|
|
58
|
-
* <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery">neptune-db:DeleteDataViaQuery</a>
|
|
59
|
-
* </p>
|
|
60
|
-
* </li>
|
|
61
|
-
* </ul>
|
|
62
|
-
* <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>
|
|
63
|
-
* IAM condition key can be used in the policy document to restrict the use of
|
|
64
|
-
* openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
|
|
65
|
-
* keys available in Neptune IAM data-access policy statements</a>).</p>
|
|
30
|
+
* <p>Executes an openCypher query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html">Accessing the Neptune Graph with openCypher</a> for more information.</p> <p>Neptune supports building graph applications using openCypher, which is currently one of the most popular query languages among developers working with graph databases. Developers, business analysts, and data scientists like openCypher's declarative, SQL-inspired syntax because it provides a familiar structure in which to querying property graphs.</p> <p>The openCypher language was originally developed by Neo4j, then open-sourced in 2015 and contributed to the <a href="https://opencypher.org/">openCypher project</a> under an Apache 2 open-source license.</p> <p>Note that 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 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> 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>
|
|
66
31
|
* @example
|
|
67
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
68
33
|
* ```javascript
|
|
@@ -97,8 +62,7 @@ declare const ExecuteOpenCypherQueryCommand_base: {
|
|
|
97
62
|
* <p>Raised when a request timed out in the client.</p>
|
|
98
63
|
*
|
|
99
64
|
* @throws {@link ConcurrentModificationException} (server fault)
|
|
100
|
-
* <p>Raised when a request attempts to modify data that is concurrently being
|
|
101
|
-
* modified by another process.</p>
|
|
65
|
+
* <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
|
|
102
66
|
*
|
|
103
67
|
* @throws {@link ConstraintViolationException} (client fault)
|
|
104
68
|
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
@@ -119,12 +83,10 @@ declare const ExecuteOpenCypherQueryCommand_base: {
|
|
|
119
83
|
* <p>Raised when a parameter value is not valid.</p>
|
|
120
84
|
*
|
|
121
85
|
* @throws {@link MalformedQueryException} (client fault)
|
|
122
|
-
* <p>Raised when a query is submitted that is syntactically incorrect or does not
|
|
123
|
-
* pass additional validation.</p>
|
|
86
|
+
* <p>Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.</p>
|
|
124
87
|
*
|
|
125
88
|
* @throws {@link MemoryLimitExceededException} (server fault)
|
|
126
|
-
* <p>Raised when a request fails because of insufficient memory resources. The
|
|
127
|
-
* request can be retried.</p>
|
|
89
|
+
* <p>Raised when a request fails because of insufficient memory resources. The request can be retried.</p>
|
|
128
90
|
*
|
|
129
91
|
* @throws {@link MissingParameterException} (client fault)
|
|
130
92
|
* <p>Raised when a required parameter is missing.</p>
|
|
@@ -136,8 +98,7 @@ declare const ExecuteOpenCypherQueryCommand_base: {
|
|
|
136
98
|
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
137
99
|
*
|
|
138
100
|
* @throws {@link QueryLimitExceededException} (server fault)
|
|
139
|
-
* <p>Raised when the number of active queries exceeds what the server can process.
|
|
140
|
-
* The query in question can be retried when the system is less busy.</p>
|
|
101
|
+
* <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>
|
|
141
102
|
*
|
|
142
103
|
* @throws {@link QueryLimitException} (client fault)
|
|
143
104
|
* <p>Raised when the size of a query exceeds the system limit.</p>
|
|
@@ -27,11 +27,7 @@ declare const GetEngineStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the status of the graph database on the host.</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#getenginestatus">neptune-db:GetEngineStatus</a>
|
|
34
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <p>Retrieves the status of the graph database on the host.</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#getenginestatus">neptune-db:GetEngineStatus</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,15 +27,7 @@ declare const GetGremlinQueryStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets the status of a specified Gremlin query.</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#getquerystatus">neptune-db:GetQueryStatus</a>
|
|
34
|
-
* IAM action in that cluster.</p>
|
|
35
|
-
* <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>
|
|
36
|
-
* IAM condition key can be used in the policy document to restrict the use of
|
|
37
|
-
* Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
|
|
38
|
-
* keys available in Neptune IAM data-access policy statements</a>).</p>
|
|
30
|
+
* <p>Gets the status of a specified Gremlin query.</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#getquerystatus">neptune-db:GetQueryStatus</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>
|
|
39
31
|
* @example
|
|
40
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
33
|
* ```javascript
|
|
@@ -76,8 +68,7 @@ declare const GetGremlinQueryStatusCommand_base: {
|
|
|
76
68
|
* <p>Raised when a request timed out in the client.</p>
|
|
77
69
|
*
|
|
78
70
|
* @throws {@link ConcurrentModificationException} (server fault)
|
|
79
|
-
* <p>Raised when a request attempts to modify data that is concurrently being
|
|
80
|
-
* modified by another process.</p>
|
|
71
|
+
* <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
|
|
81
72
|
*
|
|
82
73
|
* @throws {@link ConstraintViolationException} (client fault)
|
|
83
74
|
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
@@ -27,15 +27,7 @@ declare const GetLoaderJobStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets status information about a specified load job.
|
|
31
|
-
* Neptune keeps track of the most recent 1,024 bulk load jobs,
|
|
32
|
-
* and stores the last 10,000 error details per job.</p>
|
|
33
|
-
* <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm">Neptune
|
|
34
|
-
* Loader Get-Status API</a> for more information.</p>
|
|
35
|
-
* <p>When invoking this operation in a Neptune cluster that has IAM
|
|
36
|
-
* authentication enabled, the IAM user or role making the request must
|
|
37
|
-
* 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>
|
|
38
|
-
* IAM action in that cluster..</p>
|
|
30
|
+
* <p>Gets status information about a specified load job. Neptune keeps track of the most recent 1,024 bulk load jobs, and stores the last 10,000 error details per job.</p> <p>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#getloaderjobstatus">neptune-db:GetLoaderJobStatus</a> IAM action in that cluster..</p>
|
|
39
31
|
* @example
|
|
40
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
33
|
* ```javascript
|
|
@@ -27,12 +27,7 @@ declare const GetMLDataProcessingJobCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <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
|
|
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#getmldataprocessingjobstatus">neptune-db:neptune-db:GetMLDataProcessingJobStatus</a>
|
|
35
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <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 <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#getmldataprocessingjobstatus">neptune-db:neptune-db:GetMLDataProcessingJobStatus</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 GetMLEndpointCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves details about an inference endpoint. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing
|
|
31
|
-
* inference endpoints using the endpoints 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#getmlendpointstatus">neptune-db:GetMLEndpointStatus</a>
|
|
35
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <p>Retrieves details about an 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#getmlendpointstatus">neptune-db:GetMLEndpointStatus</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 GetMLModelTrainingJobCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <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
|
|
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#getmlmodeltrainingjobstatus">neptune-db:GetMLModelTrainingJobStatus</a>
|
|
35
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <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 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#getmlmodeltrainingjobstatus">neptune-db:GetMLModelTrainingJobStatus</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 GetMLModelTransformJobCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <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
|
|
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#getmlmodeltransformjobstatus">neptune-db:GetMLModelTransformJobStatus</a>
|
|
35
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <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 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#getmlmodeltransformjobstatus">neptune-db:GetMLModelTransformJobStatus</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,15 +27,7 @@ declare const GetOpenCypherQueryStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the status of a specified openCypher query.</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#getquerystatus">neptune-db:GetQueryStatus</a>
|
|
34
|
-
* IAM action in that cluster.</p>
|
|
35
|
-
* <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>
|
|
36
|
-
* IAM condition key can be used in the policy document to restrict the use of
|
|
37
|
-
* openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
|
|
38
|
-
* keys available in Neptune IAM data-access policy statements</a>).</p>
|
|
30
|
+
* <p>Retrieves the status of a specified openCypher query.</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#getquerystatus">neptune-db:GetQueryStatus</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>
|
|
39
31
|
* @example
|
|
40
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
33
|
* ```javascript
|
|
@@ -76,8 +68,7 @@ declare const GetOpenCypherQueryStatusCommand_base: {
|
|
|
76
68
|
* <p>Raised when a request timed out in the client.</p>
|
|
77
69
|
*
|
|
78
70
|
* @throws {@link ConcurrentModificationException} (server fault)
|
|
79
|
-
* <p>Raised when a request attempts to modify data that is concurrently being
|
|
80
|
-
* modified by another process.</p>
|
|
71
|
+
* <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
|
|
81
72
|
*
|
|
82
73
|
* @throws {@link ConstraintViolationException} (client fault)
|
|
83
74
|
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
@@ -27,11 +27,7 @@ declare const GetPropertygraphStatisticsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets property graph statistics (Gremlin and openCypher).</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#getstatisticsstatus">neptune-db:GetStatisticsStatus</a>
|
|
34
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <p>Gets property graph statistics (Gremlin and openCypher).</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#getstatisticsstatus">neptune-db:GetStatisticsStatus</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,40 +27,7 @@ declare const GetPropertygraphStreamCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets a stream for a property graph.</p>
|
|
31
|
-
* <p>With the Neptune Streams feature, you can generate a complete
|
|
32
|
-
* sequence of change-log entries that record every change made to your
|
|
33
|
-
* graph data as it happens. <code>GetPropertygraphStream</code> lets
|
|
34
|
-
* you collect these change-log entries for a property graph.</p>
|
|
35
|
-
* <p>The Neptune streams feature needs to be enabled on your Neptune
|
|
36
|
-
* 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>
|
|
37
|
-
* DB cluster parameter to <code>1</code>.</p>
|
|
38
|
-
* <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams.html">Capturing
|
|
39
|
-
* graph changes in real time using Neptune streams</a>.</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#getstreamrecords">neptune-db:GetStreamRecords</a>
|
|
43
|
-
* IAM action in that cluster.</p>
|
|
44
|
-
* <p>When invoking this operation in a Neptune cluster that has IAM
|
|
45
|
-
* authentication enabled, the IAM user or role making the request must
|
|
46
|
-
* have a policy attached that enables one of the following IAM actions,
|
|
47
|
-
* depending on the query:</p>
|
|
48
|
-
* <p>Note that you can restrict property-graph queries using the
|
|
49
|
-
* following IAM context keys:</p>
|
|
50
|
-
* <ul>
|
|
51
|
-
* <li>
|
|
52
|
-
* <p>
|
|
53
|
-
* <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
|
-
* </p>
|
|
55
|
-
* </li>
|
|
56
|
-
* <li>
|
|
57
|
-
* <p>
|
|
58
|
-
* <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
|
-
* </p>
|
|
60
|
-
* </li>
|
|
61
|
-
* </ul>
|
|
62
|
-
* <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
|
|
63
|
-
* keys available in Neptune IAM data-access policy statements</a>).</p>
|
|
30
|
+
* <p>Gets a stream for a property graph.</p> <p>With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. <code>GetPropertygraphStream</code> lets you collect these change-log entries for a property graph.</p> <p>The Neptune streams feature needs to be enabled on your Neptune 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> DB cluster parameter to <code>1</code>.</p> <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams.html">Capturing graph changes in real time using Neptune streams</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#getstreamrecords">neptune-db:GetStreamRecords</a> IAM action in that cluster.</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, depending on the query:</p> <p>Note that you can restrict property-graph queries using the following IAM context keys:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:Gremlin</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:OpenCypher</a> </p> </li> </ul> <p>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>
|
|
64
31
|
* @example
|
|
65
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
66
33
|
* ```javascript
|
|
@@ -130,8 +97,7 @@ declare const GetPropertygraphStreamCommand_base: {
|
|
|
130
97
|
* <p>Raised when a parameter value is not valid.</p>
|
|
131
98
|
*
|
|
132
99
|
* @throws {@link MemoryLimitExceededException} (server fault)
|
|
133
|
-
* <p>Raised when a request fails because of insufficient memory resources. The
|
|
134
|
-
* request can be retried.</p>
|
|
100
|
+
* <p>Raised when a request fails because of insufficient memory resources. The request can be retried.</p>
|
|
135
101
|
*
|
|
136
102
|
* @throws {@link PreconditionsFailedException} (client fault)
|
|
137
103
|
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
@@ -140,8 +106,7 @@ declare const GetPropertygraphStreamCommand_base: {
|
|
|
140
106
|
* <p>Raised when stream records requested by a query cannot be found.</p>
|
|
141
107
|
*
|
|
142
108
|
* @throws {@link ThrottlingException} (server fault)
|
|
143
|
-
* <p>Raised when the rate of requests exceeds the maximum throughput. Requests can
|
|
144
|
-
* be retried after encountering this exception.</p>
|
|
109
|
+
* <p>Raised when the rate of requests exceeds the maximum throughput. Requests can be retried after encountering this exception.</p>
|
|
145
110
|
*
|
|
146
111
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
147
112
|
* <p>Raised when the number of requests being processed exceeds the limit.</p>
|
|
@@ -27,11 +27,7 @@ declare const GetPropertygraphSummaryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets a graph summary for a property graph.</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#getgraphsummary">neptune-db:GetGraphSummary</a>
|
|
34
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <p>Gets a graph summary for a property graph.</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#getgraphsummary">neptune-db:GetGraphSummary</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,11 +27,7 @@ declare const GetRDFGraphSummaryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets a graph summary for an RDF graph.</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#getgraphsummary">neptune-db:GetGraphSummary</a>
|
|
34
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <p>Gets a graph summary for an RDF graph.</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#getgraphsummary">neptune-db:GetGraphSummary</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,24 +27,7 @@ declare const GetSparqlStreamCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Gets a stream for an RDF graph.</p>
|
|
31
|
-
* <p>With the Neptune Streams feature, you can generate a complete
|
|
32
|
-
* sequence of change-log entries that record every change made to your
|
|
33
|
-
* graph data as it happens. <code>GetSparqlStream</code> lets
|
|
34
|
-
* you collect these change-log entries for an RDF graph.</p>
|
|
35
|
-
* <p>The Neptune streams feature needs to be enabled on your Neptune
|
|
36
|
-
* 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>
|
|
37
|
-
* DB cluster parameter to <code>1</code>.</p>
|
|
38
|
-
* <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams.html">Capturing
|
|
39
|
-
* graph changes in real time using Neptune streams</a>.</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#getstreamrecords">neptune-db:GetStreamRecords</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:Sparql</a>
|
|
45
|
-
* IAM condition key can be used in the policy document to restrict the use of
|
|
46
|
-
* SPARQL 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>
|
|
30
|
+
* <p>Gets a stream for an RDF graph.</p> <p>With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. <code>GetSparqlStream</code> lets you collect these change-log entries for an RDF graph.</p> <p>The Neptune streams feature needs to be enabled on your Neptune 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> DB cluster parameter to <code>1</code>.</p> <p>See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams.html">Capturing graph changes in real time using Neptune streams</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#getstreamrecords">neptune-db:GetStreamRecords</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:Sparql</a> IAM condition key can be used in the policy document to restrict the use of SPARQL 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
31
|
* @example
|
|
49
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
50
33
|
* ```javascript
|
|
@@ -109,8 +92,7 @@ declare const GetSparqlStreamCommand_base: {
|
|
|
109
92
|
* <p>Raised when a parameter value is not valid.</p>
|
|
110
93
|
*
|
|
111
94
|
* @throws {@link MemoryLimitExceededException} (server fault)
|
|
112
|
-
* <p>Raised when a request fails because of insufficient memory resources. The
|
|
113
|
-
* request can be retried.</p>
|
|
95
|
+
* <p>Raised when a request fails because of insufficient memory resources. The request can be retried.</p>
|
|
114
96
|
*
|
|
115
97
|
* @throws {@link PreconditionsFailedException} (client fault)
|
|
116
98
|
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
@@ -119,8 +101,7 @@ declare const GetSparqlStreamCommand_base: {
|
|
|
119
101
|
* <p>Raised when stream records requested by a query cannot be found.</p>
|
|
120
102
|
*
|
|
121
103
|
* @throws {@link ThrottlingException} (server fault)
|
|
122
|
-
* <p>Raised when the rate of requests exceeds the maximum throughput. Requests can
|
|
123
|
-
* be retried after encountering this exception.</p>
|
|
104
|
+
* <p>Raised when the rate of requests exceeds the maximum throughput. Requests can be retried after encountering this exception.</p>
|
|
124
105
|
*
|
|
125
106
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
126
107
|
* <p>Raised when the number of requests being processed exceeds the limit.</p>
|
|
@@ -27,16 +27,7 @@ declare const ListGremlinQueriesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists active Gremlin queries. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html">Gremlin query
|
|
31
|
-
* status API</a> for details about the output.</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#getquerystatus">neptune-db:GetQueryStatus</a>
|
|
35
|
-
* IAM action in that cluster.</p>
|
|
36
|
-
* <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>
|
|
37
|
-
* IAM condition key can be used in the policy document to restrict the use of
|
|
38
|
-
* Gremlin queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
|
|
39
|
-
* keys available in Neptune IAM data-access policy statements</a>).</p>
|
|
30
|
+
* <p>Lists active Gremlin queries. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html">Gremlin query status API</a> for details about the output.</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#getquerystatus">neptune-db:GetQueryStatus</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>
|
|
40
31
|
* @example
|
|
41
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
33
|
* ```javascript
|
|
@@ -83,8 +74,7 @@ declare const ListGremlinQueriesCommand_base: {
|
|
|
83
74
|
* <p>Raised when a request timed out in the client.</p>
|
|
84
75
|
*
|
|
85
76
|
* @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>
|
|
77
|
+
* <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
|
|
88
78
|
*
|
|
89
79
|
* @throws {@link ConstraintViolationException} (client fault)
|
|
90
80
|
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
@@ -27,12 +27,7 @@ declare const ListLoaderJobsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves a list of the <code>loadIds</code> for all active
|
|
31
|
-
* loader jobs.</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#listloaderjobs">neptune-db:ListLoaderJobs</a>
|
|
35
|
-
* IAM action in that cluster..</p>
|
|
30
|
+
* <p>Retrieves a list of the <code>loadIds</code> for all active loader jobs.</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#listloaderjobs">neptune-db:ListLoaderJobs</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 ListMLDataProcessingJobsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <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
|
|
31
|
-
* active data-processing jobs using the Neptune ML dataprocessing 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#listmldataprocessingjobs">neptune-db:ListMLDataProcessingJobs</a>
|
|
35
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <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 active data-processing jobs using the Neptune ML dataprocessing 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#listmldataprocessingjobs">neptune-db:ListMLDataProcessingJobs</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 ListMLEndpointsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists existing inference endpoints. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html">Managing
|
|
31
|
-
* inference endpoints using the endpoints 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#listmlendpoints">neptune-db:ListMLEndpoints</a>
|
|
35
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <p>Lists existing inference endpoints. 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#listmlendpoints">neptune-db:ListMLEndpoints</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 ListMLModelTrainingJobsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists Neptune ML model-training jobs. 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#neptune-db:listmlmodeltrainingjobs">neptune-db:neptune-db:ListMLModelTrainingJobs</a>
|
|
35
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <p>Lists Neptune ML model-training jobs. 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#neptune-db:listmlmodeltrainingjobs">neptune-db:neptune-db:ListMLModelTrainingJobs</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 ListMLModelTransformJobsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <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
|
|
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#listmlmodeltransformjobs">neptune-db:ListMLModelTransformJobs</a>
|
|
35
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <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 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#listmlmodeltransformjobs">neptune-db:ListMLModelTransformJobs</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,16 +27,7 @@ declare const ListOpenCypherQueriesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists active openCypher queries. 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#getquerystatus">neptune-db:GetQueryStatus</a>
|
|
35
|
-
* IAM action in that cluster.</p>
|
|
36
|
-
* <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>
|
|
37
|
-
* IAM condition key can be used in the policy document to restrict the use of
|
|
38
|
-
* openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition
|
|
39
|
-
* keys available in Neptune IAM data-access policy statements</a>).</p>
|
|
30
|
+
* <p>Lists active openCypher queries. 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#getquerystatus">neptune-db:GetQueryStatus</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>
|
|
40
31
|
* @example
|
|
41
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
33
|
* ```javascript
|
|
@@ -83,8 +74,7 @@ declare const ListOpenCypherQueriesCommand_base: {
|
|
|
83
74
|
* <p>Raised when a request timed out in the client.</p>
|
|
84
75
|
*
|
|
85
76
|
* @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>
|
|
77
|
+
* <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
|
|
88
78
|
*
|
|
89
79
|
* @throws {@link ConstraintViolationException} (client fault)
|
|
90
80
|
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
@@ -27,11 +27,7 @@ declare const ManagePropertygraphStatisticsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Manages the generation and use of property graph 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#managestatistics">neptune-db:ManageStatistics</a>
|
|
34
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <p>Manages the generation and use of property graph 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#managestatistics">neptune-db:ManageStatistics</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,11 +27,7 @@ declare const ManageSparqlStatisticsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Manages the generation and use of RDF graph 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#managestatistics">neptune-db:ManageStatistics</a>
|
|
34
|
-
* IAM action in that cluster.</p>
|
|
30
|
+
* <p>Manages the generation and use of RDF graph 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#managestatistics">neptune-db:ManageStatistics</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
|