@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.
Files changed (243) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +555 -0
  3. package/dist-cjs/Neptunedata.js +97 -0
  4. package/dist-cjs/NeptunedataClient.js +43 -0
  5. package/dist-cjs/commands/CancelGremlinQueryCommand.js +46 -0
  6. package/dist-cjs/commands/CancelLoaderJobCommand.js +46 -0
  7. package/dist-cjs/commands/CancelMLDataProcessingJobCommand.js +46 -0
  8. package/dist-cjs/commands/CancelMLModelTrainingJobCommand.js +46 -0
  9. package/dist-cjs/commands/CancelMLModelTransformJobCommand.js +46 -0
  10. package/dist-cjs/commands/CancelOpenCypherQueryCommand.js +46 -0
  11. package/dist-cjs/commands/CreateMLEndpointCommand.js +46 -0
  12. package/dist-cjs/commands/DeleteMLEndpointCommand.js +46 -0
  13. package/dist-cjs/commands/DeletePropertygraphStatisticsCommand.js +46 -0
  14. package/dist-cjs/commands/DeleteSparqlStatisticsCommand.js +46 -0
  15. package/dist-cjs/commands/ExecuteFastResetCommand.js +46 -0
  16. package/dist-cjs/commands/ExecuteGremlinExplainQueryCommand.js +46 -0
  17. package/dist-cjs/commands/ExecuteGremlinProfileQueryCommand.js +46 -0
  18. package/dist-cjs/commands/ExecuteGremlinQueryCommand.js +46 -0
  19. package/dist-cjs/commands/ExecuteOpenCypherExplainQueryCommand.js +46 -0
  20. package/dist-cjs/commands/ExecuteOpenCypherQueryCommand.js +46 -0
  21. package/dist-cjs/commands/GetEngineStatusCommand.js +46 -0
  22. package/dist-cjs/commands/GetGremlinQueryStatusCommand.js +46 -0
  23. package/dist-cjs/commands/GetLoaderJobStatusCommand.js +46 -0
  24. package/dist-cjs/commands/GetMLDataProcessingJobCommand.js +46 -0
  25. package/dist-cjs/commands/GetMLEndpointCommand.js +46 -0
  26. package/dist-cjs/commands/GetMLModelTrainingJobCommand.js +46 -0
  27. package/dist-cjs/commands/GetMLModelTransformJobCommand.js +46 -0
  28. package/dist-cjs/commands/GetOpenCypherQueryStatusCommand.js +46 -0
  29. package/dist-cjs/commands/GetPropertygraphStatisticsCommand.js +46 -0
  30. package/dist-cjs/commands/GetPropertygraphStreamCommand.js +46 -0
  31. package/dist-cjs/commands/GetPropertygraphSummaryCommand.js +46 -0
  32. package/dist-cjs/commands/GetRDFGraphSummaryCommand.js +46 -0
  33. package/dist-cjs/commands/GetSparqlStatisticsCommand.js +46 -0
  34. package/dist-cjs/commands/GetSparqlStreamCommand.js +46 -0
  35. package/dist-cjs/commands/ListGremlinQueriesCommand.js +46 -0
  36. package/dist-cjs/commands/ListLoaderJobsCommand.js +46 -0
  37. package/dist-cjs/commands/ListMLDataProcessingJobsCommand.js +46 -0
  38. package/dist-cjs/commands/ListMLEndpointsCommand.js +46 -0
  39. package/dist-cjs/commands/ListMLModelTrainingJobsCommand.js +46 -0
  40. package/dist-cjs/commands/ListMLModelTransformJobsCommand.js +46 -0
  41. package/dist-cjs/commands/ListOpenCypherQueriesCommand.js +46 -0
  42. package/dist-cjs/commands/ManagePropertygraphStatisticsCommand.js +46 -0
  43. package/dist-cjs/commands/ManageSparqlStatisticsCommand.js +46 -0
  44. package/dist-cjs/commands/StartLoaderJobCommand.js +46 -0
  45. package/dist-cjs/commands/StartMLDataProcessingJobCommand.js +46 -0
  46. package/dist-cjs/commands/StartMLModelTrainingJobCommand.js +46 -0
  47. package/dist-cjs/commands/StartMLModelTransformJobCommand.js +46 -0
  48. package/dist-cjs/commands/index.js +46 -0
  49. package/dist-cjs/endpoint/EndpointParameters.js +12 -0
  50. package/dist-cjs/endpoint/endpointResolver.js +12 -0
  51. package/dist-cjs/endpoint/ruleset.js +7 -0
  52. package/dist-cjs/extensionConfiguration.js +2 -0
  53. package/dist-cjs/index.js +10 -0
  54. package/dist-cjs/models/NeptunedataServiceException.js +12 -0
  55. package/dist-cjs/models/index.js +4 -0
  56. package/dist-cjs/models/models_0.js +631 -0
  57. package/dist-cjs/protocols/Aws_restJson1.js +4771 -0
  58. package/dist-cjs/runtimeConfig.browser.js +39 -0
  59. package/dist-cjs/runtimeConfig.js +48 -0
  60. package/dist-cjs/runtimeConfig.native.js +15 -0
  61. package/dist-cjs/runtimeConfig.shared.js +22 -0
  62. package/dist-cjs/runtimeExtensions.js +16 -0
  63. package/dist-es/Neptunedata.js +93 -0
  64. package/dist-es/NeptunedataClient.js +39 -0
  65. package/dist-es/commands/CancelGremlinQueryCommand.js +42 -0
  66. package/dist-es/commands/CancelLoaderJobCommand.js +42 -0
  67. package/dist-es/commands/CancelMLDataProcessingJobCommand.js +42 -0
  68. package/dist-es/commands/CancelMLModelTrainingJobCommand.js +42 -0
  69. package/dist-es/commands/CancelMLModelTransformJobCommand.js +42 -0
  70. package/dist-es/commands/CancelOpenCypherQueryCommand.js +42 -0
  71. package/dist-es/commands/CreateMLEndpointCommand.js +42 -0
  72. package/dist-es/commands/DeleteMLEndpointCommand.js +42 -0
  73. package/dist-es/commands/DeletePropertygraphStatisticsCommand.js +42 -0
  74. package/dist-es/commands/DeleteSparqlStatisticsCommand.js +42 -0
  75. package/dist-es/commands/ExecuteFastResetCommand.js +42 -0
  76. package/dist-es/commands/ExecuteGremlinExplainQueryCommand.js +42 -0
  77. package/dist-es/commands/ExecuteGremlinProfileQueryCommand.js +42 -0
  78. package/dist-es/commands/ExecuteGremlinQueryCommand.js +42 -0
  79. package/dist-es/commands/ExecuteOpenCypherExplainQueryCommand.js +42 -0
  80. package/dist-es/commands/ExecuteOpenCypherQueryCommand.js +42 -0
  81. package/dist-es/commands/GetEngineStatusCommand.js +42 -0
  82. package/dist-es/commands/GetGremlinQueryStatusCommand.js +42 -0
  83. package/dist-es/commands/GetLoaderJobStatusCommand.js +42 -0
  84. package/dist-es/commands/GetMLDataProcessingJobCommand.js +42 -0
  85. package/dist-es/commands/GetMLEndpointCommand.js +42 -0
  86. package/dist-es/commands/GetMLModelTrainingJobCommand.js +42 -0
  87. package/dist-es/commands/GetMLModelTransformJobCommand.js +42 -0
  88. package/dist-es/commands/GetOpenCypherQueryStatusCommand.js +42 -0
  89. package/dist-es/commands/GetPropertygraphStatisticsCommand.js +42 -0
  90. package/dist-es/commands/GetPropertygraphStreamCommand.js +42 -0
  91. package/dist-es/commands/GetPropertygraphSummaryCommand.js +42 -0
  92. package/dist-es/commands/GetRDFGraphSummaryCommand.js +42 -0
  93. package/dist-es/commands/GetSparqlStatisticsCommand.js +42 -0
  94. package/dist-es/commands/GetSparqlStreamCommand.js +42 -0
  95. package/dist-es/commands/ListGremlinQueriesCommand.js +42 -0
  96. package/dist-es/commands/ListLoaderJobsCommand.js +42 -0
  97. package/dist-es/commands/ListMLDataProcessingJobsCommand.js +42 -0
  98. package/dist-es/commands/ListMLEndpointsCommand.js +42 -0
  99. package/dist-es/commands/ListMLModelTrainingJobsCommand.js +42 -0
  100. package/dist-es/commands/ListMLModelTransformJobsCommand.js +42 -0
  101. package/dist-es/commands/ListOpenCypherQueriesCommand.js +42 -0
  102. package/dist-es/commands/ManagePropertygraphStatisticsCommand.js +42 -0
  103. package/dist-es/commands/ManageSparqlStatisticsCommand.js +42 -0
  104. package/dist-es/commands/StartLoaderJobCommand.js +42 -0
  105. package/dist-es/commands/StartMLDataProcessingJobCommand.js +42 -0
  106. package/dist-es/commands/StartMLModelTrainingJobCommand.js +42 -0
  107. package/dist-es/commands/StartMLModelTransformJobCommand.js +42 -0
  108. package/dist-es/commands/index.js +43 -0
  109. package/dist-es/endpoint/EndpointParameters.js +8 -0
  110. package/dist-es/endpoint/endpointResolver.js +8 -0
  111. package/dist-es/endpoint/ruleset.js +4 -0
  112. package/dist-es/extensionConfiguration.js +1 -0
  113. package/dist-es/index.js +5 -0
  114. package/dist-es/models/NeptunedataServiceException.js +8 -0
  115. package/dist-es/models/index.js +1 -0
  116. package/dist-es/models/models_0.js +594 -0
  117. package/dist-es/protocols/Aws_restJson1.js +4681 -0
  118. package/dist-es/runtimeConfig.browser.js +34 -0
  119. package/dist-es/runtimeConfig.js +43 -0
  120. package/dist-es/runtimeConfig.native.js +11 -0
  121. package/dist-es/runtimeConfig.shared.js +18 -0
  122. package/dist-es/runtimeExtensions.js +12 -0
  123. package/dist-types/Neptunedata.d.ts +316 -0
  124. package/dist-types/NeptunedataClient.d.ts +215 -0
  125. package/dist-types/commands/CancelGremlinQueryCommand.d.ts +117 -0
  126. package/dist-types/commands/CancelLoaderJobCommand.d.ts +115 -0
  127. package/dist-types/commands/CancelMLDataProcessingJobCommand.d.ts +109 -0
  128. package/dist-types/commands/CancelMLModelTrainingJobCommand.d.ts +109 -0
  129. package/dist-types/commands/CancelMLModelTransformJobCommand.d.ts +109 -0
  130. package/dist-types/commands/CancelOpenCypherQueryCommand.d.ts +122 -0
  131. package/dist-types/commands/CreateMLEndpointCommand.d.ts +119 -0
  132. package/dist-types/commands/DeleteMLEndpointCommand.d.ts +110 -0
  133. package/dist-types/commands/DeletePropertygraphStatisticsCommand.d.ts +116 -0
  134. package/dist-types/commands/DeleteSparqlStatisticsCommand.d.ts +115 -0
  135. package/dist-types/commands/ExecuteFastResetCommand.d.ts +123 -0
  136. package/dist-types/commands/ExecuteGremlinExplainQueryCommand.d.ts +155 -0
  137. package/dist-types/commands/ExecuteGremlinProfileQueryCommand.d.ts +151 -0
  138. package/dist-types/commands/ExecuteGremlinQueryCommand.d.ts +150 -0
  139. package/dist-types/commands/ExecuteOpenCypherExplainQueryCommand.d.ts +151 -0
  140. package/dist-types/commands/ExecuteOpenCypherQueryCommand.d.ts +151 -0
  141. package/dist-types/commands/GetEngineStatusCommand.d.ts +119 -0
  142. package/dist-types/commands/GetGremlinQueryStatusCommand.d.ts +129 -0
  143. package/dist-types/commands/GetLoaderJobStatusCommand.d.ts +121 -0
  144. package/dist-types/commands/GetMLDataProcessingJobCommand.d.ts +117 -0
  145. package/dist-types/commands/GetMLEndpointCommand.d.ts +121 -0
  146. package/dist-types/commands/GetMLModelTrainingJobCommand.d.ts +139 -0
  147. package/dist-types/commands/GetMLModelTransformJobCommand.d.ts +131 -0
  148. package/dist-types/commands/GetOpenCypherQueryStatusCommand.d.ts +132 -0
  149. package/dist-types/commands/GetPropertygraphStatisticsCommand.d.ts +122 -0
  150. package/dist-types/commands/GetPropertygraphStreamCommand.d.ts +147 -0
  151. package/dist-types/commands/GetPropertygraphSummaryCommand.d.ts +161 -0
  152. package/dist-types/commands/GetRDFGraphSummaryCommand.d.ts +138 -0
  153. package/dist-types/commands/GetSparqlStatisticsCommand.d.ts +122 -0
  154. package/dist-types/commands/GetSparqlStreamCommand.d.ts +142 -0
  155. package/dist-types/commands/ListGremlinQueriesCommand.d.ts +136 -0
  156. package/dist-types/commands/ListLoaderJobsCommand.d.ts +116 -0
  157. package/dist-types/commands/ListMLDataProcessingJobsCommand.d.ts +110 -0
  158. package/dist-types/commands/ListMLEndpointsCommand.d.ts +110 -0
  159. package/dist-types/commands/ListMLModelTrainingJobsCommand.d.ts +110 -0
  160. package/dist-types/commands/ListMLModelTransformJobsCommand.d.ts +110 -0
  161. package/dist-types/commands/ListOpenCypherQueriesCommand.d.ts +139 -0
  162. package/dist-types/commands/ManagePropertygraphStatisticsCommand.d.ts +115 -0
  163. package/dist-types/commands/ManageSparqlStatisticsCommand.d.ts +115 -0
  164. package/dist-types/commands/StartLoaderJobCommand.d.ts +135 -0
  165. package/dist-types/commands/StartMLDataProcessingJobCommand.d.ts +128 -0
  166. package/dist-types/commands/StartMLModelTrainingJobCommand.d.ts +134 -0
  167. package/dist-types/commands/StartMLModelTransformJobCommand.d.ts +129 -0
  168. package/dist-types/commands/index.d.ts +43 -0
  169. package/dist-types/endpoint/EndpointParameters.d.ts +22 -0
  170. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  171. package/dist-types/endpoint/ruleset.d.ts +2 -0
  172. package/dist-types/extensionConfiguration.d.ts +6 -0
  173. package/dist-types/index.d.ts +16 -0
  174. package/dist-types/models/NeptunedataServiceException.d.ts +13 -0
  175. package/dist-types/models/index.d.ts +1 -0
  176. package/dist-types/models/models_0.d.ts +4026 -0
  177. package/dist-types/protocols/Aws_restJson1.d.ts +389 -0
  178. package/dist-types/runtimeConfig.browser.d.ts +46 -0
  179. package/dist-types/runtimeConfig.d.ts +43 -0
  180. package/dist-types/runtimeConfig.native.d.ts +42 -0
  181. package/dist-types/runtimeConfig.shared.d.ts +19 -0
  182. package/dist-types/runtimeExtensions.d.ts +17 -0
  183. package/dist-types/ts3.4/Neptunedata.d.ts +738 -0
  184. package/dist-types/ts3.4/NeptunedataClient.d.ts +376 -0
  185. package/dist-types/ts3.4/commands/CancelGremlinQueryCommand.d.ts +39 -0
  186. package/dist-types/ts3.4/commands/CancelLoaderJobCommand.d.ts +38 -0
  187. package/dist-types/ts3.4/commands/CancelMLDataProcessingJobCommand.d.ts +42 -0
  188. package/dist-types/ts3.4/commands/CancelMLModelTrainingJobCommand.d.ts +42 -0
  189. package/dist-types/ts3.4/commands/CancelMLModelTransformJobCommand.d.ts +42 -0
  190. package/dist-types/ts3.4/commands/CancelOpenCypherQueryCommand.d.ts +42 -0
  191. package/dist-types/ts3.4/commands/CreateMLEndpointCommand.d.ts +38 -0
  192. package/dist-types/ts3.4/commands/DeleteMLEndpointCommand.d.ts +38 -0
  193. package/dist-types/ts3.4/commands/DeletePropertygraphStatisticsCommand.d.ts +38 -0
  194. package/dist-types/ts3.4/commands/DeleteSparqlStatisticsCommand.d.ts +38 -0
  195. package/dist-types/ts3.4/commands/ExecuteFastResetCommand.d.ts +38 -0
  196. package/dist-types/ts3.4/commands/ExecuteGremlinExplainQueryCommand.d.ts +49 -0
  197. package/dist-types/ts3.4/commands/ExecuteGremlinProfileQueryCommand.d.ts +49 -0
  198. package/dist-types/ts3.4/commands/ExecuteGremlinQueryCommand.d.ts +39 -0
  199. package/dist-types/ts3.4/commands/ExecuteOpenCypherExplainQueryCommand.d.ts +49 -0
  200. package/dist-types/ts3.4/commands/ExecuteOpenCypherQueryCommand.d.ts +42 -0
  201. package/dist-types/ts3.4/commands/GetEngineStatusCommand.d.ts +35 -0
  202. package/dist-types/ts3.4/commands/GetGremlinQueryStatusCommand.d.ts +42 -0
  203. package/dist-types/ts3.4/commands/GetLoaderJobStatusCommand.d.ts +39 -0
  204. package/dist-types/ts3.4/commands/GetMLDataProcessingJobCommand.d.ts +42 -0
  205. package/dist-types/ts3.4/commands/GetMLEndpointCommand.d.ts +35 -0
  206. package/dist-types/ts3.4/commands/GetMLModelTrainingJobCommand.d.ts +42 -0
  207. package/dist-types/ts3.4/commands/GetMLModelTransformJobCommand.d.ts +42 -0
  208. package/dist-types/ts3.4/commands/GetOpenCypherQueryStatusCommand.d.ts +42 -0
  209. package/dist-types/ts3.4/commands/GetPropertygraphStatisticsCommand.d.ts +38 -0
  210. package/dist-types/ts3.4/commands/GetPropertygraphStreamCommand.d.ts +42 -0
  211. package/dist-types/ts3.4/commands/GetPropertygraphSummaryCommand.d.ts +42 -0
  212. package/dist-types/ts3.4/commands/GetRDFGraphSummaryCommand.d.ts +39 -0
  213. package/dist-types/ts3.4/commands/GetSparqlStatisticsCommand.d.ts +35 -0
  214. package/dist-types/ts3.4/commands/GetSparqlStreamCommand.d.ts +38 -0
  215. package/dist-types/ts3.4/commands/ListGremlinQueriesCommand.d.ts +39 -0
  216. package/dist-types/ts3.4/commands/ListLoaderJobsCommand.d.ts +35 -0
  217. package/dist-types/ts3.4/commands/ListMLDataProcessingJobsCommand.d.ts +42 -0
  218. package/dist-types/ts3.4/commands/ListMLEndpointsCommand.d.ts +38 -0
  219. package/dist-types/ts3.4/commands/ListMLModelTrainingJobsCommand.d.ts +42 -0
  220. package/dist-types/ts3.4/commands/ListMLModelTransformJobsCommand.d.ts +42 -0
  221. package/dist-types/ts3.4/commands/ListOpenCypherQueriesCommand.d.ts +42 -0
  222. package/dist-types/ts3.4/commands/ManagePropertygraphStatisticsCommand.d.ts +42 -0
  223. package/dist-types/ts3.4/commands/ManageSparqlStatisticsCommand.d.ts +42 -0
  224. package/dist-types/ts3.4/commands/StartLoaderJobCommand.d.ts +35 -0
  225. package/dist-types/ts3.4/commands/StartMLDataProcessingJobCommand.d.ts +42 -0
  226. package/dist-types/ts3.4/commands/StartMLModelTrainingJobCommand.d.ts +42 -0
  227. package/dist-types/ts3.4/commands/StartMLModelTransformJobCommand.d.ts +42 -0
  228. package/dist-types/ts3.4/commands/index.d.ts +43 -0
  229. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
  230. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  231. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  232. package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -0
  233. package/dist-types/ts3.4/index.d.ts +6 -0
  234. package/dist-types/ts3.4/models/NeptunedataServiceException.d.ts +8 -0
  235. package/dist-types/ts3.4/models/index.d.ts +1 -0
  236. package/dist-types/ts3.4/models/models_0.d.ts +994 -0
  237. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +521 -0
  238. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +90 -0
  239. package/dist-types/ts3.4/runtimeConfig.d.ts +90 -0
  240. package/dist-types/ts3.4/runtimeConfig.native.d.ts +81 -0
  241. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
  242. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  243. package/package.json +100 -0
@@ -0,0 +1,4026 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { DocumentType as __DocumentType } from "@smithy/types";
3
+ import { NeptunedataServiceException as __BaseException } from "./NeptunedataServiceException";
4
+ /**
5
+ * @public
6
+ * <p>Raised in case of an authentication or authorization failure.</p>
7
+ */
8
+ export declare class AccessDeniedException extends __BaseException {
9
+ readonly name: "AccessDeniedException";
10
+ readonly $fault: "client";
11
+ /**
12
+ * @public
13
+ * <p>A detailed message describing the problem.</p>
14
+ */
15
+ detailedMessage: string | undefined;
16
+ /**
17
+ * @public
18
+ * <p>The ID of the request in question.</p>
19
+ */
20
+ requestId: string | undefined;
21
+ /**
22
+ * @public
23
+ * <p>The HTTP status code returned with the exception.</p>
24
+ */
25
+ code: string | undefined;
26
+ /**
27
+ * @internal
28
+ */
29
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
30
+ }
31
+ /**
32
+ * @public
33
+ * @enum
34
+ */
35
+ export declare const Action: {
36
+ readonly INITIALIZE_RESET: "initiateDatabaseReset";
37
+ readonly PERFORM_RESET: "performDatabaseReset";
38
+ };
39
+ /**
40
+ * @public
41
+ */
42
+ export type Action = (typeof Action)[keyof typeof Action];
43
+ /**
44
+ * @public
45
+ * <p>Raised when a request is submitted that cannot be processed.</p>
46
+ */
47
+ export declare class BadRequestException extends __BaseException {
48
+ readonly name: "BadRequestException";
49
+ readonly $fault: "client";
50
+ /**
51
+ * @public
52
+ * <p>A detailed message describing the problem.</p>
53
+ */
54
+ detailedMessage: string | undefined;
55
+ /**
56
+ * @public
57
+ * <p>The ID of the bad request.</p>
58
+ */
59
+ requestId: string | undefined;
60
+ /**
61
+ * @public
62
+ * <p>The HTTP status code returned with the exception.</p>
63
+ */
64
+ code: string | undefined;
65
+ /**
66
+ * @internal
67
+ */
68
+ constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
69
+ }
70
+ /**
71
+ * @public
72
+ */
73
+ export interface CancelGremlinQueryInput {
74
+ /**
75
+ * @public
76
+ * <p>The unique identifier that identifies the query to be canceled.</p>
77
+ */
78
+ queryId: string | undefined;
79
+ }
80
+ /**
81
+ * @public
82
+ */
83
+ export interface CancelGremlinQueryOutput {
84
+ /**
85
+ * @public
86
+ * <p>The status of the cancelation</p>
87
+ */
88
+ status?: string;
89
+ }
90
+ /**
91
+ * @public
92
+ * <p>Raised when a request timed out in the client.</p>
93
+ */
94
+ export declare class ClientTimeoutException extends __BaseException {
95
+ readonly name: "ClientTimeoutException";
96
+ readonly $fault: "client";
97
+ $retryable: {};
98
+ /**
99
+ * @public
100
+ * <p>A detailed message describing the problem.</p>
101
+ */
102
+ detailedMessage: string | undefined;
103
+ /**
104
+ * @public
105
+ * <p>The ID of the request in question.</p>
106
+ */
107
+ requestId: string | undefined;
108
+ /**
109
+ * @public
110
+ * <p>The HTTP status code returned with the exception.</p>
111
+ */
112
+ code: string | undefined;
113
+ /**
114
+ * @internal
115
+ */
116
+ constructor(opts: __ExceptionOptionType<ClientTimeoutException, __BaseException>);
117
+ }
118
+ /**
119
+ * @public
120
+ * <p>Raised when a request attempts to modify data that is concurrently being
121
+ * modified by another process.</p>
122
+ */
123
+ export declare class ConcurrentModificationException extends __BaseException {
124
+ readonly name: "ConcurrentModificationException";
125
+ readonly $fault: "server";
126
+ $retryable: {};
127
+ /**
128
+ * @public
129
+ * <p>A detailed message describing the problem.</p>
130
+ */
131
+ detailedMessage: string | undefined;
132
+ /**
133
+ * @public
134
+ * <p>The ID of the request in question.</p>
135
+ */
136
+ requestId: string | undefined;
137
+ /**
138
+ * @public
139
+ * <p>The HTTP status code returned with the exception.</p>
140
+ */
141
+ code: string | undefined;
142
+ /**
143
+ * @internal
144
+ */
145
+ constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
146
+ }
147
+ /**
148
+ * @public
149
+ * <p>Raised when a value in a request field did not satisfy required constraints.</p>
150
+ */
151
+ export declare class ConstraintViolationException extends __BaseException {
152
+ readonly name: "ConstraintViolationException";
153
+ readonly $fault: "client";
154
+ $retryable: {};
155
+ /**
156
+ * @public
157
+ * <p>A detailed message describing the problem.</p>
158
+ */
159
+ detailedMessage: string | undefined;
160
+ /**
161
+ * @public
162
+ * <p>The ID of the request in question.</p>
163
+ */
164
+ requestId: string | undefined;
165
+ /**
166
+ * @public
167
+ * <p>The HTTP status code returned with the exception.</p>
168
+ */
169
+ code: string | undefined;
170
+ /**
171
+ * @internal
172
+ */
173
+ constructor(opts: __ExceptionOptionType<ConstraintViolationException, __BaseException>);
174
+ }
175
+ /**
176
+ * @public
177
+ * <p>Raised when a request fails.</p>
178
+ */
179
+ export declare class FailureByQueryException extends __BaseException {
180
+ readonly name: "FailureByQueryException";
181
+ readonly $fault: "server";
182
+ $retryable: {};
183
+ /**
184
+ * @public
185
+ * <p>A detailed message describing the problem.</p>
186
+ */
187
+ detailedMessage: string | undefined;
188
+ /**
189
+ * @public
190
+ * <p>The ID of the request in question.</p>
191
+ */
192
+ requestId: string | undefined;
193
+ /**
194
+ * @public
195
+ * <p>The HTTP status code returned with the exception.</p>
196
+ */
197
+ code: string | undefined;
198
+ /**
199
+ * @internal
200
+ */
201
+ constructor(opts: __ExceptionOptionType<FailureByQueryException, __BaseException>);
202
+ }
203
+ /**
204
+ * @public
205
+ * <p>Raised when an argument in a request is not supported.</p>
206
+ */
207
+ export declare class IllegalArgumentException extends __BaseException {
208
+ readonly name: "IllegalArgumentException";
209
+ readonly $fault: "client";
210
+ /**
211
+ * @public
212
+ * <p>A detailed message describing the problem.</p>
213
+ */
214
+ detailedMessage: string | undefined;
215
+ /**
216
+ * @public
217
+ * <p>The ID of the request in question.</p>
218
+ */
219
+ requestId: string | undefined;
220
+ /**
221
+ * @public
222
+ * <p>The HTTP status code returned with the exception.</p>
223
+ */
224
+ code: string | undefined;
225
+ /**
226
+ * @internal
227
+ */
228
+ constructor(opts: __ExceptionOptionType<IllegalArgumentException, __BaseException>);
229
+ }
230
+ /**
231
+ * @public
232
+ * <p>Raised when an argument in a request has an invalid value.</p>
233
+ */
234
+ export declare class InvalidArgumentException extends __BaseException {
235
+ readonly name: "InvalidArgumentException";
236
+ readonly $fault: "client";
237
+ /**
238
+ * @public
239
+ * <p>A detailed message describing the problem.</p>
240
+ */
241
+ detailedMessage: string | undefined;
242
+ /**
243
+ * @public
244
+ * <p>The ID of the request in question.</p>
245
+ */
246
+ requestId: string | undefined;
247
+ /**
248
+ * @public
249
+ * <p>The HTTP status code returned with the exception.</p>
250
+ */
251
+ code: string | undefined;
252
+ /**
253
+ * @internal
254
+ */
255
+ constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
256
+ }
257
+ /**
258
+ * @public
259
+ * <p>Raised when a parameter value is not valid.</p>
260
+ */
261
+ export declare class InvalidParameterException extends __BaseException {
262
+ readonly name: "InvalidParameterException";
263
+ readonly $fault: "client";
264
+ /**
265
+ * @public
266
+ * <p>A detailed message describing the problem.</p>
267
+ */
268
+ detailedMessage: string | undefined;
269
+ /**
270
+ * @public
271
+ * <p>The ID of the request that includes an invalid parameter.</p>
272
+ */
273
+ requestId: string | undefined;
274
+ /**
275
+ * @public
276
+ * <p>The HTTP status code returned with the exception.</p>
277
+ */
278
+ code: string | undefined;
279
+ /**
280
+ * @internal
281
+ */
282
+ constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
283
+ }
284
+ /**
285
+ * @public
286
+ * <p>Raised when a required parameter is missing.</p>
287
+ */
288
+ export declare class MissingParameterException extends __BaseException {
289
+ readonly name: "MissingParameterException";
290
+ readonly $fault: "client";
291
+ /**
292
+ * @public
293
+ * <p>A detailed message describing the problem.</p>
294
+ */
295
+ detailedMessage: string | undefined;
296
+ /**
297
+ * @public
298
+ * <p>The ID of the request in which the parameter is missing.</p>
299
+ */
300
+ requestId: string | undefined;
301
+ /**
302
+ * @public
303
+ * <p>The HTTP status code returned with the exception.</p>
304
+ */
305
+ code: string | undefined;
306
+ /**
307
+ * @internal
308
+ */
309
+ constructor(opts: __ExceptionOptionType<MissingParameterException, __BaseException>);
310
+ }
311
+ /**
312
+ * @public
313
+ * <p>Raised when a parsing issue is encountered.</p>
314
+ */
315
+ export declare class ParsingException extends __BaseException {
316
+ readonly name: "ParsingException";
317
+ readonly $fault: "client";
318
+ /**
319
+ * @public
320
+ * <p>A detailed message describing the problem.</p>
321
+ */
322
+ detailedMessage: string | undefined;
323
+ /**
324
+ * @public
325
+ * <p>The ID of the request in question.</p>
326
+ */
327
+ requestId: string | undefined;
328
+ /**
329
+ * @public
330
+ * <p>The HTTP status code returned with the exception.</p>
331
+ */
332
+ code: string | undefined;
333
+ /**
334
+ * @internal
335
+ */
336
+ constructor(opts: __ExceptionOptionType<ParsingException, __BaseException>);
337
+ }
338
+ /**
339
+ * @public
340
+ * <p>Raised when a precondition for processing a request is not satisfied.</p>
341
+ */
342
+ export declare class PreconditionsFailedException extends __BaseException {
343
+ readonly name: "PreconditionsFailedException";
344
+ readonly $fault: "client";
345
+ /**
346
+ * @public
347
+ * <p>A detailed message describing the problem.</p>
348
+ */
349
+ detailedMessage: string | undefined;
350
+ /**
351
+ * @public
352
+ * <p>The ID of the request in question.</p>
353
+ */
354
+ requestId: string | undefined;
355
+ /**
356
+ * @public
357
+ * <p>The HTTP status code returned with the exception.</p>
358
+ */
359
+ code: string | undefined;
360
+ /**
361
+ * @internal
362
+ */
363
+ constructor(opts: __ExceptionOptionType<PreconditionsFailedException, __BaseException>);
364
+ }
365
+ /**
366
+ * @public
367
+ * <p>Raised when the an operation exceeds the time limit allowed for it.</p>
368
+ */
369
+ export declare class TimeLimitExceededException extends __BaseException {
370
+ readonly name: "TimeLimitExceededException";
371
+ readonly $fault: "server";
372
+ $retryable: {};
373
+ /**
374
+ * @public
375
+ * <p>A detailed message describing the problem.</p>
376
+ */
377
+ detailedMessage: string | undefined;
378
+ /**
379
+ * @public
380
+ * <p>The ID of the request that could not be processed for this reason.</p>
381
+ */
382
+ requestId: string | undefined;
383
+ /**
384
+ * @public
385
+ * <p>The HTTP status code returned with the exception.</p>
386
+ */
387
+ code: string | undefined;
388
+ /**
389
+ * @internal
390
+ */
391
+ constructor(opts: __ExceptionOptionType<TimeLimitExceededException, __BaseException>);
392
+ }
393
+ /**
394
+ * @public
395
+ * <p>Raised when the number of requests being processed exceeds the limit.</p>
396
+ */
397
+ export declare class TooManyRequestsException extends __BaseException {
398
+ readonly name: "TooManyRequestsException";
399
+ readonly $fault: "client";
400
+ $retryable: {};
401
+ /**
402
+ * @public
403
+ * <p>A detailed message describing the problem.</p>
404
+ */
405
+ detailedMessage: string | undefined;
406
+ /**
407
+ * @public
408
+ * <p>The ID of the request that could not be processed for this reason.</p>
409
+ */
410
+ requestId: string | undefined;
411
+ /**
412
+ * @public
413
+ * <p>The HTTP status code returned with the exception.</p>
414
+ */
415
+ code: string | undefined;
416
+ /**
417
+ * @internal
418
+ */
419
+ constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
420
+ }
421
+ /**
422
+ * @public
423
+ * <p>Raised when a request attempts to initiate an operation that is not supported.</p>
424
+ */
425
+ export declare class UnsupportedOperationException extends __BaseException {
426
+ readonly name: "UnsupportedOperationException";
427
+ readonly $fault: "client";
428
+ /**
429
+ * @public
430
+ * <p>A detailed message describing the problem.</p>
431
+ */
432
+ detailedMessage: string | undefined;
433
+ /**
434
+ * @public
435
+ * <p>The ID of the request in question.</p>
436
+ */
437
+ requestId: string | undefined;
438
+ /**
439
+ * @public
440
+ * <p>The HTTP status code returned with the exception.</p>
441
+ */
442
+ code: string | undefined;
443
+ /**
444
+ * @internal
445
+ */
446
+ constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
447
+ }
448
+ /**
449
+ * @public
450
+ * <p>Raised when a specified bulk-load job ID cannot be found.</p>
451
+ */
452
+ export declare class BulkLoadIdNotFoundException extends __BaseException {
453
+ readonly name: "BulkLoadIdNotFoundException";
454
+ readonly $fault: "client";
455
+ $retryable: {};
456
+ /**
457
+ * @public
458
+ * <p>A detailed message describing the problem.</p>
459
+ */
460
+ detailedMessage: string | undefined;
461
+ /**
462
+ * @public
463
+ * <p>The bulk-load job ID that could not be found.</p>
464
+ */
465
+ requestId: string | undefined;
466
+ /**
467
+ * @public
468
+ * <p>The HTTP status code returned with the exception.</p>
469
+ */
470
+ code: string | undefined;
471
+ /**
472
+ * @internal
473
+ */
474
+ constructor(opts: __ExceptionOptionType<BulkLoadIdNotFoundException, __BaseException>);
475
+ }
476
+ /**
477
+ * @public
478
+ */
479
+ export interface CancelLoaderJobInput {
480
+ /**
481
+ * @public
482
+ * <p>The ID of the load job to be deleted.</p>
483
+ */
484
+ loadId: string | undefined;
485
+ }
486
+ /**
487
+ * @public
488
+ */
489
+ export interface CancelLoaderJobOutput {
490
+ /**
491
+ * @public
492
+ * <p>The cancellation status.</p>
493
+ */
494
+ status?: string;
495
+ }
496
+ /**
497
+ * @public
498
+ * <p>Raised when the processing of the request failed unexpectedly.</p>
499
+ */
500
+ export declare class InternalFailureException extends __BaseException {
501
+ readonly name: "InternalFailureException";
502
+ readonly $fault: "server";
503
+ /**
504
+ * @public
505
+ * <p>A detailed message describing the problem.</p>
506
+ */
507
+ detailedMessage: string | undefined;
508
+ /**
509
+ * @public
510
+ * <p>The ID of the request in question.</p>
511
+ */
512
+ requestId: string | undefined;
513
+ /**
514
+ * @public
515
+ * <p>The HTTP status code returned with the exception.</p>
516
+ */
517
+ code: string | undefined;
518
+ /**
519
+ * @internal
520
+ */
521
+ constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
522
+ }
523
+ /**
524
+ * @public
525
+ * <p>Raised when access is denied to a specified load URL.</p>
526
+ */
527
+ export declare class LoadUrlAccessDeniedException extends __BaseException {
528
+ readonly name: "LoadUrlAccessDeniedException";
529
+ readonly $fault: "client";
530
+ /**
531
+ * @public
532
+ * <p>A detailed message describing the problem.</p>
533
+ */
534
+ detailedMessage: string | undefined;
535
+ /**
536
+ * @public
537
+ * <p>The ID of the request in question.</p>
538
+ */
539
+ requestId: string | undefined;
540
+ /**
541
+ * @public
542
+ * <p>The HTTP status code returned with the exception.</p>
543
+ */
544
+ code: string | undefined;
545
+ /**
546
+ * @internal
547
+ */
548
+ constructor(opts: __ExceptionOptionType<LoadUrlAccessDeniedException, __BaseException>);
549
+ }
550
+ /**
551
+ * @public
552
+ */
553
+ export interface CancelMLDataProcessingJobInput {
554
+ /**
555
+ * @public
556
+ * <p>The unique identifier of the data-processing job.</p>
557
+ */
558
+ id: string | undefined;
559
+ /**
560
+ * @public
561
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
562
+ * and Amazon S3 resources. This must be listed in your DB cluster
563
+ * parameter group or an error will occur.</p>
564
+ */
565
+ neptuneIamRoleArn?: string;
566
+ /**
567
+ * @public
568
+ * <p>If set to <code>TRUE</code>, this flag specifies that all
569
+ * Neptune ML S3 artifacts should be deleted when the job is stopped.
570
+ * The default is <code>FALSE</code>.</p>
571
+ */
572
+ clean?: boolean;
573
+ }
574
+ /**
575
+ * @public
576
+ */
577
+ export interface CancelMLDataProcessingJobOutput {
578
+ /**
579
+ * @public
580
+ * <p>The status of the cancellation request.</p>
581
+ */
582
+ status?: string;
583
+ }
584
+ /**
585
+ * @public
586
+ * <p>Raised when a specified machine-learning resource could not be found.</p>
587
+ */
588
+ export declare class MLResourceNotFoundException extends __BaseException {
589
+ readonly name: "MLResourceNotFoundException";
590
+ readonly $fault: "client";
591
+ /**
592
+ * @public
593
+ * <p>A detailed message describing the problem.</p>
594
+ */
595
+ detailedMessage: string | undefined;
596
+ /**
597
+ * @public
598
+ * <p>The ID of the request in question.</p>
599
+ */
600
+ requestId: string | undefined;
601
+ /**
602
+ * @public
603
+ * <p>The HTTP status code returned with the exception.</p>
604
+ */
605
+ code: string | undefined;
606
+ /**
607
+ * @internal
608
+ */
609
+ constructor(opts: __ExceptionOptionType<MLResourceNotFoundException, __BaseException>);
610
+ }
611
+ /**
612
+ * @public
613
+ */
614
+ export interface CancelMLModelTrainingJobInput {
615
+ /**
616
+ * @public
617
+ * <p>The unique identifier of the model-training job to be canceled.</p>
618
+ */
619
+ id: string | undefined;
620
+ /**
621
+ * @public
622
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
623
+ * and Amazon S3 resources. This must be listed in your DB cluster
624
+ * parameter group or an error will occur.</p>
625
+ */
626
+ neptuneIamRoleArn?: string;
627
+ /**
628
+ * @public
629
+ * <p>If set to <code>TRUE</code>, this flag specifies that all
630
+ * Amazon S3 artifacts should be deleted when the job is stopped.
631
+ * The default is <code>FALSE</code>.</p>
632
+ */
633
+ clean?: boolean;
634
+ }
635
+ /**
636
+ * @public
637
+ */
638
+ export interface CancelMLModelTrainingJobOutput {
639
+ /**
640
+ * @public
641
+ * <p>The status of the cancellation.</p>
642
+ */
643
+ status?: string;
644
+ }
645
+ /**
646
+ * @public
647
+ */
648
+ export interface CancelMLModelTransformJobInput {
649
+ /**
650
+ * @public
651
+ * <p>The unique ID of the model transform job to be canceled.</p>
652
+ */
653
+ id: string | undefined;
654
+ /**
655
+ * @public
656
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
657
+ * and Amazon S3 resources. This must be listed in your DB cluster
658
+ * parameter group or an error will occur.</p>
659
+ */
660
+ neptuneIamRoleArn?: string;
661
+ /**
662
+ * @public
663
+ * <p>If this flag is set to <code>TRUE</code>, all Neptune ML S3 artifacts
664
+ * should be deleted when the job is stopped. The default is <code>FALSE</code>.</p>
665
+ */
666
+ clean?: boolean;
667
+ }
668
+ /**
669
+ * @public
670
+ */
671
+ export interface CancelMLModelTransformJobOutput {
672
+ /**
673
+ * @public
674
+ * <p>the status of the cancelation.</p>
675
+ */
676
+ status?: string;
677
+ }
678
+ /**
679
+ * @public
680
+ */
681
+ export interface CancelOpenCypherQueryInput {
682
+ /**
683
+ * @public
684
+ * <p>The unique ID of the openCypher query to cancel.</p>
685
+ */
686
+ queryId: string | undefined;
687
+ /**
688
+ * @public
689
+ * <p>If set to <code>TRUE</code>, causes the cancelation of the
690
+ * openCypher query to happen silently.</p>
691
+ */
692
+ silent?: boolean;
693
+ }
694
+ /**
695
+ * @public
696
+ */
697
+ export interface CancelOpenCypherQueryOutput {
698
+ /**
699
+ * @public
700
+ * <p>The cancellation status of the openCypher query.</p>
701
+ */
702
+ status?: string;
703
+ /**
704
+ * @public
705
+ * <p>The cancelation payload for the openCypher query.</p>
706
+ */
707
+ payload?: boolean;
708
+ }
709
+ /**
710
+ * @public
711
+ * <p>Raised when invalid numerical data is encountered when servicing a request.</p>
712
+ */
713
+ export declare class InvalidNumericDataException extends __BaseException {
714
+ readonly name: "InvalidNumericDataException";
715
+ readonly $fault: "client";
716
+ /**
717
+ * @public
718
+ * <p>A detailed message describing the problem.</p>
719
+ */
720
+ detailedMessage: string | undefined;
721
+ /**
722
+ * @public
723
+ * <p>The ID of the request in question.</p>
724
+ */
725
+ requestId: string | undefined;
726
+ /**
727
+ * @public
728
+ * <p>The HTTP status code returned with the exception.</p>
729
+ */
730
+ code: string | undefined;
731
+ /**
732
+ * @internal
733
+ */
734
+ constructor(opts: __ExceptionOptionType<InvalidNumericDataException, __BaseException>);
735
+ }
736
+ /**
737
+ * @public
738
+ */
739
+ export interface CreateMLEndpointInput {
740
+ /**
741
+ * @public
742
+ * <p>A unique identifier for the new inference endpoint. The default
743
+ * is an autogenerated timestamped name.</p>
744
+ */
745
+ id?: string;
746
+ /**
747
+ * @public
748
+ * <p>The job Id of the completed model-training job that has created the
749
+ * model that the inference endpoint will point to. You must supply either
750
+ * the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>
751
+ */
752
+ mlModelTrainingJobId?: string;
753
+ /**
754
+ * @public
755
+ * <p>The job Id of the completed model-transform job. You must supply
756
+ * either the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>
757
+ */
758
+ mlModelTransformJobId?: string;
759
+ /**
760
+ * @public
761
+ * <p>If set to <code>true</code>, <code>update</code> indicates that this
762
+ * is an update request. The default is <code>false</code>. You must supply
763
+ * either the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>
764
+ */
765
+ update?: boolean;
766
+ /**
767
+ * @public
768
+ * <p>The ARN of an IAM role providing Neptune access to SageMaker and
769
+ * Amazon S3 resources. This must be listed in your DB cluster parameter
770
+ * group or an error will be thrown.</p>
771
+ */
772
+ neptuneIamRoleArn?: string;
773
+ /**
774
+ * @public
775
+ * <p>Model type for training. By default the Neptune ML model is
776
+ * automatically based on the <code>modelType</code> used in data processing,
777
+ * but you can specify a different model type here. The default is
778
+ * <code>rgcn</code> for heterogeneous graphs and <code>kge</code> for
779
+ * knowledge graphs. The only valid value for heterogeneous graphs is
780
+ * <code>rgcn</code>. Valid values for knowledge graphs are: <code>kge</code>,
781
+ * <code>transe</code>, <code>distmult</code>, and <code>rotate</code>.</p>
782
+ */
783
+ modelName?: string;
784
+ /**
785
+ * @public
786
+ * <p>The type of Neptune ML instance to use for online servicing.
787
+ * The default is <code>ml.m5.xlarge</code>. Choosing the ML instance
788
+ * for an inference endpoint depends on the task type, the graph size,
789
+ * and your budget.</p>
790
+ */
791
+ instanceType?: string;
792
+ /**
793
+ * @public
794
+ * <p>The minimum number of Amazon EC2 instances to deploy to an endpoint
795
+ * for prediction. The default is 1</p>
796
+ */
797
+ instanceCount?: number;
798
+ /**
799
+ * @public
800
+ * <p>The Amazon Key Management Service (Amazon KMS) key that SageMaker uses
801
+ * to encrypt data on the storage volume attached to the ML compute instances
802
+ * that run the training job. The default is None.</p>
803
+ */
804
+ volumeEncryptionKMSKey?: string;
805
+ }
806
+ /**
807
+ * @public
808
+ */
809
+ export interface CreateMLEndpointOutput {
810
+ /**
811
+ * @public
812
+ * <p>The unique ID of the new inference endpoint.</p>
813
+ */
814
+ id?: string;
815
+ /**
816
+ * @public
817
+ * <p>The ARN for the new inference endpoint.</p>
818
+ */
819
+ arn?: string;
820
+ /**
821
+ * @public
822
+ * <p>The endpoint creation time, in milliseconds.</p>
823
+ */
824
+ creationTimeInMillis?: number;
825
+ }
826
+ /**
827
+ * @public
828
+ */
829
+ export interface DeleteMLEndpointInput {
830
+ /**
831
+ * @public
832
+ * <p>The unique identifier of the inference endpoint.</p>
833
+ */
834
+ id: string | undefined;
835
+ /**
836
+ * @public
837
+ * <p>The ARN of an IAM role providing Neptune access to SageMaker and
838
+ * Amazon S3 resources. This must be listed in your DB cluster parameter
839
+ * group or an error will be thrown.</p>
840
+ */
841
+ neptuneIamRoleArn?: string;
842
+ /**
843
+ * @public
844
+ * <p>If this flag is set to <code>TRUE</code>, all Neptune ML S3 artifacts
845
+ * should be deleted when the job is stopped. The default is
846
+ * <code>FALSE</code>.</p>
847
+ */
848
+ clean?: boolean;
849
+ }
850
+ /**
851
+ * @public
852
+ */
853
+ export interface DeleteMLEndpointOutput {
854
+ /**
855
+ * @public
856
+ * <p>The status of the cancellation.</p>
857
+ */
858
+ status?: string;
859
+ }
860
+ /**
861
+ * @public
862
+ * <p>The payload for DeleteStatistics.</p>
863
+ */
864
+ export interface DeleteStatisticsValueMap {
865
+ /**
866
+ * @public
867
+ * <p>The current status of the statistics.</p>
868
+ */
869
+ active?: boolean;
870
+ /**
871
+ * @public
872
+ * <p>The ID of the statistics generation run that is currently occurring.</p>
873
+ */
874
+ statisticsId?: string;
875
+ }
876
+ /**
877
+ * @public
878
+ */
879
+ export interface DeletePropertygraphStatisticsOutput {
880
+ /**
881
+ * @public
882
+ * <p>The HTTP response code: 200 if the delete was successful, or
883
+ * 204 if there were no statistics to delete.</p>
884
+ */
885
+ statusCode?: number;
886
+ /**
887
+ * @public
888
+ * <p>The cancel status.</p>
889
+ */
890
+ status?: string;
891
+ /**
892
+ * @public
893
+ * <p>The deletion payload.</p>
894
+ */
895
+ payload?: DeleteStatisticsValueMap;
896
+ }
897
+ /**
898
+ * @public
899
+ * <p>Raised when a request attempts to write to a read-only resource.</p>
900
+ */
901
+ export declare class ReadOnlyViolationException extends __BaseException {
902
+ readonly name: "ReadOnlyViolationException";
903
+ readonly $fault: "client";
904
+ /**
905
+ * @public
906
+ * <p>A detailed message describing the problem.</p>
907
+ */
908
+ detailedMessage: string | undefined;
909
+ /**
910
+ * @public
911
+ * <p>The ID of the request in which the parameter is missing.</p>
912
+ */
913
+ requestId: string | undefined;
914
+ /**
915
+ * @public
916
+ * <p>The HTTP status code returned with the exception.</p>
917
+ */
918
+ code: string | undefined;
919
+ /**
920
+ * @internal
921
+ */
922
+ constructor(opts: __ExceptionOptionType<ReadOnlyViolationException, __BaseException>);
923
+ }
924
+ /**
925
+ * @public
926
+ * <p>Raised when statistics needed to satisfy a request are not available.</p>
927
+ */
928
+ export declare class StatisticsNotAvailableException extends __BaseException {
929
+ readonly name: "StatisticsNotAvailableException";
930
+ readonly $fault: "client";
931
+ /**
932
+ * @public
933
+ * <p>A detailed message describing the problem.</p>
934
+ */
935
+ detailedMessage: string | undefined;
936
+ /**
937
+ * @public
938
+ * <p>The ID of the request in question.</p>
939
+ */
940
+ requestId: string | undefined;
941
+ /**
942
+ * @public
943
+ * <p>The HTTP status code returned with the exception.</p>
944
+ */
945
+ code: string | undefined;
946
+ /**
947
+ * @internal
948
+ */
949
+ constructor(opts: __ExceptionOptionType<StatisticsNotAvailableException, __BaseException>);
950
+ }
951
+ /**
952
+ * @public
953
+ */
954
+ export interface DeleteSparqlStatisticsOutput {
955
+ /**
956
+ * @public
957
+ * <p>The HTTP response code: 200 if the delete was successful, or
958
+ * 204 if there were no statistics to delete.</p>
959
+ */
960
+ statusCode?: number;
961
+ /**
962
+ * @public
963
+ * <p>The cancel status.</p>
964
+ */
965
+ status?: string;
966
+ /**
967
+ * @public
968
+ * <p>The deletion payload.</p>
969
+ */
970
+ payload?: DeleteStatisticsValueMap;
971
+ }
972
+ /**
973
+ * @public
974
+ */
975
+ export interface ExecuteFastResetInput {
976
+ /**
977
+ * @public
978
+ * <p>The fast reset action. One of the following values:</p>
979
+ * <ul>
980
+ * <li>
981
+ * <p>
982
+ * <b>
983
+ * <code>initiateDatabaseReset</code>
984
+ * </b>   –
985
+ * This action generates a unique token needed to actually perform the
986
+ * fast reset.</p>
987
+ * </li>
988
+ * <li>
989
+ * <p>
990
+ * <b>
991
+ * <code>performDatabaseReset</code>
992
+ * </b>   –
993
+ * This action uses the token generated by the <code>initiateDatabaseReset</code> action
994
+ * to actually perform the fast reset.</p>
995
+ * <p/>
996
+ * </li>
997
+ * </ul>
998
+ */
999
+ action: Action | string | undefined;
1000
+ /**
1001
+ * @public
1002
+ * <p>The fast-reset token to initiate the reset.</p>
1003
+ */
1004
+ token?: string;
1005
+ }
1006
+ /**
1007
+ * @public
1008
+ * <p>A structure containing the fast reset token used to initiate
1009
+ * a fast reset.</p>
1010
+ */
1011
+ export interface FastResetToken {
1012
+ /**
1013
+ * @public
1014
+ * <p>A UUID generated by the database in the <code>initiateDatabaseReset</code> action,
1015
+ * and then consumed by the <code>performDatabaseReset</code> to reset the database.</p>
1016
+ */
1017
+ token?: string;
1018
+ }
1019
+ /**
1020
+ * @public
1021
+ */
1022
+ export interface ExecuteFastResetOutput {
1023
+ /**
1024
+ * @public
1025
+ * <p>The <code>status</code> is only returned for the <code>performDatabaseReset</code>
1026
+ * action, and indicates whether or not the fast reset rquest is accepted.</p>
1027
+ */
1028
+ status: string | undefined;
1029
+ /**
1030
+ * @public
1031
+ * <p>The <code>payload</code> is only returned by the <code>initiateDatabaseReset</code>
1032
+ * action, and contains the unique token to use with the <code>performDatabaseReset</code>
1033
+ * action to make the reset occur.</p>
1034
+ */
1035
+ payload?: FastResetToken;
1036
+ }
1037
+ /**
1038
+ * @public
1039
+ * <p>Raised when the HTTP method used by a request is not supported by the endpoint
1040
+ * being used.</p>
1041
+ */
1042
+ export declare class MethodNotAllowedException extends __BaseException {
1043
+ readonly name: "MethodNotAllowedException";
1044
+ readonly $fault: "client";
1045
+ /**
1046
+ * @public
1047
+ * <p>A detailed message describing the problem.</p>
1048
+ */
1049
+ detailedMessage: string | undefined;
1050
+ /**
1051
+ * @public
1052
+ * <p>The ID of the request in question.</p>
1053
+ */
1054
+ requestId: string | undefined;
1055
+ /**
1056
+ * @public
1057
+ * <p>The HTTP status code returned with the exception.</p>
1058
+ */
1059
+ code: string | undefined;
1060
+ /**
1061
+ * @internal
1062
+ */
1063
+ constructor(opts: __ExceptionOptionType<MethodNotAllowedException, __BaseException>);
1064
+ }
1065
+ /**
1066
+ * @public
1067
+ * <p>Raised when the server shuts down while processing a request.</p>
1068
+ */
1069
+ export declare class ServerShutdownException extends __BaseException {
1070
+ readonly name: "ServerShutdownException";
1071
+ readonly $fault: "server";
1072
+ /**
1073
+ * @public
1074
+ * <p>A detailed message describing the problem.</p>
1075
+ */
1076
+ detailedMessage: string | undefined;
1077
+ /**
1078
+ * @public
1079
+ * <p>The ID of the request in question.</p>
1080
+ */
1081
+ requestId: string | undefined;
1082
+ /**
1083
+ * @public
1084
+ * <p>The HTTP status code returned with the exception.</p>
1085
+ */
1086
+ code: string | undefined;
1087
+ /**
1088
+ * @internal
1089
+ */
1090
+ constructor(opts: __ExceptionOptionType<ServerShutdownException, __BaseException>);
1091
+ }
1092
+ /**
1093
+ * @public
1094
+ * <p>Raised when a user cancelled a request.</p>
1095
+ */
1096
+ export declare class CancelledByUserException extends __BaseException {
1097
+ readonly name: "CancelledByUserException";
1098
+ readonly $fault: "server";
1099
+ $retryable: {};
1100
+ /**
1101
+ * @public
1102
+ * <p>A detailed message describing the problem.</p>
1103
+ */
1104
+ detailedMessage: string | undefined;
1105
+ /**
1106
+ * @public
1107
+ * <p>The ID of the request in question.</p>
1108
+ */
1109
+ requestId: string | undefined;
1110
+ /**
1111
+ * @public
1112
+ * <p>The HTTP status code returned with the exception.</p>
1113
+ */
1114
+ code: string | undefined;
1115
+ /**
1116
+ * @internal
1117
+ */
1118
+ constructor(opts: __ExceptionOptionType<CancelledByUserException, __BaseException>);
1119
+ }
1120
+ /**
1121
+ * @public
1122
+ */
1123
+ export interface ExecuteGremlinExplainQueryInput {
1124
+ /**
1125
+ * @public
1126
+ * <p>The Gremlin explain query string.</p>
1127
+ */
1128
+ gremlinQuery: string | undefined;
1129
+ }
1130
+ /**
1131
+ * @public
1132
+ */
1133
+ export interface ExecuteGremlinExplainQueryOutput {
1134
+ /**
1135
+ * @public
1136
+ * <p>A text blob containing the Gremlin explain result, as described
1137
+ * in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html">Tuning
1138
+ * Gremlin queries</a>.</p>
1139
+ */
1140
+ output?: Uint8Array;
1141
+ }
1142
+ /**
1143
+ * @public
1144
+ * <p>Raised when a query is submitted that is syntactically incorrect or does not
1145
+ * pass additional validation.</p>
1146
+ */
1147
+ export declare class MalformedQueryException extends __BaseException {
1148
+ readonly name: "MalformedQueryException";
1149
+ readonly $fault: "client";
1150
+ /**
1151
+ * @public
1152
+ * <p>A detailed message describing the problem.</p>
1153
+ */
1154
+ detailedMessage: string | undefined;
1155
+ /**
1156
+ * @public
1157
+ * <p>The ID of the malformed query request.</p>
1158
+ */
1159
+ requestId: string | undefined;
1160
+ /**
1161
+ * @public
1162
+ * <p>The HTTP status code returned with the exception.</p>
1163
+ */
1164
+ code: string | undefined;
1165
+ /**
1166
+ * @internal
1167
+ */
1168
+ constructor(opts: __ExceptionOptionType<MalformedQueryException, __BaseException>);
1169
+ }
1170
+ /**
1171
+ * @public
1172
+ * <p>Raised when a request fails because of insufficient memory resources. The
1173
+ * request can be retried.</p>
1174
+ */
1175
+ export declare class MemoryLimitExceededException extends __BaseException {
1176
+ readonly name: "MemoryLimitExceededException";
1177
+ readonly $fault: "server";
1178
+ $retryable: {};
1179
+ /**
1180
+ * @public
1181
+ * <p>A detailed message describing the problem.</p>
1182
+ */
1183
+ detailedMessage: string | undefined;
1184
+ /**
1185
+ * @public
1186
+ * <p>The ID of the request that failed.</p>
1187
+ */
1188
+ requestId: string | undefined;
1189
+ /**
1190
+ * @public
1191
+ * <p>The HTTP status code returned with the exception.</p>
1192
+ */
1193
+ code: string | undefined;
1194
+ /**
1195
+ * @internal
1196
+ */
1197
+ constructor(opts: __ExceptionOptionType<MemoryLimitExceededException, __BaseException>);
1198
+ }
1199
+ /**
1200
+ * @public
1201
+ * <p>Raised when the number of active queries exceeds what the server can process.
1202
+ * The query in question can be retried when the system is less busy.</p>
1203
+ */
1204
+ export declare class QueryLimitExceededException extends __BaseException {
1205
+ readonly name: "QueryLimitExceededException";
1206
+ readonly $fault: "server";
1207
+ $retryable: {};
1208
+ /**
1209
+ * @public
1210
+ * <p>A detailed message describing the problem.</p>
1211
+ */
1212
+ detailedMessage: string | undefined;
1213
+ /**
1214
+ * @public
1215
+ * <p>The ID of the request which exceeded the limit.</p>
1216
+ */
1217
+ requestId: string | undefined;
1218
+ /**
1219
+ * @public
1220
+ * <p>The HTTP status code returned with the exception.</p>
1221
+ */
1222
+ code: string | undefined;
1223
+ /**
1224
+ * @internal
1225
+ */
1226
+ constructor(opts: __ExceptionOptionType<QueryLimitExceededException, __BaseException>);
1227
+ }
1228
+ /**
1229
+ * @public
1230
+ * <p>Raised when the size of a query exceeds the system limit.</p>
1231
+ */
1232
+ export declare class QueryLimitException extends __BaseException {
1233
+ readonly name: "QueryLimitException";
1234
+ readonly $fault: "client";
1235
+ /**
1236
+ * @public
1237
+ * <p>A detailed message describing the problem.</p>
1238
+ */
1239
+ detailedMessage: string | undefined;
1240
+ /**
1241
+ * @public
1242
+ * <p>The ID of the request that exceeded the limit.</p>
1243
+ */
1244
+ requestId: string | undefined;
1245
+ /**
1246
+ * @public
1247
+ * <p>The HTTP status code returned with the exception.</p>
1248
+ */
1249
+ code: string | undefined;
1250
+ /**
1251
+ * @internal
1252
+ */
1253
+ constructor(opts: __ExceptionOptionType<QueryLimitException, __BaseException>);
1254
+ }
1255
+ /**
1256
+ * @public
1257
+ * <p>Raised when the body of a query is too large.</p>
1258
+ */
1259
+ export declare class QueryTooLargeException extends __BaseException {
1260
+ readonly name: "QueryTooLargeException";
1261
+ readonly $fault: "client";
1262
+ /**
1263
+ * @public
1264
+ * <p>A detailed message describing the problem.</p>
1265
+ */
1266
+ detailedMessage: string | undefined;
1267
+ /**
1268
+ * @public
1269
+ * <p>The ID of the request that is too large.</p>
1270
+ */
1271
+ requestId: string | undefined;
1272
+ /**
1273
+ * @public
1274
+ * <p>The HTTP status code returned with the exception.</p>
1275
+ */
1276
+ code: string | undefined;
1277
+ /**
1278
+ * @internal
1279
+ */
1280
+ constructor(opts: __ExceptionOptionType<QueryTooLargeException, __BaseException>);
1281
+ }
1282
+ /**
1283
+ * @public
1284
+ */
1285
+ export interface ExecuteGremlinProfileQueryInput {
1286
+ /**
1287
+ * @public
1288
+ * <p>The Gremlin query string to profile.</p>
1289
+ */
1290
+ gremlinQuery: string | undefined;
1291
+ /**
1292
+ * @public
1293
+ * <p>If this flag is set to <code>TRUE</code>, the query results are
1294
+ * gathered and displayed as part of the profile report.
1295
+ * If <code>FALSE</code>, only the result count is displayed.</p>
1296
+ */
1297
+ results?: boolean;
1298
+ /**
1299
+ * @public
1300
+ * <p>If non-zero, causes the results string to be truncated at that
1301
+ * number of characters. If set to zero, the string contains all the results.</p>
1302
+ */
1303
+ chop?: number;
1304
+ /**
1305
+ * @public
1306
+ * <p>If non-null, the gathered results are returned in a serialized response
1307
+ * message in the format specified by this parameter. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile
1308
+ * API in Neptune</a> for more information.</p>
1309
+ */
1310
+ serializer?: string;
1311
+ /**
1312
+ * @public
1313
+ * <p>If this flag is set to <code>TRUE</code>, the results include a
1314
+ * detailed report of all index operations that took place during query
1315
+ * execution and serialization.</p>
1316
+ */
1317
+ indexOps?: boolean;
1318
+ }
1319
+ /**
1320
+ * @public
1321
+ */
1322
+ export interface ExecuteGremlinProfileQueryOutput {
1323
+ /**
1324
+ * @public
1325
+ * <p>A text blob containing the Gremlin Profile result. See
1326
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin
1327
+ * profile API in Neptune</a> for details.</p>
1328
+ */
1329
+ output?: Uint8Array;
1330
+ }
1331
+ /**
1332
+ * @public
1333
+ */
1334
+ export interface ExecuteGremlinQueryInput {
1335
+ /**
1336
+ * @public
1337
+ * <p>Using this API, you can run Gremlin queries in string format
1338
+ * much as you can using the HTTP endpoint. The interface is
1339
+ * compatible with whatever Gremlin version your DB cluster is using
1340
+ * (see the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest">Tinkerpop
1341
+ * client section</a> to determine which Gremlin releases your
1342
+ * engine version supports).</p>
1343
+ */
1344
+ gremlinQuery: string | undefined;
1345
+ /**
1346
+ * @public
1347
+ * <p>If non-null, the query results are returned in a serialized response
1348
+ * message in the format specified by this parameter. See the <a href="https://tinkerpop.apache.org/docs/current/reference/#_graphson">GraphSON</a>
1349
+ * section in the TinkerPop documentation for a list of the formats that
1350
+ * are currently supported.</p>
1351
+ */
1352
+ serializer?: string;
1353
+ }
1354
+ /**
1355
+ * @public
1356
+ * <p>Contains status components of a Gremlin query.</p>
1357
+ */
1358
+ export interface GremlinQueryStatusAttributes {
1359
+ /**
1360
+ * @public
1361
+ * <p>The status message.</p>
1362
+ */
1363
+ message?: string;
1364
+ /**
1365
+ * @public
1366
+ * <p>The HTTP response code returned fro the Gremlin query request..</p>
1367
+ */
1368
+ code?: number;
1369
+ /**
1370
+ * @public
1371
+ * <p>Attributes of the Gremlin query status.</p>
1372
+ */
1373
+ attributes?: __DocumentType;
1374
+ }
1375
+ /**
1376
+ * @public
1377
+ */
1378
+ export interface ExecuteGremlinQueryOutput {
1379
+ /**
1380
+ * @public
1381
+ * <p>The unique identifier of the Gremlin query.</p>
1382
+ */
1383
+ requestId?: string;
1384
+ /**
1385
+ * @public
1386
+ * <p>The status of the Gremlin query.</p>
1387
+ */
1388
+ status?: GremlinQueryStatusAttributes;
1389
+ /**
1390
+ * @public
1391
+ * <p>The Gremlin query output from the server.</p>
1392
+ */
1393
+ result?: __DocumentType;
1394
+ /**
1395
+ * @public
1396
+ * <p>Metadata about the Gremlin query.</p>
1397
+ */
1398
+ meta?: __DocumentType;
1399
+ }
1400
+ /**
1401
+ * @public
1402
+ * @enum
1403
+ */
1404
+ export declare const OpenCypherExplainMode: {
1405
+ readonly DETAILS: "details";
1406
+ readonly DYNAMIC: "dynamic";
1407
+ readonly STATIC: "static";
1408
+ };
1409
+ /**
1410
+ * @public
1411
+ */
1412
+ export type OpenCypherExplainMode = (typeof OpenCypherExplainMode)[keyof typeof OpenCypherExplainMode];
1413
+ /**
1414
+ * @public
1415
+ */
1416
+ export interface ExecuteOpenCypherExplainQueryInput {
1417
+ /**
1418
+ * @public
1419
+ * <p>The openCypher query string.</p>
1420
+ */
1421
+ openCypherQuery: string | undefined;
1422
+ /**
1423
+ * @public
1424
+ * <p>The openCypher query parameters.</p>
1425
+ */
1426
+ parameters?: string;
1427
+ /**
1428
+ * @public
1429
+ * <p>The openCypher <code>explain</code> mode. Can be one of:
1430
+ * <code>static</code>, <code>dynamic</code>, or <code>details</code>.</p>
1431
+ */
1432
+ explainMode: OpenCypherExplainMode | string | undefined;
1433
+ }
1434
+ /**
1435
+ * @public
1436
+ */
1437
+ export interface ExecuteOpenCypherExplainQueryOutput {
1438
+ /**
1439
+ * @public
1440
+ * <p>A text blob containing the openCypher <code>explain</code> results.</p>
1441
+ */
1442
+ results: Uint8Array | undefined;
1443
+ }
1444
+ /**
1445
+ * @public
1446
+ */
1447
+ export interface ExecuteOpenCypherQueryInput {
1448
+ /**
1449
+ * @public
1450
+ * <p>The openCypher query string to be executed.</p>
1451
+ */
1452
+ openCypherQuery: string | undefined;
1453
+ /**
1454
+ * @public
1455
+ * <p>The openCypher query parameters for query execution.
1456
+ * See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html">Examples
1457
+ * of openCypher parameterized queries</a> for more information.</p>
1458
+ */
1459
+ parameters?: string;
1460
+ }
1461
+ /**
1462
+ * @public
1463
+ */
1464
+ export interface ExecuteOpenCypherQueryOutput {
1465
+ /**
1466
+ * @public
1467
+ * <p>The openCypherquery results.</p>
1468
+ */
1469
+ results: __DocumentType | undefined;
1470
+ }
1471
+ /**
1472
+ * @public
1473
+ * <p>Structure for expressing the query language version.</p>
1474
+ */
1475
+ export interface QueryLanguageVersion {
1476
+ /**
1477
+ * @public
1478
+ * <p>The version of the query language.</p>
1479
+ */
1480
+ version: string | undefined;
1481
+ }
1482
+ /**
1483
+ * @public
1484
+ */
1485
+ export interface GetEngineStatusOutput {
1486
+ /**
1487
+ * @public
1488
+ * <p>Set to <code>healthy</code> if the instance is not experiencing problems.
1489
+ * If the instance is recovering from a crash or from being rebooted and there
1490
+ * are active transactions running from the latest server shutdown, status is set
1491
+ * to <code>recovery</code>.</p>
1492
+ */
1493
+ status?: string;
1494
+ /**
1495
+ * @public
1496
+ * <p>Set to the UTC time at which the current server process started.</p>
1497
+ */
1498
+ startTime?: string;
1499
+ /**
1500
+ * @public
1501
+ * <p>Set to the Neptune engine version running on your DB cluster.
1502
+ * If this engine version has been manually patched since it was released,
1503
+ * the version number is prefixed by <code>Patch-</code>.</p>
1504
+ */
1505
+ dbEngineVersion?: string;
1506
+ /**
1507
+ * @public
1508
+ * <p>Set to <code>reader</code> if the instance is a read-replica,
1509
+ * or to <code>writer</code> if the instance is the primary instance.</p>
1510
+ */
1511
+ role?: string;
1512
+ /**
1513
+ * @public
1514
+ * <p>Set to <code>enabled</code> if the DFE engine is fully enabled,
1515
+ * or to <code>viaQueryHint</code> (the default) if the DFE engine is
1516
+ * only used with queries that have the <code>useDFE</code> query hint
1517
+ * set to <code>true</code>.</p>
1518
+ */
1519
+ dfeQueryEngine?: string;
1520
+ /**
1521
+ * @public
1522
+ * <p>Contains information about the Gremlin query language available
1523
+ * on your cluster. Specifically, it contains a version field that specifies
1524
+ * the current TinkerPop version being used by the engine.</p>
1525
+ */
1526
+ gremlin?: QueryLanguageVersion;
1527
+ /**
1528
+ * @public
1529
+ * <p>Contains information about the SPARQL query language available
1530
+ * on your cluster. Specifically, it contains a version field that
1531
+ * specifies the current SPARQL version being used by the engine.</p>
1532
+ */
1533
+ sparql?: QueryLanguageVersion;
1534
+ /**
1535
+ * @public
1536
+ * <p>Contains information about the openCypher query language available
1537
+ * on your cluster. Specifically, it contains a version field that
1538
+ * specifies the current operCypher version being used by the engine.</p>
1539
+ */
1540
+ opencypher?: QueryLanguageVersion;
1541
+ /**
1542
+ * @public
1543
+ * <p>Contains Lab Mode settings being used by the engine.</p>
1544
+ */
1545
+ labMode?: Record<string, string>;
1546
+ /**
1547
+ * @public
1548
+ * <p>If there are transactions being rolled back, this field is set
1549
+ * to the number of such transactions. If there are none, the field
1550
+ * doesn't appear at all.</p>
1551
+ */
1552
+ rollingBackTrxCount?: number;
1553
+ /**
1554
+ * @public
1555
+ * <p>Set to the start time of the earliest transaction being rolled back.
1556
+ * If no transactions are being rolled back, the field doesn't appear at all.</p>
1557
+ */
1558
+ rollingBackTrxEarliestStartTime?: string;
1559
+ /**
1560
+ * @public
1561
+ * <p>Contains status information about the features enabled on your DB cluster.</p>
1562
+ */
1563
+ features?: Record<string, __DocumentType>;
1564
+ /**
1565
+ * @public
1566
+ * <p>Contains information about the current settings on your DB cluster.
1567
+ * For example, contains the current cluster query timeout setting
1568
+ * (<code>clusterQueryTimeoutInMs</code>).</p>
1569
+ */
1570
+ settings?: Record<string, string>;
1571
+ }
1572
+ /**
1573
+ * @public
1574
+ */
1575
+ export interface GetGremlinQueryStatusInput {
1576
+ /**
1577
+ * @public
1578
+ * <p>The unique identifier that identifies the Gremlin query.</p>
1579
+ */
1580
+ queryId: string | undefined;
1581
+ }
1582
+ /**
1583
+ * @public
1584
+ * <p>Structure to capture query statistics such as how many queries
1585
+ * are running, accepted or waiting and their details.</p>
1586
+ */
1587
+ export interface QueryEvalStats {
1588
+ /**
1589
+ * @public
1590
+ * <p>Indicates how long the query waited, in milliseconds.</p>
1591
+ */
1592
+ waited?: number;
1593
+ /**
1594
+ * @public
1595
+ * <p>The number of milliseconds the query has been running so far.</p>
1596
+ */
1597
+ elapsed?: number;
1598
+ /**
1599
+ * @public
1600
+ * <p>Set to <code>TRUE</code> if the query was cancelled, or FALSE
1601
+ * otherwise.</p>
1602
+ */
1603
+ cancelled?: boolean;
1604
+ /**
1605
+ * @public
1606
+ * <p>The number of subqueries in this query.</p>
1607
+ */
1608
+ subqueries?: __DocumentType;
1609
+ }
1610
+ /**
1611
+ * @public
1612
+ */
1613
+ export interface GetGremlinQueryStatusOutput {
1614
+ /**
1615
+ * @public
1616
+ * <p>The ID of the query for which status is being returned.</p>
1617
+ */
1618
+ queryId?: string;
1619
+ /**
1620
+ * @public
1621
+ * <p>The Gremlin query string.</p>
1622
+ */
1623
+ queryString?: string;
1624
+ /**
1625
+ * @public
1626
+ * <p>The evaluation status of the Gremlin query.</p>
1627
+ */
1628
+ queryEvalStats?: QueryEvalStats;
1629
+ }
1630
+ /**
1631
+ * @public
1632
+ */
1633
+ export interface GetLoaderJobStatusInput {
1634
+ /**
1635
+ * @public
1636
+ * <p>The load ID of the load job to get the status of.</p>
1637
+ */
1638
+ loadId: string | undefined;
1639
+ /**
1640
+ * @public
1641
+ * <p>Flag indicating whether or not to include details beyond the
1642
+ * overall status (<code>TRUE</code> or <code>FALSE</code>; the default
1643
+ * is <code>FALSE</code>).</p>
1644
+ */
1645
+ details?: boolean;
1646
+ /**
1647
+ * @public
1648
+ * <p>Flag indicating whether or not to include a list of errors
1649
+ * encountered (<code>TRUE</code> or <code>FALSE</code>; the default
1650
+ * is <code>FALSE</code>).</p>
1651
+ * <p>The list of errors is paged. The <code>page</code> and <code>errorsPerPage</code>
1652
+ * parameters allow you to page through all the errors.</p>
1653
+ */
1654
+ errors?: boolean;
1655
+ /**
1656
+ * @public
1657
+ * <p>The error page number (a positive integer; the default is <code>1</code>).
1658
+ * Only valid when the <code>errors</code> parameter is set to
1659
+ * <code>TRUE</code>.</p>
1660
+ */
1661
+ page?: number;
1662
+ /**
1663
+ * @public
1664
+ * <p>The number of errors returned in each page (a positive integer; the
1665
+ * default is <code>10</code>). Only valid when the <code>errors</code>
1666
+ * parameter set to <code>TRUE</code>.</p>
1667
+ */
1668
+ errorsPerPage?: number;
1669
+ }
1670
+ /**
1671
+ * @public
1672
+ */
1673
+ export interface GetLoaderJobStatusOutput {
1674
+ /**
1675
+ * @public
1676
+ * <p>The HTTP response code for the request.</p>
1677
+ */
1678
+ status: string | undefined;
1679
+ /**
1680
+ * @public
1681
+ * <p>Status information about the load job, in a layout
1682
+ * that could look like this:</p>
1683
+ */
1684
+ payload: __DocumentType | undefined;
1685
+ }
1686
+ /**
1687
+ * @public
1688
+ */
1689
+ export interface GetMLDataProcessingJobInput {
1690
+ /**
1691
+ * @public
1692
+ * <p>The unique identifier of the data-processing job to be retrieved.</p>
1693
+ */
1694
+ id: string | undefined;
1695
+ /**
1696
+ * @public
1697
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
1698
+ * and Amazon S3 resources. This must be listed in your DB cluster
1699
+ * parameter group or an error will occur.</p>
1700
+ */
1701
+ neptuneIamRoleArn?: string;
1702
+ }
1703
+ /**
1704
+ * @public
1705
+ * <p>Defines a Neptune ML resource.</p>
1706
+ */
1707
+ export interface MlResourceDefinition {
1708
+ /**
1709
+ * @public
1710
+ * <p>The resource name.</p>
1711
+ */
1712
+ name?: string;
1713
+ /**
1714
+ * @public
1715
+ * <p>The resource ARN.</p>
1716
+ */
1717
+ arn?: string;
1718
+ /**
1719
+ * @public
1720
+ * <p>The resource status.</p>
1721
+ */
1722
+ status?: string;
1723
+ /**
1724
+ * @public
1725
+ * <p>The output location.</p>
1726
+ */
1727
+ outputLocation?: string;
1728
+ /**
1729
+ * @public
1730
+ * <p>The failure reason, in case of a failure.</p>
1731
+ */
1732
+ failureReason?: string;
1733
+ /**
1734
+ * @public
1735
+ * <p>The CloudWatch log URL for the resource.</p>
1736
+ */
1737
+ cloudwatchLogUrl?: string;
1738
+ }
1739
+ /**
1740
+ * @public
1741
+ */
1742
+ export interface GetMLDataProcessingJobOutput {
1743
+ /**
1744
+ * @public
1745
+ * <p>Status of the data processing job.</p>
1746
+ */
1747
+ status?: string;
1748
+ /**
1749
+ * @public
1750
+ * <p>The unique identifier of this data-processing job.</p>
1751
+ */
1752
+ id?: string;
1753
+ /**
1754
+ * @public
1755
+ * <p>Definition of the data processing job.</p>
1756
+ */
1757
+ processingJob?: MlResourceDefinition;
1758
+ }
1759
+ /**
1760
+ * @public
1761
+ */
1762
+ export interface GetMLEndpointInput {
1763
+ /**
1764
+ * @public
1765
+ * <p>The unique identifier of the inference endpoint.</p>
1766
+ */
1767
+ id: string | undefined;
1768
+ /**
1769
+ * @public
1770
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
1771
+ * and Amazon S3 resources. This must be listed in your DB cluster parameter
1772
+ * group or an error will occur.</p>
1773
+ */
1774
+ neptuneIamRoleArn?: string;
1775
+ }
1776
+ /**
1777
+ * @public
1778
+ * <p>Contains a Neptune ML configuration.</p>
1779
+ */
1780
+ export interface MlConfigDefinition {
1781
+ /**
1782
+ * @public
1783
+ * <p>The configuration name.</p>
1784
+ */
1785
+ name?: string;
1786
+ /**
1787
+ * @public
1788
+ * <p>The ARN for the configuration.</p>
1789
+ */
1790
+ arn?: string;
1791
+ }
1792
+ /**
1793
+ * @public
1794
+ */
1795
+ export interface GetMLEndpointOutput {
1796
+ /**
1797
+ * @public
1798
+ * <p>The status of the inference endpoint.</p>
1799
+ */
1800
+ status?: string;
1801
+ /**
1802
+ * @public
1803
+ * <p>The unique identifier of the inference endpoint.</p>
1804
+ */
1805
+ id?: string;
1806
+ /**
1807
+ * @public
1808
+ * <p>The endpoint definition.</p>
1809
+ */
1810
+ endpoint?: MlResourceDefinition;
1811
+ /**
1812
+ * @public
1813
+ * <p>The endpoint configuration</p>
1814
+ */
1815
+ endpointConfig?: MlConfigDefinition;
1816
+ }
1817
+ /**
1818
+ * @public
1819
+ */
1820
+ export interface GetMLModelTrainingJobInput {
1821
+ /**
1822
+ * @public
1823
+ * <p>The unique identifier of the model-training job to retrieve.</p>
1824
+ */
1825
+ id: string | undefined;
1826
+ /**
1827
+ * @public
1828
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
1829
+ * and Amazon S3 resources. This must be listed in your DB cluster
1830
+ * parameter group or an error will occur.</p>
1831
+ */
1832
+ neptuneIamRoleArn?: string;
1833
+ }
1834
+ /**
1835
+ * @public
1836
+ */
1837
+ export interface GetMLModelTrainingJobOutput {
1838
+ /**
1839
+ * @public
1840
+ * <p>The status of the model training job.</p>
1841
+ */
1842
+ status?: string;
1843
+ /**
1844
+ * @public
1845
+ * <p>The unique identifier of this model-training job.</p>
1846
+ */
1847
+ id?: string;
1848
+ /**
1849
+ * @public
1850
+ * <p>The data processing job.</p>
1851
+ */
1852
+ processingJob?: MlResourceDefinition;
1853
+ /**
1854
+ * @public
1855
+ * <p>The HPO job.</p>
1856
+ */
1857
+ hpoJob?: MlResourceDefinition;
1858
+ /**
1859
+ * @public
1860
+ * <p>The model transform job.</p>
1861
+ */
1862
+ modelTransformJob?: MlResourceDefinition;
1863
+ /**
1864
+ * @public
1865
+ * <p>A list of the configurations of the ML models being used.</p>
1866
+ */
1867
+ mlModels?: MlConfigDefinition[];
1868
+ }
1869
+ /**
1870
+ * @public
1871
+ */
1872
+ export interface GetMLModelTransformJobInput {
1873
+ /**
1874
+ * @public
1875
+ * <p>The unique identifier of the model-transform job to be reetrieved.</p>
1876
+ */
1877
+ id: string | undefined;
1878
+ /**
1879
+ * @public
1880
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
1881
+ * and Amazon S3 resources. This must be listed in your DB cluster
1882
+ * parameter group or an error will occur.</p>
1883
+ */
1884
+ neptuneIamRoleArn?: string;
1885
+ }
1886
+ /**
1887
+ * @public
1888
+ */
1889
+ export interface GetMLModelTransformJobOutput {
1890
+ /**
1891
+ * @public
1892
+ * <p>The status of the model-transform job.</p>
1893
+ */
1894
+ status?: string;
1895
+ /**
1896
+ * @public
1897
+ * <p>The unique identifier of the model-transform job to be retrieved.</p>
1898
+ */
1899
+ id?: string;
1900
+ /**
1901
+ * @public
1902
+ * <p>The base data processing job.</p>
1903
+ */
1904
+ baseProcessingJob?: MlResourceDefinition;
1905
+ /**
1906
+ * @public
1907
+ * <p>The remote model transform job.</p>
1908
+ */
1909
+ remoteModelTransformJob?: MlResourceDefinition;
1910
+ /**
1911
+ * @public
1912
+ * <p>A list of the configuration information for the models being used.</p>
1913
+ */
1914
+ models?: MlConfigDefinition[];
1915
+ }
1916
+ /**
1917
+ * @public
1918
+ */
1919
+ export interface GetOpenCypherQueryStatusInput {
1920
+ /**
1921
+ * @public
1922
+ * <p>The unique ID of the openCypher query for which to retrieve
1923
+ * the query status.</p>
1924
+ */
1925
+ queryId: string | undefined;
1926
+ }
1927
+ /**
1928
+ * @public
1929
+ */
1930
+ export interface GetOpenCypherQueryStatusOutput {
1931
+ /**
1932
+ * @public
1933
+ * <p>The unique ID of the query for which status is being returned.</p>
1934
+ */
1935
+ queryId?: string;
1936
+ /**
1937
+ * @public
1938
+ * <p>The openCypher query string.</p>
1939
+ */
1940
+ queryString?: string;
1941
+ /**
1942
+ * @public
1943
+ * <p>The openCypher query evaluation status.</p>
1944
+ */
1945
+ queryEvalStats?: QueryEvalStats;
1946
+ }
1947
+ /**
1948
+ * @public
1949
+ * <p>Information about the characteristic sets generated in the statistics.</p>
1950
+ */
1951
+ export interface StatisticsSummary {
1952
+ /**
1953
+ * @public
1954
+ * <p>The total number of signatures across all characteristic sets.</p>
1955
+ */
1956
+ signatureCount?: number;
1957
+ /**
1958
+ * @public
1959
+ * <p>The total number of characteristic-set instances.</p>
1960
+ */
1961
+ instanceCount?: number;
1962
+ /**
1963
+ * @public
1964
+ * <p>The total number of unique predicates.</p>
1965
+ */
1966
+ predicateCount?: number;
1967
+ }
1968
+ /**
1969
+ * @public
1970
+ * <p>Contains statistics information. The DFE engine uses information
1971
+ * about the data in your Neptune graph to make effective trade-offs when
1972
+ * planning query execution. This information takes the form of statistics
1973
+ * that include so-called characteristic sets and predicate statistics
1974
+ * that can guide query planning. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html">Managing
1975
+ * statistics for the Neptune DFE to use</a>.</p>
1976
+ */
1977
+ export interface Statistics {
1978
+ /**
1979
+ * @public
1980
+ * <p>Indicates whether or not automatic statistics generation is enabled.</p>
1981
+ */
1982
+ autoCompute?: boolean;
1983
+ /**
1984
+ * @public
1985
+ * <p>Indicates whether or not DFE statistics generation is enabled at all.</p>
1986
+ */
1987
+ active?: boolean;
1988
+ /**
1989
+ * @public
1990
+ * <p>Reports the ID of the current statistics generation run.
1991
+ * A value of -1 indicates that no statistics have been generated.</p>
1992
+ */
1993
+ statisticsId?: string;
1994
+ /**
1995
+ * @public
1996
+ * <p>The UTC time at which DFE statistics have most recently been generated.</p>
1997
+ */
1998
+ date?: Date;
1999
+ /**
2000
+ * @public
2001
+ * <p>A note about problems in the case where statistics are invalid.</p>
2002
+ */
2003
+ note?: string;
2004
+ /**
2005
+ * @public
2006
+ * <p>A StatisticsSummary structure that contains:</p>
2007
+ * <ul>
2008
+ * <li>
2009
+ * <p>
2010
+ * <code>signatureCount</code> - The total number of signatures
2011
+ * across all characteristic sets.</p>
2012
+ * </li>
2013
+ * <li>
2014
+ * <p>
2015
+ * <code>instanceCount</code> - The total number of
2016
+ * characteristic-set instances.</p>
2017
+ * </li>
2018
+ * <li>
2019
+ * <p>
2020
+ * <code>predicateCount</code> - The total number of unique predicates.</p>
2021
+ * </li>
2022
+ * </ul>
2023
+ */
2024
+ signatureInfo?: StatisticsSummary;
2025
+ }
2026
+ /**
2027
+ * @public
2028
+ */
2029
+ export interface GetPropertygraphStatisticsOutput {
2030
+ /**
2031
+ * @public
2032
+ * <p>The HTTP return code of the request. If the request succeeded,
2033
+ * the code is 200. See <a href="docs.aws.amazon.comneptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors">Common
2034
+ * error codes for DFE statistics request</a> for a list of common errors.</p>
2035
+ */
2036
+ status: string | undefined;
2037
+ /**
2038
+ * @public
2039
+ * <p>Statistics for property-graph data.</p>
2040
+ */
2041
+ payload: Statistics | undefined;
2042
+ }
2043
+ /**
2044
+ * @public
2045
+ * <p>Raised when a request attempts to access an stream that has expired.</p>
2046
+ */
2047
+ export declare class ExpiredStreamException extends __BaseException {
2048
+ readonly name: "ExpiredStreamException";
2049
+ readonly $fault: "client";
2050
+ /**
2051
+ * @public
2052
+ * <p>A detailed message describing the problem.</p>
2053
+ */
2054
+ detailedMessage: string | undefined;
2055
+ /**
2056
+ * @public
2057
+ * <p>The ID of the request in question.</p>
2058
+ */
2059
+ requestId: string | undefined;
2060
+ /**
2061
+ * @public
2062
+ * <p>The HTTP status code returned with the exception.</p>
2063
+ */
2064
+ code: string | undefined;
2065
+ /**
2066
+ * @internal
2067
+ */
2068
+ constructor(opts: __ExceptionOptionType<ExpiredStreamException, __BaseException>);
2069
+ }
2070
+ /**
2071
+ * @public
2072
+ * @enum
2073
+ */
2074
+ export declare const Encoding: {
2075
+ readonly GZIP: "gzip";
2076
+ };
2077
+ /**
2078
+ * @public
2079
+ */
2080
+ export type Encoding = (typeof Encoding)[keyof typeof Encoding];
2081
+ /**
2082
+ * @public
2083
+ * @enum
2084
+ */
2085
+ export declare const IteratorType: {
2086
+ readonly AFTER_SEQUENCE_NUMBER: "AFTER_SEQUENCE_NUMBER";
2087
+ readonly AT_SEQUENCE_NUMBER: "AT_SEQUENCE_NUMBER";
2088
+ readonly LATEST: "LATEST";
2089
+ readonly TRIM_HORIZON: "TRIM_HORIZON";
2090
+ };
2091
+ /**
2092
+ * @public
2093
+ */
2094
+ export type IteratorType = (typeof IteratorType)[keyof typeof IteratorType];
2095
+ /**
2096
+ * @public
2097
+ */
2098
+ export interface GetPropertygraphStreamInput {
2099
+ /**
2100
+ * @public
2101
+ * <p>Specifies the maximum number of records to return. There
2102
+ * is also a size limit of 10 MB on the response that can't be modified
2103
+ * and that takes precedence over the number of records specified in
2104
+ * the <code>limit</code> parameter. The response does include a
2105
+ * threshold-breaching record if the 10 MB limit was reached.</p>
2106
+ * <p>The range for <code>limit</code> is 1 to 100,000, with a
2107
+ * default of 10.</p>
2108
+ */
2109
+ limit?: number;
2110
+ /**
2111
+ * @public
2112
+ * <p>Can be one of:</p>
2113
+ * <ul>
2114
+ * <li>
2115
+ * <p>
2116
+ * <code>AT_SEQUENCE_NUMBER</code>   –
2117
+ * Indicates that reading should start from the event sequence number
2118
+ * specified jointly by the <code>commitNum</code> and
2119
+ * <code>opNum</code> parameters.</p>
2120
+ * </li>
2121
+ * <li>
2122
+ * <p>
2123
+ * <code>AFTER_SEQUENCE_NUMBER</code>   –
2124
+ * Indicates that reading should start right after the event sequence number
2125
+ * specified jointly by the <code>commitNum</code> and <code>opNum</code>
2126
+ * parameters.</p>
2127
+ * </li>
2128
+ * <li>
2129
+ * <p>
2130
+ * <code>TRIM_HORIZON</code>   –
2131
+ * Indicates that reading should start at the last untrimmed record in the system,
2132
+ * which is the oldest unexpired (not yet deleted) record in the change-log stream.</p>
2133
+ * </li>
2134
+ * <li>
2135
+ * <p>
2136
+ * <code>LATEST</code>   –
2137
+ * Indicates that reading should start at the most recent record in the system,
2138
+ * which is the latest unexpired (not yet deleted) record in the change-log stream.</p>
2139
+ * </li>
2140
+ * </ul>
2141
+ */
2142
+ iteratorType?: IteratorType | string;
2143
+ /**
2144
+ * @public
2145
+ * <p>The commit number of the starting record to read from the
2146
+ * change-log stream. This parameter is required when <code>iteratorType</code>
2147
+ * is<code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>, and
2148
+ * ignored when <code>iteratorType</code> is <code>TRIM_HORIZON</code> or
2149
+ * <code>LATEST</code>.</p>
2150
+ */
2151
+ commitNum?: number;
2152
+ /**
2153
+ * @public
2154
+ * <p>The operation sequence number within the specified commit to
2155
+ * start reading from in the change-log stream data. The default is <code>1</code>.</p>
2156
+ */
2157
+ opNum?: number;
2158
+ /**
2159
+ * @public
2160
+ * <p>If set to TRUE, Neptune compresses the response using gzip encoding.</p>
2161
+ */
2162
+ encoding?: Encoding | string;
2163
+ }
2164
+ /**
2165
+ * @public
2166
+ * <p>A Gremlin or openCypher change record.</p>
2167
+ */
2168
+ export interface PropertygraphData {
2169
+ /**
2170
+ * @public
2171
+ * <p>The ID of the Gremlin or openCypher element.</p>
2172
+ */
2173
+ id: string | undefined;
2174
+ /**
2175
+ * @public
2176
+ * <p>The type of this Gremlin or openCypher element. Must be one of:</p>
2177
+ * <ul>
2178
+ * <li>
2179
+ * <p>
2180
+ * <b>
2181
+ * <code>v1</code>
2182
+ * </b>   -
2183
+ * Vertex label for Gremlin, or node label for openCypher.</p>
2184
+ * </li>
2185
+ * <li>
2186
+ * <p>
2187
+ * <b>
2188
+ * <code>vp</code>
2189
+ * </b>   -
2190
+ * Vertex properties for Gremlin, or node properties for openCypher.</p>
2191
+ * </li>
2192
+ * <li>
2193
+ * <p>
2194
+ * <b>
2195
+ * <code>e</code>
2196
+ * </b>   -
2197
+ * Edge and edge label for Gremlin, or relationship and relationship type
2198
+ * for openCypher.</p>
2199
+ * </li>
2200
+ * <li>
2201
+ * <p>
2202
+ * <b>
2203
+ * <code>ep</code>
2204
+ * </b>   -
2205
+ * Edge properties for Gremlin, or relationship properties for openCypher.</p>
2206
+ * </li>
2207
+ * </ul>
2208
+ */
2209
+ type: string | undefined;
2210
+ /**
2211
+ * @public
2212
+ * <p>The property name. For element labels, this is <code>label</code>.</p>
2213
+ */
2214
+ key: string | undefined;
2215
+ /**
2216
+ * @public
2217
+ * <p>This is a JSON object that contains a value field for the value itself,
2218
+ * and a datatype field for the JSON data type of that value:</p>
2219
+ */
2220
+ value: __DocumentType | undefined;
2221
+ /**
2222
+ * @public
2223
+ * <p>If this is an edge (type = <code>e</code>), the ID of the
2224
+ * corresponding <code>from</code> vertex or source node.</p>
2225
+ */
2226
+ from?: string;
2227
+ /**
2228
+ * @public
2229
+ * <p>If this is an edge (type = <code>e</code>), the ID of the
2230
+ * corresponding <code>to</code> vertex or target node.</p>
2231
+ */
2232
+ to?: string;
2233
+ }
2234
+ /**
2235
+ * @public
2236
+ * <p>Structure of a property graph record.</p>
2237
+ */
2238
+ export interface PropertygraphRecord {
2239
+ /**
2240
+ * @public
2241
+ * <p>The time at which the commit for the transaction was requested,
2242
+ * in milliseconds from the Unix epoch.</p>
2243
+ */
2244
+ commitTimestampInMillis: number | undefined;
2245
+ /**
2246
+ * @public
2247
+ * <p>The sequence identifier of the stream change record.</p>
2248
+ */
2249
+ eventId: Record<string, string> | undefined;
2250
+ /**
2251
+ * @public
2252
+ * <p>The serialized Gremlin or openCypher change record.</p>
2253
+ */
2254
+ data: PropertygraphData | undefined;
2255
+ /**
2256
+ * @public
2257
+ * <p>The operation that created the change.</p>
2258
+ */
2259
+ op: string | undefined;
2260
+ /**
2261
+ * @public
2262
+ * <p>Only present if this operation is the last one in its transaction.
2263
+ * If present, it is set to true. It is useful for ensuring that an
2264
+ * entire transaction is consumed.</p>
2265
+ */
2266
+ isLastOp?: boolean;
2267
+ }
2268
+ /**
2269
+ * @public
2270
+ */
2271
+ export interface GetPropertygraphStreamOutput {
2272
+ /**
2273
+ * @public
2274
+ * <p>Sequence identifier of the last change in the stream response.</p>
2275
+ * <p>An event ID is composed of two fields: a <code>commitNum</code>, which
2276
+ * identifies a transaction that changed the graph, and an <code>opNum</code>,
2277
+ * which identifies a specific operation within that transaction:</p>
2278
+ */
2279
+ lastEventId: Record<string, string> | undefined;
2280
+ /**
2281
+ * @public
2282
+ * <p>The time at which the commit for the transaction was requested,
2283
+ * in milliseconds from the Unix epoch.</p>
2284
+ */
2285
+ lastTrxTimestampInMillis: number | undefined;
2286
+ /**
2287
+ * @public
2288
+ * <p>Serialization format for the change records being returned.
2289
+ * Currently, the only supported value is <code>PG_JSON</code>.</p>
2290
+ */
2291
+ format: string | undefined;
2292
+ /**
2293
+ * @public
2294
+ * <p>An array of serialized change-log stream records included in the response.</p>
2295
+ */
2296
+ records: PropertygraphRecord[] | undefined;
2297
+ /**
2298
+ * @public
2299
+ * <p>The total number of records in the response.</p>
2300
+ */
2301
+ totalRecords: number | undefined;
2302
+ }
2303
+ /**
2304
+ * @public
2305
+ * <p>Raised when stream records requested by a query cannot be found.</p>
2306
+ */
2307
+ export declare class StreamRecordsNotFoundException extends __BaseException {
2308
+ readonly name: "StreamRecordsNotFoundException";
2309
+ readonly $fault: "client";
2310
+ /**
2311
+ * @public
2312
+ * <p>A detailed message describing the problem.</p>
2313
+ */
2314
+ detailedMessage: string | undefined;
2315
+ /**
2316
+ * @public
2317
+ * <p>The ID of the request in question.</p>
2318
+ */
2319
+ requestId: string | undefined;
2320
+ /**
2321
+ * @public
2322
+ * <p>The HTTP status code returned with the exception.</p>
2323
+ */
2324
+ code: string | undefined;
2325
+ /**
2326
+ * @internal
2327
+ */
2328
+ constructor(opts: __ExceptionOptionType<StreamRecordsNotFoundException, __BaseException>);
2329
+ }
2330
+ /**
2331
+ * @public
2332
+ * <p>Raised when the rate of requests exceeds the maximum throughput. Requests can
2333
+ * be retried after encountering this exception.</p>
2334
+ */
2335
+ export declare class ThrottlingException extends __BaseException {
2336
+ readonly name: "ThrottlingException";
2337
+ readonly $fault: "server";
2338
+ $retryable: {};
2339
+ /**
2340
+ * @public
2341
+ * <p>A detailed message describing the problem.</p>
2342
+ */
2343
+ detailedMessage: string | undefined;
2344
+ /**
2345
+ * @public
2346
+ * <p>The ID of the request that could not be processed for this reason.</p>
2347
+ */
2348
+ requestId: string | undefined;
2349
+ /**
2350
+ * @public
2351
+ * <p>The HTTP status code returned with the exception.</p>
2352
+ */
2353
+ code: string | undefined;
2354
+ /**
2355
+ * @internal
2356
+ */
2357
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
2358
+ }
2359
+ /**
2360
+ * @public
2361
+ * @enum
2362
+ */
2363
+ export declare const GraphSummaryType: {
2364
+ readonly BASIC: "basic";
2365
+ readonly DETAILED: "detailed";
2366
+ };
2367
+ /**
2368
+ * @public
2369
+ */
2370
+ export type GraphSummaryType = (typeof GraphSummaryType)[keyof typeof GraphSummaryType];
2371
+ /**
2372
+ * @public
2373
+ */
2374
+ export interface GetPropertygraphSummaryInput {
2375
+ /**
2376
+ * @public
2377
+ * <p>Mode can take one of two values: <code>BASIC</code> (the default),
2378
+ * and <code>DETAILED</code>.</p>
2379
+ */
2380
+ mode?: GraphSummaryType | string;
2381
+ }
2382
+ /**
2383
+ * @public
2384
+ * <p>An edge structure.</p>
2385
+ */
2386
+ export interface EdgeStructure {
2387
+ /**
2388
+ * @public
2389
+ * <p>The number of edges that have this specific structure.</p>
2390
+ */
2391
+ count?: number;
2392
+ /**
2393
+ * @public
2394
+ * <p>A list of edge properties present in this specific structure.</p>
2395
+ */
2396
+ edgeProperties?: string[];
2397
+ }
2398
+ /**
2399
+ * @public
2400
+ * <p>A node structure.</p>
2401
+ */
2402
+ export interface NodeStructure {
2403
+ /**
2404
+ * @public
2405
+ * <p>Number of nodes that have this specific structure.</p>
2406
+ */
2407
+ count?: number;
2408
+ /**
2409
+ * @public
2410
+ * <p>A list of the node properties present in this specific structure.</p>
2411
+ */
2412
+ nodeProperties?: string[];
2413
+ /**
2414
+ * @public
2415
+ * <p>A list of distinct outgoing edge labels present in this specific structure.</p>
2416
+ */
2417
+ distinctOutgoingEdgeLabels?: string[];
2418
+ }
2419
+ /**
2420
+ * @public
2421
+ * <p>The graph summary API returns a read-only list of node and edge
2422
+ * labels and property keys, along with counts of nodes, edges, and
2423
+ * properties. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response">Graph
2424
+ * summary response for a property graph (PG)</a>.</p>
2425
+ */
2426
+ export interface PropertygraphSummary {
2427
+ /**
2428
+ * @public
2429
+ * <p>The number of nodes in the graph.</p>
2430
+ */
2431
+ numNodes?: number;
2432
+ /**
2433
+ * @public
2434
+ * <p>The number of edges in the graph.</p>
2435
+ */
2436
+ numEdges?: number;
2437
+ /**
2438
+ * @public
2439
+ * <p>The number of distinct node labels in the graph.</p>
2440
+ */
2441
+ numNodeLabels?: number;
2442
+ /**
2443
+ * @public
2444
+ * <p>The number of distinct edge labels in the graph.</p>
2445
+ */
2446
+ numEdgeLabels?: number;
2447
+ /**
2448
+ * @public
2449
+ * <p>A list of the distinct node labels in the graph.</p>
2450
+ */
2451
+ nodeLabels?: string[];
2452
+ /**
2453
+ * @public
2454
+ * <p>A list of the distinct edge labels in the graph.</p>
2455
+ */
2456
+ edgeLabels?: string[];
2457
+ /**
2458
+ * @public
2459
+ * <p>A list of the distinct node properties in the graph, along
2460
+ * with the count of nodes where each property is used.</p>
2461
+ */
2462
+ numNodeProperties?: number;
2463
+ /**
2464
+ * @public
2465
+ * <p>The number of distinct edge properties in the graph.</p>
2466
+ */
2467
+ numEdgeProperties?: number;
2468
+ /**
2469
+ * @public
2470
+ * <p>The number of distinct node properties in the graph.</p>
2471
+ */
2472
+ nodeProperties?: Record<string, number>[];
2473
+ /**
2474
+ * @public
2475
+ * <p>A list of the distinct edge properties in the graph, along
2476
+ * with the count of edges where each property is used.</p>
2477
+ */
2478
+ edgeProperties?: Record<string, number>[];
2479
+ /**
2480
+ * @public
2481
+ * <p>The total number of usages of all node properties.</p>
2482
+ */
2483
+ totalNodePropertyValues?: number;
2484
+ /**
2485
+ * @public
2486
+ * <p>The total number of usages of all edge properties.</p>
2487
+ */
2488
+ totalEdgePropertyValues?: number;
2489
+ /**
2490
+ * @public
2491
+ * <p>This field is only present when the requested mode is
2492
+ * <code>DETAILED</code>. It contains a list of node structures.</p>
2493
+ */
2494
+ nodeStructures?: NodeStructure[];
2495
+ /**
2496
+ * @public
2497
+ * <p>This field is only present when the requested mode is
2498
+ * <code>DETAILED</code>. It contains a list of edge structures.</p>
2499
+ */
2500
+ edgeStructures?: EdgeStructure[];
2501
+ }
2502
+ /**
2503
+ * @public
2504
+ * <p>Payload for the property graph summary response.</p>
2505
+ */
2506
+ export interface PropertygraphSummaryValueMap {
2507
+ /**
2508
+ * @public
2509
+ * <p>The version of this graph summary response.</p>
2510
+ */
2511
+ version?: string;
2512
+ /**
2513
+ * @public
2514
+ * <p>The timestamp, in ISO 8601 format, of the time at which Neptune last computed statistics.</p>
2515
+ */
2516
+ lastStatisticsComputationTime?: Date;
2517
+ /**
2518
+ * @public
2519
+ * <p>The graph summary.</p>
2520
+ */
2521
+ graphSummary?: PropertygraphSummary;
2522
+ }
2523
+ /**
2524
+ * @public
2525
+ */
2526
+ export interface GetPropertygraphSummaryOutput {
2527
+ /**
2528
+ * @public
2529
+ * <p>The HTTP return code of the request. If the request succeeded,
2530
+ * the code is 200.</p>
2531
+ */
2532
+ statusCode?: number;
2533
+ /**
2534
+ * @public
2535
+ * <p>Payload containing the property graph summary response.</p>
2536
+ */
2537
+ payload?: PropertygraphSummaryValueMap;
2538
+ }
2539
+ /**
2540
+ * @public
2541
+ */
2542
+ export interface GetRDFGraphSummaryInput {
2543
+ /**
2544
+ * @public
2545
+ * <p>Mode can take one of two values: <code>BASIC</code> (the default),
2546
+ * and <code>DETAILED</code>.</p>
2547
+ */
2548
+ mode?: GraphSummaryType | string;
2549
+ }
2550
+ /**
2551
+ * @public
2552
+ * <p>A subject structure.</p>
2553
+ */
2554
+ export interface SubjectStructure {
2555
+ /**
2556
+ * @public
2557
+ * <p>Number of occurrences of this specific structure.</p>
2558
+ */
2559
+ count?: number;
2560
+ /**
2561
+ * @public
2562
+ * <p>A list of predicates present in this specific structure.</p>
2563
+ */
2564
+ predicates?: string[];
2565
+ }
2566
+ /**
2567
+ * @public
2568
+ * <p>The RDF graph summary API returns a read-only list of classes and
2569
+ * predicate keys, along with counts of quads, subjects, and predicates.</p>
2570
+ */
2571
+ export interface RDFGraphSummary {
2572
+ /**
2573
+ * @public
2574
+ * <p>The number of distinct subjects in the graph.</p>
2575
+ */
2576
+ numDistinctSubjects?: number;
2577
+ /**
2578
+ * @public
2579
+ * <p>The number of distinct predicates in the graph.</p>
2580
+ */
2581
+ numDistinctPredicates?: number;
2582
+ /**
2583
+ * @public
2584
+ * <p>The number of quads in the graph.</p>
2585
+ */
2586
+ numQuads?: number;
2587
+ /**
2588
+ * @public
2589
+ * <p>The number of classes in the graph.</p>
2590
+ */
2591
+ numClasses?: number;
2592
+ /**
2593
+ * @public
2594
+ * <p>A list of the classes in the graph.</p>
2595
+ */
2596
+ classes?: string[];
2597
+ /**
2598
+ * @public
2599
+ * <p>"A list of predicates in the graph, along with the predicate counts.</p>
2600
+ */
2601
+ predicates?: Record<string, number>[];
2602
+ /**
2603
+ * @public
2604
+ * <p>This field is only present when the request mode is
2605
+ * <code>DETAILED</code>. It contains a list of subject structures.</p>
2606
+ */
2607
+ subjectStructures?: SubjectStructure[];
2608
+ }
2609
+ /**
2610
+ * @public
2611
+ * <p>Payload for an RDF graph summary response.</p>
2612
+ */
2613
+ export interface RDFGraphSummaryValueMap {
2614
+ /**
2615
+ * @public
2616
+ * <p>The version of this graph summary response.</p>
2617
+ */
2618
+ version?: string;
2619
+ /**
2620
+ * @public
2621
+ * <p>The timestamp, in ISO 8601 format, of the time at which Neptune
2622
+ * last computed statistics.</p>
2623
+ */
2624
+ lastStatisticsComputationTime?: Date;
2625
+ /**
2626
+ * @public
2627
+ * <p>The graph summary of an RDF graph. See <a href="https://docs.aws.amazon.com/neptune-graph-summary.html#neptune-graph-summary-rdf-response">Graph
2628
+ * summary response for an RDF graph</a>.</p>
2629
+ */
2630
+ graphSummary?: RDFGraphSummary;
2631
+ }
2632
+ /**
2633
+ * @public
2634
+ */
2635
+ export interface GetRDFGraphSummaryOutput {
2636
+ /**
2637
+ * @public
2638
+ * <p>The HTTP return code of the request. If the request succeeded,
2639
+ * the code is 200.</p>
2640
+ */
2641
+ statusCode?: number;
2642
+ /**
2643
+ * @public
2644
+ * <p>Payload for an RDF graph summary response</p>
2645
+ */
2646
+ payload?: RDFGraphSummaryValueMap;
2647
+ }
2648
+ /**
2649
+ * @public
2650
+ */
2651
+ export interface GetSparqlStatisticsOutput {
2652
+ /**
2653
+ * @public
2654
+ * <p>The HTTP return code of the request. If the request succeeded,
2655
+ * the code is 200. See <a href="docs.aws.amazon.comneptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors">Common
2656
+ * error codes for DFE statistics request</a> for a list of common errors.</p>
2657
+ */
2658
+ status: string | undefined;
2659
+ /**
2660
+ * @public
2661
+ * <p>Statistics for RDF data.</p>
2662
+ */
2663
+ payload: Statistics | undefined;
2664
+ }
2665
+ /**
2666
+ * @public
2667
+ */
2668
+ export interface GetSparqlStreamInput {
2669
+ /**
2670
+ * @public
2671
+ * <p>Specifies the maximum number of records to return. There
2672
+ * is also a size limit of 10 MB on the response that can't be modified
2673
+ * and that takes precedence over the number of records specified in
2674
+ * the <code>limit</code> parameter. The response does include a
2675
+ * threshold-breaching record if the 10 MB limit was reached.</p>
2676
+ * <p>The range for <code>limit</code> is 1 to 100,000, with a
2677
+ * default of 10.</p>
2678
+ */
2679
+ limit?: number;
2680
+ /**
2681
+ * @public
2682
+ * <p>Can be one of:</p>
2683
+ * <ul>
2684
+ * <li>
2685
+ * <p>
2686
+ * <code>AT_SEQUENCE_NUMBER</code>   –
2687
+ * Indicates that reading should start from the event sequence number
2688
+ * specified jointly by the <code>commitNum</code> and
2689
+ * <code>opNum</code> parameters.</p>
2690
+ * </li>
2691
+ * <li>
2692
+ * <p>
2693
+ * <code>AFTER_SEQUENCE_NUMBER</code>   –
2694
+ * Indicates that reading should start right after the event sequence number
2695
+ * specified jointly by the <code>commitNum</code> and <code>opNum</code>
2696
+ * parameters.</p>
2697
+ * </li>
2698
+ * <li>
2699
+ * <p>
2700
+ * <code>TRIM_HORIZON</code>   –
2701
+ * Indicates that reading should start at the last untrimmed record in the system,
2702
+ * which is the oldest unexpired (not yet deleted) record in the change-log stream.</p>
2703
+ * </li>
2704
+ * <li>
2705
+ * <p>
2706
+ * <code>LATEST</code>   –
2707
+ * Indicates that reading should start at the most recent record in the system,
2708
+ * which is the latest unexpired (not yet deleted) record in the change-log stream.</p>
2709
+ * </li>
2710
+ * </ul>
2711
+ */
2712
+ iteratorType?: IteratorType | string;
2713
+ /**
2714
+ * @public
2715
+ * <p>The commit number of the starting record to read from the
2716
+ * change-log stream. This parameter is required when <code>iteratorType</code>
2717
+ * is<code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>, and
2718
+ * ignored when <code>iteratorType</code> is <code>TRIM_HORIZON</code> or
2719
+ * <code>LATEST</code>.</p>
2720
+ */
2721
+ commitNum?: number;
2722
+ /**
2723
+ * @public
2724
+ * <p>The operation sequence number within the specified commit to
2725
+ * start reading from in the change-log stream data. The default is <code>1</code>.</p>
2726
+ */
2727
+ opNum?: number;
2728
+ /**
2729
+ * @public
2730
+ * <p>If set to TRUE, Neptune compresses the response using gzip encoding.</p>
2731
+ */
2732
+ encoding?: Encoding | string;
2733
+ }
2734
+ /**
2735
+ * @public
2736
+ * <p>Neptune logs are converted to SPARQL quads in the graph using the
2737
+ * Resource Description Framework (RDF) <a href="https://www.w3.org/TR/n-quads/">N-QUADS</a> language defined
2738
+ * in the W3C RDF 1.1 N-Quads specification</p>
2739
+ */
2740
+ export interface SparqlData {
2741
+ /**
2742
+ * @public
2743
+ * <p>Holds an <a href="https://www.w3.org/TR/n-quads/">N-QUADS</a>
2744
+ * statement expressing the changed quad.</p>
2745
+ */
2746
+ stmt: string | undefined;
2747
+ }
2748
+ /**
2749
+ * @public
2750
+ * <p>A serialized SPARQL stream record capturing a change-log entry
2751
+ * for the RDF graph.</p>
2752
+ */
2753
+ export interface SparqlRecord {
2754
+ /**
2755
+ * @public
2756
+ * <p>The time at which the commit for the transaction was requested,
2757
+ * in milliseconds from the Unix epoch.</p>
2758
+ */
2759
+ commitTimestampInMillis: number | undefined;
2760
+ /**
2761
+ * @public
2762
+ * <p>The sequence identifier of the stream change record.</p>
2763
+ */
2764
+ eventId: Record<string, string> | undefined;
2765
+ /**
2766
+ * @public
2767
+ * <p>The serialized SPARQL change record. The serialization formats
2768
+ * of each record are described in more detail in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams-change-formats.html">Serialization
2769
+ * Formats in Neptune Streams</a>.</p>
2770
+ */
2771
+ data: SparqlData | undefined;
2772
+ /**
2773
+ * @public
2774
+ * <p>The operation that created the change.</p>
2775
+ */
2776
+ op: string | undefined;
2777
+ /**
2778
+ * @public
2779
+ * <p>Only present if this operation is the last one in its transaction.
2780
+ * If present, it is set to true. It is useful for ensuring that an
2781
+ * entire transaction is consumed.</p>
2782
+ */
2783
+ isLastOp?: boolean;
2784
+ }
2785
+ /**
2786
+ * @public
2787
+ */
2788
+ export interface GetSparqlStreamOutput {
2789
+ /**
2790
+ * @public
2791
+ * <p>Sequence identifier of the last change in the stream response.</p>
2792
+ * <p>An event ID is composed of two fields: a <code>commitNum</code>, which
2793
+ * identifies a transaction that changed the graph, and an <code>opNum</code>,
2794
+ * which identifies a specific operation within that transaction:</p>
2795
+ */
2796
+ lastEventId: Record<string, string> | undefined;
2797
+ /**
2798
+ * @public
2799
+ * <p>The time at which the commit for the transaction was requested,
2800
+ * in milliseconds from the Unix epoch.</p>
2801
+ */
2802
+ lastTrxTimestampInMillis: number | undefined;
2803
+ /**
2804
+ * @public
2805
+ * <p>Serialization format for the change records being returned.
2806
+ * Currently, the only supported value is <code>NQUADS</code>.</p>
2807
+ */
2808
+ format: string | undefined;
2809
+ /**
2810
+ * @public
2811
+ * <p>An array of serialized change-log stream records included in the response.</p>
2812
+ */
2813
+ records: SparqlRecord[] | undefined;
2814
+ /**
2815
+ * @public
2816
+ * <p>The total number of records in the response.</p>
2817
+ */
2818
+ totalRecords: number | undefined;
2819
+ }
2820
+ /**
2821
+ * @public
2822
+ */
2823
+ export interface ListGremlinQueriesInput {
2824
+ /**
2825
+ * @public
2826
+ * <p>If set to <code>TRUE</code>, the list returned includes waiting
2827
+ * queries. The default is <code>FALSE</code>;</p>
2828
+ */
2829
+ includeWaiting?: boolean;
2830
+ }
2831
+ /**
2832
+ * @public
2833
+ * <p>Captures the status of a Gremlin query (see the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html">Gremlin query
2834
+ * status API</a> page).</p>
2835
+ */
2836
+ export interface GremlinQueryStatus {
2837
+ /**
2838
+ * @public
2839
+ * <p>The ID of the Gremlin query.</p>
2840
+ */
2841
+ queryId?: string;
2842
+ /**
2843
+ * @public
2844
+ * <p>The query string of the Gremlin query.</p>
2845
+ */
2846
+ queryString?: string;
2847
+ /**
2848
+ * @public
2849
+ * <p>The query statistics of the Gremlin query.</p>
2850
+ */
2851
+ queryEvalStats?: QueryEvalStats;
2852
+ }
2853
+ /**
2854
+ * @public
2855
+ */
2856
+ export interface ListGremlinQueriesOutput {
2857
+ /**
2858
+ * @public
2859
+ * <p>The number of queries that have been accepted but not yet
2860
+ * completed, including queries in the queue.</p>
2861
+ */
2862
+ acceptedQueryCount?: number;
2863
+ /**
2864
+ * @public
2865
+ * <p>The number of Gremlin queries currently running.</p>
2866
+ */
2867
+ runningQueryCount?: number;
2868
+ /**
2869
+ * @public
2870
+ * <p>A list of the current queries.</p>
2871
+ */
2872
+ queries?: GremlinQueryStatus[];
2873
+ }
2874
+ /**
2875
+ * @public
2876
+ */
2877
+ export interface ListLoaderJobsInput {
2878
+ /**
2879
+ * @public
2880
+ * <p>The number of load IDs to list. Must be a positive integer
2881
+ * greater than zero and not more than <code>100</code> (which is the default).</p>
2882
+ */
2883
+ limit?: number;
2884
+ /**
2885
+ * @public
2886
+ * <p>An optional parameter that can be used to exclude the load
2887
+ * IDs of queued load requests when requesting a list of load IDs by
2888
+ * setting the parameter to <code>FALSE</code>. The default value
2889
+ * is <code>TRUE</code>.</p>
2890
+ */
2891
+ includeQueuedLoads?: boolean;
2892
+ }
2893
+ /**
2894
+ * @public
2895
+ * <p>Contains a list of load IDs.</p>
2896
+ */
2897
+ export interface LoaderIdResult {
2898
+ /**
2899
+ * @public
2900
+ * <p>A list of load IDs.</p>
2901
+ */
2902
+ loadIds?: string[];
2903
+ }
2904
+ /**
2905
+ * @public
2906
+ */
2907
+ export interface ListLoaderJobsOutput {
2908
+ /**
2909
+ * @public
2910
+ * <p>Returns the status of the job list request.</p>
2911
+ */
2912
+ status: string | undefined;
2913
+ /**
2914
+ * @public
2915
+ * <p>The requested list of job IDs.</p>
2916
+ */
2917
+ payload: LoaderIdResult | undefined;
2918
+ }
2919
+ /**
2920
+ * @public
2921
+ */
2922
+ export interface ListMLDataProcessingJobsInput {
2923
+ /**
2924
+ * @public
2925
+ * <p>The maximum number of items to return (from 1 to 1024; the default is 10).</p>
2926
+ */
2927
+ maxItems?: number;
2928
+ /**
2929
+ * @public
2930
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
2931
+ * and Amazon S3 resources. This must be listed in your DB cluster
2932
+ * parameter group or an error will occur.</p>
2933
+ */
2934
+ neptuneIamRoleArn?: string;
2935
+ }
2936
+ /**
2937
+ * @public
2938
+ */
2939
+ export interface ListMLDataProcessingJobsOutput {
2940
+ /**
2941
+ * @public
2942
+ * <p>A page listing data processing job IDs.</p>
2943
+ */
2944
+ ids?: string[];
2945
+ }
2946
+ /**
2947
+ * @public
2948
+ */
2949
+ export interface ListMLEndpointsInput {
2950
+ /**
2951
+ * @public
2952
+ * <p>The maximum number of items to return (from 1 to 1024; the default
2953
+ * is 10.</p>
2954
+ */
2955
+ maxItems?: number;
2956
+ /**
2957
+ * @public
2958
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
2959
+ * and Amazon S3 resources. This must be listed in your DB cluster
2960
+ * parameter group or an error will occur.</p>
2961
+ */
2962
+ neptuneIamRoleArn?: string;
2963
+ }
2964
+ /**
2965
+ * @public
2966
+ */
2967
+ export interface ListMLEndpointsOutput {
2968
+ /**
2969
+ * @public
2970
+ * <p>A page from the list of inference endpoint IDs.</p>
2971
+ */
2972
+ ids?: string[];
2973
+ }
2974
+ /**
2975
+ * @public
2976
+ */
2977
+ export interface ListMLModelTrainingJobsInput {
2978
+ /**
2979
+ * @public
2980
+ * <p>The maximum number of items to return (from 1 to 1024; the default
2981
+ * is 10).</p>
2982
+ */
2983
+ maxItems?: number;
2984
+ /**
2985
+ * @public
2986
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
2987
+ * and Amazon S3 resources. This must be listed in your DB cluster
2988
+ * parameter group or an error will occur.</p>
2989
+ */
2990
+ neptuneIamRoleArn?: string;
2991
+ }
2992
+ /**
2993
+ * @public
2994
+ */
2995
+ export interface ListMLModelTrainingJobsOutput {
2996
+ /**
2997
+ * @public
2998
+ * <p>A page of the list of model training job IDs.</p>
2999
+ */
3000
+ ids?: string[];
3001
+ }
3002
+ /**
3003
+ * @public
3004
+ */
3005
+ export interface ListMLModelTransformJobsInput {
3006
+ /**
3007
+ * @public
3008
+ * <p>The maximum number of items to return (from 1 to 1024; the
3009
+ * default is 10).</p>
3010
+ */
3011
+ maxItems?: number;
3012
+ /**
3013
+ * @public
3014
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
3015
+ * and Amazon S3 resources. This must be listed in your DB cluster
3016
+ * parameter group or an error will occur.</p>
3017
+ */
3018
+ neptuneIamRoleArn?: string;
3019
+ }
3020
+ /**
3021
+ * @public
3022
+ */
3023
+ export interface ListMLModelTransformJobsOutput {
3024
+ /**
3025
+ * @public
3026
+ * <p>A page from the list of model transform IDs.</p>
3027
+ */
3028
+ ids?: string[];
3029
+ }
3030
+ /**
3031
+ * @public
3032
+ */
3033
+ export interface ListOpenCypherQueriesInput {
3034
+ /**
3035
+ * @public
3036
+ * <p> When set to <code>TRUE</code> and other parameters are not
3037
+ * present, causes status information to be returned for waiting
3038
+ * queries as well as for running queries.</p>
3039
+ */
3040
+ includeWaiting?: boolean;
3041
+ }
3042
+ /**
3043
+ * @public
3044
+ */
3045
+ export interface ListOpenCypherQueriesOutput {
3046
+ /**
3047
+ * @public
3048
+ * <p>The number of queries that have been accepted but not yet completed,
3049
+ * including queries in the queue.</p>
3050
+ */
3051
+ acceptedQueryCount?: number;
3052
+ /**
3053
+ * @public
3054
+ * <p>The number of currently running openCypher queries.</p>
3055
+ */
3056
+ runningQueryCount?: number;
3057
+ /**
3058
+ * @public
3059
+ * <p>A list of current openCypher queries.</p>
3060
+ */
3061
+ queries?: GremlinQueryStatus[];
3062
+ }
3063
+ /**
3064
+ * @public
3065
+ * @enum
3066
+ */
3067
+ export declare const StatisticsAutoGenerationMode: {
3068
+ readonly DISABLE_AUTOCOMPUTE: "disableAutoCompute";
3069
+ readonly ENABLE_AUTOCOMPUTE: "enableAutoCompute";
3070
+ readonly REFRESH: "refresh";
3071
+ };
3072
+ /**
3073
+ * @public
3074
+ */
3075
+ export type StatisticsAutoGenerationMode = (typeof StatisticsAutoGenerationMode)[keyof typeof StatisticsAutoGenerationMode];
3076
+ /**
3077
+ * @public
3078
+ */
3079
+ export interface ManagePropertygraphStatisticsInput {
3080
+ /**
3081
+ * @public
3082
+ * <p>The statistics generation mode. One of: <code>DISABLE_AUTOCOMPUTE</code>,
3083
+ * <code>ENABLE_AUTOCOMPUTE</code>, or <code>REFRESH</code>, the last of
3084
+ * which manually triggers DFE statistics generation.</p>
3085
+ */
3086
+ mode?: StatisticsAutoGenerationMode | string;
3087
+ }
3088
+ /**
3089
+ * @public
3090
+ * <p>Statistics for <code>REFRESH</code> mode.</p>
3091
+ */
3092
+ export interface RefreshStatisticsIdMap {
3093
+ /**
3094
+ * @public
3095
+ * <p>The ID of the statistics generation run that is currently occurring.</p>
3096
+ */
3097
+ statisticsId?: string;
3098
+ }
3099
+ /**
3100
+ * @public
3101
+ */
3102
+ export interface ManagePropertygraphStatisticsOutput {
3103
+ /**
3104
+ * @public
3105
+ * <p>The HTTP return code of the request. If the request succeeded,
3106
+ * the code is 200.</p>
3107
+ */
3108
+ status: string | undefined;
3109
+ /**
3110
+ * @public
3111
+ * <p>This is only returned for refresh mode.</p>
3112
+ */
3113
+ payload?: RefreshStatisticsIdMap;
3114
+ }
3115
+ /**
3116
+ * @public
3117
+ */
3118
+ export interface ManageSparqlStatisticsInput {
3119
+ /**
3120
+ * @public
3121
+ * <p>The statistics generation mode. One of: <code>DISABLE_AUTOCOMPUTE</code>,
3122
+ * <code>ENABLE_AUTOCOMPUTE</code>, or <code>REFRESH</code>, the last of
3123
+ * which manually triggers DFE statistics generation.</p>
3124
+ */
3125
+ mode?: StatisticsAutoGenerationMode | string;
3126
+ }
3127
+ /**
3128
+ * @public
3129
+ */
3130
+ export interface ManageSparqlStatisticsOutput {
3131
+ /**
3132
+ * @public
3133
+ * <p>The HTTP return code of the request. If the request succeeded,
3134
+ * the code is 200.</p>
3135
+ */
3136
+ status: string | undefined;
3137
+ /**
3138
+ * @public
3139
+ * <p>This is only returned for refresh mode.</p>
3140
+ */
3141
+ payload?: RefreshStatisticsIdMap;
3142
+ }
3143
+ /**
3144
+ * @public
3145
+ * <p>Raised when there is a problem accessing Amazon S3.</p>
3146
+ */
3147
+ export declare class S3Exception extends __BaseException {
3148
+ readonly name: "S3Exception";
3149
+ readonly $fault: "client";
3150
+ $retryable: {};
3151
+ /**
3152
+ * @public
3153
+ * <p>A detailed message describing the problem.</p>
3154
+ */
3155
+ detailedMessage: string | undefined;
3156
+ /**
3157
+ * @public
3158
+ * <p>The ID of the request in question.</p>
3159
+ */
3160
+ requestId: string | undefined;
3161
+ /**
3162
+ * @public
3163
+ * <p>The HTTP status code returned with the exception.</p>
3164
+ */
3165
+ code: string | undefined;
3166
+ /**
3167
+ * @internal
3168
+ */
3169
+ constructor(opts: __ExceptionOptionType<S3Exception, __BaseException>);
3170
+ }
3171
+ /**
3172
+ * @public
3173
+ * @enum
3174
+ */
3175
+ export declare const Format: {
3176
+ readonly CSV: "csv";
3177
+ readonly NQUADS: "nquads";
3178
+ readonly NTRIPLES: "ntriples";
3179
+ readonly OPENCYPHER: "opencypher";
3180
+ readonly RDFXML: "rdfxml";
3181
+ readonly TURTLE: "turtle";
3182
+ };
3183
+ /**
3184
+ * @public
3185
+ */
3186
+ export type Format = (typeof Format)[keyof typeof Format];
3187
+ /**
3188
+ * @public
3189
+ * @enum
3190
+ */
3191
+ export declare const Mode: {
3192
+ readonly AUTO: "AUTO";
3193
+ readonly NEW: "NEW";
3194
+ readonly RESUME: "RESUME";
3195
+ };
3196
+ /**
3197
+ * @public
3198
+ */
3199
+ export type Mode = (typeof Mode)[keyof typeof Mode];
3200
+ /**
3201
+ * @public
3202
+ * @enum
3203
+ */
3204
+ export declare const Parallelism: {
3205
+ readonly HIGH: "HIGH";
3206
+ readonly LOW: "LOW";
3207
+ readonly MEDIUM: "MEDIUM";
3208
+ readonly OVERSUBSCRIBE: "OVERSUBSCRIBE";
3209
+ };
3210
+ /**
3211
+ * @public
3212
+ */
3213
+ export type Parallelism = (typeof Parallelism)[keyof typeof Parallelism];
3214
+ /**
3215
+ * @public
3216
+ * @enum
3217
+ */
3218
+ export declare const S3BucketRegion: {
3219
+ readonly AF_SOUTH_1: "af-south-1";
3220
+ readonly AP_EAST_1: "ap-east-1";
3221
+ readonly AP_NORTHEAST_1: "ap-northeast-1";
3222
+ readonly AP_NORTHEAST_2: "ap-northeast-2";
3223
+ readonly AP_SOUTHEAST_1: "ap-southeast-1";
3224
+ readonly AP_SOUTHEAST_2: "ap-southeast-2";
3225
+ readonly AP_SOUTH_1: "ap-south-1";
3226
+ readonly CA_CENTRAL_1: "ca-central-1";
3227
+ readonly CN_NORTHWEST_1: "cn-northwest-1";
3228
+ readonly CN_NORTH_1: "cn-north-1";
3229
+ readonly EU_CENTRAL_1: "eu-central-1";
3230
+ readonly EU_NORTH_1: "eu-north-1";
3231
+ readonly EU_WEST_1: "eu-west-1";
3232
+ readonly EU_WEST_2: "eu-west-2";
3233
+ readonly EU_WEST_3: "eu-west-3";
3234
+ readonly ME_SOUTH_1: "me-south-1";
3235
+ readonly SA_EAST_1: "sa-east-1";
3236
+ readonly US_EAST_1: "us-east-1";
3237
+ readonly US_EAST_2: "us-east-2";
3238
+ readonly US_GOV_EAST_1: "us-gov-east-1";
3239
+ readonly US_GOV_WEST_1: "us-gov-west-1";
3240
+ readonly US_WEST_1: "us-west-1";
3241
+ readonly US_WEST_2: "us-west-2";
3242
+ };
3243
+ /**
3244
+ * @public
3245
+ */
3246
+ export type S3BucketRegion = (typeof S3BucketRegion)[keyof typeof S3BucketRegion];
3247
+ /**
3248
+ * @public
3249
+ */
3250
+ export interface StartLoaderJobInput {
3251
+ /**
3252
+ * @public
3253
+ * <p>The <code>source</code> parameter accepts an S3 URI that identifies a single
3254
+ * file, multiple files, a folder, or multiple folders. Neptune loads every data file
3255
+ * in any folder that is specified.</p>
3256
+ * <p>The URI can be in any of the following formats.</p>
3257
+ * <ul>
3258
+ * <li>
3259
+ * <p>
3260
+ * <code>s3://(bucket_name)/(object-key-name)</code>
3261
+ * </p>
3262
+ * </li>
3263
+ * <li>
3264
+ * <p>
3265
+ * <code>https://s3.amazonaws.com/(bucket_name)/(object-key-name)</code>
3266
+ * </p>
3267
+ * </li>
3268
+ * <li>
3269
+ * <p>
3270
+ * <code>https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)</code>
3271
+ * </p>
3272
+ * </li>
3273
+ * </ul>
3274
+ * <p>The <code>object-key-name</code> element of the URI is equivalent to the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters">prefix</a>
3275
+ * parameter in an S3 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>
3276
+ * API call. It identifies all the objects in the specified S3 bucket whose names begin with
3277
+ * that prefix. That can be a single file or folder, or multiple files and/or folders.</p>
3278
+ * <p>The specified folder or folders can contain multiple vertex files and multiple edge files.</p>
3279
+ */
3280
+ source: string | undefined;
3281
+ /**
3282
+ * @public
3283
+ * <p>The format of the data. For more information about data formats for the Neptune
3284
+ * <code>Loader</code> command, see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html">Load Data Formats</a>.</p>
3285
+ * <p class="title">
3286
+ * <b>Allowed values</b>
3287
+ * </p>
3288
+ * <ul>
3289
+ * <li>
3290
+ * <p>
3291
+ * <b>
3292
+ * <code>csv</code>
3293
+ * </b> for the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin CSV data format</a>.</p>
3294
+ * </li>
3295
+ * <li>
3296
+ * <p>
3297
+ * <b>
3298
+ * <code>opencypher</code>
3299
+ * </b> for the
3300
+ * <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher CSV data format</a>.</p>
3301
+ * </li>
3302
+ * <li>
3303
+ * <p>
3304
+ * <b>
3305
+ * <code>ntriples</code>
3306
+ * </b> for the
3307
+ * <a href="https://www.w3.org/TR/n-triples/">N-Triples RDF data format</a>.</p>
3308
+ * </li>
3309
+ * <li>
3310
+ * <p>
3311
+ * <b>
3312
+ * <code>nquads</code>
3313
+ * </b> for the
3314
+ * <a href="https://www.w3.org/TR/n-quads/">N-Quads RDF data format</a>.</p>
3315
+ * </li>
3316
+ * <li>
3317
+ * <p>
3318
+ * <b>
3319
+ * <code>rdfxml</code>
3320
+ * </b> for the
3321
+ * <a href="https://www.w3.org/TR/rdf-syntax-grammar/">RDF\XML RDF data format</a>.</p>
3322
+ * </li>
3323
+ * <li>
3324
+ * <p>
3325
+ * <b>
3326
+ * <code>turtle</code>
3327
+ * </b> for the
3328
+ * <a href="https://www.w3.org/TR/turtle/">Turtle RDF data format</a>.</p>
3329
+ * </li>
3330
+ * </ul>
3331
+ */
3332
+ format: Format | string | undefined;
3333
+ /**
3334
+ * @public
3335
+ * <p>The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.</p>
3336
+ */
3337
+ s3BucketRegion: S3BucketRegion | string | undefined;
3338
+ /**
3339
+ * @public
3340
+ * <p>The Amazon Resource Name (ARN) for an IAM role to be assumed by
3341
+ * the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided
3342
+ * here should be attached to the DB cluster (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html">Adding
3343
+ * the IAM Role to an Amazon Neptune Cluster</a>.</p>
3344
+ */
3345
+ iamRoleArn: string | undefined;
3346
+ /**
3347
+ * @public
3348
+ * <p>The load job mode.</p>
3349
+ * <p>
3350
+ * <i>Allowed values</i>: <code>RESUME</code>, <code>NEW</code>,
3351
+ * <code>AUTO</code>.</p>
3352
+ * <p>
3353
+ * <i>Default value</i>: <code>AUTO</code>.</p>
3354
+ * <p class="title">
3355
+ * <b/>
3356
+ * </p>
3357
+ * <ul>
3358
+ * <li>
3359
+ * <p>
3360
+ * <code>RESUME</code>   –   In RESUME mode,
3361
+ * the loader looks for a previous load from this source, and if it finds
3362
+ * one, resumes that load job. If no previous load job is found, the loader stops.</p>
3363
+ * <p>The loader avoids reloading files that were successfully loaded in
3364
+ * a previous job. It only tries to process failed files. If you dropped
3365
+ * previously loaded data from your Neptune cluster, that data is not
3366
+ * reloaded in this mode. If a previous load job loaded all files from the
3367
+ * same source successfully, nothing is reloaded, and the loader returns
3368
+ * success.</p>
3369
+ * </li>
3370
+ * <li>
3371
+ * <p>
3372
+ * <code>NEW</code>   –   In NEW mode, the
3373
+ * creates a new load request regardless of any previous loads. You
3374
+ * can use this mode to reload all the data from a source after dropping
3375
+ * previously loaded data from your Neptune cluster, or to load new data
3376
+ * available at the same source.</p>
3377
+ * </li>
3378
+ * <li>
3379
+ * <p>
3380
+ * <code>AUTO</code>   –   In AUTO mode,
3381
+ * the loader looks for a previous load job from the same source, and if it
3382
+ * finds one, resumes that job, just as in <code>RESUME</code> mode.</p>
3383
+ * <p>If the loader doesn't find a previous load job from the same
3384
+ * source, it loads all data from the source, just as in <code>NEW</code>
3385
+ * mode.</p>
3386
+ * </li>
3387
+ * </ul>
3388
+ */
3389
+ mode?: Mode | string;
3390
+ /**
3391
+ * @public
3392
+ * <p>
3393
+ * <b>
3394
+ * <code>failOnError</code>
3395
+ * </b>   –   A flag to toggle a
3396
+ * complete stop on an error.</p>
3397
+ * <p>
3398
+ * <i>Allowed values</i>: <code>"TRUE"</code>, <code>"FALSE"</code>.</p>
3399
+ * <p>
3400
+ * <i>Default value</i>: <code>"TRUE"</code>.</p>
3401
+ * <p>When this parameter is set to <code>"FALSE"</code>, the loader tries to load all
3402
+ * the data in the location specified, skipping any entries with errors.</p>
3403
+ * <p>When this parameter is set to <code>"TRUE"</code>, the loader stops
3404
+ * as soon as it encounters an error. Data loaded up to that point persists.</p>
3405
+ */
3406
+ failOnError?: boolean;
3407
+ /**
3408
+ * @public
3409
+ * <p>The optional <code>parallelism</code> parameter can be set
3410
+ * to reduce the number of threads used by the bulk load process.</p>
3411
+ * <p>
3412
+ * <i>Allowed values</i>:</p>
3413
+ * <ul>
3414
+ * <li>
3415
+ * <p>
3416
+ * <code>LOW</code> –   The number of threads used is the
3417
+ * number of available vCPUs divided by 8.</p>
3418
+ * </li>
3419
+ * <li>
3420
+ * <p>
3421
+ * <code>MEDIUM</code> –   The number of threads used is the
3422
+ * number of available vCPUs divided by 2.</p>
3423
+ * </li>
3424
+ * <li>
3425
+ * <p>
3426
+ * <code>HIGH</code> –   The number of threads used is the
3427
+ * same as the number of available vCPUs.</p>
3428
+ * </li>
3429
+ * <li>
3430
+ * <p>
3431
+ * <code>OVERSUBSCRIBE</code> –   The number of threads used is the
3432
+ * number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all
3433
+ * available resources.</p>
3434
+ * <p>This does not mean, however, that the <code>OVERSUBSCRIBE</code> setting
3435
+ * results in 100% CPU utilization. Because the load operation is I/O bound, the
3436
+ * highest CPU utilization to expect is in the 60% to 70% range.</p>
3437
+ * </li>
3438
+ * </ul>
3439
+ * <p>
3440
+ * <i>Default value</i>: <code>HIGH</code>
3441
+ * </p>
3442
+ * <p>The <code>parallelism</code> setting can sometimes result in a deadlock
3443
+ * between threads when loading openCypher data. When this happens, Neptune returns the
3444
+ * <code>LOAD_DATA_DEADLOCK</code> error. You can generally fix the issue by setting
3445
+ * <code>parallelism</code> to a lower setting and retrying the load command.</p>
3446
+ */
3447
+ parallelism?: Parallelism | string;
3448
+ /**
3449
+ * @public
3450
+ * <p>
3451
+ * <b>
3452
+ * <code>parserConfiguration</code>
3453
+ * </b>
3454
+ * –   An optional object with additional parser configuration values.
3455
+ * Each of the child parameters is also optional:</p>
3456
+ * <p class="title">
3457
+ * <b/>
3458
+ * </p>
3459
+ * <ul>
3460
+ * <li>
3461
+ * <p>
3462
+ * <b>
3463
+ * <code>namedGraphUri</code>
3464
+ * </b>   –
3465
+ * The default graph for all RDF formats when no graph is specified (for non-quads
3466
+ * formats and NQUAD entries with no graph).</p>
3467
+ * <p>The default is <code>https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph</code>.</p>
3468
+ * </li>
3469
+ * <li>
3470
+ * <p>
3471
+ * <b>
3472
+ * <code>baseUri</code>
3473
+ * </b>   –
3474
+ * The base URI for RDF/XML and Turtle formats.</p>
3475
+ * <p>The default is <code>https://aws.amazon.com/neptune/default</code>.</p>
3476
+ * </li>
3477
+ * <li>
3478
+ * <p>
3479
+ * <b>
3480
+ * <code>allowEmptyStrings</code>
3481
+ * </b>   –
3482
+ * Gremlin users need to be able to pass empty string values("") as node
3483
+ * and edge properties when loading CSV data. If <code>allowEmptyStrings</code>
3484
+ * is set to <code>false</code> (the default), such empty strings are treated
3485
+ * as nulls and are not loaded.</p>
3486
+ * <p>If <code>allowEmptyStrings</code> is set to <code>true</code>,
3487
+ * the loader treats empty strings as valid property values and loads
3488
+ * them accordingly.</p>
3489
+ * </li>
3490
+ * </ul>
3491
+ */
3492
+ parserConfiguration?: Record<string, string>;
3493
+ /**
3494
+ * @public
3495
+ * <p>
3496
+ * <code>updateSingleCardinalityProperties</code>
3497
+ * is an optional parameter that controls how the bulk loader treats a new
3498
+ * value for single-cardinality vertex or edge properties. This is not supported for
3499
+ * loading openCypher data.</p>
3500
+ * <p>
3501
+ * <i>Allowed values</i>: <code>"TRUE"</code>, <code>"FALSE"</code>.</p>
3502
+ * <p>
3503
+ * <i>Default value</i>: <code>"FALSE"</code>.</p>
3504
+ * <p>By default, or when <code>updateSingleCardinalityProperties</code> is explicitly
3505
+ * set to <code>"FALSE"</code>, the loader treats a new value as an error, because it
3506
+ * violates single cardinality.</p>
3507
+ * <p>When <code>updateSingleCardinalityProperties</code> is set to <code>"TRUE"</code>,
3508
+ * on the other hand, the bulk loader replaces the existing value with the new one.
3509
+ * If multiple edge or single-cardinality vertex property values are provided in the
3510
+ * source file(s) being loaded, the final value at the end of the bulk load could be
3511
+ * any one of those new values. The loader only guarantees that the existing value
3512
+ * has been replaced by one of the new ones.</p>
3513
+ */
3514
+ updateSingleCardinalityProperties?: boolean;
3515
+ /**
3516
+ * @public
3517
+ * <p>This is an optional flag parameter
3518
+ * that indicates whether the load request can be queued up or not. </p>
3519
+ * <p>You don't have to wait for one load job to complete before issuing the next one,
3520
+ * because Neptune can queue up as many as 64 jobs at a time, provided that their
3521
+ * <code>queueRequest</code> parameters are all set to <code>"TRUE"</code>.</p>
3522
+ * <p>If the <code>queueRequest</code> parameter is omitted or set to <code>"FALSE"</code>,
3523
+ * the load request will fail if another load job is already running.</p>
3524
+ * <p>
3525
+ * <i>Allowed values</i>: <code>"TRUE"</code>, <code>"FALSE"</code>.</p>
3526
+ * <p>
3527
+ * <i>Default value</i>: <code>"FALSE"</code>.</p>
3528
+ */
3529
+ queueRequest?: boolean;
3530
+ /**
3531
+ * @public
3532
+ * <p>This is an optional parameter that can make a queued load request
3533
+ * contingent on the successful completion of one or more previous jobs
3534
+ * in the queue.</p>
3535
+ * <p>Neptune can queue up as many as 64 load requests at a time, if their
3536
+ * <code>queueRequest</code> parameters are set to <code>"TRUE"</code>. The
3537
+ * <code>dependencies</code> parameter lets you make execution of such a queued request
3538
+ * dependent on the successful completion of one or more specified previous requests
3539
+ * in the queue.</p>
3540
+ * <p>For example, if load <code>Job-A</code> and <code>Job-B</code> are independent
3541
+ * of each other, but load <code>Job-C</code> needs <code>Job-A</code> and <code>Job-B</code>
3542
+ * to be finished before it begins, proceed as follows:</p>
3543
+ * <ol>
3544
+ * <li>
3545
+ * <p>Submit <code>load-job-A</code> and <code>load-job-B</code> one after
3546
+ * another in any order, and save their load-ids.</p>
3547
+ * </li>
3548
+ * <li>
3549
+ * <p>Submit <code>load-job-C</code> with the load-ids of the
3550
+ * two jobs in its <code>dependencies</code> field:</p>
3551
+ * </li>
3552
+ * </ol>
3553
+ * <p>Because of the <code>dependencies</code> parameter, the bulk loader will not start
3554
+ * <code>Job-C</code> until <code>Job-A</code> and <code>Job-B</code> have completed
3555
+ * successfully. If either one of them fails, Job-C will not be executed, and its
3556
+ * status will be set to <code>LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED</code>.</p>
3557
+ * <p>You can set up multiple levels of dependency in this way, so that the failure of one job
3558
+ * will cause all requests that are directly or indirectly dependent on it to be cancelled.</p>
3559
+ */
3560
+ dependencies?: string[];
3561
+ /**
3562
+ * @public
3563
+ * <p>This parameter is required only when loading openCypher data that contains relationship
3564
+ * IDs. It must be included and set to <code>True</code> when openCypher relationship IDs
3565
+ * are explicitly provided in the load data (recommended).</p>
3566
+ * <p>When <code>userProvidedEdgeIds</code> is absent or set to <code>True</code>,
3567
+ * an <code>:ID</code> column must be present in every relationship file in the load.</p>
3568
+ * <p>When <code>userProvidedEdgeIds</code> is present and set to <code>False</code>,
3569
+ * relationship files in the load <b>must not</b> contain an
3570
+ * <code>:ID</code> column. Instead, the Neptune loader automatically generates an
3571
+ * ID for each relationship.</p>
3572
+ * <p>It's useful to provide relationship IDs explicitly so that the loader can resume
3573
+ * loading after error in the CSV data have been fixed, without having to reload any
3574
+ * relationships that have already been loaded. If relationship IDs have not been
3575
+ * explicitly assigned, the loader cannot resume a failed load if any relationship file
3576
+ * has had to be corrected, and must instead reload all the relationships.</p>
3577
+ */
3578
+ userProvidedEdgeIds?: boolean;
3579
+ }
3580
+ /**
3581
+ * @public
3582
+ */
3583
+ export interface StartLoaderJobOutput {
3584
+ /**
3585
+ * @public
3586
+ * <p>The HTTP return code indicating the status of the load job.</p>
3587
+ */
3588
+ status: string | undefined;
3589
+ /**
3590
+ * @public
3591
+ * <p>Contains a <code>loadId</code> name-value pair that provides an identifier
3592
+ * for the load operation.</p>
3593
+ */
3594
+ payload: Record<string, string> | undefined;
3595
+ }
3596
+ /**
3597
+ * @public
3598
+ */
3599
+ export interface StartMLDataProcessingJobInput {
3600
+ /**
3601
+ * @public
3602
+ * <p>A unique identifier for the new job. The default is an autogenerated UUID.</p>
3603
+ */
3604
+ id?: string;
3605
+ /**
3606
+ * @public
3607
+ * <p>The job ID of a completed data processing job run on an earlier version of the data.</p>
3608
+ */
3609
+ previousDataProcessingJobId?: string;
3610
+ /**
3611
+ * @public
3612
+ * <p>The URI of the Amazon S3 location where you want SageMaker to download
3613
+ * the data needed to run the data processing job.</p>
3614
+ */
3615
+ inputDataS3Location: string | undefined;
3616
+ /**
3617
+ * @public
3618
+ * <p>The URI of the Amazon S3 location where you want SageMaker to save the
3619
+ * results of a data processing job.</p>
3620
+ */
3621
+ processedDataS3Location: string | undefined;
3622
+ /**
3623
+ * @public
3624
+ * <p>The ARN of an IAM role for SageMaker execution.
3625
+ * This must be listed in your DB cluster parameter group or an error will occur.</p>
3626
+ */
3627
+ sagemakerIamRoleArn?: string;
3628
+ /**
3629
+ * @public
3630
+ * <p>The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume
3631
+ * to perform tasks on your behalf. This must be listed in your DB cluster
3632
+ * parameter group or an error will occur.</p>
3633
+ */
3634
+ neptuneIamRoleArn?: string;
3635
+ /**
3636
+ * @public
3637
+ * <p>The type of ML instance used during data processing. Its memory
3638
+ * should be large enough to hold the processed dataset. The default is
3639
+ * the smallest ml.r5 type whose memory is ten times larger than the size
3640
+ * of the exported graph data on disk.</p>
3641
+ */
3642
+ processingInstanceType?: string;
3643
+ /**
3644
+ * @public
3645
+ * <p>The disk volume size of the processing instance. Both input data
3646
+ * and processed data are stored on disk, so the volume size must be large
3647
+ * enough to hold both data sets. The default is 0. If not specified or 0,
3648
+ * Neptune ML chooses the volume size automatically based on the data size.</p>
3649
+ */
3650
+ processingInstanceVolumeSizeInGB?: number;
3651
+ /**
3652
+ * @public
3653
+ * <p>Timeout in seconds for the data processing job. The default is 86,400 (1 day).</p>
3654
+ */
3655
+ processingTimeOutInSeconds?: number;
3656
+ /**
3657
+ * @public
3658
+ * <p>One of the two model types that Neptune ML currently supports:
3659
+ * heterogeneous graph models (<code>heterogeneous</code>), and knowledge
3660
+ * graph (<code>kge</code>). The default is none. If not specified,
3661
+ * Neptune ML chooses the model type automatically based on the data.</p>
3662
+ */
3663
+ modelType?: string;
3664
+ /**
3665
+ * @public
3666
+ * <p>A data specification file that describes how to load the exported
3667
+ * graph data for training. The file is automatically generated by the
3668
+ * Neptune export toolkit. The default is
3669
+ * <code>training-data-configuration.json</code>.</p>
3670
+ */
3671
+ configFileName?: string;
3672
+ /**
3673
+ * @public
3674
+ * <p>The IDs of the subnets in the Neptune VPC. The default is None.</p>
3675
+ */
3676
+ subnets?: string[];
3677
+ /**
3678
+ * @public
3679
+ * <p>The VPC security group IDs. The default is None.</p>
3680
+ */
3681
+ securityGroupIds?: string[];
3682
+ /**
3683
+ * @public
3684
+ * <p>The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to
3685
+ * encrypt data on the storage volume attached to the ML compute instances
3686
+ * that run the training job. The default is None.</p>
3687
+ */
3688
+ volumeEncryptionKMSKey?: string;
3689
+ /**
3690
+ * @public
3691
+ * <p>The Amazon Key Management Service (Amazon KMS) key that SageMaker uses
3692
+ * to encrypt the output of the processing job. The default is none.</p>
3693
+ */
3694
+ s3OutputEncryptionKMSKey?: string;
3695
+ }
3696
+ /**
3697
+ * @public
3698
+ */
3699
+ export interface StartMLDataProcessingJobOutput {
3700
+ /**
3701
+ * @public
3702
+ * <p>The unique ID of the new data processing job.</p>
3703
+ */
3704
+ id?: string;
3705
+ /**
3706
+ * @public
3707
+ * <p>The ARN of the data processing job.</p>
3708
+ */
3709
+ arn?: string;
3710
+ /**
3711
+ * @public
3712
+ * <p>The time it took to create the new processing job, in milliseconds.</p>
3713
+ */
3714
+ creationTimeInMillis?: number;
3715
+ }
3716
+ /**
3717
+ * @public
3718
+ * <p>Contains custom model training parameters. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.html">Custom
3719
+ * models in Neptune ML</a>.</p>
3720
+ */
3721
+ export interface CustomModelTrainingParameters {
3722
+ /**
3723
+ * @public
3724
+ * <p>The path to the Amazon S3 location where the Python module
3725
+ * implementing your model is located. This must point to a valid
3726
+ * existing Amazon S3 location that contains, at a minimum, a training
3727
+ * script, a transform script, and a <code>model-hpo-configuration.json</code>
3728
+ * file.</p>
3729
+ */
3730
+ sourceS3DirectoryPath: string | undefined;
3731
+ /**
3732
+ * @public
3733
+ * <p>The name of the entry point in your module of a script that performs
3734
+ * model training and takes hyperparameters as command-line arguments,
3735
+ * including fixed hyperparameters. The default is <code>training.py</code>.</p>
3736
+ */
3737
+ trainingEntryPointScript?: string;
3738
+ /**
3739
+ * @public
3740
+ * <p>The name of the entry point in your module of a script that should
3741
+ * be run after the best model from the hyperparameter search has been
3742
+ * identified, to compute the model artifacts necessary for model deployment.
3743
+ * It should be able to run with no command-line arguments.The default is
3744
+ * <code>transform.py</code>.</p>
3745
+ */
3746
+ transformEntryPointScript?: string;
3747
+ }
3748
+ /**
3749
+ * @public
3750
+ */
3751
+ export interface StartMLModelTrainingJobInput {
3752
+ /**
3753
+ * @public
3754
+ * <p>A unique identifier for the new job. The default is An autogenerated UUID.</p>
3755
+ */
3756
+ id?: string;
3757
+ /**
3758
+ * @public
3759
+ * <p>The job ID of a completed model-training job that you want to update
3760
+ * incrementally based on updated data.</p>
3761
+ */
3762
+ previousModelTrainingJobId?: string;
3763
+ /**
3764
+ * @public
3765
+ * <p>The job ID of the completed data-processing job that has created
3766
+ * the data that the training will work with.</p>
3767
+ */
3768
+ dataProcessingJobId: string | undefined;
3769
+ /**
3770
+ * @public
3771
+ * <p>The location in Amazon S3 where the model artifacts are to be stored.</p>
3772
+ */
3773
+ trainModelS3Location: string | undefined;
3774
+ /**
3775
+ * @public
3776
+ * <p>The ARN of an IAM role for SageMaker execution.This must be listed
3777
+ * in your DB cluster parameter group or an error will occur.</p>
3778
+ */
3779
+ sagemakerIamRoleArn?: string;
3780
+ /**
3781
+ * @public
3782
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
3783
+ * and Amazon S3 resources. This must be listed in your DB cluster
3784
+ * parameter group or an error will occur.</p>
3785
+ */
3786
+ neptuneIamRoleArn?: string;
3787
+ /**
3788
+ * @public
3789
+ * <p>The type of ML instance used in preparing and managing training
3790
+ * of ML models. This is a CPU instance chosen based on memory requirements
3791
+ * for processing the training data and model.</p>
3792
+ */
3793
+ baseProcessingInstanceType?: string;
3794
+ /**
3795
+ * @public
3796
+ * <p>The type of ML instance used for model training. All Neptune ML
3797
+ * models support CPU, GPU, and multiGPU training. The default is
3798
+ * <code>ml.p3.2xlarge</code>. Choosing the right instance type for
3799
+ * training depends on the task type, graph size, and your budget.</p>
3800
+ */
3801
+ trainingInstanceType?: string;
3802
+ /**
3803
+ * @public
3804
+ * <p>The disk volume size of the training instance. Both input data
3805
+ * and the output model are stored on disk, so the volume size must be
3806
+ * large enough to hold both data sets. The default is 0. If not specified
3807
+ * or 0, Neptune ML selects a disk volume size based on the recommendation
3808
+ * generated in the data processing step.</p>
3809
+ */
3810
+ trainingInstanceVolumeSizeInGB?: number;
3811
+ /**
3812
+ * @public
3813
+ * <p>Timeout in seconds for the training job. The default is 86,400 (1 day).</p>
3814
+ */
3815
+ trainingTimeOutInSeconds?: number;
3816
+ /**
3817
+ * @public
3818
+ * <p>Maximum total number of training jobs to start for the hyperparameter
3819
+ * tuning job. The default is 2. Neptune ML automatically tunes the hyperparameters
3820
+ * of the machine learning model. To obtain a model that performs well, use at
3821
+ * least 10 jobs (in other words, set <code>maxHPONumberOfTrainingJobs</code> to 10).
3822
+ * In general, the more tuning runs, the better the results.</p>
3823
+ */
3824
+ maxHPONumberOfTrainingJobs?: number;
3825
+ /**
3826
+ * @public
3827
+ * <p>Maximum number of parallel training jobs to start for the hyperparameter
3828
+ * tuning job. The default is 2. The number of parallel jobs you can run is
3829
+ * limited by the available resources on your training instance.</p>
3830
+ */
3831
+ maxHPOParallelTrainingJobs?: number;
3832
+ /**
3833
+ * @public
3834
+ * <p>The IDs of the subnets in the Neptune VPC. The default is None.</p>
3835
+ */
3836
+ subnets?: string[];
3837
+ /**
3838
+ * @public
3839
+ * <p>The VPC security group IDs. The default is None.</p>
3840
+ */
3841
+ securityGroupIds?: string[];
3842
+ /**
3843
+ * @public
3844
+ * <p>The Amazon Key Management Service (KMS) key that SageMaker uses to
3845
+ * encrypt data on the storage volume attached to the ML compute instances
3846
+ * that run the training job. The default is None.</p>
3847
+ */
3848
+ volumeEncryptionKMSKey?: string;
3849
+ /**
3850
+ * @public
3851
+ * <p>The Amazon Key Management Service (KMS) key that SageMaker uses
3852
+ * to encrypt the output of the processing job. The default is none.</p>
3853
+ */
3854
+ s3OutputEncryptionKMSKey?: string;
3855
+ /**
3856
+ * @public
3857
+ * <p>Optimizes the cost of training machine-learning models by using
3858
+ * Amazon Elastic Compute Cloud spot instances. The default is <code>False</code>.</p>
3859
+ */
3860
+ enableManagedSpotTraining?: boolean;
3861
+ /**
3862
+ * @public
3863
+ * <p>The configuration for custom model training. This is a JSON object.</p>
3864
+ */
3865
+ customModelTrainingParameters?: CustomModelTrainingParameters;
3866
+ }
3867
+ /**
3868
+ * @public
3869
+ */
3870
+ export interface StartMLModelTrainingJobOutput {
3871
+ /**
3872
+ * @public
3873
+ * <p>The unique ID of the new model training job.</p>
3874
+ */
3875
+ id?: string;
3876
+ /**
3877
+ * @public
3878
+ * <p>The ARN of the new model training job.</p>
3879
+ */
3880
+ arn?: string;
3881
+ /**
3882
+ * @public
3883
+ * <p>The model training job creation time, in milliseconds.</p>
3884
+ */
3885
+ creationTimeInMillis?: number;
3886
+ }
3887
+ /**
3888
+ * @public
3889
+ * <p>Contains custom model transform parameters. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use
3890
+ * a trained model to generate new model artifacts</a>.</p>
3891
+ */
3892
+ export interface CustomModelTransformParameters {
3893
+ /**
3894
+ * @public
3895
+ * <p>The path to the Amazon S3 location where the Python module
3896
+ * implementing your model is located. This must point to a valid
3897
+ * existing Amazon S3 location that contains, at a minimum, a training
3898
+ * script, a transform script, and a <code>model-hpo-configuration.json</code>
3899
+ * file.</p>
3900
+ */
3901
+ sourceS3DirectoryPath: string | undefined;
3902
+ /**
3903
+ * @public
3904
+ * <p>The name of the entry point in your module of a script that should
3905
+ * be run after the best model from the hyperparameter search has been
3906
+ * identified, to compute the model artifacts necessary for model deployment.
3907
+ * It should be able to run with no command-line arguments. The default
3908
+ * is <code>transform.py</code>.</p>
3909
+ */
3910
+ transformEntryPointScript?: string;
3911
+ }
3912
+ /**
3913
+ * @public
3914
+ */
3915
+ export interface StartMLModelTransformJobInput {
3916
+ /**
3917
+ * @public
3918
+ * <p>A unique identifier for the new job. The default is an autogenerated UUID.</p>
3919
+ */
3920
+ id?: string;
3921
+ /**
3922
+ * @public
3923
+ * <p>The job ID of a completed data-processing job. You must include either
3924
+ * <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>,
3925
+ * or a <code>trainingJobName</code>.</p>
3926
+ */
3927
+ dataProcessingJobId?: string;
3928
+ /**
3929
+ * @public
3930
+ * <p>The job ID of a completed model-training job. You must include either
3931
+ * <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>,
3932
+ * or a <code>trainingJobName</code>.</p>
3933
+ */
3934
+ mlModelTrainingJobId?: string;
3935
+ /**
3936
+ * @public
3937
+ * <p>The name of a completed SageMaker training job. You must include either
3938
+ * <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>,
3939
+ * or a <code>trainingJobName</code>.</p>
3940
+ */
3941
+ trainingJobName?: string;
3942
+ /**
3943
+ * @public
3944
+ * <p>The location in Amazon S3 where the model artifacts are to be stored.</p>
3945
+ */
3946
+ modelTransformOutputS3Location: string | undefined;
3947
+ /**
3948
+ * @public
3949
+ * <p>The ARN of an IAM role for SageMaker execution. This must be listed
3950
+ * in your DB cluster parameter group or an error will occur.</p>
3951
+ */
3952
+ sagemakerIamRoleArn?: string;
3953
+ /**
3954
+ * @public
3955
+ * <p>The ARN of an IAM role that provides Neptune access to SageMaker
3956
+ * and Amazon S3 resources. This must be listed in your DB cluster
3957
+ * parameter group or an error will occur.</p>
3958
+ */
3959
+ neptuneIamRoleArn?: string;
3960
+ /**
3961
+ * @public
3962
+ * <p>Configuration information for a model transform using a custom model.
3963
+ * The <code>customModelTransformParameters</code> object contains the following
3964
+ * fields, which must have values compatible with the saved model parameters from
3965
+ * the training job:</p>
3966
+ */
3967
+ customModelTransformParameters?: CustomModelTransformParameters;
3968
+ /**
3969
+ * @public
3970
+ * <p>The type of ML instance used in preparing and managing training of ML models.
3971
+ * This is an ML compute instance chosen based on memory requirements for processing
3972
+ * the training data and model.</p>
3973
+ */
3974
+ baseProcessingInstanceType?: string;
3975
+ /**
3976
+ * @public
3977
+ * <p>The disk volume size of the training instance in gigabytes. The default is 0.
3978
+ * Both input data and the output model are stored on disk, so the volume size must
3979
+ * be large enough to hold both data sets. If not specified or 0, Neptune ML selects
3980
+ * a disk volume size based on the recommendation generated in the data processing step.</p>
3981
+ */
3982
+ baseProcessingInstanceVolumeSizeInGB?: number;
3983
+ /**
3984
+ * @public
3985
+ * <p>The IDs of the subnets in the Neptune VPC. The default is None.</p>
3986
+ */
3987
+ subnets?: string[];
3988
+ /**
3989
+ * @public
3990
+ * <p>The VPC security group IDs. The default is None.</p>
3991
+ */
3992
+ securityGroupIds?: string[];
3993
+ /**
3994
+ * @public
3995
+ * <p>The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data
3996
+ * on the storage volume attached to the ML compute instances that run the training job.
3997
+ * The default is None.</p>
3998
+ */
3999
+ volumeEncryptionKMSKey?: string;
4000
+ /**
4001
+ * @public
4002
+ * <p>The Amazon Key Management Service (KMS) key that SageMaker uses to
4003
+ * encrypt the output of the processing job. The default is none.</p>
4004
+ */
4005
+ s3OutputEncryptionKMSKey?: string;
4006
+ }
4007
+ /**
4008
+ * @public
4009
+ */
4010
+ export interface StartMLModelTransformJobOutput {
4011
+ /**
4012
+ * @public
4013
+ * <p>The unique ID of the new model transform job.</p>
4014
+ */
4015
+ id?: string;
4016
+ /**
4017
+ * @public
4018
+ * <p>The ARN of the model transform job.</p>
4019
+ */
4020
+ arn?: string;
4021
+ /**
4022
+ * @public
4023
+ * <p>The creation time of the model transform job, in milliseconds.</p>
4024
+ */
4025
+ creationTimeInMillis?: number;
4026
+ }