Class: Aws::CleanRoomsML::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CleanRoomsML::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb
Overview
An API client for CleanRoomsML. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CleanRoomsML::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_audience_model(params = {}) ⇒ Types::CreateAudienceModelResponse
Defines the information necessary to create an audience model.
-
#create_configured_audience_model(params = {}) ⇒ Types::CreateConfiguredAudienceModelResponse
Defines the information necessary to create a configured audience model.
-
#create_training_dataset(params = {}) ⇒ Types::CreateTrainingDatasetResponse
Defines the information necessary to create a training dataset.
-
#delete_audience_generation_job(params = {}) ⇒ Struct
Deletes the specified audience generation job, and removes all data associated with the job.
-
#delete_audience_model(params = {}) ⇒ Struct
Specifies an audience model that you want to delete.
-
#delete_configured_audience_model(params = {}) ⇒ Struct
Deletes the specified configured audience model.
-
#delete_configured_audience_model_policy(params = {}) ⇒ Struct
Deletes the specified configured audience model policy.
-
#delete_training_dataset(params = {}) ⇒ Struct
Specifies a training dataset that you want to delete.
-
#get_audience_generation_job(params = {}) ⇒ Types::GetAudienceGenerationJobResponse
Returns information about an audience generation job.
-
#get_audience_model(params = {}) ⇒ Types::GetAudienceModelResponse
Returns information about an audience model.
-
#get_configured_audience_model(params = {}) ⇒ Types::GetConfiguredAudienceModelResponse
Returns information about a specified configured audience model.
-
#get_configured_audience_model_policy(params = {}) ⇒ Types::GetConfiguredAudienceModelPolicyResponse
Returns information about a configured audience model policy.
-
#get_training_dataset(params = {}) ⇒ Types::GetTrainingDatasetResponse
Returns information about a training dataset.
-
#list_audience_export_jobs(params = {}) ⇒ Types::ListAudienceExportJobsResponse
Returns a list of the audience export jobs.
-
#list_audience_generation_jobs(params = {}) ⇒ Types::ListAudienceGenerationJobsResponse
Returns a list of audience generation jobs.
-
#list_audience_models(params = {}) ⇒ Types::ListAudienceModelsResponse
Returns a list of audience models.
-
#list_configured_audience_models(params = {}) ⇒ Types::ListConfiguredAudienceModelsResponse
Returns a list of the configured audience models.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for a provided resource.
-
#list_training_datasets(params = {}) ⇒ Types::ListTrainingDatasetsResponse
Returns a list of training datasets.
-
#put_configured_audience_model_policy(params = {}) ⇒ Types::PutConfiguredAudienceModelPolicyResponse
Create or update the resource policy for a configured audience model.
-
#start_audience_export_job(params = {}) ⇒ Struct
Export an audience of a specified size after you have generated an audience.
-
#start_audience_generation_job(params = {}) ⇒ Types::StartAudienceGenerationJobResponse
Information necessary to start the audience generation job.
-
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to a specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes metadata tags from a specified resource.
-
#update_configured_audience_model(params = {}) ⇒ Types::UpdateConfiguredAudienceModelResponse
Provides the information necessary to update a configured audience model.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_audience_model(params = {}) ⇒ Types::CreateAudienceModelResponse
Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.
501 502 503 504 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 501 def create_audience_model(params = {}, = {}) req = build_request(:create_audience_model, params) req.send_request() end |
#create_configured_audience_model(params = {}) ⇒ Types::CreateConfiguredAudienceModelResponse
Defines the information necessary to create a configured audience model.
627 628 629 630 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 627 def create_configured_audience_model(params = {}, = {}) req = build_request(:create_configured_audience_model, params) req.send_request() end |
#create_training_dataset(params = {}) ⇒ Types::CreateTrainingDatasetResponse
Defines the information necessary to create a training dataset. In
Clean Rooms ML, the TrainingDataset
is metadata that points to a
Glue table, which is read only during AudienceModel
creation.
730 731 732 733 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 730 def create_training_dataset(params = {}, = {}) req = build_request(:create_training_dataset, params) req.send_request() end |
#delete_audience_generation_job(params = {}) ⇒ Struct
Deletes the specified audience generation job, and removes all data associated with the job.
754 755 756 757 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 754 def delete_audience_generation_job(params = {}, = {}) req = build_request(:delete_audience_generation_job, params) req.send_request() end |
#delete_audience_model(params = {}) ⇒ Struct
Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.
779 780 781 782 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 779 def delete_audience_model(params = {}, = {}) req = build_request(:delete_audience_model, params) req.send_request() end |
#delete_configured_audience_model(params = {}) ⇒ Struct
Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.
806 807 808 809 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 806 def delete_configured_audience_model(params = {}, = {}) req = build_request(:delete_configured_audience_model, params) req.send_request() end |
#delete_configured_audience_model_policy(params = {}) ⇒ Struct
Deletes the specified configured audience model policy.
829 830 831 832 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 829 def delete_configured_audience_model_policy(params = {}, = {}) req = build_request(:delete_configured_audience_model_policy, params) req.send_request() end |
#delete_training_dataset(params = {}) ⇒ Struct
Specifies a training dataset that you want to delete. You can't
delete a training dataset if there are any audience models that depend
on the training dataset. In Clean Rooms ML, the TrainingDataset
is
metadata that points to a Glue table, which is read only during
AudienceModel
creation. This action deletes the metadata.
856 857 858 859 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 856 def delete_training_dataset(params = {}, = {}) req = build_request(:delete_training_dataset, params) req.send_request() end |
#get_audience_generation_job(params = {}) ⇒ Types::GetAudienceGenerationJobResponse
Returns information about an audience generation job.
918 919 920 921 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 918 def get_audience_generation_job(params = {}, = {}) req = build_request(:get_audience_generation_job, params) req.send_request() end |
#get_audience_model(params = {}) ⇒ Types::GetAudienceModelResponse
Returns information about an audience model
971 972 973 974 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 971 def get_audience_model(params = {}, = {}) req = build_request(:get_audience_model, params) req.send_request() end |
#get_configured_audience_model(params = {}) ⇒ Types::GetConfiguredAudienceModelResponse
Returns information about a specified configured audience model.
1029 1030 1031 1032 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1029 def get_configured_audience_model(params = {}, = {}) req = build_request(:get_configured_audience_model, params) req.send_request() end |
#get_configured_audience_model_policy(params = {}) ⇒ Types::GetConfiguredAudienceModelPolicyResponse
Returns information about a configured audience model policy.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1062 def get_configured_audience_model_policy(params = {}, = {}) req = build_request(:get_configured_audience_model_policy, params) req.send_request() end |
#get_training_dataset(params = {}) ⇒ Types::GetTrainingDatasetResponse
Returns information about a training dataset.
1116 1117 1118 1119 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1116 def get_training_dataset(params = {}, = {}) req = build_request(:get_training_dataset, params) req.send_request() end |
#list_audience_export_jobs(params = {}) ⇒ Types::ListAudienceExportJobsResponse
Returns a list of the audience export jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1169 1170 1171 1172 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1169 def list_audience_export_jobs(params = {}, = {}) req = build_request(:list_audience_export_jobs, params) req.send_request() end |
#list_audience_generation_jobs(params = {}) ⇒ Types::ListAudienceGenerationJobsResponse
Returns a list of audience generation jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1225 1226 1227 1228 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1225 def list_audience_generation_jobs(params = {}, = {}) req = build_request(:list_audience_generation_jobs, params) req.send_request() end |
#list_audience_models(params = {}) ⇒ Types::ListAudienceModelsResponse
Returns a list of audience models.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1269 1270 1271 1272 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1269 def list_audience_models(params = {}, = {}) req = build_request(:list_audience_models, params) req.send_request() end |
#list_configured_audience_models(params = {}) ⇒ Types::ListConfiguredAudienceModelsResponse
Returns a list of the configured audience models.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1315 1316 1317 1318 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1315 def list_configured_audience_models(params = {}, = {}) req = build_request(:list_configured_audience_models, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for a provided resource.
1345 1346 1347 1348 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1345 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_training_datasets(params = {}) ⇒ Types::ListTrainingDatasetsResponse
Returns a list of training datasets.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1388 1389 1390 1391 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1388 def list_training_datasets(params = {}, = {}) req = build_request(:list_training_datasets, params) req.send_request() end |
#put_configured_audience_model_policy(params = {}) ⇒ Types::PutConfiguredAudienceModelPolicyResponse
Create or update the resource policy for a configured audience model.
1432 1433 1434 1435 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1432 def put_configured_audience_model_policy(params = {}, = {}) req = build_request(:put_configured_audience_model_policy, params) req.send_request() end |
#start_audience_export_job(params = {}) ⇒ Struct
Export an audience of a specified size after you have generated an audience.
1472 1473 1474 1475 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1472 def start_audience_export_job(params = {}, = {}) req = build_request(:start_audience_export_job, params) req.send_request() end |
#start_audience_generation_job(params = {}) ⇒ Types::StartAudienceGenerationJobResponse
Information necessary to start the audience generation job.
1563 1564 1565 1566 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1563 def start_audience_generation_job(params = {}, = {}) req = build_request(:start_audience_generation_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to a specified resource.
1621 1622 1623 1624 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1621 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes metadata tags from a specified resource.
1648 1649 1650 1651 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1648 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_configured_audience_model(params = {}) ⇒ Types::UpdateConfiguredAudienceModelResponse
Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.
1715 1716 1717 1718 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1715 def update_configured_audience_model(params = {}, = {}) req = build_request(:update_configured_audience_model, params) req.send_request() end |