@aws-sdk/client-sagemaker 3.862.0 → 3.864.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 (66) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/index.js +575 -392
  3. package/dist-es/SageMaker.js +4 -0
  4. package/dist-es/commands/DescribeReservedCapacityCommand.js +22 -0
  5. package/dist-es/commands/ListUltraServersByReservedCapacityCommand.js +22 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/models_0.js +1 -13
  8. package/dist-es/models/models_1.js +13 -0
  9. package/dist-es/models/models_3.js +22 -33
  10. package/dist-es/models/models_4.js +21 -14
  11. package/dist-es/models/models_5.js +12 -1
  12. package/dist-es/pagination/ListUltraServersByReservedCapacityPaginator.js +4 -0
  13. package/dist-es/pagination/index.js +1 -0
  14. package/dist-es/protocols/Aws_json1_1.js +133 -0
  15. package/dist-types/SageMaker.d.ts +14 -0
  16. package/dist-types/SageMakerClient.d.ts +4 -2
  17. package/dist-types/commands/AttachClusterNodeVolumeCommand.d.ts +1 -1
  18. package/dist-types/commands/CreateAlgorithmCommand.d.ts +12 -3
  19. package/dist-types/commands/CreateHyperParameterTuningJobCommand.d.ts +26 -8
  20. package/dist-types/commands/CreateModelBiasJobDefinitionCommand.d.ts +1 -2
  21. package/dist-types/commands/CreateTrainingJobCommand.d.ts +11 -2
  22. package/dist-types/commands/CreateTrainingPlanCommand.d.ts +1 -0
  23. package/dist-types/commands/DescribeAlgorithmCommand.d.ts +12 -3
  24. package/dist-types/commands/DescribeClusterNodeCommand.d.ts +3 -0
  25. package/dist-types/commands/DescribeComputeQuotaCommand.d.ts +1 -1
  26. package/dist-types/commands/DescribeContextCommand.d.ts +1 -2
  27. package/dist-types/commands/DescribeHyperParameterTuningJobCommand.d.ts +26 -8
  28. package/dist-types/commands/DescribeReservedCapacityCommand.d.ts +93 -0
  29. package/dist-types/commands/DescribeTrainingJobCommand.d.ts +11 -2
  30. package/dist-types/commands/DescribeTrainingPlanCommand.d.ts +7 -1
  31. package/dist-types/commands/DetachClusterNodeVolumeCommand.d.ts +1 -1
  32. package/dist-types/commands/ListClusterNodesCommand.d.ts +3 -0
  33. package/dist-types/commands/ListTrainingPlansCommand.d.ts +5 -1
  34. package/dist-types/commands/ListUltraServersByReservedCapacityCommand.d.ts +92 -0
  35. package/dist-types/commands/ListWorkteamsCommand.d.ts +1 -1
  36. package/dist-types/commands/SearchCommand.d.ts +26 -8
  37. package/dist-types/commands/SearchTrainingPlanOfferingsCommand.d.ts +7 -2
  38. package/dist-types/commands/index.d.ts +2 -0
  39. package/dist-types/models/models_0.d.ts +71 -87
  40. package/dist-types/models/models_1.d.ts +77 -89
  41. package/dist-types/models/models_2.d.ts +94 -107
  42. package/dist-types/models/models_3.d.ts +295 -295
  43. package/dist-types/models/models_4.d.ts +374 -674
  44. package/dist-types/models/models_5.d.ts +703 -5
  45. package/dist-types/pagination/ListUltraServersByReservedCapacityPaginator.d.ts +7 -0
  46. package/dist-types/pagination/index.d.ts +1 -0
  47. package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
  48. package/dist-types/ts3.4/SageMaker.d.ts +40 -0
  49. package/dist-types/ts3.4/SageMakerClient.d.ts +12 -0
  50. package/dist-types/ts3.4/commands/CreateModelBiasJobDefinitionCommand.d.ts +4 -2
  51. package/dist-types/ts3.4/commands/DescribeComputeQuotaCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/DescribeContextCommand.d.ts +4 -2
  53. package/dist-types/ts3.4/commands/DescribeReservedCapacityCommand.d.ts +51 -0
  54. package/dist-types/ts3.4/commands/ListUltraServersByReservedCapacityCommand.d.ts +51 -0
  55. package/dist-types/ts3.4/commands/ListWorkteamsCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  57. package/dist-types/ts3.4/models/models_0.d.ts +15 -25
  58. package/dist-types/ts3.4/models/models_1.d.ts +25 -21
  59. package/dist-types/ts3.4/models/models_2.d.ts +24 -29
  60. package/dist-types/ts3.4/models/models_3.d.ts +88 -93
  61. package/dist-types/ts3.4/models/models_4.d.ts +112 -184
  62. package/dist-types/ts3.4/models/models_5.d.ts +183 -5
  63. package/dist-types/ts3.4/pagination/ListUltraServersByReservedCapacityPaginator.d.ts +11 -0
  64. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  65. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
  66. package/package.json +5 -5
@@ -1,8 +1,673 @@
1
- import { ActionStatus, ActivationState, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, BooleanOperator, CfnUpdateTemplateProvider, Channel, CheckpointConfig, ClusterInstanceGroupSpecification, ClusterNodeRecovery, ClusterRestrictedInstanceGroupSpecification, CodeEditorAppImageConfig, DeploymentConfiguration, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, ModelApprovalStatus, OutputDataConfig, OutputParameter, ResourceConfig, StoppingCondition, Tag, UserContext, VpcConfig } from "./models_0";
2
- import { _InstanceType, ComputeQuotaConfig, ComputeQuotaTarget, DefaultSpaceSettings, DeploymentConfig, EdgeOutputConfig, FeatureDefinition, HubContentType, InferenceComponentRuntimeConfig, InferenceComponentSpecification, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, JobType, MetadataProperties, ModelVariantConfig, Processor, RetryStrategy, SchedulerConfig, ShadowModeConfig, TagPropagation, ThroughputMode, TrackingServerSize, TtlDuration, UiTemplate, UserSettings, VendorGuidance } from "./models_1";
3
- import { CrossAccountFilterOption, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, ExperimentConfig, InstanceMetadataServiceConfiguration, MemberDefinition, ModelArtifacts, ModelCardStatus, ModelLifeCycle, ModelPackageModelCard, MonitoringScheduleConfig, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, NotificationConfiguration, OidcConfig, ParallelismConfiguration, PartnerAppConfig, PartnerAppMaintenanceConfig, PipelineDefinitionS3Location, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProfilerConfig, ProfilerRuleConfiguration, ProvisioningParameter, RootAccess, ServiceCatalogProvisioningDetails, SourceIpConfig, SpaceSettings, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, WorkerAccessConfiguration, WorkforceIpAddressType, WorkforceVpcConfigRequest } from "./models_2";
4
- import { DesiredWeightAndCapacity, Device, Direction, DomainSettingsForUpdate, Edge, Endpoint, Experiment, FeatureGroup, FeatureMetadata, FeatureParameter, Filter, GitConfigForUpdate, HubContentSupportStatus, HyperParameterTuningJobSearchEntity, InferenceComponentDeploymentConfig, MetricData, ModelPackageGroupStatus, PipelineExecutionStatus, PipelineExperimentConfig, PipelineStatus, ProcessingJobStatus, ProjectStatus, ReservedCapacityInstanceType, ResourceType, SageMakerResourceName, SecondaryStatus, SecondaryStatusTransition, SelectiveExecutionConfig, ServiceCatalogProvisionedProductDetails, TemplateProviderDetail, TrainingJobStatus, TrialComponentMetricSummary, TrialComponentSource, TrialSource, Workforce, Workteam } from "./models_3";
5
- import { InferenceExperimentStopDesiredState, LineageType, ModelCard, ModelDashboardModel, ModelPackage, Parameter, TransformJob } from "./models_4";
1
+ import { ActionStatus, ActivationState, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, BatchDataCaptureConfig, BatchStrategy, BatchTransformInput, BooleanOperator, CfnUpdateTemplateProvider, Channel, CheckpointConfig, ClusterInstanceGroupSpecification, ClusterNodeRecovery, ClusterRestrictedInstanceGroupSpecification, CodeEditorAppImageConfig, DeploymentConfiguration, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, ModelApprovalStatus, ModelPackageStatus, OutputDataConfig, OutputParameter, ResourceConfig, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, VpcConfig } from "./models_0";
2
+ import { _InstanceType, ComputeQuotaConfig, ComputeQuotaTarget, ContainerDefinition, DefaultSpaceSettings, DeploymentConfig, EdgeOutputConfig, FeatureDefinition, HubContentType, InferenceComponentRuntimeConfig, InferenceComponentSpecification, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, JobType, MetadataProperties, ModelVariantConfig, Processor, RetryStrategy, SchedulerConfig, ShadowModeConfig, TagPropagation, ThroughputMode, TrackingServerSize, TtlDuration, UiTemplate, UserSettings, VendorGuidance } from "./models_1";
3
+ import { CrossAccountFilterOption, DataProcessing, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DeploymentRecommendation, DriftCheckBaselines, ExperimentConfig, InstanceMetadataServiceConfiguration, MemberDefinition, ModelArtifacts, ModelCardSecurityConfig, ModelCardStatus, ModelClientConfig, ModelLifeCycle, ModelMetrics, ModelPackageModelCard, ModelPackageSecurityConfig, ModelPackageValidationSpecification, MonitoringScheduleConfig, MonitoringType, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, NotificationConfiguration, OidcConfig, ParallelismConfiguration, PartnerAppConfig, PartnerAppMaintenanceConfig, PipelineDefinitionS3Location, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProfilerConfig, ProfilerRuleConfiguration, ProvisioningParameter, RootAccess, ServiceCatalogProvisioningDetails, SkipModelValidation, SourceAlgorithmSpecification, SourceIpConfig, SpaceSettings, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, WorkerAccessConfiguration, WorkforceIpAddressType, WorkforceVpcConfigRequest } from "./models_2";
4
+ import { DesiredWeightAndCapacity, Device, Direction, DomainSettingsForUpdate, Edge, Endpoint, EndpointStatus, Experiment, FeatureGroup, FeatureMetadata, FeatureParameter, Filter, GitConfigForUpdate, HubContentSupportStatus, InferenceComponentDeploymentConfig, MetricData, ModelPackageGroupStatus, ModelPackageStatusDetails, MonitoringExecutionSummary, PipelineExecutionStatus, PipelineExperimentConfig, PipelineStatus, ProcessingJobStatus, ProjectStatus, ReservedCapacityInstanceType, ReservedCapacityType, ResourceType, SageMakerResourceName, ScheduleStatus, SecondaryStatus, SecondaryStatusTransition, SelectiveExecutionConfig, ServiceCatalogProvisionedProductDetails, TemplateProviderDetail, TrainingJobStatus, TransformJobStatus, TrialComponentMetricSummary, TrialComponentSource, TrialSource, Workforce, Workteam } from "./models_3";
5
+ import { HyperParameterTuningJobSearchEntity, InferenceExperimentStopDesiredState, LineageType, MonitoringAlertSummary, Parameter, SortOrder } from "./models_4";
6
+ /**
7
+ * @public
8
+ * @enum
9
+ */
10
+ export declare const ListWorkteamsSortByOptions: {
11
+ readonly CreateDate: "CreateDate";
12
+ readonly Name: "Name";
13
+ };
14
+ /**
15
+ * @public
16
+ */
17
+ export type ListWorkteamsSortByOptions = (typeof ListWorkteamsSortByOptions)[keyof typeof ListWorkteamsSortByOptions];
18
+ /**
19
+ * @public
20
+ */
21
+ export interface ListWorkteamsRequest {
22
+ /**
23
+ * <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
24
+ * @public
25
+ */
26
+ SortBy?: ListWorkteamsSortByOptions | undefined;
27
+ /**
28
+ * <p>The sort order for results. The default is <code>Ascending</code>.</p>
29
+ * @public
30
+ */
31
+ SortOrder?: SortOrder | undefined;
32
+ /**
33
+ * <p>A string in the work team's name. This filter returns only work teams whose name contains the specified string.</p>
34
+ * @public
35
+ */
36
+ NameContains?: string | undefined;
37
+ /**
38
+ * <p>If the result of the previous <code>ListWorkteams</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of labeling jobs, use the token in the next request.</p>
39
+ * @public
40
+ */
41
+ NextToken?: string | undefined;
42
+ /**
43
+ * <p>The maximum number of work teams to return in each page of the response.</p>
44
+ * @public
45
+ */
46
+ MaxResults?: number | undefined;
47
+ }
48
+ /**
49
+ * @public
50
+ */
51
+ export interface ListWorkteamsResponse {
52
+ /**
53
+ * <p>An array of <code>Workteam</code> objects, each describing a work team.</p>
54
+ * @public
55
+ */
56
+ Workteams: Workteam[] | undefined;
57
+ /**
58
+ * <p>If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.</p>
59
+ * @public
60
+ */
61
+ NextToken?: string | undefined;
62
+ }
63
+ /**
64
+ * <p>The properties of a model as returned by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API.</p>
65
+ * @public
66
+ */
67
+ export interface Model {
68
+ /**
69
+ * <p>The name of the model.</p>
70
+ * @public
71
+ */
72
+ ModelName?: string | undefined;
73
+ /**
74
+ * <p>Describes the container, as part of model definition.</p>
75
+ * @public
76
+ */
77
+ PrimaryContainer?: ContainerDefinition | undefined;
78
+ /**
79
+ * <p>The containers in the inference pipeline.</p>
80
+ * @public
81
+ */
82
+ Containers?: ContainerDefinition[] | undefined;
83
+ /**
84
+ * <p>Specifies details about how containers in a multi-container endpoint are run.</p>
85
+ * @public
86
+ */
87
+ InferenceExecutionConfig?: InferenceExecutionConfig | undefined;
88
+ /**
89
+ * <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the model.</p>
90
+ * @public
91
+ */
92
+ ExecutionRoleArn?: string | undefined;
93
+ /**
94
+ * <p>Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to Resources in your Amazon VPC</a>. </p>
95
+ * @public
96
+ */
97
+ VpcConfig?: VpcConfig | undefined;
98
+ /**
99
+ * <p>A timestamp that indicates when the model was created.</p>
100
+ * @public
101
+ */
102
+ CreationTime?: Date | undefined;
103
+ /**
104
+ * <p>The Amazon Resource Name (ARN) of the model.</p>
105
+ * @public
106
+ */
107
+ ModelArn?: string | undefined;
108
+ /**
109
+ * <p>Isolates the model container. No inbound or outbound network calls can be made to or from the model container.</p>
110
+ * @public
111
+ */
112
+ EnableNetworkIsolation?: boolean | undefined;
113
+ /**
114
+ * <p>A list of key-value pairs associated with the model. 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>
115
+ * @public
116
+ */
117
+ Tags?: Tag[] | undefined;
118
+ /**
119
+ * <p>A set of recommended deployment configurations for the model.</p>
120
+ * @public
121
+ */
122
+ DeploymentRecommendation?: DeploymentRecommendation | undefined;
123
+ }
124
+ /**
125
+ * <p>An Amazon SageMaker Model Card.</p>
126
+ * @public
127
+ */
128
+ export interface ModelCard {
129
+ /**
130
+ * <p>The Amazon Resource Name (ARN) of the model card.</p>
131
+ * @public
132
+ */
133
+ ModelCardArn?: string | undefined;
134
+ /**
135
+ * <p>The unique name of the model card.</p>
136
+ * @public
137
+ */
138
+ ModelCardName?: string | undefined;
139
+ /**
140
+ * <p>The version of the model card.</p>
141
+ * @public
142
+ */
143
+ ModelCardVersion?: number | undefined;
144
+ /**
145
+ * <p>The content of the model card. Content uses the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</p>
146
+ * @public
147
+ */
148
+ Content?: string | undefined;
149
+ /**
150
+ * <p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p> <ul> <li> <p> <code>Draft</code>: The model card is a work in progress.</p> </li> <li> <p> <code>PendingReview</code>: The model card is pending review.</p> </li> <li> <p> <code>Approved</code>: The model card is approved.</p> </li> <li> <p> <code>Archived</code>: The model card is archived. No more updates should be made to the model card, but it can still be exported.</p> </li> </ul>
151
+ * @public
152
+ */
153
+ ModelCardStatus?: ModelCardStatus | undefined;
154
+ /**
155
+ * <p>The security configuration used to protect model card data.</p>
156
+ * @public
157
+ */
158
+ SecurityConfig?: ModelCardSecurityConfig | undefined;
159
+ /**
160
+ * <p>The date and time that the model card was created.</p>
161
+ * @public
162
+ */
163
+ CreationTime?: Date | undefined;
164
+ /**
165
+ * <p>Information about the user who created or modified a SageMaker resource.</p>
166
+ * @public
167
+ */
168
+ CreatedBy?: UserContext | undefined;
169
+ /**
170
+ * <p>The date and time that the model card was last modified.</p>
171
+ * @public
172
+ */
173
+ LastModifiedTime?: Date | undefined;
174
+ /**
175
+ * <p>Information about the user who created or modified a SageMaker resource.</p>
176
+ * @public
177
+ */
178
+ LastModifiedBy?: UserContext | undefined;
179
+ /**
180
+ * <p>Key-value pairs used to manage metadata for the model card.</p>
181
+ * @public
182
+ */
183
+ Tags?: Tag[] | undefined;
184
+ /**
185
+ * <p>The unique name (ID) of the model.</p>
186
+ * @public
187
+ */
188
+ ModelId?: string | undefined;
189
+ /**
190
+ * <p>The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-risk-rating.html">Risk ratings</a>.</p>
191
+ * @public
192
+ */
193
+ RiskRating?: string | undefined;
194
+ /**
195
+ * <p>The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry. </p>
196
+ * @public
197
+ */
198
+ ModelPackageGroupName?: string | undefined;
199
+ }
200
+ /**
201
+ * <p>An endpoint that hosts a model displayed in the Amazon SageMaker Model Dashboard.</p>
202
+ * @public
203
+ */
204
+ export interface ModelDashboardEndpoint {
205
+ /**
206
+ * <p>The endpoint name.</p>
207
+ * @public
208
+ */
209
+ EndpointName: string | undefined;
210
+ /**
211
+ * <p>The Amazon Resource Name (ARN) of the endpoint.</p>
212
+ * @public
213
+ */
214
+ EndpointArn: string | undefined;
215
+ /**
216
+ * <p>A timestamp that indicates when the endpoint was created.</p>
217
+ * @public
218
+ */
219
+ CreationTime: Date | undefined;
220
+ /**
221
+ * <p>The last time the endpoint was modified.</p>
222
+ * @public
223
+ */
224
+ LastModifiedTime: Date | undefined;
225
+ /**
226
+ * <p>The endpoint status.</p>
227
+ * @public
228
+ */
229
+ EndpointStatus: EndpointStatus | undefined;
230
+ }
231
+ /**
232
+ * <p>A batch transform job. For information about SageMaker batch transform, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html">Use Batch Transform</a>.</p>
233
+ * @public
234
+ */
235
+ export interface TransformJob {
236
+ /**
237
+ * <p>The name of the transform job.</p>
238
+ * @public
239
+ */
240
+ TransformJobName?: string | undefined;
241
+ /**
242
+ * <p>The Amazon Resource Name (ARN) of the transform job.</p>
243
+ * @public
244
+ */
245
+ TransformJobArn?: string | undefined;
246
+ /**
247
+ * <p>The status of the transform job.</p> <p>Transform job statuses are:</p> <ul> <li> <p> <code>InProgress</code> - The job is in progress.</p> </li> <li> <p> <code>Completed</code> - The job has completed.</p> </li> <li> <p> <code>Failed</code> - The transform job has failed. To see the reason for the failure, see the <code>FailureReason</code> field in the response to a <code>DescribeTransformJob</code> call.</p> </li> <li> <p> <code>Stopping</code> - The transform job is stopping.</p> </li> <li> <p> <code>Stopped</code> - The transform job has stopped.</p> </li> </ul>
248
+ * @public
249
+ */
250
+ TransformJobStatus?: TransformJobStatus | undefined;
251
+ /**
252
+ * <p>If the transform job failed, the reason it failed.</p>
253
+ * @public
254
+ */
255
+ FailureReason?: string | undefined;
256
+ /**
257
+ * <p>The name of the model associated with the transform job.</p>
258
+ * @public
259
+ */
260
+ ModelName?: string | undefined;
261
+ /**
262
+ * <p>The maximum number of parallel requests that can be sent to each instance in a transform job. If <code>MaxConcurrentTransforms</code> is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don't need to set a value for <code>MaxConcurrentTransforms</code>.</p>
263
+ * @public
264
+ */
265
+ MaxConcurrentTransforms?: number | undefined;
266
+ /**
267
+ * <p>Configures the timeout and maximum number of retries for processing a transform job invocation.</p>
268
+ * @public
269
+ */
270
+ ModelClientConfig?: ModelClientConfig | undefined;
271
+ /**
272
+ * <p>The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in <code>MaxPayloadInMB</code> must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.</p>
273
+ * @public
274
+ */
275
+ MaxPayloadInMB?: number | undefined;
276
+ /**
277
+ * <p>Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.</p>
278
+ * @public
279
+ */
280
+ BatchStrategy?: BatchStrategy | undefined;
281
+ /**
282
+ * <p>The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.</p>
283
+ * @public
284
+ */
285
+ Environment?: Record<string, string> | undefined;
286
+ /**
287
+ * <p>Describes the input source of a transform job and the way the transform job consumes it.</p>
288
+ * @public
289
+ */
290
+ TransformInput?: TransformInput | undefined;
291
+ /**
292
+ * <p>Describes the results of a transform job.</p>
293
+ * @public
294
+ */
295
+ TransformOutput?: TransformOutput | undefined;
296
+ /**
297
+ * <p>Configuration to control how SageMaker captures inference data for batch transform jobs.</p>
298
+ * @public
299
+ */
300
+ DataCaptureConfig?: BatchDataCaptureConfig | undefined;
301
+ /**
302
+ * <p>Describes the resources, including ML instance types and ML instance count, to use for transform job.</p>
303
+ * @public
304
+ */
305
+ TransformResources?: TransformResources | undefined;
306
+ /**
307
+ * <p>A timestamp that shows when the transform Job was created.</p>
308
+ * @public
309
+ */
310
+ CreationTime?: Date | undefined;
311
+ /**
312
+ * <p>Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of <code>TransformEndTime</code>.</p>
313
+ * @public
314
+ */
315
+ TransformStartTime?: Date | undefined;
316
+ /**
317
+ * <p>Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of <code>TransformStartTime</code>.</p>
318
+ * @public
319
+ */
320
+ TransformEndTime?: Date | undefined;
321
+ /**
322
+ * <p>The Amazon Resource Name (ARN) of the labeling job that created the transform job.</p>
323
+ * @public
324
+ */
325
+ LabelingJobArn?: string | undefined;
326
+ /**
327
+ * <p>The Amazon Resource Name (ARN) of the AutoML job that created the transform job.</p>
328
+ * @public
329
+ */
330
+ AutoMLJobArn?: string | undefined;
331
+ /**
332
+ * <p>The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html">Associate Prediction Results with their Corresponding Input Records</a>.</p>
333
+ * @public
334
+ */
335
+ DataProcessing?: DataProcessing | undefined;
336
+ /**
337
+ * <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a> </p> </li> </ul>
338
+ * @public
339
+ */
340
+ ExperimentConfig?: ExperimentConfig | undefined;
341
+ /**
342
+ * <p>A list of tags associated with the transform job.</p>
343
+ * @public
344
+ */
345
+ Tags?: Tag[] | undefined;
346
+ }
347
+ /**
348
+ * <p>The model card for a model displayed in the Amazon SageMaker Model Dashboard.</p>
349
+ * @public
350
+ */
351
+ export interface ModelDashboardModelCard {
352
+ /**
353
+ * <p>The Amazon Resource Name (ARN) for a model card.</p>
354
+ * @public
355
+ */
356
+ ModelCardArn?: string | undefined;
357
+ /**
358
+ * <p>The name of a model card.</p>
359
+ * @public
360
+ */
361
+ ModelCardName?: string | undefined;
362
+ /**
363
+ * <p>The model card version.</p>
364
+ * @public
365
+ */
366
+ ModelCardVersion?: number | undefined;
367
+ /**
368
+ * <p>The model card status.</p>
369
+ * @public
370
+ */
371
+ ModelCardStatus?: ModelCardStatus | undefined;
372
+ /**
373
+ * <p>The KMS Key ID (<code>KMSKeyId</code>) for encryption of model card information.</p>
374
+ * @public
375
+ */
376
+ SecurityConfig?: ModelCardSecurityConfig | undefined;
377
+ /**
378
+ * <p>A timestamp that indicates when the model card was created.</p>
379
+ * @public
380
+ */
381
+ CreationTime?: Date | undefined;
382
+ /**
383
+ * <p>Information about the user who created or modified a SageMaker resource.</p>
384
+ * @public
385
+ */
386
+ CreatedBy?: UserContext | undefined;
387
+ /**
388
+ * <p>A timestamp that indicates when the model card was last updated.</p>
389
+ * @public
390
+ */
391
+ LastModifiedTime?: Date | undefined;
392
+ /**
393
+ * <p>Information about the user who created or modified a SageMaker resource.</p>
394
+ * @public
395
+ */
396
+ LastModifiedBy?: UserContext | undefined;
397
+ /**
398
+ * <p>The tags associated with a model card.</p>
399
+ * @public
400
+ */
401
+ Tags?: Tag[] | undefined;
402
+ /**
403
+ * <p>For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.</p>
404
+ * @public
405
+ */
406
+ ModelId?: string | undefined;
407
+ /**
408
+ * <p>A model card's risk rating. Can be low, medium, or high.</p>
409
+ * @public
410
+ */
411
+ RiskRating?: string | undefined;
412
+ }
413
+ /**
414
+ * <p>A monitoring schedule for a model displayed in the Amazon SageMaker Model Dashboard.</p>
415
+ * @public
416
+ */
417
+ export interface ModelDashboardMonitoringSchedule {
418
+ /**
419
+ * <p>The Amazon Resource Name (ARN) of a monitoring schedule.</p>
420
+ * @public
421
+ */
422
+ MonitoringScheduleArn?: string | undefined;
423
+ /**
424
+ * <p>The name of a monitoring schedule.</p>
425
+ * @public
426
+ */
427
+ MonitoringScheduleName?: string | undefined;
428
+ /**
429
+ * <p>The status of the monitoring schedule.</p>
430
+ * @public
431
+ */
432
+ MonitoringScheduleStatus?: ScheduleStatus | undefined;
433
+ /**
434
+ * <p>The monitor type of a model monitor.</p>
435
+ * @public
436
+ */
437
+ MonitoringType?: MonitoringType | undefined;
438
+ /**
439
+ * <p>If a monitoring job failed, provides the reason.</p>
440
+ * @public
441
+ */
442
+ FailureReason?: string | undefined;
443
+ /**
444
+ * <p>A timestamp that indicates when the monitoring schedule was created.</p>
445
+ * @public
446
+ */
447
+ CreationTime?: Date | undefined;
448
+ /**
449
+ * <p>A timestamp that indicates when the monitoring schedule was last updated.</p>
450
+ * @public
451
+ */
452
+ LastModifiedTime?: Date | undefined;
453
+ /**
454
+ * <p>Configures the monitoring schedule and defines the monitoring job.</p>
455
+ * @public
456
+ */
457
+ MonitoringScheduleConfig?: MonitoringScheduleConfig | undefined;
458
+ /**
459
+ * <p>The endpoint which is monitored.</p>
460
+ * @public
461
+ */
462
+ EndpointName?: string | undefined;
463
+ /**
464
+ * <p>A JSON array where each element is a summary for a monitoring alert.</p>
465
+ * @public
466
+ */
467
+ MonitoringAlertSummaries?: MonitoringAlertSummary[] | undefined;
468
+ /**
469
+ * <p>Summary of information about the last monitoring job to run.</p>
470
+ * @public
471
+ */
472
+ LastMonitoringExecutionSummary?: MonitoringExecutionSummary | undefined;
473
+ /**
474
+ * <p>Input object for the batch transform job.</p>
475
+ * @public
476
+ */
477
+ BatchTransformInput?: BatchTransformInput | undefined;
478
+ }
479
+ /**
480
+ * <p>A model displayed in the Amazon SageMaker Model Dashboard.</p>
481
+ * @public
482
+ */
483
+ export interface ModelDashboardModel {
484
+ /**
485
+ * <p>A model displayed in the Model Dashboard.</p>
486
+ * @public
487
+ */
488
+ Model?: Model | undefined;
489
+ /**
490
+ * <p>The endpoints that host a model.</p>
491
+ * @public
492
+ */
493
+ Endpoints?: ModelDashboardEndpoint[] | undefined;
494
+ /**
495
+ * <p>A batch transform job. For information about SageMaker batch transform, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html">Use Batch Transform</a>.</p>
496
+ * @public
497
+ */
498
+ LastBatchTransformJob?: TransformJob | undefined;
499
+ /**
500
+ * <p>The monitoring schedules for a model.</p>
501
+ * @public
502
+ */
503
+ MonitoringSchedules?: ModelDashboardMonitoringSchedule[] | undefined;
504
+ /**
505
+ * <p>The model card for a model.</p>
506
+ * @public
507
+ */
508
+ ModelCard?: ModelDashboardModelCard | undefined;
509
+ }
510
+ /**
511
+ * <p>A container for your trained model that can be deployed for SageMaker inference. This can include inference code, artifacts, and metadata. The model package type can be one of the following.</p> <ul> <li> <p>Versioned model: A part of a model package group in Model Registry.</p> </li> <li> <p>Unversioned model: Not part of a model package group and used in Amazon Web Services Marketplace.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModelPackage.html"> <code>CreateModelPackage</code> </a>.</p>
512
+ * @public
513
+ */
514
+ export interface ModelPackage {
515
+ /**
516
+ * <p>The name of the model package. The name can be as follows:</p> <ul> <li> <p>For a versioned model, the name is automatically generated by SageMaker Model Registry and follows the format '<code>ModelPackageGroupName/ModelPackageVersion</code>'.</p> </li> <li> <p>For an unversioned model, you must provide the name.</p> </li> </ul>
517
+ * @public
518
+ */
519
+ ModelPackageName?: string | undefined;
520
+ /**
521
+ * <p>The model group to which the model belongs.</p>
522
+ * @public
523
+ */
524
+ ModelPackageGroupName?: string | undefined;
525
+ /**
526
+ * <p>The version number of a versioned model.</p>
527
+ * @public
528
+ */
529
+ ModelPackageVersion?: number | undefined;
530
+ /**
531
+ * <p>The Amazon Resource Name (ARN) of the model package.</p>
532
+ * @public
533
+ */
534
+ ModelPackageArn?: string | undefined;
535
+ /**
536
+ * <p>The description of the model package.</p>
537
+ * @public
538
+ */
539
+ ModelPackageDescription?: string | undefined;
540
+ /**
541
+ * <p>The time that the model package was created.</p>
542
+ * @public
543
+ */
544
+ CreationTime?: Date | undefined;
545
+ /**
546
+ * <p>Defines how to perform inference generation after a training job is run.</p>
547
+ * @public
548
+ */
549
+ InferenceSpecification?: InferenceSpecification | undefined;
550
+ /**
551
+ * <p>A list of algorithms that were used to create a model package.</p>
552
+ * @public
553
+ */
554
+ SourceAlgorithmSpecification?: SourceAlgorithmSpecification | undefined;
555
+ /**
556
+ * <p>Specifies batch transform jobs that SageMaker runs to validate your model package.</p>
557
+ * @public
558
+ */
559
+ ValidationSpecification?: ModelPackageValidationSpecification | undefined;
560
+ /**
561
+ * <p>The status of the model package. This can be one of the following values.</p> <ul> <li> <p> <code>PENDING</code> - The model package is pending being created.</p> </li> <li> <p> <code>IN_PROGRESS</code> - The model package is in the process of being created.</p> </li> <li> <p> <code>COMPLETED</code> - The model package was successfully created.</p> </li> <li> <p> <code>FAILED</code> - The model package failed.</p> </li> <li> <p> <code>DELETING</code> - The model package is in the process of being deleted.</p> </li> </ul>
562
+ * @public
563
+ */
564
+ ModelPackageStatus?: ModelPackageStatus | undefined;
565
+ /**
566
+ * <p>Specifies the validation and image scan statuses of the model package.</p>
567
+ * @public
568
+ */
569
+ ModelPackageStatusDetails?: ModelPackageStatusDetails | undefined;
570
+ /**
571
+ * <p>Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-mkt-list.html">List Your Algorithm or Model Package on Amazon Web Services Marketplace</a>.</p>
572
+ * @public
573
+ */
574
+ CertifyForMarketplace?: boolean | undefined;
575
+ /**
576
+ * <p>The approval status of the model. This can be one of the following values.</p> <ul> <li> <p> <code>APPROVED</code> - The model is approved</p> </li> <li> <p> <code>REJECTED</code> - The model is rejected.</p> </li> <li> <p> <code>PENDING_MANUAL_APPROVAL</code> - The model is waiting for manual approval.</p> </li> </ul>
577
+ * @public
578
+ */
579
+ ModelApprovalStatus?: ModelApprovalStatus | undefined;
580
+ /**
581
+ * <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.</p>
582
+ * @public
583
+ */
584
+ CreatedBy?: UserContext | undefined;
585
+ /**
586
+ * <p>Metadata properties of the tracking entity, trial, or trial component.</p>
587
+ * @public
588
+ */
589
+ MetadataProperties?: MetadataProperties | undefined;
590
+ /**
591
+ * <p>Metrics for the model.</p>
592
+ * @public
593
+ */
594
+ ModelMetrics?: ModelMetrics | undefined;
595
+ /**
596
+ * <p>The last time the model package was modified.</p>
597
+ * @public
598
+ */
599
+ LastModifiedTime?: Date | undefined;
600
+ /**
601
+ * <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.</p>
602
+ * @public
603
+ */
604
+ LastModifiedBy?: UserContext | undefined;
605
+ /**
606
+ * <p>A description provided when the model approval is set.</p>
607
+ * @public
608
+ */
609
+ ApprovalDescription?: string | undefined;
610
+ /**
611
+ * <p>The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.</p>
612
+ * @public
613
+ */
614
+ Domain?: string | undefined;
615
+ /**
616
+ * <p>The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.</p>
617
+ * @public
618
+ */
619
+ Task?: string | undefined;
620
+ /**
621
+ * <p>The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).</p>
622
+ * @public
623
+ */
624
+ SamplePayloadUrl?: string | undefined;
625
+ /**
626
+ * <p>An array of additional Inference Specification objects.</p>
627
+ * @public
628
+ */
629
+ AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined;
630
+ /**
631
+ * <p>The URI of the source for the model package.</p>
632
+ * @public
633
+ */
634
+ SourceUri?: string | undefined;
635
+ /**
636
+ * <p>An optional Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.</p>
637
+ * @public
638
+ */
639
+ SecurityConfig?: ModelPackageSecurityConfig | undefined;
640
+ /**
641
+ * <p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>, and <code>model_overview</code> is composed of the <code>model_creator</code> and <code>model_artifact</code> properties. For more information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model package model card schema</a>. For more information about the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model Version</a>.</p>
642
+ * @public
643
+ */
644
+ ModelCard?: ModelPackageModelCard | undefined;
645
+ /**
646
+ * <p> A structure describing the current state of the model in its life cycle. </p>
647
+ * @public
648
+ */
649
+ ModelLifeCycle?: ModelLifeCycle | undefined;
650
+ /**
651
+ * <p>A list of the tags associated with the model package. 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>
652
+ * @public
653
+ */
654
+ Tags?: Tag[] | undefined;
655
+ /**
656
+ * <p>The metadata properties for the model package. </p>
657
+ * @public
658
+ */
659
+ CustomerMetadataProperties?: Record<string, string> | undefined;
660
+ /**
661
+ * <p>Represents the drift check baselines that can be used when the model monitor is set using the model package.</p>
662
+ * @public
663
+ */
664
+ DriftCheckBaselines?: DriftCheckBaselines | undefined;
665
+ /**
666
+ * <p>Indicates if you want to skip model validation.</p>
667
+ * @public
668
+ */
669
+ SkipModelValidation?: SkipModelValidation | undefined;
670
+ }
6
671
  /**
7
672
  * <p>A group of versioned models in the Model Registry.</p>
8
673
  * @public
@@ -793,6 +1458,21 @@ export interface RenderUiTemplateResponse {
793
1458
  * @public
794
1459
  */
795
1460
  export interface ReservedCapacityOffering {
1461
+ /**
1462
+ * <p>The type of reserved capacity offering.</p>
1463
+ * @public
1464
+ */
1465
+ ReservedCapacityType?: ReservedCapacityType | undefined;
1466
+ /**
1467
+ * <p>The type of UltraServer included in this reserved capacity offering, such as ml.u-p6e-gb200x72.</p>
1468
+ * @public
1469
+ */
1470
+ UltraServerType?: string | undefined;
1471
+ /**
1472
+ * <p>The number of UltraServers included in this reserved capacity offering.</p>
1473
+ * @public
1474
+ */
1475
+ UltraServerCount?: number | undefined;
796
1476
  /**
797
1477
  * <p>The instance type for the reserved capacity offering.</p>
798
1478
  * @public
@@ -1464,6 +2144,16 @@ export interface SearchTrainingPlanOfferingsRequest {
1464
2144
  * @public
1465
2145
  */
1466
2146
  InstanceCount?: number | undefined;
2147
+ /**
2148
+ * <p>The type of UltraServer to search for, such as ml.u-p6e-gb200x72.</p>
2149
+ * @public
2150
+ */
2151
+ UltraServerType?: string | undefined;
2152
+ /**
2153
+ * <p>The number of UltraServers to search for.</p>
2154
+ * @public
2155
+ */
2156
+ UltraServerCount?: number | undefined;
1467
2157
  /**
1468
2158
  * <p>A filter to search for training plan offerings with a start time after a specified date.</p>
1469
2159
  * @public
@@ -3910,6 +4600,14 @@ export interface SearchRequest {
3910
4600
  */
3911
4601
  VisibilityConditions?: VisibilityConditions[] | undefined;
3912
4602
  }
4603
+ /**
4604
+ * @internal
4605
+ */
4606
+ export declare const ModelCardFilterSensitiveLog: (obj: ModelCard) => any;
4607
+ /**
4608
+ * @internal
4609
+ */
4610
+ export declare const ModelPackageFilterSensitiveLog: (obj: ModelPackage) => any;
3913
4611
  /**
3914
4612
  * @internal
3915
4613
  */