@aws-sdk/client-neptunedata 3.403.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/LICENSE +201 -0
- package/README.md +555 -0
- package/dist-cjs/Neptunedata.js +97 -0
- package/dist-cjs/NeptunedataClient.js +43 -0
- package/dist-cjs/commands/CancelGremlinQueryCommand.js +46 -0
- package/dist-cjs/commands/CancelLoaderJobCommand.js +46 -0
- package/dist-cjs/commands/CancelMLDataProcessingJobCommand.js +46 -0
- package/dist-cjs/commands/CancelMLModelTrainingJobCommand.js +46 -0
- package/dist-cjs/commands/CancelMLModelTransformJobCommand.js +46 -0
- package/dist-cjs/commands/CancelOpenCypherQueryCommand.js +46 -0
- package/dist-cjs/commands/CreateMLEndpointCommand.js +46 -0
- package/dist-cjs/commands/DeleteMLEndpointCommand.js +46 -0
- package/dist-cjs/commands/DeletePropertygraphStatisticsCommand.js +46 -0
- package/dist-cjs/commands/DeleteSparqlStatisticsCommand.js +46 -0
- package/dist-cjs/commands/ExecuteFastResetCommand.js +46 -0
- package/dist-cjs/commands/ExecuteGremlinExplainQueryCommand.js +46 -0
- package/dist-cjs/commands/ExecuteGremlinProfileQueryCommand.js +46 -0
- package/dist-cjs/commands/ExecuteGremlinQueryCommand.js +46 -0
- package/dist-cjs/commands/ExecuteOpenCypherExplainQueryCommand.js +46 -0
- package/dist-cjs/commands/ExecuteOpenCypherQueryCommand.js +46 -0
- package/dist-cjs/commands/GetEngineStatusCommand.js +46 -0
- package/dist-cjs/commands/GetGremlinQueryStatusCommand.js +46 -0
- package/dist-cjs/commands/GetLoaderJobStatusCommand.js +46 -0
- package/dist-cjs/commands/GetMLDataProcessingJobCommand.js +46 -0
- package/dist-cjs/commands/GetMLEndpointCommand.js +46 -0
- package/dist-cjs/commands/GetMLModelTrainingJobCommand.js +46 -0
- package/dist-cjs/commands/GetMLModelTransformJobCommand.js +46 -0
- package/dist-cjs/commands/GetOpenCypherQueryStatusCommand.js +46 -0
- package/dist-cjs/commands/GetPropertygraphStatisticsCommand.js +46 -0
- package/dist-cjs/commands/GetPropertygraphStreamCommand.js +46 -0
- package/dist-cjs/commands/GetPropertygraphSummaryCommand.js +46 -0
- package/dist-cjs/commands/GetRDFGraphSummaryCommand.js +46 -0
- package/dist-cjs/commands/GetSparqlStatisticsCommand.js +46 -0
- package/dist-cjs/commands/GetSparqlStreamCommand.js +46 -0
- package/dist-cjs/commands/ListGremlinQueriesCommand.js +46 -0
- package/dist-cjs/commands/ListLoaderJobsCommand.js +46 -0
- package/dist-cjs/commands/ListMLDataProcessingJobsCommand.js +46 -0
- package/dist-cjs/commands/ListMLEndpointsCommand.js +46 -0
- package/dist-cjs/commands/ListMLModelTrainingJobsCommand.js +46 -0
- package/dist-cjs/commands/ListMLModelTransformJobsCommand.js +46 -0
- package/dist-cjs/commands/ListOpenCypherQueriesCommand.js +46 -0
- package/dist-cjs/commands/ManagePropertygraphStatisticsCommand.js +46 -0
- package/dist-cjs/commands/ManageSparqlStatisticsCommand.js +46 -0
- package/dist-cjs/commands/StartLoaderJobCommand.js +46 -0
- package/dist-cjs/commands/StartMLDataProcessingJobCommand.js +46 -0
- package/dist-cjs/commands/StartMLModelTrainingJobCommand.js +46 -0
- package/dist-cjs/commands/StartMLModelTransformJobCommand.js +46 -0
- package/dist-cjs/commands/index.js +46 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +10 -0
- package/dist-cjs/models/NeptunedataServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +631 -0
- package/dist-cjs/protocols/Aws_restJson1.js +4771 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +48 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +22 -0
- package/dist-cjs/runtimeExtensions.js +16 -0
- package/dist-es/Neptunedata.js +93 -0
- package/dist-es/NeptunedataClient.js +39 -0
- package/dist-es/commands/CancelGremlinQueryCommand.js +42 -0
- package/dist-es/commands/CancelLoaderJobCommand.js +42 -0
- package/dist-es/commands/CancelMLDataProcessingJobCommand.js +42 -0
- package/dist-es/commands/CancelMLModelTrainingJobCommand.js +42 -0
- package/dist-es/commands/CancelMLModelTransformJobCommand.js +42 -0
- package/dist-es/commands/CancelOpenCypherQueryCommand.js +42 -0
- package/dist-es/commands/CreateMLEndpointCommand.js +42 -0
- package/dist-es/commands/DeleteMLEndpointCommand.js +42 -0
- package/dist-es/commands/DeletePropertygraphStatisticsCommand.js +42 -0
- package/dist-es/commands/DeleteSparqlStatisticsCommand.js +42 -0
- package/dist-es/commands/ExecuteFastResetCommand.js +42 -0
- package/dist-es/commands/ExecuteGremlinExplainQueryCommand.js +42 -0
- package/dist-es/commands/ExecuteGremlinProfileQueryCommand.js +42 -0
- package/dist-es/commands/ExecuteGremlinQueryCommand.js +42 -0
- package/dist-es/commands/ExecuteOpenCypherExplainQueryCommand.js +42 -0
- package/dist-es/commands/ExecuteOpenCypherQueryCommand.js +42 -0
- package/dist-es/commands/GetEngineStatusCommand.js +42 -0
- package/dist-es/commands/GetGremlinQueryStatusCommand.js +42 -0
- package/dist-es/commands/GetLoaderJobStatusCommand.js +42 -0
- package/dist-es/commands/GetMLDataProcessingJobCommand.js +42 -0
- package/dist-es/commands/GetMLEndpointCommand.js +42 -0
- package/dist-es/commands/GetMLModelTrainingJobCommand.js +42 -0
- package/dist-es/commands/GetMLModelTransformJobCommand.js +42 -0
- package/dist-es/commands/GetOpenCypherQueryStatusCommand.js +42 -0
- package/dist-es/commands/GetPropertygraphStatisticsCommand.js +42 -0
- package/dist-es/commands/GetPropertygraphStreamCommand.js +42 -0
- package/dist-es/commands/GetPropertygraphSummaryCommand.js +42 -0
- package/dist-es/commands/GetRDFGraphSummaryCommand.js +42 -0
- package/dist-es/commands/GetSparqlStatisticsCommand.js +42 -0
- package/dist-es/commands/GetSparqlStreamCommand.js +42 -0
- package/dist-es/commands/ListGremlinQueriesCommand.js +42 -0
- package/dist-es/commands/ListLoaderJobsCommand.js +42 -0
- package/dist-es/commands/ListMLDataProcessingJobsCommand.js +42 -0
- package/dist-es/commands/ListMLEndpointsCommand.js +42 -0
- package/dist-es/commands/ListMLModelTrainingJobsCommand.js +42 -0
- package/dist-es/commands/ListMLModelTransformJobsCommand.js +42 -0
- package/dist-es/commands/ListOpenCypherQueriesCommand.js +42 -0
- package/dist-es/commands/ManagePropertygraphStatisticsCommand.js +42 -0
- package/dist-es/commands/ManageSparqlStatisticsCommand.js +42 -0
- package/dist-es/commands/StartLoaderJobCommand.js +42 -0
- package/dist-es/commands/StartMLDataProcessingJobCommand.js +42 -0
- package/dist-es/commands/StartMLModelTrainingJobCommand.js +42 -0
- package/dist-es/commands/StartMLModelTransformJobCommand.js +42 -0
- package/dist-es/commands/index.js +43 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +5 -0
- package/dist-es/models/NeptunedataServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +594 -0
- package/dist-es/protocols/Aws_restJson1.js +4681 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +43 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +18 -0
- package/dist-es/runtimeExtensions.js +12 -0
- package/dist-types/Neptunedata.d.ts +316 -0
- package/dist-types/NeptunedataClient.d.ts +215 -0
- package/dist-types/commands/CancelGremlinQueryCommand.d.ts +117 -0
- package/dist-types/commands/CancelLoaderJobCommand.d.ts +115 -0
- package/dist-types/commands/CancelMLDataProcessingJobCommand.d.ts +109 -0
- package/dist-types/commands/CancelMLModelTrainingJobCommand.d.ts +109 -0
- package/dist-types/commands/CancelMLModelTransformJobCommand.d.ts +109 -0
- package/dist-types/commands/CancelOpenCypherQueryCommand.d.ts +122 -0
- package/dist-types/commands/CreateMLEndpointCommand.d.ts +119 -0
- package/dist-types/commands/DeleteMLEndpointCommand.d.ts +110 -0
- package/dist-types/commands/DeletePropertygraphStatisticsCommand.d.ts +116 -0
- package/dist-types/commands/DeleteSparqlStatisticsCommand.d.ts +115 -0
- package/dist-types/commands/ExecuteFastResetCommand.d.ts +123 -0
- package/dist-types/commands/ExecuteGremlinExplainQueryCommand.d.ts +155 -0
- package/dist-types/commands/ExecuteGremlinProfileQueryCommand.d.ts +151 -0
- package/dist-types/commands/ExecuteGremlinQueryCommand.d.ts +150 -0
- package/dist-types/commands/ExecuteOpenCypherExplainQueryCommand.d.ts +151 -0
- package/dist-types/commands/ExecuteOpenCypherQueryCommand.d.ts +151 -0
- package/dist-types/commands/GetEngineStatusCommand.d.ts +119 -0
- package/dist-types/commands/GetGremlinQueryStatusCommand.d.ts +129 -0
- package/dist-types/commands/GetLoaderJobStatusCommand.d.ts +121 -0
- package/dist-types/commands/GetMLDataProcessingJobCommand.d.ts +117 -0
- package/dist-types/commands/GetMLEndpointCommand.d.ts +121 -0
- package/dist-types/commands/GetMLModelTrainingJobCommand.d.ts +139 -0
- package/dist-types/commands/GetMLModelTransformJobCommand.d.ts +131 -0
- package/dist-types/commands/GetOpenCypherQueryStatusCommand.d.ts +132 -0
- package/dist-types/commands/GetPropertygraphStatisticsCommand.d.ts +122 -0
- package/dist-types/commands/GetPropertygraphStreamCommand.d.ts +147 -0
- package/dist-types/commands/GetPropertygraphSummaryCommand.d.ts +161 -0
- package/dist-types/commands/GetRDFGraphSummaryCommand.d.ts +138 -0
- package/dist-types/commands/GetSparqlStatisticsCommand.d.ts +122 -0
- package/dist-types/commands/GetSparqlStreamCommand.d.ts +142 -0
- package/dist-types/commands/ListGremlinQueriesCommand.d.ts +136 -0
- package/dist-types/commands/ListLoaderJobsCommand.d.ts +116 -0
- package/dist-types/commands/ListMLDataProcessingJobsCommand.d.ts +110 -0
- package/dist-types/commands/ListMLEndpointsCommand.d.ts +110 -0
- package/dist-types/commands/ListMLModelTrainingJobsCommand.d.ts +110 -0
- package/dist-types/commands/ListMLModelTransformJobsCommand.d.ts +110 -0
- package/dist-types/commands/ListOpenCypherQueriesCommand.d.ts +139 -0
- package/dist-types/commands/ManagePropertygraphStatisticsCommand.d.ts +115 -0
- package/dist-types/commands/ManageSparqlStatisticsCommand.d.ts +115 -0
- package/dist-types/commands/StartLoaderJobCommand.d.ts +135 -0
- package/dist-types/commands/StartMLDataProcessingJobCommand.d.ts +128 -0
- package/dist-types/commands/StartMLModelTrainingJobCommand.d.ts +134 -0
- package/dist-types/commands/StartMLModelTransformJobCommand.d.ts +129 -0
- package/dist-types/commands/index.d.ts +43 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +22 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +6 -0
- package/dist-types/index.d.ts +16 -0
- package/dist-types/models/NeptunedataServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +4026 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +389 -0
- package/dist-types/runtimeConfig.browser.d.ts +46 -0
- package/dist-types/runtimeConfig.d.ts +43 -0
- package/dist-types/runtimeConfig.native.d.ts +42 -0
- package/dist-types/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/Neptunedata.d.ts +738 -0
- package/dist-types/ts3.4/NeptunedataClient.d.ts +376 -0
- package/dist-types/ts3.4/commands/CancelGremlinQueryCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CancelLoaderJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CancelMLDataProcessingJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CancelMLModelTrainingJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CancelMLModelTransformJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CancelOpenCypherQueryCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateMLEndpointCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteMLEndpointCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeletePropertygraphStatisticsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteSparqlStatisticsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ExecuteFastResetCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ExecuteGremlinExplainQueryCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/ExecuteGremlinProfileQueryCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/ExecuteGremlinQueryCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ExecuteOpenCypherExplainQueryCommand.d.ts +49 -0
- package/dist-types/ts3.4/commands/ExecuteOpenCypherQueryCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetEngineStatusCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetGremlinQueryStatusCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetLoaderJobStatusCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetMLDataProcessingJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetMLEndpointCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetMLModelTrainingJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetMLModelTransformJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetOpenCypherQueryStatusCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetPropertygraphStatisticsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetPropertygraphStreamCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetPropertygraphSummaryCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetRDFGraphSummaryCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetSparqlStatisticsCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetSparqlStreamCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListGremlinQueriesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListLoaderJobsCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListMLDataProcessingJobsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListMLEndpointsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListMLModelTrainingJobsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListMLModelTransformJobsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListOpenCypherQueriesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ManagePropertygraphStatisticsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ManageSparqlStatisticsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartLoaderJobCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/StartMLDataProcessingJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartMLModelTrainingJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartMLModelTransformJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +43 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -0
- package/dist-types/ts3.4/index.d.ts +6 -0
- package/dist-types/ts3.4/models/NeptunedataServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +994 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +521 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +90 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +90 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +81 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +100 -0
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ExecuteGremlinQueryInput, ExecuteGremlinQueryOutput } from "../models/models_0";
|
|
5
|
+
import { NeptunedataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptunedataClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ExecuteGremlinQueryCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ExecuteGremlinQueryCommandInput extends ExecuteGremlinQueryInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ExecuteGremlinQueryCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ExecuteGremlinQueryCommandOutput extends ExecuteGremlinQueryOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>This commands executes a Gremlin query. Amazon Neptune is compatible
|
|
27
|
+
* with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal
|
|
28
|
+
* language to query the graph, as described under <a href="https://tinkerpop.apache.org/docs/current/reference/#graph">The
|
|
29
|
+
* Graph</a> in the Apache TinkerPop3 documentation.
|
|
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
|
+
* Neptune graph with Gremlin</a>.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { NeptunedataClient, ExecuteGremlinQueryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
|
|
36
|
+
* // const { NeptunedataClient, ExecuteGremlinQueryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
|
|
37
|
+
* const client = new NeptunedataClient(config);
|
|
38
|
+
* const input = { // ExecuteGremlinQueryInput
|
|
39
|
+
* gremlinQuery: "STRING_VALUE", // required
|
|
40
|
+
* serializer: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ExecuteGremlinQueryCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // ExecuteGremlinQueryOutput
|
|
45
|
+
* // requestId: "STRING_VALUE",
|
|
46
|
+
* // status: { // GremlinQueryStatusAttributes
|
|
47
|
+
* // message: "STRING_VALUE",
|
|
48
|
+
* // code: Number("int"),
|
|
49
|
+
* // attributes: "DOCUMENT_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // result: "DOCUMENT_VALUE",
|
|
52
|
+
* // meta: "DOCUMENT_VALUE",
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param ExecuteGremlinQueryCommandInput - {@link ExecuteGremlinQueryCommandInput}
|
|
58
|
+
* @returns {@link ExecuteGremlinQueryCommandOutput}
|
|
59
|
+
* @see {@link ExecuteGremlinQueryCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link ExecuteGremlinQueryCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link BadRequestException} (client fault)
|
|
64
|
+
* <p>Raised when a request is submitted that cannot be processed.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link CancelledByUserException} (server fault)
|
|
67
|
+
* <p>Raised when a user cancelled a request.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ClientTimeoutException} (client fault)
|
|
70
|
+
* <p>Raised when a request timed out in the client.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ConcurrentModificationException} (server fault)
|
|
73
|
+
* <p>Raised when a request attempts to modify data that is concurrently being
|
|
74
|
+
* modified by another process.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ConstraintViolationException} (client fault)
|
|
77
|
+
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link FailureByQueryException} (server fault)
|
|
80
|
+
* <p>Raised when a request fails.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link IllegalArgumentException} (client fault)
|
|
83
|
+
* <p>Raised when an argument in a request is not supported.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
86
|
+
* <p>Raised when an argument in a request has an invalid value.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
89
|
+
* <p>Raised when a parameter value is not valid.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link MalformedQueryException} (client fault)
|
|
92
|
+
* <p>Raised when a query is submitted that is syntactically incorrect or does not
|
|
93
|
+
* pass additional validation.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link MemoryLimitExceededException} (server fault)
|
|
96
|
+
* <p>Raised when a request fails because of insufficient memory resources. The
|
|
97
|
+
* request can be retried.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link MissingParameterException} (client fault)
|
|
100
|
+
* <p>Raised when a required parameter is missing.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ParsingException} (client fault)
|
|
103
|
+
* <p>Raised when a parsing issue is encountered.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link PreconditionsFailedException} (client fault)
|
|
106
|
+
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link QueryLimitExceededException} (server fault)
|
|
109
|
+
* <p>Raised when the number of active queries exceeds what the server can process.
|
|
110
|
+
* The query in question can be retried when the system is less busy.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link QueryLimitException} (client fault)
|
|
113
|
+
* <p>Raised when the size of a query exceeds the system limit.</p>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link QueryTooLargeException} (client fault)
|
|
116
|
+
* <p>Raised when the body of a query is too large.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link TimeLimitExceededException} (server fault)
|
|
119
|
+
* <p>Raised when the an operation exceeds the time limit allowed for it.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
122
|
+
* <p>Raised when the number of requests being processed exceeds the limit.</p>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
125
|
+
* <p>Raised when a request attempts to initiate an operation that is not supported.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link NeptunedataServiceException}
|
|
128
|
+
* <p>Base exception class for all service exceptions from Neptunedata service.</p>
|
|
129
|
+
*
|
|
130
|
+
*/
|
|
131
|
+
export declare class ExecuteGremlinQueryCommand extends $Command<ExecuteGremlinQueryCommandInput, ExecuteGremlinQueryCommandOutput, NeptunedataClientResolvedConfig> {
|
|
132
|
+
readonly input: ExecuteGremlinQueryCommandInput;
|
|
133
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
134
|
+
/**
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
constructor(input: ExecuteGremlinQueryCommandInput);
|
|
138
|
+
/**
|
|
139
|
+
* @internal
|
|
140
|
+
*/
|
|
141
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NeptunedataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteGremlinQueryCommandInput, ExecuteGremlinQueryCommandOutput>;
|
|
142
|
+
/**
|
|
143
|
+
* @internal
|
|
144
|
+
*/
|
|
145
|
+
private serialize;
|
|
146
|
+
/**
|
|
147
|
+
* @internal
|
|
148
|
+
*/
|
|
149
|
+
private deserialize;
|
|
150
|
+
}
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { Uint8ArrayBlobAdapter } from "@smithy/util-stream";
|
|
5
|
+
import { ExecuteOpenCypherExplainQueryInput, ExecuteOpenCypherExplainQueryOutput } from "../models/models_0";
|
|
6
|
+
import { NeptunedataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptunedataClient";
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*/
|
|
10
|
+
export { __MetadataBearer, $Command };
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*
|
|
14
|
+
* The input for {@link ExecuteOpenCypherExplainQueryCommand}.
|
|
15
|
+
*/
|
|
16
|
+
export interface ExecuteOpenCypherExplainQueryCommandInput extends ExecuteOpenCypherExplainQueryInput {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
export type ExecuteOpenCypherExplainQueryCommandOutputType = Omit<ExecuteOpenCypherExplainQueryOutput, "results"> & {
|
|
22
|
+
results: Uint8ArrayBlobAdapter;
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
*
|
|
27
|
+
* The output of {@link ExecuteOpenCypherExplainQueryCommand}.
|
|
28
|
+
*/
|
|
29
|
+
export interface ExecuteOpenCypherExplainQueryCommandOutput extends ExecuteOpenCypherExplainQueryCommandOutputType, __MetadataBearer {
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
* <p>Executes an openCypher <code>explain</code> request. See
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html">The
|
|
35
|
+
* openCypher explain feature</a> for more information.</p>
|
|
36
|
+
* @example
|
|
37
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
38
|
+
* ```javascript
|
|
39
|
+
* import { NeptunedataClient, ExecuteOpenCypherExplainQueryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
|
|
40
|
+
* // const { NeptunedataClient, ExecuteOpenCypherExplainQueryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
|
|
41
|
+
* const client = new NeptunedataClient(config);
|
|
42
|
+
* const input = { // ExecuteOpenCypherExplainQueryInput
|
|
43
|
+
* openCypherQuery: "STRING_VALUE", // required
|
|
44
|
+
* parameters: "STRING_VALUE",
|
|
45
|
+
* explainMode: "static" || "dynamic" || "details", // required
|
|
46
|
+
* };
|
|
47
|
+
* const command = new ExecuteOpenCypherExplainQueryCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // ExecuteOpenCypherExplainQueryOutput
|
|
50
|
+
* // results: "BLOB_VALUE", // required
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param ExecuteOpenCypherExplainQueryCommandInput - {@link ExecuteOpenCypherExplainQueryCommandInput}
|
|
56
|
+
* @returns {@link ExecuteOpenCypherExplainQueryCommandOutput}
|
|
57
|
+
* @see {@link ExecuteOpenCypherExplainQueryCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link ExecuteOpenCypherExplainQueryCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link BadRequestException} (client fault)
|
|
62
|
+
* <p>Raised when a request is submitted that cannot be processed.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link CancelledByUserException} (server fault)
|
|
65
|
+
* <p>Raised when a user cancelled a request.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ClientTimeoutException} (client fault)
|
|
68
|
+
* <p>Raised when a request timed out in the client.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ConcurrentModificationException} (server fault)
|
|
71
|
+
* <p>Raised when a request attempts to modify data that is concurrently being
|
|
72
|
+
* modified by another process.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ConstraintViolationException} (client fault)
|
|
75
|
+
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link FailureByQueryException} (server fault)
|
|
78
|
+
* <p>Raised when a request fails.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link IllegalArgumentException} (client fault)
|
|
81
|
+
* <p>Raised when an argument in a request is not supported.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
84
|
+
* <p>Raised when an argument in a request has an invalid value.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link InvalidNumericDataException} (client fault)
|
|
87
|
+
* <p>Raised when invalid numerical data is encountered when servicing a request.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
90
|
+
* <p>Raised when a parameter value is not valid.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link MalformedQueryException} (client fault)
|
|
93
|
+
* <p>Raised when a query is submitted that is syntactically incorrect or does not
|
|
94
|
+
* pass additional validation.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link MemoryLimitExceededException} (server fault)
|
|
97
|
+
* <p>Raised when a request fails because of insufficient memory resources. The
|
|
98
|
+
* request can be retried.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link MissingParameterException} (client fault)
|
|
101
|
+
* <p>Raised when a required parameter is missing.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ParsingException} (client fault)
|
|
104
|
+
* <p>Raised when a parsing issue is encountered.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link PreconditionsFailedException} (client fault)
|
|
107
|
+
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link QueryLimitExceededException} (server fault)
|
|
110
|
+
* <p>Raised when the number of active queries exceeds what the server can process.
|
|
111
|
+
* The query in question can be retried when the system is less busy.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link QueryLimitException} (client fault)
|
|
114
|
+
* <p>Raised when the size of a query exceeds the system limit.</p>
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link QueryTooLargeException} (client fault)
|
|
117
|
+
* <p>Raised when the body of a query is too large.</p>
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link TimeLimitExceededException} (server fault)
|
|
120
|
+
* <p>Raised when the an operation exceeds the time limit allowed for it.</p>
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
123
|
+
* <p>Raised when the number of requests being processed exceeds the limit.</p>
|
|
124
|
+
*
|
|
125
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
126
|
+
* <p>Raised when a request attempts to initiate an operation that is not supported.</p>
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link NeptunedataServiceException}
|
|
129
|
+
* <p>Base exception class for all service exceptions from Neptunedata service.</p>
|
|
130
|
+
*
|
|
131
|
+
*/
|
|
132
|
+
export declare class ExecuteOpenCypherExplainQueryCommand extends $Command<ExecuteOpenCypherExplainQueryCommandInput, ExecuteOpenCypherExplainQueryCommandOutput, NeptunedataClientResolvedConfig> {
|
|
133
|
+
readonly input: ExecuteOpenCypherExplainQueryCommandInput;
|
|
134
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
135
|
+
/**
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
constructor(input: ExecuteOpenCypherExplainQueryCommandInput);
|
|
139
|
+
/**
|
|
140
|
+
* @internal
|
|
141
|
+
*/
|
|
142
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NeptunedataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteOpenCypherExplainQueryCommandInput, ExecuteOpenCypherExplainQueryCommandOutput>;
|
|
143
|
+
/**
|
|
144
|
+
* @internal
|
|
145
|
+
*/
|
|
146
|
+
private serialize;
|
|
147
|
+
/**
|
|
148
|
+
* @internal
|
|
149
|
+
*/
|
|
150
|
+
private deserialize;
|
|
151
|
+
}
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ExecuteOpenCypherQueryInput, ExecuteOpenCypherQueryOutput } from "../models/models_0";
|
|
5
|
+
import { NeptunedataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptunedataClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ExecuteOpenCypherQueryCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ExecuteOpenCypherQueryCommandInput extends ExecuteOpenCypherQueryInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ExecuteOpenCypherQueryCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ExecuteOpenCypherQueryCommandOutput extends ExecuteOpenCypherQueryOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Executes an openCypher query. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html">Accessing
|
|
27
|
+
* the Neptune Graph with openCypher</a> for more information.</p>
|
|
28
|
+
* <p>Neptune supports building graph applications using openCypher,
|
|
29
|
+
* which is currently one of the most popular query languages among
|
|
30
|
+
* developers working with graph databases. Developers, business analysts,
|
|
31
|
+
* and data scientists like openCypher's declarative, SQL-inspired syntax
|
|
32
|
+
* because it provides a familiar structure in which to querying property
|
|
33
|
+
* graphs.</p>
|
|
34
|
+
* <p>The openCypher language was originally developed by Neo4j, then
|
|
35
|
+
* open-sourced in 2015 and contributed to the <a href="https://opencypher.org/">openCypher project</a> under an Apache
|
|
36
|
+
* 2 open-source license.</p>
|
|
37
|
+
* @example
|
|
38
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
39
|
+
* ```javascript
|
|
40
|
+
* import { NeptunedataClient, ExecuteOpenCypherQueryCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
|
|
41
|
+
* // const { NeptunedataClient, ExecuteOpenCypherQueryCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
|
|
42
|
+
* const client = new NeptunedataClient(config);
|
|
43
|
+
* const input = { // ExecuteOpenCypherQueryInput
|
|
44
|
+
* openCypherQuery: "STRING_VALUE", // required
|
|
45
|
+
* parameters: "STRING_VALUE",
|
|
46
|
+
* };
|
|
47
|
+
* const command = new ExecuteOpenCypherQueryCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // ExecuteOpenCypherQueryOutput
|
|
50
|
+
* // results: "DOCUMENT_VALUE", // required
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param ExecuteOpenCypherQueryCommandInput - {@link ExecuteOpenCypherQueryCommandInput}
|
|
56
|
+
* @returns {@link ExecuteOpenCypherQueryCommandOutput}
|
|
57
|
+
* @see {@link ExecuteOpenCypherQueryCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link ExecuteOpenCypherQueryCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link BadRequestException} (client fault)
|
|
62
|
+
* <p>Raised when a request is submitted that cannot be processed.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link CancelledByUserException} (server fault)
|
|
65
|
+
* <p>Raised when a user cancelled a request.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ClientTimeoutException} (client fault)
|
|
68
|
+
* <p>Raised when a request timed out in the client.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ConcurrentModificationException} (server fault)
|
|
71
|
+
* <p>Raised when a request attempts to modify data that is concurrently being
|
|
72
|
+
* modified by another process.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ConstraintViolationException} (client fault)
|
|
75
|
+
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link FailureByQueryException} (server fault)
|
|
78
|
+
* <p>Raised when a request fails.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link IllegalArgumentException} (client fault)
|
|
81
|
+
* <p>Raised when an argument in a request is not supported.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
84
|
+
* <p>Raised when an argument in a request has an invalid value.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link InvalidNumericDataException} (client fault)
|
|
87
|
+
* <p>Raised when invalid numerical data is encountered when servicing a request.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
90
|
+
* <p>Raised when a parameter value is not valid.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link MalformedQueryException} (client fault)
|
|
93
|
+
* <p>Raised when a query is submitted that is syntactically incorrect or does not
|
|
94
|
+
* pass additional validation.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link MemoryLimitExceededException} (server fault)
|
|
97
|
+
* <p>Raised when a request fails because of insufficient memory resources. The
|
|
98
|
+
* request can be retried.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link MissingParameterException} (client fault)
|
|
101
|
+
* <p>Raised when a required parameter is missing.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ParsingException} (client fault)
|
|
104
|
+
* <p>Raised when a parsing issue is encountered.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link PreconditionsFailedException} (client fault)
|
|
107
|
+
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link QueryLimitExceededException} (server fault)
|
|
110
|
+
* <p>Raised when the number of active queries exceeds what the server can process.
|
|
111
|
+
* The query in question can be retried when the system is less busy.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link QueryLimitException} (client fault)
|
|
114
|
+
* <p>Raised when the size of a query exceeds the system limit.</p>
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link QueryTooLargeException} (client fault)
|
|
117
|
+
* <p>Raised when the body of a query is too large.</p>
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link TimeLimitExceededException} (server fault)
|
|
120
|
+
* <p>Raised when the an operation exceeds the time limit allowed for it.</p>
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
123
|
+
* <p>Raised when the number of requests being processed exceeds the limit.</p>
|
|
124
|
+
*
|
|
125
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
126
|
+
* <p>Raised when a request attempts to initiate an operation that is not supported.</p>
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link NeptunedataServiceException}
|
|
129
|
+
* <p>Base exception class for all service exceptions from Neptunedata service.</p>
|
|
130
|
+
*
|
|
131
|
+
*/
|
|
132
|
+
export declare class ExecuteOpenCypherQueryCommand extends $Command<ExecuteOpenCypherQueryCommandInput, ExecuteOpenCypherQueryCommandOutput, NeptunedataClientResolvedConfig> {
|
|
133
|
+
readonly input: ExecuteOpenCypherQueryCommandInput;
|
|
134
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
135
|
+
/**
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
constructor(input: ExecuteOpenCypherQueryCommandInput);
|
|
139
|
+
/**
|
|
140
|
+
* @internal
|
|
141
|
+
*/
|
|
142
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NeptunedataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteOpenCypherQueryCommandInput, ExecuteOpenCypherQueryCommandOutput>;
|
|
143
|
+
/**
|
|
144
|
+
* @internal
|
|
145
|
+
*/
|
|
146
|
+
private serialize;
|
|
147
|
+
/**
|
|
148
|
+
* @internal
|
|
149
|
+
*/
|
|
150
|
+
private deserialize;
|
|
151
|
+
}
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetEngineStatusOutput } from "../models/models_0";
|
|
5
|
+
import { NeptunedataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptunedataClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetEngineStatusCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetEngineStatusCommandInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetEngineStatusCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetEngineStatusCommandOutput extends GetEngineStatusOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Check the status of the graph database on the host.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { NeptunedataClient, GetEngineStatusCommand } from "@aws-sdk/client-neptunedata"; // ES Modules import
|
|
31
|
+
* // const { NeptunedataClient, GetEngineStatusCommand } = require("@aws-sdk/client-neptunedata"); // CommonJS import
|
|
32
|
+
* const client = new NeptunedataClient(config);
|
|
33
|
+
* const input = {};
|
|
34
|
+
* const command = new GetEngineStatusCommand(input);
|
|
35
|
+
* const response = await client.send(command);
|
|
36
|
+
* // { // GetEngineStatusOutput
|
|
37
|
+
* // status: "STRING_VALUE",
|
|
38
|
+
* // startTime: "STRING_VALUE",
|
|
39
|
+
* // dbEngineVersion: "STRING_VALUE",
|
|
40
|
+
* // role: "STRING_VALUE",
|
|
41
|
+
* // dfeQueryEngine: "STRING_VALUE",
|
|
42
|
+
* // gremlin: { // QueryLanguageVersion
|
|
43
|
+
* // version: "STRING_VALUE", // required
|
|
44
|
+
* // },
|
|
45
|
+
* // sparql: {
|
|
46
|
+
* // version: "STRING_VALUE", // required
|
|
47
|
+
* // },
|
|
48
|
+
* // opencypher: {
|
|
49
|
+
* // version: "STRING_VALUE", // required
|
|
50
|
+
* // },
|
|
51
|
+
* // labMode: { // StringValuedMap
|
|
52
|
+
* // "<keys>": "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // rollingBackTrxCount: Number("int"),
|
|
55
|
+
* // rollingBackTrxEarliestStartTime: "STRING_VALUE",
|
|
56
|
+
* // features: { // DocumentValuedMap
|
|
57
|
+
* // "<keys>": "DOCUMENT_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // settings: {
|
|
60
|
+
* // "<keys>": "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param GetEngineStatusCommandInput - {@link GetEngineStatusCommandInput}
|
|
67
|
+
* @returns {@link GetEngineStatusCommandOutput}
|
|
68
|
+
* @see {@link GetEngineStatusCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link GetEngineStatusCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link NeptunedataClientResolvedConfig | config} for NeptunedataClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ClientTimeoutException} (client fault)
|
|
73
|
+
* <p>Raised when a request timed out in the client.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ConstraintViolationException} (client fault)
|
|
76
|
+
* <p>Raised when a value in a request field did not satisfy required constraints.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link IllegalArgumentException} (client fault)
|
|
79
|
+
* <p>Raised when an argument in a request is not supported.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
82
|
+
* <p>Raised when the processing of the request failed unexpectedly.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InvalidArgumentException} (client fault)
|
|
85
|
+
* <p>Raised when an argument in a request has an invalid value.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link PreconditionsFailedException} (client fault)
|
|
88
|
+
* <p>Raised when a precondition for processing a request is not satisfied.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
91
|
+
* <p>Raised when the number of requests being processed exceeds the limit.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
94
|
+
* <p>Raised when a request attempts to initiate an operation that is not supported.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link NeptunedataServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from Neptunedata service.</p>
|
|
98
|
+
*
|
|
99
|
+
*/
|
|
100
|
+
export declare class GetEngineStatusCommand extends $Command<GetEngineStatusCommandInput, GetEngineStatusCommandOutput, NeptunedataClientResolvedConfig> {
|
|
101
|
+
readonly input: GetEngineStatusCommandInput;
|
|
102
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
constructor(input: GetEngineStatusCommandInput);
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NeptunedataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEngineStatusCommandInput, GetEngineStatusCommandOutput>;
|
|
111
|
+
/**
|
|
112
|
+
* @internal
|
|
113
|
+
*/
|
|
114
|
+
private serialize;
|
|
115
|
+
/**
|
|
116
|
+
* @internal
|
|
117
|
+
*/
|
|
118
|
+
private deserialize;
|
|
119
|
+
}
|