@aws-sdk/client-neptune-graph 3.503.1 → 3.505.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/README.md +43 -3
  2. package/dist-cjs/commands/CancelQueryCommand.js +1 -0
  3. package/dist-cjs/commands/ExecuteQueryCommand.js +1 -0
  4. package/dist-cjs/commands/GetGraphSummaryCommand.js +1 -0
  5. package/dist-cjs/commands/GetQueryCommand.js +1 -0
  6. package/dist-cjs/commands/ListQueriesCommand.js +1 -0
  7. package/dist-cjs/index.js +624 -41
  8. package/dist-cjs/runtimeConfig.shared.js +2 -0
  9. package/dist-es/NeptuneGraph.js +10 -0
  10. package/dist-es/commands/CancelQueryCommand.js +25 -0
  11. package/dist-es/commands/ExecuteQueryCommand.js +26 -0
  12. package/dist-es/commands/GetGraphSummaryCommand.js +25 -0
  13. package/dist-es/commands/GetQueryCommand.js +25 -0
  14. package/dist-es/commands/ListQueriesCommand.js +25 -0
  15. package/dist-es/commands/index.js +5 -0
  16. package/dist-es/models/models_0.js +91 -29
  17. package/dist-es/protocols/Aws_restJson1.js +385 -2
  18. package/dist-es/runtimeConfig.shared.js +2 -0
  19. package/dist-types/NeptuneGraph.d.ts +38 -3
  20. package/dist-types/NeptuneGraphClient.d.ts +16 -6
  21. package/dist-types/commands/CancelImportTaskCommand.d.ts +2 -2
  22. package/dist-types/commands/CancelQueryCommand.d.ts +72 -0
  23. package/dist-types/commands/CreateGraphCommand.d.ts +1 -1
  24. package/dist-types/commands/CreateGraphSnapshotCommand.d.ts +1 -1
  25. package/dist-types/commands/CreateGraphUsingImportTaskCommand.d.ts +1 -1
  26. package/dist-types/commands/CreatePrivateGraphEndpointCommand.d.ts +1 -1
  27. package/dist-types/commands/DeleteGraphCommand.d.ts +1 -1
  28. package/dist-types/commands/DeleteGraphSnapshotCommand.d.ts +1 -1
  29. package/dist-types/commands/DeletePrivateGraphEndpointCommand.d.ts +1 -1
  30. package/dist-types/commands/ExecuteQueryCommand.d.ts +90 -0
  31. package/dist-types/commands/GetGraphCommand.d.ts +1 -1
  32. package/dist-types/commands/GetGraphSnapshotCommand.d.ts +1 -1
  33. package/dist-types/commands/GetGraphSummaryCommand.d.ts +120 -0
  34. package/dist-types/commands/GetImportTaskCommand.d.ts +1 -1
  35. package/dist-types/commands/GetPrivateGraphEndpointCommand.d.ts +1 -1
  36. package/dist-types/commands/GetQueryCommand.d.ts +78 -0
  37. package/dist-types/commands/ListGraphSnapshotsCommand.d.ts +1 -1
  38. package/dist-types/commands/ListImportTasksCommand.d.ts +1 -1
  39. package/dist-types/commands/ListPrivateGraphEndpointsCommand.d.ts +1 -1
  40. package/dist-types/commands/ListQueriesCommand.d.ts +80 -0
  41. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  42. package/dist-types/commands/ResetGraphCommand.d.ts +1 -1
  43. package/dist-types/commands/RestoreGraphFromSnapshotCommand.d.ts +1 -1
  44. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  45. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  46. package/dist-types/commands/UpdateGraphCommand.d.ts +1 -1
  47. package/dist-types/commands/index.d.ts +5 -0
  48. package/dist-types/index.d.ts +3 -3
  49. package/dist-types/models/models_0.d.ts +522 -78
  50. package/dist-types/protocols/Aws_restJson1.d.ts +46 -1
  51. package/dist-types/runtimeConfig.browser.d.ts +1 -0
  52. package/dist-types/runtimeConfig.d.ts +1 -0
  53. package/dist-types/runtimeConfig.native.d.ts +1 -0
  54. package/dist-types/runtimeConfig.shared.d.ts +1 -0
  55. package/dist-types/ts3.4/NeptuneGraph.d.ts +85 -0
  56. package/dist-types/ts3.4/NeptuneGraphClient.d.ts +32 -0
  57. package/dist-types/ts3.4/commands/CancelQueryCommand.d.ts +24 -0
  58. package/dist-types/ts3.4/commands/ExecuteQueryCommand.d.ts +34 -0
  59. package/dist-types/ts3.4/commands/GetGraphSummaryCommand.d.ts +29 -0
  60. package/dist-types/ts3.4/commands/GetQueryCommand.d.ts +26 -0
  61. package/dist-types/ts3.4/commands/ListQueriesCommand.d.ts +26 -0
  62. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  63. package/dist-types/ts3.4/models/models_0.d.ts +182 -44
  64. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +64 -1
  65. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -0
  66. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -0
  67. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
  68. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -0
  69. package/package.json +4 -3
@@ -7,8 +7,9 @@ import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-
7
7
  import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
8
8
  import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
9
9
  import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
10
- import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
10
+ import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, SdkStreamMixinInjector as __SdkStreamMixinInjector, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
11
11
  import { CancelImportTaskCommandInput, CancelImportTaskCommandOutput } from "./commands/CancelImportTaskCommand";
12
+ import { CancelQueryCommandInput, CancelQueryCommandOutput } from "./commands/CancelQueryCommand";
12
13
  import { CreateGraphCommandInput, CreateGraphCommandOutput } from "./commands/CreateGraphCommand";
13
14
  import { CreateGraphSnapshotCommandInput, CreateGraphSnapshotCommandOutput } from "./commands/CreateGraphSnapshotCommand";
14
15
  import { CreateGraphUsingImportTaskCommandInput, CreateGraphUsingImportTaskCommandOutput } from "./commands/CreateGraphUsingImportTaskCommand";
@@ -16,14 +17,18 @@ import { CreatePrivateGraphEndpointCommandInput, CreatePrivateGraphEndpointComma
16
17
  import { DeleteGraphCommandInput, DeleteGraphCommandOutput } from "./commands/DeleteGraphCommand";
17
18
  import { DeleteGraphSnapshotCommandInput, DeleteGraphSnapshotCommandOutput } from "./commands/DeleteGraphSnapshotCommand";
18
19
  import { DeletePrivateGraphEndpointCommandInput, DeletePrivateGraphEndpointCommandOutput } from "./commands/DeletePrivateGraphEndpointCommand";
20
+ import { ExecuteQueryCommandInput, ExecuteQueryCommandOutput } from "./commands/ExecuteQueryCommand";
19
21
  import { GetGraphCommandInput, GetGraphCommandOutput } from "./commands/GetGraphCommand";
20
22
  import { GetGraphSnapshotCommandInput, GetGraphSnapshotCommandOutput } from "./commands/GetGraphSnapshotCommand";
23
+ import { GetGraphSummaryCommandInput, GetGraphSummaryCommandOutput } from "./commands/GetGraphSummaryCommand";
21
24
  import { GetImportTaskCommandInput, GetImportTaskCommandOutput } from "./commands/GetImportTaskCommand";
22
25
  import { GetPrivateGraphEndpointCommandInput, GetPrivateGraphEndpointCommandOutput } from "./commands/GetPrivateGraphEndpointCommand";
26
+ import { GetQueryCommandInput, GetQueryCommandOutput } from "./commands/GetQueryCommand";
23
27
  import { ListGraphsCommandInput, ListGraphsCommandOutput } from "./commands/ListGraphsCommand";
24
28
  import { ListGraphSnapshotsCommandInput, ListGraphSnapshotsCommandOutput } from "./commands/ListGraphSnapshotsCommand";
25
29
  import { ListImportTasksCommandInput, ListImportTasksCommandOutput } from "./commands/ListImportTasksCommand";
26
30
  import { ListPrivateGraphEndpointsCommandInput, ListPrivateGraphEndpointsCommandOutput } from "./commands/ListPrivateGraphEndpointsCommand";
31
+ import { ListQueriesCommandInput, ListQueriesCommandOutput } from "./commands/ListQueriesCommand";
27
32
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
28
33
  import { ResetGraphCommandInput, ResetGraphCommandOutput } from "./commands/ResetGraphCommand";
29
34
  import { RestoreGraphFromSnapshotCommandInput, RestoreGraphFromSnapshotCommandOutput } from "./commands/RestoreGraphFromSnapshotCommand";
@@ -36,11 +41,11 @@ export { __Client };
36
41
  /**
37
42
  * @public
38
43
  */
39
- export type ServiceInputTypes = CancelImportTaskCommandInput | CreateGraphCommandInput | CreateGraphSnapshotCommandInput | CreateGraphUsingImportTaskCommandInput | CreatePrivateGraphEndpointCommandInput | DeleteGraphCommandInput | DeleteGraphSnapshotCommandInput | DeletePrivateGraphEndpointCommandInput | GetGraphCommandInput | GetGraphSnapshotCommandInput | GetImportTaskCommandInput | GetPrivateGraphEndpointCommandInput | ListGraphSnapshotsCommandInput | ListGraphsCommandInput | ListImportTasksCommandInput | ListPrivateGraphEndpointsCommandInput | ListTagsForResourceCommandInput | ResetGraphCommandInput | RestoreGraphFromSnapshotCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGraphCommandInput;
44
+ export type ServiceInputTypes = CancelImportTaskCommandInput | CancelQueryCommandInput | CreateGraphCommandInput | CreateGraphSnapshotCommandInput | CreateGraphUsingImportTaskCommandInput | CreatePrivateGraphEndpointCommandInput | DeleteGraphCommandInput | DeleteGraphSnapshotCommandInput | DeletePrivateGraphEndpointCommandInput | ExecuteQueryCommandInput | GetGraphCommandInput | GetGraphSnapshotCommandInput | GetGraphSummaryCommandInput | GetImportTaskCommandInput | GetPrivateGraphEndpointCommandInput | GetQueryCommandInput | ListGraphSnapshotsCommandInput | ListGraphsCommandInput | ListImportTasksCommandInput | ListPrivateGraphEndpointsCommandInput | ListQueriesCommandInput | ListTagsForResourceCommandInput | ResetGraphCommandInput | RestoreGraphFromSnapshotCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGraphCommandInput;
40
45
  /**
41
46
  * @public
42
47
  */
43
- export type ServiceOutputTypes = CancelImportTaskCommandOutput | CreateGraphCommandOutput | CreateGraphSnapshotCommandOutput | CreateGraphUsingImportTaskCommandOutput | CreatePrivateGraphEndpointCommandOutput | DeleteGraphCommandOutput | DeleteGraphSnapshotCommandOutput | DeletePrivateGraphEndpointCommandOutput | GetGraphCommandOutput | GetGraphSnapshotCommandOutput | GetImportTaskCommandOutput | GetPrivateGraphEndpointCommandOutput | ListGraphSnapshotsCommandOutput | ListGraphsCommandOutput | ListImportTasksCommandOutput | ListPrivateGraphEndpointsCommandOutput | ListTagsForResourceCommandOutput | ResetGraphCommandOutput | RestoreGraphFromSnapshotCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGraphCommandOutput;
48
+ export type ServiceOutputTypes = CancelImportTaskCommandOutput | CancelQueryCommandOutput | CreateGraphCommandOutput | CreateGraphSnapshotCommandOutput | CreateGraphUsingImportTaskCommandOutput | CreatePrivateGraphEndpointCommandOutput | DeleteGraphCommandOutput | DeleteGraphSnapshotCommandOutput | DeletePrivateGraphEndpointCommandOutput | ExecuteQueryCommandOutput | GetGraphCommandOutput | GetGraphSnapshotCommandOutput | GetGraphSummaryCommandOutput | GetImportTaskCommandOutput | GetPrivateGraphEndpointCommandOutput | GetQueryCommandOutput | ListGraphSnapshotsCommandOutput | ListGraphsCommandOutput | ListImportTasksCommandOutput | ListPrivateGraphEndpointsCommandOutput | ListQueriesCommandOutput | ListTagsForResourceCommandOutput | ResetGraphCommandOutput | RestoreGraphFromSnapshotCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGraphCommandOutput;
44
49
  /**
45
50
  * @public
46
51
  */
@@ -149,6 +154,11 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
149
154
  * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
150
155
  */
151
156
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
157
+ /**
158
+ * The internal function that inject utilities to runtime-specific stream to help users consume the data
159
+ * @internal
160
+ */
161
+ sdkStreamMixin?: __SdkStreamMixinInjector;
152
162
  }
153
163
  /**
154
164
  * @public
@@ -174,9 +184,9 @@ export interface NeptuneGraphClientResolvedConfig extends NeptuneGraphClientReso
174
184
  }
175
185
  /**
176
186
  * @public
177
- * <p>Neptune Analytics is a serverless in-memory graph database service for analytics
178
- * that delivers high-performance analytics and real-time queries for any graph type. It
179
- * complements the Amazon Neptune Database, an industry-leading managed graph database.</p>
187
+ * <p>Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to
188
+ * insights faster by quickly processing large amounts of graph data, invoking popular graph analytic
189
+ * algorithms in low-latency queries, and getting analytics results in seconds.</p>
180
190
  */
181
191
  export declare class NeptuneGraphClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, NeptuneGraphClientResolvedConfig> {
182
192
  /**
@@ -26,7 +26,7 @@ declare const CancelImportTaskCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Deletes the specified import task</p>
29
+ * <p>Deletes the specified import task.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -68,7 +68,7 @@ declare const CancelImportTaskCommand_base: {
68
68
  * <p>The exception was interrupted by throttling.</p>
69
69
  *
70
70
  * @throws {@link ValidationException} (client fault)
71
- * <p>A resource could not be validated</p>
71
+ * <p>A resource could not be validated.</p>
72
72
  *
73
73
  * @throws {@link NeptuneGraphServiceException}
74
74
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -0,0 +1,72 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CancelQueryInput } from "../models/models_0";
4
+ import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link CancelQueryCommand}.
13
+ */
14
+ export interface CancelQueryCommandInput extends CancelQueryInput {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link CancelQueryCommand}.
20
+ */
21
+ export interface CancelQueryCommandOutput extends __MetadataBearer {
22
+ }
23
+ declare const CancelQueryCommand_base: {
24
+ new (input: CancelQueryCommandInput): import("@smithy/smithy-client").CommandImpl<CancelQueryCommandInput, CancelQueryCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
+ };
27
+ /**
28
+ * @public
29
+ * <p>Cancels a specified query.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { NeptuneGraphClient, CancelQueryCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
34
+ * // const { NeptuneGraphClient, CancelQueryCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
35
+ * const client = new NeptuneGraphClient(config);
36
+ * const input = { // CancelQueryInput
37
+ * graphIdentifier: "STRING_VALUE", // required
38
+ * queryId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new CancelQueryCommand(input);
41
+ * const response = await client.send(command);
42
+ * // {};
43
+ *
44
+ * ```
45
+ *
46
+ * @param CancelQueryCommandInput - {@link CancelQueryCommandInput}
47
+ * @returns {@link CancelQueryCommandOutput}
48
+ * @see {@link CancelQueryCommandInput} for command's `input` shape.
49
+ * @see {@link CancelQueryCommandOutput} for command's `response` shape.
50
+ * @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape.
51
+ *
52
+ * @throws {@link AccessDeniedException} (client fault)
53
+ * <p>Raised in case of an authentication or authorization failure.</p>
54
+ *
55
+ * @throws {@link InternalServerException} (server fault)
56
+ * <p>A failure occurred on the server.</p>
57
+ *
58
+ * @throws {@link ResourceNotFoundException} (client fault)
59
+ * <p>A specified resource could not be located.</p>
60
+ *
61
+ * @throws {@link ThrottlingException} (client fault)
62
+ * <p>The exception was interrupted by throttling.</p>
63
+ *
64
+ * @throws {@link ValidationException} (client fault)
65
+ * <p>A resource could not be validated.</p>
66
+ *
67
+ * @throws {@link NeptuneGraphServiceException}
68
+ * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
69
+ *
70
+ */
71
+ export declare class CancelQueryCommand extends CancelQueryCommand_base {
72
+ }
@@ -90,7 +90,7 @@ declare const CreateGraphCommand_base: {
90
90
  * <p>The exception was interrupted by throttling.</p>
91
91
  *
92
92
  * @throws {@link ValidationException} (client fault)
93
- * <p>A resource could not be validated</p>
93
+ * <p>A resource could not be validated.</p>
94
94
  *
95
95
  * @throws {@link NeptuneGraphServiceException}
96
96
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -76,7 +76,7 @@ declare const CreateGraphSnapshotCommand_base: {
76
76
  * <p>The exception was interrupted by throttling.</p>
77
77
  *
78
78
  * @throws {@link ValidationException} (client fault)
79
- * <p>A resource could not be validated</p>
79
+ * <p>A resource could not be validated.</p>
80
80
  *
81
81
  * @throws {@link NeptuneGraphServiceException}
82
82
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -104,7 +104,7 @@ declare const CreateGraphUsingImportTaskCommand_base: {
104
104
  * <p>The exception was interrupted by throttling.</p>
105
105
  *
106
106
  * @throws {@link ValidationException} (client fault)
107
- * <p>A resource could not be validated</p>
107
+ * <p>A resource could not be validated.</p>
108
108
  *
109
109
  * @throws {@link NeptuneGraphServiceException}
110
110
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -79,7 +79,7 @@ declare const CreatePrivateGraphEndpointCommand_base: {
79
79
  * <p>The exception was interrupted by throttling.</p>
80
80
  *
81
81
  * @throws {@link ValidationException} (client fault)
82
- * <p>A resource could not be validated</p>
82
+ * <p>A resource could not be validated.</p>
83
83
  *
84
84
  * @throws {@link NeptuneGraphServiceException}
85
85
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -80,7 +80,7 @@ declare const DeleteGraphCommand_base: {
80
80
  * <p>The exception was interrupted by throttling.</p>
81
81
  *
82
82
  * @throws {@link ValidationException} (client fault)
83
- * <p>A resource could not be validated</p>
83
+ * <p>A resource could not be validated.</p>
84
84
  *
85
85
  * @throws {@link NeptuneGraphServiceException}
86
86
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -69,7 +69,7 @@ declare const DeleteGraphSnapshotCommand_base: {
69
69
  * <p>The exception was interrupted by throttling.</p>
70
70
  *
71
71
  * @throws {@link ValidationException} (client fault)
72
- * <p>A resource could not be validated</p>
72
+ * <p>A resource could not be validated.</p>
73
73
  *
74
74
  * @throws {@link NeptuneGraphServiceException}
75
75
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -69,7 +69,7 @@ declare const DeletePrivateGraphEndpointCommand_base: {
69
69
  * <p>The exception was interrupted by throttling.</p>
70
70
  *
71
71
  * @throws {@link ValidationException} (client fault)
72
- * <p>A resource could not be validated</p>
72
+ * <p>A resource could not be validated.</p>
73
73
  *
74
74
  * @throws {@link NeptuneGraphServiceException}
75
75
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -0,0 +1,90 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer, StreamingBlobPayloadOutputTypes } from "@smithy/types";
3
+ import { ExecuteQueryInput, ExecuteQueryOutput } from "../models/models_0";
4
+ import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link ExecuteQueryCommand}.
13
+ */
14
+ export interface ExecuteQueryCommandInput extends ExecuteQueryInput {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link ExecuteQueryCommand}.
20
+ */
21
+ export interface ExecuteQueryCommandOutput extends Omit<ExecuteQueryOutput, "payload">, __MetadataBearer {
22
+ payload: StreamingBlobPayloadOutputTypes;
23
+ }
24
+ declare const ExecuteQueryCommand_base: {
25
+ new (input: ExecuteQueryCommandInput): import("@smithy/smithy-client").CommandImpl<ExecuteQueryCommandInput, ExecuteQueryCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * @public
30
+ * <p>Execute an openCypher query. Currently, the SDK does not support parameterized queries. If you want to make a
31
+ * parameterized query call, you can use an HTTP request. </p>
32
+ * <note>
33
+ * <p>
34
+ * Non-parametrized queries are not considered for plan caching. You can force plan caching with
35
+ * <code>planCache=enabled</code>. The plan cache will be reused only for the same exact query. Slight variations
36
+ * in the query will not be able to reuse the query plan cache.
37
+ * </p>
38
+ * </note>
39
+ * @example
40
+ * Use a bare-bones client and the command you need to make an API call.
41
+ * ```javascript
42
+ * import { NeptuneGraphClient, ExecuteQueryCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
43
+ * // const { NeptuneGraphClient, ExecuteQueryCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
44
+ * const client = new NeptuneGraphClient(config);
45
+ * const input = { // ExecuteQueryInput
46
+ * graphIdentifier: "STRING_VALUE", // required
47
+ * queryString: "STRING_VALUE", // required
48
+ * language: "OPEN_CYPHER", // required
49
+ * planCache: "ENABLED" || "DISABLED" || "AUTO",
50
+ * explainMode: "STATIC" || "DETAILS",
51
+ * queryTimeoutMilliseconds: Number("int"),
52
+ * };
53
+ * const command = new ExecuteQueryCommand(input);
54
+ * const response = await client.send(command);
55
+ * // { // ExecuteQueryOutput
56
+ * // payload: "STREAMING_BLOB_VALUE", // required
57
+ * // };
58
+ *
59
+ * ```
60
+ *
61
+ * @param ExecuteQueryCommandInput - {@link ExecuteQueryCommandInput}
62
+ * @returns {@link ExecuteQueryCommandOutput}
63
+ * @see {@link ExecuteQueryCommandInput} for command's `input` shape.
64
+ * @see {@link ExecuteQueryCommandOutput} for command's `response` shape.
65
+ * @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape.
66
+ *
67
+ * @throws {@link AccessDeniedException} (client fault)
68
+ * <p>Raised in case of an authentication or authorization failure.</p>
69
+ *
70
+ * @throws {@link ConflictException} (client fault)
71
+ * <p>Raised when a conflict is encountered.</p>
72
+ *
73
+ * @throws {@link InternalServerException} (server fault)
74
+ * <p>A failure occurred on the server.</p>
75
+ *
76
+ * @throws {@link ThrottlingException} (client fault)
77
+ * <p>The exception was interrupted by throttling.</p>
78
+ *
79
+ * @throws {@link UnprocessableException} (client fault)
80
+ * <p>Request cannot be processed due to known reasons. Eg. partition full.</p>
81
+ *
82
+ * @throws {@link ValidationException} (client fault)
83
+ * <p>A resource could not be validated.</p>
84
+ *
85
+ * @throws {@link NeptuneGraphServiceException}
86
+ * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
87
+ *
88
+ */
89
+ export declare class ExecuteQueryCommand extends ExecuteQueryCommand_base {
90
+ }
@@ -76,7 +76,7 @@ declare const GetGraphCommand_base: {
76
76
  * <p>The exception was interrupted by throttling.</p>
77
77
  *
78
78
  * @throws {@link ValidationException} (client fault)
79
- * <p>A resource could not be validated</p>
79
+ * <p>A resource could not be validated.</p>
80
80
  *
81
81
  * @throws {@link NeptuneGraphServiceException}
82
82
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -66,7 +66,7 @@ declare const GetGraphSnapshotCommand_base: {
66
66
  * <p>The exception was interrupted by throttling.</p>
67
67
  *
68
68
  * @throws {@link ValidationException} (client fault)
69
- * <p>A resource could not be validated</p>
69
+ * <p>A resource could not be validated.</p>
70
70
  *
71
71
  * @throws {@link NeptuneGraphServiceException}
72
72
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -0,0 +1,120 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetGraphSummaryInput, GetGraphSummaryOutput } from "../models/models_0";
4
+ import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link GetGraphSummaryCommand}.
13
+ */
14
+ export interface GetGraphSummaryCommandInput extends GetGraphSummaryInput {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link GetGraphSummaryCommand}.
20
+ */
21
+ export interface GetGraphSummaryCommandOutput extends GetGraphSummaryOutput, __MetadataBearer {
22
+ }
23
+ declare const GetGraphSummaryCommand_base: {
24
+ new (input: GetGraphSummaryCommandInput): import("@smithy/smithy-client").CommandImpl<GetGraphSummaryCommandInput, GetGraphSummaryCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
+ };
27
+ /**
28
+ * @public
29
+ * <p>Gets a graph summary for a property graph.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { NeptuneGraphClient, GetGraphSummaryCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
34
+ * // const { NeptuneGraphClient, GetGraphSummaryCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
35
+ * const client = new NeptuneGraphClient(config);
36
+ * const input = { // GetGraphSummaryInput
37
+ * graphIdentifier: "STRING_VALUE", // required
38
+ * mode: "BASIC" || "DETAILED",
39
+ * };
40
+ * const command = new GetGraphSummaryCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetGraphSummaryOutput
43
+ * // version: "STRING_VALUE",
44
+ * // lastStatisticsComputationTime: new Date("TIMESTAMP"),
45
+ * // graphSummary: { // GraphDataSummary
46
+ * // numNodes: Number("long"),
47
+ * // numEdges: Number("long"),
48
+ * // numNodeLabels: Number("long"),
49
+ * // numEdgeLabels: Number("long"),
50
+ * // nodeLabels: [ // NodeLabels
51
+ * // "STRING_VALUE",
52
+ * // ],
53
+ * // edgeLabels: [ // EdgeLabels
54
+ * // "STRING_VALUE",
55
+ * // ],
56
+ * // numNodeProperties: Number("long"),
57
+ * // numEdgeProperties: Number("long"),
58
+ * // nodeProperties: [ // LongValuedMapList
59
+ * // { // LongValuedMap
60
+ * // "<keys>": Number("long"),
61
+ * // },
62
+ * // ],
63
+ * // edgeProperties: [
64
+ * // {
65
+ * // "<keys>": Number("long"),
66
+ * // },
67
+ * // ],
68
+ * // totalNodePropertyValues: Number("long"),
69
+ * // totalEdgePropertyValues: Number("long"),
70
+ * // nodeStructures: [ // NodeStructures
71
+ * // { // NodeStructure
72
+ * // count: Number("long"),
73
+ * // nodeProperties: [ // NodeProperties
74
+ * // "STRING_VALUE",
75
+ * // ],
76
+ * // distinctOutgoingEdgeLabels: [ // OutgoingEdgeLabels
77
+ * // "STRING_VALUE",
78
+ * // ],
79
+ * // },
80
+ * // ],
81
+ * // edgeStructures: [ // EdgeStructures
82
+ * // { // EdgeStructure
83
+ * // count: Number("long"),
84
+ * // edgeProperties: [ // EdgeProperties
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // },
88
+ * // ],
89
+ * // },
90
+ * // };
91
+ *
92
+ * ```
93
+ *
94
+ * @param GetGraphSummaryCommandInput - {@link GetGraphSummaryCommandInput}
95
+ * @returns {@link GetGraphSummaryCommandOutput}
96
+ * @see {@link GetGraphSummaryCommandInput} for command's `input` shape.
97
+ * @see {@link GetGraphSummaryCommandOutput} for command's `response` shape.
98
+ * @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape.
99
+ *
100
+ * @throws {@link AccessDeniedException} (client fault)
101
+ * <p>Raised in case of an authentication or authorization failure.</p>
102
+ *
103
+ * @throws {@link InternalServerException} (server fault)
104
+ * <p>A failure occurred on the server.</p>
105
+ *
106
+ * @throws {@link ResourceNotFoundException} (client fault)
107
+ * <p>A specified resource could not be located.</p>
108
+ *
109
+ * @throws {@link ThrottlingException} (client fault)
110
+ * <p>The exception was interrupted by throttling.</p>
111
+ *
112
+ * @throws {@link ValidationException} (client fault)
113
+ * <p>A resource could not be validated.</p>
114
+ *
115
+ * @throws {@link NeptuneGraphServiceException}
116
+ * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
117
+ *
118
+ */
119
+ export declare class GetGraphSummaryCommand extends GetGraphSummaryCommand_base {
120
+ }
@@ -85,7 +85,7 @@ declare const GetImportTaskCommand_base: {
85
85
  * <p>The exception was interrupted by throttling.</p>
86
86
  *
87
87
  * @throws {@link ValidationException} (client fault)
88
- * <p>A resource could not be validated</p>
88
+ * <p>A resource could not be validated.</p>
89
89
  *
90
90
  * @throws {@link NeptuneGraphServiceException}
91
91
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -66,7 +66,7 @@ declare const GetPrivateGraphEndpointCommand_base: {
66
66
  * <p>The exception was interrupted by throttling.</p>
67
67
  *
68
68
  * @throws {@link ValidationException} (client fault)
69
- * <p>A resource could not be validated</p>
69
+ * <p>A resource could not be validated.</p>
70
70
  *
71
71
  * @throws {@link NeptuneGraphServiceException}
72
72
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -0,0 +1,78 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetQueryInput, GetQueryOutput } from "../models/models_0";
4
+ import { NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneGraphClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link GetQueryCommand}.
13
+ */
14
+ export interface GetQueryCommandInput extends GetQueryInput {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link GetQueryCommand}.
20
+ */
21
+ export interface GetQueryCommandOutput extends GetQueryOutput, __MetadataBearer {
22
+ }
23
+ declare const GetQueryCommand_base: {
24
+ new (input: GetQueryCommandInput): import("@smithy/smithy-client").CommandImpl<GetQueryCommandInput, GetQueryCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
+ };
27
+ /**
28
+ * @public
29
+ * <p>Retrieves the status of a specified query.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { NeptuneGraphClient, GetQueryCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
34
+ * // const { NeptuneGraphClient, GetQueryCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
35
+ * const client = new NeptuneGraphClient(config);
36
+ * const input = { // GetQueryInput
37
+ * graphIdentifier: "STRING_VALUE", // required
38
+ * queryId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetQueryCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetQueryOutput
43
+ * // id: "STRING_VALUE",
44
+ * // queryString: "STRING_VALUE",
45
+ * // waited: Number("int"),
46
+ * // elapsed: Number("int"),
47
+ * // state: "RUNNING" || "WAITING" || "CANCELLING",
48
+ * // };
49
+ *
50
+ * ```
51
+ *
52
+ * @param GetQueryCommandInput - {@link GetQueryCommandInput}
53
+ * @returns {@link GetQueryCommandOutput}
54
+ * @see {@link GetQueryCommandInput} for command's `input` shape.
55
+ * @see {@link GetQueryCommandOutput} for command's `response` shape.
56
+ * @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape.
57
+ *
58
+ * @throws {@link AccessDeniedException} (client fault)
59
+ * <p>Raised in case of an authentication or authorization failure.</p>
60
+ *
61
+ * @throws {@link InternalServerException} (server fault)
62
+ * <p>A failure occurred on the server.</p>
63
+ *
64
+ * @throws {@link ResourceNotFoundException} (client fault)
65
+ * <p>A specified resource could not be located.</p>
66
+ *
67
+ * @throws {@link ThrottlingException} (client fault)
68
+ * <p>The exception was interrupted by throttling.</p>
69
+ *
70
+ * @throws {@link ValidationException} (client fault)
71
+ * <p>A resource could not be validated.</p>
72
+ *
73
+ * @throws {@link NeptuneGraphServiceException}
74
+ * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
75
+ *
76
+ */
77
+ export declare class GetQueryCommand extends GetQueryCommand_base {
78
+ }
@@ -73,7 +73,7 @@ declare const ListGraphSnapshotsCommand_base: {
73
73
  * <p>The exception was interrupted by throttling.</p>
74
74
  *
75
75
  * @throws {@link ValidationException} (client fault)
76
- * <p>A resource could not be validated</p>
76
+ * <p>A resource could not be validated.</p>
77
77
  *
78
78
  * @throws {@link NeptuneGraphServiceException}
79
79
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -71,7 +71,7 @@ declare const ListImportTasksCommand_base: {
71
71
  * <p>The exception was interrupted by throttling.</p>
72
72
  *
73
73
  * @throws {@link ValidationException} (client fault)
74
- * <p>A resource could not be validated</p>
74
+ * <p>A resource could not be validated.</p>
75
75
  *
76
76
  * @throws {@link NeptuneGraphServiceException}
77
77
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
@@ -72,7 +72,7 @@ declare const ListPrivateGraphEndpointsCommand_base: {
72
72
  * <p>The exception was interrupted by throttling.</p>
73
73
  *
74
74
  * @throws {@link ValidationException} (client fault)
75
- * <p>A resource could not be validated</p>
75
+ * <p>A resource could not be validated.</p>
76
76
  *
77
77
  * @throws {@link NeptuneGraphServiceException}
78
78
  * <p>Base exception class for all service exceptions from NeptuneGraph service.</p>