@aws-sdk/client-sagemaker 3.504.0 → 3.506.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/index.js +6 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_json1_1.js +6 -0
- package/dist-types/commands/CreateAppImageConfigCommand.d.ts +2 -2
- package/dist-types/commands/CreateCodeRepositoryCommand.d.ts +5 -5
- package/dist-types/commands/CreateCompilationJobCommand.d.ts +1 -2
- package/dist-types/commands/CreateDomainCommand.d.ts +3 -0
- package/dist-types/commands/CreateImageCommand.d.ts +1 -1
- package/dist-types/commands/CreateImageVersionCommand.d.ts +1 -1
- package/dist-types/commands/CreateNotebookInstanceCommand.d.ts +17 -17
- package/dist-types/commands/CreateNotebookInstanceLifecycleConfigCommand.d.ts +9 -9
- package/dist-types/commands/CreatePresignedDomainUrlCommand.d.ts +1 -1
- package/dist-types/commands/CreateSpaceCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserProfileCommand.d.ts +4 -1
- package/dist-types/commands/DeleteNotebookInstanceCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDomainCommand.d.ts +3 -0
- package/dist-types/commands/DescribeNotebookInstanceLifecycleConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStudioLifecycleConfigCommand.d.ts +1 -2
- package/dist-types/commands/DescribeUserProfileCommand.d.ts +3 -0
- package/dist-types/commands/ListAppImageConfigsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDomainCommand.d.ts +3 -0
- package/dist-types/commands/UpdateUserProfileCommand.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +49 -105
- package/dist-types/models/models_1.d.ts +161 -117
- package/dist-types/models/models_2.d.ts +50 -27
- package/dist-types/models/models_3.d.ts +51 -52
- package/dist-types/models/models_4.d.ts +37 -26
- package/dist-types/ts3.4/commands/CreateCompilationJobCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeStudioLifecycleConfigCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +4 -10
- package/dist-types/ts3.4/models/models_1.d.ts +13 -7
- package/dist-types/ts3.4/models/models_2.d.ts +7 -4
- package/dist-types/ts3.4/models/models_3.d.ts +4 -4
- package/dist-types/ts3.4/models/models_4.d.ts +4 -2
- package/package.json +1 -1
|
@@ -1,5 +1,82 @@
|
|
|
1
1
|
import { LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
|
|
2
|
-
import { AdditionalInferenceSpecificationDefinition, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppType, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoParameter, AutoRollbackConfig, Autotune, AwsManagedHumanLoopRequestSource, BatchTransformInput, BestObjectiveNotImproving, Bias, BlueGreenUpdatePolicy, CanvasAppSettings, CapacitySize, CaptureContentTypeHeader, CaptureOption, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, ClarifyExplainerConfig, CodeEditorAppSettings, CodeRepository, CollectionConfig,
|
|
2
|
+
import { AdditionalInferenceSpecificationDefinition, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppType, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoParameter, AutoRollbackConfig, Autotune, AwsManagedHumanLoopRequestSource, BatchTransformInput, BestObjectiveNotImproving, Bias, BlueGreenUpdatePolicy, CanvasAppSettings, CapacitySize, CaptureContentTypeHeader, CaptureOption, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, ClarifyExplainerConfig, CodeEditorAppSettings, CodeRepository, CollectionConfig, CollectionType, ContainerDefinition, ContentClassifier, ContextSource, ContinuousParameterRange, ConvergenceDetected, FeatureStatus, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, InputConfig, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, NeoVpcConfig, OutputConfig, OutputDataConfig, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TrainingInputMode, TrainingInstanceType, TransformJobDefinition, VpcConfig } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface CreateCompilationJobRequest {
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
* <p>A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. </p>
|
|
10
|
+
*/
|
|
11
|
+
CompilationJobName: string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* @public
|
|
14
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on
|
|
15
|
+
* your behalf. </p>
|
|
16
|
+
* <p>During model compilation, Amazon SageMaker needs your permission to:</p>
|
|
17
|
+
* <ul>
|
|
18
|
+
* <li>
|
|
19
|
+
* <p>Read input data from an S3 bucket</p>
|
|
20
|
+
* </li>
|
|
21
|
+
* <li>
|
|
22
|
+
* <p>Write model artifacts to an S3 bucket</p>
|
|
23
|
+
* </li>
|
|
24
|
+
* <li>
|
|
25
|
+
* <p>Write logs to Amazon CloudWatch Logs</p>
|
|
26
|
+
* </li>
|
|
27
|
+
* <li>
|
|
28
|
+
* <p>Publish metrics to Amazon CloudWatch</p>
|
|
29
|
+
* </li>
|
|
30
|
+
* </ul>
|
|
31
|
+
* <p>You grant permissions for all of these tasks to an IAM role. To pass this role to
|
|
32
|
+
* Amazon SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission. For
|
|
33
|
+
* more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker
|
|
34
|
+
* Roles.</a>
|
|
35
|
+
* </p>
|
|
36
|
+
*/
|
|
37
|
+
RoleArn: string | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* @public
|
|
40
|
+
* <p>The Amazon Resource Name (ARN) of a versioned model package. Provide either a
|
|
41
|
+
* <code>ModelPackageVersionArn</code> or an <code>InputConfig</code> object in the
|
|
42
|
+
* request syntax. The presence of both objects in the <code>CreateCompilationJob</code>
|
|
43
|
+
* request will return an exception.</p>
|
|
44
|
+
*/
|
|
45
|
+
ModelPackageVersionArn?: string;
|
|
46
|
+
/**
|
|
47
|
+
* @public
|
|
48
|
+
* <p>Provides information about the location of input model artifacts, the name and shape
|
|
49
|
+
* of the expected data inputs, and the framework in which the model was trained.</p>
|
|
50
|
+
*/
|
|
51
|
+
InputConfig?: InputConfig;
|
|
52
|
+
/**
|
|
53
|
+
* @public
|
|
54
|
+
* <p>Provides information about the output location for the compiled model and the target
|
|
55
|
+
* device the model runs on.</p>
|
|
56
|
+
*/
|
|
57
|
+
OutputConfig: OutputConfig | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* @public
|
|
60
|
+
* <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that you want your compilation job
|
|
61
|
+
* to connect to. Control access to your models by configuring the VPC. For more
|
|
62
|
+
* information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html">Protect Compilation Jobs by Using an Amazon Virtual Private Cloud</a>.</p>
|
|
63
|
+
*/
|
|
64
|
+
VpcConfig?: NeoVpcConfig;
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
* <p>Specifies a limit to how long a model compilation job can run. When the job reaches
|
|
68
|
+
* the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training
|
|
69
|
+
* costs.</p>
|
|
70
|
+
*/
|
|
71
|
+
StoppingCondition: StoppingCondition | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* @public
|
|
74
|
+
* <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
|
|
75
|
+
* resources in different ways, for example, by purpose, owner, or environment. For more
|
|
76
|
+
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
|
|
77
|
+
*/
|
|
78
|
+
Tags?: Tag[];
|
|
79
|
+
}
|
|
3
80
|
/**
|
|
4
81
|
* @public
|
|
5
82
|
*/
|
|
@@ -648,7 +725,7 @@ export interface JupyterServerAppSettings {
|
|
|
648
725
|
/**
|
|
649
726
|
* @public
|
|
650
727
|
* <p>A custom SageMaker image. For more information, see
|
|
651
|
-
*
|
|
728
|
+
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html">Bring your own SageMaker image</a>.</p>
|
|
652
729
|
*/
|
|
653
730
|
export interface CustomImage {
|
|
654
731
|
/**
|
|
@@ -676,9 +753,9 @@ export interface KernelGatewayAppSettings {
|
|
|
676
753
|
* @public
|
|
677
754
|
* <p>The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.</p>
|
|
678
755
|
* <note>
|
|
679
|
-
* <p>The Amazon SageMaker Studio UI does not use the default instance type value set here. The
|
|
680
|
-
*
|
|
681
|
-
*
|
|
756
|
+
* <p>The Amazon SageMaker Studio UI does not use the default instance type value set here. The
|
|
757
|
+
* default instance type set here is used when Apps are created using the CLI or
|
|
758
|
+
* CloudFormation and the instance type parameter value is not passed.</p>
|
|
682
759
|
* </note>
|
|
683
760
|
*/
|
|
684
761
|
DefaultResourceSpec?: ResourceSpec;
|
|
@@ -698,7 +775,7 @@ export interface KernelGatewayAppSettings {
|
|
|
698
775
|
}
|
|
699
776
|
/**
|
|
700
777
|
* @public
|
|
701
|
-
* <p>A collection of settings that apply to spaces created in the
|
|
778
|
+
* <p>A collection of settings that apply to spaces created in the domain.</p>
|
|
702
779
|
*/
|
|
703
780
|
export interface DefaultSpaceSettings {
|
|
704
781
|
/**
|
|
@@ -708,7 +785,7 @@ export interface DefaultSpaceSettings {
|
|
|
708
785
|
ExecutionRole?: string;
|
|
709
786
|
/**
|
|
710
787
|
* @public
|
|
711
|
-
* <p>The security group IDs for the Amazon
|
|
788
|
+
* <p>The security group IDs for the Amazon VPC that the space uses for communication.</p>
|
|
712
789
|
*/
|
|
713
790
|
SecurityGroups?: string[];
|
|
714
791
|
/**
|
|
@@ -795,7 +872,7 @@ export interface JupyterLabAppSettings {
|
|
|
795
872
|
/**
|
|
796
873
|
* @public
|
|
797
874
|
* <p>Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that
|
|
798
|
-
*
|
|
875
|
+
* the version runs on.</p>
|
|
799
876
|
*/
|
|
800
877
|
DefaultResourceSpec?: ResourceSpec;
|
|
801
878
|
/**
|
|
@@ -822,7 +899,7 @@ export interface RSessionAppSettings {
|
|
|
822
899
|
/**
|
|
823
900
|
* @public
|
|
824
901
|
* <p>Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that
|
|
825
|
-
*
|
|
902
|
+
* the version runs on.</p>
|
|
826
903
|
*/
|
|
827
904
|
DefaultResourceSpec?: ResourceSpec;
|
|
828
905
|
/**
|
|
@@ -858,20 +935,20 @@ export type RStudioServerProUserGroup = (typeof RStudioServerProUserGroup)[keyof
|
|
|
858
935
|
/**
|
|
859
936
|
* @public
|
|
860
937
|
* <p>A collection of settings that configure user interaction with the
|
|
861
|
-
*
|
|
938
|
+
* <code>RStudioServerPro</code> app.</p>
|
|
862
939
|
*/
|
|
863
940
|
export interface RStudioServerProAppSettings {
|
|
864
941
|
/**
|
|
865
942
|
* @public
|
|
866
943
|
* <p>Indicates whether the current user has access to the <code>RStudioServerPro</code>
|
|
867
|
-
*
|
|
944
|
+
* app.</p>
|
|
868
945
|
*/
|
|
869
946
|
AccessStatus?: RStudioServerProAccessStatus;
|
|
870
947
|
/**
|
|
871
948
|
* @public
|
|
872
949
|
* <p>The level of permissions that the user has within the <code>RStudioServerPro</code>
|
|
873
|
-
*
|
|
874
|
-
*
|
|
950
|
+
* app. This value defaults to `User`. The `Admin` value allows the user access to the
|
|
951
|
+
* RStudio Administrative Dashboard.</p>
|
|
875
952
|
*/
|
|
876
953
|
UserGroup?: RStudioServerProUserGroup;
|
|
877
954
|
}
|
|
@@ -890,28 +967,28 @@ export type NotebookOutputOption = (typeof NotebookOutputOption)[keyof typeof No
|
|
|
890
967
|
/**
|
|
891
968
|
* @public
|
|
892
969
|
* <p>Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are
|
|
893
|
-
*
|
|
894
|
-
*
|
|
895
|
-
*
|
|
896
|
-
*
|
|
970
|
+
* specified as part of <code>DefaultUserSettings</code> when the <code>CreateDomain</code>
|
|
971
|
+
* API is called, and as part of <code>UserSettings</code> when the <code>CreateUserProfile</code>
|
|
972
|
+
* API is called. When <code>SharingSettings</code> is not specified, notebook sharing
|
|
973
|
+
* isn't allowed.</p>
|
|
897
974
|
*/
|
|
898
975
|
export interface SharingSettings {
|
|
899
976
|
/**
|
|
900
977
|
* @public
|
|
901
978
|
* <p>Whether to include the notebook cell output when sharing the notebook. The default
|
|
902
|
-
*
|
|
979
|
+
* is <code>Disabled</code>.</p>
|
|
903
980
|
*/
|
|
904
981
|
NotebookOutputOption?: NotebookOutputOption;
|
|
905
982
|
/**
|
|
906
983
|
* @public
|
|
907
984
|
* <p>When <code>NotebookOutputOption</code> is <code>Allowed</code>, the Amazon S3 bucket used
|
|
908
|
-
*
|
|
985
|
+
* to store the shared notebook snapshots.</p>
|
|
909
986
|
*/
|
|
910
987
|
S3OutputPath?: string;
|
|
911
988
|
/**
|
|
912
989
|
* @public
|
|
913
990
|
* <p>When <code>NotebookOutputOption</code> is <code>Allowed</code>, the Amazon Web Services Key Management Service (KMS)
|
|
914
|
-
*
|
|
991
|
+
* encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.</p>
|
|
915
992
|
*/
|
|
916
993
|
S3KmsKeyId?: string;
|
|
917
994
|
}
|
|
@@ -972,8 +1049,8 @@ export interface TensorBoardAppSettings {
|
|
|
972
1049
|
* when the <code>CreateDomain</code> API is called.</p>
|
|
973
1050
|
* <p>
|
|
974
1051
|
* <code>SecurityGroups</code> is aggregated when specified in both calls. For all other
|
|
975
|
-
*
|
|
976
|
-
*
|
|
1052
|
+
* settings in <code>UserSettings</code>, the values specified in <code>CreateUserProfile</code>
|
|
1053
|
+
* take precedence over those specified in <code>CreateDomain</code>.</p>
|
|
977
1054
|
*/
|
|
978
1055
|
export interface UserSettings {
|
|
979
1056
|
/**
|
|
@@ -985,11 +1062,11 @@ export interface UserSettings {
|
|
|
985
1062
|
* @public
|
|
986
1063
|
* <p>The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.</p>
|
|
987
1064
|
* <p>Optional when the <code>CreateDomain.AppNetworkAccessType</code> parameter is set to
|
|
988
|
-
*
|
|
1065
|
+
* <code>PublicInternetOnly</code>.</p>
|
|
989
1066
|
* <p>Required when the <code>CreateDomain.AppNetworkAccessType</code> parameter is set to
|
|
990
|
-
*
|
|
1067
|
+
* <code>VpcOnly</code>, unless specified as part of the <code>DefaultUserSettings</code> for the domain.</p>
|
|
991
1068
|
* <p>Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the
|
|
992
|
-
*
|
|
1069
|
+
* number of security groups that you can specify is one less than the maximum number shown.</p>
|
|
993
1070
|
*/
|
|
994
1071
|
SecurityGroups?: string[];
|
|
995
1072
|
/**
|
|
@@ -1015,7 +1092,7 @@ export interface UserSettings {
|
|
|
1015
1092
|
/**
|
|
1016
1093
|
* @public
|
|
1017
1094
|
* <p>A collection of settings that configure user interaction with the
|
|
1018
|
-
*
|
|
1095
|
+
* <code>RStudioServerPro</code> app.</p>
|
|
1019
1096
|
*/
|
|
1020
1097
|
RStudioServerProAppSettings?: RStudioServerProAppSettings;
|
|
1021
1098
|
/**
|
|
@@ -1106,13 +1183,13 @@ export type ExecutionRoleIdentityConfig = (typeof ExecutionRoleIdentityConfig)[k
|
|
|
1106
1183
|
/**
|
|
1107
1184
|
* @public
|
|
1108
1185
|
* <p>A collection of settings that configure the <code>RStudioServerPro</code> Domain-level
|
|
1109
|
-
*
|
|
1186
|
+
* app.</p>
|
|
1110
1187
|
*/
|
|
1111
1188
|
export interface RStudioServerProDomainSettings {
|
|
1112
1189
|
/**
|
|
1113
1190
|
* @public
|
|
1114
1191
|
* <p>The ARN of the execution role for the <code>RStudioServerPro</code> Domain-level
|
|
1115
|
-
*
|
|
1192
|
+
* app.</p>
|
|
1116
1193
|
*/
|
|
1117
1194
|
DomainExecutionRoleArn: string | undefined;
|
|
1118
1195
|
/**
|
|
@@ -1128,7 +1205,7 @@ export interface RStudioServerProDomainSettings {
|
|
|
1128
1205
|
/**
|
|
1129
1206
|
* @public
|
|
1130
1207
|
* <p>Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that
|
|
1131
|
-
*
|
|
1208
|
+
* the version runs on.</p>
|
|
1132
1209
|
*/
|
|
1133
1210
|
DefaultResourceSpec?: ResourceSpec;
|
|
1134
1211
|
}
|
|
@@ -3699,7 +3776,7 @@ export interface HyperbandStrategyConfig {
|
|
|
3699
3776
|
* launched by a hyperparameter tuning job. Once a job reaches the <code>MaxResource</code>
|
|
3700
3777
|
* value, it is stopped. If a value for <code>MaxResource</code> is not provided, and
|
|
3701
3778
|
* <code>Hyperband</code> is selected as the hyperparameter tuning strategy,
|
|
3702
|
-
* <code>
|
|
3779
|
+
* <code>HyperbandTraining</code> attempts to infer <code>MaxResource</code> from the
|
|
3703
3780
|
* following keys (if present) in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-StaticHyperParameters">StaticsHyperParameters</a>:</p>
|
|
3704
3781
|
* <ul>
|
|
3705
3782
|
* <li>
|
|
@@ -3731,7 +3808,7 @@ export interface HyperbandStrategyConfig {
|
|
|
3731
3808
|
* <p>If <code>HyperbandStrategyConfig</code> is unable to infer a value for
|
|
3732
3809
|
* <code>MaxResource</code>, it generates a validation error. The maximum value is 20,000
|
|
3733
3810
|
* epochs. All metrics that correspond to an objective metric are used to derive <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html">early stopping
|
|
3734
|
-
* decisions</a>. For <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/distributed-training.html">
|
|
3811
|
+
* decisions</a>. For <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/distributed-training.html">distributed</a> training jobs,
|
|
3735
3812
|
* ensure that duplicate metrics are not printed in the logs across the individual nodes in a
|
|
3736
3813
|
* training job. If multiple nodes are publishing duplicate or incorrect metrics, training
|
|
3737
3814
|
* jobs may make an incorrect stopping decision and stop the job prematurely. </p>
|
|
@@ -4546,7 +4623,7 @@ export interface CreateImageVersionRequest {
|
|
|
4546
4623
|
/**
|
|
4547
4624
|
* @public
|
|
4548
4625
|
* <p>The registry path of the container image to use as the starting point for this
|
|
4549
|
-
* version. The path is an Amazon
|
|
4626
|
+
* version. The path is an Amazon ECR URI in the following format:</p>
|
|
4550
4627
|
* <p>
|
|
4551
4628
|
* <code><acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]></code>
|
|
4552
4629
|
* </p>
|
|
@@ -9422,104 +9499,104 @@ export interface CreateNotebookInstanceInput {
|
|
|
9422
9499
|
/**
|
|
9423
9500
|
* @public
|
|
9424
9501
|
* <p>The ID of the subnet in a VPC to which you would like to have a connectivity from
|
|
9425
|
-
*
|
|
9502
|
+
* your ML compute instance. </p>
|
|
9426
9503
|
*/
|
|
9427
9504
|
SubnetId?: string;
|
|
9428
9505
|
/**
|
|
9429
9506
|
* @public
|
|
9430
9507
|
* <p>The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be
|
|
9431
|
-
*
|
|
9508
|
+
* for the same VPC as specified in the subnet. </p>
|
|
9432
9509
|
*/
|
|
9433
9510
|
SecurityGroupIds?: string[];
|
|
9434
9511
|
/**
|
|
9435
9512
|
* @public
|
|
9436
9513
|
* <p> When you send any requests to Amazon Web Services resources from the notebook
|
|
9437
|
-
*
|
|
9438
|
-
*
|
|
9439
|
-
*
|
|
9440
|
-
*
|
|
9514
|
+
* instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this
|
|
9515
|
+
* role necessary permissions so SageMaker can perform these tasks. The policy must allow the
|
|
9516
|
+
* SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For
|
|
9517
|
+
* more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker Roles</a>. </p>
|
|
9441
9518
|
* <note>
|
|
9442
9519
|
* <p>To be able to pass this role to SageMaker, the caller of this API must have the
|
|
9443
|
-
*
|
|
9520
|
+
* <code>iam:PassRole</code> permission.</p>
|
|
9444
9521
|
* </note>
|
|
9445
9522
|
*/
|
|
9446
9523
|
RoleArn: string | undefined;
|
|
9447
9524
|
/**
|
|
9448
9525
|
* @public
|
|
9449
9526
|
* <p>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that
|
|
9450
|
-
*
|
|
9451
|
-
*
|
|
9452
|
-
*
|
|
9453
|
-
*
|
|
9527
|
+
* SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The
|
|
9528
|
+
* KMS key you provide must be enabled. For information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html">Enabling and Disabling
|
|
9529
|
+
* Keys</a> in the <i>Amazon Web Services Key Management Service Developer
|
|
9530
|
+
* Guide</i>.</p>
|
|
9454
9531
|
*/
|
|
9455
9532
|
KmsKeyId?: string;
|
|
9456
9533
|
/**
|
|
9457
9534
|
* @public
|
|
9458
9535
|
* <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
|
|
9459
|
-
*
|
|
9460
|
-
*
|
|
9536
|
+
* resources in different ways, for example, by purpose, owner, or environment. For more
|
|
9537
|
+
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
|
|
9461
9538
|
*/
|
|
9462
9539
|
Tags?: Tag[];
|
|
9463
9540
|
/**
|
|
9464
9541
|
* @public
|
|
9465
9542
|
* <p>The name of a lifecycle configuration to associate with the notebook instance. For
|
|
9466
|
-
*
|
|
9467
|
-
*
|
|
9543
|
+
* information about lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional)
|
|
9544
|
+
* Customize a Notebook Instance</a>.</p>
|
|
9468
9545
|
*/
|
|
9469
9546
|
LifecycleConfigName?: string;
|
|
9470
9547
|
/**
|
|
9471
9548
|
* @public
|
|
9472
9549
|
* <p>Sets whether SageMaker provides internet access to the notebook instance. If you set this
|
|
9473
|
-
*
|
|
9474
|
-
*
|
|
9475
|
-
*
|
|
9550
|
+
* to <code>Disabled</code> this notebook instance is able to access resources only in your
|
|
9551
|
+
* VPC, and is not be able to connect to SageMaker training and endpoint services unless you
|
|
9552
|
+
* configure a NAT Gateway in your VPC.</p>
|
|
9476
9553
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>. You can set the value
|
|
9477
|
-
*
|
|
9478
|
-
*
|
|
9554
|
+
* of this parameter to <code>Disabled</code> only if you set a value for the
|
|
9555
|
+
* <code>SubnetId</code> parameter.</p>
|
|
9479
9556
|
*/
|
|
9480
9557
|
DirectInternetAccess?: DirectInternetAccess;
|
|
9481
9558
|
/**
|
|
9482
9559
|
* @public
|
|
9483
9560
|
* <p>The size, in GB, of the ML storage volume to attach to the notebook instance. The
|
|
9484
|
-
*
|
|
9561
|
+
* default value is 5 GB.</p>
|
|
9485
9562
|
*/
|
|
9486
9563
|
VolumeSizeInGB?: number;
|
|
9487
9564
|
/**
|
|
9488
9565
|
* @public
|
|
9489
9566
|
* <p>A list of Elastic Inference (EI) instance types to associate with this notebook
|
|
9490
|
-
*
|
|
9491
|
-
*
|
|
9567
|
+
* instance. Currently, only one instance type can be associated with a notebook instance.
|
|
9568
|
+
* For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic Inference in Amazon SageMaker</a>.</p>
|
|
9492
9569
|
*/
|
|
9493
9570
|
AcceleratorTypes?: NotebookInstanceAcceleratorType[];
|
|
9494
9571
|
/**
|
|
9495
9572
|
* @public
|
|
9496
9573
|
* <p>A Git repository to associate with the notebook instance as its default code
|
|
9497
|
-
*
|
|
9498
|
-
*
|
|
9499
|
-
*
|
|
9500
|
-
*
|
|
9501
|
-
*
|
|
9574
|
+
* repository. This can be either the name of a Git repository stored as a resource in your
|
|
9575
|
+
* account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
|
|
9576
|
+
* or in any other Git repository. When you open a notebook instance, it opens in the
|
|
9577
|
+
* directory that contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
|
|
9578
|
+
* Repositories with SageMaker Notebook Instances</a>.</p>
|
|
9502
9579
|
*/
|
|
9503
9580
|
DefaultCodeRepository?: string;
|
|
9504
9581
|
/**
|
|
9505
9582
|
* @public
|
|
9506
9583
|
* <p>An array of up to three Git repositories to associate with the notebook instance.
|
|
9507
|
-
*
|
|
9508
|
-
*
|
|
9509
|
-
*
|
|
9510
|
-
*
|
|
9511
|
-
*
|
|
9584
|
+
* These can be either the names of Git repositories stored as resources in your account,
|
|
9585
|
+
* or the URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
|
|
9586
|
+
* or in any other Git repository. These repositories are cloned at the same level as the
|
|
9587
|
+
* default repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
|
|
9588
|
+
* Repositories with SageMaker Notebook Instances</a>.</p>
|
|
9512
9589
|
*/
|
|
9513
9590
|
AdditionalCodeRepositories?: string[];
|
|
9514
9591
|
/**
|
|
9515
9592
|
* @public
|
|
9516
9593
|
* <p>Whether root access is enabled or disabled for users of the notebook instance. The
|
|
9517
|
-
*
|
|
9594
|
+
* default value is <code>Enabled</code>.</p>
|
|
9518
9595
|
* <note>
|
|
9519
9596
|
* <p>Lifecycle configurations need root access to be able to set up a notebook
|
|
9520
|
-
*
|
|
9521
|
-
*
|
|
9522
|
-
*
|
|
9597
|
+
* instance. Because of this, lifecycle configurations associated with a notebook
|
|
9598
|
+
* instance always run with root access even if you disable root access for
|
|
9599
|
+
* users.</p>
|
|
9523
9600
|
* </note>
|
|
9524
9601
|
*/
|
|
9525
9602
|
RootAccess?: RootAccess;
|
|
@@ -9549,21 +9626,21 @@ export interface CreateNotebookInstanceOutput {
|
|
|
9549
9626
|
* <p>Contains the notebook instance lifecycle configuration script.</p>
|
|
9550
9627
|
* <p>Each lifecycle configuration script has a limit of 16384 characters.</p>
|
|
9551
9628
|
* <p>The value of the <code>$PATH</code> environment variable that is available to both
|
|
9552
|
-
*
|
|
9553
|
-
* <p>View CloudWatch Logs for notebook instance lifecycle configurations in log group
|
|
9554
|
-
*
|
|
9555
|
-
*
|
|
9629
|
+
* scripts is <code>/sbin:bin:/usr/sbin:/usr/bin</code>.</p>
|
|
9630
|
+
* <p>View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group
|
|
9631
|
+
* <code>/aws/sagemaker/NotebookInstances</code> in log stream
|
|
9632
|
+
* <code>[notebook-instance-name]/[LifecycleConfigHook]</code>.</p>
|
|
9556
9633
|
* <p>Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs
|
|
9557
|
-
*
|
|
9558
|
-
*
|
|
9634
|
+
* for longer than 5 minutes, it fails and the notebook instance is not created or
|
|
9635
|
+
* started.</p>
|
|
9559
9636
|
* <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step
|
|
9560
|
-
*
|
|
9637
|
+
* 2.1: (Optional) Customize a Notebook Instance</a>.</p>
|
|
9561
9638
|
*/
|
|
9562
9639
|
export interface NotebookInstanceLifecycleHook {
|
|
9563
9640
|
/**
|
|
9564
9641
|
* @public
|
|
9565
9642
|
* <p>A base64-encoded string that contains a shell script for a notebook instance lifecycle
|
|
9566
|
-
*
|
|
9643
|
+
* configuration.</p>
|
|
9567
9644
|
*/
|
|
9568
9645
|
Content?: string;
|
|
9569
9646
|
}
|
|
@@ -9579,13 +9656,13 @@ export interface CreateNotebookInstanceLifecycleConfigInput {
|
|
|
9579
9656
|
/**
|
|
9580
9657
|
* @public
|
|
9581
9658
|
* <p>A shell script that runs only once, when you create a notebook instance. The shell
|
|
9582
|
-
*
|
|
9659
|
+
* script must be a base64-encoded string.</p>
|
|
9583
9660
|
*/
|
|
9584
9661
|
OnCreate?: NotebookInstanceLifecycleHook[];
|
|
9585
9662
|
/**
|
|
9586
9663
|
* @public
|
|
9587
9664
|
* <p>A shell script that runs every time you start a notebook instance, including when you
|
|
9588
|
-
*
|
|
9665
|
+
* create the notebook instance. The shell script must be a base64-encoded string.</p>
|
|
9589
9666
|
*/
|
|
9590
9667
|
OnStart?: NotebookInstanceLifecycleHook[];
|
|
9591
9668
|
}
|
|
@@ -10455,7 +10532,7 @@ export interface SpaceCodeEditorAppSettings {
|
|
|
10455
10532
|
/**
|
|
10456
10533
|
* @public
|
|
10457
10534
|
* <p>Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that
|
|
10458
|
-
*
|
|
10535
|
+
* the version runs on.</p>
|
|
10459
10536
|
*/
|
|
10460
10537
|
DefaultResourceSpec?: ResourceSpec;
|
|
10461
10538
|
}
|
|
@@ -10511,7 +10588,7 @@ export interface SpaceJupyterLabAppSettings {
|
|
|
10511
10588
|
/**
|
|
10512
10589
|
* @public
|
|
10513
10590
|
* <p>Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that
|
|
10514
|
-
*
|
|
10591
|
+
* the version runs on.</p>
|
|
10515
10592
|
*/
|
|
10516
10593
|
DefaultResourceSpec?: ResourceSpec;
|
|
10517
10594
|
/**
|
|
@@ -10614,7 +10691,7 @@ export interface SpaceSharingSettings {
|
|
|
10614
10691
|
export interface CreateSpaceRequest {
|
|
10615
10692
|
/**
|
|
10616
10693
|
* @public
|
|
10617
|
-
* <p>The ID of the associated
|
|
10694
|
+
* <p>The ID of the associated domain.</p>
|
|
10618
10695
|
*/
|
|
10619
10696
|
DomainId: string | undefined;
|
|
10620
10697
|
/**
|
|
@@ -10625,8 +10702,8 @@ export interface CreateSpaceRequest {
|
|
|
10625
10702
|
/**
|
|
10626
10703
|
* @public
|
|
10627
10704
|
* <p>Tags to associated with the space. Each tag consists of a key and an optional value.
|
|
10628
|
-
*
|
|
10629
|
-
*
|
|
10705
|
+
* Tag keys must be unique for each resource. Tags are searchable using the
|
|
10706
|
+
* <code>Search</code> API.</p>
|
|
10630
10707
|
*/
|
|
10631
10708
|
Tags?: Tag[];
|
|
10632
10709
|
/**
|
|
@@ -10709,39 +10786,6 @@ export interface CreateStudioLifecycleConfigResponse {
|
|
|
10709
10786
|
*/
|
|
10710
10787
|
StudioLifecycleConfigArn?: string;
|
|
10711
10788
|
}
|
|
10712
|
-
/**
|
|
10713
|
-
* @public
|
|
10714
|
-
* <p>Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
|
|
10715
|
-
* storage paths. To learn more about
|
|
10716
|
-
* how to configure the <code>DebugHookConfig</code> parameter,
|
|
10717
|
-
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.</p>
|
|
10718
|
-
*/
|
|
10719
|
-
export interface DebugHookConfig {
|
|
10720
|
-
/**
|
|
10721
|
-
* @public
|
|
10722
|
-
* <p>Path to local storage location for metrics and tensors. Defaults to
|
|
10723
|
-
* <code>/opt/ml/output/tensors/</code>.</p>
|
|
10724
|
-
*/
|
|
10725
|
-
LocalPath?: string;
|
|
10726
|
-
/**
|
|
10727
|
-
* @public
|
|
10728
|
-
* <p>Path to Amazon S3 storage location for metrics and tensors.</p>
|
|
10729
|
-
*/
|
|
10730
|
-
S3OutputPath: string | undefined;
|
|
10731
|
-
/**
|
|
10732
|
-
* @public
|
|
10733
|
-
* <p>Configuration information for the Amazon SageMaker Debugger hook parameters.</p>
|
|
10734
|
-
*/
|
|
10735
|
-
HookParameters?: Record<string, string>;
|
|
10736
|
-
/**
|
|
10737
|
-
* @public
|
|
10738
|
-
* <p>Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about
|
|
10739
|
-
* how to configure the <code>CollectionConfiguration</code> parameter,
|
|
10740
|
-
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.
|
|
10741
|
-
* </p>
|
|
10742
|
-
*/
|
|
10743
|
-
CollectionConfigurations?: CollectionConfiguration[];
|
|
10744
|
-
}
|
|
10745
10789
|
/**
|
|
10746
10790
|
* @internal
|
|
10747
10791
|
*/
|