@aws-sdk/client-neptune-graph 3.504.0 → 3.507.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 +43 -3
- package/dist-cjs/commands/CancelQueryCommand.js +1 -0
- package/dist-cjs/commands/ExecuteQueryCommand.js +1 -0
- package/dist-cjs/commands/GetGraphSummaryCommand.js +1 -0
- package/dist-cjs/commands/GetQueryCommand.js +1 -0
- package/dist-cjs/commands/ListQueriesCommand.js +1 -0
- package/dist-cjs/index.js +511 -698
- package/dist-cjs/runtimeConfig.shared.js +2 -0
- package/dist-es/NeptuneGraph.js +10 -0
- package/dist-es/commands/CancelQueryCommand.js +25 -0
- package/dist-es/commands/ExecuteQueryCommand.js +26 -0
- package/dist-es/commands/GetGraphSummaryCommand.js +25 -0
- package/dist-es/commands/GetQueryCommand.js +25 -0
- package/dist-es/commands/ListQueriesCommand.js +25 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +91 -29
- package/dist-es/protocols/Aws_restJson1.js +252 -639
- package/dist-es/runtimeConfig.shared.js +2 -0
- package/dist-types/NeptuneGraph.d.ts +38 -3
- package/dist-types/NeptuneGraphClient.d.ts +16 -6
- package/dist-types/commands/CancelImportTaskCommand.d.ts +2 -2
- package/dist-types/commands/CancelQueryCommand.d.ts +72 -0
- package/dist-types/commands/CreateGraphCommand.d.ts +1 -1
- package/dist-types/commands/CreateGraphSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/CreateGraphUsingImportTaskCommand.d.ts +1 -1
- package/dist-types/commands/CreatePrivateGraphEndpointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGraphCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGraphSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/DeletePrivateGraphEndpointCommand.d.ts +1 -1
- package/dist-types/commands/ExecuteQueryCommand.d.ts +90 -0
- package/dist-types/commands/GetGraphCommand.d.ts +1 -1
- package/dist-types/commands/GetGraphSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/GetGraphSummaryCommand.d.ts +120 -0
- package/dist-types/commands/GetImportTaskCommand.d.ts +1 -1
- package/dist-types/commands/GetPrivateGraphEndpointCommand.d.ts +1 -1
- package/dist-types/commands/GetQueryCommand.d.ts +78 -0
- package/dist-types/commands/ListGraphSnapshotsCommand.d.ts +1 -1
- package/dist-types/commands/ListImportTasksCommand.d.ts +1 -1
- package/dist-types/commands/ListPrivateGraphEndpointsCommand.d.ts +1 -1
- package/dist-types/commands/ListQueriesCommand.d.ts +80 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ResetGraphCommand.d.ts +1 -1
- package/dist-types/commands/RestoreGraphFromSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGraphCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/index.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +522 -78
- package/dist-types/protocols/Aws_restJson1.d.ts +46 -1
- package/dist-types/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/runtimeConfig.d.ts +1 -0
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/ts3.4/NeptuneGraph.d.ts +85 -0
- package/dist-types/ts3.4/NeptuneGraphClient.d.ts +32 -0
- package/dist-types/ts3.4/commands/CancelQueryCommand.d.ts +24 -0
- package/dist-types/ts3.4/commands/ExecuteQueryCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/GetGraphSummaryCommand.d.ts +29 -0
- package/dist-types/ts3.4/commands/GetQueryCommand.d.ts +26 -0
- package/dist-types/ts3.4/commands/ListQueriesCommand.d.ts +26 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +182 -44
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +64 -1
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -0
- package/package.json +4 -3
|
@@ -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
|
|
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
|
|
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
|
|
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>
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListQueriesInput, ListQueriesOutput } 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 ListQueriesCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface ListQueriesCommandInput extends ListQueriesInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link ListQueriesCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface ListQueriesCommandOutput extends ListQueriesOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const ListQueriesCommand_base: {
|
|
24
|
+
new (input: ListQueriesCommandInput): import("@smithy/smithy-client").CommandImpl<ListQueriesCommandInput, ListQueriesCommandOutput, NeptuneGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
* <p>Lists active openCypher queries.</p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { NeptuneGraphClient, ListQueriesCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
|
|
34
|
+
* // const { NeptuneGraphClient, ListQueriesCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
|
|
35
|
+
* const client = new NeptuneGraphClient(config);
|
|
36
|
+
* const input = { // ListQueriesInput
|
|
37
|
+
* graphIdentifier: "STRING_VALUE", // required
|
|
38
|
+
* maxResults: Number("int"), // required
|
|
39
|
+
* state: "ALL" || "RUNNING" || "WAITING" || "CANCELLING",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListQueriesCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListQueriesOutput
|
|
44
|
+
* // queries: [ // QuerySummaryList // required
|
|
45
|
+
* // { // QuerySummary
|
|
46
|
+
* // id: "STRING_VALUE",
|
|
47
|
+
* // queryString: "STRING_VALUE",
|
|
48
|
+
* // waited: Number("int"),
|
|
49
|
+
* // elapsed: Number("int"),
|
|
50
|
+
* // state: "RUNNING" || "WAITING" || "CANCELLING",
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param ListQueriesCommandInput - {@link ListQueriesCommandInput}
|
|
58
|
+
* @returns {@link ListQueriesCommandOutput}
|
|
59
|
+
* @see {@link ListQueriesCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link ListQueriesCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link NeptuneGraphClientResolvedConfig | config} for NeptuneGraphClient's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
+
* <p>Raised in case of an authentication or authorization failure.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerException} (server fault)
|
|
67
|
+
* <p>A failure occurred on the server.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
+
* <p>The exception was interrupted by throttling.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ValidationException} (client fault)
|
|
73
|
+
* <p>A resource could not be validated.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link NeptuneGraphServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
|
|
77
|
+
*
|
|
78
|
+
*/
|
|
79
|
+
export declare class ListQueriesCommand extends ListQueriesCommand_base {
|
|
80
|
+
}
|
|
@@ -62,7 +62,7 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
62
62
|
* <p>The exception was interrupted by throttling.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ValidationException} (client fault)
|
|
65
|
-
* <p>A resource could not be validated
|
|
65
|
+
* <p>A resource could not be validated.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link NeptuneGraphServiceException}
|
|
68
68
|
* <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
|
|
@@ -80,7 +80,7 @@ declare const ResetGraphCommand_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
|
|
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>
|
|
@@ -90,7 +90,7 @@ declare const RestoreGraphFromSnapshotCommand_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
|
|
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>
|
|
@@ -61,7 +61,7 @@ declare const TagResourceCommand_base: {
|
|
|
61
61
|
* <p>The exception was interrupted by throttling.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ValidationException} (client fault)
|
|
64
|
-
* <p>A resource could not be validated
|
|
64
|
+
* <p>A resource could not be validated.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link NeptuneGraphServiceException}
|
|
67
67
|
* <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
|
|
@@ -61,7 +61,7 @@ declare const UntagResourceCommand_base: {
|
|
|
61
61
|
* <p>The exception was interrupted by throttling.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ValidationException} (client fault)
|
|
64
|
-
* <p>A resource could not be validated
|
|
64
|
+
* <p>A resource could not be validated.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link NeptuneGraphServiceException}
|
|
67
67
|
* <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
|
|
@@ -82,7 +82,7 @@ declare const UpdateGraphCommand_base: {
|
|
|
82
82
|
* <p>The exception was interrupted by throttling.</p>
|
|
83
83
|
*
|
|
84
84
|
* @throws {@link ValidationException} (client fault)
|
|
85
|
-
* <p>A resource could not be validated
|
|
85
|
+
* <p>A resource could not be validated.</p>
|
|
86
86
|
*
|
|
87
87
|
* @throws {@link NeptuneGraphServiceException}
|
|
88
88
|
* <p>Base exception class for all service exceptions from NeptuneGraph service.</p>
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export * from "./CancelImportTaskCommand";
|
|
2
|
+
export * from "./CancelQueryCommand";
|
|
2
3
|
export * from "./CreateGraphCommand";
|
|
3
4
|
export * from "./CreateGraphSnapshotCommand";
|
|
4
5
|
export * from "./CreateGraphUsingImportTaskCommand";
|
|
@@ -6,14 +7,18 @@ export * from "./CreatePrivateGraphEndpointCommand";
|
|
|
6
7
|
export * from "./DeleteGraphCommand";
|
|
7
8
|
export * from "./DeleteGraphSnapshotCommand";
|
|
8
9
|
export * from "./DeletePrivateGraphEndpointCommand";
|
|
10
|
+
export * from "./ExecuteQueryCommand";
|
|
9
11
|
export * from "./GetGraphCommand";
|
|
10
12
|
export * from "./GetGraphSnapshotCommand";
|
|
13
|
+
export * from "./GetGraphSummaryCommand";
|
|
11
14
|
export * from "./GetImportTaskCommand";
|
|
12
15
|
export * from "./GetPrivateGraphEndpointCommand";
|
|
16
|
+
export * from "./GetQueryCommand";
|
|
13
17
|
export * from "./ListGraphSnapshotsCommand";
|
|
14
18
|
export * from "./ListGraphsCommand";
|
|
15
19
|
export * from "./ListImportTasksCommand";
|
|
16
20
|
export * from "./ListPrivateGraphEndpointsCommand";
|
|
21
|
+
export * from "./ListQueriesCommand";
|
|
17
22
|
export * from "./ListTagsForResourceCommand";
|
|
18
23
|
export * from "./ResetGraphCommand";
|
|
19
24
|
export * from "./RestoreGraphFromSnapshotCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>Neptune Analytics is a
|
|
3
|
-
*
|
|
4
|
-
*
|
|
2
|
+
* <p>Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to
|
|
3
|
+
* insights faster by quickly processing large amounts of graph data, invoking popular graph analytic
|
|
4
|
+
* algorithms in low-latency queries, and getting analytics results in seconds.</p>
|
|
5
5
|
*
|
|
6
6
|
* @packageDocumentation
|
|
7
7
|
*/
|