@aws-sdk/client-sagemaker 3.1069.0 → 3.1070.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 (48) hide show
  1. package/dist-cjs/index.js +16 -10
  2. package/dist-cjs/schemas/schemas_0.js +35 -14
  3. package/dist-es/models/enums.js +16 -10
  4. package/dist-es/schemas/schemas_0.js +33 -14
  5. package/dist-types/commands/CreateAppCommand.d.ts +1 -1
  6. package/dist-types/commands/CreateDomainCommand.d.ts +6 -6
  7. package/dist-types/commands/CreateEndpointConfigCommand.d.ts +1 -0
  8. package/dist-types/commands/CreateInferenceComponentCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateModelCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateSpaceCommand.d.ts +4 -4
  11. package/dist-types/commands/CreateUserProfileCommand.d.ts +6 -6
  12. package/dist-types/commands/DescribeAppCommand.d.ts +1 -1
  13. package/dist-types/commands/DescribeDomainCommand.d.ts +6 -6
  14. package/dist-types/commands/DescribeEndpointCommand.d.ts +1 -0
  15. package/dist-types/commands/DescribeEndpointConfigCommand.d.ts +1 -0
  16. package/dist-types/commands/DescribeImageVersionCommand.d.ts +1 -1
  17. package/dist-types/commands/DescribeInferenceComponentCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeModelCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeSpaceCommand.d.ts +4 -4
  20. package/dist-types/commands/DescribeUserProfileCommand.d.ts +6 -6
  21. package/dist-types/commands/ListAppsCommand.d.ts +1 -1
  22. package/dist-types/commands/ListInferenceRecommendationsJobsCommand.d.ts +1 -1
  23. package/dist-types/commands/SearchCommand.d.ts +16 -0
  24. package/dist-types/commands/UpdateDomainCommand.d.ts +6 -6
  25. package/dist-types/commands/UpdateInferenceComponentCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateMonitoringScheduleCommand.d.ts +2 -1
  27. package/dist-types/commands/UpdateNotebookInstanceCommand.d.ts +1 -2
  28. package/dist-types/commands/UpdateSpaceCommand.d.ts +4 -4
  29. package/dist-types/commands/UpdateUserProfileCommand.d.ts +6 -6
  30. package/dist-types/models/enums.d.ts +15 -9
  31. package/dist-types/models/models_1.d.ts +43 -33
  32. package/dist-types/models/models_2.d.ts +34 -107
  33. package/dist-types/models/models_3.d.ts +113 -84
  34. package/dist-types/models/models_4.d.ts +84 -100
  35. package/dist-types/models/models_5.d.ts +97 -2
  36. package/dist-types/schemas/schemas_0.d.ts +2 -0
  37. package/dist-types/ts3.4/commands/DescribeImageVersionCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/ListInferenceRecommendationsJobsCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/UpdateMonitoringScheduleCommand.d.ts +2 -4
  40. package/dist-types/ts3.4/commands/UpdateNotebookInstanceCommand.d.ts +4 -2
  41. package/dist-types/ts3.4/models/enums.d.ts +15 -9
  42. package/dist-types/ts3.4/models/models_1.d.ts +10 -8
  43. package/dist-types/ts3.4/models/models_2.d.ts +8 -29
  44. package/dist-types/ts3.4/models/models_3.d.ts +28 -19
  45. package/dist-types/ts3.4/models/models_4.d.ts +20 -27
  46. package/dist-types/ts3.4/models/models_5.d.ts +32 -1
  47. package/dist-types/ts3.4/schemas/schemas_0.d.ts +2 -0
  48. package/package.json +1 -1
@@ -89,6 +89,33 @@ export interface ConditionStepMetadata {
89
89
  */
90
90
  Outcome?: ConditionOutcome | undefined;
91
91
  }
92
+ /**
93
+ * <p>Specifies a metrics endpoint for a container, including the path where the container exposes Prometheus-formatted metrics and the frequency at which to publish them to Amazon CloudWatch.</p>
94
+ * @public
95
+ */
96
+ export interface MetricsEndpoint {
97
+ /**
98
+ * <p>The path to the metrics endpoint exposed by the container. For example, <code>/metrics</code> or <code>/server/metrics</code>. The path must start with <code>/</code> and can contain alphanumeric characters, forward slashes, underscores, hyphens, and periods. Maximum length is 256 characters. If not specified, defaults to <code>/metrics</code>.</p>
99
+ * @public
100
+ */
101
+ MetricsEndpointPath: string | undefined;
102
+ /**
103
+ * <p>The interval, in seconds, at which container metrics scraped from the endpoint are published to Amazon CloudWatch. Valid values: <code>10</code>, <code>30</code>, <code>60</code>, <code>120</code>, <code>180</code>, <code>240</code>, <code>300</code>. Defaults to <code>60</code>.</p>
104
+ * @public
105
+ */
106
+ MetricPublishFrequencyInSeconds?: MetricPublishFrequencyInSeconds | undefined;
107
+ }
108
+ /**
109
+ * <p>The configuration for container-level metrics scraping. Use this configuration to specify a custom metrics endpoint path and publishing frequency for container metrics. When <code>EnableDetailedObservability</code> is set to <code>True</code> in <code>MetricsConfig</code>, metrics are scraped from the container's Prometheus endpoint. If this configuration is not provided, the default path <code>/metrics</code> on port <code>8080</code> is used with a default publishing frequency of <code>60</code> seconds. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional.</p>
110
+ * @public
111
+ */
112
+ export interface ContainerMetricsConfig {
113
+ /**
114
+ * <p>A list of metrics endpoints to scrape from the container. Each endpoint specifies the path where the container exposes Prometheus-formatted metrics and the frequency at which to publish them. You can specify a maximum of 1 endpoint.</p>
115
+ * @public
116
+ */
117
+ MetricsEndpoints?: MetricsEndpoint[] | undefined;
118
+ }
92
119
  /**
93
120
  * <p>Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified <code>Vpc</code> as the value for the <code>RepositoryAccessMode</code> field of the <code>ImageConfig</code> object that you passed to a call to <code>CreateModel</code> and the private Docker registry where the model image is hosted requires authentication.</p>
94
121
  * @public
@@ -187,6 +214,11 @@ export interface ContainerDefinition {
187
214
  * @public
188
215
  */
189
216
  MultiModelConfig?: MultiModelConfig | undefined;
217
+ /**
218
+ * <p>The configuration for container metrics scraping. Specifies the metrics endpoint path and publishing frequency. If not specified when <code>EnableDetailedObservability</code> is <code>True</code>, the default path <code>/metrics</code> on port <code>8080</code> is used. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional.</p>
219
+ * @public
220
+ */
221
+ ContainerMetricsConfig?: ContainerMetricsConfig | undefined;
190
222
  }
191
223
  /**
192
224
  * <p>A structure describing the source of a context.</p>
@@ -2913,7 +2945,12 @@ export interface MetricsConfig {
2913
2945
  */
2914
2946
  EnableEnhancedMetrics?: boolean | undefined;
2915
2947
  /**
2916
- * <p>The interval, in seconds, at which metrics are published to Amazon CloudWatch. Defaults to <code>60</code>. Valid values: <code>10</code>, <code>30</code>, <code>60</code>, <code>120</code>, <code>180</code>, <code>240</code>, <code>300</code>. When <code>EnableEnhancedMetrics</code> is set to <code>False</code>, this interval applies to utilization metrics only; invocation metrics continue to be published at the default 60-second interval. When <code>EnableEnhancedMetrics</code> is set to <code>True</code>, this interval applies to both utilization and invocation metrics.</p>
2948
+ * <p>Indicates whether detailed observability is enabled for the endpoint. When set to <code>True</code>, the following metrics are published at the configured frequency:</p> <ul> <li> <p>Container-level inference metrics scraped from the container's Prometheus endpoint (such as request latency, error counts, and throughput). Available metrics vary by framework.</p> </li> <li> <p>Per-GPU metrics (utilization, memory, and temperature) attributed to individual inference components.</p> </li> <li> <p>Per-instance host metrics (CPU, memory, and disk utilization).</p> </li> <li> <p>Inference component placement metrics (copy count per Availability Zone).</p> </li> </ul> <p>For first-party and Deep Learning Containers (DLC), the Prometheus endpoint path is determined automatically. For Bring-Your-Own-Container (BYOC) cases, you can optionally set <code>ContainerMetricsConfig</code> to specify a custom endpoint path. If not specified, the default path <code>/metrics</code> on port <code>8080</code> is used.</p> <p>When set to <code>False</code>, these additional metrics are not published. Standard invocation and utilization metrics controlled by <code>EnableEnhancedMetrics</code> are unaffected.</p> <p>The default value for new endpoint configurations is <code>True</code>. For existing endpoint configurations created before this feature, the value is <code>False</code> unless explicitly set.</p>
2949
+ * @public
2950
+ */
2951
+ EnableDetailedObservability?: boolean | undefined;
2952
+ /**
2953
+ * <p>The interval, in seconds, at which metrics are published to Amazon CloudWatch. Defaults to <code>60</code>. Valid values: <code>10</code>, <code>30</code>, <code>60</code>, <code>120</code>, <code>180</code>, <code>240</code>, <code>300</code>.</p> <p>When <code>EnableEnhancedMetrics</code> is set to <code>False</code>, this interval applies to utilization metrics only. Invocation metrics continue to be published at the default 60-second interval. When <code>EnableEnhancedMetrics</code> is set to <code>True</code>, this interval applies to both utilization and invocation metrics.</p> <p>When <code>EnableDetailedObservability</code> is set to <code>True</code>, this interval applies to per-GPU metrics, per-instance host metrics, container metrics, and fleet-level inference component lifecycle and placement metrics.</p>
2917
2954
  * @public
2918
2955
  */
2919
2956
  MetricPublishFrequencyInSeconds?: MetricPublishFrequencyInSeconds | undefined;
@@ -4485,6 +4522,11 @@ export interface InferenceComponentContainerSpecification {
4485
4522
  * @public
4486
4523
  */
4487
4524
  Environment?: Record<string, string> | undefined;
4525
+ /**
4526
+ * <p>The configuration for container metrics scraping. Specifies the metrics endpoint path and publishing frequency for the inference component's container. If not specified when <code>EnableDetailedObservability</code> is <code>True</code>, the default path <code>/metrics</code> on port <code>8080</code> is used. For first-party and Deep Learning Containers (DLC), the endpoint path is determined automatically and this configuration is optional.</p>
4527
+ * @public
4528
+ */
4529
+ ContainerMetricsConfig?: ContainerMetricsConfig | undefined;
4488
4530
  }
4489
4531
  /**
4490
4532
  * <p>Settings that affect how the inference component caches data.</p>
@@ -7148,35 +7190,3 @@ export interface OptimizationJobModelSource {
7148
7190
  */
7149
7191
  SageMakerModel?: OptimizationSageMakerModel | undefined;
7150
7192
  }
7151
- /**
7152
- * <p>Settings for the model compilation technique that's applied by a model optimization job.</p>
7153
- * @public
7154
- */
7155
- export interface ModelCompilationConfig {
7156
- /**
7157
- * <p>The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.</p>
7158
- * @public
7159
- */
7160
- Image?: string | undefined;
7161
- /**
7162
- * <p>Environment variables that override the default ones in the model container.</p>
7163
- * @public
7164
- */
7165
- OverrideEnvironment?: Record<string, string> | undefined;
7166
- }
7167
- /**
7168
- * <p>Settings for the model quantization technique that's applied by a model optimization job.</p>
7169
- * @public
7170
- */
7171
- export interface ModelQuantizationConfig {
7172
- /**
7173
- * <p>The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.</p>
7174
- * @public
7175
- */
7176
- Image?: string | undefined;
7177
- /**
7178
- * <p>Environment variables that override the default ones in the model container.</p>
7179
- * @public
7180
- */
7181
- OverrideEnvironment?: Record<string, string> | undefined;
7182
- }
@@ -1,6 +1,38 @@
1
- import type { ActionStatus, ActivationState, AIBenchmarkJobStatus, AIRecommendationJobStatus, AlgorithmStatus, AppNetworkAccessType, AppSecurityGroupManagement, AppStatus, AppType, AuthMode, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLProblemTypeConfigName, BatchStrategy, CapacityReservationPreference, CaptureStatus, ClusterNodeProvisioningMode, ClusterNodeRecovery, ClusterStatus, CompilationJobStatus, CustomizationTechnique, DataDistributionType, DeepHealthCheckType, DomainStatus, EdgePackagingJobStatus, EdgePresetDeploymentStatus, EdgePresetDeploymentType, EnabledOrDisabled, EndpointStatus, EvaluationType, FeatureGroupStatus, FeatureStatus, FeatureType, FlowDefinitionStatus, HomeEfsFileSystemCreation, HubContentStatus, HubContentSupportStatus, HubContentType, HubStatus, HumanTaskUiStatus, HyperParameterTuningJobObjectiveType, HyperParameterTuningJobStatus, ImageStatus, ImageVersionStatus, InputMode, JobCategory, JobType, JoinSource, LastUpdateStatusValue, ModelSpeculativeDecodingS3DataType, ModelSpeculativeDecodingTechnique, ObjectiveStatus, OfflineStoreStatusValue, OptimizationJobDeploymentInstanceType, PartnerAppAuthType, PartnerAppType, Peft, ProblemType, ProcessingInstanceType, ProcessingS3CompressionType, ProcessingS3DataDistributionType, ProcessingS3DataType, ProcessingS3InputMode, ProcessingS3UploadMode, Processor, ProductionVariantAcceleratorType, ProductionVariantInstanceType, RecommendationStatus, RedshiftResultCompressionType, RedshiftResultFormat, RetentionType, RuleEvaluationStatus, SchedulerConfigComponent, SchedulerResourceStatus, ServerlessJobType, SharingType, StageStatus, Statistic, StudioLifecycleConfigAppType, TagPropagation, ThroughputMode, TrainingJobStatus, TrialComponentPrimaryStatus, VariantStatus, VendorGuidance, WorkforceIpAddressType } from "./enums";
1
+ import type { ActionStatus, ActivationState, AIBenchmarkJobStatus, AIRecommendationJobStatus, AlgorithmStatus, AppNetworkAccessType, AppSecurityGroupManagement, AppStatus, AppType, AuthMode, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLProblemTypeConfigName, BatchStrategy, CapacityReservationPreference, CaptureStatus, ClusterNodeProvisioningMode, ClusterNodeRecovery, ClusterStatus, CompilationJobStatus, CustomizationTechnique, DataDistributionType, DeepHealthCheckType, DomainStatus, EdgePackagingJobStatus, EdgePresetDeploymentStatus, EdgePresetDeploymentType, EnabledOrDisabled, EndpointStatus, EvaluationType, FeatureGroupStatus, FeatureStatus, FeatureType, FlowDefinitionStatus, HomeEfsFileSystemCreation, HubContentStatus, HubContentSupportStatus, HubContentType, HubStatus, HumanTaskUiStatus, HyperParameterTuningJobObjectiveType, HyperParameterTuningJobStatus, ImageStatus, InputMode, JobCategory, JoinSource, LastUpdateStatusValue, ModelSpeculativeDecodingS3DataType, ModelSpeculativeDecodingTechnique, ObjectiveStatus, OfflineStoreStatusValue, OptimizationJobDeploymentInstanceType, PartnerAppAuthType, PartnerAppType, Peft, ProblemType, ProcessingInstanceType, ProcessingS3CompressionType, ProcessingS3DataDistributionType, ProcessingS3DataType, ProcessingS3InputMode, ProcessingS3UploadMode, ProductionVariantAcceleratorType, ProductionVariantInstanceType, RecommendationStatus, RedshiftResultCompressionType, RedshiftResultFormat, RetentionType, RuleEvaluationStatus, SchedulerConfigComponent, SchedulerResourceStatus, ServerlessJobType, SharingType, StageStatus, Statistic, StudioLifecycleConfigAppType, TagPropagation, ThroughputMode, TrainingJobStatus, TrialComponentPrimaryStatus, VariantStatus, WorkforceIpAddressType } from "./enums";
2
2
  import type { ActionSource, AIBenchmarkNetworkConfig, AIBenchmarkOutputResult, AIBenchmarkTarget, AIDatasetConfig, AIModelSource, AIRecommendation, AIRecommendationComputeSpec, AIRecommendationInferenceSpecification, AIRecommendationOutputResult, AIRecommendationPerformanceTarget, AIWorkloadConfigs, AlgorithmSpecification, AlgorithmStatusDetails, AlgorithmValidationSpecification, AppSpecification, ArtifactSource, AsyncInferenceConfig, AthenaDatasetDefinition, AutoMLCandidate, AutoMLChannel, AutoMLComputeConfig, AutoMLDataSplitConfig, AutoMLJobArtifacts, AutoMLJobChannel, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLOutputDataConfig, AutoMLPartialFailureReason, AutoMLProblemTypeConfig, AutoMLResolvedAttributes, AutoMLSecurityConfig, Autotune, BatchDataCaptureConfig, CfnCreateTemplateProvider, Channel, CheckpointConfig, ClusterAutoScalingConfigOutput, ClusterEventDetail, ClusterInstanceGroupDetails, ClusterNodeDetails, ClusterOrchestrator, ClusterRestrictedInstanceGroupDetails, ClusterRestrictedInstanceGroupsConfigOutput, ClusterTieredStorageConfig, CodeEditorAppImageConfig, CodeRepository, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, ComputeQuotaConfig, GitConfig, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, OutputDataConfig, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, VpcConfig } from "./models_0";
3
- import type { ComputeQuotaTarget, ContextSource, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DefaultSpaceSettings, DeploymentConfig, DeviceSelectionConfig, DomainSettings, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, ExplainerConfig, FeatureDefinition, FlowDefinitionOutputConfig, HubS3StorageConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, InputConfig, JupyterServerAppSettings, KernelGatewayAppSettings, MetadataProperties, MetricsConfig, ModelCompilationConfig, ModelDeployConfig, ModelQuantizationConfig, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, NeoVpcConfig, NetworkConfig, OfflineStoreConfig, OnlineStoreConfig, OptimizationJobModelSource, OptimizationSageMakerModel, OutputConfig, ProductionVariant, ProductionVariantManagedInstanceScaling, ProductionVariantRoutingConfig, ProductionVariantServerlessConfig, RetryStrategy, SchedulerConfig, TrainingSpecification, UserSettings } from "./models_1";
3
+ import type { ComputeQuotaTarget, ContextSource, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DefaultSpaceSettings, DeploymentConfig, DeviceSelectionConfig, DomainSettings, EdgeDeploymentConfig, EdgeDeploymentModelConfig, EdgeOutputConfig, ExplainerConfig, FeatureDefinition, FlowDefinitionOutputConfig, HubS3StorageConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, InputConfig, JupyterServerAppSettings, KernelGatewayAppSettings, MetadataProperties, MetricsConfig, ModelDeployConfig, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, NeoVpcConfig, NetworkConfig, OfflineStoreConfig, OnlineStoreConfig, OptimizationJobModelSource, OptimizationSageMakerModel, OutputConfig, ProductionVariant, ProductionVariantManagedInstanceScaling, ProductionVariantRoutingConfig, ProductionVariantServerlessConfig, RetryStrategy, SchedulerConfig, TrainingSpecification, UserSettings } from "./models_1";
4
+ /**
5
+ * <p>Settings for the model compilation technique that's applied by a model optimization job.</p>
6
+ * @public
7
+ */
8
+ export interface ModelCompilationConfig {
9
+ /**
10
+ * <p>The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.</p>
11
+ * @public
12
+ */
13
+ Image?: string | undefined;
14
+ /**
15
+ * <p>Environment variables that override the default ones in the model container.</p>
16
+ * @public
17
+ */
18
+ OverrideEnvironment?: Record<string, string> | undefined;
19
+ }
20
+ /**
21
+ * <p>Settings for the model quantization technique that's applied by a model optimization job.</p>
22
+ * @public
23
+ */
24
+ export interface ModelQuantizationConfig {
25
+ /**
26
+ * <p>The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.</p>
27
+ * @public
28
+ */
29
+ Image?: string | undefined;
30
+ /**
31
+ * <p>Environment variables that override the default ones in the model container.</p>
32
+ * @public
33
+ */
34
+ OverrideEnvironment?: Record<string, string> | undefined;
35
+ }
4
36
  /**
5
37
  * <p>Settings for the model sharding technique that's applied by a model optimization job.</p>
6
38
  * @public
@@ -7100,108 +7132,3 @@ export interface DescribeImageResponse {
7100
7132
  */
7101
7133
  RoleArn?: string | undefined;
7102
7134
  }
7103
- /**
7104
- * @public
7105
- */
7106
- export interface DescribeImageVersionRequest {
7107
- /**
7108
- * <p>The name of the image.</p>
7109
- * @public
7110
- */
7111
- ImageName: string | undefined;
7112
- /**
7113
- * <p>The version of the image. If not specified, the latest version is described.</p>
7114
- * @public
7115
- */
7116
- Version?: number | undefined;
7117
- /**
7118
- * <p>The alias of the image version.</p>
7119
- * @public
7120
- */
7121
- Alias?: string | undefined;
7122
- }
7123
- /**
7124
- * @public
7125
- */
7126
- export interface DescribeImageVersionResponse {
7127
- /**
7128
- * <p>The registry path of the container image on which this image version is based.</p>
7129
- * @public
7130
- */
7131
- BaseImage?: string | undefined;
7132
- /**
7133
- * <p>The registry path of the container image that contains this image version.</p>
7134
- * @public
7135
- */
7136
- ContainerImage?: string | undefined;
7137
- /**
7138
- * <p>When the version was created.</p>
7139
- * @public
7140
- */
7141
- CreationTime?: Date | undefined;
7142
- /**
7143
- * <p>When a create or delete operation fails, the reason for the failure.</p>
7144
- * @public
7145
- */
7146
- FailureReason?: string | undefined;
7147
- /**
7148
- * <p>The ARN of the image the version is based on.</p>
7149
- * @public
7150
- */
7151
- ImageArn?: string | undefined;
7152
- /**
7153
- * <p>The ARN of the version.</p>
7154
- * @public
7155
- */
7156
- ImageVersionArn?: string | undefined;
7157
- /**
7158
- * <p>The status of the version.</p>
7159
- * @public
7160
- */
7161
- ImageVersionStatus?: ImageVersionStatus | undefined;
7162
- /**
7163
- * <p>When the version was last modified.</p>
7164
- * @public
7165
- */
7166
- LastModifiedTime?: Date | undefined;
7167
- /**
7168
- * <p>The version number.</p>
7169
- * @public
7170
- */
7171
- Version?: number | undefined;
7172
- /**
7173
- * <p>The stability of the image version specified by the maintainer.</p> <ul> <li> <p> <code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p> </li> <li> <p> <code>STABLE</code>: The image version is stable.</p> </li> <li> <p> <code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p> </li> <li> <p> <code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </p> </li> </ul>
7174
- * @public
7175
- */
7176
- VendorGuidance?: VendorGuidance | undefined;
7177
- /**
7178
- * <p>Indicates SageMaker AI job type compatibility.</p> <ul> <li> <p> <code>TRAINING</code>: The image version is compatible with SageMaker AI training jobs.</p> </li> <li> <p> <code>INFERENCE</code>: The image version is compatible with SageMaker AI inference jobs.</p> </li> <li> <p> <code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker AI notebook kernels.</p> </li> </ul>
7179
- * @public
7180
- */
7181
- JobType?: JobType | undefined;
7182
- /**
7183
- * <p>The machine learning framework vended in the image version.</p>
7184
- * @public
7185
- */
7186
- MLFramework?: string | undefined;
7187
- /**
7188
- * <p>The supported programming language and its version.</p>
7189
- * @public
7190
- */
7191
- ProgrammingLang?: string | undefined;
7192
- /**
7193
- * <p>Indicates CPU or GPU compatibility.</p> <ul> <li> <p> <code>CPU</code>: The image version is compatible with CPU.</p> </li> <li> <p> <code>GPU</code>: The image version is compatible with GPU.</p> </li> </ul>
7194
- * @public
7195
- */
7196
- Processor?: Processor | undefined;
7197
- /**
7198
- * <p>Indicates Horovod compatibility.</p>
7199
- * @public
7200
- */
7201
- Horovod?: boolean | undefined;
7202
- /**
7203
- * <p>The maintainer description of the image version.</p>
7204
- * @public
7205
- */
7206
- ReleaseNotes?: string | undefined;
7207
- }
@@ -1,7 +1,112 @@
1
- import type { _InstanceType, AccountDefaultStatus, AIBenchmarkJobStatus, AIRecommendationJobStatus, AlgorithmSortBy, AppImageConfigSortKey, AppSortKey, AssociationEdgeType, AutoMLJobStatus, AutoMLSortBy, AutoMLSortOrder, BatchStrategy, CandidateSortBy, CandidateStatus, ClusterEventResourceType, ClusterSortBy, CodeRepositorySortBy, CodeRepositorySortOrder, CompilationJobStatus, DetailedModelPackageStatus, DeviceDeploymentStatus, DirectInternetAccess, DomainStatus, EdgePackagingJobStatus, EndpointConfigSortKey, EndpointSortKey, EndpointStatus, EventSortBy, ExecutionRoleIdentityConfig, ExecutionStatus, FeatureGroupSortBy, FeatureGroupSortOrder, FeatureGroupStatus, FeatureType, FlowDefinitionStatus, HubContentSortBy, HubContentStatus, HubContentSupportStatus, HubContentType, HubSortBy, HubStatus, HyperParameterTuningJobSortByOptions, HyperParameterTuningJobStatus, HyperParameterTuningJobStrategyType, ImageSortBy, ImageSortOrder, ImageStatus, ImageVersionSortBy, ImageVersionSortOrder, ImageVersionStatus, IncludedData, InferenceComponentCapacitySizeType, InferenceComponentSortKey, InferenceComponentStatus, InferenceExperimentStatus, InferenceExperimentType, IPAddressType, IsTrackingServerActive, JobCategory, JobSecondaryStatus, JobStatus, LabelingJobStatus, ListAIBenchmarkJobsSortBy, ListAIRecommendationJobsSortBy, ListAIWorkloadConfigsSortBy, ListCompilationJobsSortBy, ListDeviceFleetsSortBy, ListEdgeDeploymentPlansSortBy, ListEdgePackagingJobsSortBy, ListInferenceRecommendationsJobsSortBy, MaintenanceStatus, ManagedStorageType, MlflowAppStatus, ModelApprovalStatus, ModelCardExportJobStatus, ModelCardProcessingStatus, ModelCardStatus, ModelPackageGroupStatus, ModelPackageRegistrationType, ModelPackageStatus, ModelRegistrationMode, ModelVariantStatus, MonitoringJobDefinitionSortKey, MonitoringType, NotebookInstanceAcceleratorType, NotebookInstanceStatus, OfflineStoreStatusValue, Operator, OptimizationJobDeploymentInstanceType, OptimizationJobStatus, OrderKey, PartnerAppAuthType, PartnerAppStatus, PartnerAppType, PipelineExecutionStatus, PipelineStatus, ProcessingJobStatus, ProductionVariantInstanceType, ProfilingStatus, ProjectStatus, RecommendationJobStatus, RecommendationJobType, RecommendationStepType, ReservedCapacityInstanceType, ReservedCapacityStatus, ReservedCapacityType, ResourceType, RootAccess, RuleEvaluationStatus, SageMakerResourceName, SagemakerServicecatalogStatus, SchedulerResourceStatus, ScheduleStatus, SecondaryStatus, SkipModelValidation, SortActionsBy, SortArtifactsBy, SortAssociationsBy, SortClusterSchedulerConfigBy, SortContextsBy, SortExperimentsBy, SortInferenceExperimentsBy, SortOrder, SortQuotaBy, SpaceStatus, StudioLifecycleConfigAppType, TrackingServerMaintenanceStatus, TrackingServerSize, TrackingServerStatus, TrainingJobStatus, TrainingPlanStatus, TransformJobStatus, UserProfileStatus, VolumeAttachmentStatus, WarmPoolResourceStatus, WorkforceIpAddressType, WorkforceStatus } from "./enums";
1
+ import type { _InstanceType, AccountDefaultStatus, AIBenchmarkJobStatus, AIRecommendationJobStatus, AlgorithmSortBy, AppImageConfigSortKey, AppSortKey, AssociationEdgeType, AutoMLJobStatus, AutoMLSortBy, AutoMLSortOrder, BatchStrategy, CandidateSortBy, CandidateStatus, ClusterEventResourceType, ClusterSortBy, CodeRepositorySortBy, CodeRepositorySortOrder, CompilationJobStatus, DetailedModelPackageStatus, DeviceDeploymentStatus, DirectInternetAccess, DomainStatus, EdgePackagingJobStatus, EndpointConfigSortKey, EndpointSortKey, EndpointStatus, EventSortBy, ExecutionRoleIdentityConfig, ExecutionStatus, FeatureGroupSortBy, FeatureGroupSortOrder, FeatureGroupStatus, FeatureType, FlowDefinitionStatus, HubContentSortBy, HubContentStatus, HubContentSupportStatus, HubContentType, HubSortBy, HubStatus, HyperParameterTuningJobSortByOptions, HyperParameterTuningJobStatus, HyperParameterTuningJobStrategyType, ImageSortBy, ImageSortOrder, ImageStatus, ImageVersionSortBy, ImageVersionSortOrder, ImageVersionStatus, IncludedData, InferenceComponentCapacitySizeType, InferenceComponentSortKey, InferenceComponentStatus, InferenceExperimentStatus, InferenceExperimentType, IPAddressType, IsTrackingServerActive, JobCategory, JobSecondaryStatus, JobStatus, JobType, LabelingJobStatus, ListAIBenchmarkJobsSortBy, ListAIRecommendationJobsSortBy, ListAIWorkloadConfigsSortBy, ListCompilationJobsSortBy, ListDeviceFleetsSortBy, ListEdgeDeploymentPlansSortBy, ListEdgePackagingJobsSortBy, MaintenanceStatus, ManagedStorageType, MlflowAppStatus, ModelApprovalStatus, ModelCardExportJobStatus, ModelCardProcessingStatus, ModelCardStatus, ModelPackageGroupStatus, ModelPackageRegistrationType, ModelPackageStatus, ModelRegistrationMode, ModelVariantStatus, MonitoringJobDefinitionSortKey, MonitoringType, NotebookInstanceAcceleratorType, NotebookInstanceStatus, OfflineStoreStatusValue, Operator, OptimizationJobDeploymentInstanceType, OptimizationJobStatus, OrderKey, PartnerAppAuthType, PartnerAppStatus, PartnerAppType, PipelineExecutionStatus, PipelineStatus, ProcessingJobStatus, Processor, ProductionVariantInstanceType, ProfilingStatus, ProjectStatus, RecommendationJobStatus, RecommendationJobType, RecommendationStepType, ReservedCapacityInstanceType, ReservedCapacityStatus, ReservedCapacityType, ResourceType, RootAccess, RuleEvaluationStatus, SageMakerResourceName, SagemakerServicecatalogStatus, SchedulerResourceStatus, ScheduleStatus, SecondaryStatus, SkipModelValidation, SortActionsBy, SortArtifactsBy, SortAssociationsBy, SortClusterSchedulerConfigBy, SortContextsBy, SortExperimentsBy, SortInferenceExperimentsBy, SortOrder, SortQuotaBy, SpaceStatus, StudioLifecycleConfigAppType, TrackingServerMaintenanceStatus, TrackingServerSize, TrackingServerStatus, TrainingJobStatus, TrainingPlanStatus, TransformJobStatus, UserProfileStatus, VendorGuidance, VolumeAttachmentStatus, WarmPoolResourceStatus, WorkforceIpAddressType, WorkforceStatus } from "./enums";
2
2
  import type { ActionSummary, AdditionalInferenceSpecificationDefinition, AgentVersion, AIBenchmarkJobSummary, AIRecommendationJobSummary, AIWorkloadConfigSummary, AlgorithmSpecification, AlgorithmSummary, AmazonQSettings, AppDetails, AppImageConfigDetails, AppSpecification, ArtifactSummary, AssociationInfo, AssociationSummary, AutoMLCandidate, AutoMLJobSummary, AutoRollbackConfig, AvailableUpgrade, BatchDataCaptureConfig, CfnTemplateProviderDetail, Channel, CheckpointConfig, ClusterEventSummary, ClusterNodeSummary, ClusterSchedulerConfigSummary, ClusterSummary, CodeRepositorySummary, CognitoConfig, CompilationJobSummary, InferenceSpecification, OutputDataConfig, OutputParameter, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, VpcConfig } from "./models_0";
3
- import type { ComputeQuotaSummary, ContainerDefinition, ContextSummary, DockerSettings, DriftCheckBaselines, EdgeOutputConfig, EndpointInfo, FeatureDefinition, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, InferenceComponentComputeResourceRequirements, InferenceComponentSchedulingConfig, InferenceComponentStartupParameters, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InstanceMetadataServiceConfiguration, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, ManagedConfiguration, MetadataProperties, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelCardExportOutputConfig, ModelCardSecurityConfig, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelInfrastructureConfig, ModelLifeCycle, ModelMetrics, ModelPackageModelCard, ModelPackageSecurityConfig, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringScheduleConfig, MonitoringStoppingCondition, NetworkConfig, NotebookInstanceLifecycleHook, OfflineStoreConfig, OnlineStoreConfig, OptimizationJobModelSource, ProductionVariantServerlessConfig, RecommendationJobInputConfig, RecommendationJobStoppingConditions, ResourceLimits, RetryStrategy, ShadowModeConfig, SourceAlgorithmSpecification, TrustedIdentityPropagationSettings, UnifiedStudioSettings, UserSettings } from "./models_1";
3
+ import type { ComputeQuotaSummary, ContainerDefinition, ContainerMetricsConfig, ContextSummary, DockerSettings, DriftCheckBaselines, EdgeOutputConfig, EndpointInfo, FeatureDefinition, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobWarmStartConfig, InferenceComponentComputeResourceRequirements, InferenceComponentSchedulingConfig, InferenceComponentStartupParameters, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InstanceMetadataServiceConfiguration, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, ManagedConfiguration, MetadataProperties, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelCardExportOutputConfig, ModelCardSecurityConfig, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelInfrastructureConfig, ModelLifeCycle, ModelMetrics, ModelPackageModelCard, ModelPackageSecurityConfig, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringScheduleConfig, MonitoringStoppingCondition, NetworkConfig, NotebookInstanceLifecycleHook, OfflineStoreConfig, OnlineStoreConfig, OptimizationJobModelSource, ProductionVariantServerlessConfig, RecommendationJobInputConfig, RecommendationJobStoppingConditions, ResourceLimits, RetryStrategy, ShadowModeConfig, SourceAlgorithmSpecification, TrustedIdentityPropagationSettings, UnifiedStudioSettings, UserSettings } from "./models_1";
4
4
  import type { CustomizedMetricSpecification, DataCaptureConfigSummary, DataProcessing, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DeployedImage, DeploymentRecommendation, ExperimentConfig, ExperimentSource, FeatureParameter, HyperParameterTrainingJobSummary, HyperParameterTuningJobCompletionDetails, HyperParameterTuningJobConsumedResources, InfraCheckConfig, LastUpdateStatus, MemberDefinition, MlflowConfig, ModelArtifacts, ModelClientConfig, ModelPackageConfig, NotificationConfiguration, ObjectiveStatusCounters, OfflineStoreStatus, OptimizationConfig, OptimizationJobOutputConfig, OptimizationVpcConfig, OwnershipSettings, ParallelismConfiguration, PartnerAppConfig, PartnerAppMaintenanceConfig, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProductionVariantSummary, ProfilerConfig, ProfilerRuleConfiguration, RemoteDebugConfig, ServerlessJobConfig, ServiceCatalogProvisioningDetails, SourceIpConfig, SpaceSettings, SpaceSharingSettings, TensorBoardOutputConfig, TrainingJobStatusCounters, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, WorkerAccessConfiguration } from "./models_2";
5
+ /**
6
+ * @public
7
+ */
8
+ export interface DescribeImageVersionRequest {
9
+ /**
10
+ * <p>The name of the image.</p>
11
+ * @public
12
+ */
13
+ ImageName: string | undefined;
14
+ /**
15
+ * <p>The version of the image. If not specified, the latest version is described.</p>
16
+ * @public
17
+ */
18
+ Version?: number | undefined;
19
+ /**
20
+ * <p>The alias of the image version.</p>
21
+ * @public
22
+ */
23
+ Alias?: string | undefined;
24
+ }
25
+ /**
26
+ * @public
27
+ */
28
+ export interface DescribeImageVersionResponse {
29
+ /**
30
+ * <p>The registry path of the container image on which this image version is based.</p>
31
+ * @public
32
+ */
33
+ BaseImage?: string | undefined;
34
+ /**
35
+ * <p>The registry path of the container image that contains this image version.</p>
36
+ * @public
37
+ */
38
+ ContainerImage?: string | undefined;
39
+ /**
40
+ * <p>When the version was created.</p>
41
+ * @public
42
+ */
43
+ CreationTime?: Date | undefined;
44
+ /**
45
+ * <p>When a create or delete operation fails, the reason for the failure.</p>
46
+ * @public
47
+ */
48
+ FailureReason?: string | undefined;
49
+ /**
50
+ * <p>The ARN of the image the version is based on.</p>
51
+ * @public
52
+ */
53
+ ImageArn?: string | undefined;
54
+ /**
55
+ * <p>The ARN of the version.</p>
56
+ * @public
57
+ */
58
+ ImageVersionArn?: string | undefined;
59
+ /**
60
+ * <p>The status of the version.</p>
61
+ * @public
62
+ */
63
+ ImageVersionStatus?: ImageVersionStatus | undefined;
64
+ /**
65
+ * <p>When the version was last modified.</p>
66
+ * @public
67
+ */
68
+ LastModifiedTime?: Date | undefined;
69
+ /**
70
+ * <p>The version number.</p>
71
+ * @public
72
+ */
73
+ Version?: number | undefined;
74
+ /**
75
+ * <p>The stability of the image version specified by the maintainer.</p> <ul> <li> <p> <code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p> </li> <li> <p> <code>STABLE</code>: The image version is stable.</p> </li> <li> <p> <code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p> </li> <li> <p> <code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </p> </li> </ul>
76
+ * @public
77
+ */
78
+ VendorGuidance?: VendorGuidance | undefined;
79
+ /**
80
+ * <p>Indicates SageMaker AI job type compatibility.</p> <ul> <li> <p> <code>TRAINING</code>: The image version is compatible with SageMaker AI training jobs.</p> </li> <li> <p> <code>INFERENCE</code>: The image version is compatible with SageMaker AI inference jobs.</p> </li> <li> <p> <code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker AI notebook kernels.</p> </li> </ul>
81
+ * @public
82
+ */
83
+ JobType?: JobType | undefined;
84
+ /**
85
+ * <p>The machine learning framework vended in the image version.</p>
86
+ * @public
87
+ */
88
+ MLFramework?: string | undefined;
89
+ /**
90
+ * <p>The supported programming language and its version.</p>
91
+ * @public
92
+ */
93
+ ProgrammingLang?: string | undefined;
94
+ /**
95
+ * <p>Indicates CPU or GPU compatibility.</p> <ul> <li> <p> <code>CPU</code>: The image version is compatible with CPU.</p> </li> <li> <p> <code>GPU</code>: The image version is compatible with GPU.</p> </li> </ul>
96
+ * @public
97
+ */
98
+ Processor?: Processor | undefined;
99
+ /**
100
+ * <p>Indicates Horovod compatibility.</p>
101
+ * @public
102
+ */
103
+ Horovod?: boolean | undefined;
104
+ /**
105
+ * <p>The maintainer description of the image version.</p>
106
+ * @public
107
+ */
108
+ ReleaseNotes?: string | undefined;
109
+ }
5
110
  /**
6
111
  * @public
7
112
  */
@@ -127,6 +232,11 @@ export interface InferenceComponentContainerSpecificationSummary {
127
232
  * @public
128
233
  */
129
234
  Environment?: Record<string, string> | undefined;
235
+ /**
236
+ * <p>The container metrics scraping configuration for this inference component, including the metrics endpoint path and publishing frequency.</p>
237
+ * @public
238
+ */
239
+ ContainerMetricsConfig?: ContainerMetricsConfig | undefined;
130
240
  }
131
241
  /**
132
242
  * <p>Settings that affect how the inference component caches data.</p>
@@ -6912,8 +7022,7 @@ export interface InferenceRecommendationsJobStep {
6912
7022
  InferenceBenchmark?: RecommendationJobInferenceBenchmark | undefined;
6913
7023
  }
6914
7024
  /**
6915
- * Search shape for Job. Mirrors DescribeJobResponse fields.
6916
- * If you update DescribeJobResponse, update this structure as well.
7025
+ * <p>The properties of a job returned by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API.</p>
6917
7026
  * @public
6918
7027
  */
6919
7028
  export interface Job {
@@ -9753,83 +9862,3 @@ export interface ListInferenceExperimentsResponse {
9753
9862
  */
9754
9863
  NextToken?: string | undefined;
9755
9864
  }
9756
- /**
9757
- * @public
9758
- */
9759
- export interface ListInferenceRecommendationsJobsRequest {
9760
- /**
9761
- * <p>A filter that returns only jobs created after the specified time (timestamp).</p>
9762
- * @public
9763
- */
9764
- CreationTimeAfter?: Date | undefined;
9765
- /**
9766
- * <p>A filter that returns only jobs created before the specified time (timestamp).</p>
9767
- * @public
9768
- */
9769
- CreationTimeBefore?: Date | undefined;
9770
- /**
9771
- * <p>A filter that returns only jobs that were last modified after the specified time (timestamp).</p>
9772
- * @public
9773
- */
9774
- LastModifiedTimeAfter?: Date | undefined;
9775
- /**
9776
- * <p>A filter that returns only jobs that were last modified before the specified time (timestamp).</p>
9777
- * @public
9778
- */
9779
- LastModifiedTimeBefore?: Date | undefined;
9780
- /**
9781
- * <p>A string in the job name. This filter returns only recommendations whose name contains the specified string.</p>
9782
- * @public
9783
- */
9784
- NameContains?: string | undefined;
9785
- /**
9786
- * <p>A filter that retrieves only inference recommendations jobs with a specific status.</p>
9787
- * @public
9788
- */
9789
- StatusEquals?: RecommendationJobStatus | undefined;
9790
- /**
9791
- * <p>The parameter by which to sort the results.</p>
9792
- * @public
9793
- */
9794
- SortBy?: ListInferenceRecommendationsJobsSortBy | undefined;
9795
- /**
9796
- * <p>The sort order for the results.</p>
9797
- * @public
9798
- */
9799
- SortOrder?: SortOrder | undefined;
9800
- /**
9801
- * <p>If the response to a previous <code>ListInferenceRecommendationsJobsRequest</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of recommendations, use the token in the next request.</p>
9802
- * @public
9803
- */
9804
- NextToken?: string | undefined;
9805
- /**
9806
- * <p>The maximum number of recommendations to return in the response.</p>
9807
- * @public
9808
- */
9809
- MaxResults?: number | undefined;
9810
- /**
9811
- * <p>A filter that returns only jobs that were created for this model.</p>
9812
- * @public
9813
- */
9814
- ModelNameEquals?: string | undefined;
9815
- /**
9816
- * <p>A filter that returns only jobs that were created for this versioned model package.</p>
9817
- * @public
9818
- */
9819
- ModelPackageVersionArnEquals?: string | undefined;
9820
- }
9821
- /**
9822
- * @public
9823
- */
9824
- export interface ListInferenceRecommendationsJobsResponse {
9825
- /**
9826
- * <p>The recommendations created from the Amazon SageMaker Inference Recommender job.</p>
9827
- * @public
9828
- */
9829
- InferenceRecommendationsJobs: InferenceRecommendationsJob[] | undefined;
9830
- /**
9831
- * <p>A token for getting the next set of recommendations, if there are any.</p>
9832
- * @public
9833
- */
9834
- NextToken?: string | undefined;
9835
- }