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
Creates a batch inference job.
-
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
Creates a campaign by deploying a solution version.
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates an empty dataset and adds it to the specified dataset group.
-
#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_schema(params = {}) ⇒ Types::CreateSchemaResponse
Creates an Amazon Personalize schema from the specified schema string.
-
#create_solution(params = {}) ⇒ Types::CreateSolutionResponse
Creates the configuration for training a model.
-
#create_solution_version(params = {}) ⇒ Types::CreateSolutionVersionResponse
Trains or retrains an active solution.
-
#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_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_campaign(params = {}) ⇒ Types::DescribeCampaignResponse
Describes the given campaign, including its status.
-
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Describes the given dataset.
-
#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, 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_recipe(params = {}) ⇒ Types::DescribeRecipeResponse
Describes a recipe.
-
#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_campaigns(params = {}) ⇒ Types::ListCampaignsResponse
Returns a list of campaigns that use the given solution.
-
#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_recipes(params = {}) ⇒ Types::ListRecipesResponse
Returns a list of available recipes.
-
#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 that use the given dataset group.
-
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS
parameter.
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.
334 335 336 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#create_batch_inference_job(params = {}) ⇒ Types::CreateBatchInferenceJobResponse
Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.
414 415 416 417 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 414 def create_batch_inference_job(params = {}, = {}) req = build_request(:create_batch_inference_job, params) req.send_request() end |
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
Creates a campaign by deploying 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 transaction is a single GetRecommendations
or
GetPersonalizedRanking
call. Transactions per second (TPS) is the
throughput and unit of billing for Amazon Personalize. The minimum
provisioned TPS (minProvisionedTPS
) specifies the baseline
throughput provisioned by Amazon Personalize, and thus, the minimum
billing charge.
If your TPS increases beyond 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.
The actual TPS used is calculated as the average requests/second
within a 5-minute window. You pay for maximum of either the minimum
provisioned TPS or the actual TPS. We recommend starting with a low
minProvisionedTPS
, track your usage using Amazon CloudWatch metrics,
and then increase the minProvisionedTPS
as necessary.
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
ListCampaigns
DescribeCampaign
UpdateCampaign
DeleteCampaign
513 514 515 516 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 513 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 three types of datasets:
Interactions
Items
Users
Each dataset type has an associated schema with required field types.
Only the 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
CreateDatasetGroup
ListDatasets
DescribeDataset
DeleteDataset
595 596 597 598 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 595 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, params) req.send_request() end |
#create_dataset_group(params = {}) ⇒ Types::CreateDatasetGroupResponse
Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:
Interactions
Items
Users
To train a model (create a solution), a dataset group that contains an
Interactions
dataset is required. Call CreateDataset to add a
dataset to the group.
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 AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
CreateDataset
CreateEventTracker
CreateSolution
Related APIs
ListDatasetGroups
DescribeDatasetGroup
DeleteDatasetGroup
682 683 684 685 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 682 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 AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system.
The dataset import job replaces any existing data in the dataset that you imported in bulk.
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
ListDatasetImportJobs
DescribeDatasetImportJob
759 760 761 762 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 759 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 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
ListEventTrackers
DescribeEventTracker
DeleteEventTracker
833 834 835 836 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 833 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 filter.
872 873 874 875 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 872 def create_filter(params = {}, = {}) req = build_request(:create_filter, 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. You specify a schema when you call CreateDataset.
Related APIs
ListSchemas
DescribeSchema
DeleteSchema
917 918 919 920 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 917 def create_schema(params = {}, = {}) req = build_request(:create_schema, params) req.send_request() end |
#create_solution(params = {}) ⇒ Types::CreateSolutionResponse
Creates the configuration for training a model. A trained model is
known as a solution. After the configuration is created, you train the
model (create a solution) by calling the CreateSolutionVersion
operation. Every time you call CreateSolutionVersion
, a new version
of the solution is created.
After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
To train a model, Amazon Personalize requires training data and a
recipe. The training data comes from the dataset group that you
provide in the request. A recipe specifies the training algorithm and
a feature transformation. You can specify one of the predefined
recipes provided by Amazon Personalize. Alternatively, you can specify
performAutoML
and Amazon Personalize will analyze your data and
select the optimum USER_PERSONALIZATION recipe for you.
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. Wait until
the status shows as ACTIVE before calling CreateSolutionVersion
.
Related APIs
ListSolutions
CreateSolutionVersion
DescribeSolution
DeleteSolution ^
ListSolutionVersions
DescribeSolutionVersion
1093 1094 1095 1096 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1093 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. 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 -or- CREATE FAILED
^
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
ListSolutionVersions
DescribeSolutionVersion ^
ListSolutions
CreateSolution
DescribeSolution
DeleteSolution
1174 1175 1176 1177 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1174 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 more information on campaigns, see CreateCampaign.
1204 1205 1206 1207 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1204 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.
1228 1229 1230 1231 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1228 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.
1257 1258 1259 1260 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1257 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 event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
1281 1282 1283 1284 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1281 def delete_event_tracker(params = {}, = {}) req = build_request(:delete_event_tracker, params) req.send_request() end |
#delete_filter(params = {}) ⇒ Struct
Deletes a filter.
1303 1304 1305 1306 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1303 def delete_filter(params = {}, = {}) req = build_request(:delete_filter, 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.
1327 1328 1329 1330 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1327 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.
1355 1356 1357 1358 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1355 def delete_solution(params = {}, = {}) req = build_request(:delete_solution, params) req.send_request() end |
#describe_algorithm(params = {}) ⇒ Types::DescribeAlgorithmResponse
Describes the given algorithm.
1409 1410 1411 1412 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1409 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.
1454 1455 1456 1457 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1454 def describe_batch_inference_job(params = {}, = {}) req = build_request(:describe_batch_inference_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.
1511 1512 1513 1514 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1511 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.
1547 1548 1549 1550 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1547 def describe_dataset(params = {}, = {}) req = build_request(:describe_dataset, params) req.send_request() end |
#describe_dataset_group(params = {}) ⇒ Types::DescribeDatasetGroupResponse
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
1583 1584 1585 1586 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1583 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.
1620 1621 1622 1623 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1620 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.
1657 1658 1659 1660 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1657 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.
1692 1693 1694 1695 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1692 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.
1727 1728 1729 1730 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1727 def describe_filter(params = {}, = {}) req = build_request(:describe_filter, 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.
1783 1784 1785 1786 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1783 def describe_recipe(params = {}, = {}) req = build_request(:describe_recipe, params) req.send_request() end |
#describe_schema(params = {}) ⇒ Types::DescribeSchemaResponse
Describes a schema. For more information on schemas, see CreateSchema.
1815 1816 1817 1818 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1815 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.
1884 1885 1886 1887 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1884 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.
1952 1953 1954 1955 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1952 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.
1984 1985 1986 1987 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1984 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.
2034 2035 2036 2037 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2034 def list_batch_inference_jobs(params = {}, = {}) req = build_request(:list_batch_inference_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.
2087 2088 2089 2090 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2087 def list_campaigns(params = {}, = {}) req = build_request(:list_campaigns, 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.
2132 2133 2134 2135 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2132 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.
2185 2186 2187 2188 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2185 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.
2236 2237 2238 2239 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2236 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.
2285 2286 2287 2288 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2285 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.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2331 def list_filters(params = {}, = {}) req = build_request(:list_filters, 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.
2379 2380 2381 2382 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2379 def list_recipes(params = {}, = {}) req = build_request(:list_recipes, 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.
2422 2423 2424 2425 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2422 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). For more information on solutions, see CreateSolution.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2472 2473 2474 2475 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2472 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 that use the 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.
2522 2523 2524 2525 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2522 def list_solutions(params = {}, = {}) req = build_request(:list_solutions, params) req.send_request() end |
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign by either deploying a new solution or changing the
value of the campaign's minProvisionedTPS
parameter.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.
status
of the updated campaign is ACTIVE
before asking the campaign for recommendations.
For more information on campaigns, see CreateCampaign.
2578 2579 2580 2581 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2578 def update_campaign(params = {}, = {}) req = build_request(:update_campaign, params) req.send_request() end |