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_batch_segment_job(params = {}) ⇒ Types::CreateBatchSegmentJobResponse
Creates a batch segment job.
-
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
Creates a campaign that deploys a solution version.
-
#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_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
Creates the configuration for training a model.
-
#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_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_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_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 that use the 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
Remove [tags][1] that are attached to a resource.
-
#update_campaign(params = {}) ⇒ Types::UpdateCampaignResponse
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS
parameter. -
#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.
358 359 360 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 358 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 Creating a batch inference job.
459 460 461 462 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 459 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.
552 553 554 555 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 552 def create_batch_segment_job(params = {}, = {}) req = build_request(:create_batch_segment_job, params) req.send_request() end |
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
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 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
668 669 670 671 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 668 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
772 773 774 775 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 772 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.
866 867 868 869 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 866 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:
Interactions
Items
Users
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
991 992 993 994 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 991 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.
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
1090 1091 1092 1093 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1090 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
1181 1182 1183 1184 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1181 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.
1242 1243 1244 1245 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1242 def create_filter(params = {}, = {}) req = build_request(:create_filter, 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
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
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
1372 1373 1374 1375 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1372 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
1432 1433 1434 1435 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1432 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
1634 1635 1636 1637 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1634 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
1743 1744 1745 1746 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1743 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.
1774 1775 1776 1777 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1774 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.
1803 1804 1805 1806 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1803 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.
1832 1833 1834 1835 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1832 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.
1860 1861 1862 1863 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1860 def delete_event_tracker(params = {}, = {}) req = build_request(:delete_event_tracker, params) req.send_request() end |
#delete_filter(params = {}) ⇒ Struct
Deletes a filter.
1882 1883 1884 1885 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1882 def delete_filter(params = {}, = {}) req = build_request(:delete_filter, 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.
1909 1910 1911 1912 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1909 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.
1937 1938 1939 1940 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1937 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.
1970 1971 1972 1973 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 1970 def delete_solution(params = {}, = {}) req = build_request(:delete_solution, params) req.send_request() end |
#describe_algorithm(params = {}) ⇒ Types::DescribeAlgorithmResponse
Describes the given algorithm.
2024 2025 2026 2027 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2024 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.
2069 2070 2071 2072 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2069 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.
2112 2113 2114 2115 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2112 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.
2173 2174 2175 2176 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2173 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.
2213 2214 2215 2216 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2213 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.
2256 2257 2258 2259 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2256 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.
2297 2298 2299 2300 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2297 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.
2338 2339 2340 2341 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2338 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.
2379 2380 2381 2382 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2379 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.
2414 2415 2416 2417 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2414 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.
2449 2450 2451 2452 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2449 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.
2506 2507 2508 2509 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2506 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
DELETE PENDING > DELETE IN_PROGRESS
When the status
is CREATE FAILED
, the response includes the
failureReason
key, which describes why.
For more information on recommenders, see CreateRecommender.
2567 2568 2569 2570 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2567 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.
2605 2606 2607 2608 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2605 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.
2680 2681 2682 2683 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2680 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
2754 2755 2756 2757 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2754 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.
2786 2787 2788 2789 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2786 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.
2836 2837 2838 2839 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2836 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.
2886 2887 2888 2889 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2886 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.
2947 2948 2949 2950 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 2947 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.
3006 3007 3008 3009 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3006 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.
3056 3057 3058 3059 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3056 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.
3115 3116 3117 3118 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3115 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.
3170 3171 3172 3173 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3170 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.
3223 3224 3225 3226 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3223 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.
3271 3272 3273 3274 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3271 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.
3327 3328 3329 3330 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3327 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.
3388 3389 3390 3391 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3388 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.
3436 3437 3438 3439 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3436 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.
3485 3486 3487 3488 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3485 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.
3539 3540 3541 3542 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3539 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.
3573 3574 3575 3576 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3573 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.
3603 3604 3605 3606 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3603 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.
3632 3633 3634 3635 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3632 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.
3669 3670 3671 3672 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3669 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.
3705 3706 3707 3708 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3705 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove tags that are attached to a resource.
3735 3736 3737 3738 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3735 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, 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 operation.
Active
.
For more information on campaigns, see CreateCampaign.
3799 3800 3801 3802 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3799 def update_campaign(params = {}, = {}) req = build_request(:update_campaign, params) req.send_request() end |
#update_recommender(params = {}) ⇒ Types::UpdateRecommenderResponse
Updates the recommender to modify the recommender configuration.
3836 3837 3838 3839 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/client.rb', line 3836 def update_recommender(params = {}, = {}) req = build_request(:update_recommender, params) req.send_request() end |