aws-sdk-sagemaker 1.173.0 → 1.174.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sagemaker/client.rb +361 -145
- data/lib/aws-sdk-sagemaker/client_api.rb +6 -0
- data/lib/aws-sdk-sagemaker/types.rb +741 -282
- data/lib/aws-sdk-sagemaker.rb +1 -1
- metadata +2 -2
@@ -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
|
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.
|
@@ -1598,10 +1606,16 @@ module Aws::SageMaker
|
|
1598
1606
|
# resource use and costs. The response body contains the
|
1599
1607
|
# `CompilationJobArn` for the compiled job.
|
1600
1608
|
#
|
1601
|
-
# To stop a model compilation job, use StopCompilationJob. To get
|
1609
|
+
# To stop a model compilation job, use [StopCompilationJob][1]. To get
|
1602
1610
|
# information about a particular model compilation job, use
|
1603
|
-
# DescribeCompilationJob. To get information about multiple model
|
1604
|
-
# 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
|
1605
1619
|
#
|
1606
1620
|
# @option params [required, String] :compilation_job_name
|
1607
1621
|
# A name for the model compilation job. The name must be unique within
|
@@ -1647,14 +1661,15 @@ module Aws::SageMaker
|
|
1647
1661
|
# and the target device the model runs on.
|
1648
1662
|
#
|
1649
1663
|
# @option params [Types::NeoVpcConfig] :vpc_config
|
1650
|
-
# A VpcConfig object that specifies the VPC that you want your
|
1664
|
+
# A [VpcConfig][1] object that specifies the VPC that you want your
|
1651
1665
|
# compilation job to connect to. Control access to your models by
|
1652
1666
|
# configuring the VPC. For more information, see [Protect Compilation
|
1653
|
-
# Jobs by Using an Amazon Virtual Private Cloud][
|
1667
|
+
# Jobs by Using an Amazon Virtual Private Cloud][2].
|
1654
1668
|
#
|
1655
1669
|
#
|
1656
1670
|
#
|
1657
|
-
# [1]: https://docs.aws.amazon.com/sagemaker/latest/
|
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
|
1658
1673
|
#
|
1659
1674
|
# @option params [required, Types::StoppingCondition] :stopping_condition
|
1660
1675
|
# Specifies a limit to how long a model compilation job can run. When
|
@@ -2211,6 +2226,10 @@ module Aws::SageMaker
|
|
2211
2226
|
# status: "ENABLED", # accepts ENABLED, DISABLED
|
2212
2227
|
# amazon_forecast_role_arn: "RoleArn",
|
2213
2228
|
# },
|
2229
|
+
# model_register_settings: {
|
2230
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
2231
|
+
# cross_account_model_register_role_arn: "RoleArn",
|
2232
|
+
# },
|
2214
2233
|
# },
|
2215
2234
|
# },
|
2216
2235
|
# subnet_ids: ["SubnetId"], # required
|
@@ -2468,13 +2487,13 @@ module Aws::SageMaker
|
|
2468
2487
|
# Creates an endpoint using the endpoint configuration specified in the
|
2469
2488
|
# request. SageMaker uses the endpoint to provision resources and deploy
|
2470
2489
|
# models. You create the endpoint configuration with the
|
2471
|
-
# CreateEndpointConfig API.
|
2490
|
+
# [CreateEndpointConfig][1] API.
|
2472
2491
|
#
|
2473
2492
|
# Use this API to deploy models using SageMaker hosting services.
|
2474
2493
|
#
|
2475
2494
|
# For an example that calls this method when deploying a model to
|
2476
2495
|
# SageMaker hosting services, see the [Create Endpoint example
|
2477
|
-
# notebook.][
|
2496
|
+
# notebook.][2]
|
2478
2497
|
#
|
2479
2498
|
# <note markdown="1"> You must not delete an `EndpointConfig` that is in use by an endpoint
|
2480
2499
|
# that is live or while the `UpdateEndpoint` or `CreateEndpoint`
|
@@ -2490,17 +2509,18 @@ module Aws::SageMaker
|
|
2490
2509
|
# the resources (ML compute instances), and deploys the model(s) on
|
2491
2510
|
# them.
|
2492
2511
|
#
|
2493
|
-
# <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
|
2494
2513
|
# verify that your endpoint configuration exists. When you read data
|
2495
|
-
# from a DynamoDB table supporting [ `Eventually Consistent Reads` ][
|
2514
|
+
# from a DynamoDB table supporting [ `Eventually Consistent Reads` ][4],
|
2496
2515
|
# the response might not reflect the results of a recently completed
|
2497
2516
|
# write operation. The response might include some stale data. If the
|
2498
2517
|
# dependent entities are not yet in DynamoDB, this causes a validation
|
2499
2518
|
# error. If you repeat your read request after a short time, the
|
2500
2519
|
# response should return the latest data. So retry logic is recommended
|
2501
2520
|
# to handle these possible issues. We also recommend that customers call
|
2502
|
-
# DescribeEndpointConfig before calling CreateEndpoint to
|
2503
|
-
# potential impact of a DynamoDB eventually consistent
|
2521
|
+
# [DescribeEndpointConfig][5] before calling [CreateEndpoint][3] to
|
2522
|
+
# minimize the potential impact of a DynamoDB eventually consistent
|
2523
|
+
# read.
|
2504
2524
|
#
|
2505
2525
|
# </note>
|
2506
2526
|
#
|
@@ -2508,7 +2528,7 @@ module Aws::SageMaker
|
|
2508
2528
|
# `Creating`. After it creates the endpoint, it sets the status to
|
2509
2529
|
# `InService`. SageMaker can then process incoming requests for
|
2510
2530
|
# inferences. To check the status of an endpoint, use the
|
2511
|
-
# DescribeEndpoint API.
|
2531
|
+
# [DescribeEndpoint][6] API.
|
2512
2532
|
#
|
2513
2533
|
# If any of the models hosted at this endpoint get model data from an
|
2514
2534
|
# Amazon S3 location, SageMaker uses Amazon Web Services Security Token
|
@@ -2517,14 +2537,14 @@ module Aws::SageMaker
|
|
2517
2537
|
# account by default. If you previously deactivated Amazon Web Services
|
2518
2538
|
# STS for a region, you need to reactivate Amazon Web Services STS for
|
2519
2539
|
# that region. For more information, see [Activating and Deactivating
|
2520
|
-
# Amazon Web Services STS in an Amazon Web Services Region][
|
2540
|
+
# Amazon Web Services STS in an Amazon Web Services Region][7] in the
|
2521
2541
|
# *Amazon Web Services Identity and Access Management User Guide*.
|
2522
2542
|
#
|
2523
2543
|
# <note markdown="1"> To add the IAM role policies for using this API operation, go to the
|
2524
|
-
# [IAM console][
|
2525
|
-
# the IAM role that you want to grant access to use the
|
2526
|
-
# and CreateEndpointConfig API operations, add
|
2527
|
-
# 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.
|
2528
2548
|
#
|
2529
2549
|
# * Option 1: For a full SageMaker access, search and attach the
|
2530
2550
|
# `AmazonSageMakerFullAccess` policy.
|
@@ -2545,27 +2565,39 @@ module Aws::SageMaker
|
|
2545
2565
|
# `]`
|
2546
2566
|
#
|
2547
2567
|
# For more information, see [SageMaker API Permissions: Actions,
|
2548
|
-
# Permissions, and Resources Reference][
|
2568
|
+
# Permissions, and Resources Reference][9].
|
2549
2569
|
#
|
2550
2570
|
# </note>
|
2551
2571
|
#
|
2552
2572
|
#
|
2553
2573
|
#
|
2554
|
-
# [1]: https://
|
2555
|
-
# [2]: https://
|
2556
|
-
# [3]: https://docs.aws.amazon.com/
|
2557
|
-
# [4]: https://
|
2558
|
-
# [5]: https://docs.aws.amazon.com/sagemaker/latest/
|
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
|
2559
2583
|
#
|
2560
2584
|
# @option params [required, String] :endpoint_name
|
2561
2585
|
# The name of the endpoint.The name must be unique within an Amazon Web
|
2562
2586
|
# Services Region in your Amazon Web Services account. The name is
|
2563
2587
|
# case-insensitive in `CreateEndpoint`, but the case is preserved and
|
2564
|
-
# 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
|
2565
2593
|
#
|
2566
2594
|
# @option params [required, String] :endpoint_config_name
|
2567
2595
|
# The name of an endpoint configuration. For more information, see
|
2568
|
-
# CreateEndpointConfig.
|
2596
|
+
# [CreateEndpointConfig][1].
|
2597
|
+
#
|
2598
|
+
#
|
2599
|
+
#
|
2600
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html
|
2569
2601
|
#
|
2570
2602
|
# @option params [Types::DeploymentConfig] :deployment_config
|
2571
2603
|
# The deployment configuration for an endpoint, which contains the
|
@@ -2640,7 +2672,7 @@ module Aws::SageMaker
|
|
2640
2672
|
# to deploy models. In the configuration, you identify one or more
|
2641
2673
|
# models, created using the `CreateModel` API, to deploy and the
|
2642
2674
|
# resources that you want SageMaker to provision. Then you call the
|
2643
|
-
# CreateEndpoint API.
|
2675
|
+
# [CreateEndpoint][1] API.
|
2644
2676
|
#
|
2645
2677
|
# <note markdown="1"> Use this API if you want to use SageMaker hosting services to deploy
|
2646
2678
|
# models into production.
|
@@ -2659,27 +2691,34 @@ module Aws::SageMaker
|
|
2659
2691
|
# distributes two-thirds of the traffic to Model A, and one-third to
|
2660
2692
|
# model B.
|
2661
2693
|
#
|
2662
|
-
# <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
|
2663
2695
|
# verify that your endpoint configuration exists. When you read data
|
2664
|
-
# from a DynamoDB table supporting [ `Eventually Consistent Reads` ][
|
2696
|
+
# from a DynamoDB table supporting [ `Eventually Consistent Reads` ][2],
|
2665
2697
|
# the response might not reflect the results of a recently completed
|
2666
2698
|
# write operation. The response might include some stale data. If the
|
2667
2699
|
# dependent entities are not yet in DynamoDB, this causes a validation
|
2668
2700
|
# error. If you repeat your read request after a short time, the
|
2669
2701
|
# response should return the latest data. So retry logic is recommended
|
2670
2702
|
# to handle these possible issues. We also recommend that customers call
|
2671
|
-
# DescribeEndpointConfig before calling CreateEndpoint to
|
2672
|
-
# potential impact of a DynamoDB eventually consistent
|
2703
|
+
# [DescribeEndpointConfig][3] before calling [CreateEndpoint][1] to
|
2704
|
+
# minimize the potential impact of a DynamoDB eventually consistent
|
2705
|
+
# read.
|
2673
2706
|
#
|
2674
2707
|
# </note>
|
2675
2708
|
#
|
2676
2709
|
#
|
2677
2710
|
#
|
2678
|
-
# [1]: https://docs.aws.amazon.com/
|
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
|
2679
2714
|
#
|
2680
2715
|
# @option params [required, String] :endpoint_config_name
|
2681
2716
|
# The name of the endpoint configuration. You specify this name in a
|
2682
|
-
# CreateEndpoint request.
|
2717
|
+
# [CreateEndpoint][1] request.
|
2718
|
+
#
|
2719
|
+
#
|
2720
|
+
#
|
2721
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html
|
2683
2722
|
#
|
2684
2723
|
# @option params [required, Array<Types::ProductionVariant>] :production_variants
|
2685
2724
|
# An array of `ProductionVariant` objects, one for each model that you
|
@@ -2920,16 +2959,26 @@ module Aws::SageMaker
|
|
2920
2959
|
# Python (Boto), you must use the logging APIs provided by the SDK.
|
2921
2960
|
#
|
2922
2961
|
# You can add tags to experiments, trials, trial components and then use
|
2923
|
-
# the Search API to search for the tags.
|
2962
|
+
# the [Search][1] API to search for the tags.
|
2924
2963
|
#
|
2925
2964
|
# To add a description to an experiment, specify the optional
|
2926
2965
|
# `Description` parameter. To add a description later, or to change the
|
2927
|
-
# description, call the UpdateExperiment API.
|
2966
|
+
# description, call the [UpdateExperiment][2] API.
|
2928
2967
|
#
|
2929
|
-
# To get a list of all your experiments, call the ListExperiments
|
2930
|
-
# To view an experiment's properties, call the
|
2931
|
-
# To get a list of all the trials
|
2932
|
-
#
|
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
|
2933
2982
|
#
|
2934
2983
|
# @option params [required, String] :experiment_name
|
2935
2984
|
# The name of the experiment. The name must be unique in your Amazon Web
|
@@ -2944,8 +2993,12 @@ module Aws::SageMaker
|
|
2944
2993
|
# The description of the experiment.
|
2945
2994
|
#
|
2946
2995
|
# @option params [Array<Types::Tag>] :tags
|
2947
|
-
# A list of tags to associate with the experiment. You can use
|
2948
|
-
# 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
|
2949
3002
|
#
|
2950
3003
|
# @return [Types::CreateExperimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2951
3004
|
#
|
@@ -3058,12 +3111,13 @@ module Aws::SageMaker
|
|
3058
3111
|
#
|
3059
3112
|
# @option params [Types::OnlineStoreConfig] :online_store_config
|
3060
3113
|
# You can turn the `OnlineStore` on or off by specifying `True` for the
|
3061
|
-
# `EnableOnlineStore` flag in `OnlineStoreConfig
|
3062
|
-
# `False`.
|
3114
|
+
# `EnableOnlineStore` flag in `OnlineStoreConfig`.
|
3063
3115
|
#
|
3064
3116
|
# You can also include an Amazon Web Services KMS key ID (`KMSKeyId`)
|
3065
3117
|
# for at-rest encryption of the `OnlineStore`.
|
3066
3118
|
#
|
3119
|
+
# The default value is `False`.
|
3120
|
+
#
|
3067
3121
|
# @option params [Types::OfflineStoreConfig] :offline_store_config
|
3068
3122
|
# Use this to configure an `OfflineFeatureStore`. This parameter allows
|
3069
3123
|
# you to specify:
|
@@ -3083,12 +3137,13 @@ module Aws::SageMaker
|
|
3083
3137
|
# * Format for the offline store table. Supported formats are Glue
|
3084
3138
|
# (Default) and [Apache Iceberg][2].
|
3085
3139
|
#
|
3086
|
-
# To learn more about this parameter, see OfflineStoreConfig.
|
3140
|
+
# To learn more about this parameter, see [OfflineStoreConfig][3].
|
3087
3141
|
#
|
3088
3142
|
#
|
3089
3143
|
#
|
3090
3144
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html
|
3091
3145
|
# [2]: https://iceberg.apache.org/
|
3146
|
+
# [3]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html
|
3092
3147
|
#
|
3093
3148
|
# @option params [String] :role_arn
|
3094
3149
|
# The Amazon Resource Name (ARN) of the IAM execution role used to
|
@@ -3388,25 +3443,34 @@ module Aws::SageMaker
|
|
3388
3443
|
# not case sensitive.
|
3389
3444
|
#
|
3390
3445
|
# @option params [required, Types::HyperParameterTuningJobConfig] :hyper_parameter_tuning_job_config
|
3391
|
-
# The HyperParameterTuningJobConfig object that describes the
|
3392
|
-
# job, including the search strategy, the objective metric used
|
3393
|
-
# evaluate training jobs, ranges of parameters to search, and
|
3394
|
-
# limits for the tuning job. For more information, see [How
|
3395
|
-
# Hyperparameter Tuning Works][
|
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].
|
3396
3451
|
#
|
3397
3452
|
#
|
3398
3453
|
#
|
3399
|
-
# [1]: https://docs.aws.amazon.com/sagemaker/latest/
|
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
|
3400
3456
|
#
|
3401
3457
|
# @option params [Types::HyperParameterTrainingJobDefinition] :training_job_definition
|
3402
|
-
# The HyperParameterTrainingJobDefinition object that describes the
|
3458
|
+
# The [HyperParameterTrainingJobDefinition][1] object that describes the
|
3403
3459
|
# training jobs that this tuning job launches, including static
|
3404
3460
|
# hyperparameters, input data configuration, output data configuration,
|
3405
3461
|
# resource configuration, and stopping condition.
|
3406
3462
|
#
|
3463
|
+
#
|
3464
|
+
#
|
3465
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html
|
3466
|
+
#
|
3407
3467
|
# @option params [Array<Types::HyperParameterTrainingJobDefinition>] :training_job_definitions
|
3408
|
-
# A list of the HyperParameterTrainingJobDefinition objects
|
3409
|
-
# 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
|
3410
3474
|
#
|
3411
3475
|
# @option params [Types::HyperParameterTuningJobWarmStartConfig] :warm_start_config
|
3412
3476
|
# Specifies the configuration for starting the hyperparameter tuning job
|
@@ -4154,7 +4218,10 @@ module Aws::SageMaker
|
|
4154
4218
|
# @option params [required, String] :job_name
|
4155
4219
|
# A name for the recommendation job. The name must be unique within the
|
4156
4220
|
# Amazon Web Services Region and within your Amazon Web Services
|
4157
|
-
# 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.
|
4158
4225
|
#
|
4159
4226
|
# @option params [required, String] :job_type
|
4160
4227
|
# Defines the type of recommendation job. Specify `Default` to initiate
|
@@ -4679,17 +4746,18 @@ module Aws::SageMaker
|
|
4679
4746
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
4680
4747
|
#
|
4681
4748
|
# @option params [Types::VpcConfig] :vpc_config
|
4682
|
-
# A VpcConfig object that specifies the VPC that you want your
|
4683
|
-
# connect to. Control access to and from your model container
|
4684
|
-
# 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
|
4685
4752
|
# batch transform. For more information, see [Protect Endpoints by Using
|
4686
|
-
# an Amazon Virtual Private Cloud][
|
4687
|
-
# Transform Jobs by Using an Amazon Virtual Private Cloud][
|
4753
|
+
# an Amazon Virtual Private Cloud][2] and [Protect Data in Batch
|
4754
|
+
# Transform Jobs by Using an Amazon Virtual Private Cloud][3].
|
4688
4755
|
#
|
4689
4756
|
#
|
4690
4757
|
#
|
4691
|
-
# [1]: https://docs.aws.amazon.com/sagemaker/latest/
|
4692
|
-
# [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/
|
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
|
4693
4761
|
#
|
4694
4762
|
# @option params [Boolean] :enable_network_isolation
|
4695
4763
|
# Isolates the model container. No inbound or outbound network calls can
|
@@ -4953,7 +5021,7 @@ module Aws::SageMaker
|
|
4953
5021
|
#
|
4954
5022
|
#
|
4955
5023
|
#
|
4956
|
-
# [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-
|
5024
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema
|
4957
5025
|
#
|
4958
5026
|
# @option params [required, String] :model_card_status
|
4959
5027
|
# The approval status of the model card within your organization.
|
@@ -6419,16 +6487,17 @@ module Aws::SageMaker
|
|
6419
6487
|
# notebook instance. For more information, see [Limit Access to a
|
6420
6488
|
# Notebook Instance by IP Address][1].
|
6421
6489
|
#
|
6422
|
-
# <note markdown="1"> The URL that you get from a call to
|
6423
|
-
# is valid only for 5 minutes.
|
6424
|
-
# 5-minute limit expires, you are
|
6425
|
-
# 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.
|
6426
6494
|
#
|
6427
6495
|
# </note>
|
6428
6496
|
#
|
6429
6497
|
#
|
6430
6498
|
#
|
6431
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
|
6432
6501
|
#
|
6433
6502
|
# @option params [required, String] :notebook_instance_name
|
6434
6503
|
# The name of the notebook instance.
|
@@ -6512,11 +6581,17 @@ module Aws::SageMaker
|
|
6512
6581
|
# Associates a SageMaker job as a trial component with an experiment and
|
6513
6582
|
# trial. Specified when you call the following APIs:
|
6514
6583
|
#
|
6515
|
-
# * CreateProcessingJob
|
6584
|
+
# * [CreateProcessingJob][1]
|
6516
6585
|
#
|
6517
|
-
# * CreateTrainingJob
|
6586
|
+
# * [CreateTrainingJob][2]
|
6518
6587
|
#
|
6519
|
-
# * CreateTransformJob
|
6588
|
+
# * [CreateTransformJob][3]
|
6589
|
+
#
|
6590
|
+
#
|
6591
|
+
#
|
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
|
6520
6595
|
#
|
6521
6596
|
# @return [Types::CreateProcessingJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6522
6597
|
#
|
@@ -6989,14 +7064,15 @@ module Aws::SageMaker
|
|
6989
7064
|
# an instance count greater than 1.
|
6990
7065
|
#
|
6991
7066
|
# @option params [Types::VpcConfig] :vpc_config
|
6992
|
-
# A VpcConfig object that specifies the VPC that you want your
|
6993
|
-
# job to connect to. Control access to and from your training
|
6994
|
-
# by configuring the VPC. For more information, see [Protect
|
6995
|
-
# Jobs by Using an Amazon Virtual Private Cloud][
|
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].
|
6996
7071
|
#
|
6997
7072
|
#
|
6998
7073
|
#
|
6999
|
-
# [1]: https://docs.aws.amazon.com/sagemaker/latest/
|
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
|
7000
7076
|
#
|
7001
7077
|
# @option params [required, Types::StoppingCondition] :stopping_condition
|
7002
7078
|
# Specifies a limit to how long a model training job can run. It also
|
@@ -7081,11 +7157,17 @@ module Aws::SageMaker
|
|
7081
7157
|
# Associates a SageMaker job as a trial component with an experiment and
|
7082
7158
|
# trial. Specified when you call the following APIs:
|
7083
7159
|
#
|
7084
|
-
# * CreateProcessingJob
|
7160
|
+
# * [CreateProcessingJob][1]
|
7161
|
+
#
|
7162
|
+
# * [CreateTrainingJob][2]
|
7085
7163
|
#
|
7086
|
-
# *
|
7164
|
+
# * [CreateTransformJob][3]
|
7087
7165
|
#
|
7088
|
-
#
|
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
|
7089
7171
|
#
|
7090
7172
|
# @option params [Types::ProfilerConfig] :profiler_config
|
7091
7173
|
# Configuration information for Amazon SageMaker Debugger system
|
@@ -7423,11 +7505,17 @@ module Aws::SageMaker
|
|
7423
7505
|
# Associates a SageMaker job as a trial component with an experiment and
|
7424
7506
|
# trial. Specified when you call the following APIs:
|
7425
7507
|
#
|
7426
|
-
# * CreateProcessingJob
|
7508
|
+
# * [CreateProcessingJob][1]
|
7509
|
+
#
|
7510
|
+
# * [CreateTrainingJob][2]
|
7511
|
+
#
|
7512
|
+
# * [CreateTransformJob][3]
|
7427
7513
|
#
|
7428
|
-
# * CreateTrainingJob
|
7429
7514
|
#
|
7430
|
-
#
|
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
|
7431
7519
|
#
|
7432
7520
|
# @return [Types::CreateTransformJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7433
7521
|
#
|
@@ -7516,12 +7604,19 @@ module Aws::SageMaker
|
|
7516
7604
|
# logged, and indexed. When you use the Amazon Web Services SDK for
|
7517
7605
|
# Python (Boto), you must use the logging APIs provided by the SDK.
|
7518
7606
|
#
|
7519
|
-
# You can add tags to a trial and then use the Search API to search
|
7520
|
-
# 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
|
+
#
|
7521
7615
|
#
|
7522
|
-
#
|
7523
|
-
#
|
7524
|
-
#
|
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
|
7525
7620
|
#
|
7526
7621
|
# @option params [required, String] :trial_name
|
7527
7622
|
# The name of the trial. The name must be unique in your Amazon Web
|
@@ -7538,8 +7633,12 @@ module Aws::SageMaker
|
|
7538
7633
|
# Metadata properties of the tracking entity, trial, or trial component.
|
7539
7634
|
#
|
7540
7635
|
# @option params [Array<Types::Tag>] :tags
|
7541
|
-
# A list of tags to associate with the trial. You can use Search
|
7542
|
-
# 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
|
7543
7642
|
#
|
7544
7643
|
# @return [Types::CreateTrialResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7545
7644
|
#
|
@@ -7590,8 +7689,12 @@ module Aws::SageMaker
|
|
7590
7689
|
# logged, and indexed. When you use the Amazon Web Services SDK for
|
7591
7690
|
# Python (Boto), you must use the logging APIs provided by the SDK.
|
7592
7691
|
#
|
7593
|
-
# You can add tags to a trial component and then use the Search API
|
7594
|
-
# 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
|
7595
7698
|
#
|
7596
7699
|
# @option params [required, String] :trial_component_name
|
7597
7700
|
# The name of the component. The name must be unique in your Amazon Web
|
@@ -7633,8 +7736,12 @@ module Aws::SageMaker
|
|
7633
7736
|
# Metadata properties of the tracking entity, trial, or trial component.
|
7634
7737
|
#
|
7635
7738
|
# @option params [Array<Types::Tag>] :tags
|
7636
|
-
# A list of tags to associate with the component. You can use
|
7637
|
-
# 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
|
7638
7745
|
#
|
7639
7746
|
# @return [Types::CreateTrialComponentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7640
7747
|
#
|
@@ -7823,6 +7930,10 @@ module Aws::SageMaker
|
|
7823
7930
|
# status: "ENABLED", # accepts ENABLED, DISABLED
|
7824
7931
|
# amazon_forecast_role_arn: "RoleArn",
|
7825
7932
|
# },
|
7933
|
+
# model_register_settings: {
|
7934
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
7935
|
+
# cross_account_model_register_role_arn: "RoleArn",
|
7936
|
+
# },
|
7826
7937
|
# },
|
7827
7938
|
# },
|
7828
7939
|
# })
|
@@ -7846,25 +7957,26 @@ module Aws::SageMaker
|
|
7846
7957
|
# Amazon Web Services Region per Amazon Web Services account.
|
7847
7958
|
#
|
7848
7959
|
# If you want to create a new workforce in an Amazon Web Services Region
|
7849
|
-
# where a workforce already exists, use the API
|
7850
|
-
# existing workforce and then use
|
7851
|
-
# 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.
|
7852
7963
|
#
|
7853
7964
|
# To create a private workforce using Amazon Cognito, you must specify a
|
7854
7965
|
# Cognito user pool in `CognitoConfig`. You can also create an Amazon
|
7855
7966
|
# Cognito workforce using the Amazon SageMaker console. For more
|
7856
|
-
# information, see [ Create a Private Workforce (Amazon Cognito)][
|
7967
|
+
# information, see [ Create a Private Workforce (Amazon Cognito)][2].
|
7857
7968
|
#
|
7858
7969
|
# To create a private workforce using your own OIDC Identity Provider
|
7859
7970
|
# (IdP), specify your IdP configuration in `OidcConfig`. Your OIDC IdP
|
7860
7971
|
# must support *groups* because groups are used by Ground Truth and
|
7861
7972
|
# Amazon A2I to create work teams. For more information, see [ Create a
|
7862
|
-
# Private Workforce (OIDC IdP)][
|
7973
|
+
# Private Workforce (OIDC IdP)][3].
|
7863
7974
|
#
|
7864
7975
|
#
|
7865
7976
|
#
|
7866
|
-
# [1]: https://docs.aws.amazon.com/sagemaker/latest/
|
7867
|
-
# [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private
|
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
|
7868
7980
|
#
|
7869
7981
|
# @option params [Types::CognitoConfig] :cognito_config
|
7870
7982
|
# Use this parameter to configure an Amazon Cognito private workforce. A
|
@@ -8492,8 +8604,12 @@ module Aws::SageMaker
|
|
8492
8604
|
end
|
8493
8605
|
|
8494
8606
|
# Deletes an SageMaker experiment. All trials associated with the
|
8495
|
-
# experiment must be deleted first. Use the ListTrials API to get a
|
8496
|
-
# 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
|
8497
8613
|
#
|
8498
8614
|
# @option params [required, String] :experiment_name
|
8499
8615
|
# The name of the experiment to delete.
|
@@ -8641,8 +8757,12 @@ module Aws::SageMaker
|
|
8641
8757
|
# template).
|
8642
8758
|
#
|
8643
8759
|
# To see a list of human task user interfaces (work task templates) in
|
8644
|
-
# your account, use . When you delete a worker task
|
8645
|
-
# 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
|
8646
8766
|
#
|
8647
8767
|
# @option params [required, String] :human_task_ui_name
|
8648
8768
|
# The name of the human task user interface (work task template) you
|
@@ -9170,8 +9290,12 @@ module Aws::SageMaker
|
|
9170
9290
|
end
|
9171
9291
|
|
9172
9292
|
# Deletes the specified trial. All trial components that make up the
|
9173
|
-
# trial must be deleted first. Use the DescribeTrialComponent API
|
9174
|
-
# 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
|
9175
9299
|
#
|
9176
9300
|
# @option params [required, String] :trial_name
|
9177
9301
|
# The name of the trial to delete.
|
@@ -9202,7 +9326,11 @@ module Aws::SageMaker
|
|
9202
9326
|
# Deletes the specified trial component. A trial component must be
|
9203
9327
|
# disassociated from all trials before the trial component can be
|
9204
9328
|
# deleted. To disassociate a trial component from a trial, call the
|
9205
|
-
# DisassociateTrialComponent API.
|
9329
|
+
# [DisassociateTrialComponent][1] API.
|
9330
|
+
#
|
9331
|
+
#
|
9332
|
+
#
|
9333
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html
|
9206
9334
|
#
|
9207
9335
|
# @option params [required, String] :trial_component_name
|
9208
9336
|
# The name of the component to delete.
|
@@ -9262,12 +9390,18 @@ module Aws::SageMaker
|
|
9262
9390
|
#
|
9263
9391
|
# If you want to create a new workforce in an Amazon Web Services Region
|
9264
9392
|
# where a workforce already exists, use this operation to delete the
|
9265
|
-
# existing workforce and then use to create a new
|
9393
|
+
# existing workforce and then use [CreateWorkforce][1] to create a new
|
9394
|
+
# workforce.
|
9266
9395
|
#
|
9267
9396
|
# If a private workforce contains one or more work teams, you must use
|
9268
|
-
# the operation to delete all work teams before you
|
9269
|
-
# workforce. If you try to delete a workforce that contains
|
9270
|
-
# 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
|
9271
9405
|
#
|
9272
9406
|
# @option params [required, String] :workforce_name
|
9273
9407
|
# The name of the workforce.
|
@@ -10038,9 +10172,14 @@ module Aws::SageMaker
|
|
10038
10172
|
|
10039
10173
|
# Returns information about a model compilation job.
|
10040
10174
|
#
|
10041
|
-
# To create a model compilation job, use CreateCompilationJob. To
|
10042
|
-
# information about multiple model compilation jobs, use
|
10043
|
-
# 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
|
10044
10183
|
#
|
10045
10184
|
# @option params [required, String] :compilation_job_name
|
10046
10185
|
# The name of the model compilation job that you want information about.
|
@@ -10457,6 +10596,8 @@ module Aws::SageMaker
|
|
10457
10596
|
# resp.default_user_settings.r_session_app_settings.custom_images[0].app_image_config_name #=> String
|
10458
10597
|
# resp.default_user_settings.canvas_app_settings.time_series_forecasting_settings.status #=> String, one of "ENABLED", "DISABLED"
|
10459
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
|
10460
10601
|
# resp.app_network_access_type #=> String, one of "PublicInternetOnly", "VpcOnly"
|
10461
10602
|
# resp.home_efs_file_system_kms_key_id #=> String
|
10462
10603
|
# resp.subnet_ids #=> Array
|
@@ -14045,6 +14186,8 @@ module Aws::SageMaker
|
|
14045
14186
|
# resp.user_settings.r_session_app_settings.custom_images[0].app_image_config_name #=> String
|
14046
14187
|
# resp.user_settings.canvas_app_settings.time_series_forecasting_settings.status #=> String, one of "ENABLED", "DISABLED"
|
14047
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
|
14048
14191
|
#
|
14049
14192
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeUserProfile AWS API Documentation
|
14050
14193
|
#
|
@@ -14180,13 +14323,18 @@ module Aws::SageMaker
|
|
14180
14323
|
# other trials the component is associated with. Before you can delete a
|
14181
14324
|
# component, you must disassociate the component from all trials it is
|
14182
14325
|
# associated with. To associate a trial component with a trial, call the
|
14183
|
-
# AssociateTrialComponent API.
|
14326
|
+
# [AssociateTrialComponent][1] API.
|
14184
14327
|
#
|
14185
14328
|
# To get a list of the trials a component is associated with, use the
|
14186
|
-
# Search API. Specify `ExperimentTrialComponent` for the `Resource`
|
14329
|
+
# [Search][2] API. Specify `ExperimentTrialComponent` for the `Resource`
|
14187
14330
|
# parameter. The list appears in the response under
|
14188
14331
|
# `Results.TrialComponent.Parents`.
|
14189
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
|
+
#
|
14190
14338
|
# @option params [required, String] :trial_component_name
|
14191
14339
|
# The name of the component to disassociate from the trial.
|
14192
14340
|
#
|
@@ -15258,9 +15406,14 @@ module Aws::SageMaker
|
|
15258
15406
|
|
15259
15407
|
# Lists model compilation jobs that satisfy various filters.
|
15260
15408
|
#
|
15261
|
-
# To create a model compilation job, use CreateCompilationJob. To
|
15262
|
-
# information about a particular model compilation job you have
|
15263
|
-
# 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
|
15264
15417
|
#
|
15265
15418
|
# @option params [String] :next_token
|
15266
15419
|
# If the result of the previous `ListCompilationJobs` request was
|
@@ -15293,7 +15446,7 @@ module Aws::SageMaker
|
|
15293
15446
|
#
|
15294
15447
|
# @option params [String] :status_equals
|
15295
15448
|
# A filter that retrieves model compilation jobs with a specific
|
15296
|
-
#
|
15449
|
+
# `CompilationJobStatus` status.
|
15297
15450
|
#
|
15298
15451
|
# @option params [String] :sort_by
|
15299
15452
|
# The field by which to sort results. The default is `CreationTime`.
|
@@ -16480,8 +16633,12 @@ module Aws::SageMaker
|
|
16480
16633
|
req.send_request(options)
|
16481
16634
|
end
|
16482
16635
|
|
16483
|
-
# Gets a list of HyperParameterTuningJobSummary objects that
|
16484
|
-
# 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
|
16485
16642
|
#
|
16486
16643
|
# @option params [String] :next_token
|
16487
16644
|
# If the result of the previous `ListHyperParameterTuningJobs` request
|
@@ -16743,11 +16900,19 @@ module Aws::SageMaker
|
|
16743
16900
|
#
|
16744
16901
|
# @option params [String] :type
|
16745
16902
|
# Selects inference experiments of this type. For the possible types of
|
16746
|
-
# inference experiments, see
|
16903
|
+
# inference experiments, see [CreateInferenceExperiment][1].
|
16904
|
+
#
|
16905
|
+
#
|
16906
|
+
#
|
16907
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html
|
16747
16908
|
#
|
16748
16909
|
# @option params [String] :status_equals
|
16749
16910
|
# Selects inference experiments which are in this status. For the
|
16750
|
-
# possible statuses, see
|
16911
|
+
# possible statuses, see [DescribeInferenceExperiment][1].
|
16912
|
+
#
|
16913
|
+
#
|
16914
|
+
#
|
16915
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html
|
16751
16916
|
#
|
16752
16917
|
# @option params [Time,DateTime,Date,Integer,String] :creation_time_after
|
16753
16918
|
# Selects inference experiments which were created after this timestamp.
|
@@ -18274,7 +18439,11 @@ module Aws::SageMaker
|
|
18274
18439
|
end
|
18275
18440
|
|
18276
18441
|
# Lists notebook instance lifestyle configurations created with the
|
18277
|
-
# CreateNotebookInstanceLifecycleConfig API.
|
18442
|
+
# [CreateNotebookInstanceLifecycleConfig][1] API.
|
18443
|
+
#
|
18444
|
+
#
|
18445
|
+
#
|
18446
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html
|
18278
18447
|
#
|
18279
18448
|
# @option params [String] :next_token
|
18280
18449
|
# If the result of a `ListNotebookInstanceLifecycleConfigs` request was
|
@@ -19300,8 +19469,12 @@ module Aws::SageMaker
|
|
19300
19469
|
req.send_request(options)
|
19301
19470
|
end
|
19302
19471
|
|
19303
|
-
# Gets a list of TrainingJobSummary objects that describe the
|
19304
|
-
# 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
|
19305
19478
|
#
|
19306
19479
|
# @option params [required, String] :hyper_parameter_tuning_job_name
|
19307
19480
|
# The name of the tuning job whose training jobs you want to list.
|
@@ -20052,7 +20225,11 @@ module Aws::SageMaker
|
|
20052
20225
|
# provide a `HumanTaskUiArn` if you use the `UiTemplate` parameter.
|
20053
20226
|
#
|
20054
20227
|
# See a list of available Human Ui Amazon Resource Names (ARNs) in
|
20055
|
-
# UiConfig.
|
20228
|
+
# [UiConfig][1].
|
20229
|
+
#
|
20230
|
+
#
|
20231
|
+
#
|
20232
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UiConfig.html
|
20056
20233
|
#
|
20057
20234
|
# @return [Types::RenderUiTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
20058
20235
|
#
|
@@ -20520,9 +20697,9 @@ module Aws::SageMaker
|
|
20520
20697
|
# stopped, it sends the SIGKILL signal.
|
20521
20698
|
#
|
20522
20699
|
# When it receives a `StopCompilationJob` request, Amazon SageMaker
|
20523
|
-
# changes the
|
20524
|
-
#
|
20525
|
-
#
|
20700
|
+
# changes the `CompilationJobStatus` of the job to `Stopping`. After
|
20701
|
+
# Amazon SageMaker stops the job, it sets the `CompilationJobStatus` to
|
20702
|
+
# `Stopped`.
|
20526
20703
|
#
|
20527
20704
|
# @option params [required, String] :compilation_job_name
|
20528
20705
|
# The name of the model compilation job to stop.
|
@@ -21329,6 +21506,10 @@ module Aws::SageMaker
|
|
21329
21506
|
# status: "ENABLED", # accepts ENABLED, DISABLED
|
21330
21507
|
# amazon_forecast_role_arn: "RoleArn",
|
21331
21508
|
# },
|
21509
|
+
# model_register_settings: {
|
21510
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
21511
|
+
# cross_account_model_register_role_arn: "RoleArn",
|
21512
|
+
# },
|
21332
21513
|
# },
|
21333
21514
|
# },
|
21334
21515
|
# domain_settings_for_update: {
|
@@ -21404,7 +21585,7 @@ module Aws::SageMaker
|
|
21404
21585
|
# When SageMaker receives the request, it sets the endpoint status to
|
21405
21586
|
# `Updating`. After updating the endpoint, it sets the status to
|
21406
21587
|
# `InService`. To check the status of an endpoint, use the
|
21407
|
-
# DescribeEndpoint API.
|
21588
|
+
# [DescribeEndpoint][1] API.
|
21408
21589
|
#
|
21409
21590
|
# <note markdown="1"> You must not delete an `EndpointConfig` in use by an endpoint that is
|
21410
21591
|
# live or while the `UpdateEndpoint` or `CreateEndpoint` operations are
|
@@ -21418,6 +21599,10 @@ module Aws::SageMaker
|
|
21418
21599
|
#
|
21419
21600
|
# </note>
|
21420
21601
|
#
|
21602
|
+
#
|
21603
|
+
#
|
21604
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html
|
21605
|
+
#
|
21421
21606
|
# @option params [required, String] :endpoint_name
|
21422
21607
|
# The name of the endpoint whose configuration you want to update.
|
21423
21608
|
#
|
@@ -21439,13 +21624,17 @@ module Aws::SageMaker
|
|
21439
21624
|
#
|
21440
21625
|
# @option params [Array<Types::VariantProperty>] :exclude_retained_variant_properties
|
21441
21626
|
# When you are updating endpoint resources with
|
21442
|
-
#
|
21443
|
-
# `
|
21444
|
-
# 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
|
21445
21630
|
# `EndpointConfig`. If you don't specify a value for
|
21446
21631
|
# `ExcludeRetainedVariantProperties`, no variant properties are
|
21447
21632
|
# overridden.
|
21448
21633
|
#
|
21634
|
+
#
|
21635
|
+
#
|
21636
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html
|
21637
|
+
#
|
21449
21638
|
# @option params [Types::DeploymentConfig] :deployment_config
|
21450
21639
|
# The deployment configuration for an endpoint, which contains the
|
21451
21640
|
# desired deployment strategy and rollback configurations.
|
@@ -21515,7 +21704,11 @@ module Aws::SageMaker
|
|
21515
21704
|
# existing endpoint. When it receives the request, SageMaker sets the
|
21516
21705
|
# endpoint status to `Updating`. After updating the endpoint, it sets
|
21517
21706
|
# the status to `InService`. To check the status of an endpoint, use the
|
21518
|
-
# DescribeEndpoint API.
|
21707
|
+
# [DescribeEndpoint][1] API.
|
21708
|
+
#
|
21709
|
+
#
|
21710
|
+
#
|
21711
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html
|
21519
21712
|
#
|
21520
21713
|
# @option params [required, String] :endpoint_name
|
21521
21714
|
# The name of an existing SageMaker endpoint.
|
@@ -21723,7 +21916,12 @@ module Aws::SageMaker
|
|
21723
21916
|
end
|
21724
21917
|
|
21725
21918
|
# Updates the properties of a SageMaker image. To change the image's
|
21726
|
-
# 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
|
21727
21925
|
#
|
21728
21926
|
# @option params [Array<String>] :delete_properties
|
21729
21927
|
# A list of properties to delete. Only the `Description` and
|
@@ -21869,7 +22067,11 @@ module Aws::SageMaker
|
|
21869
22067
|
# Updates an inference experiment that you created. The status of the
|
21870
22068
|
# inference experiment has to be either `Created`, `Running`. For more
|
21871
22069
|
# information on the status of an inference experiment, see
|
21872
|
-
#
|
22070
|
+
# [DescribeInferenceExperiment][1].
|
22071
|
+
#
|
22072
|
+
#
|
22073
|
+
#
|
22074
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html
|
21873
22075
|
#
|
21874
22076
|
# @option params [required, String] :name
|
21875
22077
|
# The name of the inference experiment to be updated.
|
@@ -21973,7 +22175,7 @@ module Aws::SageMaker
|
|
21973
22175
|
#
|
21974
22176
|
#
|
21975
22177
|
#
|
21976
|
-
# [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards-
|
22178
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema
|
21977
22179
|
#
|
21978
22180
|
# @option params [String] :model_card_status
|
21979
22181
|
# The approval status of the model card within your organization.
|
@@ -22424,7 +22626,11 @@ module Aws::SageMaker
|
|
22424
22626
|
end
|
22425
22627
|
|
22426
22628
|
# Updates a notebook instance lifecycle configuration created with the
|
22427
|
-
# CreateNotebookInstanceLifecycleConfig API.
|
22629
|
+
# [CreateNotebookInstanceLifecycleConfig][1] API.
|
22630
|
+
#
|
22631
|
+
#
|
22632
|
+
#
|
22633
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html
|
22428
22634
|
#
|
22429
22635
|
# @option params [required, String] :notebook_instance_lifecycle_config_name
|
22430
22636
|
# The name of the lifecycle configuration.
|
@@ -23003,6 +23209,10 @@ module Aws::SageMaker
|
|
23003
23209
|
# status: "ENABLED", # accepts ENABLED, DISABLED
|
23004
23210
|
# amazon_forecast_role_arn: "RoleArn",
|
23005
23211
|
# },
|
23212
|
+
# model_register_settings: {
|
23213
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
23214
|
+
# cross_account_model_register_role_arn: "RoleArn",
|
23215
|
+
# },
|
23006
23216
|
# },
|
23007
23217
|
# },
|
23008
23218
|
# })
|
@@ -23046,21 +23256,27 @@ module Aws::SageMaker
|
|
23046
23256
|
#
|
23047
23257
|
# You can only update your OIDC IdP configuration when there are no work
|
23048
23258
|
# teams associated with your workforce. You can delete work teams using
|
23049
|
-
# the operation.
|
23259
|
+
# the [DeleteWorkteam][2] operation.
|
23050
23260
|
#
|
23051
23261
|
# After restricting access to a range of IP addresses or updating your
|
23052
23262
|
# OIDC IdP configuration with this operation, you can view details about
|
23053
|
-
# your update workforce using the operation.
|
23263
|
+
# your update workforce using the [DescribeWorkforce][3] operation.
|
23054
23264
|
#
|
23055
23265
|
# This operation only applies to private workforces.
|
23056
23266
|
#
|
23057
23267
|
#
|
23058
23268
|
#
|
23059
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
|
23060
23272
|
#
|
23061
23273
|
# @option params [required, String] :workforce_name
|
23062
23274
|
# The name of the private workforce that you want to update. You can
|
23063
|
-
# 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
|
23064
23280
|
#
|
23065
23281
|
# @option params [Types::SourceIpConfig] :source_ip_config
|
23066
23282
|
# A list of one to ten worker IP address ranges ([CIDRs][1]) that can be
|
@@ -23254,7 +23470,7 @@ module Aws::SageMaker
|
|
23254
23470
|
params: params,
|
23255
23471
|
config: config)
|
23256
23472
|
context[:gem_name] = 'aws-sdk-sagemaker'
|
23257
|
-
context[:gem_version] = '1.
|
23473
|
+
context[:gem_version] = '1.174.0'
|
23258
23474
|
Seahorse::Client::Request.new(handlers, context)
|
23259
23475
|
end
|
23260
23476
|
|