aws-sdk-cleanroomsml 1.18.0 → 1.19.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.
@@ -306,6 +306,394 @@ module Aws::CleanRoomsML
306
306
  include Aws::Structure
307
307
  end
308
308
 
309
+ # @!attribute [rw] membership_identifier
310
+ # The membership ID of the trained model inference job that you want
311
+ # to cancel.
312
+ # @return [String]
313
+ #
314
+ # @!attribute [rw] trained_model_inference_job_arn
315
+ # The Amazon Resource Name (ARN) of the trained model inference job
316
+ # that you want to cancel.
317
+ # @return [String]
318
+ #
319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CancelTrainedModelInferenceJobRequest AWS API Documentation
320
+ #
321
+ class CancelTrainedModelInferenceJobRequest < Struct.new(
322
+ :membership_identifier,
323
+ :trained_model_inference_job_arn)
324
+ SENSITIVE = []
325
+ include Aws::Structure
326
+ end
327
+
328
+ # @!attribute [rw] membership_identifier
329
+ # The membership ID of the trained model job that you want to cancel.
330
+ # @return [String]
331
+ #
332
+ # @!attribute [rw] trained_model_arn
333
+ # The Amazon Resource Name (ARN) of the trained model job that you
334
+ # want to cancel.
335
+ # @return [String]
336
+ #
337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CancelTrainedModelRequest AWS API Documentation
338
+ #
339
+ class CancelTrainedModelRequest < Struct.new(
340
+ :membership_identifier,
341
+ :trained_model_arn)
342
+ SENSITIVE = []
343
+ include Aws::Structure
344
+ end
345
+
346
+ # Provides summary information about a configured model algorithm in a
347
+ # collaboration.
348
+ #
349
+ # @!attribute [rw] create_time
350
+ # The time at which the configured model algorithm association was
351
+ # created.
352
+ # @return [Time]
353
+ #
354
+ # @!attribute [rw] update_time
355
+ # The most recent time at which the configured model algorithm
356
+ # association was updated.
357
+ # @return [Time]
358
+ #
359
+ # @!attribute [rw] configured_model_algorithm_association_arn
360
+ # The Amazon Resource Name (ARN) of the configured model algorithm
361
+ # association.
362
+ # @return [String]
363
+ #
364
+ # @!attribute [rw] name
365
+ # The name of the configured model algorithm association.
366
+ # @return [String]
367
+ #
368
+ # @!attribute [rw] description
369
+ # The description of the configured model algorithm association.
370
+ # @return [String]
371
+ #
372
+ # @!attribute [rw] membership_identifier
373
+ # The membership ID of the member that created the configured model
374
+ # algorithm association.
375
+ # @return [String]
376
+ #
377
+ # @!attribute [rw] collaboration_identifier
378
+ # The collaboration ID of the collaboration that contains the
379
+ # configured model algorithm association.
380
+ # @return [String]
381
+ #
382
+ # @!attribute [rw] configured_model_algorithm_arn
383
+ # The Amazon Resource Name (ARN) of the configured model algorithm
384
+ # that is associated to the collaboration.
385
+ # @return [String]
386
+ #
387
+ # @!attribute [rw] creator_account_id
388
+ # The account ID of the member that created the configured model
389
+ # algorithm association.
390
+ # @return [String]
391
+ #
392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CollaborationConfiguredModelAlgorithmAssociationSummary AWS API Documentation
393
+ #
394
+ class CollaborationConfiguredModelAlgorithmAssociationSummary < Struct.new(
395
+ :create_time,
396
+ :update_time,
397
+ :configured_model_algorithm_association_arn,
398
+ :name,
399
+ :description,
400
+ :membership_identifier,
401
+ :collaboration_identifier,
402
+ :configured_model_algorithm_arn,
403
+ :creator_account_id)
404
+ SENSITIVE = []
405
+ include Aws::Structure
406
+ end
407
+
408
+ # Provides summary information about an ML input channel in a
409
+ # collaboration.
410
+ #
411
+ # @!attribute [rw] create_time
412
+ # The time at which the ML input channel was created.
413
+ # @return [Time]
414
+ #
415
+ # @!attribute [rw] update_time
416
+ # The most recent time at which the ML input channel was updated.
417
+ # @return [Time]
418
+ #
419
+ # @!attribute [rw] membership_identifier
420
+ # The membership ID of the membership that contains the ML input
421
+ # channel.
422
+ # @return [String]
423
+ #
424
+ # @!attribute [rw] collaboration_identifier
425
+ # The collaboration ID of the collaboration that contains the ML input
426
+ # channel.
427
+ # @return [String]
428
+ #
429
+ # @!attribute [rw] name
430
+ # The name of the ML input channel.
431
+ # @return [String]
432
+ #
433
+ # @!attribute [rw] configured_model_algorithm_associations
434
+ # The associated configured model algorithms used to create the ML
435
+ # input channel.
436
+ # @return [Array<String>]
437
+ #
438
+ # @!attribute [rw] ml_input_channel_arn
439
+ # The Amazon Resource Name (ARN) of the ML input channel.
440
+ # @return [String]
441
+ #
442
+ # @!attribute [rw] status
443
+ # The status of the ML input channel.
444
+ # @return [String]
445
+ #
446
+ # @!attribute [rw] creator_account_id
447
+ # The account ID of the member who created the ML input channel.
448
+ # @return [String]
449
+ #
450
+ # @!attribute [rw] description
451
+ # The description of the ML input channel.
452
+ # @return [String]
453
+ #
454
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CollaborationMLInputChannelSummary AWS API Documentation
455
+ #
456
+ class CollaborationMLInputChannelSummary < Struct.new(
457
+ :create_time,
458
+ :update_time,
459
+ :membership_identifier,
460
+ :collaboration_identifier,
461
+ :name,
462
+ :configured_model_algorithm_associations,
463
+ :ml_input_channel_arn,
464
+ :status,
465
+ :creator_account_id,
466
+ :description)
467
+ SENSITIVE = []
468
+ include Aws::Structure
469
+ end
470
+
471
+ # Provides summary information about a trained model export job in a
472
+ # collaboration.
473
+ #
474
+ # @!attribute [rw] create_time
475
+ # The time at which the trained model export job was created.
476
+ # @return [Time]
477
+ #
478
+ # @!attribute [rw] update_time
479
+ # The most recent time at which the trained model export job was
480
+ # updated.
481
+ # @return [Time]
482
+ #
483
+ # @!attribute [rw] name
484
+ # The name of the trained model export job.
485
+ # @return [String]
486
+ #
487
+ # @!attribute [rw] output_configuration
488
+ # Information about the output of the trained model export job.
489
+ # @return [Types::TrainedModelExportOutputConfiguration]
490
+ #
491
+ # @!attribute [rw] status
492
+ # The status of the trained model.
493
+ # @return [String]
494
+ #
495
+ # @!attribute [rw] status_details
496
+ # Details about the status of a resource.
497
+ # @return [Types::StatusDetails]
498
+ #
499
+ # @!attribute [rw] description
500
+ # The description of the trained model.
501
+ # @return [String]
502
+ #
503
+ # @!attribute [rw] creator_account_id
504
+ # The account ID of the member that created the trained model.
505
+ # @return [String]
506
+ #
507
+ # @!attribute [rw] trained_model_arn
508
+ # The Amazon Resource Name (ARN) of the trained model that is being
509
+ # exported.
510
+ # @return [String]
511
+ #
512
+ # @!attribute [rw] membership_identifier
513
+ # The membership ID of the member that created the trained model
514
+ # export job.
515
+ # @return [String]
516
+ #
517
+ # @!attribute [rw] collaboration_identifier
518
+ # The collaboration ID of the collaboration that contains the trained
519
+ # model export job.
520
+ # @return [String]
521
+ #
522
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CollaborationTrainedModelExportJobSummary AWS API Documentation
523
+ #
524
+ class CollaborationTrainedModelExportJobSummary < Struct.new(
525
+ :create_time,
526
+ :update_time,
527
+ :name,
528
+ :output_configuration,
529
+ :status,
530
+ :status_details,
531
+ :description,
532
+ :creator_account_id,
533
+ :trained_model_arn,
534
+ :membership_identifier,
535
+ :collaboration_identifier)
536
+ SENSITIVE = []
537
+ include Aws::Structure
538
+ end
539
+
540
+ # Provides summary information about a trained model inference job in a
541
+ # collaboration.
542
+ #
543
+ # @!attribute [rw] trained_model_inference_job_arn
544
+ # The Amazon Resource Name (ARN) of the trained model inference job.
545
+ # @return [String]
546
+ #
547
+ # @!attribute [rw] configured_model_algorithm_association_arn
548
+ # The Amazon Resource Name (ARN) of the configured model algorithm
549
+ # association that is used for the trained model inference job.
550
+ # @return [String]
551
+ #
552
+ # @!attribute [rw] membership_identifier
553
+ # The membership ID of the membership that contains the trained model
554
+ # inference job.
555
+ # @return [String]
556
+ #
557
+ # @!attribute [rw] trained_model_arn
558
+ # The Amazon Resource Name (ARN) of the trained model that is used for
559
+ # the trained model inference job.
560
+ # @return [String]
561
+ #
562
+ # @!attribute [rw] collaboration_identifier
563
+ # The collaboration ID of the collaboration that contains the trained
564
+ # model inference job.
565
+ # @return [String]
566
+ #
567
+ # @!attribute [rw] status
568
+ # The status of the trained model inference job.
569
+ # @return [String]
570
+ #
571
+ # @!attribute [rw] output_configuration
572
+ # Returns output configuration information for the trained model
573
+ # inference job.
574
+ # @return [Types::InferenceOutputConfiguration]
575
+ #
576
+ # @!attribute [rw] name
577
+ # The name of the trained model inference job.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] description
581
+ # The description of the trained model inference job.
582
+ # @return [String]
583
+ #
584
+ # @!attribute [rw] metrics_status
585
+ # the trained model inference job metrics status.
586
+ # @return [String]
587
+ #
588
+ # @!attribute [rw] metrics_status_details
589
+ # Details about the metrics status for trained model inference job.
590
+ # @return [String]
591
+ #
592
+ # @!attribute [rw] logs_status
593
+ # The trained model inference job logs status.
594
+ # @return [String]
595
+ #
596
+ # @!attribute [rw] logs_status_details
597
+ # Details about the logs status for the trained model inference job.
598
+ # @return [String]
599
+ #
600
+ # @!attribute [rw] create_time
601
+ # The time at which the trained model inference job was created.
602
+ # @return [Time]
603
+ #
604
+ # @!attribute [rw] update_time
605
+ # The most recent time at which the trained model inference job was
606
+ # updated.
607
+ # @return [Time]
608
+ #
609
+ # @!attribute [rw] creator_account_id
610
+ # The account ID that created the trained model inference job.
611
+ # @return [String]
612
+ #
613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CollaborationTrainedModelInferenceJobSummary AWS API Documentation
614
+ #
615
+ class CollaborationTrainedModelInferenceJobSummary < Struct.new(
616
+ :trained_model_inference_job_arn,
617
+ :configured_model_algorithm_association_arn,
618
+ :membership_identifier,
619
+ :trained_model_arn,
620
+ :collaboration_identifier,
621
+ :status,
622
+ :output_configuration,
623
+ :name,
624
+ :description,
625
+ :metrics_status,
626
+ :metrics_status_details,
627
+ :logs_status,
628
+ :logs_status_details,
629
+ :create_time,
630
+ :update_time,
631
+ :creator_account_id)
632
+ SENSITIVE = []
633
+ include Aws::Structure
634
+ end
635
+
636
+ # Provides summary information about a trained model in a collaboration.
637
+ #
638
+ # @!attribute [rw] create_time
639
+ # The time at which the trained model was created.
640
+ # @return [Time]
641
+ #
642
+ # @!attribute [rw] update_time
643
+ # The most recent time at which the trained model was updated.
644
+ # @return [Time]
645
+ #
646
+ # @!attribute [rw] trained_model_arn
647
+ # The Amazon Resource Name (ARN) of the trained model.
648
+ # @return [String]
649
+ #
650
+ # @!attribute [rw] name
651
+ # The name of the trained model.
652
+ # @return [String]
653
+ #
654
+ # @!attribute [rw] description
655
+ # The description of the trained model.
656
+ # @return [String]
657
+ #
658
+ # @!attribute [rw] membership_identifier
659
+ # The membership ID of the member that created the trained model.
660
+ # @return [String]
661
+ #
662
+ # @!attribute [rw] collaboration_identifier
663
+ # The collaboration ID of the collaboration that contains the trained
664
+ # model.
665
+ # @return [String]
666
+ #
667
+ # @!attribute [rw] status
668
+ # The status of the trained model.
669
+ # @return [String]
670
+ #
671
+ # @!attribute [rw] configured_model_algorithm_association_arn
672
+ # The Amazon Resource Name (ARN) of the configured model algorithm
673
+ # association that is used for this trained model.
674
+ # @return [String]
675
+ #
676
+ # @!attribute [rw] creator_account_id
677
+ # The account ID of the member that created the trained model.
678
+ # @return [String]
679
+ #
680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CollaborationTrainedModelSummary AWS API Documentation
681
+ #
682
+ class CollaborationTrainedModelSummary < Struct.new(
683
+ :create_time,
684
+ :update_time,
685
+ :trained_model_arn,
686
+ :name,
687
+ :description,
688
+ :membership_identifier,
689
+ :collaboration_identifier,
690
+ :status,
691
+ :configured_model_algorithm_association_arn,
692
+ :creator_account_id)
693
+ SENSITIVE = []
694
+ include Aws::Structure
695
+ end
696
+
309
697
  # Metadata for a column.
310
698
  #
311
699
  # @!attribute [rw] column_name
@@ -325,6 +713,30 @@ module Aws::CleanRoomsML
325
713
  include Aws::Structure
326
714
  end
327
715
 
716
+ # Provides configuration information for the instances that will perform
717
+ # the compute work.
718
+ #
719
+ # @note ComputeConfiguration is a union - when making an API calls you must set exactly one of the members.
720
+ #
721
+ # @note ComputeConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ComputeConfiguration corresponding to the set member.
722
+ #
723
+ # @!attribute [rw] worker
724
+ # The worker instances that will perform the compute work.
725
+ # @return [Types::WorkerComputeConfiguration]
726
+ #
727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ComputeConfiguration AWS API Documentation
728
+ #
729
+ class ComputeConfiguration < Struct.new(
730
+ :worker,
731
+ :unknown)
732
+ SENSITIVE = []
733
+ include Aws::Structure
734
+ include Aws::Structure::Union
735
+
736
+ class Worker < ComputeConfiguration; end
737
+ class Unknown < ComputeConfiguration; end
738
+ end
739
+
328
740
  # Configuration information necessary for the configure audience model
329
741
  # output.
330
742
  #
@@ -398,47 +810,195 @@ module Aws::CleanRoomsML
398
810
  include Aws::Structure
399
811
  end
400
812
 
401
- # You can't complete this action because another resource depends on
402
- # this resource.
403
- #
404
- # @!attribute [rw] message
405
- # @return [String]
406
- #
407
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ConflictException AWS API Documentation
813
+ # Provides summary information about the configured model algorithm
814
+ # association.
408
815
  #
409
- class ConflictException < Struct.new(
410
- :message)
411
- SENSITIVE = []
412
- include Aws::Structure
413
- end
414
-
415
- # @!attribute [rw] training_data_start_time
416
- # The start date and time of the training window.
816
+ # @!attribute [rw] create_time
817
+ # The time at which the configured model algorithm association was
818
+ # created.
417
819
  # @return [Time]
418
820
  #
419
- # @!attribute [rw] training_data_end_time
420
- # The end date and time of the training window.
821
+ # @!attribute [rw] update_time
822
+ # The most recent time at which the configured model algorithm
823
+ # association was updated.
421
824
  # @return [Time]
422
825
  #
423
- # @!attribute [rw] name
424
- # The name of the audience model resource.
826
+ # @!attribute [rw] configured_model_algorithm_association_arn
827
+ # The Amazon Resource Name (ARN) of the configured model algorithm
828
+ # association.
425
829
  # @return [String]
426
830
  #
427
- # @!attribute [rw] training_dataset_arn
428
- # The Amazon Resource Name (ARN) of the training dataset for this
429
- # audience model.
831
+ # @!attribute [rw] configured_model_algorithm_arn
832
+ # The Amazon Resource Name (ARN) of the configured model algorithm
833
+ # that is being associated.
430
834
  # @return [String]
431
835
  #
432
- # @!attribute [rw] kms_key_arn
433
- # The Amazon Resource Name (ARN) of the KMS key. This key is used to
434
- # encrypt and decrypt customer-owned data in the trained ML model and
435
- # the associated data.
836
+ # @!attribute [rw] name
837
+ # The name of the configured model algorithm association.
436
838
  # @return [String]
437
839
  #
438
- # @!attribute [rw] tags
439
- # The optional metadata that you apply to the resource to help you
440
- # categorize and organize them. Each tag consists of a key and an
441
- # optional value, both of which you define.
840
+ # @!attribute [rw] description
841
+ # The description of the configured model algorithm association.
842
+ # @return [String]
843
+ #
844
+ # @!attribute [rw] membership_identifier
845
+ # The membership ID of the member that created the configured model
846
+ # algorithm association.
847
+ # @return [String]
848
+ #
849
+ # @!attribute [rw] collaboration_identifier
850
+ # The collaboration ID of the collaboration that contains the
851
+ # configured model algorithm association.
852
+ # @return [String]
853
+ #
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ConfiguredModelAlgorithmAssociationSummary AWS API Documentation
855
+ #
856
+ class ConfiguredModelAlgorithmAssociationSummary < Struct.new(
857
+ :create_time,
858
+ :update_time,
859
+ :configured_model_algorithm_association_arn,
860
+ :configured_model_algorithm_arn,
861
+ :name,
862
+ :description,
863
+ :membership_identifier,
864
+ :collaboration_identifier)
865
+ SENSITIVE = []
866
+ include Aws::Structure
867
+ end
868
+
869
+ # Provides summary information about a configured model algorithm.
870
+ #
871
+ # @!attribute [rw] create_time
872
+ # The time at which the configured model algorithm was created.
873
+ # @return [Time]
874
+ #
875
+ # @!attribute [rw] update_time
876
+ # The most recent time at which the configured model algorithm was
877
+ # updated.
878
+ # @return [Time]
879
+ #
880
+ # @!attribute [rw] configured_model_algorithm_arn
881
+ # The Amazon Resource Name (ARN) of the configured model algorithm.
882
+ # @return [String]
883
+ #
884
+ # @!attribute [rw] name
885
+ # The name of the configured model algorithm.
886
+ # @return [String]
887
+ #
888
+ # @!attribute [rw] description
889
+ # The description of the configured model algorithm.
890
+ # @return [String]
891
+ #
892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ConfiguredModelAlgorithmSummary AWS API Documentation
893
+ #
894
+ class ConfiguredModelAlgorithmSummary < Struct.new(
895
+ :create_time,
896
+ :update_time,
897
+ :configured_model_algorithm_arn,
898
+ :name,
899
+ :description)
900
+ SENSITIVE = []
901
+ include Aws::Structure
902
+ end
903
+
904
+ # You can't complete this action because another resource depends on
905
+ # this resource.
906
+ #
907
+ # @!attribute [rw] message
908
+ # @return [String]
909
+ #
910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ConflictException AWS API Documentation
911
+ #
912
+ class ConflictException < Struct.new(
913
+ :message)
914
+ SENSITIVE = []
915
+ include Aws::Structure
916
+ end
917
+
918
+ # Provides configuration information for the dockerized container where
919
+ # the model algorithm is stored.
920
+ #
921
+ # @!attribute [rw] image_uri
922
+ # The registry path of the docker image that contains the algorithm.
923
+ # Clean Rooms ML supports both `registry/repository[:tag]` and
924
+ # `registry/repositry[@digest]` image path formats. For more
925
+ # information about using images in Clean Rooms ML, see the [Sagemaker
926
+ # API reference][1].
927
+ #
928
+ #
929
+ #
930
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html#sagemaker-Type-AlgorithmSpecification-TrainingImage
931
+ # @return [String]
932
+ #
933
+ # @!attribute [rw] entrypoint
934
+ # The entrypoint script for a Docker container used to run a training
935
+ # job. This script takes precedence over the default train processing
936
+ # instructions. See How Amazon SageMaker Runs Your Training Image for
937
+ # additional information. For more information, see [How Sagemaker
938
+ # runs your training image][1].
939
+ #
940
+ #
941
+ #
942
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo-dockerfile.html
943
+ # @return [Array<String>]
944
+ #
945
+ # @!attribute [rw] arguments
946
+ # The arguments for a container used to run a training job. See How
947
+ # Amazon SageMaker Runs Your Training Image for additional
948
+ # information. For more information, see [How Sagemaker runs your
949
+ # training image][1].
950
+ #
951
+ #
952
+ #
953
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo-dockerfile.html
954
+ # @return [Array<String>]
955
+ #
956
+ # @!attribute [rw] metric_definitions
957
+ # A list of metric definition objects. Each object specifies the
958
+ # metric name and regular expressions used to parse algorithm logs.
959
+ # Amazon Web Services Clean Rooms ML publishes each metric to all
960
+ # members' Amazon CloudWatch using IAM role configured in
961
+ # PutMLConfiguration.
962
+ # @return [Array<Types::MetricDefinition>]
963
+ #
964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ContainerConfig AWS API Documentation
965
+ #
966
+ class ContainerConfig < Struct.new(
967
+ :image_uri,
968
+ :entrypoint,
969
+ :arguments,
970
+ :metric_definitions)
971
+ SENSITIVE = []
972
+ include Aws::Structure
973
+ end
974
+
975
+ # @!attribute [rw] training_data_start_time
976
+ # The start date and time of the training window.
977
+ # @return [Time]
978
+ #
979
+ # @!attribute [rw] training_data_end_time
980
+ # The end date and time of the training window.
981
+ # @return [Time]
982
+ #
983
+ # @!attribute [rw] name
984
+ # The name of the audience model resource.
985
+ # @return [String]
986
+ #
987
+ # @!attribute [rw] training_dataset_arn
988
+ # The Amazon Resource Name (ARN) of the training dataset for this
989
+ # audience model.
990
+ # @return [String]
991
+ #
992
+ # @!attribute [rw] kms_key_arn
993
+ # The Amazon Resource Name (ARN) of the KMS key. This key is used to
994
+ # encrypt and decrypt customer-owned data in the trained ML model and
995
+ # the associated data.
996
+ # @return [String]
997
+ #
998
+ # @!attribute [rw] tags
999
+ # The optional metadata that you apply to the resource to help you
1000
+ # categorize and organize them. Each tag consists of a key and an
1001
+ # optional value, both of which you define.
442
1002
  #
443
1003
  # The following basic restrictions apply to tags:
444
1004
  #
@@ -615,25 +1175,29 @@ module Aws::CleanRoomsML
615
1175
  include Aws::Structure
616
1176
  end
617
1177
 
618
- # @!attribute [rw] name
619
- # The name of the training dataset. This name must be unique in your
620
- # account and region.
1178
+ # @!attribute [rw] membership_identifier
1179
+ # The membership ID of the member who is associating this configured
1180
+ # model algorithm.
621
1181
  # @return [String]
622
1182
  #
623
- # @!attribute [rw] role_arn
624
- # The ARN of the IAM role that Clean Rooms ML can assume to read the
625
- # data referred to in the `dataSource` field of each dataset.
1183
+ # @!attribute [rw] configured_model_algorithm_arn
1184
+ # The Amazon Resource Name (ARN) of the configured model algorithm
1185
+ # that you want to associate.
1186
+ # @return [String]
626
1187
  #
627
- # Passing a role across AWS accounts is not allowed. If you pass a
628
- # role that isn't in your account, you get an `AccessDeniedException`
629
- # error.
1188
+ # @!attribute [rw] name
1189
+ # The name of the configured model algorithm association.
630
1190
  # @return [String]
631
1191
  #
632
- # @!attribute [rw] training_data
633
- # An array of information that lists the Dataset objects, which
634
- # specifies the dataset type and details on its location and schema.
635
- # You must provide a role that has read access to these tables.
636
- # @return [Array<Types::Dataset>]
1192
+ # @!attribute [rw] description
1193
+ # The description of the configured model algorithm association.
1194
+ # @return [String]
1195
+ #
1196
+ # @!attribute [rw] privacy_configuration
1197
+ # Specifies the privacy configuration information for the configured
1198
+ # model algorithm association. This information includes the maximum
1199
+ # data size that can be exported.
1200
+ # @return [Types::PrivacyConfiguration]
637
1201
  #
638
1202
  # @!attribute [rw] tags
639
1203
  # The optional metadata that you apply to the resource to help you
@@ -668,562 +1232,2666 @@ module Aws::CleanRoomsML
668
1232
  # of aws do not count against your tags per resource limit.
669
1233
  # @return [Hash<String,String>]
670
1234
  #
671
- # @!attribute [rw] description
672
- # The description of the training dataset.
673
- # @return [String]
674
- #
675
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainingDatasetRequest AWS API Documentation
1235
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredModelAlgorithmAssociationRequest AWS API Documentation
676
1236
  #
677
- class CreateTrainingDatasetRequest < Struct.new(
1237
+ class CreateConfiguredModelAlgorithmAssociationRequest < Struct.new(
1238
+ :membership_identifier,
1239
+ :configured_model_algorithm_arn,
678
1240
  :name,
679
- :role_arn,
680
- :training_data,
681
- :tags,
682
- :description)
1241
+ :description,
1242
+ :privacy_configuration,
1243
+ :tags)
683
1244
  SENSITIVE = []
684
1245
  include Aws::Structure
685
1246
  end
686
1247
 
687
- # @!attribute [rw] training_dataset_arn
688
- # The Amazon Resource Name (ARN) of the training dataset resource.
1248
+ # @!attribute [rw] configured_model_algorithm_association_arn
1249
+ # The Amazon Resource Name (ARN) of the configured model algorithm
1250
+ # association.
689
1251
  # @return [String]
690
1252
  #
691
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainingDatasetResponse AWS API Documentation
1253
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredModelAlgorithmAssociationResponse AWS API Documentation
692
1254
  #
693
- class CreateTrainingDatasetResponse < Struct.new(
694
- :training_dataset_arn)
1255
+ class CreateConfiguredModelAlgorithmAssociationResponse < Struct.new(
1256
+ :configured_model_algorithm_association_arn)
695
1257
  SENSITIVE = []
696
1258
  include Aws::Structure
697
1259
  end
698
1260
 
699
- # Defines information about the Glue data source that contains the
700
- # training data.
1261
+ # @!attribute [rw] name
1262
+ # The name of the configured model algorithm.
1263
+ # @return [String]
701
1264
  #
702
- # @!attribute [rw] glue_data_source
703
- # A GlueDataSource object that defines the catalog ID, database name,
704
- # and table name for the training data.
705
- # @return [Types::GlueDataSource]
1265
+ # @!attribute [rw] description
1266
+ # The description of the configured model algorithm.
1267
+ # @return [String]
706
1268
  #
707
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DataSource AWS API Documentation
1269
+ # @!attribute [rw] role_arn
1270
+ # The Amazon Resource Name (ARN) of the role that is used to access
1271
+ # the repository.
1272
+ # @return [String]
708
1273
  #
709
- class DataSource < Struct.new(
710
- :glue_data_source)
711
- SENSITIVE = []
712
- include Aws::Structure
713
- end
714
-
715
- # Defines where the training dataset is located, what type of data it
716
- # contains, and how to access the data.
1274
+ # @!attribute [rw] training_container_config
1275
+ # Configuration information for the training container, including
1276
+ # entrypoints and arguments.
1277
+ # @return [Types::ContainerConfig]
717
1278
  #
718
- # @!attribute [rw] type
719
- # What type of information is found in the dataset.
720
- # @return [String]
1279
+ # @!attribute [rw] inference_container_config
1280
+ # Configuration information for the inference container that is used
1281
+ # when you run an inference job on a configured model algorithm.
1282
+ # @return [Types::InferenceContainerConfig]
721
1283
  #
722
- # @!attribute [rw] input_config
723
- # A DatasetInputConfig object that defines the data source and schema
724
- # mapping.
725
- # @return [Types::DatasetInputConfig]
1284
+ # @!attribute [rw] tags
1285
+ # The optional metadata that you apply to the resource to help you
1286
+ # categorize and organize them. Each tag consists of a key and an
1287
+ # optional value, both of which you define.
726
1288
  #
727
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/Dataset AWS API Documentation
1289
+ # The following basic restrictions apply to tags:
728
1290
  #
729
- class Dataset < Struct.new(
730
- :type,
731
- :input_config)
732
- SENSITIVE = []
733
- include Aws::Structure
734
- end
735
-
736
- # Defines the Glue data source and schema mapping information.
1291
+ # * Maximum number of tags per resource - 50.
737
1292
  #
738
- # @!attribute [rw] schema
739
- # The schema information for the training data.
740
- # @return [Array<Types::ColumnSchema>]
1293
+ # * For each resource, each tag key must be unique, and each tag key
1294
+ # can have only one value.
741
1295
  #
742
- # @!attribute [rw] data_source
743
- # A DataSource object that specifies the Glue data source for the
744
- # training data.
745
- # @return [Types::DataSource]
1296
+ # * Maximum key length - 128 Unicode characters in UTF-8.
746
1297
  #
747
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DatasetInputConfig AWS API Documentation
1298
+ # * Maximum value length - 256 Unicode characters in UTF-8.
748
1299
  #
749
- class DatasetInputConfig < Struct.new(
750
- :schema,
751
- :data_source)
752
- SENSITIVE = []
753
- include Aws::Structure
754
- end
755
-
756
- # @!attribute [rw] audience_generation_job_arn
757
- # The Amazon Resource Name (ARN) of the audience generation job that
758
- # you want to delete.
1300
+ # * If your tagging schema is used across multiple services and
1301
+ # resources, remember that other services may have restrictions on
1302
+ # allowed characters. Generally allowed characters are: letters,
1303
+ # numbers, and spaces representable in UTF-8, and the following
1304
+ # characters: + - = . \_ : / @.
1305
+ #
1306
+ # * Tag keys and values are case sensitive.
1307
+ #
1308
+ # * Do not use aws:, AWS:, or any upper or lowercase combination of
1309
+ # such as a prefix for keys as it is reserved for AWS use. You
1310
+ # cannot edit or delete tag keys with this prefix. Values can have
1311
+ # this prefix. If a tag value has aws as its prefix but the key does
1312
+ # not, then Clean Rooms ML considers it to be a user tag and will
1313
+ # count against the limit of 50 tags. Tags with only the key prefix
1314
+ # of aws do not count against your tags per resource limit.
1315
+ # @return [Hash<String,String>]
1316
+ #
1317
+ # @!attribute [rw] kms_key_arn
1318
+ # The Amazon Resource Name (ARN) of the KMS key. This key is used to
1319
+ # encrypt and decrypt customer-owned data in the configured ML model
1320
+ # algorithm and associated data.
759
1321
  # @return [String]
760
1322
  #
761
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceGenerationJobRequest AWS API Documentation
1323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredModelAlgorithmRequest AWS API Documentation
762
1324
  #
763
- class DeleteAudienceGenerationJobRequest < Struct.new(
764
- :audience_generation_job_arn)
1325
+ class CreateConfiguredModelAlgorithmRequest < Struct.new(
1326
+ :name,
1327
+ :description,
1328
+ :role_arn,
1329
+ :training_container_config,
1330
+ :inference_container_config,
1331
+ :tags,
1332
+ :kms_key_arn)
765
1333
  SENSITIVE = []
766
1334
  include Aws::Structure
767
1335
  end
768
1336
 
769
- # @!attribute [rw] audience_model_arn
770
- # The Amazon Resource Name (ARN) of the audience model that you want
771
- # to delete.
1337
+ # @!attribute [rw] configured_model_algorithm_arn
1338
+ # The Amazon Resource Name (ARN) of the configured model algorithm.
772
1339
  # @return [String]
773
1340
  #
774
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceModelRequest AWS API Documentation
1341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredModelAlgorithmResponse AWS API Documentation
775
1342
  #
776
- class DeleteAudienceModelRequest < Struct.new(
777
- :audience_model_arn)
1343
+ class CreateConfiguredModelAlgorithmResponse < Struct.new(
1344
+ :configured_model_algorithm_arn)
778
1345
  SENSITIVE = []
779
1346
  include Aws::Structure
780
1347
  end
781
1348
 
782
- # @!attribute [rw] configured_audience_model_arn
783
- # The Amazon Resource Name (ARN) of the configured audience model
784
- # policy that you want to delete.
1349
+ # @!attribute [rw] membership_identifier
1350
+ # The membership ID of the member that is creating the ML input
1351
+ # channel.
785
1352
  # @return [String]
786
1353
  #
787
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModelPolicyRequest AWS API Documentation
1354
+ # @!attribute [rw] configured_model_algorithm_associations
1355
+ # The associated configured model algorithms that are necessary to
1356
+ # create this ML input channel.
1357
+ # @return [Array<String>]
788
1358
  #
789
- class DeleteConfiguredAudienceModelPolicyRequest < Struct.new(
790
- :configured_audience_model_arn)
791
- SENSITIVE = []
792
- include Aws::Structure
793
- end
794
-
795
- # @!attribute [rw] configured_audience_model_arn
796
- # The Amazon Resource Name (ARN) of the configured audience model that
797
- # you want to delete.
1359
+ # @!attribute [rw] input_channel
1360
+ # The input data that is used to create this ML input channel.
1361
+ # @return [Types::InputChannel]
1362
+ #
1363
+ # @!attribute [rw] name
1364
+ # The name of the ML input channel.
798
1365
  # @return [String]
799
1366
  #
800
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModelRequest AWS API Documentation
1367
+ # @!attribute [rw] retention_in_days
1368
+ # The number of days that the data in the ML input channel is
1369
+ # retained.
1370
+ # @return [Integer]
801
1371
  #
802
- class DeleteConfiguredAudienceModelRequest < Struct.new(
803
- :configured_audience_model_arn)
804
- SENSITIVE = []
805
- include Aws::Structure
806
- end
1372
+ # @!attribute [rw] description
1373
+ # The description of the ML input channel.
1374
+ # @return [String]
1375
+ #
1376
+ # @!attribute [rw] kms_key_arn
1377
+ # The Amazon Resource Name (ARN) of the KMS key that is used to access
1378
+ # the input channel.
1379
+ # @return [String]
1380
+ #
1381
+ # @!attribute [rw] tags
1382
+ # The optional metadata that you apply to the resource to help you
1383
+ # categorize and organize them. Each tag consists of a key and an
1384
+ # optional value, both of which you define.
1385
+ #
1386
+ # The following basic restrictions apply to tags:
1387
+ #
1388
+ # * Maximum number of tags per resource - 50.
1389
+ #
1390
+ # * For each resource, each tag key must be unique, and each tag key
1391
+ # can have only one value.
1392
+ #
1393
+ # * Maximum key length - 128 Unicode characters in UTF-8.
1394
+ #
1395
+ # * Maximum value length - 256 Unicode characters in UTF-8.
1396
+ #
1397
+ # * If your tagging schema is used across multiple services and
1398
+ # resources, remember that other services may have restrictions on
1399
+ # allowed characters. Generally allowed characters are: letters,
1400
+ # numbers, and spaces representable in UTF-8, and the following
1401
+ # characters: + - = . \_ : / @.
1402
+ #
1403
+ # * Tag keys and values are case sensitive.
1404
+ #
1405
+ # * Do not use aws:, AWS:, or any upper or lowercase combination of
1406
+ # such as a prefix for keys as it is reserved for AWS use. You
1407
+ # cannot edit or delete tag keys with this prefix. Values can have
1408
+ # this prefix. If a tag value has aws as its prefix but the key does
1409
+ # not, then Clean Rooms ML considers it to be a user tag and will
1410
+ # count against the limit of 50 tags. Tags with only the key prefix
1411
+ # of aws do not count against your tags per resource limit.
1412
+ # @return [Hash<String,String>]
1413
+ #
1414
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateMLInputChannelRequest AWS API Documentation
1415
+ #
1416
+ class CreateMLInputChannelRequest < Struct.new(
1417
+ :membership_identifier,
1418
+ :configured_model_algorithm_associations,
1419
+ :input_channel,
1420
+ :name,
1421
+ :retention_in_days,
1422
+ :description,
1423
+ :kms_key_arn,
1424
+ :tags)
1425
+ SENSITIVE = []
1426
+ include Aws::Structure
1427
+ end
1428
+
1429
+ # @!attribute [rw] ml_input_channel_arn
1430
+ # The Amazon Resource Name (ARN) of the ML input channel.
1431
+ # @return [String]
1432
+ #
1433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateMLInputChannelResponse AWS API Documentation
1434
+ #
1435
+ class CreateMLInputChannelResponse < Struct.new(
1436
+ :ml_input_channel_arn)
1437
+ SENSITIVE = []
1438
+ include Aws::Structure
1439
+ end
1440
+
1441
+ # @!attribute [rw] membership_identifier
1442
+ # The membership ID of the member that is creating the trained model.
1443
+ # @return [String]
1444
+ #
1445
+ # @!attribute [rw] name
1446
+ # The name of the trained model.
1447
+ # @return [String]
1448
+ #
1449
+ # @!attribute [rw] configured_model_algorithm_association_arn
1450
+ # The associated configured model algorithm used to train this model.
1451
+ # @return [String]
1452
+ #
1453
+ # @!attribute [rw] hyperparameters
1454
+ # Algorithm-specific parameters that influence the quality of the
1455
+ # model. You set hyperparameters before you start the learning
1456
+ # process.
1457
+ # @return [Hash<String,String>]
1458
+ #
1459
+ # @!attribute [rw] environment
1460
+ # The environment variables to set in the Docker container.
1461
+ # @return [Hash<String,String>]
1462
+ #
1463
+ # @!attribute [rw] resource_config
1464
+ # Information about the EC2 resources that are used to train this
1465
+ # model.
1466
+ # @return [Types::ResourceConfig]
1467
+ #
1468
+ # @!attribute [rw] stopping_condition
1469
+ # The criteria that is used to stop model training.
1470
+ # @return [Types::StoppingCondition]
1471
+ #
1472
+ # @!attribute [rw] data_channels
1473
+ # Defines the data channels that are used as input for the trained
1474
+ # model request.
1475
+ # @return [Array<Types::ModelTrainingDataChannel>]
1476
+ #
1477
+ # @!attribute [rw] description
1478
+ # The description of the trained model.
1479
+ # @return [String]
1480
+ #
1481
+ # @!attribute [rw] kms_key_arn
1482
+ # The Amazon Resource Name (ARN) of the KMS key. This key is used to
1483
+ # encrypt and decrypt customer-owned data in the trained ML model and
1484
+ # the associated data.
1485
+ # @return [String]
1486
+ #
1487
+ # @!attribute [rw] tags
1488
+ # The optional metadata that you apply to the resource to help you
1489
+ # categorize and organize them. Each tag consists of a key and an
1490
+ # optional value, both of which you define.
1491
+ #
1492
+ # The following basic restrictions apply to tags:
1493
+ #
1494
+ # * Maximum number of tags per resource - 50.
1495
+ #
1496
+ # * For each resource, each tag key must be unique, and each tag key
1497
+ # can have only one value.
1498
+ #
1499
+ # * Maximum key length - 128 Unicode characters in UTF-8.
1500
+ #
1501
+ # * Maximum value length - 256 Unicode characters in UTF-8.
1502
+ #
1503
+ # * If your tagging schema is used across multiple services and
1504
+ # resources, remember that other services may have restrictions on
1505
+ # allowed characters. Generally allowed characters are: letters,
1506
+ # numbers, and spaces representable in UTF-8, and the following
1507
+ # characters: + - = . \_ : / @.
1508
+ #
1509
+ # * Tag keys and values are case sensitive.
1510
+ #
1511
+ # * Do not use aws:, AWS:, or any upper or lowercase combination of
1512
+ # such as a prefix for keys as it is reserved for AWS use. You
1513
+ # cannot edit or delete tag keys with this prefix. Values can have
1514
+ # this prefix. If a tag value has aws as its prefix but the key does
1515
+ # not, then Clean Rooms ML considers it to be a user tag and will
1516
+ # count against the limit of 50 tags. Tags with only the key prefix
1517
+ # of aws do not count against your tags per resource limit.
1518
+ # @return [Hash<String,String>]
1519
+ #
1520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainedModelRequest AWS API Documentation
1521
+ #
1522
+ class CreateTrainedModelRequest < Struct.new(
1523
+ :membership_identifier,
1524
+ :name,
1525
+ :configured_model_algorithm_association_arn,
1526
+ :hyperparameters,
1527
+ :environment,
1528
+ :resource_config,
1529
+ :stopping_condition,
1530
+ :data_channels,
1531
+ :description,
1532
+ :kms_key_arn,
1533
+ :tags)
1534
+ SENSITIVE = []
1535
+ include Aws::Structure
1536
+ end
1537
+
1538
+ # @!attribute [rw] trained_model_arn
1539
+ # The Amazon Resource Name (ARN) of the trained model.
1540
+ # @return [String]
1541
+ #
1542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainedModelResponse AWS API Documentation
1543
+ #
1544
+ class CreateTrainedModelResponse < Struct.new(
1545
+ :trained_model_arn)
1546
+ SENSITIVE = []
1547
+ include Aws::Structure
1548
+ end
1549
+
1550
+ # @!attribute [rw] name
1551
+ # The name of the training dataset. This name must be unique in your
1552
+ # account and region.
1553
+ # @return [String]
1554
+ #
1555
+ # @!attribute [rw] role_arn
1556
+ # The ARN of the IAM role that Clean Rooms ML can assume to read the
1557
+ # data referred to in the `dataSource` field of each dataset.
1558
+ #
1559
+ # Passing a role across AWS accounts is not allowed. If you pass a
1560
+ # role that isn't in your account, you get an `AccessDeniedException`
1561
+ # error.
1562
+ # @return [String]
1563
+ #
1564
+ # @!attribute [rw] training_data
1565
+ # An array of information that lists the Dataset objects, which
1566
+ # specifies the dataset type and details on its location and schema.
1567
+ # You must provide a role that has read access to these tables.
1568
+ # @return [Array<Types::Dataset>]
1569
+ #
1570
+ # @!attribute [rw] tags
1571
+ # The optional metadata that you apply to the resource to help you
1572
+ # categorize and organize them. Each tag consists of a key and an
1573
+ # optional value, both of which you define.
1574
+ #
1575
+ # The following basic restrictions apply to tags:
1576
+ #
1577
+ # * Maximum number of tags per resource - 50.
1578
+ #
1579
+ # * For each resource, each tag key must be unique, and each tag key
1580
+ # can have only one value.
1581
+ #
1582
+ # * Maximum key length - 128 Unicode characters in UTF-8.
1583
+ #
1584
+ # * Maximum value length - 256 Unicode characters in UTF-8.
1585
+ #
1586
+ # * If your tagging schema is used across multiple services and
1587
+ # resources, remember that other services may have restrictions on
1588
+ # allowed characters. Generally allowed characters are: letters,
1589
+ # numbers, and spaces representable in UTF-8, and the following
1590
+ # characters: + - = . \_ : / @.
1591
+ #
1592
+ # * Tag keys and values are case sensitive.
1593
+ #
1594
+ # * Do not use aws:, AWS:, or any upper or lowercase combination of
1595
+ # such as a prefix for keys as it is reserved for AWS use. You
1596
+ # cannot edit or delete tag keys with this prefix. Values can have
1597
+ # this prefix. If a tag value has aws as its prefix but the key does
1598
+ # not, then Clean Rooms ML considers it to be a user tag and will
1599
+ # count against the limit of 50 tags. Tags with only the key prefix
1600
+ # of aws do not count against your tags per resource limit.
1601
+ # @return [Hash<String,String>]
1602
+ #
1603
+ # @!attribute [rw] description
1604
+ # The description of the training dataset.
1605
+ # @return [String]
1606
+ #
1607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainingDatasetRequest AWS API Documentation
1608
+ #
1609
+ class CreateTrainingDatasetRequest < Struct.new(
1610
+ :name,
1611
+ :role_arn,
1612
+ :training_data,
1613
+ :tags,
1614
+ :description)
1615
+ SENSITIVE = []
1616
+ include Aws::Structure
1617
+ end
1618
+
1619
+ # @!attribute [rw] training_dataset_arn
1620
+ # The Amazon Resource Name (ARN) of the training dataset resource.
1621
+ # @return [String]
1622
+ #
1623
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainingDatasetResponse AWS API Documentation
1624
+ #
1625
+ class CreateTrainingDatasetResponse < Struct.new(
1626
+ :training_dataset_arn)
1627
+ SENSITIVE = []
1628
+ include Aws::Structure
1629
+ end
1630
+
1631
+ # Defines information about the Glue data source that contains the
1632
+ # training data.
1633
+ #
1634
+ # @!attribute [rw] glue_data_source
1635
+ # A GlueDataSource object that defines the catalog ID, database name,
1636
+ # and table name for the training data.
1637
+ # @return [Types::GlueDataSource]
1638
+ #
1639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DataSource AWS API Documentation
1640
+ #
1641
+ class DataSource < Struct.new(
1642
+ :glue_data_source)
1643
+ SENSITIVE = []
1644
+ include Aws::Structure
1645
+ end
1646
+
1647
+ # Defines where the training dataset is located, what type of data it
1648
+ # contains, and how to access the data.
1649
+ #
1650
+ # @!attribute [rw] type
1651
+ # What type of information is found in the dataset.
1652
+ # @return [String]
1653
+ #
1654
+ # @!attribute [rw] input_config
1655
+ # A DatasetInputConfig object that defines the data source and schema
1656
+ # mapping.
1657
+ # @return [Types::DatasetInputConfig]
1658
+ #
1659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/Dataset AWS API Documentation
1660
+ #
1661
+ class Dataset < Struct.new(
1662
+ :type,
1663
+ :input_config)
1664
+ SENSITIVE = []
1665
+ include Aws::Structure
1666
+ end
1667
+
1668
+ # Defines the Glue data source and schema mapping information.
1669
+ #
1670
+ # @!attribute [rw] schema
1671
+ # The schema information for the training data.
1672
+ # @return [Array<Types::ColumnSchema>]
1673
+ #
1674
+ # @!attribute [rw] data_source
1675
+ # A DataSource object that specifies the Glue data source for the
1676
+ # training data.
1677
+ # @return [Types::DataSource]
1678
+ #
1679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DatasetInputConfig AWS API Documentation
1680
+ #
1681
+ class DatasetInputConfig < Struct.new(
1682
+ :schema,
1683
+ :data_source)
1684
+ SENSITIVE = []
1685
+ include Aws::Structure
1686
+ end
1687
+
1688
+ # @!attribute [rw] audience_generation_job_arn
1689
+ # The Amazon Resource Name (ARN) of the audience generation job that
1690
+ # you want to delete.
1691
+ # @return [String]
1692
+ #
1693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceGenerationJobRequest AWS API Documentation
1694
+ #
1695
+ class DeleteAudienceGenerationJobRequest < Struct.new(
1696
+ :audience_generation_job_arn)
1697
+ SENSITIVE = []
1698
+ include Aws::Structure
1699
+ end
1700
+
1701
+ # @!attribute [rw] audience_model_arn
1702
+ # The Amazon Resource Name (ARN) of the audience model that you want
1703
+ # to delete.
1704
+ # @return [String]
1705
+ #
1706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceModelRequest AWS API Documentation
1707
+ #
1708
+ class DeleteAudienceModelRequest < Struct.new(
1709
+ :audience_model_arn)
1710
+ SENSITIVE = []
1711
+ include Aws::Structure
1712
+ end
1713
+
1714
+ # @!attribute [rw] configured_audience_model_arn
1715
+ # The Amazon Resource Name (ARN) of the configured audience model
1716
+ # policy that you want to delete.
1717
+ # @return [String]
1718
+ #
1719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModelPolicyRequest AWS API Documentation
1720
+ #
1721
+ class DeleteConfiguredAudienceModelPolicyRequest < Struct.new(
1722
+ :configured_audience_model_arn)
1723
+ SENSITIVE = []
1724
+ include Aws::Structure
1725
+ end
1726
+
1727
+ # @!attribute [rw] configured_audience_model_arn
1728
+ # The Amazon Resource Name (ARN) of the configured audience model that
1729
+ # you want to delete.
1730
+ # @return [String]
1731
+ #
1732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModelRequest AWS API Documentation
1733
+ #
1734
+ class DeleteConfiguredAudienceModelRequest < Struct.new(
1735
+ :configured_audience_model_arn)
1736
+ SENSITIVE = []
1737
+ include Aws::Structure
1738
+ end
1739
+
1740
+ # @!attribute [rw] configured_model_algorithm_association_arn
1741
+ # The Amazon Resource Name (ARN) of the configured model algorithm
1742
+ # association that you want to delete.
1743
+ # @return [String]
1744
+ #
1745
+ # @!attribute [rw] membership_identifier
1746
+ # The membership ID of the member that is deleting the configured
1747
+ # model algorithm association.
1748
+ # @return [String]
1749
+ #
1750
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredModelAlgorithmAssociationRequest AWS API Documentation
1751
+ #
1752
+ class DeleteConfiguredModelAlgorithmAssociationRequest < Struct.new(
1753
+ :configured_model_algorithm_association_arn,
1754
+ :membership_identifier)
1755
+ SENSITIVE = []
1756
+ include Aws::Structure
1757
+ end
1758
+
1759
+ # @!attribute [rw] configured_model_algorithm_arn
1760
+ # The Amazon Resource Name (ARN) of the configured model algorithm
1761
+ # that you want to delete.
1762
+ # @return [String]
1763
+ #
1764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredModelAlgorithmRequest AWS API Documentation
1765
+ #
1766
+ class DeleteConfiguredModelAlgorithmRequest < Struct.new(
1767
+ :configured_model_algorithm_arn)
1768
+ SENSITIVE = []
1769
+ include Aws::Structure
1770
+ end
1771
+
1772
+ # @!attribute [rw] membership_identifier
1773
+ # The membership ID of the of the member that is deleting the ML
1774
+ # modeling configuration.
1775
+ # @return [String]
1776
+ #
1777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteMLConfigurationRequest AWS API Documentation
1778
+ #
1779
+ class DeleteMLConfigurationRequest < Struct.new(
1780
+ :membership_identifier)
1781
+ SENSITIVE = []
1782
+ include Aws::Structure
1783
+ end
1784
+
1785
+ # @!attribute [rw] ml_input_channel_arn
1786
+ # The Amazon Resource Name (ARN) of the ML input channel that you want
1787
+ # to delete.
1788
+ # @return [String]
1789
+ #
1790
+ # @!attribute [rw] membership_identifier
1791
+ # The membership ID of the membership that contains the ML input
1792
+ # channel you want to delete.
1793
+ # @return [String]
1794
+ #
1795
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteMLInputChannelDataRequest AWS API Documentation
1796
+ #
1797
+ class DeleteMLInputChannelDataRequest < Struct.new(
1798
+ :ml_input_channel_arn,
1799
+ :membership_identifier)
1800
+ SENSITIVE = []
1801
+ include Aws::Structure
1802
+ end
1803
+
1804
+ # @!attribute [rw] trained_model_arn
1805
+ # The Amazon Resource Name (ARN) of the trained model whose output you
1806
+ # want to delete.
1807
+ # @return [String]
1808
+ #
1809
+ # @!attribute [rw] membership_identifier
1810
+ # The membership ID of the member that is deleting the trained model
1811
+ # output.
1812
+ # @return [String]
1813
+ #
1814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteTrainedModelOutputRequest AWS API Documentation
1815
+ #
1816
+ class DeleteTrainedModelOutputRequest < Struct.new(
1817
+ :trained_model_arn,
1818
+ :membership_identifier)
1819
+ SENSITIVE = []
1820
+ include Aws::Structure
1821
+ end
1822
+
1823
+ # @!attribute [rw] training_dataset_arn
1824
+ # The Amazon Resource Name (ARN) of the training dataset that you want
1825
+ # to delete.
1826
+ # @return [String]
1827
+ #
1828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteTrainingDatasetRequest AWS API Documentation
1829
+ #
1830
+ class DeleteTrainingDatasetRequest < Struct.new(
1831
+ :training_dataset_arn)
1832
+ SENSITIVE = []
1833
+ include Aws::Structure
1834
+ end
1835
+
1836
+ # The Amazon S3 location where the exported model artifacts are stored.
1837
+ #
1838
+ # @!attribute [rw] s3_destination
1839
+ # Provides information about an Amazon S3 bucket and path.
1840
+ # @return [Types::S3ConfigMap]
1841
+ #
1842
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/Destination AWS API Documentation
1843
+ #
1844
+ class Destination < Struct.new(
1845
+ :s3_destination)
1846
+ SENSITIVE = []
1847
+ include Aws::Structure
1848
+ end
1849
+
1850
+ # @!attribute [rw] audience_generation_job_arn
1851
+ # The Amazon Resource Name (ARN) of the audience generation job that
1852
+ # you are interested in.
1853
+ # @return [String]
1854
+ #
1855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJobRequest AWS API Documentation
1856
+ #
1857
+ class GetAudienceGenerationJobRequest < Struct.new(
1858
+ :audience_generation_job_arn)
1859
+ SENSITIVE = []
1860
+ include Aws::Structure
1861
+ end
1862
+
1863
+ # @!attribute [rw] create_time
1864
+ # The time at which the audience generation job was created.
1865
+ # @return [Time]
1866
+ #
1867
+ # @!attribute [rw] update_time
1868
+ # The most recent time at which the audience generation job was
1869
+ # updated.
1870
+ # @return [Time]
1871
+ #
1872
+ # @!attribute [rw] audience_generation_job_arn
1873
+ # The Amazon Resource Name (ARN) of the audience generation job.
1874
+ # @return [String]
1875
+ #
1876
+ # @!attribute [rw] name
1877
+ # The name of the audience generation job.
1878
+ # @return [String]
1879
+ #
1880
+ # @!attribute [rw] description
1881
+ # The description of the audience generation job.
1882
+ # @return [String]
1883
+ #
1884
+ # @!attribute [rw] status
1885
+ # The status of the audience generation job.
1886
+ # @return [String]
1887
+ #
1888
+ # @!attribute [rw] status_details
1889
+ # Details about the status of the audience generation job.
1890
+ # @return [Types::StatusDetails]
1891
+ #
1892
+ # @!attribute [rw] configured_audience_model_arn
1893
+ # The Amazon Resource Name (ARN) of the configured audience model used
1894
+ # for this audience generation job.
1895
+ # @return [String]
1896
+ #
1897
+ # @!attribute [rw] seed_audience
1898
+ # The seed audience that was used for this audience generation job.
1899
+ # This field will be null if the account calling the API is the
1900
+ # account that started this audience generation job.
1901
+ # @return [Types::AudienceGenerationJobDataSource]
1902
+ #
1903
+ # @!attribute [rw] include_seed_in_output
1904
+ # Configure whether the seed users are included in the output
1905
+ # audience. By default, Clean Rooms ML removes seed users from the
1906
+ # output audience. If you specify `TRUE`, the seed users will appear
1907
+ # first in the output. Clean Rooms ML does not explicitly reveal
1908
+ # whether a user was in the seed, but the recipient of the audience
1909
+ # will know that the first `minimumSeedSize` count of users are from
1910
+ # the seed.
1911
+ # @return [Boolean]
1912
+ #
1913
+ # @!attribute [rw] collaboration_id
1914
+ # The identifier of the collaboration that this audience generation
1915
+ # job is associated with.
1916
+ # @return [String]
1917
+ #
1918
+ # @!attribute [rw] metrics
1919
+ # The relevance scores for different audience sizes and the recall
1920
+ # score of the generated audience.
1921
+ # @return [Types::AudienceQualityMetrics]
1922
+ #
1923
+ # @!attribute [rw] started_by
1924
+ # The AWS account that started this audience generation job.
1925
+ # @return [String]
1926
+ #
1927
+ # @!attribute [rw] tags
1928
+ # The tags that are associated to this audience generation job.
1929
+ # @return [Hash<String,String>]
1930
+ #
1931
+ # @!attribute [rw] protected_query_identifier
1932
+ # The unique identifier of the protected query for this audience
1933
+ # generation job.
1934
+ # @return [String]
1935
+ #
1936
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJobResponse AWS API Documentation
1937
+ #
1938
+ class GetAudienceGenerationJobResponse < Struct.new(
1939
+ :create_time,
1940
+ :update_time,
1941
+ :audience_generation_job_arn,
1942
+ :name,
1943
+ :description,
1944
+ :status,
1945
+ :status_details,
1946
+ :configured_audience_model_arn,
1947
+ :seed_audience,
1948
+ :include_seed_in_output,
1949
+ :collaboration_id,
1950
+ :metrics,
1951
+ :started_by,
1952
+ :tags,
1953
+ :protected_query_identifier)
1954
+ SENSITIVE = []
1955
+ include Aws::Structure
1956
+ end
1957
+
1958
+ # @!attribute [rw] audience_model_arn
1959
+ # The Amazon Resource Name (ARN) of the audience model that you are
1960
+ # interested in.
1961
+ # @return [String]
1962
+ #
1963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModelRequest AWS API Documentation
1964
+ #
1965
+ class GetAudienceModelRequest < Struct.new(
1966
+ :audience_model_arn)
1967
+ SENSITIVE = []
1968
+ include Aws::Structure
1969
+ end
1970
+
1971
+ # @!attribute [rw] create_time
1972
+ # The time at which the audience model was created.
1973
+ # @return [Time]
1974
+ #
1975
+ # @!attribute [rw] update_time
1976
+ # The most recent time at which the audience model was updated.
1977
+ # @return [Time]
1978
+ #
1979
+ # @!attribute [rw] training_data_start_time
1980
+ # The start date specified for the training window.
1981
+ # @return [Time]
1982
+ #
1983
+ # @!attribute [rw] training_data_end_time
1984
+ # The end date specified for the training window.
1985
+ # @return [Time]
1986
+ #
1987
+ # @!attribute [rw] audience_model_arn
1988
+ # The Amazon Resource Name (ARN) of the audience model.
1989
+ # @return [String]
1990
+ #
1991
+ # @!attribute [rw] name
1992
+ # The name of the audience model.
1993
+ # @return [String]
1994
+ #
1995
+ # @!attribute [rw] training_dataset_arn
1996
+ # The Amazon Resource Name (ARN) of the training dataset that was used
1997
+ # for this audience model.
1998
+ # @return [String]
1999
+ #
2000
+ # @!attribute [rw] status
2001
+ # The status of the audience model.
2002
+ # @return [String]
2003
+ #
2004
+ # @!attribute [rw] status_details
2005
+ # Details about the status of the audience model.
2006
+ # @return [Types::StatusDetails]
2007
+ #
2008
+ # @!attribute [rw] kms_key_arn
2009
+ # The KMS key ARN used for the audience model.
2010
+ # @return [String]
2011
+ #
2012
+ # @!attribute [rw] tags
2013
+ # The tags that are assigned to the audience model.
2014
+ # @return [Hash<String,String>]
2015
+ #
2016
+ # @!attribute [rw] description
2017
+ # The description of the audience model.
2018
+ # @return [String]
2019
+ #
2020
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModelResponse AWS API Documentation
2021
+ #
2022
+ class GetAudienceModelResponse < Struct.new(
2023
+ :create_time,
2024
+ :update_time,
2025
+ :training_data_start_time,
2026
+ :training_data_end_time,
2027
+ :audience_model_arn,
2028
+ :name,
2029
+ :training_dataset_arn,
2030
+ :status,
2031
+ :status_details,
2032
+ :kms_key_arn,
2033
+ :tags,
2034
+ :description)
2035
+ SENSITIVE = []
2036
+ include Aws::Structure
2037
+ end
2038
+
2039
+ # @!attribute [rw] configured_model_algorithm_association_arn
2040
+ # The Amazon Resource Name (ARN) of the configured model algorithm
2041
+ # association that you want to return information about.
2042
+ # @return [String]
2043
+ #
2044
+ # @!attribute [rw] collaboration_identifier
2045
+ # The collaboration ID for the collaboration that contains the
2046
+ # configured model algorithm association that you want to return
2047
+ # information about.
2048
+ # @return [String]
2049
+ #
2050
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetCollaborationConfiguredModelAlgorithmAssociationRequest AWS API Documentation
2051
+ #
2052
+ class GetCollaborationConfiguredModelAlgorithmAssociationRequest < Struct.new(
2053
+ :configured_model_algorithm_association_arn,
2054
+ :collaboration_identifier)
2055
+ SENSITIVE = []
2056
+ include Aws::Structure
2057
+ end
2058
+
2059
+ # @!attribute [rw] create_time
2060
+ # The time at which the configured model algorithm association was
2061
+ # created.
2062
+ # @return [Time]
2063
+ #
2064
+ # @!attribute [rw] update_time
2065
+ # The most recent time at which the configured model algorithm
2066
+ # association was updated.
2067
+ # @return [Time]
2068
+ #
2069
+ # @!attribute [rw] configured_model_algorithm_association_arn
2070
+ # The Amazon Resource Name (ARN) of the configured model algorithm
2071
+ # association.
2072
+ # @return [String]
2073
+ #
2074
+ # @!attribute [rw] membership_identifier
2075
+ # The membership ID of the member that created the configured model
2076
+ # algorithm association.
2077
+ # @return [String]
2078
+ #
2079
+ # @!attribute [rw] collaboration_identifier
2080
+ # The collaboration ID of the collaboration that contains the
2081
+ # configured model algorithm association.
2082
+ # @return [String]
2083
+ #
2084
+ # @!attribute [rw] configured_model_algorithm_arn
2085
+ # The Amazon Resource Name (ARN) of the configured model algorithm
2086
+ # association.
2087
+ # @return [String]
2088
+ #
2089
+ # @!attribute [rw] name
2090
+ # The name of the configured model algorithm association.
2091
+ # @return [String]
2092
+ #
2093
+ # @!attribute [rw] description
2094
+ # The description of the configured model algorithm association.
2095
+ # @return [String]
2096
+ #
2097
+ # @!attribute [rw] creator_account_id
2098
+ # The account ID of the member that created the configured model
2099
+ # algorithm association.
2100
+ # @return [String]
2101
+ #
2102
+ # @!attribute [rw] privacy_configuration
2103
+ # Information about the privacy configuration for a configured model
2104
+ # algorithm association.
2105
+ # @return [Types::PrivacyConfiguration]
2106
+ #
2107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetCollaborationConfiguredModelAlgorithmAssociationResponse AWS API Documentation
2108
+ #
2109
+ class GetCollaborationConfiguredModelAlgorithmAssociationResponse < Struct.new(
2110
+ :create_time,
2111
+ :update_time,
2112
+ :configured_model_algorithm_association_arn,
2113
+ :membership_identifier,
2114
+ :collaboration_identifier,
2115
+ :configured_model_algorithm_arn,
2116
+ :name,
2117
+ :description,
2118
+ :creator_account_id,
2119
+ :privacy_configuration)
2120
+ SENSITIVE = []
2121
+ include Aws::Structure
2122
+ end
2123
+
2124
+ # @!attribute [rw] ml_input_channel_arn
2125
+ # The Amazon Resource Name (ARN) of the ML input channel that you want
2126
+ # to get.
2127
+ # @return [String]
2128
+ #
2129
+ # @!attribute [rw] collaboration_identifier
2130
+ # The collaboration ID of the collaboration that contains the ML input
2131
+ # channel that you want to get.
2132
+ # @return [String]
2133
+ #
2134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetCollaborationMLInputChannelRequest AWS API Documentation
2135
+ #
2136
+ class GetCollaborationMLInputChannelRequest < Struct.new(
2137
+ :ml_input_channel_arn,
2138
+ :collaboration_identifier)
2139
+ SENSITIVE = []
2140
+ include Aws::Structure
2141
+ end
2142
+
2143
+ # @!attribute [rw] create_time
2144
+ # The time at which the ML input channel was created.
2145
+ # @return [Time]
2146
+ #
2147
+ # @!attribute [rw] update_time
2148
+ # The most recent time at which the ML input channel was updated.
2149
+ # @return [Time]
2150
+ #
2151
+ # @!attribute [rw] creator_account_id
2152
+ # The account ID of the member who created the ML input channel.
2153
+ # @return [String]
2154
+ #
2155
+ # @!attribute [rw] membership_identifier
2156
+ # The membership ID of the membership that contains the ML input
2157
+ # channel.
2158
+ # @return [String]
2159
+ #
2160
+ # @!attribute [rw] collaboration_identifier
2161
+ # The collaboration ID of the collaboration that contains the ML input
2162
+ # channel.
2163
+ # @return [String]
2164
+ #
2165
+ # @!attribute [rw] ml_input_channel_arn
2166
+ # The Amazon Resource Name (ARN) of the ML input channel.
2167
+ # @return [String]
2168
+ #
2169
+ # @!attribute [rw] name
2170
+ # The name of the ML input channel.
2171
+ # @return [String]
2172
+ #
2173
+ # @!attribute [rw] configured_model_algorithm_associations
2174
+ # The configured model algorithm associations that were used to create
2175
+ # the ML input channel.
2176
+ # @return [Array<String>]
2177
+ #
2178
+ # @!attribute [rw] status
2179
+ # The status of the ML input channel.
2180
+ # @return [String]
2181
+ #
2182
+ # @!attribute [rw] status_details
2183
+ # Details about the status of a resource.
2184
+ # @return [Types::StatusDetails]
2185
+ #
2186
+ # @!attribute [rw] retention_in_days
2187
+ # The number of days to retain the data for the ML input channel.
2188
+ # @return [Integer]
2189
+ #
2190
+ # @!attribute [rw] number_of_records
2191
+ # The number of records in the ML input channel.
2192
+ # @return [Integer]
2193
+ #
2194
+ # @!attribute [rw] description
2195
+ # The description of the ML input channel.
2196
+ # @return [String]
2197
+ #
2198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetCollaborationMLInputChannelResponse AWS API Documentation
2199
+ #
2200
+ class GetCollaborationMLInputChannelResponse < Struct.new(
2201
+ :create_time,
2202
+ :update_time,
2203
+ :creator_account_id,
2204
+ :membership_identifier,
2205
+ :collaboration_identifier,
2206
+ :ml_input_channel_arn,
2207
+ :name,
2208
+ :configured_model_algorithm_associations,
2209
+ :status,
2210
+ :status_details,
2211
+ :retention_in_days,
2212
+ :number_of_records,
2213
+ :description)
2214
+ SENSITIVE = []
2215
+ include Aws::Structure
2216
+ end
2217
+
2218
+ # @!attribute [rw] trained_model_arn
2219
+ # The Amazon Resource Name (ARN) of the trained model that you want to
2220
+ # return information about.
2221
+ # @return [String]
2222
+ #
2223
+ # @!attribute [rw] collaboration_identifier
2224
+ # The collaboration ID that contains the trained model that you want
2225
+ # to return information about.
2226
+ # @return [String]
2227
+ #
2228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetCollaborationTrainedModelRequest AWS API Documentation
2229
+ #
2230
+ class GetCollaborationTrainedModelRequest < Struct.new(
2231
+ :trained_model_arn,
2232
+ :collaboration_identifier)
2233
+ SENSITIVE = []
2234
+ include Aws::Structure
2235
+ end
2236
+
2237
+ # @!attribute [rw] membership_identifier
2238
+ # The membership ID of the member that created the trained model.
2239
+ # @return [String]
2240
+ #
2241
+ # @!attribute [rw] collaboration_identifier
2242
+ # The collaboration ID of the collaboration that contains the trained
2243
+ # model.
2244
+ # @return [String]
2245
+ #
2246
+ # @!attribute [rw] trained_model_arn
2247
+ # The Amazon Resource Name (ARN) of the trained model.
2248
+ # @return [String]
2249
+ #
2250
+ # @!attribute [rw] name
2251
+ # The name of the trained model.
2252
+ # @return [String]
2253
+ #
2254
+ # @!attribute [rw] description
2255
+ # The description of the trained model.
2256
+ # @return [String]
2257
+ #
2258
+ # @!attribute [rw] status
2259
+ # The status of the trained model.
2260
+ # @return [String]
2261
+ #
2262
+ # @!attribute [rw] status_details
2263
+ # Details about the status of a resource.
2264
+ # @return [Types::StatusDetails]
2265
+ #
2266
+ # @!attribute [rw] configured_model_algorithm_association_arn
2267
+ # The Amazon Resource Name (ARN) of the configured model algorithm
2268
+ # association that was used to create this trained model.
2269
+ # @return [String]
2270
+ #
2271
+ # @!attribute [rw] resource_config
2272
+ # The EC2 resource configuration that was used to train this model.
2273
+ # @return [Types::ResourceConfig]
2274
+ #
2275
+ # @!attribute [rw] stopping_condition
2276
+ # The stopping condition that determined when model training ended.
2277
+ # @return [Types::StoppingCondition]
2278
+ #
2279
+ # @!attribute [rw] metrics_status
2280
+ # The status of the model metrics.
2281
+ # @return [String]
2282
+ #
2283
+ # @!attribute [rw] metrics_status_details
2284
+ # Details about the status information for the model metrics.
2285
+ # @return [String]
2286
+ #
2287
+ # @!attribute [rw] logs_status
2288
+ # Status information for the logs.
2289
+ # @return [String]
2290
+ #
2291
+ # @!attribute [rw] logs_status_details
2292
+ # Details about the status information for the logs.
2293
+ # @return [String]
2294
+ #
2295
+ # @!attribute [rw] training_container_image_digest
2296
+ # Information about the training container image.
2297
+ # @return [String]
2298
+ #
2299
+ # @!attribute [rw] create_time
2300
+ # The time at which the trained model was created.
2301
+ # @return [Time]
2302
+ #
2303
+ # @!attribute [rw] update_time
2304
+ # The most recent time at which the trained model was updated.
2305
+ # @return [Time]
2306
+ #
2307
+ # @!attribute [rw] creator_account_id
2308
+ # The account ID of the member that created the trained model.
2309
+ # @return [String]
2310
+ #
2311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetCollaborationTrainedModelResponse AWS API Documentation
2312
+ #
2313
+ class GetCollaborationTrainedModelResponse < Struct.new(
2314
+ :membership_identifier,
2315
+ :collaboration_identifier,
2316
+ :trained_model_arn,
2317
+ :name,
2318
+ :description,
2319
+ :status,
2320
+ :status_details,
2321
+ :configured_model_algorithm_association_arn,
2322
+ :resource_config,
2323
+ :stopping_condition,
2324
+ :metrics_status,
2325
+ :metrics_status_details,
2326
+ :logs_status,
2327
+ :logs_status_details,
2328
+ :training_container_image_digest,
2329
+ :create_time,
2330
+ :update_time,
2331
+ :creator_account_id)
2332
+ SENSITIVE = []
2333
+ include Aws::Structure
2334
+ end
2335
+
2336
+ # @!attribute [rw] configured_audience_model_arn
2337
+ # The Amazon Resource Name (ARN) of the configured audience model that
2338
+ # you are interested in.
2339
+ # @return [String]
2340
+ #
2341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelPolicyRequest AWS API Documentation
2342
+ #
2343
+ class GetConfiguredAudienceModelPolicyRequest < Struct.new(
2344
+ :configured_audience_model_arn)
2345
+ SENSITIVE = []
2346
+ include Aws::Structure
2347
+ end
2348
+
2349
+ # @!attribute [rw] configured_audience_model_arn
2350
+ # The Amazon Resource Name (ARN) of the configured audience model.
2351
+ # @return [String]
2352
+ #
2353
+ # @!attribute [rw] configured_audience_model_policy
2354
+ # The configured audience model policy. This is a JSON IAM resource
2355
+ # policy.
2356
+ # @return [String]
2357
+ #
2358
+ # @!attribute [rw] policy_hash
2359
+ # A cryptographic hash of the contents of the policy used to prevent
2360
+ # unexpected concurrent modification of the policy.
2361
+ # @return [String]
2362
+ #
2363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelPolicyResponse AWS API Documentation
2364
+ #
2365
+ class GetConfiguredAudienceModelPolicyResponse < Struct.new(
2366
+ :configured_audience_model_arn,
2367
+ :configured_audience_model_policy,
2368
+ :policy_hash)
2369
+ SENSITIVE = []
2370
+ include Aws::Structure
2371
+ end
2372
+
2373
+ # @!attribute [rw] configured_audience_model_arn
2374
+ # The Amazon Resource Name (ARN) of the configured audience model that
2375
+ # you are interested in.
2376
+ # @return [String]
2377
+ #
2378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelRequest AWS API Documentation
2379
+ #
2380
+ class GetConfiguredAudienceModelRequest < Struct.new(
2381
+ :configured_audience_model_arn)
2382
+ SENSITIVE = []
2383
+ include Aws::Structure
2384
+ end
2385
+
2386
+ # @!attribute [rw] create_time
2387
+ # The time at which the configured audience model was created.
2388
+ # @return [Time]
2389
+ #
2390
+ # @!attribute [rw] update_time
2391
+ # The most recent time at which the configured audience model was
2392
+ # updated.
2393
+ # @return [Time]
2394
+ #
2395
+ # @!attribute [rw] configured_audience_model_arn
2396
+ # The Amazon Resource Name (ARN) of the configured audience model.
2397
+ # @return [String]
2398
+ #
2399
+ # @!attribute [rw] name
2400
+ # The name of the configured audience model.
2401
+ # @return [String]
2402
+ #
2403
+ # @!attribute [rw] audience_model_arn
2404
+ # The Amazon Resource Name (ARN) of the audience model used for this
2405
+ # configured audience model.
2406
+ # @return [String]
2407
+ #
2408
+ # @!attribute [rw] output_config
2409
+ # The output configuration of the configured audience model
2410
+ # @return [Types::ConfiguredAudienceModelOutputConfig]
2411
+ #
2412
+ # @!attribute [rw] description
2413
+ # The description of the configured audience model.
2414
+ # @return [String]
2415
+ #
2416
+ # @!attribute [rw] status
2417
+ # The status of the configured audience model.
2418
+ # @return [String]
2419
+ #
2420
+ # @!attribute [rw] shared_audience_metrics
2421
+ # Whether audience metrics are shared.
2422
+ # @return [Array<String>]
2423
+ #
2424
+ # @!attribute [rw] min_matching_seed_size
2425
+ # The minimum number of users from the seed audience that must match
2426
+ # with users in the training data of the audience model.
2427
+ # @return [Integer]
2428
+ #
2429
+ # @!attribute [rw] audience_size_config
2430
+ # The list of output sizes of audiences that can be created using this
2431
+ # configured audience model. A request to StartAudienceGenerationJob
2432
+ # that uses this configured audience model must have an `audienceSize`
2433
+ # selected from this list. You can use the `ABSOLUTE` AudienceSize to
2434
+ # configure out audience sizes using the count of identifiers in the
2435
+ # output. You can use the `Percentage` AudienceSize to configure sizes
2436
+ # in the range 1-100 percent.
2437
+ # @return [Types::AudienceSizeConfig]
2438
+ #
2439
+ # @!attribute [rw] tags
2440
+ # The tags that are associated to this configured audience model.
2441
+ # @return [Hash<String,String>]
2442
+ #
2443
+ # @!attribute [rw] child_resource_tag_on_create_policy
2444
+ # Provides the `childResourceTagOnCreatePolicy` that was used for this
2445
+ # configured audience model.
2446
+ # @return [String]
2447
+ #
2448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelResponse AWS API Documentation
2449
+ #
2450
+ class GetConfiguredAudienceModelResponse < Struct.new(
2451
+ :create_time,
2452
+ :update_time,
2453
+ :configured_audience_model_arn,
2454
+ :name,
2455
+ :audience_model_arn,
2456
+ :output_config,
2457
+ :description,
2458
+ :status,
2459
+ :shared_audience_metrics,
2460
+ :min_matching_seed_size,
2461
+ :audience_size_config,
2462
+ :tags,
2463
+ :child_resource_tag_on_create_policy)
2464
+ SENSITIVE = []
2465
+ include Aws::Structure
2466
+ end
2467
+
2468
+ # @!attribute [rw] configured_model_algorithm_association_arn
2469
+ # The Amazon Resource Name (ARN) of the configured model algorithm
2470
+ # association that you want to return information about.
2471
+ # @return [String]
2472
+ #
2473
+ # @!attribute [rw] membership_identifier
2474
+ # The membership ID of the member that created the configured model
2475
+ # algorithm association.
2476
+ # @return [String]
2477
+ #
2478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredModelAlgorithmAssociationRequest AWS API Documentation
2479
+ #
2480
+ class GetConfiguredModelAlgorithmAssociationRequest < Struct.new(
2481
+ :configured_model_algorithm_association_arn,
2482
+ :membership_identifier)
2483
+ SENSITIVE = []
2484
+ include Aws::Structure
2485
+ end
2486
+
2487
+ # @!attribute [rw] create_time
2488
+ # The time at which the configured model algorithm association was
2489
+ # created.
2490
+ # @return [Time]
2491
+ #
2492
+ # @!attribute [rw] update_time
2493
+ # The most recent time at which the configured model algorithm
2494
+ # association was updated.
2495
+ # @return [Time]
2496
+ #
2497
+ # @!attribute [rw] configured_model_algorithm_association_arn
2498
+ # The Amazon Resource Name (ARN) of the configured model algorithm
2499
+ # association.
2500
+ # @return [String]
2501
+ #
2502
+ # @!attribute [rw] membership_identifier
2503
+ # The membership ID of the member that created the configured model
2504
+ # algorithm association.
2505
+ # @return [String]
2506
+ #
2507
+ # @!attribute [rw] collaboration_identifier
2508
+ # The collaboration ID of the collaboration that contains the
2509
+ # configured model algorithm association.
2510
+ # @return [String]
2511
+ #
2512
+ # @!attribute [rw] configured_model_algorithm_arn
2513
+ # The Amazon Resource Name (ARN) of the configured model algorithm
2514
+ # that was associated to the collaboration.
2515
+ # @return [String]
2516
+ #
2517
+ # @!attribute [rw] name
2518
+ # The name of the configured model algorithm association.
2519
+ # @return [String]
2520
+ #
2521
+ # @!attribute [rw] privacy_configuration
2522
+ # The privacy configuration information for the configured model
2523
+ # algorithm association.
2524
+ # @return [Types::PrivacyConfiguration]
2525
+ #
2526
+ # @!attribute [rw] description
2527
+ # The description of the configured model algorithm association.
2528
+ # @return [String]
2529
+ #
2530
+ # @!attribute [rw] tags
2531
+ # The optional metadata that you applied to the resource to help you
2532
+ # categorize and organize them. Each tag consists of a key and an
2533
+ # optional value, both of which you define.
2534
+ #
2535
+ # The following basic restrictions apply to tags:
2536
+ #
2537
+ # * Maximum number of tags per resource - 50.
2538
+ #
2539
+ # * For each resource, each tag key must be unique, and each tag key
2540
+ # can have only one value.
2541
+ #
2542
+ # * Maximum key length - 128 Unicode characters in UTF-8.
2543
+ #
2544
+ # * Maximum value length - 256 Unicode characters in UTF-8.
2545
+ #
2546
+ # * If your tagging schema is used across multiple services and
2547
+ # resources, remember that other services may have restrictions on
2548
+ # allowed characters. Generally allowed characters are: letters,
2549
+ # numbers, and spaces representable in UTF-8, and the following
2550
+ # characters: + - = . \_ : / @.
2551
+ #
2552
+ # * Tag keys and values are case sensitive.
2553
+ #
2554
+ # * Do not use aws:, AWS:, or any upper or lowercase combination of
2555
+ # such as a prefix for keys as it is reserved for AWS use. You
2556
+ # cannot edit or delete tag keys with this prefix. Values can have
2557
+ # this prefix. If a tag value has aws as its prefix but the key does
2558
+ # not, then Clean Rooms ML considers it to be a user tag and will
2559
+ # count against the limit of 50 tags. Tags with only the key prefix
2560
+ # of aws do not count against your tags per resource limit.
2561
+ # @return [Hash<String,String>]
2562
+ #
2563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredModelAlgorithmAssociationResponse AWS API Documentation
2564
+ #
2565
+ class GetConfiguredModelAlgorithmAssociationResponse < Struct.new(
2566
+ :create_time,
2567
+ :update_time,
2568
+ :configured_model_algorithm_association_arn,
2569
+ :membership_identifier,
2570
+ :collaboration_identifier,
2571
+ :configured_model_algorithm_arn,
2572
+ :name,
2573
+ :privacy_configuration,
2574
+ :description,
2575
+ :tags)
2576
+ SENSITIVE = []
2577
+ include Aws::Structure
2578
+ end
2579
+
2580
+ # @!attribute [rw] configured_model_algorithm_arn
2581
+ # The Amazon Resource Name (ARN) of the configured model algorithm
2582
+ # that you want to return information about.
2583
+ # @return [String]
2584
+ #
2585
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredModelAlgorithmRequest AWS API Documentation
2586
+ #
2587
+ class GetConfiguredModelAlgorithmRequest < Struct.new(
2588
+ :configured_model_algorithm_arn)
2589
+ SENSITIVE = []
2590
+ include Aws::Structure
2591
+ end
2592
+
2593
+ # @!attribute [rw] create_time
2594
+ # The time at which the configured model algorithm was created.
2595
+ # @return [Time]
2596
+ #
2597
+ # @!attribute [rw] update_time
2598
+ # The most recent time at which the configured model algorithm was
2599
+ # updated.
2600
+ # @return [Time]
2601
+ #
2602
+ # @!attribute [rw] configured_model_algorithm_arn
2603
+ # The Amazon Resource Name (ARN) of the configured model algorithm.
2604
+ # @return [String]
2605
+ #
2606
+ # @!attribute [rw] name
2607
+ # The name of the configured model algorithm.
2608
+ # @return [String]
2609
+ #
2610
+ # @!attribute [rw] training_container_config
2611
+ # The configuration information of the training container for the
2612
+ # configured model algorithm.
2613
+ # @return [Types::ContainerConfig]
2614
+ #
2615
+ # @!attribute [rw] inference_container_config
2616
+ # Configuration information for the inference container.
2617
+ # @return [Types::InferenceContainerConfig]
2618
+ #
2619
+ # @!attribute [rw] role_arn
2620
+ # The Amazon Resource Name (ARN) of the service role that was used to
2621
+ # create the configured model algorithm.
2622
+ # @return [String]
2623
+ #
2624
+ # @!attribute [rw] description
2625
+ # The description of the configured model algorithm.
2626
+ # @return [String]
2627
+ #
2628
+ # @!attribute [rw] tags
2629
+ # The optional metadata that you applied to the resource to help you
2630
+ # categorize and organize them. Each tag consists of a key and an
2631
+ # optional value, both of which you define.
2632
+ #
2633
+ # The following basic restrictions apply to tags:
2634
+ #
2635
+ # * Maximum number of tags per resource - 50.
2636
+ #
2637
+ # * For each resource, each tag key must be unique, and each tag key
2638
+ # can have only one value.
2639
+ #
2640
+ # * Maximum key length - 128 Unicode characters in UTF-8.
2641
+ #
2642
+ # * Maximum value length - 256 Unicode characters in UTF-8.
2643
+ #
2644
+ # * If your tagging schema is used across multiple services and
2645
+ # resources, remember that other services may have restrictions on
2646
+ # allowed characters. Generally allowed characters are: letters,
2647
+ # numbers, and spaces representable in UTF-8, and the following
2648
+ # characters: + - = . \_ : / @.
2649
+ #
2650
+ # * Tag keys and values are case sensitive.
2651
+ #
2652
+ # * Do not use aws:, AWS:, or any upper or lowercase combination of
2653
+ # such as a prefix for keys as it is reserved for AWS use. You
2654
+ # cannot edit or delete tag keys with this prefix. Values can have
2655
+ # this prefix. If a tag value has aws as its prefix but the key does
2656
+ # not, then Clean Rooms ML considers it to be a user tag and will
2657
+ # count against the limit of 50 tags. Tags with only the key prefix
2658
+ # of aws do not count against your tags per resource limit.
2659
+ # @return [Hash<String,String>]
2660
+ #
2661
+ # @!attribute [rw] kms_key_arn
2662
+ # The Amazon Resource Name (ARN) of the KMS key. This key is used to
2663
+ # encrypt and decrypt customer-owned data in the configured ML model
2664
+ # and associated data.
2665
+ # @return [String]
2666
+ #
2667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredModelAlgorithmResponse AWS API Documentation
2668
+ #
2669
+ class GetConfiguredModelAlgorithmResponse < Struct.new(
2670
+ :create_time,
2671
+ :update_time,
2672
+ :configured_model_algorithm_arn,
2673
+ :name,
2674
+ :training_container_config,
2675
+ :inference_container_config,
2676
+ :role_arn,
2677
+ :description,
2678
+ :tags,
2679
+ :kms_key_arn)
2680
+ SENSITIVE = []
2681
+ include Aws::Structure
2682
+ end
2683
+
2684
+ # @!attribute [rw] membership_identifier
2685
+ # The membership ID of the member that owns the ML configuration you
2686
+ # want to return information about.
2687
+ # @return [String]
2688
+ #
2689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetMLConfigurationRequest AWS API Documentation
2690
+ #
2691
+ class GetMLConfigurationRequest < Struct.new(
2692
+ :membership_identifier)
2693
+ SENSITIVE = []
2694
+ include Aws::Structure
2695
+ end
2696
+
2697
+ # @!attribute [rw] membership_identifier
2698
+ # The membership ID of the member that owns the ML configuration you
2699
+ # requested.
2700
+ # @return [String]
2701
+ #
2702
+ # @!attribute [rw] default_output_location
2703
+ # The Amazon S3 location where ML model output is stored.
2704
+ # @return [Types::MLOutputConfiguration]
2705
+ #
2706
+ # @!attribute [rw] create_time
2707
+ # The time at which the ML configuration was created.
2708
+ # @return [Time]
2709
+ #
2710
+ # @!attribute [rw] update_time
2711
+ # The most recent time at which the ML configuration was updated.
2712
+ # @return [Time]
2713
+ #
2714
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetMLConfigurationResponse AWS API Documentation
2715
+ #
2716
+ class GetMLConfigurationResponse < Struct.new(
2717
+ :membership_identifier,
2718
+ :default_output_location,
2719
+ :create_time,
2720
+ :update_time)
2721
+ SENSITIVE = []
2722
+ include Aws::Structure
2723
+ end
2724
+
2725
+ # @!attribute [rw] ml_input_channel_arn
2726
+ # The Amazon Resource Name (ARN) of the ML input channel that you want
2727
+ # to get.
2728
+ # @return [String]
2729
+ #
2730
+ # @!attribute [rw] membership_identifier
2731
+ # The membership ID of the membership that contains the ML input
2732
+ # channel that you want to get.
2733
+ # @return [String]
2734
+ #
2735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetMLInputChannelRequest AWS API Documentation
2736
+ #
2737
+ class GetMLInputChannelRequest < Struct.new(
2738
+ :ml_input_channel_arn,
2739
+ :membership_identifier)
2740
+ SENSITIVE = []
2741
+ include Aws::Structure
2742
+ end
2743
+
2744
+ # @!attribute [rw] create_time
2745
+ # The time at which the ML input channel was created.
2746
+ # @return [Time]
2747
+ #
2748
+ # @!attribute [rw] update_time
2749
+ # The most recent time at which the ML input channel was updated.
2750
+ # @return [Time]
2751
+ #
2752
+ # @!attribute [rw] membership_identifier
2753
+ # The membership ID of the membership that contains the ML input
2754
+ # channel.
2755
+ # @return [String]
2756
+ #
2757
+ # @!attribute [rw] collaboration_identifier
2758
+ # The collaboration ID of the collaboration that contains the ML input
2759
+ # channel.
2760
+ # @return [String]
2761
+ #
2762
+ # @!attribute [rw] input_channel
2763
+ # The input channel that was used to create the ML input channel.
2764
+ # @return [Types::InputChannel]
2765
+ #
2766
+ # @!attribute [rw] protected_query_identifier
2767
+ # The ID of the protected query that was used to create the ML input
2768
+ # channel.
2769
+ # @return [String]
2770
+ #
2771
+ # @!attribute [rw] ml_input_channel_arn
2772
+ # The Amazon Resource Name (ARN) of the ML input channel.
2773
+ # @return [String]
2774
+ #
2775
+ # @!attribute [rw] name
2776
+ # The name of the ML input channel.
2777
+ # @return [String]
2778
+ #
2779
+ # @!attribute [rw] configured_model_algorithm_associations
2780
+ # The configured model algorithm associations that were used to create
2781
+ # the ML input channel.
2782
+ # @return [Array<String>]
2783
+ #
2784
+ # @!attribute [rw] status
2785
+ # The status of the ML input channel.
2786
+ # @return [String]
2787
+ #
2788
+ # @!attribute [rw] status_details
2789
+ # Details about the status of a resource.
2790
+ # @return [Types::StatusDetails]
2791
+ #
2792
+ # @!attribute [rw] retention_in_days
2793
+ # The number of days to keep the data in the ML input channel.
2794
+ # @return [Integer]
2795
+ #
2796
+ # @!attribute [rw] number_of_records
2797
+ # The number of records in the ML input channel.
2798
+ # @return [Integer]
2799
+ #
2800
+ # @!attribute [rw] number_of_files
2801
+ # The number of files in the ML input channel.
2802
+ # @return [Float]
2803
+ #
2804
+ # @!attribute [rw] size_in_gb
2805
+ # The size, in GB, of the ML input channel.
2806
+ # @return [Float]
2807
+ #
2808
+ # @!attribute [rw] description
2809
+ # The description of the ML input channel.
2810
+ # @return [String]
2811
+ #
2812
+ # @!attribute [rw] kms_key_arn
2813
+ # The Amazon Resource Name (ARN) of the KMS key that was used to
2814
+ # create the ML input channel.
2815
+ # @return [String]
2816
+ #
2817
+ # @!attribute [rw] tags
2818
+ # The optional metadata that you applied to the resource to help you
2819
+ # categorize and organize them. Each tag consists of a key and an
2820
+ # optional value, both of which you define.
2821
+ #
2822
+ # The following basic restrictions apply to tags:
2823
+ #
2824
+ # * Maximum number of tags per resource - 50.
2825
+ #
2826
+ # * For each resource, each tag key must be unique, and each tag key
2827
+ # can have only one value.
2828
+ #
2829
+ # * Maximum key length - 128 Unicode characters in UTF-8.
2830
+ #
2831
+ # * Maximum value length - 256 Unicode characters in UTF-8.
2832
+ #
2833
+ # * If your tagging schema is used across multiple services and
2834
+ # resources, remember that other services may have restrictions on
2835
+ # allowed characters. Generally allowed characters are: letters,
2836
+ # numbers, and spaces representable in UTF-8, and the following
2837
+ # characters: + - = . \_ : / @.
2838
+ #
2839
+ # * Tag keys and values are case sensitive.
2840
+ #
2841
+ # * Do not use aws:, AWS:, or any upper or lowercase combination of
2842
+ # such as a prefix for keys as it is reserved for AWS use. You
2843
+ # cannot edit or delete tag keys with this prefix. Values can have
2844
+ # this prefix. If a tag value has aws as its prefix but the key does
2845
+ # not, then Clean Rooms ML considers it to be a user tag and will
2846
+ # count against the limit of 50 tags. Tags with only the key prefix
2847
+ # of aws do not count against your tags per resource limit.
2848
+ # @return [Hash<String,String>]
2849
+ #
2850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetMLInputChannelResponse AWS API Documentation
2851
+ #
2852
+ class GetMLInputChannelResponse < Struct.new(
2853
+ :create_time,
2854
+ :update_time,
2855
+ :membership_identifier,
2856
+ :collaboration_identifier,
2857
+ :input_channel,
2858
+ :protected_query_identifier,
2859
+ :ml_input_channel_arn,
2860
+ :name,
2861
+ :configured_model_algorithm_associations,
2862
+ :status,
2863
+ :status_details,
2864
+ :retention_in_days,
2865
+ :number_of_records,
2866
+ :number_of_files,
2867
+ :size_in_gb,
2868
+ :description,
2869
+ :kms_key_arn,
2870
+ :tags)
2871
+ SENSITIVE = []
2872
+ include Aws::Structure
2873
+ end
2874
+
2875
+ # @!attribute [rw] membership_identifier
2876
+ # Provides the membership ID of the membership that contains the
2877
+ # trained model inference job that you are interested in.
2878
+ # @return [String]
2879
+ #
2880
+ # @!attribute [rw] trained_model_inference_job_arn
2881
+ # Provides the Amazon Resource Name (ARN) of the trained model
2882
+ # inference job that you are interested in.
2883
+ # @return [String]
2884
+ #
2885
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainedModelInferenceJobRequest AWS API Documentation
2886
+ #
2887
+ class GetTrainedModelInferenceJobRequest < Struct.new(
2888
+ :membership_identifier,
2889
+ :trained_model_inference_job_arn)
2890
+ SENSITIVE = []
2891
+ include Aws::Structure
2892
+ end
2893
+
2894
+ # @!attribute [rw] create_time
2895
+ # The time at which the trained model inference job was created.
2896
+ # @return [Time]
2897
+ #
2898
+ # @!attribute [rw] update_time
2899
+ # The most recent time at which the trained model inference job was
2900
+ # updated.
2901
+ # @return [Time]
2902
+ #
2903
+ # @!attribute [rw] trained_model_inference_job_arn
2904
+ # The Amazon Resource Name (ARN) of the trained model inference job.
2905
+ # @return [String]
2906
+ #
2907
+ # @!attribute [rw] configured_model_algorithm_association_arn
2908
+ # The Amazon Resource Name (ARN) of the configured model algorithm
2909
+ # association that was used for the trained model inference job.
2910
+ # @return [String]
2911
+ #
2912
+ # @!attribute [rw] name
2913
+ # The name of the trained model inference job.
2914
+ # @return [String]
2915
+ #
2916
+ # @!attribute [rw] status
2917
+ # The status of the trained model inference job.
2918
+ # @return [String]
2919
+ #
2920
+ # @!attribute [rw] trained_model_arn
2921
+ # The Amazon Resource Name (ARN) for the trained model that was used
2922
+ # for the trained model inference job.
2923
+ # @return [String]
2924
+ #
2925
+ # @!attribute [rw] resource_config
2926
+ # The resource configuration information for the trained model
2927
+ # inference job.
2928
+ # @return [Types::InferenceResourceConfig]
2929
+ #
2930
+ # @!attribute [rw] output_configuration
2931
+ # The output configuration information for the trained model inference
2932
+ # job.
2933
+ # @return [Types::InferenceOutputConfiguration]
2934
+ #
2935
+ # @!attribute [rw] membership_identifier
2936
+ # The membership ID of the membership that contains the trained model
2937
+ # inference job.
2938
+ # @return [String]
2939
+ #
2940
+ # @!attribute [rw] data_source
2941
+ # The data source that was used for the trained model inference job.
2942
+ # @return [Types::ModelInferenceDataSource]
2943
+ #
2944
+ # @!attribute [rw] container_execution_parameters
2945
+ # The execution parameters for the model inference job container.
2946
+ # @return [Types::InferenceContainerExecutionParameters]
2947
+ #
2948
+ # @!attribute [rw] status_details
2949
+ # Details about the status of a resource.
2950
+ # @return [Types::StatusDetails]
2951
+ #
2952
+ # @!attribute [rw] description
2953
+ # The description of the trained model inference job.
2954
+ # @return [String]
2955
+ #
2956
+ # @!attribute [rw] inference_container_image_digest
2957
+ # Information about the training container image.
2958
+ # @return [String]
2959
+ #
2960
+ # @!attribute [rw] environment
2961
+ # The environment variables to set in the Docker container.
2962
+ # @return [Hash<String,String>]
2963
+ #
2964
+ # @!attribute [rw] kms_key_arn
2965
+ # The Amazon Resource Name (ARN) of the KMS key. This key is used to
2966
+ # encrypt and decrypt customer-owned data in the ML inference job and
2967
+ # associated data.
2968
+ # @return [String]
2969
+ #
2970
+ # @!attribute [rw] metrics_status
2971
+ # The metrics status for the trained model inference job.
2972
+ # @return [String]
2973
+ #
2974
+ # @!attribute [rw] metrics_status_details
2975
+ # Details about the metrics status for the trained model inference
2976
+ # job.
2977
+ # @return [String]
2978
+ #
2979
+ # @!attribute [rw] logs_status
2980
+ # The logs status for the trained model inference job.
2981
+ # @return [String]
2982
+ #
2983
+ # @!attribute [rw] logs_status_details
2984
+ # Details about the logs status for the trained model inference job.
2985
+ # @return [String]
2986
+ #
2987
+ # @!attribute [rw] tags
2988
+ # The optional metadata that you applied to the resource to help you
2989
+ # categorize and organize them. Each tag consists of a key and an
2990
+ # optional value, both of which you define.
2991
+ #
2992
+ # The following basic restrictions apply to tags:
2993
+ #
2994
+ # * Maximum number of tags per resource - 50.
2995
+ #
2996
+ # * For each resource, each tag key must be unique, and each tag key
2997
+ # can have only one value.
2998
+ #
2999
+ # * Maximum key length - 128 Unicode characters in UTF-8.
3000
+ #
3001
+ # * Maximum value length - 256 Unicode characters in UTF-8.
3002
+ #
3003
+ # * If your tagging schema is used across multiple services and
3004
+ # resources, remember that other services may have restrictions on
3005
+ # allowed characters. Generally allowed characters are: letters,
3006
+ # numbers, and spaces representable in UTF-8, and the following
3007
+ # characters: + - = . \_ : / @.
3008
+ #
3009
+ # * Tag keys and values are case sensitive.
3010
+ #
3011
+ # * Do not use aws:, AWS:, or any upper or lowercase combination of
3012
+ # such as a prefix for keys as it is reserved for AWS use. You
3013
+ # cannot edit or delete tag keys with this prefix. Values can have
3014
+ # this prefix. If a tag value has aws as its prefix but the key does
3015
+ # not, then Clean Rooms ML considers it to be a user tag and will
3016
+ # count against the limit of 50 tags. Tags with only the key prefix
3017
+ # of aws do not count against your tags per resource limit.
3018
+ # @return [Hash<String,String>]
3019
+ #
3020
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainedModelInferenceJobResponse AWS API Documentation
3021
+ #
3022
+ class GetTrainedModelInferenceJobResponse < Struct.new(
3023
+ :create_time,
3024
+ :update_time,
3025
+ :trained_model_inference_job_arn,
3026
+ :configured_model_algorithm_association_arn,
3027
+ :name,
3028
+ :status,
3029
+ :trained_model_arn,
3030
+ :resource_config,
3031
+ :output_configuration,
3032
+ :membership_identifier,
3033
+ :data_source,
3034
+ :container_execution_parameters,
3035
+ :status_details,
3036
+ :description,
3037
+ :inference_container_image_digest,
3038
+ :environment,
3039
+ :kms_key_arn,
3040
+ :metrics_status,
3041
+ :metrics_status_details,
3042
+ :logs_status,
3043
+ :logs_status_details,
3044
+ :tags)
3045
+ SENSITIVE = []
3046
+ include Aws::Structure
3047
+ end
3048
+
3049
+ # @!attribute [rw] trained_model_arn
3050
+ # The Amazon Resource Name (ARN) of the trained model that you are
3051
+ # interested in.
3052
+ # @return [String]
3053
+ #
3054
+ # @!attribute [rw] membership_identifier
3055
+ # The membership ID of the member that created the trained model that
3056
+ # you are interested in.
3057
+ # @return [String]
3058
+ #
3059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainedModelRequest AWS API Documentation
3060
+ #
3061
+ class GetTrainedModelRequest < Struct.new(
3062
+ :trained_model_arn,
3063
+ :membership_identifier)
3064
+ SENSITIVE = []
3065
+ include Aws::Structure
3066
+ end
3067
+
3068
+ # @!attribute [rw] membership_identifier
3069
+ # The membership ID of the member that created the trained model.
3070
+ # @return [String]
3071
+ #
3072
+ # @!attribute [rw] collaboration_identifier
3073
+ # The collaboration ID of the collaboration that contains the trained
3074
+ # model.
3075
+ # @return [String]
3076
+ #
3077
+ # @!attribute [rw] trained_model_arn
3078
+ # The Amazon Resource Name (ARN) of the trained model.
3079
+ # @return [String]
3080
+ #
3081
+ # @!attribute [rw] name
3082
+ # The name of the trained model.
3083
+ # @return [String]
3084
+ #
3085
+ # @!attribute [rw] description
3086
+ # The description of the trained model.
3087
+ # @return [String]
3088
+ #
3089
+ # @!attribute [rw] status
3090
+ # The status of the trained model.
3091
+ # @return [String]
3092
+ #
3093
+ # @!attribute [rw] status_details
3094
+ # Details about the status of a resource.
3095
+ # @return [Types::StatusDetails]
3096
+ #
3097
+ # @!attribute [rw] configured_model_algorithm_association_arn
3098
+ # The Amazon Resource Name (ARN) of the configured model algorithm
3099
+ # association that was used to create the trained model.
3100
+ # @return [String]
3101
+ #
3102
+ # @!attribute [rw] resource_config
3103
+ # The EC2 resource configuration that was used to create the trained
3104
+ # model.
3105
+ # @return [Types::ResourceConfig]
3106
+ #
3107
+ # @!attribute [rw] stopping_condition
3108
+ # The stopping condition that was used to terminate model training.
3109
+ # @return [Types::StoppingCondition]
3110
+ #
3111
+ # @!attribute [rw] metrics_status
3112
+ # The status of the model metrics.
3113
+ # @return [String]
3114
+ #
3115
+ # @!attribute [rw] metrics_status_details
3116
+ # Details about the metrics status for the trained model.
3117
+ # @return [String]
3118
+ #
3119
+ # @!attribute [rw] logs_status
3120
+ # The logs status for the trained model.
3121
+ # @return [String]
3122
+ #
3123
+ # @!attribute [rw] logs_status_details
3124
+ # Details about the logs status for the trained model.
3125
+ # @return [String]
3126
+ #
3127
+ # @!attribute [rw] training_container_image_digest
3128
+ # Information about the training image container.
3129
+ # @return [String]
3130
+ #
3131
+ # @!attribute [rw] create_time
3132
+ # The time at which the trained model was created.
3133
+ # @return [Time]
3134
+ #
3135
+ # @!attribute [rw] update_time
3136
+ # The most recent time at which the trained model was updated.
3137
+ # @return [Time]
3138
+ #
3139
+ # @!attribute [rw] hyperparameters
3140
+ # The hyperparameters that were used to create the trained model.
3141
+ # @return [Hash<String,String>]
3142
+ #
3143
+ # @!attribute [rw] environment
3144
+ # The EC2 environment that was used to create the trained model.
3145
+ # @return [Hash<String,String>]
3146
+ #
3147
+ # @!attribute [rw] kms_key_arn
3148
+ # The Amazon Resource Name (ARN) of the KMS key. This key is used to
3149
+ # encrypt and decrypt customer-owned data in the trained ML model and
3150
+ # associated data.
3151
+ # @return [String]
3152
+ #
3153
+ # @!attribute [rw] tags
3154
+ # The optional metadata that you applied to the resource to help you
3155
+ # categorize and organize them. Each tag consists of a key and an
3156
+ # optional value, both of which you define.
3157
+ #
3158
+ # The following basic restrictions apply to tags:
3159
+ #
3160
+ # * Maximum number of tags per resource - 50.
3161
+ #
3162
+ # * For each resource, each tag key must be unique, and each tag key
3163
+ # can have only one value.
3164
+ #
3165
+ # * Maximum key length - 128 Unicode characters in UTF-8.
3166
+ #
3167
+ # * Maximum value length - 256 Unicode characters in UTF-8.
3168
+ #
3169
+ # * If your tagging schema is used across multiple services and
3170
+ # resources, remember that other services may have restrictions on
3171
+ # allowed characters. Generally allowed characters are: letters,
3172
+ # numbers, and spaces representable in UTF-8, and the following
3173
+ # characters: + - = . \_ : / @.
3174
+ #
3175
+ # * Tag keys and values are case sensitive.
3176
+ #
3177
+ # * Do not use aws:, AWS:, or any upper or lowercase combination of
3178
+ # such as a prefix for keys as it is reserved for AWS use. You
3179
+ # cannot edit or delete tag keys with this prefix. Values can have
3180
+ # this prefix. If a tag value has aws as its prefix but the key does
3181
+ # not, then Clean Rooms ML considers it to be a user tag and will
3182
+ # count against the limit of 50 tags. Tags with only the key prefix
3183
+ # of aws do not count against your tags per resource limit.
3184
+ # @return [Hash<String,String>]
3185
+ #
3186
+ # @!attribute [rw] data_channels
3187
+ # The data channels that were used for the trained model.
3188
+ # @return [Array<Types::ModelTrainingDataChannel>]
3189
+ #
3190
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainedModelResponse AWS API Documentation
3191
+ #
3192
+ class GetTrainedModelResponse < Struct.new(
3193
+ :membership_identifier,
3194
+ :collaboration_identifier,
3195
+ :trained_model_arn,
3196
+ :name,
3197
+ :description,
3198
+ :status,
3199
+ :status_details,
3200
+ :configured_model_algorithm_association_arn,
3201
+ :resource_config,
3202
+ :stopping_condition,
3203
+ :metrics_status,
3204
+ :metrics_status_details,
3205
+ :logs_status,
3206
+ :logs_status_details,
3207
+ :training_container_image_digest,
3208
+ :create_time,
3209
+ :update_time,
3210
+ :hyperparameters,
3211
+ :environment,
3212
+ :kms_key_arn,
3213
+ :tags,
3214
+ :data_channels)
3215
+ SENSITIVE = []
3216
+ include Aws::Structure
3217
+ end
3218
+
3219
+ # @!attribute [rw] training_dataset_arn
3220
+ # The Amazon Resource Name (ARN) of the training dataset that you are
3221
+ # interested in.
3222
+ # @return [String]
3223
+ #
3224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDatasetRequest AWS API Documentation
3225
+ #
3226
+ class GetTrainingDatasetRequest < Struct.new(
3227
+ :training_dataset_arn)
3228
+ SENSITIVE = []
3229
+ include Aws::Structure
3230
+ end
3231
+
3232
+ # @!attribute [rw] create_time
3233
+ # The time at which the training dataset was created.
3234
+ # @return [Time]
3235
+ #
3236
+ # @!attribute [rw] update_time
3237
+ # The most recent time at which the training dataset was updated.
3238
+ # @return [Time]
3239
+ #
3240
+ # @!attribute [rw] training_dataset_arn
3241
+ # The Amazon Resource Name (ARN) of the training dataset.
3242
+ # @return [String]
3243
+ #
3244
+ # @!attribute [rw] name
3245
+ # The name of the training dataset.
3246
+ # @return [String]
3247
+ #
3248
+ # @!attribute [rw] training_data
3249
+ # Metadata about the requested training data.
3250
+ # @return [Array<Types::Dataset>]
3251
+ #
3252
+ # @!attribute [rw] status
3253
+ # The status of the training dataset.
3254
+ # @return [String]
3255
+ #
3256
+ # @!attribute [rw] role_arn
3257
+ # The IAM role used to read the training data.
3258
+ # @return [String]
3259
+ #
3260
+ # @!attribute [rw] tags
3261
+ # The tags that are assigned to this training dataset.
3262
+ # @return [Hash<String,String>]
3263
+ #
3264
+ # @!attribute [rw] description
3265
+ # The description of the training dataset.
3266
+ # @return [String]
3267
+ #
3268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDatasetResponse AWS API Documentation
3269
+ #
3270
+ class GetTrainingDatasetResponse < Struct.new(
3271
+ :create_time,
3272
+ :update_time,
3273
+ :training_dataset_arn,
3274
+ :name,
3275
+ :training_data,
3276
+ :status,
3277
+ :role_arn,
3278
+ :tags,
3279
+ :description)
3280
+ SENSITIVE = []
3281
+ include Aws::Structure
3282
+ end
3283
+
3284
+ # Defines the Glue data source that contains the training data.
3285
+ #
3286
+ # @!attribute [rw] table_name
3287
+ # The Glue table that contains the training data.
3288
+ # @return [String]
3289
+ #
3290
+ # @!attribute [rw] database_name
3291
+ # The Glue database that contains the training data.
3292
+ # @return [String]
3293
+ #
3294
+ # @!attribute [rw] catalog_id
3295
+ # The Glue catalog that contains the training data.
3296
+ # @return [String]
3297
+ #
3298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GlueDataSource AWS API Documentation
3299
+ #
3300
+ class GlueDataSource < Struct.new(
3301
+ :table_name,
3302
+ :database_name,
3303
+ :catalog_id)
3304
+ SENSITIVE = []
3305
+ include Aws::Structure
3306
+ end
3307
+
3308
+ # Provides configuration information for the inference container.
3309
+ #
3310
+ # @!attribute [rw] image_uri
3311
+ # The registry path of the docker image that contains the inference
3312
+ # algorithm. Clean Rooms ML supports both `registry/repository[:tag]`
3313
+ # and `registry/repositry[@digest]` image path formats. For more
3314
+ # information about using images in Clean Rooms ML, see the [Sagemaker
3315
+ # API reference][1].
3316
+ #
3317
+ #
3318
+ #
3319
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html#sagemaker-Type-AlgorithmSpecification-TrainingImage
3320
+ # @return [String]
3321
+ #
3322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/InferenceContainerConfig AWS API Documentation
3323
+ #
3324
+ class InferenceContainerConfig < Struct.new(
3325
+ :image_uri)
3326
+ SENSITIVE = []
3327
+ include Aws::Structure
3328
+ end
3329
+
3330
+ # Provides execution parameters for the inference container.
3331
+ #
3332
+ # @!attribute [rw] max_payload_in_mb
3333
+ # The maximum size of the inference container payload, specified in
3334
+ # MB.
3335
+ # @return [Integer]
3336
+ #
3337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/InferenceContainerExecutionParameters AWS API Documentation
3338
+ #
3339
+ class InferenceContainerExecutionParameters < Struct.new(
3340
+ :max_payload_in_mb)
3341
+ SENSITIVE = []
3342
+ include Aws::Structure
3343
+ end
807
3344
 
808
- # @!attribute [rw] training_dataset_arn
809
- # The Amazon Resource Name (ARN) of the training dataset that you want
810
- # to delete.
3345
+ # Configuration information about how the inference output is stored.
3346
+ #
3347
+ # @!attribute [rw] accept
3348
+ # The MIME type used to specify the output data.
811
3349
  # @return [String]
812
3350
  #
813
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteTrainingDatasetRequest AWS API Documentation
3351
+ # @!attribute [rw] members
3352
+ # Defines the members that can receive inference output.
3353
+ # @return [Array<Types::InferenceReceiverMember>]
814
3354
  #
815
- class DeleteTrainingDatasetRequest < Struct.new(
816
- :training_dataset_arn)
3355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/InferenceOutputConfiguration AWS API Documentation
3356
+ #
3357
+ class InferenceOutputConfiguration < Struct.new(
3358
+ :accept,
3359
+ :members)
817
3360
  SENSITIVE = []
818
3361
  include Aws::Structure
819
3362
  end
820
3363
 
821
- # @!attribute [rw] audience_generation_job_arn
822
- # The Amazon Resource Name (ARN) of the audience generation job that
823
- # you are interested in.
3364
+ # Defines who will receive inference results.
3365
+ #
3366
+ # @!attribute [rw] account_id
3367
+ # The account ID of the member that can receive inference results.
824
3368
  # @return [String]
825
3369
  #
826
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJobRequest AWS API Documentation
3370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/InferenceReceiverMember AWS API Documentation
827
3371
  #
828
- class GetAudienceGenerationJobRequest < Struct.new(
829
- :audience_generation_job_arn)
3372
+ class InferenceReceiverMember < Struct.new(
3373
+ :account_id)
830
3374
  SENSITIVE = []
831
3375
  include Aws::Structure
832
3376
  end
833
3377
 
834
- # @!attribute [rw] create_time
835
- # The time at which the audience generation job was created.
836
- # @return [Time]
837
- #
838
- # @!attribute [rw] update_time
839
- # The most recent time at which the audience generation job was
840
- # updated.
841
- # @return [Time]
3378
+ # Defines the resources used to perform model inference.
842
3379
  #
843
- # @!attribute [rw] audience_generation_job_arn
844
- # The Amazon Resource Name (ARN) of the audience generation job.
3380
+ # @!attribute [rw] instance_type
3381
+ # The type of instance that is used to perform model inference.
845
3382
  # @return [String]
846
3383
  #
847
- # @!attribute [rw] name
848
- # The name of the audience generation job.
3384
+ # @!attribute [rw] instance_count
3385
+ # The number of instances to use.
3386
+ # @return [Integer]
3387
+ #
3388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/InferenceResourceConfig AWS API Documentation
3389
+ #
3390
+ class InferenceResourceConfig < Struct.new(
3391
+ :instance_type,
3392
+ :instance_count)
3393
+ SENSITIVE = []
3394
+ include Aws::Structure
3395
+ end
3396
+
3397
+ # Provides information about the data source that is used to create an
3398
+ # ML input channel.
3399
+ #
3400
+ # @!attribute [rw] data_source
3401
+ # The data source that is used to create the ML input channel.
3402
+ # @return [Types::InputChannelDataSource]
3403
+ #
3404
+ # @!attribute [rw] role_arn
3405
+ # The ARN of the IAM role that Clean Rooms ML can assume to read the
3406
+ # data referred to in the `dataSource` field the input channel.
3407
+ #
3408
+ # Passing a role across AWS accounts is not allowed. If you pass a
3409
+ # role that isn't in your account, you get an `AccessDeniedException`
3410
+ # error.
849
3411
  # @return [String]
850
3412
  #
851
- # @!attribute [rw] description
852
- # The description of the audience generation job.
3413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/InputChannel AWS API Documentation
3414
+ #
3415
+ class InputChannel < Struct.new(
3416
+ :data_source,
3417
+ :role_arn)
3418
+ SENSITIVE = []
3419
+ include Aws::Structure
3420
+ end
3421
+
3422
+ # Provides the data source that is used to define an input channel.
3423
+ #
3424
+ # @note InputChannelDataSource is a union - when making an API calls you must set exactly one of the members.
3425
+ #
3426
+ # @note InputChannelDataSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of InputChannelDataSource corresponding to the set member.
3427
+ #
3428
+ # @!attribute [rw] protected_query_input_parameters
3429
+ # Provides information necessary to perform the protected query.
3430
+ # @return [Types::ProtectedQueryInputParameters]
3431
+ #
3432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/InputChannelDataSource AWS API Documentation
3433
+ #
3434
+ class InputChannelDataSource < Struct.new(
3435
+ :protected_query_input_parameters,
3436
+ :unknown)
3437
+ SENSITIVE = []
3438
+ include Aws::Structure
3439
+ include Aws::Structure::Union
3440
+
3441
+ class ProtectedQueryInputParameters < InputChannelDataSource; end
3442
+ class Unknown < InputChannelDataSource; end
3443
+ end
3444
+
3445
+ # @!attribute [rw] next_token
3446
+ # The token value retrieved from a previous call to access the next
3447
+ # page of results.
853
3448
  # @return [String]
854
3449
  #
855
- # @!attribute [rw] status
856
- # The status of the audience generation job.
3450
+ # @!attribute [rw] max_results
3451
+ # The maximum size of the results that is returned per call.
3452
+ # @return [Integer]
3453
+ #
3454
+ # @!attribute [rw] audience_generation_job_arn
3455
+ # The Amazon Resource Name (ARN) of the audience generation job that
3456
+ # you are interested in.
857
3457
  # @return [String]
858
3458
  #
859
- # @!attribute [rw] status_details
860
- # Details about the status of the audience generation job.
861
- # @return [Types::StatusDetails]
3459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobsRequest AWS API Documentation
862
3460
  #
863
- # @!attribute [rw] configured_audience_model_arn
864
- # The Amazon Resource Name (ARN) of the configured audience model used
865
- # for this audience generation job.
3461
+ class ListAudienceExportJobsRequest < Struct.new(
3462
+ :next_token,
3463
+ :max_results,
3464
+ :audience_generation_job_arn)
3465
+ SENSITIVE = []
3466
+ include Aws::Structure
3467
+ end
3468
+
3469
+ # @!attribute [rw] next_token
3470
+ # The token value used to access the next page of results.
866
3471
  # @return [String]
867
3472
  #
868
- # @!attribute [rw] seed_audience
869
- # The seed audience that was used for this audience generation job.
870
- # This field will be null if the account calling the API is the
871
- # account that started this audience generation job.
872
- # @return [Types::AudienceGenerationJobDataSource]
3473
+ # @!attribute [rw] audience_export_jobs
3474
+ # The audience export jobs that match the request.
3475
+ # @return [Array<Types::AudienceExportJobSummary>]
873
3476
  #
874
- # @!attribute [rw] include_seed_in_output
875
- # Configure whether the seed users are included in the output
876
- # audience. By default, Clean Rooms ML removes seed users from the
877
- # output audience. If you specify `TRUE`, the seed users will appear
878
- # first in the output. Clean Rooms ML does not explicitly reveal
879
- # whether a user was in the seed, but the recipient of the audience
880
- # will know that the first `minimumSeedSize` count of users are from
881
- # the seed.
882
- # @return [Boolean]
3477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobsResponse AWS API Documentation
883
3478
  #
884
- # @!attribute [rw] collaboration_id
885
- # The identifier of the collaboration that this audience generation
886
- # job is associated with.
3479
+ class ListAudienceExportJobsResponse < Struct.new(
3480
+ :next_token,
3481
+ :audience_export_jobs)
3482
+ SENSITIVE = []
3483
+ include Aws::Structure
3484
+ end
3485
+
3486
+ # @!attribute [rw] next_token
3487
+ # The token value retrieved from a previous call to access the next
3488
+ # page of results.
887
3489
  # @return [String]
888
3490
  #
889
- # @!attribute [rw] metrics
890
- # The relevance scores for different audience sizes and the recall
891
- # score of the generated audience.
892
- # @return [Types::AudienceQualityMetrics]
3491
+ # @!attribute [rw] max_results
3492
+ # The maximum size of the results that is returned per call.
3493
+ # @return [Integer]
893
3494
  #
894
- # @!attribute [rw] started_by
895
- # The AWS account that started this audience generation job.
3495
+ # @!attribute [rw] configured_audience_model_arn
3496
+ # The Amazon Resource Name (ARN) of the configured audience model that
3497
+ # was used for the audience generation jobs that you are interested
3498
+ # in.
896
3499
  # @return [String]
897
3500
  #
898
- # @!attribute [rw] tags
899
- # The tags that are associated to this audience generation job.
900
- # @return [Hash<String,String>]
901
- #
902
- # @!attribute [rw] protected_query_identifier
903
- # The unique identifier of the protected query for this audience
904
- # generation job.
3501
+ # @!attribute [rw] collaboration_id
3502
+ # The identifier of the collaboration that contains the audience
3503
+ # generation jobs that you are interested in.
905
3504
  # @return [String]
906
3505
  #
907
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJobResponse AWS API Documentation
3506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobsRequest AWS API Documentation
908
3507
  #
909
- class GetAudienceGenerationJobResponse < Struct.new(
910
- :create_time,
911
- :update_time,
912
- :audience_generation_job_arn,
913
- :name,
914
- :description,
915
- :status,
916
- :status_details,
3508
+ class ListAudienceGenerationJobsRequest < Struct.new(
3509
+ :next_token,
3510
+ :max_results,
917
3511
  :configured_audience_model_arn,
918
- :seed_audience,
919
- :include_seed_in_output,
920
- :collaboration_id,
921
- :metrics,
922
- :started_by,
923
- :tags,
924
- :protected_query_identifier)
3512
+ :collaboration_id)
925
3513
  SENSITIVE = []
926
3514
  include Aws::Structure
927
3515
  end
928
3516
 
929
- # @!attribute [rw] audience_model_arn
930
- # The Amazon Resource Name (ARN) of the audience model that you are
931
- # interested in.
3517
+ # @!attribute [rw] next_token
3518
+ # The token value used to access the next page of results.
932
3519
  # @return [String]
933
3520
  #
934
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModelRequest AWS API Documentation
3521
+ # @!attribute [rw] audience_generation_jobs
3522
+ # The audience generation jobs that match the request.
3523
+ # @return [Array<Types::AudienceGenerationJobSummary>]
935
3524
  #
936
- class GetAudienceModelRequest < Struct.new(
937
- :audience_model_arn)
3525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobsResponse AWS API Documentation
3526
+ #
3527
+ class ListAudienceGenerationJobsResponse < Struct.new(
3528
+ :next_token,
3529
+ :audience_generation_jobs)
938
3530
  SENSITIVE = []
939
3531
  include Aws::Structure
940
3532
  end
941
3533
 
942
- # @!attribute [rw] create_time
943
- # The time at which the audience model was created.
944
- # @return [Time]
945
- #
946
- # @!attribute [rw] update_time
947
- # The most recent time at which the audience model was updated.
948
- # @return [Time]
3534
+ # @!attribute [rw] next_token
3535
+ # The token value retrieved from a previous call to access the next
3536
+ # page of results.
3537
+ # @return [String]
949
3538
  #
950
- # @!attribute [rw] training_data_start_time
951
- # The start date specified for the training window.
952
- # @return [Time]
3539
+ # @!attribute [rw] max_results
3540
+ # The maximum size of the results that is returned per call.
3541
+ # @return [Integer]
953
3542
  #
954
- # @!attribute [rw] training_data_end_time
955
- # The end date specified for the training window.
956
- # @return [Time]
3543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModelsRequest AWS API Documentation
957
3544
  #
958
- # @!attribute [rw] audience_model_arn
959
- # The Amazon Resource Name (ARN) of the audience model.
3545
+ class ListAudienceModelsRequest < Struct.new(
3546
+ :next_token,
3547
+ :max_results)
3548
+ SENSITIVE = []
3549
+ include Aws::Structure
3550
+ end
3551
+
3552
+ # @!attribute [rw] next_token
3553
+ # The token value used to access the next page of results.
960
3554
  # @return [String]
961
3555
  #
962
- # @!attribute [rw] name
963
- # The name of the audience model.
3556
+ # @!attribute [rw] audience_models
3557
+ # The audience models that match the request.
3558
+ # @return [Array<Types::AudienceModelSummary>]
3559
+ #
3560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModelsResponse AWS API Documentation
3561
+ #
3562
+ class ListAudienceModelsResponse < Struct.new(
3563
+ :next_token,
3564
+ :audience_models)
3565
+ SENSITIVE = []
3566
+ include Aws::Structure
3567
+ end
3568
+
3569
+ # @!attribute [rw] next_token
3570
+ # The token value retrieved from a previous call to access the next
3571
+ # page of results.
964
3572
  # @return [String]
965
3573
  #
966
- # @!attribute [rw] training_dataset_arn
967
- # The Amazon Resource Name (ARN) of the training dataset that was used
968
- # for this audience model.
3574
+ # @!attribute [rw] max_results
3575
+ # The maximum size of the results that is returned per call.
3576
+ # @return [Integer]
3577
+ #
3578
+ # @!attribute [rw] collaboration_identifier
3579
+ # The collaboration ID of the collaboration that contains the
3580
+ # configured model algorithm associations that you are interested in.
969
3581
  # @return [String]
970
3582
  #
971
- # @!attribute [rw] status
972
- # The status of the audience model.
3583
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationConfiguredModelAlgorithmAssociationsRequest AWS API Documentation
3584
+ #
3585
+ class ListCollaborationConfiguredModelAlgorithmAssociationsRequest < Struct.new(
3586
+ :next_token,
3587
+ :max_results,
3588
+ :collaboration_identifier)
3589
+ SENSITIVE = []
3590
+ include Aws::Structure
3591
+ end
3592
+
3593
+ # @!attribute [rw] next_token
3594
+ # The token value used to access the next page of results.
973
3595
  # @return [String]
974
3596
  #
975
- # @!attribute [rw] status_details
976
- # Details about the status of the audience model.
977
- # @return [Types::StatusDetails]
3597
+ # @!attribute [rw] collaboration_configured_model_algorithm_associations
3598
+ # The configured model algorithm associations that belong to this
3599
+ # collaboration.
3600
+ # @return [Array<Types::CollaborationConfiguredModelAlgorithmAssociationSummary>]
978
3601
  #
979
- # @!attribute [rw] kms_key_arn
980
- # The KMS key ARN used for the audience model.
3602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationConfiguredModelAlgorithmAssociationsResponse AWS API Documentation
3603
+ #
3604
+ class ListCollaborationConfiguredModelAlgorithmAssociationsResponse < Struct.new(
3605
+ :next_token,
3606
+ :collaboration_configured_model_algorithm_associations)
3607
+ SENSITIVE = []
3608
+ include Aws::Structure
3609
+ end
3610
+
3611
+ # @!attribute [rw] next_token
3612
+ # The token value retrieved from a previous call to access the next
3613
+ # page of results.
981
3614
  # @return [String]
982
3615
  #
983
- # @!attribute [rw] tags
984
- # The tags that are assigned to the audience model.
985
- # @return [Hash<String,String>]
3616
+ # @!attribute [rw] max_results
3617
+ # The maximum number of results to return.
3618
+ # @return [Integer]
986
3619
  #
987
- # @!attribute [rw] description
988
- # The description of the audience model.
3620
+ # @!attribute [rw] collaboration_identifier
3621
+ # The collaboration ID of the collaboration that contains the ML input
3622
+ # channels that you want to list.
989
3623
  # @return [String]
990
3624
  #
991
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModelResponse AWS API Documentation
3625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationMLInputChannelsRequest AWS API Documentation
992
3626
  #
993
- class GetAudienceModelResponse < Struct.new(
994
- :create_time,
995
- :update_time,
996
- :training_data_start_time,
997
- :training_data_end_time,
998
- :audience_model_arn,
999
- :name,
1000
- :training_dataset_arn,
1001
- :status,
1002
- :status_details,
1003
- :kms_key_arn,
1004
- :tags,
1005
- :description)
3627
+ class ListCollaborationMLInputChannelsRequest < Struct.new(
3628
+ :next_token,
3629
+ :max_results,
3630
+ :collaboration_identifier)
1006
3631
  SENSITIVE = []
1007
3632
  include Aws::Structure
1008
3633
  end
1009
3634
 
1010
- # @!attribute [rw] configured_audience_model_arn
1011
- # The Amazon Resource Name (ARN) of the configured audience model that
1012
- # you are interested in.
3635
+ # @!attribute [rw] next_token
3636
+ # The token value used to access the next page of results.
1013
3637
  # @return [String]
1014
3638
  #
1015
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelPolicyRequest AWS API Documentation
3639
+ # @!attribute [rw] collaboration_ml_input_channels_list
3640
+ # The list of ML input channels that you wanted.
3641
+ # @return [Array<Types::CollaborationMLInputChannelSummary>]
1016
3642
  #
1017
- class GetConfiguredAudienceModelPolicyRequest < Struct.new(
1018
- :configured_audience_model_arn)
3643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationMLInputChannelsResponse AWS API Documentation
3644
+ #
3645
+ class ListCollaborationMLInputChannelsResponse < Struct.new(
3646
+ :next_token,
3647
+ :collaboration_ml_input_channels_list)
1019
3648
  SENSITIVE = []
1020
3649
  include Aws::Structure
1021
3650
  end
1022
3651
 
1023
- # @!attribute [rw] configured_audience_model_arn
1024
- # The Amazon Resource Name (ARN) of the configured audience model.
3652
+ # @!attribute [rw] next_token
3653
+ # The token value retrieved from a previous call to access the next
3654
+ # page of results.
1025
3655
  # @return [String]
1026
3656
  #
1027
- # @!attribute [rw] configured_audience_model_policy
1028
- # The configured audience model policy. This is a JSON IAM resource
1029
- # policy.
3657
+ # @!attribute [rw] max_results
3658
+ # The maximum size of the results that is returned per call.
3659
+ # @return [Integer]
3660
+ #
3661
+ # @!attribute [rw] collaboration_identifier
3662
+ # The collaboration ID of the collaboration that contains the trained
3663
+ # model export jobs that you are interested in.
1030
3664
  # @return [String]
1031
3665
  #
1032
- # @!attribute [rw] policy_hash
1033
- # A cryptographic hash of the contents of the policy used to prevent
1034
- # unexpected concurrent modification of the policy.
3666
+ # @!attribute [rw] trained_model_arn
3667
+ # The Amazon Resource Name (ARN) of the trained model that was used to
3668
+ # create the export jobs that you are interested in.
1035
3669
  # @return [String]
1036
3670
  #
1037
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelPolicyResponse AWS API Documentation
3671
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModelExportJobsRequest AWS API Documentation
1038
3672
  #
1039
- class GetConfiguredAudienceModelPolicyResponse < Struct.new(
1040
- :configured_audience_model_arn,
1041
- :configured_audience_model_policy,
1042
- :policy_hash)
3673
+ class ListCollaborationTrainedModelExportJobsRequest < Struct.new(
3674
+ :next_token,
3675
+ :max_results,
3676
+ :collaboration_identifier,
3677
+ :trained_model_arn)
1043
3678
  SENSITIVE = []
1044
3679
  include Aws::Structure
1045
3680
  end
1046
3681
 
1047
- # @!attribute [rw] configured_audience_model_arn
1048
- # The Amazon Resource Name (ARN) of the configured audience model that
1049
- # you are interested in.
3682
+ # @!attribute [rw] next_token
3683
+ # The token value used to access the next page of results.
1050
3684
  # @return [String]
1051
3685
  #
1052
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelRequest AWS API Documentation
3686
+ # @!attribute [rw] collaboration_trained_model_export_jobs
3687
+ # The exports jobs that exist for the requested trained model in the
3688
+ # requested collaboration.
3689
+ # @return [Array<Types::CollaborationTrainedModelExportJobSummary>]
1053
3690
  #
1054
- class GetConfiguredAudienceModelRequest < Struct.new(
1055
- :configured_audience_model_arn)
3691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModelExportJobsResponse AWS API Documentation
3692
+ #
3693
+ class ListCollaborationTrainedModelExportJobsResponse < Struct.new(
3694
+ :next_token,
3695
+ :collaboration_trained_model_export_jobs)
1056
3696
  SENSITIVE = []
1057
3697
  include Aws::Structure
1058
3698
  end
1059
3699
 
1060
- # @!attribute [rw] create_time
1061
- # The time at which the configured audience model was created.
1062
- # @return [Time]
3700
+ # @!attribute [rw] next_token
3701
+ # The token value retrieved from a previous call to access the next
3702
+ # page of results.
3703
+ # @return [String]
1063
3704
  #
1064
- # @!attribute [rw] update_time
1065
- # The most recent time at which the configured audience model was
1066
- # updated.
1067
- # @return [Time]
3705
+ # @!attribute [rw] max_results
3706
+ # The maximum size of the results that is returned per call.
3707
+ # @return [Integer]
1068
3708
  #
1069
- # @!attribute [rw] configured_audience_model_arn
1070
- # The Amazon Resource Name (ARN) of the configured audience model.
3709
+ # @!attribute [rw] collaboration_identifier
3710
+ # The collaboration ID of the collaboration that contains the trained
3711
+ # model inference jobs that you are interested in.
1071
3712
  # @return [String]
1072
3713
  #
1073
- # @!attribute [rw] name
1074
- # The name of the configured audience model.
3714
+ # @!attribute [rw] trained_model_arn
3715
+ # The Amazon Resource Name (ARN) of the trained model that was used to
3716
+ # create the trained model inference jobs that you are interested in.
1075
3717
  # @return [String]
1076
3718
  #
1077
- # @!attribute [rw] audience_model_arn
1078
- # The Amazon Resource Name (ARN) of the audience model used for this
1079
- # configured audience model.
3719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModelInferenceJobsRequest AWS API Documentation
3720
+ #
3721
+ class ListCollaborationTrainedModelInferenceJobsRequest < Struct.new(
3722
+ :next_token,
3723
+ :max_results,
3724
+ :collaboration_identifier,
3725
+ :trained_model_arn)
3726
+ SENSITIVE = []
3727
+ include Aws::Structure
3728
+ end
3729
+
3730
+ # @!attribute [rw] next_token
3731
+ # The token value used to access the next page of results.
1080
3732
  # @return [String]
1081
3733
  #
1082
- # @!attribute [rw] output_config
1083
- # The output configuration of the configured audience model
1084
- # @return [Types::ConfiguredAudienceModelOutputConfig]
3734
+ # @!attribute [rw] collaboration_trained_model_inference_jobs
3735
+ # The trained model inference jobs that you are interested in.
3736
+ # @return [Array<Types::CollaborationTrainedModelInferenceJobSummary>]
1085
3737
  #
1086
- # @!attribute [rw] description
1087
- # The description of the configured audience model.
1088
- # @return [String]
3738
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModelInferenceJobsResponse AWS API Documentation
1089
3739
  #
1090
- # @!attribute [rw] status
1091
- # The status of the configured audience model.
3740
+ class ListCollaborationTrainedModelInferenceJobsResponse < Struct.new(
3741
+ :next_token,
3742
+ :collaboration_trained_model_inference_jobs)
3743
+ SENSITIVE = []
3744
+ include Aws::Structure
3745
+ end
3746
+
3747
+ # @!attribute [rw] next_token
3748
+ # The token value retrieved from a previous call to access the next
3749
+ # page of results.
1092
3750
  # @return [String]
1093
3751
  #
1094
- # @!attribute [rw] shared_audience_metrics
1095
- # Whether audience metrics are shared.
1096
- # @return [Array<String>]
1097
- #
1098
- # @!attribute [rw] min_matching_seed_size
1099
- # The minimum number of users from the seed audience that must match
1100
- # with users in the training data of the audience model.
3752
+ # @!attribute [rw] max_results
3753
+ # The maximum size of the results that is returned per call.
1101
3754
  # @return [Integer]
1102
3755
  #
1103
- # @!attribute [rw] audience_size_config
1104
- # The list of output sizes of audiences that can be created using this
1105
- # configured audience model. A request to StartAudienceGenerationJob
1106
- # that uses this configured audience model must have an `audienceSize`
1107
- # selected from this list. You can use the `ABSOLUTE` AudienceSize to
1108
- # configure out audience sizes using the count of identifiers in the
1109
- # output. You can use the `Percentage` AudienceSize to configure sizes
1110
- # in the range 1-100 percent.
1111
- # @return [Types::AudienceSizeConfig]
3756
+ # @!attribute [rw] collaboration_identifier
3757
+ # The collaboration ID of the collaboration that contains the trained
3758
+ # models you are interested in.
3759
+ # @return [String]
1112
3760
  #
1113
- # @!attribute [rw] tags
1114
- # The tags that are associated to this configured audience model.
1115
- # @return [Hash<String,String>]
3761
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModelsRequest AWS API Documentation
1116
3762
  #
1117
- # @!attribute [rw] child_resource_tag_on_create_policy
1118
- # Provides the `childResourceTagOnCreatePolicy` that was used for this
1119
- # configured audience model.
3763
+ class ListCollaborationTrainedModelsRequest < Struct.new(
3764
+ :next_token,
3765
+ :max_results,
3766
+ :collaboration_identifier)
3767
+ SENSITIVE = []
3768
+ include Aws::Structure
3769
+ end
3770
+
3771
+ # @!attribute [rw] next_token
3772
+ # The token value used to access the next page of results.
1120
3773
  # @return [String]
1121
3774
  #
1122
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelResponse AWS API Documentation
3775
+ # @!attribute [rw] collaboration_trained_models
3776
+ # The trained models in the collaboration that you requested.
3777
+ # @return [Array<Types::CollaborationTrainedModelSummary>]
1123
3778
  #
1124
- class GetConfiguredAudienceModelResponse < Struct.new(
1125
- :create_time,
1126
- :update_time,
1127
- :configured_audience_model_arn,
1128
- :name,
1129
- :audience_model_arn,
1130
- :output_config,
1131
- :description,
1132
- :status,
1133
- :shared_audience_metrics,
1134
- :min_matching_seed_size,
1135
- :audience_size_config,
1136
- :tags,
1137
- :child_resource_tag_on_create_policy)
3779
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModelsResponse AWS API Documentation
3780
+ #
3781
+ class ListCollaborationTrainedModelsResponse < Struct.new(
3782
+ :next_token,
3783
+ :collaboration_trained_models)
1138
3784
  SENSITIVE = []
1139
3785
  include Aws::Structure
1140
3786
  end
1141
3787
 
1142
- # @!attribute [rw] training_dataset_arn
1143
- # The Amazon Resource Name (ARN) of the training dataset that you are
1144
- # interested in.
3788
+ # @!attribute [rw] next_token
3789
+ # The token value retrieved from a previous call to access the next
3790
+ # page of results.
1145
3791
  # @return [String]
1146
3792
  #
1147
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDatasetRequest AWS API Documentation
3793
+ # @!attribute [rw] max_results
3794
+ # The maximum size of the results that is returned per call.
3795
+ # @return [Integer]
1148
3796
  #
1149
- class GetTrainingDatasetRequest < Struct.new(
1150
- :training_dataset_arn)
3797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModelsRequest AWS API Documentation
3798
+ #
3799
+ class ListConfiguredAudienceModelsRequest < Struct.new(
3800
+ :next_token,
3801
+ :max_results)
1151
3802
  SENSITIVE = []
1152
3803
  include Aws::Structure
1153
3804
  end
1154
3805
 
1155
- # @!attribute [rw] create_time
1156
- # The time at which the training dataset was created.
1157
- # @return [Time]
3806
+ # @!attribute [rw] next_token
3807
+ # The token value used to access the next page of results.
3808
+ # @return [String]
1158
3809
  #
1159
- # @!attribute [rw] update_time
1160
- # The most recent time at which the training dataset was updated.
1161
- # @return [Time]
3810
+ # @!attribute [rw] configured_audience_models
3811
+ # The configured audience models.
3812
+ # @return [Array<Types::ConfiguredAudienceModelSummary>]
1162
3813
  #
1163
- # @!attribute [rw] training_dataset_arn
1164
- # The Amazon Resource Name (ARN) of the training dataset.
1165
- # @return [String]
3814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModelsResponse AWS API Documentation
1166
3815
  #
1167
- # @!attribute [rw] name
1168
- # The name of the training dataset.
3816
+ class ListConfiguredAudienceModelsResponse < Struct.new(
3817
+ :next_token,
3818
+ :configured_audience_models)
3819
+ SENSITIVE = []
3820
+ include Aws::Structure
3821
+ end
3822
+
3823
+ # @!attribute [rw] next_token
3824
+ # The token value retrieved from a previous call to access the next
3825
+ # page of results.
1169
3826
  # @return [String]
1170
3827
  #
1171
- # @!attribute [rw] training_data
1172
- # Metadata about the requested training data.
1173
- # @return [Array<Types::Dataset>]
3828
+ # @!attribute [rw] max_results
3829
+ # The maximum size of the results that is returned per call.
3830
+ # @return [Integer]
1174
3831
  #
1175
- # @!attribute [rw] status
1176
- # The status of the training dataset.
3832
+ # @!attribute [rw] membership_identifier
3833
+ # The membership ID of the member that created the configured model
3834
+ # algorithm associations you are interested in.
1177
3835
  # @return [String]
1178
3836
  #
1179
- # @!attribute [rw] role_arn
1180
- # The IAM role used to read the training data.
3837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredModelAlgorithmAssociationsRequest AWS API Documentation
3838
+ #
3839
+ class ListConfiguredModelAlgorithmAssociationsRequest < Struct.new(
3840
+ :next_token,
3841
+ :max_results,
3842
+ :membership_identifier)
3843
+ SENSITIVE = []
3844
+ include Aws::Structure
3845
+ end
3846
+
3847
+ # @!attribute [rw] next_token
3848
+ # The token value used to access the next page of results.
1181
3849
  # @return [String]
1182
3850
  #
1183
- # @!attribute [rw] tags
1184
- # The tags that are assigned to this training dataset.
1185
- # @return [Hash<String,String>]
3851
+ # @!attribute [rw] configured_model_algorithm_associations
3852
+ # The list of configured model algorithm associations.
3853
+ # @return [Array<Types::ConfiguredModelAlgorithmAssociationSummary>]
1186
3854
  #
1187
- # @!attribute [rw] description
1188
- # The description of the training dataset.
3855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredModelAlgorithmAssociationsResponse AWS API Documentation
3856
+ #
3857
+ class ListConfiguredModelAlgorithmAssociationsResponse < Struct.new(
3858
+ :next_token,
3859
+ :configured_model_algorithm_associations)
3860
+ SENSITIVE = []
3861
+ include Aws::Structure
3862
+ end
3863
+
3864
+ # @!attribute [rw] next_token
3865
+ # The token value retrieved from a previous call to access the next
3866
+ # page of results.
1189
3867
  # @return [String]
1190
3868
  #
1191
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDatasetResponse AWS API Documentation
3869
+ # @!attribute [rw] max_results
3870
+ # The maximum size of the results that is returned per call.
3871
+ # @return [Integer]
1192
3872
  #
1193
- class GetTrainingDatasetResponse < Struct.new(
1194
- :create_time,
1195
- :update_time,
1196
- :training_dataset_arn,
1197
- :name,
1198
- :training_data,
1199
- :status,
1200
- :role_arn,
1201
- :tags,
1202
- :description)
3873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredModelAlgorithmsRequest AWS API Documentation
3874
+ #
3875
+ class ListConfiguredModelAlgorithmsRequest < Struct.new(
3876
+ :next_token,
3877
+ :max_results)
1203
3878
  SENSITIVE = []
1204
3879
  include Aws::Structure
1205
3880
  end
1206
3881
 
1207
- # Defines the Glue data source that contains the training data.
1208
- #
1209
- # @!attribute [rw] table_name
1210
- # The Glue table that contains the training data.
1211
- # @return [String]
1212
- #
1213
- # @!attribute [rw] database_name
1214
- # The Glue database that contains the training data.
3882
+ # @!attribute [rw] next_token
3883
+ # The token value used to access the next page of results.
1215
3884
  # @return [String]
1216
3885
  #
1217
- # @!attribute [rw] catalog_id
1218
- # The Glue catalog that contains the training data.
1219
- # @return [String]
3886
+ # @!attribute [rw] configured_model_algorithms
3887
+ # The list of configured model algorithms.
3888
+ # @return [Array<Types::ConfiguredModelAlgorithmSummary>]
1220
3889
  #
1221
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GlueDataSource AWS API Documentation
3890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredModelAlgorithmsResponse AWS API Documentation
1222
3891
  #
1223
- class GlueDataSource < Struct.new(
1224
- :table_name,
1225
- :database_name,
1226
- :catalog_id)
3892
+ class ListConfiguredModelAlgorithmsResponse < Struct.new(
3893
+ :next_token,
3894
+ :configured_model_algorithms)
1227
3895
  SENSITIVE = []
1228
3896
  include Aws::Structure
1229
3897
  end
@@ -1234,38 +3902,62 @@ module Aws::CleanRoomsML
1234
3902
  # @return [String]
1235
3903
  #
1236
3904
  # @!attribute [rw] max_results
1237
- # The maximum size of the results that is returned per call.
3905
+ # The maximum number of ML input channels to return.
1238
3906
  # @return [Integer]
1239
3907
  #
1240
- # @!attribute [rw] audience_generation_job_arn
1241
- # The Amazon Resource Name (ARN) of the audience generation job that
1242
- # you are interested in.
3908
+ # @!attribute [rw] membership_identifier
3909
+ # The membership ID of the membership that contains the ML input
3910
+ # channels that you want to list.
1243
3911
  # @return [String]
1244
3912
  #
1245
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobsRequest AWS API Documentation
3913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListMLInputChannelsRequest AWS API Documentation
1246
3914
  #
1247
- class ListAudienceExportJobsRequest < Struct.new(
3915
+ class ListMLInputChannelsRequest < Struct.new(
1248
3916
  :next_token,
1249
3917
  :max_results,
1250
- :audience_generation_job_arn)
3918
+ :membership_identifier)
1251
3919
  SENSITIVE = []
1252
3920
  include Aws::Structure
1253
3921
  end
1254
3922
 
1255
3923
  # @!attribute [rw] next_token
1256
- # The token value retrieved from a previous call to access the next
1257
- # page of results.
3924
+ # The token value used to access the next page of results.
1258
3925
  # @return [String]
1259
3926
  #
1260
- # @!attribute [rw] audience_export_jobs
1261
- # The audience export jobs that match the request.
1262
- # @return [Array<Types::AudienceExportJobSummary>]
3927
+ # @!attribute [rw] ml_input_channels_list
3928
+ # The list of ML input channels that you wanted.
3929
+ # @return [Array<Types::MLInputChannelSummary>]
1263
3930
  #
1264
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobsResponse AWS API Documentation
3931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListMLInputChannelsResponse AWS API Documentation
1265
3932
  #
1266
- class ListAudienceExportJobsResponse < Struct.new(
3933
+ class ListMLInputChannelsResponse < Struct.new(
1267
3934
  :next_token,
1268
- :audience_export_jobs)
3935
+ :ml_input_channels_list)
3936
+ SENSITIVE = []
3937
+ include Aws::Structure
3938
+ end
3939
+
3940
+ # @!attribute [rw] resource_arn
3941
+ # The Amazon Resource Name (ARN) of the resource that you are
3942
+ # interested in.
3943
+ # @return [String]
3944
+ #
3945
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTagsForResourceRequest AWS API Documentation
3946
+ #
3947
+ class ListTagsForResourceRequest < Struct.new(
3948
+ :resource_arn)
3949
+ SENSITIVE = []
3950
+ include Aws::Structure
3951
+ end
3952
+
3953
+ # @!attribute [rw] tags
3954
+ # The tags that are associated with the resource.
3955
+ # @return [Hash<String,String>]
3956
+ #
3957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTagsForResourceResponse AWS API Documentation
3958
+ #
3959
+ class ListTagsForResourceResponse < Struct.new(
3960
+ :tags)
1269
3961
  SENSITIVE = []
1270
3962
  include Aws::Structure
1271
3963
  end
@@ -1279,42 +3971,39 @@ module Aws::CleanRoomsML
1279
3971
  # The maximum size of the results that is returned per call.
1280
3972
  # @return [Integer]
1281
3973
  #
1282
- # @!attribute [rw] configured_audience_model_arn
1283
- # The Amazon Resource Name (ARN) of the configured audience model that
1284
- # was used for the audience generation jobs that you are interested
1285
- # in.
3974
+ # @!attribute [rw] membership_identifier
3975
+ # The membership
1286
3976
  # @return [String]
1287
3977
  #
1288
- # @!attribute [rw] collaboration_id
1289
- # The identifier of the collaboration that contains the audience
1290
- # generation jobs that you are interested in.
3978
+ # @!attribute [rw] trained_model_arn
3979
+ # The Amazon Resource Name (ARN) of a trained model that was used to
3980
+ # create the trained model inference jobs that you are interested in.
1291
3981
  # @return [String]
1292
3982
  #
1293
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobsRequest AWS API Documentation
3983
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainedModelInferenceJobsRequest AWS API Documentation
1294
3984
  #
1295
- class ListAudienceGenerationJobsRequest < Struct.new(
3985
+ class ListTrainedModelInferenceJobsRequest < Struct.new(
1296
3986
  :next_token,
1297
3987
  :max_results,
1298
- :configured_audience_model_arn,
1299
- :collaboration_id)
3988
+ :membership_identifier,
3989
+ :trained_model_arn)
1300
3990
  SENSITIVE = []
1301
3991
  include Aws::Structure
1302
3992
  end
1303
3993
 
1304
3994
  # @!attribute [rw] next_token
1305
- # The token value retrieved from a previous call to access the next
1306
- # page of results.
3995
+ # The token value used to access the next page of results.
1307
3996
  # @return [String]
1308
3997
  #
1309
- # @!attribute [rw] audience_generation_jobs
1310
- # The audience generation jobs that match the request.
1311
- # @return [Array<Types::AudienceGenerationJobSummary>]
3998
+ # @!attribute [rw] trained_model_inference_jobs
3999
+ # Returns the requested trained model inference jobs.
4000
+ # @return [Array<Types::TrainedModelInferenceJobSummary>]
1312
4001
  #
1313
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobsResponse AWS API Documentation
4002
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainedModelInferenceJobsResponse AWS API Documentation
1314
4003
  #
1315
- class ListAudienceGenerationJobsResponse < Struct.new(
4004
+ class ListTrainedModelInferenceJobsResponse < Struct.new(
1316
4005
  :next_token,
1317
- :audience_generation_jobs)
4006
+ :trained_model_inference_jobs)
1318
4007
  SENSITIVE = []
1319
4008
  include Aws::Structure
1320
4009
  end
@@ -1328,29 +4017,34 @@ module Aws::CleanRoomsML
1328
4017
  # The maximum size of the results that is returned per call.
1329
4018
  # @return [Integer]
1330
4019
  #
1331
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModelsRequest AWS API Documentation
4020
+ # @!attribute [rw] membership_identifier
4021
+ # The membership ID of the member that created the trained models you
4022
+ # are interested in.
4023
+ # @return [String]
1332
4024
  #
1333
- class ListAudienceModelsRequest < Struct.new(
4025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainedModelsRequest AWS API Documentation
4026
+ #
4027
+ class ListTrainedModelsRequest < Struct.new(
1334
4028
  :next_token,
1335
- :max_results)
4029
+ :max_results,
4030
+ :membership_identifier)
1336
4031
  SENSITIVE = []
1337
4032
  include Aws::Structure
1338
4033
  end
1339
4034
 
1340
4035
  # @!attribute [rw] next_token
1341
- # The token value retrieved from a previous call to access the next
1342
- # page of results.
4036
+ # The token value used to access the next page of results.
1343
4037
  # @return [String]
1344
4038
  #
1345
- # @!attribute [rw] audience_models
1346
- # The audience models that match the request.
1347
- # @return [Array<Types::AudienceModelSummary>]
4039
+ # @!attribute [rw] trained_models
4040
+ # The list of trained models.
4041
+ # @return [Array<Types::TrainedModelSummary>]
1348
4042
  #
1349
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModelsResponse AWS API Documentation
4043
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainedModelsResponse AWS API Documentation
1350
4044
  #
1351
- class ListAudienceModelsResponse < Struct.new(
4045
+ class ListTrainedModelsResponse < Struct.new(
1352
4046
  :next_token,
1353
- :audience_models)
4047
+ :trained_models)
1354
4048
  SENSITIVE = []
1355
4049
  include Aws::Structure
1356
4050
  end
@@ -1364,9 +4058,9 @@ module Aws::CleanRoomsML
1364
4058
  # The maximum size of the results that is returned per call.
1365
4059
  # @return [Integer]
1366
4060
  #
1367
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModelsRequest AWS API Documentation
4061
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainingDatasetsRequest AWS API Documentation
1368
4062
  #
1369
- class ListConfiguredAudienceModelsRequest < Struct.new(
4063
+ class ListTrainingDatasetsRequest < Struct.new(
1370
4064
  :next_token,
1371
4065
  :max_results)
1372
4066
  SENSITIVE = []
@@ -1374,84 +4068,259 @@ module Aws::CleanRoomsML
1374
4068
  end
1375
4069
 
1376
4070
  # @!attribute [rw] next_token
1377
- # The token value retrieved from a previous call to access the next
1378
- # page of results.
4071
+ # The token value used to access the next page of results.
1379
4072
  # @return [String]
1380
4073
  #
1381
- # @!attribute [rw] configured_audience_models
1382
- # The configured audience models.
1383
- # @return [Array<Types::ConfiguredAudienceModelSummary>]
4074
+ # @!attribute [rw] training_datasets
4075
+ # The training datasets that match the request.
4076
+ # @return [Array<Types::TrainingDatasetSummary>]
1384
4077
  #
1385
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModelsResponse AWS API Documentation
4078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainingDatasetsResponse AWS API Documentation
1386
4079
  #
1387
- class ListConfiguredAudienceModelsResponse < Struct.new(
4080
+ class ListTrainingDatasetsResponse < Struct.new(
1388
4081
  :next_token,
1389
- :configured_audience_models)
4082
+ :training_datasets)
1390
4083
  SENSITIVE = []
1391
4084
  include Aws::Structure
1392
4085
  end
1393
4086
 
1394
- # @!attribute [rw] resource_arn
1395
- # The Amazon Resource Name (ARN) of the resource that you are
1396
- # interested in.
4087
+ # Provides the information necessary for a user to access the logs.
4088
+ #
4089
+ # @!attribute [rw] allowed_account_ids
4090
+ # A list of account IDs that are allowed to access the logs.
4091
+ # @return [Array<String>]
4092
+ #
4093
+ # @!attribute [rw] filter_pattern
4094
+ # A regular expression pattern that is used to parse the logs and
4095
+ # return information that matches the pattern.
1397
4096
  # @return [String]
1398
4097
  #
1399
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTagsForResourceRequest AWS API Documentation
4098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/LogsConfigurationPolicy AWS API Documentation
1400
4099
  #
1401
- class ListTagsForResourceRequest < Struct.new(
1402
- :resource_arn)
4100
+ class LogsConfigurationPolicy < Struct.new(
4101
+ :allowed_account_ids,
4102
+ :filter_pattern)
1403
4103
  SENSITIVE = []
1404
4104
  include Aws::Structure
1405
4105
  end
1406
4106
 
1407
- # @!attribute [rw] tags
1408
- # The tags that are associated with the resource.
1409
- # @return [Hash<String,String>]
4107
+ # Provides summary information about the ML input channel.
1410
4108
  #
1411
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTagsForResourceResponse AWS API Documentation
4109
+ # @!attribute [rw] create_time
4110
+ # The time at which the ML input channel was created.
4111
+ # @return [Time]
1412
4112
  #
1413
- class ListTagsForResourceResponse < Struct.new(
1414
- :tags)
4113
+ # @!attribute [rw] update_time
4114
+ # The most recent time at which the ML input channel was updated.
4115
+ # @return [Time]
4116
+ #
4117
+ # @!attribute [rw] membership_identifier
4118
+ # The membership ID of the membership that contains the ML input
4119
+ # channel.
4120
+ # @return [String]
4121
+ #
4122
+ # @!attribute [rw] collaboration_identifier
4123
+ # The collaboration ID of the collaboration that contains the ML input
4124
+ # channel.
4125
+ # @return [String]
4126
+ #
4127
+ # @!attribute [rw] name
4128
+ # The name of the ML input channel.
4129
+ # @return [String]
4130
+ #
4131
+ # @!attribute [rw] configured_model_algorithm_associations
4132
+ # The associated configured model algorithms used to create the ML
4133
+ # input channel.
4134
+ # @return [Array<String>]
4135
+ #
4136
+ # @!attribute [rw] protected_query_identifier
4137
+ # The ID of the protected query that was used to create the ML input
4138
+ # channel.
4139
+ # @return [String]
4140
+ #
4141
+ # @!attribute [rw] ml_input_channel_arn
4142
+ # The Amazon Resource Name (ARN) of the ML input channel.
4143
+ # @return [String]
4144
+ #
4145
+ # @!attribute [rw] status
4146
+ # The status of the ML input channel.
4147
+ # @return [String]
4148
+ #
4149
+ # @!attribute [rw] description
4150
+ # The description of the ML input channel.
4151
+ # @return [String]
4152
+ #
4153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/MLInputChannelSummary AWS API Documentation
4154
+ #
4155
+ class MLInputChannelSummary < Struct.new(
4156
+ :create_time,
4157
+ :update_time,
4158
+ :membership_identifier,
4159
+ :collaboration_identifier,
4160
+ :name,
4161
+ :configured_model_algorithm_associations,
4162
+ :protected_query_identifier,
4163
+ :ml_input_channel_arn,
4164
+ :status,
4165
+ :description)
1415
4166
  SENSITIVE = []
1416
4167
  include Aws::Structure
1417
4168
  end
1418
4169
 
1419
- # @!attribute [rw] next_token
1420
- # The token value retrieved from a previous call to access the next
1421
- # page of results.
4170
+ # Configuration information about how the exported model artifacts are
4171
+ # stored.
4172
+ #
4173
+ # @!attribute [rw] destination
4174
+ # The Amazon S3 location where exported model artifacts are stored.
4175
+ # @return [Types::Destination]
4176
+ #
4177
+ # @!attribute [rw] role_arn
4178
+ # The Amazon Resource Name (ARN) of the service access role that is
4179
+ # used to store the model artifacts.
1422
4180
  # @return [String]
1423
4181
  #
1424
- # @!attribute [rw] max_results
1425
- # The maximum size of the results that is returned per call.
1426
- # @return [Integer]
4182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/MLOutputConfiguration AWS API Documentation
1427
4183
  #
1428
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainingDatasetsRequest AWS API Documentation
4184
+ class MLOutputConfiguration < Struct.new(
4185
+ :destination,
4186
+ :role_arn)
4187
+ SENSITIVE = []
4188
+ include Aws::Structure
4189
+ end
4190
+
4191
+ # Information about the model metric that is reported for a trained
4192
+ # model.
1429
4193
  #
1430
- class ListTrainingDatasetsRequest < Struct.new(
1431
- :next_token,
1432
- :max_results)
4194
+ # @!attribute [rw] name
4195
+ # The name of the model metric.
4196
+ # @return [String]
4197
+ #
4198
+ # @!attribute [rw] regex
4199
+ # The regular expression statement that defines how the model metric
4200
+ # is reported.
4201
+ # @return [String]
4202
+ #
4203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/MetricDefinition AWS API Documentation
4204
+ #
4205
+ class MetricDefinition < Struct.new(
4206
+ :name,
4207
+ :regex)
1433
4208
  SENSITIVE = []
1434
4209
  include Aws::Structure
1435
4210
  end
1436
4211
 
1437
- # @!attribute [rw] next_token
1438
- # The token value retrieved from a previous call to access the next
1439
- # page of results.
4212
+ # Provides the configuration policy for metrics generation.
4213
+ #
4214
+ # @!attribute [rw] noise_level
4215
+ # The noise level for the generated metrics.
1440
4216
  # @return [String]
1441
4217
  #
1442
- # @!attribute [rw] training_datasets
1443
- # The training datasets that match the request.
1444
- # @return [Array<Types::TrainingDatasetSummary>]
4218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/MetricsConfigurationPolicy AWS API Documentation
1445
4219
  #
1446
- # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainingDatasetsResponse AWS API Documentation
4220
+ class MetricsConfigurationPolicy < Struct.new(
4221
+ :noise_level)
4222
+ SENSITIVE = []
4223
+ include Aws::Structure
4224
+ end
4225
+
4226
+ # Defines information about the data source used for model inference.
1447
4227
  #
1448
- class ListTrainingDatasetsResponse < Struct.new(
1449
- :next_token,
1450
- :training_datasets)
4228
+ # @!attribute [rw] ml_input_channel_arn
4229
+ # The Amazon Resource Name (ARN) of the ML input channel for this
4230
+ # model inference data source.
4231
+ # @return [String]
4232
+ #
4233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ModelInferenceDataSource AWS API Documentation
4234
+ #
4235
+ class ModelInferenceDataSource < Struct.new(
4236
+ :ml_input_channel_arn)
4237
+ SENSITIVE = []
4238
+ include Aws::Structure
4239
+ end
4240
+
4241
+ # Information about the model training data channel. A training data
4242
+ # channel is a named data source that the training algorithms can
4243
+ # consume.
4244
+ #
4245
+ # @!attribute [rw] ml_input_channel_arn
4246
+ # The Amazon Resource Name (ARN) of the ML input channel for this
4247
+ # model training data channel.
4248
+ # @return [String]
4249
+ #
4250
+ # @!attribute [rw] channel_name
4251
+ # The name of the training data channel.
4252
+ # @return [String]
4253
+ #
4254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ModelTrainingDataChannel AWS API Documentation
4255
+ #
4256
+ class ModelTrainingDataChannel < Struct.new(
4257
+ :ml_input_channel_arn,
4258
+ :channel_name)
4259
+ SENSITIVE = []
4260
+ include Aws::Structure
4261
+ end
4262
+
4263
+ # Information about the privacy configuration for a configured model
4264
+ # algorithm association.
4265
+ #
4266
+ # @!attribute [rw] policies
4267
+ # The privacy configuration policies for a configured model algorithm
4268
+ # association.
4269
+ # @return [Types::PrivacyConfigurationPolicies]
4270
+ #
4271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/PrivacyConfiguration AWS API Documentation
4272
+ #
4273
+ class PrivacyConfiguration < Struct.new(
4274
+ :policies)
4275
+ SENSITIVE = []
4276
+ include Aws::Structure
4277
+ end
4278
+
4279
+ # Information about the privacy configuration policies for a configured
4280
+ # model algorithm association.
4281
+ #
4282
+ # @!attribute [rw] trained_models
4283
+ # Specifies who will receive the trained models.
4284
+ # @return [Types::TrainedModelsConfigurationPolicy]
4285
+ #
4286
+ # @!attribute [rw] trained_model_exports
4287
+ # Specifies who will receive the trained model export.
4288
+ # @return [Types::TrainedModelExportsConfigurationPolicy]
4289
+ #
4290
+ # @!attribute [rw] trained_model_inference_jobs
4291
+ # Specifies who will receive the trained model inference jobs.
4292
+ # @return [Types::TrainedModelInferenceJobsConfigurationPolicy]
4293
+ #
4294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/PrivacyConfigurationPolicies AWS API Documentation
4295
+ #
4296
+ class PrivacyConfigurationPolicies < Struct.new(
4297
+ :trained_models,
4298
+ :trained_model_exports,
4299
+ :trained_model_inference_jobs)
1451
4300
  SENSITIVE = []
1452
4301
  include Aws::Structure
1453
4302
  end
1454
4303
 
4304
+ # Provides information necessary to perform the protected query.
4305
+ #
4306
+ # @!attribute [rw] sql_parameters
4307
+ # The parameters for the SQL type Protected Query.
4308
+ # @return [Types::ProtectedQuerySQLParameters]
4309
+ #
4310
+ # @!attribute [rw] compute_configuration
4311
+ # Provides configuration information for the workers that will perform
4312
+ # the protected query.
4313
+ # @return [Types::ComputeConfiguration]
4314
+ #
4315
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ProtectedQueryInputParameters AWS API Documentation
4316
+ #
4317
+ class ProtectedQueryInputParameters < Struct.new(
4318
+ :sql_parameters,
4319
+ :compute_configuration)
4320
+ SENSITIVE = [:sql_parameters]
4321
+ include Aws::Structure
4322
+ end
4323
+
1455
4324
  # The parameters for the SQL type Protected Query.
1456
4325
  #
1457
4326
  # @!attribute [rw] query_string
@@ -1525,6 +4394,24 @@ module Aws::CleanRoomsML
1525
4394
  include Aws::Structure
1526
4395
  end
1527
4396
 
4397
+ # @!attribute [rw] membership_identifier
4398
+ # The membership ID of the member that is being configured.
4399
+ # @return [String]
4400
+ #
4401
+ # @!attribute [rw] default_output_location
4402
+ # The default Amazon S3 location where ML output is stored for the
4403
+ # specified member.
4404
+ # @return [Types::MLOutputConfiguration]
4405
+ #
4406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/PutMLConfigurationRequest AWS API Documentation
4407
+ #
4408
+ class PutMLConfigurationRequest < Struct.new(
4409
+ :membership_identifier,
4410
+ :default_output_location)
4411
+ SENSITIVE = []
4412
+ include Aws::Structure
4413
+ end
4414
+
1528
4415
  # The relevance score of a generated audience.
1529
4416
  #
1530
4417
  # @!attribute [rw] audience_size
@@ -1545,6 +4432,30 @@ module Aws::CleanRoomsML
1545
4432
  include Aws::Structure
1546
4433
  end
1547
4434
 
4435
+ # Information about the EC2 resources that are used to train the model.
4436
+ #
4437
+ # @!attribute [rw] instance_count
4438
+ # The number of resources that are used to train the model.
4439
+ # @return [Integer]
4440
+ #
4441
+ # @!attribute [rw] instance_type
4442
+ # The instance type that is used to train the model.
4443
+ # @return [String]
4444
+ #
4445
+ # @!attribute [rw] volume_size_in_gb
4446
+ # The maximum size of the instance that is used to train the model.
4447
+ # @return [Integer]
4448
+ #
4449
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ResourceConfig AWS API Documentation
4450
+ #
4451
+ class ResourceConfig < Struct.new(
4452
+ :instance_count,
4453
+ :instance_type,
4454
+ :volume_size_in_gb)
4455
+ SENSITIVE = []
4456
+ include Aws::Structure
4457
+ end
4458
+
1548
4459
  # The resource you are requesting does not exist.
1549
4460
  #
1550
4461
  # @!attribute [rw] message
@@ -1700,6 +4611,157 @@ module Aws::CleanRoomsML
1700
4611
  include Aws::Structure
1701
4612
  end
1702
4613
 
4614
+ # @!attribute [rw] name
4615
+ # The name of the trained model export job.
4616
+ # @return [String]
4617
+ #
4618
+ # @!attribute [rw] trained_model_arn
4619
+ # The Amazon Resource Name (ARN) of the trained model that you want to
4620
+ # export.
4621
+ # @return [String]
4622
+ #
4623
+ # @!attribute [rw] membership_identifier
4624
+ # The membership ID of the member that is receiving the exported
4625
+ # trained model artifacts.
4626
+ # @return [String]
4627
+ #
4628
+ # @!attribute [rw] output_configuration
4629
+ # The output configuration information for the trained model export
4630
+ # job.
4631
+ # @return [Types::TrainedModelExportOutputConfiguration]
4632
+ #
4633
+ # @!attribute [rw] description
4634
+ # The description of the trained model export job.
4635
+ # @return [String]
4636
+ #
4637
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartTrainedModelExportJobRequest AWS API Documentation
4638
+ #
4639
+ class StartTrainedModelExportJobRequest < Struct.new(
4640
+ :name,
4641
+ :trained_model_arn,
4642
+ :membership_identifier,
4643
+ :output_configuration,
4644
+ :description)
4645
+ SENSITIVE = []
4646
+ include Aws::Structure
4647
+ end
4648
+
4649
+ # @!attribute [rw] membership_identifier
4650
+ # The membership ID of the membership that contains the trained model
4651
+ # inference job.
4652
+ # @return [String]
4653
+ #
4654
+ # @!attribute [rw] name
4655
+ # The name of the trained model inference job.
4656
+ # @return [String]
4657
+ #
4658
+ # @!attribute [rw] trained_model_arn
4659
+ # The Amazon Resource Name (ARN) of the trained model that is used for
4660
+ # this trained model inference job.
4661
+ # @return [String]
4662
+ #
4663
+ # @!attribute [rw] configured_model_algorithm_association_arn
4664
+ # The Amazon Resource Name (ARN) of the configured model algorithm
4665
+ # association that is used for this trained model inference job.
4666
+ # @return [String]
4667
+ #
4668
+ # @!attribute [rw] resource_config
4669
+ # Defines the resource configuration for the trained model inference
4670
+ # job.
4671
+ # @return [Types::InferenceResourceConfig]
4672
+ #
4673
+ # @!attribute [rw] output_configuration
4674
+ # Defines the output configuration information for the trained model
4675
+ # inference job.
4676
+ # @return [Types::InferenceOutputConfiguration]
4677
+ #
4678
+ # @!attribute [rw] data_source
4679
+ # Defines he data source that is used for the trained model inference
4680
+ # job.
4681
+ # @return [Types::ModelInferenceDataSource]
4682
+ #
4683
+ # @!attribute [rw] description
4684
+ # The description of the trained model inference job.
4685
+ # @return [String]
4686
+ #
4687
+ # @!attribute [rw] container_execution_parameters
4688
+ # The execution parameters for the container.
4689
+ # @return [Types::InferenceContainerExecutionParameters]
4690
+ #
4691
+ # @!attribute [rw] environment
4692
+ # The environment variables to set in the Docker container.
4693
+ # @return [Hash<String,String>]
4694
+ #
4695
+ # @!attribute [rw] kms_key_arn
4696
+ # The Amazon Resource Name (ARN) of the KMS key. This key is used to
4697
+ # encrypt and decrypt customer-owned data in the ML inference job and
4698
+ # associated data.
4699
+ # @return [String]
4700
+ #
4701
+ # @!attribute [rw] tags
4702
+ # The optional metadata that you apply to the resource to help you
4703
+ # categorize and organize them. Each tag consists of a key and an
4704
+ # optional value, both of which you define.
4705
+ #
4706
+ # The following basic restrictions apply to tags:
4707
+ #
4708
+ # * Maximum number of tags per resource - 50.
4709
+ #
4710
+ # * For each resource, each tag key must be unique, and each tag key
4711
+ # can have only one value.
4712
+ #
4713
+ # * Maximum key length - 128 Unicode characters in UTF-8.
4714
+ #
4715
+ # * Maximum value length - 256 Unicode characters in UTF-8.
4716
+ #
4717
+ # * If your tagging schema is used across multiple services and
4718
+ # resources, remember that other services may have restrictions on
4719
+ # allowed characters. Generally allowed characters are: letters,
4720
+ # numbers, and spaces representable in UTF-8, and the following
4721
+ # characters: + - = . \_ : / @.
4722
+ #
4723
+ # * Tag keys and values are case sensitive.
4724
+ #
4725
+ # * Do not use aws:, AWS:, or any upper or lowercase combination of
4726
+ # such as a prefix for keys as it is reserved for AWS use. You
4727
+ # cannot edit or delete tag keys with this prefix. Values can have
4728
+ # this prefix. If a tag value has aws as its prefix but the key does
4729
+ # not, then Clean Rooms ML considers it to be a user tag and will
4730
+ # count against the limit of 50 tags. Tags with only the key prefix
4731
+ # of aws do not count against your tags per resource limit.
4732
+ # @return [Hash<String,String>]
4733
+ #
4734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartTrainedModelInferenceJobRequest AWS API Documentation
4735
+ #
4736
+ class StartTrainedModelInferenceJobRequest < Struct.new(
4737
+ :membership_identifier,
4738
+ :name,
4739
+ :trained_model_arn,
4740
+ :configured_model_algorithm_association_arn,
4741
+ :resource_config,
4742
+ :output_configuration,
4743
+ :data_source,
4744
+ :description,
4745
+ :container_execution_parameters,
4746
+ :environment,
4747
+ :kms_key_arn,
4748
+ :tags)
4749
+ SENSITIVE = []
4750
+ include Aws::Structure
4751
+ end
4752
+
4753
+ # @!attribute [rw] trained_model_inference_job_arn
4754
+ # The Amazon Resource Name (ARN) of the trained model inference job.
4755
+ # @return [String]
4756
+ #
4757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartTrainedModelInferenceJobResponse AWS API Documentation
4758
+ #
4759
+ class StartTrainedModelInferenceJobResponse < Struct.new(
4760
+ :trained_model_inference_job_arn)
4761
+ SENSITIVE = []
4762
+ include Aws::Structure
4763
+ end
4764
+
1703
4765
  # Details about the status of a resource.
1704
4766
  #
1705
4767
  # @!attribute [rw] status_code
@@ -1723,6 +4785,21 @@ module Aws::CleanRoomsML
1723
4785
  include Aws::Structure
1724
4786
  end
1725
4787
 
4788
+ # The criteria used to stop model training.
4789
+ #
4790
+ # @!attribute [rw] max_runtime_in_seconds
4791
+ # The maximum amount of time, in seconds, that model training can run
4792
+ # before it is terminated.
4793
+ # @return [Integer]
4794
+ #
4795
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StoppingCondition AWS API Documentation
4796
+ #
4797
+ class StoppingCondition < Struct.new(
4798
+ :max_runtime_in_seconds)
4799
+ SENSITIVE = []
4800
+ include Aws::Structure
4801
+ end
4802
+
1726
4803
  # @!attribute [rw] resource_arn
1727
4804
  # The Amazon Resource Name (ARN) of the resource that you want to
1728
4805
  # assign tags.
@@ -1774,6 +4851,281 @@ module Aws::CleanRoomsML
1774
4851
  #
1775
4852
  class TagResourceResponse < Aws::EmptyStructure; end
1776
4853
 
4854
+ # Information about the output of the trained model export job.
4855
+ #
4856
+ # @!attribute [rw] members
4857
+ # The members that will received the exported trained model output.
4858
+ # @return [Array<Types::TrainedModelExportReceiverMember>]
4859
+ #
4860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelExportOutputConfiguration AWS API Documentation
4861
+ #
4862
+ class TrainedModelExportOutputConfiguration < Struct.new(
4863
+ :members)
4864
+ SENSITIVE = []
4865
+ include Aws::Structure
4866
+ end
4867
+
4868
+ # Provides information about the member who will receive trained model
4869
+ # exports.
4870
+ #
4871
+ # @!attribute [rw] account_id
4872
+ # The account ID of the member who will receive trained model exports.
4873
+ # @return [String]
4874
+ #
4875
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelExportReceiverMember AWS API Documentation
4876
+ #
4877
+ class TrainedModelExportReceiverMember < Struct.new(
4878
+ :account_id)
4879
+ SENSITIVE = []
4880
+ include Aws::Structure
4881
+ end
4882
+
4883
+ # Information about how the trained model exports are configured.
4884
+ #
4885
+ # @!attribute [rw] max_size
4886
+ # The maximum size of the data that can be exported.
4887
+ # @return [Types::TrainedModelExportsMaxSize]
4888
+ #
4889
+ # @!attribute [rw] files_to_export
4890
+ # The files that are exported during the trained model export job.
4891
+ # @return [Array<String>]
4892
+ #
4893
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelExportsConfigurationPolicy AWS API Documentation
4894
+ #
4895
+ class TrainedModelExportsConfigurationPolicy < Struct.new(
4896
+ :max_size,
4897
+ :files_to_export)
4898
+ SENSITIVE = []
4899
+ include Aws::Structure
4900
+ end
4901
+
4902
+ # The maximum size of the trained model metrics that can be exported. If
4903
+ # the trained model metrics dataset is larger than this value, it will
4904
+ # not be exported.
4905
+ #
4906
+ # @!attribute [rw] unit
4907
+ # The unit of measurement for the data size.
4908
+ # @return [String]
4909
+ #
4910
+ # @!attribute [rw] value
4911
+ # The maximum size of the dataset to export.
4912
+ # @return [Float]
4913
+ #
4914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelExportsMaxSize AWS API Documentation
4915
+ #
4916
+ class TrainedModelExportsMaxSize < Struct.new(
4917
+ :unit,
4918
+ :value)
4919
+ SENSITIVE = []
4920
+ include Aws::Structure
4921
+ end
4922
+
4923
+ # Provides information about the trained model inference job.
4924
+ #
4925
+ # @!attribute [rw] trained_model_inference_job_arn
4926
+ # The Amazon Resource Name (ARN) of the trained model inference job.
4927
+ # @return [String]
4928
+ #
4929
+ # @!attribute [rw] configured_model_algorithm_association_arn
4930
+ # The Amazon Resource Name (ARN) of the configured model algorithm
4931
+ # association that is used for the trained model inference job.
4932
+ # @return [String]
4933
+ #
4934
+ # @!attribute [rw] membership_identifier
4935
+ # The membership ID of the membership that contains the trained model
4936
+ # inference job.
4937
+ # @return [String]
4938
+ #
4939
+ # @!attribute [rw] trained_model_arn
4940
+ # The Amazon Resource Name (ARN) of the trained model that is used for
4941
+ # the trained model inference job.
4942
+ # @return [String]
4943
+ #
4944
+ # @!attribute [rw] collaboration_identifier
4945
+ # The collaboration ID of the collaboration that contains the trained
4946
+ # model inference job.
4947
+ # @return [String]
4948
+ #
4949
+ # @!attribute [rw] status
4950
+ # The status of the trained model inference job.
4951
+ # @return [String]
4952
+ #
4953
+ # @!attribute [rw] output_configuration
4954
+ # The output configuration information of the trained model job.
4955
+ # @return [Types::InferenceOutputConfiguration]
4956
+ #
4957
+ # @!attribute [rw] name
4958
+ # The name of the trained model inference job.
4959
+ # @return [String]
4960
+ #
4961
+ # @!attribute [rw] description
4962
+ # The description of the trained model inference job.
4963
+ # @return [String]
4964
+ #
4965
+ # @!attribute [rw] metrics_status
4966
+ # The metric status of the trained model inference job.
4967
+ # @return [String]
4968
+ #
4969
+ # @!attribute [rw] metrics_status_details
4970
+ # Details about the metrics status for the trained model inference
4971
+ # job.
4972
+ # @return [String]
4973
+ #
4974
+ # @!attribute [rw] logs_status
4975
+ # The log status of the trained model inference job.
4976
+ # @return [String]
4977
+ #
4978
+ # @!attribute [rw] logs_status_details
4979
+ # Details about the log status for the trained model inference job.
4980
+ # @return [String]
4981
+ #
4982
+ # @!attribute [rw] create_time
4983
+ # The time at which the trained model inference job was created.
4984
+ # @return [Time]
4985
+ #
4986
+ # @!attribute [rw] update_time
4987
+ # The most recent time at which the trained model inference job was
4988
+ # updated.
4989
+ # @return [Time]
4990
+ #
4991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelInferenceJobSummary AWS API Documentation
4992
+ #
4993
+ class TrainedModelInferenceJobSummary < Struct.new(
4994
+ :trained_model_inference_job_arn,
4995
+ :configured_model_algorithm_association_arn,
4996
+ :membership_identifier,
4997
+ :trained_model_arn,
4998
+ :collaboration_identifier,
4999
+ :status,
5000
+ :output_configuration,
5001
+ :name,
5002
+ :description,
5003
+ :metrics_status,
5004
+ :metrics_status_details,
5005
+ :logs_status,
5006
+ :logs_status_details,
5007
+ :create_time,
5008
+ :update_time)
5009
+ SENSITIVE = []
5010
+ include Aws::Structure
5011
+ end
5012
+
5013
+ # Provides configuration information for the trained model inference
5014
+ # job.
5015
+ #
5016
+ # @!attribute [rw] container_logs
5017
+ # The logs container for the trained model inference job.
5018
+ # @return [Array<Types::LogsConfigurationPolicy>]
5019
+ #
5020
+ # @!attribute [rw] max_output_size
5021
+ # The maximum allowed size of the output of the trained model
5022
+ # inference job.
5023
+ # @return [Types::TrainedModelInferenceMaxOutputSize]
5024
+ #
5025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelInferenceJobsConfigurationPolicy AWS API Documentation
5026
+ #
5027
+ class TrainedModelInferenceJobsConfigurationPolicy < Struct.new(
5028
+ :container_logs,
5029
+ :max_output_size)
5030
+ SENSITIVE = []
5031
+ include Aws::Structure
5032
+ end
5033
+
5034
+ # Information about the maximum output size for a trained model
5035
+ # inference job.
5036
+ #
5037
+ # @!attribute [rw] unit
5038
+ # The measurement unit to use.
5039
+ # @return [String]
5040
+ #
5041
+ # @!attribute [rw] value
5042
+ # The maximum output size value.
5043
+ # @return [Float]
5044
+ #
5045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelInferenceMaxOutputSize AWS API Documentation
5046
+ #
5047
+ class TrainedModelInferenceMaxOutputSize < Struct.new(
5048
+ :unit,
5049
+ :value)
5050
+ SENSITIVE = []
5051
+ include Aws::Structure
5052
+ end
5053
+
5054
+ # Summary information about the trained model.
5055
+ #
5056
+ # @!attribute [rw] create_time
5057
+ # The time at which the trained model was created.
5058
+ # @return [Time]
5059
+ #
5060
+ # @!attribute [rw] update_time
5061
+ # The most recent time at which the trained model was updated.
5062
+ # @return [Time]
5063
+ #
5064
+ # @!attribute [rw] trained_model_arn
5065
+ # The Amazon Resource Name (ARN) of the trained model.
5066
+ # @return [String]
5067
+ #
5068
+ # @!attribute [rw] name
5069
+ # The name of the trained model.
5070
+ # @return [String]
5071
+ #
5072
+ # @!attribute [rw] description
5073
+ # The description of the trained model.
5074
+ # @return [String]
5075
+ #
5076
+ # @!attribute [rw] membership_identifier
5077
+ # The membership ID of the member that created the trained model.
5078
+ # @return [String]
5079
+ #
5080
+ # @!attribute [rw] collaboration_identifier
5081
+ # The collaboration ID of the collaboration that contains the trained
5082
+ # model.
5083
+ # @return [String]
5084
+ #
5085
+ # @!attribute [rw] status
5086
+ # The status of the trained model.
5087
+ # @return [String]
5088
+ #
5089
+ # @!attribute [rw] configured_model_algorithm_association_arn
5090
+ # The Amazon Resource Name (ARN) of the configured model algorithm
5091
+ # association that was used to create this trained model.
5092
+ # @return [String]
5093
+ #
5094
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelSummary AWS API Documentation
5095
+ #
5096
+ class TrainedModelSummary < Struct.new(
5097
+ :create_time,
5098
+ :update_time,
5099
+ :trained_model_arn,
5100
+ :name,
5101
+ :description,
5102
+ :membership_identifier,
5103
+ :collaboration_identifier,
5104
+ :status,
5105
+ :configured_model_algorithm_association_arn)
5106
+ SENSITIVE = []
5107
+ include Aws::Structure
5108
+ end
5109
+
5110
+ # The configuration policy for the trained models.
5111
+ #
5112
+ # @!attribute [rw] container_logs
5113
+ # The container for the logs of the trained model.
5114
+ # @return [Array<Types::LogsConfigurationPolicy>]
5115
+ #
5116
+ # @!attribute [rw] container_metrics
5117
+ # The container for the metrics of the trained model.
5118
+ # @return [Types::MetricsConfigurationPolicy]
5119
+ #
5120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TrainedModelsConfigurationPolicy AWS API Documentation
5121
+ #
5122
+ class TrainedModelsConfigurationPolicy < Struct.new(
5123
+ :container_logs,
5124
+ :container_metrics)
5125
+ SENSITIVE = []
5126
+ include Aws::Structure
5127
+ end
5128
+
1777
5129
  # Provides information about the training dataset.
1778
5130
  #
1779
5131
  # @!attribute [rw] create_time
@@ -1906,6 +5258,26 @@ module Aws::CleanRoomsML
1906
5258
  include Aws::Structure
1907
5259
  end
1908
5260
 
5261
+ # Configuration information about the compute workers that perform the
5262
+ # transform job.
5263
+ #
5264
+ # @!attribute [rw] type
5265
+ # The instance type of the compute workers that are used.
5266
+ # @return [String]
5267
+ #
5268
+ # @!attribute [rw] number
5269
+ # The number of compute workers that are used.
5270
+ # @return [Integer]
5271
+ #
5272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/WorkerComputeConfiguration AWS API Documentation
5273
+ #
5274
+ class WorkerComputeConfiguration < Struct.new(
5275
+ :type,
5276
+ :number)
5277
+ SENSITIVE = []
5278
+ include Aws::Structure
5279
+ end
5280
+
1909
5281
  end
1910
5282
  end
1911
5283