@aws-sdk/client-neptune-graph 3.533.0 → 3.540.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/NeptuneGraph.d.ts +4 -1
- package/dist-types/NeptuneGraphClient.d.ts +1 -1
- package/dist-types/commands/CancelImportTaskCommand.d.ts +2 -1
- package/dist-types/commands/CancelQueryCommand.d.ts +2 -1
- package/dist-types/commands/CreateGraphCommand.d.ts +2 -1
- package/dist-types/commands/CreateGraphSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/CreateGraphUsingImportTaskCommand.d.ts +2 -1
- package/dist-types/commands/CreatePrivateGraphEndpointCommand.d.ts +2 -1
- package/dist-types/commands/DeleteGraphCommand.d.ts +2 -1
- package/dist-types/commands/DeleteGraphSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/DeletePrivateGraphEndpointCommand.d.ts +2 -1
- package/dist-types/commands/ExecuteQueryCommand.d.ts +2 -1
- package/dist-types/commands/GetGraphCommand.d.ts +2 -1
- package/dist-types/commands/GetGraphSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/GetGraphSummaryCommand.d.ts +2 -1
- package/dist-types/commands/GetImportTaskCommand.d.ts +2 -1
- package/dist-types/commands/GetPrivateGraphEndpointCommand.d.ts +2 -1
- package/dist-types/commands/GetQueryCommand.d.ts +2 -1
- package/dist-types/commands/ListGraphSnapshotsCommand.d.ts +2 -1
- package/dist-types/commands/ListGraphsCommand.d.ts +2 -1
- package/dist-types/commands/ListImportTasksCommand.d.ts +2 -1
- package/dist-types/commands/ListPrivateGraphEndpointsCommand.d.ts +2 -1
- package/dist-types/commands/ListQueriesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ResetGraphCommand.d.ts +2 -1
- package/dist-types/commands/RestoreGraphFromSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateGraphCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +341 -341
- package/dist-types/ts3.4/NeptuneGraph.d.ts +3 -0
- package/dist-types/ts3.4/commands/CancelImportTaskCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CancelQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateGraphCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateGraphSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateGraphUsingImportTaskCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePrivateGraphEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteGraphCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteGraphSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePrivateGraphEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ExecuteQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetGraphCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetGraphSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetGraphSummaryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetImportTaskCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetPrivateGraphEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListGraphSnapshotsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListGraphsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListImportTasksCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPrivateGraphEndpointsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListQueriesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ResetGraphCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreGraphFromSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateGraphCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +42 -42
|
@@ -2,8 +2,8 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { DocumentType as __DocumentType, StreamingBlobTypes } from "@smithy/types";
|
|
3
3
|
import { NeptuneGraphServiceException as __BaseException } from "./NeptuneGraphServiceException";
|
|
4
4
|
/**
|
|
5
|
-
* @public
|
|
6
5
|
* <p>Raised in case of an authentication or authorization failure.</p>
|
|
6
|
+
* @public
|
|
7
7
|
*/
|
|
8
8
|
export declare class AccessDeniedException extends __BaseException {
|
|
9
9
|
readonly name: "AccessDeniedException";
|
|
@@ -18,19 +18,19 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
18
18
|
*/
|
|
19
19
|
export interface CancelQueryInput {
|
|
20
20
|
/**
|
|
21
|
-
* @public
|
|
22
21
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
22
|
+
* @public
|
|
23
23
|
*/
|
|
24
24
|
graphIdentifier: string | undefined;
|
|
25
25
|
/**
|
|
26
|
-
* @public
|
|
27
26
|
* <p>The unique identifier of the query to cancel.</p>
|
|
27
|
+
* @public
|
|
28
28
|
*/
|
|
29
29
|
queryId: string | undefined;
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
-
* @public
|
|
33
32
|
* <p>A failure occurred on the server.</p>
|
|
33
|
+
* @public
|
|
34
34
|
*/
|
|
35
35
|
export declare class InternalServerException extends __BaseException {
|
|
36
36
|
readonly name: "InternalServerException";
|
|
@@ -42,8 +42,8 @@ export declare class InternalServerException extends __BaseException {
|
|
|
42
42
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p>A specified resource could not be located.</p>
|
|
46
|
+
* @public
|
|
47
47
|
*/
|
|
48
48
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
49
49
|
readonly name: "ResourceNotFoundException";
|
|
@@ -54,8 +54,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
54
54
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p>The exception was interrupted by throttling.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
export declare class ThrottlingException extends __BaseException {
|
|
61
61
|
readonly name: "ThrottlingException";
|
|
@@ -86,15 +86,15 @@ export declare const ValidationExceptionReason: {
|
|
|
86
86
|
*/
|
|
87
87
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
88
88
|
/**
|
|
89
|
-
* @public
|
|
90
89
|
* <p>A resource could not be validated.</p>
|
|
90
|
+
* @public
|
|
91
91
|
*/
|
|
92
92
|
export declare class ValidationException extends __BaseException {
|
|
93
93
|
readonly name: "ValidationException";
|
|
94
94
|
readonly $fault: "client";
|
|
95
95
|
/**
|
|
96
|
-
* @public
|
|
97
96
|
* <p>The reason that the resource could not be validated.</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
reason?: ValidationExceptionReason;
|
|
100
100
|
/**
|
|
@@ -114,15 +114,15 @@ export declare const ConflictExceptionReason: {
|
|
|
114
114
|
*/
|
|
115
115
|
export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
|
|
116
116
|
/**
|
|
117
|
-
* @public
|
|
118
117
|
* <p>Raised when a conflict is encountered.</p>
|
|
118
|
+
* @public
|
|
119
119
|
*/
|
|
120
120
|
export declare class ConflictException extends __BaseException {
|
|
121
121
|
readonly name: "ConflictException";
|
|
122
122
|
readonly $fault: "client";
|
|
123
123
|
/**
|
|
124
|
-
* @public
|
|
125
124
|
* <p>The reason for the conflict exception.</p>
|
|
125
|
+
* @public
|
|
126
126
|
*/
|
|
127
127
|
reason?: ConflictExceptionReason;
|
|
128
128
|
/**
|
|
@@ -171,42 +171,42 @@ export type PlanCacheType = (typeof PlanCacheType)[keyof typeof PlanCacheType];
|
|
|
171
171
|
*/
|
|
172
172
|
export interface ExecuteQueryInput {
|
|
173
173
|
/**
|
|
174
|
-
* @public
|
|
175
174
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
175
|
+
* @public
|
|
176
176
|
*/
|
|
177
177
|
graphIdentifier: string | undefined;
|
|
178
178
|
/**
|
|
179
|
-
* @public
|
|
180
179
|
* <p>The query string to be executed.</p>
|
|
180
|
+
* @public
|
|
181
181
|
*/
|
|
182
182
|
queryString: string | undefined;
|
|
183
183
|
/**
|
|
184
|
-
* @public
|
|
185
184
|
* <p>The query language the query is written in. Currently only openCypher is supported.</p>
|
|
185
|
+
* @public
|
|
186
186
|
*/
|
|
187
187
|
language: QueryLanguage | undefined;
|
|
188
188
|
/**
|
|
189
|
-
* @public
|
|
190
189
|
* <p>The data parameters the query can use in JSON format. For example: \{"name": "john", "age": 20\}. (optional) </p>
|
|
190
|
+
* @public
|
|
191
191
|
*/
|
|
192
192
|
parameters?: Record<string, __DocumentType>;
|
|
193
193
|
/**
|
|
194
|
-
* @public
|
|
195
194
|
* <p>Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query.
|
|
196
195
|
* This reduces query latency, and works for both <code>READ</code> and <code>UPDATE</code> queries. The plan cache is an
|
|
197
196
|
* LRU cache with a 5 minute TTL and a capacity of 1000.</p>
|
|
197
|
+
* @public
|
|
198
198
|
*/
|
|
199
199
|
planCache?: PlanCacheType;
|
|
200
200
|
/**
|
|
201
|
-
* @public
|
|
202
201
|
* <p>The explain mode parameter returns a query explain instead of the actual query results. A query explain can
|
|
203
202
|
* be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions
|
|
204
203
|
* flowing etc.</p>
|
|
204
|
+
* @public
|
|
205
205
|
*/
|
|
206
206
|
explainMode?: ExplainMode;
|
|
207
207
|
/**
|
|
208
|
-
* @public
|
|
209
208
|
* <p>Specifies the query timeout duration, in milliseconds. (optional)</p>
|
|
209
|
+
* @public
|
|
210
210
|
*/
|
|
211
211
|
queryTimeoutMilliseconds?: number;
|
|
212
212
|
}
|
|
@@ -215,8 +215,8 @@ export interface ExecuteQueryInput {
|
|
|
215
215
|
*/
|
|
216
216
|
export interface ExecuteQueryOutput {
|
|
217
217
|
/**
|
|
218
|
-
* @public
|
|
219
218
|
* <p>The query results.</p>
|
|
219
|
+
* @public
|
|
220
220
|
*/
|
|
221
221
|
payload: StreamingBlobTypes | undefined;
|
|
222
222
|
}
|
|
@@ -236,15 +236,15 @@ export declare const UnprocessableExceptionReason: {
|
|
|
236
236
|
*/
|
|
237
237
|
export type UnprocessableExceptionReason = (typeof UnprocessableExceptionReason)[keyof typeof UnprocessableExceptionReason];
|
|
238
238
|
/**
|
|
239
|
-
* @public
|
|
240
239
|
* <p>Request cannot be processed due to known reasons. Eg. partition full.</p>
|
|
240
|
+
* @public
|
|
241
241
|
*/
|
|
242
242
|
export declare class UnprocessableException extends __BaseException {
|
|
243
243
|
readonly name: "UnprocessableException";
|
|
244
244
|
readonly $fault: "client";
|
|
245
245
|
/**
|
|
246
|
-
* @public
|
|
247
246
|
* <p>The reason for the unprocessable exception.</p>
|
|
247
|
+
* @public
|
|
248
248
|
*/
|
|
249
249
|
reason: UnprocessableExceptionReason | undefined;
|
|
250
250
|
/**
|
|
@@ -269,128 +269,128 @@ export type GraphSummaryMode = (typeof GraphSummaryMode)[keyof typeof GraphSumma
|
|
|
269
269
|
*/
|
|
270
270
|
export interface GetGraphSummaryInput {
|
|
271
271
|
/**
|
|
272
|
-
* @public
|
|
273
272
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
273
|
+
* @public
|
|
274
274
|
*/
|
|
275
275
|
graphIdentifier: string | undefined;
|
|
276
276
|
/**
|
|
277
|
-
* @public
|
|
278
277
|
* <p>The summary mode can take one of two values: <code>basic</code> (the default), and
|
|
279
278
|
* <code>detailed</code>.</p>
|
|
279
|
+
* @public
|
|
280
280
|
*/
|
|
281
281
|
mode?: GraphSummaryMode;
|
|
282
282
|
}
|
|
283
283
|
/**
|
|
284
|
-
* @public
|
|
285
284
|
* <p>Contains information about an edge in a Neptune Analytics graph.</p>
|
|
285
|
+
* @public
|
|
286
286
|
*/
|
|
287
287
|
export interface EdgeStructure {
|
|
288
288
|
/**
|
|
289
|
-
* @public
|
|
290
289
|
* <p>The number of instances of the edge in the graph.</p>
|
|
290
|
+
* @public
|
|
291
291
|
*/
|
|
292
292
|
count?: number;
|
|
293
293
|
/**
|
|
294
|
-
* @public
|
|
295
294
|
* <p>A list of the properties associated with the edge.</p>
|
|
295
|
+
* @public
|
|
296
296
|
*/
|
|
297
297
|
edgeProperties?: string[];
|
|
298
298
|
}
|
|
299
299
|
/**
|
|
300
|
-
* @public
|
|
301
300
|
* <p>Information about a node.</p>
|
|
301
|
+
* @public
|
|
302
302
|
*/
|
|
303
303
|
export interface NodeStructure {
|
|
304
304
|
/**
|
|
305
|
-
* @public
|
|
306
305
|
* <p>The number of instances of this node.</p>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
count?: number;
|
|
309
309
|
/**
|
|
310
|
-
* @public
|
|
311
310
|
* <p>Properties associated with this node.</p>
|
|
311
|
+
* @public
|
|
312
312
|
*/
|
|
313
313
|
nodeProperties?: string[];
|
|
314
314
|
/**
|
|
315
|
-
* @public
|
|
316
315
|
* <p>The outgoing edge labels associated with this node.</p>
|
|
316
|
+
* @public
|
|
317
317
|
*/
|
|
318
318
|
distinctOutgoingEdgeLabels?: string[];
|
|
319
319
|
}
|
|
320
320
|
/**
|
|
321
|
-
* @public
|
|
322
321
|
* <p>Summary information about the graph.</p>
|
|
322
|
+
* @public
|
|
323
323
|
*/
|
|
324
324
|
export interface GraphDataSummary {
|
|
325
325
|
/**
|
|
326
|
-
* @public
|
|
327
326
|
* <p>The number of nodes in the graph.</p>
|
|
327
|
+
* @public
|
|
328
328
|
*/
|
|
329
329
|
numNodes?: number;
|
|
330
330
|
/**
|
|
331
|
-
* @public
|
|
332
331
|
* <p>The number of edges in the graph.</p>
|
|
332
|
+
* @public
|
|
333
333
|
*/
|
|
334
334
|
numEdges?: number;
|
|
335
335
|
/**
|
|
336
|
-
* @public
|
|
337
336
|
* <p>The number of distinct node labels in the graph.</p>
|
|
337
|
+
* @public
|
|
338
338
|
*/
|
|
339
339
|
numNodeLabels?: number;
|
|
340
340
|
/**
|
|
341
|
-
* @public
|
|
342
341
|
* <p>The number of unique edge labels in the graph.</p>
|
|
342
|
+
* @public
|
|
343
343
|
*/
|
|
344
344
|
numEdgeLabels?: number;
|
|
345
345
|
/**
|
|
346
|
-
* @public
|
|
347
346
|
* <p>A list of distinct node labels in the graph.</p>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
nodeLabels?: string[];
|
|
350
350
|
/**
|
|
351
|
-
* @public
|
|
352
351
|
* <p>A list of the edge labels in the graph.</p>
|
|
352
|
+
* @public
|
|
353
353
|
*/
|
|
354
354
|
edgeLabels?: string[];
|
|
355
355
|
/**
|
|
356
|
-
* @public
|
|
357
356
|
* <p>The number of distinct node properties in the graph.</p>
|
|
357
|
+
* @public
|
|
358
358
|
*/
|
|
359
359
|
numNodeProperties?: number;
|
|
360
360
|
/**
|
|
361
|
-
* @public
|
|
362
361
|
* <p>The number of edge properties in the graph.</p>
|
|
362
|
+
* @public
|
|
363
363
|
*/
|
|
364
364
|
numEdgeProperties?: number;
|
|
365
365
|
/**
|
|
366
|
-
* @public
|
|
367
366
|
* <p>A list of the distinct node properties in the graph, along with the count of nodes where each property is used.</p>
|
|
367
|
+
* @public
|
|
368
368
|
*/
|
|
369
369
|
nodeProperties?: Record<string, number>[];
|
|
370
370
|
/**
|
|
371
|
-
* @public
|
|
372
371
|
* <p>A list of the distinct edge properties in the graph, along with the count of edges
|
|
373
372
|
* where each property is used.</p>
|
|
373
|
+
* @public
|
|
374
374
|
*/
|
|
375
375
|
edgeProperties?: Record<string, number>[];
|
|
376
376
|
/**
|
|
377
|
-
* @public
|
|
378
377
|
* <p>The total number of usages of all node properties.</p>
|
|
378
|
+
* @public
|
|
379
379
|
*/
|
|
380
380
|
totalNodePropertyValues?: number;
|
|
381
381
|
/**
|
|
382
|
-
* @public
|
|
383
382
|
* <p>The total number of usages of all edge properties.</p>
|
|
383
|
+
* @public
|
|
384
384
|
*/
|
|
385
385
|
totalEdgePropertyValues?: number;
|
|
386
386
|
/**
|
|
387
|
-
* @public
|
|
388
387
|
* <p>This field is only present when the requested mode is DETAILED. It contains a list of node structures.</p>
|
|
388
|
+
* @public
|
|
389
389
|
*/
|
|
390
390
|
nodeStructures?: NodeStructure[];
|
|
391
391
|
/**
|
|
392
|
-
* @public
|
|
393
392
|
* <p>This field is only present when the requested mode is DETAILED. It contains a list of edge structures.</p>
|
|
393
|
+
* @public
|
|
394
394
|
*/
|
|
395
395
|
edgeStructures?: EdgeStructure[];
|
|
396
396
|
}
|
|
@@ -399,18 +399,18 @@ export interface GraphDataSummary {
|
|
|
399
399
|
*/
|
|
400
400
|
export interface GetGraphSummaryOutput {
|
|
401
401
|
/**
|
|
402
|
-
* @public
|
|
403
402
|
* <p>Display the version of this tool.</p>
|
|
403
|
+
* @public
|
|
404
404
|
*/
|
|
405
405
|
version?: string;
|
|
406
406
|
/**
|
|
407
|
-
* @public
|
|
408
407
|
* <p>The timestamp, in ISO 8601 format, of the time at which Neptune Analytics last computed statistics.</p>
|
|
408
|
+
* @public
|
|
409
409
|
*/
|
|
410
410
|
lastStatisticsComputationTime?: Date;
|
|
411
411
|
/**
|
|
412
|
-
* @public
|
|
413
412
|
* <p>The graph summary.</p>
|
|
413
|
+
* @public
|
|
414
414
|
*/
|
|
415
415
|
graphSummary?: GraphDataSummary;
|
|
416
416
|
}
|
|
@@ -419,13 +419,13 @@ export interface GetGraphSummaryOutput {
|
|
|
419
419
|
*/
|
|
420
420
|
export interface GetQueryInput {
|
|
421
421
|
/**
|
|
422
|
-
* @public
|
|
423
422
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
423
|
+
* @public
|
|
424
424
|
*/
|
|
425
425
|
graphIdentifier: string | undefined;
|
|
426
426
|
/**
|
|
427
|
-
* @public
|
|
428
427
|
* <p>The ID of the query in question.</p>
|
|
428
|
+
* @public
|
|
429
429
|
*/
|
|
430
430
|
queryId: string | undefined;
|
|
431
431
|
}
|
|
@@ -447,39 +447,39 @@ export type QueryState = (typeof QueryState)[keyof typeof QueryState];
|
|
|
447
447
|
*/
|
|
448
448
|
export interface GetQueryOutput {
|
|
449
449
|
/**
|
|
450
|
-
* @public
|
|
451
450
|
* <p>The ID of the query in question.</p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
id?: string;
|
|
454
454
|
/**
|
|
455
|
-
* @public
|
|
456
455
|
* <p>The query in question.</p>
|
|
456
|
+
* @public
|
|
457
457
|
*/
|
|
458
458
|
queryString?: string;
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>Indicates how long the query waited, in milliseconds.</p>
|
|
461
|
+
* @public
|
|
462
462
|
*/
|
|
463
463
|
waited?: number;
|
|
464
464
|
/**
|
|
465
|
-
* @public
|
|
466
465
|
* <p>The number of milliseconds the query has been running.</p>
|
|
466
|
+
* @public
|
|
467
467
|
*/
|
|
468
468
|
elapsed?: number;
|
|
469
469
|
/**
|
|
470
|
-
* @public
|
|
471
470
|
* <p>State of the query.</p>
|
|
471
|
+
* @public
|
|
472
472
|
*/
|
|
473
473
|
state?: QueryState;
|
|
474
474
|
}
|
|
475
475
|
/**
|
|
476
|
-
* @public
|
|
477
476
|
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
477
|
+
* @public
|
|
478
478
|
*/
|
|
479
479
|
export interface VectorSearchConfiguration {
|
|
480
480
|
/**
|
|
481
|
-
* @public
|
|
482
481
|
* <p>The number of dimensions.</p>
|
|
482
|
+
* @public
|
|
483
483
|
*/
|
|
484
484
|
dimension: number | undefined;
|
|
485
485
|
}
|
|
@@ -488,50 +488,50 @@ export interface VectorSearchConfiguration {
|
|
|
488
488
|
*/
|
|
489
489
|
export interface CreateGraphInput {
|
|
490
490
|
/**
|
|
491
|
-
* @public
|
|
492
491
|
* <p>A name for the new Neptune Analytics graph to be created.</p>
|
|
493
492
|
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
494
493
|
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
495
494
|
* consecutive hyphens. </p>
|
|
495
|
+
* @public
|
|
496
496
|
*/
|
|
497
497
|
graphName: string | undefined;
|
|
498
498
|
/**
|
|
499
|
-
* @public
|
|
500
499
|
* <p>Adds metadata tags to the new graph.
|
|
501
500
|
* These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
501
|
+
* @public
|
|
502
502
|
*/
|
|
503
503
|
tags?: Record<string, string>;
|
|
504
504
|
/**
|
|
505
|
-
* @public
|
|
506
505
|
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
|
|
507
506
|
* (<code>true</code> to enable, or <code>false</code> to disable.</p>
|
|
507
|
+
* @public
|
|
508
508
|
*/
|
|
509
509
|
publicConnectivity?: boolean;
|
|
510
510
|
/**
|
|
511
|
-
* @public
|
|
512
511
|
* <p>Specifies a KMS key to use to encrypt data in the new graph.</p>
|
|
512
|
+
* @public
|
|
513
513
|
*/
|
|
514
514
|
kmsKeyIdentifier?: string;
|
|
515
515
|
/**
|
|
516
|
-
* @public
|
|
517
516
|
* <p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph.
|
|
518
517
|
* The value is specified as <code>dimension=</code>value. Max = 65,535</p>
|
|
518
|
+
* @public
|
|
519
519
|
*/
|
|
520
520
|
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
521
521
|
/**
|
|
522
|
-
* @public
|
|
523
522
|
* <p>The number of replicas in other AZs. Min =0, Max = 2, Default = 1.</p>
|
|
523
|
+
* @public
|
|
524
524
|
*/
|
|
525
525
|
replicaCount?: number;
|
|
526
526
|
/**
|
|
527
|
-
* @public
|
|
528
527
|
* <p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled.
|
|
529
528
|
* (<code>true</code> or <code>false</code>).</p>
|
|
529
|
+
* @public
|
|
530
530
|
*/
|
|
531
531
|
deletionProtection?: boolean;
|
|
532
532
|
/**
|
|
533
|
-
* @public
|
|
534
533
|
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
|
|
534
|
+
* @public
|
|
535
535
|
*/
|
|
536
536
|
provisionedMemory: number | undefined;
|
|
537
537
|
}
|
|
@@ -557,111 +557,111 @@ export type GraphStatus = (typeof GraphStatus)[keyof typeof GraphStatus];
|
|
|
557
557
|
*/
|
|
558
558
|
export interface CreateGraphOutput {
|
|
559
559
|
/**
|
|
560
|
-
* @public
|
|
561
560
|
* <p>The ID of the graph.</p>
|
|
561
|
+
* @public
|
|
562
562
|
*/
|
|
563
563
|
id: string | undefined;
|
|
564
564
|
/**
|
|
565
|
-
* @public
|
|
566
565
|
* <p>The graph name. For example: <code>my-graph-1</code>.</p>
|
|
567
566
|
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
568
567
|
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
569
568
|
* consecutive hyphens. </p>
|
|
569
|
+
* @public
|
|
570
570
|
*/
|
|
571
571
|
name: string | undefined;
|
|
572
572
|
/**
|
|
573
|
-
* @public
|
|
574
573
|
* <p>The ARN of the graph.</p>
|
|
574
|
+
* @public
|
|
575
575
|
*/
|
|
576
576
|
arn: string | undefined;
|
|
577
577
|
/**
|
|
578
|
-
* @public
|
|
579
578
|
* <p>The current status of the graph.</p>
|
|
579
|
+
* @public
|
|
580
580
|
*/
|
|
581
581
|
status?: GraphStatus;
|
|
582
582
|
/**
|
|
583
|
-
* @public
|
|
584
583
|
* <p>The reason the status was given.</p>
|
|
584
|
+
* @public
|
|
585
585
|
*/
|
|
586
586
|
statusReason?: string;
|
|
587
587
|
/**
|
|
588
|
-
* @public
|
|
589
588
|
* <p>The time when the graph was created.</p>
|
|
589
|
+
* @public
|
|
590
590
|
*/
|
|
591
591
|
createTime?: Date;
|
|
592
592
|
/**
|
|
593
|
-
* @public
|
|
594
593
|
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
|
|
594
|
+
* @public
|
|
595
595
|
*/
|
|
596
596
|
provisionedMemory?: number;
|
|
597
597
|
/**
|
|
598
|
-
* @public
|
|
599
598
|
* <p>The graph endpoint.</p>
|
|
599
|
+
* @public
|
|
600
600
|
*/
|
|
601
601
|
endpoint?: string;
|
|
602
602
|
/**
|
|
603
|
-
* @public
|
|
604
603
|
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.</p>
|
|
604
|
+
* @public
|
|
605
605
|
*/
|
|
606
606
|
publicConnectivity?: boolean;
|
|
607
607
|
/**
|
|
608
|
-
* @public
|
|
609
608
|
* <p>The vector-search configuration for the graph, which specifies the vector dimension
|
|
610
609
|
* to use in the vector index, if any.</p>
|
|
610
|
+
* @public
|
|
611
611
|
*/
|
|
612
612
|
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
613
613
|
/**
|
|
614
|
-
* @public
|
|
615
614
|
* <p>The number of replicas in other AZs.</p>
|
|
615
|
+
* @public
|
|
616
616
|
*/
|
|
617
617
|
replicaCount?: number;
|
|
618
618
|
/**
|
|
619
|
-
* @public
|
|
620
619
|
* <p>Specifies the KMS key used to encrypt data in the new graph.</p>
|
|
620
|
+
* @public
|
|
621
621
|
*/
|
|
622
622
|
kmsKeyIdentifier?: string;
|
|
623
623
|
/**
|
|
624
|
-
* @public
|
|
625
624
|
* <p>The ID of the source graph.</p>
|
|
625
|
+
* @public
|
|
626
626
|
*/
|
|
627
627
|
sourceSnapshotId?: string;
|
|
628
628
|
/**
|
|
629
|
-
* @public
|
|
630
629
|
* <p>A value that indicates whether the graph has deletion protection enabled.
|
|
631
630
|
* The graph can't be deleted when deletion protection is enabled.</p>
|
|
631
|
+
* @public
|
|
632
632
|
*/
|
|
633
633
|
deletionProtection?: boolean;
|
|
634
634
|
/**
|
|
635
|
-
* @public
|
|
636
635
|
* <p>The build number of the graph software.</p>
|
|
636
|
+
* @public
|
|
637
637
|
*/
|
|
638
638
|
buildNumber?: string;
|
|
639
639
|
}
|
|
640
640
|
/**
|
|
641
|
-
* @public
|
|
642
641
|
* <p>A service quota was exceeded.</p>
|
|
642
|
+
* @public
|
|
643
643
|
*/
|
|
644
644
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
645
645
|
readonly name: "ServiceQuotaExceededException";
|
|
646
646
|
readonly $fault: "client";
|
|
647
647
|
/**
|
|
648
|
-
* @public
|
|
649
648
|
* <p>The identifier of the resource that exceeded quota.</p>
|
|
649
|
+
* @public
|
|
650
650
|
*/
|
|
651
651
|
resourceId?: string;
|
|
652
652
|
/**
|
|
653
|
-
* @public
|
|
654
653
|
* <p>The type of the resource that exceeded quota. Ex: Graph, Snapshot</p>
|
|
654
|
+
* @public
|
|
655
655
|
*/
|
|
656
656
|
resourceType?: string;
|
|
657
657
|
/**
|
|
658
|
-
* @public
|
|
659
658
|
* <p>The service code that exceeded quota.</p>
|
|
659
|
+
* @public
|
|
660
660
|
*/
|
|
661
661
|
serviceCode?: string;
|
|
662
662
|
/**
|
|
663
|
-
* @public
|
|
664
663
|
* <p>Service quota code of the resource for which quota was exceeded.</p>
|
|
664
|
+
* @public
|
|
665
665
|
*/
|
|
666
666
|
quotaCode?: string;
|
|
667
667
|
/**
|
|
@@ -674,15 +674,15 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
674
674
|
*/
|
|
675
675
|
export interface DeleteGraphInput {
|
|
676
676
|
/**
|
|
677
|
-
* @public
|
|
678
677
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
678
|
+
* @public
|
|
679
679
|
*/
|
|
680
680
|
graphIdentifier: string | undefined;
|
|
681
681
|
/**
|
|
682
|
-
* @public
|
|
683
682
|
* <p>Determines whether a final graph snapshot is created before the graph is deleted.
|
|
684
683
|
* If <code>true</code> is specified, no graph snapshot is created. If <code>false</code>
|
|
685
684
|
* is specified, a graph snapshot is created before the graph is deleted.</p>
|
|
685
|
+
* @public
|
|
686
686
|
*/
|
|
687
687
|
skipSnapshot: boolean | undefined;
|
|
688
688
|
}
|
|
@@ -691,78 +691,78 @@ export interface DeleteGraphInput {
|
|
|
691
691
|
*/
|
|
692
692
|
export interface DeleteGraphOutput {
|
|
693
693
|
/**
|
|
694
|
-
* @public
|
|
695
694
|
* <p>The unique identifier of the graph.</p>
|
|
695
|
+
* @public
|
|
696
696
|
*/
|
|
697
697
|
id: string | undefined;
|
|
698
698
|
/**
|
|
699
|
-
* @public
|
|
700
699
|
* <p>The name of the graph.</p>
|
|
700
|
+
* @public
|
|
701
701
|
*/
|
|
702
702
|
name: string | undefined;
|
|
703
703
|
/**
|
|
704
|
-
* @public
|
|
705
704
|
* <p>The ARN associated with the graph.</p>
|
|
705
|
+
* @public
|
|
706
706
|
*/
|
|
707
707
|
arn: string | undefined;
|
|
708
708
|
/**
|
|
709
|
-
* @public
|
|
710
709
|
* <p>The status of the graph.</p>
|
|
710
|
+
* @public
|
|
711
711
|
*/
|
|
712
712
|
status?: GraphStatus;
|
|
713
713
|
/**
|
|
714
|
-
* @public
|
|
715
714
|
* <p>The reason for the status of the graph.</p>
|
|
715
|
+
* @public
|
|
716
716
|
*/
|
|
717
717
|
statusReason?: string;
|
|
718
718
|
/**
|
|
719
|
-
* @public
|
|
720
719
|
* <p>The time at which the graph was created.</p>
|
|
720
|
+
* @public
|
|
721
721
|
*/
|
|
722
722
|
createTime?: Date;
|
|
723
723
|
/**
|
|
724
|
-
* @public
|
|
725
724
|
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
725
|
+
* @public
|
|
726
726
|
*/
|
|
727
727
|
provisionedMemory?: number;
|
|
728
728
|
/**
|
|
729
|
-
* @public
|
|
730
729
|
* <p>The graph endpoint.</p>
|
|
730
|
+
* @public
|
|
731
731
|
*/
|
|
732
732
|
endpoint?: string;
|
|
733
733
|
/**
|
|
734
|
-
* @public
|
|
735
734
|
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
735
|
+
* @public
|
|
736
736
|
*/
|
|
737
737
|
publicConnectivity?: boolean;
|
|
738
738
|
/**
|
|
739
|
-
* @public
|
|
740
739
|
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
740
|
+
* @public
|
|
741
741
|
*/
|
|
742
742
|
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
743
743
|
/**
|
|
744
|
-
* @public
|
|
745
744
|
* <p>The number of replicas for the graph.</p>
|
|
745
|
+
* @public
|
|
746
746
|
*/
|
|
747
747
|
replicaCount?: number;
|
|
748
748
|
/**
|
|
749
|
-
* @public
|
|
750
749
|
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
750
|
+
* @public
|
|
751
751
|
*/
|
|
752
752
|
kmsKeyIdentifier?: string;
|
|
753
753
|
/**
|
|
754
|
-
* @public
|
|
755
754
|
* <p>The ID of the snapshot from which the graph was created, if the graph was recovered from a snapshot.</p>
|
|
755
|
+
* @public
|
|
756
756
|
*/
|
|
757
757
|
sourceSnapshotId?: string;
|
|
758
758
|
/**
|
|
759
|
-
* @public
|
|
760
759
|
* <p>If <code>true</code>, deletion protection was enabled for the graph.</p>
|
|
760
|
+
* @public
|
|
761
761
|
*/
|
|
762
762
|
deletionProtection?: boolean;
|
|
763
763
|
/**
|
|
764
|
-
* @public
|
|
765
764
|
* <p>The build number associated with the graph.</p>
|
|
765
|
+
* @public
|
|
766
766
|
*/
|
|
767
767
|
buildNumber?: string;
|
|
768
768
|
}
|
|
@@ -771,8 +771,8 @@ export interface DeleteGraphOutput {
|
|
|
771
771
|
*/
|
|
772
772
|
export interface GetGraphInput {
|
|
773
773
|
/**
|
|
774
|
-
* @public
|
|
775
774
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
775
|
+
* @public
|
|
776
776
|
*/
|
|
777
777
|
graphIdentifier: string | undefined;
|
|
778
778
|
}
|
|
@@ -781,78 +781,78 @@ export interface GetGraphInput {
|
|
|
781
781
|
*/
|
|
782
782
|
export interface GetGraphOutput {
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>The unique identifier of the graph.</p>
|
|
785
|
+
* @public
|
|
786
786
|
*/
|
|
787
787
|
id: string | undefined;
|
|
788
788
|
/**
|
|
789
|
-
* @public
|
|
790
789
|
* <p>The name of the graph.</p>
|
|
790
|
+
* @public
|
|
791
791
|
*/
|
|
792
792
|
name: string | undefined;
|
|
793
793
|
/**
|
|
794
|
-
* @public
|
|
795
794
|
* <p>The ARN associated with the graph.</p>
|
|
795
|
+
* @public
|
|
796
796
|
*/
|
|
797
797
|
arn: string | undefined;
|
|
798
798
|
/**
|
|
799
|
-
* @public
|
|
800
799
|
* <p>The status of the graph.</p>
|
|
800
|
+
* @public
|
|
801
801
|
*/
|
|
802
802
|
status?: GraphStatus;
|
|
803
803
|
/**
|
|
804
|
-
* @public
|
|
805
804
|
* <p>The reason that the graph has this status.</p>
|
|
805
|
+
* @public
|
|
806
806
|
*/
|
|
807
807
|
statusReason?: string;
|
|
808
808
|
/**
|
|
809
|
-
* @public
|
|
810
809
|
* <p>The time at which the graph was created.</p>
|
|
810
|
+
* @public
|
|
811
811
|
*/
|
|
812
812
|
createTime?: Date;
|
|
813
813
|
/**
|
|
814
|
-
* @public
|
|
815
814
|
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
815
|
+
* @public
|
|
816
816
|
*/
|
|
817
817
|
provisionedMemory?: number;
|
|
818
818
|
/**
|
|
819
|
-
* @public
|
|
820
819
|
* <p>The graph endpoint.</p>
|
|
820
|
+
* @public
|
|
821
821
|
*/
|
|
822
822
|
endpoint?: string;
|
|
823
823
|
/**
|
|
824
|
-
* @public
|
|
825
824
|
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
825
|
+
* @public
|
|
826
826
|
*/
|
|
827
827
|
publicConnectivity?: boolean;
|
|
828
828
|
/**
|
|
829
|
-
* @public
|
|
830
829
|
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
830
|
+
* @public
|
|
831
831
|
*/
|
|
832
832
|
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
833
833
|
/**
|
|
834
|
-
* @public
|
|
835
834
|
* <p>The number of replicas for the graph.</p>
|
|
835
|
+
* @public
|
|
836
836
|
*/
|
|
837
837
|
replicaCount?: number;
|
|
838
838
|
/**
|
|
839
|
-
* @public
|
|
840
839
|
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
840
|
+
* @public
|
|
841
841
|
*/
|
|
842
842
|
kmsKeyIdentifier?: string;
|
|
843
843
|
/**
|
|
844
|
-
* @public
|
|
845
844
|
* <p>The ID of the snapshot from which the graph was created, if it was created from a snapshot.</p>
|
|
845
|
+
* @public
|
|
846
846
|
*/
|
|
847
847
|
sourceSnapshotId?: string;
|
|
848
848
|
/**
|
|
849
|
-
* @public
|
|
850
849
|
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
850
|
+
* @public
|
|
851
851
|
*/
|
|
852
852
|
deletionProtection?: boolean;
|
|
853
853
|
/**
|
|
854
|
-
* @public
|
|
855
854
|
* <p>The build number of the graph.</p>
|
|
855
|
+
* @public
|
|
856
856
|
*/
|
|
857
857
|
buildNumber?: string;
|
|
858
858
|
}
|
|
@@ -861,77 +861,77 @@ export interface GetGraphOutput {
|
|
|
861
861
|
*/
|
|
862
862
|
export interface ListGraphsInput {
|
|
863
863
|
/**
|
|
864
|
-
* @public
|
|
865
864
|
* <p>Pagination token used to paginate output.</p>
|
|
866
865
|
* <p>When this value is provided as input, the service returns results from where
|
|
867
866
|
* the previous response left off. When this value is present in output, it indicates
|
|
868
867
|
* that there are more results to retrieve.</p>
|
|
868
|
+
* @public
|
|
869
869
|
*/
|
|
870
870
|
nextToken?: string;
|
|
871
871
|
/**
|
|
872
|
-
* @public
|
|
873
872
|
* <p>The total number of records to return in the command's output.</p>
|
|
874
873
|
* <p>If the total number of records available is more than the value specified,
|
|
875
874
|
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
876
875
|
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
877
876
|
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
878
877
|
* outside of the Amazon CLI.</p>
|
|
878
|
+
* @public
|
|
879
879
|
*/
|
|
880
880
|
maxResults?: number;
|
|
881
881
|
}
|
|
882
882
|
/**
|
|
883
|
-
* @public
|
|
884
883
|
* <p>Summary details about a graph.</p>
|
|
884
|
+
* @public
|
|
885
885
|
*/
|
|
886
886
|
export interface GraphSummary {
|
|
887
887
|
/**
|
|
888
|
-
* @public
|
|
889
888
|
* <p>The unique identifier of the graph.</p>
|
|
889
|
+
* @public
|
|
890
890
|
*/
|
|
891
891
|
id: string | undefined;
|
|
892
892
|
/**
|
|
893
|
-
* @public
|
|
894
893
|
* <p>The name of the graph.</p>
|
|
894
|
+
* @public
|
|
895
895
|
*/
|
|
896
896
|
name: string | undefined;
|
|
897
897
|
/**
|
|
898
|
-
* @public
|
|
899
898
|
* <p>The ARN associated with the graph.</p>
|
|
899
|
+
* @public
|
|
900
900
|
*/
|
|
901
901
|
arn: string | undefined;
|
|
902
902
|
/**
|
|
903
|
-
* @public
|
|
904
903
|
* <p>The status of the graph.</p>
|
|
904
|
+
* @public
|
|
905
905
|
*/
|
|
906
906
|
status?: GraphStatus;
|
|
907
907
|
/**
|
|
908
|
-
* @public
|
|
909
908
|
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
909
|
+
* @public
|
|
910
910
|
*/
|
|
911
911
|
provisionedMemory?: number;
|
|
912
912
|
/**
|
|
913
|
-
* @public
|
|
914
913
|
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
914
|
+
* @public
|
|
915
915
|
*/
|
|
916
916
|
publicConnectivity?: boolean;
|
|
917
917
|
/**
|
|
918
|
-
* @public
|
|
919
918
|
* <p>The graph endpoint.</p>
|
|
919
|
+
* @public
|
|
920
920
|
*/
|
|
921
921
|
endpoint?: string;
|
|
922
922
|
/**
|
|
923
|
-
* @public
|
|
924
923
|
* <p>The number of replicas for the graph.</p>
|
|
924
|
+
* @public
|
|
925
925
|
*/
|
|
926
926
|
replicaCount?: number;
|
|
927
927
|
/**
|
|
928
|
-
* @public
|
|
929
928
|
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
929
|
+
* @public
|
|
930
930
|
*/
|
|
931
931
|
kmsKeyIdentifier?: string;
|
|
932
932
|
/**
|
|
933
|
-
* @public
|
|
934
933
|
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
934
|
+
* @public
|
|
935
935
|
*/
|
|
936
936
|
deletionProtection?: boolean;
|
|
937
937
|
}
|
|
@@ -940,16 +940,16 @@ export interface GraphSummary {
|
|
|
940
940
|
*/
|
|
941
941
|
export interface ListGraphsOutput {
|
|
942
942
|
/**
|
|
943
|
-
* @public
|
|
944
943
|
* <p>A list of the graphs.</p>
|
|
944
|
+
* @public
|
|
945
945
|
*/
|
|
946
946
|
graphs: GraphSummary[] | undefined;
|
|
947
947
|
/**
|
|
948
|
-
* @public
|
|
949
948
|
* <p>Pagination token used to paginate output.</p>
|
|
950
949
|
* <p>When this value is provided as input, the service returns results from where
|
|
951
950
|
* the previous response left off. When this value is present in output, it indicates
|
|
952
951
|
* that there are more results to retrieve.</p>
|
|
952
|
+
* @public
|
|
953
953
|
*/
|
|
954
954
|
nextToken?: string;
|
|
955
955
|
}
|
|
@@ -958,15 +958,15 @@ export interface ListGraphsOutput {
|
|
|
958
958
|
*/
|
|
959
959
|
export interface ResetGraphInput {
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p>ID of the graph to reset.</p>
|
|
962
|
+
* @public
|
|
963
963
|
*/
|
|
964
964
|
graphIdentifier: string | undefined;
|
|
965
965
|
/**
|
|
966
|
-
* @public
|
|
967
966
|
* <p>Determines whether a final graph snapshot is created before the graph data is deleted.
|
|
968
967
|
* If set to <code>true</code>, no graph snapshot is created. If set to <code>false</code>,
|
|
969
968
|
* a graph snapshot is created before the data is deleted.</p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
skipSnapshot: boolean | undefined;
|
|
972
972
|
}
|
|
@@ -975,78 +975,78 @@ export interface ResetGraphInput {
|
|
|
975
975
|
*/
|
|
976
976
|
export interface ResetGraphOutput {
|
|
977
977
|
/**
|
|
978
|
-
* @public
|
|
979
978
|
* <p>The unique identifier of the graph.</p>
|
|
979
|
+
* @public
|
|
980
980
|
*/
|
|
981
981
|
id: string | undefined;
|
|
982
982
|
/**
|
|
983
|
-
* @public
|
|
984
983
|
* <p>The name of the graph.</p>
|
|
984
|
+
* @public
|
|
985
985
|
*/
|
|
986
986
|
name: string | undefined;
|
|
987
987
|
/**
|
|
988
|
-
* @public
|
|
989
988
|
* <p>The ARN associated with the graph.</p>
|
|
989
|
+
* @public
|
|
990
990
|
*/
|
|
991
991
|
arn: string | undefined;
|
|
992
992
|
/**
|
|
993
|
-
* @public
|
|
994
993
|
* <p>The status of the graph.</p>
|
|
994
|
+
* @public
|
|
995
995
|
*/
|
|
996
996
|
status?: GraphStatus;
|
|
997
997
|
/**
|
|
998
|
-
* @public
|
|
999
998
|
* <p>The reason that the graph has this status.</p>
|
|
999
|
+
* @public
|
|
1000
1000
|
*/
|
|
1001
1001
|
statusReason?: string;
|
|
1002
1002
|
/**
|
|
1003
|
-
* @public
|
|
1004
1003
|
* <p>The time at which the graph was created.</p>
|
|
1004
|
+
* @public
|
|
1005
1005
|
*/
|
|
1006
1006
|
createTime?: Date;
|
|
1007
1007
|
/**
|
|
1008
|
-
* @public
|
|
1009
1008
|
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
1009
|
+
* @public
|
|
1010
1010
|
*/
|
|
1011
1011
|
provisionedMemory?: number;
|
|
1012
1012
|
/**
|
|
1013
|
-
* @public
|
|
1014
1013
|
* <p>The graph endpoint.</p>
|
|
1014
|
+
* @public
|
|
1015
1015
|
*/
|
|
1016
1016
|
endpoint?: string;
|
|
1017
1017
|
/**
|
|
1018
|
-
* @public
|
|
1019
1018
|
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
1019
|
+
* @public
|
|
1020
1020
|
*/
|
|
1021
1021
|
publicConnectivity?: boolean;
|
|
1022
1022
|
/**
|
|
1023
|
-
* @public
|
|
1024
1023
|
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
1024
|
+
* @public
|
|
1025
1025
|
*/
|
|
1026
1026
|
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
1027
1027
|
/**
|
|
1028
|
-
* @public
|
|
1029
1028
|
* <p>The number of replicas for the graph.</p>
|
|
1029
|
+
* @public
|
|
1030
1030
|
*/
|
|
1031
1031
|
replicaCount?: number;
|
|
1032
1032
|
/**
|
|
1033
|
-
* @public
|
|
1034
1033
|
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
1034
|
+
* @public
|
|
1035
1035
|
*/
|
|
1036
1036
|
kmsKeyIdentifier?: string;
|
|
1037
1037
|
/**
|
|
1038
|
-
* @public
|
|
1039
1038
|
* <p>The ID of the snapshot from which the graph was created, if any.</p>
|
|
1039
|
+
* @public
|
|
1040
1040
|
*/
|
|
1041
1041
|
sourceSnapshotId?: string;
|
|
1042
1042
|
/**
|
|
1043
|
-
* @public
|
|
1044
1043
|
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
1044
|
+
* @public
|
|
1045
1045
|
*/
|
|
1046
1046
|
deletionProtection?: boolean;
|
|
1047
1047
|
/**
|
|
1048
|
-
* @public
|
|
1049
1048
|
* <p>The build number of the graph.</p>
|
|
1049
|
+
* @public
|
|
1050
1050
|
*/
|
|
1051
1051
|
buildNumber?: string;
|
|
1052
1052
|
}
|
|
@@ -1055,44 +1055,44 @@ export interface ResetGraphOutput {
|
|
|
1055
1055
|
*/
|
|
1056
1056
|
export interface RestoreGraphFromSnapshotInput {
|
|
1057
1057
|
/**
|
|
1058
|
-
* @public
|
|
1059
1058
|
* <p>The ID of the snapshot in question.</p>
|
|
1059
|
+
* @public
|
|
1060
1060
|
*/
|
|
1061
1061
|
snapshotIdentifier: string | undefined;
|
|
1062
1062
|
/**
|
|
1063
|
-
* @public
|
|
1064
1063
|
* <p>A name for the new Neptune Analytics graph to be created from the snapshot.</p>
|
|
1065
1064
|
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1066
1065
|
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1067
1066
|
* consecutive hyphens. </p>
|
|
1067
|
+
* @public
|
|
1068
1068
|
*/
|
|
1069
1069
|
graphName: string | undefined;
|
|
1070
1070
|
/**
|
|
1071
|
-
* @public
|
|
1072
1071
|
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
|
|
1072
|
+
* @public
|
|
1073
1073
|
*/
|
|
1074
1074
|
provisionedMemory?: number;
|
|
1075
1075
|
/**
|
|
1076
|
-
* @public
|
|
1077
1076
|
* <p>A value that indicates whether the graph has deletion protection enabled.
|
|
1078
1077
|
* The graph can't be deleted when deletion protection is enabled.</p>
|
|
1078
|
+
* @public
|
|
1079
1079
|
*/
|
|
1080
1080
|
deletionProtection?: boolean;
|
|
1081
1081
|
/**
|
|
1082
|
-
* @public
|
|
1083
1082
|
* <p>Adds metadata tags to the snapshot.
|
|
1084
1083
|
* These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
1084
|
+
* @public
|
|
1085
1085
|
*/
|
|
1086
1086
|
tags?: Record<string, string>;
|
|
1087
1087
|
/**
|
|
1088
|
-
* @public
|
|
1089
1088
|
* <p>The number of replicas in other AZs. Min =0, Max = 2, Default =1</p>
|
|
1089
|
+
* @public
|
|
1090
1090
|
*/
|
|
1091
1091
|
replicaCount?: number;
|
|
1092
1092
|
/**
|
|
1093
|
-
* @public
|
|
1094
1093
|
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
|
|
1095
1094
|
* (<code>true</code> to enable, or <code>false</code> to disable).</p>
|
|
1095
|
+
* @public
|
|
1096
1096
|
*/
|
|
1097
1097
|
publicConnectivity?: boolean;
|
|
1098
1098
|
}
|
|
@@ -1101,78 +1101,78 @@ export interface RestoreGraphFromSnapshotInput {
|
|
|
1101
1101
|
*/
|
|
1102
1102
|
export interface RestoreGraphFromSnapshotOutput {
|
|
1103
1103
|
/**
|
|
1104
|
-
* @public
|
|
1105
1104
|
* <p>The unique identifier of the graph.</p>
|
|
1105
|
+
* @public
|
|
1106
1106
|
*/
|
|
1107
1107
|
id: string | undefined;
|
|
1108
1108
|
/**
|
|
1109
|
-
* @public
|
|
1110
1109
|
* <p>The name of the graph.</p>
|
|
1110
|
+
* @public
|
|
1111
1111
|
*/
|
|
1112
1112
|
name: string | undefined;
|
|
1113
1113
|
/**
|
|
1114
|
-
* @public
|
|
1115
1114
|
* <p>The ARN associated with the graph.</p>
|
|
1115
|
+
* @public
|
|
1116
1116
|
*/
|
|
1117
1117
|
arn: string | undefined;
|
|
1118
1118
|
/**
|
|
1119
|
-
* @public
|
|
1120
1119
|
* <p>The status of the graph.</p>
|
|
1120
|
+
* @public
|
|
1121
1121
|
*/
|
|
1122
1122
|
status?: GraphStatus;
|
|
1123
1123
|
/**
|
|
1124
|
-
* @public
|
|
1125
1124
|
* <p>The reason that the graph has this status.</p>
|
|
1125
|
+
* @public
|
|
1126
1126
|
*/
|
|
1127
1127
|
statusReason?: string;
|
|
1128
1128
|
/**
|
|
1129
|
-
* @public
|
|
1130
1129
|
* <p>The time at which the graph was created.</p>
|
|
1130
|
+
* @public
|
|
1131
1131
|
*/
|
|
1132
1132
|
createTime?: Date;
|
|
1133
1133
|
/**
|
|
1134
|
-
* @public
|
|
1135
1134
|
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
1135
|
+
* @public
|
|
1136
1136
|
*/
|
|
1137
1137
|
provisionedMemory?: number;
|
|
1138
1138
|
/**
|
|
1139
|
-
* @public
|
|
1140
1139
|
* <p>The graph endpoint.</p>
|
|
1140
|
+
* @public
|
|
1141
1141
|
*/
|
|
1142
1142
|
endpoint?: string;
|
|
1143
1143
|
/**
|
|
1144
|
-
* @public
|
|
1145
1144
|
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
1145
|
+
* @public
|
|
1146
1146
|
*/
|
|
1147
1147
|
publicConnectivity?: boolean;
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
1153
1153
|
/**
|
|
1154
|
-
* @public
|
|
1155
1154
|
* <p>The number of replicas for the graph.</p>
|
|
1155
|
+
* @public
|
|
1156
1156
|
*/
|
|
1157
1157
|
replicaCount?: number;
|
|
1158
1158
|
/**
|
|
1159
|
-
* @public
|
|
1160
1159
|
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
1160
|
+
* @public
|
|
1161
1161
|
*/
|
|
1162
1162
|
kmsKeyIdentifier?: string;
|
|
1163
1163
|
/**
|
|
1164
|
-
* @public
|
|
1165
1164
|
* <p>The ID of the snapshot from which the graph was created, if any.</p>
|
|
1165
|
+
* @public
|
|
1166
1166
|
*/
|
|
1167
1167
|
sourceSnapshotId?: string;
|
|
1168
1168
|
/**
|
|
1169
|
-
* @public
|
|
1170
1169
|
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
1170
|
+
* @public
|
|
1171
1171
|
*/
|
|
1172
1172
|
deletionProtection?: boolean;
|
|
1173
1173
|
/**
|
|
1174
|
-
* @public
|
|
1175
1174
|
* <p>The build number of the graph.</p>
|
|
1175
|
+
* @public
|
|
1176
1176
|
*/
|
|
1177
1177
|
buildNumber?: string;
|
|
1178
1178
|
}
|
|
@@ -1181,25 +1181,25 @@ export interface RestoreGraphFromSnapshotOutput {
|
|
|
1181
1181
|
*/
|
|
1182
1182
|
export interface UpdateGraphInput {
|
|
1183
1183
|
/**
|
|
1184
|
-
* @public
|
|
1185
1184
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1185
|
+
* @public
|
|
1186
1186
|
*/
|
|
1187
1187
|
graphIdentifier: string | undefined;
|
|
1188
1188
|
/**
|
|
1189
|
-
* @public
|
|
1190
1189
|
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
|
|
1191
1190
|
* (<code>true</code> to enable, or <code>false</code> to disable.</p>
|
|
1191
|
+
* @public
|
|
1192
1192
|
*/
|
|
1193
1193
|
publicConnectivity?: boolean;
|
|
1194
1194
|
/**
|
|
1195
|
-
* @public
|
|
1196
1195
|
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
|
|
1196
|
+
* @public
|
|
1197
1197
|
*/
|
|
1198
1198
|
provisionedMemory?: number;
|
|
1199
1199
|
/**
|
|
1200
|
-
* @public
|
|
1201
1200
|
* <p>A value that indicates whether the graph has deletion protection enabled.
|
|
1202
1201
|
* The graph can't be deleted when deletion protection is enabled.</p>
|
|
1202
|
+
* @public
|
|
1203
1203
|
*/
|
|
1204
1204
|
deletionProtection?: boolean;
|
|
1205
1205
|
}
|
|
@@ -1208,78 +1208,78 @@ export interface UpdateGraphInput {
|
|
|
1208
1208
|
*/
|
|
1209
1209
|
export interface UpdateGraphOutput {
|
|
1210
1210
|
/**
|
|
1211
|
-
* @public
|
|
1212
1211
|
* <p>The unique identifier of the graph.</p>
|
|
1212
|
+
* @public
|
|
1213
1213
|
*/
|
|
1214
1214
|
id: string | undefined;
|
|
1215
1215
|
/**
|
|
1216
|
-
* @public
|
|
1217
1216
|
* <p>The name of the graph.</p>
|
|
1217
|
+
* @public
|
|
1218
1218
|
*/
|
|
1219
1219
|
name: string | undefined;
|
|
1220
1220
|
/**
|
|
1221
|
-
* @public
|
|
1222
1221
|
* <p>The ARN associated with the graph.</p>
|
|
1222
|
+
* @public
|
|
1223
1223
|
*/
|
|
1224
1224
|
arn: string | undefined;
|
|
1225
1225
|
/**
|
|
1226
|
-
* @public
|
|
1227
1226
|
* <p>The status of the graph.</p>
|
|
1227
|
+
* @public
|
|
1228
1228
|
*/
|
|
1229
1229
|
status?: GraphStatus;
|
|
1230
1230
|
/**
|
|
1231
|
-
* @public
|
|
1232
1231
|
* <p>The reason that the graph has this status.</p>
|
|
1232
|
+
* @public
|
|
1233
1233
|
*/
|
|
1234
1234
|
statusReason?: string;
|
|
1235
1235
|
/**
|
|
1236
|
-
* @public
|
|
1237
1236
|
* <p>The time at which the graph was created.</p>
|
|
1237
|
+
* @public
|
|
1238
1238
|
*/
|
|
1239
1239
|
createTime?: Date;
|
|
1240
1240
|
/**
|
|
1241
|
-
* @public
|
|
1242
1241
|
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
1242
|
+
* @public
|
|
1243
1243
|
*/
|
|
1244
1244
|
provisionedMemory?: number;
|
|
1245
1245
|
/**
|
|
1246
|
-
* @public
|
|
1247
1246
|
* <p>The graph endpoint.</p>
|
|
1247
|
+
* @public
|
|
1248
1248
|
*/
|
|
1249
1249
|
endpoint?: string;
|
|
1250
1250
|
/**
|
|
1251
|
-
* @public
|
|
1252
1251
|
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
1252
|
+
* @public
|
|
1253
1253
|
*/
|
|
1254
1254
|
publicConnectivity?: boolean;
|
|
1255
1255
|
/**
|
|
1256
|
-
* @public
|
|
1257
1256
|
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
1257
|
+
* @public
|
|
1258
1258
|
*/
|
|
1259
1259
|
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
1260
1260
|
/**
|
|
1261
|
-
* @public
|
|
1262
1261
|
* <p>The number of replicas for the graph.</p>
|
|
1262
|
+
* @public
|
|
1263
1263
|
*/
|
|
1264
1264
|
replicaCount?: number;
|
|
1265
1265
|
/**
|
|
1266
|
-
* @public
|
|
1267
1266
|
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
1267
|
+
* @public
|
|
1268
1268
|
*/
|
|
1269
1269
|
kmsKeyIdentifier?: string;
|
|
1270
1270
|
/**
|
|
1271
|
-
* @public
|
|
1272
1271
|
* <p>The ID of the snapshot from which the graph was created, if any.</p>
|
|
1272
|
+
* @public
|
|
1273
1273
|
*/
|
|
1274
1274
|
sourceSnapshotId?: string;
|
|
1275
1275
|
/**
|
|
1276
|
-
* @public
|
|
1277
1276
|
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
1277
|
+
* @public
|
|
1278
1278
|
*/
|
|
1279
1279
|
deletionProtection?: boolean;
|
|
1280
1280
|
/**
|
|
1281
|
-
* @public
|
|
1282
1281
|
* <p>The build number of the graph.</p>
|
|
1282
|
+
* @public
|
|
1283
1283
|
*/
|
|
1284
1284
|
buildNumber?: string;
|
|
1285
1285
|
}
|
|
@@ -1302,49 +1302,49 @@ export type QueryStateInput = (typeof QueryStateInput)[keyof typeof QueryStateIn
|
|
|
1302
1302
|
*/
|
|
1303
1303
|
export interface ListQueriesInput {
|
|
1304
1304
|
/**
|
|
1305
|
-
* @public
|
|
1306
1305
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1306
|
+
* @public
|
|
1307
1307
|
*/
|
|
1308
1308
|
graphIdentifier: string | undefined;
|
|
1309
1309
|
/**
|
|
1310
|
-
* @public
|
|
1311
1310
|
* <p>The maximum number of results to be fetched by the API.</p>
|
|
1311
|
+
* @public
|
|
1312
1312
|
*/
|
|
1313
1313
|
maxResults: number | undefined;
|
|
1314
1314
|
/**
|
|
1315
|
-
* @public
|
|
1316
1315
|
* <p>Filtered list of queries based on state.</p>
|
|
1316
|
+
* @public
|
|
1317
1317
|
*/
|
|
1318
1318
|
state?: QueryStateInput;
|
|
1319
1319
|
}
|
|
1320
1320
|
/**
|
|
1321
|
-
* @public
|
|
1322
1321
|
* <p>Details of the query listed.</p>
|
|
1322
|
+
* @public
|
|
1323
1323
|
*/
|
|
1324
1324
|
export interface QuerySummary {
|
|
1325
1325
|
/**
|
|
1326
|
-
* @public
|
|
1327
1326
|
* <p>A string representation of the id of the query.</p>
|
|
1327
|
+
* @public
|
|
1328
1328
|
*/
|
|
1329
1329
|
id?: string;
|
|
1330
1330
|
/**
|
|
1331
|
-
* @public
|
|
1332
1331
|
* <p>The actual query text. The <code>queryString</code> may be truncated if the actual query string is too long.</p>
|
|
1332
|
+
* @public
|
|
1333
1333
|
*/
|
|
1334
1334
|
queryString?: string;
|
|
1335
1335
|
/**
|
|
1336
|
-
* @public
|
|
1337
1336
|
* <p>The amount of time, in milliseconds, the query has waited in the queue before being picked up by a worker thread.</p>
|
|
1337
|
+
* @public
|
|
1338
1338
|
*/
|
|
1339
1339
|
waited?: number;
|
|
1340
1340
|
/**
|
|
1341
|
-
* @public
|
|
1342
1341
|
* <p>The running time of the query, in milliseconds.</p>
|
|
1342
|
+
* @public
|
|
1343
1343
|
*/
|
|
1344
1344
|
elapsed?: number;
|
|
1345
1345
|
/**
|
|
1346
|
-
* @public
|
|
1347
1346
|
* <p>State of the query.</p>
|
|
1347
|
+
* @public
|
|
1348
1348
|
*/
|
|
1349
1349
|
state?: QueryState;
|
|
1350
1350
|
}
|
|
@@ -1353,8 +1353,8 @@ export interface QuerySummary {
|
|
|
1353
1353
|
*/
|
|
1354
1354
|
export interface ListQueriesOutput {
|
|
1355
1355
|
/**
|
|
1356
|
-
* @public
|
|
1357
1356
|
* <p>A list of current openCypher queries.</p>
|
|
1357
|
+
* @public
|
|
1358
1358
|
*/
|
|
1359
1359
|
queries: QuerySummary[] | undefined;
|
|
1360
1360
|
}
|
|
@@ -1363,8 +1363,8 @@ export interface ListQueriesOutput {
|
|
|
1363
1363
|
*/
|
|
1364
1364
|
export interface ListTagsForResourceInput {
|
|
1365
1365
|
/**
|
|
1366
|
-
* @public
|
|
1367
1366
|
* <p>The ARN of the resource.</p>
|
|
1367
|
+
* @public
|
|
1368
1368
|
*/
|
|
1369
1369
|
resourceArn: string | undefined;
|
|
1370
1370
|
}
|
|
@@ -1373,8 +1373,8 @@ export interface ListTagsForResourceInput {
|
|
|
1373
1373
|
*/
|
|
1374
1374
|
export interface ListTagsForResourceOutput {
|
|
1375
1375
|
/**
|
|
1376
|
-
* @public
|
|
1377
1376
|
* <p>The list of metadata tags associated with the resource.</p>
|
|
1377
|
+
* @public
|
|
1378
1378
|
*/
|
|
1379
1379
|
tags?: Record<string, string>;
|
|
1380
1380
|
}
|
|
@@ -1383,23 +1383,23 @@ export interface ListTagsForResourceOutput {
|
|
|
1383
1383
|
*/
|
|
1384
1384
|
export interface CreatePrivateGraphEndpointInput {
|
|
1385
1385
|
/**
|
|
1386
|
-
* @public
|
|
1387
1386
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1387
|
+
* @public
|
|
1388
1388
|
*/
|
|
1389
1389
|
graphIdentifier: string | undefined;
|
|
1390
1390
|
/**
|
|
1391
|
-
* @public
|
|
1392
1391
|
* <p> The VPC in which the private graph endpoint needs to be created.</p>
|
|
1392
|
+
* @public
|
|
1393
1393
|
*/
|
|
1394
1394
|
vpcId?: string;
|
|
1395
1395
|
/**
|
|
1396
|
-
* @public
|
|
1397
1396
|
* <p>Subnets in which private graph endpoint ENIs are created.</p>
|
|
1397
|
+
* @public
|
|
1398
1398
|
*/
|
|
1399
1399
|
subnetIds?: string[];
|
|
1400
1400
|
/**
|
|
1401
|
-
* @public
|
|
1402
1401
|
* <p>Security groups to be attached to the private graph endpoint..</p>
|
|
1402
|
+
* @public
|
|
1403
1403
|
*/
|
|
1404
1404
|
vpcSecurityGroupIds?: string[];
|
|
1405
1405
|
}
|
|
@@ -1422,23 +1422,23 @@ export type PrivateGraphEndpointStatus = (typeof PrivateGraphEndpointStatus)[key
|
|
|
1422
1422
|
*/
|
|
1423
1423
|
export interface CreatePrivateGraphEndpointOutput {
|
|
1424
1424
|
/**
|
|
1425
|
-
* @public
|
|
1426
1425
|
* <p>VPC in which the private graph endpoint is created.</p>
|
|
1426
|
+
* @public
|
|
1427
1427
|
*/
|
|
1428
1428
|
vpcId: string | undefined;
|
|
1429
1429
|
/**
|
|
1430
|
-
* @public
|
|
1431
1430
|
* <p>Subnets in which the private graph endpoint ENIs are created. </p>
|
|
1431
|
+
* @public
|
|
1432
1432
|
*/
|
|
1433
1433
|
subnetIds: string[] | undefined;
|
|
1434
1434
|
/**
|
|
1435
|
-
* @public
|
|
1436
1435
|
* <p>Status of the private graph endpoint.</p>
|
|
1436
|
+
* @public
|
|
1437
1437
|
*/
|
|
1438
1438
|
status: PrivateGraphEndpointStatus | undefined;
|
|
1439
1439
|
/**
|
|
1440
|
-
* @public
|
|
1441
1440
|
* <p>Endpoint ID of the prviate grpah endpoint.</p>
|
|
1441
|
+
* @public
|
|
1442
1442
|
*/
|
|
1443
1443
|
vpcEndpointId?: string;
|
|
1444
1444
|
}
|
|
@@ -1447,13 +1447,13 @@ export interface CreatePrivateGraphEndpointOutput {
|
|
|
1447
1447
|
*/
|
|
1448
1448
|
export interface DeletePrivateGraphEndpointInput {
|
|
1449
1449
|
/**
|
|
1450
|
-
* @public
|
|
1451
1450
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1451
|
+
* @public
|
|
1452
1452
|
*/
|
|
1453
1453
|
graphIdentifier: string | undefined;
|
|
1454
1454
|
/**
|
|
1455
|
-
* @public
|
|
1456
1455
|
* <p>The ID of the VPC where the private endpoint is located.</p>
|
|
1456
|
+
* @public
|
|
1457
1457
|
*/
|
|
1458
1458
|
vpcId: string | undefined;
|
|
1459
1459
|
}
|
|
@@ -1462,23 +1462,23 @@ export interface DeletePrivateGraphEndpointInput {
|
|
|
1462
1462
|
*/
|
|
1463
1463
|
export interface DeletePrivateGraphEndpointOutput {
|
|
1464
1464
|
/**
|
|
1465
|
-
* @public
|
|
1466
1465
|
* <p>The ID of the VPC where the private endpoint was deleted.</p>
|
|
1466
|
+
* @public
|
|
1467
1467
|
*/
|
|
1468
1468
|
vpcId: string | undefined;
|
|
1469
1469
|
/**
|
|
1470
|
-
* @public
|
|
1471
1470
|
* <p>The subnet IDs involved.</p>
|
|
1471
|
+
* @public
|
|
1472
1472
|
*/
|
|
1473
1473
|
subnetIds: string[] | undefined;
|
|
1474
1474
|
/**
|
|
1475
|
-
* @public
|
|
1476
1475
|
* <p>The status of the delete operation.</p>
|
|
1476
|
+
* @public
|
|
1477
1477
|
*/
|
|
1478
1478
|
status: PrivateGraphEndpointStatus | undefined;
|
|
1479
1479
|
/**
|
|
1480
|
-
* @public
|
|
1481
1480
|
* <p>The ID of the VPC endpoint that was deleted.</p>
|
|
1481
|
+
* @public
|
|
1482
1482
|
*/
|
|
1483
1483
|
vpcEndpointId?: string;
|
|
1484
1484
|
}
|
|
@@ -1487,13 +1487,13 @@ export interface DeletePrivateGraphEndpointOutput {
|
|
|
1487
1487
|
*/
|
|
1488
1488
|
export interface GetPrivateGraphEndpointInput {
|
|
1489
1489
|
/**
|
|
1490
|
-
* @public
|
|
1491
1490
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1491
|
+
* @public
|
|
1492
1492
|
*/
|
|
1493
1493
|
graphIdentifier: string | undefined;
|
|
1494
1494
|
/**
|
|
1495
|
-
* @public
|
|
1496
1495
|
* <p>The ID of the VPC where the private endpoint is located.</p>
|
|
1496
|
+
* @public
|
|
1497
1497
|
*/
|
|
1498
1498
|
vpcId: string | undefined;
|
|
1499
1499
|
}
|
|
@@ -1502,23 +1502,23 @@ export interface GetPrivateGraphEndpointInput {
|
|
|
1502
1502
|
*/
|
|
1503
1503
|
export interface GetPrivateGraphEndpointOutput {
|
|
1504
1504
|
/**
|
|
1505
|
-
* @public
|
|
1506
1505
|
* <p>The ID of the VPC where the private endpoint is located.</p>
|
|
1506
|
+
* @public
|
|
1507
1507
|
*/
|
|
1508
1508
|
vpcId: string | undefined;
|
|
1509
1509
|
/**
|
|
1510
|
-
* @public
|
|
1511
1510
|
* <p>The subnet IDs involved.</p>
|
|
1511
|
+
* @public
|
|
1512
1512
|
*/
|
|
1513
1513
|
subnetIds: string[] | undefined;
|
|
1514
1514
|
/**
|
|
1515
|
-
* @public
|
|
1516
1515
|
* <p>The current status of the private endpoint.</p>
|
|
1516
|
+
* @public
|
|
1517
1517
|
*/
|
|
1518
1518
|
status: PrivateGraphEndpointStatus | undefined;
|
|
1519
1519
|
/**
|
|
1520
|
-
* @public
|
|
1521
1520
|
* <p>The ID of the private endpoint.</p>
|
|
1521
|
+
* @public
|
|
1522
1522
|
*/
|
|
1523
1523
|
vpcEndpointId?: string;
|
|
1524
1524
|
}
|
|
@@ -1527,52 +1527,52 @@ export interface GetPrivateGraphEndpointOutput {
|
|
|
1527
1527
|
*/
|
|
1528
1528
|
export interface ListPrivateGraphEndpointsInput {
|
|
1529
1529
|
/**
|
|
1530
|
-
* @public
|
|
1531
1530
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1531
|
+
* @public
|
|
1532
1532
|
*/
|
|
1533
1533
|
graphIdentifier: string | undefined;
|
|
1534
1534
|
/**
|
|
1535
|
-
* @public
|
|
1536
1535
|
* <p>Pagination token used to paginate output.</p>
|
|
1537
1536
|
* <p>When this value is provided as input, the service returns results from where
|
|
1538
1537
|
* the previous response left off. When this value is present in output, it indicates
|
|
1539
1538
|
* that there are more results to retrieve.</p>
|
|
1539
|
+
* @public
|
|
1540
1540
|
*/
|
|
1541
1541
|
nextToken?: string;
|
|
1542
1542
|
/**
|
|
1543
|
-
* @public
|
|
1544
1543
|
* <p>The total number of records to return in the command's output.</p>
|
|
1545
1544
|
* <p>If the total number of records available is more than the value specified,
|
|
1546
1545
|
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
1547
1546
|
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
1548
1547
|
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
1549
1548
|
* outside of the Amazon CLI.</p>
|
|
1549
|
+
* @public
|
|
1550
1550
|
*/
|
|
1551
1551
|
maxResults?: number;
|
|
1552
1552
|
}
|
|
1553
1553
|
/**
|
|
1554
|
-
* @public
|
|
1555
1554
|
* <p>Details about a private graph endpoint.</p>
|
|
1555
|
+
* @public
|
|
1556
1556
|
*/
|
|
1557
1557
|
export interface PrivateGraphEndpointSummary {
|
|
1558
1558
|
/**
|
|
1559
|
-
* @public
|
|
1560
1559
|
* <p>The ID of the VPC in which the private graph endpoint is located.</p>
|
|
1560
|
+
* @public
|
|
1561
1561
|
*/
|
|
1562
1562
|
vpcId: string | undefined;
|
|
1563
1563
|
/**
|
|
1564
|
-
* @public
|
|
1565
1564
|
* <p>The subnet IDs associated with the private graph endpoint.</p>
|
|
1565
|
+
* @public
|
|
1566
1566
|
*/
|
|
1567
1567
|
subnetIds: string[] | undefined;
|
|
1568
1568
|
/**
|
|
1569
|
-
* @public
|
|
1570
1569
|
* <p>The status of the private graph endpoint.</p>
|
|
1570
|
+
* @public
|
|
1571
1571
|
*/
|
|
1572
1572
|
status: PrivateGraphEndpointStatus | undefined;
|
|
1573
1573
|
/**
|
|
1574
|
-
* @public
|
|
1575
1574
|
* <p>The ID of the VPC endpoint.</p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
vpcEndpointId?: string;
|
|
1578
1578
|
}
|
|
@@ -1581,16 +1581,16 @@ export interface PrivateGraphEndpointSummary {
|
|
|
1581
1581
|
*/
|
|
1582
1582
|
export interface ListPrivateGraphEndpointsOutput {
|
|
1583
1583
|
/**
|
|
1584
|
-
* @public
|
|
1585
1584
|
* <p>A list of private endpoints for the specified Neptune Analytics graph.</p>
|
|
1585
|
+
* @public
|
|
1586
1586
|
*/
|
|
1587
1587
|
privateGraphEndpoints: PrivateGraphEndpointSummary[] | undefined;
|
|
1588
1588
|
/**
|
|
1589
|
-
* @public
|
|
1590
1589
|
* <p>Pagination token used to paginate output.</p>
|
|
1591
1590
|
* <p>When this value is provided as input, the service returns results from where
|
|
1592
1591
|
* the previous response left off. When this value is present in output, it indicates
|
|
1593
1592
|
* that there are more results to retrieve.</p>
|
|
1593
|
+
* @public
|
|
1594
1594
|
*/
|
|
1595
1595
|
nextToken?: string;
|
|
1596
1596
|
}
|
|
@@ -1599,22 +1599,22 @@ export interface ListPrivateGraphEndpointsOutput {
|
|
|
1599
1599
|
*/
|
|
1600
1600
|
export interface CreateGraphSnapshotInput {
|
|
1601
1601
|
/**
|
|
1602
|
-
* @public
|
|
1603
1602
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1603
|
+
* @public
|
|
1604
1604
|
*/
|
|
1605
1605
|
graphIdentifier: string | undefined;
|
|
1606
1606
|
/**
|
|
1607
|
-
* @public
|
|
1608
1607
|
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1609
1608
|
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1610
1609
|
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1611
1610
|
* consecutive hyphens.</p>
|
|
1611
|
+
* @public
|
|
1612
1612
|
*/
|
|
1613
1613
|
snapshotName: string | undefined;
|
|
1614
1614
|
/**
|
|
1615
|
-
* @public
|
|
1616
1615
|
* <p>Adds metadata tags to the new graph.
|
|
1617
1616
|
* These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
1617
|
+
* @public
|
|
1618
1618
|
*/
|
|
1619
1619
|
tags?: Record<string, string>;
|
|
1620
1620
|
}
|
|
@@ -1637,38 +1637,38 @@ export type SnapshotStatus = (typeof SnapshotStatus)[keyof typeof SnapshotStatus
|
|
|
1637
1637
|
*/
|
|
1638
1638
|
export interface CreateGraphSnapshotOutput {
|
|
1639
1639
|
/**
|
|
1640
|
-
* @public
|
|
1641
1640
|
* <p>The ID of the snapshot created.</p>
|
|
1641
|
+
* @public
|
|
1642
1642
|
*/
|
|
1643
1643
|
id: string | undefined;
|
|
1644
1644
|
/**
|
|
1645
|
-
* @public
|
|
1646
1645
|
* <p>The name of the snapshot created.</p>
|
|
1646
|
+
* @public
|
|
1647
1647
|
*/
|
|
1648
1648
|
name: string | undefined;
|
|
1649
1649
|
/**
|
|
1650
|
-
* @public
|
|
1651
1650
|
* <p>The ARN of the snapshot created.</p>
|
|
1651
|
+
* @public
|
|
1652
1652
|
*/
|
|
1653
1653
|
arn: string | undefined;
|
|
1654
1654
|
/**
|
|
1655
|
-
* @public
|
|
1656
1655
|
* <p>The Id of the Neptune Analytics graph from which the snapshot is created.</p>
|
|
1656
|
+
* @public
|
|
1657
1657
|
*/
|
|
1658
1658
|
sourceGraphId?: string;
|
|
1659
1659
|
/**
|
|
1660
|
-
* @public
|
|
1661
1660
|
* <p>The snapshot creation time</p>
|
|
1661
|
+
* @public
|
|
1662
1662
|
*/
|
|
1663
1663
|
snapshotCreateTime?: Date;
|
|
1664
1664
|
/**
|
|
1665
|
-
* @public
|
|
1666
1665
|
* <p>The current state of the snapshot.</p>
|
|
1666
|
+
* @public
|
|
1667
1667
|
*/
|
|
1668
1668
|
status?: SnapshotStatus;
|
|
1669
1669
|
/**
|
|
1670
|
-
* @public
|
|
1671
1670
|
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
1671
|
+
* @public
|
|
1672
1672
|
*/
|
|
1673
1673
|
kmsKeyIdentifier?: string;
|
|
1674
1674
|
}
|
|
@@ -1677,8 +1677,8 @@ export interface CreateGraphSnapshotOutput {
|
|
|
1677
1677
|
*/
|
|
1678
1678
|
export interface DeleteGraphSnapshotInput {
|
|
1679
1679
|
/**
|
|
1680
|
-
* @public
|
|
1681
1680
|
* <p>ID of the graph snapshot to be deleted.</p>
|
|
1681
|
+
* @public
|
|
1682
1682
|
*/
|
|
1683
1683
|
snapshotIdentifier: string | undefined;
|
|
1684
1684
|
}
|
|
@@ -1687,41 +1687,41 @@ export interface DeleteGraphSnapshotInput {
|
|
|
1687
1687
|
*/
|
|
1688
1688
|
export interface DeleteGraphSnapshotOutput {
|
|
1689
1689
|
/**
|
|
1690
|
-
* @public
|
|
1691
1690
|
* <p>The unique identifier of the graph snapshot.</p>
|
|
1691
|
+
* @public
|
|
1692
1692
|
*/
|
|
1693
1693
|
id: string | undefined;
|
|
1694
1694
|
/**
|
|
1695
|
-
* @public
|
|
1696
1695
|
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1697
1696
|
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1698
1697
|
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1699
1698
|
* consecutive hyphens.</p>
|
|
1699
|
+
* @public
|
|
1700
1700
|
*/
|
|
1701
1701
|
name: string | undefined;
|
|
1702
1702
|
/**
|
|
1703
|
-
* @public
|
|
1704
1703
|
* <p>The ARN of the graph snapshot.</p>
|
|
1704
|
+
* @public
|
|
1705
1705
|
*/
|
|
1706
1706
|
arn: string | undefined;
|
|
1707
1707
|
/**
|
|
1708
|
-
* @public
|
|
1709
1708
|
* <p>The graph identifier for the graph from which the snapshot was created.</p>
|
|
1709
|
+
* @public
|
|
1710
1710
|
*/
|
|
1711
1711
|
sourceGraphId?: string;
|
|
1712
1712
|
/**
|
|
1713
|
-
* @public
|
|
1714
1713
|
* <p>The time when the snapshot was created.</p>
|
|
1714
|
+
* @public
|
|
1715
1715
|
*/
|
|
1716
1716
|
snapshotCreateTime?: Date;
|
|
1717
1717
|
/**
|
|
1718
|
-
* @public
|
|
1719
1718
|
* <p>The status of the graph snapshot.</p>
|
|
1719
|
+
* @public
|
|
1720
1720
|
*/
|
|
1721
1721
|
status?: SnapshotStatus;
|
|
1722
1722
|
/**
|
|
1723
|
-
* @public
|
|
1724
1723
|
* <p>The ID of the KMS key used to encrypt and decrypt the snapshot.</p>
|
|
1724
|
+
* @public
|
|
1725
1725
|
*/
|
|
1726
1726
|
kmsKeyIdentifier?: string;
|
|
1727
1727
|
}
|
|
@@ -1730,8 +1730,8 @@ export interface DeleteGraphSnapshotOutput {
|
|
|
1730
1730
|
*/
|
|
1731
1731
|
export interface GetGraphSnapshotInput {
|
|
1732
1732
|
/**
|
|
1733
|
-
* @public
|
|
1734
1733
|
* <p>The ID of the snapshot to retrieve.</p>
|
|
1734
|
+
* @public
|
|
1735
1735
|
*/
|
|
1736
1736
|
snapshotIdentifier: string | undefined;
|
|
1737
1737
|
}
|
|
@@ -1740,41 +1740,41 @@ export interface GetGraphSnapshotInput {
|
|
|
1740
1740
|
*/
|
|
1741
1741
|
export interface GetGraphSnapshotOutput {
|
|
1742
1742
|
/**
|
|
1743
|
-
* @public
|
|
1744
1743
|
* <p>The unique identifier of the graph snapshot.</p>
|
|
1744
|
+
* @public
|
|
1745
1745
|
*/
|
|
1746
1746
|
id: string | undefined;
|
|
1747
1747
|
/**
|
|
1748
|
-
* @public
|
|
1749
1748
|
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1750
1749
|
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1751
1750
|
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1752
1751
|
* consecutive hyphens.</p>
|
|
1752
|
+
* @public
|
|
1753
1753
|
*/
|
|
1754
1754
|
name: string | undefined;
|
|
1755
1755
|
/**
|
|
1756
|
-
* @public
|
|
1757
1756
|
* <p>The ARN of the graph snapshot.</p>
|
|
1757
|
+
* @public
|
|
1758
1758
|
*/
|
|
1759
1759
|
arn: string | undefined;
|
|
1760
1760
|
/**
|
|
1761
|
-
* @public
|
|
1762
1761
|
* <p>The graph identifier for the graph for which a snapshot is to be created.</p>
|
|
1762
|
+
* @public
|
|
1763
1763
|
*/
|
|
1764
1764
|
sourceGraphId?: string;
|
|
1765
1765
|
/**
|
|
1766
|
-
* @public
|
|
1767
1766
|
* <p>The time when the snapshot was created.</p>
|
|
1767
|
+
* @public
|
|
1768
1768
|
*/
|
|
1769
1769
|
snapshotCreateTime?: Date;
|
|
1770
1770
|
/**
|
|
1771
|
-
* @public
|
|
1772
1771
|
* <p>The status of the graph snapshot.</p>
|
|
1772
|
+
* @public
|
|
1773
1773
|
*/
|
|
1774
1774
|
status?: SnapshotStatus;
|
|
1775
1775
|
/**
|
|
1776
|
-
* @public
|
|
1777
1776
|
* <p>The ID of the KMS key used to encrypt and decrypt the snapshot.</p>
|
|
1777
|
+
* @public
|
|
1778
1778
|
*/
|
|
1779
1779
|
kmsKeyIdentifier?: string;
|
|
1780
1780
|
}
|
|
@@ -1783,70 +1783,70 @@ export interface GetGraphSnapshotOutput {
|
|
|
1783
1783
|
*/
|
|
1784
1784
|
export interface ListGraphSnapshotsInput {
|
|
1785
1785
|
/**
|
|
1786
|
-
* @public
|
|
1787
1786
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1787
|
+
* @public
|
|
1788
1788
|
*/
|
|
1789
1789
|
graphIdentifier?: string;
|
|
1790
1790
|
/**
|
|
1791
|
-
* @public
|
|
1792
1791
|
* <p>Pagination token used to paginate output.</p>
|
|
1793
1792
|
* <p>When this value is provided as input, the service returns results from where
|
|
1794
1793
|
* the previous response left off. When this value is present in output, it indicates
|
|
1795
1794
|
* that there are more results to retrieve.</p>
|
|
1795
|
+
* @public
|
|
1796
1796
|
*/
|
|
1797
1797
|
nextToken?: string;
|
|
1798
1798
|
/**
|
|
1799
|
-
* @public
|
|
1800
1799
|
* <p>The total number of records to return in the command's output.</p>
|
|
1801
1800
|
* <p>If the total number of records available is more than the value specified,
|
|
1802
1801
|
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
1803
1802
|
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
1804
1803
|
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
1805
1804
|
* outside of the Amazon CLI.</p>
|
|
1805
|
+
* @public
|
|
1806
1806
|
*/
|
|
1807
1807
|
maxResults?: number;
|
|
1808
1808
|
}
|
|
1809
1809
|
/**
|
|
1810
|
-
* @public
|
|
1811
1810
|
* <p>Details about a graph snapshot.</p>
|
|
1811
|
+
* @public
|
|
1812
1812
|
*/
|
|
1813
1813
|
export interface GraphSnapshotSummary {
|
|
1814
1814
|
/**
|
|
1815
|
-
* @public
|
|
1816
1815
|
* <p>The unique identifier of the graph snapshot.</p>
|
|
1816
|
+
* @public
|
|
1817
1817
|
*/
|
|
1818
1818
|
id: string | undefined;
|
|
1819
1819
|
/**
|
|
1820
|
-
* @public
|
|
1821
1820
|
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1822
1821
|
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1823
1822
|
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1824
1823
|
* consecutive hyphens.</p>
|
|
1824
|
+
* @public
|
|
1825
1825
|
*/
|
|
1826
1826
|
name: string | undefined;
|
|
1827
1827
|
/**
|
|
1828
|
-
* @public
|
|
1829
1828
|
* <p>The ARN of the graph snapshot.</p>
|
|
1829
|
+
* @public
|
|
1830
1830
|
*/
|
|
1831
1831
|
arn: string | undefined;
|
|
1832
1832
|
/**
|
|
1833
|
-
* @public
|
|
1834
1833
|
* <p>The graph identifier for the graph for which a snapshot is to be created.</p>
|
|
1834
|
+
* @public
|
|
1835
1835
|
*/
|
|
1836
1836
|
sourceGraphId?: string;
|
|
1837
1837
|
/**
|
|
1838
|
-
* @public
|
|
1839
1838
|
* <p>The time when the snapshot was created.</p>
|
|
1839
|
+
* @public
|
|
1840
1840
|
*/
|
|
1841
1841
|
snapshotCreateTime?: Date;
|
|
1842
1842
|
/**
|
|
1843
|
-
* @public
|
|
1844
1843
|
* <p>The status of the graph snapshot.</p>
|
|
1844
|
+
* @public
|
|
1845
1845
|
*/
|
|
1846
1846
|
status?: SnapshotStatus;
|
|
1847
1847
|
/**
|
|
1848
|
-
* @public
|
|
1849
1848
|
* <p>The ID of the KMS key used to encrypt and decrypt the snapshot.</p>
|
|
1849
|
+
* @public
|
|
1850
1850
|
*/
|
|
1851
1851
|
kmsKeyIdentifier?: string;
|
|
1852
1852
|
}
|
|
@@ -1855,16 +1855,16 @@ export interface GraphSnapshotSummary {
|
|
|
1855
1855
|
*/
|
|
1856
1856
|
export interface ListGraphSnapshotsOutput {
|
|
1857
1857
|
/**
|
|
1858
|
-
* @public
|
|
1859
1858
|
* <p>The requested list of snapshots.</p>
|
|
1859
|
+
* @public
|
|
1860
1860
|
*/
|
|
1861
1861
|
graphSnapshots: GraphSnapshotSummary[] | undefined;
|
|
1862
1862
|
/**
|
|
1863
|
-
* @public
|
|
1864
1863
|
* <p>Pagination token used to paginate output.</p>
|
|
1865
1864
|
* <p>When this value is provided as input, the service returns results from where
|
|
1866
1865
|
* the previous response left off. When this value is present in output, it indicates
|
|
1867
1866
|
* that there are more results to retrieve.</p>
|
|
1867
|
+
* @public
|
|
1868
1868
|
*/
|
|
1869
1869
|
nextToken?: string;
|
|
1870
1870
|
}
|
|
@@ -1873,12 +1873,11 @@ export interface ListGraphSnapshotsOutput {
|
|
|
1873
1873
|
*/
|
|
1874
1874
|
export interface TagResourceInput {
|
|
1875
1875
|
/**
|
|
1876
|
-
* @public
|
|
1877
1876
|
* <p>ARN of the resource for which tags need to be added.</p>
|
|
1877
|
+
* @public
|
|
1878
1878
|
*/
|
|
1879
1879
|
resourceArn: string | undefined;
|
|
1880
1880
|
/**
|
|
1881
|
-
* @public
|
|
1882
1881
|
* <p>The tags to be assigned to the Neptune Analytics resource.</p>
|
|
1883
1882
|
* <p>The tags are metadata that are specified as a list of key-value pairs:</p>
|
|
1884
1883
|
* <p>
|
|
@@ -1895,6 +1894,7 @@ export interface TagResourceInput {
|
|
|
1895
1894
|
* prefixed with <code>aws:</code> and can only contain the
|
|
1896
1895
|
* set of Unicode characters specified by this Java regular expression:
|
|
1897
1896
|
* <code>"^([\p\{L\}\p\{Z\}\p\{N\}_.:/=+\-]*)$")</code>.</p>
|
|
1897
|
+
* @public
|
|
1898
1898
|
*/
|
|
1899
1899
|
tags: Record<string, string> | undefined;
|
|
1900
1900
|
}
|
|
@@ -1908,8 +1908,8 @@ export interface TagResourceOutput {
|
|
|
1908
1908
|
*/
|
|
1909
1909
|
export interface CancelImportTaskInput {
|
|
1910
1910
|
/**
|
|
1911
|
-
* @public
|
|
1912
1911
|
* <p>The unique identifier of the import task.</p>
|
|
1912
|
+
* @public
|
|
1913
1913
|
*/
|
|
1914
1914
|
taskIdentifier: string | undefined;
|
|
1915
1915
|
}
|
|
@@ -1950,76 +1950,76 @@ export type ImportTaskStatus = (typeof ImportTaskStatus)[keyof typeof ImportTask
|
|
|
1950
1950
|
*/
|
|
1951
1951
|
export interface CancelImportTaskOutput {
|
|
1952
1952
|
/**
|
|
1953
|
-
* @public
|
|
1954
1953
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1954
|
+
* @public
|
|
1955
1955
|
*/
|
|
1956
1956
|
graphId?: string;
|
|
1957
1957
|
/**
|
|
1958
|
-
* @public
|
|
1959
1958
|
* <p>The unique identifier of the import task.</p>
|
|
1959
|
+
* @public
|
|
1960
1960
|
*/
|
|
1961
1961
|
taskId: string | undefined;
|
|
1962
1962
|
/**
|
|
1963
|
-
* @public
|
|
1964
1963
|
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
1965
1964
|
* or can point to a Neptune database endpoint or snapshot.</p>
|
|
1965
|
+
* @public
|
|
1966
1966
|
*/
|
|
1967
1967
|
source: string | undefined;
|
|
1968
1968
|
/**
|
|
1969
|
-
* @public
|
|
1970
1969
|
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
1971
1970
|
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
1972
1971
|
* CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
1973
1972
|
* load format</a>.</p>
|
|
1973
|
+
* @public
|
|
1974
1974
|
*/
|
|
1975
1975
|
format?: Format;
|
|
1976
1976
|
/**
|
|
1977
|
-
* @public
|
|
1978
1977
|
* <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
|
|
1978
|
+
* @public
|
|
1979
1979
|
*/
|
|
1980
1980
|
roleArn: string | undefined;
|
|
1981
1981
|
/**
|
|
1982
|
-
* @public
|
|
1983
1982
|
* <p>Current status of the task. Status is CANCELLING when the import task is cancelled.</p>
|
|
1983
|
+
* @public
|
|
1984
1984
|
*/
|
|
1985
1985
|
status: ImportTaskStatus | undefined;
|
|
1986
1986
|
}
|
|
1987
1987
|
/**
|
|
1988
|
-
* @public
|
|
1989
1988
|
* <p>Options for how to import Neptune data.</p>
|
|
1989
|
+
* @public
|
|
1990
1990
|
*/
|
|
1991
1991
|
export interface NeptuneImportOptions {
|
|
1992
1992
|
/**
|
|
1993
|
-
* @public
|
|
1994
1993
|
* <p>The path to an S3 bucket from which to import data.</p>
|
|
1994
|
+
* @public
|
|
1995
1995
|
*/
|
|
1996
1996
|
s3ExportPath: string | undefined;
|
|
1997
1997
|
/**
|
|
1998
|
-
* @public
|
|
1999
1998
|
* <p>The KMS key to use to encrypt data in the S3 bucket where the graph data is exported</p>
|
|
1999
|
+
* @public
|
|
2000
2000
|
*/
|
|
2001
2001
|
s3ExportKmsKeyId: string | undefined;
|
|
2002
2002
|
/**
|
|
2003
|
-
* @public
|
|
2004
2003
|
* <p>Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly
|
|
2005
2004
|
* provided. Neptune assigns default labels when none is explicitly provided. When importing the data into
|
|
2006
2005
|
* Neptune Analytics, the default vertex labels can be omitted by setting
|
|
2007
2006
|
* <i>preserveDefaultVertexLabels</i> to false. Note that if the vertex only has default labels,
|
|
2008
2007
|
* and has no other properties or edges, then the vertex will effectively not get
|
|
2009
2008
|
* imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.</p>
|
|
2009
|
+
* @public
|
|
2010
2010
|
*/
|
|
2011
2011
|
preserveDefaultVertexLabels?: boolean;
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p>Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by
|
|
2015
2014
|
* default. They are imported if <i>preserveEdgeIds</i> is set to true, and ids are stored as
|
|
2016
2015
|
* properties on the relationships with the property name <i>neptuneEdgeId</i>.</p>
|
|
2016
|
+
* @public
|
|
2017
2017
|
*/
|
|
2018
2018
|
preserveEdgeIds?: boolean;
|
|
2019
2019
|
}
|
|
2020
2020
|
/**
|
|
2021
|
-
* @public
|
|
2022
2021
|
* <p>Options for how to perform an import.</p>
|
|
2022
|
+
* @public
|
|
2023
2023
|
*/
|
|
2024
2024
|
export type ImportOptions = ImportOptions.NeptuneMember | ImportOptions.$UnknownMember;
|
|
2025
2025
|
/**
|
|
@@ -2027,8 +2027,8 @@ export type ImportOptions = ImportOptions.NeptuneMember | ImportOptions.$Unknown
|
|
|
2027
2027
|
*/
|
|
2028
2028
|
export declare namespace ImportOptions {
|
|
2029
2029
|
/**
|
|
2030
|
-
* @public
|
|
2031
2030
|
* <p>Options for importing data from a Neptune database.</p>
|
|
2031
|
+
* @public
|
|
2032
2032
|
*/
|
|
2033
2033
|
interface NeptuneMember {
|
|
2034
2034
|
neptune: NeptuneImportOptions;
|
|
@@ -2052,92 +2052,92 @@ export declare namespace ImportOptions {
|
|
|
2052
2052
|
*/
|
|
2053
2053
|
export interface CreateGraphUsingImportTaskInput {
|
|
2054
2054
|
/**
|
|
2055
|
-
* @public
|
|
2056
2055
|
* <p>A name for the new Neptune Analytics graph to be created.</p>
|
|
2057
2056
|
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
2058
2057
|
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
2059
2058
|
* consecutive hyphens. </p>
|
|
2059
|
+
* @public
|
|
2060
2060
|
*/
|
|
2061
2061
|
graphName: string | undefined;
|
|
2062
2062
|
/**
|
|
2063
|
-
* @public
|
|
2064
2063
|
* <p>Adds metadata tags to the new graph. These tags can also be used with cost allocation
|
|
2065
2064
|
* reporting, or used in a Condition statement in an IAM policy.</p>
|
|
2065
|
+
* @public
|
|
2066
2066
|
*/
|
|
2067
2067
|
tags?: Record<string, string>;
|
|
2068
2068
|
/**
|
|
2069
|
-
* @public
|
|
2070
2069
|
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
|
|
2071
2070
|
* (<code>true</code> to enable, or <code>false</code> to disable).</p>
|
|
2071
|
+
* @public
|
|
2072
2072
|
*/
|
|
2073
2073
|
publicConnectivity?: boolean;
|
|
2074
2074
|
/**
|
|
2075
|
-
* @public
|
|
2076
2075
|
* <p>Specifies a KMS key to use to encrypt data imported into the new graph.</p>
|
|
2076
|
+
* @public
|
|
2077
2077
|
*/
|
|
2078
2078
|
kmsKeyIdentifier?: string;
|
|
2079
2079
|
/**
|
|
2080
|
-
* @public
|
|
2081
2080
|
* <p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph.
|
|
2082
2081
|
* The value is specified as <code>dimension=</code>value. Max = 65,535 </p>
|
|
2082
|
+
* @public
|
|
2083
2083
|
*/
|
|
2084
2084
|
vectorSearchConfiguration?: VectorSearchConfiguration;
|
|
2085
2085
|
/**
|
|
2086
|
-
* @public
|
|
2087
2086
|
* <p>The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.</p>
|
|
2087
|
+
* @public
|
|
2088
2088
|
*/
|
|
2089
2089
|
replicaCount?: number;
|
|
2090
2090
|
/**
|
|
2091
|
-
* @public
|
|
2092
2091
|
* <p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled.
|
|
2093
2092
|
* (<code>true</code> or <code>false</code>).</p>
|
|
2093
|
+
* @public
|
|
2094
2094
|
*/
|
|
2095
2095
|
deletionProtection?: boolean;
|
|
2096
2096
|
/**
|
|
2097
|
-
* @public
|
|
2098
2097
|
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key
|
|
2099
2098
|
* is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to
|
|
2100
2099
|
* <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is
|
|
2101
2100
|
* encountered.</p>
|
|
2101
|
+
* @public
|
|
2102
2102
|
*/
|
|
2103
2103
|
importOptions?: ImportOptions;
|
|
2104
2104
|
/**
|
|
2105
|
-
* @public
|
|
2106
2105
|
* <p>The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024,
|
|
2107
2106
|
* or the approved upper limit for your account.</p>
|
|
2108
2107
|
* <p> If both the minimum and maximum values are specified, the max of the
|
|
2109
2108
|
* <code>min-provisioned-memory</code> and <code>max-provisioned memory</code> is
|
|
2110
2109
|
* used to create the graph. If neither value is specified 128 m-NCUs are used.</p>
|
|
2110
|
+
* @public
|
|
2111
2111
|
*/
|
|
2112
2112
|
maxProvisionedMemory?: number;
|
|
2113
2113
|
/**
|
|
2114
|
-
* @public
|
|
2115
2114
|
* <p>The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 128</p>
|
|
2115
|
+
* @public
|
|
2116
2116
|
*/
|
|
2117
2117
|
minProvisionedMemory?: number;
|
|
2118
2118
|
/**
|
|
2119
|
-
* @public
|
|
2120
2119
|
* <p>If set to <code>true</code>, the task halts when an import error is encountered. If set to <code>false</code>,
|
|
2121
2120
|
* the task skips the data that caused the error and continues if possible.</p>
|
|
2121
|
+
* @public
|
|
2122
2122
|
*/
|
|
2123
2123
|
failOnError?: boolean;
|
|
2124
2124
|
/**
|
|
2125
|
-
* @public
|
|
2126
2125
|
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
2127
2126
|
* or can point to a Neptune database endpoint or snapshot.</p>
|
|
2127
|
+
* @public
|
|
2128
2128
|
*/
|
|
2129
2129
|
source: string | undefined;
|
|
2130
2130
|
/**
|
|
2131
|
-
* @public
|
|
2132
2131
|
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
2133
2132
|
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
2134
2133
|
* CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
2135
2134
|
* load format</a>.</p>
|
|
2135
|
+
* @public
|
|
2136
2136
|
*/
|
|
2137
2137
|
format?: Format;
|
|
2138
2138
|
/**
|
|
2139
|
-
* @public
|
|
2140
2139
|
* <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
|
|
2140
|
+
* @public
|
|
2141
2141
|
*/
|
|
2142
2142
|
roleArn: string | undefined;
|
|
2143
2143
|
}
|
|
@@ -2146,45 +2146,45 @@ export interface CreateGraphUsingImportTaskInput {
|
|
|
2146
2146
|
*/
|
|
2147
2147
|
export interface CreateGraphUsingImportTaskOutput {
|
|
2148
2148
|
/**
|
|
2149
|
-
* @public
|
|
2150
2149
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
2150
|
+
* @public
|
|
2151
2151
|
*/
|
|
2152
2152
|
graphId?: string;
|
|
2153
2153
|
/**
|
|
2154
|
-
* @public
|
|
2155
2154
|
* <p>The unique identifier of the import task.</p>
|
|
2155
|
+
* @public
|
|
2156
2156
|
*/
|
|
2157
2157
|
taskId: string | undefined;
|
|
2158
2158
|
/**
|
|
2159
|
-
* @public
|
|
2160
2159
|
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
2161
2160
|
* or can point to a Neptune database endpoint or snapshot.</p>
|
|
2161
|
+
* @public
|
|
2162
2162
|
*/
|
|
2163
2163
|
source: string | undefined;
|
|
2164
2164
|
/**
|
|
2165
|
-
* @public
|
|
2166
2165
|
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
2167
2166
|
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
2168
2167
|
* CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
2169
2168
|
* load format</a>.</p>
|
|
2169
|
+
* @public
|
|
2170
2170
|
*/
|
|
2171
2171
|
format?: Format;
|
|
2172
2172
|
/**
|
|
2173
|
-
* @public
|
|
2174
2173
|
* <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
|
|
2174
|
+
* @public
|
|
2175
2175
|
*/
|
|
2176
2176
|
roleArn: string | undefined;
|
|
2177
2177
|
/**
|
|
2178
|
-
* @public
|
|
2179
2178
|
* <p>The status of the import task.</p>
|
|
2179
|
+
* @public
|
|
2180
2180
|
*/
|
|
2181
2181
|
status: ImportTaskStatus | undefined;
|
|
2182
2182
|
/**
|
|
2183
|
-
* @public
|
|
2184
2183
|
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key
|
|
2185
2184
|
* is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to
|
|
2186
2185
|
* <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is
|
|
2187
2186
|
* encountered.</p>
|
|
2187
|
+
* @public
|
|
2188
2188
|
*/
|
|
2189
2189
|
importOptions?: ImportOptions;
|
|
2190
2190
|
}
|
|
@@ -2193,54 +2193,54 @@ export interface CreateGraphUsingImportTaskOutput {
|
|
|
2193
2193
|
*/
|
|
2194
2194
|
export interface GetImportTaskInput {
|
|
2195
2195
|
/**
|
|
2196
|
-
* @public
|
|
2197
2196
|
* <p>The unique identifier of the import task.</p>
|
|
2197
|
+
* @public
|
|
2198
2198
|
*/
|
|
2199
2199
|
taskIdentifier: string | undefined;
|
|
2200
2200
|
}
|
|
2201
2201
|
/**
|
|
2202
|
-
* @public
|
|
2203
2202
|
* <p>Contains details about an import task.</p>
|
|
2203
|
+
* @public
|
|
2204
2204
|
*/
|
|
2205
2205
|
export interface ImportTaskDetails {
|
|
2206
2206
|
/**
|
|
2207
|
-
* @public
|
|
2208
2207
|
* <p>Status of the import task.</p>
|
|
2208
|
+
* @public
|
|
2209
2209
|
*/
|
|
2210
2210
|
status: string | undefined;
|
|
2211
2211
|
/**
|
|
2212
|
-
* @public
|
|
2213
2212
|
* <p>Time at which the import task started.</p>
|
|
2213
|
+
* @public
|
|
2214
2214
|
*/
|
|
2215
2215
|
startTime: Date | undefined;
|
|
2216
2216
|
/**
|
|
2217
|
-
* @public
|
|
2218
2217
|
* <p>Seconds elapsed since the import task started.</p>
|
|
2218
|
+
* @public
|
|
2219
2219
|
*/
|
|
2220
2220
|
timeElapsedSeconds: number | undefined;
|
|
2221
2221
|
/**
|
|
2222
|
-
* @public
|
|
2223
2222
|
* <p>The percentage progress so far.</p>
|
|
2223
|
+
* @public
|
|
2224
2224
|
*/
|
|
2225
2225
|
progressPercentage: number | undefined;
|
|
2226
2226
|
/**
|
|
2227
|
-
* @public
|
|
2228
2227
|
* <p>The number of errors encountered so far.</p>
|
|
2228
|
+
* @public
|
|
2229
2229
|
*/
|
|
2230
2230
|
errorCount: number | undefined;
|
|
2231
2231
|
/**
|
|
2232
|
-
* @public
|
|
2233
2232
|
* <p>Details about the errors that have been encountered.</p>
|
|
2233
|
+
* @public
|
|
2234
2234
|
*/
|
|
2235
2235
|
errorDetails?: string;
|
|
2236
2236
|
/**
|
|
2237
|
-
* @public
|
|
2238
2237
|
* <p>The number of statements in the import task.</p>
|
|
2238
|
+
* @public
|
|
2239
2239
|
*/
|
|
2240
2240
|
statementCount: number | undefined;
|
|
2241
2241
|
/**
|
|
2242
|
-
* @public
|
|
2243
2242
|
* <p>The number of dictionary entries in the import task.</p>
|
|
2243
|
+
* @public
|
|
2244
2244
|
*/
|
|
2245
2245
|
dictionaryEntryCount: number | undefined;
|
|
2246
2246
|
}
|
|
@@ -2249,36 +2249,35 @@ export interface ImportTaskDetails {
|
|
|
2249
2249
|
*/
|
|
2250
2250
|
export interface GetImportTaskOutput {
|
|
2251
2251
|
/**
|
|
2252
|
-
* @public
|
|
2253
2252
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
2253
|
+
* @public
|
|
2254
2254
|
*/
|
|
2255
2255
|
graphId?: string;
|
|
2256
2256
|
/**
|
|
2257
|
-
* @public
|
|
2258
2257
|
* <p>The unique identifier of the import task.</p>
|
|
2258
|
+
* @public
|
|
2259
2259
|
*/
|
|
2260
2260
|
taskId: string | undefined;
|
|
2261
2261
|
/**
|
|
2262
|
-
* @public
|
|
2263
2262
|
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
2264
2263
|
* or can point to a Neptune database endpoint or snapshot</p>
|
|
2264
|
+
* @public
|
|
2265
2265
|
*/
|
|
2266
2266
|
source: string | undefined;
|
|
2267
2267
|
/**
|
|
2268
|
-
* @public
|
|
2269
2268
|
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
2270
2269
|
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
2271
2270
|
* CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
2272
2271
|
* load format</a>.</p>
|
|
2272
|
+
* @public
|
|
2273
2273
|
*/
|
|
2274
2274
|
format?: Format;
|
|
2275
2275
|
/**
|
|
2276
|
-
* @public
|
|
2277
2276
|
* <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
|
|
2277
|
+
* @public
|
|
2278
2278
|
*/
|
|
2279
2279
|
roleArn: string | undefined;
|
|
2280
2280
|
/**
|
|
2281
|
-
* @public
|
|
2282
2281
|
* <p>The status of the import task:</p>
|
|
2283
2282
|
* <ul>
|
|
2284
2283
|
* <li>
|
|
@@ -2337,29 +2336,30 @@ export interface GetImportTaskOutput {
|
|
|
2337
2336
|
* You have successfully cancelled the import task.</p>
|
|
2338
2337
|
* </li>
|
|
2339
2338
|
* </ul>
|
|
2339
|
+
* @public
|
|
2340
2340
|
*/
|
|
2341
2341
|
status: ImportTaskStatus | undefined;
|
|
2342
2342
|
/**
|
|
2343
|
-
* @public
|
|
2344
2343
|
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key
|
|
2345
2344
|
* is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to
|
|
2346
2345
|
* <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is
|
|
2347
2346
|
* encountered.</p>
|
|
2347
|
+
* @public
|
|
2348
2348
|
*/
|
|
2349
2349
|
importOptions?: ImportOptions;
|
|
2350
2350
|
/**
|
|
2351
|
-
* @public
|
|
2352
2351
|
* <p>Contains details about the specified import task.</p>
|
|
2352
|
+
* @public
|
|
2353
2353
|
*/
|
|
2354
2354
|
importTaskDetails?: ImportTaskDetails;
|
|
2355
2355
|
/**
|
|
2356
|
-
* @public
|
|
2357
2356
|
* <p>The number of the current attempt to execute the import task.</p>
|
|
2357
|
+
* @public
|
|
2358
2358
|
*/
|
|
2359
2359
|
attemptNumber?: number;
|
|
2360
2360
|
/**
|
|
2361
|
-
* @public
|
|
2362
2361
|
* <p>The reason that the import task has this status value.</p>
|
|
2362
|
+
* @public
|
|
2363
2363
|
*/
|
|
2364
2364
|
statusReason?: string;
|
|
2365
2365
|
}
|
|
@@ -2368,61 +2368,61 @@ export interface GetImportTaskOutput {
|
|
|
2368
2368
|
*/
|
|
2369
2369
|
export interface ListImportTasksInput {
|
|
2370
2370
|
/**
|
|
2371
|
-
* @public
|
|
2372
2371
|
* <p>Pagination token used to paginate output.</p>
|
|
2373
2372
|
* <p>When this value is provided as input, the service returns results from where
|
|
2374
2373
|
* the previous response left off. When this value is present in output, it indicates
|
|
2375
2374
|
* that there are more results to retrieve.</p>
|
|
2375
|
+
* @public
|
|
2376
2376
|
*/
|
|
2377
2377
|
nextToken?: string;
|
|
2378
2378
|
/**
|
|
2379
|
-
* @public
|
|
2380
2379
|
* <p>The total number of records to return in the command's output.</p>
|
|
2381
2380
|
* <p>If the total number of records available is more than the value specified,
|
|
2382
2381
|
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
2383
2382
|
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
2384
2383
|
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
2385
2384
|
* outside of the Amazon CLI.</p>
|
|
2385
|
+
* @public
|
|
2386
2386
|
*/
|
|
2387
2387
|
maxResults?: number;
|
|
2388
2388
|
}
|
|
2389
2389
|
/**
|
|
2390
|
-
* @public
|
|
2391
2390
|
* <p>Details about an import task.</p>
|
|
2391
|
+
* @public
|
|
2392
2392
|
*/
|
|
2393
2393
|
export interface ImportTaskSummary {
|
|
2394
2394
|
/**
|
|
2395
|
-
* @public
|
|
2396
2395
|
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
2396
|
+
* @public
|
|
2397
2397
|
*/
|
|
2398
2398
|
graphId?: string;
|
|
2399
2399
|
/**
|
|
2400
|
-
* @public
|
|
2401
2400
|
* <p>The unique identifier of the import task.</p>
|
|
2401
|
+
* @public
|
|
2402
2402
|
*/
|
|
2403
2403
|
taskId: string | undefined;
|
|
2404
2404
|
/**
|
|
2405
|
-
* @public
|
|
2406
2405
|
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
2407
2406
|
* or can point to a Neptune database endpoint or snapshot</p>
|
|
2407
|
+
* @public
|
|
2408
2408
|
*/
|
|
2409
2409
|
source: string | undefined;
|
|
2410
2410
|
/**
|
|
2411
|
-
* @public
|
|
2412
2411
|
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
2413
2412
|
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
2414
2413
|
* CSV format</a> or <code>OPENCYPHER</code>, which identies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
2415
2414
|
* load format</a>.</p>
|
|
2415
|
+
* @public
|
|
2416
2416
|
*/
|
|
2417
2417
|
format?: Format;
|
|
2418
2418
|
/**
|
|
2419
|
-
* @public
|
|
2420
2419
|
* <p>The ARN of the IAM role that will allow access to the data that is to be imported.</p>
|
|
2420
|
+
* @public
|
|
2421
2421
|
*/
|
|
2422
2422
|
roleArn: string | undefined;
|
|
2423
2423
|
/**
|
|
2424
|
-
* @public
|
|
2425
2424
|
* <p>Status of the import task.</p>
|
|
2425
|
+
* @public
|
|
2426
2426
|
*/
|
|
2427
2427
|
status: ImportTaskStatus | undefined;
|
|
2428
2428
|
}
|
|
@@ -2431,16 +2431,16 @@ export interface ImportTaskSummary {
|
|
|
2431
2431
|
*/
|
|
2432
2432
|
export interface ListImportTasksOutput {
|
|
2433
2433
|
/**
|
|
2434
|
-
* @public
|
|
2435
2434
|
* <p>The requested list of import tasks.</p>
|
|
2435
|
+
* @public
|
|
2436
2436
|
*/
|
|
2437
2437
|
tasks: ImportTaskSummary[] | undefined;
|
|
2438
2438
|
/**
|
|
2439
|
-
* @public
|
|
2440
2439
|
* <p>Pagination token used to paginate output.</p>
|
|
2441
2440
|
* <p>When this value is provided as input, the service returns results from where
|
|
2442
2441
|
* the previous response left off. When this value is present in output, it indicates
|
|
2443
2442
|
* that there are more results to retrieve.</p>
|
|
2443
|
+
* @public
|
|
2444
2444
|
*/
|
|
2445
2445
|
nextToken?: string;
|
|
2446
2446
|
}
|
|
@@ -2449,13 +2449,13 @@ export interface ListImportTasksOutput {
|
|
|
2449
2449
|
*/
|
|
2450
2450
|
export interface UntagResourceInput {
|
|
2451
2451
|
/**
|
|
2452
|
-
* @public
|
|
2453
2452
|
* <p>ARN of the resource whose tag needs to be removed.</p>
|
|
2453
|
+
* @public
|
|
2454
2454
|
*/
|
|
2455
2455
|
resourceArn: string | undefined;
|
|
2456
2456
|
/**
|
|
2457
|
-
* @public
|
|
2458
2457
|
* <p>Tag keys for the tags to be removed.</p>
|
|
2458
|
+
* @public
|
|
2459
2459
|
*/
|
|
2460
2460
|
tagKeys: string[] | undefined;
|
|
2461
2461
|
}
|