Personalize class

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

Constructors

Personalize({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createBatchInferenceJob({required BatchInferenceJobInput jobInput, required String jobName, required BatchInferenceJobOutput jobOutput, required String roleArn, required String solutionVersionArn, BatchInferenceJobConfig? batchInferenceJobConfig, String? filterArn, int? numResults}) → Future<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.
createCampaign({required int minProvisionedTPS, required String name, required String solutionVersionArn, CampaignConfig? campaignConfig}) → Future<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.
createDataset({required String datasetGroupArn, required String datasetType, required String name, required String schemaArn}) → Future<CreateDatasetResponse>
Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.
createDatasetGroup({required String name, String? kmsKeyArn, String? roleArn}) → Future<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:
createDatasetImportJob({required DataSource dataSource, required String datasetArn, required String jobName, required String roleArn}) → Future<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. Status
createEventTracker({required String datasetGroupArn, required String name}) → Future<CreateEventTrackerResponse>
Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API.
createFilter({required String datasetGroupArn, required String filterExpression, required String name}) → Future<CreateFilterResponse>
Creates a recommendation filter. For more information, see Using Filters with Amazon Personalize.
createSchema({required String name, required String schema}) → Future<CreateSchemaResponse>
Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.
createSolution({required String datasetGroupArn, required String name, String? eventType, bool? performAutoML, bool? performHPO, String? recipeArn, SolutionConfig? solutionConfig}) → Future<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.
createSolutionVersion({required String solutionArn, TrainingMode? trainingMode}) → Future<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.
deleteCampaign({required String campaignArn}) → Future<void>
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.
deleteDataset({required String datasetArn}) → Future<void>
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.
deleteDatasetGroup({required String datasetGroupArn}) → Future<void>
Deletes a dataset group. Before you delete a dataset group, you must delete the following:
deleteEventTracker({required String eventTrackerArn}) → Future<void>
Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
deleteFilter({required String filterArn}) → Future<void>
Deletes a filter.
deleteSchema({required String schemaArn}) → Future<void>
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
deleteSolution({required String solutionArn}) → Future<void>
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.
describeAlgorithm({required String algorithmArn}) → Future<DescribeAlgorithmResponse>
Describes the given algorithm.
describeBatchInferenceJob({required String batchInferenceJobArn}) → Future<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.
describeCampaign({required String campaignArn}) → Future<DescribeCampaignResponse>
Describes the given campaign, including its status.
describeDataset({required String datasetArn}) → Future<DescribeDatasetResponse>
Describes the given dataset. For more information on datasets, see CreateDataset.
describeDatasetGroup({required String datasetGroupArn}) → Future<DescribeDatasetGroupResponse>
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
describeDatasetImportJob({required String datasetImportJobArn}) → Future<DescribeDatasetImportJobResponse>
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
describeEventTracker({required String eventTrackerArn}) → Future<DescribeEventTrackerResponse>
Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
describeFeatureTransformation({required String featureTransformationArn}) → Future<DescribeFeatureTransformationResponse>
Describes the given feature transformation.
describeFilter({required String filterArn}) → Future<DescribeFilterResponse>
Describes a filter's properties.
describeRecipe({required String recipeArn}) → Future<DescribeRecipeResponse>
Describes a recipe.
describeSchema({required String schemaArn}) → Future<DescribeSchemaResponse>
Describes a schema. For more information on schemas, see CreateSchema.
describeSolution({required String solutionArn}) → Future<DescribeSolutionResponse>
Describes a solution. For more information on solutions, see CreateSolution.
describeSolutionVersion({required String solutionVersionArn}) → Future<DescribeSolutionVersionResponse>
Describes a specific version of a solution. For more information on solutions, see CreateSolution.
getSolutionMetrics({required String solutionVersionArn}) → Future<GetSolutionMetricsResponse>
Gets the metrics for the specified solution version.
listBatchInferenceJobs({int? maxResults, String? nextToken, String? solutionVersionArn}) → Future<ListBatchInferenceJobsResponse>
Gets a list of the batch inference jobs that have been performed off of a solution version.
listCampaigns({int? maxResults, String? nextToken, String? solutionArn}) → Future<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.
listDatasetGroups({int? maxResults, String? nextToken}) → Future<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.
listDatasetImportJobs({String? datasetArn, int? maxResults, String? nextToken}) → Future<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.
listDatasets({String? datasetGroupArn, int? maxResults, String? nextToken}) → Future<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.
listEventTrackers({String? datasetGroupArn, int? maxResults, String? nextToken}) → Future<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.
listFilters({String? datasetGroupArn, int? maxResults, String? nextToken}) → Future<ListFiltersResponse>
Lists all filters that belong to a given dataset group.
listRecipes({int? maxResults, String? nextToken, RecipeProvider? recipeProvider}) → Future<ListRecipesResponse>
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
listSchemas({int? maxResults, String? nextToken}) → Future<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.
listSolutions({String? datasetGroupArn, int? maxResults, String? nextToken}) → Future<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.
listSolutionVersions({int? maxResults, String? nextToken, String? solutionArn}) → Future<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.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
updateCampaign({required String campaignArn, CampaignConfig? campaignConfig, int? minProvisionedTPS, String? solutionVersionArn}) → Future<UpdateCampaignResponse>
Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

Operators

operator ==(Object other) → bool
The equality operator.
inherited