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