aws-sdk-sagemaker 1.171.0 → 1.174.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -456,7 +456,7 @@ module Aws::SageMaker
456
456
  # also added to all training jobs that the hyperparameter tuning job
457
457
  # launches, add the tags when you first create the tuning job by
458
458
  # specifying them in the `Tags` parameter of
459
- # CreateHyperParameterTuningJob
459
+ # [CreateHyperParameterTuningJob][2]
460
460
  #
461
461
  # </note>
462
462
  #
@@ -467,13 +467,17 @@ module Aws::SageMaker
467
467
  # sure that the tags associated with a Domain or User Profile are also
468
468
  # added to all Apps that the Domain or User Profile launches, add the
469
469
  # tags when you first create the Domain or User Profile by specifying
470
- # them in the `Tags` parameter of CreateDomain or CreateUserProfile.
470
+ # them in the `Tags` parameter of [CreateDomain][3] or
471
+ # [CreateUserProfile][4].
471
472
  #
472
473
  # </note>
473
474
  #
474
475
  #
475
476
  #
476
477
  # [1]: https://aws.amazon.com/answers/account-management/aws-tagging-strategies/
478
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html
479
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html
480
+ # [4]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html
477
481
  #
478
482
  # @option params [required, String] :resource_arn
479
483
  # The Amazon Resource Name (ARN) of the resource that you want to tag.
@@ -521,7 +525,11 @@ module Aws::SageMaker
521
525
 
522
526
  # Associates a trial component with a trial. A trial component can be
523
527
  # associated with multiple trials. To disassociate a trial component
524
- # from a trial, call the DisassociateTrialComponent API.
528
+ # from a trial, call the [DisassociateTrialComponent][1] API.
529
+ #
530
+ #
531
+ #
532
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html
525
533
  #
526
534
  # @option params [required, String] :trial_component_name
527
535
  # The name of the component to associated with the trial.
@@ -1174,14 +1182,15 @@ module Aws::SageMaker
1174
1182
  # Creates an Autopilot job.
1175
1183
  #
1176
1184
  # Find the best-performing model after you run an Autopilot job by
1177
- # calling ` DescribeAutoMLJob `.
1185
+ # calling [DescribeAutoMLJob][1].
1178
1186
  #
1179
1187
  # For information about how to use Autopilot, see [Automate Model
1180
- # Development with Amazon SageMaker Autopilot][1].
1188
+ # Development with Amazon SageMaker Autopilot][2].
1181
1189
  #
1182
1190
  #
1183
1191
  #
1184
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html
1192
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html
1193
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development.html
1185
1194
  #
1186
1195
  # @option params [required, String] :auto_ml_job_name
1187
1196
  # Identifies an Autopilot job. The name must be unique to your account
@@ -1190,10 +1199,15 @@ module Aws::SageMaker
1190
1199
  # @option params [required, Array<Types::AutoMLChannel>] :input_data_config
1191
1200
  # An array of channel objects that describes the input data and its
1192
1201
  # location. Each channel is a named input source. Similar to
1193
- # `InputDataConfig` supported by ` HyperParameterTrainingJobDefinition
1194
- # `. Format(s) supported: CSV, Parquet. A minimum of 500 rows is
1195
- # required for the training dataset. There is not a minimum number of
1196
- # rows required for the validation dataset.
1202
+ # `InputDataConfig` supported by
1203
+ # [HyperParameterTrainingJobDefinition][1]. Format(s) supported: CSV,
1204
+ # Parquet. A minimum of 500 rows is required for the training dataset.
1205
+ # There is not a minimum number of rows required for the validation
1206
+ # dataset.
1207
+ #
1208
+ #
1209
+ #
1210
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html
1197
1211
  #
1198
1212
  # @option params [required, Types::AutoMLOutputDataConfig] :output_data_config
1199
1213
  # Provides information about encryption and the Amazon S3 output path
@@ -1211,9 +1225,14 @@ module Aws::SageMaker
1211
1225
  #
1212
1226
  # @option params [Types::AutoMLJobObjective] :auto_ml_job_objective
1213
1227
  # Defines the objective metric used to measure the predictive quality of
1214
- # an AutoML job. You provide an ` AutoMLJobObjective$MetricName ` and
1215
- # Autopilot infers whether to minimize or maximize it. For `
1216
- # CreateAutoMLJobV2 `, only `Accuracy` is supported.
1228
+ # an AutoML job. You provide an [AutoMLJobObjective$MetricName][1] and
1229
+ # Autopilot infers whether to minimize or maximize it. For
1230
+ # [CreateAutoMLJobV2][2], only `Accuracy` is supported.
1231
+ #
1232
+ #
1233
+ #
1234
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html
1235
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html
1217
1236
  #
1218
1237
  # @option params [Types::AutoMLJobConfig] :auto_ml_job_config
1219
1238
  # A collection of settings used to configure an AutoML job.
@@ -1329,24 +1348,29 @@ module Aws::SageMaker
1329
1348
  # as images or text for Computer Vision or Natural Language Processing
1330
1349
  # problems.
1331
1350
  #
1332
- # Find the resulting model after you run an AutoML job V2 by calling `
1333
- # DescribeAutoMLJobV2 `.
1351
+ # Find the resulting model after you run an AutoML job V2 by calling
1352
+ # [DescribeAutoMLJobV2][1].
1334
1353
  #
1335
- # To create an `AutoMLJob` using tabular data, see ` CreateAutoMLJob `.
1354
+ # To create an `AutoMLJob` using tabular data, see [CreateAutoMLJob][2].
1336
1355
  #
1337
1356
  # <note markdown="1"> This API action is callable through SageMaker Canvas only. Calling it
1338
1357
  # directly from the CLI or an SDK results in an error.
1339
1358
  #
1340
1359
  # </note>
1341
1360
  #
1361
+ #
1362
+ #
1363
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html
1364
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html
1365
+ #
1342
1366
  # @option params [required, String] :auto_ml_job_name
1343
1367
  # Identifies an Autopilot job. The name must be unique to your account
1344
1368
  # and is case insensitive.
1345
1369
  #
1346
1370
  # @option params [required, Array<Types::AutoMLJobChannel>] :auto_ml_job_input_data_config
1347
1371
  # An array of channel objects describing the input data and their
1348
- # location. Each channel is a named input source. Similar to `
1349
- # InputDataConfig ` supported by `CreateAutoMLJob`. The supported
1372
+ # location. Each channel is a named input source. Similar to
1373
+ # [InputDataConfig][1] supported by `CreateAutoMLJob`. The supported
1350
1374
  # formats depend on the problem type:
1351
1375
  #
1352
1376
  # * ImageClassification: S3Prefix, `ManifestFile`,
@@ -1354,6 +1378,10 @@ module Aws::SageMaker
1354
1378
  #
1355
1379
  # * TextClassification: S3Prefix
1356
1380
  #
1381
+ #
1382
+ #
1383
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html#sagemaker-CreateAutoMLJob-request-InputDataConfig
1384
+ #
1357
1385
  # @option params [required, Types::AutoMLOutputDataConfig] :output_data_config
1358
1386
  # Provides information about encryption and the Amazon S3 output path
1359
1387
  # needed to store artifacts from an AutoML job.
@@ -1381,7 +1409,11 @@ module Aws::SageMaker
1381
1409
  #
1382
1410
  # @option params [Types::AutoMLJobObjective] :auto_ml_job_objective
1383
1411
  # Specifies a metric to minimize or maximize as the objective of a job.
1384
- # For ` CreateAutoMLJobV2 `, only `Accuracy` is supported.
1412
+ # For [CreateAutoMLJobV2][1], only `Accuracy` is supported.
1413
+ #
1414
+ #
1415
+ #
1416
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html
1385
1417
  #
1386
1418
  # @option params [Types::ModelDeployConfig] :model_deploy_config
1387
1419
  # Specifies how to generate the endpoint name for an automatic one-click
@@ -1574,10 +1606,16 @@ module Aws::SageMaker
1574
1606
  # resource use and costs. The response body contains the
1575
1607
  # `CompilationJobArn` for the compiled job.
1576
1608
  #
1577
- # To stop a model compilation job, use StopCompilationJob. To get
1609
+ # To stop a model compilation job, use [StopCompilationJob][1]. To get
1578
1610
  # information about a particular model compilation job, use
1579
- # DescribeCompilationJob. To get information about multiple model
1580
- # compilation jobs, use ListCompilationJobs.
1611
+ # [DescribeCompilationJob][2]. To get information about multiple model
1612
+ # compilation jobs, use [ListCompilationJobs][3].
1613
+ #
1614
+ #
1615
+ #
1616
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopCompilationJob.html
1617
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html
1618
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html
1581
1619
  #
1582
1620
  # @option params [required, String] :compilation_job_name
1583
1621
  # A name for the model compilation job. The name must be unique within
@@ -1623,14 +1661,15 @@ module Aws::SageMaker
1623
1661
  # and the target device the model runs on.
1624
1662
  #
1625
1663
  # @option params [Types::NeoVpcConfig] :vpc_config
1626
- # A VpcConfig object that specifies the VPC that you want your
1664
+ # A [VpcConfig][1] object that specifies the VPC that you want your
1627
1665
  # compilation job to connect to. Control access to your models by
1628
1666
  # configuring the VPC. For more information, see [Protect Compilation
1629
- # Jobs by Using an Amazon Virtual Private Cloud][1].
1667
+ # Jobs by Using an Amazon Virtual Private Cloud][2].
1630
1668
  #
1631
1669
  #
1632
1670
  #
1633
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html
1671
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
1672
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html
1634
1673
  #
1635
1674
  # @option params [required, Types::StoppingCondition] :stopping_condition
1636
1675
  # Specifies a limit to how long a model compilation job can run. When
@@ -2187,6 +2226,10 @@ module Aws::SageMaker
2187
2226
  # status: "ENABLED", # accepts ENABLED, DISABLED
2188
2227
  # amazon_forecast_role_arn: "RoleArn",
2189
2228
  # },
2229
+ # model_register_settings: {
2230
+ # status: "ENABLED", # accepts ENABLED, DISABLED
2231
+ # cross_account_model_register_role_arn: "RoleArn",
2232
+ # },
2190
2233
  # },
2191
2234
  # },
2192
2235
  # subnet_ids: ["SubnetId"], # required
@@ -2444,13 +2487,13 @@ module Aws::SageMaker
2444
2487
  # Creates an endpoint using the endpoint configuration specified in the
2445
2488
  # request. SageMaker uses the endpoint to provision resources and deploy
2446
2489
  # models. You create the endpoint configuration with the
2447
- # CreateEndpointConfig API.
2490
+ # [CreateEndpointConfig][1] API.
2448
2491
  #
2449
2492
  # Use this API to deploy models using SageMaker hosting services.
2450
2493
  #
2451
2494
  # For an example that calls this method when deploying a model to
2452
2495
  # SageMaker hosting services, see the [Create Endpoint example
2453
- # notebook.][1]
2496
+ # notebook.][2]
2454
2497
  #
2455
2498
  # <note markdown="1"> You must not delete an `EndpointConfig` that is in use by an endpoint
2456
2499
  # that is live or while the `UpdateEndpoint` or `CreateEndpoint`
@@ -2466,17 +2509,18 @@ module Aws::SageMaker
2466
2509
  # the resources (ML compute instances), and deploys the model(s) on
2467
2510
  # them.
2468
2511
  #
2469
- # <note markdown="1"> When you call CreateEndpoint, a load call is made to DynamoDB to
2512
+ # <note markdown="1"> When you call [CreateEndpoint][3], a load call is made to DynamoDB to
2470
2513
  # verify that your endpoint configuration exists. When you read data
2471
- # from a DynamoDB table supporting [ `Eventually Consistent Reads` ][2],
2514
+ # from a DynamoDB table supporting [ `Eventually Consistent Reads` ][4],
2472
2515
  # the response might not reflect the results of a recently completed
2473
2516
  # write operation. The response might include some stale data. If the
2474
2517
  # dependent entities are not yet in DynamoDB, this causes a validation
2475
2518
  # error. If you repeat your read request after a short time, the
2476
2519
  # response should return the latest data. So retry logic is recommended
2477
2520
  # to handle these possible issues. We also recommend that customers call
2478
- # DescribeEndpointConfig before calling CreateEndpoint to minimize the
2479
- # potential impact of a DynamoDB eventually consistent read.
2521
+ # [DescribeEndpointConfig][5] before calling [CreateEndpoint][3] to
2522
+ # minimize the potential impact of a DynamoDB eventually consistent
2523
+ # read.
2480
2524
  #
2481
2525
  # </note>
2482
2526
  #
@@ -2484,7 +2528,7 @@ module Aws::SageMaker
2484
2528
  # `Creating`. After it creates the endpoint, it sets the status to
2485
2529
  # `InService`. SageMaker can then process incoming requests for
2486
2530
  # inferences. To check the status of an endpoint, use the
2487
- # DescribeEndpoint API.
2531
+ # [DescribeEndpoint][6] API.
2488
2532
  #
2489
2533
  # If any of the models hosted at this endpoint get model data from an
2490
2534
  # Amazon S3 location, SageMaker uses Amazon Web Services Security Token
@@ -2493,14 +2537,14 @@ module Aws::SageMaker
2493
2537
  # account by default. If you previously deactivated Amazon Web Services
2494
2538
  # STS for a region, you need to reactivate Amazon Web Services STS for
2495
2539
  # that region. For more information, see [Activating and Deactivating
2496
- # Amazon Web Services STS in an Amazon Web Services Region][3] in the
2540
+ # Amazon Web Services STS in an Amazon Web Services Region][7] in the
2497
2541
  # *Amazon Web Services Identity and Access Management User Guide*.
2498
2542
  #
2499
2543
  # <note markdown="1"> To add the IAM role policies for using this API operation, go to the
2500
- # [IAM console][4], and choose Roles in the left navigation pane. Search
2501
- # the IAM role that you want to grant access to use the CreateEndpoint
2502
- # and CreateEndpointConfig API operations, add the following policies to
2503
- # the role.
2544
+ # [IAM console][8], and choose Roles in the left navigation pane. Search
2545
+ # the IAM role that you want to grant access to use the
2546
+ # [CreateEndpoint][3] and [CreateEndpointConfig][1] API operations, add
2547
+ # the following policies to the role.
2504
2548
  #
2505
2549
  # * Option 1: For a full SageMaker access, search and attach the
2506
2550
  # `AmazonSageMakerFullAccess` policy.
@@ -2521,27 +2565,39 @@ module Aws::SageMaker
2521
2565
  # `]`
2522
2566
  #
2523
2567
  # For more information, see [SageMaker API Permissions: Actions,
2524
- # Permissions, and Resources Reference][5].
2568
+ # Permissions, and Resources Reference][9].
2525
2569
  #
2526
2570
  # </note>
2527
2571
  #
2528
2572
  #
2529
2573
  #
2530
- # [1]: https://github.com/aws/amazon-sagemaker-examples/blob/master/sagemaker-fundamentals/create-endpoint/create_endpoint.ipynb
2531
- # [2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html
2532
- # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
2533
- # [4]: https://console.aws.amazon.com/iam/
2534
- # [5]: https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html
2574
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html
2575
+ # [2]: https://github.com/aws/amazon-sagemaker-examples/blob/master/sagemaker-fundamentals/create-endpoint/create_endpoint.ipynb
2576
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html
2577
+ # [4]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html
2578
+ # [5]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html
2579
+ # [6]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html
2580
+ # [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
2581
+ # [8]: https://console.aws.amazon.com/iam/
2582
+ # [9]: https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html
2535
2583
  #
2536
2584
  # @option params [required, String] :endpoint_name
2537
2585
  # The name of the endpoint.The name must be unique within an Amazon Web
2538
2586
  # Services Region in your Amazon Web Services account. The name is
2539
2587
  # case-insensitive in `CreateEndpoint`, but the case is preserved and
2540
- # must be matched in .
2588
+ # must be matched in [InvokeEndpoint][1].
2589
+ #
2590
+ #
2591
+ #
2592
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html
2541
2593
  #
2542
2594
  # @option params [required, String] :endpoint_config_name
2543
2595
  # The name of an endpoint configuration. For more information, see
2544
- # CreateEndpointConfig.
2596
+ # [CreateEndpointConfig][1].
2597
+ #
2598
+ #
2599
+ #
2600
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html
2545
2601
  #
2546
2602
  # @option params [Types::DeploymentConfig] :deployment_config
2547
2603
  # The deployment configuration for an endpoint, which contains the
@@ -2616,7 +2672,7 @@ module Aws::SageMaker
2616
2672
  # to deploy models. In the configuration, you identify one or more
2617
2673
  # models, created using the `CreateModel` API, to deploy and the
2618
2674
  # resources that you want SageMaker to provision. Then you call the
2619
- # CreateEndpoint API.
2675
+ # [CreateEndpoint][1] API.
2620
2676
  #
2621
2677
  # <note markdown="1"> Use this API if you want to use SageMaker hosting services to deploy
2622
2678
  # models into production.
@@ -2635,27 +2691,34 @@ module Aws::SageMaker
2635
2691
  # distributes two-thirds of the traffic to Model A, and one-third to
2636
2692
  # model B.
2637
2693
  #
2638
- # <note markdown="1"> When you call CreateEndpoint, a load call is made to DynamoDB to
2694
+ # <note markdown="1"> When you call [CreateEndpoint][1], a load call is made to DynamoDB to
2639
2695
  # verify that your endpoint configuration exists. When you read data
2640
- # from a DynamoDB table supporting [ `Eventually Consistent Reads` ][1],
2696
+ # from a DynamoDB table supporting [ `Eventually Consistent Reads` ][2],
2641
2697
  # the response might not reflect the results of a recently completed
2642
2698
  # write operation. The response might include some stale data. If the
2643
2699
  # dependent entities are not yet in DynamoDB, this causes a validation
2644
2700
  # error. If you repeat your read request after a short time, the
2645
2701
  # response should return the latest data. So retry logic is recommended
2646
2702
  # to handle these possible issues. We also recommend that customers call
2647
- # DescribeEndpointConfig before calling CreateEndpoint to minimize the
2648
- # potential impact of a DynamoDB eventually consistent read.
2703
+ # [DescribeEndpointConfig][3] before calling [CreateEndpoint][1] to
2704
+ # minimize the potential impact of a DynamoDB eventually consistent
2705
+ # read.
2649
2706
  #
2650
2707
  # </note>
2651
2708
  #
2652
2709
  #
2653
2710
  #
2654
- # [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html
2711
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html
2712
+ # [2]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html
2713
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html
2655
2714
  #
2656
2715
  # @option params [required, String] :endpoint_config_name
2657
2716
  # The name of the endpoint configuration. You specify this name in a
2658
- # CreateEndpoint request.
2717
+ # [CreateEndpoint][1] request.
2718
+ #
2719
+ #
2720
+ #
2721
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html
2659
2722
  #
2660
2723
  # @option params [required, Array<Types::ProductionVariant>] :production_variants
2661
2724
  # An array of `ProductionVariant` objects, one for each model that you
@@ -2797,11 +2860,13 @@ module Aws::SageMaker
2797
2860
  # },
2798
2861
  # output_config: { # required
2799
2862
  # kms_key_id: "KmsKeyId",
2800
- # s3_output_path: "DestinationS3Uri", # required
2863
+ # s3_output_path: "DestinationS3Uri",
2801
2864
  # notification_config: {
2802
2865
  # success_topic: "SnsTopicArn",
2803
2866
  # error_topic: "SnsTopicArn",
2867
+ # include_inference_response_in: ["SUCCESS_NOTIFICATION_TOPIC"], # accepts SUCCESS_NOTIFICATION_TOPIC, ERROR_NOTIFICATION_TOPIC
2804
2868
  # },
2869
+ # s3_failure_path: "DestinationS3Uri",
2805
2870
  # },
2806
2871
  # },
2807
2872
  # explainer_config: {
@@ -2894,16 +2959,26 @@ module Aws::SageMaker
2894
2959
  # Python (Boto), you must use the logging APIs provided by the SDK.
2895
2960
  #
2896
2961
  # You can add tags to experiments, trials, trial components and then use
2897
- # the Search API to search for the tags.
2962
+ # the [Search][1] API to search for the tags.
2898
2963
  #
2899
2964
  # To add a description to an experiment, specify the optional
2900
2965
  # `Description` parameter. To add a description later, or to change the
2901
- # description, call the UpdateExperiment API.
2966
+ # description, call the [UpdateExperiment][2] API.
2902
2967
  #
2903
- # To get a list of all your experiments, call the ListExperiments API.
2904
- # To view an experiment's properties, call the DescribeExperiment API.
2905
- # To get a list of all the trials associated with an experiment, call
2906
- # the ListTrials API. To create a trial call the CreateTrial API.
2968
+ # To get a list of all your experiments, call the [ListExperiments][3]
2969
+ # API. To view an experiment's properties, call the
2970
+ # [DescribeExperiment][4] API. To get a list of all the trials
2971
+ # associated with an experiment, call the [ListTrials][5] API. To create
2972
+ # a trial call the [CreateTrial][6] API.
2973
+ #
2974
+ #
2975
+ #
2976
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
2977
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateExperiment.html
2978
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListExperiments.html
2979
+ # [4]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html
2980
+ # [5]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html
2981
+ # [6]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrial.html
2907
2982
  #
2908
2983
  # @option params [required, String] :experiment_name
2909
2984
  # The name of the experiment. The name must be unique in your Amazon Web
@@ -2918,8 +2993,12 @@ module Aws::SageMaker
2918
2993
  # The description of the experiment.
2919
2994
  #
2920
2995
  # @option params [Array<Types::Tag>] :tags
2921
- # A list of tags to associate with the experiment. You can use Search
2922
- # API to search on the tags.
2996
+ # A list of tags to associate with the experiment. You can use
2997
+ # [Search][1] API to search on the tags.
2998
+ #
2999
+ #
3000
+ #
3001
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
2923
3002
  #
2924
3003
  # @return [Types::CreateExperimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2925
3004
  #
@@ -3032,12 +3111,13 @@ module Aws::SageMaker
3032
3111
  #
3033
3112
  # @option params [Types::OnlineStoreConfig] :online_store_config
3034
3113
  # You can turn the `OnlineStore` on or off by specifying `True` for the
3035
- # `EnableOnlineStore` flag in `OnlineStoreConfig`; the default value is
3036
- # `False`.
3114
+ # `EnableOnlineStore` flag in `OnlineStoreConfig`.
3037
3115
  #
3038
3116
  # You can also include an Amazon Web Services KMS key ID (`KMSKeyId`)
3039
3117
  # for at-rest encryption of the `OnlineStore`.
3040
3118
  #
3119
+ # The default value is `False`.
3120
+ #
3041
3121
  # @option params [Types::OfflineStoreConfig] :offline_store_config
3042
3122
  # Use this to configure an `OfflineFeatureStore`. This parameter allows
3043
3123
  # you to specify:
@@ -3057,12 +3137,13 @@ module Aws::SageMaker
3057
3137
  # * Format for the offline store table. Supported formats are Glue
3058
3138
  # (Default) and [Apache Iceberg][2].
3059
3139
  #
3060
- # To learn more about this parameter, see OfflineStoreConfig.
3140
+ # To learn more about this parameter, see [OfflineStoreConfig][3].
3061
3141
  #
3062
3142
  #
3063
3143
  #
3064
3144
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html
3065
3145
  # [2]: https://iceberg.apache.org/
3146
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html
3066
3147
  #
3067
3148
  # @option params [String] :role_arn
3068
3149
  # The Amazon Resource Name (ARN) of the IAM execution role used to
@@ -3362,25 +3443,34 @@ module Aws::SageMaker
3362
3443
  # not case sensitive.
3363
3444
  #
3364
3445
  # @option params [required, Types::HyperParameterTuningJobConfig] :hyper_parameter_tuning_job_config
3365
- # The HyperParameterTuningJobConfig object that describes the tuning
3366
- # job, including the search strategy, the objective metric used to
3367
- # evaluate training jobs, ranges of parameters to search, and resource
3368
- # limits for the tuning job. For more information, see [How
3369
- # Hyperparameter Tuning Works][1].
3446
+ # The [HyperParameterTuningJobConfig][1] object that describes the
3447
+ # tuning job, including the search strategy, the objective metric used
3448
+ # to evaluate training jobs, ranges of parameters to search, and
3449
+ # resource limits for the tuning job. For more information, see [How
3450
+ # Hyperparameter Tuning Works][2].
3370
3451
  #
3371
3452
  #
3372
3453
  #
3373
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html
3454
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html
3455
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html
3374
3456
  #
3375
3457
  # @option params [Types::HyperParameterTrainingJobDefinition] :training_job_definition
3376
- # The HyperParameterTrainingJobDefinition object that describes the
3458
+ # The [HyperParameterTrainingJobDefinition][1] object that describes the
3377
3459
  # training jobs that this tuning job launches, including static
3378
3460
  # hyperparameters, input data configuration, output data configuration,
3379
3461
  # resource configuration, and stopping condition.
3380
3462
  #
3463
+ #
3464
+ #
3465
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html
3466
+ #
3381
3467
  # @option params [Array<Types::HyperParameterTrainingJobDefinition>] :training_job_definitions
3382
- # A list of the HyperParameterTrainingJobDefinition objects launched for
3383
- # this tuning job.
3468
+ # A list of the [HyperParameterTrainingJobDefinition][1] objects
3469
+ # launched for this tuning job.
3470
+ #
3471
+ #
3472
+ #
3473
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html
3384
3474
  #
3385
3475
  # @option params [Types::HyperParameterTuningJobWarmStartConfig] :warm_start_config
3386
3476
  # Specifies the configuration for starting the hyperparameter tuning job
@@ -4128,7 +4218,10 @@ module Aws::SageMaker
4128
4218
  # @option params [required, String] :job_name
4129
4219
  # A name for the recommendation job. The name must be unique within the
4130
4220
  # Amazon Web Services Region and within your Amazon Web Services
4131
- # account.
4221
+ # account. The job name is passed down to the resources created by the
4222
+ # recommendation job. The names of resources (such as the model,
4223
+ # endpoint configuration, endpoint, and compilation) that are prefixed
4224
+ # with the job name are truncated at 40 characters.
4132
4225
  #
4133
4226
  # @option params [required, String] :job_type
4134
4227
  # Defines the type of recommendation job. Specify `Default` to initiate
@@ -4653,17 +4746,18 @@ module Aws::SageMaker
4653
4746
  # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
4654
4747
  #
4655
4748
  # @option params [Types::VpcConfig] :vpc_config
4656
- # A VpcConfig object that specifies the VPC that you want your model to
4657
- # connect to. Control access to and from your model container by
4658
- # configuring the VPC. `VpcConfig` is used in hosting services and in
4749
+ # A [VpcConfig][1] object that specifies the VPC that you want your
4750
+ # model to connect to. Control access to and from your model container
4751
+ # by configuring the VPC. `VpcConfig` is used in hosting services and in
4659
4752
  # batch transform. For more information, see [Protect Endpoints by Using
4660
- # an Amazon Virtual Private Cloud][1] and [Protect Data in Batch
4661
- # Transform Jobs by Using an Amazon Virtual Private Cloud][2].
4753
+ # an Amazon Virtual Private Cloud][2] and [Protect Data in Batch
4754
+ # Transform Jobs by Using an Amazon Virtual Private Cloud][3].
4662
4755
  #
4663
4756
  #
4664
4757
  #
4665
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html
4666
- # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html
4758
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
4759
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html
4760
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html
4667
4761
  #
4668
4762
  # @option params [Boolean] :enable_network_isolation
4669
4763
  # Isolates the model container. No inbound or outbound network calls can
@@ -4927,7 +5021,7 @@ module Aws::SageMaker
4927
5021
  #
4928
5022
  #
4929
5023
  #
4930
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html
5024
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema
4931
5025
  #
4932
5026
  # @option params [required, String] :model_card_status
4933
5027
  # The approval status of the model card within your organization.
@@ -6393,16 +6487,17 @@ module Aws::SageMaker
6393
6487
  # notebook instance. For more information, see [Limit Access to a
6394
6488
  # Notebook Instance by IP Address][1].
6395
6489
  #
6396
- # <note markdown="1"> The URL that you get from a call to CreatePresignedNotebookInstanceUrl
6397
- # is valid only for 5 minutes. If you try to use the URL after the
6398
- # 5-minute limit expires, you are directed to the Amazon Web Services
6399
- # console sign-in page.
6490
+ # <note markdown="1"> The URL that you get from a call to
6491
+ # [CreatePresignedNotebookInstanceUrl][2] is valid only for 5 minutes.
6492
+ # If you try to use the URL after the 5-minute limit expires, you are
6493
+ # directed to the Amazon Web Services console sign-in page.
6400
6494
  #
6401
6495
  # </note>
6402
6496
  #
6403
6497
  #
6404
6498
  #
6405
6499
  # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/security_iam_id-based-policy-examples.html#nbi-ip-filter
6500
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreatePresignedNotebookInstanceUrl.html
6406
6501
  #
6407
6502
  # @option params [required, String] :notebook_instance_name
6408
6503
  # The name of the notebook instance.
@@ -6486,11 +6581,17 @@ module Aws::SageMaker
6486
6581
  # Associates a SageMaker job as a trial component with an experiment and
6487
6582
  # trial. Specified when you call the following APIs:
6488
6583
  #
6489
- # * CreateProcessingJob
6584
+ # * [CreateProcessingJob][1]
6585
+ #
6586
+ # * [CreateTrainingJob][2]
6587
+ #
6588
+ # * [CreateTransformJob][3]
6589
+ #
6490
6590
  #
6491
- # * CreateTrainingJob
6492
6591
  #
6493
- # * CreateTransformJob
6592
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
6593
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
6594
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
6494
6595
  #
6495
6596
  # @return [Types::CreateProcessingJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6496
6597
  #
@@ -6963,14 +7064,15 @@ module Aws::SageMaker
6963
7064
  # an instance count greater than 1.
6964
7065
  #
6965
7066
  # @option params [Types::VpcConfig] :vpc_config
6966
- # A VpcConfig object that specifies the VPC that you want your training
6967
- # job to connect to. Control access to and from your training container
6968
- # by configuring the VPC. For more information, see [Protect Training
6969
- # Jobs by Using an Amazon Virtual Private Cloud][1].
7067
+ # A [VpcConfig][1] object that specifies the VPC that you want your
7068
+ # training job to connect to. Control access to and from your training
7069
+ # container by configuring the VPC. For more information, see [Protect
7070
+ # Training Jobs by Using an Amazon Virtual Private Cloud][2].
6970
7071
  #
6971
7072
  #
6972
7073
  #
6973
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html
7074
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html
7075
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html
6974
7076
  #
6975
7077
  # @option params [required, Types::StoppingCondition] :stopping_condition
6976
7078
  # Specifies a limit to how long a model training job can run. It also
@@ -7055,11 +7157,17 @@ module Aws::SageMaker
7055
7157
  # Associates a SageMaker job as a trial component with an experiment and
7056
7158
  # trial. Specified when you call the following APIs:
7057
7159
  #
7058
- # * CreateProcessingJob
7160
+ # * [CreateProcessingJob][1]
7059
7161
  #
7060
- # * CreateTrainingJob
7162
+ # * [CreateTrainingJob][2]
7061
7163
  #
7062
- # * CreateTransformJob
7164
+ # * [CreateTransformJob][3]
7165
+ #
7166
+ #
7167
+ #
7168
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
7169
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
7170
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
7063
7171
  #
7064
7172
  # @option params [Types::ProfilerConfig] :profiler_config
7065
7173
  # Configuration information for Amazon SageMaker Debugger system
@@ -7397,11 +7505,17 @@ module Aws::SageMaker
7397
7505
  # Associates a SageMaker job as a trial component with an experiment and
7398
7506
  # trial. Specified when you call the following APIs:
7399
7507
  #
7400
- # * CreateProcessingJob
7508
+ # * [CreateProcessingJob][1]
7509
+ #
7510
+ # * [CreateTrainingJob][2]
7511
+ #
7512
+ # * [CreateTransformJob][3]
7401
7513
  #
7402
- # * CreateTrainingJob
7403
7514
  #
7404
- # * CreateTransformJob
7515
+ #
7516
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html
7517
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html
7518
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html
7405
7519
  #
7406
7520
  # @return [Types::CreateTransformJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7407
7521
  #
@@ -7490,12 +7604,19 @@ module Aws::SageMaker
7490
7604
  # logged, and indexed. When you use the Amazon Web Services SDK for
7491
7605
  # Python (Boto), you must use the logging APIs provided by the SDK.
7492
7606
  #
7493
- # You can add tags to a trial and then use the Search API to search for
7494
- # the tags.
7607
+ # You can add tags to a trial and then use the [Search][1] API to search
7608
+ # for the tags.
7609
+ #
7610
+ # To get a list of all your trials, call the [ListTrials][2] API. To
7611
+ # view a trial's properties, call the [DescribeTrial][3] API. To create
7612
+ # a trial component, call the [CreateTrialComponent][4] API.
7613
+ #
7614
+ #
7495
7615
  #
7496
- # To get a list of all your trials, call the ListTrials API. To view a
7497
- # trial's properties, call the DescribeTrial API. To create a trial
7498
- # component, call the CreateTrialComponent API.
7616
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
7617
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html
7618
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html
7619
+ # [4]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html
7499
7620
  #
7500
7621
  # @option params [required, String] :trial_name
7501
7622
  # The name of the trial. The name must be unique in your Amazon Web
@@ -7512,8 +7633,12 @@ module Aws::SageMaker
7512
7633
  # Metadata properties of the tracking entity, trial, or trial component.
7513
7634
  #
7514
7635
  # @option params [Array<Types::Tag>] :tags
7515
- # A list of tags to associate with the trial. You can use Search API to
7516
- # search on the tags.
7636
+ # A list of tags to associate with the trial. You can use [Search][1]
7637
+ # API to search on the tags.
7638
+ #
7639
+ #
7640
+ #
7641
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
7517
7642
  #
7518
7643
  # @return [Types::CreateTrialResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7519
7644
  #
@@ -7564,8 +7689,12 @@ module Aws::SageMaker
7564
7689
  # logged, and indexed. When you use the Amazon Web Services SDK for
7565
7690
  # Python (Boto), you must use the logging APIs provided by the SDK.
7566
7691
  #
7567
- # You can add tags to a trial component and then use the Search API to
7568
- # search for the tags.
7692
+ # You can add tags to a trial component and then use the [Search][1] API
7693
+ # to search for the tags.
7694
+ #
7695
+ #
7696
+ #
7697
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
7569
7698
  #
7570
7699
  # @option params [required, String] :trial_component_name
7571
7700
  # The name of the component. The name must be unique in your Amazon Web
@@ -7607,8 +7736,12 @@ module Aws::SageMaker
7607
7736
  # Metadata properties of the tracking entity, trial, or trial component.
7608
7737
  #
7609
7738
  # @option params [Array<Types::Tag>] :tags
7610
- # A list of tags to associate with the component. You can use Search API
7611
- # to search on the tags.
7739
+ # A list of tags to associate with the component. You can use
7740
+ # [Search][1] API to search on the tags.
7741
+ #
7742
+ #
7743
+ #
7744
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
7612
7745
  #
7613
7746
  # @return [Types::CreateTrialComponentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7614
7747
  #
@@ -7797,6 +7930,10 @@ module Aws::SageMaker
7797
7930
  # status: "ENABLED", # accepts ENABLED, DISABLED
7798
7931
  # amazon_forecast_role_arn: "RoleArn",
7799
7932
  # },
7933
+ # model_register_settings: {
7934
+ # status: "ENABLED", # accepts ENABLED, DISABLED
7935
+ # cross_account_model_register_role_arn: "RoleArn",
7936
+ # },
7800
7937
  # },
7801
7938
  # },
7802
7939
  # })
@@ -7820,25 +7957,26 @@ module Aws::SageMaker
7820
7957
  # Amazon Web Services Region per Amazon Web Services account.
7821
7958
  #
7822
7959
  # If you want to create a new workforce in an Amazon Web Services Region
7823
- # where a workforce already exists, use the API operation to delete the
7824
- # existing workforce and then use `CreateWorkforce` to create a new
7825
- # workforce.
7960
+ # where a workforce already exists, use the [DeleteWorkforce][1] API
7961
+ # operation to delete the existing workforce and then use
7962
+ # `CreateWorkforce` to create a new workforce.
7826
7963
  #
7827
7964
  # To create a private workforce using Amazon Cognito, you must specify a
7828
7965
  # Cognito user pool in `CognitoConfig`. You can also create an Amazon
7829
7966
  # Cognito workforce using the Amazon SageMaker console. For more
7830
- # information, see [ Create a Private Workforce (Amazon Cognito)][1].
7967
+ # information, see [ Create a Private Workforce (Amazon Cognito)][2].
7831
7968
  #
7832
7969
  # To create a private workforce using your own OIDC Identity Provider
7833
7970
  # (IdP), specify your IdP configuration in `OidcConfig`. Your OIDC IdP
7834
7971
  # must support *groups* because groups are used by Ground Truth and
7835
7972
  # Amazon A2I to create work teams. For more information, see [ Create a
7836
- # Private Workforce (OIDC IdP)][2].
7973
+ # Private Workforce (OIDC IdP)][3].
7837
7974
  #
7838
7975
  #
7839
7976
  #
7840
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html
7841
- # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private-oidc.html
7977
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkforce.html
7978
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html
7979
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private-oidc.html
7842
7980
  #
7843
7981
  # @option params [Types::CognitoConfig] :cognito_config
7844
7982
  # Use this parameter to configure an Amazon Cognito private workforce. A
@@ -8466,8 +8604,12 @@ module Aws::SageMaker
8466
8604
  end
8467
8605
 
8468
8606
  # Deletes an SageMaker experiment. All trials associated with the
8469
- # experiment must be deleted first. Use the ListTrials API to get a list
8470
- # of the trials associated with the experiment.
8607
+ # experiment must be deleted first. Use the [ListTrials][1] API to get a
8608
+ # list of the trials associated with the experiment.
8609
+ #
8610
+ #
8611
+ #
8612
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html
8471
8613
  #
8472
8614
  # @option params [required, String] :experiment_name
8473
8615
  # The name of the experiment to delete.
@@ -8615,8 +8757,12 @@ module Aws::SageMaker
8615
8757
  # template).
8616
8758
  #
8617
8759
  # To see a list of human task user interfaces (work task templates) in
8618
- # your account, use . When you delete a worker task template, it no
8619
- # longer appears when you call `ListHumanTaskUis`.
8760
+ # your account, use [ListHumanTaskUis][1]. When you delete a worker task
8761
+ # template, it no longer appears when you call `ListHumanTaskUis`.
8762
+ #
8763
+ #
8764
+ #
8765
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListHumanTaskUis.html
8620
8766
  #
8621
8767
  # @option params [required, String] :human_task_ui_name
8622
8768
  # The name of the human task user interface (work task template) you
@@ -9144,8 +9290,12 @@ module Aws::SageMaker
9144
9290
  end
9145
9291
 
9146
9292
  # Deletes the specified trial. All trial components that make up the
9147
- # trial must be deleted first. Use the DescribeTrialComponent API to get
9148
- # the list of trial components.
9293
+ # trial must be deleted first. Use the [DescribeTrialComponent][1] API
9294
+ # to get the list of trial components.
9295
+ #
9296
+ #
9297
+ #
9298
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html
9149
9299
  #
9150
9300
  # @option params [required, String] :trial_name
9151
9301
  # The name of the trial to delete.
@@ -9176,7 +9326,11 @@ module Aws::SageMaker
9176
9326
  # Deletes the specified trial component. A trial component must be
9177
9327
  # disassociated from all trials before the trial component can be
9178
9328
  # deleted. To disassociate a trial component from a trial, call the
9179
- # DisassociateTrialComponent API.
9329
+ # [DisassociateTrialComponent][1] API.
9330
+ #
9331
+ #
9332
+ #
9333
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html
9180
9334
  #
9181
9335
  # @option params [required, String] :trial_component_name
9182
9336
  # The name of the component to delete.
@@ -9236,12 +9390,18 @@ module Aws::SageMaker
9236
9390
  #
9237
9391
  # If you want to create a new workforce in an Amazon Web Services Region
9238
9392
  # where a workforce already exists, use this operation to delete the
9239
- # existing workforce and then use to create a new workforce.
9393
+ # existing workforce and then use [CreateWorkforce][1] to create a new
9394
+ # workforce.
9240
9395
  #
9241
9396
  # If a private workforce contains one or more work teams, you must use
9242
- # the operation to delete all work teams before you delete the
9243
- # workforce. If you try to delete a workforce that contains one or more
9244
- # work teams, you will recieve a `ResourceInUse` error.
9397
+ # the [DeleteWorkteam][2] operation to delete all work teams before you
9398
+ # delete the workforce. If you try to delete a workforce that contains
9399
+ # one or more work teams, you will recieve a `ResourceInUse` error.
9400
+ #
9401
+ #
9402
+ #
9403
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateWorkforce.html
9404
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html
9245
9405
  #
9246
9406
  # @option params [required, String] :workforce_name
9247
9407
  # The name of the workforce.
@@ -10012,9 +10172,14 @@ module Aws::SageMaker
10012
10172
 
10013
10173
  # Returns information about a model compilation job.
10014
10174
  #
10015
- # To create a model compilation job, use CreateCompilationJob. To get
10016
- # information about multiple model compilation jobs, use
10017
- # ListCompilationJobs.
10175
+ # To create a model compilation job, use [CreateCompilationJob][1]. To
10176
+ # get information about multiple model compilation jobs, use
10177
+ # [ListCompilationJobs][2].
10178
+ #
10179
+ #
10180
+ #
10181
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html
10182
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html
10018
10183
  #
10019
10184
  # @option params [required, String] :compilation_job_name
10020
10185
  # The name of the model compilation job that you want information about.
@@ -10431,6 +10596,8 @@ module Aws::SageMaker
10431
10596
  # resp.default_user_settings.r_session_app_settings.custom_images[0].app_image_config_name #=> String
10432
10597
  # resp.default_user_settings.canvas_app_settings.time_series_forecasting_settings.status #=> String, one of "ENABLED", "DISABLED"
10433
10598
  # resp.default_user_settings.canvas_app_settings.time_series_forecasting_settings.amazon_forecast_role_arn #=> String
10599
+ # resp.default_user_settings.canvas_app_settings.model_register_settings.status #=> String, one of "ENABLED", "DISABLED"
10600
+ # resp.default_user_settings.canvas_app_settings.model_register_settings.cross_account_model_register_role_arn #=> String
10434
10601
  # resp.app_network_access_type #=> String, one of "PublicInternetOnly", "VpcOnly"
10435
10602
  # resp.home_efs_file_system_kms_key_id #=> String
10436
10603
  # resp.subnet_ids #=> Array
@@ -10690,6 +10857,9 @@ module Aws::SageMaker
10690
10857
  # resp.async_inference_config.output_config.s3_output_path #=> String
10691
10858
  # resp.async_inference_config.output_config.notification_config.success_topic #=> String
10692
10859
  # resp.async_inference_config.output_config.notification_config.error_topic #=> String
10860
+ # resp.async_inference_config.output_config.notification_config.include_inference_response_in #=> Array
10861
+ # resp.async_inference_config.output_config.notification_config.include_inference_response_in[0] #=> String, one of "SUCCESS_NOTIFICATION_TOPIC", "ERROR_NOTIFICATION_TOPIC"
10862
+ # resp.async_inference_config.output_config.s3_failure_path #=> String
10693
10863
  # resp.pending_deployment_summary.endpoint_config_name #=> String
10694
10864
  # resp.pending_deployment_summary.production_variants #=> Array
10695
10865
  # resp.pending_deployment_summary.production_variants[0].variant_name #=> String
@@ -10849,6 +11019,9 @@ module Aws::SageMaker
10849
11019
  # resp.async_inference_config.output_config.s3_output_path #=> String
10850
11020
  # resp.async_inference_config.output_config.notification_config.success_topic #=> String
10851
11021
  # resp.async_inference_config.output_config.notification_config.error_topic #=> String
11022
+ # resp.async_inference_config.output_config.notification_config.include_inference_response_in #=> Array
11023
+ # resp.async_inference_config.output_config.notification_config.include_inference_response_in[0] #=> String, one of "SUCCESS_NOTIFICATION_TOPIC", "ERROR_NOTIFICATION_TOPIC"
11024
+ # resp.async_inference_config.output_config.s3_failure_path #=> String
10852
11025
  # resp.explainer_config.clarify_explainer_config.enable_explanations #=> String
10853
11026
  # resp.explainer_config.clarify_explainer_config.inference_config.features_attribute #=> String
10854
11027
  # resp.explainer_config.clarify_explainer_config.inference_config.content_template #=> String
@@ -14013,6 +14186,8 @@ module Aws::SageMaker
14013
14186
  # resp.user_settings.r_session_app_settings.custom_images[0].app_image_config_name #=> String
14014
14187
  # resp.user_settings.canvas_app_settings.time_series_forecasting_settings.status #=> String, one of "ENABLED", "DISABLED"
14015
14188
  # resp.user_settings.canvas_app_settings.time_series_forecasting_settings.amazon_forecast_role_arn #=> String
14189
+ # resp.user_settings.canvas_app_settings.model_register_settings.status #=> String, one of "ENABLED", "DISABLED"
14190
+ # resp.user_settings.canvas_app_settings.model_register_settings.cross_account_model_register_role_arn #=> String
14016
14191
  #
14017
14192
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeUserProfile AWS API Documentation
14018
14193
  #
@@ -14148,13 +14323,18 @@ module Aws::SageMaker
14148
14323
  # other trials the component is associated with. Before you can delete a
14149
14324
  # component, you must disassociate the component from all trials it is
14150
14325
  # associated with. To associate a trial component with a trial, call the
14151
- # AssociateTrialComponent API.
14326
+ # [AssociateTrialComponent][1] API.
14152
14327
  #
14153
14328
  # To get a list of the trials a component is associated with, use the
14154
- # Search API. Specify `ExperimentTrialComponent` for the `Resource`
14329
+ # [Search][2] API. Specify `ExperimentTrialComponent` for the `Resource`
14155
14330
  # parameter. The list appears in the response under
14156
14331
  # `Results.TrialComponent.Parents`.
14157
14332
  #
14333
+ #
14334
+ #
14335
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AssociateTrialComponent.html
14336
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html
14337
+ #
14158
14338
  # @option params [required, String] :trial_component_name
14159
14339
  # The name of the component to disassociate from the trial.
14160
14340
  #
@@ -15226,9 +15406,14 @@ module Aws::SageMaker
15226
15406
 
15227
15407
  # Lists model compilation jobs that satisfy various filters.
15228
15408
  #
15229
- # To create a model compilation job, use CreateCompilationJob. To get
15230
- # information about a particular model compilation job you have created,
15231
- # use DescribeCompilationJob.
15409
+ # To create a model compilation job, use [CreateCompilationJob][1]. To
15410
+ # get information about a particular model compilation job you have
15411
+ # created, use [DescribeCompilationJob][2].
15412
+ #
15413
+ #
15414
+ #
15415
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html
15416
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html
15232
15417
  #
15233
15418
  # @option params [String] :next_token
15234
15419
  # If the result of the previous `ListCompilationJobs` request was
@@ -15261,7 +15446,7 @@ module Aws::SageMaker
15261
15446
  #
15262
15447
  # @option params [String] :status_equals
15263
15448
  # A filter that retrieves model compilation jobs with a specific
15264
- # DescribeCompilationJobResponse$CompilationJobStatus status.
15449
+ # `CompilationJobStatus` status.
15265
15450
  #
15266
15451
  # @option params [String] :sort_by
15267
15452
  # The field by which to sort results. The default is `CreationTime`.
@@ -16448,8 +16633,12 @@ module Aws::SageMaker
16448
16633
  req.send_request(options)
16449
16634
  end
16450
16635
 
16451
- # Gets a list of HyperParameterTuningJobSummary objects that describe
16452
- # the hyperparameter tuning jobs launched in your account.
16636
+ # Gets a list of [HyperParameterTuningJobSummary][1] objects that
16637
+ # describe the hyperparameter tuning jobs launched in your account.
16638
+ #
16639
+ #
16640
+ #
16641
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html
16453
16642
  #
16454
16643
  # @option params [String] :next_token
16455
16644
  # If the result of the previous `ListHyperParameterTuningJobs` request
@@ -16711,11 +16900,19 @@ module Aws::SageMaker
16711
16900
  #
16712
16901
  # @option params [String] :type
16713
16902
  # Selects inference experiments of this type. For the possible types of
16714
- # inference experiments, see CreateInferenceExperimentRequest$Type.
16903
+ # inference experiments, see [CreateInferenceExperiment][1].
16904
+ #
16905
+ #
16906
+ #
16907
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html
16715
16908
  #
16716
16909
  # @option params [String] :status_equals
16717
16910
  # Selects inference experiments which are in this status. For the
16718
- # possible statuses, see DescribeInferenceExperimentResponse$Status.
16911
+ # possible statuses, see [DescribeInferenceExperiment][1].
16912
+ #
16913
+ #
16914
+ #
16915
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html
16719
16916
  #
16720
16917
  # @option params [Time,DateTime,Date,Integer,String] :creation_time_after
16721
16918
  # Selects inference experiments which were created after this timestamp.
@@ -18242,7 +18439,11 @@ module Aws::SageMaker
18242
18439
  end
18243
18440
 
18244
18441
  # Lists notebook instance lifestyle configurations created with the
18245
- # CreateNotebookInstanceLifecycleConfig API.
18442
+ # [CreateNotebookInstanceLifecycleConfig][1] API.
18443
+ #
18444
+ #
18445
+ #
18446
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html
18246
18447
  #
18247
18448
  # @option params [String] :next_token
18248
18449
  # If the result of a `ListNotebookInstanceLifecycleConfigs` request was
@@ -19268,8 +19469,12 @@ module Aws::SageMaker
19268
19469
  req.send_request(options)
19269
19470
  end
19270
19471
 
19271
- # Gets a list of TrainingJobSummary objects that describe the training
19272
- # jobs that a hyperparameter tuning job launched.
19472
+ # Gets a list of [TrainingJobSummary][1] objects that describe the
19473
+ # training jobs that a hyperparameter tuning job launched.
19474
+ #
19475
+ #
19476
+ #
19477
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html
19273
19478
  #
19274
19479
  # @option params [required, String] :hyper_parameter_tuning_job_name
19275
19480
  # The name of the tuning job whose training jobs you want to list.
@@ -20020,7 +20225,11 @@ module Aws::SageMaker
20020
20225
  # provide a `HumanTaskUiArn` if you use the `UiTemplate` parameter.
20021
20226
  #
20022
20227
  # See a list of available Human Ui Amazon Resource Names (ARNs) in
20023
- # UiConfig.
20228
+ # [UiConfig][1].
20229
+ #
20230
+ #
20231
+ #
20232
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UiConfig.html
20024
20233
  #
20025
20234
  # @return [Types::RenderUiTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
20026
20235
  #
@@ -20488,9 +20697,9 @@ module Aws::SageMaker
20488
20697
  # stopped, it sends the SIGKILL signal.
20489
20698
  #
20490
20699
  # When it receives a `StopCompilationJob` request, Amazon SageMaker
20491
- # changes the CompilationJobSummary$CompilationJobStatus of the job to
20492
- # `Stopping`. After Amazon SageMaker stops the job, it sets the
20493
- # CompilationJobSummary$CompilationJobStatus to `Stopped`.
20700
+ # changes the `CompilationJobStatus` of the job to `Stopping`. After
20701
+ # Amazon SageMaker stops the job, it sets the `CompilationJobStatus` to
20702
+ # `Stopped`.
20494
20703
  #
20495
20704
  # @option params [required, String] :compilation_job_name
20496
20705
  # The name of the model compilation job to stop.
@@ -21297,6 +21506,10 @@ module Aws::SageMaker
21297
21506
  # status: "ENABLED", # accepts ENABLED, DISABLED
21298
21507
  # amazon_forecast_role_arn: "RoleArn",
21299
21508
  # },
21509
+ # model_register_settings: {
21510
+ # status: "ENABLED", # accepts ENABLED, DISABLED
21511
+ # cross_account_model_register_role_arn: "RoleArn",
21512
+ # },
21300
21513
  # },
21301
21514
  # },
21302
21515
  # domain_settings_for_update: {
@@ -21372,7 +21585,7 @@ module Aws::SageMaker
21372
21585
  # When SageMaker receives the request, it sets the endpoint status to
21373
21586
  # `Updating`. After updating the endpoint, it sets the status to
21374
21587
  # `InService`. To check the status of an endpoint, use the
21375
- # DescribeEndpoint API.
21588
+ # [DescribeEndpoint][1] API.
21376
21589
  #
21377
21590
  # <note markdown="1"> You must not delete an `EndpointConfig` in use by an endpoint that is
21378
21591
  # live or while the `UpdateEndpoint` or `CreateEndpoint` operations are
@@ -21386,6 +21599,10 @@ module Aws::SageMaker
21386
21599
  #
21387
21600
  # </note>
21388
21601
  #
21602
+ #
21603
+ #
21604
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html
21605
+ #
21389
21606
  # @option params [required, String] :endpoint_name
21390
21607
  # The name of the endpoint whose configuration you want to update.
21391
21608
  #
@@ -21407,13 +21624,17 @@ module Aws::SageMaker
21407
21624
  #
21408
21625
  # @option params [Array<Types::VariantProperty>] :exclude_retained_variant_properties
21409
21626
  # When you are updating endpoint resources with
21410
- # UpdateEndpointInput$RetainAllVariantProperties, whose value is set to
21411
- # `true`, `ExcludeRetainedVariantProperties` specifies the list of type
21412
- # VariantProperty to override with the values provided by
21627
+ # `RetainAllVariantProperties`, whose value is set to `true`,
21628
+ # `ExcludeRetainedVariantProperties` specifies the list of type
21629
+ # [VariantProperty][1] to override with the values provided by
21413
21630
  # `EndpointConfig`. If you don't specify a value for
21414
21631
  # `ExcludeRetainedVariantProperties`, no variant properties are
21415
21632
  # overridden.
21416
21633
  #
21634
+ #
21635
+ #
21636
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html
21637
+ #
21417
21638
  # @option params [Types::DeploymentConfig] :deployment_config
21418
21639
  # The deployment configuration for an endpoint, which contains the
21419
21640
  # desired deployment strategy and rollback configurations.
@@ -21483,7 +21704,11 @@ module Aws::SageMaker
21483
21704
  # existing endpoint. When it receives the request, SageMaker sets the
21484
21705
  # endpoint status to `Updating`. After updating the endpoint, it sets
21485
21706
  # the status to `InService`. To check the status of an endpoint, use the
21486
- # DescribeEndpoint API.
21707
+ # [DescribeEndpoint][1] API.
21708
+ #
21709
+ #
21710
+ #
21711
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html
21487
21712
  #
21488
21713
  # @option params [required, String] :endpoint_name
21489
21714
  # The name of an existing SageMaker endpoint.
@@ -21691,7 +21916,12 @@ module Aws::SageMaker
21691
21916
  end
21692
21917
 
21693
21918
  # Updates the properties of a SageMaker image. To change the image's
21694
- # tags, use the AddTags and DeleteTags APIs.
21919
+ # tags, use the [AddTags][1] and [DeleteTags][2] APIs.
21920
+ #
21921
+ #
21922
+ #
21923
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html
21924
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html
21695
21925
  #
21696
21926
  # @option params [Array<String>] :delete_properties
21697
21927
  # A list of properties to delete. Only the `Description` and
@@ -21837,7 +22067,11 @@ module Aws::SageMaker
21837
22067
  # Updates an inference experiment that you created. The status of the
21838
22068
  # inference experiment has to be either `Created`, `Running`. For more
21839
22069
  # information on the status of an inference experiment, see
21840
- # DescribeInferenceExperimentResponse$Status.
22070
+ # [DescribeInferenceExperiment][1].
22071
+ #
22072
+ #
22073
+ #
22074
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html
21841
22075
  #
21842
22076
  # @option params [required, String] :name
21843
22077
  # The name of the inference experiment to be updated.
@@ -21941,7 +22175,7 @@ module Aws::SageMaker
21941
22175
  #
21942
22176
  #
21943
22177
  #
21944
- # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-api-json-schema.html
22178
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema
21945
22179
  #
21946
22180
  # @option params [String] :model_card_status
21947
22181
  # The approval status of the model card within your organization.
@@ -22392,7 +22626,11 @@ module Aws::SageMaker
22392
22626
  end
22393
22627
 
22394
22628
  # Updates a notebook instance lifecycle configuration created with the
22395
- # CreateNotebookInstanceLifecycleConfig API.
22629
+ # [CreateNotebookInstanceLifecycleConfig][1] API.
22630
+ #
22631
+ #
22632
+ #
22633
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html
22396
22634
  #
22397
22635
  # @option params [required, String] :notebook_instance_lifecycle_config_name
22398
22636
  # The name of the lifecycle configuration.
@@ -22971,6 +23209,10 @@ module Aws::SageMaker
22971
23209
  # status: "ENABLED", # accepts ENABLED, DISABLED
22972
23210
  # amazon_forecast_role_arn: "RoleArn",
22973
23211
  # },
23212
+ # model_register_settings: {
23213
+ # status: "ENABLED", # accepts ENABLED, DISABLED
23214
+ # cross_account_model_register_role_arn: "RoleArn",
23215
+ # },
22974
23216
  # },
22975
23217
  # },
22976
23218
  # })
@@ -23014,21 +23256,27 @@ module Aws::SageMaker
23014
23256
  #
23015
23257
  # You can only update your OIDC IdP configuration when there are no work
23016
23258
  # teams associated with your workforce. You can delete work teams using
23017
- # the operation.
23259
+ # the [DeleteWorkteam][2] operation.
23018
23260
  #
23019
23261
  # After restricting access to a range of IP addresses or updating your
23020
23262
  # OIDC IdP configuration with this operation, you can view details about
23021
- # your update workforce using the operation.
23263
+ # your update workforce using the [DescribeWorkforce][3] operation.
23022
23264
  #
23023
23265
  # This operation only applies to private workforces.
23024
23266
  #
23025
23267
  #
23026
23268
  #
23027
23269
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html
23270
+ # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html
23271
+ # [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeWorkforce.html
23028
23272
  #
23029
23273
  # @option params [required, String] :workforce_name
23030
23274
  # The name of the private workforce that you want to update. You can
23031
- # find your workforce name by using the operation.
23275
+ # find your workforce name by using the [ListWorkforces][1] operation.
23276
+ #
23277
+ #
23278
+ #
23279
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html
23032
23280
  #
23033
23281
  # @option params [Types::SourceIpConfig] :source_ip_config
23034
23282
  # A list of one to ten worker IP address ranges ([CIDRs][1]) that can be
@@ -23222,7 +23470,7 @@ module Aws::SageMaker
23222
23470
  params: params,
23223
23471
  config: config)
23224
23472
  context[:gem_name] = 'aws-sdk-sagemaker'
23225
- context[:gem_version] = '1.171.0'
23473
+ context[:gem_version] = '1.174.0'
23226
23474
  Seahorse::Client::Request.new(handlers, context)
23227
23475
  end
23228
23476