String name
The name of the algorithm.
String algorithmArn
The Amazon Resource Name (ARN) of the algorithm.
AlgorithmImage algorithmImage
The URI of the Docker container for the algorithm image.
Map<K,V> defaultHyperParameters
Specifies the default hyperparameters.
DefaultHyperParameterRanges defaultHyperParameterRanges
Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
Map<K,V> defaultResourceConfig
Specifies the default maximum number of training jobs and parallel training jobs.
String trainingInputMode
The training input mode.
String roleArn
The Amazon Resource Name (ARN) of the role.
Date creationDateTime
The date and time (in Unix time) that the algorithm was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the algorithm was last updated.
String bestRecipeArn
The Amazon Resource Name (ARN) of the best recipe.
String jobName
The name of the batch inference job.
String batchInferenceJobArn
The Amazon Resource Name (ARN) of the batch inference job.
String filterArn
The ARN of the filter used on the batch inference job.
String failureReason
If the batch inference job failed, the reason for the failure.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
Integer numResults
The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
BatchInferenceJobInput jobInput
The Amazon S3 path that leads to the input data used to generate the batch inference job.
BatchInferenceJobOutput jobOutput
The Amazon S3 bucket that contains the output data generated by the batch inference job.
BatchInferenceJobConfig batchInferenceJobConfig
A string to string map of the configuration details of a batch inference job.
String roleArn
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
String status
The status of the batch inference job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
Date creationDateTime
The time at which the batch inference job was created.
Date lastUpdatedDateTime
The time at which the batch inference job was last updated.
Map<K,V> itemExplorationConfig
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.
S3DataConfig s3DataSource
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.
S3DataConfig s3DataDestination
Information on the Amazon S3 bucket in which the batch inference job's output is stored.
String batchInferenceJobArn
The Amazon Resource Name (ARN) of the batch inference job.
String jobName
The name of the batch inference job.
String status
The status of the batch inference job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
Date creationDateTime
The time at which the batch inference job was created.
Date lastUpdatedDateTime
The time at which the batch inference job was last updated.
String failureReason
If the batch inference job failed, the reason for the failure.
String solutionVersionArn
The ARN of the solution version used by the batch inference job.
String jobName
The name of the batch segment job.
String batchSegmentJobArn
The Amazon Resource Name (ARN) of the batch segment job.
String filterArn
The ARN of the filter used on the batch segment job.
String failureReason
If the batch segment job failed, the reason for the failure.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
Integer numResults
The number of predicted users generated by the batch segment job for each line of input data.
BatchSegmentJobInput jobInput
The Amazon S3 path that leads to the input data used to generate the batch segment job.
BatchSegmentJobOutput jobOutput
The Amazon S3 bucket that contains the output data generated by the batch segment job.
String roleArn
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
String status
The status of the batch segment job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
Date creationDateTime
The time at which the batch segment job was created.
Date lastUpdatedDateTime
The time at which the batch segment job last updated.
S3DataConfig s3DataSource
S3DataConfig s3DataDestination
String batchSegmentJobArn
The Amazon Resource Name (ARN) of the batch segment job.
String jobName
The name of the batch segment job.
String status
The status of the batch segment job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
Date creationDateTime
The time at which the batch segment job was created.
Date lastUpdatedDateTime
The time at which the batch segment job was last updated.
String failureReason
If the batch segment job failed, the reason for the failure.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
String name
The name of the campaign.
String campaignArn
The Amazon Resource Name (ARN) of the campaign.
String solutionVersionArn
The Amazon Resource Name (ARN) of a specific version of the solution.
Integer minProvisionedTPS
Specifies the requested minimum provisioned transactions (recommendations) per second.
CampaignConfig campaignConfig
The configuration details of a campaign.
String status
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
String failureReason
If a campaign fails, the reason behind the failure.
Date creationDateTime
The date and time (in Unix format) that the campaign was created.
Date lastUpdatedDateTime
The date and time (in Unix format) that the campaign was last updated.
CampaignUpdateSummary latestCampaignUpdate
Map<K,V> itemExplorationConfig
Specifies 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.
String name
The name of the campaign.
String campaignArn
The Amazon Resource Name (ARN) of the campaign.
String status
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
Date creationDateTime
The date and time (in Unix time) that the campaign was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the campaign was last updated.
String failureReason
If a campaign fails, the reason behind the failure.
String solutionVersionArn
The Amazon Resource Name (ARN) of the deployed solution version.
Integer minProvisionedTPS
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
CampaignConfig campaignConfig
String status
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
String failureReason
If a campaign update fails, the reason behind the failure.
Date creationDateTime
The date and time (in Unix time) that the campaign update was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the campaign update was last updated.
String jobName
The name of the batch inference job to create.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
String filterArn
The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
Integer numResults
The number of recommendations to retrieve.
BatchInferenceJobInput jobInput
The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.
BatchInferenceJobOutput jobOutput
The path to the Amazon S3 bucket where the job's output will be stored.
String roleArn
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.
BatchInferenceJobConfig batchInferenceJobConfig
The configuration details of a batch inference job.
List<E> tags
A list of tags to apply to the batch inference job.
String batchInferenceJobArn
The ARN of the batch inference job.
String jobName
The name of the batch segment job to create.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
String filterArn
The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.
Integer numResults
The number of predicted users generated by the batch segment job for each line of input data.
BatchSegmentJobInput jobInput
The Amazon S3 path for the input data used to generate the batch segment job.
BatchSegmentJobOutput jobOutput
The Amazon S3 path for the bucket where the job's output will be stored.
String roleArn
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.
List<E> tags
A list of tags to apply to the batch segment job.
String batchSegmentJobArn
The ARN of the batch segment job.
String name
A name for the new campaign. The campaign name must be unique within your account.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version to deploy.
Integer minProvisionedTPS
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
CampaignConfig campaignConfig
The configuration details of a campaign.
List<E> tags
A list of tags to apply to the campaign.
String campaignArn
The Amazon Resource Name (ARN) of the campaign.
String jobName
The name for the dataset export job.
String datasetArn
The Amazon Resource Name (ARN) of the dataset that contains the data to export.
String ingestionMode
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.
String roleArn
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
DatasetExportJobOutput jobOutput
The path to the Amazon S3 bucket where the job's output is stored.
List<E> tags
A list of tags to apply to the dataset export job.
String datasetExportJobArn
The Amazon Resource Name (ARN) of the dataset export job.
String name
The name for the new dataset group.
String roleArn
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.
String kmsKeyArn
The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
String domain
The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.
List<E> tags
A list of tags to apply to the dataset group.
String jobName
The name for the dataset import job.
String datasetArn
The ARN of the dataset that receives the imported data.
DataSource dataSource
The Amazon S3 bucket that contains the training data to import.
String roleArn
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
List<E> tags
A list of tags to apply to the dataset import job.
String importMode
Specify how to add the new records to an existing dataset. The default import mode is FULL. If you
haven't imported bulk records into the dataset previously, you can only specify FULL.
Specify FULL to overwrite all existing bulk data in your dataset. Data you imported individually is
not replaced.
Specify INCREMENTAL to append the new records to the existing data in your dataset. Amazon
Personalize replaces any record with the same ID with the new one.
Boolean publishAttributionMetricsToS3
If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3
String datasetImportJobArn
The ARN of the dataset import job.
String name
The name for the dataset.
String schemaArn
The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
String datasetType
The type of dataset.
One of the following (case insensitive) values:
Interactions
Items
Users
List<E> tags
A list of tags to apply to the dataset.
String datasetArn
The ARN of the dataset.
String name
The name of the filter to create.
String datasetGroupArn
The ARN of the dataset group that the filter will belong to.
String filterExpression
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.
List<E> tags
A list of tags to apply to the filter.
String filterArn
The ARN of the new filter.
String name
A name for the metric attribution.
String datasetGroupArn
The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.
List<E> metrics
A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track
and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions,
provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example
SUM(Items.PRICE).
MetricAttributionOutput metricsOutputConfig
The output configuration details for the metric attribution.
String metricAttributionArn
The Amazon Resource Name (ARN) for the new metric attribution.
String name
The name of the recommender.
String datasetGroupArn
The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
String recipeArn
The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.
RecommenderConfig recommenderConfig
The configuration details of the recommender.
List<E> tags
A list of tags to apply to the recommender.
String recommenderArn
The Amazon Resource Name (ARN) of the recommender.
String schemaArn
The Amazon Resource Name (ARN) of the created schema.
String name
The name for the solution.
Boolean performHPO
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.
Boolean performAutoML
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.
String recipeArn
The ARN of the recipe to use for model training. Only specified when performAutoML is false.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
String eventType
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.
SolutionConfig solutionConfig
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.
List<E> tags
A list of tags to apply to the solution.
String solutionArn
The ARN of the solution.
String name
The name of the solution version.
String solutionArn
The Amazon Resource Name (ARN) of the solution containing the training configuration information.
String trainingMode
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.
List<E> tags
A list of tags to apply to the solution version.
String solutionVersionArn
The ARN of the new solution version.
String name
The name of the dataset.
String datasetArn
The Amazon Resource Name (ARN) of the dataset that you want metadata for.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group.
String datasetType
One of the following values:
Interactions
Items
Users
String schemaArn
The ARN of the associated schema.
String status
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
Date creationDateTime
The creation date and time (in Unix time) of the dataset.
Date lastUpdatedDateTime
A time stamp that shows when the dataset was updated.
String jobName
The name of the export job.
String datasetExportJobArn
The Amazon Resource Name (ARN) of the dataset export job.
String datasetArn
The Amazon Resource Name (ARN) of the dataset to export.
String ingestionMode
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.
String roleArn
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
String status
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
DatasetExportJobOutput jobOutput
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
Date creationDateTime
The creation date and time (in Unix time) of the dataset export job.
Date lastUpdatedDateTime
The date and time (in Unix time) the status of the dataset export job was last updated.
String failureReason
If a dataset export job fails, provides the reason why.
S3DataConfig s3DataDestination
String datasetExportJobArn
The Amazon Resource Name (ARN) of the dataset export job.
String jobName
The name of the dataset export job.
String status
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
Date creationDateTime
The date and time (in Unix time) that the dataset export job was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the dataset export job status was last updated.
String failureReason
If a dataset export job fails, the reason behind the failure.
String name
The name of the dataset group.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group.
String status
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
String roleArn
The ARN of the IAM role that has permissions to create the dataset group.
String kmsKeyArn
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.
Date creationDateTime
The creation date and time (in Unix time) of the dataset group.
Date lastUpdatedDateTime
The last update date and time (in Unix time) of the dataset group.
String failureReason
If creating a dataset group fails, provides the reason why.
String domain
The domain of a Domain dataset group.
String name
The name of the dataset group.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group.
String status
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
Date creationDateTime
The date and time (in Unix time) that the dataset group was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the dataset group was last updated.
String failureReason
If creating a dataset group fails, the reason behind the failure.
String domain
The domain of a Domain dataset group.
String jobName
The name of the import job.
String datasetImportJobArn
The ARN of the dataset import job.
String datasetArn
The Amazon Resource Name (ARN) of the dataset that receives the imported data.
DataSource dataSource
The Amazon S3 bucket that contains the training data to import.
String roleArn
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
String status
The status of the dataset ACTIVE -or- CREATE FAILED
Date creationDateTime
The creation date and time (in Unix time) of the dataset import job.
Date lastUpdatedDateTime
The date and time (in Unix time) the dataset was last updated.
String failureReason
If a dataset import job fails, provides the reason why.
String importMode
The import mode used by the dataset import job to import new records.
Boolean publishAttributionMetricsToS3
Whether the job publishes metrics to Amazon S3 for a metric attribution.
String datasetImportJobArn
The Amazon Resource Name (ARN) of the dataset import job.
String jobName
The name of the dataset import job.
String status
The status of the dataset ACTIVE -or- CREATE FAILED
Date creationDateTime
The date and time (in Unix time) that the dataset import job was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the dataset import job status was last updated.
String failureReason
If a dataset import job fails, the reason behind the failure.
String importMode
The import mode the dataset import job used to update the data in the dataset. For more information see Updating existing bulk data.
String name
The name of the schema.
String schemaArn
The Amazon Resource Name (ARN) of the schema.
String schema
The schema.
Date creationDateTime
The date and time (in Unix time) that the schema was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the schema was last updated.
String domain
The domain of a schema that you created for a dataset in a Domain dataset group.
String name
The name of the schema.
String schemaArn
The Amazon Resource Name (ARN) of the schema.
Date creationDateTime
The date and time (in Unix time) that the schema was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the schema was last updated.
String domain
The domain of a schema that you created for a dataset in a Domain dataset group.
String name
The name of the dataset.
String datasetArn
The Amazon Resource Name (ARN) of the dataset.
String datasetType
The dataset type. One of the following values:
Interactions
Items
Users
Event-Interactions
String status
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
Date creationDateTime
The date and time (in Unix time) that the dataset was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the dataset was last updated.
String dataLocation
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/
List<E> integerHyperParameterRanges
The integer-valued hyperparameters and their default ranges.
List<E> continuousHyperParameterRanges
The continuous hyperparameters and their default ranges.
List<E> categoricalHyperParameterRanges
The categorical hyperparameters and their default ranges.
String campaignArn
The Amazon Resource Name (ARN) of the campaign to delete.
String datasetGroupArn
The ARN of the dataset group to delete.
String datasetArn
The Amazon Resource Name (ARN) of the dataset to delete.
String eventTrackerArn
The Amazon Resource Name (ARN) of the event tracker to delete.
String filterArn
The ARN of the filter to delete.
String metricAttributionArn
The metric attribution's Amazon Resource Name (ARN).
String recommenderArn
The Amazon Resource Name (ARN) of the recommender to delete.
String schemaArn
The Amazon Resource Name (ARN) of the schema to delete.
String solutionArn
The ARN of the solution to delete.
String algorithmArn
The Amazon Resource Name (ARN) of the algorithm to describe.
Algorithm algorithm
A listing of the properties of the algorithm.
String batchInferenceJobArn
The ARN of the batch inference job to describe.
BatchInferenceJob batchInferenceJob
Information on the specified batch inference job.
String batchSegmentJobArn
The ARN of the batch segment job to describe.
BatchSegmentJob batchSegmentJob
Information on the specified batch segment job.
String campaignArn
The Amazon Resource Name (ARN) of the campaign.
Campaign campaign
The properties of the campaign.
String datasetExportJobArn
The Amazon Resource Name (ARN) of the dataset export job to describe.
DatasetExportJob datasetExportJob
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
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group to describe.
DatasetGroup datasetGroup
A listing of the dataset group's properties.
String datasetImportJobArn
The Amazon Resource Name (ARN) of the dataset import job to describe.
DatasetImportJob datasetImportJob
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
String datasetArn
The Amazon Resource Name (ARN) of the dataset to describe.
Dataset dataset
A listing of the dataset's properties.
String eventTrackerArn
The Amazon Resource Name (ARN) of the event tracker to describe.
EventTracker eventTracker
An object that describes the event tracker.
String featureTransformationArn
The Amazon Resource Name (ARN) of the feature transformation to describe.
FeatureTransformation featureTransformation
A listing of the FeatureTransformation properties.
String filterArn
The ARN of the filter to describe.
Filter filter
The filter's details.
String metricAttributionArn
The metric attribution's Amazon Resource Name (ARN).
MetricAttribution metricAttribution
The details of the metric attribution.
String recipeArn
The Amazon Resource Name (ARN) of the recipe to describe.
Recipe recipe
An object that describes the recipe.
String recommenderArn
The Amazon Resource Name (ARN) of the recommender to describe.
Recommender recommender
The properties of the recommender.
String schemaArn
The Amazon Resource Name (ARN) of the schema to retrieve.
DatasetSchema schema
The requested schema.
String solutionArn
The Amazon Resource Name (ARN) of the solution to describe.
Solution solution
An object that describes the solution.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version.
SolutionVersion solutionVersion
The solution version.
String name
The name of the event tracker.
String eventTrackerArn
The ARN of the event tracker.
String accountId
The Amazon Web Services account that owns the event tracker.
String trackingId
The ID of the event tracker. Include this ID in requests to the PutEvents API.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group that receives the event data.
String status
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
Date creationDateTime
The date and time (in Unix format) that the event tracker was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the event tracker was last updated.
String name
The name of the event tracker.
String eventTrackerArn
The Amazon Resource Name (ARN) of the event tracker.
String status
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
Date creationDateTime
The date and time (in Unix time) that the event tracker was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the event tracker was last updated.
String name
The name of the feature transformation.
String featureTransformationArn
The Amazon Resource Name (ARN) of the FeatureTransformation object.
Map<K,V> defaultParameters
Provides the default parameters for feature transformation.
Date creationDateTime
The creation date and time (in Unix time) of the feature transformation.
Date lastUpdatedDateTime
The last update date and time (in Unix time) of the feature transformation.
String status
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
String name
The name of the filter.
String filterArn
The ARN of the filter.
Date creationDateTime
The time at which the filter was created.
Date lastUpdatedDateTime
The time at which the filter was last updated.
String datasetGroupArn
The ARN of the dataset group to which the filter belongs.
String failureReason
If the filter failed, the reason for its failure.
String filterExpression
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.
String status
The status of the filter.
String name
The name of the filter.
String filterArn
The ARN of the filter.
Date creationDateTime
The time at which the filter was created.
Date lastUpdatedDateTime
The time at which the filter was last updated.
String datasetGroupArn
The ARN of the dataset group to which the filter belongs.
String failureReason
If the filter failed, the reason for the failure.
String status
The status of the filter.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version for which to get metrics.
String solutionVersionArn
The same solution version ARN as specified in the request.
Map<K,V> metrics
The metrics for the solution version. For more information, see Evaluating a solution version with metrics .
HPOObjective hpoObjective
The metric to optimize during HPO.
Amazon Personalize doesn't support configuring the hpoObjective at this time.
HPOResourceConfig hpoResourceConfig
Describes the resource configuration for HPO.
HyperParameterRanges algorithmHyperParameterRanges
The hyperparameters and their allowable ranges.
String maxNumberOfTrainingJobs
The maximum number of training jobs when you create a solution version. The maximum value for
maxNumberOfTrainingJobs is 40.
String maxParallelTrainingJobs
The maximum number of parallel training jobs when you create a solution version. The maximum value for
maxParallelTrainingJobs is 10.
List<E> integerHyperParameterRanges
The integer-valued hyperparameters and their ranges.
List<E> continuousHyperParameterRanges
The continuous hyperparameters and their ranges.
List<E> categoricalHyperParameterRanges
The categorical hyperparameters and their ranges.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of batch inference job results to return in each page. The default value is 100.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of batch segment job results to return in each page. The default value is 100.
String solutionArn
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.
String nextToken
A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
Integer maxResults
The maximum number of campaigns to return.
String datasetArn
The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.
String nextToken
A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset
export jobs (if they exist).
Integer maxResults
The maximum number of dataset export jobs to return.
String datasetArn
The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.
String nextToken
A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset
import jobs (if they exist).
Integer maxResults
The maximum number of dataset import jobs to return.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
String nextToken
A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset
import jobs (if they exist).
Integer maxResults
The maximum number of datasets to return.
String datasetGroupArn
The ARN of a dataset group used to filter the response.
String nextToken
A token returned from the previous call to ListEventTrackers for getting the next set of event
trackers (if they exist).
Integer maxResults
The maximum number of event trackers to return.
String datasetGroupArn
The ARN of the dataset group that contains the filters.
String nextToken
A token returned from the previous call to ListFilters for getting the next set of filters (if they
exist).
Integer maxResults
The maximum number of filters to return.
String metricAttributionArn
The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.
String nextToken
Specify the pagination token from a previous request to retrieve the next page of results.
Integer maxResults
The maximum number of metrics to return in one page of results.
String datasetGroupArn
The metric attributions' dataset group Amazon Resource Name (ARN).
String nextToken
Specify the pagination token from a previous request to retrieve the next page of results.
Integer maxResults
The maximum number of metric attributions to return in one page of results.
String recipeProvider
The default is SERVICE.
String nextToken
A token returned from the previous call to ListRecipes for getting the next set of recipes (if they
exist).
Integer maxResults
The maximum number of recipes to return.
String domain
Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.
String datasetGroupArn
The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
String nextToken
A token returned from the previous call to ListRecommenders for getting the next set of recommenders
(if they exist).
Integer maxResults
The maximum number of recommenders to return.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group.
String nextToken
A token returned from the previous call to ListSolutions for getting the next set of solutions (if
they exist).
Integer maxResults
The maximum number of solutions to return.
String solutionArn
The Amazon Resource Name (ARN) of the solution.
String nextToken
A token returned from the previous call to ListSolutionVersions for getting the next set of solution
versions (if they exist).
Integer maxResults
The maximum number of solution versions to return.
String resourceArn
The resource's Amazon Resource Name.
String eventType
The metric's event type.
String metricName
The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
String expression
The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM()
functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example
SUM(Items.PRICE).
String name
The metric attribution's name.
String metricAttributionArn
The metric attribution's Amazon Resource Name (ARN).
String datasetGroupArn
The metric attribution's dataset group Amazon Resource Name (ARN).
MetricAttributionOutput metricsOutputConfig
The metric attribution's output configuration.
String status
The metric attribution's status.
Date creationDateTime
The metric attribution's creation date time.
Date lastUpdatedDateTime
The metric attribution's last updated date time.
String failureReason
The metric attribution's failure reason.
S3DataConfig s3DataDestination
String roleArn
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.
String name
The name of the metric attribution.
String metricAttributionArn
The metric attribution's Amazon Resource Name (ARN).
String status
The metric attribution's status.
Date creationDateTime
The metric attribution's creation date time.
Date lastUpdatedDateTime
The metric attribution's last updated date time.
String failureReason
The metric attribution's failure reason.
String itemAttribute
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).
String objectiveSensitivity
Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.
String name
The name of the recipe.
String recipeArn
The Amazon Resource Name (ARN) of the recipe.
String algorithmArn
The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
String featureTransformationArn
The ARN of the FeatureTransformation object.
String status
The status of the recipe.
String description
The description of the recipe.
Date creationDateTime
The date and time (in Unix format) that the recipe was created.
String recipeType
One of the following values:
PERSONALIZED_RANKING
RELATED_ITEMS
USER_PERSONALIZATION
Date lastUpdatedDateTime
The date and time (in Unix format) that the recipe was last updated.
String name
The name of the recipe.
String recipeArn
The Amazon Resource Name (ARN) of the recipe.
String status
The status of the recipe.
Date creationDateTime
The date and time (in Unix time) that the recipe was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the recipe was last updated.
String domain
The domain of the recipe (if the recipe is a Domain dataset group use case).
String recommenderArn
The Amazon Resource Name (ARN) of the recommender.
String datasetGroupArn
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
String name
The name of the recommender.
String recipeArn
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
RecommenderConfig recommenderConfig
The configuration details of the recommender.
Date creationDateTime
The date and time (in Unix format) that the recommender was created.
Date lastUpdatedDateTime
The date and time (in Unix format) that the recommender was last updated.
String status
The status of the recommender.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
String failureReason
If a recommender fails, the reason behind the failure.
RecommenderUpdateSummary latestRecommenderUpdate
Provides a summary of the latest updates to the recommender.
Map<K,V> modelMetrics
Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.
Map<K,V> itemExplorationConfig
Specifies 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
recommenders generate personalized recommendations for a user (not popular items or similar items).
Integer minRecommendationRequestsPerSecond
Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.
String name
The name of the recommender.
String recommenderArn
The Amazon Resource Name (ARN) of the recommender.
String datasetGroupArn
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
String recipeArn
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
RecommenderConfig recommenderConfig
The configuration details of the recommender.
String status
The status of the recommender. A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
Date creationDateTime
The date and time (in Unix format) that the recommender was created.
Date lastUpdatedDateTime
The date and time (in Unix format) that the recommender was last updated.
RecommenderConfig recommenderConfig
The configuration details of the recommender update.
Date creationDateTime
The date and time (in Unix format) that the recommender update was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the recommender update was last updated.
String status
The status of the recommender update.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
String failureReason
If a recommender update fails, the reason behind the failure.
String name
The name of the solution.
String solutionArn
The ARN of the solution.
Boolean performHPO
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
Boolean performAutoML
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.
String recipeArn
The ARN of the recipe used to create the solution.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
String eventType
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.
SolutionConfig solutionConfig
Describes the configuration properties for the solution.
AutoMLResult autoMLResult
When performAutoML is true, specifies the best recipe found.
String status
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
Date creationDateTime
The creation date and time (in Unix time) of the solution.
Date lastUpdatedDateTime
The date and time (in Unix time) that the solution was last updated.
SolutionVersionSummary latestSolutionVersion
Describes the latest version of the solution, including the status and the ARN.
String eventValueThreshold
Only events with a value greater than or equal to this threshold are used for training a model.
HPOConfig hpoConfig
Describes the properties for hyperparameter optimization (HPO).
Map<K,V> algorithmHyperParameters
Lists the hyperparameter names and ranges.
Map<K,V> featureTransformationParameters
Lists the feature transformation parameters.
AutoMLConfig autoMLConfig
The AutoMLConfig object containing a list of recipes to search when AutoML is performed.
OptimizationObjective optimizationObjective
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
String name
The name of the solution.
String solutionArn
The Amazon Resource Name (ARN) of the solution.
String status
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
Date creationDateTime
The date and time (in Unix time) that the solution was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the solution was last updated.
String recipeArn
The Amazon Resource Name (ARN) of the recipe used by the solution.
String name
The name of the solution version.
String solutionVersionArn
The ARN of the solution version.
String solutionArn
The ARN of the solution.
Boolean performHPO
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
Boolean performAutoML
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When
false (the default), Amazon Personalize uses recipeArn.
String recipeArn
The ARN of the recipe used in the solution.
String eventType
The event type (for example, 'click' or 'like') that is used for training the model.
String datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group providing the training data.
SolutionConfig solutionConfig
Describes the configuration properties for the solution.
Double trainingHours
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.
String trainingMode
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.
TunedHPOParams tunedHPOParams
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
String status
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
String failureReason
If training a solution version fails, the reason for the failure.
Date creationDateTime
The date and time (in Unix time) that this version of the solution was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the solution was last updated.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version.
String status
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
Date creationDateTime
The date and time (in Unix time) that this version of a solution was created.
Date lastUpdatedDateTime
The date and time (in Unix time) that the solution version was last updated.
String failureReason
If a solution version fails, the reason behind the failure.
String recommenderArn
The Amazon Resource Name (ARN) of the recommender to start.
String recommenderArn
The Amazon Resource Name (ARN) of the recommender you started.
String recommenderArn
The Amazon Resource Name (ARN) of the recommender to stop.
String recommenderArn
The Amazon Resource Name (ARN) of the recommender you stopped.
String solutionVersionArn
The Amazon Resource Name (ARN) of the solution version you want to stop creating.
String resourceArn
The resource's Amazon Resource Name (ARN).
List<E> tags
Tags to apply to the resource. For more information see Tagging Personalize resources.
String campaignArn
The Amazon Resource Name (ARN) of the campaign.
String solutionVersionArn
The ARN of a new solution version to deploy.
Integer minProvisionedTPS
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
CampaignConfig campaignConfig
The configuration details of a campaign.
String campaignArn
The same campaign ARN as given in the request.
List<E> addMetrics
Add new metric attributes to the metric attribution.
List<E> removeMetrics
Remove metric attributes from the metric attribution.
MetricAttributionOutput metricsOutputConfig
An output config for the metric attribution.
String metricAttributionArn
The Amazon Resource Name (ARN) for the metric attribution to update.
String metricAttributionArn
The Amazon Resource Name (ARN) for the metric attribution that you updated.
String recommenderArn
The Amazon Resource Name (ARN) of the recommender to modify.
RecommenderConfig recommenderConfig
The configuration details of the recommender.
String recommenderArn
The same recommender Amazon Resource Name (ARN) as given in the request.
Copyright © 2023. All rights reserved.