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.
440 441 442 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 440 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.
531 532 533 534 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 531 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.
657 658 659 660 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 657 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.
760 761 762 763 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 760 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.
784 785 786 787 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 784 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.
809 810 811 812 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 809 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.
836 837 838 839 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 836 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.
859 860 861 862 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 859 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.
886 887 888 889 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 886 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.
954 955 956 957 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 954 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
1007 1008 1009 1010 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1007 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.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1065 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.
1098 1099 1100 1101 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1098 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.
1152 1153 1154 1155 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1152 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.
1205 1206 1207 1208 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1205 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.
1261 1262 1263 1264 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1261 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.
1305 1306 1307 1308 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1305 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.
1351 1352 1353 1354 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1351 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.
1381 1382 1383 1384 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1381 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.
1424 1425 1426 1427 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1424 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.
1468 1469 1470 1471 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1468 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.
1508 1509 1510 1511 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1508 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.
1606 1607 1608 1609 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1606 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.
1664 1665 1666 1667 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1664 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.
1691 1692 1693 1694 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1691 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.
1758 1759 1760 1761 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1758 def update_configured_audience_model(params = {}, = {}) req = build_request(:update_configured_audience_model, params) req.send_request() end |