@aws-sdk/client-neptunedata 3.848.0 → 3.851.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 +1 -7
- package/dist-cjs/index.js +13 -0
- package/dist-es/models/models_0.js +13 -0
- package/dist-types/Neptunedata.d.ts +1 -6
- package/dist-types/NeptunedataClient.d.ts +1 -6
- package/dist-types/commands/CancelGremlinQueryCommand.d.ts +2 -8
- package/dist-types/commands/CancelLoaderJobCommand.d.ts +1 -7
- package/dist-types/commands/CancelMLDataProcessingJobCommand.d.ts +1 -6
- package/dist-types/commands/CancelMLModelTrainingJobCommand.d.ts +1 -6
- package/dist-types/commands/CancelMLModelTransformJobCommand.d.ts +1 -6
- package/dist-types/commands/CancelOpenCypherQueryCommand.d.ts +2 -8
- package/dist-types/commands/CreateMLEndpointCommand.d.ts +1 -8
- package/dist-types/commands/DeleteMLEndpointCommand.d.ts +1 -7
- package/dist-types/commands/DeletePropertygraphStatisticsCommand.d.ts +1 -6
- package/dist-types/commands/DeleteSparqlStatisticsCommand.d.ts +1 -5
- package/dist-types/commands/ExecuteFastResetCommand.d.ts +2 -13
- package/dist-types/commands/ExecuteGremlinExplainQueryCommand.d.ts +5 -45
- package/dist-types/commands/ExecuteGremlinProfileQueryCommand.d.ts +5 -20
- package/dist-types/commands/ExecuteGremlinQueryCommand.d.ts +5 -39
- package/dist-types/commands/ExecuteOpenCypherExplainQueryCommand.d.ts +5 -19
- package/dist-types/commands/ExecuteOpenCypherQueryCommand.d.ts +5 -44
- package/dist-types/commands/GetEngineStatusCommand.d.ts +1 -5
- package/dist-types/commands/GetGremlinQueryStatusCommand.d.ts +2 -11
- package/dist-types/commands/GetLoaderJobStatusCommand.d.ts +1 -9
- package/dist-types/commands/GetMLDataProcessingJobCommand.d.ts +1 -6
- package/dist-types/commands/GetMLEndpointCommand.d.ts +1 -6
- package/dist-types/commands/GetMLModelTrainingJobCommand.d.ts +1 -6
- package/dist-types/commands/GetMLModelTransformJobCommand.d.ts +1 -6
- package/dist-types/commands/GetOpenCypherQueryStatusCommand.d.ts +2 -11
- package/dist-types/commands/GetPropertygraphStatisticsCommand.d.ts +1 -5
- package/dist-types/commands/GetPropertygraphStreamCommand.d.ts +3 -38
- package/dist-types/commands/GetPropertygraphSummaryCommand.d.ts +1 -5
- package/dist-types/commands/GetRDFGraphSummaryCommand.d.ts +1 -5
- package/dist-types/commands/GetSparqlStreamCommand.d.ts +3 -22
- package/dist-types/commands/ListGremlinQueriesCommand.d.ts +2 -12
- package/dist-types/commands/ListLoaderJobsCommand.d.ts +1 -6
- package/dist-types/commands/ListMLDataProcessingJobsCommand.d.ts +1 -6
- package/dist-types/commands/ListMLEndpointsCommand.d.ts +1 -6
- package/dist-types/commands/ListMLModelTrainingJobsCommand.d.ts +1 -6
- package/dist-types/commands/ListMLModelTransformJobsCommand.d.ts +1 -6
- package/dist-types/commands/ListOpenCypherQueriesCommand.d.ts +2 -12
- package/dist-types/commands/ManagePropertygraphStatisticsCommand.d.ts +1 -5
- package/dist-types/commands/ManageSparqlStatisticsCommand.d.ts +1 -5
- package/dist-types/commands/StartLoaderJobCommand.d.ts +2 -8
- package/dist-types/commands/StartMLDataProcessingJobCommand.d.ts +1 -7
- package/dist-types/commands/StartMLModelTrainingJobCommand.d.ts +1 -6
- package/dist-types/commands/StartMLModelTransformJobCommand.d.ts +1 -6
- package/dist-types/index.d.ts +1 -6
- package/dist-types/models/models_0.d.ts +189 -868
- package/dist-types/ts3.4/models/models_0.d.ts +13 -0
- package/package.json +1 -1
|
@@ -116,8 +116,7 @@ export declare class ClientTimeoutException extends __BaseException {
|
|
|
116
116
|
constructor(opts: __ExceptionOptionType<ClientTimeoutException, __BaseException>);
|
|
117
117
|
}
|
|
118
118
|
/**
|
|
119
|
-
* <p>Raised when a request attempts to modify data that is concurrently being
|
|
120
|
-
* modified by another process.</p>
|
|
119
|
+
* <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
|
|
121
120
|
* @public
|
|
122
121
|
*/
|
|
123
122
|
export declare class ConcurrentModificationException extends __BaseException {
|
|
@@ -557,16 +556,12 @@ export interface CancelMLDataProcessingJobInput {
|
|
|
557
556
|
*/
|
|
558
557
|
id: string | undefined;
|
|
559
558
|
/**
|
|
560
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
561
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
562
|
-
* parameter group or an error will occur.</p>
|
|
559
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
563
560
|
* @public
|
|
564
561
|
*/
|
|
565
562
|
neptuneIamRoleArn?: string | undefined;
|
|
566
563
|
/**
|
|
567
|
-
* <p>If set to <code>TRUE</code>, this flag specifies that all
|
|
568
|
-
* Neptune ML S3 artifacts should be deleted when the job is stopped.
|
|
569
|
-
* The default is <code>FALSE</code>.</p>
|
|
564
|
+
* <p>If set to <code>TRUE</code>, this flag specifies that all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is <code>FALSE</code>.</p>
|
|
570
565
|
* @public
|
|
571
566
|
*/
|
|
572
567
|
clean?: boolean | undefined;
|
|
@@ -618,16 +613,12 @@ export interface CancelMLModelTrainingJobInput {
|
|
|
618
613
|
*/
|
|
619
614
|
id: string | undefined;
|
|
620
615
|
/**
|
|
621
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
622
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
623
|
-
* parameter group or an error will occur.</p>
|
|
616
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
624
617
|
* @public
|
|
625
618
|
*/
|
|
626
619
|
neptuneIamRoleArn?: string | undefined;
|
|
627
620
|
/**
|
|
628
|
-
* <p>If set to <code>TRUE</code>, this flag specifies that all
|
|
629
|
-
* Amazon S3 artifacts should be deleted when the job is stopped.
|
|
630
|
-
* The default is <code>FALSE</code>.</p>
|
|
621
|
+
* <p>If set to <code>TRUE</code>, this flag specifies that all Amazon S3 artifacts should be deleted when the job is stopped. The default is <code>FALSE</code>.</p>
|
|
631
622
|
* @public
|
|
632
623
|
*/
|
|
633
624
|
clean?: boolean | undefined;
|
|
@@ -652,15 +643,12 @@ export interface CancelMLModelTransformJobInput {
|
|
|
652
643
|
*/
|
|
653
644
|
id: string | undefined;
|
|
654
645
|
/**
|
|
655
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
656
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
657
|
-
* parameter group or an error will occur.</p>
|
|
646
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
658
647
|
* @public
|
|
659
648
|
*/
|
|
660
649
|
neptuneIamRoleArn?: string | undefined;
|
|
661
650
|
/**
|
|
662
|
-
* <p>If this flag is set to <code>TRUE</code>, all Neptune ML S3 artifacts
|
|
663
|
-
* should be deleted when the job is stopped. The default is <code>FALSE</code>.</p>
|
|
651
|
+
* <p>If this flag is set to <code>TRUE</code>, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is <code>FALSE</code>.</p>
|
|
664
652
|
* @public
|
|
665
653
|
*/
|
|
666
654
|
clean?: boolean | undefined;
|
|
@@ -685,8 +673,7 @@ export interface CancelOpenCypherQueryInput {
|
|
|
685
673
|
*/
|
|
686
674
|
queryId: string | undefined;
|
|
687
675
|
/**
|
|
688
|
-
* <p>If set to <code>TRUE</code>, causes the cancelation of the
|
|
689
|
-
* openCypher query to happen silently.</p>
|
|
676
|
+
* <p>If set to <code>TRUE</code>, causes the cancelation of the openCypher query to happen silently.</p>
|
|
690
677
|
* @public
|
|
691
678
|
*/
|
|
692
679
|
silent?: boolean | undefined;
|
|
@@ -738,67 +725,47 @@ export declare class InvalidNumericDataException extends __BaseException {
|
|
|
738
725
|
*/
|
|
739
726
|
export interface CreateMLEndpointInput {
|
|
740
727
|
/**
|
|
741
|
-
* <p>A unique identifier for the new inference endpoint. The default
|
|
742
|
-
* is an autogenerated timestamped name.</p>
|
|
728
|
+
* <p>A unique identifier for the new inference endpoint. The default is an autogenerated timestamped name.</p>
|
|
743
729
|
* @public
|
|
744
730
|
*/
|
|
745
731
|
id?: string | undefined;
|
|
746
732
|
/**
|
|
747
|
-
* <p>The job Id of the completed model-training job that has created the
|
|
748
|
-
* model that the inference endpoint will point to. You must supply either
|
|
749
|
-
* the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>
|
|
733
|
+
* <p>The job Id of the completed model-training job that has created the model that the inference endpoint will point to. You must supply either the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>
|
|
750
734
|
* @public
|
|
751
735
|
*/
|
|
752
736
|
mlModelTrainingJobId?: string | undefined;
|
|
753
737
|
/**
|
|
754
|
-
* <p>The job Id of the completed model-transform job. You must supply
|
|
755
|
-
* either the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>
|
|
738
|
+
* <p>The job Id of the completed model-transform job. You must supply either the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>
|
|
756
739
|
* @public
|
|
757
740
|
*/
|
|
758
741
|
mlModelTransformJobId?: string | undefined;
|
|
759
742
|
/**
|
|
760
|
-
* <p>If set to <code>true</code>, <code>update</code> indicates that this
|
|
761
|
-
* is an update request. The default is <code>false</code>. You must supply
|
|
762
|
-
* either the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>
|
|
743
|
+
* <p>If set to <code>true</code>, <code>update</code> indicates that this is an update request. The default is <code>false</code>. You must supply either the <code>mlModelTrainingJobId</code> or the <code>mlModelTransformJobId</code>.</p>
|
|
763
744
|
* @public
|
|
764
745
|
*/
|
|
765
746
|
update?: boolean | undefined;
|
|
766
747
|
/**
|
|
767
|
-
* <p>The ARN of an IAM role providing Neptune access to SageMaker and
|
|
768
|
-
* Amazon S3 resources. This must be listed in your DB cluster parameter
|
|
769
|
-
* group or an error will be thrown.</p>
|
|
748
|
+
* <p>The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.</p>
|
|
770
749
|
* @public
|
|
771
750
|
*/
|
|
772
751
|
neptuneIamRoleArn?: string | undefined;
|
|
773
752
|
/**
|
|
774
|
-
* <p>Model type for training. By default the Neptune ML model is
|
|
775
|
-
* automatically based on the <code>modelType</code> used in data processing,
|
|
776
|
-
* but you can specify a different model type here. The default is
|
|
777
|
-
* <code>rgcn</code> for heterogeneous graphs and <code>kge</code> for
|
|
778
|
-
* knowledge graphs. The only valid value for heterogeneous graphs is
|
|
779
|
-
* <code>rgcn</code>. Valid values for knowledge graphs are: <code>kge</code>,
|
|
780
|
-
* <code>transe</code>, <code>distmult</code>, and <code>rotate</code>.</p>
|
|
753
|
+
* <p>Model type for training. By default the Neptune ML model is automatically based on the <code>modelType</code> used in data processing, but you can specify a different model type here. The default is <code>rgcn</code> for heterogeneous graphs and <code>kge</code> for knowledge graphs. The only valid value for heterogeneous graphs is <code>rgcn</code>. Valid values for knowledge graphs are: <code>kge</code>, <code>transe</code>, <code>distmult</code>, and <code>rotate</code>.</p>
|
|
781
754
|
* @public
|
|
782
755
|
*/
|
|
783
756
|
modelName?: string | undefined;
|
|
784
757
|
/**
|
|
785
|
-
* <p>The type of Neptune ML instance to use for online servicing.
|
|
786
|
-
* The default is <code>ml.m5.xlarge</code>. Choosing the ML instance
|
|
787
|
-
* for an inference endpoint depends on the task type, the graph size,
|
|
788
|
-
* and your budget.</p>
|
|
758
|
+
* <p>The type of Neptune ML instance to use for online servicing. The default is <code>ml.m5.xlarge</code>. Choosing the ML instance for an inference endpoint depends on the task type, the graph size, and your budget.</p>
|
|
789
759
|
* @public
|
|
790
760
|
*/
|
|
791
761
|
instanceType?: string | undefined;
|
|
792
762
|
/**
|
|
793
|
-
* <p>The minimum number of Amazon EC2 instances to deploy to an endpoint
|
|
794
|
-
* for prediction. The default is 1</p>
|
|
763
|
+
* <p>The minimum number of Amazon EC2 instances to deploy to an endpoint for prediction. The default is 1</p>
|
|
795
764
|
* @public
|
|
796
765
|
*/
|
|
797
766
|
instanceCount?: number | undefined;
|
|
798
767
|
/**
|
|
799
|
-
* <p>The Amazon Key Management Service (Amazon KMS) key that SageMaker uses
|
|
800
|
-
* to encrypt data on the storage volume attached to the ML compute instances
|
|
801
|
-
* that run the training job. The default is None.</p>
|
|
768
|
+
* <p>The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.</p>
|
|
802
769
|
* @public
|
|
803
770
|
*/
|
|
804
771
|
volumeEncryptionKMSKey?: string | undefined;
|
|
@@ -833,16 +800,12 @@ export interface DeleteMLEndpointInput {
|
|
|
833
800
|
*/
|
|
834
801
|
id: string | undefined;
|
|
835
802
|
/**
|
|
836
|
-
* <p>The ARN of an IAM role providing Neptune access to SageMaker and
|
|
837
|
-
* Amazon S3 resources. This must be listed in your DB cluster parameter
|
|
838
|
-
* group or an error will be thrown.</p>
|
|
803
|
+
* <p>The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.</p>
|
|
839
804
|
* @public
|
|
840
805
|
*/
|
|
841
806
|
neptuneIamRoleArn?: string | undefined;
|
|
842
807
|
/**
|
|
843
|
-
* <p>If this flag is set to <code>TRUE</code>, all Neptune ML S3 artifacts
|
|
844
|
-
* should be deleted when the job is stopped. The default is
|
|
845
|
-
* <code>FALSE</code>.</p>
|
|
808
|
+
* <p>If this flag is set to <code>TRUE</code>, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is <code>FALSE</code>.</p>
|
|
846
809
|
* @public
|
|
847
810
|
*/
|
|
848
811
|
clean?: boolean | undefined;
|
|
@@ -878,8 +841,7 @@ export interface DeleteStatisticsValueMap {
|
|
|
878
841
|
*/
|
|
879
842
|
export interface DeletePropertygraphStatisticsOutput {
|
|
880
843
|
/**
|
|
881
|
-
* <p>The HTTP response code: 200 if the delete was successful, or
|
|
882
|
-
* 204 if there were no statistics to delete.</p>
|
|
844
|
+
* <p>The HTTP response code: 200 if the delete was successful, or 204 if there were no statistics to delete.</p>
|
|
883
845
|
* @public
|
|
884
846
|
*/
|
|
885
847
|
statusCode?: number | undefined;
|
|
@@ -953,8 +915,7 @@ export declare class StatisticsNotAvailableException extends __BaseException {
|
|
|
953
915
|
*/
|
|
954
916
|
export interface DeleteSparqlStatisticsOutput {
|
|
955
917
|
/**
|
|
956
|
-
* <p>The HTTP response code: 200 if the delete was successful, or
|
|
957
|
-
* 204 if there were no statistics to delete.</p>
|
|
918
|
+
* <p>The HTTP response code: 200 if the delete was successful, or 204 if there were no statistics to delete.</p>
|
|
958
919
|
* @public
|
|
959
920
|
*/
|
|
960
921
|
statusCode?: number | undefined;
|
|
@@ -974,26 +935,7 @@ export interface DeleteSparqlStatisticsOutput {
|
|
|
974
935
|
*/
|
|
975
936
|
export interface ExecuteFastResetInput {
|
|
976
937
|
/**
|
|
977
|
-
* <p>The fast reset action. One of the following values:</p>
|
|
978
|
-
* <ul>
|
|
979
|
-
* <li>
|
|
980
|
-
* <p>
|
|
981
|
-
* <b>
|
|
982
|
-
* <code>initiateDatabaseReset</code>
|
|
983
|
-
* </b> –
|
|
984
|
-
* This action generates a unique token needed to actually perform the
|
|
985
|
-
* fast reset.</p>
|
|
986
|
-
* </li>
|
|
987
|
-
* <li>
|
|
988
|
-
* <p>
|
|
989
|
-
* <b>
|
|
990
|
-
* <code>performDatabaseReset</code>
|
|
991
|
-
* </b> –
|
|
992
|
-
* This action uses the token generated by the <code>initiateDatabaseReset</code> action
|
|
993
|
-
* to actually perform the fast reset.</p>
|
|
994
|
-
* <p/>
|
|
995
|
-
* </li>
|
|
996
|
-
* </ul>
|
|
938
|
+
* <p>The fast reset action. One of the following values:</p> <ul> <li> <p> <b> <code>initiateDatabaseReset</code> </b> – This action generates a unique token needed to actually perform the fast reset.</p> </li> <li> <p> <b> <code>performDatabaseReset</code> </b> – This action uses the token generated by the <code>initiateDatabaseReset</code> action to actually perform the fast reset.</p> <p/> </li> </ul>
|
|
997
939
|
* @public
|
|
998
940
|
*/
|
|
999
941
|
action: Action | undefined;
|
|
@@ -1004,14 +946,12 @@ export interface ExecuteFastResetInput {
|
|
|
1004
946
|
token?: string | undefined;
|
|
1005
947
|
}
|
|
1006
948
|
/**
|
|
1007
|
-
* <p>A structure containing the fast reset token used to initiate
|
|
1008
|
-
* a fast reset.</p>
|
|
949
|
+
* <p>A structure containing the fast reset token used to initiate a fast reset.</p>
|
|
1009
950
|
* @public
|
|
1010
951
|
*/
|
|
1011
952
|
export interface FastResetToken {
|
|
1012
953
|
/**
|
|
1013
|
-
* <p>A UUID generated by the database in the <code>initiateDatabaseReset</code> action,
|
|
1014
|
-
* and then consumed by the <code>performDatabaseReset</code> to reset the database.</p>
|
|
954
|
+
* <p>A UUID generated by the database in the <code>initiateDatabaseReset</code> action, and then consumed by the <code>performDatabaseReset</code> to reset the database.</p>
|
|
1015
955
|
* @public
|
|
1016
956
|
*/
|
|
1017
957
|
token?: string | undefined;
|
|
@@ -1021,22 +961,18 @@ export interface FastResetToken {
|
|
|
1021
961
|
*/
|
|
1022
962
|
export interface ExecuteFastResetOutput {
|
|
1023
963
|
/**
|
|
1024
|
-
* <p>The <code>status</code> is only returned for the <code>performDatabaseReset</code>
|
|
1025
|
-
* action, and indicates whether or not the fast reset rquest is accepted.</p>
|
|
964
|
+
* <p>The <code>status</code> is only returned for the <code>performDatabaseReset</code> action, and indicates whether or not the fast reset rquest is accepted.</p>
|
|
1026
965
|
* @public
|
|
1027
966
|
*/
|
|
1028
967
|
status: string | undefined;
|
|
1029
968
|
/**
|
|
1030
|
-
* <p>The <code>payload</code> is only returned by the <code>initiateDatabaseReset</code>
|
|
1031
|
-
* action, and contains the unique token to use with the <code>performDatabaseReset</code>
|
|
1032
|
-
* action to make the reset occur.</p>
|
|
969
|
+
* <p>The <code>payload</code> is only returned by the <code>initiateDatabaseReset</code> action, and contains the unique token to use with the <code>performDatabaseReset</code> action to make the reset occur.</p>
|
|
1033
970
|
* @public
|
|
1034
971
|
*/
|
|
1035
972
|
payload?: FastResetToken | undefined;
|
|
1036
973
|
}
|
|
1037
974
|
/**
|
|
1038
|
-
* <p>Raised when the HTTP method used by a request is not supported by the endpoint
|
|
1039
|
-
* being used.</p>
|
|
975
|
+
* <p>Raised when the HTTP method used by a request is not supported by the endpoint being used.</p>
|
|
1040
976
|
* @public
|
|
1041
977
|
*/
|
|
1042
978
|
export declare class MethodNotAllowedException extends __BaseException {
|
|
@@ -1131,16 +1067,13 @@ export interface ExecuteGremlinExplainQueryInput {
|
|
|
1131
1067
|
*/
|
|
1132
1068
|
export interface ExecuteGremlinExplainQueryOutput {
|
|
1133
1069
|
/**
|
|
1134
|
-
* <p>A text blob containing the Gremlin explain result, as described
|
|
1135
|
-
* in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html">Tuning
|
|
1136
|
-
* Gremlin queries</a>.</p>
|
|
1070
|
+
* <p>A text blob containing the Gremlin explain result, as described in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html">Tuning Gremlin queries</a>.</p>
|
|
1137
1071
|
* @public
|
|
1138
1072
|
*/
|
|
1139
1073
|
output?: Uint8Array | undefined;
|
|
1140
1074
|
}
|
|
1141
1075
|
/**
|
|
1142
|
-
* <p>Raised when a query is submitted that is syntactically incorrect or does not
|
|
1143
|
-
* pass additional validation.</p>
|
|
1076
|
+
* <p>Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.</p>
|
|
1144
1077
|
* @public
|
|
1145
1078
|
*/
|
|
1146
1079
|
export declare class MalformedQueryException extends __BaseException {
|
|
@@ -1167,8 +1100,7 @@ export declare class MalformedQueryException extends __BaseException {
|
|
|
1167
1100
|
constructor(opts: __ExceptionOptionType<MalformedQueryException, __BaseException>);
|
|
1168
1101
|
}
|
|
1169
1102
|
/**
|
|
1170
|
-
* <p>Raised when a request fails because of insufficient memory resources. The
|
|
1171
|
-
* request can be retried.</p>
|
|
1103
|
+
* <p>Raised when a request fails because of insufficient memory resources. The request can be retried.</p>
|
|
1172
1104
|
* @public
|
|
1173
1105
|
*/
|
|
1174
1106
|
export declare class MemoryLimitExceededException extends __BaseException {
|
|
@@ -1196,8 +1128,7 @@ export declare class MemoryLimitExceededException extends __BaseException {
|
|
|
1196
1128
|
constructor(opts: __ExceptionOptionType<MemoryLimitExceededException, __BaseException>);
|
|
1197
1129
|
}
|
|
1198
1130
|
/**
|
|
1199
|
-
* <p>Raised when the number of active queries exceeds what the server can process.
|
|
1200
|
-
* The query in question can be retried when the system is less busy.</p>
|
|
1131
|
+
* <p>Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.</p>
|
|
1201
1132
|
* @public
|
|
1202
1133
|
*/
|
|
1203
1134
|
export declare class QueryLimitExceededException extends __BaseException {
|
|
@@ -1288,29 +1219,22 @@ export interface ExecuteGremlinProfileQueryInput {
|
|
|
1288
1219
|
*/
|
|
1289
1220
|
gremlinQuery: string | undefined;
|
|
1290
1221
|
/**
|
|
1291
|
-
* <p>If this flag is set to <code>TRUE</code>, the query results are
|
|
1292
|
-
* gathered and displayed as part of the profile report.
|
|
1293
|
-
* If <code>FALSE</code>, only the result count is displayed.</p>
|
|
1222
|
+
* <p>If this flag is set to <code>TRUE</code>, the query results are gathered and displayed as part of the profile report. If <code>FALSE</code>, only the result count is displayed.</p>
|
|
1294
1223
|
* @public
|
|
1295
1224
|
*/
|
|
1296
1225
|
results?: boolean | undefined;
|
|
1297
1226
|
/**
|
|
1298
|
-
* <p>If non-zero, causes the results string to be truncated at that
|
|
1299
|
-
* number of characters. If set to zero, the string contains all the results.</p>
|
|
1227
|
+
* <p>If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.</p>
|
|
1300
1228
|
* @public
|
|
1301
1229
|
*/
|
|
1302
1230
|
chop?: number | undefined;
|
|
1303
1231
|
/**
|
|
1304
|
-
* <p>If non-null, the gathered results are returned in a serialized response
|
|
1305
|
-
* message in the format specified by this parameter. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile
|
|
1306
|
-
* API in Neptune</a> for more information.</p>
|
|
1232
|
+
* <p>If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile API in Neptune</a> for more information.</p>
|
|
1307
1233
|
* @public
|
|
1308
1234
|
*/
|
|
1309
1235
|
serializer?: string | undefined;
|
|
1310
1236
|
/**
|
|
1311
|
-
* <p>If this flag is set to <code>TRUE</code>, the results include a
|
|
1312
|
-
* detailed report of all index operations that took place during query
|
|
1313
|
-
* execution and serialization.</p>
|
|
1237
|
+
* <p>If this flag is set to <code>TRUE</code>, the results include a detailed report of all index operations that took place during query execution and serialization.</p>
|
|
1314
1238
|
* @public
|
|
1315
1239
|
*/
|
|
1316
1240
|
indexOps?: boolean | undefined;
|
|
@@ -1320,9 +1244,7 @@ export interface ExecuteGremlinProfileQueryInput {
|
|
|
1320
1244
|
*/
|
|
1321
1245
|
export interface ExecuteGremlinProfileQueryOutput {
|
|
1322
1246
|
/**
|
|
1323
|
-
* <p>A text blob containing the Gremlin Profile result. See
|
|
1324
|
-
* <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin
|
|
1325
|
-
* profile API in Neptune</a> for details.</p>
|
|
1247
|
+
* <p>A text blob containing the Gremlin Profile result. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile API in Neptune</a> for details.</p>
|
|
1326
1248
|
* @public
|
|
1327
1249
|
*/
|
|
1328
1250
|
output?: Uint8Array | undefined;
|
|
@@ -1332,20 +1254,12 @@ export interface ExecuteGremlinProfileQueryOutput {
|
|
|
1332
1254
|
*/
|
|
1333
1255
|
export interface ExecuteGremlinQueryInput {
|
|
1334
1256
|
/**
|
|
1335
|
-
* <p>Using this API, you can run Gremlin queries in string format
|
|
1336
|
-
* much as you can using the HTTP endpoint. The interface is
|
|
1337
|
-
* compatible with whatever Gremlin version your DB cluster is using
|
|
1338
|
-
* (see the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest">Tinkerpop
|
|
1339
|
-
* client section</a> to determine which Gremlin releases your
|
|
1340
|
-
* engine version supports).</p>
|
|
1257
|
+
* <p>Using this API, you can run Gremlin queries in string format much as you can using the HTTP endpoint. The interface is compatible with whatever Gremlin version your DB cluster is using (see the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest">Tinkerpop client section</a> to determine which Gremlin releases your engine version supports).</p>
|
|
1341
1258
|
* @public
|
|
1342
1259
|
*/
|
|
1343
1260
|
gremlinQuery: string | undefined;
|
|
1344
1261
|
/**
|
|
1345
|
-
* <p>If non-null, the query results are returned in a serialized response
|
|
1346
|
-
* message in the format specified by this parameter. See the <a href="https://tinkerpop.apache.org/docs/current/reference/#_graphson">GraphSON</a>
|
|
1347
|
-
* section in the TinkerPop documentation for a list of the formats that
|
|
1348
|
-
* are currently supported.</p>
|
|
1262
|
+
* <p>If non-null, the query results are returned in a serialized response message in the format specified by this parameter. See the <a href="https://tinkerpop.apache.org/docs/current/reference/#_graphson">GraphSON</a> section in the TinkerPop documentation for a list of the formats that are currently supported.</p>
|
|
1349
1263
|
* @public
|
|
1350
1264
|
*/
|
|
1351
1265
|
serializer?: string | undefined;
|
|
@@ -1424,8 +1338,7 @@ export interface ExecuteOpenCypherExplainQueryInput {
|
|
|
1424
1338
|
*/
|
|
1425
1339
|
parameters?: string | undefined;
|
|
1426
1340
|
/**
|
|
1427
|
-
* <p>The openCypher <code>explain</code> mode. Can be one of:
|
|
1428
|
-
* <code>static</code>, <code>dynamic</code>, or <code>details</code>.</p>
|
|
1341
|
+
* <p>The openCypher <code>explain</code> mode. Can be one of: <code>static</code>, <code>dynamic</code>, or <code>details</code>.</p>
|
|
1429
1342
|
* @public
|
|
1430
1343
|
*/
|
|
1431
1344
|
explainMode: OpenCypherExplainMode | undefined;
|
|
@@ -1450,9 +1363,7 @@ export interface ExecuteOpenCypherQueryInput {
|
|
|
1450
1363
|
*/
|
|
1451
1364
|
openCypherQuery: string | undefined;
|
|
1452
1365
|
/**
|
|
1453
|
-
* <p>The openCypher query parameters for query execution.
|
|
1454
|
-
* See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html">Examples
|
|
1455
|
-
* of openCypher parameterized queries</a> for more information.</p>
|
|
1366
|
+
* <p>The openCypher query parameters for query execution. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html">Examples of openCypher parameterized queries</a> for more information.</p>
|
|
1456
1367
|
* @public
|
|
1457
1368
|
*/
|
|
1458
1369
|
parameters?: string | undefined;
|
|
@@ -1483,10 +1394,7 @@ export interface QueryLanguageVersion {
|
|
|
1483
1394
|
*/
|
|
1484
1395
|
export interface GetEngineStatusOutput {
|
|
1485
1396
|
/**
|
|
1486
|
-
* <p>Set to <code>healthy</code> if the instance is not experiencing problems.
|
|
1487
|
-
* If the instance is recovering from a crash or from being rebooted and there
|
|
1488
|
-
* are active transactions running from the latest server shutdown, status is set
|
|
1489
|
-
* to <code>recovery</code>.</p>
|
|
1397
|
+
* <p>Set to <code>healthy</code> if the instance is not experiencing problems. If the instance is recovering from a crash or from being rebooted and there are active transactions running from the latest server shutdown, status is set to <code>recovery</code>.</p>
|
|
1490
1398
|
* @public
|
|
1491
1399
|
*/
|
|
1492
1400
|
status?: string | undefined;
|
|
@@ -1496,44 +1404,32 @@ export interface GetEngineStatusOutput {
|
|
|
1496
1404
|
*/
|
|
1497
1405
|
startTime?: string | undefined;
|
|
1498
1406
|
/**
|
|
1499
|
-
* <p>Set to the Neptune engine version running on your DB cluster.
|
|
1500
|
-
* If this engine version has been manually patched since it was released,
|
|
1501
|
-
* the version number is prefixed by <code>Patch-</code>.</p>
|
|
1407
|
+
* <p>Set to the Neptune engine version running on your DB cluster. If this engine version has been manually patched since it was released, the version number is prefixed by <code>Patch-</code>.</p>
|
|
1502
1408
|
* @public
|
|
1503
1409
|
*/
|
|
1504
1410
|
dbEngineVersion?: string | undefined;
|
|
1505
1411
|
/**
|
|
1506
|
-
* <p>Set to <code>reader</code> if the instance is a read-replica,
|
|
1507
|
-
* or to <code>writer</code> if the instance is the primary instance.</p>
|
|
1412
|
+
* <p>Set to <code>reader</code> if the instance is a read-replica, or to <code>writer</code> if the instance is the primary instance.</p>
|
|
1508
1413
|
* @public
|
|
1509
1414
|
*/
|
|
1510
1415
|
role?: string | undefined;
|
|
1511
1416
|
/**
|
|
1512
|
-
* <p>Set to <code>enabled</code> if the DFE engine is fully enabled,
|
|
1513
|
-
* or to <code>viaQueryHint</code> (the default) if the DFE engine is
|
|
1514
|
-
* only used with queries that have the <code>useDFE</code> query hint
|
|
1515
|
-
* set to <code>true</code>.</p>
|
|
1417
|
+
* <p>Set to <code>enabled</code> if the DFE engine is fully enabled, or to <code>viaQueryHint</code> (the default) if the DFE engine is only used with queries that have the <code>useDFE</code> query hint set to <code>true</code>.</p>
|
|
1516
1418
|
* @public
|
|
1517
1419
|
*/
|
|
1518
1420
|
dfeQueryEngine?: string | undefined;
|
|
1519
1421
|
/**
|
|
1520
|
-
* <p>Contains information about the Gremlin query language available
|
|
1521
|
-
* on your cluster. Specifically, it contains a version field that specifies
|
|
1522
|
-
* the current TinkerPop version being used by the engine.</p>
|
|
1422
|
+
* <p>Contains information about the Gremlin query language available on your cluster. Specifically, it contains a version field that specifies the current TinkerPop version being used by the engine.</p>
|
|
1523
1423
|
* @public
|
|
1524
1424
|
*/
|
|
1525
1425
|
gremlin?: QueryLanguageVersion | undefined;
|
|
1526
1426
|
/**
|
|
1527
|
-
* <p>Contains information about the SPARQL query language available
|
|
1528
|
-
* on your cluster. Specifically, it contains a version field that
|
|
1529
|
-
* specifies the current SPARQL version being used by the engine.</p>
|
|
1427
|
+
* <p>Contains information about the SPARQL query language available on your cluster. Specifically, it contains a version field that specifies the current SPARQL version being used by the engine.</p>
|
|
1530
1428
|
* @public
|
|
1531
1429
|
*/
|
|
1532
1430
|
sparql?: QueryLanguageVersion | undefined;
|
|
1533
1431
|
/**
|
|
1534
|
-
* <p>Contains information about the openCypher query language available
|
|
1535
|
-
* on your cluster. Specifically, it contains a version field that
|
|
1536
|
-
* specifies the current operCypher version being used by the engine.</p>
|
|
1432
|
+
* <p>Contains information about the openCypher query language available on your cluster. Specifically, it contains a version field that specifies the current operCypher version being used by the engine.</p>
|
|
1537
1433
|
* @public
|
|
1538
1434
|
*/
|
|
1539
1435
|
opencypher?: QueryLanguageVersion | undefined;
|
|
@@ -1543,15 +1439,12 @@ export interface GetEngineStatusOutput {
|
|
|
1543
1439
|
*/
|
|
1544
1440
|
labMode?: Record<string, string> | undefined;
|
|
1545
1441
|
/**
|
|
1546
|
-
* <p>If there are transactions being rolled back, this field is set
|
|
1547
|
-
* to the number of such transactions. If there are none, the field
|
|
1548
|
-
* doesn't appear at all.</p>
|
|
1442
|
+
* <p>If there are transactions being rolled back, this field is set to the number of such transactions. If there are none, the field doesn't appear at all.</p>
|
|
1549
1443
|
* @public
|
|
1550
1444
|
*/
|
|
1551
1445
|
rollingBackTrxCount?: number | undefined;
|
|
1552
1446
|
/**
|
|
1553
|
-
* <p>Set to the start time of the earliest transaction being rolled back.
|
|
1554
|
-
* If no transactions are being rolled back, the field doesn't appear at all.</p>
|
|
1447
|
+
* <p>Set to the start time of the earliest transaction being rolled back. If no transactions are being rolled back, the field doesn't appear at all.</p>
|
|
1555
1448
|
* @public
|
|
1556
1449
|
*/
|
|
1557
1450
|
rollingBackTrxEarliestStartTime?: string | undefined;
|
|
@@ -1561,9 +1454,7 @@ export interface GetEngineStatusOutput {
|
|
|
1561
1454
|
*/
|
|
1562
1455
|
features?: Record<string, __DocumentType> | undefined;
|
|
1563
1456
|
/**
|
|
1564
|
-
* <p>Contains information about the current settings on your DB cluster.
|
|
1565
|
-
* For example, contains the current cluster query timeout setting
|
|
1566
|
-
* (<code>clusterQueryTimeoutInMs</code>).</p>
|
|
1457
|
+
* <p>Contains information about the current settings on your DB cluster. For example, contains the current cluster query timeout setting (<code>clusterQueryTimeoutInMs</code>).</p>
|
|
1567
1458
|
* @public
|
|
1568
1459
|
*/
|
|
1569
1460
|
settings?: Record<string, string> | undefined;
|
|
@@ -1579,8 +1470,7 @@ export interface GetGremlinQueryStatusInput {
|
|
|
1579
1470
|
queryId: string | undefined;
|
|
1580
1471
|
}
|
|
1581
1472
|
/**
|
|
1582
|
-
* <p>Structure to capture query statistics such as how many queries
|
|
1583
|
-
* are running, accepted or waiting and their details.</p>
|
|
1473
|
+
* <p>Structure to capture query statistics such as how many queries are running, accepted or waiting and their details.</p>
|
|
1584
1474
|
* @public
|
|
1585
1475
|
*/
|
|
1586
1476
|
export interface QueryEvalStats {
|
|
@@ -1595,8 +1485,7 @@ export interface QueryEvalStats {
|
|
|
1595
1485
|
*/
|
|
1596
1486
|
elapsed?: number | undefined;
|
|
1597
1487
|
/**
|
|
1598
|
-
* <p>Set to <code>TRUE</code> if the query was cancelled, or FALSE
|
|
1599
|
-
* otherwise.</p>
|
|
1488
|
+
* <p>Set to <code>TRUE</code> if the query was cancelled, or FALSE otherwise.</p>
|
|
1600
1489
|
* @public
|
|
1601
1490
|
*/
|
|
1602
1491
|
cancelled?: boolean | undefined;
|
|
@@ -1636,32 +1525,22 @@ export interface GetLoaderJobStatusInput {
|
|
|
1636
1525
|
*/
|
|
1637
1526
|
loadId: string | undefined;
|
|
1638
1527
|
/**
|
|
1639
|
-
* <p>Flag indicating whether or not to include details beyond the
|
|
1640
|
-
* overall status (<code>TRUE</code> or <code>FALSE</code>; the default
|
|
1641
|
-
* is <code>FALSE</code>).</p>
|
|
1528
|
+
* <p>Flag indicating whether or not to include details beyond the overall status (<code>TRUE</code> or <code>FALSE</code>; the default is <code>FALSE</code>).</p>
|
|
1642
1529
|
* @public
|
|
1643
1530
|
*/
|
|
1644
1531
|
details?: boolean | undefined;
|
|
1645
1532
|
/**
|
|
1646
|
-
* <p>Flag indicating whether or not to include a list of errors
|
|
1647
|
-
* encountered (<code>TRUE</code> or <code>FALSE</code>; the default
|
|
1648
|
-
* is <code>FALSE</code>).</p>
|
|
1649
|
-
* <p>The list of errors is paged. The <code>page</code> and <code>errorsPerPage</code>
|
|
1650
|
-
* parameters allow you to page through all the errors.</p>
|
|
1533
|
+
* <p>Flag indicating whether or not to include a list of errors encountered (<code>TRUE</code> or <code>FALSE</code>; the default is <code>FALSE</code>).</p> <p>The list of errors is paged. The <code>page</code> and <code>errorsPerPage</code> parameters allow you to page through all the errors.</p>
|
|
1651
1534
|
* @public
|
|
1652
1535
|
*/
|
|
1653
1536
|
errors?: boolean | undefined;
|
|
1654
1537
|
/**
|
|
1655
|
-
* <p>The error page number (a positive integer; the default is <code>1</code>).
|
|
1656
|
-
* Only valid when the <code>errors</code> parameter is set to
|
|
1657
|
-
* <code>TRUE</code>.</p>
|
|
1538
|
+
* <p>The error page number (a positive integer; the default is <code>1</code>). Only valid when the <code>errors</code> parameter is set to <code>TRUE</code>.</p>
|
|
1658
1539
|
* @public
|
|
1659
1540
|
*/
|
|
1660
1541
|
page?: number | undefined;
|
|
1661
1542
|
/**
|
|
1662
|
-
* <p>The number of errors returned in each page (a positive integer; the
|
|
1663
|
-
* default is <code>10</code>). Only valid when the <code>errors</code>
|
|
1664
|
-
* parameter set to <code>TRUE</code>.</p>
|
|
1543
|
+
* <p>The number of errors returned in each page (a positive integer; the default is <code>10</code>). Only valid when the <code>errors</code> parameter set to <code>TRUE</code>.</p>
|
|
1665
1544
|
* @public
|
|
1666
1545
|
*/
|
|
1667
1546
|
errorsPerPage?: number | undefined;
|
|
@@ -1676,8 +1555,7 @@ export interface GetLoaderJobStatusOutput {
|
|
|
1676
1555
|
*/
|
|
1677
1556
|
status: string | undefined;
|
|
1678
1557
|
/**
|
|
1679
|
-
* <p>Status information about the load job, in a layout
|
|
1680
|
-
* that could look like this:</p>
|
|
1558
|
+
* <p>Status information about the load job, in a layout that could look like this:</p>
|
|
1681
1559
|
* @public
|
|
1682
1560
|
*/
|
|
1683
1561
|
payload: __DocumentType | undefined;
|
|
@@ -1692,9 +1570,7 @@ export interface GetMLDataProcessingJobInput {
|
|
|
1692
1570
|
*/
|
|
1693
1571
|
id: string | undefined;
|
|
1694
1572
|
/**
|
|
1695
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
1696
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
1697
|
-
* parameter group or an error will occur.</p>
|
|
1573
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
1698
1574
|
* @public
|
|
1699
1575
|
*/
|
|
1700
1576
|
neptuneIamRoleArn?: string | undefined;
|
|
@@ -1765,9 +1641,7 @@ export interface GetMLEndpointInput {
|
|
|
1765
1641
|
*/
|
|
1766
1642
|
id: string | undefined;
|
|
1767
1643
|
/**
|
|
1768
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
1769
|
-
* and Amazon S3 resources. This must be listed in your DB cluster parameter
|
|
1770
|
-
* group or an error will occur.</p>
|
|
1644
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
1771
1645
|
* @public
|
|
1772
1646
|
*/
|
|
1773
1647
|
neptuneIamRoleArn?: string | undefined;
|
|
@@ -1823,9 +1697,7 @@ export interface GetMLModelTrainingJobInput {
|
|
|
1823
1697
|
*/
|
|
1824
1698
|
id: string | undefined;
|
|
1825
1699
|
/**
|
|
1826
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
1827
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
1828
|
-
* parameter group or an error will occur.</p>
|
|
1700
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
1829
1701
|
* @public
|
|
1830
1702
|
*/
|
|
1831
1703
|
neptuneIamRoleArn?: string | undefined;
|
|
@@ -1875,9 +1747,7 @@ export interface GetMLModelTransformJobInput {
|
|
|
1875
1747
|
*/
|
|
1876
1748
|
id: string | undefined;
|
|
1877
1749
|
/**
|
|
1878
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
1879
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
1880
|
-
* parameter group or an error will occur.</p>
|
|
1750
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
1881
1751
|
* @public
|
|
1882
1752
|
*/
|
|
1883
1753
|
neptuneIamRoleArn?: string | undefined;
|
|
@@ -1917,8 +1787,7 @@ export interface GetMLModelTransformJobOutput {
|
|
|
1917
1787
|
*/
|
|
1918
1788
|
export interface GetOpenCypherQueryStatusInput {
|
|
1919
1789
|
/**
|
|
1920
|
-
* <p>The unique ID of the openCypher query for which to retrieve
|
|
1921
|
-
* the query status.</p>
|
|
1790
|
+
* <p>The unique ID of the openCypher query for which to retrieve the query status.</p>
|
|
1922
1791
|
* @public
|
|
1923
1792
|
*/
|
|
1924
1793
|
queryId: string | undefined;
|
|
@@ -1965,12 +1834,7 @@ export interface StatisticsSummary {
|
|
|
1965
1834
|
predicateCount?: number | undefined;
|
|
1966
1835
|
}
|
|
1967
1836
|
/**
|
|
1968
|
-
* <p>Contains statistics information. The DFE engine uses information
|
|
1969
|
-
* about the data in your Neptune graph to make effective trade-offs when
|
|
1970
|
-
* planning query execution. This information takes the form of statistics
|
|
1971
|
-
* that include so-called characteristic sets and predicate statistics
|
|
1972
|
-
* that can guide query planning. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html">Managing
|
|
1973
|
-
* statistics for the Neptune DFE to use</a>.</p>
|
|
1837
|
+
* <p>Contains statistics information. The DFE engine uses information about the data in your Neptune graph to make effective trade-offs when planning query execution. This information takes the form of statistics that include so-called characteristic sets and predicate statistics that can guide query planning. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html">Managing statistics for the Neptune DFE to use</a>.</p>
|
|
1974
1838
|
* @public
|
|
1975
1839
|
*/
|
|
1976
1840
|
export interface Statistics {
|
|
@@ -1985,8 +1849,7 @@ export interface Statistics {
|
|
|
1985
1849
|
*/
|
|
1986
1850
|
active?: boolean | undefined;
|
|
1987
1851
|
/**
|
|
1988
|
-
* <p>Reports the ID of the current statistics generation run.
|
|
1989
|
-
* A value of -1 indicates that no statistics have been generated.</p>
|
|
1852
|
+
* <p>Reports the ID of the current statistics generation run. A value of -1 indicates that no statistics have been generated.</p>
|
|
1990
1853
|
* @public
|
|
1991
1854
|
*/
|
|
1992
1855
|
statisticsId?: string | undefined;
|
|
@@ -2001,23 +1864,7 @@ export interface Statistics {
|
|
|
2001
1864
|
*/
|
|
2002
1865
|
note?: string | undefined;
|
|
2003
1866
|
/**
|
|
2004
|
-
* <p>A StatisticsSummary structure that contains:</p>
|
|
2005
|
-
* <ul>
|
|
2006
|
-
* <li>
|
|
2007
|
-
* <p>
|
|
2008
|
-
* <code>signatureCount</code> - The total number of signatures
|
|
2009
|
-
* across all characteristic sets.</p>
|
|
2010
|
-
* </li>
|
|
2011
|
-
* <li>
|
|
2012
|
-
* <p>
|
|
2013
|
-
* <code>instanceCount</code> - The total number of
|
|
2014
|
-
* characteristic-set instances.</p>
|
|
2015
|
-
* </li>
|
|
2016
|
-
* <li>
|
|
2017
|
-
* <p>
|
|
2018
|
-
* <code>predicateCount</code> - The total number of unique predicates.</p>
|
|
2019
|
-
* </li>
|
|
2020
|
-
* </ul>
|
|
1867
|
+
* <p>A StatisticsSummary structure that contains:</p> <ul> <li> <p> <code>signatureCount</code> - The total number of signatures across all characteristic sets.</p> </li> <li> <p> <code>instanceCount</code> - The total number of characteristic-set instances.</p> </li> <li> <p> <code>predicateCount</code> - The total number of unique predicates.</p> </li> </ul>
|
|
2021
1868
|
* @public
|
|
2022
1869
|
*/
|
|
2023
1870
|
signatureInfo?: StatisticsSummary | undefined;
|
|
@@ -2027,9 +1874,7 @@ export interface Statistics {
|
|
|
2027
1874
|
*/
|
|
2028
1875
|
export interface GetPropertygraphStatisticsOutput {
|
|
2029
1876
|
/**
|
|
2030
|
-
* <p>The HTTP return code of the request. If the request succeeded,
|
|
2031
|
-
* the code is 200. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors">Common
|
|
2032
|
-
* error codes for DFE statistics request</a> for a list of common errors.</p>
|
|
1877
|
+
* <p>The HTTP return code of the request. If the request succeeded, the code is 200. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors">Common error codes for DFE statistics request</a> for a list of common errors.</p>
|
|
2033
1878
|
* @public
|
|
2034
1879
|
*/
|
|
2035
1880
|
status: string | undefined;
|
|
@@ -2096,61 +1941,22 @@ export type IteratorType = (typeof IteratorType)[keyof typeof IteratorType];
|
|
|
2096
1941
|
*/
|
|
2097
1942
|
export interface GetPropertygraphStreamInput {
|
|
2098
1943
|
/**
|
|
2099
|
-
* <p>Specifies the maximum number of records to return. There
|
|
2100
|
-
* is also a size limit of 10 MB on the response that can't be modified
|
|
2101
|
-
* and that takes precedence over the number of records specified in
|
|
2102
|
-
* the <code>limit</code> parameter. The response does include a
|
|
2103
|
-
* threshold-breaching record if the 10 MB limit was reached.</p>
|
|
2104
|
-
* <p>The range for <code>limit</code> is 1 to 100,000, with a
|
|
2105
|
-
* default of 10.</p>
|
|
1944
|
+
* <p>Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the <code>limit</code> parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.</p> <p>The range for <code>limit</code> is 1 to 100,000, with a default of 10.</p>
|
|
2106
1945
|
* @public
|
|
2107
1946
|
*/
|
|
2108
1947
|
limit?: number | undefined;
|
|
2109
1948
|
/**
|
|
2110
|
-
* <p>Can be one of:</p>
|
|
2111
|
-
* <ul>
|
|
2112
|
-
* <li>
|
|
2113
|
-
* <p>
|
|
2114
|
-
* <code>AT_SEQUENCE_NUMBER</code> –
|
|
2115
|
-
* Indicates that reading should start from the event sequence number
|
|
2116
|
-
* specified jointly by the <code>commitNum</code> and
|
|
2117
|
-
* <code>opNum</code> parameters.</p>
|
|
2118
|
-
* </li>
|
|
2119
|
-
* <li>
|
|
2120
|
-
* <p>
|
|
2121
|
-
* <code>AFTER_SEQUENCE_NUMBER</code> –
|
|
2122
|
-
* Indicates that reading should start right after the event sequence number
|
|
2123
|
-
* specified jointly by the <code>commitNum</code> and <code>opNum</code>
|
|
2124
|
-
* parameters.</p>
|
|
2125
|
-
* </li>
|
|
2126
|
-
* <li>
|
|
2127
|
-
* <p>
|
|
2128
|
-
* <code>TRIM_HORIZON</code> –
|
|
2129
|
-
* Indicates that reading should start at the last untrimmed record in the system,
|
|
2130
|
-
* which is the oldest unexpired (not yet deleted) record in the change-log stream.</p>
|
|
2131
|
-
* </li>
|
|
2132
|
-
* <li>
|
|
2133
|
-
* <p>
|
|
2134
|
-
* <code>LATEST</code> –
|
|
2135
|
-
* Indicates that reading should start at the most recent record in the system,
|
|
2136
|
-
* which is the latest unexpired (not yet deleted) record in the change-log stream.</p>
|
|
2137
|
-
* </li>
|
|
2138
|
-
* </ul>
|
|
1949
|
+
* <p>Can be one of:</p> <ul> <li> <p> <code>AT_SEQUENCE_NUMBER</code> – Indicates that reading should start from the event sequence number specified jointly by the <code>commitNum</code> and <code>opNum</code> parameters.</p> </li> <li> <p> <code>AFTER_SEQUENCE_NUMBER</code> – Indicates that reading should start right after the event sequence number specified jointly by the <code>commitNum</code> and <code>opNum</code> parameters.</p> </li> <li> <p> <code>TRIM_HORIZON</code> – Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.</p> </li> <li> <p> <code>LATEST</code> – Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.</p> </li> </ul>
|
|
2139
1950
|
* @public
|
|
2140
1951
|
*/
|
|
2141
1952
|
iteratorType?: IteratorType | undefined;
|
|
2142
1953
|
/**
|
|
2143
|
-
* <p>The commit number of the starting record to read from the
|
|
2144
|
-
* change-log stream. This parameter is required when <code>iteratorType</code>
|
|
2145
|
-
* is<code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>, and
|
|
2146
|
-
* ignored when <code>iteratorType</code> is <code>TRIM_HORIZON</code> or
|
|
2147
|
-
* <code>LATEST</code>.</p>
|
|
1954
|
+
* <p>The commit number of the starting record to read from the change-log stream. This parameter is required when <code>iteratorType</code> is<code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>, and ignored when <code>iteratorType</code> is <code>TRIM_HORIZON</code> or <code>LATEST</code>.</p>
|
|
2148
1955
|
* @public
|
|
2149
1956
|
*/
|
|
2150
1957
|
commitNum?: number | undefined;
|
|
2151
1958
|
/**
|
|
2152
|
-
* <p>The operation sequence number within the specified commit to
|
|
2153
|
-
* start reading from in the change-log stream data. The default is <code>1</code>.</p>
|
|
1959
|
+
* <p>The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is <code>1</code>.</p>
|
|
2154
1960
|
* @public
|
|
2155
1961
|
*/
|
|
2156
1962
|
opNum?: number | undefined;
|
|
@@ -2171,38 +1977,7 @@ export interface PropertygraphData {
|
|
|
2171
1977
|
*/
|
|
2172
1978
|
id: string | undefined;
|
|
2173
1979
|
/**
|
|
2174
|
-
* <p>The type of this Gremlin or openCypher element. Must be one of:</p>
|
|
2175
|
-
* <ul>
|
|
2176
|
-
* <li>
|
|
2177
|
-
* <p>
|
|
2178
|
-
* <b>
|
|
2179
|
-
* <code>v1</code>
|
|
2180
|
-
* </b> -
|
|
2181
|
-
* Vertex label for Gremlin, or node label for openCypher.</p>
|
|
2182
|
-
* </li>
|
|
2183
|
-
* <li>
|
|
2184
|
-
* <p>
|
|
2185
|
-
* <b>
|
|
2186
|
-
* <code>vp</code>
|
|
2187
|
-
* </b> -
|
|
2188
|
-
* Vertex properties for Gremlin, or node properties for openCypher.</p>
|
|
2189
|
-
* </li>
|
|
2190
|
-
* <li>
|
|
2191
|
-
* <p>
|
|
2192
|
-
* <b>
|
|
2193
|
-
* <code>e</code>
|
|
2194
|
-
* </b> -
|
|
2195
|
-
* Edge and edge label for Gremlin, or relationship and relationship type
|
|
2196
|
-
* for openCypher.</p>
|
|
2197
|
-
* </li>
|
|
2198
|
-
* <li>
|
|
2199
|
-
* <p>
|
|
2200
|
-
* <b>
|
|
2201
|
-
* <code>ep</code>
|
|
2202
|
-
* </b> -
|
|
2203
|
-
* Edge properties for Gremlin, or relationship properties for openCypher.</p>
|
|
2204
|
-
* </li>
|
|
2205
|
-
* </ul>
|
|
1980
|
+
* <p>The type of this Gremlin or openCypher element. Must be one of:</p> <ul> <li> <p> <b> <code>v1</code> </b> - Vertex label for Gremlin, or node label for openCypher.</p> </li> <li> <p> <b> <code>vp</code> </b> - Vertex properties for Gremlin, or node properties for openCypher.</p> </li> <li> <p> <b> <code>e</code> </b> - Edge and edge label for Gremlin, or relationship and relationship type for openCypher.</p> </li> <li> <p> <b> <code>ep</code> </b> - Edge properties for Gremlin, or relationship properties for openCypher.</p> </li> </ul>
|
|
2206
1981
|
* @public
|
|
2207
1982
|
*/
|
|
2208
1983
|
type: string | undefined;
|
|
@@ -2212,20 +1987,17 @@ export interface PropertygraphData {
|
|
|
2212
1987
|
*/
|
|
2213
1988
|
key: string | undefined;
|
|
2214
1989
|
/**
|
|
2215
|
-
* <p>This is a JSON object that contains a value field for the value itself,
|
|
2216
|
-
* and a datatype field for the JSON data type of that value:</p>
|
|
1990
|
+
* <p>This is a JSON object that contains a value field for the value itself, and a datatype field for the JSON data type of that value:</p>
|
|
2217
1991
|
* @public
|
|
2218
1992
|
*/
|
|
2219
1993
|
value: __DocumentType | undefined;
|
|
2220
1994
|
/**
|
|
2221
|
-
* <p>If this is an edge (type = <code>e</code>), the ID of the
|
|
2222
|
-
* corresponding <code>from</code> vertex or source node.</p>
|
|
1995
|
+
* <p>If this is an edge (type = <code>e</code>), the ID of the corresponding <code>from</code> vertex or source node.</p>
|
|
2223
1996
|
* @public
|
|
2224
1997
|
*/
|
|
2225
1998
|
from?: string | undefined;
|
|
2226
1999
|
/**
|
|
2227
|
-
* <p>If this is an edge (type = <code>e</code>), the ID of the
|
|
2228
|
-
* corresponding <code>to</code> vertex or target node.</p>
|
|
2000
|
+
* <p>If this is an edge (type = <code>e</code>), the ID of the corresponding <code>to</code> vertex or target node.</p>
|
|
2229
2001
|
* @public
|
|
2230
2002
|
*/
|
|
2231
2003
|
to?: string | undefined;
|
|
@@ -2236,8 +2008,7 @@ export interface PropertygraphData {
|
|
|
2236
2008
|
*/
|
|
2237
2009
|
export interface PropertygraphRecord {
|
|
2238
2010
|
/**
|
|
2239
|
-
* <p>The time at which the commit for the transaction was requested,
|
|
2240
|
-
* in milliseconds from the Unix epoch.</p>
|
|
2011
|
+
* <p>The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.</p>
|
|
2241
2012
|
* @public
|
|
2242
2013
|
*/
|
|
2243
2014
|
commitTimestampInMillis: number | undefined;
|
|
@@ -2257,9 +2028,7 @@ export interface PropertygraphRecord {
|
|
|
2257
2028
|
*/
|
|
2258
2029
|
op: string | undefined;
|
|
2259
2030
|
/**
|
|
2260
|
-
* <p>Only present if this operation is the last one in its transaction.
|
|
2261
|
-
* If present, it is set to true. It is useful for ensuring that an
|
|
2262
|
-
* entire transaction is consumed.</p>
|
|
2031
|
+
* <p>Only present if this operation is the last one in its transaction. If present, it is set to true. It is useful for ensuring that an entire transaction is consumed.</p>
|
|
2263
2032
|
* @public
|
|
2264
2033
|
*/
|
|
2265
2034
|
isLastOp?: boolean | undefined;
|
|
@@ -2269,22 +2038,17 @@ export interface PropertygraphRecord {
|
|
|
2269
2038
|
*/
|
|
2270
2039
|
export interface GetPropertygraphStreamOutput {
|
|
2271
2040
|
/**
|
|
2272
|
-
* <p>Sequence identifier of the last change in the stream response.</p>
|
|
2273
|
-
* <p>An event ID is composed of two fields: a <code>commitNum</code>, which
|
|
2274
|
-
* identifies a transaction that changed the graph, and an <code>opNum</code>,
|
|
2275
|
-
* which identifies a specific operation within that transaction:</p>
|
|
2041
|
+
* <p>Sequence identifier of the last change in the stream response.</p> <p>An event ID is composed of two fields: a <code>commitNum</code>, which identifies a transaction that changed the graph, and an <code>opNum</code>, which identifies a specific operation within that transaction:</p>
|
|
2276
2042
|
* @public
|
|
2277
2043
|
*/
|
|
2278
2044
|
lastEventId: Record<string, string> | undefined;
|
|
2279
2045
|
/**
|
|
2280
|
-
* <p>The time at which the commit for the transaction was requested,
|
|
2281
|
-
* in milliseconds from the Unix epoch.</p>
|
|
2046
|
+
* <p>The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.</p>
|
|
2282
2047
|
* @public
|
|
2283
2048
|
*/
|
|
2284
2049
|
lastTrxTimestampInMillis: number | undefined;
|
|
2285
2050
|
/**
|
|
2286
|
-
* <p>Serialization format for the change records being returned.
|
|
2287
|
-
* Currently, the only supported value is <code>PG_JSON</code>.</p>
|
|
2051
|
+
* <p>Serialization format for the change records being returned. Currently, the only supported value is <code>PG_JSON</code>.</p>
|
|
2288
2052
|
* @public
|
|
2289
2053
|
*/
|
|
2290
2054
|
format: string | undefined;
|
|
@@ -2327,8 +2091,7 @@ export declare class StreamRecordsNotFoundException extends __BaseException {
|
|
|
2327
2091
|
constructor(opts: __ExceptionOptionType<StreamRecordsNotFoundException, __BaseException>);
|
|
2328
2092
|
}
|
|
2329
2093
|
/**
|
|
2330
|
-
* <p>Raised when the rate of requests exceeds the maximum throughput. Requests can
|
|
2331
|
-
* be retried after encountering this exception.</p>
|
|
2094
|
+
* <p>Raised when the rate of requests exceeds the maximum throughput. Requests can be retried after encountering this exception.</p>
|
|
2332
2095
|
* @public
|
|
2333
2096
|
*/
|
|
2334
2097
|
export declare class ThrottlingException extends __BaseException {
|
|
@@ -2372,8 +2135,7 @@ export type GraphSummaryType = (typeof GraphSummaryType)[keyof typeof GraphSumma
|
|
|
2372
2135
|
*/
|
|
2373
2136
|
export interface GetPropertygraphSummaryInput {
|
|
2374
2137
|
/**
|
|
2375
|
-
* <p>Mode can take one of two values: <code>BASIC</code> (the default),
|
|
2376
|
-
* and <code>DETAILED</code>.</p>
|
|
2138
|
+
* <p>Mode can take one of two values: <code>BASIC</code> (the default), and <code>DETAILED</code>.</p>
|
|
2377
2139
|
* @public
|
|
2378
2140
|
*/
|
|
2379
2141
|
mode?: GraphSummaryType | undefined;
|
|
@@ -2416,10 +2178,7 @@ export interface NodeStructure {
|
|
|
2416
2178
|
distinctOutgoingEdgeLabels?: string[] | undefined;
|
|
2417
2179
|
}
|
|
2418
2180
|
/**
|
|
2419
|
-
* <p>The graph summary API returns a read-only list of node and edge
|
|
2420
|
-
* labels and property keys, along with counts of nodes, edges, and
|
|
2421
|
-
* properties. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response">Graph
|
|
2422
|
-
* summary response for a property graph (PG)</a>.</p>
|
|
2181
|
+
* <p>The graph summary API returns a read-only list of node and edge labels and property keys, along with counts of nodes, edges, and properties. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response">Graph summary response for a property graph (PG)</a>.</p>
|
|
2423
2182
|
* @public
|
|
2424
2183
|
*/
|
|
2425
2184
|
export interface PropertygraphSummary {
|
|
@@ -2454,8 +2213,7 @@ export interface PropertygraphSummary {
|
|
|
2454
2213
|
*/
|
|
2455
2214
|
edgeLabels?: string[] | undefined;
|
|
2456
2215
|
/**
|
|
2457
|
-
* <p>A list of the distinct node properties in the graph, along
|
|
2458
|
-
* with the count of nodes where each property is used.</p>
|
|
2216
|
+
* <p>A list of the distinct node properties in the graph, along with the count of nodes where each property is used.</p>
|
|
2459
2217
|
* @public
|
|
2460
2218
|
*/
|
|
2461
2219
|
numNodeProperties?: number | undefined;
|
|
@@ -2470,8 +2228,7 @@ export interface PropertygraphSummary {
|
|
|
2470
2228
|
*/
|
|
2471
2229
|
nodeProperties?: Record<string, number>[] | undefined;
|
|
2472
2230
|
/**
|
|
2473
|
-
* <p>A list of the distinct edge properties in the graph, along
|
|
2474
|
-
* with the count of edges where each property is used.</p>
|
|
2231
|
+
* <p>A list of the distinct edge properties in the graph, along with the count of edges where each property is used.</p>
|
|
2475
2232
|
* @public
|
|
2476
2233
|
*/
|
|
2477
2234
|
edgeProperties?: Record<string, number>[] | undefined;
|
|
@@ -2486,14 +2243,12 @@ export interface PropertygraphSummary {
|
|
|
2486
2243
|
*/
|
|
2487
2244
|
totalEdgePropertyValues?: number | undefined;
|
|
2488
2245
|
/**
|
|
2489
|
-
* <p>This field is only present when the requested mode is
|
|
2490
|
-
* <code>DETAILED</code>. It contains a list of node structures.</p>
|
|
2246
|
+
* <p>This field is only present when the requested mode is <code>DETAILED</code>. It contains a list of node structures.</p>
|
|
2491
2247
|
* @public
|
|
2492
2248
|
*/
|
|
2493
2249
|
nodeStructures?: NodeStructure[] | undefined;
|
|
2494
2250
|
/**
|
|
2495
|
-
* <p>This field is only present when the requested mode is
|
|
2496
|
-
* <code>DETAILED</code>. It contains a list of edge structures.</p>
|
|
2251
|
+
* <p>This field is only present when the requested mode is <code>DETAILED</code>. It contains a list of edge structures.</p>
|
|
2497
2252
|
* @public
|
|
2498
2253
|
*/
|
|
2499
2254
|
edgeStructures?: EdgeStructure[] | undefined;
|
|
@@ -2524,8 +2279,7 @@ export interface PropertygraphSummaryValueMap {
|
|
|
2524
2279
|
*/
|
|
2525
2280
|
export interface GetPropertygraphSummaryOutput {
|
|
2526
2281
|
/**
|
|
2527
|
-
* <p>The HTTP return code of the request. If the request succeeded,
|
|
2528
|
-
* the code is 200.</p>
|
|
2282
|
+
* <p>The HTTP return code of the request. If the request succeeded, the code is 200.</p>
|
|
2529
2283
|
* @public
|
|
2530
2284
|
*/
|
|
2531
2285
|
statusCode?: number | undefined;
|
|
@@ -2540,8 +2294,7 @@ export interface GetPropertygraphSummaryOutput {
|
|
|
2540
2294
|
*/
|
|
2541
2295
|
export interface GetRDFGraphSummaryInput {
|
|
2542
2296
|
/**
|
|
2543
|
-
* <p>Mode can take one of two values: <code>BASIC</code> (the default),
|
|
2544
|
-
* and <code>DETAILED</code>.</p>
|
|
2297
|
+
* <p>Mode can take one of two values: <code>BASIC</code> (the default), and <code>DETAILED</code>.</p>
|
|
2545
2298
|
* @public
|
|
2546
2299
|
*/
|
|
2547
2300
|
mode?: GraphSummaryType | undefined;
|
|
@@ -2563,8 +2316,7 @@ export interface SubjectStructure {
|
|
|
2563
2316
|
predicates?: string[] | undefined;
|
|
2564
2317
|
}
|
|
2565
2318
|
/**
|
|
2566
|
-
* <p>The RDF graph summary API returns a read-only list of classes and
|
|
2567
|
-
* predicate keys, along with counts of quads, subjects, and predicates.</p>
|
|
2319
|
+
* <p>The RDF graph summary API returns a read-only list of classes and predicate keys, along with counts of quads, subjects, and predicates.</p>
|
|
2568
2320
|
* @public
|
|
2569
2321
|
*/
|
|
2570
2322
|
export interface RDFGraphSummary {
|
|
@@ -2599,8 +2351,7 @@ export interface RDFGraphSummary {
|
|
|
2599
2351
|
*/
|
|
2600
2352
|
predicates?: Record<string, number>[] | undefined;
|
|
2601
2353
|
/**
|
|
2602
|
-
* <p>This field is only present when the request mode is
|
|
2603
|
-
* <code>DETAILED</code>. It contains a list of subject structures.</p>
|
|
2354
|
+
* <p>This field is only present when the request mode is <code>DETAILED</code>. It contains a list of subject structures.</p>
|
|
2604
2355
|
* @public
|
|
2605
2356
|
*/
|
|
2606
2357
|
subjectStructures?: SubjectStructure[] | undefined;
|
|
@@ -2616,14 +2367,12 @@ export interface RDFGraphSummaryValueMap {
|
|
|
2616
2367
|
*/
|
|
2617
2368
|
version?: string | undefined;
|
|
2618
2369
|
/**
|
|
2619
|
-
* <p>The timestamp, in ISO 8601 format, of the time at which Neptune
|
|
2620
|
-
* last computed statistics.</p>
|
|
2370
|
+
* <p>The timestamp, in ISO 8601 format, of the time at which Neptune last computed statistics.</p>
|
|
2621
2371
|
* @public
|
|
2622
2372
|
*/
|
|
2623
2373
|
lastStatisticsComputationTime?: Date | undefined;
|
|
2624
2374
|
/**
|
|
2625
|
-
* <p>The graph summary of an RDF graph. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-rdf-response">Graph
|
|
2626
|
-
* summary response for an RDF graph</a>.</p>
|
|
2375
|
+
* <p>The graph summary of an RDF graph. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-rdf-response">Graph summary response for an RDF graph</a>.</p>
|
|
2627
2376
|
* @public
|
|
2628
2377
|
*/
|
|
2629
2378
|
graphSummary?: RDFGraphSummary | undefined;
|
|
@@ -2633,8 +2382,7 @@ export interface RDFGraphSummaryValueMap {
|
|
|
2633
2382
|
*/
|
|
2634
2383
|
export interface GetRDFGraphSummaryOutput {
|
|
2635
2384
|
/**
|
|
2636
|
-
* <p>The HTTP return code of the request. If the request succeeded,
|
|
2637
|
-
* the code is 200.</p>
|
|
2385
|
+
* <p>The HTTP return code of the request. If the request succeeded, the code is 200.</p>
|
|
2638
2386
|
* @public
|
|
2639
2387
|
*/
|
|
2640
2388
|
statusCode?: number | undefined;
|
|
@@ -2649,13 +2397,7 @@ export interface GetRDFGraphSummaryOutput {
|
|
|
2649
2397
|
*/
|
|
2650
2398
|
export interface GetSparqlStatisticsOutput {
|
|
2651
2399
|
/**
|
|
2652
|
-
* <p>The HTTP return code of the request. If the request succeeded,
|
|
2653
|
-
* the code is 200. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors">Common
|
|
2654
|
-
* error codes for DFE statistics request</a> for a list of common errors.</p>
|
|
2655
|
-
* <p>When invoking this operation in a Neptune cluster that has IAM
|
|
2656
|
-
* authentication enabled, the IAM user or role making the request must
|
|
2657
|
-
* have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus">neptune-db:GetStatisticsStatus</a>
|
|
2658
|
-
* IAM action in that cluster.</p>
|
|
2400
|
+
* <p>The HTTP return code of the request. If the request succeeded, the code is 200. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors">Common error codes for DFE statistics request</a> for a list of common errors.</p> <p>When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus">neptune-db:GetStatisticsStatus</a> IAM action in that cluster.</p>
|
|
2659
2401
|
* @public
|
|
2660
2402
|
*/
|
|
2661
2403
|
status: string | undefined;
|
|
@@ -2670,61 +2412,22 @@ export interface GetSparqlStatisticsOutput {
|
|
|
2670
2412
|
*/
|
|
2671
2413
|
export interface GetSparqlStreamInput {
|
|
2672
2414
|
/**
|
|
2673
|
-
* <p>Specifies the maximum number of records to return. There
|
|
2674
|
-
* is also a size limit of 10 MB on the response that can't be modified
|
|
2675
|
-
* and that takes precedence over the number of records specified in
|
|
2676
|
-
* the <code>limit</code> parameter. The response does include a
|
|
2677
|
-
* threshold-breaching record if the 10 MB limit was reached.</p>
|
|
2678
|
-
* <p>The range for <code>limit</code> is 1 to 100,000, with a
|
|
2679
|
-
* default of 10.</p>
|
|
2415
|
+
* <p>Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the <code>limit</code> parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.</p> <p>The range for <code>limit</code> is 1 to 100,000, with a default of 10.</p>
|
|
2680
2416
|
* @public
|
|
2681
2417
|
*/
|
|
2682
2418
|
limit?: number | undefined;
|
|
2683
2419
|
/**
|
|
2684
|
-
* <p>Can be one of:</p>
|
|
2685
|
-
* <ul>
|
|
2686
|
-
* <li>
|
|
2687
|
-
* <p>
|
|
2688
|
-
* <code>AT_SEQUENCE_NUMBER</code> –
|
|
2689
|
-
* Indicates that reading should start from the event sequence number
|
|
2690
|
-
* specified jointly by the <code>commitNum</code> and
|
|
2691
|
-
* <code>opNum</code> parameters.</p>
|
|
2692
|
-
* </li>
|
|
2693
|
-
* <li>
|
|
2694
|
-
* <p>
|
|
2695
|
-
* <code>AFTER_SEQUENCE_NUMBER</code> –
|
|
2696
|
-
* Indicates that reading should start right after the event sequence number
|
|
2697
|
-
* specified jointly by the <code>commitNum</code> and <code>opNum</code>
|
|
2698
|
-
* parameters.</p>
|
|
2699
|
-
* </li>
|
|
2700
|
-
* <li>
|
|
2701
|
-
* <p>
|
|
2702
|
-
* <code>TRIM_HORIZON</code> –
|
|
2703
|
-
* Indicates that reading should start at the last untrimmed record in the system,
|
|
2704
|
-
* which is the oldest unexpired (not yet deleted) record in the change-log stream.</p>
|
|
2705
|
-
* </li>
|
|
2706
|
-
* <li>
|
|
2707
|
-
* <p>
|
|
2708
|
-
* <code>LATEST</code> –
|
|
2709
|
-
* Indicates that reading should start at the most recent record in the system,
|
|
2710
|
-
* which is the latest unexpired (not yet deleted) record in the change-log stream.</p>
|
|
2711
|
-
* </li>
|
|
2712
|
-
* </ul>
|
|
2420
|
+
* <p>Can be one of:</p> <ul> <li> <p> <code>AT_SEQUENCE_NUMBER</code> – Indicates that reading should start from the event sequence number specified jointly by the <code>commitNum</code> and <code>opNum</code> parameters.</p> </li> <li> <p> <code>AFTER_SEQUENCE_NUMBER</code> – Indicates that reading should start right after the event sequence number specified jointly by the <code>commitNum</code> and <code>opNum</code> parameters.</p> </li> <li> <p> <code>TRIM_HORIZON</code> – Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.</p> </li> <li> <p> <code>LATEST</code> – Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.</p> </li> </ul>
|
|
2713
2421
|
* @public
|
|
2714
2422
|
*/
|
|
2715
2423
|
iteratorType?: IteratorType | undefined;
|
|
2716
2424
|
/**
|
|
2717
|
-
* <p>The commit number of the starting record to read from the
|
|
2718
|
-
* change-log stream. This parameter is required when <code>iteratorType</code>
|
|
2719
|
-
* is<code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>, and
|
|
2720
|
-
* ignored when <code>iteratorType</code> is <code>TRIM_HORIZON</code> or
|
|
2721
|
-
* <code>LATEST</code>.</p>
|
|
2425
|
+
* <p>The commit number of the starting record to read from the change-log stream. This parameter is required when <code>iteratorType</code> is<code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>, and ignored when <code>iteratorType</code> is <code>TRIM_HORIZON</code> or <code>LATEST</code>.</p>
|
|
2722
2426
|
* @public
|
|
2723
2427
|
*/
|
|
2724
2428
|
commitNum?: number | undefined;
|
|
2725
2429
|
/**
|
|
2726
|
-
* <p>The operation sequence number within the specified commit to
|
|
2727
|
-
* start reading from in the change-log stream data. The default is <code>1</code>.</p>
|
|
2430
|
+
* <p>The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is <code>1</code>.</p>
|
|
2728
2431
|
* @public
|
|
2729
2432
|
*/
|
|
2730
2433
|
opNum?: number | undefined;
|
|
@@ -2735,28 +2438,23 @@ export interface GetSparqlStreamInput {
|
|
|
2735
2438
|
encoding?: Encoding | undefined;
|
|
2736
2439
|
}
|
|
2737
2440
|
/**
|
|
2738
|
-
* <p>Neptune logs are converted to SPARQL quads in the graph using the
|
|
2739
|
-
* Resource Description Framework (RDF) <a href="https://www.w3.org/TR/n-quads/">N-QUADS</a> language defined
|
|
2740
|
-
* in the W3C RDF 1.1 N-Quads specification</p>
|
|
2441
|
+
* <p>Neptune logs are converted to SPARQL quads in the graph using the Resource Description Framework (RDF) <a href="https://www.w3.org/TR/n-quads/">N-QUADS</a> language defined in the W3C RDF 1.1 N-Quads specification</p>
|
|
2741
2442
|
* @public
|
|
2742
2443
|
*/
|
|
2743
2444
|
export interface SparqlData {
|
|
2744
2445
|
/**
|
|
2745
|
-
* <p>Holds an <a href="https://www.w3.org/TR/n-quads/">N-QUADS</a>
|
|
2746
|
-
* statement expressing the changed quad.</p>
|
|
2446
|
+
* <p>Holds an <a href="https://www.w3.org/TR/n-quads/">N-QUADS</a> statement expressing the changed quad.</p>
|
|
2747
2447
|
* @public
|
|
2748
2448
|
*/
|
|
2749
2449
|
stmt: string | undefined;
|
|
2750
2450
|
}
|
|
2751
2451
|
/**
|
|
2752
|
-
* <p>A serialized SPARQL stream record capturing a change-log entry
|
|
2753
|
-
* for the RDF graph.</p>
|
|
2452
|
+
* <p>A serialized SPARQL stream record capturing a change-log entry for the RDF graph.</p>
|
|
2754
2453
|
* @public
|
|
2755
2454
|
*/
|
|
2756
2455
|
export interface SparqlRecord {
|
|
2757
2456
|
/**
|
|
2758
|
-
* <p>The time at which the commit for the transaction was requested,
|
|
2759
|
-
* in milliseconds from the Unix epoch.</p>
|
|
2457
|
+
* <p>The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.</p>
|
|
2760
2458
|
* @public
|
|
2761
2459
|
*/
|
|
2762
2460
|
commitTimestampInMillis: number | undefined;
|
|
@@ -2766,9 +2464,7 @@ export interface SparqlRecord {
|
|
|
2766
2464
|
*/
|
|
2767
2465
|
eventId: Record<string, string> | undefined;
|
|
2768
2466
|
/**
|
|
2769
|
-
* <p>The serialized SPARQL change record. The serialization formats
|
|
2770
|
-
* of each record are described in more detail in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams-change-formats.html">Serialization
|
|
2771
|
-
* Formats in Neptune Streams</a>.</p>
|
|
2467
|
+
* <p>The serialized SPARQL change record. The serialization formats of each record are described in more detail in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/streams-change-formats.html">Serialization Formats in Neptune Streams</a>.</p>
|
|
2772
2468
|
* @public
|
|
2773
2469
|
*/
|
|
2774
2470
|
data: SparqlData | undefined;
|
|
@@ -2778,9 +2474,7 @@ export interface SparqlRecord {
|
|
|
2778
2474
|
*/
|
|
2779
2475
|
op: string | undefined;
|
|
2780
2476
|
/**
|
|
2781
|
-
* <p>Only present if this operation is the last one in its transaction.
|
|
2782
|
-
* If present, it is set to true. It is useful for ensuring that an
|
|
2783
|
-
* entire transaction is consumed.</p>
|
|
2477
|
+
* <p>Only present if this operation is the last one in its transaction. If present, it is set to true. It is useful for ensuring that an entire transaction is consumed.</p>
|
|
2784
2478
|
* @public
|
|
2785
2479
|
*/
|
|
2786
2480
|
isLastOp?: boolean | undefined;
|
|
@@ -2790,22 +2484,17 @@ export interface SparqlRecord {
|
|
|
2790
2484
|
*/
|
|
2791
2485
|
export interface GetSparqlStreamOutput {
|
|
2792
2486
|
/**
|
|
2793
|
-
* <p>Sequence identifier of the last change in the stream response.</p>
|
|
2794
|
-
* <p>An event ID is composed of two fields: a <code>commitNum</code>, which
|
|
2795
|
-
* identifies a transaction that changed the graph, and an <code>opNum</code>,
|
|
2796
|
-
* which identifies a specific operation within that transaction:</p>
|
|
2487
|
+
* <p>Sequence identifier of the last change in the stream response.</p> <p>An event ID is composed of two fields: a <code>commitNum</code>, which identifies a transaction that changed the graph, and an <code>opNum</code>, which identifies a specific operation within that transaction:</p>
|
|
2797
2488
|
* @public
|
|
2798
2489
|
*/
|
|
2799
2490
|
lastEventId: Record<string, string> | undefined;
|
|
2800
2491
|
/**
|
|
2801
|
-
* <p>The time at which the commit for the transaction was requested,
|
|
2802
|
-
* in milliseconds from the Unix epoch.</p>
|
|
2492
|
+
* <p>The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.</p>
|
|
2803
2493
|
* @public
|
|
2804
2494
|
*/
|
|
2805
2495
|
lastTrxTimestampInMillis: number | undefined;
|
|
2806
2496
|
/**
|
|
2807
|
-
* <p>Serialization format for the change records being returned.
|
|
2808
|
-
* Currently, the only supported value is <code>NQUADS</code>.</p>
|
|
2497
|
+
* <p>Serialization format for the change records being returned. Currently, the only supported value is <code>NQUADS</code>.</p>
|
|
2809
2498
|
* @public
|
|
2810
2499
|
*/
|
|
2811
2500
|
format: string | undefined;
|
|
@@ -2825,15 +2514,13 @@ export interface GetSparqlStreamOutput {
|
|
|
2825
2514
|
*/
|
|
2826
2515
|
export interface ListGremlinQueriesInput {
|
|
2827
2516
|
/**
|
|
2828
|
-
* <p>If set to <code>TRUE</code>, the list returned includes waiting
|
|
2829
|
-
* queries. The default is <code>FALSE</code>;</p>
|
|
2517
|
+
* <p>If set to <code>TRUE</code>, the list returned includes waiting queries. The default is <code>FALSE</code>;</p>
|
|
2830
2518
|
* @public
|
|
2831
2519
|
*/
|
|
2832
2520
|
includeWaiting?: boolean | undefined;
|
|
2833
2521
|
}
|
|
2834
2522
|
/**
|
|
2835
|
-
* <p>Captures the status of a Gremlin query (see the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html">Gremlin query
|
|
2836
|
-
* status API</a> page).</p>
|
|
2523
|
+
* <p>Captures the status of a Gremlin query (see the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html">Gremlin query status API</a> page).</p>
|
|
2837
2524
|
* @public
|
|
2838
2525
|
*/
|
|
2839
2526
|
export interface GremlinQueryStatus {
|
|
@@ -2858,8 +2545,7 @@ export interface GremlinQueryStatus {
|
|
|
2858
2545
|
*/
|
|
2859
2546
|
export interface ListGremlinQueriesOutput {
|
|
2860
2547
|
/**
|
|
2861
|
-
* <p>The number of queries that have been accepted but not yet
|
|
2862
|
-
* completed, including queries in the queue.</p>
|
|
2548
|
+
* <p>The number of queries that have been accepted but not yet completed, including queries in the queue.</p>
|
|
2863
2549
|
* @public
|
|
2864
2550
|
*/
|
|
2865
2551
|
acceptedQueryCount?: number | undefined;
|
|
@@ -2879,16 +2565,12 @@ export interface ListGremlinQueriesOutput {
|
|
|
2879
2565
|
*/
|
|
2880
2566
|
export interface ListLoaderJobsInput {
|
|
2881
2567
|
/**
|
|
2882
|
-
* <p>The number of load IDs to list. Must be a positive integer
|
|
2883
|
-
* greater than zero and not more than <code>100</code> (which is the default).</p>
|
|
2568
|
+
* <p>The number of load IDs to list. Must be a positive integer greater than zero and not more than <code>100</code> (which is the default).</p>
|
|
2884
2569
|
* @public
|
|
2885
2570
|
*/
|
|
2886
2571
|
limit?: number | undefined;
|
|
2887
2572
|
/**
|
|
2888
|
-
* <p>An optional parameter that can be used to exclude the load
|
|
2889
|
-
* IDs of queued load requests when requesting a list of load IDs by
|
|
2890
|
-
* setting the parameter to <code>FALSE</code>. The default value
|
|
2891
|
-
* is <code>TRUE</code>.</p>
|
|
2573
|
+
* <p>An optional parameter that can be used to exclude the load IDs of queued load requests when requesting a list of load IDs by setting the parameter to <code>FALSE</code>. The default value is <code>TRUE</code>.</p>
|
|
2892
2574
|
* @public
|
|
2893
2575
|
*/
|
|
2894
2576
|
includeQueuedLoads?: boolean | undefined;
|
|
@@ -2929,9 +2611,7 @@ export interface ListMLDataProcessingJobsInput {
|
|
|
2929
2611
|
*/
|
|
2930
2612
|
maxItems?: number | undefined;
|
|
2931
2613
|
/**
|
|
2932
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
2933
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
2934
|
-
* parameter group or an error will occur.</p>
|
|
2614
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
2935
2615
|
* @public
|
|
2936
2616
|
*/
|
|
2937
2617
|
neptuneIamRoleArn?: string | undefined;
|
|
@@ -2951,15 +2631,12 @@ export interface ListMLDataProcessingJobsOutput {
|
|
|
2951
2631
|
*/
|
|
2952
2632
|
export interface ListMLEndpointsInput {
|
|
2953
2633
|
/**
|
|
2954
|
-
* <p>The maximum number of items to return (from 1 to 1024; the default
|
|
2955
|
-
* is 10.</p>
|
|
2634
|
+
* <p>The maximum number of items to return (from 1 to 1024; the default is 10.</p>
|
|
2956
2635
|
* @public
|
|
2957
2636
|
*/
|
|
2958
2637
|
maxItems?: number | undefined;
|
|
2959
2638
|
/**
|
|
2960
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
2961
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
2962
|
-
* parameter group or an error will occur.</p>
|
|
2639
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
2963
2640
|
* @public
|
|
2964
2641
|
*/
|
|
2965
2642
|
neptuneIamRoleArn?: string | undefined;
|
|
@@ -2979,15 +2656,12 @@ export interface ListMLEndpointsOutput {
|
|
|
2979
2656
|
*/
|
|
2980
2657
|
export interface ListMLModelTrainingJobsInput {
|
|
2981
2658
|
/**
|
|
2982
|
-
* <p>The maximum number of items to return (from 1 to 1024; the default
|
|
2983
|
-
* is 10).</p>
|
|
2659
|
+
* <p>The maximum number of items to return (from 1 to 1024; the default is 10).</p>
|
|
2984
2660
|
* @public
|
|
2985
2661
|
*/
|
|
2986
2662
|
maxItems?: number | undefined;
|
|
2987
2663
|
/**
|
|
2988
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
2989
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
2990
|
-
* parameter group or an error will occur.</p>
|
|
2664
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
2991
2665
|
* @public
|
|
2992
2666
|
*/
|
|
2993
2667
|
neptuneIamRoleArn?: string | undefined;
|
|
@@ -3007,15 +2681,12 @@ export interface ListMLModelTrainingJobsOutput {
|
|
|
3007
2681
|
*/
|
|
3008
2682
|
export interface ListMLModelTransformJobsInput {
|
|
3009
2683
|
/**
|
|
3010
|
-
* <p>The maximum number of items to return (from 1 to 1024; the
|
|
3011
|
-
* default is 10).</p>
|
|
2684
|
+
* <p>The maximum number of items to return (from 1 to 1024; the default is 10).</p>
|
|
3012
2685
|
* @public
|
|
3013
2686
|
*/
|
|
3014
2687
|
maxItems?: number | undefined;
|
|
3015
2688
|
/**
|
|
3016
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
3017
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
3018
|
-
* parameter group or an error will occur.</p>
|
|
2689
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
3019
2690
|
* @public
|
|
3020
2691
|
*/
|
|
3021
2692
|
neptuneIamRoleArn?: string | undefined;
|
|
@@ -3035,9 +2706,7 @@ export interface ListMLModelTransformJobsOutput {
|
|
|
3035
2706
|
*/
|
|
3036
2707
|
export interface ListOpenCypherQueriesInput {
|
|
3037
2708
|
/**
|
|
3038
|
-
* <p> When set to <code>TRUE</code> and other parameters are not
|
|
3039
|
-
* present, causes status information to be returned for waiting
|
|
3040
|
-
* queries as well as for running queries.</p>
|
|
2709
|
+
* <p> When set to <code>TRUE</code> and other parameters are not present, causes status information to be returned for waiting queries as well as for running queries.</p>
|
|
3041
2710
|
* @public
|
|
3042
2711
|
*/
|
|
3043
2712
|
includeWaiting?: boolean | undefined;
|
|
@@ -3047,8 +2716,7 @@ export interface ListOpenCypherQueriesInput {
|
|
|
3047
2716
|
*/
|
|
3048
2717
|
export interface ListOpenCypherQueriesOutput {
|
|
3049
2718
|
/**
|
|
3050
|
-
* <p>The number of queries that have been accepted but not yet completed,
|
|
3051
|
-
* including queries in the queue.</p>
|
|
2719
|
+
* <p>The number of queries that have been accepted but not yet completed, including queries in the queue.</p>
|
|
3052
2720
|
* @public
|
|
3053
2721
|
*/
|
|
3054
2722
|
acceptedQueryCount?: number | undefined;
|
|
@@ -3081,9 +2749,7 @@ export type StatisticsAutoGenerationMode = (typeof StatisticsAutoGenerationMode)
|
|
|
3081
2749
|
*/
|
|
3082
2750
|
export interface ManagePropertygraphStatisticsInput {
|
|
3083
2751
|
/**
|
|
3084
|
-
* <p>The statistics generation mode. One of: <code>DISABLE_AUTOCOMPUTE</code>,
|
|
3085
|
-
* <code>ENABLE_AUTOCOMPUTE</code>, or <code>REFRESH</code>, the last of
|
|
3086
|
-
* which manually triggers DFE statistics generation.</p>
|
|
2752
|
+
* <p>The statistics generation mode. One of: <code>DISABLE_AUTOCOMPUTE</code>, <code>ENABLE_AUTOCOMPUTE</code>, or <code>REFRESH</code>, the last of which manually triggers DFE statistics generation.</p>
|
|
3087
2753
|
* @public
|
|
3088
2754
|
*/
|
|
3089
2755
|
mode?: StatisticsAutoGenerationMode | undefined;
|
|
@@ -3104,8 +2770,7 @@ export interface RefreshStatisticsIdMap {
|
|
|
3104
2770
|
*/
|
|
3105
2771
|
export interface ManagePropertygraphStatisticsOutput {
|
|
3106
2772
|
/**
|
|
3107
|
-
* <p>The HTTP return code of the request. If the request succeeded,
|
|
3108
|
-
* the code is 200.</p>
|
|
2773
|
+
* <p>The HTTP return code of the request. If the request succeeded, the code is 200.</p>
|
|
3109
2774
|
* @public
|
|
3110
2775
|
*/
|
|
3111
2776
|
status: string | undefined;
|
|
@@ -3120,9 +2785,7 @@ export interface ManagePropertygraphStatisticsOutput {
|
|
|
3120
2785
|
*/
|
|
3121
2786
|
export interface ManageSparqlStatisticsInput {
|
|
3122
2787
|
/**
|
|
3123
|
-
* <p>The statistics generation mode. One of: <code>DISABLE_AUTOCOMPUTE</code>,
|
|
3124
|
-
* <code>ENABLE_AUTOCOMPUTE</code>, or <code>REFRESH</code>, the last of
|
|
3125
|
-
* which manually triggers DFE statistics generation.</p>
|
|
2788
|
+
* <p>The statistics generation mode. One of: <code>DISABLE_AUTOCOMPUTE</code>, <code>ENABLE_AUTOCOMPUTE</code>, or <code>REFRESH</code>, the last of which manually triggers DFE statistics generation.</p>
|
|
3126
2789
|
* @public
|
|
3127
2790
|
*/
|
|
3128
2791
|
mode?: StatisticsAutoGenerationMode | undefined;
|
|
@@ -3132,8 +2795,7 @@ export interface ManageSparqlStatisticsInput {
|
|
|
3132
2795
|
*/
|
|
3133
2796
|
export interface ManageSparqlStatisticsOutput {
|
|
3134
2797
|
/**
|
|
3135
|
-
* <p>The HTTP return code of the request. If the request succeeded,
|
|
3136
|
-
* the code is 200.</p>
|
|
2798
|
+
* <p>The HTTP return code of the request. If the request succeeded, the code is 200.</p>
|
|
3137
2799
|
* @public
|
|
3138
2800
|
*/
|
|
3139
2801
|
status: string | undefined;
|
|
@@ -3221,20 +2883,33 @@ export type Parallelism = (typeof Parallelism)[keyof typeof Parallelism];
|
|
|
3221
2883
|
export declare const S3BucketRegion: {
|
|
3222
2884
|
readonly AF_SOUTH_1: "af-south-1";
|
|
3223
2885
|
readonly AP_EAST_1: "ap-east-1";
|
|
2886
|
+
readonly AP_EAST_2: "ap-east-2";
|
|
3224
2887
|
readonly AP_NORTHEAST_1: "ap-northeast-1";
|
|
3225
2888
|
readonly AP_NORTHEAST_2: "ap-northeast-2";
|
|
2889
|
+
readonly AP_NORTHEAST_3: "ap-northeast-3";
|
|
3226
2890
|
readonly AP_SOUTHEAST_1: "ap-southeast-1";
|
|
3227
2891
|
readonly AP_SOUTHEAST_2: "ap-southeast-2";
|
|
2892
|
+
readonly AP_SOUTHEAST_3: "ap-southeast-3";
|
|
2893
|
+
readonly AP_SOUTHEAST_4: "ap-southeast-4";
|
|
2894
|
+
readonly AP_SOUTHEAST_5: "ap-southeast-5";
|
|
2895
|
+
readonly AP_SOUTHEAST_7: "ap-southeast-7";
|
|
3228
2896
|
readonly AP_SOUTH_1: "ap-south-1";
|
|
2897
|
+
readonly AP_SOUTH_2: "ap-south-2";
|
|
3229
2898
|
readonly CA_CENTRAL_1: "ca-central-1";
|
|
2899
|
+
readonly CA_WEST_1: "ca-west-1";
|
|
3230
2900
|
readonly CN_NORTHWEST_1: "cn-northwest-1";
|
|
3231
2901
|
readonly CN_NORTH_1: "cn-north-1";
|
|
3232
2902
|
readonly EU_CENTRAL_1: "eu-central-1";
|
|
2903
|
+
readonly EU_CENTRAL_2: "eu-central-2";
|
|
3233
2904
|
readonly EU_NORTH_1: "eu-north-1";
|
|
2905
|
+
readonly EU_SOUTH_2: "eu-south-2";
|
|
3234
2906
|
readonly EU_WEST_1: "eu-west-1";
|
|
3235
2907
|
readonly EU_WEST_2: "eu-west-2";
|
|
3236
2908
|
readonly EU_WEST_3: "eu-west-3";
|
|
2909
|
+
readonly IL_CENTRAL_1: "il-central-1";
|
|
2910
|
+
readonly ME_CENTRAL_1: "me-central-1";
|
|
3237
2911
|
readonly ME_SOUTH_1: "me-south-1";
|
|
2912
|
+
readonly MX_CENTRAL_1: "mx-central-1";
|
|
3238
2913
|
readonly SA_EAST_1: "sa-east-1";
|
|
3239
2914
|
readonly US_EAST_1: "us-east-1";
|
|
3240
2915
|
readonly US_EAST_2: "us-east-2";
|
|
@@ -3252,84 +2927,12 @@ export type S3BucketRegion = (typeof S3BucketRegion)[keyof typeof S3BucketRegion
|
|
|
3252
2927
|
*/
|
|
3253
2928
|
export interface StartLoaderJobInput {
|
|
3254
2929
|
/**
|
|
3255
|
-
* <p>The <code>source</code> parameter accepts an S3 URI that identifies a single
|
|
3256
|
-
* file, multiple files, a folder, or multiple folders. Neptune loads every data file
|
|
3257
|
-
* in any folder that is specified.</p>
|
|
3258
|
-
* <p>The URI can be in any of the following formats.</p>
|
|
3259
|
-
* <ul>
|
|
3260
|
-
* <li>
|
|
3261
|
-
* <p>
|
|
3262
|
-
* <code>s3://(bucket_name)/(object-key-name)</code>
|
|
3263
|
-
* </p>
|
|
3264
|
-
* </li>
|
|
3265
|
-
* <li>
|
|
3266
|
-
* <p>
|
|
3267
|
-
* <code>https://s3.amazonaws.com/(bucket_name)/(object-key-name)</code>
|
|
3268
|
-
* </p>
|
|
3269
|
-
* </li>
|
|
3270
|
-
* <li>
|
|
3271
|
-
* <p>
|
|
3272
|
-
* <code>https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)</code>
|
|
3273
|
-
* </p>
|
|
3274
|
-
* </li>
|
|
3275
|
-
* </ul>
|
|
3276
|
-
* <p>The <code>object-key-name</code> element of the URI is equivalent to the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters">prefix</a>
|
|
3277
|
-
* parameter in an S3 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>
|
|
3278
|
-
* API call. It identifies all the objects in the specified S3 bucket whose names begin with
|
|
3279
|
-
* that prefix. That can be a single file or folder, or multiple files and/or folders.</p>
|
|
3280
|
-
* <p>The specified folder or folders can contain multiple vertex files and multiple edge files.</p>
|
|
2930
|
+
* <p>The <code>source</code> parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders. Neptune loads every data file in any folder that is specified.</p> <p>The URI can be in any of the following formats.</p> <ul> <li> <p> <code>s3://(bucket_name)/(object-key-name)</code> </p> </li> <li> <p> <code>https://s3.amazonaws.com/(bucket_name)/(object-key-name)</code> </p> </li> <li> <p> <code>https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)</code> </p> </li> </ul> <p>The <code>object-key-name</code> element of the URI is equivalent to the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters">prefix</a> parameter in an S3 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> API call. It identifies all the objects in the specified S3 bucket whose names begin with that prefix. That can be a single file or folder, or multiple files and/or folders.</p> <p>The specified folder or folders can contain multiple vertex files and multiple edge files.</p>
|
|
3281
2931
|
* @public
|
|
3282
2932
|
*/
|
|
3283
2933
|
source: string | undefined;
|
|
3284
2934
|
/**
|
|
3285
|
-
* <p>The format of the data. For more information about data formats for the Neptune
|
|
3286
|
-
* <code>Loader</code> command, see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html">Load Data Formats</a>.</p>
|
|
3287
|
-
* <p class="title">
|
|
3288
|
-
* <b>Allowed values</b>
|
|
3289
|
-
* </p>
|
|
3290
|
-
* <ul>
|
|
3291
|
-
* <li>
|
|
3292
|
-
* <p>
|
|
3293
|
-
* <b>
|
|
3294
|
-
* <code>csv</code>
|
|
3295
|
-
* </b> for the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin CSV data format</a>.</p>
|
|
3296
|
-
* </li>
|
|
3297
|
-
* <li>
|
|
3298
|
-
* <p>
|
|
3299
|
-
* <b>
|
|
3300
|
-
* <code>opencypher</code>
|
|
3301
|
-
* </b> for the
|
|
3302
|
-
* <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher CSV data format</a>.</p>
|
|
3303
|
-
* </li>
|
|
3304
|
-
* <li>
|
|
3305
|
-
* <p>
|
|
3306
|
-
* <b>
|
|
3307
|
-
* <code>ntriples</code>
|
|
3308
|
-
* </b> for the
|
|
3309
|
-
* <a href="https://www.w3.org/TR/n-triples/">N-Triples RDF data format</a>.</p>
|
|
3310
|
-
* </li>
|
|
3311
|
-
* <li>
|
|
3312
|
-
* <p>
|
|
3313
|
-
* <b>
|
|
3314
|
-
* <code>nquads</code>
|
|
3315
|
-
* </b> for the
|
|
3316
|
-
* <a href="https://www.w3.org/TR/n-quads/">N-Quads RDF data format</a>.</p>
|
|
3317
|
-
* </li>
|
|
3318
|
-
* <li>
|
|
3319
|
-
* <p>
|
|
3320
|
-
* <b>
|
|
3321
|
-
* <code>rdfxml</code>
|
|
3322
|
-
* </b> for the
|
|
3323
|
-
* <a href="https://www.w3.org/TR/rdf-syntax-grammar/">RDF\XML RDF data format</a>.</p>
|
|
3324
|
-
* </li>
|
|
3325
|
-
* <li>
|
|
3326
|
-
* <p>
|
|
3327
|
-
* <b>
|
|
3328
|
-
* <code>turtle</code>
|
|
3329
|
-
* </b> for the
|
|
3330
|
-
* <a href="https://www.w3.org/TR/turtle/">Turtle RDF data format</a>.</p>
|
|
3331
|
-
* </li>
|
|
3332
|
-
* </ul>
|
|
2935
|
+
* <p>The format of the data. For more information about data formats for the Neptune <code>Loader</code> command, see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html">Load Data Formats</a>.</p> <p class="title"> <b>Allowed values</b> </p> <ul> <li> <p> <b> <code>csv</code> </b> for the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html">Gremlin CSV data format</a>.</p> </li> <li> <p> <b> <code>opencypher</code> </b> for the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html">openCypher CSV data format</a>.</p> </li> <li> <p> <b> <code>ntriples</code> </b> for the <a href="https://www.w3.org/TR/n-triples/">N-Triples RDF data format</a>.</p> </li> <li> <p> <b> <code>nquads</code> </b> for the <a href="https://www.w3.org/TR/n-quads/">N-Quads RDF data format</a>.</p> </li> <li> <p> <b> <code>rdfxml</code> </b> for the <a href="https://www.w3.org/TR/rdf-syntax-grammar/">RDF\XML RDF data format</a>.</p> </li> <li> <p> <b> <code>turtle</code> </b> for the <a href="https://www.w3.org/TR/turtle/">Turtle RDF data format</a>.</p> </li> </ul>
|
|
3333
2936
|
* @public
|
|
3334
2937
|
*/
|
|
3335
2938
|
format: Format | undefined;
|
|
@@ -3339,244 +2942,47 @@ export interface StartLoaderJobInput {
|
|
|
3339
2942
|
*/
|
|
3340
2943
|
s3BucketRegion: S3BucketRegion | undefined;
|
|
3341
2944
|
/**
|
|
3342
|
-
* <p>The Amazon Resource Name (ARN) for an IAM role to be assumed by
|
|
3343
|
-
* the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided
|
|
3344
|
-
* here should be attached to the DB cluster (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html">Adding
|
|
3345
|
-
* the IAM Role to an Amazon Neptune Cluster</a>.</p>
|
|
2945
|
+
* <p>The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be attached to the DB cluster (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html">Adding the IAM Role to an Amazon Neptune Cluster</a>.</p>
|
|
3346
2946
|
* @public
|
|
3347
2947
|
*/
|
|
3348
2948
|
iamRoleArn: string | undefined;
|
|
3349
2949
|
/**
|
|
3350
|
-
* <p>The load job mode.</p>
|
|
3351
|
-
* <p>
|
|
3352
|
-
* <i>Allowed values</i>: <code>RESUME</code>, <code>NEW</code>,
|
|
3353
|
-
* <code>AUTO</code>.</p>
|
|
3354
|
-
* <p>
|
|
3355
|
-
* <i>Default value</i>: <code>AUTO</code>.</p>
|
|
3356
|
-
* <p class="title">
|
|
3357
|
-
* <b/>
|
|
3358
|
-
* </p>
|
|
3359
|
-
* <ul>
|
|
3360
|
-
* <li>
|
|
3361
|
-
* <p>
|
|
3362
|
-
* <code>RESUME</code> – In RESUME mode,
|
|
3363
|
-
* the loader looks for a previous load from this source, and if it finds
|
|
3364
|
-
* one, resumes that load job. If no previous load job is found, the loader stops.</p>
|
|
3365
|
-
* <p>The loader avoids reloading files that were successfully loaded in
|
|
3366
|
-
* a previous job. It only tries to process failed files. If you dropped
|
|
3367
|
-
* previously loaded data from your Neptune cluster, that data is not
|
|
3368
|
-
* reloaded in this mode. If a previous load job loaded all files from the
|
|
3369
|
-
* same source successfully, nothing is reloaded, and the loader returns
|
|
3370
|
-
* success.</p>
|
|
3371
|
-
* </li>
|
|
3372
|
-
* <li>
|
|
3373
|
-
* <p>
|
|
3374
|
-
* <code>NEW</code> – In NEW mode, the
|
|
3375
|
-
* creates a new load request regardless of any previous loads. You
|
|
3376
|
-
* can use this mode to reload all the data from a source after dropping
|
|
3377
|
-
* previously loaded data from your Neptune cluster, or to load new data
|
|
3378
|
-
* available at the same source.</p>
|
|
3379
|
-
* </li>
|
|
3380
|
-
* <li>
|
|
3381
|
-
* <p>
|
|
3382
|
-
* <code>AUTO</code> – In AUTO mode,
|
|
3383
|
-
* the loader looks for a previous load job from the same source, and if it
|
|
3384
|
-
* finds one, resumes that job, just as in <code>RESUME</code> mode.</p>
|
|
3385
|
-
* <p>If the loader doesn't find a previous load job from the same
|
|
3386
|
-
* source, it loads all data from the source, just as in <code>NEW</code>
|
|
3387
|
-
* mode.</p>
|
|
3388
|
-
* </li>
|
|
3389
|
-
* </ul>
|
|
2950
|
+
* <p>The load job mode.</p> <p> <i>Allowed values</i>: <code>RESUME</code>, <code>NEW</code>, <code>AUTO</code>.</p> <p> <i>Default value</i>: <code>AUTO</code>.</p> <p class="title"> <b/> </p> <ul> <li> <p> <code>RESUME</code> – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.</p> <p>The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.</p> </li> <li> <p> <code>NEW</code> – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.</p> </li> <li> <p> <code>AUTO</code> – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in <code>RESUME</code> mode.</p> <p>If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in <code>NEW</code> mode.</p> </li> </ul>
|
|
3390
2951
|
* @public
|
|
3391
2952
|
*/
|
|
3392
2953
|
mode?: Mode | undefined;
|
|
3393
2954
|
/**
|
|
3394
|
-
* <p>
|
|
3395
|
-
* <b>
|
|
3396
|
-
* <code>failOnError</code>
|
|
3397
|
-
* </b> – A flag to toggle a
|
|
3398
|
-
* complete stop on an error.</p>
|
|
3399
|
-
* <p>
|
|
3400
|
-
* <i>Allowed values</i>: <code>"TRUE"</code>, <code>"FALSE"</code>.</p>
|
|
3401
|
-
* <p>
|
|
3402
|
-
* <i>Default value</i>: <code>"TRUE"</code>.</p>
|
|
3403
|
-
* <p>When this parameter is set to <code>"FALSE"</code>, the loader tries to load all
|
|
3404
|
-
* the data in the location specified, skipping any entries with errors.</p>
|
|
3405
|
-
* <p>When this parameter is set to <code>"TRUE"</code>, the loader stops
|
|
3406
|
-
* as soon as it encounters an error. Data loaded up to that point persists.</p>
|
|
2955
|
+
* <p> <b> <code>failOnError</code> </b> – A flag to toggle a complete stop on an error.</p> <p> <i>Allowed values</i>: <code>"TRUE"</code>, <code>"FALSE"</code>.</p> <p> <i>Default value</i>: <code>"TRUE"</code>.</p> <p>When this parameter is set to <code>"FALSE"</code>, the loader tries to load all the data in the location specified, skipping any entries with errors.</p> <p>When this parameter is set to <code>"TRUE"</code>, the loader stops as soon as it encounters an error. Data loaded up to that point persists.</p>
|
|
3407
2956
|
* @public
|
|
3408
2957
|
*/
|
|
3409
2958
|
failOnError?: boolean | undefined;
|
|
3410
2959
|
/**
|
|
3411
|
-
* <p>The optional <code>parallelism</code> parameter can be set
|
|
3412
|
-
* to reduce the number of threads used by the bulk load process.</p>
|
|
3413
|
-
* <p>
|
|
3414
|
-
* <i>Allowed values</i>:</p>
|
|
3415
|
-
* <ul>
|
|
3416
|
-
* <li>
|
|
3417
|
-
* <p>
|
|
3418
|
-
* <code>LOW</code> – The number of threads used is the
|
|
3419
|
-
* number of available vCPUs divided by 8.</p>
|
|
3420
|
-
* </li>
|
|
3421
|
-
* <li>
|
|
3422
|
-
* <p>
|
|
3423
|
-
* <code>MEDIUM</code> – The number of threads used is the
|
|
3424
|
-
* number of available vCPUs divided by 2.</p>
|
|
3425
|
-
* </li>
|
|
3426
|
-
* <li>
|
|
3427
|
-
* <p>
|
|
3428
|
-
* <code>HIGH</code> – The number of threads used is the
|
|
3429
|
-
* same as the number of available vCPUs.</p>
|
|
3430
|
-
* </li>
|
|
3431
|
-
* <li>
|
|
3432
|
-
* <p>
|
|
3433
|
-
* <code>OVERSUBSCRIBE</code> – The number of threads used is the
|
|
3434
|
-
* number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all
|
|
3435
|
-
* available resources.</p>
|
|
3436
|
-
* <p>This does not mean, however, that the <code>OVERSUBSCRIBE</code> setting
|
|
3437
|
-
* results in 100% CPU utilization. Because the load operation is I/O bound, the
|
|
3438
|
-
* highest CPU utilization to expect is in the 60% to 70% range.</p>
|
|
3439
|
-
* </li>
|
|
3440
|
-
* </ul>
|
|
3441
|
-
* <p>
|
|
3442
|
-
* <i>Default value</i>: <code>HIGH</code>
|
|
3443
|
-
* </p>
|
|
3444
|
-
* <p>The <code>parallelism</code> setting can sometimes result in a deadlock
|
|
3445
|
-
* between threads when loading openCypher data. When this happens, Neptune returns the
|
|
3446
|
-
* <code>LOAD_DATA_DEADLOCK</code> error. You can generally fix the issue by setting
|
|
3447
|
-
* <code>parallelism</code> to a lower setting and retrying the load command.</p>
|
|
2960
|
+
* <p>The optional <code>parallelism</code> parameter can be set to reduce the number of threads used by the bulk load process.</p> <p> <i>Allowed values</i>:</p> <ul> <li> <p> <code>LOW</code> – The number of threads used is the number of available vCPUs divided by 8.</p> </li> <li> <p> <code>MEDIUM</code> – The number of threads used is the number of available vCPUs divided by 2.</p> </li> <li> <p> <code>HIGH</code> – The number of threads used is the same as the number of available vCPUs.</p> </li> <li> <p> <code>OVERSUBSCRIBE</code> – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.</p> <p>This does not mean, however, that the <code>OVERSUBSCRIBE</code> setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.</p> </li> </ul> <p> <i>Default value</i>: <code>HIGH</code> </p> <p>The <code>parallelism</code> setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the <code>LOAD_DATA_DEADLOCK</code> error. You can generally fix the issue by setting <code>parallelism</code> to a lower setting and retrying the load command.</p>
|
|
3448
2961
|
* @public
|
|
3449
2962
|
*/
|
|
3450
2963
|
parallelism?: Parallelism | undefined;
|
|
3451
2964
|
/**
|
|
3452
|
-
* <p>
|
|
3453
|
-
* <b>
|
|
3454
|
-
* <code>parserConfiguration</code>
|
|
3455
|
-
* </b>
|
|
3456
|
-
* – An optional object with additional parser configuration values.
|
|
3457
|
-
* Each of the child parameters is also optional:</p>
|
|
3458
|
-
* <p class="title">
|
|
3459
|
-
* <b/>
|
|
3460
|
-
* </p>
|
|
3461
|
-
* <ul>
|
|
3462
|
-
* <li>
|
|
3463
|
-
* <p>
|
|
3464
|
-
* <b>
|
|
3465
|
-
* <code>namedGraphUri</code>
|
|
3466
|
-
* </b> –
|
|
3467
|
-
* The default graph for all RDF formats when no graph is specified (for non-quads
|
|
3468
|
-
* formats and NQUAD entries with no graph).</p>
|
|
3469
|
-
* <p>The default is <code>https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph</code>.</p>
|
|
3470
|
-
* </li>
|
|
3471
|
-
* <li>
|
|
3472
|
-
* <p>
|
|
3473
|
-
* <b>
|
|
3474
|
-
* <code>baseUri</code>
|
|
3475
|
-
* </b> –
|
|
3476
|
-
* The base URI for RDF/XML and Turtle formats.</p>
|
|
3477
|
-
* <p>The default is <code>https://aws.amazon.com/neptune/default</code>.</p>
|
|
3478
|
-
* </li>
|
|
3479
|
-
* <li>
|
|
3480
|
-
* <p>
|
|
3481
|
-
* <b>
|
|
3482
|
-
* <code>allowEmptyStrings</code>
|
|
3483
|
-
* </b> –
|
|
3484
|
-
* Gremlin users need to be able to pass empty string values("") as node
|
|
3485
|
-
* and edge properties when loading CSV data. If <code>allowEmptyStrings</code>
|
|
3486
|
-
* is set to <code>false</code> (the default), such empty strings are treated
|
|
3487
|
-
* as nulls and are not loaded.</p>
|
|
3488
|
-
* <p>If <code>allowEmptyStrings</code> is set to <code>true</code>,
|
|
3489
|
-
* the loader treats empty strings as valid property values and loads
|
|
3490
|
-
* them accordingly.</p>
|
|
3491
|
-
* </li>
|
|
3492
|
-
* </ul>
|
|
2965
|
+
* <p> <b> <code>parserConfiguration</code> </b> – An optional object with additional parser configuration values. Each of the child parameters is also optional:</p> <p class="title"> <b/> </p> <ul> <li> <p> <b> <code>namedGraphUri</code> </b> – The default graph for all RDF formats when no graph is specified (for non-quads formats and NQUAD entries with no graph).</p> <p>The default is <code>https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph</code>.</p> </li> <li> <p> <b> <code>baseUri</code> </b> – The base URI for RDF/XML and Turtle formats.</p> <p>The default is <code>https://aws.amazon.com/neptune/default</code>.</p> </li> <li> <p> <b> <code>allowEmptyStrings</code> </b> – Gremlin users need to be able to pass empty string values("") as node and edge properties when loading CSV data. If <code>allowEmptyStrings</code> is set to <code>false</code> (the default), such empty strings are treated as nulls and are not loaded.</p> <p>If <code>allowEmptyStrings</code> is set to <code>true</code>, the loader treats empty strings as valid property values and loads them accordingly.</p> </li> </ul>
|
|
3493
2966
|
* @public
|
|
3494
2967
|
*/
|
|
3495
2968
|
parserConfiguration?: Record<string, string> | undefined;
|
|
3496
2969
|
/**
|
|
3497
|
-
* <p>
|
|
3498
|
-
* <code>updateSingleCardinalityProperties</code>
|
|
3499
|
-
* is an optional parameter that controls how the bulk loader treats a new
|
|
3500
|
-
* value for single-cardinality vertex or edge properties. This is not supported for
|
|
3501
|
-
* loading openCypher data.</p>
|
|
3502
|
-
* <p>
|
|
3503
|
-
* <i>Allowed values</i>: <code>"TRUE"</code>, <code>"FALSE"</code>.</p>
|
|
3504
|
-
* <p>
|
|
3505
|
-
* <i>Default value</i>: <code>"FALSE"</code>.</p>
|
|
3506
|
-
* <p>By default, or when <code>updateSingleCardinalityProperties</code> is explicitly
|
|
3507
|
-
* set to <code>"FALSE"</code>, the loader treats a new value as an error, because it
|
|
3508
|
-
* violates single cardinality.</p>
|
|
3509
|
-
* <p>When <code>updateSingleCardinalityProperties</code> is set to <code>"TRUE"</code>,
|
|
3510
|
-
* on the other hand, the bulk loader replaces the existing value with the new one.
|
|
3511
|
-
* If multiple edge or single-cardinality vertex property values are provided in the
|
|
3512
|
-
* source file(s) being loaded, the final value at the end of the bulk load could be
|
|
3513
|
-
* any one of those new values. The loader only guarantees that the existing value
|
|
3514
|
-
* has been replaced by one of the new ones.</p>
|
|
2970
|
+
* <p> <code>updateSingleCardinalityProperties</code> is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.</p> <p> <i>Allowed values</i>: <code>"TRUE"</code>, <code>"FALSE"</code>.</p> <p> <i>Default value</i>: <code>"FALSE"</code>.</p> <p>By default, or when <code>updateSingleCardinalityProperties</code> is explicitly set to <code>"FALSE"</code>, the loader treats a new value as an error, because it violates single cardinality.</p> <p>When <code>updateSingleCardinalityProperties</code> is set to <code>"TRUE"</code>, on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.</p>
|
|
3515
2971
|
* @public
|
|
3516
2972
|
*/
|
|
3517
2973
|
updateSingleCardinalityProperties?: boolean | undefined;
|
|
3518
2974
|
/**
|
|
3519
|
-
* <p>This is an optional flag parameter
|
|
3520
|
-
* that indicates whether the load request can be queued up or not. </p>
|
|
3521
|
-
* <p>You don't have to wait for one load job to complete before issuing the next one,
|
|
3522
|
-
* because Neptune can queue up as many as 64 jobs at a time, provided that their
|
|
3523
|
-
* <code>queueRequest</code> parameters are all set to <code>"TRUE"</code>.
|
|
3524
|
-
* The queue order of the jobs will be first-in-first-out (FIFO).</p>
|
|
3525
|
-
* <p>If the <code>queueRequest</code> parameter is omitted or set to <code>"FALSE"</code>,
|
|
3526
|
-
* the load request will fail if another load job is already running.</p>
|
|
3527
|
-
* <p>
|
|
3528
|
-
* <i>Allowed values</i>: <code>"TRUE"</code>, <code>"FALSE"</code>.</p>
|
|
3529
|
-
* <p>
|
|
3530
|
-
* <i>Default value</i>: <code>"FALSE"</code>.</p>
|
|
2975
|
+
* <p>This is an optional flag parameter that indicates whether the load request can be queued up or not. </p> <p>You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their <code>queueRequest</code> parameters are all set to <code>"TRUE"</code>. The queue order of the jobs will be first-in-first-out (FIFO).</p> <p>If the <code>queueRequest</code> parameter is omitted or set to <code>"FALSE"</code>, the load request will fail if another load job is already running.</p> <p> <i>Allowed values</i>: <code>"TRUE"</code>, <code>"FALSE"</code>.</p> <p> <i>Default value</i>: <code>"FALSE"</code>.</p>
|
|
3531
2976
|
* @public
|
|
3532
2977
|
*/
|
|
3533
2978
|
queueRequest?: boolean | undefined;
|
|
3534
2979
|
/**
|
|
3535
|
-
* <p>This is an optional parameter that can make a queued load request
|
|
3536
|
-
* contingent on the successful completion of one or more previous jobs
|
|
3537
|
-
* in the queue.</p>
|
|
3538
|
-
* <p>Neptune can queue up as many as 64 load requests at a time, if their
|
|
3539
|
-
* <code>queueRequest</code> parameters are set to <code>"TRUE"</code>. The
|
|
3540
|
-
* <code>dependencies</code> parameter lets you make execution of such a queued request
|
|
3541
|
-
* dependent on the successful completion of one or more specified previous requests
|
|
3542
|
-
* in the queue.</p>
|
|
3543
|
-
* <p>For example, if load <code>Job-A</code> and <code>Job-B</code> are independent
|
|
3544
|
-
* of each other, but load <code>Job-C</code> needs <code>Job-A</code> and <code>Job-B</code>
|
|
3545
|
-
* to be finished before it begins, proceed as follows:</p>
|
|
3546
|
-
* <ol>
|
|
3547
|
-
* <li>
|
|
3548
|
-
* <p>Submit <code>load-job-A</code> and <code>load-job-B</code> one after
|
|
3549
|
-
* another in any order, and save their load-ids.</p>
|
|
3550
|
-
* </li>
|
|
3551
|
-
* <li>
|
|
3552
|
-
* <p>Submit <code>load-job-C</code> with the load-ids of the
|
|
3553
|
-
* two jobs in its <code>dependencies</code> field:</p>
|
|
3554
|
-
* </li>
|
|
3555
|
-
* </ol>
|
|
3556
|
-
* <p>Because of the <code>dependencies</code> parameter, the bulk loader will not start
|
|
3557
|
-
* <code>Job-C</code> until <code>Job-A</code> and <code>Job-B</code> have completed
|
|
3558
|
-
* successfully. If either one of them fails, Job-C will not be executed, and its
|
|
3559
|
-
* status will be set to <code>LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED</code>.</p>
|
|
3560
|
-
* <p>You can set up multiple levels of dependency in this way, so that the failure of one job
|
|
3561
|
-
* will cause all requests that are directly or indirectly dependent on it to be cancelled.</p>
|
|
2980
|
+
* <p>This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.</p> <p>Neptune can queue up as many as 64 load requests at a time, if their <code>queueRequest</code> parameters are set to <code>"TRUE"</code>. The <code>dependencies</code> parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.</p> <p>For example, if load <code>Job-A</code> and <code>Job-B</code> are independent of each other, but load <code>Job-C</code> needs <code>Job-A</code> and <code>Job-B</code> to be finished before it begins, proceed as follows:</p> <ol> <li> <p>Submit <code>load-job-A</code> and <code>load-job-B</code> one after another in any order, and save their load-ids.</p> </li> <li> <p>Submit <code>load-job-C</code> with the load-ids of the two jobs in its <code>dependencies</code> field:</p> </li> </ol> <p>Because of the <code>dependencies</code> parameter, the bulk loader will not start <code>Job-C</code> until <code>Job-A</code> and <code>Job-B</code> have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to <code>LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED</code>.</p> <p>You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.</p>
|
|
3562
2981
|
* @public
|
|
3563
2982
|
*/
|
|
3564
2983
|
dependencies?: string[] | undefined;
|
|
3565
2984
|
/**
|
|
3566
|
-
* <p>This parameter is required only when loading openCypher data that contains relationship
|
|
3567
|
-
* IDs. It must be included and set to <code>True</code> when openCypher relationship IDs
|
|
3568
|
-
* are explicitly provided in the load data (recommended).</p>
|
|
3569
|
-
* <p>When <code>userProvidedEdgeIds</code> is absent or set to <code>True</code>,
|
|
3570
|
-
* an <code>:ID</code> column must be present in every relationship file in the load.</p>
|
|
3571
|
-
* <p>When <code>userProvidedEdgeIds</code> is present and set to <code>False</code>,
|
|
3572
|
-
* relationship files in the load <b>must not</b> contain an
|
|
3573
|
-
* <code>:ID</code> column. Instead, the Neptune loader automatically generates an
|
|
3574
|
-
* ID for each relationship.</p>
|
|
3575
|
-
* <p>It's useful to provide relationship IDs explicitly so that the loader can resume
|
|
3576
|
-
* loading after error in the CSV data have been fixed, without having to reload any
|
|
3577
|
-
* relationships that have already been loaded. If relationship IDs have not been
|
|
3578
|
-
* explicitly assigned, the loader cannot resume a failed load if any relationship file
|
|
3579
|
-
* has had to be corrected, and must instead reload all the relationships.</p>
|
|
2985
|
+
* <p>This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to <code>True</code> when openCypher relationship IDs are explicitly provided in the load data (recommended).</p> <p>When <code>userProvidedEdgeIds</code> is absent or set to <code>True</code>, an <code>:ID</code> column must be present in every relationship file in the load.</p> <p>When <code>userProvidedEdgeIds</code> is present and set to <code>False</code>, relationship files in the load <b>must not</b> contain an <code>:ID</code> column. Instead, the Neptune loader automatically generates an ID for each relationship.</p> <p>It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.</p>
|
|
3580
2986
|
* @public
|
|
3581
2987
|
*/
|
|
3582
2988
|
userProvidedEdgeIds?: boolean | undefined;
|
|
@@ -3591,8 +2997,7 @@ export interface StartLoaderJobOutput {
|
|
|
3591
2997
|
*/
|
|
3592
2998
|
status: string | undefined;
|
|
3593
2999
|
/**
|
|
3594
|
-
* <p>Contains a <code>loadId</code> name-value pair that provides an identifier
|
|
3595
|
-
* for the load operation.</p>
|
|
3000
|
+
* <p>Contains a <code>loadId</code> name-value pair that provides an identifier for the load operation.</p>
|
|
3596
3001
|
* @public
|
|
3597
3002
|
*/
|
|
3598
3003
|
payload: Record<string, string> | undefined;
|
|
@@ -3612,43 +3017,32 @@ export interface StartMLDataProcessingJobInput {
|
|
|
3612
3017
|
*/
|
|
3613
3018
|
previousDataProcessingJobId?: string | undefined;
|
|
3614
3019
|
/**
|
|
3615
|
-
* <p>The URI of the Amazon S3 location where you want SageMaker to download
|
|
3616
|
-
* the data needed to run the data processing job.</p>
|
|
3020
|
+
* <p>The URI of the Amazon S3 location where you want SageMaker to download the data needed to run the data processing job.</p>
|
|
3617
3021
|
* @public
|
|
3618
3022
|
*/
|
|
3619
3023
|
inputDataS3Location: string | undefined;
|
|
3620
3024
|
/**
|
|
3621
|
-
* <p>The URI of the Amazon S3 location where you want SageMaker to save the
|
|
3622
|
-
* results of a data processing job.</p>
|
|
3025
|
+
* <p>The URI of the Amazon S3 location where you want SageMaker to save the results of a data processing job.</p>
|
|
3623
3026
|
* @public
|
|
3624
3027
|
*/
|
|
3625
3028
|
processedDataS3Location: string | undefined;
|
|
3626
3029
|
/**
|
|
3627
|
-
* <p>The ARN of an IAM role for SageMaker execution.
|
|
3628
|
-
* This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
3030
|
+
* <p>The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
3629
3031
|
* @public
|
|
3630
3032
|
*/
|
|
3631
3033
|
sagemakerIamRoleArn?: string | undefined;
|
|
3632
3034
|
/**
|
|
3633
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume
|
|
3634
|
-
* to perform tasks on your behalf. This must be listed in your DB cluster
|
|
3635
|
-
* parameter group or an error will occur.</p>
|
|
3035
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
3636
3036
|
* @public
|
|
3637
3037
|
*/
|
|
3638
3038
|
neptuneIamRoleArn?: string | undefined;
|
|
3639
3039
|
/**
|
|
3640
|
-
* <p>The type of ML instance used during data processing. Its memory
|
|
3641
|
-
* should be large enough to hold the processed dataset. The default is
|
|
3642
|
-
* the smallest ml.r5 type whose memory is ten times larger than the size
|
|
3643
|
-
* of the exported graph data on disk.</p>
|
|
3040
|
+
* <p>The type of ML instance used during data processing. Its memory should be large enough to hold the processed dataset. The default is the smallest ml.r5 type whose memory is ten times larger than the size of the exported graph data on disk.</p>
|
|
3644
3041
|
* @public
|
|
3645
3042
|
*/
|
|
3646
3043
|
processingInstanceType?: string | undefined;
|
|
3647
3044
|
/**
|
|
3648
|
-
* <p>The disk volume size of the processing instance. Both input data
|
|
3649
|
-
* and processed data are stored on disk, so the volume size must be large
|
|
3650
|
-
* enough to hold both data sets. The default is 0. If not specified or 0,
|
|
3651
|
-
* Neptune ML chooses the volume size automatically based on the data size.</p>
|
|
3045
|
+
* <p>The disk volume size of the processing instance. Both input data and processed data are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML chooses the volume size automatically based on the data size.</p>
|
|
3652
3046
|
* @public
|
|
3653
3047
|
*/
|
|
3654
3048
|
processingInstanceVolumeSizeInGB?: number | undefined;
|
|
@@ -3658,18 +3052,12 @@ export interface StartMLDataProcessingJobInput {
|
|
|
3658
3052
|
*/
|
|
3659
3053
|
processingTimeOutInSeconds?: number | undefined;
|
|
3660
3054
|
/**
|
|
3661
|
-
* <p>One of the two model types that Neptune ML currently supports:
|
|
3662
|
-
* heterogeneous graph models (<code>heterogeneous</code>), and knowledge
|
|
3663
|
-
* graph (<code>kge</code>). The default is none. If not specified,
|
|
3664
|
-
* Neptune ML chooses the model type automatically based on the data.</p>
|
|
3055
|
+
* <p>One of the two model types that Neptune ML currently supports: heterogeneous graph models (<code>heterogeneous</code>), and knowledge graph (<code>kge</code>). The default is none. If not specified, Neptune ML chooses the model type automatically based on the data.</p>
|
|
3665
3056
|
* @public
|
|
3666
3057
|
*/
|
|
3667
3058
|
modelType?: string | undefined;
|
|
3668
3059
|
/**
|
|
3669
|
-
* <p>A data specification file that describes how to load the exported
|
|
3670
|
-
* graph data for training. The file is automatically generated by the
|
|
3671
|
-
* Neptune export toolkit. The default is
|
|
3672
|
-
* <code>training-data-configuration.json</code>.</p>
|
|
3060
|
+
* <p>A data specification file that describes how to load the exported graph data for training. The file is automatically generated by the Neptune export toolkit. The default is <code>training-data-configuration.json</code>.</p>
|
|
3673
3061
|
* @public
|
|
3674
3062
|
*/
|
|
3675
3063
|
configFileName?: string | undefined;
|
|
@@ -3684,15 +3072,12 @@ export interface StartMLDataProcessingJobInput {
|
|
|
3684
3072
|
*/
|
|
3685
3073
|
securityGroupIds?: string[] | undefined;
|
|
3686
3074
|
/**
|
|
3687
|
-
* <p>The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to
|
|
3688
|
-
* encrypt data on the storage volume attached to the ML compute instances
|
|
3689
|
-
* that run the training job. The default is None.</p>
|
|
3075
|
+
* <p>The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.</p>
|
|
3690
3076
|
* @public
|
|
3691
3077
|
*/
|
|
3692
3078
|
volumeEncryptionKMSKey?: string | undefined;
|
|
3693
3079
|
/**
|
|
3694
|
-
* <p>The Amazon Key Management Service (Amazon KMS) key that SageMaker uses
|
|
3695
|
-
* to encrypt the output of the processing job. The default is none.</p>
|
|
3080
|
+
* <p>The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.</p>
|
|
3696
3081
|
* @public
|
|
3697
3082
|
*/
|
|
3698
3083
|
s3OutputEncryptionKMSKey?: string | undefined;
|
|
@@ -3718,33 +3103,22 @@ export interface StartMLDataProcessingJobOutput {
|
|
|
3718
3103
|
creationTimeInMillis?: number | undefined;
|
|
3719
3104
|
}
|
|
3720
3105
|
/**
|
|
3721
|
-
* <p>Contains custom model training parameters. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.html">Custom
|
|
3722
|
-
* models in Neptune ML</a>.</p>
|
|
3106
|
+
* <p>Contains custom model training parameters. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.html">Custom models in Neptune ML</a>.</p>
|
|
3723
3107
|
* @public
|
|
3724
3108
|
*/
|
|
3725
3109
|
export interface CustomModelTrainingParameters {
|
|
3726
3110
|
/**
|
|
3727
|
-
* <p>The path to the Amazon S3 location where the Python module
|
|
3728
|
-
* implementing your model is located. This must point to a valid
|
|
3729
|
-
* existing Amazon S3 location that contains, at a minimum, a training
|
|
3730
|
-
* script, a transform script, and a <code>model-hpo-configuration.json</code>
|
|
3731
|
-
* file.</p>
|
|
3111
|
+
* <p>The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a <code>model-hpo-configuration.json</code> file.</p>
|
|
3732
3112
|
* @public
|
|
3733
3113
|
*/
|
|
3734
3114
|
sourceS3DirectoryPath: string | undefined;
|
|
3735
3115
|
/**
|
|
3736
|
-
* <p>The name of the entry point in your module of a script that performs
|
|
3737
|
-
* model training and takes hyperparameters as command-line arguments,
|
|
3738
|
-
* including fixed hyperparameters. The default is <code>training.py</code>.</p>
|
|
3116
|
+
* <p>The name of the entry point in your module of a script that performs model training and takes hyperparameters as command-line arguments, including fixed hyperparameters. The default is <code>training.py</code>.</p>
|
|
3739
3117
|
* @public
|
|
3740
3118
|
*/
|
|
3741
3119
|
trainingEntryPointScript?: string | undefined;
|
|
3742
3120
|
/**
|
|
3743
|
-
* <p>The name of the entry point in your module of a script that should
|
|
3744
|
-
* be run after the best model from the hyperparameter search has been
|
|
3745
|
-
* identified, to compute the model artifacts necessary for model deployment.
|
|
3746
|
-
* It should be able to run with no command-line arguments.The default is
|
|
3747
|
-
* <code>transform.py</code>.</p>
|
|
3121
|
+
* <p>The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments.The default is <code>transform.py</code>.</p>
|
|
3748
3122
|
* @public
|
|
3749
3123
|
*/
|
|
3750
3124
|
transformEntryPointScript?: string | undefined;
|
|
@@ -3759,14 +3133,12 @@ export interface StartMLModelTrainingJobInput {
|
|
|
3759
3133
|
*/
|
|
3760
3134
|
id?: string | undefined;
|
|
3761
3135
|
/**
|
|
3762
|
-
* <p>The job ID of a completed model-training job that you want to update
|
|
3763
|
-
* incrementally based on updated data.</p>
|
|
3136
|
+
* <p>The job ID of a completed model-training job that you want to update incrementally based on updated data.</p>
|
|
3764
3137
|
* @public
|
|
3765
3138
|
*/
|
|
3766
3139
|
previousModelTrainingJobId?: string | undefined;
|
|
3767
3140
|
/**
|
|
3768
|
-
* <p>The job ID of the completed data-processing job that has created
|
|
3769
|
-
* the data that the training will work with.</p>
|
|
3141
|
+
* <p>The job ID of the completed data-processing job that has created the data that the training will work with.</p>
|
|
3770
3142
|
* @public
|
|
3771
3143
|
*/
|
|
3772
3144
|
dataProcessingJobId: string | undefined;
|
|
@@ -3776,39 +3148,27 @@ export interface StartMLModelTrainingJobInput {
|
|
|
3776
3148
|
*/
|
|
3777
3149
|
trainModelS3Location: string | undefined;
|
|
3778
3150
|
/**
|
|
3779
|
-
* <p>The ARN of an IAM role for SageMaker execution.This must be listed
|
|
3780
|
-
* in your DB cluster parameter group or an error will occur.</p>
|
|
3151
|
+
* <p>The ARN of an IAM role for SageMaker execution.This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
3781
3152
|
* @public
|
|
3782
3153
|
*/
|
|
3783
3154
|
sagemakerIamRoleArn?: string | undefined;
|
|
3784
3155
|
/**
|
|
3785
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
3786
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
3787
|
-
* parameter group or an error will occur.</p>
|
|
3156
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
3788
3157
|
* @public
|
|
3789
3158
|
*/
|
|
3790
3159
|
neptuneIamRoleArn?: string | undefined;
|
|
3791
3160
|
/**
|
|
3792
|
-
* <p>The type of ML instance used in preparing and managing training
|
|
3793
|
-
* of ML models. This is a CPU instance chosen based on memory requirements
|
|
3794
|
-
* for processing the training data and model.</p>
|
|
3161
|
+
* <p>The type of ML instance used in preparing and managing training of ML models. This is a CPU instance chosen based on memory requirements for processing the training data and model.</p>
|
|
3795
3162
|
* @public
|
|
3796
3163
|
*/
|
|
3797
3164
|
baseProcessingInstanceType?: string | undefined;
|
|
3798
3165
|
/**
|
|
3799
|
-
* <p>The type of ML instance used for model training. All Neptune ML
|
|
3800
|
-
* models support CPU, GPU, and multiGPU training. The default is
|
|
3801
|
-
* <code>ml.p3.2xlarge</code>. Choosing the right instance type for
|
|
3802
|
-
* training depends on the task type, graph size, and your budget.</p>
|
|
3166
|
+
* <p>The type of ML instance used for model training. All Neptune ML models support CPU, GPU, and multiGPU training. The default is <code>ml.p3.2xlarge</code>. Choosing the right instance type for training depends on the task type, graph size, and your budget.</p>
|
|
3803
3167
|
* @public
|
|
3804
3168
|
*/
|
|
3805
3169
|
trainingInstanceType?: string | undefined;
|
|
3806
3170
|
/**
|
|
3807
|
-
* <p>The disk volume size of the training instance. Both input data
|
|
3808
|
-
* and the output model are stored on disk, so the volume size must be
|
|
3809
|
-
* large enough to hold both data sets. The default is 0. If not specified
|
|
3810
|
-
* or 0, Neptune ML selects a disk volume size based on the recommendation
|
|
3811
|
-
* generated in the data processing step.</p>
|
|
3171
|
+
* <p>The disk volume size of the training instance. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.</p>
|
|
3812
3172
|
* @public
|
|
3813
3173
|
*/
|
|
3814
3174
|
trainingInstanceVolumeSizeInGB?: number | undefined;
|
|
@@ -3818,18 +3178,12 @@ export interface StartMLModelTrainingJobInput {
|
|
|
3818
3178
|
*/
|
|
3819
3179
|
trainingTimeOutInSeconds?: number | undefined;
|
|
3820
3180
|
/**
|
|
3821
|
-
* <p>Maximum total number of training jobs to start for the hyperparameter
|
|
3822
|
-
* tuning job. The default is 2. Neptune ML automatically tunes the hyperparameters
|
|
3823
|
-
* of the machine learning model. To obtain a model that performs well, use at
|
|
3824
|
-
* least 10 jobs (in other words, set <code>maxHPONumberOfTrainingJobs</code> to 10).
|
|
3825
|
-
* In general, the more tuning runs, the better the results.</p>
|
|
3181
|
+
* <p>Maximum total number of training jobs to start for the hyperparameter tuning job. The default is 2. Neptune ML automatically tunes the hyperparameters of the machine learning model. To obtain a model that performs well, use at least 10 jobs (in other words, set <code>maxHPONumberOfTrainingJobs</code> to 10). In general, the more tuning runs, the better the results.</p>
|
|
3826
3182
|
* @public
|
|
3827
3183
|
*/
|
|
3828
3184
|
maxHPONumberOfTrainingJobs?: number | undefined;
|
|
3829
3185
|
/**
|
|
3830
|
-
* <p>Maximum number of parallel training jobs to start for the hyperparameter
|
|
3831
|
-
* tuning job. The default is 2. The number of parallel jobs you can run is
|
|
3832
|
-
* limited by the available resources on your training instance.</p>
|
|
3186
|
+
* <p>Maximum number of parallel training jobs to start for the hyperparameter tuning job. The default is 2. The number of parallel jobs you can run is limited by the available resources on your training instance.</p>
|
|
3833
3187
|
* @public
|
|
3834
3188
|
*/
|
|
3835
3189
|
maxHPOParallelTrainingJobs?: number | undefined;
|
|
@@ -3844,21 +3198,17 @@ export interface StartMLModelTrainingJobInput {
|
|
|
3844
3198
|
*/
|
|
3845
3199
|
securityGroupIds?: string[] | undefined;
|
|
3846
3200
|
/**
|
|
3847
|
-
* <p>The Amazon Key Management Service (KMS) key that SageMaker uses to
|
|
3848
|
-
* encrypt data on the storage volume attached to the ML compute instances
|
|
3849
|
-
* that run the training job. The default is None.</p>
|
|
3201
|
+
* <p>The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.</p>
|
|
3850
3202
|
* @public
|
|
3851
3203
|
*/
|
|
3852
3204
|
volumeEncryptionKMSKey?: string | undefined;
|
|
3853
3205
|
/**
|
|
3854
|
-
* <p>The Amazon Key Management Service (KMS) key that SageMaker uses
|
|
3855
|
-
* to encrypt the output of the processing job. The default is none.</p>
|
|
3206
|
+
* <p>The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.</p>
|
|
3856
3207
|
* @public
|
|
3857
3208
|
*/
|
|
3858
3209
|
s3OutputEncryptionKMSKey?: string | undefined;
|
|
3859
3210
|
/**
|
|
3860
|
-
* <p>Optimizes the cost of training machine-learning models by using
|
|
3861
|
-
* Amazon Elastic Compute Cloud spot instances. The default is <code>False</code>.</p>
|
|
3211
|
+
* <p>Optimizes the cost of training machine-learning models by using Amazon Elastic Compute Cloud spot instances. The default is <code>False</code>.</p>
|
|
3862
3212
|
* @public
|
|
3863
3213
|
*/
|
|
3864
3214
|
enableManagedSpotTraining?: boolean | undefined;
|
|
@@ -3889,26 +3239,17 @@ export interface StartMLModelTrainingJobOutput {
|
|
|
3889
3239
|
creationTimeInMillis?: number | undefined;
|
|
3890
3240
|
}
|
|
3891
3241
|
/**
|
|
3892
|
-
* <p>Contains custom model transform parameters. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use
|
|
3893
|
-
* a trained model to generate new model artifacts</a>.</p>
|
|
3242
|
+
* <p>Contains custom model transform parameters. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html">Use a trained model to generate new model artifacts</a>.</p>
|
|
3894
3243
|
* @public
|
|
3895
3244
|
*/
|
|
3896
3245
|
export interface CustomModelTransformParameters {
|
|
3897
3246
|
/**
|
|
3898
|
-
* <p>The path to the Amazon S3 location where the Python module
|
|
3899
|
-
* implementing your model is located. This must point to a valid
|
|
3900
|
-
* existing Amazon S3 location that contains, at a minimum, a training
|
|
3901
|
-
* script, a transform script, and a <code>model-hpo-configuration.json</code>
|
|
3902
|
-
* file.</p>
|
|
3247
|
+
* <p>The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a <code>model-hpo-configuration.json</code> file.</p>
|
|
3903
3248
|
* @public
|
|
3904
3249
|
*/
|
|
3905
3250
|
sourceS3DirectoryPath: string | undefined;
|
|
3906
3251
|
/**
|
|
3907
|
-
* <p>The name of the entry point in your module of a script that should
|
|
3908
|
-
* be run after the best model from the hyperparameter search has been
|
|
3909
|
-
* identified, to compute the model artifacts necessary for model deployment.
|
|
3910
|
-
* It should be able to run with no command-line arguments. The default
|
|
3911
|
-
* is <code>transform.py</code>.</p>
|
|
3252
|
+
* <p>The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments. The default is <code>transform.py</code>.</p>
|
|
3912
3253
|
* @public
|
|
3913
3254
|
*/
|
|
3914
3255
|
transformEntryPointScript?: string | undefined;
|
|
@@ -3923,23 +3264,17 @@ export interface StartMLModelTransformJobInput {
|
|
|
3923
3264
|
*/
|
|
3924
3265
|
id?: string | undefined;
|
|
3925
3266
|
/**
|
|
3926
|
-
* <p>The job ID of a completed data-processing job. You must include either
|
|
3927
|
-
* <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>,
|
|
3928
|
-
* or a <code>trainingJobName</code>.</p>
|
|
3267
|
+
* <p>The job ID of a completed data-processing job. You must include either <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>, or a <code>trainingJobName</code>.</p>
|
|
3929
3268
|
* @public
|
|
3930
3269
|
*/
|
|
3931
3270
|
dataProcessingJobId?: string | undefined;
|
|
3932
3271
|
/**
|
|
3933
|
-
* <p>The job ID of a completed model-training job. You must include either
|
|
3934
|
-
* <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>,
|
|
3935
|
-
* or a <code>trainingJobName</code>.</p>
|
|
3272
|
+
* <p>The job ID of a completed model-training job. You must include either <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>, or a <code>trainingJobName</code>.</p>
|
|
3936
3273
|
* @public
|
|
3937
3274
|
*/
|
|
3938
3275
|
mlModelTrainingJobId?: string | undefined;
|
|
3939
3276
|
/**
|
|
3940
|
-
* <p>The name of a completed SageMaker training job. You must include either
|
|
3941
|
-
* <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>,
|
|
3942
|
-
* or a <code>trainingJobName</code>.</p>
|
|
3277
|
+
* <p>The name of a completed SageMaker training job. You must include either <code>dataProcessingJobId</code> and a <code>mlModelTrainingJobId</code>, or a <code>trainingJobName</code>.</p>
|
|
3943
3278
|
* @public
|
|
3944
3279
|
*/
|
|
3945
3280
|
trainingJobName?: string | undefined;
|
|
@@ -3949,38 +3284,27 @@ export interface StartMLModelTransformJobInput {
|
|
|
3949
3284
|
*/
|
|
3950
3285
|
modelTransformOutputS3Location: string | undefined;
|
|
3951
3286
|
/**
|
|
3952
|
-
* <p>The ARN of an IAM role for SageMaker execution. This must be listed
|
|
3953
|
-
* in your DB cluster parameter group or an error will occur.</p>
|
|
3287
|
+
* <p>The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
3954
3288
|
* @public
|
|
3955
3289
|
*/
|
|
3956
3290
|
sagemakerIamRoleArn?: string | undefined;
|
|
3957
3291
|
/**
|
|
3958
|
-
* <p>The ARN of an IAM role that provides Neptune access to SageMaker
|
|
3959
|
-
* and Amazon S3 resources. This must be listed in your DB cluster
|
|
3960
|
-
* parameter group or an error will occur.</p>
|
|
3292
|
+
* <p>The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.</p>
|
|
3961
3293
|
* @public
|
|
3962
3294
|
*/
|
|
3963
3295
|
neptuneIamRoleArn?: string | undefined;
|
|
3964
3296
|
/**
|
|
3965
|
-
* <p>Configuration information for a model transform using a custom model.
|
|
3966
|
-
* The <code>customModelTransformParameters</code> object contains the following
|
|
3967
|
-
* fields, which must have values compatible with the saved model parameters from
|
|
3968
|
-
* the training job:</p>
|
|
3297
|
+
* <p>Configuration information for a model transform using a custom model. The <code>customModelTransformParameters</code> object contains the following fields, which must have values compatible with the saved model parameters from the training job:</p>
|
|
3969
3298
|
* @public
|
|
3970
3299
|
*/
|
|
3971
3300
|
customModelTransformParameters?: CustomModelTransformParameters | undefined;
|
|
3972
3301
|
/**
|
|
3973
|
-
* <p>The type of ML instance used in preparing and managing training of ML models.
|
|
3974
|
-
* This is an ML compute instance chosen based on memory requirements for processing
|
|
3975
|
-
* the training data and model.</p>
|
|
3302
|
+
* <p>The type of ML instance used in preparing and managing training of ML models. This is an ML compute instance chosen based on memory requirements for processing the training data and model.</p>
|
|
3976
3303
|
* @public
|
|
3977
3304
|
*/
|
|
3978
3305
|
baseProcessingInstanceType?: string | undefined;
|
|
3979
3306
|
/**
|
|
3980
|
-
* <p>The disk volume size of the training instance in gigabytes. The default is 0.
|
|
3981
|
-
* Both input data and the output model are stored on disk, so the volume size must
|
|
3982
|
-
* be large enough to hold both data sets. If not specified or 0, Neptune ML selects
|
|
3983
|
-
* a disk volume size based on the recommendation generated in the data processing step.</p>
|
|
3307
|
+
* <p>The disk volume size of the training instance in gigabytes. The default is 0. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.</p>
|
|
3984
3308
|
* @public
|
|
3985
3309
|
*/
|
|
3986
3310
|
baseProcessingInstanceVolumeSizeInGB?: number | undefined;
|
|
@@ -3995,15 +3319,12 @@ export interface StartMLModelTransformJobInput {
|
|
|
3995
3319
|
*/
|
|
3996
3320
|
securityGroupIds?: string[] | undefined;
|
|
3997
3321
|
/**
|
|
3998
|
-
* <p>The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data
|
|
3999
|
-
* on the storage volume attached to the ML compute instances that run the training job.
|
|
4000
|
-
* The default is None.</p>
|
|
3322
|
+
* <p>The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.</p>
|
|
4001
3323
|
* @public
|
|
4002
3324
|
*/
|
|
4003
3325
|
volumeEncryptionKMSKey?: string | undefined;
|
|
4004
3326
|
/**
|
|
4005
|
-
* <p>The Amazon Key Management Service (KMS) key that SageMaker uses to
|
|
4006
|
-
* encrypt the output of the processing job. The default is none.</p>
|
|
3327
|
+
* <p>The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.</p>
|
|
4007
3328
|
* @public
|
|
4008
3329
|
*/
|
|
4009
3330
|
s3OutputEncryptionKMSKey?: string | undefined;
|