libZSservicesZSamazonka-personalizeZSamazonka-personalize
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Personalize.Lens

Contents

Description

 
Synopsis

Operations

ListDatasetGroups

listDatasetGroups_nextToken :: Lens' ListDatasetGroups (Maybe Text) Source #

A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).

listDatasetGroups_maxResults :: Lens' ListDatasetGroups (Maybe Natural) Source #

The maximum number of dataset groups to return.

listDatasetGroupsResponse_nextToken :: Lens' ListDatasetGroupsResponse (Maybe Text) Source #

A token for getting the next set of dataset groups (if they exist).

CreateBatchInferenceJob

createBatchInferenceJob_numResults :: Lens' CreateBatchInferenceJob (Maybe Int) Source #

The number of recommendations to retreive.

createBatchInferenceJob_filterArn :: Lens' CreateBatchInferenceJob (Maybe Text) Source #

The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering Batch Recommendations..

createBatchInferenceJob_jobName :: Lens' CreateBatchInferenceJob Text Source #

The name of the batch inference job to create.

createBatchInferenceJob_solutionVersionArn :: Lens' CreateBatchInferenceJob Text Source #

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

createBatchInferenceJob_jobInput :: Lens' CreateBatchInferenceJob BatchInferenceJobInput Source #

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

createBatchInferenceJob_jobOutput :: Lens' CreateBatchInferenceJob BatchInferenceJobOutput Source #

The path to the Amazon S3 bucket where the job's output will be stored.

createBatchInferenceJob_roleArn :: Lens' CreateBatchInferenceJob Text Source #

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

CreateFilter

createFilter_name :: Lens' CreateFilter Text Source #

The name of the filter to create.

createFilter_datasetGroupArn :: Lens' CreateFilter Text Source #

The ARN of the dataset group that the filter will belong to.

createFilter_filterExpression :: Lens' CreateFilter Text Source #

The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

CreateDatasetImportJob

createDatasetImportJob_datasetArn :: Lens' CreateDatasetImportJob Text Source #

The ARN of the dataset that receives the imported data.

createDatasetImportJob_dataSource :: Lens' CreateDatasetImportJob DataSource Source #

The Amazon S3 bucket that contains the training data to import.

createDatasetImportJob_roleArn :: Lens' CreateDatasetImportJob Text Source #

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

DescribeSolution

describeSolution_solutionArn :: Lens' DescribeSolution Text Source #

The Amazon Resource Name (ARN) of the solution to describe.

DescribeDatasetExportJob

describeDatasetExportJob_datasetExportJobArn :: Lens' DescribeDatasetExportJob Text Source #

The Amazon Resource Name (ARN) of the dataset export job to describe.

describeDatasetExportJobResponse_datasetExportJob :: Lens' DescribeDatasetExportJobResponse (Maybe DatasetExportJob) Source #

Information about the dataset export job, including the status.

The status is one of the following values:

  • CREATE PENDING
  • CREATE IN_PROGRESS
  • ACTIVE
  • CREATE FAILED

DeleteCampaign

deleteCampaign_campaignArn :: Lens' DeleteCampaign Text Source #

The Amazon Resource Name (ARN) of the campaign to delete.

UpdateCampaign

updateCampaign_campaignConfig :: Lens' UpdateCampaign (Maybe CampaignConfig) Source #

The configuration details of a campaign.

updateCampaign_minProvisionedTPS :: Lens' UpdateCampaign (Maybe Natural) Source #

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

updateCampaign_solutionVersionArn :: Lens' UpdateCampaign (Maybe Text) Source #

The ARN of a new solution version to deploy.

updateCampaign_campaignArn :: Lens' UpdateCampaign Text Source #

The Amazon Resource Name (ARN) of the campaign.

updateCampaignResponse_campaignArn :: Lens' UpdateCampaignResponse (Maybe Text) Source #

The same campaign ARN as given in the request.

ListCampaigns

listCampaigns_solutionArn :: Lens' ListCampaigns (Maybe Text) Source #

The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.

listCampaigns_nextToken :: Lens' ListCampaigns (Maybe Text) Source #

A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).

listCampaigns_maxResults :: Lens' ListCampaigns (Maybe Natural) Source #

The maximum number of campaigns to return.

listCampaignsResponse_nextToken :: Lens' ListCampaignsResponse (Maybe Text) Source #

A token for getting the next set of campaigns (if they exist).

DescribeDataset

describeDataset_datasetArn :: Lens' DescribeDataset Text Source #

The Amazon Resource Name (ARN) of the dataset to describe.

CreateSolutionVersion

createSolutionVersion_trainingMode :: Lens' CreateSolutionVersion (Maybe TrainingMode) Source #

The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

createSolutionVersion_solutionArn :: Lens' CreateSolutionVersion Text Source #

The Amazon Resource Name (ARN) of the solution containing the training configuration information.

StopSolutionVersionCreation

stopSolutionVersionCreation_solutionVersionArn :: Lens' StopSolutionVersionCreation Text Source #

The Amazon Resource Name (ARN) of the solution version you want to stop creating.

CreateCampaign

createCampaign_campaignConfig :: Lens' CreateCampaign (Maybe CampaignConfig) Source #

The configuration details of a campaign.

createCampaign_minProvisionedTPS :: Lens' CreateCampaign (Maybe Natural) Source #

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

createCampaign_name :: Lens' CreateCampaign Text Source #

A name for the new campaign. The campaign name must be unique within your account.

createCampaign_solutionVersionArn :: Lens' CreateCampaign Text Source #

The Amazon Resource Name (ARN) of the solution version to deploy.

createCampaignResponse_campaignArn :: Lens' CreateCampaignResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the campaign.

DescribeFilter

describeFilter_filterArn :: Lens' DescribeFilter Text Source #

The ARN of the filter to describe.

ListEventTrackers

listEventTrackers_nextToken :: Lens' ListEventTrackers (Maybe Text) Source #

A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).

listEventTrackers_datasetGroupArn :: Lens' ListEventTrackers (Maybe Text) Source #

The ARN of a dataset group used to filter the response.

listEventTrackers_maxResults :: Lens' ListEventTrackers (Maybe Natural) Source #

The maximum number of event trackers to return.

listEventTrackersResponse_nextToken :: Lens' ListEventTrackersResponse (Maybe Text) Source #

A token for getting the next set of event trackers (if they exist).

CreateDatasetExportJob

createDatasetExportJob_ingestionMode :: Lens' CreateDatasetExportJob (Maybe IngestionMode) Source #

The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

createDatasetExportJob_datasetArn :: Lens' CreateDatasetExportJob Text Source #

The Amazon Resource Name (ARN) of the dataset that contains the data to export.

createDatasetExportJob_roleArn :: Lens' CreateDatasetExportJob Text Source #

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

createDatasetExportJob_jobOutput :: Lens' CreateDatasetExportJob DatasetExportJobOutput Source #

The path to the Amazon S3 bucket where the job's output is stored.

createDatasetExportJobResponse_datasetExportJobArn :: Lens' CreateDatasetExportJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset export job.

CreateSolution

createSolution_performAutoML :: Lens' CreateSolution (Maybe Bool) Source #

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

createSolution_recipeArn :: Lens' CreateSolution (Maybe Text) Source #

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

createSolution_eventType :: Lens' CreateSolution (Maybe Text) Source #

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

createSolution_solutionConfig :: Lens' CreateSolution (Maybe SolutionConfig) Source #

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

createSolution_performHPO :: Lens' CreateSolution (Maybe Bool) Source #

Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

When performing AutoML, this parameter is always true and you should not set it to false.

createSolution_name :: Lens' CreateSolution Text Source #

The name for the solution.

createSolution_datasetGroupArn :: Lens' CreateSolution Text Source #

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

DeleteEventTracker

deleteEventTracker_eventTrackerArn :: Lens' DeleteEventTracker Text Source #

The Amazon Resource Name (ARN) of the event tracker to delete.

DescribeDatasetImportJob

describeDatasetImportJob_datasetImportJobArn :: Lens' DescribeDatasetImportJob Text Source #

The Amazon Resource Name (ARN) of the dataset import job to describe.

describeDatasetImportJobResponse_datasetImportJob :: Lens' DescribeDatasetImportJobResponse (Maybe DatasetImportJob) Source #

Information about the dataset import job, including the status.

The status is one of the following values:

  • CREATE PENDING
  • CREATE IN_PROGRESS
  • ACTIVE
  • CREATE FAILED

ListSchemas

listSchemas_nextToken :: Lens' ListSchemas (Maybe Text) Source #

A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).

listSchemas_maxResults :: Lens' ListSchemas (Maybe Natural) Source #

The maximum number of schemas to return.

listSchemasResponse_nextToken :: Lens' ListSchemasResponse (Maybe Text) Source #

A token used to get the next set of schemas (if they exist).

CreateEventTracker

createEventTracker_name :: Lens' CreateEventTracker Text Source #

The name for the event tracker.

createEventTracker_datasetGroupArn :: Lens' CreateEventTracker Text Source #

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

createEventTrackerResponse_trackingId :: Lens' CreateEventTrackerResponse (Maybe Text) Source #

The ID of the event tracker. Include this ID in requests to the PutEvents API.

DeleteSolution

deleteSolution_solutionArn :: Lens' DeleteSolution Text Source #

The ARN of the solution to delete.

DescribeCampaign

describeCampaign_campaignArn :: Lens' DescribeCampaign Text Source #

The Amazon Resource Name (ARN) of the campaign.

DeleteDataset

deleteDataset_datasetArn :: Lens' DeleteDataset Text Source #

The Amazon Resource Name (ARN) of the dataset to delete.

CreateDataset

createDataset_name :: Lens' CreateDataset Text Source #

The name for the dataset.

createDataset_schemaArn :: Lens' CreateDataset Text Source #

The ARN of the schema to associate with the dataset. The schema defines the dataset fields.

createDataset_datasetGroupArn :: Lens' CreateDataset Text Source #

The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

createDataset_datasetType :: Lens' CreateDataset Text Source #

The type of dataset.

One of the following (case insensitive) values:

  • Interactions
  • Items
  • Users

DescribeSolutionVersion

describeSolutionVersion_solutionVersionArn :: Lens' DescribeSolutionVersion Text Source #

The Amazon Resource Name (ARN) of the solution version.

DescribeEventTracker

describeEventTracker_eventTrackerArn :: Lens' DescribeEventTracker Text Source #

The Amazon Resource Name (ARN) of the event tracker to describe.

ListDatasetImportJobs

listDatasetImportJobs_datasetArn :: Lens' ListDatasetImportJobs (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.

listDatasetImportJobs_nextToken :: Lens' ListDatasetImportJobs (Maybe Text) Source #

A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

listDatasetImportJobs_maxResults :: Lens' ListDatasetImportJobs (Maybe Natural) Source #

The maximum number of dataset import jobs to return.

listDatasetImportJobsResponse_nextToken :: Lens' ListDatasetImportJobsResponse (Maybe Text) Source #

A token for getting the next set of dataset import jobs (if they exist).

DeleteFilter

deleteFilter_filterArn :: Lens' DeleteFilter Text Source #

The ARN of the filter to delete.

ListBatchInferenceJobs

listBatchInferenceJobs_nextToken :: Lens' ListBatchInferenceJobs (Maybe Text) Source #

The token to request the next page of results.

listBatchInferenceJobs_maxResults :: Lens' ListBatchInferenceJobs (Maybe Natural) Source #

The maximum number of batch inference job results to return in each page. The default value is 100.

listBatchInferenceJobs_solutionVersionArn :: Lens' ListBatchInferenceJobs (Maybe Text) Source #

The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.

listBatchInferenceJobsResponse_nextToken :: Lens' ListBatchInferenceJobsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

ListFilters

listFilters_nextToken :: Lens' ListFilters (Maybe Text) Source #

A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).

listFilters_datasetGroupArn :: Lens' ListFilters (Maybe Text) Source #

The ARN of the dataset group that contains the filters.

listFilters_maxResults :: Lens' ListFilters (Maybe Natural) Source #

The maximum number of filters to return.

listFiltersResponse_nextToken :: Lens' ListFiltersResponse (Maybe Text) Source #

A token for getting the next set of filters (if they exist).

DeleteDatasetGroup

deleteDatasetGroup_datasetGroupArn :: Lens' DeleteDatasetGroup Text Source #

The ARN of the dataset group to delete.

DescribeSchema

describeSchema_schemaArn :: Lens' DescribeSchema Text Source #

The Amazon Resource Name (ARN) of the schema to retrieve.

DescribeAlgorithm

describeAlgorithm_algorithmArn :: Lens' DescribeAlgorithm Text Source #

The Amazon Resource Name (ARN) of the algorithm to describe.

ListSolutionVersions

listSolutionVersions_solutionArn :: Lens' ListSolutionVersions (Maybe Text) Source #

The Amazon Resource Name (ARN) of the solution.

listSolutionVersions_nextToken :: Lens' ListSolutionVersions (Maybe Text) Source #

A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).

listSolutionVersions_maxResults :: Lens' ListSolutionVersions (Maybe Natural) Source #

The maximum number of solution versions to return.

listSolutionVersionsResponse_nextToken :: Lens' ListSolutionVersionsResponse (Maybe Text) Source #

A token for getting the next set of solution versions (if they exist).

listSolutionVersionsResponse_solutionVersions :: Lens' ListSolutionVersionsResponse (Maybe [SolutionVersionSummary]) Source #

A list of solution versions describing the version properties.

DescribeBatchInferenceJob

CreateSchema

createSchema_name :: Lens' CreateSchema Text Source #

The name for the schema.

createSchema_schema :: Lens' CreateSchema Text Source #

A schema in Avro JSON format.

createSchemaResponse_schemaArn :: Lens' CreateSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the created schema.

DescribeRecipe

describeRecipe_recipeArn :: Lens' DescribeRecipe Text Source #

The Amazon Resource Name (ARN) of the recipe to describe.

ListSolutions

listSolutions_nextToken :: Lens' ListSolutions (Maybe Text) Source #

A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).

listSolutions_datasetGroupArn :: Lens' ListSolutions (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group.

listSolutions_maxResults :: Lens' ListSolutions (Maybe Natural) Source #

The maximum number of solutions to return.

listSolutionsResponse_nextToken :: Lens' ListSolutionsResponse (Maybe Text) Source #

A token for getting the next set of solutions (if they exist).

ListDatasetExportJobs

listDatasetExportJobs_datasetArn :: Lens' ListDatasetExportJobs (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.

listDatasetExportJobs_nextToken :: Lens' ListDatasetExportJobs (Maybe Text) Source #

A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).

listDatasetExportJobs_maxResults :: Lens' ListDatasetExportJobs (Maybe Natural) Source #

The maximum number of dataset export jobs to return.

listDatasetExportJobsResponse_nextToken :: Lens' ListDatasetExportJobsResponse (Maybe Text) Source #

A token for getting the next set of dataset export jobs (if they exist).

DescribeDatasetGroup

describeDatasetGroup_datasetGroupArn :: Lens' DescribeDatasetGroup Text Source #

The Amazon Resource Name (ARN) of the dataset group to describe.

DescribeFeatureTransformation

describeFeatureTransformation_featureTransformationArn :: Lens' DescribeFeatureTransformation Text Source #

The Amazon Resource Name (ARN) of the feature transformation to describe.

GetSolutionMetrics

getSolutionMetrics_solutionVersionArn :: Lens' GetSolutionMetrics Text Source #

The Amazon Resource Name (ARN) of the solution version for which to get metrics.

getSolutionMetricsResponse_solutionVersionArn :: Lens' GetSolutionMetricsResponse (Maybe Text) Source #

The same solution version ARN as specified in the request.

DeleteSchema

deleteSchema_schemaArn :: Lens' DeleteSchema Text Source #

The Amazon Resource Name (ARN) of the schema to delete.

ListDatasets

listDatasets_nextToken :: Lens' ListDatasets (Maybe Text) Source #

A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

listDatasets_datasetGroupArn :: Lens' ListDatasets (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.

listDatasets_maxResults :: Lens' ListDatasets (Maybe Natural) Source #

The maximum number of datasets to return.

listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text) Source #

A token for getting the next set of datasets (if they exist).

listDatasetsResponse_datasets :: Lens' ListDatasetsResponse (Maybe [DatasetSummary]) Source #

An array of Dataset objects. Each object provides metadata information.

CreateDatasetGroup

createDatasetGroup_kmsKeyArn :: Lens' CreateDatasetGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.

createDatasetGroup_roleArn :: Lens' CreateDatasetGroup (Maybe Text) Source #

The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.

createDatasetGroup_name :: Lens' CreateDatasetGroup Text Source #

The name for the new dataset group.

createDatasetGroupResponse_datasetGroupArn :: Lens' CreateDatasetGroupResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the new dataset group.

ListRecipes

listRecipes_nextToken :: Lens' ListRecipes (Maybe Text) Source #

A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

listRecipes_maxResults :: Lens' ListRecipes (Maybe Natural) Source #

The maximum number of recipes to return.

listRecipesResponse_nextToken :: Lens' ListRecipesResponse (Maybe Text) Source #

A token for getting the next set of recipes.

Types

Algorithm

algorithm_defaultHyperParameters :: Lens' Algorithm (Maybe (HashMap Text Text)) Source #

Specifies the default hyperparameters.

algorithm_algorithmArn :: Lens' Algorithm (Maybe Text) Source #

The Amazon Resource Name (ARN) of the algorithm.

algorithm_defaultHyperParameterRanges :: Lens' Algorithm (Maybe DefaultHyperParameterRanges) Source #

Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

algorithm_algorithmImage :: Lens' Algorithm (Maybe AlgorithmImage) Source #

The URI of the Docker container for the algorithm image.

algorithm_lastUpdatedDateTime :: Lens' Algorithm (Maybe UTCTime) Source #

The date and time (in Unix time) that the algorithm was last updated.

algorithm_name :: Lens' Algorithm (Maybe Text) Source #

The name of the algorithm.

algorithm_creationDateTime :: Lens' Algorithm (Maybe UTCTime) Source #

The date and time (in Unix time) that the algorithm was created.

algorithm_defaultResourceConfig :: Lens' Algorithm (Maybe (HashMap Text Text)) Source #

Specifies the default maximum number of training jobs and parallel training jobs.

algorithm_roleArn :: Lens' Algorithm (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role.

AlgorithmImage

algorithmImage_name :: Lens' AlgorithmImage (Maybe Text) Source #

The name of the algorithm image.

algorithmImage_dockerURI :: Lens' AlgorithmImage Text Source #

The URI of the Docker container for the algorithm image.

AutoMLConfig

autoMLConfig_recipeList :: Lens' AutoMLConfig (Maybe [Text]) Source #

The list of candidate recipes.

AutoMLResult

autoMLResult_bestRecipeArn :: Lens' AutoMLResult (Maybe Text) Source #

The Amazon Resource Name (ARN) of the best recipe.

BatchInferenceJob

batchInferenceJob_failureReason :: Lens' BatchInferenceJob (Maybe Text) Source #

If the batch inference job failed, the reason for the failure.

batchInferenceJob_status :: Lens' BatchInferenceJob (Maybe Text) Source #

The status of the batch inference job. The status is one of the following values:

  • PENDING
  • IN PROGRESS
  • ACTIVE
  • CREATE FAILED

batchInferenceJob_jobOutput :: Lens' BatchInferenceJob (Maybe BatchInferenceJobOutput) Source #

The Amazon S3 bucket that contains the output data generated by the batch inference job.

batchInferenceJob_jobName :: Lens' BatchInferenceJob (Maybe Text) Source #

The name of the batch inference job.

batchInferenceJob_lastUpdatedDateTime :: Lens' BatchInferenceJob (Maybe UTCTime) Source #

The time at which the batch inference job was last updated.

batchInferenceJob_numResults :: Lens' BatchInferenceJob (Maybe Int) Source #

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

batchInferenceJob_batchInferenceJobConfig :: Lens' BatchInferenceJob (Maybe BatchInferenceJobConfig) Source #

A string to string map of the configuration details of a batch inference job.

batchInferenceJob_batchInferenceJobArn :: Lens' BatchInferenceJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the batch inference job.

batchInferenceJob_filterArn :: Lens' BatchInferenceJob (Maybe Text) Source #

The ARN of the filter used on the batch inference job.

batchInferenceJob_creationDateTime :: Lens' BatchInferenceJob (Maybe UTCTime) Source #

The time at which the batch inference job was created.

batchInferenceJob_solutionVersionArn :: Lens' BatchInferenceJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

batchInferenceJob_roleArn :: Lens' BatchInferenceJob (Maybe Text) Source #

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

batchInferenceJob_jobInput :: Lens' BatchInferenceJob (Maybe BatchInferenceJobInput) Source #

The Amazon S3 path that leads to the input data used to generate the batch inference job.

BatchInferenceJobConfig

batchInferenceJobConfig_itemExplorationConfig :: Lens' BatchInferenceJobConfig (Maybe (HashMap Text Text)) Source #

A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.

BatchInferenceJobInput

batchInferenceJobInput_s3DataSource :: Lens' BatchInferenceJobInput S3DataConfig Source #

The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.

BatchInferenceJobOutput

batchInferenceJobOutput_s3DataDestination :: Lens' BatchInferenceJobOutput S3DataConfig Source #

Information on the Amazon S3 bucket in which the batch inference job's output is stored.

BatchInferenceJobSummary

batchInferenceJobSummary_failureReason :: Lens' BatchInferenceJobSummary (Maybe Text) Source #

If the batch inference job failed, the reason for the failure.

batchInferenceJobSummary_status :: Lens' BatchInferenceJobSummary (Maybe Text) Source #

The status of the batch inference job. The status is one of the following values:

  • PENDING
  • IN PROGRESS
  • ACTIVE
  • CREATE FAILED

batchInferenceJobSummary_lastUpdatedDateTime :: Lens' BatchInferenceJobSummary (Maybe UTCTime) Source #

The time at which the batch inference job was last updated.

batchInferenceJobSummary_batchInferenceJobArn :: Lens' BatchInferenceJobSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the batch inference job.

batchInferenceJobSummary_creationDateTime :: Lens' BatchInferenceJobSummary (Maybe UTCTime) Source #

The time at which the batch inference job was created.

batchInferenceJobSummary_solutionVersionArn :: Lens' BatchInferenceJobSummary (Maybe Text) Source #

The ARN of the solution version used by the batch inference job.

Campaign

campaign_failureReason :: Lens' Campaign (Maybe Text) Source #

If a campaign fails, the reason behind the failure.

campaign_status :: Lens' Campaign (Maybe Text) Source #

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

campaign_lastUpdatedDateTime :: Lens' Campaign (Maybe UTCTime) Source #

The date and time (in Unix format) that the campaign was last updated.

campaign_campaignConfig :: Lens' Campaign (Maybe CampaignConfig) Source #

The configuration details of a campaign.

campaign_name :: Lens' Campaign (Maybe Text) Source #

The name of the campaign.

campaign_minProvisionedTPS :: Lens' Campaign (Maybe Natural) Source #

Specifies the requested minimum provisioned transactions (recommendations) per second.

campaign_creationDateTime :: Lens' Campaign (Maybe UTCTime) Source #

The date and time (in Unix format) that the campaign was created.

campaign_campaignArn :: Lens' Campaign (Maybe Text) Source #

The Amazon Resource Name (ARN) of the campaign.

campaign_solutionVersionArn :: Lens' Campaign (Maybe Text) Source #

The Amazon Resource Name (ARN) of a specific version of the solution.

CampaignConfig

campaignConfig_itemExplorationConfig :: Lens' CampaignConfig (Maybe (HashMap Text Text)) Source #

A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

CampaignSummary

campaignSummary_failureReason :: Lens' CampaignSummary (Maybe Text) Source #

If a campaign fails, the reason behind the failure.

campaignSummary_status :: Lens' CampaignSummary (Maybe Text) Source #

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

campaignSummary_lastUpdatedDateTime :: Lens' CampaignSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the campaign was last updated.

campaignSummary_creationDateTime :: Lens' CampaignSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the campaign was created.

campaignSummary_campaignArn :: Lens' CampaignSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the campaign.

CampaignUpdateSummary

campaignUpdateSummary_failureReason :: Lens' CampaignUpdateSummary (Maybe Text) Source #

If a campaign update fails, the reason behind the failure.

campaignUpdateSummary_status :: Lens' CampaignUpdateSummary (Maybe Text) Source #

The status of the campaign update.

A campaign update can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

campaignUpdateSummary_lastUpdatedDateTime :: Lens' CampaignUpdateSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the campaign update was last updated.

campaignUpdateSummary_minProvisionedTPS :: Lens' CampaignUpdateSummary (Maybe Natural) Source #

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

campaignUpdateSummary_creationDateTime :: Lens' CampaignUpdateSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the campaign update was created.

campaignUpdateSummary_solutionVersionArn :: Lens' CampaignUpdateSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the deployed solution version.

CategoricalHyperParameterRange

categoricalHyperParameterRange_values :: Lens' CategoricalHyperParameterRange (Maybe [Text]) Source #

A list of the categories for the hyperparameter.

ContinuousHyperParameterRange

continuousHyperParameterRange_maxValue :: Lens' ContinuousHyperParameterRange (Maybe Double) Source #

The maximum allowable value for the hyperparameter.

continuousHyperParameterRange_minValue :: Lens' ContinuousHyperParameterRange (Maybe Double) Source #

The minimum allowable value for the hyperparameter.

DataSource

dataSource_dataLocation :: Lens' DataSource (Maybe Text) Source #

The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example:

s3://bucket-name/folder-name/

Dataset

dataset_status :: Lens' Dataset (Maybe Text) Source #

The status of the dataset.

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

dataset_datasetArn :: Lens' Dataset (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

dataset_lastUpdatedDateTime :: Lens' Dataset (Maybe UTCTime) Source #

A time stamp that shows when the dataset was updated.

dataset_schemaArn :: Lens' Dataset (Maybe Text) Source #

The ARN of the associated schema.

dataset_name :: Lens' Dataset (Maybe Text) Source #

The name of the dataset.

dataset_datasetType :: Lens' Dataset (Maybe Text) Source #

One of the following values:

  • Interactions
  • Items
  • Users

dataset_creationDateTime :: Lens' Dataset (Maybe UTCTime) Source #

The creation date and time (in Unix time) of the dataset.

dataset_datasetGroupArn :: Lens' Dataset (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group.

DatasetExportJob

datasetExportJob_failureReason :: Lens' DatasetExportJob (Maybe Text) Source #

If a dataset export job fails, provides the reason why.

datasetExportJob_status :: Lens' DatasetExportJob (Maybe Text) Source #

The status of the dataset export job.

A dataset export job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

datasetExportJob_datasetExportJobArn :: Lens' DatasetExportJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset export job.

datasetExportJob_datasetArn :: Lens' DatasetExportJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset to export.

datasetExportJob_jobOutput :: Lens' DatasetExportJob (Maybe DatasetExportJobOutput) Source #

The path to the Amazon S3 bucket where the job's output is stored. For example:

s3://bucket-name/folder-name/

datasetExportJob_lastUpdatedDateTime :: Lens' DatasetExportJob (Maybe UTCTime) Source #

The date and time (in Unix time) the status of the dataset export job was last updated.

datasetExportJob_ingestionMode :: Lens' DatasetExportJob (Maybe IngestionMode) Source #

The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

datasetExportJob_creationDateTime :: Lens' DatasetExportJob (Maybe UTCTime) Source #

The creation date and time (in Unix time) of the dataset export job.

datasetExportJob_roleArn :: Lens' DatasetExportJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

DatasetExportJobOutput

DatasetExportJobSummary

datasetExportJobSummary_failureReason :: Lens' DatasetExportJobSummary (Maybe Text) Source #

If a dataset export job fails, the reason behind the failure.

datasetExportJobSummary_status :: Lens' DatasetExportJobSummary (Maybe Text) Source #

The status of the dataset export job.

A dataset export job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

datasetExportJobSummary_datasetExportJobArn :: Lens' DatasetExportJobSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset export job.

datasetExportJobSummary_lastUpdatedDateTime :: Lens' DatasetExportJobSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the dataset export job status was last updated.

datasetExportJobSummary_creationDateTime :: Lens' DatasetExportJobSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the dataset export job was created.

DatasetGroup

datasetGroup_failureReason :: Lens' DatasetGroup (Maybe Text) Source #

If creating a dataset group fails, provides the reason why.

datasetGroup_status :: Lens' DatasetGroup (Maybe Text) Source #

The current status of the dataset group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING

datasetGroup_kmsKeyArn :: Lens' DatasetGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

datasetGroup_lastUpdatedDateTime :: Lens' DatasetGroup (Maybe UTCTime) Source #

The last update date and time (in Unix time) of the dataset group.

datasetGroup_name :: Lens' DatasetGroup (Maybe Text) Source #

The name of the dataset group.

datasetGroup_creationDateTime :: Lens' DatasetGroup (Maybe UTCTime) Source #

The creation date and time (in Unix time) of the dataset group.

datasetGroup_datasetGroupArn :: Lens' DatasetGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group.

datasetGroup_roleArn :: Lens' DatasetGroup (Maybe Text) Source #

The ARN of the IAM role that has permissions to create the dataset group.

DatasetGroupSummary

datasetGroupSummary_failureReason :: Lens' DatasetGroupSummary (Maybe Text) Source #

If creating a dataset group fails, the reason behind the failure.

datasetGroupSummary_status :: Lens' DatasetGroupSummary (Maybe Text) Source #

The status of the dataset group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING

datasetGroupSummary_lastUpdatedDateTime :: Lens' DatasetGroupSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the dataset group was last updated.

datasetGroupSummary_creationDateTime :: Lens' DatasetGroupSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the dataset group was created.

datasetGroupSummary_datasetGroupArn :: Lens' DatasetGroupSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group.

DatasetImportJob

datasetImportJob_failureReason :: Lens' DatasetImportJob (Maybe Text) Source #

If a dataset import job fails, provides the reason why.

datasetImportJob_status :: Lens' DatasetImportJob (Maybe Text) Source #

The status of the dataset import job.

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

datasetImportJob_datasetArn :: Lens' DatasetImportJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

datasetImportJob_lastUpdatedDateTime :: Lens' DatasetImportJob (Maybe UTCTime) Source #

The date and time (in Unix time) the dataset was last updated.

datasetImportJob_dataSource :: Lens' DatasetImportJob (Maybe DataSource) Source #

The Amazon S3 bucket that contains the training data to import.

datasetImportJob_creationDateTime :: Lens' DatasetImportJob (Maybe UTCTime) Source #

The creation date and time (in Unix time) of the dataset import job.

datasetImportJob_roleArn :: Lens' DatasetImportJob (Maybe Text) Source #

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

DatasetImportJobSummary

datasetImportJobSummary_failureReason :: Lens' DatasetImportJobSummary (Maybe Text) Source #

If a dataset import job fails, the reason behind the failure.

datasetImportJobSummary_status :: Lens' DatasetImportJobSummary (Maybe Text) Source #

The status of the dataset import job.

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

datasetImportJobSummary_lastUpdatedDateTime :: Lens' DatasetImportJobSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the dataset import job status was last updated.

datasetImportJobSummary_datasetImportJobArn :: Lens' DatasetImportJobSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset import job.

datasetImportJobSummary_creationDateTime :: Lens' DatasetImportJobSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the dataset import job was created.

DatasetSchema

datasetSchema_lastUpdatedDateTime :: Lens' DatasetSchema (Maybe UTCTime) Source #

The date and time (in Unix time) that the schema was last updated.

datasetSchema_schemaArn :: Lens' DatasetSchema (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

datasetSchema_creationDateTime :: Lens' DatasetSchema (Maybe UTCTime) Source #

The date and time (in Unix time) that the schema was created.

DatasetSchemaSummary

datasetSchemaSummary_lastUpdatedDateTime :: Lens' DatasetSchemaSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the schema was last updated.

datasetSchemaSummary_schemaArn :: Lens' DatasetSchemaSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the schema.

datasetSchemaSummary_creationDateTime :: Lens' DatasetSchemaSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the schema was created.

DatasetSummary

datasetSummary_status :: Lens' DatasetSummary (Maybe Text) Source #

The status of the dataset.

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

datasetSummary_datasetArn :: Lens' DatasetSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

datasetSummary_lastUpdatedDateTime :: Lens' DatasetSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the dataset was last updated.

datasetSummary_datasetType :: Lens' DatasetSummary (Maybe Text) Source #

The dataset type. One of the following values:

  • Interactions
  • Items
  • Users
  • Event-Interactions

datasetSummary_creationDateTime :: Lens' DatasetSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the dataset was created.

DefaultCategoricalHyperParameterRange

DefaultContinuousHyperParameterRange

DefaultHyperParameterRanges

DefaultIntegerHyperParameterRange

EventTracker

eventTracker_status :: Lens' EventTracker (Maybe Text) Source #

The status of the event tracker.

An event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

eventTracker_trackingId :: Lens' EventTracker (Maybe Text) Source #

The ID of the event tracker. Include this ID in requests to the PutEvents API.

eventTracker_lastUpdatedDateTime :: Lens' EventTracker (Maybe UTCTime) Source #

The date and time (in Unix time) that the event tracker was last updated.

eventTracker_accountId :: Lens' EventTracker (Maybe Text) Source #

The Amazon Web Services account that owns the event tracker.

eventTracker_name :: Lens' EventTracker (Maybe Text) Source #

The name of the event tracker.

eventTracker_creationDateTime :: Lens' EventTracker (Maybe UTCTime) Source #

The date and time (in Unix format) that the event tracker was created.

eventTracker_datasetGroupArn :: Lens' EventTracker (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

EventTrackerSummary

eventTrackerSummary_status :: Lens' EventTrackerSummary (Maybe Text) Source #

The status of the event tracker.

An event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

eventTrackerSummary_lastUpdatedDateTime :: Lens' EventTrackerSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the event tracker was last updated.

eventTrackerSummary_creationDateTime :: Lens' EventTrackerSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the event tracker was created.

eventTrackerSummary_eventTrackerArn :: Lens' EventTrackerSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the event tracker.

FeatureTransformation

featureTransformation_status :: Lens' FeatureTransformation (Maybe Text) Source #

The status of the feature transformation.

A feature transformation can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

featureTransformation_featureTransformationArn :: Lens' FeatureTransformation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the FeatureTransformation object.

featureTransformation_lastUpdatedDateTime :: Lens' FeatureTransformation (Maybe UTCTime) Source #

The last update date and time (in Unix time) of the feature transformation.

featureTransformation_name :: Lens' FeatureTransformation (Maybe Text) Source #

The name of the feature transformation.

featureTransformation_creationDateTime :: Lens' FeatureTransformation (Maybe UTCTime) Source #

The creation date and time (in Unix time) of the feature transformation.

featureTransformation_defaultParameters :: Lens' FeatureTransformation (Maybe (HashMap Text Text)) Source #

Provides the default parameters for feature transformation.

Filter

filter_failureReason :: Lens' Filter (Maybe Text) Source #

If the filter failed, the reason for its failure.

filter_status :: Lens' Filter (Maybe Text) Source #

The status of the filter.

filter_filterExpression :: Lens' Filter (Maybe Text) Source #

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

filter_lastUpdatedDateTime :: Lens' Filter (Maybe UTCTime) Source #

The time at which the filter was last updated.

filter_name :: Lens' Filter (Maybe Text) Source #

The name of the filter.

filter_filterArn :: Lens' Filter (Maybe Text) Source #

The ARN of the filter.

filter_creationDateTime :: Lens' Filter (Maybe UTCTime) Source #

The time at which the filter was created.

filter_datasetGroupArn :: Lens' Filter (Maybe Text) Source #

The ARN of the dataset group to which the filter belongs.

FilterSummary

filterSummary_failureReason :: Lens' FilterSummary (Maybe Text) Source #

If the filter failed, the reason for the failure.

filterSummary_status :: Lens' FilterSummary (Maybe Text) Source #

The status of the filter.

filterSummary_lastUpdatedDateTime :: Lens' FilterSummary (Maybe UTCTime) Source #

The time at which the filter was last updated.

filterSummary_creationDateTime :: Lens' FilterSummary (Maybe UTCTime) Source #

The time at which the filter was created.

filterSummary_datasetGroupArn :: Lens' FilterSummary (Maybe Text) Source #

The ARN of the dataset group to which the filter belongs.

HPOConfig

hPOConfig_algorithmHyperParameterRanges :: Lens' HPOConfig (Maybe HyperParameterRanges) Source #

The hyperparameters and their allowable ranges.

hPOConfig_hpoResourceConfig :: Lens' HPOConfig (Maybe HPOResourceConfig) Source #

Describes the resource configuration for HPO.

hPOConfig_hpoObjective :: Lens' HPOConfig (Maybe HPOObjective) Source #

The metric to optimize during HPO.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

HPOObjective

hPOObjective_type :: Lens' HPOObjective (Maybe Text) Source #

The type of the metric. Valid values are Maximize and Minimize.

hPOObjective_metricRegex :: Lens' HPOObjective (Maybe Text) Source #

A regular expression for finding the metric in the training job logs.

HPOResourceConfig

hPOResourceConfig_maxNumberOfTrainingJobs :: Lens' HPOResourceConfig (Maybe Text) Source #

The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.

hPOResourceConfig_maxParallelTrainingJobs :: Lens' HPOResourceConfig (Maybe Text) Source #

The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.

HyperParameterRanges

IntegerHyperParameterRange

integerHyperParameterRange_maxValue :: Lens' IntegerHyperParameterRange (Maybe Int) Source #

The maximum allowable value for the hyperparameter.

integerHyperParameterRange_minValue :: Lens' IntegerHyperParameterRange (Maybe Int) Source #

The minimum allowable value for the hyperparameter.

OptimizationObjective

optimizationObjective_itemAttribute :: Lens' OptimizationObjective (Maybe Text) Source #

The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).

optimizationObjective_objectiveSensitivity :: Lens' OptimizationObjective (Maybe ObjectiveSensitivity) Source #

Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.

Recipe

recipe_status :: Lens' Recipe (Maybe Text) Source #

The status of the recipe.

recipe_algorithmArn :: Lens' Recipe (Maybe Text) Source #

The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.

recipe_recipeArn :: Lens' Recipe (Maybe Text) Source #

The Amazon Resource Name (ARN) of the recipe.

recipe_featureTransformationArn :: Lens' Recipe (Maybe Text) Source #

The ARN of the FeatureTransformation object.

recipe_lastUpdatedDateTime :: Lens' Recipe (Maybe UTCTime) Source #

The date and time (in Unix format) that the recipe was last updated.

recipe_name :: Lens' Recipe (Maybe Text) Source #

The name of the recipe.

recipe_creationDateTime :: Lens' Recipe (Maybe UTCTime) Source #

The date and time (in Unix format) that the recipe was created.

recipe_recipeType :: Lens' Recipe (Maybe Text) Source #

One of the following values:

  • PERSONALIZED_RANKING
  • RELATED_ITEMS
  • USER_PERSONALIZATION

recipe_description :: Lens' Recipe (Maybe Text) Source #

The description of the recipe.

RecipeSummary

recipeSummary_status :: Lens' RecipeSummary (Maybe Text) Source #

The status of the recipe.

recipeSummary_recipeArn :: Lens' RecipeSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the recipe.

recipeSummary_lastUpdatedDateTime :: Lens' RecipeSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the recipe was last updated.

recipeSummary_creationDateTime :: Lens' RecipeSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the recipe was created.

S3DataConfig

s3DataConfig_kmsKeyArn :: Lens' S3DataConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.

s3DataConfig_path :: Lens' S3DataConfig Text Source #

The file path of the Amazon S3 bucket.

Solution

solution_solutionArn :: Lens' Solution (Maybe Text) Source #

The ARN of the solution.

solution_status :: Lens' Solution (Maybe Text) Source #

The status of the solution.

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

solution_performAutoML :: Lens' Solution (Maybe Bool) Source #

When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.

solution_recipeArn :: Lens' Solution (Maybe Text) Source #

The ARN of the recipe used to create the solution.

solution_lastUpdatedDateTime :: Lens' Solution (Maybe UTCTime) Source #

The date and time (in Unix time) that the solution was last updated.

solution_eventType :: Lens' Solution (Maybe Text) Source #

The event type (for example, 'click' or 'like') that is used for training the model. If no eventType is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.

solution_name :: Lens' Solution (Maybe Text) Source #

The name of the solution.

solution_autoMLResult :: Lens' Solution (Maybe AutoMLResult) Source #

When performAutoML is true, specifies the best recipe found.

solution_creationDateTime :: Lens' Solution (Maybe UTCTime) Source #

The creation date and time (in Unix time) of the solution.

solution_datasetGroupArn :: Lens' Solution (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

solution_latestSolutionVersion :: Lens' Solution (Maybe SolutionVersionSummary) Source #

Describes the latest version of the solution, including the status and the ARN.

solution_solutionConfig :: Lens' Solution (Maybe SolutionConfig) Source #

Describes the configuration properties for the solution.

solution_performHPO :: Lens' Solution (Maybe Bool) Source #

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

SolutionConfig

solutionConfig_hpoConfig :: Lens' SolutionConfig (Maybe HPOConfig) Source #

Describes the properties for hyperparameter optimization (HPO).

solutionConfig_eventValueThreshold :: Lens' SolutionConfig (Maybe Text) Source #

Only events with a value greater than or equal to this threshold are used for training a model.

solutionConfig_autoMLConfig :: Lens' SolutionConfig (Maybe AutoMLConfig) Source #

The AutoMLConfig object containing a list of recipes to search when AutoML is performed.

solutionConfig_algorithmHyperParameters :: Lens' SolutionConfig (Maybe (HashMap Text Text)) Source #

Lists the hyperparameter names and ranges.

solutionConfig_optimizationObjective :: Lens' SolutionConfig (Maybe OptimizationObjective) Source #

Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.

SolutionSummary

solutionSummary_solutionArn :: Lens' SolutionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the solution.

solutionSummary_status :: Lens' SolutionSummary (Maybe Text) Source #

The status of the solution.

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS

solutionSummary_lastUpdatedDateTime :: Lens' SolutionSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the solution was last updated.

solutionSummary_creationDateTime :: Lens' SolutionSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the solution was created.

SolutionVersion

solutionVersion_failureReason :: Lens' SolutionVersion (Maybe Text) Source #

If training a solution version fails, the reason for the failure.

solutionVersion_status :: Lens' SolutionVersion (Maybe Text) Source #

The status of the solution version.

A solution version can be in one of the following states:

  • CREATE PENDING
  • CREATE IN_PROGRESS
  • ACTIVE
  • CREATE FAILED
  • CREATE STOPPING
  • CREATE STOPPED

solutionVersion_performAutoML :: Lens' SolutionVersion (Maybe Bool) Source #

When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

solutionVersion_tunedHPOParams :: Lens' SolutionVersion (Maybe TunedHPOParams) Source #

If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.

solutionVersion_recipeArn :: Lens' SolutionVersion (Maybe Text) Source #

The ARN of the recipe used in the solution.

solutionVersion_lastUpdatedDateTime :: Lens' SolutionVersion (Maybe UTCTime) Source #

The date and time (in Unix time) that the solution was last updated.

solutionVersion_eventType :: Lens' SolutionVersion (Maybe Text) Source #

The event type (for example, 'click' or 'like') that is used for training the model.

solutionVersion_creationDateTime :: Lens' SolutionVersion (Maybe UTCTime) Source #

The date and time (in Unix time) that this version of the solution was created.

solutionVersion_datasetGroupArn :: Lens' SolutionVersion (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group providing the training data.

solutionVersion_trainingMode :: Lens' SolutionVersion (Maybe TrainingMode) Source #

The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

solutionVersion_trainingHours :: Lens' SolutionVersion (Maybe Double) Source #

The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.

solutionVersion_solutionConfig :: Lens' SolutionVersion (Maybe SolutionConfig) Source #

Describes the configuration properties for the solution.

solutionVersion_performHPO :: Lens' SolutionVersion (Maybe Bool) Source #

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

SolutionVersionSummary

solutionVersionSummary_failureReason :: Lens' SolutionVersionSummary (Maybe Text) Source #

If a solution version fails, the reason behind the failure.

solutionVersionSummary_status :: Lens' SolutionVersionSummary (Maybe Text) Source #

The status of the solution version.

A solution version can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

solutionVersionSummary_lastUpdatedDateTime :: Lens' SolutionVersionSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that the solution version was last updated.

solutionVersionSummary_creationDateTime :: Lens' SolutionVersionSummary (Maybe UTCTime) Source #

The date and time (in Unix time) that this version of a solution was created.

solutionVersionSummary_solutionVersionArn :: Lens' SolutionVersionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the solution version.

TunedHPOParams

tunedHPOParams_algorithmHyperParameters :: Lens' TunedHPOParams (Maybe (HashMap Text Text)) Source #

A list of the hyperparameter values of the best performing model.