@aws-sdk/client-neptune-graph 3.876.0 → 3.879.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -3
- package/dist-cjs/index.js +175 -12
- package/dist-es/NeptuneGraph.js +4 -0
- package/dist-es/commands/StartGraphCommand.js +25 -0
- package/dist-es/commands/StopGraphCommand.js +25 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +74 -0
- package/dist-es/waiters/index.js +1 -0
- package/dist-es/waiters/waitForGraphStopped.js +40 -0
- package/dist-types/NeptuneGraph.d.ts +15 -3
- package/dist-types/NeptuneGraphClient.d.ts +5 -5
- package/dist-types/commands/CreateGraphCommand.d.ts +1 -1
- package/dist-types/commands/CreateGraphUsingImportTaskCommand.d.ts +1 -5
- package/dist-types/commands/CreatePrivateGraphEndpointCommand.d.ts +1 -5
- package/dist-types/commands/DeleteGraphCommand.d.ts +1 -1
- package/dist-types/commands/ExecuteQueryCommand.d.ts +1 -16
- package/dist-types/commands/GetGraphCommand.d.ts +1 -1
- package/dist-types/commands/GetQueryCommand.d.ts +1 -7
- package/dist-types/commands/ListGraphsCommand.d.ts +1 -1
- package/dist-types/commands/ResetGraphCommand.d.ts +1 -1
- package/dist-types/commands/RestoreGraphFromSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/StartGraphCommand.d.ts +103 -0
- package/dist-types/commands/StopGraphCommand.d.ts +103 -0
- package/dist-types/commands/UpdateGraphCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +1 -3
- package/dist-types/models/models_0.d.ts +268 -338
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/NeptuneGraph.d.ts +34 -0
- package/dist-types/ts3.4/NeptuneGraphClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/StartGraphCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/StopGraphCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +43 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/dist-types/ts3.4/waiters/index.d.ts +1 -0
- package/dist-types/ts3.4/waiters/waitForGraphStopped.d.ts +11 -0
- package/dist-types/waiters/index.d.ts +1 -0
- package/dist-types/waiters/waitForGraphStopped.d.ts +14 -0
- package/package.json +12 -12
|
@@ -191,16 +191,12 @@ export interface ExecuteQueryInput {
|
|
|
191
191
|
*/
|
|
192
192
|
parameters?: Record<string, __DocumentType> | undefined;
|
|
193
193
|
/**
|
|
194
|
-
* <p>Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query.
|
|
195
|
-
* This reduces query latency, and works for both <code>READ</code> and <code>UPDATE</code> queries. The plan cache is an
|
|
196
|
-
* LRU cache with a 5 minute TTL and a capacity of 1000.</p>
|
|
194
|
+
* <p>Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both <code>READ</code> and <code>UPDATE</code> queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.</p>
|
|
197
195
|
* @public
|
|
198
196
|
*/
|
|
199
197
|
planCache?: PlanCacheType | undefined;
|
|
200
198
|
/**
|
|
201
|
-
* <p>The explain mode parameter returns a query explain instead of the actual query results. A query explain can
|
|
202
|
-
* be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions
|
|
203
|
-
* flowing etc.</p>
|
|
199
|
+
* <p>The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.</p>
|
|
204
200
|
* @public
|
|
205
201
|
*/
|
|
206
202
|
explainMode?: ExplainMode | undefined;
|
|
@@ -274,8 +270,7 @@ export interface GetGraphSummaryInput {
|
|
|
274
270
|
*/
|
|
275
271
|
graphIdentifier: string | undefined;
|
|
276
272
|
/**
|
|
277
|
-
* <p>The summary mode can take one of two values: <code>basic</code> (the default), and
|
|
278
|
-
* <code>detailed</code>.</p>
|
|
273
|
+
* <p>The summary mode can take one of two values: <code>basic</code> (the default), and <code>detailed</code>.</p>
|
|
279
274
|
* @public
|
|
280
275
|
*/
|
|
281
276
|
mode?: GraphSummaryMode | undefined;
|
|
@@ -368,8 +363,7 @@ export interface GraphDataSummary {
|
|
|
368
363
|
*/
|
|
369
364
|
nodeProperties?: Record<string, number>[] | undefined;
|
|
370
365
|
/**
|
|
371
|
-
* <p>A list of the distinct edge properties in the graph, along with the count of edges
|
|
372
|
-
* where each property is used.</p>
|
|
366
|
+
* <p>A list of the distinct edge properties in the graph, along with the count of edges where each property is used.</p>
|
|
373
367
|
* @public
|
|
374
368
|
*/
|
|
375
369
|
edgeProperties?: Record<string, number>[] | undefined;
|
|
@@ -488,22 +482,17 @@ export interface VectorSearchConfiguration {
|
|
|
488
482
|
*/
|
|
489
483
|
export interface CreateGraphInput {
|
|
490
484
|
/**
|
|
491
|
-
* <p>A name for the new Neptune Analytics graph to be created.</p>
|
|
492
|
-
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
493
|
-
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
494
|
-
* consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
485
|
+
* <p>A name for the new Neptune Analytics graph to be created.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
495
486
|
* @public
|
|
496
487
|
*/
|
|
497
488
|
graphName: string | undefined;
|
|
498
489
|
/**
|
|
499
|
-
* <p>Adds metadata tags to the new graph.
|
|
500
|
-
* These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
490
|
+
* <p>Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
501
491
|
* @public
|
|
502
492
|
*/
|
|
503
493
|
tags?: Record<string, string> | undefined;
|
|
504
494
|
/**
|
|
505
|
-
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
|
|
506
|
-
* (<code>true</code> to enable, or <code>false</code> to disable.</p>
|
|
495
|
+
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable.</p>
|
|
507
496
|
* @public
|
|
508
497
|
*/
|
|
509
498
|
publicConnectivity?: boolean | undefined;
|
|
@@ -513,24 +502,17 @@ export interface CreateGraphInput {
|
|
|
513
502
|
*/
|
|
514
503
|
kmsKeyIdentifier?: string | undefined;
|
|
515
504
|
/**
|
|
516
|
-
* <p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph.
|
|
517
|
-
* The value is specified as <code>dimension=</code>value. Max = 65,535</p>
|
|
505
|
+
* <p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as <code>dimension=</code>value. Max = 65,535</p>
|
|
518
506
|
* @public
|
|
519
507
|
*/
|
|
520
508
|
vectorSearchConfiguration?: VectorSearchConfiguration | undefined;
|
|
521
509
|
/**
|
|
522
|
-
* <p>The number of replicas in other AZs. Min =0, Max = 2, Default = 1.</p>
|
|
523
|
-
* <important>
|
|
524
|
-
* <p>
|
|
525
|
-
* Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.
|
|
526
|
-
* </p>
|
|
527
|
-
* </important>
|
|
510
|
+
* <p>The number of replicas in other AZs. Min =0, Max = 2, Default = 1.</p> <important> <p> Additional charges equivalent to the m-NCUs selected for the graph apply for each replica. </p> </important>
|
|
528
511
|
* @public
|
|
529
512
|
*/
|
|
530
513
|
replicaCount?: number | undefined;
|
|
531
514
|
/**
|
|
532
|
-
* <p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled.
|
|
533
|
-
* (<code>true</code> or <code>false</code>).</p>
|
|
515
|
+
* <p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (<code>true</code> or <code>false</code>).</p>
|
|
534
516
|
* @public
|
|
535
517
|
*/
|
|
536
518
|
deletionProtection?: boolean | undefined;
|
|
@@ -552,6 +534,9 @@ export declare const GraphStatus: {
|
|
|
552
534
|
readonly IMPORTING: "IMPORTING";
|
|
553
535
|
readonly RESETTING: "RESETTING";
|
|
554
536
|
readonly SNAPSHOTTING: "SNAPSHOTTING";
|
|
537
|
+
readonly STARTING: "STARTING";
|
|
538
|
+
readonly STOPPED: "STOPPED";
|
|
539
|
+
readonly STOPPING: "STOPPING";
|
|
555
540
|
readonly UPDATING: "UPDATING";
|
|
556
541
|
};
|
|
557
542
|
/**
|
|
@@ -568,10 +553,7 @@ export interface CreateGraphOutput {
|
|
|
568
553
|
*/
|
|
569
554
|
id: string | undefined;
|
|
570
555
|
/**
|
|
571
|
-
* <p>The graph name. For example: <code>my-graph-1</code>.</p>
|
|
572
|
-
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
573
|
-
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
574
|
-
* consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
556
|
+
* <p>The graph name. For example: <code>my-graph-1</code>.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
575
557
|
* @public
|
|
576
558
|
*/
|
|
577
559
|
name: string | undefined;
|
|
@@ -596,8 +578,7 @@ export interface CreateGraphOutput {
|
|
|
596
578
|
*/
|
|
597
579
|
createTime?: Date | undefined;
|
|
598
580
|
/**
|
|
599
|
-
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p>
|
|
600
|
-
* <p>Min = 16</p>
|
|
581
|
+
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p> <p>Min = 16</p>
|
|
601
582
|
* @public
|
|
602
583
|
*/
|
|
603
584
|
provisionedMemory?: number | undefined;
|
|
@@ -607,22 +588,17 @@ export interface CreateGraphOutput {
|
|
|
607
588
|
*/
|
|
608
589
|
endpoint?: string | undefined;
|
|
609
590
|
/**
|
|
610
|
-
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.</p>
|
|
611
|
-
* <note>
|
|
612
|
-
* <p>If enabling public connectivity for the first time, there will be a delay while it is enabled.</p>
|
|
613
|
-
* </note>
|
|
591
|
+
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.</p> <note> <p>If enabling public connectivity for the first time, there will be a delay while it is enabled.</p> </note>
|
|
614
592
|
* @public
|
|
615
593
|
*/
|
|
616
594
|
publicConnectivity?: boolean | undefined;
|
|
617
595
|
/**
|
|
618
|
-
* <p>The vector-search configuration for the graph, which specifies the vector dimension
|
|
619
|
-
* to use in the vector index, if any.</p>
|
|
596
|
+
* <p>The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.</p>
|
|
620
597
|
* @public
|
|
621
598
|
*/
|
|
622
599
|
vectorSearchConfiguration?: VectorSearchConfiguration | undefined;
|
|
623
600
|
/**
|
|
624
|
-
* <p>The number of replicas in other AZs.</p>
|
|
625
|
-
* <p>Default: If not specified, the default value is 1.</p>
|
|
601
|
+
* <p>The number of replicas in other AZs.</p> <p>Default: If not specified, the default value is 1.</p>
|
|
626
602
|
* @public
|
|
627
603
|
*/
|
|
628
604
|
replicaCount?: number | undefined;
|
|
@@ -637,8 +613,7 @@ export interface CreateGraphOutput {
|
|
|
637
613
|
*/
|
|
638
614
|
sourceSnapshotId?: string | undefined;
|
|
639
615
|
/**
|
|
640
|
-
* <p>A value that indicates whether the graph has deletion protection enabled.
|
|
641
|
-
* The graph can't be deleted when deletion protection is enabled.</p>
|
|
616
|
+
* <p>A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.</p>
|
|
642
617
|
* @public
|
|
643
618
|
*/
|
|
644
619
|
deletionProtection?: boolean | undefined;
|
|
@@ -690,9 +665,7 @@ export interface DeleteGraphInput {
|
|
|
690
665
|
*/
|
|
691
666
|
graphIdentifier: string | undefined;
|
|
692
667
|
/**
|
|
693
|
-
* <p>Determines whether a final graph snapshot is created before the graph is deleted.
|
|
694
|
-
* If <code>true</code> is specified, no graph snapshot is created. If <code>false</code>
|
|
695
|
-
* is specified, a graph snapshot is created before the graph is deleted.</p>
|
|
668
|
+
* <p>Determines whether a final graph snapshot is created before the graph is deleted. If <code>true</code> is specified, no graph snapshot is created. If <code>false</code> is specified, a graph snapshot is created before the graph is deleted.</p>
|
|
696
669
|
* @public
|
|
697
670
|
*/
|
|
698
671
|
skipSnapshot: boolean | undefined;
|
|
@@ -872,20 +845,12 @@ export interface GetGraphOutput {
|
|
|
872
845
|
*/
|
|
873
846
|
export interface ListGraphsInput {
|
|
874
847
|
/**
|
|
875
|
-
* <p>Pagination token used to paginate output.</p>
|
|
876
|
-
* <p>When this value is provided as input, the service returns results from where
|
|
877
|
-
* the previous response left off. When this value is present in output, it indicates
|
|
878
|
-
* that there are more results to retrieve.</p>
|
|
848
|
+
* <p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>
|
|
879
849
|
* @public
|
|
880
850
|
*/
|
|
881
851
|
nextToken?: string | undefined;
|
|
882
852
|
/**
|
|
883
|
-
* <p>The total number of records to return in the command's output.</p>
|
|
884
|
-
* <p>If the total number of records available is more than the value specified,
|
|
885
|
-
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
886
|
-
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
887
|
-
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
888
|
-
* outside of the Amazon CLI.</p>
|
|
853
|
+
* <p>The total number of records to return in the command's output.</p> <p>If the total number of records available is more than the value specified, <code>nextToken</code> is provided in the command's output. To resume pagination, provide the <code>nextToken</code> output value in the <code>nextToken</code> argument of a subsequent command. Do not use the <code>nextToken</code> response element directly outside of the Amazon CLI.</p>
|
|
889
854
|
* @public
|
|
890
855
|
*/
|
|
891
856
|
maxResults?: number | undefined;
|
|
@@ -956,10 +921,7 @@ export interface ListGraphsOutput {
|
|
|
956
921
|
*/
|
|
957
922
|
graphs: GraphSummary[] | undefined;
|
|
958
923
|
/**
|
|
959
|
-
* <p>Pagination token used to paginate output.</p>
|
|
960
|
-
* <p>When this value is provided as input, the service returns results from where
|
|
961
|
-
* the previous response left off. When this value is present in output, it indicates
|
|
962
|
-
* that there are more results to retrieve.</p>
|
|
924
|
+
* <p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>
|
|
963
925
|
* @public
|
|
964
926
|
*/
|
|
965
927
|
nextToken?: string | undefined;
|
|
@@ -974,9 +936,7 @@ export interface ResetGraphInput {
|
|
|
974
936
|
*/
|
|
975
937
|
graphIdentifier: string | undefined;
|
|
976
938
|
/**
|
|
977
|
-
* <p>Determines whether a final graph snapshot is created before the graph data is deleted.
|
|
978
|
-
* If set to <code>true</code>, no graph snapshot is created. If set to <code>false</code>,
|
|
979
|
-
* a graph snapshot is created before the data is deleted.</p>
|
|
939
|
+
* <p>Determines whether a final graph snapshot is created before the graph data is deleted. If set to <code>true</code>, no graph snapshot is created. If set to <code>false</code>, a graph snapshot is created before the data is deleted.</p>
|
|
980
940
|
* @public
|
|
981
941
|
*/
|
|
982
942
|
skipSnapshot: boolean | undefined;
|
|
@@ -1071,44 +1031,32 @@ export interface RestoreGraphFromSnapshotInput {
|
|
|
1071
1031
|
*/
|
|
1072
1032
|
snapshotIdentifier: string | undefined;
|
|
1073
1033
|
/**
|
|
1074
|
-
* <p>A name for the new Neptune Analytics graph to be created from the snapshot.</p>
|
|
1075
|
-
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1076
|
-
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1077
|
-
* consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
1034
|
+
* <p>A name for the new Neptune Analytics graph to be created from the snapshot.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
1078
1035
|
* @public
|
|
1079
1036
|
*/
|
|
1080
1037
|
graphName: string | undefined;
|
|
1081
1038
|
/**
|
|
1082
|
-
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p>
|
|
1083
|
-
* <p>Min = 16</p>
|
|
1039
|
+
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p> <p>Min = 16</p>
|
|
1084
1040
|
* @public
|
|
1085
1041
|
*/
|
|
1086
1042
|
provisionedMemory?: number | undefined;
|
|
1087
1043
|
/**
|
|
1088
|
-
* <p>A value that indicates whether the graph has deletion protection enabled.
|
|
1089
|
-
* The graph can't be deleted when deletion protection is enabled.</p>
|
|
1044
|
+
* <p>A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.</p>
|
|
1090
1045
|
* @public
|
|
1091
1046
|
*/
|
|
1092
1047
|
deletionProtection?: boolean | undefined;
|
|
1093
1048
|
/**
|
|
1094
|
-
* <p>Adds metadata tags to the snapshot.
|
|
1095
|
-
* These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
1049
|
+
* <p>Adds metadata tags to the snapshot. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
1096
1050
|
* @public
|
|
1097
1051
|
*/
|
|
1098
1052
|
tags?: Record<string, string> | undefined;
|
|
1099
1053
|
/**
|
|
1100
|
-
* <p>The number of replicas in other AZs. Min =0, Max = 2, Default =1</p>
|
|
1101
|
-
* <important>
|
|
1102
|
-
* <p>
|
|
1103
|
-
* Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.
|
|
1104
|
-
* </p>
|
|
1105
|
-
* </important>
|
|
1054
|
+
* <p>The number of replicas in other AZs. Min =0, Max = 2, Default =1</p> <important> <p> Additional charges equivalent to the m-NCUs selected for the graph apply for each replica. </p> </important>
|
|
1106
1055
|
* @public
|
|
1107
1056
|
*/
|
|
1108
1057
|
replicaCount?: number | undefined;
|
|
1109
1058
|
/**
|
|
1110
|
-
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
|
|
1111
|
-
* (<code>true</code> to enable, or <code>false</code> to disable).</p>
|
|
1059
|
+
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable).</p>
|
|
1112
1060
|
* @public
|
|
1113
1061
|
*/
|
|
1114
1062
|
publicConnectivity?: boolean | undefined;
|
|
@@ -1193,6 +1141,186 @@ export interface RestoreGraphFromSnapshotOutput {
|
|
|
1193
1141
|
*/
|
|
1194
1142
|
buildNumber?: string | undefined;
|
|
1195
1143
|
}
|
|
1144
|
+
/**
|
|
1145
|
+
* @public
|
|
1146
|
+
*/
|
|
1147
|
+
export interface StartGraphInput {
|
|
1148
|
+
/**
|
|
1149
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1150
|
+
* @public
|
|
1151
|
+
*/
|
|
1152
|
+
graphIdentifier: string | undefined;
|
|
1153
|
+
}
|
|
1154
|
+
/**
|
|
1155
|
+
* @public
|
|
1156
|
+
*/
|
|
1157
|
+
export interface StartGraphOutput {
|
|
1158
|
+
/**
|
|
1159
|
+
* <p>The unique identifier of the graph.</p>
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1162
|
+
id: string | undefined;
|
|
1163
|
+
/**
|
|
1164
|
+
* <p>The name of the graph.</p>
|
|
1165
|
+
* @public
|
|
1166
|
+
*/
|
|
1167
|
+
name: string | undefined;
|
|
1168
|
+
/**
|
|
1169
|
+
* <p>The ARN associated with the graph.</p>
|
|
1170
|
+
* @public
|
|
1171
|
+
*/
|
|
1172
|
+
arn: string | undefined;
|
|
1173
|
+
/**
|
|
1174
|
+
* <p>The status of the graph.</p>
|
|
1175
|
+
* @public
|
|
1176
|
+
*/
|
|
1177
|
+
status?: GraphStatus | undefined;
|
|
1178
|
+
/**
|
|
1179
|
+
* <p>The reason that the graph has this status.</p>
|
|
1180
|
+
* @public
|
|
1181
|
+
*/
|
|
1182
|
+
statusReason?: string | undefined;
|
|
1183
|
+
/**
|
|
1184
|
+
* <p>The time at which the graph was created.</p>
|
|
1185
|
+
* @public
|
|
1186
|
+
*/
|
|
1187
|
+
createTime?: Date | undefined;
|
|
1188
|
+
/**
|
|
1189
|
+
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
1190
|
+
* @public
|
|
1191
|
+
*/
|
|
1192
|
+
provisionedMemory?: number | undefined;
|
|
1193
|
+
/**
|
|
1194
|
+
* <p>The graph endpoint.</p>
|
|
1195
|
+
* @public
|
|
1196
|
+
*/
|
|
1197
|
+
endpoint?: string | undefined;
|
|
1198
|
+
/**
|
|
1199
|
+
* <p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>
|
|
1200
|
+
* @public
|
|
1201
|
+
*/
|
|
1202
|
+
publicConnectivity?: boolean | undefined;
|
|
1203
|
+
/**
|
|
1204
|
+
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
1205
|
+
* @public
|
|
1206
|
+
*/
|
|
1207
|
+
vectorSearchConfiguration?: VectorSearchConfiguration | undefined;
|
|
1208
|
+
/**
|
|
1209
|
+
* <p>The number of replicas for the graph.</p>
|
|
1210
|
+
* @public
|
|
1211
|
+
*/
|
|
1212
|
+
replicaCount?: number | undefined;
|
|
1213
|
+
/**
|
|
1214
|
+
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
1215
|
+
* @public
|
|
1216
|
+
*/
|
|
1217
|
+
kmsKeyIdentifier?: string | undefined;
|
|
1218
|
+
/**
|
|
1219
|
+
* <p>The ID of the snapshot from which the graph was created, if it was created from a snapshot.</p>
|
|
1220
|
+
* @public
|
|
1221
|
+
*/
|
|
1222
|
+
sourceSnapshotId?: string | undefined;
|
|
1223
|
+
/**
|
|
1224
|
+
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
1225
|
+
* @public
|
|
1226
|
+
*/
|
|
1227
|
+
deletionProtection?: boolean | undefined;
|
|
1228
|
+
/**
|
|
1229
|
+
* <p>The build number of the graph.</p>
|
|
1230
|
+
* @public
|
|
1231
|
+
*/
|
|
1232
|
+
buildNumber?: string | undefined;
|
|
1233
|
+
}
|
|
1234
|
+
/**
|
|
1235
|
+
* @public
|
|
1236
|
+
*/
|
|
1237
|
+
export interface StopGraphInput {
|
|
1238
|
+
/**
|
|
1239
|
+
* <p>The unique identifier of the Neptune Analytics graph.</p>
|
|
1240
|
+
* @public
|
|
1241
|
+
*/
|
|
1242
|
+
graphIdentifier: string | undefined;
|
|
1243
|
+
}
|
|
1244
|
+
/**
|
|
1245
|
+
* @public
|
|
1246
|
+
*/
|
|
1247
|
+
export interface StopGraphOutput {
|
|
1248
|
+
/**
|
|
1249
|
+
* <p>The unique identifier of the graph.</p>
|
|
1250
|
+
* @public
|
|
1251
|
+
*/
|
|
1252
|
+
id: string | undefined;
|
|
1253
|
+
/**
|
|
1254
|
+
* <p>The name of the graph.</p>
|
|
1255
|
+
* @public
|
|
1256
|
+
*/
|
|
1257
|
+
name: string | undefined;
|
|
1258
|
+
/**
|
|
1259
|
+
* <p>The ARN associated with the graph.</p>
|
|
1260
|
+
* @public
|
|
1261
|
+
*/
|
|
1262
|
+
arn: string | undefined;
|
|
1263
|
+
/**
|
|
1264
|
+
* <p>The status of the graph.</p>
|
|
1265
|
+
* @public
|
|
1266
|
+
*/
|
|
1267
|
+
status?: GraphStatus | undefined;
|
|
1268
|
+
/**
|
|
1269
|
+
* <p>The reason that the graph has this status.</p>
|
|
1270
|
+
* @public
|
|
1271
|
+
*/
|
|
1272
|
+
statusReason?: string | undefined;
|
|
1273
|
+
/**
|
|
1274
|
+
* <p>The time at which the graph was created.</p>
|
|
1275
|
+
* @public
|
|
1276
|
+
*/
|
|
1277
|
+
createTime?: Date | undefined;
|
|
1278
|
+
/**
|
|
1279
|
+
* <p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>
|
|
1280
|
+
* @public
|
|
1281
|
+
*/
|
|
1282
|
+
provisionedMemory?: number | undefined;
|
|
1283
|
+
/**
|
|
1284
|
+
* <p>The graph endpoint.</p>
|
|
1285
|
+
* @public
|
|
1286
|
+
*/
|
|
1287
|
+
endpoint?: string | undefined;
|
|
1288
|
+
/**
|
|
1289
|
+
* <p>If true, the graph has a public endpoint, otherwise not.</p>
|
|
1290
|
+
* @public
|
|
1291
|
+
*/
|
|
1292
|
+
publicConnectivity?: boolean | undefined;
|
|
1293
|
+
/**
|
|
1294
|
+
* <p>Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535</p>
|
|
1295
|
+
* @public
|
|
1296
|
+
*/
|
|
1297
|
+
vectorSearchConfiguration?: VectorSearchConfiguration | undefined;
|
|
1298
|
+
/**
|
|
1299
|
+
* <p>The number of replicas for the graph.</p>
|
|
1300
|
+
* @public
|
|
1301
|
+
*/
|
|
1302
|
+
replicaCount?: number | undefined;
|
|
1303
|
+
/**
|
|
1304
|
+
* <p>The ID of the KMS key used to encrypt and decrypt graph data.</p>
|
|
1305
|
+
* @public
|
|
1306
|
+
*/
|
|
1307
|
+
kmsKeyIdentifier?: string | undefined;
|
|
1308
|
+
/**
|
|
1309
|
+
* <p>The ID of the snapshot from which the graph was created, if it was created from a snapshot.</p>
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
sourceSnapshotId?: string | undefined;
|
|
1313
|
+
/**
|
|
1314
|
+
* <p>If <code>true</code>, deletion protection is enabled for the graph.</p>
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
deletionProtection?: boolean | undefined;
|
|
1318
|
+
/**
|
|
1319
|
+
* <p>The build number of the graph.</p>
|
|
1320
|
+
* @public
|
|
1321
|
+
*/
|
|
1322
|
+
buildNumber?: string | undefined;
|
|
1323
|
+
}
|
|
1196
1324
|
/**
|
|
1197
1325
|
* @public
|
|
1198
1326
|
*/
|
|
@@ -1203,20 +1331,17 @@ export interface UpdateGraphInput {
|
|
|
1203
1331
|
*/
|
|
1204
1332
|
graphIdentifier: string | undefined;
|
|
1205
1333
|
/**
|
|
1206
|
-
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
|
|
1207
|
-
* (<code>true</code> to enable, or <code>false</code> to disable.</p>
|
|
1334
|
+
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable.</p>
|
|
1208
1335
|
* @public
|
|
1209
1336
|
*/
|
|
1210
1337
|
publicConnectivity?: boolean | undefined;
|
|
1211
1338
|
/**
|
|
1212
|
-
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p>
|
|
1213
|
-
* <p>Min = 16</p>
|
|
1339
|
+
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p> <p>Min = 16</p>
|
|
1214
1340
|
* @public
|
|
1215
1341
|
*/
|
|
1216
1342
|
provisionedMemory?: number | undefined;
|
|
1217
1343
|
/**
|
|
1218
|
-
* <p>A value that indicates whether the graph has deletion protection enabled.
|
|
1219
|
-
* The graph can't be deleted when deletion protection is enabled.</p>
|
|
1344
|
+
* <p>A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.</p>
|
|
1220
1345
|
* @public
|
|
1221
1346
|
*/
|
|
1222
1347
|
deletionProtection?: boolean | undefined;
|
|
@@ -1550,20 +1675,12 @@ export interface ListPrivateGraphEndpointsInput {
|
|
|
1550
1675
|
*/
|
|
1551
1676
|
graphIdentifier: string | undefined;
|
|
1552
1677
|
/**
|
|
1553
|
-
* <p>Pagination token used to paginate output.</p>
|
|
1554
|
-
* <p>When this value is provided as input, the service returns results from where
|
|
1555
|
-
* the previous response left off. When this value is present in output, it indicates
|
|
1556
|
-
* that there are more results to retrieve.</p>
|
|
1678
|
+
* <p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>
|
|
1557
1679
|
* @public
|
|
1558
1680
|
*/
|
|
1559
1681
|
nextToken?: string | undefined;
|
|
1560
1682
|
/**
|
|
1561
|
-
* <p>The total number of records to return in the command's output.</p>
|
|
1562
|
-
* <p>If the total number of records available is more than the value specified,
|
|
1563
|
-
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
1564
|
-
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
1565
|
-
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
1566
|
-
* outside of the Amazon CLI.</p>
|
|
1683
|
+
* <p>The total number of records to return in the command's output.</p> <p>If the total number of records available is more than the value specified, <code>nextToken</code> is provided in the command's output. To resume pagination, provide the <code>nextToken</code> output value in the <code>nextToken</code> argument of a subsequent command. Do not use the <code>nextToken</code> response element directly outside of the Amazon CLI.</p>
|
|
1567
1684
|
* @public
|
|
1568
1685
|
*/
|
|
1569
1686
|
maxResults?: number | undefined;
|
|
@@ -1604,10 +1721,7 @@ export interface ListPrivateGraphEndpointsOutput {
|
|
|
1604
1721
|
*/
|
|
1605
1722
|
privateGraphEndpoints: PrivateGraphEndpointSummary[] | undefined;
|
|
1606
1723
|
/**
|
|
1607
|
-
* <p>Pagination token used to paginate output.</p>
|
|
1608
|
-
* <p>When this value is provided as input, the service returns results from where
|
|
1609
|
-
* the previous response left off. When this value is present in output, it indicates
|
|
1610
|
-
* that there are more results to retrieve.</p>
|
|
1724
|
+
* <p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>
|
|
1611
1725
|
* @public
|
|
1612
1726
|
*/
|
|
1613
1727
|
nextToken?: string | undefined;
|
|
@@ -1622,16 +1736,12 @@ export interface CreateGraphSnapshotInput {
|
|
|
1622
1736
|
*/
|
|
1623
1737
|
graphIdentifier: string | undefined;
|
|
1624
1738
|
/**
|
|
1625
|
-
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1626
|
-
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1627
|
-
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1628
|
-
* consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
1739
|
+
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
1629
1740
|
* @public
|
|
1630
1741
|
*/
|
|
1631
1742
|
snapshotName: string | undefined;
|
|
1632
1743
|
/**
|
|
1633
|
-
* <p>Adds metadata tags to the new graph.
|
|
1634
|
-
* These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
1744
|
+
* <p>Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
1635
1745
|
* @public
|
|
1636
1746
|
*/
|
|
1637
1747
|
tags?: Record<string, string> | undefined;
|
|
@@ -1710,10 +1820,7 @@ export interface DeleteGraphSnapshotOutput {
|
|
|
1710
1820
|
*/
|
|
1711
1821
|
id: string | undefined;
|
|
1712
1822
|
/**
|
|
1713
|
-
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1714
|
-
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1715
|
-
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1716
|
-
* consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
1823
|
+
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
1717
1824
|
* @public
|
|
1718
1825
|
*/
|
|
1719
1826
|
name: string | undefined;
|
|
@@ -1763,10 +1870,7 @@ export interface GetGraphSnapshotOutput {
|
|
|
1763
1870
|
*/
|
|
1764
1871
|
id: string | undefined;
|
|
1765
1872
|
/**
|
|
1766
|
-
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1767
|
-
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1768
|
-
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1769
|
-
* consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
1873
|
+
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
1770
1874
|
* @public
|
|
1771
1875
|
*/
|
|
1772
1876
|
name: string | undefined;
|
|
@@ -1806,20 +1910,12 @@ export interface ListGraphSnapshotsInput {
|
|
|
1806
1910
|
*/
|
|
1807
1911
|
graphIdentifier?: string | undefined;
|
|
1808
1912
|
/**
|
|
1809
|
-
* <p>Pagination token used to paginate output.</p>
|
|
1810
|
-
* <p>When this value is provided as input, the service returns results from where
|
|
1811
|
-
* the previous response left off. When this value is present in output, it indicates
|
|
1812
|
-
* that there are more results to retrieve.</p>
|
|
1913
|
+
* <p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>
|
|
1813
1914
|
* @public
|
|
1814
1915
|
*/
|
|
1815
1916
|
nextToken?: string | undefined;
|
|
1816
1917
|
/**
|
|
1817
|
-
* <p>The total number of records to return in the command's output.</p>
|
|
1818
|
-
* <p>If the total number of records available is more than the value specified,
|
|
1819
|
-
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
1820
|
-
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
1821
|
-
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
1822
|
-
* outside of the Amazon CLI.</p>
|
|
1918
|
+
* <p>The total number of records to return in the command's output.</p> <p>If the total number of records available is more than the value specified, <code>nextToken</code> is provided in the command's output. To resume pagination, provide the <code>nextToken</code> output value in the <code>nextToken</code> argument of a subsequent command. Do not use the <code>nextToken</code> response element directly outside of the Amazon CLI.</p>
|
|
1823
1919
|
* @public
|
|
1824
1920
|
*/
|
|
1825
1921
|
maxResults?: number | undefined;
|
|
@@ -1835,10 +1931,7 @@ export interface GraphSnapshotSummary {
|
|
|
1835
1931
|
*/
|
|
1836
1932
|
id: string | undefined;
|
|
1837
1933
|
/**
|
|
1838
|
-
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p>
|
|
1839
|
-
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
1840
|
-
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
1841
|
-
* consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
1934
|
+
* <p>The snapshot name. For example: <code>my-snapshot-1</code>.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
1842
1935
|
* @public
|
|
1843
1936
|
*/
|
|
1844
1937
|
name: string | undefined;
|
|
@@ -1878,10 +1971,7 @@ export interface ListGraphSnapshotsOutput {
|
|
|
1878
1971
|
*/
|
|
1879
1972
|
graphSnapshots: GraphSnapshotSummary[] | undefined;
|
|
1880
1973
|
/**
|
|
1881
|
-
* <p>Pagination token used to paginate output.</p>
|
|
1882
|
-
* <p>When this value is provided as input, the service returns results from where
|
|
1883
|
-
* the previous response left off. When this value is present in output, it indicates
|
|
1884
|
-
* that there are more results to retrieve.</p>
|
|
1974
|
+
* <p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>
|
|
1885
1975
|
* @public
|
|
1886
1976
|
*/
|
|
1887
1977
|
nextToken?: string | undefined;
|
|
@@ -1896,22 +1986,7 @@ export interface TagResourceInput {
|
|
|
1896
1986
|
*/
|
|
1897
1987
|
resourceArn: string | undefined;
|
|
1898
1988
|
/**
|
|
1899
|
-
* <p>The tags to be assigned to the Neptune Analytics resource.</p>
|
|
1900
|
-
* <p>The tags are metadata that are specified as a list of key-value pairs:</p>
|
|
1901
|
-
* <p>
|
|
1902
|
-
* <b>Key</b> (string) –
|
|
1903
|
-
* A key is the required name of the tag. The string value can be
|
|
1904
|
-
* from 1 to 128 Unicode characters in length. It can't be
|
|
1905
|
-
* prefixed with <code>aws:</code> and can only contain the
|
|
1906
|
-
* set of Unicode characters specified by this Java regular expression:
|
|
1907
|
-
* <code>"^([\p\{L\}\p\{Z\}\p\{N\}_.:/=+\-]*)$")</code>.</p>
|
|
1908
|
-
* <p>
|
|
1909
|
-
* <b>Value</b> (string) –
|
|
1910
|
-
* A value is the optional value of the tag. The string value can
|
|
1911
|
-
* be from 1 to 256 Unicode characters in length. It can't be
|
|
1912
|
-
* prefixed with <code>aws:</code> and can only contain the
|
|
1913
|
-
* set of Unicode characters specified by this Java regular expression:
|
|
1914
|
-
* <code>"^([\p\{L\}\p\{Z\}\p\{N\}_.:/=+\-]*)$")</code>.</p>
|
|
1989
|
+
* <p>The tags to be assigned to the Neptune Analytics resource.</p> <p>The tags are metadata that are specified as a list of key-value pairs:</p> <p> <b>Key</b> (string) – A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length. It can't be prefixed with <code>aws:</code> and can only contain the set of Unicode characters specified by this Java regular expression: <code>"^([\p\{L\}\p\{Z\}\p\{N\}_.:/=+\-]*)$")</code>.</p> <p> <b>Value</b> (string) – A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length. It can't be prefixed with <code>aws:</code> and can only contain the set of Unicode characters specified by this Java regular expression: <code>"^([\p\{L\}\p\{Z\}\p\{N\}_.:/=+\-]*)$")</code>.</p>
|
|
1915
1990
|
* @public
|
|
1916
1991
|
*/
|
|
1917
1992
|
tags: Record<string, string> | undefined;
|
|
@@ -1991,8 +2066,7 @@ export interface CancelExportTaskOutput {
|
|
|
1991
2066
|
*/
|
|
1992
2067
|
taskId: string | undefined;
|
|
1993
2068
|
/**
|
|
1994
|
-
* <p>The current status of the export task. The status is <code>CANCELLING</code> when the
|
|
1995
|
-
* export task is cancelled.</p>
|
|
2069
|
+
* <p>The current status of the export task. The status is <code>CANCELLING</code> when the export task is cancelled.</p>
|
|
1996
2070
|
* @public
|
|
1997
2071
|
*/
|
|
1998
2072
|
status: ExportTaskStatus | undefined;
|
|
@@ -2082,16 +2156,12 @@ export interface CancelImportTaskOutput {
|
|
|
2082
2156
|
*/
|
|
2083
2157
|
taskId: string | undefined;
|
|
2084
2158
|
/**
|
|
2085
|
-
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
2086
|
-
* or can point to a Neptune database endpoint or snapshot.</p>
|
|
2159
|
+
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.</p>
|
|
2087
2160
|
* @public
|
|
2088
2161
|
*/
|
|
2089
2162
|
source: string | undefined;
|
|
2090
2163
|
/**
|
|
2091
|
-
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
2092
|
-
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
2093
|
-
* 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
|
|
2094
|
-
* load format</a>.</p>
|
|
2164
|
+
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin 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 load format</a>.</p>
|
|
2095
2165
|
* @public
|
|
2096
2166
|
*/
|
|
2097
2167
|
format?: Format | undefined;
|
|
@@ -2138,19 +2208,12 @@ export interface NeptuneImportOptions {
|
|
|
2138
2208
|
*/
|
|
2139
2209
|
s3ExportKmsKeyId: string | undefined;
|
|
2140
2210
|
/**
|
|
2141
|
-
* <p>Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly
|
|
2142
|
-
* provided. Neptune assigns default labels when none is explicitly provided. When importing the data into
|
|
2143
|
-
* Neptune Analytics, the default vertex labels can be omitted by setting
|
|
2144
|
-
* <i>preserveDefaultVertexLabels</i> to false. Note that if the vertex only has default labels,
|
|
2145
|
-
* and has no other properties or edges, then the vertex will effectively not get
|
|
2146
|
-
* imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.</p>
|
|
2211
|
+
* <p>Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided. Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting <i>preserveDefaultVertexLabels</i> to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.</p>
|
|
2147
2212
|
* @public
|
|
2148
2213
|
*/
|
|
2149
2214
|
preserveDefaultVertexLabels?: boolean | undefined;
|
|
2150
2215
|
/**
|
|
2151
|
-
* <p>Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by
|
|
2152
|
-
* default. They are imported if <i>preserveEdgeIds</i> is set to true, and ids are stored as
|
|
2153
|
-
* properties on the relationships with the property name <i>neptuneEdgeId</i>.</p>
|
|
2216
|
+
* <p>Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by default. They are imported if <i>preserveEdgeIds</i> is set to true, and ids are stored as properties on the relationships with the property name <i>neptuneEdgeId</i>.</p>
|
|
2154
2217
|
* @public
|
|
2155
2218
|
*/
|
|
2156
2219
|
preserveEdgeIds?: boolean | undefined;
|
|
@@ -2190,22 +2253,17 @@ export declare namespace ImportOptions {
|
|
|
2190
2253
|
*/
|
|
2191
2254
|
export interface CreateGraphUsingImportTaskInput {
|
|
2192
2255
|
/**
|
|
2193
|
-
* <p>A name for the new Neptune Analytics graph to be created.</p>
|
|
2194
|
-
* <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its
|
|
2195
|
-
* first character must be a letter. It cannot end with a hyphen or contain two
|
|
2196
|
-
* consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
2256
|
+
* <p>A name for the new Neptune Analytics graph to be created.</p> <p>The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.</p>
|
|
2197
2257
|
* @public
|
|
2198
2258
|
*/
|
|
2199
2259
|
graphName: string | undefined;
|
|
2200
2260
|
/**
|
|
2201
|
-
* <p>Adds metadata tags to the new graph. These tags can also be used with cost allocation
|
|
2202
|
-
* reporting, or used in a Condition statement in an IAM policy.</p>
|
|
2261
|
+
* <p>Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.</p>
|
|
2203
2262
|
* @public
|
|
2204
2263
|
*/
|
|
2205
2264
|
tags?: Record<string, string> | undefined;
|
|
2206
2265
|
/**
|
|
2207
|
-
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
|
|
2208
|
-
* (<code>true</code> to enable, or <code>false</code> to disable).</p>
|
|
2266
|
+
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable).</p>
|
|
2209
2267
|
* @public
|
|
2210
2268
|
*/
|
|
2211
2269
|
publicConnectivity?: boolean | undefined;
|
|
@@ -2215,41 +2273,27 @@ export interface CreateGraphUsingImportTaskInput {
|
|
|
2215
2273
|
*/
|
|
2216
2274
|
kmsKeyIdentifier?: string | undefined;
|
|
2217
2275
|
/**
|
|
2218
|
-
* <p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph.
|
|
2219
|
-
* The value is specified as <code>dimension=</code>value. Max = 65,535 </p>
|
|
2276
|
+
* <p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as <code>dimension=</code>value. Max = 65,535 </p>
|
|
2220
2277
|
* @public
|
|
2221
2278
|
*/
|
|
2222
2279
|
vectorSearchConfiguration?: VectorSearchConfiguration | undefined;
|
|
2223
2280
|
/**
|
|
2224
|
-
* <p>The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.</p>
|
|
2225
|
-
* <important>
|
|
2226
|
-
* <p>
|
|
2227
|
-
* Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.
|
|
2228
|
-
* </p>
|
|
2229
|
-
* </important>
|
|
2281
|
+
* <p>The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.</p> <important> <p> Additional charges equivalent to the m-NCUs selected for the graph apply for each replica. </p> </important>
|
|
2230
2282
|
* @public
|
|
2231
2283
|
*/
|
|
2232
2284
|
replicaCount?: number | undefined;
|
|
2233
2285
|
/**
|
|
2234
|
-
* <p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled.
|
|
2235
|
-
* (<code>true</code> or <code>false</code>).</p>
|
|
2286
|
+
* <p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (<code>true</code> or <code>false</code>).</p>
|
|
2236
2287
|
* @public
|
|
2237
2288
|
*/
|
|
2238
2289
|
deletionProtection?: boolean | undefined;
|
|
2239
2290
|
/**
|
|
2240
|
-
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key
|
|
2241
|
-
* is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to
|
|
2242
|
-
* <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is
|
|
2243
|
-
* encountered.</p>
|
|
2291
|
+
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is encountered.</p>
|
|
2244
2292
|
* @public
|
|
2245
2293
|
*/
|
|
2246
2294
|
importOptions?: ImportOptions | undefined;
|
|
2247
2295
|
/**
|
|
2248
|
-
* <p>The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024,
|
|
2249
|
-
* or the approved upper limit for your account.</p>
|
|
2250
|
-
* <p> If both the minimum and maximum values are specified, the final
|
|
2251
|
-
* <code>provisioned-memory</code> will be chosen per the actual size of your imported data. If neither value is specified,
|
|
2252
|
-
* 128 m-NCUs are used.</p>
|
|
2296
|
+
* <p>The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account.</p> <p> If both the minimum and maximum values are specified, the final <code>provisioned-memory</code> will be chosen per the actual size of your imported data. If neither value is specified, 128 m-NCUs are used.</p>
|
|
2253
2297
|
* @public
|
|
2254
2298
|
*/
|
|
2255
2299
|
maxProvisionedMemory?: number | undefined;
|
|
@@ -2259,23 +2303,17 @@ export interface CreateGraphUsingImportTaskInput {
|
|
|
2259
2303
|
*/
|
|
2260
2304
|
minProvisionedMemory?: number | undefined;
|
|
2261
2305
|
/**
|
|
2262
|
-
* <p>If set to <code>true</code>, the task halts when an import error is encountered. If set to <code>false</code>,
|
|
2263
|
-
* the task skips the data that caused the error and continues if possible.</p>
|
|
2306
|
+
* <p>If set to <code>true</code>, the task halts when an import error is encountered. If set to <code>false</code>, the task skips the data that caused the error and continues if possible.</p>
|
|
2264
2307
|
* @public
|
|
2265
2308
|
*/
|
|
2266
2309
|
failOnError?: boolean | undefined;
|
|
2267
2310
|
/**
|
|
2268
|
-
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
2269
|
-
* or can point to a Neptune database endpoint or snapshot.</p>
|
|
2311
|
+
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.</p>
|
|
2270
2312
|
* @public
|
|
2271
2313
|
*/
|
|
2272
2314
|
source: string | undefined;
|
|
2273
2315
|
/**
|
|
2274
|
-
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
2275
|
-
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
2276
|
-
* CSV format</a>, <code>OPEN_CYPHER</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
2277
|
-
* load format</a>, or <code>ntriples</code>, which identifies the
|
|
2278
|
-
* <a href="https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html">RDF n-triples</a> format.</p>
|
|
2316
|
+
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin CSV format</a>, <code>OPEN_CYPHER</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher load format</a>, or <code>ntriples</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html">RDF n-triples</a> format.</p>
|
|
2279
2317
|
* @public
|
|
2280
2318
|
*/
|
|
2281
2319
|
format?: Format | undefined;
|
|
@@ -2285,9 +2323,7 @@ export interface CreateGraphUsingImportTaskInput {
|
|
|
2285
2323
|
*/
|
|
2286
2324
|
parquetType?: ParquetType | undefined;
|
|
2287
2325
|
/**
|
|
2288
|
-
* <p>The method to handle blank nodes in the dataset. Currently, only <code>convertToIri</code> is supported,
|
|
2289
|
-
* meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is <code>ntriples</code>.
|
|
2290
|
-
* For more information, see <a href="https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html#rdf-handling">Handling RDF values</a>.</p>
|
|
2326
|
+
* <p>The method to handle blank nodes in the dataset. Currently, only <code>convertToIri</code> is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is <code>ntriples</code>. For more information, see <a href="https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html#rdf-handling">Handling RDF values</a>.</p>
|
|
2291
2327
|
* @public
|
|
2292
2328
|
*/
|
|
2293
2329
|
blankNodeHandling?: BlankNodeHandling | undefined;
|
|
@@ -2312,17 +2348,12 @@ export interface CreateGraphUsingImportTaskOutput {
|
|
|
2312
2348
|
*/
|
|
2313
2349
|
taskId: string | undefined;
|
|
2314
2350
|
/**
|
|
2315
|
-
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
2316
|
-
* or can point to a Neptune database endpoint or snapshot.</p>
|
|
2351
|
+
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.</p>
|
|
2317
2352
|
* @public
|
|
2318
2353
|
*/
|
|
2319
2354
|
source: string | undefined;
|
|
2320
2355
|
/**
|
|
2321
|
-
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
2322
|
-
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
2323
|
-
* CSV format</a>, <code>OPENCYPHER</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher
|
|
2324
|
-
* load format</a>, or <code>ntriples</code>, which identifies the
|
|
2325
|
-
* <a href="https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html">RDF n-triples</a> format.</p>
|
|
2356
|
+
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin CSV format</a>, <code>OPENCYPHER</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher load format</a>, or <code>ntriples</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html">RDF n-triples</a> format.</p>
|
|
2326
2357
|
* @public
|
|
2327
2358
|
*/
|
|
2328
2359
|
format?: Format | undefined;
|
|
@@ -2342,10 +2373,7 @@ export interface CreateGraphUsingImportTaskOutput {
|
|
|
2342
2373
|
*/
|
|
2343
2374
|
status: ImportTaskStatus | undefined;
|
|
2344
2375
|
/**
|
|
2345
|
-
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key
|
|
2346
|
-
* is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to
|
|
2347
|
-
* <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is
|
|
2348
|
-
* encountered.</p>
|
|
2376
|
+
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is encountered.</p>
|
|
2349
2377
|
* @public
|
|
2350
2378
|
*/
|
|
2351
2379
|
importOptions?: ImportOptions | undefined;
|
|
@@ -2373,29 +2401,22 @@ export declare const MultiValueHandlingType: {
|
|
|
2373
2401
|
*/
|
|
2374
2402
|
export type MultiValueHandlingType = (typeof MultiValueHandlingType)[keyof typeof MultiValueHandlingType];
|
|
2375
2403
|
/**
|
|
2376
|
-
* <p>A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName
|
|
2377
|
-
* and multiValueHandling.</p>
|
|
2404
|
+
* <p>A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName and multiValueHandling.</p>
|
|
2378
2405
|
* @public
|
|
2379
2406
|
*/
|
|
2380
2407
|
export interface ExportFilterPropertyAttributes {
|
|
2381
2408
|
/**
|
|
2382
|
-
* <p>Specifies the data type to use for the property in the exported data (e.g. "String", "Int", "Float").
|
|
2383
|
-
* If a type is not provided, the export process will determine the type. If a given property is present as multiple
|
|
2384
|
-
* types (e.g. one vertex has "height" stored as a double, and another edge has it stored as a string), the type
|
|
2385
|
-
* will be of Any type, otherwise, it will be the type of the property as present in vertices.</p>
|
|
2409
|
+
* <p>Specifies the data type to use for the property in the exported data (e.g. "String", "Int", "Float"). If a type is not provided, the export process will determine the type. If a given property is present as multiple types (e.g. one vertex has "height" stored as a double, and another edge has it stored as a string), the type will be of Any type, otherwise, it will be the type of the property as present in vertices.</p>
|
|
2386
2410
|
* @public
|
|
2387
2411
|
*/
|
|
2388
2412
|
outputType?: string | undefined;
|
|
2389
2413
|
/**
|
|
2390
|
-
* <p>The name of the property as it exists in the original graph data. If not provided, it is assumed that the key
|
|
2391
|
-
* matches the desired sourcePropertyName.</p>
|
|
2414
|
+
* <p>The name of the property as it exists in the original graph data. If not provided, it is assumed that the key matches the desired sourcePropertyName.</p>
|
|
2392
2415
|
* @public
|
|
2393
2416
|
*/
|
|
2394
2417
|
sourcePropertyName?: string | undefined;
|
|
2395
2418
|
/**
|
|
2396
|
-
* <p>Specifies how to handle properties that have multiple values. Can be either <code>TO_LIST</code> to export all
|
|
2397
|
-
* values as a list, or <code>PICK_FIRST</code> to export the first value encountered. If not specified, the default
|
|
2398
|
-
* value is <code>PICK_FIRST</code>.</p>
|
|
2419
|
+
* <p>Specifies how to handle properties that have multiple values. Can be either <code>TO_LIST</code> to export all values as a list, or <code>PICK_FIRST</code> to export the first value encountered. If not specified, the default value is <code>PICK_FIRST</code>.</p>
|
|
2399
2420
|
* @public
|
|
2400
2421
|
*/
|
|
2401
2422
|
multiValueHandling?: MultiValueHandlingType | undefined;
|
|
@@ -2406,28 +2427,23 @@ export interface ExportFilterPropertyAttributes {
|
|
|
2406
2427
|
*/
|
|
2407
2428
|
export interface ExportFilterElement {
|
|
2408
2429
|
/**
|
|
2409
|
-
* <p>Each property is defined by a key-value pair, where the key is the desired output property name (e.g. "name"),
|
|
2410
|
-
* and the value is an object.</p>
|
|
2430
|
+
* <p>Each property is defined by a key-value pair, where the key is the desired output property name (e.g. "name"), and the value is an object.</p>
|
|
2411
2431
|
* @public
|
|
2412
2432
|
*/
|
|
2413
2433
|
properties?: Record<string, ExportFilterPropertyAttributes> | undefined;
|
|
2414
2434
|
}
|
|
2415
2435
|
/**
|
|
2416
|
-
* <p>This is the top-level field for specifying vertex or edge filters. If the ExportFilter is not provided,
|
|
2417
|
-
* then all properties for all labels will be exported. If the ExportFilter is provided but is an empty object,
|
|
2418
|
-
* then no data will be exported.</p>
|
|
2436
|
+
* <p>This is the top-level field for specifying vertex or edge filters. If the ExportFilter is not provided, then all properties for all labels will be exported. If the ExportFilter is provided but is an empty object, then no data will be exported.</p>
|
|
2419
2437
|
* @public
|
|
2420
2438
|
*/
|
|
2421
2439
|
export interface ExportFilter {
|
|
2422
2440
|
/**
|
|
2423
|
-
* <p>Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels
|
|
2424
|
-
* and properties are included in the export.</p>
|
|
2441
|
+
* <p>Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels and properties are included in the export.</p>
|
|
2425
2442
|
* @public
|
|
2426
2443
|
*/
|
|
2427
2444
|
vertexFilter?: Record<string, ExportFilterElement> | undefined;
|
|
2428
2445
|
/**
|
|
2429
|
-
* <p>Used to specify filters on a per-label basis for edges. This allows you to control which edge labels
|
|
2430
|
-
* and properties are included in the export.</p>
|
|
2446
|
+
* <p>Used to specify filters on a per-label basis for edges. This allows you to control which edge labels and properties are included in the export.</p>
|
|
2431
2447
|
* @public
|
|
2432
2448
|
*/
|
|
2433
2449
|
edgeFilter?: Record<string, ExportFilterElement> | undefined;
|
|
@@ -2594,16 +2610,12 @@ export interface GetImportTaskOutput {
|
|
|
2594
2610
|
*/
|
|
2595
2611
|
taskId: string | undefined;
|
|
2596
2612
|
/**
|
|
2597
|
-
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
2598
|
-
* or can point to a Neptune database endpoint or snapshot</p>
|
|
2613
|
+
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot</p>
|
|
2599
2614
|
* @public
|
|
2600
2615
|
*/
|
|
2601
2616
|
source: string | undefined;
|
|
2602
2617
|
/**
|
|
2603
|
-
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
2604
|
-
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
2605
|
-
* 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
|
|
2606
|
-
* load format</a>.</p>
|
|
2618
|
+
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin 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 load format</a>.</p>
|
|
2607
2619
|
* @public
|
|
2608
2620
|
*/
|
|
2609
2621
|
format?: Format | undefined;
|
|
@@ -2618,72 +2630,12 @@ export interface GetImportTaskOutput {
|
|
|
2618
2630
|
*/
|
|
2619
2631
|
roleArn: string | undefined;
|
|
2620
2632
|
/**
|
|
2621
|
-
* <p>The status of the import task:</p>
|
|
2622
|
-
* <ul>
|
|
2623
|
-
* <li>
|
|
2624
|
-
* <p>
|
|
2625
|
-
* <b>INITIALIZING</b> –
|
|
2626
|
-
* The necessary resources needed to create the graph are being prepared.</p>
|
|
2627
|
-
* </li>
|
|
2628
|
-
* <li>
|
|
2629
|
-
* <p>
|
|
2630
|
-
* <b>ANALYZING_DATA</b> –
|
|
2631
|
-
* The data is being analyzed to determine the optimal infrastructure configuration
|
|
2632
|
-
* for the new graph.</p>
|
|
2633
|
-
* </li>
|
|
2634
|
-
* <li>
|
|
2635
|
-
* <p>
|
|
2636
|
-
* <b>RE_PROVISIONING</b> –
|
|
2637
|
-
* The data did not fit into the provisioned graph, so it is being re-provisioned
|
|
2638
|
-
* with more capacity.</p>
|
|
2639
|
-
* </li>
|
|
2640
|
-
* <li>
|
|
2641
|
-
* <p>
|
|
2642
|
-
* <b>IMPORTING</b> –
|
|
2643
|
-
* The data is being loaded.</p>
|
|
2644
|
-
* </li>
|
|
2645
|
-
* <li>
|
|
2646
|
-
* <p>
|
|
2647
|
-
* <b>ERROR_ENCOUNTERED</b> –
|
|
2648
|
-
* An error has been encountered while trying to create the graph and import the data.</p>
|
|
2649
|
-
* </li>
|
|
2650
|
-
* <li>
|
|
2651
|
-
* <p>
|
|
2652
|
-
* <b>ERROR_ENCOUNTERED_ROLLING_BACK</b> –
|
|
2653
|
-
* Because of the error that was encountered, the graph is being rolled back and all
|
|
2654
|
-
* its resources released.</p>
|
|
2655
|
-
* </li>
|
|
2656
|
-
* <li>
|
|
2657
|
-
* <p>
|
|
2658
|
-
* <b>SUCCEEDED</b> –
|
|
2659
|
-
* Graph creation and data loading succeeded.</p>
|
|
2660
|
-
* </li>
|
|
2661
|
-
* <li>
|
|
2662
|
-
* <p>
|
|
2663
|
-
* <b>FAILED</b> –
|
|
2664
|
-
* Graph creation or data loading failed. When the status is <code>FAILED</code>,
|
|
2665
|
-
* you can use <code>get-graphs</code> to get more information about the state of
|
|
2666
|
-
* the graph.</p>
|
|
2667
|
-
* </li>
|
|
2668
|
-
* <li>
|
|
2669
|
-
* <p>
|
|
2670
|
-
* <b>CANCELLING</b> –
|
|
2671
|
-
* Because you cancelled the import task, cancellation is in progress.</p>
|
|
2672
|
-
* </li>
|
|
2673
|
-
* <li>
|
|
2674
|
-
* <p>
|
|
2675
|
-
* <b>CANCELLED</b> –
|
|
2676
|
-
* You have successfully cancelled the import task.</p>
|
|
2677
|
-
* </li>
|
|
2678
|
-
* </ul>
|
|
2633
|
+
* <p>The status of the import task:</p> <ul> <li> <p> <b>INITIALIZING</b> – The necessary resources needed to create the graph are being prepared.</p> </li> <li> <p> <b>ANALYZING_DATA</b> – The data is being analyzed to determine the optimal infrastructure configuration for the new graph.</p> </li> <li> <p> <b>RE_PROVISIONING</b> – The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.</p> </li> <li> <p> <b>IMPORTING</b> – The data is being loaded.</p> </li> <li> <p> <b>ERROR_ENCOUNTERED</b> – An error has been encountered while trying to create the graph and import the data.</p> </li> <li> <p> <b>ERROR_ENCOUNTERED_ROLLING_BACK</b> – Because of the error that was encountered, the graph is being rolled back and all its resources released.</p> </li> <li> <p> <b>SUCCEEDED</b> – Graph creation and data loading succeeded.</p> </li> <li> <p> <b>FAILED</b> – Graph creation or data loading failed. When the status is <code>FAILED</code>, you can use <code>get-graphs</code> to get more information about the state of the graph.</p> </li> <li> <p> <b>CANCELLING</b> – Because you cancelled the import task, cancellation is in progress.</p> </li> <li> <p> <b>CANCELLED</b> – You have successfully cancelled the import task.</p> </li> </ul>
|
|
2679
2634
|
* @public
|
|
2680
2635
|
*/
|
|
2681
2636
|
status: ImportTaskStatus | undefined;
|
|
2682
2637
|
/**
|
|
2683
|
-
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key
|
|
2684
|
-
* is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to
|
|
2685
|
-
* <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is
|
|
2686
|
-
* encountered.</p>
|
|
2638
|
+
* <p>Contains options for controlling the import process. For example, if the <code>failOnError</code> key is set to <code>false</code>, the import skips problem data and attempts to continue (whereas if set to <code>true</code>, the default, or if omitted, the import operation halts immediately when an error is encountered.</p>
|
|
2687
2639
|
* @public
|
|
2688
2640
|
*/
|
|
2689
2641
|
importOptions?: ImportOptions | undefined;
|
|
@@ -2794,20 +2746,12 @@ export interface ListExportTasksOutput {
|
|
|
2794
2746
|
*/
|
|
2795
2747
|
export interface ListImportTasksInput {
|
|
2796
2748
|
/**
|
|
2797
|
-
* <p>Pagination token used to paginate output.</p>
|
|
2798
|
-
* <p>When this value is provided as input, the service returns results from where
|
|
2799
|
-
* the previous response left off. When this value is present in output, it indicates
|
|
2800
|
-
* that there are more results to retrieve.</p>
|
|
2749
|
+
* <p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>
|
|
2801
2750
|
* @public
|
|
2802
2751
|
*/
|
|
2803
2752
|
nextToken?: string | undefined;
|
|
2804
2753
|
/**
|
|
2805
|
-
* <p>The total number of records to return in the command's output.</p>
|
|
2806
|
-
* <p>If the total number of records available is more than the value specified,
|
|
2807
|
-
* <code>nextToken</code> is provided in the command's output. To resume pagination,
|
|
2808
|
-
* provide the <code>nextToken</code> output value in the <code>nextToken</code> argument
|
|
2809
|
-
* of a subsequent command. Do not use the <code>nextToken</code> response element directly
|
|
2810
|
-
* outside of the Amazon CLI.</p>
|
|
2754
|
+
* <p>The total number of records to return in the command's output.</p> <p>If the total number of records available is more than the value specified, <code>nextToken</code> is provided in the command's output. To resume pagination, provide the <code>nextToken</code> output value in the <code>nextToken</code> argument of a subsequent command. Do not use the <code>nextToken</code> response element directly outside of the Amazon CLI.</p>
|
|
2811
2755
|
* @public
|
|
2812
2756
|
*/
|
|
2813
2757
|
maxResults?: number | undefined;
|
|
@@ -2828,16 +2772,12 @@ export interface ImportTaskSummary {
|
|
|
2828
2772
|
*/
|
|
2829
2773
|
taskId: string | undefined;
|
|
2830
2774
|
/**
|
|
2831
|
-
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,
|
|
2832
|
-
* or can point to a Neptune database endpoint or snapshot</p>
|
|
2775
|
+
* <p>A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot</p>
|
|
2833
2776
|
* @public
|
|
2834
2777
|
*/
|
|
2835
2778
|
source: string | undefined;
|
|
2836
2779
|
/**
|
|
2837
|
-
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies
|
|
2838
|
-
* the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin
|
|
2839
|
-
* 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
|
|
2840
|
-
* load format</a>.</p>
|
|
2780
|
+
* <p>Specifies the format of S3 data to be imported. Valid values are <code>CSV</code>, which identifies the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin 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 load format</a>.</p>
|
|
2841
2781
|
* @public
|
|
2842
2782
|
*/
|
|
2843
2783
|
format?: Format | undefined;
|
|
@@ -2867,10 +2807,7 @@ export interface ListImportTasksOutput {
|
|
|
2867
2807
|
*/
|
|
2868
2808
|
tasks: ImportTaskSummary[] | undefined;
|
|
2869
2809
|
/**
|
|
2870
|
-
* <p>Pagination token used to paginate output.</p>
|
|
2871
|
-
* <p>When this value is provided as input, the service returns results from where
|
|
2872
|
-
* the previous response left off. When this value is present in output, it indicates
|
|
2873
|
-
* that there are more results to retrieve.</p>
|
|
2810
|
+
* <p>Pagination token used to paginate output.</p> <p>When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.</p>
|
|
2874
2811
|
* @public
|
|
2875
2812
|
*/
|
|
2876
2813
|
nextToken?: string | undefined;
|
|
@@ -2985,20 +2922,17 @@ export interface StartImportTaskInput {
|
|
|
2985
2922
|
*/
|
|
2986
2923
|
importOptions?: ImportOptions | undefined;
|
|
2987
2924
|
/**
|
|
2988
|
-
* <p>If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that
|
|
2989
|
-
* caused the error and continues if possible.</p>
|
|
2925
|
+
* <p>If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.</p>
|
|
2990
2926
|
* @public
|
|
2991
2927
|
*/
|
|
2992
2928
|
failOnError?: boolean | undefined;
|
|
2993
2929
|
/**
|
|
2994
|
-
* <p>A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a
|
|
2995
|
-
* Neptune database endpoint or snapshot.</p>
|
|
2930
|
+
* <p>A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.</p>
|
|
2996
2931
|
* @public
|
|
2997
2932
|
*/
|
|
2998
2933
|
source: string | undefined;
|
|
2999
2934
|
/**
|
|
3000
|
-
* <p>Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or
|
|
3001
|
-
* OPENCYPHER, which identies the openCypher load format.</p>
|
|
2935
|
+
* <p>Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.</p>
|
|
3002
2936
|
* @public
|
|
3003
2937
|
*/
|
|
3004
2938
|
format?: Format | undefined;
|
|
@@ -3008,9 +2942,7 @@ export interface StartImportTaskInput {
|
|
|
3008
2942
|
*/
|
|
3009
2943
|
parquetType?: ParquetType | undefined;
|
|
3010
2944
|
/**
|
|
3011
|
-
* <p>The method to handle blank nodes in the dataset. Currently, only <code>convertToIri</code> is supported,
|
|
3012
|
-
* meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is <code>ntriples</code>.
|
|
3013
|
-
* For more information, see <a href="https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html#rdf-handling">Handling RDF values</a>.</p>
|
|
2945
|
+
* <p>The method to handle blank nodes in the dataset. Currently, only <code>convertToIri</code> is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is <code>ntriples</code>. For more information, see <a href="https://docs.aws.amazon.com/neptune-analytics/latest/userguide/using-rdf-data.html#rdf-handling">Handling RDF values</a>.</p>
|
|
3014
2946
|
* @public
|
|
3015
2947
|
*/
|
|
3016
2948
|
blankNodeHandling?: BlankNodeHandling | undefined;
|
|
@@ -3040,14 +2972,12 @@ export interface StartImportTaskOutput {
|
|
|
3040
2972
|
*/
|
|
3041
2973
|
taskId: string | undefined;
|
|
3042
2974
|
/**
|
|
3043
|
-
* <p>A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a
|
|
3044
|
-
* Neptune database endpoint or snapshot.</p>
|
|
2975
|
+
* <p>A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.</p>
|
|
3045
2976
|
* @public
|
|
3046
2977
|
*/
|
|
3047
2978
|
source: string | undefined;
|
|
3048
2979
|
/**
|
|
3049
|
-
* <p>Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or
|
|
3050
|
-
* OPENCYPHER, which identies the openCypher load format.</p>
|
|
2980
|
+
* <p>Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.</p>
|
|
3051
2981
|
* @public
|
|
3052
2982
|
*/
|
|
3053
2983
|
format?: Format | undefined;
|