@aws-sdk/client-sagemaker 3.379.0 → 3.382.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 (29) hide show
  1. package/dist-cjs/endpoint/ruleset.js +1 -1
  2. package/dist-cjs/models/models_1.js +6 -5
  3. package/dist-cjs/models/models_2.js +5 -5
  4. package/dist-cjs/models/models_3.js +6 -2
  5. package/dist-es/endpoint/ruleset.js +1 -1
  6. package/dist-es/models/models_1.js +5 -4
  7. package/dist-es/models/models_2.js +4 -4
  8. package/dist-es/models/models_3.js +4 -0
  9. package/dist-types/commands/CreateInferenceRecommendationsJobCommand.d.ts +7 -1
  10. package/dist-types/commands/DeleteHubCommand.d.ts +1 -1
  11. package/dist-types/commands/DescribeInferenceRecommendationsJobCommand.d.ts +7 -1
  12. package/dist-types/commands/GetSagemakerServicecatalogPortfolioStatusCommand.d.ts +1 -2
  13. package/dist-types/commands/RenderUiTemplateCommand.d.ts +2 -1
  14. package/dist-types/endpoint/EndpointParameters.d.ts +3 -0
  15. package/dist-types/index.d.ts +1 -0
  16. package/dist-types/models/models_0.d.ts +699 -1
  17. package/dist-types/models/models_1.d.ts +910 -26
  18. package/dist-types/models/models_2.d.ts +1273 -18
  19. package/dist-types/models/models_3.d.ts +1295 -28
  20. package/dist-types/models/models_4.d.ts +371 -1
  21. package/dist-types/ts3.4/commands/DeleteHubCommand.d.ts +1 -1
  22. package/dist-types/ts3.4/commands/GetSagemakerServicecatalogPortfolioStatusCommand.d.ts +4 -2
  23. package/dist-types/ts3.4/commands/RenderUiTemplateCommand.d.ts +2 -4
  24. package/dist-types/ts3.4/index.d.ts +1 -0
  25. package/dist-types/ts3.4/models/models_1.d.ts +14 -9
  26. package/dist-types/ts3.4/models/models_2.d.ts +9 -8
  27. package/dist-types/ts3.4/models/models_3.d.ts +8 -9
  28. package/dist-types/ts3.4/models/models_4.d.ts +8 -1
  29. package/package.json +7 -7
@@ -1,21 +1,53 @@
1
1
  import { ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AppSecurityGroupManagement, BooleanOperator, Channel, CheckpointConfig, DefaultSpaceSettings, EdgeOutputConfig, KernelGatewayImageConfig, MetadataProperties, ModelApprovalStatus, OutputDataConfig, OutputParameter, ResourceConfig, StoppingCondition, Tag, UserContext, VpcConfig } from "./models_0";
2
2
  import { _InstanceType, CrossAccountFilterOption, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DeploymentConfig, ExperimentConfig, FeatureDefinition, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InstanceMetadataServiceConfiguration, JobType, MemberDefinition, ModelCardStatus, ModelVariantConfig, MonitoringScheduleConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, NotificationConfiguration, OidcConfig, ParallelismConfiguration, PipelineDefinitionS3Location, Processor, ProfilerConfig, ProfilerRuleConfiguration, ProvisioningParameter, RetryStrategy, RootAccess, ShadowModeConfig, SourceIpConfig, SpaceSettings, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, UserSettings, VendorGuidance, WorkforceVpcConfigRequest } from "./models_1";
3
3
  import { DesiredWeightAndCapacity, Device, DomainSettingsForUpdate, Endpoint, Experiment, FeatureGroup, FeatureMetadata, FeatureParameter, Filter, MetricData, ModelArtifacts, SecondaryStatus, SecondaryStatusTransition, SelectiveExecutionConfig, TrainingJobStatus, TrialComponentMetricSummary, TrialComponentSource, TrialSource, Workforce, Workteam } from "./models_2";
4
- import { GitConfigForUpdate, HyperParameterTuningJobSearchEntity, InferenceExperimentStopDesiredState, ModelCard, ModelDashboardModel, ModelPackage, ModelPackageGroup, ModelVariantAction, NestedFilters, OnlineStoreConfigUpdate, Parameter, Parent, Pipeline, PipelineExecution, ProcessingJob, ProfilerConfigForUpdate, Project, ResourceConfigForUpdate, ResourceType, TransformJob } from "./models_3";
4
+ import { GitConfigForUpdate, HyperParameterTuningJobSearchEntity, InferenceExperimentStopDesiredState, ModelCard, ModelDashboardModel, ModelPackage, ModelPackageGroup, ModelVariantAction, NestedFilters, OnlineStoreConfigUpdate, Parameter, Parent, Pipeline, PipelineExecution, ProcessingJob, ProfilerConfigForUpdate, Project, RenderingError, ResourceType, TransformJob } from "./models_3";
5
+ /**
6
+ * @public
7
+ */
8
+ export interface RenderUiTemplateResponse {
9
+ /**
10
+ * @public
11
+ * <p>A Liquid template that renders the HTML for the worker UI.</p>
12
+ */
13
+ RenderedContent: string | undefined;
14
+ /**
15
+ * @public
16
+ * <p>A list of one or more <code>RenderingError</code> objects if any were encountered
17
+ * while rendering the template. If there were no errors, the list is empty.</p>
18
+ */
19
+ Errors: RenderingError[] | undefined;
20
+ }
21
+ /**
22
+ * @public
23
+ * <p>The <code>ResourceConfig</code> to update <code>KeepAlivePeriodInSeconds</code>. Other
24
+ * fields in the <code>ResourceConfig</code> cannot be updated.</p>
25
+ */
26
+ export interface ResourceConfigForUpdate {
27
+ /**
28
+ * @public
29
+ * <p>The <code>KeepAlivePeriodInSeconds</code> value specified in the
30
+ * <code>ResourceConfig</code> to update.</p>
31
+ */
32
+ KeepAlivePeriodInSeconds: number | undefined;
33
+ }
5
34
  /**
6
35
  * @public
7
36
  */
8
37
  export interface RetryPipelineExecutionRequest {
9
38
  /**
39
+ * @public
10
40
  * <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
11
41
  */
12
42
  PipelineExecutionArn: string | undefined;
13
43
  /**
44
+ * @public
14
45
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
15
46
  * operation. An idempotent operation completes no more than once.</p>
16
47
  */
17
48
  ClientRequestToken?: string;
18
49
  /**
50
+ * @public
19
51
  * <p>This configuration, if specified, overrides the parallelism configuration
20
52
  * of the parent pipeline.</p>
21
53
  */
@@ -26,6 +58,7 @@ export interface RetryPipelineExecutionRequest {
26
58
  */
27
59
  export interface RetryPipelineExecutionResponse {
28
60
  /**
61
+ * @public
29
62
  * <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
30
63
  */
31
64
  PipelineExecutionArn?: string;
@@ -48,32 +81,39 @@ export type SearchSortOrder = (typeof SearchSortOrder)[keyof typeof SearchSortOr
48
81
  */
49
82
  export interface TrainingJob {
50
83
  /**
84
+ * @public
51
85
  * <p>The name of the training job.</p>
52
86
  */
53
87
  TrainingJobName?: string;
54
88
  /**
89
+ * @public
55
90
  * <p>The Amazon Resource Name (ARN) of the training job.</p>
56
91
  */
57
92
  TrainingJobArn?: string;
58
93
  /**
94
+ * @public
59
95
  * <p>The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the
60
96
  * training job was launched by a hyperparameter tuning job.</p>
61
97
  */
62
98
  TuningJobArn?: string;
63
99
  /**
100
+ * @public
64
101
  * <p>The Amazon Resource Name (ARN) of the labeling job.</p>
65
102
  */
66
103
  LabelingJobArn?: string;
67
104
  /**
105
+ * @public
68
106
  * <p>The Amazon Resource Name (ARN) of the job.</p>
69
107
  */
70
108
  AutoMLJobArn?: string;
71
109
  /**
110
+ * @public
72
111
  * <p>Information about the Amazon S3 location that is configured for storing model
73
112
  * artifacts.</p>
74
113
  */
75
114
  ModelArtifacts?: ModelArtifacts;
76
115
  /**
116
+ * @public
77
117
  * <p>The status of the
78
118
  * training
79
119
  * job.</p>
@@ -107,6 +147,7 @@ export interface TrainingJob {
107
147
  */
108
148
  TrainingJobStatus?: TrainingJobStatus | string;
109
149
  /**
150
+ * @public
110
151
  * <p> Provides detailed information about the state of the training job. For detailed
111
152
  * information about the secondary status of the training job, see
112
153
  * <code>StatusMessage</code> under <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html">SecondaryStatusTransition</a>.</p>
@@ -206,45 +247,54 @@ export interface TrainingJob {
206
247
  */
207
248
  SecondaryStatus?: SecondaryStatus | string;
208
249
  /**
250
+ * @public
209
251
  * <p>If the training job failed, the reason it failed.</p>
210
252
  */
211
253
  FailureReason?: string;
212
254
  /**
255
+ * @public
213
256
  * <p>Algorithm-specific parameters.</p>
214
257
  */
215
258
  HyperParameters?: Record<string, string>;
216
259
  /**
260
+ * @public
217
261
  * <p>Information about the algorithm used for training, and algorithm metadata.</p>
218
262
  */
219
263
  AlgorithmSpecification?: AlgorithmSpecification;
220
264
  /**
265
+ * @public
221
266
  * <p>The Amazon Web Services Identity and Access Management (IAM) role configured for the
222
267
  * training job.</p>
223
268
  */
224
269
  RoleArn?: string;
225
270
  /**
271
+ * @public
226
272
  * <p>An array of <code>Channel</code> objects that describes each data input
227
273
  * channel.</p>
228
274
  * <p>Your input must be in the same Amazon Web Services region as your training job.</p>
229
275
  */
230
276
  InputDataConfig?: Channel[];
231
277
  /**
278
+ * @public
232
279
  * <p>The S3 path where model artifacts that you configured when creating the job are
233
280
  * stored. SageMaker creates subfolders for model artifacts.</p>
234
281
  */
235
282
  OutputDataConfig?: OutputDataConfig;
236
283
  /**
284
+ * @public
237
285
  * <p>Resources, including ML compute instances and ML storage volumes, that are configured
238
286
  * for model training.</p>
239
287
  */
240
288
  ResourceConfig?: ResourceConfig;
241
289
  /**
290
+ * @public
242
291
  * <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that this training job has access
243
292
  * to. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html">Protect Training Jobs by Using an Amazon
244
293
  * Virtual Private Cloud</a>.</p>
245
294
  */
246
295
  VpcConfig?: VpcConfig;
247
296
  /**
297
+ * @public
248
298
  * <p>Specifies a limit to how long a model training job can run. It also specifies how long
249
299
  * a managed Spot training job has to complete. When the job reaches the time limit, SageMaker
250
300
  * ends the training job. Use this API to cap model training costs.</p>
@@ -254,10 +304,12 @@ export interface TrainingJob {
254
304
  */
255
305
  StoppingCondition?: StoppingCondition;
256
306
  /**
307
+ * @public
257
308
  * <p>A timestamp that indicates when the training job was created.</p>
258
309
  */
259
310
  CreationTime?: Date;
260
311
  /**
312
+ * @public
261
313
  * <p>Indicates the time when the training job starts on training instances. You are billed
262
314
  * for the time interval between this time and the value of <code>TrainingEndTime</code>.
263
315
  * The start time in CloudWatch Logs might be later than this time. The difference is due to the time
@@ -265,6 +317,7 @@ export interface TrainingJob {
265
317
  */
266
318
  TrainingStartTime?: Date;
267
319
  /**
320
+ * @public
268
321
  * <p>Indicates the time when the training job ends on training instances. You are billed
269
322
  * for the time interval between the value of <code>TrainingStartTime</code> and this time.
270
323
  * For successful jobs and stopped jobs, this is the time after model artifacts are
@@ -272,27 +325,32 @@ export interface TrainingJob {
272
325
  */
273
326
  TrainingEndTime?: Date;
274
327
  /**
328
+ * @public
275
329
  * <p>A timestamp that indicates when the status of the training job was last
276
330
  * modified.</p>
277
331
  */
278
332
  LastModifiedTime?: Date;
279
333
  /**
334
+ * @public
280
335
  * <p>A history of all of the secondary statuses that the training job has transitioned
281
336
  * through.</p>
282
337
  */
283
338
  SecondaryStatusTransitions?: SecondaryStatusTransition[];
284
339
  /**
340
+ * @public
285
341
  * <p>A list of final metric values that are set when the training job completes. Used only
286
342
  * if the training job was configured to use metrics.</p>
287
343
  */
288
344
  FinalMetricDataList?: MetricData[];
289
345
  /**
346
+ * @public
290
347
  * <p>If the <code>TrainingJob</code> was created with network isolation, the value is set
291
348
  * to <code>true</code>. If network isolation is enabled, nodes can't communicate beyond
292
349
  * the VPC they run in.</p>
293
350
  */
294
351
  EnableNetworkIsolation?: boolean;
295
352
  /**
353
+ * @public
296
354
  * <p>To encrypt all communications between ML compute instances in distributed training,
297
355
  * choose <code>True</code>. Encryption provides greater security for distributed training,
298
356
  * but training might take longer. How long it takes depends on the amount of communication
@@ -301,24 +359,29 @@ export interface TrainingJob {
301
359
  */
302
360
  EnableInterContainerTrafficEncryption?: boolean;
303
361
  /**
362
+ * @public
304
363
  * <p>When true, enables managed spot training using Amazon EC2 Spot instances to run
305
364
  * training jobs instead of on-demand instances. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html">Managed Spot Training</a>.</p>
306
365
  */
307
366
  EnableManagedSpotTraining?: boolean;
308
367
  /**
368
+ * @public
309
369
  * <p>Contains information about the output location for managed spot training checkpoint
310
370
  * data. </p>
311
371
  */
312
372
  CheckpointConfig?: CheckpointConfig;
313
373
  /**
374
+ * @public
314
375
  * <p>The training time in seconds.</p>
315
376
  */
316
377
  TrainingTimeInSeconds?: number;
317
378
  /**
379
+ * @public
318
380
  * <p>The billable time in seconds.</p>
319
381
  */
320
382
  BillableTimeInSeconds?: number;
321
383
  /**
384
+ * @public
322
385
  * <p>Configuration information for the Amazon SageMaker Debugger hook parameters, metric and tensor collections, and
323
386
  * storage paths. To learn more about
324
387
  * how to configure the <code>DebugHookConfig</code> parameter,
@@ -326,6 +389,7 @@ export interface TrainingJob {
326
389
  */
327
390
  DebugHookConfig?: DebugHookConfig;
328
391
  /**
392
+ * @public
329
393
  * <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
330
394
  * you call the following APIs:</p>
331
395
  * <ul>
@@ -348,32 +412,39 @@ export interface TrainingJob {
348
412
  */
349
413
  ExperimentConfig?: ExperimentConfig;
350
414
  /**
415
+ * @public
351
416
  * <p>Information about the debug rule configuration.</p>
352
417
  */
353
418
  DebugRuleConfigurations?: DebugRuleConfiguration[];
354
419
  /**
420
+ * @public
355
421
  * <p>Configuration of storage locations for the Amazon SageMaker Debugger TensorBoard output data.</p>
356
422
  */
357
423
  TensorBoardOutputConfig?: TensorBoardOutputConfig;
358
424
  /**
425
+ * @public
359
426
  * <p>Information about the evaluation status of the rules for the training job.</p>
360
427
  */
361
428
  DebugRuleEvaluationStatuses?: DebugRuleEvaluationStatus[];
362
429
  /**
430
+ * @public
363
431
  * <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and
364
432
  * storage paths.</p>
365
433
  */
366
434
  ProfilerConfig?: ProfilerConfig;
367
435
  /**
436
+ * @public
368
437
  * <p>The environment variables to set in the Docker container.</p>
369
438
  */
370
439
  Environment?: Record<string, string>;
371
440
  /**
441
+ * @public
372
442
  * <p>The number of times to retry the job when the job fails due to an
373
443
  * <code>InternalServerError</code>.</p>
374
444
  */
375
445
  RetryStrategy?: RetryStrategy;
376
446
  /**
447
+ * @public
377
448
  * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
378
449
  * resources in different ways, for example, by purpose, owner, or environment. For more
379
450
  * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
@@ -386,22 +457,27 @@ export interface TrainingJob {
386
457
  */
387
458
  export interface TrialComponentSimpleSummary {
388
459
  /**
460
+ * @public
389
461
  * <p>The name of the trial component.</p>
390
462
  */
391
463
  TrialComponentName?: string;
392
464
  /**
465
+ * @public
393
466
  * <p>The Amazon Resource Name (ARN) of the trial component.</p>
394
467
  */
395
468
  TrialComponentArn?: string;
396
469
  /**
470
+ * @public
397
471
  * <p>The Amazon Resource Name (ARN) and job type of the source of a trial component.</p>
398
472
  */
399
473
  TrialComponentSource?: TrialComponentSource;
400
474
  /**
475
+ * @public
401
476
  * <p>When the component was created.</p>
402
477
  */
403
478
  CreationTime?: Date;
404
479
  /**
480
+ * @public
405
481
  * <p>Information about the user who created or modified an experiment, trial, trial
406
482
  * component, lineage group, project, or model card.</p>
407
483
  */
@@ -413,53 +489,65 @@ export interface TrialComponentSimpleSummary {
413
489
  */
414
490
  export interface Trial {
415
491
  /**
492
+ * @public
416
493
  * <p>The name of the trial.</p>
417
494
  */
418
495
  TrialName?: string;
419
496
  /**
497
+ * @public
420
498
  * <p>The Amazon Resource Name (ARN) of the trial.</p>
421
499
  */
422
500
  TrialArn?: string;
423
501
  /**
502
+ * @public
424
503
  * <p>The name of the trial as displayed. If <code>DisplayName</code> isn't specified,
425
504
  * <code>TrialName</code> is displayed.</p>
426
505
  */
427
506
  DisplayName?: string;
428
507
  /**
508
+ * @public
429
509
  * <p>The name of the experiment the trial is part of.</p>
430
510
  */
431
511
  ExperimentName?: string;
432
512
  /**
513
+ * @public
433
514
  * <p>The source of the trial.</p>
434
515
  */
435
516
  Source?: TrialSource;
436
517
  /**
518
+ * @public
437
519
  * <p>When the trial was created.</p>
438
520
  */
439
521
  CreationTime?: Date;
440
522
  /**
523
+ * @public
441
524
  * <p>Who created the trial.</p>
442
525
  */
443
526
  CreatedBy?: UserContext;
444
527
  /**
528
+ * @public
445
529
  * <p>Who last modified the trial.</p>
446
530
  */
447
531
  LastModifiedTime?: Date;
448
532
  /**
533
+ * @public
449
534
  * <p>Information about the user who created or modified an experiment, trial, trial
450
535
  * component, lineage group, project, or model card.</p>
451
536
  */
452
537
  LastModifiedBy?: UserContext;
453
538
  /**
539
+ * @public
454
540
  * <p>Metadata properties of the tracking entity, trial, or trial component.</p>
455
541
  */
456
542
  MetadataProperties?: MetadataProperties;
457
543
  /**
544
+ * @public
458
545
  * <p>The list of tags that are associated with the trial. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a>
459
546
  * API to search on the tags.</p>
460
547
  */
461
548
  Tags?: Tag[];
462
549
  /**
550
+ * @public
463
551
  * <p>A list of the components associated with the trial. For each component, a summary of the
464
552
  * component's properties is included.</p>
465
553
  */
@@ -472,18 +560,22 @@ export interface Trial {
472
560
  */
473
561
  export interface TrialComponentSourceDetail {
474
562
  /**
563
+ * @public
475
564
  * <p>The Amazon Resource Name (ARN) of the source.</p>
476
565
  */
477
566
  SourceArn?: string;
478
567
  /**
568
+ * @public
479
569
  * <p>Information about a training job that's the source of a trial component.</p>
480
570
  */
481
571
  TrainingJob?: TrainingJob;
482
572
  /**
573
+ * @public
483
574
  * <p>Information about a processing job that's the source of a trial component.</p>
484
575
  */
485
576
  ProcessingJob?: ProcessingJob;
486
577
  /**
578
+ * @public
487
579
  * <p>Information about a transform job that's the source of a trial component.</p>
488
580
  */
489
581
  TransformJob?: TransformJob;
@@ -495,89 +587,110 @@ export interface TrialComponentSourceDetail {
495
587
  */
496
588
  export interface TrialComponent {
497
589
  /**
590
+ * @public
498
591
  * <p>The name of the trial component.</p>
499
592
  */
500
593
  TrialComponentName?: string;
501
594
  /**
595
+ * @public
502
596
  * <p>The name of the component as displayed. If <code>DisplayName</code> isn't specified,
503
597
  * <code>TrialComponentName</code> is displayed.</p>
504
598
  */
505
599
  DisplayName?: string;
506
600
  /**
601
+ * @public
507
602
  * <p>The Amazon Resource Name (ARN) of the trial component.</p>
508
603
  */
509
604
  TrialComponentArn?: string;
510
605
  /**
606
+ * @public
511
607
  * <p>The Amazon Resource Name (ARN) and job type of the source of the component.</p>
512
608
  */
513
609
  Source?: TrialComponentSource;
514
610
  /**
611
+ * @public
515
612
  * <p>The status of the trial component.</p>
516
613
  */
517
614
  Status?: TrialComponentStatus;
518
615
  /**
616
+ * @public
519
617
  * <p>When the component started.</p>
520
618
  */
521
619
  StartTime?: Date;
522
620
  /**
621
+ * @public
523
622
  * <p>When the component ended.</p>
524
623
  */
525
624
  EndTime?: Date;
526
625
  /**
626
+ * @public
527
627
  * <p>When the component was created.</p>
528
628
  */
529
629
  CreationTime?: Date;
530
630
  /**
631
+ * @public
531
632
  * <p>Who created the trial component.</p>
532
633
  */
533
634
  CreatedBy?: UserContext;
534
635
  /**
636
+ * @public
535
637
  * <p>When the component was last modified.</p>
536
638
  */
537
639
  LastModifiedTime?: Date;
538
640
  /**
641
+ * @public
539
642
  * <p>Information about the user who created or modified an experiment, trial, trial
540
643
  * component, lineage group, project, or model card.</p>
541
644
  */
542
645
  LastModifiedBy?: UserContext;
543
646
  /**
647
+ * @public
544
648
  * <p>The hyperparameters of the component.</p>
545
649
  */
546
650
  Parameters?: Record<string, TrialComponentParameterValue>;
547
651
  /**
652
+ * @public
548
653
  * <p>The input artifacts of the component.</p>
549
654
  */
550
655
  InputArtifacts?: Record<string, TrialComponentArtifact>;
551
656
  /**
657
+ * @public
552
658
  * <p>The output artifacts of the component.</p>
553
659
  */
554
660
  OutputArtifacts?: Record<string, TrialComponentArtifact>;
555
661
  /**
662
+ * @public
556
663
  * <p>The metrics for the component.</p>
557
664
  */
558
665
  Metrics?: TrialComponentMetricSummary[];
559
666
  /**
667
+ * @public
560
668
  * <p>Metadata properties of the tracking entity, trial, or trial component.</p>
561
669
  */
562
670
  MetadataProperties?: MetadataProperties;
563
671
  /**
672
+ * @public
564
673
  * <p>Details of the source of the component.</p>
565
674
  */
566
675
  SourceDetail?: TrialComponentSourceDetail;
567
676
  /**
677
+ * @public
568
678
  * <p>The Amazon Resource Name (ARN) of the lineage group resource.</p>
569
679
  */
570
680
  LineageGroupArn?: string;
571
681
  /**
682
+ * @public
572
683
  * <p>The list of tags that are associated with the component. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p>
573
684
  */
574
685
  Tags?: Tag[];
575
686
  /**
687
+ * @public
576
688
  * <p>An array of the parents of the component. A parent is a trial the component is associated
577
689
  * with and the experiment the trial is part of. A component might not have any parents.</p>
578
690
  */
579
691
  Parents?: Parent[];
580
692
  /**
693
+ * @public
581
694
  * <p>The name of the experiment run.</p>
582
695
  */
583
696
  RunName?: string;
@@ -588,42 +701,52 @@ export interface TrialComponent {
588
701
  */
589
702
  export interface SearchRecord {
590
703
  /**
704
+ * @public
591
705
  * <p>The properties of a training job.</p>
592
706
  */
593
707
  TrainingJob?: TrainingJob;
594
708
  /**
709
+ * @public
595
710
  * <p>The properties of an experiment.</p>
596
711
  */
597
712
  Experiment?: Experiment;
598
713
  /**
714
+ * @public
599
715
  * <p>The properties of a trial.</p>
600
716
  */
601
717
  Trial?: Trial;
602
718
  /**
719
+ * @public
603
720
  * <p>The properties of a trial component.</p>
604
721
  */
605
722
  TrialComponent?: TrialComponent;
606
723
  /**
724
+ * @public
607
725
  * <p>A hosted endpoint for real-time inference.</p>
608
726
  */
609
727
  Endpoint?: Endpoint;
610
728
  /**
729
+ * @public
611
730
  * <p>A versioned model that can be deployed for SageMaker inference.</p>
612
731
  */
613
732
  ModelPackage?: ModelPackage;
614
733
  /**
734
+ * @public
615
735
  * <p>A group of versioned models in the model registry.</p>
616
736
  */
617
737
  ModelPackageGroup?: ModelPackageGroup;
618
738
  /**
739
+ * @public
619
740
  * <p>A SageMaker Model Building Pipeline instance.</p>
620
741
  */
621
742
  Pipeline?: Pipeline;
622
743
  /**
744
+ * @public
623
745
  * <p>An execution of a pipeline.</p>
624
746
  */
625
747
  PipelineExecution?: PipelineExecution;
626
748
  /**
749
+ * @public
627
750
  * <p>Amazon SageMaker Feature Store stores features in a collection called Feature Group. A
628
751
  * Feature Group can be visualized as a table which has rows, with a unique identifier for
629
752
  * each row where each column in the table is a feature. In principle, a Feature Group is
@@ -631,22 +754,27 @@ export interface SearchRecord {
631
754
  */
632
755
  FeatureGroup?: FeatureGroup;
633
756
  /**
757
+ * @public
634
758
  * <p>The properties of a project.</p>
635
759
  */
636
760
  Project?: Project;
637
761
  /**
762
+ * @public
638
763
  * <p>The feature metadata used to search through the features.</p>
639
764
  */
640
765
  FeatureMetadata?: FeatureMetadata;
641
766
  /**
767
+ * @public
642
768
  * <p>The properties of a hyperparameter tuning job.</p>
643
769
  */
644
770
  HyperParameterTuningJob?: HyperParameterTuningJobSearchEntity;
645
771
  /**
772
+ * @public
646
773
  * <p>A model displayed in the Amazon SageMaker Model Dashboard.</p>
647
774
  */
648
775
  Model?: ModelDashboardModel;
649
776
  /**
777
+ * @public
650
778
  * <p>An Amazon SageMaker Model Card that documents details about a machine learning model.</p>
651
779
  */
652
780
  ModelCard?: ModelCard;
@@ -656,10 +784,12 @@ export interface SearchRecord {
656
784
  */
657
785
  export interface SearchResponse {
658
786
  /**
787
+ * @public
659
788
  * <p>A list of <code>SearchRecord</code> objects.</p>
660
789
  */
661
790
  Results?: SearchRecord[];
662
791
  /**
792
+ * @public
663
793
  * <p>If the result of the previous <code>Search</code> request was truncated, the response
664
794
  * includes a NextToken. To retrieve the next set of results, use the token in the next
665
795
  * request.</p>
@@ -671,14 +801,17 @@ export interface SearchResponse {
671
801
  */
672
802
  export interface SendPipelineExecutionStepFailureRequest {
673
803
  /**
804
+ * @public
674
805
  * <p>The pipeline generated token from the Amazon SQS queue.</p>
675
806
  */
676
807
  CallbackToken: string | undefined;
677
808
  /**
809
+ * @public
678
810
  * <p>A message describing why the step failed.</p>
679
811
  */
680
812
  FailureReason?: string;
681
813
  /**
814
+ * @public
682
815
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
683
816
  * operation. An idempotent operation completes no more than one time.</p>
684
817
  */
@@ -689,6 +822,7 @@ export interface SendPipelineExecutionStepFailureRequest {
689
822
  */
690
823
  export interface SendPipelineExecutionStepFailureResponse {
691
824
  /**
825
+ * @public
692
826
  * <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
693
827
  */
694
828
  PipelineExecutionArn?: string;
@@ -698,14 +832,17 @@ export interface SendPipelineExecutionStepFailureResponse {
698
832
  */
699
833
  export interface SendPipelineExecutionStepSuccessRequest {
700
834
  /**
835
+ * @public
701
836
  * <p>The pipeline generated token from the Amazon SQS queue.</p>
702
837
  */
703
838
  CallbackToken: string | undefined;
704
839
  /**
840
+ * @public
705
841
  * <p>A list of the output parameters of the callback step.</p>
706
842
  */
707
843
  OutputParameters?: OutputParameter[];
708
844
  /**
845
+ * @public
709
846
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
710
847
  * operation. An idempotent operation completes no more than one time.</p>
711
848
  */
@@ -716,6 +853,7 @@ export interface SendPipelineExecutionStepSuccessRequest {
716
853
  */
717
854
  export interface SendPipelineExecutionStepSuccessResponse {
718
855
  /**
856
+ * @public
719
857
  * <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
720
858
  */
721
859
  PipelineExecutionArn?: string;
@@ -725,10 +863,12 @@ export interface SendPipelineExecutionStepSuccessResponse {
725
863
  */
726
864
  export interface StartEdgeDeploymentStageRequest {
727
865
  /**
866
+ * @public
728
867
  * <p>The name of the edge deployment plan to start.</p>
729
868
  */
730
869
  EdgeDeploymentPlanName: string | undefined;
731
870
  /**
871
+ * @public
732
872
  * <p>The name of the stage to start.</p>
733
873
  */
734
874
  StageName: string | undefined;
@@ -738,6 +878,7 @@ export interface StartEdgeDeploymentStageRequest {
738
878
  */
739
879
  export interface StartInferenceExperimentRequest {
740
880
  /**
881
+ * @public
741
882
  * <p>The name of the inference experiment to start.</p>
742
883
  */
743
884
  Name: string | undefined;
@@ -747,6 +888,7 @@ export interface StartInferenceExperimentRequest {
747
888
  */
748
889
  export interface StartInferenceExperimentResponse {
749
890
  /**
891
+ * @public
750
892
  * <p>The ARN of the started inference experiment to start.</p>
751
893
  */
752
894
  InferenceExperimentArn: string | undefined;
@@ -756,6 +898,7 @@ export interface StartInferenceExperimentResponse {
756
898
  */
757
899
  export interface StartMonitoringScheduleRequest {
758
900
  /**
901
+ * @public
759
902
  * <p>The name of the schedule to start.</p>
760
903
  */
761
904
  MonitoringScheduleName: string | undefined;
@@ -765,6 +908,7 @@ export interface StartMonitoringScheduleRequest {
765
908
  */
766
909
  export interface StartNotebookInstanceInput {
767
910
  /**
911
+ * @public
768
912
  * <p>The name of the notebook instance to start.</p>
769
913
  */
770
914
  NotebookInstanceName: string | undefined;
@@ -774,32 +918,39 @@ export interface StartNotebookInstanceInput {
774
918
  */
775
919
  export interface StartPipelineExecutionRequest {
776
920
  /**
921
+ * @public
777
922
  * <p>The name or Amazon Resource Name (ARN) of the pipeline.</p>
778
923
  */
779
924
  PipelineName: string | undefined;
780
925
  /**
926
+ * @public
781
927
  * <p>The display name of the pipeline execution.</p>
782
928
  */
783
929
  PipelineExecutionDisplayName?: string;
784
930
  /**
931
+ * @public
785
932
  * <p>Contains a list of pipeline parameters. This list can be empty. </p>
786
933
  */
787
934
  PipelineParameters?: Parameter[];
788
935
  /**
936
+ * @public
789
937
  * <p>The description of the pipeline execution.</p>
790
938
  */
791
939
  PipelineExecutionDescription?: string;
792
940
  /**
941
+ * @public
793
942
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
794
943
  * operation. An idempotent operation completes no more than once.</p>
795
944
  */
796
945
  ClientRequestToken?: string;
797
946
  /**
947
+ * @public
798
948
  * <p>This configuration, if specified, overrides the parallelism configuration
799
949
  * of the parent pipeline for this specific run.</p>
800
950
  */
801
951
  ParallelismConfiguration?: ParallelismConfiguration;
802
952
  /**
953
+ * @public
803
954
  * <p>The selective execution configuration applied to the pipeline run.</p>
804
955
  */
805
956
  SelectiveExecutionConfig?: SelectiveExecutionConfig;
@@ -809,6 +960,7 @@ export interface StartPipelineExecutionRequest {
809
960
  */
810
961
  export interface StartPipelineExecutionResponse {
811
962
  /**
963
+ * @public
812
964
  * <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
813
965
  */
814
966
  PipelineExecutionArn?: string;
@@ -818,6 +970,7 @@ export interface StartPipelineExecutionResponse {
818
970
  */
819
971
  export interface StopAutoMLJobRequest {
820
972
  /**
973
+ * @public
821
974
  * <p>The name of the object you are requesting.</p>
822
975
  */
823
976
  AutoMLJobName: string | undefined;
@@ -827,6 +980,7 @@ export interface StopAutoMLJobRequest {
827
980
  */
828
981
  export interface StopCompilationJobRequest {
829
982
  /**
983
+ * @public
830
984
  * <p>The name of the model compilation job to stop.</p>
831
985
  */
832
986
  CompilationJobName: string | undefined;
@@ -836,10 +990,12 @@ export interface StopCompilationJobRequest {
836
990
  */
837
991
  export interface StopEdgeDeploymentStageRequest {
838
992
  /**
993
+ * @public
839
994
  * <p>The name of the edge deployment plan to stop.</p>
840
995
  */
841
996
  EdgeDeploymentPlanName: string | undefined;
842
997
  /**
998
+ * @public
843
999
  * <p>The name of the stage to stop.</p>
844
1000
  */
845
1001
  StageName: string | undefined;
@@ -849,6 +1005,7 @@ export interface StopEdgeDeploymentStageRequest {
849
1005
  */
850
1006
  export interface StopEdgePackagingJobRequest {
851
1007
  /**
1008
+ * @public
852
1009
  * <p>The name of the edge packaging job.</p>
853
1010
  */
854
1011
  EdgePackagingJobName: string | undefined;
@@ -858,6 +1015,7 @@ export interface StopEdgePackagingJobRequest {
858
1015
  */
859
1016
  export interface StopHyperParameterTuningJobRequest {
860
1017
  /**
1018
+ * @public
861
1019
  * <p>The name of the tuning job to stop.</p>
862
1020
  */
863
1021
  HyperParameterTuningJobName: string | undefined;
@@ -867,10 +1025,12 @@ export interface StopHyperParameterTuningJobRequest {
867
1025
  */
868
1026
  export interface StopInferenceExperimentRequest {
869
1027
  /**
1028
+ * @public
870
1029
  * <p>The name of the inference experiment to stop.</p>
871
1030
  */
872
1031
  Name: string | undefined;
873
1032
  /**
1033
+ * @public
874
1034
  * <p>
875
1035
  * Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:
876
1036
  * </p>
@@ -891,6 +1051,7 @@ export interface StopInferenceExperimentRequest {
891
1051
  */
892
1052
  ModelVariantActions: Record<string, ModelVariantAction | string> | undefined;
893
1053
  /**
1054
+ * @public
894
1055
  * <p>
895
1056
  * An array of <code>ModelVariantConfig</code> objects. There is one for each variant that you want to deploy
896
1057
  * after the inference experiment stops. Each <code>ModelVariantConfig</code> describes the infrastructure
@@ -899,6 +1060,7 @@ export interface StopInferenceExperimentRequest {
899
1060
  */
900
1061
  DesiredModelVariants?: ModelVariantConfig[];
901
1062
  /**
1063
+ * @public
902
1064
  * <p>
903
1065
  * The desired state of the experiment after stopping. The possible states are the following:
904
1066
  * </p>
@@ -915,6 +1077,7 @@ export interface StopInferenceExperimentRequest {
915
1077
  */
916
1078
  DesiredState?: InferenceExperimentStopDesiredState | string;
917
1079
  /**
1080
+ * @public
918
1081
  * <p>The reason for stopping the experiment.</p>
919
1082
  */
920
1083
  Reason?: string;
@@ -924,6 +1087,7 @@ export interface StopInferenceExperimentRequest {
924
1087
  */
925
1088
  export interface StopInferenceExperimentResponse {
926
1089
  /**
1090
+ * @public
927
1091
  * <p>The ARN of the stopped inference experiment.</p>
928
1092
  */
929
1093
  InferenceExperimentArn: string | undefined;
@@ -933,6 +1097,7 @@ export interface StopInferenceExperimentResponse {
933
1097
  */
934
1098
  export interface StopInferenceRecommendationsJobRequest {
935
1099
  /**
1100
+ * @public
936
1101
  * <p>The name of the job you want to stop.</p>
937
1102
  */
938
1103
  JobName: string | undefined;
@@ -942,6 +1107,7 @@ export interface StopInferenceRecommendationsJobRequest {
942
1107
  */
943
1108
  export interface StopLabelingJobRequest {
944
1109
  /**
1110
+ * @public
945
1111
  * <p>The name of the labeling job to stop.</p>
946
1112
  */
947
1113
  LabelingJobName: string | undefined;
@@ -951,6 +1117,7 @@ export interface StopLabelingJobRequest {
951
1117
  */
952
1118
  export interface StopMonitoringScheduleRequest {
953
1119
  /**
1120
+ * @public
954
1121
  * <p>The name of the schedule to stop.</p>
955
1122
  */
956
1123
  MonitoringScheduleName: string | undefined;
@@ -960,6 +1127,7 @@ export interface StopMonitoringScheduleRequest {
960
1127
  */
961
1128
  export interface StopNotebookInstanceInput {
962
1129
  /**
1130
+ * @public
963
1131
  * <p>The name of the notebook instance to terminate.</p>
964
1132
  */
965
1133
  NotebookInstanceName: string | undefined;
@@ -969,10 +1137,12 @@ export interface StopNotebookInstanceInput {
969
1137
  */
970
1138
  export interface StopPipelineExecutionRequest {
971
1139
  /**
1140
+ * @public
972
1141
  * <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
973
1142
  */
974
1143
  PipelineExecutionArn: string | undefined;
975
1144
  /**
1145
+ * @public
976
1146
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
977
1147
  * operation. An idempotent operation completes no more than once.</p>
978
1148
  */
@@ -983,6 +1153,7 @@ export interface StopPipelineExecutionRequest {
983
1153
  */
984
1154
  export interface StopPipelineExecutionResponse {
985
1155
  /**
1156
+ * @public
986
1157
  * <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
987
1158
  */
988
1159
  PipelineExecutionArn?: string;
@@ -992,6 +1163,7 @@ export interface StopPipelineExecutionResponse {
992
1163
  */
993
1164
  export interface StopProcessingJobRequest {
994
1165
  /**
1166
+ * @public
995
1167
  * <p>The name of the processing job to stop.</p>
996
1168
  */
997
1169
  ProcessingJobName: string | undefined;
@@ -1001,6 +1173,7 @@ export interface StopProcessingJobRequest {
1001
1173
  */
1002
1174
  export interface StopTrainingJobRequest {
1003
1175
  /**
1176
+ * @public
1004
1177
  * <p>The name of the training job to stop.</p>
1005
1178
  */
1006
1179
  TrainingJobName: string | undefined;
@@ -1010,6 +1183,7 @@ export interface StopTrainingJobRequest {
1010
1183
  */
1011
1184
  export interface StopTransformJobRequest {
1012
1185
  /**
1186
+ * @public
1013
1187
  * <p>The name of the batch transform job to stop.</p>
1014
1188
  */
1015
1189
  TransformJobName: string | undefined;
@@ -1019,22 +1193,27 @@ export interface StopTransformJobRequest {
1019
1193
  */
1020
1194
  export interface UpdateActionRequest {
1021
1195
  /**
1196
+ * @public
1022
1197
  * <p>The name of the action to update.</p>
1023
1198
  */
1024
1199
  ActionName: string | undefined;
1025
1200
  /**
1201
+ * @public
1026
1202
  * <p>The new description for the action.</p>
1027
1203
  */
1028
1204
  Description?: string;
1029
1205
  /**
1206
+ * @public
1030
1207
  * <p>The new status for the action.</p>
1031
1208
  */
1032
1209
  Status?: ActionStatus | string;
1033
1210
  /**
1211
+ * @public
1034
1212
  * <p>The new list of properties. Overwrites the current property list.</p>
1035
1213
  */
1036
1214
  Properties?: Record<string, string>;
1037
1215
  /**
1216
+ * @public
1038
1217
  * <p>A list of properties to remove.</p>
1039
1218
  */
1040
1219
  PropertiesToRemove?: string[];
@@ -1044,6 +1223,7 @@ export interface UpdateActionRequest {
1044
1223
  */
1045
1224
  export interface UpdateActionResponse {
1046
1225
  /**
1226
+ * @public
1047
1227
  * <p>The Amazon Resource Name (ARN) of the action.</p>
1048
1228
  */
1049
1229
  ActionArn?: string;
@@ -1053,10 +1233,12 @@ export interface UpdateActionResponse {
1053
1233
  */
1054
1234
  export interface UpdateAppImageConfigRequest {
1055
1235
  /**
1236
+ * @public
1056
1237
  * <p>The name of the AppImageConfig to update.</p>
1057
1238
  */
1058
1239
  AppImageConfigName: string | undefined;
1059
1240
  /**
1241
+ * @public
1060
1242
  * <p>The new KernelGateway app to run on the image.</p>
1061
1243
  */
1062
1244
  KernelGatewayImageConfig?: KernelGatewayImageConfig;
@@ -1066,6 +1248,7 @@ export interface UpdateAppImageConfigRequest {
1066
1248
  */
1067
1249
  export interface UpdateAppImageConfigResponse {
1068
1250
  /**
1251
+ * @public
1069
1252
  * <p>The Amazon Resource Name (ARN) for the AppImageConfig.</p>
1070
1253
  */
1071
1254
  AppImageConfigArn?: string;
@@ -1075,18 +1258,22 @@ export interface UpdateAppImageConfigResponse {
1075
1258
  */
1076
1259
  export interface UpdateArtifactRequest {
1077
1260
  /**
1261
+ * @public
1078
1262
  * <p>The Amazon Resource Name (ARN) of the artifact to update.</p>
1079
1263
  */
1080
1264
  ArtifactArn: string | undefined;
1081
1265
  /**
1266
+ * @public
1082
1267
  * <p>The new name for the artifact.</p>
1083
1268
  */
1084
1269
  ArtifactName?: string;
1085
1270
  /**
1271
+ * @public
1086
1272
  * <p>The new list of properties. Overwrites the current property list.</p>
1087
1273
  */
1088
1274
  Properties?: Record<string, string>;
1089
1275
  /**
1276
+ * @public
1090
1277
  * <p>A list of properties to remove.</p>
1091
1278
  */
1092
1279
  PropertiesToRemove?: string[];
@@ -1096,6 +1283,7 @@ export interface UpdateArtifactRequest {
1096
1283
  */
1097
1284
  export interface UpdateArtifactResponse {
1098
1285
  /**
1286
+ * @public
1099
1287
  * <p>The Amazon Resource Name (ARN) of the artifact.</p>
1100
1288
  */
1101
1289
  ArtifactArn?: string;
@@ -1105,10 +1293,12 @@ export interface UpdateArtifactResponse {
1105
1293
  */
1106
1294
  export interface UpdateCodeRepositoryInput {
1107
1295
  /**
1296
+ * @public
1108
1297
  * <p>The name of the Git repository to update.</p>
1109
1298
  */
1110
1299
  CodeRepositoryName: string | undefined;
1111
1300
  /**
1301
+ * @public
1112
1302
  * <p>The configuration of the git repository, including the URL and the Amazon Resource
1113
1303
  * Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the
1114
1304
  * credentials used to access the repository. The secret must have a staging label of
@@ -1125,6 +1315,7 @@ export interface UpdateCodeRepositoryInput {
1125
1315
  */
1126
1316
  export interface UpdateCodeRepositoryOutput {
1127
1317
  /**
1318
+ * @public
1128
1319
  * <p>The ARN of the Git repository.</p>
1129
1320
  */
1130
1321
  CodeRepositoryArn: string | undefined;
@@ -1134,18 +1325,22 @@ export interface UpdateCodeRepositoryOutput {
1134
1325
  */
1135
1326
  export interface UpdateContextRequest {
1136
1327
  /**
1328
+ * @public
1137
1329
  * <p>The name of the context to update.</p>
1138
1330
  */
1139
1331
  ContextName: string | undefined;
1140
1332
  /**
1333
+ * @public
1141
1334
  * <p>The new description for the context.</p>
1142
1335
  */
1143
1336
  Description?: string;
1144
1337
  /**
1338
+ * @public
1145
1339
  * <p>The new list of properties. Overwrites the current property list.</p>
1146
1340
  */
1147
1341
  Properties?: Record<string, string>;
1148
1342
  /**
1343
+ * @public
1149
1344
  * <p>A list of properties to remove.</p>
1150
1345
  */
1151
1346
  PropertiesToRemove?: string[];
@@ -1155,6 +1350,7 @@ export interface UpdateContextRequest {
1155
1350
  */
1156
1351
  export interface UpdateContextResponse {
1157
1352
  /**
1353
+ * @public
1158
1354
  * <p>The Amazon Resource Name (ARN) of the context.</p>
1159
1355
  */
1160
1356
  ContextArn?: string;
@@ -1164,22 +1360,27 @@ export interface UpdateContextResponse {
1164
1360
  */
1165
1361
  export interface UpdateDeviceFleetRequest {
1166
1362
  /**
1363
+ * @public
1167
1364
  * <p>The name of the fleet.</p>
1168
1365
  */
1169
1366
  DeviceFleetName: string | undefined;
1170
1367
  /**
1368
+ * @public
1171
1369
  * <p>The Amazon Resource Name (ARN) of the device.</p>
1172
1370
  */
1173
1371
  RoleArn?: string;
1174
1372
  /**
1373
+ * @public
1175
1374
  * <p>Description of the fleet.</p>
1176
1375
  */
1177
1376
  Description?: string;
1178
1377
  /**
1378
+ * @public
1179
1379
  * <p>Output configuration for storing sample data collected by the fleet.</p>
1180
1380
  */
1181
1381
  OutputConfig: EdgeOutputConfig | undefined;
1182
1382
  /**
1383
+ * @public
1183
1384
  * <p>Whether to create an Amazon Web Services IoT Role Alias during device fleet creation.
1184
1385
  * The name of the role alias generated will match this pattern:
1185
1386
  * "SageMakerEdge-\{DeviceFleetName\}".</p>
@@ -1193,10 +1394,12 @@ export interface UpdateDeviceFleetRequest {
1193
1394
  */
1194
1395
  export interface UpdateDevicesRequest {
1195
1396
  /**
1397
+ * @public
1196
1398
  * <p>The name of the fleet the devices belong to.</p>
1197
1399
  */
1198
1400
  DeviceFleetName: string | undefined;
1199
1401
  /**
1402
+ * @public
1200
1403
  * <p>List of devices to register with Edge Manager agent.</p>
1201
1404
  */
1202
1405
  Devices: Device[] | undefined;
@@ -1206,22 +1409,27 @@ export interface UpdateDevicesRequest {
1206
1409
  */
1207
1410
  export interface UpdateDomainRequest {
1208
1411
  /**
1412
+ * @public
1209
1413
  * <p>The ID of the domain to be updated.</p>
1210
1414
  */
1211
1415
  DomainId: string | undefined;
1212
1416
  /**
1417
+ * @public
1213
1418
  * <p>A collection of settings.</p>
1214
1419
  */
1215
1420
  DefaultUserSettings?: UserSettings;
1216
1421
  /**
1422
+ * @public
1217
1423
  * <p>A collection of <code>DomainSettings</code> configuration values to update.</p>
1218
1424
  */
1219
1425
  DomainSettingsForUpdate?: DomainSettingsForUpdate;
1220
1426
  /**
1427
+ * @public
1221
1428
  * <p>The default settings used to create a space within the Domain.</p>
1222
1429
  */
1223
1430
  DefaultSpaceSettings?: DefaultSpaceSettings;
1224
1431
  /**
1432
+ * @public
1225
1433
  * <p>The entity that creates and manages the required security groups for inter-app
1226
1434
  * communication in <code>VPCOnly</code> mode. Required when
1227
1435
  * <code>CreateDomain.AppNetworkAccessType</code> is <code>VPCOnly</code> and
@@ -1236,6 +1444,7 @@ export interface UpdateDomainRequest {
1236
1444
  */
1237
1445
  export interface UpdateDomainResponse {
1238
1446
  /**
1447
+ * @public
1239
1448
  * <p>The Amazon Resource Name (ARN) of the domain.</p>
1240
1449
  */
1241
1450
  DomainArn?: string;
@@ -1264,6 +1473,7 @@ export type VariantPropertyType = (typeof VariantPropertyType)[keyof typeof Vari
1264
1473
  */
1265
1474
  export interface VariantProperty {
1266
1475
  /**
1476
+ * @public
1267
1477
  * <p>The type of variant property. The supported values are:</p>
1268
1478
  * <ul>
1269
1479
  * <li>
@@ -1291,14 +1501,17 @@ export interface VariantProperty {
1291
1501
  */
1292
1502
  export interface UpdateEndpointInput {
1293
1503
  /**
1504
+ * @public
1294
1505
  * <p>The name of the endpoint whose configuration you want to update.</p>
1295
1506
  */
1296
1507
  EndpointName: string | undefined;
1297
1508
  /**
1509
+ * @public
1298
1510
  * <p>The name of the new endpoint configuration.</p>
1299
1511
  */
1300
1512
  EndpointConfigName: string | undefined;
1301
1513
  /**
1514
+ * @public
1302
1515
  * <p>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To
1303
1516
  * retain the variant properties of an endpoint when updating it, set
1304
1517
  * <code>RetainAllVariantProperties</code> to <code>true</code>. To use the variant
@@ -1308,6 +1521,7 @@ export interface UpdateEndpointInput {
1308
1521
  */
1309
1522
  RetainAllVariantProperties?: boolean;
1310
1523
  /**
1524
+ * @public
1311
1525
  * <p>When you are updating endpoint resources with <code>RetainAllVariantProperties</code>,
1312
1526
  * whose value is set to <code>true</code>, <code>ExcludeRetainedVariantProperties</code>
1313
1527
  * specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a>
@@ -1317,11 +1531,13 @@ export interface UpdateEndpointInput {
1317
1531
  */
1318
1532
  ExcludeRetainedVariantProperties?: VariantProperty[];
1319
1533
  /**
1534
+ * @public
1320
1535
  * <p>The deployment configuration for an endpoint, which contains the desired deployment
1321
1536
  * strategy and rollback configurations.</p>
1322
1537
  */
1323
1538
  DeploymentConfig?: DeploymentConfig;
1324
1539
  /**
1540
+ * @public
1325
1541
  * <p>Specifies whether to reuse the last deployment configuration. The default value is
1326
1542
  * false (the configuration is not reused).</p>
1327
1543
  */
@@ -1332,6 +1548,7 @@ export interface UpdateEndpointInput {
1332
1548
  */
1333
1549
  export interface UpdateEndpointOutput {
1334
1550
  /**
1551
+ * @public
1335
1552
  * <p>The Amazon Resource Name (ARN) of the endpoint.</p>
1336
1553
  */
1337
1554
  EndpointArn: string | undefined;
@@ -1341,10 +1558,12 @@ export interface UpdateEndpointOutput {
1341
1558
  */
1342
1559
  export interface UpdateEndpointWeightsAndCapacitiesInput {
1343
1560
  /**
1561
+ * @public
1344
1562
  * <p>The name of an existing SageMaker endpoint.</p>
1345
1563
  */
1346
1564
  EndpointName: string | undefined;
1347
1565
  /**
1566
+ * @public
1348
1567
  * <p>An object that provides new capacity and weight values for a variant.</p>
1349
1568
  */
1350
1569
  DesiredWeightsAndCapacities: DesiredWeightAndCapacity[] | undefined;
@@ -1354,6 +1573,7 @@ export interface UpdateEndpointWeightsAndCapacitiesInput {
1354
1573
  */
1355
1574
  export interface UpdateEndpointWeightsAndCapacitiesOutput {
1356
1575
  /**
1576
+ * @public
1357
1577
  * <p>The Amazon Resource Name (ARN) of the updated endpoint.</p>
1358
1578
  */
1359
1579
  EndpointArn: string | undefined;
@@ -1363,15 +1583,18 @@ export interface UpdateEndpointWeightsAndCapacitiesOutput {
1363
1583
  */
1364
1584
  export interface UpdateExperimentRequest {
1365
1585
  /**
1586
+ * @public
1366
1587
  * <p>The name of the experiment to update.</p>
1367
1588
  */
1368
1589
  ExperimentName: string | undefined;
1369
1590
  /**
1591
+ * @public
1370
1592
  * <p>The name of the experiment as displayed. The name doesn't need to be unique. If
1371
1593
  * <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
1372
1594
  */
1373
1595
  DisplayName?: string;
1374
1596
  /**
1597
+ * @public
1375
1598
  * <p>The description of the experiment.</p>
1376
1599
  */
1377
1600
  Description?: string;
@@ -1381,6 +1604,7 @@ export interface UpdateExperimentRequest {
1381
1604
  */
1382
1605
  export interface UpdateExperimentResponse {
1383
1606
  /**
1607
+ * @public
1384
1608
  * <p>The Amazon Resource Name (ARN) of the experiment.</p>
1385
1609
  */
1386
1610
  ExperimentArn?: string;
@@ -1390,16 +1614,19 @@ export interface UpdateExperimentResponse {
1390
1614
  */
1391
1615
  export interface UpdateFeatureGroupRequest {
1392
1616
  /**
1617
+ * @public
1393
1618
  * <p>The name or Amazon Resource Name (ARN) of the feature group that you're updating.</p>
1394
1619
  */
1395
1620
  FeatureGroupName: string | undefined;
1396
1621
  /**
1622
+ * @public
1397
1623
  * <p>Updates the feature group. Updating a feature group is an asynchronous operation. When
1398
1624
  * you get an HTTP 200 response, you've made a valid request. It takes some time after you've
1399
1625
  * made a valid request for Feature Store to update the feature group.</p>
1400
1626
  */
1401
1627
  FeatureAdditions?: FeatureDefinition[];
1402
1628
  /**
1629
+ * @public
1403
1630
  * <p>Updates the feature group online store configuration.</p>
1404
1631
  */
1405
1632
  OnlineStoreConfig?: OnlineStoreConfigUpdate;
@@ -1409,6 +1636,7 @@ export interface UpdateFeatureGroupRequest {
1409
1636
  */
1410
1637
  export interface UpdateFeatureGroupResponse {
1411
1638
  /**
1639
+ * @public
1412
1640
  * <p>The Amazon Resource Number (ARN) of the feature group that you're updating.</p>
1413
1641
  */
1414
1642
  FeatureGroupArn: string | undefined;
@@ -1418,23 +1646,28 @@ export interface UpdateFeatureGroupResponse {
1418
1646
  */
1419
1647
  export interface UpdateFeatureMetadataRequest {
1420
1648
  /**
1649
+ * @public
1421
1650
  * <p>The name or Amazon Resource Name (ARN) of the feature group containing the feature that
1422
1651
  * you're updating.</p>
1423
1652
  */
1424
1653
  FeatureGroupName: string | undefined;
1425
1654
  /**
1655
+ * @public
1426
1656
  * <p>The name of the feature that you're updating.</p>
1427
1657
  */
1428
1658
  FeatureName: string | undefined;
1429
1659
  /**
1660
+ * @public
1430
1661
  * <p>A description that you can write to better describe the feature.</p>
1431
1662
  */
1432
1663
  Description?: string;
1433
1664
  /**
1665
+ * @public
1434
1666
  * <p>A list of key-value pairs that you can add to better describe the feature.</p>
1435
1667
  */
1436
1668
  ParameterAdditions?: FeatureParameter[];
1437
1669
  /**
1670
+ * @public
1438
1671
  * <p>A list of parameter keys that you can specify to remove parameters that describe your
1439
1672
  * feature.</p>
1440
1673
  */
@@ -1445,18 +1678,22 @@ export interface UpdateFeatureMetadataRequest {
1445
1678
  */
1446
1679
  export interface UpdateHubRequest {
1447
1680
  /**
1681
+ * @public
1448
1682
  * <p>The name of the hub to update.</p>
1449
1683
  */
1450
1684
  HubName: string | undefined;
1451
1685
  /**
1686
+ * @public
1452
1687
  * <p>A description of the updated hub.</p>
1453
1688
  */
1454
1689
  HubDescription?: string;
1455
1690
  /**
1691
+ * @public
1456
1692
  * <p>The display name of the hub.</p>
1457
1693
  */
1458
1694
  HubDisplayName?: string;
1459
1695
  /**
1696
+ * @public
1460
1697
  * <p>The searchable keywords for the hub.</p>
1461
1698
  */
1462
1699
  HubSearchKeywords?: string[];
@@ -1466,6 +1703,7 @@ export interface UpdateHubRequest {
1466
1703
  */
1467
1704
  export interface UpdateHubResponse {
1468
1705
  /**
1706
+ * @public
1469
1707
  * <p>The Amazon Resource Name (ARN) of the updated hub.</p>
1470
1708
  */
1471
1709
  HubArn: string | undefined;
@@ -1475,23 +1713,28 @@ export interface UpdateHubResponse {
1475
1713
  */
1476
1714
  export interface UpdateImageRequest {
1477
1715
  /**
1716
+ * @public
1478
1717
  * <p>A list of properties to delete. Only the <code>Description</code> and
1479
1718
  * <code>DisplayName</code> properties can be deleted.</p>
1480
1719
  */
1481
1720
  DeleteProperties?: string[];
1482
1721
  /**
1722
+ * @public
1483
1723
  * <p>The new description for the image.</p>
1484
1724
  */
1485
1725
  Description?: string;
1486
1726
  /**
1727
+ * @public
1487
1728
  * <p>The new display name for the image.</p>
1488
1729
  */
1489
1730
  DisplayName?: string;
1490
1731
  /**
1732
+ * @public
1491
1733
  * <p>The name of the image to update.</p>
1492
1734
  */
1493
1735
  ImageName: string | undefined;
1494
1736
  /**
1737
+ * @public
1495
1738
  * <p>The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>
1496
1739
  */
1497
1740
  RoleArn?: string;
@@ -1501,6 +1744,7 @@ export interface UpdateImageRequest {
1501
1744
  */
1502
1745
  export interface UpdateImageResponse {
1503
1746
  /**
1747
+ * @public
1504
1748
  * <p>The ARN of the image.</p>
1505
1749
  */
1506
1750
  ImageArn?: string;
@@ -1510,26 +1754,32 @@ export interface UpdateImageResponse {
1510
1754
  */
1511
1755
  export interface UpdateImageVersionRequest {
1512
1756
  /**
1757
+ * @public
1513
1758
  * <p>The name of the image.</p>
1514
1759
  */
1515
1760
  ImageName: string | undefined;
1516
1761
  /**
1762
+ * @public
1517
1763
  * <p>The alias of the image version.</p>
1518
1764
  */
1519
1765
  Alias?: string;
1520
1766
  /**
1767
+ * @public
1521
1768
  * <p>The version of the image.</p>
1522
1769
  */
1523
1770
  Version?: number;
1524
1771
  /**
1772
+ * @public
1525
1773
  * <p>A list of aliases to add.</p>
1526
1774
  */
1527
1775
  AliasesToAdd?: string[];
1528
1776
  /**
1777
+ * @public
1529
1778
  * <p>A list of aliases to delete.</p>
1530
1779
  */
1531
1780
  AliasesToDelete?: string[];
1532
1781
  /**
1782
+ * @public
1533
1783
  * <p>The availability of the image version specified by the maintainer.</p>
1534
1784
  * <ul>
1535
1785
  * <li>
@@ -1552,6 +1802,7 @@ export interface UpdateImageVersionRequest {
1552
1802
  */
1553
1803
  VendorGuidance?: VendorGuidance | string;
1554
1804
  /**
1805
+ * @public
1555
1806
  * <p>Indicates SageMaker job type compatibility.</p>
1556
1807
  * <ul>
1557
1808
  * <li>
@@ -1570,14 +1821,17 @@ export interface UpdateImageVersionRequest {
1570
1821
  */
1571
1822
  JobType?: JobType | string;
1572
1823
  /**
1824
+ * @public
1573
1825
  * <p>The machine learning framework vended in the image version.</p>
1574
1826
  */
1575
1827
  MLFramework?: string;
1576
1828
  /**
1829
+ * @public
1577
1830
  * <p>The supported programming language and its version.</p>
1578
1831
  */
1579
1832
  ProgrammingLang?: string;
1580
1833
  /**
1834
+ * @public
1581
1835
  * <p>Indicates CPU or GPU compatibility.</p>
1582
1836
  * <ul>
1583
1837
  * <li>
@@ -1592,10 +1846,12 @@ export interface UpdateImageVersionRequest {
1592
1846
  */
1593
1847
  Processor?: Processor | string;
1594
1848
  /**
1849
+ * @public
1595
1850
  * <p>Indicates Horovod compatibility.</p>
1596
1851
  */
1597
1852
  Horovod?: boolean;
1598
1853
  /**
1854
+ * @public
1599
1855
  * <p>The maintainer description of the image version.</p>
1600
1856
  */
1601
1857
  ReleaseNotes?: string;
@@ -1605,6 +1861,7 @@ export interface UpdateImageVersionRequest {
1605
1861
  */
1606
1862
  export interface UpdateImageVersionResponse {
1607
1863
  /**
1864
+ * @public
1608
1865
  * <p>The ARN of the image version.</p>
1609
1866
  */
1610
1867
  ImageVersionArn?: string;
@@ -1614,10 +1871,12 @@ export interface UpdateImageVersionResponse {
1614
1871
  */
1615
1872
  export interface UpdateInferenceExperimentRequest {
1616
1873
  /**
1874
+ * @public
1617
1875
  * <p>The name of the inference experiment to be updated.</p>
1618
1876
  */
1619
1877
  Name: string | undefined;
1620
1878
  /**
1879
+ * @public
1621
1880
  * <p>
1622
1881
  * The duration for which the inference experiment will run. If the status of the inference experiment is
1623
1882
  * <code>Created</code>, then you can update both the start and end dates. If the status of the inference
@@ -1626,10 +1885,12 @@ export interface UpdateInferenceExperimentRequest {
1626
1885
  */
1627
1886
  Schedule?: InferenceExperimentSchedule;
1628
1887
  /**
1888
+ * @public
1629
1889
  * <p>The description of the inference experiment.</p>
1630
1890
  */
1631
1891
  Description?: string;
1632
1892
  /**
1893
+ * @public
1633
1894
  * <p>
1634
1895
  * An array of <code>ModelVariantConfig</code> objects. There is one for each variant, whose infrastructure
1635
1896
  * configuration you want to update.
@@ -1637,10 +1898,12 @@ export interface UpdateInferenceExperimentRequest {
1637
1898
  */
1638
1899
  ModelVariants?: ModelVariantConfig[];
1639
1900
  /**
1901
+ * @public
1640
1902
  * <p>The Amazon S3 location and configuration for storing inference request and response data.</p>
1641
1903
  */
1642
1904
  DataStorageConfig?: InferenceExperimentDataStorageConfig;
1643
1905
  /**
1906
+ * @public
1644
1907
  * <p>
1645
1908
  * The configuration of <code>ShadowMode</code> inference experiment type. Use this field to specify a
1646
1909
  * production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a
@@ -1655,6 +1918,7 @@ export interface UpdateInferenceExperimentRequest {
1655
1918
  */
1656
1919
  export interface UpdateInferenceExperimentResponse {
1657
1920
  /**
1921
+ * @public
1658
1922
  * <p>The ARN of the updated inference experiment.</p>
1659
1923
  */
1660
1924
  InferenceExperimentArn: string | undefined;
@@ -1664,15 +1928,18 @@ export interface UpdateInferenceExperimentResponse {
1664
1928
  */
1665
1929
  export interface UpdateModelCardRequest {
1666
1930
  /**
1931
+ * @public
1667
1932
  * <p>The name of the model card to update.</p>
1668
1933
  */
1669
1934
  ModelCardName: string | undefined;
1670
1935
  /**
1936
+ * @public
1671
1937
  * <p>The updated model card content. Content must be in <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>
1672
1938
  * <p>When updating model card content, be sure to include the full content and not just updated content.</p>
1673
1939
  */
1674
1940
  Content?: string;
1675
1941
  /**
1942
+ * @public
1676
1943
  * <p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p>
1677
1944
  * <ul>
1678
1945
  * <li>
@@ -1701,6 +1968,7 @@ export interface UpdateModelCardRequest {
1701
1968
  */
1702
1969
  export interface UpdateModelCardResponse {
1703
1970
  /**
1971
+ * @public
1704
1972
  * <p>The Amazon Resource Name (ARN) of the updated model card.</p>
1705
1973
  */
1706
1974
  ModelCardArn: string | undefined;
@@ -1710,26 +1978,32 @@ export interface UpdateModelCardResponse {
1710
1978
  */
1711
1979
  export interface UpdateModelPackageInput {
1712
1980
  /**
1981
+ * @public
1713
1982
  * <p>The Amazon Resource Name (ARN) of the model package.</p>
1714
1983
  */
1715
1984
  ModelPackageArn: string | undefined;
1716
1985
  /**
1986
+ * @public
1717
1987
  * <p>The approval status of the model.</p>
1718
1988
  */
1719
1989
  ModelApprovalStatus?: ModelApprovalStatus | string;
1720
1990
  /**
1991
+ * @public
1721
1992
  * <p>A description for the approval status of the model.</p>
1722
1993
  */
1723
1994
  ApprovalDescription?: string;
1724
1995
  /**
1996
+ * @public
1725
1997
  * <p>The metadata properties associated with the model package versions.</p>
1726
1998
  */
1727
1999
  CustomerMetadataProperties?: Record<string, string>;
1728
2000
  /**
2001
+ * @public
1729
2002
  * <p>The metadata properties associated with the model package versions to remove.</p>
1730
2003
  */
1731
2004
  CustomerMetadataPropertiesToRemove?: string[];
1732
2005
  /**
2006
+ * @public
1733
2007
  * <p>An array of additional Inference Specification objects to be added to the
1734
2008
  * existing array additional Inference Specification. Total number of additional
1735
2009
  * Inference Specifications can not exceed 15. Each additional Inference Specification
@@ -1743,6 +2017,7 @@ export interface UpdateModelPackageInput {
1743
2017
  */
1744
2018
  export interface UpdateModelPackageOutput {
1745
2019
  /**
2020
+ * @public
1746
2021
  * <p>The Amazon Resource Name (ARN) of the model.</p>
1747
2022
  */
1748
2023
  ModelPackageArn: string | undefined;
@@ -1752,19 +2027,23 @@ export interface UpdateModelPackageOutput {
1752
2027
  */
1753
2028
  export interface UpdateMonitoringAlertRequest {
1754
2029
  /**
2030
+ * @public
1755
2031
  * <p>The name of a monitoring schedule.</p>
1756
2032
  */
1757
2033
  MonitoringScheduleName: string | undefined;
1758
2034
  /**
2035
+ * @public
1759
2036
  * <p>The name of a monitoring alert.</p>
1760
2037
  */
1761
2038
  MonitoringAlertName: string | undefined;
1762
2039
  /**
2040
+ * @public
1763
2041
  * <p>Within <code>EvaluationPeriod</code>, how many execution failures will raise an
1764
2042
  * alert.</p>
1765
2043
  */
1766
2044
  DatapointsToAlert: number | undefined;
1767
2045
  /**
2046
+ * @public
1768
2047
  * <p>The number of most recent monitoring executions to consider when evaluating alert
1769
2048
  * status.</p>
1770
2049
  */
@@ -1775,10 +2054,12 @@ export interface UpdateMonitoringAlertRequest {
1775
2054
  */
1776
2055
  export interface UpdateMonitoringAlertResponse {
1777
2056
  /**
2057
+ * @public
1778
2058
  * <p>The Amazon Resource Name (ARN) of the monitoring schedule.</p>
1779
2059
  */
1780
2060
  MonitoringScheduleArn: string | undefined;
1781
2061
  /**
2062
+ * @public
1782
2063
  * <p>The name of a monitoring alert.</p>
1783
2064
  */
1784
2065
  MonitoringAlertName?: string;
@@ -1788,11 +2069,13 @@ export interface UpdateMonitoringAlertResponse {
1788
2069
  */
1789
2070
  export interface UpdateMonitoringScheduleRequest {
1790
2071
  /**
2072
+ * @public
1791
2073
  * <p>The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within
1792
2074
  * an Amazon Web Services account.</p>
1793
2075
  */
1794
2076
  MonitoringScheduleName: string | undefined;
1795
2077
  /**
2078
+ * @public
1796
2079
  * <p>The configuration object that specifies the monitoring schedule and defines the
1797
2080
  * monitoring job.</p>
1798
2081
  */
@@ -1803,6 +2086,7 @@ export interface UpdateMonitoringScheduleRequest {
1803
2086
  */
1804
2087
  export interface UpdateMonitoringScheduleResponse {
1805
2088
  /**
2089
+ * @public
1806
2090
  * <p>The Amazon Resource Name (ARN) of the monitoring schedule.</p>
1807
2091
  */
1808
2092
  MonitoringScheduleArn: string | undefined;
@@ -1812,14 +2096,17 @@ export interface UpdateMonitoringScheduleResponse {
1812
2096
  */
1813
2097
  export interface UpdateNotebookInstanceInput {
1814
2098
  /**
2099
+ * @public
1815
2100
  * <p>The name of the notebook instance to update.</p>
1816
2101
  */
1817
2102
  NotebookInstanceName: string | undefined;
1818
2103
  /**
2104
+ * @public
1819
2105
  * <p>The Amazon ML compute instance type.</p>
1820
2106
  */
1821
2107
  InstanceType?: _InstanceType | string;
1822
2108
  /**
2109
+ * @public
1823
2110
  * <p>The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the
1824
2111
  * notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker Roles</a>. </p>
1825
2112
  * <note>
@@ -1829,12 +2116,14 @@ export interface UpdateNotebookInstanceInput {
1829
2116
  */
1830
2117
  RoleArn?: string;
1831
2118
  /**
2119
+ * @public
1832
2120
  * <p>The name of a lifecycle configuration to associate with the notebook instance. For
1833
2121
  * information about lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional)
1834
2122
  * Customize a Notebook Instance</a>.</p>
1835
2123
  */
1836
2124
  LifecycleConfigName?: string;
1837
2125
  /**
2126
+ * @public
1838
2127
  * <p>Set to <code>true</code> to remove the notebook instance lifecycle configuration
1839
2128
  * currently associated with the notebook instance. This operation is idempotent. If you
1840
2129
  * specify a lifecycle configuration that is not associated with the notebook instance when
@@ -1842,6 +2131,7 @@ export interface UpdateNotebookInstanceInput {
1842
2131
  */
1843
2132
  DisassociateLifecycleConfig?: boolean;
1844
2133
  /**
2134
+ * @public
1845
2135
  * <p>The size, in GB, of the ML storage volume to attach to the notebook instance. The
1846
2136
  * default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the
1847
2137
  * amount of available free space on the volume. Because of this, you can increase the
@@ -1851,6 +2141,7 @@ export interface UpdateNotebookInstanceInput {
1851
2141
  */
1852
2142
  VolumeSizeInGB?: number;
1853
2143
  /**
2144
+ * @public
1854
2145
  * <p>The Git repository to associate with the notebook instance as its default code
1855
2146
  * repository. This can be either the name of a Git repository stored as a resource in your
1856
2147
  * 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>
@@ -1860,6 +2151,7 @@ export interface UpdateNotebookInstanceInput {
1860
2151
  */
1861
2152
  DefaultCodeRepository?: string;
1862
2153
  /**
2154
+ * @public
1863
2155
  * <p>An array of up to three Git repositories to associate with the notebook instance.
1864
2156
  * These can be either the names of Git repositories stored as resources in your account,
1865
2157
  * or the URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
@@ -1869,6 +2161,7 @@ export interface UpdateNotebookInstanceInput {
1869
2161
  */
1870
2162
  AdditionalCodeRepositories?: string[];
1871
2163
  /**
2164
+ * @public
1872
2165
  * <p>A list of the Elastic Inference (EI) instance types to associate with this notebook
1873
2166
  * instance. Currently only one EI instance type can be associated with a notebook
1874
2167
  * instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic Inference in
@@ -1876,6 +2169,7 @@ export interface UpdateNotebookInstanceInput {
1876
2169
  */
1877
2170
  AcceleratorTypes?: (NotebookInstanceAcceleratorType | string)[];
1878
2171
  /**
2172
+ * @public
1879
2173
  * <p>A list of the Elastic Inference (EI) instance types to remove from this notebook
1880
2174
  * instance. This operation is idempotent. If you specify an accelerator type that is not
1881
2175
  * associated with the notebook instance when you call this method, it does not throw an
@@ -1883,12 +2177,14 @@ export interface UpdateNotebookInstanceInput {
1883
2177
  */
1884
2178
  DisassociateAcceleratorTypes?: boolean;
1885
2179
  /**
2180
+ * @public
1886
2181
  * <p>The name or URL of the default Git repository to remove from this notebook instance.
1887
2182
  * This operation is idempotent. If you specify a Git repository that is not associated
1888
2183
  * with the notebook instance when you call this method, it does not throw an error.</p>
1889
2184
  */
1890
2185
  DisassociateDefaultCodeRepository?: boolean;
1891
2186
  /**
2187
+ * @public
1892
2188
  * <p>A list of names or URLs of the default Git repositories to remove from this notebook
1893
2189
  * instance. This operation is idempotent. If you specify a Git repository that is not
1894
2190
  * associated with the notebook instance when you call this method, it does not throw an
@@ -1896,6 +2192,7 @@ export interface UpdateNotebookInstanceInput {
1896
2192
  */
1897
2193
  DisassociateAdditionalCodeRepositories?: boolean;
1898
2194
  /**
2195
+ * @public
1899
2196
  * <p>Whether root access is enabled or disabled for users of the notebook instance. The
1900
2197
  * default value is <code>Enabled</code>.</p>
1901
2198
  * <note>
@@ -1906,6 +2203,7 @@ export interface UpdateNotebookInstanceInput {
1906
2203
  */
1907
2204
  RootAccess?: RootAccess | string;
1908
2205
  /**
2206
+ * @public
1909
2207
  * <p>Information on the IMDS configuration of the notebook instance</p>
1910
2208
  */
1911
2209
  InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration;
@@ -1920,15 +2218,18 @@ export interface UpdateNotebookInstanceOutput {
1920
2218
  */
1921
2219
  export interface UpdateNotebookInstanceLifecycleConfigInput {
1922
2220
  /**
2221
+ * @public
1923
2222
  * <p>The name of the lifecycle configuration.</p>
1924
2223
  */
1925
2224
  NotebookInstanceLifecycleConfigName: string | undefined;
1926
2225
  /**
2226
+ * @public
1927
2227
  * <p>The shell script that runs only once, when you create a notebook instance. The shell
1928
2228
  * script must be a base64-encoded string.</p>
1929
2229
  */
1930
2230
  OnCreate?: NotebookInstanceLifecycleHook[];
1931
2231
  /**
2232
+ * @public
1932
2233
  * <p>The shell script that runs every time you start a notebook instance, including when
1933
2234
  * you create the notebook instance. The shell script must be a base64-encoded
1934
2235
  * string.</p>
@@ -1945,31 +2246,38 @@ export interface UpdateNotebookInstanceLifecycleConfigOutput {
1945
2246
  */
1946
2247
  export interface UpdatePipelineRequest {
1947
2248
  /**
2249
+ * @public
1948
2250
  * <p>The name of the pipeline to update.</p>
1949
2251
  */
1950
2252
  PipelineName: string | undefined;
1951
2253
  /**
2254
+ * @public
1952
2255
  * <p>The display name of the pipeline.</p>
1953
2256
  */
1954
2257
  PipelineDisplayName?: string;
1955
2258
  /**
2259
+ * @public
1956
2260
  * <p>The JSON pipeline definition.</p>
1957
2261
  */
1958
2262
  PipelineDefinition?: string;
1959
2263
  /**
2264
+ * @public
1960
2265
  * <p>The location of the pipeline definition stored in Amazon S3. If specified,
1961
2266
  * SageMaker will retrieve the pipeline definition from this location.</p>
1962
2267
  */
1963
2268
  PipelineDefinitionS3Location?: PipelineDefinitionS3Location;
1964
2269
  /**
2270
+ * @public
1965
2271
  * <p>The description of the pipeline.</p>
1966
2272
  */
1967
2273
  PipelineDescription?: string;
1968
2274
  /**
2275
+ * @public
1969
2276
  * <p>The Amazon Resource Name (ARN) that the pipeline uses to execute.</p>
1970
2277
  */
1971
2278
  RoleArn?: string;
1972
2279
  /**
2280
+ * @public
1973
2281
  * <p>If specified, it applies to all executions of this pipeline by default.</p>
1974
2282
  */
1975
2283
  ParallelismConfiguration?: ParallelismConfiguration;
@@ -1979,6 +2287,7 @@ export interface UpdatePipelineRequest {
1979
2287
  */
1980
2288
  export interface UpdatePipelineResponse {
1981
2289
  /**
2290
+ * @public
1982
2291
  * <p>The Amazon Resource Name (ARN) of the updated pipeline.</p>
1983
2292
  */
1984
2293
  PipelineArn?: string;
@@ -1988,18 +2297,22 @@ export interface UpdatePipelineResponse {
1988
2297
  */
1989
2298
  export interface UpdatePipelineExecutionRequest {
1990
2299
  /**
2300
+ * @public
1991
2301
  * <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
1992
2302
  */
1993
2303
  PipelineExecutionArn: string | undefined;
1994
2304
  /**
2305
+ * @public
1995
2306
  * <p>The description of the pipeline execution.</p>
1996
2307
  */
1997
2308
  PipelineExecutionDescription?: string;
1998
2309
  /**
2310
+ * @public
1999
2311
  * <p>The display name of the pipeline execution.</p>
2000
2312
  */
2001
2313
  PipelineExecutionDisplayName?: string;
2002
2314
  /**
2315
+ * @public
2003
2316
  * <p>This configuration, if specified, overrides the parallelism configuration
2004
2317
  * of the parent pipeline for this specific run.</p>
2005
2318
  */
@@ -2010,6 +2323,7 @@ export interface UpdatePipelineExecutionRequest {
2010
2323
  */
2011
2324
  export interface UpdatePipelineExecutionResponse {
2012
2325
  /**
2326
+ * @public
2013
2327
  * <p>The Amazon Resource Name (ARN) of the updated pipeline execution.</p>
2014
2328
  */
2015
2329
  PipelineExecutionArn?: string;
@@ -2022,10 +2336,12 @@ export interface UpdatePipelineExecutionResponse {
2022
2336
  */
2023
2337
  export interface ServiceCatalogProvisioningUpdateDetails {
2024
2338
  /**
2339
+ * @public
2025
2340
  * <p>The ID of the provisioning artifact.</p>
2026
2341
  */
2027
2342
  ProvisioningArtifactId?: string;
2028
2343
  /**
2344
+ * @public
2029
2345
  * <p>A list of key value pairs that you specify when you provision a product.</p>
2030
2346
  */
2031
2347
  ProvisioningParameters?: ProvisioningParameter[];
@@ -2035,14 +2351,17 @@ export interface ServiceCatalogProvisioningUpdateDetails {
2035
2351
  */
2036
2352
  export interface UpdateProjectInput {
2037
2353
  /**
2354
+ * @public
2038
2355
  * <p>The name of the project.</p>
2039
2356
  */
2040
2357
  ProjectName: string | undefined;
2041
2358
  /**
2359
+ * @public
2042
2360
  * <p>The description for the project.</p>
2043
2361
  */
2044
2362
  ProjectDescription?: string;
2045
2363
  /**
2364
+ * @public
2046
2365
  * <p>The product ID and provisioning artifact ID to provision a service catalog.
2047
2366
  * The provisioning artifact ID will default to the latest provisioning artifact
2048
2367
  * ID of the product, if you don't provide the provisioning artifact ID. For more
@@ -2051,6 +2370,7 @@ export interface UpdateProjectInput {
2051
2370
  */
2052
2371
  ServiceCatalogProvisioningUpdateDetails?: ServiceCatalogProvisioningUpdateDetails;
2053
2372
  /**
2373
+ * @public
2054
2374
  * <p>An array of key-value pairs. You can use tags to categorize your
2055
2375
  * Amazon Web Services resources in different ways, for example, by purpose, owner, or
2056
2376
  * environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.
@@ -2065,6 +2385,7 @@ export interface UpdateProjectInput {
2065
2385
  */
2066
2386
  export interface UpdateProjectOutput {
2067
2387
  /**
2388
+ * @public
2068
2389
  * <p>The Amazon Resource Name (ARN) of the project.</p>
2069
2390
  */
2070
2391
  ProjectArn: string | undefined;
@@ -2074,14 +2395,17 @@ export interface UpdateProjectOutput {
2074
2395
  */
2075
2396
  export interface UpdateSpaceRequest {
2076
2397
  /**
2398
+ * @public
2077
2399
  * <p>The ID of the associated Domain.</p>
2078
2400
  */
2079
2401
  DomainId: string | undefined;
2080
2402
  /**
2403
+ * @public
2081
2404
  * <p>The name of the space.</p>
2082
2405
  */
2083
2406
  SpaceName: string | undefined;
2084
2407
  /**
2408
+ * @public
2085
2409
  * <p>A collection of space settings.</p>
2086
2410
  */
2087
2411
  SpaceSettings?: SpaceSettings;
@@ -2091,6 +2415,7 @@ export interface UpdateSpaceRequest {
2091
2415
  */
2092
2416
  export interface UpdateSpaceResponse {
2093
2417
  /**
2418
+ * @public
2094
2419
  * <p>The space's Amazon Resource Name (ARN).</p>
2095
2420
  */
2096
2421
  SpaceArn?: string;
@@ -2100,20 +2425,24 @@ export interface UpdateSpaceResponse {
2100
2425
  */
2101
2426
  export interface UpdateTrainingJobRequest {
2102
2427
  /**
2428
+ * @public
2103
2429
  * <p>The name of a training job to update the Debugger profiling configuration.</p>
2104
2430
  */
2105
2431
  TrainingJobName: string | undefined;
2106
2432
  /**
2433
+ * @public
2107
2434
  * <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and
2108
2435
  * storage paths.</p>
2109
2436
  */
2110
2437
  ProfilerConfig?: ProfilerConfigForUpdate;
2111
2438
  /**
2439
+ * @public
2112
2440
  * <p>Configuration information for Amazon SageMaker Debugger rules for profiling system and framework
2113
2441
  * metrics.</p>
2114
2442
  */
2115
2443
  ProfilerRuleConfigurations?: ProfilerRuleConfiguration[];
2116
2444
  /**
2445
+ * @public
2117
2446
  * <p>The training job <code>ResourceConfig</code> to update warm pool retention
2118
2447
  * length.</p>
2119
2448
  */
@@ -2124,6 +2453,7 @@ export interface UpdateTrainingJobRequest {
2124
2453
  */
2125
2454
  export interface UpdateTrainingJobResponse {
2126
2455
  /**
2456
+ * @public
2127
2457
  * <p>The Amazon Resource Name (ARN) of the training job.</p>
2128
2458
  */
2129
2459
  TrainingJobArn: string | undefined;
@@ -2133,10 +2463,12 @@ export interface UpdateTrainingJobResponse {
2133
2463
  */
2134
2464
  export interface UpdateTrialRequest {
2135
2465
  /**
2466
+ * @public
2136
2467
  * <p>The name of the trial to update.</p>
2137
2468
  */
2138
2469
  TrialName: string | undefined;
2139
2470
  /**
2471
+ * @public
2140
2472
  * <p>The name of the trial as displayed. The name doesn't need to be unique. If
2141
2473
  * <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
2142
2474
  */
@@ -2147,6 +2479,7 @@ export interface UpdateTrialRequest {
2147
2479
  */
2148
2480
  export interface UpdateTrialResponse {
2149
2481
  /**
2482
+ * @public
2150
2483
  * <p>The Amazon Resource Name (ARN) of the trial.</p>
2151
2484
  */
2152
2485
  TrialArn?: string;
@@ -2156,48 +2489,59 @@ export interface UpdateTrialResponse {
2156
2489
  */
2157
2490
  export interface UpdateTrialComponentRequest {
2158
2491
  /**
2492
+ * @public
2159
2493
  * <p>The name of the component to update.</p>
2160
2494
  */
2161
2495
  TrialComponentName: string | undefined;
2162
2496
  /**
2497
+ * @public
2163
2498
  * <p>The name of the component as displayed. The name doesn't need to be unique. If
2164
2499
  * <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is
2165
2500
  * displayed.</p>
2166
2501
  */
2167
2502
  DisplayName?: string;
2168
2503
  /**
2504
+ * @public
2169
2505
  * <p>The new status of the component.</p>
2170
2506
  */
2171
2507
  Status?: TrialComponentStatus;
2172
2508
  /**
2509
+ * @public
2173
2510
  * <p>When the component started.</p>
2174
2511
  */
2175
2512
  StartTime?: Date;
2176
2513
  /**
2514
+ * @public
2177
2515
  * <p>When the component ended.</p>
2178
2516
  */
2179
2517
  EndTime?: Date;
2180
2518
  /**
2519
+ * @public
2181
2520
  * <p>Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.</p>
2182
2521
  */
2183
2522
  Parameters?: Record<string, TrialComponentParameterValue>;
2184
2523
  /**
2524
+ * @public
2185
2525
  * <p>The hyperparameters to remove from the component.</p>
2186
2526
  */
2187
2527
  ParametersToRemove?: string[];
2188
2528
  /**
2529
+ * @public
2189
2530
  * <p>Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.</p>
2190
2531
  */
2191
2532
  InputArtifacts?: Record<string, TrialComponentArtifact>;
2192
2533
  /**
2534
+ * @public
2193
2535
  * <p>The input artifacts to remove from the component.</p>
2194
2536
  */
2195
2537
  InputArtifactsToRemove?: string[];
2196
2538
  /**
2539
+ * @public
2197
2540
  * <p>Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.</p>
2198
2541
  */
2199
2542
  OutputArtifacts?: Record<string, TrialComponentArtifact>;
2200
2543
  /**
2544
+ * @public
2201
2545
  * <p>The output artifacts to remove from the component.</p>
2202
2546
  */
2203
2547
  OutputArtifactsToRemove?: string[];
@@ -2207,6 +2551,7 @@ export interface UpdateTrialComponentRequest {
2207
2551
  */
2208
2552
  export interface UpdateTrialComponentResponse {
2209
2553
  /**
2554
+ * @public
2210
2555
  * <p>The Amazon Resource Name (ARN) of the trial component.</p>
2211
2556
  */
2212
2557
  TrialComponentArn?: string;
@@ -2216,14 +2561,17 @@ export interface UpdateTrialComponentResponse {
2216
2561
  */
2217
2562
  export interface UpdateUserProfileRequest {
2218
2563
  /**
2564
+ * @public
2219
2565
  * <p>The domain ID.</p>
2220
2566
  */
2221
2567
  DomainId: string | undefined;
2222
2568
  /**
2569
+ * @public
2223
2570
  * <p>The user profile name.</p>
2224
2571
  */
2225
2572
  UserProfileName: string | undefined;
2226
2573
  /**
2574
+ * @public
2227
2575
  * <p>A collection of settings.</p>
2228
2576
  */
2229
2577
  UserSettings?: UserSettings;
@@ -2233,6 +2581,7 @@ export interface UpdateUserProfileRequest {
2233
2581
  */
2234
2582
  export interface UpdateUserProfileResponse {
2235
2583
  /**
2584
+ * @public
2236
2585
  * <p>The user profile Amazon Resource Name (ARN).</p>
2237
2586
  */
2238
2587
  UserProfileArn?: string;
@@ -2242,22 +2591,26 @@ export interface UpdateUserProfileResponse {
2242
2591
  */
2243
2592
  export interface UpdateWorkforceRequest {
2244
2593
  /**
2594
+ * @public
2245
2595
  * <p>The name of the private workforce that you want to update. You can find your workforce
2246
2596
  * name by using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html">ListWorkforces</a> operation.</p>
2247
2597
  */
2248
2598
  WorkforceName: string | undefined;
2249
2599
  /**
2600
+ * @public
2250
2601
  * <p>A list of one to ten worker IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>) that can be used to
2251
2602
  * access tasks assigned to this workforce.</p>
2252
2603
  * <p>Maximum: Ten CIDR values</p>
2253
2604
  */
2254
2605
  SourceIpConfig?: SourceIpConfig;
2255
2606
  /**
2607
+ * @public
2256
2608
  * <p>Use this parameter to update your OIDC Identity Provider (IdP)
2257
2609
  * configuration for a workforce made using your own IdP.</p>
2258
2610
  */
2259
2611
  OidcConfig?: OidcConfig;
2260
2612
  /**
2613
+ * @public
2261
2614
  * <p>Use this parameter to update your VPC configuration for a workforce.</p>
2262
2615
  */
2263
2616
  WorkforceVpcConfig?: WorkforceVpcConfigRequest;
@@ -2267,6 +2620,7 @@ export interface UpdateWorkforceRequest {
2267
2620
  */
2268
2621
  export interface UpdateWorkforceResponse {
2269
2622
  /**
2623
+ * @public
2270
2624
  * <p>A single private workforce. You can create one private work force in each Amazon Web Services Region. By default,
2271
2625
  * any workforce-related API operation used in a specific region will apply to the
2272
2626
  * workforce created in that region. To learn how to create a private workforce, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html">Create a Private Workforce</a>.</p>
@@ -2278,10 +2632,12 @@ export interface UpdateWorkforceResponse {
2278
2632
  */
2279
2633
  export interface UpdateWorkteamRequest {
2280
2634
  /**
2635
+ * @public
2281
2636
  * <p>The name of the work team to update.</p>
2282
2637
  */
2283
2638
  WorkteamName: string | undefined;
2284
2639
  /**
2640
+ * @public
2285
2641
  * <p>A list of <code>MemberDefinition</code> objects that contains objects that identify
2286
2642
  * the workers that make up the work team. </p>
2287
2643
  * <p>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP).
@@ -2305,10 +2661,12 @@ export interface UpdateWorkteamRequest {
2305
2661
  */
2306
2662
  MemberDefinitions?: MemberDefinition[];
2307
2663
  /**
2664
+ * @public
2308
2665
  * <p>An updated description for the work team.</p>
2309
2666
  */
2310
2667
  Description?: string;
2311
2668
  /**
2669
+ * @public
2312
2670
  * <p>Configures SNS topic notifications for available or expiring work items</p>
2313
2671
  */
2314
2672
  NotificationConfiguration?: NotificationConfiguration;
@@ -2318,6 +2676,7 @@ export interface UpdateWorkteamRequest {
2318
2676
  */
2319
2677
  export interface UpdateWorkteamResponse {
2320
2678
  /**
2679
+ * @public
2321
2680
  * <p>A <code>Workteam</code> object that describes the updated work team.</p>
2322
2681
  */
2323
2682
  Workteam: Workteam | undefined;
@@ -2352,18 +2711,22 @@ export interface UpdateWorkteamResponse {
2352
2711
  */
2353
2712
  export interface SearchExpression {
2354
2713
  /**
2714
+ * @public
2355
2715
  * <p>A list of filter objects.</p>
2356
2716
  */
2357
2717
  Filters?: Filter[];
2358
2718
  /**
2719
+ * @public
2359
2720
  * <p>A list of nested filter objects.</p>
2360
2721
  */
2361
2722
  NestedFilters?: NestedFilters[];
2362
2723
  /**
2724
+ * @public
2363
2725
  * <p>A list of search expression objects.</p>
2364
2726
  */
2365
2727
  SubExpressions?: SearchExpression[];
2366
2728
  /**
2729
+ * @public
2367
2730
  * <p>A Boolean operator used to evaluate the search expression. If you want every
2368
2731
  * conditional statement in all lists to be satisfied for the entire search expression to
2369
2732
  * be true, specify <code>And</code>. If only a single conditional statement needs to be
@@ -2377,10 +2740,12 @@ export interface SearchExpression {
2377
2740
  */
2378
2741
  export interface SearchRequest {
2379
2742
  /**
2743
+ * @public
2380
2744
  * <p>The name of the SageMaker resource to search for.</p>
2381
2745
  */
2382
2746
  Resource: ResourceType | string | undefined;
2383
2747
  /**
2748
+ * @public
2384
2749
  * <p>A Boolean conditional statement. Resources must satisfy this condition to be
2385
2750
  * included in search results. You must provide at least one subexpression, filter, or
2386
2751
  * nested filter. The maximum number of recursive <code>SubExpressions</code>,
@@ -2389,16 +2754,19 @@ export interface SearchRequest {
2389
2754
  */
2390
2755
  SearchExpression?: SearchExpression;
2391
2756
  /**
2757
+ * @public
2392
2758
  * <p>The name of the resource property used to sort the <code>SearchResults</code>. The
2393
2759
  * default is <code>LastModifiedTime</code>.</p>
2394
2760
  */
2395
2761
  SortBy?: string;
2396
2762
  /**
2763
+ * @public
2397
2764
  * <p>How <code>SearchResults</code> are ordered. Valid values are <code>Ascending</code> or
2398
2765
  * <code>Descending</code>. The default is <code>Descending</code>.</p>
2399
2766
  */
2400
2767
  SortOrder?: SearchSortOrder | string;
2401
2768
  /**
2769
+ * @public
2402
2770
  * <p>If more than <code>MaxResults</code> resources match the specified
2403
2771
  * <code>SearchExpression</code>, the response includes a
2404
2772
  * <code>NextToken</code>. The <code>NextToken</code> can be passed to the next
@@ -2406,10 +2774,12 @@ export interface SearchRequest {
2406
2774
  */
2407
2775
  NextToken?: string;
2408
2776
  /**
2777
+ * @public
2409
2778
  * <p>The maximum number of results to return.</p>
2410
2779
  */
2411
2780
  MaxResults?: number;
2412
2781
  /**
2782
+ * @public
2413
2783
  * <p>
2414
2784
  * A cross account filter option. When the value is <code>"CrossAccount"</code> the
2415
2785
  * search results will only include resources made discoverable to you from other