aws-sdk-cleanroomsml 1.26.0 → 1.27.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cleanroomsml/client.rb +215 -2
- data/lib/aws-sdk-cleanroomsml/client_api.rb +150 -22
- data/lib/aws-sdk-cleanroomsml/errors.rb +42 -0
- data/lib/aws-sdk-cleanroomsml/types.rb +435 -21
- data/lib/aws-sdk-cleanroomsml.rb +1 -1
- data/sig/client.rbs +53 -8
- data/sig/errors.rbs +8 -0
- data/sig/types.rbs +75 -0
- metadata +1 -1
@@ -340,11 +340,21 @@ module Aws::CleanRoomsML
|
|
340
340
|
# want to cancel.
|
341
341
|
# @return [String]
|
342
342
|
#
|
343
|
+
# @!attribute [rw] version_identifier
|
344
|
+
# The version identifier of the trained model to cancel. This
|
345
|
+
# parameter allows you to specify which version of the trained model
|
346
|
+
# you want to cancel when multiple versions exist.
|
347
|
+
#
|
348
|
+
# If `versionIdentifier` is not specified, the base model will be
|
349
|
+
# cancelled.
|
350
|
+
# @return [String]
|
351
|
+
#
|
343
352
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CancelTrainedModelRequest AWS API Documentation
|
344
353
|
#
|
345
354
|
class CancelTrainedModelRequest < Struct.new(
|
346
355
|
:membership_identifier,
|
347
|
-
:trained_model_arn
|
356
|
+
:trained_model_arn,
|
357
|
+
:version_identifier)
|
348
358
|
SENSITIVE = []
|
349
359
|
include Aws::Structure
|
350
360
|
end
|
@@ -515,6 +525,11 @@ module Aws::CleanRoomsML
|
|
515
525
|
# exported.
|
516
526
|
# @return [String]
|
517
527
|
#
|
528
|
+
# @!attribute [rw] trained_model_version_identifier
|
529
|
+
# The version identifier of the trained model that was exported in
|
530
|
+
# this job.
|
531
|
+
# @return [String]
|
532
|
+
#
|
518
533
|
# @!attribute [rw] membership_identifier
|
519
534
|
# The membership ID of the member that created the trained model
|
520
535
|
# export job.
|
@@ -537,6 +552,7 @@ module Aws::CleanRoomsML
|
|
537
552
|
:description,
|
538
553
|
:creator_account_id,
|
539
554
|
:trained_model_arn,
|
555
|
+
:trained_model_version_identifier,
|
540
556
|
:membership_identifier,
|
541
557
|
:collaboration_identifier)
|
542
558
|
SENSITIVE = []
|
@@ -565,6 +581,11 @@ module Aws::CleanRoomsML
|
|
565
581
|
# the trained model inference job.
|
566
582
|
# @return [String]
|
567
583
|
#
|
584
|
+
# @!attribute [rw] trained_model_version_identifier
|
585
|
+
# The version identifier of the trained model that was used for
|
586
|
+
# inference in this job.
|
587
|
+
# @return [String]
|
588
|
+
#
|
568
589
|
# @!attribute [rw] collaboration_identifier
|
569
590
|
# The collaboration ID of the collaboration that contains the trained
|
570
591
|
# model inference job.
|
@@ -623,6 +644,7 @@ module Aws::CleanRoomsML
|
|
623
644
|
:configured_model_algorithm_association_arn,
|
624
645
|
:membership_identifier,
|
625
646
|
:trained_model_arn,
|
647
|
+
:trained_model_version_identifier,
|
626
648
|
:collaboration_identifier,
|
627
649
|
:status,
|
628
650
|
:output_configuration,
|
@@ -657,6 +679,15 @@ module Aws::CleanRoomsML
|
|
657
679
|
# The name of the trained model.
|
658
680
|
# @return [String]
|
659
681
|
#
|
682
|
+
# @!attribute [rw] version_identifier
|
683
|
+
# The version identifier of this trained model version.
|
684
|
+
# @return [String]
|
685
|
+
#
|
686
|
+
# @!attribute [rw] incremental_training_data_channels
|
687
|
+
# Information about the incremental training data channels used to
|
688
|
+
# create this version of the trained model.
|
689
|
+
# @return [Array<Types::IncrementalTrainingDataChannelOutput>]
|
690
|
+
#
|
660
691
|
# @!attribute [rw] description
|
661
692
|
# The description of the trained model.
|
662
693
|
# @return [String]
|
@@ -690,6 +721,8 @@ module Aws::CleanRoomsML
|
|
690
721
|
:update_time,
|
691
722
|
:trained_model_arn,
|
692
723
|
:name,
|
724
|
+
:version_identifier,
|
725
|
+
:incremental_training_data_channels,
|
693
726
|
:description,
|
694
727
|
:membership_identifier,
|
695
728
|
:collaboration_identifier,
|
@@ -926,10 +959,10 @@ module Aws::CleanRoomsML
|
|
926
959
|
#
|
927
960
|
# @!attribute [rw] image_uri
|
928
961
|
# The registry path of the docker image that contains the algorithm.
|
929
|
-
# Clean Rooms ML
|
930
|
-
# `registry/
|
931
|
-
#
|
932
|
-
#
|
962
|
+
# Clean Rooms ML currently only supports the
|
963
|
+
# `registry/repository[:tag]` image path format. For more information
|
964
|
+
# about using images in Clean Rooms ML, see the [Sagemaker API
|
965
|
+
# reference][1].
|
933
966
|
#
|
934
967
|
#
|
935
968
|
#
|
@@ -1475,11 +1508,44 @@ module Aws::CleanRoomsML
|
|
1475
1508
|
# The criteria that is used to stop model training.
|
1476
1509
|
# @return [Types::StoppingCondition]
|
1477
1510
|
#
|
1511
|
+
# @!attribute [rw] incremental_training_data_channels
|
1512
|
+
# Specifies the incremental training data channels for the trained
|
1513
|
+
# model.
|
1514
|
+
#
|
1515
|
+
# Incremental training allows you to create a new trained model with
|
1516
|
+
# updates without retraining from scratch. You can specify up to one
|
1517
|
+
# incremental training data channel that references a previously
|
1518
|
+
# trained model and its version.
|
1519
|
+
#
|
1520
|
+
# Limit: Maximum of 20 channels total (including both
|
1521
|
+
# `incrementalTrainingDataChannels` and `dataChannels`).
|
1522
|
+
# @return [Array<Types::IncrementalTrainingDataChannel>]
|
1523
|
+
#
|
1478
1524
|
# @!attribute [rw] data_channels
|
1479
1525
|
# Defines the data channels that are used as input for the trained
|
1480
1526
|
# model request.
|
1527
|
+
#
|
1528
|
+
# Limit: Maximum of 20 channels total (including both `dataChannels`
|
1529
|
+
# and `incrementalTrainingDataChannels`).
|
1481
1530
|
# @return [Array<Types::ModelTrainingDataChannel>]
|
1482
1531
|
#
|
1532
|
+
# @!attribute [rw] training_input_mode
|
1533
|
+
# The input mode for accessing the training data. This parameter
|
1534
|
+
# determines how the training data is made available to the training
|
1535
|
+
# algorithm. Valid values are:
|
1536
|
+
#
|
1537
|
+
# * `File` - The training data is downloaded to the training instance
|
1538
|
+
# and made available as files.
|
1539
|
+
#
|
1540
|
+
# * `FastFile` - The training data is streamed directly from Amazon S3
|
1541
|
+
# to the training algorithm, providing faster access for large
|
1542
|
+
# datasets.
|
1543
|
+
#
|
1544
|
+
# * `Pipe` - The training data is streamed to the training algorithm
|
1545
|
+
# using named pipes, which can improve performance for certain
|
1546
|
+
# algorithms.
|
1547
|
+
# @return [String]
|
1548
|
+
#
|
1483
1549
|
# @!attribute [rw] description
|
1484
1550
|
# The description of the trained model.
|
1485
1551
|
# @return [String]
|
@@ -1533,7 +1599,9 @@ module Aws::CleanRoomsML
|
|
1533
1599
|
:environment,
|
1534
1600
|
:resource_config,
|
1535
1601
|
:stopping_condition,
|
1602
|
+
:incremental_training_data_channels,
|
1536
1603
|
:data_channels,
|
1604
|
+
:training_input_mode,
|
1537
1605
|
:description,
|
1538
1606
|
:kms_key_arn,
|
1539
1607
|
:tags)
|
@@ -1545,10 +1613,21 @@ module Aws::CleanRoomsML
|
|
1545
1613
|
# The Amazon Resource Name (ARN) of the trained model.
|
1546
1614
|
# @return [String]
|
1547
1615
|
#
|
1616
|
+
# @!attribute [rw] version_identifier
|
1617
|
+
# The unique version identifier assigned to the newly created trained
|
1618
|
+
# model. This identifier can be used to reference this specific
|
1619
|
+
# version of the trained model in subsequent operations such as
|
1620
|
+
# inference jobs or incremental training.
|
1621
|
+
#
|
1622
|
+
# The initial version identifier for the base version of the trained
|
1623
|
+
# model is "NULL".
|
1624
|
+
# @return [String]
|
1625
|
+
#
|
1548
1626
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainedModelResponse AWS API Documentation
|
1549
1627
|
#
|
1550
1628
|
class CreateTrainedModelResponse < Struct.new(
|
1551
|
-
:trained_model_arn
|
1629
|
+
:trained_model_arn,
|
1630
|
+
:version_identifier)
|
1552
1631
|
SENSITIVE = []
|
1553
1632
|
include Aws::Structure
|
1554
1633
|
end
|
@@ -1817,11 +1896,18 @@ module Aws::CleanRoomsML
|
|
1817
1896
|
# output.
|
1818
1897
|
# @return [String]
|
1819
1898
|
#
|
1899
|
+
# @!attribute [rw] version_identifier
|
1900
|
+
# The version identifier of the trained model to delete. If not
|
1901
|
+
# specified, the operation will delete the base version of the trained
|
1902
|
+
# model. When specified, only the particular version will be deleted.
|
1903
|
+
# @return [String]
|
1904
|
+
#
|
1820
1905
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteTrainedModelOutputRequest AWS API Documentation
|
1821
1906
|
#
|
1822
1907
|
class DeleteTrainedModelOutputRequest < Struct.new(
|
1823
1908
|
:trained_model_arn,
|
1824
|
-
:membership_identifier
|
1909
|
+
:membership_identifier,
|
1910
|
+
:version_identifier)
|
1825
1911
|
SENSITIVE = []
|
1826
1912
|
include Aws::Structure
|
1827
1913
|
end
|
@@ -2231,11 +2317,18 @@ module Aws::CleanRoomsML
|
|
2231
2317
|
# to return information about.
|
2232
2318
|
# @return [String]
|
2233
2319
|
#
|
2320
|
+
# @!attribute [rw] version_identifier
|
2321
|
+
# The version identifier of the trained model to retrieve. If not
|
2322
|
+
# specified, the operation returns information about the latest
|
2323
|
+
# version of the trained model.
|
2324
|
+
# @return [String]
|
2325
|
+
#
|
2234
2326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetCollaborationTrainedModelRequest AWS API Documentation
|
2235
2327
|
#
|
2236
2328
|
class GetCollaborationTrainedModelRequest < Struct.new(
|
2237
2329
|
:trained_model_arn,
|
2238
|
-
:collaboration_identifier
|
2330
|
+
:collaboration_identifier,
|
2331
|
+
:version_identifier)
|
2239
2332
|
SENSITIVE = []
|
2240
2333
|
include Aws::Structure
|
2241
2334
|
end
|
@@ -2253,6 +2346,19 @@ module Aws::CleanRoomsML
|
|
2253
2346
|
# The Amazon Resource Name (ARN) of the trained model.
|
2254
2347
|
# @return [String]
|
2255
2348
|
#
|
2349
|
+
# @!attribute [rw] version_identifier
|
2350
|
+
# The version identifier of the trained model. This unique identifier
|
2351
|
+
# distinguishes this version from other versions of the same trained
|
2352
|
+
# model.
|
2353
|
+
# @return [String]
|
2354
|
+
#
|
2355
|
+
# @!attribute [rw] incremental_training_data_channels
|
2356
|
+
# Information about the incremental training data channels used to
|
2357
|
+
# create this version of the trained model. This includes details
|
2358
|
+
# about the base model that was used for incremental training and the
|
2359
|
+
# channel configuration.
|
2360
|
+
# @return [Array<Types::IncrementalTrainingDataChannelOutput>]
|
2361
|
+
#
|
2256
2362
|
# @!attribute [rw] name
|
2257
2363
|
# The name of the trained model.
|
2258
2364
|
# @return [String]
|
@@ -2278,6 +2384,12 @@ module Aws::CleanRoomsML
|
|
2278
2384
|
# The EC2 resource configuration that was used to train this model.
|
2279
2385
|
# @return [Types::ResourceConfig]
|
2280
2386
|
#
|
2387
|
+
# @!attribute [rw] training_input_mode
|
2388
|
+
# The input mode that was used for accessing the training data when
|
2389
|
+
# this trained model was created. This indicates how the training data
|
2390
|
+
# was made available to the training algorithm.
|
2391
|
+
# @return [String]
|
2392
|
+
#
|
2281
2393
|
# @!attribute [rw] stopping_condition
|
2282
2394
|
# The stopping condition that determined when model training ended.
|
2283
2395
|
# @return [Types::StoppingCondition]
|
@@ -2320,12 +2432,15 @@ module Aws::CleanRoomsML
|
|
2320
2432
|
:membership_identifier,
|
2321
2433
|
:collaboration_identifier,
|
2322
2434
|
:trained_model_arn,
|
2435
|
+
:version_identifier,
|
2436
|
+
:incremental_training_data_channels,
|
2323
2437
|
:name,
|
2324
2438
|
:description,
|
2325
2439
|
:status,
|
2326
2440
|
:status_details,
|
2327
2441
|
:configured_model_algorithm_association_arn,
|
2328
2442
|
:resource_config,
|
2443
|
+
:training_input_mode,
|
2329
2444
|
:stopping_condition,
|
2330
2445
|
:metrics_status,
|
2331
2446
|
:metrics_status_details,
|
@@ -2928,6 +3043,12 @@ module Aws::CleanRoomsML
|
|
2928
3043
|
# for the trained model inference job.
|
2929
3044
|
# @return [String]
|
2930
3045
|
#
|
3046
|
+
# @!attribute [rw] trained_model_version_identifier
|
3047
|
+
# The version identifier of the trained model used for this inference
|
3048
|
+
# job. This identifies the specific version of the trained model that
|
3049
|
+
# was used to generate the inference results.
|
3050
|
+
# @return [String]
|
3051
|
+
#
|
2931
3052
|
# @!attribute [rw] resource_config
|
2932
3053
|
# The resource configuration information for the trained model
|
2933
3054
|
# inference job.
|
@@ -3033,6 +3154,7 @@ module Aws::CleanRoomsML
|
|
3033
3154
|
:name,
|
3034
3155
|
:status,
|
3035
3156
|
:trained_model_arn,
|
3157
|
+
:trained_model_version_identifier,
|
3036
3158
|
:resource_config,
|
3037
3159
|
:output_configuration,
|
3038
3160
|
:membership_identifier,
|
@@ -3062,11 +3184,18 @@ module Aws::CleanRoomsML
|
|
3062
3184
|
# you are interested in.
|
3063
3185
|
# @return [String]
|
3064
3186
|
#
|
3187
|
+
# @!attribute [rw] version_identifier
|
3188
|
+
# The version identifier of the trained model to retrieve. If not
|
3189
|
+
# specified, the operation returns information about the latest
|
3190
|
+
# version of the trained model.
|
3191
|
+
# @return [String]
|
3192
|
+
#
|
3065
3193
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainedModelRequest AWS API Documentation
|
3066
3194
|
#
|
3067
3195
|
class GetTrainedModelRequest < Struct.new(
|
3068
3196
|
:trained_model_arn,
|
3069
|
-
:membership_identifier
|
3197
|
+
:membership_identifier,
|
3198
|
+
:version_identifier)
|
3070
3199
|
SENSITIVE = []
|
3071
3200
|
include Aws::Structure
|
3072
3201
|
end
|
@@ -3084,6 +3213,19 @@ module Aws::CleanRoomsML
|
|
3084
3213
|
# The Amazon Resource Name (ARN) of the trained model.
|
3085
3214
|
# @return [String]
|
3086
3215
|
#
|
3216
|
+
# @!attribute [rw] version_identifier
|
3217
|
+
# The version identifier of the trained model. This unique identifier
|
3218
|
+
# distinguishes this version from other versions of the same trained
|
3219
|
+
# model.
|
3220
|
+
# @return [String]
|
3221
|
+
#
|
3222
|
+
# @!attribute [rw] incremental_training_data_channels
|
3223
|
+
# Information about the incremental training data channels used to
|
3224
|
+
# create this version of the trained model. This includes details
|
3225
|
+
# about the base model that was used for incremental training and the
|
3226
|
+
# channel configuration.
|
3227
|
+
# @return [Array<Types::IncrementalTrainingDataChannelOutput>]
|
3228
|
+
#
|
3087
3229
|
# @!attribute [rw] name
|
3088
3230
|
# The name of the trained model.
|
3089
3231
|
# @return [String]
|
@@ -3110,6 +3252,12 @@ module Aws::CleanRoomsML
|
|
3110
3252
|
# model.
|
3111
3253
|
# @return [Types::ResourceConfig]
|
3112
3254
|
#
|
3255
|
+
# @!attribute [rw] training_input_mode
|
3256
|
+
# The input mode that was used for accessing the training data when
|
3257
|
+
# this trained model was created. This indicates how the training data
|
3258
|
+
# was made available to the training algorithm.
|
3259
|
+
# @return [String]
|
3260
|
+
#
|
3113
3261
|
# @!attribute [rw] stopping_condition
|
3114
3262
|
# The stopping condition that was used to terminate model training.
|
3115
3263
|
# @return [Types::StoppingCondition]
|
@@ -3199,12 +3347,15 @@ module Aws::CleanRoomsML
|
|
3199
3347
|
:membership_identifier,
|
3200
3348
|
:collaboration_identifier,
|
3201
3349
|
:trained_model_arn,
|
3350
|
+
:version_identifier,
|
3351
|
+
:incremental_training_data_channels,
|
3202
3352
|
:name,
|
3203
3353
|
:description,
|
3204
3354
|
:status,
|
3205
3355
|
:status_details,
|
3206
3356
|
:configured_model_algorithm_association_arn,
|
3207
3357
|
:resource_config,
|
3358
|
+
:training_input_mode,
|
3208
3359
|
:stopping_condition,
|
3209
3360
|
:metrics_status,
|
3210
3361
|
:metrics_status_details,
|
@@ -3311,14 +3462,78 @@ module Aws::CleanRoomsML
|
|
3311
3462
|
include Aws::Structure
|
3312
3463
|
end
|
3313
3464
|
|
3465
|
+
# Defines an incremental training data channel that references a
|
3466
|
+
# previously trained model. Incremental training allows you to update an
|
3467
|
+
# existing trained model with new data, building upon the knowledge from
|
3468
|
+
# a base model rather than training from scratch. This can significantly
|
3469
|
+
# reduce training time and computational costs while improving model
|
3470
|
+
# performance with additional data.
|
3471
|
+
#
|
3472
|
+
# @!attribute [rw] trained_model_arn
|
3473
|
+
# The Amazon Resource Name (ARN) of the base trained model to use for
|
3474
|
+
# incremental training. This model serves as the starting point for
|
3475
|
+
# the incremental training process.
|
3476
|
+
# @return [String]
|
3477
|
+
#
|
3478
|
+
# @!attribute [rw] version_identifier
|
3479
|
+
# The version identifier of the base trained model to use for
|
3480
|
+
# incremental training. If not specified, the latest version of the
|
3481
|
+
# trained model is used.
|
3482
|
+
# @return [String]
|
3483
|
+
#
|
3484
|
+
# @!attribute [rw] channel_name
|
3485
|
+
# The name of the incremental training data channel. This name is used
|
3486
|
+
# to identify the channel during the training process and must be
|
3487
|
+
# unique within the training job.
|
3488
|
+
# @return [String]
|
3489
|
+
#
|
3490
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/IncrementalTrainingDataChannel AWS API Documentation
|
3491
|
+
#
|
3492
|
+
class IncrementalTrainingDataChannel < Struct.new(
|
3493
|
+
:trained_model_arn,
|
3494
|
+
:version_identifier,
|
3495
|
+
:channel_name)
|
3496
|
+
SENSITIVE = []
|
3497
|
+
include Aws::Structure
|
3498
|
+
end
|
3499
|
+
|
3500
|
+
# Contains information about an incremental training data channel that
|
3501
|
+
# was used to create a trained model. This structure provides details
|
3502
|
+
# about the base model and channel configuration used during incremental
|
3503
|
+
# training.
|
3504
|
+
#
|
3505
|
+
# @!attribute [rw] channel_name
|
3506
|
+
# The name of the incremental training data channel that was used.
|
3507
|
+
# @return [String]
|
3508
|
+
#
|
3509
|
+
# @!attribute [rw] version_identifier
|
3510
|
+
# The version identifier of the trained model that was used for
|
3511
|
+
# incremental training.
|
3512
|
+
# @return [String]
|
3513
|
+
#
|
3514
|
+
# @!attribute [rw] model_name
|
3515
|
+
# The name of the base trained model that was used for incremental
|
3516
|
+
# training.
|
3517
|
+
# @return [String]
|
3518
|
+
#
|
3519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/IncrementalTrainingDataChannelOutput AWS API Documentation
|
3520
|
+
#
|
3521
|
+
class IncrementalTrainingDataChannelOutput < Struct.new(
|
3522
|
+
:channel_name,
|
3523
|
+
:version_identifier,
|
3524
|
+
:model_name)
|
3525
|
+
SENSITIVE = []
|
3526
|
+
include Aws::Structure
|
3527
|
+
end
|
3528
|
+
|
3314
3529
|
# Provides configuration information for the inference container.
|
3315
3530
|
#
|
3316
3531
|
# @!attribute [rw] image_uri
|
3317
3532
|
# The registry path of the docker image that contains the inference
|
3318
|
-
# algorithm. Clean Rooms ML supports
|
3319
|
-
#
|
3320
|
-
#
|
3321
|
-
#
|
3533
|
+
# algorithm. Clean Rooms ML currently only supports the
|
3534
|
+
# `registry/repository[:tag]` image path format. For more information
|
3535
|
+
# about using images in Clean Rooms ML, see the [Sagemaker API
|
3536
|
+
# reference][1].
|
3322
3537
|
#
|
3323
3538
|
#
|
3324
3539
|
#
|
@@ -3408,8 +3623,8 @@ module Aws::CleanRoomsML
|
|
3408
3623
|
# @return [Types::InputChannelDataSource]
|
3409
3624
|
#
|
3410
3625
|
# @!attribute [rw] role_arn
|
3411
|
-
# The ARN of the
|
3412
|
-
#
|
3626
|
+
# The Amazon Resource Name (ARN) of the role used to run the query
|
3627
|
+
# specified in the `dataSource` field of the input channel.
|
3413
3628
|
#
|
3414
3629
|
# Passing a role across AWS accounts is not allowed. If you pass a
|
3415
3630
|
# role that isn't in your account, you get an `AccessDeniedException`
|
@@ -3448,6 +3663,20 @@ module Aws::CleanRoomsML
|
|
3448
3663
|
class Unknown < InputChannelDataSource; end
|
3449
3664
|
end
|
3450
3665
|
|
3666
|
+
# An internal service error occurred. Retry your request. If the problem
|
3667
|
+
# persists, contact AWS Support.
|
3668
|
+
#
|
3669
|
+
# @!attribute [rw] message
|
3670
|
+
# @return [String]
|
3671
|
+
#
|
3672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/InternalServiceException AWS API Documentation
|
3673
|
+
#
|
3674
|
+
class InternalServiceException < Struct.new(
|
3675
|
+
:message)
|
3676
|
+
SENSITIVE = []
|
3677
|
+
include Aws::Structure
|
3678
|
+
end
|
3679
|
+
|
3451
3680
|
# @!attribute [rw] next_token
|
3452
3681
|
# The token value retrieved from a previous call to access the next
|
3453
3682
|
# page of results.
|
@@ -3674,13 +3903,20 @@ module Aws::CleanRoomsML
|
|
3674
3903
|
# create the export jobs that you are interested in.
|
3675
3904
|
# @return [String]
|
3676
3905
|
#
|
3906
|
+
# @!attribute [rw] trained_model_version_identifier
|
3907
|
+
# The version identifier of the trained model to filter export jobs
|
3908
|
+
# by. When specified, only export jobs for this specific version of
|
3909
|
+
# the trained model are returned.
|
3910
|
+
# @return [String]
|
3911
|
+
#
|
3677
3912
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModelExportJobsRequest AWS API Documentation
|
3678
3913
|
#
|
3679
3914
|
class ListCollaborationTrainedModelExportJobsRequest < Struct.new(
|
3680
3915
|
:next_token,
|
3681
3916
|
:max_results,
|
3682
3917
|
:collaboration_identifier,
|
3683
|
-
:trained_model_arn
|
3918
|
+
:trained_model_arn,
|
3919
|
+
:trained_model_version_identifier)
|
3684
3920
|
SENSITIVE = []
|
3685
3921
|
include Aws::Structure
|
3686
3922
|
end
|
@@ -3722,13 +3958,20 @@ module Aws::CleanRoomsML
|
|
3722
3958
|
# create the trained model inference jobs that you are interested in.
|
3723
3959
|
# @return [String]
|
3724
3960
|
#
|
3961
|
+
# @!attribute [rw] trained_model_version_identifier
|
3962
|
+
# The version identifier of the trained model to filter inference jobs
|
3963
|
+
# by. When specified, only inference jobs that used this specific
|
3964
|
+
# version of the trained model are returned.
|
3965
|
+
# @return [String]
|
3966
|
+
#
|
3725
3967
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModelInferenceJobsRequest AWS API Documentation
|
3726
3968
|
#
|
3727
3969
|
class ListCollaborationTrainedModelInferenceJobsRequest < Struct.new(
|
3728
3970
|
:next_token,
|
3729
3971
|
:max_results,
|
3730
3972
|
:collaboration_identifier,
|
3731
|
-
:trained_model_arn
|
3973
|
+
:trained_model_arn,
|
3974
|
+
:trained_model_version_identifier)
|
3732
3975
|
SENSITIVE = []
|
3733
3976
|
include Aws::Structure
|
3734
3977
|
end
|
@@ -3986,13 +4229,20 @@ module Aws::CleanRoomsML
|
|
3986
4229
|
# create the trained model inference jobs that you are interested in.
|
3987
4230
|
# @return [String]
|
3988
4231
|
#
|
4232
|
+
# @!attribute [rw] trained_model_version_identifier
|
4233
|
+
# The version identifier of the trained model to filter inference jobs
|
4234
|
+
# by. When specified, only inference jobs that used this specific
|
4235
|
+
# version of the trained model are returned.
|
4236
|
+
# @return [String]
|
4237
|
+
#
|
3989
4238
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainedModelInferenceJobsRequest AWS API Documentation
|
3990
4239
|
#
|
3991
4240
|
class ListTrainedModelInferenceJobsRequest < Struct.new(
|
3992
4241
|
:next_token,
|
3993
4242
|
:max_results,
|
3994
4243
|
:membership_identifier,
|
3995
|
-
:trained_model_arn
|
4244
|
+
:trained_model_arn,
|
4245
|
+
:trained_model_version_identifier)
|
3996
4246
|
SENSITIVE = []
|
3997
4247
|
include Aws::Structure
|
3998
4248
|
end
|
@@ -4014,6 +4264,67 @@ module Aws::CleanRoomsML
|
|
4014
4264
|
include Aws::Structure
|
4015
4265
|
end
|
4016
4266
|
|
4267
|
+
# @!attribute [rw] next_token
|
4268
|
+
# The pagination token from a previous `ListTrainedModelVersions`
|
4269
|
+
# request. Use this token to retrieve the next page of results.
|
4270
|
+
# @return [String]
|
4271
|
+
#
|
4272
|
+
# @!attribute [rw] max_results
|
4273
|
+
# The maximum number of trained model versions to return in a single
|
4274
|
+
# page. The default value is 10, and the maximum value is 100.
|
4275
|
+
# @return [Integer]
|
4276
|
+
#
|
4277
|
+
# @!attribute [rw] membership_identifier
|
4278
|
+
# The membership identifier for the collaboration that contains the
|
4279
|
+
# trained model.
|
4280
|
+
# @return [String]
|
4281
|
+
#
|
4282
|
+
# @!attribute [rw] trained_model_arn
|
4283
|
+
# The Amazon Resource Name (ARN) of the trained model for which to
|
4284
|
+
# list versions.
|
4285
|
+
# @return [String]
|
4286
|
+
#
|
4287
|
+
# @!attribute [rw] status
|
4288
|
+
# Filter the results to only include trained model versions with the
|
4289
|
+
# specified status. Valid values include `CREATE_PENDING`,
|
4290
|
+
# `CREATE_IN_PROGRESS`, `ACTIVE`, `CREATE_FAILED`, and others.
|
4291
|
+
# @return [String]
|
4292
|
+
#
|
4293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainedModelVersionsRequest AWS API Documentation
|
4294
|
+
#
|
4295
|
+
class ListTrainedModelVersionsRequest < Struct.new(
|
4296
|
+
:next_token,
|
4297
|
+
:max_results,
|
4298
|
+
:membership_identifier,
|
4299
|
+
:trained_model_arn,
|
4300
|
+
:status)
|
4301
|
+
SENSITIVE = []
|
4302
|
+
include Aws::Structure
|
4303
|
+
end
|
4304
|
+
|
4305
|
+
# @!attribute [rw] next_token
|
4306
|
+
# The pagination token to use in a subsequent
|
4307
|
+
# `ListTrainedModelVersions` request to retrieve the next page of
|
4308
|
+
# results. This value is null when there are no more results to
|
4309
|
+
# return.
|
4310
|
+
# @return [String]
|
4311
|
+
#
|
4312
|
+
# @!attribute [rw] trained_models
|
4313
|
+
# A list of trained model versions that match the specified criteria.
|
4314
|
+
# Each entry contains summary information about a trained model
|
4315
|
+
# version, including its version identifier, status, and creation
|
4316
|
+
# details.
|
4317
|
+
# @return [Array<Types::TrainedModelSummary>]
|
4318
|
+
#
|
4319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainedModelVersionsResponse AWS API Documentation
|
4320
|
+
#
|
4321
|
+
class ListTrainedModelVersionsResponse < Struct.new(
|
4322
|
+
:next_token,
|
4323
|
+
:trained_models)
|
4324
|
+
SENSITIVE = []
|
4325
|
+
include Aws::Structure
|
4326
|
+
end
|
4327
|
+
|
4017
4328
|
# @!attribute [rw] next_token
|
4018
4329
|
# The token value retrieved from a previous call to access the next
|
4019
4330
|
# page of results.
|
@@ -4257,11 +4568,27 @@ module Aws::CleanRoomsML
|
|
4257
4568
|
# The name of the training data channel.
|
4258
4569
|
# @return [String]
|
4259
4570
|
#
|
4571
|
+
# @!attribute [rw] s3_data_distribution_type
|
4572
|
+
# Specifies how the training data stored in Amazon S3 should be
|
4573
|
+
# distributed to training instances. This parameter controls the data
|
4574
|
+
# distribution strategy for the training job:
|
4575
|
+
#
|
4576
|
+
# * `FullyReplicated` - The entire dataset is replicated on each
|
4577
|
+
# training instance. This is suitable for smaller datasets and
|
4578
|
+
# algorithms that require access to the complete dataset.
|
4579
|
+
#
|
4580
|
+
# * `ShardedByS3Key` - The dataset is distributed across training
|
4581
|
+
# instances based on Amazon S3 key names. This is suitable for
|
4582
|
+
# larger datasets and distributed training scenarios where each
|
4583
|
+
# instance processes a subset of the data.
|
4584
|
+
# @return [String]
|
4585
|
+
#
|
4260
4586
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ModelTrainingDataChannel AWS API Documentation
|
4261
4587
|
#
|
4262
4588
|
class ModelTrainingDataChannel < Struct.new(
|
4263
4589
|
:ml_input_channel_arn,
|
4264
|
-
:channel_name
|
4590
|
+
:channel_name,
|
4591
|
+
:s3_data_distribution_type)
|
4265
4592
|
SENSITIVE = []
|
4266
4593
|
include Aws::Structure
|
4267
4594
|
end
|
@@ -4494,10 +4821,20 @@ module Aws::CleanRoomsML
|
|
4494
4821
|
# @!attribute [rw] message
|
4495
4822
|
# @return [String]
|
4496
4823
|
#
|
4824
|
+
# @!attribute [rw] quota_name
|
4825
|
+
# The name of the service quota limit that was exceeded
|
4826
|
+
# @return [String]
|
4827
|
+
#
|
4828
|
+
# @!attribute [rw] quota_value
|
4829
|
+
# The current limit on the service quota that was exceeded
|
4830
|
+
# @return [Float]
|
4831
|
+
#
|
4497
4832
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ServiceQuotaExceededException AWS API Documentation
|
4498
4833
|
#
|
4499
4834
|
class ServiceQuotaExceededException < Struct.new(
|
4500
|
-
:message
|
4835
|
+
:message,
|
4836
|
+
:quota_name,
|
4837
|
+
:quota_value)
|
4501
4838
|
SENSITIVE = []
|
4502
4839
|
include Aws::Structure
|
4503
4840
|
end
|
@@ -4626,6 +4963,12 @@ module Aws::CleanRoomsML
|
|
4626
4963
|
# export.
|
4627
4964
|
# @return [String]
|
4628
4965
|
#
|
4966
|
+
# @!attribute [rw] trained_model_version_identifier
|
4967
|
+
# The version identifier of the trained model to export. This
|
4968
|
+
# specifies which version of the trained model should be exported to
|
4969
|
+
# the specified destination.
|
4970
|
+
# @return [String]
|
4971
|
+
#
|
4629
4972
|
# @!attribute [rw] membership_identifier
|
4630
4973
|
# The membership ID of the member that is receiving the exported
|
4631
4974
|
# trained model artifacts.
|
@@ -4645,6 +4988,7 @@ module Aws::CleanRoomsML
|
|
4645
4988
|
class StartTrainedModelExportJobRequest < Struct.new(
|
4646
4989
|
:name,
|
4647
4990
|
:trained_model_arn,
|
4991
|
+
:trained_model_version_identifier,
|
4648
4992
|
:membership_identifier,
|
4649
4993
|
:output_configuration,
|
4650
4994
|
:description)
|
@@ -4666,6 +5010,12 @@ module Aws::CleanRoomsML
|
|
4666
5010
|
# this trained model inference job.
|
4667
5011
|
# @return [String]
|
4668
5012
|
#
|
5013
|
+
# @!attribute [rw] trained_model_version_identifier
|
5014
|
+
# The version identifier of the trained model to use for inference.
|
5015
|
+
# This specifies which version of the trained model should be used to
|
5016
|
+
# generate predictions on the input data.
|
5017
|
+
# @return [String]
|
5018
|
+
#
|
4669
5019
|
# @!attribute [rw] configured_model_algorithm_association_arn
|
4670
5020
|
# The Amazon Resource Name (ARN) of the configured model algorithm
|
4671
5021
|
# association that is used for this trained model inference job.
|
@@ -4743,6 +5093,7 @@ module Aws::CleanRoomsML
|
|
4743
5093
|
:membership_identifier,
|
4744
5094
|
:name,
|
4745
5095
|
:trained_model_arn,
|
5096
|
+
:trained_model_version_identifier,
|
4746
5097
|
:configured_model_algorithm_association_arn,
|
4747
5098
|
:resource_config,
|
4748
5099
|
:output_configuration,
|
@@ -4857,6 +5208,45 @@ module Aws::CleanRoomsML
|
|
4857
5208
|
#
|
4858
5209
|
class TagResourceResponse < Aws::EmptyStructure; end
|
4859
5210
|
|
5211
|
+
# The request was denied due to request throttling.
|
5212
|
+
#
|
5213
|
+
# @!attribute [rw] message
|
5214
|
+
# @return [String]
|
5215
|
+
#
|
5216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ThrottlingException AWS API Documentation
|
5217
|
+
#
|
5218
|
+
class ThrottlingException < Struct.new(
|
5219
|
+
:message)
|
5220
|
+
SENSITIVE = []
|
5221
|
+
include Aws::Structure
|
5222
|
+
end
|
5223
|
+
|
5224
|
+
# Specifies the maximum size limit for trained model artifacts. This
|
5225
|
+
# configuration helps control storage costs and ensures that trained
|
5226
|
+
# models don't exceed specified size constraints. The size limit
|
5227
|
+
# applies to the total size of all artifacts produced by the training
|
5228
|
+
# job.
|
5229
|
+
#
|
5230
|
+
# @!attribute [rw] unit
|
5231
|
+
# The unit of measurement for the maximum artifact size. Valid values
|
5232
|
+
# include common storage units such as bytes, kilobytes, megabytes,
|
5233
|
+
# gigabytes, and terabytes.
|
5234
|
+
# @return [String]
|
5235
|
+
#
|
5236
|
+
# @!attribute [rw] value
|
5237
|
+
# The numerical value for the maximum artifact size limit. This value
|
5238
|
+
# is interpreted according to the specified unit.
|
5239
|
+
# @return [Float]
|
5240
|
+
#
|
5241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelArtifactMaxSize AWS API Documentation
|
5242
|
+
#
|
5243
|
+
class TrainedModelArtifactMaxSize < Struct.new(
|
5244
|
+
:unit,
|
5245
|
+
:value)
|
5246
|
+
SENSITIVE = []
|
5247
|
+
include Aws::Structure
|
5248
|
+
end
|
5249
|
+
|
4860
5250
|
# Information about the output of the trained model export job.
|
4861
5251
|
#
|
4862
5252
|
# @!attribute [rw] members
|
@@ -4947,6 +5337,11 @@ module Aws::CleanRoomsML
|
|
4947
5337
|
# the trained model inference job.
|
4948
5338
|
# @return [String]
|
4949
5339
|
#
|
5340
|
+
# @!attribute [rw] trained_model_version_identifier
|
5341
|
+
# The version identifier of the trained model that was used for
|
5342
|
+
# inference in this job.
|
5343
|
+
# @return [String]
|
5344
|
+
#
|
4950
5345
|
# @!attribute [rw] collaboration_identifier
|
4951
5346
|
# The collaboration ID of the collaboration that contains the trained
|
4952
5347
|
# model inference job.
|
@@ -5001,6 +5396,7 @@ module Aws::CleanRoomsML
|
|
5001
5396
|
:configured_model_algorithm_association_arn,
|
5002
5397
|
:membership_identifier,
|
5003
5398
|
:trained_model_arn,
|
5399
|
+
:trained_model_version_identifier,
|
5004
5400
|
:collaboration_identifier,
|
5005
5401
|
:status,
|
5006
5402
|
:output_configuration,
|
@@ -5071,6 +5467,15 @@ module Aws::CleanRoomsML
|
|
5071
5467
|
# The Amazon Resource Name (ARN) of the trained model.
|
5072
5468
|
# @return [String]
|
5073
5469
|
#
|
5470
|
+
# @!attribute [rw] version_identifier
|
5471
|
+
# The version identifier of this trained model version.
|
5472
|
+
# @return [String]
|
5473
|
+
#
|
5474
|
+
# @!attribute [rw] incremental_training_data_channels
|
5475
|
+
# Information about the incremental training data channels used to
|
5476
|
+
# create this version of the trained model.
|
5477
|
+
# @return [Array<Types::IncrementalTrainingDataChannelOutput>]
|
5478
|
+
#
|
5074
5479
|
# @!attribute [rw] name
|
5075
5480
|
# The name of the trained model.
|
5076
5481
|
# @return [String]
|
@@ -5103,6 +5508,8 @@ module Aws::CleanRoomsML
|
|
5103
5508
|
:create_time,
|
5104
5509
|
:update_time,
|
5105
5510
|
:trained_model_arn,
|
5511
|
+
:version_identifier,
|
5512
|
+
:incremental_training_data_channels,
|
5106
5513
|
:name,
|
5107
5514
|
:description,
|
5108
5515
|
:membership_identifier,
|
@@ -5123,11 +5530,18 @@ module Aws::CleanRoomsML
|
|
5123
5530
|
# The container for the metrics of the trained model.
|
5124
5531
|
# @return [Types::MetricsConfigurationPolicy]
|
5125
5532
|
#
|
5533
|
+
# @!attribute [rw] max_artifact_size
|
5534
|
+
# The maximum size limit for trained model artifacts as defined in the
|
5535
|
+
# configuration policy. This setting helps enforce consistent size
|
5536
|
+
# limits across trained models in the collaboration.
|
5537
|
+
# @return [Types::TrainedModelArtifactMaxSize]
|
5538
|
+
#
|
5126
5539
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelsConfigurationPolicy AWS API Documentation
|
5127
5540
|
#
|
5128
5541
|
class TrainedModelsConfigurationPolicy < Struct.new(
|
5129
5542
|
:container_logs,
|
5130
|
-
:container_metrics
|
5543
|
+
:container_metrics,
|
5544
|
+
:max_artifact_size)
|
5131
5545
|
SENSITIVE = []
|
5132
5546
|
include Aws::Structure
|
5133
5547
|
end
|