aws-sdk-cleanroomsml 1.17.0 → 1.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cleanroomsml/client.rb +2399 -414
- data/lib/aws-sdk-cleanroomsml/client_api.rb +1273 -3
- data/lib/aws-sdk-cleanroomsml/types.rb +3869 -497
- data/lib/aws-sdk-cleanroomsml.rb +2 -2
- data/sig/client.rbs +600 -0
- data/sig/types.rbs +812 -0
- metadata +2 -2
@@ -447,6 +447,61 @@ module Aws::CleanRoomsML
|
|
447
447
|
|
448
448
|
# @!group API Operations
|
449
449
|
|
450
|
+
# Submits a request to cancel the trained model job.
|
451
|
+
#
|
452
|
+
# @option params [required, String] :membership_identifier
|
453
|
+
# The membership ID of the trained model job that you want to cancel.
|
454
|
+
#
|
455
|
+
# @option params [required, String] :trained_model_arn
|
456
|
+
# The Amazon Resource Name (ARN) of the trained model job that you want
|
457
|
+
# to cancel.
|
458
|
+
#
|
459
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
460
|
+
#
|
461
|
+
# @example Request syntax with placeholder values
|
462
|
+
#
|
463
|
+
# resp = client.cancel_trained_model({
|
464
|
+
# membership_identifier: "UUID", # required
|
465
|
+
# trained_model_arn: "TrainedModelArn", # required
|
466
|
+
# })
|
467
|
+
#
|
468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CancelTrainedModel AWS API Documentation
|
469
|
+
#
|
470
|
+
# @overload cancel_trained_model(params = {})
|
471
|
+
# @param [Hash] params ({})
|
472
|
+
def cancel_trained_model(params = {}, options = {})
|
473
|
+
req = build_request(:cancel_trained_model, params)
|
474
|
+
req.send_request(options)
|
475
|
+
end
|
476
|
+
|
477
|
+
# Submits a request to cancel a trained model inference job.
|
478
|
+
#
|
479
|
+
# @option params [required, String] :membership_identifier
|
480
|
+
# The membership ID of the trained model inference job that you want to
|
481
|
+
# cancel.
|
482
|
+
#
|
483
|
+
# @option params [required, String] :trained_model_inference_job_arn
|
484
|
+
# The Amazon Resource Name (ARN) of the trained model inference job that
|
485
|
+
# you want to cancel.
|
486
|
+
#
|
487
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
488
|
+
#
|
489
|
+
# @example Request syntax with placeholder values
|
490
|
+
#
|
491
|
+
# resp = client.cancel_trained_model_inference_job({
|
492
|
+
# membership_identifier: "UUID", # required
|
493
|
+
# trained_model_inference_job_arn: "TrainedModelInferenceJobArn", # required
|
494
|
+
# })
|
495
|
+
#
|
496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CancelTrainedModelInferenceJob AWS API Documentation
|
497
|
+
#
|
498
|
+
# @overload cancel_trained_model_inference_job(params = {})
|
499
|
+
# @param [Hash] params ({})
|
500
|
+
def cancel_trained_model_inference_job(params = {}, options = {})
|
501
|
+
req = build_request(:cancel_trained_model_inference_job, params)
|
502
|
+
req.send_request(options)
|
503
|
+
end
|
504
|
+
|
450
505
|
# Defines the information necessary to create an audience model. An
|
451
506
|
# audience model is a machine learning model that Clean Rooms ML trains
|
452
507
|
# to measure similarity between users. Clean Rooms ML manages training
|
@@ -663,25 +718,26 @@ module Aws::CleanRoomsML
|
|
663
718
|
req.send_request(options)
|
664
719
|
end
|
665
720
|
|
666
|
-
#
|
667
|
-
#
|
668
|
-
# Glue table, which is read only during `AudienceModel` creation.
|
721
|
+
# Creates a configured model algorithm using a container image stored in
|
722
|
+
# an ECR repository.
|
669
723
|
#
|
670
724
|
# @option params [required, String] :name
|
671
|
-
# The name of the
|
672
|
-
#
|
725
|
+
# The name of the configured model algorithm.
|
726
|
+
#
|
727
|
+
# @option params [String] :description
|
728
|
+
# The description of the configured model algorithm.
|
673
729
|
#
|
674
730
|
# @option params [required, String] :role_arn
|
675
|
-
# The ARN of the
|
676
|
-
#
|
731
|
+
# The Amazon Resource Name (ARN) of the role that is used to access the
|
732
|
+
# repository.
|
677
733
|
#
|
678
|
-
#
|
679
|
-
#
|
734
|
+
# @option params [Types::ContainerConfig] :training_container_config
|
735
|
+
# Configuration information for the training container, including
|
736
|
+
# entrypoints and arguments.
|
680
737
|
#
|
681
|
-
# @option params [
|
682
|
-
#
|
683
|
-
#
|
684
|
-
# must provide a role that has read access to these tables.
|
738
|
+
# @option params [Types::InferenceContainerConfig] :inference_container_config
|
739
|
+
# Configuration information for the inference container that is used
|
740
|
+
# when you run an inference job on a configured model algorithm.
|
685
741
|
#
|
686
742
|
# @option params [Hash<String,String>] :tags
|
687
743
|
# The optional metadata that you apply to the resource to help you
|
@@ -715,450 +771,2063 @@ module Aws::CleanRoomsML
|
|
715
771
|
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
716
772
|
# against your tags per resource limit.
|
717
773
|
#
|
718
|
-
# @option params [String] :
|
719
|
-
# The
|
774
|
+
# @option params [String] :kms_key_arn
|
775
|
+
# The Amazon Resource Name (ARN) of the KMS key. This key is used to
|
776
|
+
# encrypt and decrypt customer-owned data in the configured ML model
|
777
|
+
# algorithm and associated data.
|
720
778
|
#
|
721
|
-
# @return [Types::
|
779
|
+
# @return [Types::CreateConfiguredModelAlgorithmResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
722
780
|
#
|
723
|
-
# * {Types::
|
781
|
+
# * {Types::CreateConfiguredModelAlgorithmResponse#configured_model_algorithm_arn #configured_model_algorithm_arn} => String
|
724
782
|
#
|
725
783
|
# @example Request syntax with placeholder values
|
726
784
|
#
|
727
|
-
# resp = client.
|
785
|
+
# resp = client.create_configured_model_algorithm({
|
728
786
|
# name: "NameString", # required
|
787
|
+
# description: "ResourceDescription",
|
729
788
|
# role_arn: "IamRoleArn", # required
|
730
|
-
#
|
731
|
-
#
|
732
|
-
#
|
733
|
-
#
|
734
|
-
#
|
735
|
-
#
|
736
|
-
#
|
737
|
-
#
|
738
|
-
# },
|
739
|
-
# ],
|
740
|
-
# data_source: { # required
|
741
|
-
# glue_data_source: { # required
|
742
|
-
# table_name: "GlueTableName", # required
|
743
|
-
# database_name: "GlueDatabaseName", # required
|
744
|
-
# catalog_id: "AccountId",
|
745
|
-
# },
|
746
|
-
# },
|
789
|
+
# training_container_config: {
|
790
|
+
# image_uri: "AlgorithmImage", # required
|
791
|
+
# entrypoint: ["ContainerEntrypointString"],
|
792
|
+
# arguments: ["ContainerArgument"],
|
793
|
+
# metric_definitions: [
|
794
|
+
# {
|
795
|
+
# name: "MetricName", # required
|
796
|
+
# regex: "MetricRegex", # required
|
747
797
|
# },
|
748
|
-
#
|
749
|
-
#
|
798
|
+
# ],
|
799
|
+
# },
|
800
|
+
# inference_container_config: {
|
801
|
+
# image_uri: "AlgorithmImage", # required
|
802
|
+
# },
|
750
803
|
# tags: {
|
751
804
|
# "TagKey" => "TagValue",
|
752
805
|
# },
|
753
|
-
#
|
806
|
+
# kms_key_arn: "KmsKeyArn",
|
754
807
|
# })
|
755
808
|
#
|
756
809
|
# @example Response structure
|
757
810
|
#
|
758
|
-
# resp.
|
811
|
+
# resp.configured_model_algorithm_arn #=> String
|
759
812
|
#
|
760
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/
|
813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredModelAlgorithm AWS API Documentation
|
761
814
|
#
|
762
|
-
# @overload
|
815
|
+
# @overload create_configured_model_algorithm(params = {})
|
763
816
|
# @param [Hash] params ({})
|
764
|
-
def
|
765
|
-
req = build_request(:
|
817
|
+
def create_configured_model_algorithm(params = {}, options = {})
|
818
|
+
req = build_request(:create_configured_model_algorithm, params)
|
766
819
|
req.send_request(options)
|
767
820
|
end
|
768
821
|
|
769
|
-
#
|
770
|
-
#
|
822
|
+
# Associates a configured model algorithm to a collaboration for use by
|
823
|
+
# any member of the collaboration.
|
771
824
|
#
|
772
|
-
# @option params [required, String] :
|
773
|
-
# The
|
774
|
-
#
|
825
|
+
# @option params [required, String] :membership_identifier
|
826
|
+
# The membership ID of the member who is associating this configured
|
827
|
+
# model algorithm.
|
775
828
|
#
|
776
|
-
# @
|
829
|
+
# @option params [required, String] :configured_model_algorithm_arn
|
830
|
+
# The Amazon Resource Name (ARN) of the configured model algorithm that
|
831
|
+
# you want to associate.
|
777
832
|
#
|
778
|
-
# @
|
833
|
+
# @option params [required, String] :name
|
834
|
+
# The name of the configured model algorithm association.
|
779
835
|
#
|
780
|
-
#
|
781
|
-
#
|
782
|
-
# })
|
836
|
+
# @option params [String] :description
|
837
|
+
# The description of the configured model algorithm association.
|
783
838
|
#
|
784
|
-
# @
|
839
|
+
# @option params [Types::PrivacyConfiguration] :privacy_configuration
|
840
|
+
# Specifies the privacy configuration information for the configured
|
841
|
+
# model algorithm association. This information includes the maximum
|
842
|
+
# data size that can be exported.
|
785
843
|
#
|
786
|
-
# @
|
787
|
-
#
|
788
|
-
|
789
|
-
|
790
|
-
req.send_request(options)
|
791
|
-
end
|
792
|
-
|
793
|
-
# Specifies an audience model that you want to delete. You can't delete
|
794
|
-
# an audience model if there are any configured audience models that
|
795
|
-
# depend on the audience model.
|
844
|
+
# @option params [Hash<String,String>] :tags
|
845
|
+
# The optional metadata that you apply to the resource to help you
|
846
|
+
# categorize and organize them. Each tag consists of a key and an
|
847
|
+
# optional value, both of which you define.
|
796
848
|
#
|
797
|
-
#
|
798
|
-
# The Amazon Resource Name (ARN) of the audience model that you want to
|
799
|
-
# delete.
|
849
|
+
# The following basic restrictions apply to tags:
|
800
850
|
#
|
801
|
-
#
|
851
|
+
# * Maximum number of tags per resource - 50.
|
802
852
|
#
|
803
|
-
#
|
853
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
854
|
+
# have only one value.
|
804
855
|
#
|
805
|
-
#
|
806
|
-
# audience_model_arn: "AudienceModelArn", # required
|
807
|
-
# })
|
856
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
808
857
|
#
|
809
|
-
#
|
858
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
810
859
|
#
|
811
|
-
#
|
812
|
-
#
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
end
|
817
|
-
|
818
|
-
# Deletes the specified configured audience model. You can't delete a
|
819
|
-
# configured audience model if there are any lookalike models that use
|
820
|
-
# the configured audience model. If you delete a configured audience
|
821
|
-
# model, it will be removed from any collaborations that it is
|
822
|
-
# associated to.
|
860
|
+
# * If your tagging schema is used across multiple services and
|
861
|
+
# resources, remember that other services may have restrictions on
|
862
|
+
# allowed characters. Generally allowed characters are: letters,
|
863
|
+
# numbers, and spaces representable in UTF-8, and the following
|
864
|
+
# characters: + - = . \_ : / @.
|
823
865
|
#
|
824
|
-
#
|
825
|
-
# The Amazon Resource Name (ARN) of the configured audience model that
|
826
|
-
# you want to delete.
|
866
|
+
# * Tag keys and values are case sensitive.
|
827
867
|
#
|
828
|
-
#
|
868
|
+
# * Do not use aws:, AWS:, or any upper or lowercase combination of such
|
869
|
+
# as a prefix for keys as it is reserved for AWS use. You cannot edit
|
870
|
+
# or delete tag keys with this prefix. Values can have this prefix. If
|
871
|
+
# a tag value has aws as its prefix but the key does not, then Clean
|
872
|
+
# Rooms ML considers it to be a user tag and will count against the
|
873
|
+
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
874
|
+
# against your tags per resource limit.
|
875
|
+
#
|
876
|
+
# @return [Types::CreateConfiguredModelAlgorithmAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
877
|
+
#
|
878
|
+
# * {Types::CreateConfiguredModelAlgorithmAssociationResponse#configured_model_algorithm_association_arn #configured_model_algorithm_association_arn} => String
|
829
879
|
#
|
830
880
|
# @example Request syntax with placeholder values
|
831
881
|
#
|
832
|
-
# resp = client.
|
833
|
-
#
|
882
|
+
# resp = client.create_configured_model_algorithm_association({
|
883
|
+
# membership_identifier: "UUID", # required
|
884
|
+
# configured_model_algorithm_arn: "ConfiguredModelAlgorithmArn", # required
|
885
|
+
# name: "NameString", # required
|
886
|
+
# description: "ResourceDescription",
|
887
|
+
# privacy_configuration: {
|
888
|
+
# policies: { # required
|
889
|
+
# trained_models: {
|
890
|
+
# container_logs: [
|
891
|
+
# {
|
892
|
+
# allowed_account_ids: ["String"], # required
|
893
|
+
# filter_pattern: "LogsConfigurationPolicyFilterPatternString",
|
894
|
+
# },
|
895
|
+
# ],
|
896
|
+
# container_metrics: {
|
897
|
+
# noise_level: "HIGH", # required, accepts HIGH, MEDIUM, LOW, NONE
|
898
|
+
# },
|
899
|
+
# },
|
900
|
+
# trained_model_exports: {
|
901
|
+
# max_size: { # required
|
902
|
+
# unit: "GB", # required, accepts GB
|
903
|
+
# value: 1.0, # required
|
904
|
+
# },
|
905
|
+
# files_to_export: ["MODEL"], # required, accepts MODEL, OUTPUT
|
906
|
+
# },
|
907
|
+
# trained_model_inference_jobs: {
|
908
|
+
# container_logs: [
|
909
|
+
# {
|
910
|
+
# allowed_account_ids: ["String"], # required
|
911
|
+
# filter_pattern: "LogsConfigurationPolicyFilterPatternString",
|
912
|
+
# },
|
913
|
+
# ],
|
914
|
+
# max_output_size: {
|
915
|
+
# unit: "GB", # required, accepts GB
|
916
|
+
# value: 1.0, # required
|
917
|
+
# },
|
918
|
+
# },
|
919
|
+
# },
|
920
|
+
# },
|
921
|
+
# tags: {
|
922
|
+
# "TagKey" => "TagValue",
|
923
|
+
# },
|
834
924
|
# })
|
835
925
|
#
|
836
|
-
# @
|
926
|
+
# @example Response structure
|
837
927
|
#
|
838
|
-
#
|
928
|
+
# resp.configured_model_algorithm_association_arn #=> String
|
929
|
+
#
|
930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredModelAlgorithmAssociation AWS API Documentation
|
931
|
+
#
|
932
|
+
# @overload create_configured_model_algorithm_association(params = {})
|
839
933
|
# @param [Hash] params ({})
|
840
|
-
def
|
841
|
-
req = build_request(:
|
934
|
+
def create_configured_model_algorithm_association(params = {}, options = {})
|
935
|
+
req = build_request(:create_configured_model_algorithm_association, params)
|
842
936
|
req.send_request(options)
|
843
937
|
end
|
844
938
|
|
845
|
-
#
|
939
|
+
# Provides the information to create an ML input channel. An ML input
|
940
|
+
# channel is the result of a query that can be used for ML modeling.
|
846
941
|
#
|
847
|
-
# @option params [required, String] :
|
848
|
-
# The
|
849
|
-
# that you want to delete.
|
942
|
+
# @option params [required, String] :membership_identifier
|
943
|
+
# The membership ID of the member that is creating the ML input channel.
|
850
944
|
#
|
851
|
-
# @
|
945
|
+
# @option params [required, Array<String>] :configured_model_algorithm_associations
|
946
|
+
# The associated configured model algorithms that are necessary to
|
947
|
+
# create this ML input channel.
|
852
948
|
#
|
853
|
-
# @
|
949
|
+
# @option params [required, Types::InputChannel] :input_channel
|
950
|
+
# The input data that is used to create this ML input channel.
|
854
951
|
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
# })
|
952
|
+
# @option params [required, String] :name
|
953
|
+
# The name of the ML input channel.
|
858
954
|
#
|
859
|
-
# @
|
955
|
+
# @option params [required, Integer] :retention_in_days
|
956
|
+
# The number of days that the data in the ML input channel is retained.
|
860
957
|
#
|
861
|
-
# @
|
862
|
-
#
|
863
|
-
def delete_configured_audience_model_policy(params = {}, options = {})
|
864
|
-
req = build_request(:delete_configured_audience_model_policy, params)
|
865
|
-
req.send_request(options)
|
866
|
-
end
|
867
|
-
|
868
|
-
# Specifies a training dataset that you want to delete. You can't
|
869
|
-
# delete a training dataset if there are any audience models that depend
|
870
|
-
# on the training dataset. In Clean Rooms ML, the `TrainingDataset` is
|
871
|
-
# metadata that points to a Glue table, which is read only during
|
872
|
-
# `AudienceModel` creation. This action deletes the metadata.
|
958
|
+
# @option params [String] :description
|
959
|
+
# The description of the ML input channel.
|
873
960
|
#
|
874
|
-
# @option params [
|
875
|
-
# The Amazon Resource Name (ARN) of the
|
876
|
-
#
|
961
|
+
# @option params [String] :kms_key_arn
|
962
|
+
# The Amazon Resource Name (ARN) of the KMS key that is used to access
|
963
|
+
# the input channel.
|
877
964
|
#
|
878
|
-
# @
|
965
|
+
# @option params [Hash<String,String>] :tags
|
966
|
+
# The optional metadata that you apply to the resource to help you
|
967
|
+
# categorize and organize them. Each tag consists of a key and an
|
968
|
+
# optional value, both of which you define.
|
879
969
|
#
|
880
|
-
#
|
970
|
+
# The following basic restrictions apply to tags:
|
881
971
|
#
|
882
|
-
#
|
883
|
-
# training_dataset_arn: "TrainingDatasetArn", # required
|
884
|
-
# })
|
972
|
+
# * Maximum number of tags per resource - 50.
|
885
973
|
#
|
886
|
-
#
|
974
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
975
|
+
# have only one value.
|
887
976
|
#
|
888
|
-
#
|
889
|
-
# @param [Hash] params ({})
|
890
|
-
def delete_training_dataset(params = {}, options = {})
|
891
|
-
req = build_request(:delete_training_dataset, params)
|
892
|
-
req.send_request(options)
|
893
|
-
end
|
894
|
-
|
895
|
-
# Returns information about an audience generation job.
|
977
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
896
978
|
#
|
897
|
-
#
|
898
|
-
# The Amazon Resource Name (ARN) of the audience generation job that you
|
899
|
-
# are interested in.
|
979
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
900
980
|
#
|
901
|
-
#
|
981
|
+
# * If your tagging schema is used across multiple services and
|
982
|
+
# resources, remember that other services may have restrictions on
|
983
|
+
# allowed characters. Generally allowed characters are: letters,
|
984
|
+
# numbers, and spaces representable in UTF-8, and the following
|
985
|
+
# characters: + - = . \_ : / @.
|
902
986
|
#
|
903
|
-
# *
|
904
|
-
#
|
905
|
-
# *
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
915
|
-
# * {Types::
|
916
|
-
#
|
917
|
-
#
|
987
|
+
# * Tag keys and values are case sensitive.
|
988
|
+
#
|
989
|
+
# * Do not use aws:, AWS:, or any upper or lowercase combination of such
|
990
|
+
# as a prefix for keys as it is reserved for AWS use. You cannot edit
|
991
|
+
# or delete tag keys with this prefix. Values can have this prefix. If
|
992
|
+
# a tag value has aws as its prefix but the key does not, then Clean
|
993
|
+
# Rooms ML considers it to be a user tag and will count against the
|
994
|
+
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
995
|
+
# against your tags per resource limit.
|
996
|
+
#
|
997
|
+
# @return [Types::CreateMLInputChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
998
|
+
#
|
999
|
+
# * {Types::CreateMLInputChannelResponse#ml_input_channel_arn #ml_input_channel_arn} => String
|
1000
|
+
#
|
1001
|
+
# @example Request syntax with placeholder values
|
1002
|
+
#
|
1003
|
+
# resp = client.create_ml_input_channel({
|
1004
|
+
# membership_identifier: "UUID", # required
|
1005
|
+
# configured_model_algorithm_associations: ["ConfiguredModelAlgorithmAssociationArn"], # required
|
1006
|
+
# input_channel: { # required
|
1007
|
+
# data_source: { # required
|
1008
|
+
# protected_query_input_parameters: {
|
1009
|
+
# sql_parameters: { # required
|
1010
|
+
# query_string: "ProtectedQuerySQLParametersQueryStringString",
|
1011
|
+
# analysis_template_arn: "AnalysisTemplateArn",
|
1012
|
+
# parameters: {
|
1013
|
+
# "ParameterKey" => "ParameterValue",
|
1014
|
+
# },
|
1015
|
+
# },
|
1016
|
+
# compute_configuration: {
|
1017
|
+
# worker: {
|
1018
|
+
# type: "CR.1X", # accepts CR.1X, CR.4X
|
1019
|
+
# number: 1,
|
1020
|
+
# },
|
1021
|
+
# },
|
1022
|
+
# },
|
1023
|
+
# },
|
1024
|
+
# role_arn: "IamRoleArn", # required
|
1025
|
+
# },
|
1026
|
+
# name: "NameString", # required
|
1027
|
+
# retention_in_days: 1, # required
|
1028
|
+
# description: "ResourceDescription",
|
1029
|
+
# kms_key_arn: "KmsKeyArn",
|
1030
|
+
# tags: {
|
1031
|
+
# "TagKey" => "TagValue",
|
1032
|
+
# },
|
1033
|
+
# })
|
1034
|
+
#
|
1035
|
+
# @example Response structure
|
1036
|
+
#
|
1037
|
+
# resp.ml_input_channel_arn #=> String
|
1038
|
+
#
|
1039
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateMLInputChannel AWS API Documentation
|
1040
|
+
#
|
1041
|
+
# @overload create_ml_input_channel(params = {})
|
1042
|
+
# @param [Hash] params ({})
|
1043
|
+
def create_ml_input_channel(params = {}, options = {})
|
1044
|
+
req = build_request(:create_ml_input_channel, params)
|
1045
|
+
req.send_request(options)
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
# Creates a trained model from an associated configured model algorithm
|
1049
|
+
# using data from any member of the collaboration.
|
1050
|
+
#
|
1051
|
+
# @option params [required, String] :membership_identifier
|
1052
|
+
# The membership ID of the member that is creating the trained model.
|
1053
|
+
#
|
1054
|
+
# @option params [required, String] :name
|
1055
|
+
# The name of the trained model.
|
1056
|
+
#
|
1057
|
+
# @option params [required, String] :configured_model_algorithm_association_arn
|
1058
|
+
# The associated configured model algorithm used to train this model.
|
1059
|
+
#
|
1060
|
+
# @option params [Hash<String,String>] :hyperparameters
|
1061
|
+
# Algorithm-specific parameters that influence the quality of the model.
|
1062
|
+
# You set hyperparameters before you start the learning process.
|
1063
|
+
#
|
1064
|
+
# @option params [Hash<String,String>] :environment
|
1065
|
+
# The environment variables to set in the Docker container.
|
1066
|
+
#
|
1067
|
+
# @option params [required, Types::ResourceConfig] :resource_config
|
1068
|
+
# Information about the EC2 resources that are used to train this model.
|
1069
|
+
#
|
1070
|
+
# @option params [Types::StoppingCondition] :stopping_condition
|
1071
|
+
# The criteria that is used to stop model training.
|
1072
|
+
#
|
1073
|
+
# @option params [required, Array<Types::ModelTrainingDataChannel>] :data_channels
|
1074
|
+
# Defines the data channels that are used as input for the trained model
|
1075
|
+
# request.
|
1076
|
+
#
|
1077
|
+
# @option params [String] :description
|
1078
|
+
# The description of the trained model.
|
1079
|
+
#
|
1080
|
+
# @option params [String] :kms_key_arn
|
1081
|
+
# The Amazon Resource Name (ARN) of the KMS key. This key is used to
|
1082
|
+
# encrypt and decrypt customer-owned data in the trained ML model and
|
1083
|
+
# the associated data.
|
1084
|
+
#
|
1085
|
+
# @option params [Hash<String,String>] :tags
|
1086
|
+
# The optional metadata that you apply to the resource to help you
|
1087
|
+
# categorize and organize them. Each tag consists of a key and an
|
1088
|
+
# optional value, both of which you define.
|
1089
|
+
#
|
1090
|
+
# The following basic restrictions apply to tags:
|
1091
|
+
#
|
1092
|
+
# * Maximum number of tags per resource - 50.
|
1093
|
+
#
|
1094
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
1095
|
+
# have only one value.
|
1096
|
+
#
|
1097
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
1098
|
+
#
|
1099
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
1100
|
+
#
|
1101
|
+
# * If your tagging schema is used across multiple services and
|
1102
|
+
# resources, remember that other services may have restrictions on
|
1103
|
+
# allowed characters. Generally allowed characters are: letters,
|
1104
|
+
# numbers, and spaces representable in UTF-8, and the following
|
1105
|
+
# characters: + - = . \_ : / @.
|
1106
|
+
#
|
1107
|
+
# * Tag keys and values are case sensitive.
|
1108
|
+
#
|
1109
|
+
# * Do not use aws:, AWS:, or any upper or lowercase combination of such
|
1110
|
+
# as a prefix for keys as it is reserved for AWS use. You cannot edit
|
1111
|
+
# or delete tag keys with this prefix. Values can have this prefix. If
|
1112
|
+
# a tag value has aws as its prefix but the key does not, then Clean
|
1113
|
+
# Rooms ML considers it to be a user tag and will count against the
|
1114
|
+
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
1115
|
+
# against your tags per resource limit.
|
1116
|
+
#
|
1117
|
+
# @return [Types::CreateTrainedModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1118
|
+
#
|
1119
|
+
# * {Types::CreateTrainedModelResponse#trained_model_arn #trained_model_arn} => String
|
1120
|
+
#
|
1121
|
+
# @example Request syntax with placeholder values
|
1122
|
+
#
|
1123
|
+
# resp = client.create_trained_model({
|
1124
|
+
# membership_identifier: "UUID", # required
|
1125
|
+
# name: "NameString", # required
|
1126
|
+
# configured_model_algorithm_association_arn: "ConfiguredModelAlgorithmAssociationArn", # required
|
1127
|
+
# hyperparameters: {
|
1128
|
+
# "HyperParametersKeyString" => "HyperParametersValueString",
|
1129
|
+
# },
|
1130
|
+
# environment: {
|
1131
|
+
# "EnvironmentKeyString" => "EnvironmentValueString",
|
1132
|
+
# },
|
1133
|
+
# resource_config: { # required
|
1134
|
+
# instance_count: 1,
|
1135
|
+
# instance_type: "ml.m4.xlarge", # required, accepts ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.p4d.24xlarge, ml.p4de.24xlarge, ml.p5.48xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5n.xlarge, ml.c5n.2xlarge, ml.c5n.4xlarge, ml.c5n.9xlarge, ml.c5n.18xlarge, ml.g5.xlarge, ml.g5.2xlarge, ml.g5.4xlarge, ml.g5.8xlarge, ml.g5.16xlarge, ml.g5.12xlarge, ml.g5.24xlarge, ml.g5.48xlarge, ml.trn1.2xlarge, ml.trn1.32xlarge, ml.trn1n.32xlarge, ml.m6i.large, ml.m6i.xlarge, ml.m6i.2xlarge, ml.m6i.4xlarge, ml.m6i.8xlarge, ml.m6i.12xlarge, ml.m6i.16xlarge, ml.m6i.24xlarge, ml.m6i.32xlarge, ml.c6i.xlarge, ml.c6i.2xlarge, ml.c6i.8xlarge, ml.c6i.4xlarge, ml.c6i.12xlarge, ml.c6i.16xlarge, ml.c6i.24xlarge, ml.c6i.32xlarge, ml.r5d.large, ml.r5d.xlarge, ml.r5d.2xlarge, ml.r5d.4xlarge, ml.r5d.8xlarge, ml.r5d.12xlarge, ml.r5d.16xlarge, ml.r5d.24xlarge, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge
|
1136
|
+
# volume_size_in_gb: 1, # required
|
1137
|
+
# },
|
1138
|
+
# stopping_condition: {
|
1139
|
+
# max_runtime_in_seconds: 1,
|
1140
|
+
# },
|
1141
|
+
# data_channels: [ # required
|
1142
|
+
# {
|
1143
|
+
# ml_input_channel_arn: "MLInputChannelArn", # required
|
1144
|
+
# channel_name: "ModelTrainingDataChannelName", # required
|
1145
|
+
# },
|
1146
|
+
# ],
|
1147
|
+
# description: "ResourceDescription",
|
1148
|
+
# kms_key_arn: "KmsKeyArn",
|
1149
|
+
# tags: {
|
1150
|
+
# "TagKey" => "TagValue",
|
1151
|
+
# },
|
1152
|
+
# })
|
1153
|
+
#
|
1154
|
+
# @example Response structure
|
1155
|
+
#
|
1156
|
+
# resp.trained_model_arn #=> String
|
1157
|
+
#
|
1158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainedModel AWS API Documentation
|
1159
|
+
#
|
1160
|
+
# @overload create_trained_model(params = {})
|
1161
|
+
# @param [Hash] params ({})
|
1162
|
+
def create_trained_model(params = {}, options = {})
|
1163
|
+
req = build_request(:create_trained_model, params)
|
1164
|
+
req.send_request(options)
|
1165
|
+
end
|
1166
|
+
|
1167
|
+
# Defines the information necessary to create a training dataset. In
|
1168
|
+
# Clean Rooms ML, the `TrainingDataset` is metadata that points to a
|
1169
|
+
# Glue table, which is read only during `AudienceModel` creation.
|
1170
|
+
#
|
1171
|
+
# @option params [required, String] :name
|
1172
|
+
# The name of the training dataset. This name must be unique in your
|
1173
|
+
# account and region.
|
1174
|
+
#
|
1175
|
+
# @option params [required, String] :role_arn
|
1176
|
+
# The ARN of the IAM role that Clean Rooms ML can assume to read the
|
1177
|
+
# data referred to in the `dataSource` field of each dataset.
|
1178
|
+
#
|
1179
|
+
# Passing a role across AWS accounts is not allowed. If you pass a role
|
1180
|
+
# that isn't in your account, you get an `AccessDeniedException` error.
|
1181
|
+
#
|
1182
|
+
# @option params [required, Array<Types::Dataset>] :training_data
|
1183
|
+
# An array of information that lists the Dataset objects, which
|
1184
|
+
# specifies the dataset type and details on its location and schema. You
|
1185
|
+
# must provide a role that has read access to these tables.
|
1186
|
+
#
|
1187
|
+
# @option params [Hash<String,String>] :tags
|
1188
|
+
# The optional metadata that you apply to the resource to help you
|
1189
|
+
# categorize and organize them. Each tag consists of a key and an
|
1190
|
+
# optional value, both of which you define.
|
1191
|
+
#
|
1192
|
+
# The following basic restrictions apply to tags:
|
1193
|
+
#
|
1194
|
+
# * Maximum number of tags per resource - 50.
|
1195
|
+
#
|
1196
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
1197
|
+
# have only one value.
|
1198
|
+
#
|
1199
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
1200
|
+
#
|
1201
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
1202
|
+
#
|
1203
|
+
# * If your tagging schema is used across multiple services and
|
1204
|
+
# resources, remember that other services may have restrictions on
|
1205
|
+
# allowed characters. Generally allowed characters are: letters,
|
1206
|
+
# numbers, and spaces representable in UTF-8, and the following
|
1207
|
+
# characters: + - = . \_ : / @.
|
1208
|
+
#
|
1209
|
+
# * Tag keys and values are case sensitive.
|
1210
|
+
#
|
1211
|
+
# * Do not use aws:, AWS:, or any upper or lowercase combination of such
|
1212
|
+
# as a prefix for keys as it is reserved for AWS use. You cannot edit
|
1213
|
+
# or delete tag keys with this prefix. Values can have this prefix. If
|
1214
|
+
# a tag value has aws as its prefix but the key does not, then Clean
|
1215
|
+
# Rooms ML considers it to be a user tag and will count against the
|
1216
|
+
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
1217
|
+
# against your tags per resource limit.
|
1218
|
+
#
|
1219
|
+
# @option params [String] :description
|
1220
|
+
# The description of the training dataset.
|
1221
|
+
#
|
1222
|
+
# @return [Types::CreateTrainingDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1223
|
+
#
|
1224
|
+
# * {Types::CreateTrainingDatasetResponse#training_dataset_arn #training_dataset_arn} => String
|
1225
|
+
#
|
1226
|
+
# @example Request syntax with placeholder values
|
1227
|
+
#
|
1228
|
+
# resp = client.create_training_dataset({
|
1229
|
+
# name: "NameString", # required
|
1230
|
+
# role_arn: "IamRoleArn", # required
|
1231
|
+
# training_data: [ # required
|
1232
|
+
# {
|
1233
|
+
# type: "INTERACTIONS", # required, accepts INTERACTIONS
|
1234
|
+
# input_config: { # required
|
1235
|
+
# schema: [ # required
|
1236
|
+
# {
|
1237
|
+
# column_name: "ColumnName", # required
|
1238
|
+
# column_types: ["USER_ID"], # required, accepts USER_ID, ITEM_ID, TIMESTAMP, CATEGORICAL_FEATURE, NUMERICAL_FEATURE
|
1239
|
+
# },
|
1240
|
+
# ],
|
1241
|
+
# data_source: { # required
|
1242
|
+
# glue_data_source: { # required
|
1243
|
+
# table_name: "GlueTableName", # required
|
1244
|
+
# database_name: "GlueDatabaseName", # required
|
1245
|
+
# catalog_id: "AccountId",
|
1246
|
+
# },
|
1247
|
+
# },
|
1248
|
+
# },
|
1249
|
+
# },
|
1250
|
+
# ],
|
1251
|
+
# tags: {
|
1252
|
+
# "TagKey" => "TagValue",
|
1253
|
+
# },
|
1254
|
+
# description: "ResourceDescription",
|
1255
|
+
# })
|
1256
|
+
#
|
1257
|
+
# @example Response structure
|
1258
|
+
#
|
1259
|
+
# resp.training_dataset_arn #=> String
|
1260
|
+
#
|
1261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainingDataset AWS API Documentation
|
1262
|
+
#
|
1263
|
+
# @overload create_training_dataset(params = {})
|
1264
|
+
# @param [Hash] params ({})
|
1265
|
+
def create_training_dataset(params = {}, options = {})
|
1266
|
+
req = build_request(:create_training_dataset, params)
|
1267
|
+
req.send_request(options)
|
1268
|
+
end
|
1269
|
+
|
1270
|
+
# Deletes the specified audience generation job, and removes all data
|
1271
|
+
# associated with the job.
|
1272
|
+
#
|
1273
|
+
# @option params [required, String] :audience_generation_job_arn
|
1274
|
+
# The Amazon Resource Name (ARN) of the audience generation job that you
|
1275
|
+
# want to delete.
|
1276
|
+
#
|
1277
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1278
|
+
#
|
1279
|
+
# @example Request syntax with placeholder values
|
1280
|
+
#
|
1281
|
+
# resp = client.delete_audience_generation_job({
|
1282
|
+
# audience_generation_job_arn: "AudienceGenerationJobArn", # required
|
1283
|
+
# })
|
1284
|
+
#
|
1285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceGenerationJob AWS API Documentation
|
1286
|
+
#
|
1287
|
+
# @overload delete_audience_generation_job(params = {})
|
1288
|
+
# @param [Hash] params ({})
|
1289
|
+
def delete_audience_generation_job(params = {}, options = {})
|
1290
|
+
req = build_request(:delete_audience_generation_job, params)
|
1291
|
+
req.send_request(options)
|
1292
|
+
end
|
1293
|
+
|
1294
|
+
# Specifies an audience model that you want to delete. You can't delete
|
1295
|
+
# an audience model if there are any configured audience models that
|
1296
|
+
# depend on the audience model.
|
1297
|
+
#
|
1298
|
+
# @option params [required, String] :audience_model_arn
|
1299
|
+
# The Amazon Resource Name (ARN) of the audience model that you want to
|
1300
|
+
# delete.
|
1301
|
+
#
|
1302
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1303
|
+
#
|
1304
|
+
# @example Request syntax with placeholder values
|
1305
|
+
#
|
1306
|
+
# resp = client.delete_audience_model({
|
1307
|
+
# audience_model_arn: "AudienceModelArn", # required
|
1308
|
+
# })
|
1309
|
+
#
|
1310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceModel AWS API Documentation
|
1311
|
+
#
|
1312
|
+
# @overload delete_audience_model(params = {})
|
1313
|
+
# @param [Hash] params ({})
|
1314
|
+
def delete_audience_model(params = {}, options = {})
|
1315
|
+
req = build_request(:delete_audience_model, params)
|
1316
|
+
req.send_request(options)
|
1317
|
+
end
|
1318
|
+
|
1319
|
+
# Deletes the specified configured audience model. You can't delete a
|
1320
|
+
# configured audience model if there are any lookalike models that use
|
1321
|
+
# the configured audience model. If you delete a configured audience
|
1322
|
+
# model, it will be removed from any collaborations that it is
|
1323
|
+
# associated to.
|
1324
|
+
#
|
1325
|
+
# @option params [required, String] :configured_audience_model_arn
|
1326
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
1327
|
+
# you want to delete.
|
1328
|
+
#
|
1329
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1330
|
+
#
|
1331
|
+
# @example Request syntax with placeholder values
|
1332
|
+
#
|
1333
|
+
# resp = client.delete_configured_audience_model({
|
1334
|
+
# configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
|
1335
|
+
# })
|
1336
|
+
#
|
1337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModel AWS API Documentation
|
1338
|
+
#
|
1339
|
+
# @overload delete_configured_audience_model(params = {})
|
1340
|
+
# @param [Hash] params ({})
|
1341
|
+
def delete_configured_audience_model(params = {}, options = {})
|
1342
|
+
req = build_request(:delete_configured_audience_model, params)
|
1343
|
+
req.send_request(options)
|
1344
|
+
end
|
1345
|
+
|
1346
|
+
# Deletes the specified configured audience model policy.
|
1347
|
+
#
|
1348
|
+
# @option params [required, String] :configured_audience_model_arn
|
1349
|
+
# The Amazon Resource Name (ARN) of the configured audience model policy
|
1350
|
+
# that you want to delete.
|
1351
|
+
#
|
1352
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1353
|
+
#
|
1354
|
+
# @example Request syntax with placeholder values
|
1355
|
+
#
|
1356
|
+
# resp = client.delete_configured_audience_model_policy({
|
1357
|
+
# configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
|
1358
|
+
# })
|
1359
|
+
#
|
1360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModelPolicy AWS API Documentation
|
1361
|
+
#
|
1362
|
+
# @overload delete_configured_audience_model_policy(params = {})
|
1363
|
+
# @param [Hash] params ({})
|
1364
|
+
def delete_configured_audience_model_policy(params = {}, options = {})
|
1365
|
+
req = build_request(:delete_configured_audience_model_policy, params)
|
1366
|
+
req.send_request(options)
|
1367
|
+
end
|
1368
|
+
|
1369
|
+
# Deletes a configured model algorithm.
|
1370
|
+
#
|
1371
|
+
# @option params [required, String] :configured_model_algorithm_arn
|
1372
|
+
# The Amazon Resource Name (ARN) of the configured model algorithm that
|
1373
|
+
# you want to delete.
|
1374
|
+
#
|
1375
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1376
|
+
#
|
1377
|
+
# @example Request syntax with placeholder values
|
1378
|
+
#
|
1379
|
+
# resp = client.delete_configured_model_algorithm({
|
1380
|
+
# configured_model_algorithm_arn: "ConfiguredModelAlgorithmArn", # required
|
1381
|
+
# })
|
1382
|
+
#
|
1383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredModelAlgorithm AWS API Documentation
|
1384
|
+
#
|
1385
|
+
# @overload delete_configured_model_algorithm(params = {})
|
1386
|
+
# @param [Hash] params ({})
|
1387
|
+
def delete_configured_model_algorithm(params = {}, options = {})
|
1388
|
+
req = build_request(:delete_configured_model_algorithm, params)
|
1389
|
+
req.send_request(options)
|
1390
|
+
end
|
1391
|
+
|
1392
|
+
# Deletes a configured model algorithm association.
|
1393
|
+
#
|
1394
|
+
# @option params [required, String] :configured_model_algorithm_association_arn
|
1395
|
+
# The Amazon Resource Name (ARN) of the configured model algorithm
|
1396
|
+
# association that you want to delete.
|
1397
|
+
#
|
1398
|
+
# @option params [required, String] :membership_identifier
|
1399
|
+
# The membership ID of the member that is deleting the configured model
|
1400
|
+
# algorithm association.
|
1401
|
+
#
|
1402
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1403
|
+
#
|
1404
|
+
# @example Request syntax with placeholder values
|
1405
|
+
#
|
1406
|
+
# resp = client.delete_configured_model_algorithm_association({
|
1407
|
+
# configured_model_algorithm_association_arn: "ConfiguredModelAlgorithmAssociationArn", # required
|
1408
|
+
# membership_identifier: "UUID", # required
|
1409
|
+
# })
|
1410
|
+
#
|
1411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredModelAlgorithmAssociation AWS API Documentation
|
1412
|
+
#
|
1413
|
+
# @overload delete_configured_model_algorithm_association(params = {})
|
1414
|
+
# @param [Hash] params ({})
|
1415
|
+
def delete_configured_model_algorithm_association(params = {}, options = {})
|
1416
|
+
req = build_request(:delete_configured_model_algorithm_association, params)
|
1417
|
+
req.send_request(options)
|
1418
|
+
end
|
1419
|
+
|
1420
|
+
# Deletes a ML modeling configuration.
|
1421
|
+
#
|
1422
|
+
# @option params [required, String] :membership_identifier
|
1423
|
+
# The membership ID of the of the member that is deleting the ML
|
1424
|
+
# modeling configuration.
|
1425
|
+
#
|
1426
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1427
|
+
#
|
1428
|
+
# @example Request syntax with placeholder values
|
1429
|
+
#
|
1430
|
+
# resp = client.delete_ml_configuration({
|
1431
|
+
# membership_identifier: "UUID", # required
|
1432
|
+
# })
|
1433
|
+
#
|
1434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteMLConfiguration AWS API Documentation
|
1435
|
+
#
|
1436
|
+
# @overload delete_ml_configuration(params = {})
|
1437
|
+
# @param [Hash] params ({})
|
1438
|
+
def delete_ml_configuration(params = {}, options = {})
|
1439
|
+
req = build_request(:delete_ml_configuration, params)
|
1440
|
+
req.send_request(options)
|
1441
|
+
end
|
1442
|
+
|
1443
|
+
# Provides the information necessary to delete an ML input channel.
|
1444
|
+
#
|
1445
|
+
# @option params [required, String] :ml_input_channel_arn
|
1446
|
+
# The Amazon Resource Name (ARN) of the ML input channel that you want
|
1447
|
+
# to delete.
|
1448
|
+
#
|
1449
|
+
# @option params [required, String] :membership_identifier
|
1450
|
+
# The membership ID of the membership that contains the ML input channel
|
1451
|
+
# you want to delete.
|
1452
|
+
#
|
1453
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1454
|
+
#
|
1455
|
+
# @example Request syntax with placeholder values
|
1456
|
+
#
|
1457
|
+
# resp = client.delete_ml_input_channel_data({
|
1458
|
+
# ml_input_channel_arn: "MLInputChannelArn", # required
|
1459
|
+
# membership_identifier: "UUID", # required
|
1460
|
+
# })
|
1461
|
+
#
|
1462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteMLInputChannelData AWS API Documentation
|
1463
|
+
#
|
1464
|
+
# @overload delete_ml_input_channel_data(params = {})
|
1465
|
+
# @param [Hash] params ({})
|
1466
|
+
def delete_ml_input_channel_data(params = {}, options = {})
|
1467
|
+
req = build_request(:delete_ml_input_channel_data, params)
|
1468
|
+
req.send_request(options)
|
1469
|
+
end
|
1470
|
+
|
1471
|
+
# Deletes the output of a trained model.
|
1472
|
+
#
|
1473
|
+
# @option params [required, String] :trained_model_arn
|
1474
|
+
# The Amazon Resource Name (ARN) of the trained model whose output you
|
1475
|
+
# want to delete.
|
1476
|
+
#
|
1477
|
+
# @option params [required, String] :membership_identifier
|
1478
|
+
# The membership ID of the member that is deleting the trained model
|
1479
|
+
# output.
|
1480
|
+
#
|
1481
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1482
|
+
#
|
1483
|
+
# @example Request syntax with placeholder values
|
1484
|
+
#
|
1485
|
+
# resp = client.delete_trained_model_output({
|
1486
|
+
# trained_model_arn: "TrainedModelArn", # required
|
1487
|
+
# membership_identifier: "UUID", # required
|
1488
|
+
# })
|
1489
|
+
#
|
1490
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteTrainedModelOutput AWS API Documentation
|
1491
|
+
#
|
1492
|
+
# @overload delete_trained_model_output(params = {})
|
1493
|
+
# @param [Hash] params ({})
|
1494
|
+
def delete_trained_model_output(params = {}, options = {})
|
1495
|
+
req = build_request(:delete_trained_model_output, params)
|
1496
|
+
req.send_request(options)
|
1497
|
+
end
|
1498
|
+
|
1499
|
+
# Specifies a training dataset that you want to delete. You can't
|
1500
|
+
# delete a training dataset if there are any audience models that depend
|
1501
|
+
# on the training dataset. In Clean Rooms ML, the `TrainingDataset` is
|
1502
|
+
# metadata that points to a Glue table, which is read only during
|
1503
|
+
# `AudienceModel` creation. This action deletes the metadata.
|
1504
|
+
#
|
1505
|
+
# @option params [required, String] :training_dataset_arn
|
1506
|
+
# The Amazon Resource Name (ARN) of the training dataset that you want
|
1507
|
+
# to delete.
|
1508
|
+
#
|
1509
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1510
|
+
#
|
1511
|
+
# @example Request syntax with placeholder values
|
1512
|
+
#
|
1513
|
+
# resp = client.delete_training_dataset({
|
1514
|
+
# training_dataset_arn: "TrainingDatasetArn", # required
|
1515
|
+
# })
|
1516
|
+
#
|
1517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteTrainingDataset AWS API Documentation
|
1518
|
+
#
|
1519
|
+
# @overload delete_training_dataset(params = {})
|
1520
|
+
# @param [Hash] params ({})
|
1521
|
+
def delete_training_dataset(params = {}, options = {})
|
1522
|
+
req = build_request(:delete_training_dataset, params)
|
1523
|
+
req.send_request(options)
|
1524
|
+
end
|
1525
|
+
|
1526
|
+
# Returns information about an audience generation job.
|
1527
|
+
#
|
1528
|
+
# @option params [required, String] :audience_generation_job_arn
|
1529
|
+
# The Amazon Resource Name (ARN) of the audience generation job that you
|
1530
|
+
# are interested in.
|
1531
|
+
#
|
1532
|
+
# @return [Types::GetAudienceGenerationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1533
|
+
#
|
1534
|
+
# * {Types::GetAudienceGenerationJobResponse#create_time #create_time} => Time
|
1535
|
+
# * {Types::GetAudienceGenerationJobResponse#update_time #update_time} => Time
|
1536
|
+
# * {Types::GetAudienceGenerationJobResponse#audience_generation_job_arn #audience_generation_job_arn} => String
|
1537
|
+
# * {Types::GetAudienceGenerationJobResponse#name #name} => String
|
1538
|
+
# * {Types::GetAudienceGenerationJobResponse#description #description} => String
|
1539
|
+
# * {Types::GetAudienceGenerationJobResponse#status #status} => String
|
1540
|
+
# * {Types::GetAudienceGenerationJobResponse#status_details #status_details} => Types::StatusDetails
|
1541
|
+
# * {Types::GetAudienceGenerationJobResponse#configured_audience_model_arn #configured_audience_model_arn} => String
|
1542
|
+
# * {Types::GetAudienceGenerationJobResponse#seed_audience #seed_audience} => Types::AudienceGenerationJobDataSource
|
1543
|
+
# * {Types::GetAudienceGenerationJobResponse#include_seed_in_output #include_seed_in_output} => Boolean
|
1544
|
+
# * {Types::GetAudienceGenerationJobResponse#collaboration_id #collaboration_id} => String
|
1545
|
+
# * {Types::GetAudienceGenerationJobResponse#metrics #metrics} => Types::AudienceQualityMetrics
|
1546
|
+
# * {Types::GetAudienceGenerationJobResponse#started_by #started_by} => String
|
1547
|
+
# * {Types::GetAudienceGenerationJobResponse#tags #tags} => Hash<String,String>
|
1548
|
+
# * {Types::GetAudienceGenerationJobResponse#protected_query_identifier #protected_query_identifier} => String
|
1549
|
+
#
|
1550
|
+
# @example Request syntax with placeholder values
|
1551
|
+
#
|
1552
|
+
# resp = client.get_audience_generation_job({
|
1553
|
+
# audience_generation_job_arn: "AudienceGenerationJobArn", # required
|
1554
|
+
# })
|
1555
|
+
#
|
1556
|
+
# @example Response structure
|
1557
|
+
#
|
1558
|
+
# resp.create_time #=> Time
|
1559
|
+
# resp.update_time #=> Time
|
1560
|
+
# resp.audience_generation_job_arn #=> String
|
1561
|
+
# resp.name #=> String
|
1562
|
+
# resp.description #=> String
|
1563
|
+
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
1564
|
+
# resp.status_details.status_code #=> String
|
1565
|
+
# resp.status_details.message #=> String
|
1566
|
+
# resp.configured_audience_model_arn #=> String
|
1567
|
+
# resp.seed_audience.data_source.s3_uri #=> String
|
1568
|
+
# resp.seed_audience.role_arn #=> String
|
1569
|
+
# resp.seed_audience.sql_parameters.query_string #=> String
|
1570
|
+
# resp.seed_audience.sql_parameters.analysis_template_arn #=> String
|
1571
|
+
# resp.seed_audience.sql_parameters.parameters #=> Hash
|
1572
|
+
# resp.seed_audience.sql_parameters.parameters["ParameterKey"] #=> String
|
1573
|
+
# resp.include_seed_in_output #=> Boolean
|
1574
|
+
# resp.collaboration_id #=> String
|
1575
|
+
# resp.metrics.relevance_metrics #=> Array
|
1576
|
+
# resp.metrics.relevance_metrics[0].audience_size.type #=> String, one of "ABSOLUTE", "PERCENTAGE"
|
1577
|
+
# resp.metrics.relevance_metrics[0].audience_size.value #=> Integer
|
1578
|
+
# resp.metrics.relevance_metrics[0].score #=> Float
|
1579
|
+
# resp.metrics.recall_metric #=> Float
|
1580
|
+
# resp.started_by #=> String
|
1581
|
+
# resp.tags #=> Hash
|
1582
|
+
# resp.tags["TagKey"] #=> String
|
1583
|
+
# resp.protected_query_identifier #=> String
|
1584
|
+
#
|
1585
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJob AWS API Documentation
|
1586
|
+
#
|
1587
|
+
# @overload get_audience_generation_job(params = {})
|
1588
|
+
# @param [Hash] params ({})
|
1589
|
+
def get_audience_generation_job(params = {}, options = {})
|
1590
|
+
req = build_request(:get_audience_generation_job, params)
|
1591
|
+
req.send_request(options)
|
1592
|
+
end
|
1593
|
+
|
1594
|
+
# Returns information about an audience model
|
1595
|
+
#
|
1596
|
+
# @option params [required, String] :audience_model_arn
|
1597
|
+
# The Amazon Resource Name (ARN) of the audience model that you are
|
1598
|
+
# interested in.
|
1599
|
+
#
|
1600
|
+
# @return [Types::GetAudienceModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1601
|
+
#
|
1602
|
+
# * {Types::GetAudienceModelResponse#create_time #create_time} => Time
|
1603
|
+
# * {Types::GetAudienceModelResponse#update_time #update_time} => Time
|
1604
|
+
# * {Types::GetAudienceModelResponse#training_data_start_time #training_data_start_time} => Time
|
1605
|
+
# * {Types::GetAudienceModelResponse#training_data_end_time #training_data_end_time} => Time
|
1606
|
+
# * {Types::GetAudienceModelResponse#audience_model_arn #audience_model_arn} => String
|
1607
|
+
# * {Types::GetAudienceModelResponse#name #name} => String
|
1608
|
+
# * {Types::GetAudienceModelResponse#training_dataset_arn #training_dataset_arn} => String
|
1609
|
+
# * {Types::GetAudienceModelResponse#status #status} => String
|
1610
|
+
# * {Types::GetAudienceModelResponse#status_details #status_details} => Types::StatusDetails
|
1611
|
+
# * {Types::GetAudienceModelResponse#kms_key_arn #kms_key_arn} => String
|
1612
|
+
# * {Types::GetAudienceModelResponse#tags #tags} => Hash<String,String>
|
1613
|
+
# * {Types::GetAudienceModelResponse#description #description} => String
|
1614
|
+
#
|
1615
|
+
# @example Request syntax with placeholder values
|
1616
|
+
#
|
1617
|
+
# resp = client.get_audience_model({
|
1618
|
+
# audience_model_arn: "AudienceModelArn", # required
|
1619
|
+
# })
|
1620
|
+
#
|
1621
|
+
# @example Response structure
|
1622
|
+
#
|
1623
|
+
# resp.create_time #=> Time
|
1624
|
+
# resp.update_time #=> Time
|
1625
|
+
# resp.training_data_start_time #=> Time
|
1626
|
+
# resp.training_data_end_time #=> Time
|
1627
|
+
# resp.audience_model_arn #=> String
|
1628
|
+
# resp.name #=> String
|
1629
|
+
# resp.training_dataset_arn #=> String
|
1630
|
+
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
1631
|
+
# resp.status_details.status_code #=> String
|
1632
|
+
# resp.status_details.message #=> String
|
1633
|
+
# resp.kms_key_arn #=> String
|
1634
|
+
# resp.tags #=> Hash
|
1635
|
+
# resp.tags["TagKey"] #=> String
|
1636
|
+
# resp.description #=> String
|
1637
|
+
#
|
1638
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModel AWS API Documentation
|
1639
|
+
#
|
1640
|
+
# @overload get_audience_model(params = {})
|
1641
|
+
# @param [Hash] params ({})
|
1642
|
+
def get_audience_model(params = {}, options = {})
|
1643
|
+
req = build_request(:get_audience_model, params)
|
1644
|
+
req.send_request(options)
|
1645
|
+
end
|
1646
|
+
|
1647
|
+
# Returns information about the configured model algorithm association
|
1648
|
+
# in a collaboration.
|
1649
|
+
#
|
1650
|
+
# @option params [required, String] :configured_model_algorithm_association_arn
|
1651
|
+
# The Amazon Resource Name (ARN) of the configured model algorithm
|
1652
|
+
# association that you want to return information about.
|
1653
|
+
#
|
1654
|
+
# @option params [required, String] :collaboration_identifier
|
1655
|
+
# The collaboration ID for the collaboration that contains the
|
1656
|
+
# configured model algorithm association that you want to return
|
1657
|
+
# information about.
|
1658
|
+
#
|
1659
|
+
# @return [Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1660
|
+
#
|
1661
|
+
# * {Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse#create_time #create_time} => Time
|
1662
|
+
# * {Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse#update_time #update_time} => Time
|
1663
|
+
# * {Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse#configured_model_algorithm_association_arn #configured_model_algorithm_association_arn} => String
|
1664
|
+
# * {Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse#membership_identifier #membership_identifier} => String
|
1665
|
+
# * {Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse#collaboration_identifier #collaboration_identifier} => String
|
1666
|
+
# * {Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse#configured_model_algorithm_arn #configured_model_algorithm_arn} => String
|
1667
|
+
# * {Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse#name #name} => String
|
1668
|
+
# * {Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse#description #description} => String
|
1669
|
+
# * {Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse#creator_account_id #creator_account_id} => String
|
1670
|
+
# * {Types::GetCollaborationConfiguredModelAlgorithmAssociationResponse#privacy_configuration #privacy_configuration} => Types::PrivacyConfiguration
|
1671
|
+
#
|
1672
|
+
# @example Request syntax with placeholder values
|
1673
|
+
#
|
1674
|
+
# resp = client.get_collaboration_configured_model_algorithm_association({
|
1675
|
+
# configured_model_algorithm_association_arn: "ConfiguredModelAlgorithmAssociationArn", # required
|
1676
|
+
# collaboration_identifier: "UUID", # required
|
1677
|
+
# })
|
1678
|
+
#
|
1679
|
+
# @example Response structure
|
1680
|
+
#
|
1681
|
+
# resp.create_time #=> Time
|
1682
|
+
# resp.update_time #=> Time
|
1683
|
+
# resp.configured_model_algorithm_association_arn #=> String
|
1684
|
+
# resp.membership_identifier #=> String
|
1685
|
+
# resp.collaboration_identifier #=> String
|
1686
|
+
# resp.configured_model_algorithm_arn #=> String
|
1687
|
+
# resp.name #=> String
|
1688
|
+
# resp.description #=> String
|
1689
|
+
# resp.creator_account_id #=> String
|
1690
|
+
# resp.privacy_configuration.policies.trained_models.container_logs #=> Array
|
1691
|
+
# resp.privacy_configuration.policies.trained_models.container_logs[0].allowed_account_ids #=> Array
|
1692
|
+
# resp.privacy_configuration.policies.trained_models.container_logs[0].allowed_account_ids[0] #=> String
|
1693
|
+
# resp.privacy_configuration.policies.trained_models.container_logs[0].filter_pattern #=> String
|
1694
|
+
# resp.privacy_configuration.policies.trained_models.container_metrics.noise_level #=> String, one of "HIGH", "MEDIUM", "LOW", "NONE"
|
1695
|
+
# resp.privacy_configuration.policies.trained_model_exports.max_size.unit #=> String, one of "GB"
|
1696
|
+
# resp.privacy_configuration.policies.trained_model_exports.max_size.value #=> Float
|
1697
|
+
# resp.privacy_configuration.policies.trained_model_exports.files_to_export #=> Array
|
1698
|
+
# resp.privacy_configuration.policies.trained_model_exports.files_to_export[0] #=> String, one of "MODEL", "OUTPUT"
|
1699
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.container_logs #=> Array
|
1700
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.container_logs[0].allowed_account_ids #=> Array
|
1701
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.container_logs[0].allowed_account_ids[0] #=> String
|
1702
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.container_logs[0].filter_pattern #=> String
|
1703
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.max_output_size.unit #=> String, one of "GB"
|
1704
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.max_output_size.value #=> Float
|
1705
|
+
#
|
1706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetCollaborationConfiguredModelAlgorithmAssociation AWS API Documentation
|
1707
|
+
#
|
1708
|
+
# @overload get_collaboration_configured_model_algorithm_association(params = {})
|
1709
|
+
# @param [Hash] params ({})
|
1710
|
+
def get_collaboration_configured_model_algorithm_association(params = {}, options = {})
|
1711
|
+
req = build_request(:get_collaboration_configured_model_algorithm_association, params)
|
1712
|
+
req.send_request(options)
|
1713
|
+
end
|
1714
|
+
|
1715
|
+
# Returns information about a specific ML input channel in a
|
1716
|
+
# collaboration.
|
1717
|
+
#
|
1718
|
+
# @option params [required, String] :ml_input_channel_arn
|
1719
|
+
# The Amazon Resource Name (ARN) of the ML input channel that you want
|
1720
|
+
# to get.
|
1721
|
+
#
|
1722
|
+
# @option params [required, String] :collaboration_identifier
|
1723
|
+
# The collaboration ID of the collaboration that contains the ML input
|
1724
|
+
# channel that you want to get.
|
1725
|
+
#
|
1726
|
+
# @return [Types::GetCollaborationMLInputChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1727
|
+
#
|
1728
|
+
# * {Types::GetCollaborationMLInputChannelResponse#create_time #create_time} => Time
|
1729
|
+
# * {Types::GetCollaborationMLInputChannelResponse#update_time #update_time} => Time
|
1730
|
+
# * {Types::GetCollaborationMLInputChannelResponse#creator_account_id #creator_account_id} => String
|
1731
|
+
# * {Types::GetCollaborationMLInputChannelResponse#membership_identifier #membership_identifier} => String
|
1732
|
+
# * {Types::GetCollaborationMLInputChannelResponse#collaboration_identifier #collaboration_identifier} => String
|
1733
|
+
# * {Types::GetCollaborationMLInputChannelResponse#ml_input_channel_arn #ml_input_channel_arn} => String
|
1734
|
+
# * {Types::GetCollaborationMLInputChannelResponse#name #name} => String
|
1735
|
+
# * {Types::GetCollaborationMLInputChannelResponse#configured_model_algorithm_associations #configured_model_algorithm_associations} => Array<String>
|
1736
|
+
# * {Types::GetCollaborationMLInputChannelResponse#status #status} => String
|
1737
|
+
# * {Types::GetCollaborationMLInputChannelResponse#status_details #status_details} => Types::StatusDetails
|
1738
|
+
# * {Types::GetCollaborationMLInputChannelResponse#retention_in_days #retention_in_days} => Integer
|
1739
|
+
# * {Types::GetCollaborationMLInputChannelResponse#number_of_records #number_of_records} => Integer
|
1740
|
+
# * {Types::GetCollaborationMLInputChannelResponse#description #description} => String
|
1741
|
+
#
|
1742
|
+
# @example Request syntax with placeholder values
|
1743
|
+
#
|
1744
|
+
# resp = client.get_collaboration_ml_input_channel({
|
1745
|
+
# ml_input_channel_arn: "MLInputChannelArn", # required
|
1746
|
+
# collaboration_identifier: "UUID", # required
|
1747
|
+
# })
|
1748
|
+
#
|
1749
|
+
# @example Response structure
|
1750
|
+
#
|
1751
|
+
# resp.create_time #=> Time
|
1752
|
+
# resp.update_time #=> Time
|
1753
|
+
# resp.creator_account_id #=> String
|
1754
|
+
# resp.membership_identifier #=> String
|
1755
|
+
# resp.collaboration_identifier #=> String
|
1756
|
+
# resp.ml_input_channel_arn #=> String
|
1757
|
+
# resp.name #=> String
|
1758
|
+
# resp.configured_model_algorithm_associations #=> Array
|
1759
|
+
# resp.configured_model_algorithm_associations[0] #=> String
|
1760
|
+
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED", "INACTIVE"
|
1761
|
+
# resp.status_details.status_code #=> String
|
1762
|
+
# resp.status_details.message #=> String
|
1763
|
+
# resp.retention_in_days #=> Integer
|
1764
|
+
# resp.number_of_records #=> Integer
|
1765
|
+
# resp.description #=> String
|
1766
|
+
#
|
1767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetCollaborationMLInputChannel AWS API Documentation
|
1768
|
+
#
|
1769
|
+
# @overload get_collaboration_ml_input_channel(params = {})
|
1770
|
+
# @param [Hash] params ({})
|
1771
|
+
def get_collaboration_ml_input_channel(params = {}, options = {})
|
1772
|
+
req = build_request(:get_collaboration_ml_input_channel, params)
|
1773
|
+
req.send_request(options)
|
1774
|
+
end
|
1775
|
+
|
1776
|
+
# Returns information about a trained model in a collaboration.
|
1777
|
+
#
|
1778
|
+
# @option params [required, String] :trained_model_arn
|
1779
|
+
# The Amazon Resource Name (ARN) of the trained model that you want to
|
1780
|
+
# return information about.
|
1781
|
+
#
|
1782
|
+
# @option params [required, String] :collaboration_identifier
|
1783
|
+
# The collaboration ID that contains the trained model that you want to
|
1784
|
+
# return information about.
|
1785
|
+
#
|
1786
|
+
# @return [Types::GetCollaborationTrainedModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1787
|
+
#
|
1788
|
+
# * {Types::GetCollaborationTrainedModelResponse#membership_identifier #membership_identifier} => String
|
1789
|
+
# * {Types::GetCollaborationTrainedModelResponse#collaboration_identifier #collaboration_identifier} => String
|
1790
|
+
# * {Types::GetCollaborationTrainedModelResponse#trained_model_arn #trained_model_arn} => String
|
1791
|
+
# * {Types::GetCollaborationTrainedModelResponse#name #name} => String
|
1792
|
+
# * {Types::GetCollaborationTrainedModelResponse#description #description} => String
|
1793
|
+
# * {Types::GetCollaborationTrainedModelResponse#status #status} => String
|
1794
|
+
# * {Types::GetCollaborationTrainedModelResponse#status_details #status_details} => Types::StatusDetails
|
1795
|
+
# * {Types::GetCollaborationTrainedModelResponse#configured_model_algorithm_association_arn #configured_model_algorithm_association_arn} => String
|
1796
|
+
# * {Types::GetCollaborationTrainedModelResponse#resource_config #resource_config} => Types::ResourceConfig
|
1797
|
+
# * {Types::GetCollaborationTrainedModelResponse#stopping_condition #stopping_condition} => Types::StoppingCondition
|
1798
|
+
# * {Types::GetCollaborationTrainedModelResponse#metrics_status #metrics_status} => String
|
1799
|
+
# * {Types::GetCollaborationTrainedModelResponse#metrics_status_details #metrics_status_details} => String
|
1800
|
+
# * {Types::GetCollaborationTrainedModelResponse#logs_status #logs_status} => String
|
1801
|
+
# * {Types::GetCollaborationTrainedModelResponse#logs_status_details #logs_status_details} => String
|
1802
|
+
# * {Types::GetCollaborationTrainedModelResponse#training_container_image_digest #training_container_image_digest} => String
|
1803
|
+
# * {Types::GetCollaborationTrainedModelResponse#create_time #create_time} => Time
|
1804
|
+
# * {Types::GetCollaborationTrainedModelResponse#update_time #update_time} => Time
|
1805
|
+
# * {Types::GetCollaborationTrainedModelResponse#creator_account_id #creator_account_id} => String
|
1806
|
+
#
|
1807
|
+
# @example Request syntax with placeholder values
|
1808
|
+
#
|
1809
|
+
# resp = client.get_collaboration_trained_model({
|
1810
|
+
# trained_model_arn: "TrainedModelArn", # required
|
1811
|
+
# collaboration_identifier: "UUID", # required
|
1812
|
+
# })
|
1813
|
+
#
|
1814
|
+
# @example Response structure
|
1815
|
+
#
|
1816
|
+
# resp.membership_identifier #=> String
|
1817
|
+
# resp.collaboration_identifier #=> String
|
1818
|
+
# resp.trained_model_arn #=> String
|
1819
|
+
# resp.name #=> String
|
1820
|
+
# resp.description #=> String
|
1821
|
+
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED", "INACTIVE", "CANCEL_PENDING", "CANCEL_IN_PROGRESS", "CANCEL_FAILED"
|
1822
|
+
# resp.status_details.status_code #=> String
|
1823
|
+
# resp.status_details.message #=> String
|
1824
|
+
# resp.configured_model_algorithm_association_arn #=> String
|
1825
|
+
# resp.resource_config.instance_count #=> Integer
|
1826
|
+
# resp.resource_config.instance_type #=> String, one of "ml.m4.xlarge", "ml.m4.2xlarge", "ml.m4.4xlarge", "ml.m4.10xlarge", "ml.m4.16xlarge", "ml.g4dn.xlarge", "ml.g4dn.2xlarge", "ml.g4dn.4xlarge", "ml.g4dn.8xlarge", "ml.g4dn.12xlarge", "ml.g4dn.16xlarge", "ml.m5.large", "ml.m5.xlarge", "ml.m5.2xlarge", "ml.m5.4xlarge", "ml.m5.12xlarge", "ml.m5.24xlarge", "ml.c4.xlarge", "ml.c4.2xlarge", "ml.c4.4xlarge", "ml.c4.8xlarge", "ml.p2.xlarge", "ml.p2.8xlarge", "ml.p2.16xlarge", "ml.p3.2xlarge", "ml.p3.8xlarge", "ml.p3.16xlarge", "ml.p3dn.24xlarge", "ml.p4d.24xlarge", "ml.p4de.24xlarge", "ml.p5.48xlarge", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", "ml.c5.9xlarge", "ml.c5.18xlarge", "ml.c5n.xlarge", "ml.c5n.2xlarge", "ml.c5n.4xlarge", "ml.c5n.9xlarge", "ml.c5n.18xlarge", "ml.g5.xlarge", "ml.g5.2xlarge", "ml.g5.4xlarge", "ml.g5.8xlarge", "ml.g5.16xlarge", "ml.g5.12xlarge", "ml.g5.24xlarge", "ml.g5.48xlarge", "ml.trn1.2xlarge", "ml.trn1.32xlarge", "ml.trn1n.32xlarge", "ml.m6i.large", "ml.m6i.xlarge", "ml.m6i.2xlarge", "ml.m6i.4xlarge", "ml.m6i.8xlarge", "ml.m6i.12xlarge", "ml.m6i.16xlarge", "ml.m6i.24xlarge", "ml.m6i.32xlarge", "ml.c6i.xlarge", "ml.c6i.2xlarge", "ml.c6i.8xlarge", "ml.c6i.4xlarge", "ml.c6i.12xlarge", "ml.c6i.16xlarge", "ml.c6i.24xlarge", "ml.c6i.32xlarge", "ml.r5d.large", "ml.r5d.xlarge", "ml.r5d.2xlarge", "ml.r5d.4xlarge", "ml.r5d.8xlarge", "ml.r5d.12xlarge", "ml.r5d.16xlarge", "ml.r5d.24xlarge", "ml.t3.medium", "ml.t3.large", "ml.t3.xlarge", "ml.t3.2xlarge", "ml.r5.large", "ml.r5.xlarge", "ml.r5.2xlarge", "ml.r5.4xlarge", "ml.r5.8xlarge", "ml.r5.12xlarge", "ml.r5.16xlarge", "ml.r5.24xlarge"
|
1827
|
+
# resp.resource_config.volume_size_in_gb #=> Integer
|
1828
|
+
# resp.stopping_condition.max_runtime_in_seconds #=> Integer
|
1829
|
+
# resp.metrics_status #=> String, one of "PUBLISH_SUCCEEDED", "PUBLISH_FAILED"
|
1830
|
+
# resp.metrics_status_details #=> String
|
1831
|
+
# resp.logs_status #=> String, one of "PUBLISH_SUCCEEDED", "PUBLISH_FAILED"
|
1832
|
+
# resp.logs_status_details #=> String
|
1833
|
+
# resp.training_container_image_digest #=> String
|
1834
|
+
# resp.create_time #=> Time
|
1835
|
+
# resp.update_time #=> Time
|
1836
|
+
# resp.creator_account_id #=> String
|
1837
|
+
#
|
1838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetCollaborationTrainedModel AWS API Documentation
|
1839
|
+
#
|
1840
|
+
# @overload get_collaboration_trained_model(params = {})
|
1841
|
+
# @param [Hash] params ({})
|
1842
|
+
def get_collaboration_trained_model(params = {}, options = {})
|
1843
|
+
req = build_request(:get_collaboration_trained_model, params)
|
1844
|
+
req.send_request(options)
|
1845
|
+
end
|
1846
|
+
|
1847
|
+
# Returns information about a specified configured audience model.
|
1848
|
+
#
|
1849
|
+
# @option params [required, String] :configured_audience_model_arn
|
1850
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
1851
|
+
# you are interested in.
|
1852
|
+
#
|
1853
|
+
# @return [Types::GetConfiguredAudienceModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1854
|
+
#
|
1855
|
+
# * {Types::GetConfiguredAudienceModelResponse#create_time #create_time} => Time
|
1856
|
+
# * {Types::GetConfiguredAudienceModelResponse#update_time #update_time} => Time
|
1857
|
+
# * {Types::GetConfiguredAudienceModelResponse#configured_audience_model_arn #configured_audience_model_arn} => String
|
1858
|
+
# * {Types::GetConfiguredAudienceModelResponse#name #name} => String
|
1859
|
+
# * {Types::GetConfiguredAudienceModelResponse#audience_model_arn #audience_model_arn} => String
|
1860
|
+
# * {Types::GetConfiguredAudienceModelResponse#output_config #output_config} => Types::ConfiguredAudienceModelOutputConfig
|
1861
|
+
# * {Types::GetConfiguredAudienceModelResponse#description #description} => String
|
1862
|
+
# * {Types::GetConfiguredAudienceModelResponse#status #status} => String
|
1863
|
+
# * {Types::GetConfiguredAudienceModelResponse#shared_audience_metrics #shared_audience_metrics} => Array<String>
|
1864
|
+
# * {Types::GetConfiguredAudienceModelResponse#min_matching_seed_size #min_matching_seed_size} => Integer
|
1865
|
+
# * {Types::GetConfiguredAudienceModelResponse#audience_size_config #audience_size_config} => Types::AudienceSizeConfig
|
1866
|
+
# * {Types::GetConfiguredAudienceModelResponse#tags #tags} => Hash<String,String>
|
1867
|
+
# * {Types::GetConfiguredAudienceModelResponse#child_resource_tag_on_create_policy #child_resource_tag_on_create_policy} => String
|
1868
|
+
#
|
1869
|
+
# @example Request syntax with placeholder values
|
1870
|
+
#
|
1871
|
+
# resp = client.get_configured_audience_model({
|
1872
|
+
# configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
|
1873
|
+
# })
|
1874
|
+
#
|
1875
|
+
# @example Response structure
|
1876
|
+
#
|
1877
|
+
# resp.create_time #=> Time
|
1878
|
+
# resp.update_time #=> Time
|
1879
|
+
# resp.configured_audience_model_arn #=> String
|
1880
|
+
# resp.name #=> String
|
1881
|
+
# resp.audience_model_arn #=> String
|
1882
|
+
# resp.output_config.destination.s3_destination.s3_uri #=> String
|
1883
|
+
# resp.output_config.role_arn #=> String
|
1884
|
+
# resp.description #=> String
|
1885
|
+
# resp.status #=> String, one of "ACTIVE"
|
1886
|
+
# resp.shared_audience_metrics #=> Array
|
1887
|
+
# resp.shared_audience_metrics[0] #=> String, one of "ALL", "NONE"
|
1888
|
+
# resp.min_matching_seed_size #=> Integer
|
1889
|
+
# resp.audience_size_config.audience_size_type #=> String, one of "ABSOLUTE", "PERCENTAGE"
|
1890
|
+
# resp.audience_size_config.audience_size_bins #=> Array
|
1891
|
+
# resp.audience_size_config.audience_size_bins[0] #=> Integer
|
1892
|
+
# resp.tags #=> Hash
|
1893
|
+
# resp.tags["TagKey"] #=> String
|
1894
|
+
# resp.child_resource_tag_on_create_policy #=> String, one of "FROM_PARENT_RESOURCE", "NONE"
|
1895
|
+
#
|
1896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModel AWS API Documentation
|
1897
|
+
#
|
1898
|
+
# @overload get_configured_audience_model(params = {})
|
1899
|
+
# @param [Hash] params ({})
|
1900
|
+
def get_configured_audience_model(params = {}, options = {})
|
1901
|
+
req = build_request(:get_configured_audience_model, params)
|
1902
|
+
req.send_request(options)
|
1903
|
+
end
|
1904
|
+
|
1905
|
+
# Returns information about a configured audience model policy.
|
1906
|
+
#
|
1907
|
+
# @option params [required, String] :configured_audience_model_arn
|
1908
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
1909
|
+
# you are interested in.
|
1910
|
+
#
|
1911
|
+
# @return [Types::GetConfiguredAudienceModelPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1912
|
+
#
|
1913
|
+
# * {Types::GetConfiguredAudienceModelPolicyResponse#configured_audience_model_arn #configured_audience_model_arn} => String
|
1914
|
+
# * {Types::GetConfiguredAudienceModelPolicyResponse#configured_audience_model_policy #configured_audience_model_policy} => String
|
1915
|
+
# * {Types::GetConfiguredAudienceModelPolicyResponse#policy_hash #policy_hash} => String
|
1916
|
+
#
|
1917
|
+
# @example Request syntax with placeholder values
|
1918
|
+
#
|
1919
|
+
# resp = client.get_configured_audience_model_policy({
|
1920
|
+
# configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
|
1921
|
+
# })
|
1922
|
+
#
|
1923
|
+
# @example Response structure
|
1924
|
+
#
|
1925
|
+
# resp.configured_audience_model_arn #=> String
|
1926
|
+
# resp.configured_audience_model_policy #=> String
|
1927
|
+
# resp.policy_hash #=> String
|
1928
|
+
#
|
1929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelPolicy AWS API Documentation
|
1930
|
+
#
|
1931
|
+
# @overload get_configured_audience_model_policy(params = {})
|
1932
|
+
# @param [Hash] params ({})
|
1933
|
+
def get_configured_audience_model_policy(params = {}, options = {})
|
1934
|
+
req = build_request(:get_configured_audience_model_policy, params)
|
1935
|
+
req.send_request(options)
|
1936
|
+
end
|
1937
|
+
|
1938
|
+
# Returns information about a configured model algorithm.
|
1939
|
+
#
|
1940
|
+
# @option params [required, String] :configured_model_algorithm_arn
|
1941
|
+
# The Amazon Resource Name (ARN) of the configured model algorithm that
|
1942
|
+
# you want to return information about.
|
1943
|
+
#
|
1944
|
+
# @return [Types::GetConfiguredModelAlgorithmResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1945
|
+
#
|
1946
|
+
# * {Types::GetConfiguredModelAlgorithmResponse#create_time #create_time} => Time
|
1947
|
+
# * {Types::GetConfiguredModelAlgorithmResponse#update_time #update_time} => Time
|
1948
|
+
# * {Types::GetConfiguredModelAlgorithmResponse#configured_model_algorithm_arn #configured_model_algorithm_arn} => String
|
1949
|
+
# * {Types::GetConfiguredModelAlgorithmResponse#name #name} => String
|
1950
|
+
# * {Types::GetConfiguredModelAlgorithmResponse#training_container_config #training_container_config} => Types::ContainerConfig
|
1951
|
+
# * {Types::GetConfiguredModelAlgorithmResponse#inference_container_config #inference_container_config} => Types::InferenceContainerConfig
|
1952
|
+
# * {Types::GetConfiguredModelAlgorithmResponse#role_arn #role_arn} => String
|
1953
|
+
# * {Types::GetConfiguredModelAlgorithmResponse#description #description} => String
|
1954
|
+
# * {Types::GetConfiguredModelAlgorithmResponse#tags #tags} => Hash<String,String>
|
1955
|
+
# * {Types::GetConfiguredModelAlgorithmResponse#kms_key_arn #kms_key_arn} => String
|
1956
|
+
#
|
1957
|
+
# @example Request syntax with placeholder values
|
1958
|
+
#
|
1959
|
+
# resp = client.get_configured_model_algorithm({
|
1960
|
+
# configured_model_algorithm_arn: "ConfiguredModelAlgorithmArn", # required
|
1961
|
+
# })
|
1962
|
+
#
|
1963
|
+
# @example Response structure
|
1964
|
+
#
|
1965
|
+
# resp.create_time #=> Time
|
1966
|
+
# resp.update_time #=> Time
|
1967
|
+
# resp.configured_model_algorithm_arn #=> String
|
1968
|
+
# resp.name #=> String
|
1969
|
+
# resp.training_container_config.image_uri #=> String
|
1970
|
+
# resp.training_container_config.entrypoint #=> Array
|
1971
|
+
# resp.training_container_config.entrypoint[0] #=> String
|
1972
|
+
# resp.training_container_config.arguments #=> Array
|
1973
|
+
# resp.training_container_config.arguments[0] #=> String
|
1974
|
+
# resp.training_container_config.metric_definitions #=> Array
|
1975
|
+
# resp.training_container_config.metric_definitions[0].name #=> String
|
1976
|
+
# resp.training_container_config.metric_definitions[0].regex #=> String
|
1977
|
+
# resp.inference_container_config.image_uri #=> String
|
1978
|
+
# resp.role_arn #=> String
|
1979
|
+
# resp.description #=> String
|
1980
|
+
# resp.tags #=> Hash
|
1981
|
+
# resp.tags["TagKey"] #=> String
|
1982
|
+
# resp.kms_key_arn #=> String
|
1983
|
+
#
|
1984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredModelAlgorithm AWS API Documentation
|
1985
|
+
#
|
1986
|
+
# @overload get_configured_model_algorithm(params = {})
|
1987
|
+
# @param [Hash] params ({})
|
1988
|
+
def get_configured_model_algorithm(params = {}, options = {})
|
1989
|
+
req = build_request(:get_configured_model_algorithm, params)
|
1990
|
+
req.send_request(options)
|
1991
|
+
end
|
1992
|
+
|
1993
|
+
# Returns information about a configured model algorithm association.
|
1994
|
+
#
|
1995
|
+
# @option params [required, String] :configured_model_algorithm_association_arn
|
1996
|
+
# The Amazon Resource Name (ARN) of the configured model algorithm
|
1997
|
+
# association that you want to return information about.
|
1998
|
+
#
|
1999
|
+
# @option params [required, String] :membership_identifier
|
2000
|
+
# The membership ID of the member that created the configured model
|
2001
|
+
# algorithm association.
|
2002
|
+
#
|
2003
|
+
# @return [Types::GetConfiguredModelAlgorithmAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2004
|
+
#
|
2005
|
+
# * {Types::GetConfiguredModelAlgorithmAssociationResponse#create_time #create_time} => Time
|
2006
|
+
# * {Types::GetConfiguredModelAlgorithmAssociationResponse#update_time #update_time} => Time
|
2007
|
+
# * {Types::GetConfiguredModelAlgorithmAssociationResponse#configured_model_algorithm_association_arn #configured_model_algorithm_association_arn} => String
|
2008
|
+
# * {Types::GetConfiguredModelAlgorithmAssociationResponse#membership_identifier #membership_identifier} => String
|
2009
|
+
# * {Types::GetConfiguredModelAlgorithmAssociationResponse#collaboration_identifier #collaboration_identifier} => String
|
2010
|
+
# * {Types::GetConfiguredModelAlgorithmAssociationResponse#configured_model_algorithm_arn #configured_model_algorithm_arn} => String
|
2011
|
+
# * {Types::GetConfiguredModelAlgorithmAssociationResponse#name #name} => String
|
2012
|
+
# * {Types::GetConfiguredModelAlgorithmAssociationResponse#privacy_configuration #privacy_configuration} => Types::PrivacyConfiguration
|
2013
|
+
# * {Types::GetConfiguredModelAlgorithmAssociationResponse#description #description} => String
|
2014
|
+
# * {Types::GetConfiguredModelAlgorithmAssociationResponse#tags #tags} => Hash<String,String>
|
2015
|
+
#
|
2016
|
+
# @example Request syntax with placeholder values
|
2017
|
+
#
|
2018
|
+
# resp = client.get_configured_model_algorithm_association({
|
2019
|
+
# configured_model_algorithm_association_arn: "ConfiguredModelAlgorithmAssociationArn", # required
|
2020
|
+
# membership_identifier: "UUID", # required
|
2021
|
+
# })
|
2022
|
+
#
|
2023
|
+
# @example Response structure
|
2024
|
+
#
|
2025
|
+
# resp.create_time #=> Time
|
2026
|
+
# resp.update_time #=> Time
|
2027
|
+
# resp.configured_model_algorithm_association_arn #=> String
|
2028
|
+
# resp.membership_identifier #=> String
|
2029
|
+
# resp.collaboration_identifier #=> String
|
2030
|
+
# resp.configured_model_algorithm_arn #=> String
|
2031
|
+
# resp.name #=> String
|
2032
|
+
# resp.privacy_configuration.policies.trained_models.container_logs #=> Array
|
2033
|
+
# resp.privacy_configuration.policies.trained_models.container_logs[0].allowed_account_ids #=> Array
|
2034
|
+
# resp.privacy_configuration.policies.trained_models.container_logs[0].allowed_account_ids[0] #=> String
|
2035
|
+
# resp.privacy_configuration.policies.trained_models.container_logs[0].filter_pattern #=> String
|
2036
|
+
# resp.privacy_configuration.policies.trained_models.container_metrics.noise_level #=> String, one of "HIGH", "MEDIUM", "LOW", "NONE"
|
2037
|
+
# resp.privacy_configuration.policies.trained_model_exports.max_size.unit #=> String, one of "GB"
|
2038
|
+
# resp.privacy_configuration.policies.trained_model_exports.max_size.value #=> Float
|
2039
|
+
# resp.privacy_configuration.policies.trained_model_exports.files_to_export #=> Array
|
2040
|
+
# resp.privacy_configuration.policies.trained_model_exports.files_to_export[0] #=> String, one of "MODEL", "OUTPUT"
|
2041
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.container_logs #=> Array
|
2042
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.container_logs[0].allowed_account_ids #=> Array
|
2043
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.container_logs[0].allowed_account_ids[0] #=> String
|
2044
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.container_logs[0].filter_pattern #=> String
|
2045
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.max_output_size.unit #=> String, one of "GB"
|
2046
|
+
# resp.privacy_configuration.policies.trained_model_inference_jobs.max_output_size.value #=> Float
|
2047
|
+
# resp.description #=> String
|
2048
|
+
# resp.tags #=> Hash
|
2049
|
+
# resp.tags["TagKey"] #=> String
|
2050
|
+
#
|
2051
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredModelAlgorithmAssociation AWS API Documentation
|
2052
|
+
#
|
2053
|
+
# @overload get_configured_model_algorithm_association(params = {})
|
2054
|
+
# @param [Hash] params ({})
|
2055
|
+
def get_configured_model_algorithm_association(params = {}, options = {})
|
2056
|
+
req = build_request(:get_configured_model_algorithm_association, params)
|
2057
|
+
req.send_request(options)
|
2058
|
+
end
|
2059
|
+
|
2060
|
+
# Returns information about a specific ML configuration.
|
2061
|
+
#
|
2062
|
+
# @option params [required, String] :membership_identifier
|
2063
|
+
# The membership ID of the member that owns the ML configuration you
|
2064
|
+
# want to return information about.
|
2065
|
+
#
|
2066
|
+
# @return [Types::GetMLConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2067
|
+
#
|
2068
|
+
# * {Types::GetMLConfigurationResponse#membership_identifier #membership_identifier} => String
|
2069
|
+
# * {Types::GetMLConfigurationResponse#default_output_location #default_output_location} => Types::MLOutputConfiguration
|
2070
|
+
# * {Types::GetMLConfigurationResponse#create_time #create_time} => Time
|
2071
|
+
# * {Types::GetMLConfigurationResponse#update_time #update_time} => Time
|
2072
|
+
#
|
2073
|
+
# @example Request syntax with placeholder values
|
2074
|
+
#
|
2075
|
+
# resp = client.get_ml_configuration({
|
2076
|
+
# membership_identifier: "UUID", # required
|
2077
|
+
# })
|
2078
|
+
#
|
2079
|
+
# @example Response structure
|
2080
|
+
#
|
2081
|
+
# resp.membership_identifier #=> String
|
2082
|
+
# resp.default_output_location.destination.s3_destination.s3_uri #=> String
|
2083
|
+
# resp.default_output_location.role_arn #=> String
|
2084
|
+
# resp.create_time #=> Time
|
2085
|
+
# resp.update_time #=> Time
|
2086
|
+
#
|
2087
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetMLConfiguration AWS API Documentation
|
2088
|
+
#
|
2089
|
+
# @overload get_ml_configuration(params = {})
|
2090
|
+
# @param [Hash] params ({})
|
2091
|
+
def get_ml_configuration(params = {}, options = {})
|
2092
|
+
req = build_request(:get_ml_configuration, params)
|
2093
|
+
req.send_request(options)
|
2094
|
+
end
|
2095
|
+
|
2096
|
+
# Returns information about an ML input channel.
|
2097
|
+
#
|
2098
|
+
# @option params [required, String] :ml_input_channel_arn
|
2099
|
+
# The Amazon Resource Name (ARN) of the ML input channel that you want
|
2100
|
+
# to get.
|
2101
|
+
#
|
2102
|
+
# @option params [required, String] :membership_identifier
|
2103
|
+
# The membership ID of the membership that contains the ML input channel
|
2104
|
+
# that you want to get.
|
2105
|
+
#
|
2106
|
+
# @return [Types::GetMLInputChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2107
|
+
#
|
2108
|
+
# * {Types::GetMLInputChannelResponse#create_time #create_time} => Time
|
2109
|
+
# * {Types::GetMLInputChannelResponse#update_time #update_time} => Time
|
2110
|
+
# * {Types::GetMLInputChannelResponse#membership_identifier #membership_identifier} => String
|
2111
|
+
# * {Types::GetMLInputChannelResponse#collaboration_identifier #collaboration_identifier} => String
|
2112
|
+
# * {Types::GetMLInputChannelResponse#input_channel #input_channel} => Types::InputChannel
|
2113
|
+
# * {Types::GetMLInputChannelResponse#protected_query_identifier #protected_query_identifier} => String
|
2114
|
+
# * {Types::GetMLInputChannelResponse#ml_input_channel_arn #ml_input_channel_arn} => String
|
2115
|
+
# * {Types::GetMLInputChannelResponse#name #name} => String
|
2116
|
+
# * {Types::GetMLInputChannelResponse#configured_model_algorithm_associations #configured_model_algorithm_associations} => Array<String>
|
2117
|
+
# * {Types::GetMLInputChannelResponse#status #status} => String
|
2118
|
+
# * {Types::GetMLInputChannelResponse#status_details #status_details} => Types::StatusDetails
|
2119
|
+
# * {Types::GetMLInputChannelResponse#retention_in_days #retention_in_days} => Integer
|
2120
|
+
# * {Types::GetMLInputChannelResponse#number_of_records #number_of_records} => Integer
|
2121
|
+
# * {Types::GetMLInputChannelResponse#number_of_files #number_of_files} => Float
|
2122
|
+
# * {Types::GetMLInputChannelResponse#size_in_gb #size_in_gb} => Float
|
2123
|
+
# * {Types::GetMLInputChannelResponse#description #description} => String
|
2124
|
+
# * {Types::GetMLInputChannelResponse#kms_key_arn #kms_key_arn} => String
|
2125
|
+
# * {Types::GetMLInputChannelResponse#tags #tags} => Hash<String,String>
|
2126
|
+
#
|
2127
|
+
# @example Request syntax with placeholder values
|
2128
|
+
#
|
2129
|
+
# resp = client.get_ml_input_channel({
|
2130
|
+
# ml_input_channel_arn: "MLInputChannelArn", # required
|
2131
|
+
# membership_identifier: "UUID", # required
|
2132
|
+
# })
|
2133
|
+
#
|
2134
|
+
# @example Response structure
|
2135
|
+
#
|
2136
|
+
# resp.create_time #=> Time
|
2137
|
+
# resp.update_time #=> Time
|
2138
|
+
# resp.membership_identifier #=> String
|
2139
|
+
# resp.collaboration_identifier #=> String
|
2140
|
+
# resp.input_channel.data_source.protected_query_input_parameters.sql_parameters.query_string #=> String
|
2141
|
+
# resp.input_channel.data_source.protected_query_input_parameters.sql_parameters.analysis_template_arn #=> String
|
2142
|
+
# resp.input_channel.data_source.protected_query_input_parameters.sql_parameters.parameters #=> Hash
|
2143
|
+
# resp.input_channel.data_source.protected_query_input_parameters.sql_parameters.parameters["ParameterKey"] #=> String
|
2144
|
+
# resp.input_channel.data_source.protected_query_input_parameters.compute_configuration.worker.type #=> String, one of "CR.1X", "CR.4X"
|
2145
|
+
# resp.input_channel.data_source.protected_query_input_parameters.compute_configuration.worker.number #=> Integer
|
2146
|
+
# resp.input_channel.role_arn #=> String
|
2147
|
+
# resp.protected_query_identifier #=> String
|
2148
|
+
# resp.ml_input_channel_arn #=> String
|
2149
|
+
# resp.name #=> String
|
2150
|
+
# resp.configured_model_algorithm_associations #=> Array
|
2151
|
+
# resp.configured_model_algorithm_associations[0] #=> String
|
2152
|
+
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED", "INACTIVE"
|
2153
|
+
# resp.status_details.status_code #=> String
|
2154
|
+
# resp.status_details.message #=> String
|
2155
|
+
# resp.retention_in_days #=> Integer
|
2156
|
+
# resp.number_of_records #=> Integer
|
2157
|
+
# resp.number_of_files #=> Float
|
2158
|
+
# resp.size_in_gb #=> Float
|
2159
|
+
# resp.description #=> String
|
2160
|
+
# resp.kms_key_arn #=> String
|
2161
|
+
# resp.tags #=> Hash
|
2162
|
+
# resp.tags["TagKey"] #=> String
|
2163
|
+
#
|
2164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetMLInputChannel AWS API Documentation
|
2165
|
+
#
|
2166
|
+
# @overload get_ml_input_channel(params = {})
|
2167
|
+
# @param [Hash] params ({})
|
2168
|
+
def get_ml_input_channel(params = {}, options = {})
|
2169
|
+
req = build_request(:get_ml_input_channel, params)
|
2170
|
+
req.send_request(options)
|
2171
|
+
end
|
2172
|
+
|
2173
|
+
# Returns information about a trained model.
|
2174
|
+
#
|
2175
|
+
# @option params [required, String] :trained_model_arn
|
2176
|
+
# The Amazon Resource Name (ARN) of the trained model that you are
|
2177
|
+
# interested in.
|
2178
|
+
#
|
2179
|
+
# @option params [required, String] :membership_identifier
|
2180
|
+
# The membership ID of the member that created the trained model that
|
2181
|
+
# you are interested in.
|
2182
|
+
#
|
2183
|
+
# @return [Types::GetTrainedModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2184
|
+
#
|
2185
|
+
# * {Types::GetTrainedModelResponse#membership_identifier #membership_identifier} => String
|
2186
|
+
# * {Types::GetTrainedModelResponse#collaboration_identifier #collaboration_identifier} => String
|
2187
|
+
# * {Types::GetTrainedModelResponse#trained_model_arn #trained_model_arn} => String
|
2188
|
+
# * {Types::GetTrainedModelResponse#name #name} => String
|
2189
|
+
# * {Types::GetTrainedModelResponse#description #description} => String
|
2190
|
+
# * {Types::GetTrainedModelResponse#status #status} => String
|
2191
|
+
# * {Types::GetTrainedModelResponse#status_details #status_details} => Types::StatusDetails
|
2192
|
+
# * {Types::GetTrainedModelResponse#configured_model_algorithm_association_arn #configured_model_algorithm_association_arn} => String
|
2193
|
+
# * {Types::GetTrainedModelResponse#resource_config #resource_config} => Types::ResourceConfig
|
2194
|
+
# * {Types::GetTrainedModelResponse#stopping_condition #stopping_condition} => Types::StoppingCondition
|
2195
|
+
# * {Types::GetTrainedModelResponse#metrics_status #metrics_status} => String
|
2196
|
+
# * {Types::GetTrainedModelResponse#metrics_status_details #metrics_status_details} => String
|
2197
|
+
# * {Types::GetTrainedModelResponse#logs_status #logs_status} => String
|
2198
|
+
# * {Types::GetTrainedModelResponse#logs_status_details #logs_status_details} => String
|
2199
|
+
# * {Types::GetTrainedModelResponse#training_container_image_digest #training_container_image_digest} => String
|
2200
|
+
# * {Types::GetTrainedModelResponse#create_time #create_time} => Time
|
2201
|
+
# * {Types::GetTrainedModelResponse#update_time #update_time} => Time
|
2202
|
+
# * {Types::GetTrainedModelResponse#hyperparameters #hyperparameters} => Hash<String,String>
|
2203
|
+
# * {Types::GetTrainedModelResponse#environment #environment} => Hash<String,String>
|
2204
|
+
# * {Types::GetTrainedModelResponse#kms_key_arn #kms_key_arn} => String
|
2205
|
+
# * {Types::GetTrainedModelResponse#tags #tags} => Hash<String,String>
|
2206
|
+
# * {Types::GetTrainedModelResponse#data_channels #data_channels} => Array<Types::ModelTrainingDataChannel>
|
918
2207
|
#
|
919
2208
|
# @example Request syntax with placeholder values
|
920
2209
|
#
|
921
|
-
# resp = client.
|
922
|
-
#
|
2210
|
+
# resp = client.get_trained_model({
|
2211
|
+
# trained_model_arn: "TrainedModelArn", # required
|
2212
|
+
# membership_identifier: "UUID", # required
|
923
2213
|
# })
|
924
2214
|
#
|
925
2215
|
# @example Response structure
|
926
2216
|
#
|
2217
|
+
# resp.membership_identifier #=> String
|
2218
|
+
# resp.collaboration_identifier #=> String
|
2219
|
+
# resp.trained_model_arn #=> String
|
2220
|
+
# resp.name #=> String
|
2221
|
+
# resp.description #=> String
|
2222
|
+
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED", "INACTIVE", "CANCEL_PENDING", "CANCEL_IN_PROGRESS", "CANCEL_FAILED"
|
2223
|
+
# resp.status_details.status_code #=> String
|
2224
|
+
# resp.status_details.message #=> String
|
2225
|
+
# resp.configured_model_algorithm_association_arn #=> String
|
2226
|
+
# resp.resource_config.instance_count #=> Integer
|
2227
|
+
# resp.resource_config.instance_type #=> String, one of "ml.m4.xlarge", "ml.m4.2xlarge", "ml.m4.4xlarge", "ml.m4.10xlarge", "ml.m4.16xlarge", "ml.g4dn.xlarge", "ml.g4dn.2xlarge", "ml.g4dn.4xlarge", "ml.g4dn.8xlarge", "ml.g4dn.12xlarge", "ml.g4dn.16xlarge", "ml.m5.large", "ml.m5.xlarge", "ml.m5.2xlarge", "ml.m5.4xlarge", "ml.m5.12xlarge", "ml.m5.24xlarge", "ml.c4.xlarge", "ml.c4.2xlarge", "ml.c4.4xlarge", "ml.c4.8xlarge", "ml.p2.xlarge", "ml.p2.8xlarge", "ml.p2.16xlarge", "ml.p3.2xlarge", "ml.p3.8xlarge", "ml.p3.16xlarge", "ml.p3dn.24xlarge", "ml.p4d.24xlarge", "ml.p4de.24xlarge", "ml.p5.48xlarge", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", "ml.c5.9xlarge", "ml.c5.18xlarge", "ml.c5n.xlarge", "ml.c5n.2xlarge", "ml.c5n.4xlarge", "ml.c5n.9xlarge", "ml.c5n.18xlarge", "ml.g5.xlarge", "ml.g5.2xlarge", "ml.g5.4xlarge", "ml.g5.8xlarge", "ml.g5.16xlarge", "ml.g5.12xlarge", "ml.g5.24xlarge", "ml.g5.48xlarge", "ml.trn1.2xlarge", "ml.trn1.32xlarge", "ml.trn1n.32xlarge", "ml.m6i.large", "ml.m6i.xlarge", "ml.m6i.2xlarge", "ml.m6i.4xlarge", "ml.m6i.8xlarge", "ml.m6i.12xlarge", "ml.m6i.16xlarge", "ml.m6i.24xlarge", "ml.m6i.32xlarge", "ml.c6i.xlarge", "ml.c6i.2xlarge", "ml.c6i.8xlarge", "ml.c6i.4xlarge", "ml.c6i.12xlarge", "ml.c6i.16xlarge", "ml.c6i.24xlarge", "ml.c6i.32xlarge", "ml.r5d.large", "ml.r5d.xlarge", "ml.r5d.2xlarge", "ml.r5d.4xlarge", "ml.r5d.8xlarge", "ml.r5d.12xlarge", "ml.r5d.16xlarge", "ml.r5d.24xlarge", "ml.t3.medium", "ml.t3.large", "ml.t3.xlarge", "ml.t3.2xlarge", "ml.r5.large", "ml.r5.xlarge", "ml.r5.2xlarge", "ml.r5.4xlarge", "ml.r5.8xlarge", "ml.r5.12xlarge", "ml.r5.16xlarge", "ml.r5.24xlarge"
|
2228
|
+
# resp.resource_config.volume_size_in_gb #=> Integer
|
2229
|
+
# resp.stopping_condition.max_runtime_in_seconds #=> Integer
|
2230
|
+
# resp.metrics_status #=> String, one of "PUBLISH_SUCCEEDED", "PUBLISH_FAILED"
|
2231
|
+
# resp.metrics_status_details #=> String
|
2232
|
+
# resp.logs_status #=> String, one of "PUBLISH_SUCCEEDED", "PUBLISH_FAILED"
|
2233
|
+
# resp.logs_status_details #=> String
|
2234
|
+
# resp.training_container_image_digest #=> String
|
927
2235
|
# resp.create_time #=> Time
|
928
2236
|
# resp.update_time #=> Time
|
929
|
-
# resp.
|
2237
|
+
# resp.hyperparameters #=> Hash
|
2238
|
+
# resp.hyperparameters["HyperParametersKeyString"] #=> String
|
2239
|
+
# resp.environment #=> Hash
|
2240
|
+
# resp.environment["EnvironmentKeyString"] #=> String
|
2241
|
+
# resp.kms_key_arn #=> String
|
2242
|
+
# resp.tags #=> Hash
|
2243
|
+
# resp.tags["TagKey"] #=> String
|
2244
|
+
# resp.data_channels #=> Array
|
2245
|
+
# resp.data_channels[0].ml_input_channel_arn #=> String
|
2246
|
+
# resp.data_channels[0].channel_name #=> String
|
2247
|
+
#
|
2248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainedModel AWS API Documentation
|
2249
|
+
#
|
2250
|
+
# @overload get_trained_model(params = {})
|
2251
|
+
# @param [Hash] params ({})
|
2252
|
+
def get_trained_model(params = {}, options = {})
|
2253
|
+
req = build_request(:get_trained_model, params)
|
2254
|
+
req.send_request(options)
|
2255
|
+
end
|
2256
|
+
|
2257
|
+
# Returns information about a trained model inference job.
|
2258
|
+
#
|
2259
|
+
# @option params [required, String] :membership_identifier
|
2260
|
+
# Provides the membership ID of the membership that contains the trained
|
2261
|
+
# model inference job that you are interested in.
|
2262
|
+
#
|
2263
|
+
# @option params [required, String] :trained_model_inference_job_arn
|
2264
|
+
# Provides the Amazon Resource Name (ARN) of the trained model inference
|
2265
|
+
# job that you are interested in.
|
2266
|
+
#
|
2267
|
+
# @return [Types::GetTrainedModelInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2268
|
+
#
|
2269
|
+
# * {Types::GetTrainedModelInferenceJobResponse#create_time #create_time} => Time
|
2270
|
+
# * {Types::GetTrainedModelInferenceJobResponse#update_time #update_time} => Time
|
2271
|
+
# * {Types::GetTrainedModelInferenceJobResponse#trained_model_inference_job_arn #trained_model_inference_job_arn} => String
|
2272
|
+
# * {Types::GetTrainedModelInferenceJobResponse#configured_model_algorithm_association_arn #configured_model_algorithm_association_arn} => String
|
2273
|
+
# * {Types::GetTrainedModelInferenceJobResponse#name #name} => String
|
2274
|
+
# * {Types::GetTrainedModelInferenceJobResponse#status #status} => String
|
2275
|
+
# * {Types::GetTrainedModelInferenceJobResponse#trained_model_arn #trained_model_arn} => String
|
2276
|
+
# * {Types::GetTrainedModelInferenceJobResponse#resource_config #resource_config} => Types::InferenceResourceConfig
|
2277
|
+
# * {Types::GetTrainedModelInferenceJobResponse#output_configuration #output_configuration} => Types::InferenceOutputConfiguration
|
2278
|
+
# * {Types::GetTrainedModelInferenceJobResponse#membership_identifier #membership_identifier} => String
|
2279
|
+
# * {Types::GetTrainedModelInferenceJobResponse#data_source #data_source} => Types::ModelInferenceDataSource
|
2280
|
+
# * {Types::GetTrainedModelInferenceJobResponse#container_execution_parameters #container_execution_parameters} => Types::InferenceContainerExecutionParameters
|
2281
|
+
# * {Types::GetTrainedModelInferenceJobResponse#status_details #status_details} => Types::StatusDetails
|
2282
|
+
# * {Types::GetTrainedModelInferenceJobResponse#description #description} => String
|
2283
|
+
# * {Types::GetTrainedModelInferenceJobResponse#inference_container_image_digest #inference_container_image_digest} => String
|
2284
|
+
# * {Types::GetTrainedModelInferenceJobResponse#environment #environment} => Hash<String,String>
|
2285
|
+
# * {Types::GetTrainedModelInferenceJobResponse#kms_key_arn #kms_key_arn} => String
|
2286
|
+
# * {Types::GetTrainedModelInferenceJobResponse#metrics_status #metrics_status} => String
|
2287
|
+
# * {Types::GetTrainedModelInferenceJobResponse#metrics_status_details #metrics_status_details} => String
|
2288
|
+
# * {Types::GetTrainedModelInferenceJobResponse#logs_status #logs_status} => String
|
2289
|
+
# * {Types::GetTrainedModelInferenceJobResponse#logs_status_details #logs_status_details} => String
|
2290
|
+
# * {Types::GetTrainedModelInferenceJobResponse#tags #tags} => Hash<String,String>
|
2291
|
+
#
|
2292
|
+
# @example Request syntax with placeholder values
|
2293
|
+
#
|
2294
|
+
# resp = client.get_trained_model_inference_job({
|
2295
|
+
# membership_identifier: "UUID", # required
|
2296
|
+
# trained_model_inference_job_arn: "TrainedModelInferenceJobArn", # required
|
2297
|
+
# })
|
2298
|
+
#
|
2299
|
+
# @example Response structure
|
2300
|
+
#
|
2301
|
+
# resp.create_time #=> Time
|
2302
|
+
# resp.update_time #=> Time
|
2303
|
+
# resp.trained_model_inference_job_arn #=> String
|
2304
|
+
# resp.configured_model_algorithm_association_arn #=> String
|
930
2305
|
# resp.name #=> String
|
931
|
-
# resp.
|
932
|
-
# resp.
|
2306
|
+
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "CANCEL_PENDING", "CANCEL_IN_PROGRESS", "CANCEL_FAILED", "INACTIVE"
|
2307
|
+
# resp.trained_model_arn #=> String
|
2308
|
+
# resp.resource_config.instance_type #=> String, one of "ml.r7i.48xlarge", "ml.r6i.16xlarge", "ml.m6i.xlarge", "ml.m5.4xlarge", "ml.p2.xlarge", "ml.m4.16xlarge", "ml.r7i.16xlarge", "ml.m7i.xlarge", "ml.m6i.12xlarge", "ml.r7i.8xlarge", "ml.r7i.large", "ml.m7i.12xlarge", "ml.m6i.24xlarge", "ml.m7i.24xlarge", "ml.r6i.8xlarge", "ml.r6i.large", "ml.g5.2xlarge", "ml.m5.large", "ml.p3.16xlarge", "ml.m7i.48xlarge", "ml.m6i.16xlarge", "ml.p2.16xlarge", "ml.g5.4xlarge", "ml.m7i.16xlarge", "ml.c4.2xlarge", "ml.c5.2xlarge", "ml.c6i.32xlarge", "ml.c4.4xlarge", "ml.g5.8xlarge", "ml.c6i.xlarge", "ml.c5.4xlarge", "ml.g4dn.xlarge", "ml.c7i.xlarge", "ml.c6i.12xlarge", "ml.g4dn.12xlarge", "ml.c7i.12xlarge", "ml.c6i.24xlarge", "ml.g4dn.2xlarge", "ml.c7i.24xlarge", "ml.c7i.2xlarge", "ml.c4.8xlarge", "ml.c6i.2xlarge", "ml.g4dn.4xlarge", "ml.c7i.48xlarge", "ml.c7i.4xlarge", "ml.c6i.16xlarge", "ml.c5.9xlarge", "ml.g4dn.16xlarge", "ml.c7i.16xlarge", "ml.c6i.4xlarge", "ml.c5.xlarge", "ml.c4.xlarge", "ml.g4dn.8xlarge", "ml.c7i.8xlarge", "ml.c7i.large", "ml.g5.xlarge", "ml.c6i.8xlarge", "ml.c6i.large", "ml.g5.12xlarge", "ml.g5.24xlarge", "ml.m7i.2xlarge", "ml.c5.18xlarge", "ml.g5.48xlarge", "ml.m6i.2xlarge", "ml.g5.16xlarge", "ml.m7i.4xlarge", "ml.p3.2xlarge", "ml.r6i.32xlarge", "ml.m6i.4xlarge", "ml.m5.xlarge", "ml.m4.10xlarge", "ml.r6i.xlarge", "ml.m5.12xlarge", "ml.m4.xlarge", "ml.r7i.2xlarge", "ml.r7i.xlarge", "ml.r6i.12xlarge", "ml.m5.24xlarge", "ml.r7i.12xlarge", "ml.m7i.8xlarge", "ml.m7i.large", "ml.r6i.24xlarge", "ml.r6i.2xlarge", "ml.m4.2xlarge", "ml.r7i.24xlarge", "ml.r7i.4xlarge", "ml.m6i.8xlarge", "ml.m6i.large", "ml.m5.2xlarge", "ml.p2.8xlarge", "ml.r6i.4xlarge", "ml.m6i.32xlarge", "ml.p3.8xlarge", "ml.m4.4xlarge"
|
2309
|
+
# resp.resource_config.instance_count #=> Integer
|
2310
|
+
# resp.output_configuration.accept #=> String
|
2311
|
+
# resp.output_configuration.members #=> Array
|
2312
|
+
# resp.output_configuration.members[0].account_id #=> String
|
2313
|
+
# resp.membership_identifier #=> String
|
2314
|
+
# resp.data_source.ml_input_channel_arn #=> String
|
2315
|
+
# resp.container_execution_parameters.max_payload_in_mb #=> Integer
|
933
2316
|
# resp.status_details.status_code #=> String
|
934
2317
|
# resp.status_details.message #=> String
|
935
|
-
# resp.
|
936
|
-
# resp.
|
937
|
-
# resp.
|
938
|
-
# resp.
|
939
|
-
# resp.
|
940
|
-
# resp.
|
941
|
-
# resp.
|
942
|
-
# resp.
|
943
|
-
# resp.
|
944
|
-
# resp.metrics.relevance_metrics #=> Array
|
945
|
-
# resp.metrics.relevance_metrics[0].audience_size.type #=> String, one of "ABSOLUTE", "PERCENTAGE"
|
946
|
-
# resp.metrics.relevance_metrics[0].audience_size.value #=> Integer
|
947
|
-
# resp.metrics.relevance_metrics[0].score #=> Float
|
948
|
-
# resp.metrics.recall_metric #=> Float
|
949
|
-
# resp.started_by #=> String
|
2318
|
+
# resp.description #=> String
|
2319
|
+
# resp.inference_container_image_digest #=> String
|
2320
|
+
# resp.environment #=> Hash
|
2321
|
+
# resp.environment["InferenceEnvironmentMapKeyString"] #=> String
|
2322
|
+
# resp.kms_key_arn #=> String
|
2323
|
+
# resp.metrics_status #=> String, one of "PUBLISH_SUCCEEDED", "PUBLISH_FAILED"
|
2324
|
+
# resp.metrics_status_details #=> String
|
2325
|
+
# resp.logs_status #=> String, one of "PUBLISH_SUCCEEDED", "PUBLISH_FAILED"
|
2326
|
+
# resp.logs_status_details #=> String
|
950
2327
|
# resp.tags #=> Hash
|
951
2328
|
# resp.tags["TagKey"] #=> String
|
952
|
-
# resp.protected_query_identifier #=> String
|
953
2329
|
#
|
954
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/
|
2330
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainedModelInferenceJob AWS API Documentation
|
2331
|
+
#
|
2332
|
+
# @overload get_trained_model_inference_job(params = {})
|
2333
|
+
# @param [Hash] params ({})
|
2334
|
+
def get_trained_model_inference_job(params = {}, options = {})
|
2335
|
+
req = build_request(:get_trained_model_inference_job, params)
|
2336
|
+
req.send_request(options)
|
2337
|
+
end
|
2338
|
+
|
2339
|
+
# Returns information about a training dataset.
|
2340
|
+
#
|
2341
|
+
# @option params [required, String] :training_dataset_arn
|
2342
|
+
# The Amazon Resource Name (ARN) of the training dataset that you are
|
2343
|
+
# interested in.
|
2344
|
+
#
|
2345
|
+
# @return [Types::GetTrainingDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2346
|
+
#
|
2347
|
+
# * {Types::GetTrainingDatasetResponse#create_time #create_time} => Time
|
2348
|
+
# * {Types::GetTrainingDatasetResponse#update_time #update_time} => Time
|
2349
|
+
# * {Types::GetTrainingDatasetResponse#training_dataset_arn #training_dataset_arn} => String
|
2350
|
+
# * {Types::GetTrainingDatasetResponse#name #name} => String
|
2351
|
+
# * {Types::GetTrainingDatasetResponse#training_data #training_data} => Array<Types::Dataset>
|
2352
|
+
# * {Types::GetTrainingDatasetResponse#status #status} => String
|
2353
|
+
# * {Types::GetTrainingDatasetResponse#role_arn #role_arn} => String
|
2354
|
+
# * {Types::GetTrainingDatasetResponse#tags #tags} => Hash<String,String>
|
2355
|
+
# * {Types::GetTrainingDatasetResponse#description #description} => String
|
2356
|
+
#
|
2357
|
+
# @example Request syntax with placeholder values
|
2358
|
+
#
|
2359
|
+
# resp = client.get_training_dataset({
|
2360
|
+
# training_dataset_arn: "TrainingDatasetArn", # required
|
2361
|
+
# })
|
2362
|
+
#
|
2363
|
+
# @example Response structure
|
2364
|
+
#
|
2365
|
+
# resp.create_time #=> Time
|
2366
|
+
# resp.update_time #=> Time
|
2367
|
+
# resp.training_dataset_arn #=> String
|
2368
|
+
# resp.name #=> String
|
2369
|
+
# resp.training_data #=> Array
|
2370
|
+
# resp.training_data[0].type #=> String, one of "INTERACTIONS"
|
2371
|
+
# resp.training_data[0].input_config.schema #=> Array
|
2372
|
+
# resp.training_data[0].input_config.schema[0].column_name #=> String
|
2373
|
+
# resp.training_data[0].input_config.schema[0].column_types #=> Array
|
2374
|
+
# resp.training_data[0].input_config.schema[0].column_types[0] #=> String, one of "USER_ID", "ITEM_ID", "TIMESTAMP", "CATEGORICAL_FEATURE", "NUMERICAL_FEATURE"
|
2375
|
+
# resp.training_data[0].input_config.data_source.glue_data_source.table_name #=> String
|
2376
|
+
# resp.training_data[0].input_config.data_source.glue_data_source.database_name #=> String
|
2377
|
+
# resp.training_data[0].input_config.data_source.glue_data_source.catalog_id #=> String
|
2378
|
+
# resp.status #=> String, one of "ACTIVE"
|
2379
|
+
# resp.role_arn #=> String
|
2380
|
+
# resp.tags #=> Hash
|
2381
|
+
# resp.tags["TagKey"] #=> String
|
2382
|
+
# resp.description #=> String
|
2383
|
+
#
|
2384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDataset AWS API Documentation
|
2385
|
+
#
|
2386
|
+
# @overload get_training_dataset(params = {})
|
2387
|
+
# @param [Hash] params ({})
|
2388
|
+
def get_training_dataset(params = {}, options = {})
|
2389
|
+
req = build_request(:get_training_dataset, params)
|
2390
|
+
req.send_request(options)
|
2391
|
+
end
|
2392
|
+
|
2393
|
+
# Returns a list of the audience export jobs.
|
2394
|
+
#
|
2395
|
+
# @option params [String] :next_token
|
2396
|
+
# The token value retrieved from a previous call to access the next page
|
2397
|
+
# of results.
|
2398
|
+
#
|
2399
|
+
# @option params [Integer] :max_results
|
2400
|
+
# The maximum size of the results that is returned per call.
|
2401
|
+
#
|
2402
|
+
# @option params [String] :audience_generation_job_arn
|
2403
|
+
# The Amazon Resource Name (ARN) of the audience generation job that you
|
2404
|
+
# are interested in.
|
2405
|
+
#
|
2406
|
+
# @return [Types::ListAudienceExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2407
|
+
#
|
2408
|
+
# * {Types::ListAudienceExportJobsResponse#next_token #next_token} => String
|
2409
|
+
# * {Types::ListAudienceExportJobsResponse#audience_export_jobs #audience_export_jobs} => Array<Types::AudienceExportJobSummary>
|
2410
|
+
#
|
2411
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2412
|
+
#
|
2413
|
+
# @example Request syntax with placeholder values
|
2414
|
+
#
|
2415
|
+
# resp = client.list_audience_export_jobs({
|
2416
|
+
# next_token: "NextToken",
|
2417
|
+
# max_results: 1,
|
2418
|
+
# audience_generation_job_arn: "AudienceGenerationJobArn",
|
2419
|
+
# })
|
2420
|
+
#
|
2421
|
+
# @example Response structure
|
2422
|
+
#
|
2423
|
+
# resp.next_token #=> String
|
2424
|
+
# resp.audience_export_jobs #=> Array
|
2425
|
+
# resp.audience_export_jobs[0].create_time #=> Time
|
2426
|
+
# resp.audience_export_jobs[0].update_time #=> Time
|
2427
|
+
# resp.audience_export_jobs[0].name #=> String
|
2428
|
+
# resp.audience_export_jobs[0].audience_generation_job_arn #=> String
|
2429
|
+
# resp.audience_export_jobs[0].audience_size.type #=> String, one of "ABSOLUTE", "PERCENTAGE"
|
2430
|
+
# resp.audience_export_jobs[0].audience_size.value #=> Integer
|
2431
|
+
# resp.audience_export_jobs[0].description #=> String
|
2432
|
+
# resp.audience_export_jobs[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE"
|
2433
|
+
# resp.audience_export_jobs[0].status_details.status_code #=> String
|
2434
|
+
# resp.audience_export_jobs[0].status_details.message #=> String
|
2435
|
+
# resp.audience_export_jobs[0].output_location #=> String
|
2436
|
+
#
|
2437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobs AWS API Documentation
|
2438
|
+
#
|
2439
|
+
# @overload list_audience_export_jobs(params = {})
|
2440
|
+
# @param [Hash] params ({})
|
2441
|
+
def list_audience_export_jobs(params = {}, options = {})
|
2442
|
+
req = build_request(:list_audience_export_jobs, params)
|
2443
|
+
req.send_request(options)
|
2444
|
+
end
|
2445
|
+
|
2446
|
+
# Returns a list of audience generation jobs.
|
2447
|
+
#
|
2448
|
+
# @option params [String] :next_token
|
2449
|
+
# The token value retrieved from a previous call to access the next page
|
2450
|
+
# of results.
|
2451
|
+
#
|
2452
|
+
# @option params [Integer] :max_results
|
2453
|
+
# The maximum size of the results that is returned per call.
|
2454
|
+
#
|
2455
|
+
# @option params [String] :configured_audience_model_arn
|
2456
|
+
# The Amazon Resource Name (ARN) of the configured audience model that
|
2457
|
+
# was used for the audience generation jobs that you are interested in.
|
2458
|
+
#
|
2459
|
+
# @option params [String] :collaboration_id
|
2460
|
+
# The identifier of the collaboration that contains the audience
|
2461
|
+
# generation jobs that you are interested in.
|
2462
|
+
#
|
2463
|
+
# @return [Types::ListAudienceGenerationJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2464
|
+
#
|
2465
|
+
# * {Types::ListAudienceGenerationJobsResponse#next_token #next_token} => String
|
2466
|
+
# * {Types::ListAudienceGenerationJobsResponse#audience_generation_jobs #audience_generation_jobs} => Array<Types::AudienceGenerationJobSummary>
|
2467
|
+
#
|
2468
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2469
|
+
#
|
2470
|
+
# @example Request syntax with placeholder values
|
2471
|
+
#
|
2472
|
+
# resp = client.list_audience_generation_jobs({
|
2473
|
+
# next_token: "NextToken",
|
2474
|
+
# max_results: 1,
|
2475
|
+
# configured_audience_model_arn: "ConfiguredAudienceModelArn",
|
2476
|
+
# collaboration_id: "UUID",
|
2477
|
+
# })
|
2478
|
+
#
|
2479
|
+
# @example Response structure
|
2480
|
+
#
|
2481
|
+
# resp.next_token #=> String
|
2482
|
+
# resp.audience_generation_jobs #=> Array
|
2483
|
+
# resp.audience_generation_jobs[0].create_time #=> Time
|
2484
|
+
# resp.audience_generation_jobs[0].update_time #=> Time
|
2485
|
+
# resp.audience_generation_jobs[0].audience_generation_job_arn #=> String
|
2486
|
+
# resp.audience_generation_jobs[0].name #=> String
|
2487
|
+
# resp.audience_generation_jobs[0].description #=> String
|
2488
|
+
# resp.audience_generation_jobs[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
2489
|
+
# resp.audience_generation_jobs[0].configured_audience_model_arn #=> String
|
2490
|
+
# resp.audience_generation_jobs[0].collaboration_id #=> String
|
2491
|
+
# resp.audience_generation_jobs[0].started_by #=> String
|
2492
|
+
#
|
2493
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobs AWS API Documentation
|
2494
|
+
#
|
2495
|
+
# @overload list_audience_generation_jobs(params = {})
|
2496
|
+
# @param [Hash] params ({})
|
2497
|
+
def list_audience_generation_jobs(params = {}, options = {})
|
2498
|
+
req = build_request(:list_audience_generation_jobs, params)
|
2499
|
+
req.send_request(options)
|
2500
|
+
end
|
2501
|
+
|
2502
|
+
# Returns a list of audience models.
|
2503
|
+
#
|
2504
|
+
# @option params [String] :next_token
|
2505
|
+
# The token value retrieved from a previous call to access the next page
|
2506
|
+
# of results.
|
2507
|
+
#
|
2508
|
+
# @option params [Integer] :max_results
|
2509
|
+
# The maximum size of the results that is returned per call.
|
2510
|
+
#
|
2511
|
+
# @return [Types::ListAudienceModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2512
|
+
#
|
2513
|
+
# * {Types::ListAudienceModelsResponse#next_token #next_token} => String
|
2514
|
+
# * {Types::ListAudienceModelsResponse#audience_models #audience_models} => Array<Types::AudienceModelSummary>
|
2515
|
+
#
|
2516
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2517
|
+
#
|
2518
|
+
# @example Request syntax with placeholder values
|
2519
|
+
#
|
2520
|
+
# resp = client.list_audience_models({
|
2521
|
+
# next_token: "NextToken",
|
2522
|
+
# max_results: 1,
|
2523
|
+
# })
|
2524
|
+
#
|
2525
|
+
# @example Response structure
|
2526
|
+
#
|
2527
|
+
# resp.next_token #=> String
|
2528
|
+
# resp.audience_models #=> Array
|
2529
|
+
# resp.audience_models[0].create_time #=> Time
|
2530
|
+
# resp.audience_models[0].update_time #=> Time
|
2531
|
+
# resp.audience_models[0].audience_model_arn #=> String
|
2532
|
+
# resp.audience_models[0].name #=> String
|
2533
|
+
# resp.audience_models[0].training_dataset_arn #=> String
|
2534
|
+
# resp.audience_models[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
2535
|
+
# resp.audience_models[0].description #=> String
|
2536
|
+
#
|
2537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModels AWS API Documentation
|
955
2538
|
#
|
956
|
-
# @overload
|
2539
|
+
# @overload list_audience_models(params = {})
|
957
2540
|
# @param [Hash] params ({})
|
958
|
-
def
|
959
|
-
req = build_request(:
|
2541
|
+
def list_audience_models(params = {}, options = {})
|
2542
|
+
req = build_request(:list_audience_models, params)
|
960
2543
|
req.send_request(options)
|
961
2544
|
end
|
962
2545
|
|
963
|
-
# Returns
|
2546
|
+
# Returns a list of the configured model algorithm associations in a
|
2547
|
+
# collaboration.
|
964
2548
|
#
|
965
|
-
# @option params [
|
966
|
-
# The
|
967
|
-
#
|
2549
|
+
# @option params [String] :next_token
|
2550
|
+
# The token value retrieved from a previous call to access the next page
|
2551
|
+
# of results.
|
968
2552
|
#
|
969
|
-
# @
|
2553
|
+
# @option params [Integer] :max_results
|
2554
|
+
# The maximum size of the results that is returned per call.
|
970
2555
|
#
|
971
|
-
#
|
972
|
-
#
|
973
|
-
#
|
974
|
-
#
|
975
|
-
#
|
976
|
-
#
|
977
|
-
# * {Types::
|
978
|
-
# * {Types::
|
979
|
-
#
|
980
|
-
#
|
981
|
-
# * {Types::GetAudienceModelResponse#tags #tags} => Hash<String,String>
|
982
|
-
# * {Types::GetAudienceModelResponse#description #description} => String
|
2556
|
+
# @option params [required, String] :collaboration_identifier
|
2557
|
+
# The collaboration ID of the collaboration that contains the configured
|
2558
|
+
# model algorithm associations that you are interested in.
|
2559
|
+
#
|
2560
|
+
# @return [Types::ListCollaborationConfiguredModelAlgorithmAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2561
|
+
#
|
2562
|
+
# * {Types::ListCollaborationConfiguredModelAlgorithmAssociationsResponse#next_token #next_token} => String
|
2563
|
+
# * {Types::ListCollaborationConfiguredModelAlgorithmAssociationsResponse#collaboration_configured_model_algorithm_associations #collaboration_configured_model_algorithm_associations} => Array<Types::CollaborationConfiguredModelAlgorithmAssociationSummary>
|
2564
|
+
#
|
2565
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
983
2566
|
#
|
984
2567
|
# @example Request syntax with placeholder values
|
985
2568
|
#
|
986
|
-
# resp = client.
|
987
|
-
#
|
2569
|
+
# resp = client.list_collaboration_configured_model_algorithm_associations({
|
2570
|
+
# next_token: "NextToken",
|
2571
|
+
# max_results: 1,
|
2572
|
+
# collaboration_identifier: "UUID", # required
|
988
2573
|
# })
|
989
2574
|
#
|
990
2575
|
# @example Response structure
|
991
2576
|
#
|
992
|
-
# resp.
|
993
|
-
# resp.
|
994
|
-
# resp.
|
995
|
-
# resp.
|
996
|
-
# resp.
|
997
|
-
# resp.name #=> String
|
998
|
-
# resp.
|
999
|
-
# resp.
|
1000
|
-
# resp.
|
1001
|
-
# resp.
|
1002
|
-
# resp.
|
1003
|
-
#
|
1004
|
-
#
|
1005
|
-
#
|
1006
|
-
#
|
1007
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModel AWS API Documentation
|
1008
|
-
#
|
1009
|
-
# @overload get_audience_model(params = {})
|
2577
|
+
# resp.next_token #=> String
|
2578
|
+
# resp.collaboration_configured_model_algorithm_associations #=> Array
|
2579
|
+
# resp.collaboration_configured_model_algorithm_associations[0].create_time #=> Time
|
2580
|
+
# resp.collaboration_configured_model_algorithm_associations[0].update_time #=> Time
|
2581
|
+
# resp.collaboration_configured_model_algorithm_associations[0].configured_model_algorithm_association_arn #=> String
|
2582
|
+
# resp.collaboration_configured_model_algorithm_associations[0].name #=> String
|
2583
|
+
# resp.collaboration_configured_model_algorithm_associations[0].description #=> String
|
2584
|
+
# resp.collaboration_configured_model_algorithm_associations[0].membership_identifier #=> String
|
2585
|
+
# resp.collaboration_configured_model_algorithm_associations[0].collaboration_identifier #=> String
|
2586
|
+
# resp.collaboration_configured_model_algorithm_associations[0].configured_model_algorithm_arn #=> String
|
2587
|
+
# resp.collaboration_configured_model_algorithm_associations[0].creator_account_id #=> String
|
2588
|
+
#
|
2589
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationConfiguredModelAlgorithmAssociations AWS API Documentation
|
2590
|
+
#
|
2591
|
+
# @overload list_collaboration_configured_model_algorithm_associations(params = {})
|
1010
2592
|
# @param [Hash] params ({})
|
1011
|
-
def
|
1012
|
-
req = build_request(:
|
2593
|
+
def list_collaboration_configured_model_algorithm_associations(params = {}, options = {})
|
2594
|
+
req = build_request(:list_collaboration_configured_model_algorithm_associations, params)
|
1013
2595
|
req.send_request(options)
|
1014
2596
|
end
|
1015
2597
|
|
1016
|
-
# Returns
|
2598
|
+
# Returns a list of the ML input channels in a collaboration.
|
1017
2599
|
#
|
1018
|
-
# @option params [
|
1019
|
-
# The
|
1020
|
-
#
|
2600
|
+
# @option params [String] :next_token
|
2601
|
+
# The token value retrieved from a previous call to access the next page
|
2602
|
+
# of results.
|
1021
2603
|
#
|
1022
|
-
# @
|
2604
|
+
# @option params [Integer] :max_results
|
2605
|
+
# The maximum number of results to return.
|
1023
2606
|
#
|
1024
|
-
#
|
1025
|
-
#
|
1026
|
-
#
|
1027
|
-
#
|
1028
|
-
#
|
1029
|
-
#
|
1030
|
-
# * {Types::
|
1031
|
-
# * {Types::
|
1032
|
-
#
|
1033
|
-
#
|
1034
|
-
# * {Types::GetConfiguredAudienceModelResponse#audience_size_config #audience_size_config} => Types::AudienceSizeConfig
|
1035
|
-
# * {Types::GetConfiguredAudienceModelResponse#tags #tags} => Hash<String,String>
|
1036
|
-
# * {Types::GetConfiguredAudienceModelResponse#child_resource_tag_on_create_policy #child_resource_tag_on_create_policy} => String
|
2607
|
+
# @option params [required, String] :collaboration_identifier
|
2608
|
+
# The collaboration ID of the collaboration that contains the ML input
|
2609
|
+
# channels that you want to list.
|
2610
|
+
#
|
2611
|
+
# @return [Types::ListCollaborationMLInputChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2612
|
+
#
|
2613
|
+
# * {Types::ListCollaborationMLInputChannelsResponse#next_token #next_token} => String
|
2614
|
+
# * {Types::ListCollaborationMLInputChannelsResponse#collaboration_ml_input_channels_list #collaboration_ml_input_channels_list} => Array<Types::CollaborationMLInputChannelSummary>
|
2615
|
+
#
|
2616
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1037
2617
|
#
|
1038
2618
|
# @example Request syntax with placeholder values
|
1039
2619
|
#
|
1040
|
-
# resp = client.
|
1041
|
-
#
|
2620
|
+
# resp = client.list_collaboration_ml_input_channels({
|
2621
|
+
# next_token: "NextToken",
|
2622
|
+
# max_results: 1,
|
2623
|
+
# collaboration_identifier: "UUID", # required
|
1042
2624
|
# })
|
1043
2625
|
#
|
1044
2626
|
# @example Response structure
|
1045
2627
|
#
|
1046
|
-
# resp.
|
1047
|
-
# resp.
|
1048
|
-
# resp.
|
1049
|
-
# resp.
|
1050
|
-
# resp.
|
1051
|
-
# resp.
|
1052
|
-
# resp.
|
1053
|
-
# resp.
|
1054
|
-
# resp.
|
1055
|
-
# resp.
|
1056
|
-
# resp.
|
1057
|
-
# resp.
|
1058
|
-
# resp.
|
1059
|
-
#
|
1060
|
-
#
|
1061
|
-
#
|
1062
|
-
#
|
1063
|
-
# resp.child_resource_tag_on_create_policy #=> String, one of "FROM_PARENT_RESOURCE", "NONE"
|
1064
|
-
#
|
1065
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModel AWS API Documentation
|
1066
|
-
#
|
1067
|
-
# @overload get_configured_audience_model(params = {})
|
2628
|
+
# resp.next_token #=> String
|
2629
|
+
# resp.collaboration_ml_input_channels_list #=> Array
|
2630
|
+
# resp.collaboration_ml_input_channels_list[0].create_time #=> Time
|
2631
|
+
# resp.collaboration_ml_input_channels_list[0].update_time #=> Time
|
2632
|
+
# resp.collaboration_ml_input_channels_list[0].membership_identifier #=> String
|
2633
|
+
# resp.collaboration_ml_input_channels_list[0].collaboration_identifier #=> String
|
2634
|
+
# resp.collaboration_ml_input_channels_list[0].name #=> String
|
2635
|
+
# resp.collaboration_ml_input_channels_list[0].configured_model_algorithm_associations #=> Array
|
2636
|
+
# resp.collaboration_ml_input_channels_list[0].configured_model_algorithm_associations[0] #=> String
|
2637
|
+
# resp.collaboration_ml_input_channels_list[0].ml_input_channel_arn #=> String
|
2638
|
+
# resp.collaboration_ml_input_channels_list[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED", "INACTIVE"
|
2639
|
+
# resp.collaboration_ml_input_channels_list[0].creator_account_id #=> String
|
2640
|
+
# resp.collaboration_ml_input_channels_list[0].description #=> String
|
2641
|
+
#
|
2642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationMLInputChannels AWS API Documentation
|
2643
|
+
#
|
2644
|
+
# @overload list_collaboration_ml_input_channels(params = {})
|
1068
2645
|
# @param [Hash] params ({})
|
1069
|
-
def
|
1070
|
-
req = build_request(:
|
2646
|
+
def list_collaboration_ml_input_channels(params = {}, options = {})
|
2647
|
+
req = build_request(:list_collaboration_ml_input_channels, params)
|
1071
2648
|
req.send_request(options)
|
1072
2649
|
end
|
1073
2650
|
|
1074
|
-
# Returns
|
2651
|
+
# Returns a list of the export jobs for a trained model in a
|
2652
|
+
# collaboration.
|
1075
2653
|
#
|
1076
|
-
# @option params [
|
1077
|
-
# The
|
1078
|
-
#
|
2654
|
+
# @option params [String] :next_token
|
2655
|
+
# The token value retrieved from a previous call to access the next page
|
2656
|
+
# of results.
|
1079
2657
|
#
|
1080
|
-
# @
|
2658
|
+
# @option params [Integer] :max_results
|
2659
|
+
# The maximum size of the results that is returned per call.
|
1081
2660
|
#
|
1082
|
-
#
|
1083
|
-
#
|
1084
|
-
#
|
2661
|
+
# @option params [required, String] :collaboration_identifier
|
2662
|
+
# The collaboration ID of the collaboration that contains the trained
|
2663
|
+
# model export jobs that you are interested in.
|
2664
|
+
#
|
2665
|
+
# @option params [required, String] :trained_model_arn
|
2666
|
+
# The Amazon Resource Name (ARN) of the trained model that was used to
|
2667
|
+
# create the export jobs that you are interested in.
|
2668
|
+
#
|
2669
|
+
# @return [Types::ListCollaborationTrainedModelExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2670
|
+
#
|
2671
|
+
# * {Types::ListCollaborationTrainedModelExportJobsResponse#next_token #next_token} => String
|
2672
|
+
# * {Types::ListCollaborationTrainedModelExportJobsResponse#collaboration_trained_model_export_jobs #collaboration_trained_model_export_jobs} => Array<Types::CollaborationTrainedModelExportJobSummary>
|
2673
|
+
#
|
2674
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1085
2675
|
#
|
1086
2676
|
# @example Request syntax with placeholder values
|
1087
2677
|
#
|
1088
|
-
# resp = client.
|
1089
|
-
#
|
2678
|
+
# resp = client.list_collaboration_trained_model_export_jobs({
|
2679
|
+
# next_token: "NextToken",
|
2680
|
+
# max_results: 1,
|
2681
|
+
# collaboration_identifier: "UUID", # required
|
2682
|
+
# trained_model_arn: "TrainedModelArn", # required
|
1090
2683
|
# })
|
1091
2684
|
#
|
1092
2685
|
# @example Response structure
|
1093
2686
|
#
|
1094
|
-
# resp.
|
1095
|
-
# resp.
|
1096
|
-
# resp.
|
1097
|
-
#
|
1098
|
-
#
|
1099
|
-
#
|
1100
|
-
#
|
2687
|
+
# resp.next_token #=> String
|
2688
|
+
# resp.collaboration_trained_model_export_jobs #=> Array
|
2689
|
+
# resp.collaboration_trained_model_export_jobs[0].create_time #=> Time
|
2690
|
+
# resp.collaboration_trained_model_export_jobs[0].update_time #=> Time
|
2691
|
+
# resp.collaboration_trained_model_export_jobs[0].name #=> String
|
2692
|
+
# resp.collaboration_trained_model_export_jobs[0].output_configuration.members #=> Array
|
2693
|
+
# resp.collaboration_trained_model_export_jobs[0].output_configuration.members[0].account_id #=> String
|
2694
|
+
# resp.collaboration_trained_model_export_jobs[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE"
|
2695
|
+
# resp.collaboration_trained_model_export_jobs[0].status_details.status_code #=> String
|
2696
|
+
# resp.collaboration_trained_model_export_jobs[0].status_details.message #=> String
|
2697
|
+
# resp.collaboration_trained_model_export_jobs[0].description #=> String
|
2698
|
+
# resp.collaboration_trained_model_export_jobs[0].creator_account_id #=> String
|
2699
|
+
# resp.collaboration_trained_model_export_jobs[0].trained_model_arn #=> String
|
2700
|
+
# resp.collaboration_trained_model_export_jobs[0].membership_identifier #=> String
|
2701
|
+
# resp.collaboration_trained_model_export_jobs[0].collaboration_identifier #=> String
|
2702
|
+
#
|
2703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModelExportJobs AWS API Documentation
|
2704
|
+
#
|
2705
|
+
# @overload list_collaboration_trained_model_export_jobs(params = {})
|
1101
2706
|
# @param [Hash] params ({})
|
1102
|
-
def
|
1103
|
-
req = build_request(:
|
2707
|
+
def list_collaboration_trained_model_export_jobs(params = {}, options = {})
|
2708
|
+
req = build_request(:list_collaboration_trained_model_export_jobs, params)
|
1104
2709
|
req.send_request(options)
|
1105
2710
|
end
|
1106
2711
|
|
1107
|
-
# Returns
|
2712
|
+
# Returns a list of trained model inference jobs in a specified
|
2713
|
+
# collaboration.
|
1108
2714
|
#
|
1109
|
-
# @option params [
|
1110
|
-
# The
|
1111
|
-
#
|
2715
|
+
# @option params [String] :next_token
|
2716
|
+
# The token value retrieved from a previous call to access the next page
|
2717
|
+
# of results.
|
1112
2718
|
#
|
1113
|
-
# @
|
2719
|
+
# @option params [Integer] :max_results
|
2720
|
+
# The maximum size of the results that is returned per call.
|
1114
2721
|
#
|
1115
|
-
#
|
1116
|
-
#
|
1117
|
-
#
|
1118
|
-
#
|
1119
|
-
#
|
1120
|
-
#
|
1121
|
-
#
|
1122
|
-
#
|
1123
|
-
#
|
2722
|
+
# @option params [required, String] :collaboration_identifier
|
2723
|
+
# The collaboration ID of the collaboration that contains the trained
|
2724
|
+
# model inference jobs that you are interested in.
|
2725
|
+
#
|
2726
|
+
# @option params [String] :trained_model_arn
|
2727
|
+
# The Amazon Resource Name (ARN) of the trained model that was used to
|
2728
|
+
# create the trained model inference jobs that you are interested in.
|
2729
|
+
#
|
2730
|
+
# @return [Types::ListCollaborationTrainedModelInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2731
|
+
#
|
2732
|
+
# * {Types::ListCollaborationTrainedModelInferenceJobsResponse#next_token #next_token} => String
|
2733
|
+
# * {Types::ListCollaborationTrainedModelInferenceJobsResponse#collaboration_trained_model_inference_jobs #collaboration_trained_model_inference_jobs} => Array<Types::CollaborationTrainedModelInferenceJobSummary>
|
2734
|
+
#
|
2735
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1124
2736
|
#
|
1125
2737
|
# @example Request syntax with placeholder values
|
1126
2738
|
#
|
1127
|
-
# resp = client.
|
1128
|
-
#
|
2739
|
+
# resp = client.list_collaboration_trained_model_inference_jobs({
|
2740
|
+
# next_token: "NextToken",
|
2741
|
+
# max_results: 1,
|
2742
|
+
# collaboration_identifier: "UUID", # required
|
2743
|
+
# trained_model_arn: "TrainedModelArn",
|
1129
2744
|
# })
|
1130
2745
|
#
|
1131
2746
|
# @example Response structure
|
1132
2747
|
#
|
1133
|
-
# resp.
|
1134
|
-
# resp.
|
1135
|
-
# resp.
|
1136
|
-
# resp.
|
1137
|
-
# resp.
|
1138
|
-
# resp.
|
1139
|
-
# resp.
|
1140
|
-
# resp.
|
1141
|
-
# resp.
|
1142
|
-
# resp.
|
1143
|
-
# resp.
|
1144
|
-
# resp.
|
1145
|
-
# resp.
|
1146
|
-
# resp.
|
1147
|
-
# resp.
|
1148
|
-
# resp.
|
1149
|
-
# resp.
|
1150
|
-
# resp.
|
2748
|
+
# resp.next_token #=> String
|
2749
|
+
# resp.collaboration_trained_model_inference_jobs #=> Array
|
2750
|
+
# resp.collaboration_trained_model_inference_jobs[0].trained_model_inference_job_arn #=> String
|
2751
|
+
# resp.collaboration_trained_model_inference_jobs[0].configured_model_algorithm_association_arn #=> String
|
2752
|
+
# resp.collaboration_trained_model_inference_jobs[0].membership_identifier #=> String
|
2753
|
+
# resp.collaboration_trained_model_inference_jobs[0].trained_model_arn #=> String
|
2754
|
+
# resp.collaboration_trained_model_inference_jobs[0].collaboration_identifier #=> String
|
2755
|
+
# resp.collaboration_trained_model_inference_jobs[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "CANCEL_PENDING", "CANCEL_IN_PROGRESS", "CANCEL_FAILED", "INACTIVE"
|
2756
|
+
# resp.collaboration_trained_model_inference_jobs[0].output_configuration.accept #=> String
|
2757
|
+
# resp.collaboration_trained_model_inference_jobs[0].output_configuration.members #=> Array
|
2758
|
+
# resp.collaboration_trained_model_inference_jobs[0].output_configuration.members[0].account_id #=> String
|
2759
|
+
# resp.collaboration_trained_model_inference_jobs[0].name #=> String
|
2760
|
+
# resp.collaboration_trained_model_inference_jobs[0].description #=> String
|
2761
|
+
# resp.collaboration_trained_model_inference_jobs[0].metrics_status #=> String, one of "PUBLISH_SUCCEEDED", "PUBLISH_FAILED"
|
2762
|
+
# resp.collaboration_trained_model_inference_jobs[0].metrics_status_details #=> String
|
2763
|
+
# resp.collaboration_trained_model_inference_jobs[0].logs_status #=> String, one of "PUBLISH_SUCCEEDED", "PUBLISH_FAILED"
|
2764
|
+
# resp.collaboration_trained_model_inference_jobs[0].logs_status_details #=> String
|
2765
|
+
# resp.collaboration_trained_model_inference_jobs[0].create_time #=> Time
|
2766
|
+
# resp.collaboration_trained_model_inference_jobs[0].update_time #=> Time
|
2767
|
+
# resp.collaboration_trained_model_inference_jobs[0].creator_account_id #=> String
|
2768
|
+
#
|
2769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModelInferenceJobs AWS API Documentation
|
2770
|
+
#
|
2771
|
+
# @overload list_collaboration_trained_model_inference_jobs(params = {})
|
2772
|
+
# @param [Hash] params ({})
|
2773
|
+
def list_collaboration_trained_model_inference_jobs(params = {}, options = {})
|
2774
|
+
req = build_request(:list_collaboration_trained_model_inference_jobs, params)
|
2775
|
+
req.send_request(options)
|
2776
|
+
end
|
2777
|
+
|
2778
|
+
# Returns a list of the trained models in a collaboration.
|
1151
2779
|
#
|
1152
|
-
# @
|
2780
|
+
# @option params [String] :next_token
|
2781
|
+
# The token value retrieved from a previous call to access the next page
|
2782
|
+
# of results.
|
1153
2783
|
#
|
1154
|
-
# @
|
2784
|
+
# @option params [Integer] :max_results
|
2785
|
+
# The maximum size of the results that is returned per call.
|
2786
|
+
#
|
2787
|
+
# @option params [required, String] :collaboration_identifier
|
2788
|
+
# The collaboration ID of the collaboration that contains the trained
|
2789
|
+
# models you are interested in.
|
2790
|
+
#
|
2791
|
+
# @return [Types::ListCollaborationTrainedModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2792
|
+
#
|
2793
|
+
# * {Types::ListCollaborationTrainedModelsResponse#next_token #next_token} => String
|
2794
|
+
# * {Types::ListCollaborationTrainedModelsResponse#collaboration_trained_models #collaboration_trained_models} => Array<Types::CollaborationTrainedModelSummary>
|
2795
|
+
#
|
2796
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2797
|
+
#
|
2798
|
+
# @example Request syntax with placeholder values
|
2799
|
+
#
|
2800
|
+
# resp = client.list_collaboration_trained_models({
|
2801
|
+
# next_token: "NextToken",
|
2802
|
+
# max_results: 1,
|
2803
|
+
# collaboration_identifier: "UUID", # required
|
2804
|
+
# })
|
2805
|
+
#
|
2806
|
+
# @example Response structure
|
2807
|
+
#
|
2808
|
+
# resp.next_token #=> String
|
2809
|
+
# resp.collaboration_trained_models #=> Array
|
2810
|
+
# resp.collaboration_trained_models[0].create_time #=> Time
|
2811
|
+
# resp.collaboration_trained_models[0].update_time #=> Time
|
2812
|
+
# resp.collaboration_trained_models[0].trained_model_arn #=> String
|
2813
|
+
# resp.collaboration_trained_models[0].name #=> String
|
2814
|
+
# resp.collaboration_trained_models[0].description #=> String
|
2815
|
+
# resp.collaboration_trained_models[0].membership_identifier #=> String
|
2816
|
+
# resp.collaboration_trained_models[0].collaboration_identifier #=> String
|
2817
|
+
# resp.collaboration_trained_models[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED", "INACTIVE", "CANCEL_PENDING", "CANCEL_IN_PROGRESS", "CANCEL_FAILED"
|
2818
|
+
# resp.collaboration_trained_models[0].configured_model_algorithm_association_arn #=> String
|
2819
|
+
# resp.collaboration_trained_models[0].creator_account_id #=> String
|
2820
|
+
#
|
2821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListCollaborationTrainedModels AWS API Documentation
|
2822
|
+
#
|
2823
|
+
# @overload list_collaboration_trained_models(params = {})
|
1155
2824
|
# @param [Hash] params ({})
|
1156
|
-
def
|
1157
|
-
req = build_request(:
|
2825
|
+
def list_collaboration_trained_models(params = {}, options = {})
|
2826
|
+
req = build_request(:list_collaboration_trained_models, params)
|
1158
2827
|
req.send_request(options)
|
1159
2828
|
end
|
1160
2829
|
|
1161
|
-
# Returns a list of the audience
|
2830
|
+
# Returns a list of the configured audience models.
|
1162
2831
|
#
|
1163
2832
|
# @option params [String] :next_token
|
1164
2833
|
# The token value retrieved from a previous call to access the next page
|
@@ -1167,51 +2836,44 @@ module Aws::CleanRoomsML
|
|
1167
2836
|
# @option params [Integer] :max_results
|
1168
2837
|
# The maximum size of the results that is returned per call.
|
1169
2838
|
#
|
1170
|
-
# @
|
1171
|
-
# The Amazon Resource Name (ARN) of the audience generation job that you
|
1172
|
-
# are interested in.
|
1173
|
-
#
|
1174
|
-
# @return [Types::ListAudienceExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2839
|
+
# @return [Types::ListConfiguredAudienceModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1175
2840
|
#
|
1176
|
-
# * {Types::
|
1177
|
-
# * {Types::
|
2841
|
+
# * {Types::ListConfiguredAudienceModelsResponse#next_token #next_token} => String
|
2842
|
+
# * {Types::ListConfiguredAudienceModelsResponse#configured_audience_models #configured_audience_models} => Array<Types::ConfiguredAudienceModelSummary>
|
1178
2843
|
#
|
1179
2844
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1180
2845
|
#
|
1181
2846
|
# @example Request syntax with placeholder values
|
1182
2847
|
#
|
1183
|
-
# resp = client.
|
2848
|
+
# resp = client.list_configured_audience_models({
|
1184
2849
|
# next_token: "NextToken",
|
1185
2850
|
# max_results: 1,
|
1186
|
-
# audience_generation_job_arn: "AudienceGenerationJobArn",
|
1187
2851
|
# })
|
1188
2852
|
#
|
1189
2853
|
# @example Response structure
|
1190
2854
|
#
|
1191
2855
|
# resp.next_token #=> String
|
1192
|
-
# resp.
|
1193
|
-
# resp.
|
1194
|
-
# resp.
|
1195
|
-
# resp.
|
1196
|
-
# resp.
|
1197
|
-
# resp.
|
1198
|
-
# resp.
|
1199
|
-
# resp.
|
1200
|
-
# resp.
|
1201
|
-
# resp.
|
1202
|
-
# resp.audience_export_jobs[0].status_details.message #=> String
|
1203
|
-
# resp.audience_export_jobs[0].output_location #=> String
|
2856
|
+
# resp.configured_audience_models #=> Array
|
2857
|
+
# resp.configured_audience_models[0].create_time #=> Time
|
2858
|
+
# resp.configured_audience_models[0].update_time #=> Time
|
2859
|
+
# resp.configured_audience_models[0].name #=> String
|
2860
|
+
# resp.configured_audience_models[0].audience_model_arn #=> String
|
2861
|
+
# resp.configured_audience_models[0].output_config.destination.s3_destination.s3_uri #=> String
|
2862
|
+
# resp.configured_audience_models[0].output_config.role_arn #=> String
|
2863
|
+
# resp.configured_audience_models[0].description #=> String
|
2864
|
+
# resp.configured_audience_models[0].configured_audience_model_arn #=> String
|
2865
|
+
# resp.configured_audience_models[0].status #=> String, one of "ACTIVE"
|
1204
2866
|
#
|
1205
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/
|
2867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModels AWS API Documentation
|
1206
2868
|
#
|
1207
|
-
# @overload
|
2869
|
+
# @overload list_configured_audience_models(params = {})
|
1208
2870
|
# @param [Hash] params ({})
|
1209
|
-
def
|
1210
|
-
req = build_request(:
|
2871
|
+
def list_configured_audience_models(params = {}, options = {})
|
2872
|
+
req = build_request(:list_configured_audience_models, params)
|
1211
2873
|
req.send_request(options)
|
1212
2874
|
end
|
1213
2875
|
|
1214
|
-
# Returns a list of
|
2876
|
+
# Returns a list of configured model algorithm associations.
|
1215
2877
|
#
|
1216
2878
|
# @option params [String] :next_token
|
1217
2879
|
# The token value retrieved from a previous call to access the next page
|
@@ -1220,54 +2882,48 @@ module Aws::CleanRoomsML
|
|
1220
2882
|
# @option params [Integer] :max_results
|
1221
2883
|
# The maximum size of the results that is returned per call.
|
1222
2884
|
#
|
1223
|
-
# @option params [String] :
|
1224
|
-
# The
|
1225
|
-
#
|
1226
|
-
#
|
1227
|
-
# @option params [String] :collaboration_id
|
1228
|
-
# The identifier of the collaboration that contains the audience
|
1229
|
-
# generation jobs that you are interested in.
|
2885
|
+
# @option params [required, String] :membership_identifier
|
2886
|
+
# The membership ID of the member that created the configured model
|
2887
|
+
# algorithm associations you are interested in.
|
1230
2888
|
#
|
1231
|
-
# @return [Types::
|
2889
|
+
# @return [Types::ListConfiguredModelAlgorithmAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1232
2890
|
#
|
1233
|
-
# * {Types::
|
1234
|
-
# * {Types::
|
2891
|
+
# * {Types::ListConfiguredModelAlgorithmAssociationsResponse#next_token #next_token} => String
|
2892
|
+
# * {Types::ListConfiguredModelAlgorithmAssociationsResponse#configured_model_algorithm_associations #configured_model_algorithm_associations} => Array<Types::ConfiguredModelAlgorithmAssociationSummary>
|
1235
2893
|
#
|
1236
2894
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1237
2895
|
#
|
1238
2896
|
# @example Request syntax with placeholder values
|
1239
2897
|
#
|
1240
|
-
# resp = client.
|
2898
|
+
# resp = client.list_configured_model_algorithm_associations({
|
1241
2899
|
# next_token: "NextToken",
|
1242
2900
|
# max_results: 1,
|
1243
|
-
#
|
1244
|
-
# collaboration_id: "UUID",
|
2901
|
+
# membership_identifier: "UUID", # required
|
1245
2902
|
# })
|
1246
2903
|
#
|
1247
2904
|
# @example Response structure
|
1248
2905
|
#
|
1249
2906
|
# resp.next_token #=> String
|
1250
|
-
# resp.
|
1251
|
-
# resp.
|
1252
|
-
# resp.
|
1253
|
-
# resp.
|
1254
|
-
# resp.
|
1255
|
-
# resp.
|
1256
|
-
# resp.
|
1257
|
-
# resp.
|
1258
|
-
# resp.
|
1259
|
-
#
|
1260
|
-
#
|
1261
|
-
#
|
1262
|
-
#
|
1263
|
-
# @overload list_audience_generation_jobs(params = {})
|
2907
|
+
# resp.configured_model_algorithm_associations #=> Array
|
2908
|
+
# resp.configured_model_algorithm_associations[0].create_time #=> Time
|
2909
|
+
# resp.configured_model_algorithm_associations[0].update_time #=> Time
|
2910
|
+
# resp.configured_model_algorithm_associations[0].configured_model_algorithm_association_arn #=> String
|
2911
|
+
# resp.configured_model_algorithm_associations[0].configured_model_algorithm_arn #=> String
|
2912
|
+
# resp.configured_model_algorithm_associations[0].name #=> String
|
2913
|
+
# resp.configured_model_algorithm_associations[0].description #=> String
|
2914
|
+
# resp.configured_model_algorithm_associations[0].membership_identifier #=> String
|
2915
|
+
# resp.configured_model_algorithm_associations[0].collaboration_identifier #=> String
|
2916
|
+
#
|
2917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredModelAlgorithmAssociations AWS API Documentation
|
2918
|
+
#
|
2919
|
+
# @overload list_configured_model_algorithm_associations(params = {})
|
1264
2920
|
# @param [Hash] params ({})
|
1265
|
-
def
|
1266
|
-
req = build_request(:
|
2921
|
+
def list_configured_model_algorithm_associations(params = {}, options = {})
|
2922
|
+
req = build_request(:list_configured_model_algorithm_associations, params)
|
1267
2923
|
req.send_request(options)
|
1268
2924
|
end
|
1269
2925
|
|
1270
|
-
# Returns a list of
|
2926
|
+
# Returns a list of configured model algorithms.
|
1271
2927
|
#
|
1272
2928
|
# @option params [String] :next_token
|
1273
2929
|
# The token value retrieved from a previous call to access the next page
|
@@ -1276,16 +2932,16 @@ module Aws::CleanRoomsML
|
|
1276
2932
|
# @option params [Integer] :max_results
|
1277
2933
|
# The maximum size of the results that is returned per call.
|
1278
2934
|
#
|
1279
|
-
# @return [Types::
|
2935
|
+
# @return [Types::ListConfiguredModelAlgorithmsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1280
2936
|
#
|
1281
|
-
# * {Types::
|
1282
|
-
# * {Types::
|
2937
|
+
# * {Types::ListConfiguredModelAlgorithmsResponse#next_token #next_token} => String
|
2938
|
+
# * {Types::ListConfiguredModelAlgorithmsResponse#configured_model_algorithms #configured_model_algorithms} => Array<Types::ConfiguredModelAlgorithmSummary>
|
1283
2939
|
#
|
1284
2940
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1285
2941
|
#
|
1286
2942
|
# @example Request syntax with placeholder values
|
1287
2943
|
#
|
1288
|
-
# resp = client.
|
2944
|
+
# resp = client.list_configured_model_algorithms({
|
1289
2945
|
# next_token: "NextToken",
|
1290
2946
|
# max_results: 1,
|
1291
2947
|
# })
|
@@ -1293,67 +2949,72 @@ module Aws::CleanRoomsML
|
|
1293
2949
|
# @example Response structure
|
1294
2950
|
#
|
1295
2951
|
# resp.next_token #=> String
|
1296
|
-
# resp.
|
1297
|
-
# resp.
|
1298
|
-
# resp.
|
1299
|
-
# resp.
|
1300
|
-
# resp.
|
1301
|
-
# resp.
|
1302
|
-
# resp.audience_models[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
1303
|
-
# resp.audience_models[0].description #=> String
|
2952
|
+
# resp.configured_model_algorithms #=> Array
|
2953
|
+
# resp.configured_model_algorithms[0].create_time #=> Time
|
2954
|
+
# resp.configured_model_algorithms[0].update_time #=> Time
|
2955
|
+
# resp.configured_model_algorithms[0].configured_model_algorithm_arn #=> String
|
2956
|
+
# resp.configured_model_algorithms[0].name #=> String
|
2957
|
+
# resp.configured_model_algorithms[0].description #=> String
|
1304
2958
|
#
|
1305
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/
|
2959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredModelAlgorithms AWS API Documentation
|
1306
2960
|
#
|
1307
|
-
# @overload
|
2961
|
+
# @overload list_configured_model_algorithms(params = {})
|
1308
2962
|
# @param [Hash] params ({})
|
1309
|
-
def
|
1310
|
-
req = build_request(:
|
2963
|
+
def list_configured_model_algorithms(params = {}, options = {})
|
2964
|
+
req = build_request(:list_configured_model_algorithms, params)
|
1311
2965
|
req.send_request(options)
|
1312
2966
|
end
|
1313
2967
|
|
1314
|
-
# Returns a list of
|
2968
|
+
# Returns a list of ML input channels.
|
1315
2969
|
#
|
1316
2970
|
# @option params [String] :next_token
|
1317
2971
|
# The token value retrieved from a previous call to access the next page
|
1318
2972
|
# of results.
|
1319
2973
|
#
|
1320
2974
|
# @option params [Integer] :max_results
|
1321
|
-
# The maximum
|
2975
|
+
# The maximum number of ML input channels to return.
|
1322
2976
|
#
|
1323
|
-
# @
|
2977
|
+
# @option params [required, String] :membership_identifier
|
2978
|
+
# The membership ID of the membership that contains the ML input
|
2979
|
+
# channels that you want to list.
|
1324
2980
|
#
|
1325
|
-
#
|
1326
|
-
#
|
2981
|
+
# @return [Types::ListMLInputChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2982
|
+
#
|
2983
|
+
# * {Types::ListMLInputChannelsResponse#next_token #next_token} => String
|
2984
|
+
# * {Types::ListMLInputChannelsResponse#ml_input_channels_list #ml_input_channels_list} => Array<Types::MLInputChannelSummary>
|
1327
2985
|
#
|
1328
2986
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1329
2987
|
#
|
1330
2988
|
# @example Request syntax with placeholder values
|
1331
2989
|
#
|
1332
|
-
# resp = client.
|
2990
|
+
# resp = client.list_ml_input_channels({
|
1333
2991
|
# next_token: "NextToken",
|
1334
2992
|
# max_results: 1,
|
2993
|
+
# membership_identifier: "UUID", # required
|
1335
2994
|
# })
|
1336
2995
|
#
|
1337
2996
|
# @example Response structure
|
1338
2997
|
#
|
1339
2998
|
# resp.next_token #=> String
|
1340
|
-
# resp.
|
1341
|
-
# resp.
|
1342
|
-
# resp.
|
1343
|
-
# resp.
|
1344
|
-
# resp.
|
1345
|
-
# resp.
|
1346
|
-
# resp.
|
1347
|
-
# resp.
|
1348
|
-
# resp.
|
1349
|
-
# resp.
|
1350
|
-
#
|
1351
|
-
#
|
1352
|
-
#
|
1353
|
-
# @
|
2999
|
+
# resp.ml_input_channels_list #=> Array
|
3000
|
+
# resp.ml_input_channels_list[0].create_time #=> Time
|
3001
|
+
# resp.ml_input_channels_list[0].update_time #=> Time
|
3002
|
+
# resp.ml_input_channels_list[0].membership_identifier #=> String
|
3003
|
+
# resp.ml_input_channels_list[0].collaboration_identifier #=> String
|
3004
|
+
# resp.ml_input_channels_list[0].name #=> String
|
3005
|
+
# resp.ml_input_channels_list[0].configured_model_algorithm_associations #=> Array
|
3006
|
+
# resp.ml_input_channels_list[0].configured_model_algorithm_associations[0] #=> String
|
3007
|
+
# resp.ml_input_channels_list[0].protected_query_identifier #=> String
|
3008
|
+
# resp.ml_input_channels_list[0].ml_input_channel_arn #=> String
|
3009
|
+
# resp.ml_input_channels_list[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED", "INACTIVE"
|
3010
|
+
# resp.ml_input_channels_list[0].description #=> String
|
3011
|
+
#
|
3012
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListMLInputChannels AWS API Documentation
|
3013
|
+
#
|
3014
|
+
# @overload list_ml_input_channels(params = {})
|
1354
3015
|
# @param [Hash] params ({})
|
1355
|
-
def
|
1356
|
-
req = build_request(:
|
3016
|
+
def list_ml_input_channels(params = {}, options = {})
|
3017
|
+
req = build_request(:list_ml_input_channels, params)
|
1357
3018
|
req.send_request(options)
|
1358
3019
|
end
|
1359
3020
|
|
@@ -1387,6 +3048,121 @@ module Aws::CleanRoomsML
|
|
1387
3048
|
req.send_request(options)
|
1388
3049
|
end
|
1389
3050
|
|
3051
|
+
# Returns a list of trained model inference jobs that match the request
|
3052
|
+
# parameters.
|
3053
|
+
#
|
3054
|
+
# @option params [String] :next_token
|
3055
|
+
# The token value retrieved from a previous call to access the next page
|
3056
|
+
# of results.
|
3057
|
+
#
|
3058
|
+
# @option params [Integer] :max_results
|
3059
|
+
# The maximum size of the results that is returned per call.
|
3060
|
+
#
|
3061
|
+
# @option params [required, String] :membership_identifier
|
3062
|
+
# The membership
|
3063
|
+
#
|
3064
|
+
# @option params [String] :trained_model_arn
|
3065
|
+
# The Amazon Resource Name (ARN) of a trained model that was used to
|
3066
|
+
# create the trained model inference jobs that you are interested in.
|
3067
|
+
#
|
3068
|
+
# @return [Types::ListTrainedModelInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3069
|
+
#
|
3070
|
+
# * {Types::ListTrainedModelInferenceJobsResponse#next_token #next_token} => String
|
3071
|
+
# * {Types::ListTrainedModelInferenceJobsResponse#trained_model_inference_jobs #trained_model_inference_jobs} => Array<Types::TrainedModelInferenceJobSummary>
|
3072
|
+
#
|
3073
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3074
|
+
#
|
3075
|
+
# @example Request syntax with placeholder values
|
3076
|
+
#
|
3077
|
+
# resp = client.list_trained_model_inference_jobs({
|
3078
|
+
# next_token: "NextToken",
|
3079
|
+
# max_results: 1,
|
3080
|
+
# membership_identifier: "UUID", # required
|
3081
|
+
# trained_model_arn: "TrainedModelArn",
|
3082
|
+
# })
|
3083
|
+
#
|
3084
|
+
# @example Response structure
|
3085
|
+
#
|
3086
|
+
# resp.next_token #=> String
|
3087
|
+
# resp.trained_model_inference_jobs #=> Array
|
3088
|
+
# resp.trained_model_inference_jobs[0].trained_model_inference_job_arn #=> String
|
3089
|
+
# resp.trained_model_inference_jobs[0].configured_model_algorithm_association_arn #=> String
|
3090
|
+
# resp.trained_model_inference_jobs[0].membership_identifier #=> String
|
3091
|
+
# resp.trained_model_inference_jobs[0].trained_model_arn #=> String
|
3092
|
+
# resp.trained_model_inference_jobs[0].collaboration_identifier #=> String
|
3093
|
+
# resp.trained_model_inference_jobs[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "CANCEL_PENDING", "CANCEL_IN_PROGRESS", "CANCEL_FAILED", "INACTIVE"
|
3094
|
+
# resp.trained_model_inference_jobs[0].output_configuration.accept #=> String
|
3095
|
+
# resp.trained_model_inference_jobs[0].output_configuration.members #=> Array
|
3096
|
+
# resp.trained_model_inference_jobs[0].output_configuration.members[0].account_id #=> String
|
3097
|
+
# resp.trained_model_inference_jobs[0].name #=> String
|
3098
|
+
# resp.trained_model_inference_jobs[0].description #=> String
|
3099
|
+
# resp.trained_model_inference_jobs[0].metrics_status #=> String, one of "PUBLISH_SUCCEEDED", "PUBLISH_FAILED"
|
3100
|
+
# resp.trained_model_inference_jobs[0].metrics_status_details #=> String
|
3101
|
+
# resp.trained_model_inference_jobs[0].logs_status #=> String, one of "PUBLISH_SUCCEEDED", "PUBLISH_FAILED"
|
3102
|
+
# resp.trained_model_inference_jobs[0].logs_status_details #=> String
|
3103
|
+
# resp.trained_model_inference_jobs[0].create_time #=> Time
|
3104
|
+
# resp.trained_model_inference_jobs[0].update_time #=> Time
|
3105
|
+
#
|
3106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainedModelInferenceJobs AWS API Documentation
|
3107
|
+
#
|
3108
|
+
# @overload list_trained_model_inference_jobs(params = {})
|
3109
|
+
# @param [Hash] params ({})
|
3110
|
+
def list_trained_model_inference_jobs(params = {}, options = {})
|
3111
|
+
req = build_request(:list_trained_model_inference_jobs, params)
|
3112
|
+
req.send_request(options)
|
3113
|
+
end
|
3114
|
+
|
3115
|
+
# Returns a list of trained models.
|
3116
|
+
#
|
3117
|
+
# @option params [String] :next_token
|
3118
|
+
# The token value retrieved from a previous call to access the next page
|
3119
|
+
# of results.
|
3120
|
+
#
|
3121
|
+
# @option params [Integer] :max_results
|
3122
|
+
# The maximum size of the results that is returned per call.
|
3123
|
+
#
|
3124
|
+
# @option params [required, String] :membership_identifier
|
3125
|
+
# The membership ID of the member that created the trained models you
|
3126
|
+
# are interested in.
|
3127
|
+
#
|
3128
|
+
# @return [Types::ListTrainedModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3129
|
+
#
|
3130
|
+
# * {Types::ListTrainedModelsResponse#next_token #next_token} => String
|
3131
|
+
# * {Types::ListTrainedModelsResponse#trained_models #trained_models} => Array<Types::TrainedModelSummary>
|
3132
|
+
#
|
3133
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3134
|
+
#
|
3135
|
+
# @example Request syntax with placeholder values
|
3136
|
+
#
|
3137
|
+
# resp = client.list_trained_models({
|
3138
|
+
# next_token: "NextToken",
|
3139
|
+
# max_results: 1,
|
3140
|
+
# membership_identifier: "UUID", # required
|
3141
|
+
# })
|
3142
|
+
#
|
3143
|
+
# @example Response structure
|
3144
|
+
#
|
3145
|
+
# resp.next_token #=> String
|
3146
|
+
# resp.trained_models #=> Array
|
3147
|
+
# resp.trained_models[0].create_time #=> Time
|
3148
|
+
# resp.trained_models[0].update_time #=> Time
|
3149
|
+
# resp.trained_models[0].trained_model_arn #=> String
|
3150
|
+
# resp.trained_models[0].name #=> String
|
3151
|
+
# resp.trained_models[0].description #=> String
|
3152
|
+
# resp.trained_models[0].membership_identifier #=> String
|
3153
|
+
# resp.trained_models[0].collaboration_identifier #=> String
|
3154
|
+
# resp.trained_models[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED", "INACTIVE", "CANCEL_PENDING", "CANCEL_IN_PROGRESS", "CANCEL_FAILED"
|
3155
|
+
# resp.trained_models[0].configured_model_algorithm_association_arn #=> String
|
3156
|
+
#
|
3157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainedModels AWS API Documentation
|
3158
|
+
#
|
3159
|
+
# @overload list_trained_models(params = {})
|
3160
|
+
# @param [Hash] params ({})
|
3161
|
+
def list_trained_models(params = {}, options = {})
|
3162
|
+
req = build_request(:list_trained_models, params)
|
3163
|
+
req.send_request(options)
|
3164
|
+
end
|
3165
|
+
|
1390
3166
|
# Returns a list of training datasets.
|
1391
3167
|
#
|
1392
3168
|
# @option params [String] :next_token
|
@@ -1474,6 +3250,40 @@ module Aws::CleanRoomsML
|
|
1474
3250
|
req.send_request(options)
|
1475
3251
|
end
|
1476
3252
|
|
3253
|
+
# Assigns information about an ML configuration.
|
3254
|
+
#
|
3255
|
+
# @option params [required, String] :membership_identifier
|
3256
|
+
# The membership ID of the member that is being configured.
|
3257
|
+
#
|
3258
|
+
# @option params [required, Types::MLOutputConfiguration] :default_output_location
|
3259
|
+
# The default Amazon S3 location where ML output is stored for the
|
3260
|
+
# specified member.
|
3261
|
+
#
|
3262
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3263
|
+
#
|
3264
|
+
# @example Request syntax with placeholder values
|
3265
|
+
#
|
3266
|
+
# resp = client.put_ml_configuration({
|
3267
|
+
# membership_identifier: "UUID", # required
|
3268
|
+
# default_output_location: { # required
|
3269
|
+
# destination: {
|
3270
|
+
# s3_destination: { # required
|
3271
|
+
# s3_uri: "S3Path", # required
|
3272
|
+
# },
|
3273
|
+
# },
|
3274
|
+
# role_arn: "IamRoleArn", # required
|
3275
|
+
# },
|
3276
|
+
# })
|
3277
|
+
#
|
3278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/PutMLConfiguration AWS API Documentation
|
3279
|
+
#
|
3280
|
+
# @overload put_ml_configuration(params = {})
|
3281
|
+
# @param [Hash] params ({})
|
3282
|
+
def put_ml_configuration(params = {}, options = {})
|
3283
|
+
req = build_request(:put_ml_configuration, params)
|
3284
|
+
req.send_request(options)
|
3285
|
+
end
|
3286
|
+
|
1477
3287
|
# Export an audience of a specified size after you have generated an
|
1478
3288
|
# audience.
|
1479
3289
|
#
|
@@ -1612,6 +3422,181 @@ module Aws::CleanRoomsML
|
|
1612
3422
|
req.send_request(options)
|
1613
3423
|
end
|
1614
3424
|
|
3425
|
+
# Provides the information necessary to start a trained model export
|
3426
|
+
# job.
|
3427
|
+
#
|
3428
|
+
# @option params [required, String] :name
|
3429
|
+
# The name of the trained model export job.
|
3430
|
+
#
|
3431
|
+
# @option params [required, String] :trained_model_arn
|
3432
|
+
# The Amazon Resource Name (ARN) of the trained model that you want to
|
3433
|
+
# export.
|
3434
|
+
#
|
3435
|
+
# @option params [required, String] :membership_identifier
|
3436
|
+
# The membership ID of the member that is receiving the exported trained
|
3437
|
+
# model artifacts.
|
3438
|
+
#
|
3439
|
+
# @option params [required, Types::TrainedModelExportOutputConfiguration] :output_configuration
|
3440
|
+
# The output configuration information for the trained model export job.
|
3441
|
+
#
|
3442
|
+
# @option params [String] :description
|
3443
|
+
# The description of the trained model export job.
|
3444
|
+
#
|
3445
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3446
|
+
#
|
3447
|
+
# @example Request syntax with placeholder values
|
3448
|
+
#
|
3449
|
+
# resp = client.start_trained_model_export_job({
|
3450
|
+
# name: "NameString", # required
|
3451
|
+
# trained_model_arn: "TrainedModelArn", # required
|
3452
|
+
# membership_identifier: "UUID", # required
|
3453
|
+
# output_configuration: { # required
|
3454
|
+
# members: [ # required
|
3455
|
+
# {
|
3456
|
+
# account_id: "AccountId", # required
|
3457
|
+
# },
|
3458
|
+
# ],
|
3459
|
+
# },
|
3460
|
+
# description: "ResourceDescription",
|
3461
|
+
# })
|
3462
|
+
#
|
3463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartTrainedModelExportJob AWS API Documentation
|
3464
|
+
#
|
3465
|
+
# @overload start_trained_model_export_job(params = {})
|
3466
|
+
# @param [Hash] params ({})
|
3467
|
+
def start_trained_model_export_job(params = {}, options = {})
|
3468
|
+
req = build_request(:start_trained_model_export_job, params)
|
3469
|
+
req.send_request(options)
|
3470
|
+
end
|
3471
|
+
|
3472
|
+
# Defines the information necessary to begin a trained model inference
|
3473
|
+
# job.
|
3474
|
+
#
|
3475
|
+
# @option params [required, String] :membership_identifier
|
3476
|
+
# The membership ID of the membership that contains the trained model
|
3477
|
+
# inference job.
|
3478
|
+
#
|
3479
|
+
# @option params [required, String] :name
|
3480
|
+
# The name of the trained model inference job.
|
3481
|
+
#
|
3482
|
+
# @option params [required, String] :trained_model_arn
|
3483
|
+
# The Amazon Resource Name (ARN) of the trained model that is used for
|
3484
|
+
# this trained model inference job.
|
3485
|
+
#
|
3486
|
+
# @option params [String] :configured_model_algorithm_association_arn
|
3487
|
+
# The Amazon Resource Name (ARN) of the configured model algorithm
|
3488
|
+
# association that is used for this trained model inference job.
|
3489
|
+
#
|
3490
|
+
# @option params [required, Types::InferenceResourceConfig] :resource_config
|
3491
|
+
# Defines the resource configuration for the trained model inference
|
3492
|
+
# job.
|
3493
|
+
#
|
3494
|
+
# @option params [required, Types::InferenceOutputConfiguration] :output_configuration
|
3495
|
+
# Defines the output configuration information for the trained model
|
3496
|
+
# inference job.
|
3497
|
+
#
|
3498
|
+
# @option params [required, Types::ModelInferenceDataSource] :data_source
|
3499
|
+
# Defines he data source that is used for the trained model inference
|
3500
|
+
# job.
|
3501
|
+
#
|
3502
|
+
# @option params [String] :description
|
3503
|
+
# The description of the trained model inference job.
|
3504
|
+
#
|
3505
|
+
# @option params [Types::InferenceContainerExecutionParameters] :container_execution_parameters
|
3506
|
+
# The execution parameters for the container.
|
3507
|
+
#
|
3508
|
+
# @option params [Hash<String,String>] :environment
|
3509
|
+
# The environment variables to set in the Docker container.
|
3510
|
+
#
|
3511
|
+
# @option params [String] :kms_key_arn
|
3512
|
+
# The Amazon Resource Name (ARN) of the KMS key. This key is used to
|
3513
|
+
# encrypt and decrypt customer-owned data in the ML inference job and
|
3514
|
+
# associated data.
|
3515
|
+
#
|
3516
|
+
# @option params [Hash<String,String>] :tags
|
3517
|
+
# The optional metadata that you apply to the resource to help you
|
3518
|
+
# categorize and organize them. Each tag consists of a key and an
|
3519
|
+
# optional value, both of which you define.
|
3520
|
+
#
|
3521
|
+
# The following basic restrictions apply to tags:
|
3522
|
+
#
|
3523
|
+
# * Maximum number of tags per resource - 50.
|
3524
|
+
#
|
3525
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
3526
|
+
# have only one value.
|
3527
|
+
#
|
3528
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
3529
|
+
#
|
3530
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
3531
|
+
#
|
3532
|
+
# * If your tagging schema is used across multiple services and
|
3533
|
+
# resources, remember that other services may have restrictions on
|
3534
|
+
# allowed characters. Generally allowed characters are: letters,
|
3535
|
+
# numbers, and spaces representable in UTF-8, and the following
|
3536
|
+
# characters: + - = . \_ : / @.
|
3537
|
+
#
|
3538
|
+
# * Tag keys and values are case sensitive.
|
3539
|
+
#
|
3540
|
+
# * Do not use aws:, AWS:, or any upper or lowercase combination of such
|
3541
|
+
# as a prefix for keys as it is reserved for AWS use. You cannot edit
|
3542
|
+
# or delete tag keys with this prefix. Values can have this prefix. If
|
3543
|
+
# a tag value has aws as its prefix but the key does not, then Clean
|
3544
|
+
# Rooms ML considers it to be a user tag and will count against the
|
3545
|
+
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
3546
|
+
# against your tags per resource limit.
|
3547
|
+
#
|
3548
|
+
# @return [Types::StartTrainedModelInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3549
|
+
#
|
3550
|
+
# * {Types::StartTrainedModelInferenceJobResponse#trained_model_inference_job_arn #trained_model_inference_job_arn} => String
|
3551
|
+
#
|
3552
|
+
# @example Request syntax with placeholder values
|
3553
|
+
#
|
3554
|
+
# resp = client.start_trained_model_inference_job({
|
3555
|
+
# membership_identifier: "UUID", # required
|
3556
|
+
# name: "NameString", # required
|
3557
|
+
# trained_model_arn: "TrainedModelArn", # required
|
3558
|
+
# configured_model_algorithm_association_arn: "ConfiguredModelAlgorithmAssociationArn",
|
3559
|
+
# resource_config: { # required
|
3560
|
+
# instance_type: "ml.r7i.48xlarge", # required, accepts ml.r7i.48xlarge, ml.r6i.16xlarge, ml.m6i.xlarge, ml.m5.4xlarge, ml.p2.xlarge, ml.m4.16xlarge, ml.r7i.16xlarge, ml.m7i.xlarge, ml.m6i.12xlarge, ml.r7i.8xlarge, ml.r7i.large, ml.m7i.12xlarge, ml.m6i.24xlarge, ml.m7i.24xlarge, ml.r6i.8xlarge, ml.r6i.large, ml.g5.2xlarge, ml.m5.large, ml.p3.16xlarge, ml.m7i.48xlarge, ml.m6i.16xlarge, ml.p2.16xlarge, ml.g5.4xlarge, ml.m7i.16xlarge, ml.c4.2xlarge, ml.c5.2xlarge, ml.c6i.32xlarge, ml.c4.4xlarge, ml.g5.8xlarge, ml.c6i.xlarge, ml.c5.4xlarge, ml.g4dn.xlarge, ml.c7i.xlarge, ml.c6i.12xlarge, ml.g4dn.12xlarge, ml.c7i.12xlarge, ml.c6i.24xlarge, ml.g4dn.2xlarge, ml.c7i.24xlarge, ml.c7i.2xlarge, ml.c4.8xlarge, ml.c6i.2xlarge, ml.g4dn.4xlarge, ml.c7i.48xlarge, ml.c7i.4xlarge, ml.c6i.16xlarge, ml.c5.9xlarge, ml.g4dn.16xlarge, ml.c7i.16xlarge, ml.c6i.4xlarge, ml.c5.xlarge, ml.c4.xlarge, ml.g4dn.8xlarge, ml.c7i.8xlarge, ml.c7i.large, ml.g5.xlarge, ml.c6i.8xlarge, ml.c6i.large, ml.g5.12xlarge, ml.g5.24xlarge, ml.m7i.2xlarge, ml.c5.18xlarge, ml.g5.48xlarge, ml.m6i.2xlarge, ml.g5.16xlarge, ml.m7i.4xlarge, ml.p3.2xlarge, ml.r6i.32xlarge, ml.m6i.4xlarge, ml.m5.xlarge, ml.m4.10xlarge, ml.r6i.xlarge, ml.m5.12xlarge, ml.m4.xlarge, ml.r7i.2xlarge, ml.r7i.xlarge, ml.r6i.12xlarge, ml.m5.24xlarge, ml.r7i.12xlarge, ml.m7i.8xlarge, ml.m7i.large, ml.r6i.24xlarge, ml.r6i.2xlarge, ml.m4.2xlarge, ml.r7i.24xlarge, ml.r7i.4xlarge, ml.m6i.8xlarge, ml.m6i.large, ml.m5.2xlarge, ml.p2.8xlarge, ml.r6i.4xlarge, ml.m6i.32xlarge, ml.p3.8xlarge, ml.m4.4xlarge
|
3561
|
+
# instance_count: 1,
|
3562
|
+
# },
|
3563
|
+
# output_configuration: { # required
|
3564
|
+
# accept: "InferenceOutputConfigurationAcceptString",
|
3565
|
+
# members: [ # required
|
3566
|
+
# {
|
3567
|
+
# account_id: "AccountId", # required
|
3568
|
+
# },
|
3569
|
+
# ],
|
3570
|
+
# },
|
3571
|
+
# data_source: { # required
|
3572
|
+
# ml_input_channel_arn: "MLInputChannelArn", # required
|
3573
|
+
# },
|
3574
|
+
# description: "ResourceDescription",
|
3575
|
+
# container_execution_parameters: {
|
3576
|
+
# max_payload_in_mb: 1,
|
3577
|
+
# },
|
3578
|
+
# environment: {
|
3579
|
+
# "InferenceEnvironmentMapKeyString" => "InferenceEnvironmentMapValueString",
|
3580
|
+
# },
|
3581
|
+
# kms_key_arn: "KmsKeyArn",
|
3582
|
+
# tags: {
|
3583
|
+
# "TagKey" => "TagValue",
|
3584
|
+
# },
|
3585
|
+
# })
|
3586
|
+
#
|
3587
|
+
# @example Response structure
|
3588
|
+
#
|
3589
|
+
# resp.trained_model_inference_job_arn #=> String
|
3590
|
+
#
|
3591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartTrainedModelInferenceJob AWS API Documentation
|
3592
|
+
#
|
3593
|
+
# @overload start_trained_model_inference_job(params = {})
|
3594
|
+
# @param [Hash] params ({})
|
3595
|
+
def start_trained_model_inference_job(params = {}, options = {})
|
3596
|
+
req = build_request(:start_trained_model_inference_job, params)
|
3597
|
+
req.send_request(options)
|
3598
|
+
end
|
3599
|
+
|
1615
3600
|
# Adds metadata tags to a specified resource.
|
1616
3601
|
#
|
1617
3602
|
# @option params [required, String] :resource_arn
|
@@ -1782,7 +3767,7 @@ module Aws::CleanRoomsML
|
|
1782
3767
|
tracer: tracer
|
1783
3768
|
)
|
1784
3769
|
context[:gem_name] = 'aws-sdk-cleanroomsml'
|
1785
|
-
context[:gem_version] = '1.
|
3770
|
+
context[:gem_version] = '1.19.0'
|
1786
3771
|
Seahorse::Client::Request.new(handlers, context)
|
1787
3772
|
end
|
1788
3773
|
|