@aws-sdk/client-sagemaker 3.600.0 → 3.606.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/index.js +171 -37
  3. package/dist-es/SageMaker.js +4 -0
  4. package/dist-es/commands/CreateHubContentReferenceCommand.js +24 -0
  5. package/dist-es/commands/DeleteHubContentReferenceCommand.js +24 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/models_1.js +15 -0
  8. package/dist-es/models/models_2.js +5 -24
  9. package/dist-es/models/models_3.js +24 -8
  10. package/dist-es/models/models_4.js +8 -0
  11. package/dist-es/protocols/Aws_json1_1.js +76 -0
  12. package/dist-types/SageMaker.d.ts +14 -0
  13. package/dist-types/SageMakerClient.d.ts +4 -2
  14. package/dist-types/commands/BatchDescribeModelPackageCommand.d.ts +3 -0
  15. package/dist-types/commands/CreateAlgorithmCommand.d.ts +3 -0
  16. package/dist-types/commands/CreateCodeRepositoryCommand.d.ts +2 -1
  17. package/dist-types/commands/CreateDomainCommand.d.ts +8 -0
  18. package/dist-types/commands/CreateHubCommand.d.ts +0 -3
  19. package/dist-types/commands/CreateHubContentReferenceCommand.d.ts +80 -0
  20. package/dist-types/commands/CreateModelCommand.d.ts +6 -0
  21. package/dist-types/commands/CreateModelPackageCommand.d.ts +9 -0
  22. package/dist-types/commands/CreateProjectCommand.d.ts +1 -1
  23. package/dist-types/commands/CreateUserProfileCommand.d.ts +8 -0
  24. package/dist-types/commands/DeleteHubCommand.d.ts +0 -3
  25. package/dist-types/commands/DeleteHubContentCommand.d.ts +1 -4
  26. package/dist-types/commands/DeleteHubContentReferenceCommand.d.ts +63 -0
  27. package/dist-types/commands/DescribeAlgorithmCommand.d.ts +3 -0
  28. package/dist-types/commands/DescribeDomainCommand.d.ts +8 -0
  29. package/dist-types/commands/DescribeHubCommand.d.ts +1 -4
  30. package/dist-types/commands/DescribeHubContentCommand.d.ts +5 -5
  31. package/dist-types/commands/DescribeInferenceRecommendationsJobCommand.d.ts +4 -4
  32. package/dist-types/commands/DescribeModelCommand.d.ts +6 -0
  33. package/dist-types/commands/DescribeModelPackageCommand.d.ts +9 -0
  34. package/dist-types/commands/DescribeMonitoringScheduleCommand.d.ts +2 -1
  35. package/dist-types/commands/DescribeNotebookInstanceCommand.d.ts +1 -1
  36. package/dist-types/commands/DescribeUserProfileCommand.d.ts +8 -0
  37. package/dist-types/commands/ImportHubContentCommand.d.ts +1 -4
  38. package/dist-types/commands/ListHubContentVersionsCommand.d.ts +5 -5
  39. package/dist-types/commands/ListHubContentsCommand.d.ts +5 -5
  40. package/dist-types/commands/ListHubsCommand.d.ts +0 -3
  41. package/dist-types/commands/ListInferenceRecommendationsJobStepsCommand.d.ts +4 -4
  42. package/dist-types/commands/ListModelsCommand.d.ts +2 -1
  43. package/dist-types/commands/ListMonitoringAlertHistoryCommand.d.ts +1 -1
  44. package/dist-types/commands/ListMonitoringAlertsCommand.d.ts +1 -2
  45. package/dist-types/commands/SearchCommand.d.ts +9 -0
  46. package/dist-types/commands/UpdateDomainCommand.d.ts +8 -0
  47. package/dist-types/commands/UpdateHubCommand.d.ts +0 -3
  48. package/dist-types/commands/UpdateModelPackageCommand.d.ts +6 -0
  49. package/dist-types/commands/UpdateUserProfileCommand.d.ts +8 -0
  50. package/dist-types/commands/index.d.ts +2 -0
  51. package/dist-types/models/models_0.d.ts +18 -12
  52. package/dist-types/models/models_1.d.ts +100 -81
  53. package/dist-types/models/models_2.d.ts +134 -345
  54. package/dist-types/models/models_3.d.ts +356 -162
  55. package/dist-types/models/models_4.d.ts +162 -2
  56. package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
  57. package/dist-types/ts3.4/SageMaker.d.ts +34 -0
  58. package/dist-types/ts3.4/SageMakerClient.d.ts +12 -0
  59. package/dist-types/ts3.4/commands/CreateCodeRepositoryCommand.d.ts +2 -4
  60. package/dist-types/ts3.4/commands/CreateHubContentReferenceCommand.d.ts +40 -0
  61. package/dist-types/ts3.4/commands/CreateProjectCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/DeleteHubContentReferenceCommand.d.ts +36 -0
  63. package/dist-types/ts3.4/commands/DescribeMonitoringScheduleCommand.d.ts +2 -4
  64. package/dist-types/ts3.4/commands/DescribeNotebookInstanceCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/ListModelsCommand.d.ts +2 -1
  66. package/dist-types/ts3.4/commands/ListMonitoringAlertHistoryCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/ListMonitoringAlertsCommand.d.ts +4 -2
  68. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  69. package/dist-types/ts3.4/models/models_0.d.ts +4 -3
  70. package/dist-types/ts3.4/models/models_1.d.ts +36 -21
  71. package/dist-types/ts3.4/models/models_2.d.ts +42 -96
  72. package/dist-types/ts3.4/models/models_3.d.ts +91 -45
  73. package/dist-types/ts3.4/models/models_4.d.ts +47 -5
  74. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
  75. package/package.json +3 -3
@@ -1,5 +1,85 @@
1
1
  import { ActionSource, ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmValidationSpecification, AppNetworkAccessType, AppSecurityGroupManagement, AppStatus, AppType, ArtifactSource, AsyncInferenceConfig, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLDataSplitConfig, AutoMLJobArtifacts, AutoMLJobChannel, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLOutputDataConfig, AutoMLPartialFailureReason, AutoMLProblemTypeConfig, AutoMLProblemTypeConfigName, AutoMLResolvedAttributes, AutoMLSecurityConfig, Autotune, BatchDataCaptureConfig, BatchStrategy, CaptureStatus, Channel, CheckpointConfig, ClusterInstanceGroupDetails, ClusterNodeDetails, ClusterStatus, CodeEditorAppImageConfig, CodeRepository, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, CompilationJobStatus, ContainerDefinition, ContextSource, GitConfig, HyperParameterTuningJobObjectiveType, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, MetadataProperties, ModelApprovalStatus, ModelDeployConfig, ModelPackageStatus, ObjectiveStatus, OutputDataConfig, ProblemType, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TrainingSpecification, TransformInput, TransformOutput, TransformResources, UserContext, VpcConfig } from "./models_0";
2
- import { _InstanceType, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DefaultSpaceSettings, DeploymentConfig, DeviceSelectionConfig, DirectInternetAccess, DomainSettings, DriftCheckBaselines, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, EFSFileSystem, EndpointInfo, ExperimentConfig, ExplainerConfig, FeatureDefinition, FeatureType, FlowDefinitionOutputConfig, HubS3StorageConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, InferenceComponentComputeResourceRequirements, InferenceComponentStartupParameters, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InferenceExperimentType, InputConfig, InstanceMetadataServiceConfiguration, JobType, JupyterServerAppSettings, KernelGatewayAppSettings, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelCardExportOutputConfig, ModelCardSecurityConfig, ModelCardStatus, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelInfrastructureConfig, ModelMetrics, ModelPackageModelCard, ModelPackageSecurityConfig, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringScheduleConfig, MonitoringStoppingCondition, MonitoringType, NeoVpcConfig, NotebookInstanceAcceleratorType, OfflineStoreConfig, OnlineStoreConfig, OutputConfig, OwnershipSettings, ProcessingInstanceType, Processor, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantManagedInstanceScaling, ProductionVariantRoutingConfig, ProductionVariantServerlessConfig, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, RetryStrategy, RootAccess, ShadowModeConfig, SkipModelValidation, SourceAlgorithmSpecification, SpaceCodeEditorAppSettings, ThroughputMode, TrackingServerSize, UserSettings, VendorGuidance } from "./models_1";
2
+ import { DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DefaultSpaceSettings, DeploymentConfig, DeviceSelectionConfig, DomainSettings, DriftCheckBaselines, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, EndpointInfo, ExperimentConfig, ExplainerConfig, FeatureDefinition, FeatureType, FlowDefinitionOutputConfig, HubS3StorageConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, InferenceComponentComputeResourceRequirements, InferenceComponentStartupParameters, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InferenceExperimentType, InputConfig, JobType, JupyterServerAppSettings, KernelGatewayAppSettings, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelCardExportOutputConfig, ModelCardSecurityConfig, ModelCardStatus, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelInfrastructureConfig, ModelMetrics, ModelPackageModelCard, ModelPackageSecurityConfig, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, NeoVpcConfig, OfflineStoreConfig, OnlineStoreConfig, OutputConfig, ProcessingInstanceType, Processor, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantManagedInstanceScaling, ProductionVariantRoutingConfig, ProductionVariantServerlessConfig, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, RetryStrategy, ServiceCatalogProvisioningDetails, ShadowModeConfig, SkipModelValidation, SourceAlgorithmSpecification, ThroughputMode, TrackingServerSize, UserSettings, VendorGuidance } from "./models_1";
3
+ /**
4
+ * @public
5
+ */
6
+ export interface CreateProjectInput {
7
+ /**
8
+ * <p>The name of the project.</p>
9
+ * @public
10
+ */
11
+ ProjectName: string | undefined;
12
+ /**
13
+ * <p>A description for the project.</p>
14
+ * @public
15
+ */
16
+ ProjectDescription?: string;
17
+ /**
18
+ * <p>The product ID and provisioning artifact ID to provision a service catalog. The provisioning
19
+ * artifact ID will default to the latest provisioning artifact ID of the product, if you don't
20
+ * provide the provisioning artifact ID. For more information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service
21
+ * Catalog</a>.</p>
22
+ * @public
23
+ */
24
+ ServiceCatalogProvisioningDetails: ServiceCatalogProvisioningDetails | undefined;
25
+ /**
26
+ * <p>An array of key-value pairs that you want to use to organize and track your Amazon Web Services
27
+ * resource costs. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>
28
+ * @public
29
+ */
30
+ Tags?: Tag[];
31
+ }
32
+ /**
33
+ * @public
34
+ */
35
+ export interface CreateProjectOutput {
36
+ /**
37
+ * <p>The Amazon Resource Name (ARN) of the project.</p>
38
+ * @public
39
+ */
40
+ ProjectArn: string | undefined;
41
+ /**
42
+ * <p>The ID of the new project.</p>
43
+ * @public
44
+ */
45
+ ProjectId: string | undefined;
46
+ }
47
+ /**
48
+ * <p>The collection of ownership settings for a space.</p>
49
+ * @public
50
+ */
51
+ export interface OwnershipSettings {
52
+ /**
53
+ * <p>The user profile who is the owner of the space.</p>
54
+ * @public
55
+ */
56
+ OwnerUserProfileName: string | undefined;
57
+ }
58
+ /**
59
+ * <p>The application settings for a Code Editor space.</p>
60
+ * @public
61
+ */
62
+ export interface SpaceCodeEditorAppSettings {
63
+ /**
64
+ * <p>Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that
65
+ * the version runs on.</p>
66
+ * @public
67
+ */
68
+ DefaultResourceSpec?: ResourceSpec;
69
+ }
70
+ /**
71
+ * <p>A file system, created by you in Amazon EFS, that you assign to a user profile
72
+ * or space for an Amazon SageMaker Domain. Permitted users can access this file
73
+ * system in Amazon SageMaker Studio.</p>
74
+ * @public
75
+ */
76
+ export interface EFSFileSystem {
77
+ /**
78
+ * <p>The ID of your Amazon EFS file system.</p>
79
+ * @public
80
+ */
81
+ FileSystemId: string | undefined;
82
+ }
3
83
  /**
4
84
  * <p>A file system, created by you, that you assign to a user profile or space for an
5
85
  * Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.</p>
@@ -2009,6 +2089,7 @@ export interface DeleteHubRequest {
2009
2089
  */
2010
2090
  export declare const HubContentType: {
2011
2091
  readonly MODEL: "Model";
2092
+ readonly MODEL_REFERENCE: "ModelReference";
2012
2093
  readonly NOTEBOOK: "Notebook";
2013
2094
  };
2014
2095
  /**
@@ -2040,6 +2121,26 @@ export interface DeleteHubContentRequest {
2040
2121
  */
2041
2122
  HubContentVersion: string | undefined;
2042
2123
  }
2124
+ /**
2125
+ * @public
2126
+ */
2127
+ export interface DeleteHubContentReferenceRequest {
2128
+ /**
2129
+ * <p>The name of the hub to delete the hub content reference from.</p>
2130
+ * @public
2131
+ */
2132
+ HubName: string | undefined;
2133
+ /**
2134
+ * <p>The type of hub content reference to delete. The only supported type of hub content reference to delete is <code>ModelReference</code>.</p>
2135
+ * @public
2136
+ */
2137
+ HubContentType: HubContentType | undefined;
2138
+ /**
2139
+ * <p>The name of the hub content to delete.</p>
2140
+ * @public
2141
+ */
2142
+ HubContentName: string | undefined;
2143
+ }
2043
2144
  /**
2044
2145
  * @public
2045
2146
  */
@@ -5424,6 +5525,18 @@ export declare const HubContentStatus: {
5424
5525
  * @public
5425
5526
  */
5426
5527
  export type HubContentStatus = (typeof HubContentStatus)[keyof typeof HubContentStatus];
5528
+ /**
5529
+ * @public
5530
+ * @enum
5531
+ */
5532
+ export declare const HubContentSupportStatus: {
5533
+ readonly DEPRECATED: "Deprecated";
5534
+ readonly SUPPORTED: "Supported";
5535
+ };
5536
+ /**
5537
+ * @public
5538
+ */
5539
+ export type HubContentSupportStatus = (typeof HubContentSupportStatus)[keyof typeof HubContentSupportStatus];
5427
5540
  /**
5428
5541
  * @public
5429
5542
  */
@@ -5483,6 +5596,21 @@ export interface DescribeHubContentResponse {
5483
5596
  * @public
5484
5597
  */
5485
5598
  HubContentDocument: string | undefined;
5599
+ /**
5600
+ * <p>The ARN of the public hub content.</p>
5601
+ * @public
5602
+ */
5603
+ SageMakerPublicHubContentArn?: string;
5604
+ /**
5605
+ * <p>The minimum version of the hub content.</p>
5606
+ * @public
5607
+ */
5608
+ ReferenceMinVersion?: string;
5609
+ /**
5610
+ * <p>The support status of the hub content.</p>
5611
+ * @public
5612
+ */
5613
+ SupportStatus?: HubContentSupportStatus;
5486
5614
  /**
5487
5615
  * <p>The searchable keywords for the hub content.</p>
5488
5616
  * @public
@@ -6724,22 +6852,22 @@ export interface RecommendationMetrics {
6724
6852
  * <p>Defines the cost per hour for the instance. </p>
6725
6853
  * @public
6726
6854
  */
6727
- CostPerHour: number | undefined;
6855
+ CostPerHour?: number;
6728
6856
  /**
6729
6857
  * <p>Defines the cost per inference for the instance .</p>
6730
6858
  * @public
6731
6859
  */
6732
- CostPerInference: number | undefined;
6860
+ CostPerInference?: number;
6733
6861
  /**
6734
6862
  * <p>The expected maximum number of requests per minute for the instance.</p>
6735
6863
  * @public
6736
6864
  */
6737
- MaxInvocations: number | undefined;
6865
+ MaxInvocations?: number;
6738
6866
  /**
6739
6867
  * <p>The expected model latency at maximum invocation per minute for the instance.</p>
6740
6868
  * @public
6741
6869
  */
6742
- ModelLatency: number | undefined;
6870
+ ModelLatency?: number;
6743
6871
  /**
6744
6872
  * <p>The expected CPU utilization at maximum invocations per minute for the instance.</p>
6745
6873
  * <p>
@@ -6820,7 +6948,7 @@ export interface InferenceRecommendation {
6820
6948
  * <p>The metrics used to decide what recommendation to make.</p>
6821
6949
  * @public
6822
6950
  */
6823
- Metrics: RecommendationMetrics | undefined;
6951
+ Metrics?: RecommendationMetrics;
6824
6952
  /**
6825
6953
  * <p>Defines the endpoint configuration parameters.</p>
6826
6954
  * @public
@@ -8199,345 +8327,6 @@ export interface DescribeMonitoringScheduleRequest {
8199
8327
  */
8200
8328
  MonitoringScheduleName: string | undefined;
8201
8329
  }
8202
- /**
8203
- * @public
8204
- * @enum
8205
- */
8206
- export declare const ExecutionStatus: {
8207
- readonly COMPLETED: "Completed";
8208
- readonly COMPLETED_WITH_VIOLATIONS: "CompletedWithViolations";
8209
- readonly FAILED: "Failed";
8210
- readonly IN_PROGRESS: "InProgress";
8211
- readonly PENDING: "Pending";
8212
- readonly STOPPED: "Stopped";
8213
- readonly STOPPING: "Stopping";
8214
- };
8215
- /**
8216
- * @public
8217
- */
8218
- export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionStatus];
8219
- /**
8220
- * <p>Summary of information about the last monitoring job to run.</p>
8221
- * @public
8222
- */
8223
- export interface MonitoringExecutionSummary {
8224
- /**
8225
- * <p>The name of the monitoring schedule.</p>
8226
- * @public
8227
- */
8228
- MonitoringScheduleName: string | undefined;
8229
- /**
8230
- * <p>The time the monitoring job was scheduled.</p>
8231
- * @public
8232
- */
8233
- ScheduledTime: Date | undefined;
8234
- /**
8235
- * <p>The time at which the monitoring job was created.</p>
8236
- * @public
8237
- */
8238
- CreationTime: Date | undefined;
8239
- /**
8240
- * <p>A timestamp that indicates the last time the monitoring job was modified.</p>
8241
- * @public
8242
- */
8243
- LastModifiedTime: Date | undefined;
8244
- /**
8245
- * <p>The status of the monitoring job.</p>
8246
- * @public
8247
- */
8248
- MonitoringExecutionStatus: ExecutionStatus | undefined;
8249
- /**
8250
- * <p>The Amazon Resource Name (ARN) of the monitoring job.</p>
8251
- * @public
8252
- */
8253
- ProcessingJobArn?: string;
8254
- /**
8255
- * <p>The name of the endpoint used to run the monitoring job.</p>
8256
- * @public
8257
- */
8258
- EndpointName?: string;
8259
- /**
8260
- * <p>Contains the reason a monitoring job failed, if it failed.</p>
8261
- * @public
8262
- */
8263
- FailureReason?: string;
8264
- /**
8265
- * <p>The name of the monitoring job.</p>
8266
- * @public
8267
- */
8268
- MonitoringJobDefinitionName?: string;
8269
- /**
8270
- * <p>The type of the monitoring job.</p>
8271
- * @public
8272
- */
8273
- MonitoringType?: MonitoringType;
8274
- }
8275
- /**
8276
- * @public
8277
- * @enum
8278
- */
8279
- export declare const ScheduleStatus: {
8280
- readonly FAILED: "Failed";
8281
- readonly PENDING: "Pending";
8282
- readonly SCHEDULED: "Scheduled";
8283
- readonly STOPPED: "Stopped";
8284
- };
8285
- /**
8286
- * @public
8287
- */
8288
- export type ScheduleStatus = (typeof ScheduleStatus)[keyof typeof ScheduleStatus];
8289
- /**
8290
- * @public
8291
- */
8292
- export interface DescribeMonitoringScheduleResponse {
8293
- /**
8294
- * <p>The Amazon Resource Name (ARN) of the monitoring schedule.</p>
8295
- * @public
8296
- */
8297
- MonitoringScheduleArn: string | undefined;
8298
- /**
8299
- * <p>Name of the monitoring schedule.</p>
8300
- * @public
8301
- */
8302
- MonitoringScheduleName: string | undefined;
8303
- /**
8304
- * <p>The status of an monitoring job.</p>
8305
- * @public
8306
- */
8307
- MonitoringScheduleStatus: ScheduleStatus | undefined;
8308
- /**
8309
- * <p>The type of the monitoring job that this schedule runs. This is one of the following
8310
- * values.</p>
8311
- * <ul>
8312
- * <li>
8313
- * <p>
8314
- * <code>DATA_QUALITY</code> - The schedule is for a data quality monitoring
8315
- * job.</p>
8316
- * </li>
8317
- * <li>
8318
- * <p>
8319
- * <code>MODEL_QUALITY</code> - The schedule is for a model quality monitoring
8320
- * job.</p>
8321
- * </li>
8322
- * <li>
8323
- * <p>
8324
- * <code>MODEL_BIAS</code> - The schedule is for a bias monitoring job.</p>
8325
- * </li>
8326
- * <li>
8327
- * <p>
8328
- * <code>MODEL_EXPLAINABILITY</code> - The schedule is for an explainability
8329
- * monitoring job.</p>
8330
- * </li>
8331
- * </ul>
8332
- * @public
8333
- */
8334
- MonitoringType?: MonitoringType;
8335
- /**
8336
- * <p>A string, up to one KB in size, that contains the reason a monitoring job failed, if it
8337
- * failed.</p>
8338
- * @public
8339
- */
8340
- FailureReason?: string;
8341
- /**
8342
- * <p>The time at which the monitoring job was created.</p>
8343
- * @public
8344
- */
8345
- CreationTime: Date | undefined;
8346
- /**
8347
- * <p>The time at which the monitoring job was last modified.</p>
8348
- * @public
8349
- */
8350
- LastModifiedTime: Date | undefined;
8351
- /**
8352
- * <p>The configuration object that specifies the monitoring schedule and defines the monitoring
8353
- * job.</p>
8354
- * @public
8355
- */
8356
- MonitoringScheduleConfig: MonitoringScheduleConfig | undefined;
8357
- /**
8358
- * <p> The name of the endpoint for the monitoring job.</p>
8359
- * @public
8360
- */
8361
- EndpointName?: string;
8362
- /**
8363
- * <p>Describes metadata on the last execution to run, if there was one.</p>
8364
- * @public
8365
- */
8366
- LastMonitoringExecutionSummary?: MonitoringExecutionSummary;
8367
- }
8368
- /**
8369
- * @public
8370
- */
8371
- export interface DescribeNotebookInstanceInput {
8372
- /**
8373
- * <p>The name of the notebook instance that you want information about.</p>
8374
- * @public
8375
- */
8376
- NotebookInstanceName: string | undefined;
8377
- }
8378
- /**
8379
- * @public
8380
- * @enum
8381
- */
8382
- export declare const NotebookInstanceStatus: {
8383
- readonly Deleting: "Deleting";
8384
- readonly Failed: "Failed";
8385
- readonly InService: "InService";
8386
- readonly Pending: "Pending";
8387
- readonly Stopped: "Stopped";
8388
- readonly Stopping: "Stopping";
8389
- readonly Updating: "Updating";
8390
- };
8391
- /**
8392
- * @public
8393
- */
8394
- export type NotebookInstanceStatus = (typeof NotebookInstanceStatus)[keyof typeof NotebookInstanceStatus];
8395
- /**
8396
- * @public
8397
- */
8398
- export interface DescribeNotebookInstanceOutput {
8399
- /**
8400
- * <p>The Amazon Resource Name (ARN) of the notebook instance.</p>
8401
- * @public
8402
- */
8403
- NotebookInstanceArn?: string;
8404
- /**
8405
- * <p>The name of the SageMaker notebook instance. </p>
8406
- * @public
8407
- */
8408
- NotebookInstanceName?: string;
8409
- /**
8410
- * <p>The status of the notebook instance.</p>
8411
- * @public
8412
- */
8413
- NotebookInstanceStatus?: NotebookInstanceStatus;
8414
- /**
8415
- * <p>If status is <code>Failed</code>, the reason it failed.</p>
8416
- * @public
8417
- */
8418
- FailureReason?: string;
8419
- /**
8420
- * <p>The URL that you use to connect to the Jupyter notebook that is running in your
8421
- * notebook instance. </p>
8422
- * @public
8423
- */
8424
- Url?: string;
8425
- /**
8426
- * <p>The type of ML compute instance running on the notebook instance.</p>
8427
- * @public
8428
- */
8429
- InstanceType?: _InstanceType;
8430
- /**
8431
- * <p>The ID of the VPC subnet.</p>
8432
- * @public
8433
- */
8434
- SubnetId?: string;
8435
- /**
8436
- * <p>The IDs of the VPC security groups.</p>
8437
- * @public
8438
- */
8439
- SecurityGroups?: string[];
8440
- /**
8441
- * <p>The Amazon Resource Name (ARN) of the IAM role associated with the instance.
8442
- * </p>
8443
- * @public
8444
- */
8445
- RoleArn?: string;
8446
- /**
8447
- * <p>The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the
8448
- * ML storage volume attached to the instance. </p>
8449
- * @public
8450
- */
8451
- KmsKeyId?: string;
8452
- /**
8453
- * <p>The network interface IDs that SageMaker created at the time of creating the instance.
8454
- * </p>
8455
- * @public
8456
- */
8457
- NetworkInterfaceId?: string;
8458
- /**
8459
- * <p>A timestamp. Use this parameter to retrieve the time when the notebook instance was
8460
- * last modified. </p>
8461
- * @public
8462
- */
8463
- LastModifiedTime?: Date;
8464
- /**
8465
- * <p>A timestamp. Use this parameter to return the time when the notebook instance was
8466
- * created</p>
8467
- * @public
8468
- */
8469
- CreationTime?: Date;
8470
- /**
8471
- * <p>Returns the name of a notebook instance lifecycle configuration.</p>
8472
- * <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step
8473
- * 2.1: (Optional) Customize a Notebook Instance</a>
8474
- * </p>
8475
- * @public
8476
- */
8477
- NotebookInstanceLifecycleConfigName?: string;
8478
- /**
8479
- * <p>Describes whether SageMaker provides internet access to the notebook instance. If this
8480
- * value is set to <i>Disabled</i>, the notebook instance does not have
8481
- * internet access, and cannot connect to SageMaker training and endpoint services.</p>
8482
- * <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>.</p>
8483
- * @public
8484
- */
8485
- DirectInternetAccess?: DirectInternetAccess;
8486
- /**
8487
- * <p>The size, in GB, of the ML storage volume attached to the notebook instance.</p>
8488
- * @public
8489
- */
8490
- VolumeSizeInGB?: number;
8491
- /**
8492
- * <p>A list of the Elastic Inference (EI) instance types associated with this notebook
8493
- * instance. Currently only one EI instance type can be associated with a notebook
8494
- * instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic Inference in
8495
- * Amazon SageMaker</a>.</p>
8496
- * @public
8497
- */
8498
- AcceleratorTypes?: NotebookInstanceAcceleratorType[];
8499
- /**
8500
- * <p>The Git repository associated with the notebook instance as its default code
8501
- * repository. This can be either the name of a Git repository stored as a resource in your
8502
- * 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>
8503
- * or in any other Git repository. When you open a notebook instance, it opens in the
8504
- * 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
8505
- * Repositories with SageMaker Notebook Instances</a>.</p>
8506
- * @public
8507
- */
8508
- DefaultCodeRepository?: string;
8509
- /**
8510
- * <p>An array of up to three Git repositories associated with the notebook instance. These
8511
- * can be either the names of Git repositories stored as resources in your account, or the
8512
- * URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
8513
- * or in any other Git repository. These repositories are cloned at the same level as the
8514
- * 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
8515
- * Repositories with SageMaker Notebook Instances</a>.</p>
8516
- * @public
8517
- */
8518
- AdditionalCodeRepositories?: string[];
8519
- /**
8520
- * <p>Whether root access is enabled or disabled for users of the notebook instance.</p>
8521
- * <note>
8522
- * <p>Lifecycle configurations need root access to be able to set up a notebook
8523
- * instance. Because of this, lifecycle configurations associated with a notebook
8524
- * instance always run with root access even if you disable root access for
8525
- * users.</p>
8526
- * </note>
8527
- * @public
8528
- */
8529
- RootAccess?: RootAccess;
8530
- /**
8531
- * <p>The platform identifier of the notebook instance runtime environment.</p>
8532
- * @public
8533
- */
8534
- PlatformIdentifier?: string;
8535
- /**
8536
- * <p>Information on the IMDS configuration of the notebook instance</p>
8537
- * @public
8538
- */
8539
- InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration;
8540
- }
8541
8330
  /**
8542
8331
  * @internal
8543
8332
  */