Class: Aws::Personalize::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Personalize::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb
Overview
An API client for Personalize. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Personalize::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_batch_inference_job(params = {}) ⇒ Types::CreateBatchInferenceJobResponse
Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.
-
#create_batch_segment_job(params = {}) ⇒ Types::CreateBatchSegmentJobResponse
Creates a batch segment job.
-
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
You incur campaign costs while it is active.
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates an empty dataset and adds it to the specified dataset group.
-
#create_dataset_export_job(params = {}) ⇒ Types::CreateDatasetExportJobResponse
Creates a job that exports data from your dataset to an Amazon S3 bucket.
-
#create_dataset_group(params = {}) ⇒ Types::CreateDatasetGroupResponse
Creates an empty dataset group.
-
#create_dataset_import_job(params = {}) ⇒ Types::CreateDatasetImportJobResponse
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset.
-
#create_event_tracker(params = {}) ⇒ Types::CreateEventTrackerResponse
Creates an event tracker that you use when adding event data to a specified dataset group using the [PutEvents][1] API.
-
#create_filter(params = {}) ⇒ Types::CreateFilterResponse
Creates a recommendation filter.
-
#create_metric_attribution(params = {}) ⇒ Types::CreateMetricAttributionResponse
Creates a metric attribution.
-
#create_recommender(params = {}) ⇒ Types::CreateRecommenderResponse
Creates a recommender with the recipe (a Domain dataset group use case) you specify.
-
#create_schema(params = {}) ⇒ Types::CreateSchemaResponse
Creates an Amazon Personalize schema from the specified schema string.
-
#create_solution(params = {}) ⇒ Types::CreateSolutionResponse
After you create a solution, you can’t change its configuration.
-
#create_solution_version(params = {}) ⇒ Types::CreateSolutionVersionResponse
Trains or retrains an active solution in a Custom dataset group.
-
#delete_campaign(params = {}) ⇒ Struct
Removes a campaign by deleting the solution deployment.
-
#delete_dataset(params = {}) ⇒ Struct
Deletes a dataset.
-
#delete_dataset_group(params = {}) ⇒ Struct
Deletes a dataset group.
-
#delete_event_tracker(params = {}) ⇒ Struct
Deletes the event tracker.
-
#delete_filter(params = {}) ⇒ Struct
Deletes a filter.
-
#delete_metric_attribution(params = {}) ⇒ Struct
Deletes a metric attribution.
-
#delete_recommender(params = {}) ⇒ Struct
Deactivates and removes a recommender.
-
#delete_schema(params = {}) ⇒ Struct
Deletes a schema.
-
#delete_solution(params = {}) ⇒ Struct
Deletes all versions of a solution and the
Solution
object itself. -
#describe_algorithm(params = {}) ⇒ Types::DescribeAlgorithmResponse
Describes the given algorithm.
-
#describe_batch_inference_job(params = {}) ⇒ Types::DescribeBatchInferenceJobResponse
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
-
#describe_batch_segment_job(params = {}) ⇒ Types::DescribeBatchSegmentJobResponse
Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
-
#describe_campaign(params = {}) ⇒ Types::DescribeCampaignResponse
Describes the given campaign, including its status.
-
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Describes the given dataset.
-
#describe_dataset_export_job(params = {}) ⇒ Types::DescribeDatasetExportJobResponse
Describes the dataset export job created by [CreateDatasetExportJob][1], including the export job status.
-
#describe_dataset_group(params = {}) ⇒ Types::DescribeDatasetGroupResponse
Describes the given dataset group.
-
#describe_dataset_import_job(params = {}) ⇒ Types::DescribeDatasetImportJobResponse
Describes the dataset import job created by [CreateDatasetImportJob][1], including the import job status.
-
#describe_event_tracker(params = {}) ⇒ Types::DescribeEventTrackerResponse
Describes an event tracker.
-
#describe_feature_transformation(params = {}) ⇒ Types::DescribeFeatureTransformationResponse
Describes the given feature transformation.
-
#describe_filter(params = {}) ⇒ Types::DescribeFilterResponse
Describes a filter's properties.
-
#describe_metric_attribution(params = {}) ⇒ Types::DescribeMetricAttributionResponse
Describes a metric attribution.
-
#describe_recipe(params = {}) ⇒ Types::DescribeRecipeResponse
Describes a recipe.
-
#describe_recommender(params = {}) ⇒ Types::DescribeRecommenderResponse
Describes the given recommender, including its status.
-
#describe_schema(params = {}) ⇒ Types::DescribeSchemaResponse
Describes a schema.
-
#describe_solution(params = {}) ⇒ Types::DescribeSolutionResponse
Describes a solution.
-
#describe_solution_version(params = {}) ⇒ Types::DescribeSolutionVersionResponse
Describes a specific version of a solution.
-
#get_solution_metrics(params = {}) ⇒ Types::GetSolutionMetricsResponse
Gets the metrics for the specified solution version.
-
#list_batch_inference_jobs(params = {}) ⇒ Types::ListBatchInferenceJobsResponse
Gets a list of the batch inference jobs that have been performed off of a solution version.
-
#list_batch_segment_jobs(params = {}) ⇒ Types::ListBatchSegmentJobsResponse
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
-
#list_campaigns(params = {}) ⇒ Types::ListCampaignsResponse
Returns a list of campaigns that use the given solution.
-
#list_dataset_export_jobs(params = {}) ⇒ Types::ListDatasetExportJobsResponse
Returns a list of dataset export jobs that use the given dataset.
-
#list_dataset_groups(params = {}) ⇒ Types::ListDatasetGroupsResponse
Returns a list of dataset groups.
-
#list_dataset_import_jobs(params = {}) ⇒ Types::ListDatasetImportJobsResponse
Returns a list of dataset import jobs that use the given dataset.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Returns the list of datasets contained in the given dataset group.
-
#list_event_trackers(params = {}) ⇒ Types::ListEventTrackersResponse
Returns the list of event trackers associated with the account.
-
#list_filters(params = {}) ⇒ Types::ListFiltersResponse
Lists all filters that belong to a given dataset group.
-
#list_metric_attribution_metrics(params = {}) ⇒ Types::ListMetricAttributionMetricsResponse
Lists the metrics for the metric attribution.
-
#list_metric_attributions(params = {}) ⇒ Types::ListMetricAttributionsResponse
Lists metric attributions.
-
#list_recipes(params = {}) ⇒ Types::ListRecipesResponse
Returns a list of available recipes.
-
#list_recommenders(params = {}) ⇒ Types::ListRecommendersResponse
Returns a list of recommenders in a given Domain dataset group.
-
#list_schemas(params = {}) ⇒ Types::ListSchemasResponse
Returns the list of schemas associated with the account.
-
#list_solution_versions(params = {}) ⇒ Types::ListSolutionVersionsResponse
Returns a list of solution versions for the given solution.
-
#list_solutions(params = {}) ⇒ Types::ListSolutionsResponse
Returns a list of solutions in a given dataset group.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Get a list of [tags][1] attached to a resource.
-
#start_recommender(params = {}) ⇒ Types::StartRecommenderResponse
Starts a recommender that is INACTIVE.
-
#stop_recommender(params = {}) ⇒ Types::StopRecommenderResponse
Stops a recommender that is ACTIVE.
-
#stop_solution_version_creation(params = {}) ⇒ Struct
Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
-
#tag_resource(params = {}) ⇒ Struct
Add a list of tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags that are attached to a resource.
-
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's
minProvisionedTPS
, or modify your campaign's configuration. -
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Update a dataset to replace its schema with a new or existing one.
-
#update_metric_attribution(params = {}) ⇒ Types::UpdateMetricAttributionResponse
Updates a metric attribution.
-
#update_recommender(params = {}) ⇒ Types::UpdateRecommenderResponse
Updates the recommender to modify the recommender configuration.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from 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.
395 396 397 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 395 def initialize(*args) super end |
Instance Method Details
#create_batch_inference_job(params = {}) ⇒ Types::CreateBatchInferenceJobResponse
Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.
To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file.
For more information, see Creating a batch inference job .
If you use the Similar-Items recipe, Amazon Personalize can add
descriptive themes to batch recommendations. To generate themes, set
the job's mode to THEME_GENERATION
and specify the name of the
field that contains item names in the input data.
For more information about generating themes, see Batch recommendations with themes from Content Generator .
You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.
542 543 544 545 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 542 def create_batch_inference_job(params = {}, = {}) req = build_request(:create_batch_inference_job, params) req.send_request() end |
#create_batch_segment_job(params = {}) ⇒ Types::CreateBatchSegmentJobResponse
Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.
636 637 638 639 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 636 def create_batch_segment_job(params = {}, = {}) req = build_request(:create_batch_segment_job, params) req.send_request() end |
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing.
Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.
Minimum Provisioned TPS and Auto-Scaling
A high minProvisionedTPS
will increase your cost. We recommend
starting with 1 for minProvisionedTPS
(the default). Track your
usage using Amazon CloudWatch metrics, and increase the
minProvisionedTPS
as necessary.
When you create an Amazon Personalize campaign, you can specify the
minimum provisioned transactions per second (minProvisionedTPS
) for
the campaign. This is the baseline transaction throughput for the
campaign provisioned by Amazon Personalize. It sets the minimum
billing charge for the campaign while it is active. A transaction is a
single GetRecommendations
or GetPersonalizedRanking
request. The
default minProvisionedTPS
is 1.
If your TPS increases beyond the minProvisionedTPS
, Amazon
Personalize auto-scales the provisioned capacity up and down, but
never below minProvisionedTPS
. There's a short time delay while the
capacity is increased that might cause loss of transactions. When your
traffic reduces, capacity returns to the minProvisionedTPS
.
You are charged for the the minimum provisioned TPS or, if your
requests exceed the minProvisionedTPS
, the actual TPS. The actual
TPS is the total number of recommendation requests you make. We
recommend starting with a low minProvisionedTPS
, track your usage
using Amazon CloudWatch metrics, and then increase the
minProvisionedTPS
as necessary.
For more information about campaign costs, see Amazon Personalize pricing.
Status
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the campaign status, call DescribeCampaign.
status
of the campaign is ACTIVE
before asking the
campaign for recommendations.
Related APIs
789 790 791 792 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 789 def create_campaign(params = {}, = {}) req = build_request(:create_campaign, params) req.send_request() end |
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.
There are 5 types of datasets:
Item interactions
Items
Users
Action interactions
Actions
Each dataset type has an associated schema with required field types.
Only the Item interactions
dataset is required in order to train a
model (also referred to as creating a solution).
A dataset can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the dataset, call DescribeDataset.
Related APIs
901 902 903 904 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 901 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, params) req.send_request() end |
#create_dataset_export_job(params = {}) ⇒ Types::CreateDatasetExportJobResponse
Creates a job that exports data from your dataset to an Amazon S3
bucket. To allow Amazon Personalize to export the training data, you
must specify an service-linked IAM role that gives Amazon Personalize
PutObject
permissions for your Amazon S3 bucket. For information,
see Exporting a dataset in the Amazon Personalize developer
guide.
Status
A dataset export job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
^
To get the status of the export job, call
DescribeDatasetExportJob, and specify the Amazon Resource Name
(ARN) of the dataset export job. The dataset export is complete when
the status shows as ACTIVE. If the status shows as CREATE FAILED, the
response includes a failureReason
key, which describes why the job
failed.
995 996 997 998 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 995 def create_dataset_export_job(params = {}, = {}) req = build_request(:create_dataset_export_job, params) req.send_request() end |
#create_dataset_group(params = {}) ⇒ Types::CreateDatasetGroupResponse
Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:
Item interactions
Items
Users
Actions
Action interactions
A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
To get the status of the dataset group, call
DescribeDatasetGroup. If the status shows as CREATE FAILED, the
response includes a failureReason
key, which describes why the
creation failed.
status
of the dataset group is ACTIVE
before adding a dataset to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
1124 1125 1126 1127 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1124 def create_dataset_group(params = {}, = {}) req = build_request(:create_dataset_group, params) req.send_request() end |
#create_dataset_import_job(params = {}) ⇒ Types::CreateDatasetImportJobResponse
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.
If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations.
By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.
Status
A dataset import job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
^
To get the status of the import job, call
DescribeDatasetImportJob, providing the Amazon Resource Name
(ARN) of the dataset import job. The dataset import is complete when
the status shows as ACTIVE. If the status shows as CREATE FAILED, the
response includes a failureReason
key, which describes why the job
failed.
Related APIs
1250 1251 1252 1253 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1250 def create_dataset_import_job(params = {}, = {}) req = build_request(:create_dataset_import_job, params) req.send_request() end |
#create_event_tracker(params = {}) ⇒ Types::CreateEventTrackerResponse
Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
CreateEventTracker
using the same
dataset group as an existing event tracker.
When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker.
The event tracker can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the event tracker, call DescribeEventTracker.
Related APIs
1341 1342 1343 1344 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1341 def create_event_tracker(params = {}, = {}) req = build_request(:create_event_tracker, params) req.send_request() end |
#create_filter(params = {}) ⇒ Types::CreateFilterResponse
Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
1402 1403 1404 1405 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1402 def create_filter(params = {}, = {}) req = build_request(:create_filter, params) req.send_request() end |
#create_metric_attribution(params = {}) ⇒ Types::CreateMetricAttributionResponse
Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.
1467 1468 1469 1470 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1467 def create_metric_attribution(params = {}, = {}) req = build_request(:create_metric_attribution, params) req.send_request() end |
#create_recommender(params = {}) ⇒ Types::CreateRecommenderResponse
Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.
Minimum recommendation requests per second
A high minRecommendationRequestsPerSecond
will increase your bill.
We recommend starting with 1 for minRecommendationRequestsPerSecond
(the default). Track your usage using Amazon CloudWatch metrics, and
increase the minRecommendationRequestsPerSecond
as necessary.
When you create a recommender, you can configure the recommender's
minimum recommendation requests per second. The minimum recommendation
requests per second (minRecommendationRequestsPerSecond
) specifies
the baseline recommendation request throughput provisioned by Amazon
Personalize. The default minRecommendationRequestsPerSecond is 1
. A
recommendation request is a single GetRecommendations
operation.
Request throughput is measured in requests per second and Amazon
Personalize uses your requests per second to derive your requests per
hour and the price of your recommender usage.
If your requests per second increases beyond
minRecommendationRequestsPerSecond
, Amazon Personalize auto-scales
the provisioned capacity up and down, but never below
minRecommendationRequestsPerSecond
. There's a short time delay
while the capacity is increased that might cause loss of requests.
Your bill is the greater of either the minimum requests per hour
(based on minRecommendationRequestsPerSecond) or the actual number of
requests. The actual request throughput used is calculated as the
average requests/second within a one-hour window. We recommend
starting with the default minRecommendationRequestsPerSecond
, track
your usage using Amazon CloudWatch metrics, and then increase the
minRecommendationRequestsPerSecond
as necessary.
Status
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
status
of the recommender is ACTIVE
before asking
the recommender for recommendations.
Related APIs
1611 1612 1613 1614 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1611 def create_recommender(params = {}, = {}) req = build_request(:create_recommender, params) req.send_request() end |
#create_schema(params = {}) ⇒ Types::CreateSchemaResponse
Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.
Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.
Related APIs
1671 1672 1673 1674 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1671 def create_schema(params = {}, = {}) req = build_request(:create_schema, params) req.send_request() end |
#create_solution(params = {}) ⇒ Types::CreateSolutionResponse
After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training costs, see Amazon Personalize pricing.
Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.
By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training.
To turn off automatic training, set performAutoTraining
to false. If
you turn off automatic training, you must manually create a solution
version by calling the CreateSolutionVersion operation.
After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.
After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
hpoObjective
for
solution hyperparameter optimization at this time.
Status
A solution can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. If you
use manual training, the status must be ACTIVE before you call
CreateSolutionVersion
.
Related APIs
1938 1939 1940 1941 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1938 def create_solution(params = {}, = {}) req = build_request(:create_solution, params) req.send_request() end |
#create_solution_version(params = {}) ⇒ Types::CreateSolutionVersionResponse
Trains or retrains an active solution in a Custom dataset group. A
solution is created using the CreateSolution operation and must
be in the ACTIVE state before calling CreateSolutionVersion
. A new
version of the solution is created every time you call this operation.
Status
A solution version can be in one of the following states:
CREATE PENDING
CREATE IN_PROGRESS
ACTIVE
CREATE FAILED
CREATE STOPPING
CREATE STOPPED
To get the status of the version, call DescribeSolutionVersion.
Wait until the status shows as ACTIVE before calling CreateCampaign
.
If the status shows as CREATE FAILED, the response includes a
failureReason
key, which describes why the job failed.
Related APIs
2060 2061 2062 2063 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2060 def create_solution_version(params = {}, = {}) req = build_request(:create_solution_version, params) req.send_request() end |
#delete_campaign(params = {}) ⇒ Struct
Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.
2091 2092 2093 2094 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2091 def delete_campaign(params = {}, = {}) req = build_request(:delete_campaign, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Struct
Deletes a dataset. You can't delete a dataset if an associated
DatasetImportJob
or SolutionVersion
is in the CREATE PENDING or IN
PROGRESS state. For more information on datasets, see
CreateDataset.
2120 2121 2122 2123 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2120 def delete_dataset(params = {}, = {}) req = build_request(:delete_dataset, params) req.send_request() end |
#delete_dataset_group(params = {}) ⇒ Struct
Deletes a dataset group. Before you delete a dataset group, you must delete the following:
All associated event trackers.
All associated solutions.
All datasets in the dataset group.
2149 2150 2151 2152 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2149 def delete_dataset_group(params = {}, = {}) req = build_request(:delete_dataset_group, params) req.send_request() end |
#delete_event_tracker(params = {}) ⇒ Struct
Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.
2177 2178 2179 2180 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2177 def delete_event_tracker(params = {}, = {}) req = build_request(:delete_event_tracker, params) req.send_request() end |
#delete_filter(params = {}) ⇒ Struct
Deletes a filter.
2199 2200 2201 2202 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2199 def delete_filter(params = {}, = {}) req = build_request(:delete_filter, params) req.send_request() end |
#delete_metric_attribution(params = {}) ⇒ Struct
Deletes a metric attribution.
2221 2222 2223 2224 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2221 def delete_metric_attribution(params = {}, = {}) req = build_request(:delete_metric_attribution, params) req.send_request() end |
#delete_recommender(params = {}) ⇒ Struct
Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
2248 2249 2250 2251 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2248 def delete_recommender(params = {}, = {}) req = build_request(:delete_recommender, params) req.send_request() end |
#delete_schema(params = {}) ⇒ Struct
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
2276 2277 2278 2279 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2276 def delete_schema(params = {}, = {}) req = build_request(:delete_schema, params) req.send_request() end |
#delete_solution(params = {}) ⇒ Struct
Deletes all versions of a solution and the Solution
object itself.
Before deleting a solution, you must delete all campaigns based on the
solution. To determine what campaigns are using the solution, call
ListCampaigns and supply the Amazon Resource Name (ARN) of the
solution. You can't delete a solution if an associated
SolutionVersion
is in the CREATE PENDING or IN PROGRESS state. For
more information on solutions, see CreateSolution.
2309 2310 2311 2312 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2309 def delete_solution(params = {}, = {}) req = build_request(:delete_solution, params) req.send_request() end |
#describe_algorithm(params = {}) ⇒ Types::DescribeAlgorithmResponse
Describes the given algorithm.
2363 2364 2365 2366 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2363 def describe_algorithm(params = {}, = {}) req = build_request(:describe_algorithm, params) req.send_request() end |
#describe_batch_inference_job(params = {}) ⇒ Types::DescribeBatchInferenceJobResponse
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
2410 2411 2412 2413 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2410 def describe_batch_inference_job(params = {}, = {}) req = build_request(:describe_batch_inference_job, params) req.send_request() end |
#describe_batch_segment_job(params = {}) ⇒ Types::DescribeBatchSegmentJobResponse
Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
2453 2454 2455 2456 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2453 def describe_batch_segment_job(params = {}, = {}) req = build_request(:describe_batch_segment_job, params) req.send_request() end |
#describe_campaign(params = {}) ⇒ Types::DescribeCampaignResponse
Describes the given campaign, including its status.
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
When the status
is CREATE FAILED
, the response includes the
failureReason
key, which describes why.
For more information on campaigns, see CreateCampaign.
2518 2519 2520 2521 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2518 def describe_campaign(params = {}, = {}) req = build_request(:describe_campaign, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Describes the given dataset. For more information on datasets, see CreateDataset.
2564 2565 2566 2567 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2564 def describe_dataset(params = {}, = {}) req = build_request(:describe_dataset, params) req.send_request() end |
#describe_dataset_export_job(params = {}) ⇒ Types::DescribeDatasetExportJobResponse
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
2607 2608 2609 2610 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2607 def describe_dataset_export_job(params = {}, = {}) req = build_request(:describe_dataset_export_job, params) req.send_request() end |
#describe_dataset_group(params = {}) ⇒ Types::DescribeDatasetGroupResponse
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
2648 2649 2650 2651 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2648 def describe_dataset_group(params = {}, = {}) req = build_request(:describe_dataset_group, params) req.send_request() end |
#describe_dataset_import_job(params = {}) ⇒ Types::DescribeDatasetImportJobResponse
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
2691 2692 2693 2694 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2691 def describe_dataset_import_job(params = {}, = {}) req = build_request(:describe_dataset_import_job, params) req.send_request() end |
#describe_event_tracker(params = {}) ⇒ Types::DescribeEventTrackerResponse
Describes an event tracker. The response includes the trackingId
and
status
of the event tracker. For more information on event trackers,
see CreateEventTracker.
2732 2733 2734 2735 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2732 def describe_event_tracker(params = {}, = {}) req = build_request(:describe_event_tracker, params) req.send_request() end |
#describe_feature_transformation(params = {}) ⇒ Types::DescribeFeatureTransformationResponse
Describes the given feature transformation.
2767 2768 2769 2770 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2767 def describe_feature_transformation(params = {}, = {}) req = build_request(:describe_feature_transformation, params) req.send_request() end |
#describe_filter(params = {}) ⇒ Types::DescribeFilterResponse
Describes a filter's properties.
2802 2803 2804 2805 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2802 def describe_filter(params = {}, = {}) req = build_request(:describe_filter, params) req.send_request() end |
#describe_metric_attribution(params = {}) ⇒ Types::DescribeMetricAttributionResponse
Describes a metric attribution.
2839 2840 2841 2842 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2839 def describe_metric_attribution(params = {}, = {}) req = build_request(:describe_metric_attribution, params) req.send_request() end |
#describe_recipe(params = {}) ⇒ Types::DescribeRecipeResponse
Describes a recipe.
A recipe contains three items:
An algorithm that trains a model.
Hyperparameters that govern the training.
Feature transformation information for modifying the input data before training.
Amazon Personalize provides a set of predefined recipes. You specify a
recipe when you create a solution with the CreateSolution API.
CreateSolution
trains a model by using the algorithm in the
specified recipe and a training dataset. The solution, when deployed
as a campaign, can provide recommendations using the
GetRecommendations API.
2896 2897 2898 2899 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2896 def describe_recipe(params = {}, = {}) req = build_request(:describe_recipe, params) req.send_request() end |
#describe_recommender(params = {}) ⇒ Types::DescribeRecommenderResponse
Describes the given recommender, including its status.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
When the status
is CREATE FAILED
, the response includes the
failureReason
key, which describes why.
The modelMetrics
key is null when the recommender is being created
or deleted.
For more information on recommenders, see CreateRecommender.
2973 2974 2975 2976 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2973 def describe_recommender(params = {}, = {}) req = build_request(:describe_recommender, params) req.send_request() end |
#describe_schema(params = {}) ⇒ Types::DescribeSchemaResponse
Describes a schema. For more information on schemas, see CreateSchema.
3011 3012 3013 3014 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3011 def describe_schema(params = {}, = {}) req = build_request(:describe_schema, params) req.send_request() end |
#describe_solution(params = {}) ⇒ Types::DescribeSolutionResponse
Describes a solution. For more information on solutions, see CreateSolution.
3093 3094 3095 3096 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3093 def describe_solution(params = {}, = {}) req = build_request(:describe_solution, params) req.send_request() end |
#describe_solution_version(params = {}) ⇒ Types::DescribeSolutionVersionResponse
Describes a specific version of a solution. For more information on solutions, see CreateSolution
3173 3174 3175 3176 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3173 def describe_solution_version(params = {}, = {}) req = build_request(:describe_solution_version, params) req.send_request() end |
#get_solution_metrics(params = {}) ⇒ Types::GetSolutionMetricsResponse
Gets the metrics for the specified solution version.
3205 3206 3207 3208 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3205 def get_solution_metrics(params = {}, = {}) req = build_request(:get_solution_metrics, params) req.send_request() end |
#list_batch_inference_jobs(params = {}) ⇒ Types::ListBatchInferenceJobsResponse
Gets a list of the batch inference jobs that have been performed off of a solution version.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3256 3257 3258 3259 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3256 def list_batch_inference_jobs(params = {}, = {}) req = build_request(:list_batch_inference_jobs, params) req.send_request() end |
#list_batch_segment_jobs(params = {}) ⇒ Types::ListBatchSegmentJobsResponse
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3306 3307 3308 3309 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3306 def list_batch_segment_jobs(params = {}, = {}) req = build_request(:list_batch_segment_jobs, params) req.send_request() end |
#list_campaigns(params = {}) ⇒ Types::ListCampaignsResponse
Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3367 3368 3369 3370 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3367 def list_campaigns(params = {}, = {}) req = build_request(:list_campaigns, params) req.send_request() end |
#list_dataset_export_jobs(params = {}) ⇒ Types::ListDatasetExportJobsResponse
Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3426 3427 3428 3429 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3426 def list_dataset_export_jobs(params = {}, = {}) req = build_request(:list_dataset_export_jobs, params) req.send_request() end |
#list_dataset_groups(params = {}) ⇒ Types::ListDatasetGroupsResponse
Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3476 3477 3478 3479 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3476 def list_dataset_groups(params = {}, = {}) req = build_request(:list_dataset_groups, params) req.send_request() end |
#list_dataset_import_jobs(params = {}) ⇒ Types::ListDatasetImportJobsResponse
Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3536 3537 3538 3539 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3536 def list_dataset_import_jobs(params = {}, = {}) req = build_request(:list_dataset_import_jobs, params) req.send_request() end |
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3591 3592 3593 3594 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3591 def list_datasets(params = {}, = {}) req = build_request(:list_datasets, params) req.send_request() end |
#list_event_trackers(params = {}) ⇒ Types::ListEventTrackersResponse
Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3644 3645 3646 3647 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3644 def list_event_trackers(params = {}, = {}) req = build_request(:list_event_trackers, params) req.send_request() end |
#list_filters(params = {}) ⇒ Types::ListFiltersResponse
Lists all filters that belong to a given dataset group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3692 3693 3694 3695 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3692 def list_filters(params = {}, = {}) req = build_request(:list_filters, params) req.send_request() end |
#list_metric_attribution_metrics(params = {}) ⇒ Types::ListMetricAttributionMetricsResponse
Lists the metrics for the metric attribution.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3737 3738 3739 3740 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3737 def list_metric_attribution_metrics(params = {}, = {}) req = build_request(:list_metric_attribution_metrics, params) req.send_request() end |
#list_metric_attributions(params = {}) ⇒ Types::ListMetricAttributionsResponse
Lists metric attributions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3785 3786 3787 3788 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3785 def list_metric_attributions(params = {}, = {}) req = build_request(:list_metric_attributions, params) req.send_request() end |
#list_recipes(params = {}) ⇒ Types::ListRecipesResponse
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3841 3842 3843 3844 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3841 def list_recipes(params = {}, = {}) req = build_request(:list_recipes, params) req.send_request() end |
#list_recommenders(params = {}) ⇒ Types::ListRecommendersResponse
Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3906 3907 3908 3909 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3906 def list_recommenders(params = {}, = {}) req = build_request(:list_recommenders, params) req.send_request() end |
#list_schemas(params = {}) ⇒ Types::ListSchemasResponse
Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3954 3955 3956 3957 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3954 def list_schemas(params = {}, = {}) req = build_request(:list_schemas, params) req.send_request() end |
#list_solution_versions(params = {}) ⇒ Types::ListSolutionVersionsResponse
Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4005 4006 4007 4008 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4005 def list_solution_versions(params = {}, = {}) req = build_request(:list_solution_versions, params) req.send_request() end |
#list_solutions(params = {}) ⇒ Types::ListSolutionsResponse
Returns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4060 4061 4062 4063 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4060 def list_solutions(params = {}, = {}) req = build_request(:list_solutions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Get a list of tags attached to a resource.
4094 4095 4096 4097 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4094 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_recommender(params = {}) ⇒ Types::StartRecommenderResponse
Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
4124 4125 4126 4127 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4124 def start_recommender(params = {}, = {}) req = build_request(:start_recommender, params) req.send_request() end |
#stop_recommender(params = {}) ⇒ Types::StopRecommenderResponse
Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
4153 4154 4155 4156 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4153 def stop_recommender(params = {}, = {}) req = build_request(:stop_recommender, params) req.send_request() end |
#stop_solution_version_creation(params = {}) ⇒ Struct
Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
Depending on the current state of the solution version, the solution version state changes as follows:
CREATE_PENDING > CREATE_STOPPED
or
CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED
You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.
4190 4191 4192 4193 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4190 def stop_solution_version_creation(params = {}, = {}) req = build_request(:stop_solution_version_creation, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Add a list of tags to a resource.
4226 4227 4228 4229 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4226 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.
4257 4258 4259 4260 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4257 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign to deploy a retrained solution version with an
existing campaign, change your campaign's minProvisionedTPS
, or
modify your campaign's configuration. For example, you can set
enableMetadataWithRecommendations
to true for an existing campaign.
To update a campaign to start automatically using the latest solution version, specify the following:
For the
SolutionVersionArn
parameter, specify the Amazon Resource Name (ARN) of your solution inSolutionArn/$LATEST
format.In the
campaignConfig
, setsyncWithLatestSolutionVersion
totrue
.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.
Active
.
For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.
4356 4357 4358 4359 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4356 def update_campaign(params = {}, = {}) req = build_request(:update_campaign, params) req.send_request() end |
#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse
Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.
4393 4394 4395 4396 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4393 def update_dataset(params = {}, = {}) req = build_request(:update_dataset, params) req.send_request() end |
#update_metric_attribution(params = {}) ⇒ Types::UpdateMetricAttributionResponse
Updates a metric attribution.
4445 4446 4447 4448 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4445 def update_metric_attribution(params = {}, = {}) req = build_request(:update_metric_attribution, params) req.send_request() end |
#update_recommender(params = {}) ⇒ Types::UpdateRecommenderResponse
Updates the recommender to modify the recommender configuration. If
you update the recommender to modify the columns used in training,
Amazon Personalize automatically starts a full retraining of the
models backing your recommender. While the update completes, you can
still get recommendations from the recommender. The recommender uses
the previous configuration until the update completes. To track the
status of this update, use the latestRecommenderUpdate
returned in
the DescribeRecommender operation.
4499 4500 4501 4502 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 4499 def update_recommender(params = {}, = {}) req = build_request(:update_recommender, params) req.send_request() end |