aws-sdk-sagemaker 1.173.0 → 1.175.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -257,17 +257,18 @@ module Aws::SageMaker
257
257
  include Aws::Structure
258
258
  end
259
259
 
260
- # Specifies the training algorithm to use in a CreateTrainingJob
260
+ # Specifies the training algorithm to use in a [CreateTrainingJob][1]
261
261
  # request.
262
262
  #
263
263
  # For more information about algorithms provided by SageMaker, see
264
- # [Algorithms][1]. For information about using your own algorithms, see
265
- # [Using Your Own Algorithms with Amazon SageMaker][2].
264
+ # [Algorithms][2]. For information about using your own algorithms, see
265
+ # [Using Your Own Algorithms with Amazon SageMaker][3].
266
266
  #
267
267
  #
268
268
  #
269
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html
270
- # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html
269
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
270
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html
271
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html
271
272
  #
272
273
  # @!attribute [rw] training_image
273
274
  # The registry path of the Docker image that contains the training
@@ -382,11 +383,12 @@ module Aws::SageMaker
382
383
  #
383
384
  # * PyTorch (version >= 1.3)
384
385
  #
385
- # * You specify at least one MetricDefinition
386
+ # * You specify at least one [MetricDefinition][2]
386
387
  #
387
388
  #
388
389
  #
389
390
  # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/pre-built-containers-frameworks-deep-learning.html
391
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html
390
392
  # @return [Boolean]
391
393
  #
392
394
  # @!attribute [rw] container_entrypoint
@@ -1556,6 +1558,11 @@ module Aws::SageMaker
1556
1558
  # @!attribute [rw] include_inference_response_in
1557
1559
  # The Amazon SNS topics where you want the inference response to be
1558
1560
  # included.
1561
+ #
1562
+ # <note markdown="1"> The inference response is included only if the response size is less
1563
+ # than or equal to 128 KB.
1564
+ #
1565
+ # </note>
1559
1566
  # @return [Array<String>]
1560
1567
  #
1561
1568
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AsyncInferenceNotificationConfig AWS API Documentation
@@ -3020,16 +3027,21 @@ module Aws::SageMaker
3020
3027
  include Aws::Structure
3021
3028
  end
3022
3029
 
3023
- # The SageMaker Canvas app settings.
3030
+ # The SageMaker Canvas application settings.
3024
3031
  #
3025
3032
  # @!attribute [rw] time_series_forecasting_settings
3026
- # Time series forecast settings for the Canvas app.
3033
+ # Time series forecast settings for the Canvas application.
3027
3034
  # @return [Types::TimeSeriesForecastingSettings]
3028
3035
  #
3036
+ # @!attribute [rw] model_register_settings
3037
+ # The model registry settings for the SageMaker Canvas application.
3038
+ # @return [Types::ModelRegisterSettings]
3039
+ #
3029
3040
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CanvasAppSettings AWS API Documentation
3030
3041
  #
3031
3042
  class CanvasAppSettings < Struct.new(
3032
- :time_series_forecasting_settings)
3043
+ :time_series_forecasting_settings,
3044
+ :model_register_settings)
3033
3045
  SENSITIVE = []
3034
3046
  include Aws::Structure
3035
3047
  end
@@ -3189,15 +3201,19 @@ module Aws::SageMaker
3189
3201
  # (Optional) The input mode to use for the data channel in a training
3190
3202
  # job. If you don't set a value for `InputMode`, SageMaker uses the
3191
3203
  # value set for `TrainingInputMode`. Use this parameter to override
3192
- # the `TrainingInputMode` setting in a AlgorithmSpecification request
3193
- # when you have a channel that needs a different input mode from the
3194
- # training job's general setting. To download the data from Amazon
3195
- # Simple Storage Service (Amazon S3) to the provisioned ML storage
3196
- # volume, and mount the directory to a Docker volume, use `File` input
3197
- # mode. To stream data directly from Amazon S3 to the container,
3198
- # choose `Pipe` input mode.
3204
+ # the `TrainingInputMode` setting in a [AlgorithmSpecification][1]
3205
+ # request when you have a channel that needs a different input mode
3206
+ # from the training job's general setting. To download the data from
3207
+ # Amazon Simple Storage Service (Amazon S3) to the provisioned ML
3208
+ # storage volume, and mount the directory to a Docker volume, use
3209
+ # `File` input mode. To stream data directly from Amazon S3 to the
3210
+ # container, choose `Pipe` input mode.
3199
3211
  #
3200
3212
  # To use a model for incremental training, choose `File` input model.
3213
+ #
3214
+ #
3215
+ #
3216
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html
3201
3217
  # @return [String]
3202
3218
  #
3203
3219
  # @!attribute [rw] shuffle_config
@@ -4847,14 +4863,15 @@ module Aws::SageMaker
4847
4863
  # @return [Types::OutputConfig]
4848
4864
  #
4849
4865
  # @!attribute [rw] vpc_config
4850
- # A VpcConfig object that specifies the VPC that you want your
4866
+ # A [VpcConfig][1] object that specifies the VPC that you want your
4851
4867
  # compilation job to connect to. Control access to your models by
4852
4868
  # configuring the VPC. For more information, see [Protect Compilation
4853
- # Jobs by Using an Amazon Virtual Private Cloud][1].
4869
+ # Jobs by Using an Amazon Virtual Private Cloud][2].
4854
4870
  #
4855
4871
  #
4856
4872
  #
4857
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html
4873
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
4874
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html
4858
4875
  # @return [Types::NeoVpcConfig]
4859
4876
  #
4860
4877
  # @!attribute [rw] stopping_condition
@@ -5306,7 +5323,11 @@ module Aws::SageMaker
5306
5323
 
5307
5324
  # @!attribute [rw] endpoint_config_name
5308
5325
  # The name of the endpoint configuration. You specify this name in a
5309
- # CreateEndpoint request.
5326
+ # [CreateEndpoint][1] request.
5327
+ #
5328
+ #
5329
+ #
5330
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html
5310
5331
  # @return [String]
5311
5332
  #
5312
5333
  # @!attribute [rw] production_variants
@@ -5430,12 +5451,20 @@ module Aws::SageMaker
5430
5451
  # The name of the endpoint.The name must be unique within an Amazon
5431
5452
  # Web Services Region in your Amazon Web Services account. The name is
5432
5453
  # case-insensitive in `CreateEndpoint`, but the case is preserved and
5433
- # must be matched in .
5454
+ # must be matched in [InvokeEndpoint][1].
5455
+ #
5456
+ #
5457
+ #
5458
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html
5434
5459
  # @return [String]
5435
5460
  #
5436
5461
  # @!attribute [rw] endpoint_config_name
5437
5462
  # The name of an endpoint configuration. For more information, see
5438
- # CreateEndpointConfig.
5463
+ # [CreateEndpointConfig][1].
5464
+ #
5465
+ #
5466
+ #
5467
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html
5439
5468
  # @return [String]
5440
5469
  #
5441
5470
  # @!attribute [rw] deployment_config
@@ -5493,8 +5522,12 @@ module Aws::SageMaker
5493
5522
  # @return [String]
5494
5523
  #
5495
5524
  # @!attribute [rw] tags
5496
- # A list of tags to associate with the experiment. You can use Search
5497
- # API to search on the tags.
5525
+ # A list of tags to associate with the experiment. You can use
5526
+ # [Search][1] API to search on the tags.
5527
+ #
5528
+ #
5529
+ #
5530
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
5498
5531
  # @return [Array<Types::Tag>]
5499
5532
  #
5500
5533
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateExperimentRequest AWS API Documentation
@@ -5587,11 +5620,12 @@ module Aws::SageMaker
5587
5620
  #
5588
5621
  # @!attribute [rw] online_store_config
5589
5622
  # You can turn the `OnlineStore` on or off by specifying `True` for
5590
- # the `EnableOnlineStore` flag in `OnlineStoreConfig`; the default
5591
- # value is `False`.
5623
+ # the `EnableOnlineStore` flag in `OnlineStoreConfig`.
5592
5624
  #
5593
5625
  # You can also include an Amazon Web Services KMS key ID (`KMSKeyId`)
5594
5626
  # for at-rest encryption of the `OnlineStore`.
5627
+ #
5628
+ # The default value is `False`.
5595
5629
  # @return [Types::OnlineStoreConfig]
5596
5630
  #
5597
5631
  # @!attribute [rw] offline_store_config
@@ -5613,12 +5647,13 @@ module Aws::SageMaker
5613
5647
  # * Format for the offline store table. Supported formats are Glue
5614
5648
  # (Default) and [Apache Iceberg][2].
5615
5649
  #
5616
- # To learn more about this parameter, see OfflineStoreConfig.
5650
+ # To learn more about this parameter, see [OfflineStoreConfig][3].
5617
5651
  #
5618
5652
  #
5619
5653
  #
5620
5654
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html
5621
5655
  # [2]: https://iceberg.apache.org/
5656
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html
5622
5657
  # @return [Types::OfflineStoreConfig]
5623
5658
  #
5624
5659
  # @!attribute [rw] role_arn
@@ -5823,27 +5858,36 @@ module Aws::SageMaker
5823
5858
  # @return [String]
5824
5859
  #
5825
5860
  # @!attribute [rw] hyper_parameter_tuning_job_config
5826
- # The HyperParameterTuningJobConfig object that describes the tuning
5827
- # job, including the search strategy, the objective metric used to
5828
- # evaluate training jobs, ranges of parameters to search, and resource
5829
- # limits for the tuning job. For more information, see [How
5830
- # Hyperparameter Tuning Works][1].
5861
+ # The [HyperParameterTuningJobConfig][1] object that describes the
5862
+ # tuning job, including the search strategy, the objective metric used
5863
+ # to evaluate training jobs, ranges of parameters to search, and
5864
+ # resource limits for the tuning job. For more information, see [How
5865
+ # Hyperparameter Tuning Works][2].
5831
5866
  #
5832
5867
  #
5833
5868
  #
5834
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html
5869
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html
5870
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html
5835
5871
  # @return [Types::HyperParameterTuningJobConfig]
5836
5872
  #
5837
5873
  # @!attribute [rw] training_job_definition
5838
- # The HyperParameterTrainingJobDefinition object that describes the
5839
- # training jobs that this tuning job launches, including static
5874
+ # The [HyperParameterTrainingJobDefinition][1] object that describes
5875
+ # the training jobs that this tuning job launches, including static
5840
5876
  # hyperparameters, input data configuration, output data
5841
5877
  # configuration, resource configuration, and stopping condition.
5878
+ #
5879
+ #
5880
+ #
5881
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html
5842
5882
  # @return [Types::HyperParameterTrainingJobDefinition]
5843
5883
  #
5844
5884
  # @!attribute [rw] training_job_definitions
5845
- # A list of the HyperParameterTrainingJobDefinition objects launched
5846
- # for this tuning job.
5885
+ # A list of the [HyperParameterTrainingJobDefinition][1] objects
5886
+ # launched for this tuning job.
5887
+ #
5888
+ #
5889
+ #
5890
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html
5847
5891
  # @return [Array<Types::HyperParameterTrainingJobDefinition>]
5848
5892
  #
5849
5893
  # @!attribute [rw] warm_start_config
@@ -6221,7 +6265,10 @@ module Aws::SageMaker
6221
6265
  # @!attribute [rw] job_name
6222
6266
  # A name for the recommendation job. The name must be unique within
6223
6267
  # the Amazon Web Services Region and within your Amazon Web Services
6224
- # account.
6268
+ # account. The job name is passed down to the resources created by the
6269
+ # recommendation job. The names of resources (such as the model,
6270
+ # endpoint configuration, endpoint, and compilation) that are prefixed
6271
+ # with the job name are truncated at 40 characters.
6225
6272
  # @return [String]
6226
6273
  #
6227
6274
  # @!attribute [rw] job_type
@@ -6642,7 +6689,7 @@ module Aws::SageMaker
6642
6689
  #
6643
6690
  #
6644
6691
  #
6645
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html
6692
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema
6646
6693
  # @return [String]
6647
6694
  #
6648
6695
  # @!attribute [rw] model_card_status
@@ -6817,17 +6864,18 @@ module Aws::SageMaker
6817
6864
  # @return [Array<Types::Tag>]
6818
6865
  #
6819
6866
  # @!attribute [rw] vpc_config
6820
- # A VpcConfig object that specifies the VPC that you want your model
6821
- # to connect to. Control access to and from your model container by
6822
- # configuring the VPC. `VpcConfig` is used in hosting services and in
6823
- # batch transform. For more information, see [Protect Endpoints by
6824
- # Using an Amazon Virtual Private Cloud][1] and [Protect Data in Batch
6825
- # Transform Jobs by Using an Amazon Virtual Private Cloud][2].
6867
+ # A [VpcConfig][1] object that specifies the VPC that you want your
6868
+ # model to connect to. Control access to and from your model container
6869
+ # by configuring the VPC. `VpcConfig` is used in hosting services and
6870
+ # in batch transform. For more information, see [Protect Endpoints by
6871
+ # Using an Amazon Virtual Private Cloud][2] and [Protect Data in Batch
6872
+ # Transform Jobs by Using an Amazon Virtual Private Cloud][3].
6826
6873
  #
6827
6874
  #
6828
6875
  #
6829
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html
6830
- # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html
6876
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
6877
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html
6878
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html
6831
6879
  # @return [Types::VpcConfig]
6832
6880
  #
6833
6881
  # @!attribute [rw] enable_network_isolation
@@ -7631,11 +7679,17 @@ module Aws::SageMaker
7631
7679
  # Associates a SageMaker job as a trial component with an experiment
7632
7680
  # and trial. Specified when you call the following APIs:
7633
7681
  #
7634
- # * CreateProcessingJob
7682
+ # * [CreateProcessingJob][1]
7635
7683
  #
7636
- # * CreateTrainingJob
7684
+ # * [CreateTrainingJob][2]
7637
7685
  #
7638
- # * CreateTransformJob
7686
+ # * [CreateTransformJob][3]
7687
+ #
7688
+ #
7689
+ #
7690
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
7691
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
7692
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
7639
7693
  # @return [Types::ExperimentConfig]
7640
7694
  #
7641
7695
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateProcessingJobRequest AWS API Documentation
@@ -7908,14 +7962,15 @@ module Aws::SageMaker
7908
7962
  # @return [Types::ResourceConfig]
7909
7963
  #
7910
7964
  # @!attribute [rw] vpc_config
7911
- # A VpcConfig object that specifies the VPC that you want your
7965
+ # A [VpcConfig][1] object that specifies the VPC that you want your
7912
7966
  # training job to connect to. Control access to and from your training
7913
7967
  # container by configuring the VPC. For more information, see [Protect
7914
- # Training Jobs by Using an Amazon Virtual Private Cloud][1].
7968
+ # Training Jobs by Using an Amazon Virtual Private Cloud][2].
7915
7969
  #
7916
7970
  #
7917
7971
  #
7918
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html
7972
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
7973
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html
7919
7974
  # @return [Types::VpcConfig]
7920
7975
  #
7921
7976
  # @!attribute [rw] stopping_condition
@@ -8011,11 +8066,17 @@ module Aws::SageMaker
8011
8066
  # Associates a SageMaker job as a trial component with an experiment
8012
8067
  # and trial. Specified when you call the following APIs:
8013
8068
  #
8014
- # * CreateProcessingJob
8069
+ # * [CreateProcessingJob][1]
8070
+ #
8071
+ # * [CreateTrainingJob][2]
8015
8072
  #
8016
- # * CreateTrainingJob
8073
+ # * [CreateTransformJob][3]
8017
8074
  #
8018
- # * CreateTransformJob
8075
+ #
8076
+ #
8077
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
8078
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
8079
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
8019
8080
  # @return [Types::ExperimentConfig]
8020
8081
  #
8021
8082
  # @!attribute [rw] profiler_config
@@ -8200,11 +8261,17 @@ module Aws::SageMaker
8200
8261
  # Associates a SageMaker job as a trial component with an experiment
8201
8262
  # and trial. Specified when you call the following APIs:
8202
8263
  #
8203
- # * CreateProcessingJob
8264
+ # * [CreateProcessingJob][1]
8265
+ #
8266
+ # * [CreateTrainingJob][2]
8267
+ #
8268
+ # * [CreateTransformJob][3]
8269
+ #
8204
8270
  #
8205
- # * CreateTrainingJob
8206
8271
  #
8207
- # * CreateTransformJob
8272
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
8273
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
8274
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
8208
8275
  # @return [Types::ExperimentConfig]
8209
8276
  #
8210
8277
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateTransformJobRequest AWS API Documentation
@@ -8290,8 +8357,12 @@ module Aws::SageMaker
8290
8357
  # @return [Types::MetadataProperties]
8291
8358
  #
8292
8359
  # @!attribute [rw] tags
8293
- # A list of tags to associate with the component. You can use Search
8294
- # API to search on the tags.
8360
+ # A list of tags to associate with the component. You can use
8361
+ # [Search][1] API to search on the tags.
8362
+ #
8363
+ #
8364
+ #
8365
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
8295
8366
  # @return [Array<Types::Tag>]
8296
8367
  #
8297
8368
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateTrialComponentRequest AWS API Documentation
@@ -8343,8 +8414,12 @@ module Aws::SageMaker
8343
8414
  # @return [Types::MetadataProperties]
8344
8415
  #
8345
8416
  # @!attribute [rw] tags
8346
- # A list of tags to associate with the trial. You can use Search API
8347
- # to search on the tags.
8417
+ # A list of tags to associate with the trial. You can use [Search][1]
8418
+ # API to search on the tags.
8419
+ #
8420
+ #
8421
+ #
8422
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
8348
8423
  # @return [Array<Types::Tag>]
8349
8424
  #
8350
8425
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateTrialRequest AWS API Documentation
@@ -9111,11 +9186,11 @@ module Aws::SageMaker
9111
9186
  # A collection of settings that apply to spaces created in the Domain.
9112
9187
  #
9113
9188
  # @!attribute [rw] execution_role
9114
- # The execution role for the space.
9189
+ # The ARN of the execution role for the space.
9115
9190
  # @return [String]
9116
9191
  #
9117
9192
  # @!attribute [rw] security_groups
9118
- # The security groups for the Amazon Virtual Private Cloud that the
9193
+ # The security group IDs for the Amazon Virtual Private Cloud that the
9119
9194
  # space uses for communication.
9120
9195
  # @return [Array<String>]
9121
9196
  #
@@ -9933,19 +10008,20 @@ module Aws::SageMaker
9933
10008
  end
9934
10009
 
9935
10010
  # Gets the Amazon EC2 Container Registry path of the docker image of the
9936
- # model that is hosted in this ProductionVariant.
10011
+ # model that is hosted in this [ProductionVariant][1].
9937
10012
  #
9938
10013
  # If you used the `registry/repository[:tag]` form to specify the image
9939
10014
  # path of the primary container when you created the model hosted in
9940
10015
  # this `ProductionVariant`, the path resolves to a path of the form
9941
10016
  # `registry/repository[@digest]`. A digest is a hash value that
9942
10017
  # identifies a specific version of an image. For information about
9943
- # Amazon ECR paths, see [Pulling an Image][1] in the *Amazon ECR User
10018
+ # Amazon ECR paths, see [Pulling an Image][2] in the *Amazon ECR User
9944
10019
  # Guide*.
9945
10020
  #
9946
10021
  #
9947
10022
  #
9948
- # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html
10023
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html
10024
+ # [2]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html
9949
10025
  #
9950
10026
  # @!attribute [rw] specified_image
9951
10027
  # The image path you specified when you created the model.
@@ -10796,10 +10872,10 @@ module Aws::SageMaker
10796
10872
  # instances.
10797
10873
  #
10798
10874
  # You are billed for the time between this timestamp and the timestamp
10799
- # in the DescribeCompilationJobResponse$CompilationEndTime field. In
10800
- # Amazon CloudWatch Logs, the start time might be later than this
10801
- # time. That's because it takes time to download the compilation job,
10802
- # which depends on the size of the compilation job container.
10875
+ # in the `CompilationEndTime` field. In Amazon CloudWatch Logs, the
10876
+ # start time might be later than this time. That's because it takes
10877
+ # time to download the compilation job, which depends on the size of
10878
+ # the compilation job container.
10803
10879
  # @return [Time]
10804
10880
  #
10805
10881
  # @!attribute [rw] compilation_end_time
@@ -10865,14 +10941,15 @@ module Aws::SageMaker
10865
10941
  # @return [Types::OutputConfig]
10866
10942
  #
10867
10943
  # @!attribute [rw] vpc_config
10868
- # A VpcConfig object that specifies the VPC that you want your
10944
+ # A [VpcConfig][1] object that specifies the VPC that you want your
10869
10945
  # compilation job to connect to. Control access to your models by
10870
10946
  # configuring the VPC. For more information, see [Protect Compilation
10871
- # Jobs by Using an Amazon Virtual Private Cloud][1].
10947
+ # Jobs by Using an Amazon Virtual Private Cloud][2].
10872
10948
  #
10873
10949
  #
10874
10950
  #
10875
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html
10951
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
10952
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html
10876
10953
  # @return [Types::NeoVpcConfig]
10877
10954
  #
10878
10955
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeCompilationJobResponse AWS API Documentation
@@ -11627,8 +11704,12 @@ module Aws::SageMaker
11627
11704
  # @return [String]
11628
11705
  #
11629
11706
  # @!attribute [rw] production_variants
11630
- # An array of ProductionVariantSummary objects, one for each model
11631
- # hosted behind this endpoint.
11707
+ # An array of [ProductionVariantSummary][1] objects, one for each
11708
+ # model hosted behind this endpoint.
11709
+ #
11710
+ #
11711
+ #
11712
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html
11632
11713
  # @return [Array<Types::ProductionVariantSummary>]
11633
11714
  #
11634
11715
  # @!attribute [rw] data_capture_config
@@ -11642,10 +11723,10 @@ module Aws::SageMaker
11642
11723
  # * `OutOfService`: Endpoint is not available to take incoming
11643
11724
  # requests.
11644
11725
  #
11645
- # * `Creating`: CreateEndpoint is executing.
11726
+ # * `Creating`: [CreateEndpoint][1] is executing.
11646
11727
  #
11647
- # * `Updating`: UpdateEndpoint or UpdateEndpointWeightsAndCapacities
11648
- # is executing.
11728
+ # * `Updating`: [UpdateEndpoint][2] or
11729
+ # [UpdateEndpointWeightsAndCapacities][3] is executing.
11649
11730
  #
11650
11731
  # * `SystemUpdating`: Endpoint is undergoing maintenance and cannot be
11651
11732
  # updated or deleted or re-scaled until it has completed. This
@@ -11659,17 +11740,26 @@ module Aws::SageMaker
11659
11740
  # returns to an `InService` status. This transitional status only
11660
11741
  # applies to an endpoint that has autoscaling enabled and is
11661
11742
  # undergoing variant weight or capacity changes as part of an
11662
- # UpdateEndpointWeightsAndCapacities call or when the
11663
- # UpdateEndpointWeightsAndCapacities operation is called explicitly.
11743
+ # [UpdateEndpointWeightsAndCapacities][3] call or when the
11744
+ # [UpdateEndpointWeightsAndCapacities][3] operation is called
11745
+ # explicitly.
11664
11746
  #
11665
11747
  # * `InService`: Endpoint is available to process incoming requests.
11666
11748
  #
11667
- # * `Deleting`: DeleteEndpoint is executing.
11749
+ # * `Deleting`: [DeleteEndpoint][4] is executing.
11668
11750
  #
11669
11751
  # * `Failed`: Endpoint could not be created, updated, or re-scaled.
11670
- # Use DescribeEndpointOutput$FailureReason for information about the
11671
- # failure. DeleteEndpoint is the only operation that can be
11672
- # performed on a failed endpoint.
11752
+ # Use the `FailureReason` value returned by [DescribeEndpoint][5]
11753
+ # for information about the failure. [DeleteEndpoint][4] is the only
11754
+ # operation that can be performed on a failed endpoint.
11755
+ #
11756
+ #
11757
+ #
11758
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html
11759
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html
11760
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html
11761
+ # [4]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html
11762
+ # [5]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html
11673
11763
  # @return [String]
11674
11764
  #
11675
11765
  # @!attribute [rw] failure_reason
@@ -11708,10 +11798,14 @@ module Aws::SageMaker
11708
11798
  # @return [Types::ExplainerConfig]
11709
11799
  #
11710
11800
  # @!attribute [rw] shadow_production_variants
11711
- # An array of ProductionVariantSummary objects, one for each model
11712
- # that you want to host at this endpoint in shadow mode with
11801
+ # An array of [ProductionVariantSummary][1] objects, one for each
11802
+ # model that you want to host at this endpoint in shadow mode with
11713
11803
  # production traffic replicated from the model specified on
11714
11804
  # `ProductionVariants`.
11805
+ #
11806
+ #
11807
+ #
11808
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html
11715
11809
  # @return [Array<Types::ProductionVariantSummary>]
11716
11810
  #
11717
11811
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeEndpointOutput AWS API Documentation
@@ -12337,18 +12431,30 @@ module Aws::SageMaker
12337
12431
  # @return [String]
12338
12432
  #
12339
12433
  # @!attribute [rw] hyper_parameter_tuning_job_config
12340
- # The HyperParameterTuningJobConfig object that specifies the
12434
+ # The [HyperParameterTuningJobConfig][1] object that specifies the
12341
12435
  # configuration of the tuning job.
12436
+ #
12437
+ #
12438
+ #
12439
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html
12342
12440
  # @return [Types::HyperParameterTuningJobConfig]
12343
12441
  #
12344
12442
  # @!attribute [rw] training_job_definition
12345
- # The HyperParameterTrainingJobDefinition object that specifies the
12346
- # definition of the training jobs that this tuning job launches.
12443
+ # The [HyperParameterTrainingJobDefinition][1] object that specifies
12444
+ # the definition of the training jobs that this tuning job launches.
12445
+ #
12446
+ #
12447
+ #
12448
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html
12347
12449
  # @return [Types::HyperParameterTrainingJobDefinition]
12348
12450
  #
12349
12451
  # @!attribute [rw] training_job_definitions
12350
- # A list of the HyperParameterTrainingJobDefinition objects launched
12351
- # for this tuning job.
12452
+ # A list of the [HyperParameterTrainingJobDefinition][1] objects
12453
+ # launched for this tuning job.
12454
+ #
12455
+ #
12456
+ #
12457
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html
12352
12458
  # @return [Array<Types::HyperParameterTrainingJobDefinition>]
12353
12459
  #
12354
12460
  # @!attribute [rw] hyper_parameter_tuning_job_status
@@ -12369,27 +12475,46 @@ module Aws::SageMaker
12369
12475
  # @return [Time]
12370
12476
  #
12371
12477
  # @!attribute [rw] training_job_status_counters
12372
- # The TrainingJobStatusCounters object that specifies the number of
12373
- # training jobs, categorized by status, that this tuning job launched.
12478
+ # The [TrainingJobStatusCounters][1] object that specifies the number
12479
+ # of training jobs, categorized by status, that this tuning job
12480
+ # launched.
12481
+ #
12482
+ #
12483
+ #
12484
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html
12374
12485
  # @return [Types::TrainingJobStatusCounters]
12375
12486
  #
12376
12487
  # @!attribute [rw] objective_status_counters
12377
- # The ObjectiveStatusCounters object that specifies the number of
12488
+ # The [ObjectiveStatusCounters][1] object that specifies the number of
12378
12489
  # training jobs, categorized by the status of their final objective
12379
12490
  # metric, that this tuning job launched.
12491
+ #
12492
+ #
12493
+ #
12494
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html
12380
12495
  # @return [Types::ObjectiveStatusCounters]
12381
12496
  #
12382
12497
  # @!attribute [rw] best_training_job
12383
- # A TrainingJobSummary object that describes the training job that
12384
- # completed with the best current HyperParameterTuningJobObjective.
12498
+ # A [TrainingJobSummary][1] object that describes the training job
12499
+ # that completed with the best current
12500
+ # [HyperParameterTuningJobObjective][2].
12501
+ #
12502
+ #
12503
+ #
12504
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html
12505
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html
12385
12506
  # @return [Types::HyperParameterTrainingJobSummary]
12386
12507
  #
12387
12508
  # @!attribute [rw] overall_best_training_job
12388
12509
  # If the hyperparameter tuning job is an warm start tuning job with a
12389
12510
  # `WarmStartType` of `IDENTICAL_DATA_AND_ALGORITHM`, this is the
12390
- # TrainingJobSummary for the training job with the best objective
12511
+ # [TrainingJobSummary][1] for the training job with the best objective
12391
12512
  # metric value of all training jobs launched by this tuning job and
12392
12513
  # all parent jobs specified for the warm start tuning job.
12514
+ #
12515
+ #
12516
+ #
12517
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html
12393
12518
  # @return [Types::HyperParameterTrainingJobSummary]
12394
12519
  #
12395
12520
  # @!attribute [rw] warm_start_config
@@ -12692,14 +12817,22 @@ module Aws::SageMaker
12692
12817
  # * `Completed` - Your experiment has completed.
12693
12818
  #
12694
12819
  # * `Cancelled` - When you conclude your experiment early using the
12695
- # StopInferenceExperiment API, or if any operation fails with an
12696
- # unexpected error, it shows as cancelled.
12820
+ # [StopInferenceExperiment][1] API, or if any operation fails with
12821
+ # an unexpected error, it shows as cancelled.
12822
+ #
12823
+ #
12824
+ #
12825
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html
12697
12826
  # @return [String]
12698
12827
  #
12699
12828
  # @!attribute [rw] status_reason
12700
12829
  # The error message or client-specified `Reason` from the
12701
- # StopInferenceExperiment API, that explains the status of the
12830
+ # [StopInferenceExperiment][1] API, that explains the status of the
12702
12831
  # inference experiment.
12832
+ #
12833
+ #
12834
+ #
12835
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html
12703
12836
  # @return [String]
12704
12837
  #
12705
12838
  # @!attribute [rw] description
@@ -12753,7 +12886,11 @@ module Aws::SageMaker
12753
12886
  # The Amazon Web Services Key Management Service (Amazon Web Services
12754
12887
  # KMS) key that Amazon SageMaker uses to encrypt data on the storage
12755
12888
  # volume attached to the ML compute instance that hosts the endpoint.
12756
- # For more information, see CreateInferenceExperimentRequest$KmsKey.
12889
+ # For more information, see [CreateInferenceExperiment][1].
12890
+ #
12891
+ #
12892
+ #
12893
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html
12757
12894
  # @return [String]
12758
12895
  #
12759
12896
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeInferenceExperimentResponse AWS API Documentation
@@ -13489,13 +13626,14 @@ module Aws::SageMaker
13489
13626
  # @return [String]
13490
13627
  #
13491
13628
  # @!attribute [rw] vpc_config
13492
- # A VpcConfig object that specifies the VPC that this model has access
13493
- # to. For more information, see [Protect Endpoints by Using an Amazon
13494
- # Virtual Private Cloud][1]
13629
+ # A [VpcConfig][1] object that specifies the VPC that this model has
13630
+ # access to. For more information, see [Protect Endpoints by Using an
13631
+ # Amazon Virtual Private Cloud][2]
13495
13632
  #
13496
13633
  #
13497
13634
  #
13498
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html
13635
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
13636
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html
13499
13637
  # @return [Types::VpcConfig]
13500
13638
  #
13501
13639
  # @!attribute [rw] creation_time
@@ -14774,7 +14912,7 @@ module Aws::SageMaker
14774
14912
  # @!attribute [rw] secondary_status
14775
14913
  # Provides detailed information about the state of the training job.
14776
14914
  # For detailed information on the secondary status of the training
14777
- # job, see `StatusMessage` under SecondaryStatusTransition.
14915
+ # job, see `StatusMessage` under [SecondaryStatusTransition][1].
14778
14916
  #
14779
14917
  # SageMaker provides primary statuses and secondary statuses that
14780
14918
  # apply to each of them:
@@ -14829,6 +14967,10 @@ module Aws::SageMaker
14829
14967
  # * `PreparingTraining`
14830
14968
  #
14831
14969
  # * `DownloadingTrainingImage`
14970
+ #
14971
+ #
14972
+ #
14973
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html
14832
14974
  # @return [String]
14833
14975
  #
14834
14976
  # @!attribute [rw] failure_reason
@@ -14866,13 +15008,14 @@ module Aws::SageMaker
14866
15008
  # @return [Types::ResourceConfig]
14867
15009
  #
14868
15010
  # @!attribute [rw] vpc_config
14869
- # A VpcConfig object that specifies the VPC that this training job has
14870
- # access to. For more information, see [Protect Training Jobs by Using
14871
- # an Amazon Virtual Private Cloud][1].
15011
+ # A [VpcConfig][1] object that specifies the VPC that this training
15012
+ # job has access to. For more information, see [Protect Training Jobs
15013
+ # by Using an Amazon Virtual Private Cloud][2].
14872
15014
  #
14873
15015
  #
14874
15016
  #
14875
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html
15017
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
15018
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html
14876
15019
  # @return [Types::VpcConfig]
14877
15020
  #
14878
15021
  # @!attribute [rw] stopping_condition
@@ -14987,11 +15130,17 @@ module Aws::SageMaker
14987
15130
  # Associates a SageMaker job as a trial component with an experiment
14988
15131
  # and trial. Specified when you call the following APIs:
14989
15132
  #
14990
- # * CreateProcessingJob
15133
+ # * [CreateProcessingJob][1]
15134
+ #
15135
+ # * [CreateTrainingJob][2]
15136
+ #
15137
+ # * [CreateTransformJob][3]
15138
+ #
14991
15139
  #
14992
- # * CreateTrainingJob
14993
15140
  #
14994
- # * CreateTransformJob
15141
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
15142
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
15143
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
14995
15144
  # @return [Types::ExperimentConfig]
14996
15145
  #
14997
15146
  # @!attribute [rw] debug_rule_configurations
@@ -15222,11 +15371,17 @@ module Aws::SageMaker
15222
15371
  # Associates a SageMaker job as a trial component with an experiment
15223
15372
  # and trial. Specified when you call the following APIs:
15224
15373
  #
15225
- # * CreateProcessingJob
15374
+ # * [CreateProcessingJob][1]
15226
15375
  #
15227
- # * CreateTrainingJob
15376
+ # * [CreateTrainingJob][2]
15228
15377
  #
15229
- # * CreateTransformJob
15378
+ # * [CreateTransformJob][3]
15379
+ #
15380
+ #
15381
+ #
15382
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
15383
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
15384
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
15230
15385
  # @return [Types::ExperimentConfig]
15231
15386
  #
15232
15387
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeTransformJobResponse AWS API Documentation
@@ -16781,7 +16936,11 @@ module Aws::SageMaker
16781
16936
  #
16782
16937
  # @!attribute [rw] endpoint_status
16783
16938
  # The status of the endpoint. For possible values of the status of an
16784
- # endpoint, see EndpointSummary$EndpointStatus.
16939
+ # endpoint, see [EndpointSummary][1].
16940
+ #
16941
+ #
16942
+ #
16943
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_EndpointSummary.html
16785
16944
  # @return [String]
16786
16945
  #
16787
16946
  # @!attribute [rw] failure_reason
@@ -16878,10 +17037,10 @@ module Aws::SageMaker
16878
17037
  # * `OutOfService`: Endpoint is not available to take incoming
16879
17038
  # requests.
16880
17039
  #
16881
- # * `Creating`: CreateEndpoint is executing.
17040
+ # * `Creating`: [CreateEndpoint][1] is executing.
16882
17041
  #
16883
- # * `Updating`: UpdateEndpoint or UpdateEndpointWeightsAndCapacities
16884
- # is executing.
17042
+ # * `Updating`: [UpdateEndpoint][2] or
17043
+ # [UpdateEndpointWeightsAndCapacities][3] is executing.
16885
17044
  #
16886
17045
  # * `SystemUpdating`: Endpoint is undergoing maintenance and cannot be
16887
17046
  # updated or deleted or re-scaled until it has completed. This
@@ -16895,20 +17054,29 @@ module Aws::SageMaker
16895
17054
  # returns to an `InService` status. This transitional status only
16896
17055
  # applies to an endpoint that has autoscaling enabled and is
16897
17056
  # undergoing variant weight or capacity changes as part of an
16898
- # UpdateEndpointWeightsAndCapacities call or when the
16899
- # UpdateEndpointWeightsAndCapacities operation is called explicitly.
17057
+ # [UpdateEndpointWeightsAndCapacities][3] call or when the
17058
+ # [UpdateEndpointWeightsAndCapacities][3] operation is called
17059
+ # explicitly.
16900
17060
  #
16901
17061
  # * `InService`: Endpoint is available to process incoming requests.
16902
17062
  #
16903
- # * `Deleting`: DeleteEndpoint is executing.
17063
+ # * `Deleting`: [DeleteEndpoint][4] is executing.
16904
17064
  #
16905
17065
  # * `Failed`: Endpoint could not be created, updated, or re-scaled.
16906
- # Use DescribeEndpointOutput$FailureReason for information about the
16907
- # failure. DeleteEndpoint is the only operation that can be
17066
+ # Use `DescribeEndpointOutput$FailureReason` for information about
17067
+ # the failure. [DeleteEndpoint][4] is the only operation that can be
16908
17068
  # performed on a failed endpoint.
16909
17069
  #
16910
17070
  # To get a list of endpoints with a specified status, use the
16911
- # ListEndpointsInput$StatusEquals filter.
17071
+ # `StatusEquals` filter with a call to [ListEndpoints][5].
17072
+ #
17073
+ #
17074
+ #
17075
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html
17076
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html
17077
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html
17078
+ # [4]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html
17079
+ # [5]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListEndpoints.html
16912
17080
  # @return [String]
16913
17081
  #
16914
17082
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/EndpointSummary AWS API Documentation
@@ -16964,7 +17132,11 @@ module Aws::SageMaker
16964
17132
  include Aws::Structure
16965
17133
  end
16966
17134
 
16967
- # The properties of an experiment as returned by the Search API.
17135
+ # The properties of an experiment as returned by the [Search][1] API.
17136
+ #
17137
+ #
17138
+ #
17139
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
16968
17140
  #
16969
17141
  # @!attribute [rw] experiment_name
16970
17142
  # The name of the experiment.
@@ -17006,7 +17178,11 @@ module Aws::SageMaker
17006
17178
  #
17007
17179
  # @!attribute [rw] tags
17008
17180
  # The list of tags that are associated with the experiment. You can
17009
- # use Search API to search on the tags.
17181
+ # use [Search][1] API to search on the tags.
17182
+ #
17183
+ #
17184
+ #
17185
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
17010
17186
  # @return [Array<Types::Tag>]
17011
17187
  #
17012
17188
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/Experiment AWS API Documentation
@@ -17029,11 +17205,17 @@ module Aws::SageMaker
17029
17205
  # Associates a SageMaker job as a trial component with an experiment and
17030
17206
  # trial. Specified when you call the following APIs:
17031
17207
  #
17032
- # * CreateProcessingJob
17208
+ # * [CreateProcessingJob][1]
17033
17209
  #
17034
- # * CreateTrainingJob
17210
+ # * [CreateTrainingJob][2]
17035
17211
  #
17036
- # * CreateTransformJob
17212
+ # * [CreateTransformJob][3]
17213
+ #
17214
+ #
17215
+ #
17216
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
17217
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
17218
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
17037
17219
  #
17038
17220
  # @!attribute [rw] experiment_name
17039
17221
  # The name of an existing experiment to associate with the trial
@@ -17086,9 +17268,13 @@ module Aws::SageMaker
17086
17268
  end
17087
17269
 
17088
17270
  # A summary of the properties of an experiment. To get the complete set
17089
- # of properties, call the DescribeExperiment API and provide the
17271
+ # of properties, call the [DescribeExperiment][1] API and provide the
17090
17272
  # `ExperimentName`.
17091
17273
  #
17274
+ #
17275
+ #
17276
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html
17277
+ #
17092
17278
  # @!attribute [rw] experiment_arn
17093
17279
  # The Amazon Resource Name (ARN) of the experiment.
17094
17280
  # @return [String]
@@ -17248,7 +17434,9 @@ module Aws::SageMaker
17248
17434
  # Use this to specify the Amazon Web Services Key Management Service
17249
17435
  # (KMS) Key ID, or `KMSKeyId`, for at rest data encryption. You can
17250
17436
  # turn `OnlineStore` on or off by specifying the `EnableOnlineStore`
17251
- # flag at General Assembly; the default value is `False`.
17437
+ # flag at General Assembly.
17438
+ #
17439
+ # The default value is `False`.
17252
17440
  # @return [Types::OnlineStoreConfig]
17253
17441
  #
17254
17442
  # @!attribute [rw] offline_store_config
@@ -17515,7 +17703,8 @@ module Aws::SageMaker
17515
17703
 
17516
17704
  # A conditional statement for a search expression that includes a
17517
17705
  # resource property, a Boolean operator, and a value. Resources that
17518
- # match the statement are returned in the results from the Search API.
17706
+ # match the statement are returned in the results from the [Search][1]
17707
+ # API.
17519
17708
  #
17520
17709
  # If you specify a `Value`, but not an `Operator`, SageMaker uses the
17521
17710
  # equals operator.
@@ -17563,10 +17752,18 @@ module Aws::SageMaker
17563
17752
  #
17564
17753
  # : To define a tag filter, enter a value with the form `Tags.<key>`.
17565
17754
  #
17755
+ #
17756
+ #
17757
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
17758
+ #
17566
17759
  # @!attribute [rw] name
17567
17760
  # A resource property name. For example, `TrainingJobName`. For valid
17568
- # property names, see SearchRecord. You must specify a valid property
17569
- # for the resource.
17761
+ # property names, see [SearchRecord][1]. You must specify a valid
17762
+ # property for the resource.
17763
+ #
17764
+ #
17765
+ #
17766
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html
17570
17767
  # @return [String]
17571
17768
  #
17572
17769
  # @!attribute [rw] operator
@@ -17712,7 +17909,11 @@ module Aws::SageMaker
17712
17909
  # Shows the latest objective metric emitted by a training job that was
17713
17910
  # launched by a hyperparameter tuning job. You define the objective
17714
17911
  # metric in the `HyperParameterTuningJobObjective` parameter of
17715
- # HyperParameterTuningJobConfig.
17912
+ # [HyperParameterTuningJobConfig][1].
17913
+ #
17914
+ #
17915
+ #
17916
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html
17716
17917
  #
17717
17918
  # @!attribute [rw] type
17718
17919
  # Select if you want to minimize or maximize the objective metric
@@ -18164,7 +18365,14 @@ module Aws::SageMaker
18164
18365
  end
18165
18366
 
18166
18367
  # Defines under what conditions SageMaker creates a human loop. Used
18167
- # within . See for the required format of activation conditions.
18368
+ # within [CreateFlowDefinition][1]. See
18369
+ # [HumanLoopActivationConditionsConfig][2] for the required format of
18370
+ # activation conditions.
18371
+ #
18372
+ #
18373
+ #
18374
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateFlowDefinition.html
18375
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HumanLoopActivationConditionsConfig.html
18168
18376
  #
18169
18377
  # @!attribute [rw] human_loop_activation_conditions
18170
18378
  # JSON expressing use-case specific conditions declaratively. If any
@@ -19362,8 +19570,12 @@ module Aws::SageMaker
19362
19570
  # @return [String]
19363
19571
  #
19364
19572
  # @!attribute [rw] metric_definitions
19365
- # An array of MetricDefinition objects that specify the metrics that
19366
- # the algorithm emits.
19573
+ # An array of [MetricDefinition][1] objects that specify the metrics
19574
+ # that the algorithm emits.
19575
+ #
19576
+ #
19577
+ #
19578
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html
19367
19579
  # @return [Array<Types::MetricDefinition>]
19368
19580
  #
19369
19581
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/HyperParameterAlgorithmSpecification AWS API Documentation
@@ -19461,9 +19673,13 @@ module Aws::SageMaker
19461
19673
  # @return [Hash<String,String>]
19462
19674
  #
19463
19675
  # @!attribute [rw] algorithm_specification
19464
- # The HyperParameterAlgorithmSpecification object that specifies the
19465
- # resource algorithm to use for the training jobs that the tuning job
19466
- # launches.
19676
+ # The [HyperParameterAlgorithmSpecification][1] object that specifies
19677
+ # the resource algorithm to use for the training jobs that the tuning
19678
+ # job launches.
19679
+ #
19680
+ #
19681
+ #
19682
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterAlgorithmSpecification.html
19467
19683
  # @return [Types::HyperParameterAlgorithmSpecification]
19468
19684
  #
19469
19685
  # @!attribute [rw] role_arn
@@ -19472,20 +19688,25 @@ module Aws::SageMaker
19472
19688
  # @return [String]
19473
19689
  #
19474
19690
  # @!attribute [rw] input_data_config
19475
- # An array of Channel objects that specify the input for the training
19476
- # jobs that the tuning job launches.
19691
+ # An array of [Channel][1] objects that specify the input for the
19692
+ # training jobs that the tuning job launches.
19693
+ #
19694
+ #
19695
+ #
19696
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html
19477
19697
  # @return [Array<Types::Channel>]
19478
19698
  #
19479
19699
  # @!attribute [rw] vpc_config
19480
- # The VpcConfig object that specifies the VPC that you want the
19700
+ # The [VpcConfig][1] object that specifies the VPC that you want the
19481
19701
  # training jobs that this hyperparameter tuning job launches to
19482
19702
  # connect to. Control access to and from your training container by
19483
19703
  # configuring the VPC. For more information, see [Protect Training
19484
- # Jobs by Using an Amazon Virtual Private Cloud][1].
19704
+ # Jobs by Using an Amazon Virtual Private Cloud][2].
19485
19705
  #
19486
19706
  #
19487
19707
  #
19488
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html
19708
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
19709
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html
19489
19710
  # @return [Types::VpcConfig]
19490
19711
  #
19491
19712
  # @!attribute [rw] output_data_config
@@ -19654,9 +19875,13 @@ module Aws::SageMaker
19654
19875
  # @return [String]
19655
19876
  #
19656
19877
  # @!attribute [rw] final_hyper_parameter_tuning_job_objective_metric
19657
- # The FinalHyperParameterTuningJobObjectiveMetric object that
19878
+ # The [FinalHyperParameterTuningJobObjectiveMetric][1] object that
19658
19879
  # specifies the value of the objective metric of the tuning job that
19659
19880
  # launched this training job.
19881
+ #
19882
+ #
19883
+ #
19884
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_FinalHyperParameterTuningJobObjectiveMetric.html
19660
19885
  # @return [Types::FinalHyperParameterTuningJobObjectiveMetric]
19661
19886
  #
19662
19887
  # @!attribute [rw] objective_status
@@ -19791,22 +20016,34 @@ module Aws::SageMaker
19791
20016
  # @return [Types::HyperParameterTuningJobStrategyConfig]
19792
20017
  #
19793
20018
  # @!attribute [rw] hyper_parameter_tuning_job_objective
19794
- # The HyperParameterTuningJobObjective specifies the objective metric
19795
- # used to evaluate the performance of training jobs launched by this
19796
- # tuning job.
20019
+ # The [HyperParameterTuningJobObjective][1] specifies the objective
20020
+ # metric used to evaluate the performance of training jobs launched by
20021
+ # this tuning job.
20022
+ #
20023
+ #
20024
+ #
20025
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html
19797
20026
  # @return [Types::HyperParameterTuningJobObjective]
19798
20027
  #
19799
20028
  # @!attribute [rw] resource_limits
19800
- # The ResourceLimits object that specifies the maximum number of
20029
+ # The [ResourceLimits][1] object that specifies the maximum number of
19801
20030
  # training and parallel training jobs that can be used for this
19802
20031
  # hyperparameter tuning job.
20032
+ #
20033
+ #
20034
+ #
20035
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html
19803
20036
  # @return [Types::ResourceLimits]
19804
20037
  #
19805
20038
  # @!attribute [rw] parameter_ranges
19806
- # The ParameterRanges object that specifies the ranges of
20039
+ # The [ParameterRanges][1] object that specifies the ranges of
19807
20040
  # hyperparameters that this tuning job searches over to find the
19808
20041
  # optimal configuration for the highest model performance against your
19809
20042
  # chosen objective metric.
20043
+ #
20044
+ #
20045
+ #
20046
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ParameterRanges.html
19810
20047
  # @return [Types::ParameterRanges]
19811
20048
  #
19812
20049
  # @!attribute [rw] training_job_early_stopping_type
@@ -20089,20 +20326,33 @@ module Aws::SageMaker
20089
20326
  # @return [Time]
20090
20327
  #
20091
20328
  # @!attribute [rw] training_job_status_counters
20092
- # The TrainingJobStatusCounters object that specifies the numbers of
20093
- # training jobs, categorized by status, that this tuning job launched.
20329
+ # The [TrainingJobStatusCounters][1] object that specifies the numbers
20330
+ # of training jobs, categorized by status, that this tuning job
20331
+ # launched.
20332
+ #
20333
+ #
20334
+ #
20335
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html
20094
20336
  # @return [Types::TrainingJobStatusCounters]
20095
20337
  #
20096
20338
  # @!attribute [rw] objective_status_counters
20097
- # The ObjectiveStatusCounters object that specifies the numbers of
20098
- # training jobs, categorized by objective metric status, that this
20339
+ # The [ObjectiveStatusCounters][1] object that specifies the numbers
20340
+ # of training jobs, categorized by objective metric status, that this
20099
20341
  # tuning job launched.
20342
+ #
20343
+ #
20344
+ #
20345
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html
20100
20346
  # @return [Types::ObjectiveStatusCounters]
20101
20347
  #
20102
20348
  # @!attribute [rw] resource_limits
20103
- # The ResourceLimits object that specifies the maximum number of
20349
+ # The [ResourceLimits][1] object that specifies the maximum number of
20104
20350
  # training jobs and parallel training jobs allowed for this tuning
20105
20351
  # job.
20352
+ #
20353
+ #
20354
+ #
20355
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html
20106
20356
  # @return [Types::ResourceLimits]
20107
20357
  #
20108
20358
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/HyperParameterTuningJobSummary AWS API Documentation
@@ -20967,7 +21217,7 @@ module Aws::SageMaker
20967
21217
  # @!attribute [rw] data_input_config
20968
21218
  # Specifies the name and shape of the expected data inputs for your
20969
21219
  # trained model with a JSON dictionary form. The data inputs are
20970
- # InputConfig$Framework specific.
21220
+ # `Framework` specific.
20971
21221
  #
20972
21222
  # * `TensorFlow`: You must specify the name and shape (NHWC format) of
20973
21223
  # the expected data inputs using a dictionary format for your
@@ -21057,7 +21307,7 @@ module Aws::SageMaker
21057
21307
  # * `XGBOOST`: input data name and shape are not needed.
21058
21308
  #
21059
21309
  # `DataInputConfig` supports the following parameters for `CoreML`
21060
- # OutputConfig$TargetDevice (ML Model format):
21310
+ # `TargetDevice` (ML Model format):
21061
21311
  #
21062
21312
  # * `shape`: Input shape, for example `\{"input_1": \{"shape":
21063
21313
  # [1,224,224,3]\}\}`. In addition to static input shapes, CoreML
@@ -21091,8 +21341,8 @@ module Aws::SageMaker
21091
21341
  # scale factor.
21092
21342
  #
21093
21343
  # CoreML `ClassifierConfig` parameters can be specified using
21094
- # OutputConfig$CompilerOptions. CoreML converter supports Tensorflow
21095
- # and PyTorch models. CoreML conversion examples:
21344
+ # [OutputConfig][1] `CompilerOptions`. CoreML converter supports
21345
+ # Tensorflow and PyTorch models. CoreML conversion examples:
21096
21346
  #
21097
21347
  # * Tensor type input:
21098
21348
  #
@@ -21127,12 +21377,12 @@ module Aws::SageMaker
21127
21377
  # "imagenet_labels_1000.txt"\}`
21128
21378
  #
21129
21379
  # Depending on the model format, `DataInputConfig` requires the
21130
- # following parameters for `ml_eia2` [OutputConfig:TargetDevice][1].
21380
+ # following parameters for `ml_eia2` [OutputConfig:TargetDevice][2].
21131
21381
  #
21132
21382
  # * For TensorFlow models saved in the SavedModel format, specify the
21133
21383
  # input names from `signature_def_key` and the input model shapes
21134
21384
  # for `DataInputConfig`. Specify the `signature_def_key` in [
21135
- # `OutputConfig:CompilerOptions` ][2] if the model does not use
21385
+ # `OutputConfig:CompilerOptions` ][3] if the model does not use
21136
21386
  # TensorFlow's default signature def key. For example:
21137
21387
  #
21138
21388
  # * `"DataInputConfig": \{"inputs": [1, 224, 224, 3]\}`
@@ -21141,7 +21391,7 @@ module Aws::SageMaker
21141
21391
  #
21142
21392
  # * For TensorFlow models saved as a frozen graph, specify the input
21143
21393
  # tensor names and shapes in `DataInputConfig` and the output tensor
21144
- # names for `output_names` in [ `OutputConfig:CompilerOptions` ][2].
21394
+ # names for `output_names` in [ `OutputConfig:CompilerOptions` ][3].
21145
21395
  # For example:
21146
21396
  #
21147
21397
  # * `"DataInputConfig": \{"input_tensor:0": [1, 224, 224, 3]\}`
@@ -21150,8 +21400,9 @@ module Aws::SageMaker
21150
21400
  #
21151
21401
  #
21152
21402
  #
21153
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-TargetDevice
21154
- # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-CompilerOptions
21403
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html
21404
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-TargetDevice
21405
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-CompilerOptions
21155
21406
  # @return [String]
21156
21407
  #
21157
21408
  # @!attribute [rw] framework
@@ -22767,7 +23018,7 @@ module Aws::SageMaker
22767
23018
  #
22768
23019
  # @!attribute [rw] status_equals
22769
23020
  # A filter that retrieves model compilation jobs with a specific
22770
- # DescribeCompilationJobResponse$CompilationJobStatus status.
23021
+ # `CompilationJobStatus` status.
22771
23022
  # @return [String]
22772
23023
  #
22773
23024
  # @!attribute [rw] sort_by
@@ -22796,8 +23047,12 @@ module Aws::SageMaker
22796
23047
  end
22797
23048
 
22798
23049
  # @!attribute [rw] compilation_job_summaries
22799
- # An array of CompilationJobSummary objects, each describing a model
22800
- # compilation job.
23050
+ # An array of [CompilationJobSummary][1] objects, each describing a
23051
+ # model compilation job.
23052
+ #
23053
+ #
23054
+ #
23055
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CompilationJobSummary.html
22801
23056
  # @return [Array<Types::CompilationJobSummary>]
22802
23057
  #
22803
23058
  # @!attribute [rw] next_token
@@ -23974,9 +24229,13 @@ module Aws::SageMaker
23974
24229
  end
23975
24230
 
23976
24231
  # @!attribute [rw] hyper_parameter_tuning_job_summaries
23977
- # A list of HyperParameterTuningJobSummary objects that describe the
23978
- # tuning jobs that the `ListHyperParameterTuningJobs` request
24232
+ # A list of [HyperParameterTuningJobSummary][1] objects that describe
24233
+ # the tuning jobs that the `ListHyperParameterTuningJobs` request
23979
24234
  # returned.
24235
+ #
24236
+ #
24237
+ #
24238
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html
23980
24239
  # @return [Array<Types::HyperParameterTuningJobSummary>]
23981
24240
  #
23982
24241
  # @!attribute [rw] next_token
@@ -24154,12 +24413,20 @@ module Aws::SageMaker
24154
24413
  #
24155
24414
  # @!attribute [rw] type
24156
24415
  # Selects inference experiments of this type. For the possible types
24157
- # of inference experiments, see CreateInferenceExperimentRequest$Type.
24416
+ # of inference experiments, see [CreateInferenceExperiment][1].
24417
+ #
24418
+ #
24419
+ #
24420
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html
24158
24421
  # @return [String]
24159
24422
  #
24160
24423
  # @!attribute [rw] status_equals
24161
24424
  # Selects inference experiments which are in this status. For the
24162
- # possible statuses, see DescribeInferenceExperimentResponse$Status.
24425
+ # possible statuses, see [DescribeInferenceExperiment][1].
24426
+ #
24427
+ #
24428
+ #
24429
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html
24163
24430
  # @return [String]
24164
24431
  #
24165
24432
  # @!attribute [rw] creation_time_after
@@ -26545,9 +26812,13 @@ module Aws::SageMaker
26545
26812
  end
26546
26813
 
26547
26814
  # @!attribute [rw] training_job_summaries
26548
- # A list of TrainingJobSummary objects that describe the training jobs
26549
- # that the `ListTrainingJobsForHyperParameterTuningJob` request
26815
+ # A list of [TrainingJobSummary][1] objects that describe the training
26816
+ # jobs that the `ListTrainingJobsForHyperParameterTuningJob` request
26550
26817
  # returned.
26818
+ #
26819
+ #
26820
+ #
26821
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html
26551
26822
  # @return [Array<Types::HyperParameterTrainingJobSummary>]
26552
26823
  #
26553
26824
  # @!attribute [rw] next_token
@@ -27231,7 +27502,11 @@ module Aws::SageMaker
27231
27502
  include Aws::Structure
27232
27503
  end
27233
27504
 
27234
- # The properties of a model as returned by the Search API.
27505
+ # The properties of a model as returned by the [Search][1] API.
27506
+ #
27507
+ #
27508
+ #
27509
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
27235
27510
  #
27236
27511
  # @!attribute [rw] model_name
27237
27512
  # The name of the model.
@@ -27421,7 +27696,7 @@ module Aws::SageMaker
27421
27696
  #
27422
27697
  #
27423
27698
  #
27424
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html
27699
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema
27425
27700
  # @return [String]
27426
27701
  #
27427
27702
  # @!attribute [rw] model_card_status
@@ -28915,6 +29190,30 @@ module Aws::SageMaker
28915
29190
  include Aws::Structure
28916
29191
  end
28917
29192
 
29193
+ # The model registry settings for the SageMaker Canvas application.
29194
+ #
29195
+ # @!attribute [rw] status
29196
+ # Describes whether the integration to the model registry is enabled
29197
+ # or disabled in the Canvas application.
29198
+ # @return [String]
29199
+ #
29200
+ # @!attribute [rw] cross_account_model_register_role_arn
29201
+ # The Amazon Resource Name (ARN) of the SageMaker model registry
29202
+ # account. Required only to register model versions created by a
29203
+ # different SageMaker Canvas Amazon Web Services account than the
29204
+ # Amazon Web Services account in which SageMaker model registry is set
29205
+ # up.
29206
+ # @return [String]
29207
+ #
29208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ModelRegisterSettings AWS API Documentation
29209
+ #
29210
+ class ModelRegisterSettings < Struct.new(
29211
+ :status,
29212
+ :cross_account_model_register_role_arn)
29213
+ SENSITIVE = []
29214
+ include Aws::Structure
29215
+ end
29216
+
28918
29217
  # Metadata for Model steps.
28919
29218
  #
28920
29219
  # @!attribute [rw] arn
@@ -29820,15 +30119,16 @@ module Aws::SageMaker
29820
30119
  include Aws::Structure
29821
30120
  end
29822
30121
 
29823
- # The VpcConfig configuration object that specifies the VPC that you
29824
- # want the compilation jobs to connect to. For more information on
30122
+ # The [VpcConfig][1] configuration object that specifies the VPC that
30123
+ # you want the compilation jobs to connect to. For more information on
29825
30124
  # controlling access to your Amazon S3 buckets used for compilation job,
29826
30125
  # see [Give Amazon SageMaker Compilation Jobs Access to Resources in
29827
- # Your Amazon VPC][1].
30126
+ # Your Amazon VPC][2].
29828
30127
  #
29829
30128
  #
29830
30129
  #
29831
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html
30130
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
30131
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html
29832
30132
  #
29833
30133
  # @!attribute [rw] security_group_ids
29834
30134
  # The VPC security group IDs. IDs have the form of `sg-xxxxxxxx`.
@@ -29850,9 +30150,9 @@ module Aws::SageMaker
29850
30150
  include Aws::Structure
29851
30151
  end
29852
30152
 
29853
- # A list of nested Filter objects. A resource must satisfy the
30153
+ # A list of nested [Filter][1] objects. A resource must satisfy the
29854
30154
  # conditions of all filters to be included in the results returned from
29855
- # the Search API.
30155
+ # the [Search][2] API.
29856
30156
  #
29857
30157
  # For example, to filter on a training job's `InputDataConfig` property
29858
30158
  # with a specific channel name and `S3Uri` prefix, define the following
@@ -29864,6 +30164,11 @@ module Aws::SageMaker
29864
30164
  # * `'\{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri",
29865
30165
  # "Operator":"Contains", "Value":"mybucket/catdata"\}'`
29866
30166
  #
30167
+ #
30168
+ #
30169
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Filter.html
30170
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
30171
+ #
29867
30172
  # @!attribute [rw] nested_property_name
29868
30173
  # The name of the property to use in the nested filters. The value
29869
30174
  # must match a listed property name, such as `InputDataConfig`.
@@ -30148,7 +30453,15 @@ module Aws::SageMaker
30148
30453
  #
30149
30454
  # @!attribute [rw] disable_glue_table_creation
30150
30455
  # Set to `True` to disable the automatic creation of an Amazon Web
30151
- # Services Glue table when configuring an `OfflineStore`.
30456
+ # Services Glue table when configuring an `OfflineStore`. If set to
30457
+ # `False`, Feature Store will name the `OfflineStore` Glue table
30458
+ # following [Athena's naming recommendations][1].
30459
+ #
30460
+ # The default value is `False`.
30461
+ #
30462
+ #
30463
+ #
30464
+ # [1]: https://docs.aws.amazon.com/athena/latest/ug/tables-databases-columns-names.html
30152
30465
  # @return [Boolean]
30153
30466
  #
30154
30467
  # @!attribute [rw] data_catalog_config
@@ -30323,7 +30636,9 @@ module Aws::SageMaker
30323
30636
  # Use this to specify the Amazon Web Services Key Management Service
30324
30637
  # (KMS) Key ID, or `KMSKeyId`, for at rest data encryption. You can turn
30325
30638
  # `OnlineStore` on or off by specifying the `EnableOnlineStore` flag at
30326
- # General Assembly; the default value is `False`.
30639
+ # General Assembly.
30640
+ #
30641
+ # The default value is `False`.
30327
30642
  #
30328
30643
  # @!attribute [rw] security_config
30329
30644
  # Use to specify KMS Key ID (`KMSKeyId`) for at-rest encryption of
@@ -30415,8 +30730,12 @@ module Aws::SageMaker
30415
30730
  # Identifies the target device or the machine learning instance that
30416
30731
  # you want to run your model on after the compilation has completed.
30417
30732
  # Alternatively, you can specify OS, architecture, and accelerator
30418
- # using TargetPlatform fields. It can be used instead of
30733
+ # using [TargetPlatform][1] fields. It can be used instead of
30419
30734
  # `TargetPlatform`.
30735
+ #
30736
+ #
30737
+ #
30738
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TargetPlatform.html
30420
30739
  # @return [String]
30421
30740
  #
30422
30741
  # @!attribute [rw] target_platform
@@ -30531,8 +30850,8 @@ module Aws::SageMaker
30531
30850
  # For information about supported compiler options, see [ Neuron
30532
30851
  # Compiler CLI][1].
30533
30852
  #
30534
- # * `CoreML`: Compilation for the CoreML OutputConfig$TargetDevice
30535
- # supports the following compiler options:
30853
+ # * `CoreML`: Compilation for the CoreML [OutputConfig][2]
30854
+ # `TargetDevice` supports the following compiler options:
30536
30855
  #
30537
30856
  # * `class_labels`: Specifies the classification labels file name
30538
30857
  # inside input tar.gz file. For example, `\{"class_labels":
@@ -30561,6 +30880,7 @@ module Aws::SageMaker
30561
30880
  #
30562
30881
  #
30563
30882
  # [1]: https://github.com/aws/aws-neuron-sdk/blob/master/docs/neuron-cc/command-line-reference.md
30883
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html
30564
30884
  # @return [String]
30565
30885
  #
30566
30886
  # @!attribute [rw] kms_key_id
@@ -30762,20 +31082,33 @@ module Aws::SageMaker
30762
31082
  # </note>
30763
31083
  #
30764
31084
  # @!attribute [rw] integer_parameter_ranges
30765
- # The array of IntegerParameterRange objects that specify ranges of
30766
- # integer hyperparameters that a hyperparameter tuning job searches.
31085
+ # The array of [IntegerParameterRange][1] objects that specify ranges
31086
+ # of integer hyperparameters that a hyperparameter tuning job
31087
+ # searches.
31088
+ #
31089
+ #
31090
+ #
31091
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_IntegerParameterRange.html
30767
31092
  # @return [Array<Types::IntegerParameterRange>]
30768
31093
  #
30769
31094
  # @!attribute [rw] continuous_parameter_ranges
30770
- # The array of ContinuousParameterRange objects that specify ranges of
30771
- # continuous hyperparameters that a hyperparameter tuning job
30772
- # searches.
31095
+ # The array of [ContinuousParameterRange][1] objects that specify
31096
+ # ranges of continuous hyperparameters that a hyperparameter tuning
31097
+ # job searches.
31098
+ #
31099
+ #
31100
+ #
31101
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContinuousParameterRange.html
30773
31102
  # @return [Array<Types::ContinuousParameterRange>]
30774
31103
  #
30775
31104
  # @!attribute [rw] categorical_parameter_ranges
30776
- # The array of CategoricalParameterRange objects that specify ranges
30777
- # of categorical hyperparameters that a hyperparameter tuning job
30778
- # searches.
31105
+ # The array of [CategoricalParameterRange][1] objects that specify
31106
+ # ranges of categorical hyperparameters that a hyperparameter tuning
31107
+ # job searches.
31108
+ #
31109
+ #
31110
+ #
31111
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CategoricalParameterRange.html
30779
31112
  # @return [Array<Types::CategoricalParameterRange>]
30780
31113
  #
30781
31114
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ParameterRanges AWS API Documentation
@@ -30833,8 +31166,13 @@ module Aws::SageMaker
30833
31166
  # @return [String]
30834
31167
  #
30835
31168
  # @!attribute [rw] production_variants
30836
- # An array of PendingProductionVariantSummary objects, one for each
30837
- # model hosted behind this endpoint for the in-progress deployment.
31169
+ # An array of [PendingProductionVariantSummary][1] objects, one for
31170
+ # each model hosted behind this endpoint for the in-progress
31171
+ # deployment.
31172
+ #
31173
+ #
31174
+ #
31175
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html
30838
31176
  # @return [Array<Types::PendingProductionVariantSummary>]
30839
31177
  #
30840
31178
  # @!attribute [rw] start_time
@@ -30842,10 +31180,14 @@ module Aws::SageMaker
30842
31180
  # @return [Time]
30843
31181
  #
30844
31182
  # @!attribute [rw] shadow_production_variants
30845
- # An array of PendingProductionVariantSummary objects, one for each
30846
- # model hosted behind this endpoint in shadow mode with production
30847
- # traffic replicated from the model specified on `ProductionVariants`
30848
- # for the in-progress deployment.
31183
+ # An array of [PendingProductionVariantSummary][1] objects, one for
31184
+ # each model hosted behind this endpoint in shadow mode with
31185
+ # production traffic replicated from the model specified on
31186
+ # `ProductionVariants` for the in-progress deployment.
31187
+ #
31188
+ #
31189
+ #
31190
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html
30849
31191
  # @return [Array<Types::PendingProductionVariantSummary>]
30850
31192
  #
30851
31193
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/PendingDeploymentSummary AWS API Documentation
@@ -30860,9 +31202,14 @@ module Aws::SageMaker
30860
31202
  end
30861
31203
 
30862
31204
  # The production variant summary for a deployment when an endpoint is
30863
- # creating or updating with the ` CreateEndpoint ` or ` UpdateEndpoint `
30864
- # operations. Describes the `VariantStatus `, weight and capacity for a
30865
- # production variant associated with an endpoint.
31205
+ # creating or updating with the [CreateEndpoint][1] or
31206
+ # [UpdateEndpoint][2] operations. Describes the `VariantStatus `, weight
31207
+ # and capacity for a production variant associated with an endpoint.
31208
+ #
31209
+ #
31210
+ #
31211
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html
31212
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html
30866
31213
  #
30867
31214
  # @!attribute [rw] variant_name
30868
31215
  # The name of the variant.
@@ -30881,7 +31228,12 @@ module Aws::SageMaker
30881
31228
  # @!attribute [rw] desired_weight
30882
31229
  # The requested weight for the variant in this deployment, as
30883
31230
  # specified in the endpoint configuration for the endpoint. The value
30884
- # is taken from the request to the ` CreateEndpointConfig ` operation.
31231
+ # is taken from the request to the [CreateEndpointConfig][1]
31232
+ # operation.
31233
+ #
31234
+ #
31235
+ #
31236
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html
30885
31237
  # @return [Float]
30886
31238
  #
30887
31239
  # @!attribute [rw] current_instance_count
@@ -30891,7 +31243,11 @@ module Aws::SageMaker
30891
31243
  # @!attribute [rw] desired_instance_count
30892
31244
  # The number of instances requested in this deployment, as specified
30893
31245
  # in the endpoint configuration for the endpoint. The value is taken
30894
- # from the request to the ` CreateEndpointConfig ` operation.
31246
+ # from the request to the [CreateEndpointConfig][1] operation.
31247
+ #
31248
+ #
31249
+ #
31250
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html
30895
31251
  # @return [Integer]
30896
31252
  #
30897
31253
  # @!attribute [rw] instance_type
@@ -31627,11 +31983,17 @@ module Aws::SageMaker
31627
31983
  # Associates a SageMaker job as a trial component with an experiment
31628
31984
  # and trial. Specified when you call the following APIs:
31629
31985
  #
31630
- # * CreateProcessingJob
31986
+ # * [CreateProcessingJob][1]
31987
+ #
31988
+ # * [CreateTrainingJob][2]
31989
+ #
31990
+ # * [CreateTransformJob][3]
31991
+ #
31631
31992
  #
31632
- # * CreateTrainingJob
31633
31993
  #
31634
- # * CreateTransformJob
31994
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
31995
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
31996
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
31635
31997
  # @return [Types::ExperimentConfig]
31636
31998
  #
31637
31999
  # @!attribute [rw] processing_job_arn
@@ -33760,7 +34122,11 @@ module Aws::SageMaker
33760
34122
  # parameter.
33761
34123
  #
33762
34124
  # See a list of available Human Ui Amazon Resource Names (ARNs) in
33763
- # UiConfig.
34125
+ # [UiConfig][1].
34126
+ #
34127
+ #
34128
+ #
34129
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UiConfig.html
33764
34130
  # @return [String]
33765
34131
  #
33766
34132
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RenderUiTemplateRequest AWS API Documentation
@@ -34472,7 +34838,11 @@ module Aws::SageMaker
34472
34838
  include Aws::Structure
34473
34839
  end
34474
34840
 
34475
- # A single resource returned as part of the Search API response.
34841
+ # A single resource returned as part of the [Search][1] API response.
34842
+ #
34843
+ #
34844
+ #
34845
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
34476
34846
  #
34477
34847
  # @!attribute [rw] training_job
34478
34848
  # The properties of a training job.
@@ -34626,15 +34996,21 @@ module Aws::SageMaker
34626
34996
  include Aws::Structure
34627
34997
  end
34628
34998
 
34629
- # An array element of
34630
- # DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides
34631
- # additional details about a status that the training job has
34632
- # transitioned through. A training job can be in one of several states,
34633
- # for example, starting, downloading, training, or uploading. Within
34634
- # each state, there are a number of intermediate states. For example,
34635
- # within the starting state, SageMaker could be starting the training
34636
- # job or launching the ML instances. These transitional states are
34637
- # referred to as the job's secondary status.
34999
+ # An array element of `SecondaryStatusTransitions` for
35000
+ # [DescribeTrainingJob][1]. It provides additional details about a
35001
+ # status that the training job has transitioned through. A training job
35002
+ # can be in one of several states, for example, starting, downloading,
35003
+ # training, or uploading. Within each state, there are a number of
35004
+ # intermediate states. For example, within the starting state, SageMaker
35005
+ # could be starting the training job or launching the ML instances.
35006
+ # These transitional states are referred to as the job's secondary
35007
+ # status.
35008
+ #
35009
+ #
35010
+ #
35011
+ #
35012
+ #
35013
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html
34638
35014
  #
34639
35015
  # @!attribute [rw] status
34640
35016
  # Contains a secondary status information from a training job.
@@ -34724,15 +35100,19 @@ module Aws::SageMaker
34724
35100
  # examples, don't use status messages in if statements.
34725
35101
  #
34726
35102
  # To have an overview of your training job's progress, view
34727
- # `TrainingJobStatus` and `SecondaryStatus` in DescribeTrainingJob,
34728
- # and `StatusMessage` together. For example, at the start of a
34729
- # training job, you might see the following:
35103
+ # `TrainingJobStatus` and `SecondaryStatus` in
35104
+ # [DescribeTrainingJob][1], and `StatusMessage` together. For example,
35105
+ # at the start of a training job, you might see the following:
34730
35106
  #
34731
35107
  # * `TrainingJobStatus` - InProgress
34732
35108
  #
34733
35109
  # * `SecondaryStatus` - Training
34734
35110
  #
34735
35111
  # * `StatusMessage` - Downloading the training image
35112
+ #
35113
+ #
35114
+ #
35115
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html
34736
35116
  # @return [String]
34737
35117
  #
34738
35118
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/SecondaryStatusTransition AWS API Documentation
@@ -35671,8 +36051,12 @@ module Aws::SageMaker
35671
36051
  include Aws::Structure
35672
36052
  end
35673
36053
 
35674
- # Specified in the GetSearchSuggestions request. Limits the property
35675
- # names that are included in the response.
36054
+ # Specified in the [GetSearchSuggestions][1] request. Limits the
36055
+ # property names that are included in the response.
36056
+ #
36057
+ #
36058
+ #
36059
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_GetSearchSuggestions.html
35676
36060
  #
35677
36061
  # @!attribute [rw] property_name_query
35678
36062
  # Defines a property name hint. Only property names that begin with
@@ -35693,19 +36077,20 @@ module Aws::SageMaker
35693
36077
  # You can add tags to notebook instances, training jobs, hyperparameter
35694
36078
  # tuning jobs, batch transform jobs, models, labeling jobs, work teams,
35695
36079
  # endpoint configurations, and endpoints. For more information on adding
35696
- # tags to SageMaker resources, see AddTags.
36080
+ # tags to SageMaker resources, see [AddTags][1].
35697
36081
  #
35698
36082
  # For more information on adding metadata to your Amazon Web Services
35699
36083
  # resources with tagging, see [Tagging Amazon Web Services
35700
- # resources][1]. For advice on best practices for managing Amazon Web
36084
+ # resources][2]. For advice on best practices for managing Amazon Web
35701
36085
  # Services resources with tagging, see [Tagging Best Practices:
35702
36086
  # Implement an Effective Amazon Web Services Resource Tagging
35703
- # Strategy][2].
36087
+ # Strategy][3].
35704
36088
  #
35705
36089
  #
35706
36090
  #
35707
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
35708
- # [2]: https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf
36091
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html
36092
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
36093
+ # [3]: https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf
35709
36094
  #
35710
36095
  # @!attribute [rw] key
35711
36096
  # The tag key. Tag keys must be unique per resource.
@@ -35838,23 +36223,23 @@ module Aws::SageMaker
35838
36223
  include Aws::Structure
35839
36224
  end
35840
36225
 
35841
- # Time series forecast settings for the SageMaker Canvas app.
36226
+ # Time series forecast settings for the SageMaker Canvas application.
35842
36227
  #
35843
36228
  # @!attribute [rw] status
35844
36229
  # Describes whether time series forecasting is enabled or disabled in
35845
- # the Canvas app.
36230
+ # the Canvas application.
35846
36231
  # @return [String]
35847
36232
  #
35848
36233
  # @!attribute [rw] amazon_forecast_role_arn
35849
36234
  # The IAM role that Canvas passes to Amazon Forecast for time series
35850
36235
  # forecasting. By default, Canvas uses the execution role specified in
35851
- # the `UserProfile` that launches the Canvas app. If an execution role
35852
- # is not specified in the `UserProfile`, Canvas uses the execution
35853
- # role specified in the Domain that owns the `UserProfile`. To allow
35854
- # time series forecasting, this IAM role should have the [
35855
- # AmazonSageMakerCanvasForecastAccess][1] policy attached and
35856
- # `forecast.amazonaws.com` added in the trust relationship as a
35857
- # service principal.
36236
+ # the `UserProfile` that launches the Canvas application. If an
36237
+ # execution role is not specified in the `UserProfile`, Canvas uses
36238
+ # the execution role specified in the Domain that owns the
36239
+ # `UserProfile`. To allow time series forecasting, this IAM role
36240
+ # should have the [ AmazonSageMakerCanvasForecastAccess][1] policy
36241
+ # attached and `forecast.amazonaws.com` added in the trust
36242
+ # relationship as a service principal.
35858
36243
  #
35859
36244
  #
35860
36245
  #
@@ -36009,7 +36394,7 @@ module Aws::SageMaker
36009
36394
  # @!attribute [rw] secondary_status
36010
36395
  # Provides detailed information about the state of the training job.
36011
36396
  # For detailed information about the secondary status of the training
36012
- # job, see `StatusMessage` under SecondaryStatusTransition.
36397
+ # job, see `StatusMessage` under [SecondaryStatusTransition][1].
36013
36398
  #
36014
36399
  # SageMaker provides primary statuses and secondary statuses that
36015
36400
  # apply to each of them:
@@ -36058,6 +36443,10 @@ module Aws::SageMaker
36058
36443
  # * `PreparingTrainingStack`
36059
36444
  #
36060
36445
  # * `DownloadingTrainingImage`
36446
+ #
36447
+ #
36448
+ #
36449
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html
36061
36450
  # @return [String]
36062
36451
  #
36063
36452
  # @!attribute [rw] failure_reason
@@ -36095,13 +36484,14 @@ module Aws::SageMaker
36095
36484
  # @return [Types::ResourceConfig]
36096
36485
  #
36097
36486
  # @!attribute [rw] vpc_config
36098
- # A VpcConfig object that specifies the VPC that this training job has
36099
- # access to. For more information, see [Protect Training Jobs by Using
36100
- # an Amazon Virtual Private Cloud][1].
36487
+ # A [VpcConfig][1] object that specifies the VPC that this training
36488
+ # job has access to. For more information, see [Protect Training Jobs
36489
+ # by Using an Amazon Virtual Private Cloud][2].
36101
36490
  #
36102
36491
  #
36103
36492
  #
36104
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html
36493
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
36494
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html
36105
36495
  # @return [Types::VpcConfig]
36106
36496
  #
36107
36497
  # @!attribute [rw] stopping_condition
@@ -36207,11 +36597,17 @@ module Aws::SageMaker
36207
36597
  # Associates a SageMaker job as a trial component with an experiment
36208
36598
  # and trial. Specified when you call the following APIs:
36209
36599
  #
36210
- # * CreateProcessingJob
36600
+ # * [CreateProcessingJob][1]
36601
+ #
36602
+ # * [CreateTrainingJob][2]
36603
+ #
36604
+ # * [CreateTransformJob][3]
36211
36605
  #
36212
- # * CreateTrainingJob
36213
36606
  #
36214
- # * CreateTransformJob
36607
+ #
36608
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
36609
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
36610
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
36215
36611
  # @return [Types::ExperimentConfig]
36216
36612
  #
36217
36613
  # @!attribute [rw] debug_rule_configurations
@@ -36793,11 +37189,17 @@ module Aws::SageMaker
36793
37189
  # Associates a SageMaker job as a trial component with an experiment
36794
37190
  # and trial. Specified when you call the following APIs:
36795
37191
  #
36796
- # * CreateProcessingJob
37192
+ # * [CreateProcessingJob][1]
37193
+ #
37194
+ # * [CreateTrainingJob][2]
36797
37195
  #
36798
- # * CreateTrainingJob
37196
+ # * [CreateTransformJob][3]
36799
37197
  #
36800
- # * CreateTransformJob
37198
+ #
37199
+ #
37200
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
37201
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
37202
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
36801
37203
  # @return [Types::ExperimentConfig]
36802
37204
  #
36803
37205
  # @!attribute [rw] tags
@@ -36904,7 +37306,11 @@ module Aws::SageMaker
36904
37306
 
36905
37307
  # Provides a summary of a transform job. Multiple `TransformJobSummary`
36906
37308
  # objects are returned as a list after in response to a
36907
- # ListTransformJobs call.
37309
+ # [ListTransformJobs][1] call.
37310
+ #
37311
+ #
37312
+ #
37313
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTransformJobs.html
36908
37314
  #
36909
37315
  # @!attribute [rw] transform_job_name
36910
37316
  # The name of the transform job.
@@ -37160,7 +37566,11 @@ module Aws::SageMaker
37160
37566
  include Aws::Structure
37161
37567
  end
37162
37568
 
37163
- # The properties of a trial as returned by the Search API.
37569
+ # The properties of a trial as returned by the [Search][1] API.
37570
+ #
37571
+ #
37572
+ #
37573
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
37164
37574
  #
37165
37575
  # @!attribute [rw] trial_name
37166
37576
  # The name of the trial.
@@ -37207,7 +37617,11 @@ module Aws::SageMaker
37207
37617
  #
37208
37618
  # @!attribute [rw] tags
37209
37619
  # The list of tags that are associated with the trial. You can use
37210
- # Search API to search on the tags.
37620
+ # [Search][1] API to search on the tags.
37621
+ #
37622
+ #
37623
+ #
37624
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
37211
37625
  # @return [Array<Types::Tag>]
37212
37626
  #
37213
37627
  # @!attribute [rw] trial_component_summaries
@@ -37234,7 +37648,12 @@ module Aws::SageMaker
37234
37648
  include Aws::Structure
37235
37649
  end
37236
37650
 
37237
- # The properties of a trial component as returned by the Search API.
37651
+ # The properties of a trial component as returned by the [Search][1]
37652
+ # API.
37653
+ #
37654
+ #
37655
+ #
37656
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
37238
37657
  #
37239
37658
  # @!attribute [rw] trial_component_name
37240
37659
  # The name of the trial component.
@@ -37314,7 +37733,11 @@ module Aws::SageMaker
37314
37733
  #
37315
37734
  # @!attribute [rw] tags
37316
37735
  # The list of tags that are associated with the component. You can use
37317
- # Search API to search on the tags.
37736
+ # [Search][1] API to search on the tags.
37737
+ #
37738
+ #
37739
+ #
37740
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
37318
37741
  # @return [Array<Types::Tag>]
37319
37742
  #
37320
37743
  # @!attribute [rw] parents
@@ -37357,12 +37780,16 @@ module Aws::SageMaker
37357
37780
 
37358
37781
  # Represents an input or output artifact of a trial component. You
37359
37782
  # specify `TrialComponentArtifact` as part of the `InputArtifacts` and
37360
- # `OutputArtifacts` parameters in the CreateTrialComponent request.
37783
+ # `OutputArtifacts` parameters in the [CreateTrialComponent][1] request.
37361
37784
  #
37362
37785
  # Examples of input artifacts are datasets, algorithms, hyperparameters,
37363
37786
  # source code, and instance types. Examples of output artifacts are
37364
37787
  # metrics, snapshots, logs, and images.
37365
37788
  #
37789
+ #
37790
+ #
37791
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html
37792
+ #
37366
37793
  # @!attribute [rw] media_type
37367
37794
  # The media type of the artifact, which indicates the type of data in
37368
37795
  # the artifact file. The media type consists of a *type* and a
@@ -37441,7 +37868,11 @@ module Aws::SageMaker
37441
37868
  # The value of a hyperparameter. Only one of `NumberValue` or
37442
37869
  # `StringValue` can be specified.
37443
37870
  #
37444
- # This object is specified in the CreateTrialComponent request.
37871
+ # This object is specified in the [CreateTrialComponent][1] request.
37872
+ #
37873
+ #
37874
+ #
37875
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html
37445
37876
  #
37446
37877
  # @!attribute [rw] string_value
37447
37878
  # The string value of a categorical hyperparameter. If you specify a
@@ -37573,9 +38004,13 @@ module Aws::SageMaker
37573
38004
  end
37574
38005
 
37575
38006
  # A summary of the properties of a trial component. To get all the
37576
- # properties, call the DescribeTrialComponent API and provide the
38007
+ # properties, call the [DescribeTrialComponent][1] API and provide the
37577
38008
  # `TrialComponentName`.
37578
38009
  #
38010
+ #
38011
+ #
38012
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html
38013
+ #
37579
38014
  # @!attribute [rw] trial_component_name
37580
38015
  # The name of the trial component.
37581
38016
  # @return [String]
@@ -37666,7 +38101,12 @@ module Aws::SageMaker
37666
38101
  end
37667
38102
 
37668
38103
  # A summary of the properties of a trial. To get the complete set of
37669
- # properties, call the DescribeTrial API and provide the `TrialName`.
38104
+ # properties, call the [DescribeTrial][1] API and provide the
38105
+ # `TrialName`.
38106
+ #
38107
+ #
38108
+ #
38109
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html
37670
38110
  #
37671
38111
  # @!attribute [rw] trial_arn
37672
38112
  # The Amazon Resource Name (ARN) of the trial.
@@ -38208,12 +38648,16 @@ module Aws::SageMaker
38208
38648
  #
38209
38649
  # @!attribute [rw] exclude_retained_variant_properties
38210
38650
  # When you are updating endpoint resources with
38211
- # UpdateEndpointInput$RetainAllVariantProperties, whose value is set
38212
- # to `true`, `ExcludeRetainedVariantProperties` specifies the list of
38213
- # type VariantProperty to override with the values provided by
38651
+ # `RetainAllVariantProperties`, whose value is set to `true`,
38652
+ # `ExcludeRetainedVariantProperties` specifies the list of type
38653
+ # [VariantProperty][1] to override with the values provided by
38214
38654
  # `EndpointConfig`. If you don't specify a value for
38215
38655
  # `ExcludeRetainedVariantProperties`, no variant properties are
38216
38656
  # overridden.
38657
+ #
38658
+ #
38659
+ #
38660
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html
38217
38661
  # @return [Array<Types::VariantProperty>]
38218
38662
  #
38219
38663
  # @!attribute [rw] deployment_config
@@ -38646,7 +39090,7 @@ module Aws::SageMaker
38646
39090
  #
38647
39091
  #
38648
39092
  #
38649
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html
39093
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema
38650
39094
  # @return [String]
38651
39095
  #
38652
39096
  # @!attribute [rw] model_card_status
@@ -39385,7 +39829,11 @@ module Aws::SageMaker
39385
39829
 
39386
39830
  # @!attribute [rw] workforce_name
39387
39831
  # The name of the private workforce that you want to update. You can
39388
- # find your workforce name by using the operation.
39832
+ # find your workforce name by using the [ListWorkforces][1] operation.
39833
+ #
39834
+ #
39835
+ #
39836
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html
39389
39837
  # @return [String]
39390
39838
  #
39391
39839
  # @!attribute [rw] source_ip_config
@@ -39595,7 +40043,8 @@ module Aws::SageMaker
39595
40043
  # set to `PublicInternetOnly`.
39596
40044
  #
39597
40045
  # Required when the `CreateDomain.AppNetworkAccessType` parameter is
39598
- # set to `VpcOnly`.
40046
+ # set to `VpcOnly`, unless specified as part of the
40047
+ # `DefaultUserSettings` for the domain.
39599
40048
  #
39600
40049
  # Amazon SageMaker adds a security group to allow NFS traffic from
39601
40050
  # SageMaker Studio. Therefore, the number of security groups that you
@@ -39649,24 +40098,33 @@ module Aws::SageMaker
39649
40098
 
39650
40099
  # Specifies a production variant property type for an Endpoint.
39651
40100
  #
39652
- # If you are updating an endpoint with the
39653
- # UpdateEndpointInput$RetainAllVariantProperties option set to `true`,
39654
- # the `VariantProperty` objects listed in
39655
- # UpdateEndpointInput$ExcludeRetainedVariantProperties override the
39656
- # existing variant properties of the endpoint.
40101
+ # If you are updating an endpoint with the `RetainAllVariantProperties`
40102
+ # option of [UpdateEndpointInput][1] set to `true`, the
40103
+ # `VariantProperty` objects listed in the
40104
+ # `ExcludeRetainedVariantProperties` parameter of
40105
+ # [UpdateEndpointInput][1] override the existing variant properties of
40106
+ # the endpoint.
40107
+ #
40108
+ #
40109
+ #
40110
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html
39657
40111
  #
39658
40112
  # @!attribute [rw] variant_property_type
39659
40113
  # The type of variant property. The supported values are:
39660
40114
  #
39661
40115
  # * `DesiredInstanceCount`: Overrides the existing variant instance
39662
- # counts using the ProductionVariant$InitialInstanceCount values in
39663
- # the CreateEndpointConfigInput$ProductionVariants.
40116
+ # counts using the `InitialInstanceCount` values in the
40117
+ # `ProductionVariants` of [CreateEndpointConfig][1].
39664
40118
  #
39665
40119
  # * `DesiredWeight`: Overrides the existing variant weights using the
39666
- # ProductionVariant$InitialVariantWeight values in the
39667
- # CreateEndpointConfigInput$ProductionVariants.
40120
+ # `InitialVariantWeight` values in the `ProductionVariants` of
40121
+ # [CreateEndpointConfig][1].
39668
40122
  #
39669
40123
  # * `DataCaptureConfig`: (Not currently supported.)
40124
+ #
40125
+ #
40126
+ #
40127
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html
39670
40128
  # @return [String]
39671
40129
  #
39672
40130
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/VariantProperty AWS API Documentation
@@ -39803,12 +40261,14 @@ module Aws::SageMaker
39803
40261
  # @return [String]
39804
40262
  #
39805
40263
  # @!attribute [rw] last_updated_date
39806
- # The most recent date that was used to successfully add one or more
39807
- # IP address ranges ([CIDRs][1]) to a private workforce's allow list.
40264
+ # The most recent date that [UpdateWorkforce][1] was used to
40265
+ # successfully add one or more IP address ranges ([CIDRs][2]) to a
40266
+ # private workforce's allow list.
39808
40267
  #
39809
40268
  #
39810
40269
  #
39811
- # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html
40270
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateWorkforce.html
40271
+ # [2]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html
39812
40272
  # @return [Time]
39813
40273
  #
39814
40274
  # @!attribute [rw] source_ip_config