# Data Types
<a name="API_Types"></a>

The following data types are supported by Amazon Personalize:
+  [Algorithm](API_Algorithm.md) 
+  [AlgorithmImage](API_AlgorithmImage.md) 
+  [AutoMLConfig](API_AutoMLConfig.md) 
+  [AutoMLResult](API_AutoMLResult.md) 
+  [AutoTrainingConfig](API_AutoTrainingConfig.md) 
+  [BatchInferenceJob](API_BatchInferenceJob.md) 
+  [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) 
+  [BatchInferenceJobInput](API_BatchInferenceJobInput.md) 
+  [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) 
+  [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) 
+  [BatchSegmentJob](API_BatchSegmentJob.md) 
+  [BatchSegmentJobInput](API_BatchSegmentJobInput.md) 
+  [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) 
+  [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) 
+  [Campaign](API_Campaign.md) 
+  [CampaignConfig](API_CampaignConfig.md) 
+  [CampaignSummary](API_CampaignSummary.md) 
+  [CampaignUpdateSummary](API_CampaignUpdateSummary.md) 
+  [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) 
+  [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) 
+  [DataDeletionJob](API_DataDeletionJob.md) 
+  [DataDeletionJobSummary](API_DataDeletionJobSummary.md) 
+  [Dataset](API_Dataset.md) 
+  [DatasetExportJob](API_DatasetExportJob.md) 
+  [DatasetExportJobOutput](API_DatasetExportJobOutput.md) 
+  [DatasetExportJobSummary](API_DatasetExportJobSummary.md) 
+  [DatasetGroup](API_DatasetGroup.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJob](API_DatasetImportJob.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSchema](API_DatasetSchema.md) 
+  [DatasetSchemaSummary](API_DatasetSchemaSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DatasetUpdateSummary](API_DatasetUpdateSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) 
+  [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) 
+  [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) 
+  [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) 
+  [EventParameters](API_EventParameters.md) 
+  [EventsConfig](API_EventsConfig.md) 
+  [EventTracker](API_EventTracker.md) 
+  [EventTrackerSummary](API_EventTrackerSummary.md) 
+  [FeatureTransformation](API_FeatureTransformation.md) 
+  [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) 
+  [Filter](API_Filter.md) 
+  [FilterSummary](API_FilterSummary.md) 
+  [HPOConfig](API_HPOConfig.md) 
+  [HPOObjective](API_HPOObjective.md) 
+  [HPOResourceConfig](API_HPOResourceConfig.md) 
+  [HyperParameterRanges](API_HyperParameterRanges.md) 
+  [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) 
+  [MetricAttribute](API_MetricAttribute.md) 
+  [MetricAttribution](API_MetricAttribution.md) 
+  [MetricAttributionOutput](API_MetricAttributionOutput.md) 
+  [MetricAttributionSummary](API_MetricAttributionSummary.md) 
+  [OptimizationObjective](API_OptimizationObjective.md) 
+  [Recipe](API_Recipe.md) 
+  [RecipeSummary](API_RecipeSummary.md) 
+  [Recommender](API_Recommender.md) 
+  [RecommenderConfig](API_RecommenderConfig.md) 
+  [RecommenderSummary](API_RecommenderSummary.md) 
+  [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) 
+  [S3DataConfig](API_S3DataConfig.md) 
+  [Solution](API_Solution.md) 
+  [SolutionConfig](API_SolutionConfig.md) 
+  [SolutionSummary](API_SolutionSummary.md) 
+  [SolutionUpdateConfig](API_SolutionUpdateConfig.md) 
+  [SolutionUpdateSummary](API_SolutionUpdateSummary.md) 
+  [SolutionVersion](API_SolutionVersion.md) 
+  [SolutionVersionSummary](API_SolutionVersionSummary.md) 
+  [Tag](API_Tag.md) 
+  [ThemeGenerationConfig](API_ThemeGenerationConfig.md) 
+  [TrainingDataConfig](API_TrainingDataConfig.md) 
+  [TunedHPOParams](API_TunedHPOParams.md) 

The following data types are supported by Amazon Personalize Events:
+  [Action](API_UBS_Action.md) 
+  [ActionInteraction](API_UBS_ActionInteraction.md) 
+  [Event](API_UBS_Event.md) 
+  [Item](API_UBS_Item.md) 
+  [MetricAttribution](API_UBS_MetricAttribution.md) 
+  [User](API_UBS_User.md) 

The following data types are supported by Amazon Personalize Runtime:
+  [PredictedAction](API_RS_PredictedAction.md) 
+  [PredictedItem](API_RS_PredictedItem.md) 
+  [Promotion](API_RS_Promotion.md) 

# Amazon Personalize
<a name="API_Types_Amazon_Personalize"></a>

The following data types are supported by Amazon Personalize:
+  [Algorithm](API_Algorithm.md) 
+  [AlgorithmImage](API_AlgorithmImage.md) 
+  [AutoMLConfig](API_AutoMLConfig.md) 
+  [AutoMLResult](API_AutoMLResult.md) 
+  [AutoTrainingConfig](API_AutoTrainingConfig.md) 
+  [BatchInferenceJob](API_BatchInferenceJob.md) 
+  [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) 
+  [BatchInferenceJobInput](API_BatchInferenceJobInput.md) 
+  [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) 
+  [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) 
+  [BatchSegmentJob](API_BatchSegmentJob.md) 
+  [BatchSegmentJobInput](API_BatchSegmentJobInput.md) 
+  [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) 
+  [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) 
+  [Campaign](API_Campaign.md) 
+  [CampaignConfig](API_CampaignConfig.md) 
+  [CampaignSummary](API_CampaignSummary.md) 
+  [CampaignUpdateSummary](API_CampaignUpdateSummary.md) 
+  [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) 
+  [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) 
+  [DataDeletionJob](API_DataDeletionJob.md) 
+  [DataDeletionJobSummary](API_DataDeletionJobSummary.md) 
+  [Dataset](API_Dataset.md) 
+  [DatasetExportJob](API_DatasetExportJob.md) 
+  [DatasetExportJobOutput](API_DatasetExportJobOutput.md) 
+  [DatasetExportJobSummary](API_DatasetExportJobSummary.md) 
+  [DatasetGroup](API_DatasetGroup.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJob](API_DatasetImportJob.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSchema](API_DatasetSchema.md) 
+  [DatasetSchemaSummary](API_DatasetSchemaSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DatasetUpdateSummary](API_DatasetUpdateSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) 
+  [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) 
+  [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) 
+  [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) 
+  [EventParameters](API_EventParameters.md) 
+  [EventsConfig](API_EventsConfig.md) 
+  [EventTracker](API_EventTracker.md) 
+  [EventTrackerSummary](API_EventTrackerSummary.md) 
+  [FeatureTransformation](API_FeatureTransformation.md) 
+  [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) 
+  [Filter](API_Filter.md) 
+  [FilterSummary](API_FilterSummary.md) 
+  [HPOConfig](API_HPOConfig.md) 
+  [HPOObjective](API_HPOObjective.md) 
+  [HPOResourceConfig](API_HPOResourceConfig.md) 
+  [HyperParameterRanges](API_HyperParameterRanges.md) 
+  [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) 
+  [MetricAttribute](API_MetricAttribute.md) 
+  [MetricAttribution](API_MetricAttribution.md) 
+  [MetricAttributionOutput](API_MetricAttributionOutput.md) 
+  [MetricAttributionSummary](API_MetricAttributionSummary.md) 
+  [OptimizationObjective](API_OptimizationObjective.md) 
+  [Recipe](API_Recipe.md) 
+  [RecipeSummary](API_RecipeSummary.md) 
+  [Recommender](API_Recommender.md) 
+  [RecommenderConfig](API_RecommenderConfig.md) 
+  [RecommenderSummary](API_RecommenderSummary.md) 
+  [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) 
+  [S3DataConfig](API_S3DataConfig.md) 
+  [Solution](API_Solution.md) 
+  [SolutionConfig](API_SolutionConfig.md) 
+  [SolutionSummary](API_SolutionSummary.md) 
+  [SolutionUpdateConfig](API_SolutionUpdateConfig.md) 
+  [SolutionUpdateSummary](API_SolutionUpdateSummary.md) 
+  [SolutionVersion](API_SolutionVersion.md) 
+  [SolutionVersionSummary](API_SolutionVersionSummary.md) 
+  [Tag](API_Tag.md) 
+  [ThemeGenerationConfig](API_ThemeGenerationConfig.md) 
+  [TrainingDataConfig](API_TrainingDataConfig.md) 
+  [TunedHPOParams](API_TunedHPOParams.md) 

# Algorithm
<a name="API_Algorithm"></a>

Describes a custom algorithm.

## Contents
<a name="API_Algorithm_Contents"></a>

 ** algorithmArn **   <a name="personalize-Type-Algorithm-algorithmArn"></a>
The Amazon Resource Name (ARN) of the algorithm.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** algorithmImage **   <a name="personalize-Type-Algorithm-algorithmImage"></a>
The URI of the Docker container for the algorithm image.  
Type: [AlgorithmImage](API_AlgorithmImage.md) object  
Required: No

 ** creationDateTime **   <a name="personalize-Type-Algorithm-creationDateTime"></a>
The date and time (in Unix time) that the algorithm was created.  
Type: Timestamp  
Required: No

 ** defaultHyperParameterRanges **   <a name="personalize-Type-Algorithm-defaultHyperParameterRanges"></a>
Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).  
Type: [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) object  
Required: No

 ** defaultHyperParameters **   <a name="personalize-Type-Algorithm-defaultHyperParameters"></a>
Specifies the default hyperparameters.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Maximum length of 256.  
Value Length Constraints: Maximum length of 1000.  
Required: No

 ** defaultResourceConfig **   <a name="personalize-Type-Algorithm-defaultResourceConfig"></a>
Specifies the default maximum number of training jobs and parallel training jobs.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Maximum length of 256.  
Value Length Constraints: Maximum length of 1000.  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-Algorithm-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the algorithm was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-Algorithm-name"></a>
The name of the algorithm.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** roleArn **   <a name="personalize-Type-Algorithm-roleArn"></a>
The Amazon Resource Name (ARN) of the role.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** trainingInputMode **   <a name="personalize-Type-Algorithm-trainingInputMode"></a>
The training input mode.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_Algorithm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Algorithm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Algorithm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Algorithm) 

# AlgorithmImage
<a name="API_AlgorithmImage"></a>

Describes an algorithm image.

## Contents
<a name="API_AlgorithmImage_Contents"></a>

 ** dockerURI **   <a name="personalize-Type-AlgorithmImage-dockerURI"></a>
The URI of the Docker container for the algorithm image.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: Yes

 ** name **   <a name="personalize-Type-AlgorithmImage-name"></a>
The name of the algorithm image.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

## See Also
<a name="API_AlgorithmImage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AlgorithmImage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AlgorithmImage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AlgorithmImage) 

# AutoMLConfig
<a name="API_AutoMLConfig"></a>

When the solution performs AutoML (`performAutoML` is true in [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then uses that recipe for the solution.

## Contents
<a name="API_AutoMLConfig_Contents"></a>

 ** metricName **   <a name="personalize-Type-AutoMLConfig-metricName"></a>
The metric to optimize.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** recipeList **   <a name="personalize-Type-AutoMLConfig-recipeList"></a>
The list of candidate recipes.  
Type: Array of strings  
Array Members: Maximum number of 100 items.  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

## See Also
<a name="API_AutoMLConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLConfig) 

# AutoMLResult
<a name="API_AutoMLResult"></a>

When the solution performs AutoML (`performAutoML` is true in [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)), specifies the recipe that best optimized the specified metric.

## Contents
<a name="API_AutoMLResult_Contents"></a>

 ** bestRecipeArn **   <a name="personalize-Type-AutoMLResult-bestRecipeArn"></a>
The Amazon Resource Name (ARN) of the best recipe.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

## See Also
<a name="API_AutoMLResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLResult) 

# AutoTrainingConfig
<a name="API_AutoTrainingConfig"></a>

The automatic training configuration to use when `performAutoTraining` is true.

## Contents
<a name="API_AutoTrainingConfig_Contents"></a>

 ** schedulingExpression **   <a name="personalize-Type-AutoTrainingConfig-schedulingExpression"></a>
Specifies how often to automatically train new solution versions. Specify a rate expression in rate(*value* *unit*) format. For value, specify a number between 1 and 30. For unit, specify `day` or `days`. For example, to automatically create a new solution version every 5 days, specify `rate(5 days)`. The default is every 7 days.  
For more information about auto training, see [Creating and configuring a solution](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16.  
Pattern: `rate\(\d+ days?\)`   
Required: No

## See Also
<a name="API_AutoTrainingConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoTrainingConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoTrainingConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoTrainingConfig) 

# BatchInferenceJob
<a name="API_BatchInferenceJob"></a>

Contains information on a batch inference job.

## Contents
<a name="API_BatchInferenceJob_Contents"></a>

 ** batchInferenceJobArn **   <a name="personalize-Type-BatchInferenceJob-batchInferenceJobArn"></a>
The Amazon Resource Name (ARN) of the batch inference job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** batchInferenceJobConfig **   <a name="personalize-Type-BatchInferenceJob-batchInferenceJobConfig"></a>
A string to string map of the configuration details of a batch inference job.  
Type: [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) object  
Required: No

 ** batchInferenceJobMode **   <a name="personalize-Type-BatchInferenceJob-batchInferenceJobMode"></a>
The job's mode.  
Type: String  
Valid Values: `BATCH_INFERENCE | THEME_GENERATION`   
Required: No

 ** creationDateTime **   <a name="personalize-Type-BatchInferenceJob-creationDateTime"></a>
The time at which the batch inference job was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-BatchInferenceJob-failureReason"></a>
If the batch inference job failed, the reason for the failure.  
Type: String  
Required: No

 ** filterArn **   <a name="personalize-Type-BatchInferenceJob-filterArn"></a>
The ARN of the filter used on the batch inference job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** jobInput **   <a name="personalize-Type-BatchInferenceJob-jobInput"></a>
The Amazon S3 path that leads to the input data used to generate the batch inference job.  
Type: [BatchInferenceJobInput](API_BatchInferenceJobInput.md) object  
Required: No

 ** jobName **   <a name="personalize-Type-BatchInferenceJob-jobName"></a>
The name of the batch inference job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** jobOutput **   <a name="personalize-Type-BatchInferenceJob-jobOutput"></a>
The Amazon S3 bucket that contains the output data generated by the batch inference job.  
Type: [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) object  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchInferenceJob-lastUpdatedDateTime"></a>
The time at which the batch inference job was last updated.  
Type: Timestamp  
Required: No

 ** numResults **   <a name="personalize-Type-BatchInferenceJob-numResults"></a>
The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.  
Type: Integer  
Required: No

 ** roleArn **   <a name="personalize-Type-BatchInferenceJob-roleArn"></a>
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: No

 ** solutionVersionArn **   <a name="personalize-Type-BatchInferenceJob-solutionVersionArn"></a>
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-BatchInferenceJob-status"></a>
The status of the batch inference job. The status is one of the following values:  
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** themeGenerationConfig **   <a name="personalize-Type-BatchInferenceJob-themeGenerationConfig"></a>
The job's theme generation settings.  
Type: [ThemeGenerationConfig](API_ThemeGenerationConfig.md) object  
Required: No

## See Also
<a name="API_BatchInferenceJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJob) 

# BatchInferenceJobConfig
<a name="API_BatchInferenceJobConfig"></a>

The configuration details of a batch inference job.

## Contents
<a name="API_BatchInferenceJobConfig_Contents"></a>

 ** itemExplorationConfig **   <a name="personalize-Type-BatchInferenceJobConfig-itemExplorationConfig"></a>
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](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html).  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Maximum length of 256.  
Value Length Constraints: Maximum length of 1000.  
Required: No

 ** rankingInfluence **   <a name="personalize-Type-BatchInferenceJobConfig-rankingInfluence"></a>
A map of ranking influence values for POPULARITY and FRESHNESS. For each key, specify a numerical value between 0.0 and 1.0 that determines how much influence that ranking factor has on the final recommendations. A value closer to 1.0 gives more weight to the factor, while a value closer to 0.0 reduces its influence. If not specified, both default to 0.0.  
Type: String to double map  
Valid Keys: `POPULARITY | FRESHNESS`   
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

## See Also
<a name="API_BatchInferenceJobConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobConfig) 

# BatchInferenceJobInput
<a name="API_BatchInferenceJobInput"></a>

The input configuration of a batch inference job.

## Contents
<a name="API_BatchInferenceJobInput_Contents"></a>

 ** s3DataSource **   <a name="personalize-Type-BatchInferenceJobInput-s3DataSource"></a>
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.  
Type: [S3DataConfig](API_S3DataConfig.md) object  
Required: Yes

## See Also
<a name="API_BatchInferenceJobInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobInput) 

# BatchInferenceJobOutput
<a name="API_BatchInferenceJobOutput"></a>

The output configuration parameters of a batch inference job.

## Contents
<a name="API_BatchInferenceJobOutput_Contents"></a>

 ** s3DataDestination **   <a name="personalize-Type-BatchInferenceJobOutput-s3DataDestination"></a>
Information on the Amazon S3 bucket in which the batch inference job's output is stored.  
Type: [S3DataConfig](API_S3DataConfig.md) object  
Required: Yes

## See Also
<a name="API_BatchInferenceJobOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobOutput) 

# BatchInferenceJobSummary
<a name="API_BatchInferenceJobSummary"></a>

A truncated version of the [BatchInferenceJob](https://docs.aws.amazon.com/personalize/latest/dg/API_BatchInferenceJob.html). The [ListBatchInferenceJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchInferenceJobs.html) operation returns a list of batch inference job summaries.

## Contents
<a name="API_BatchInferenceJobSummary_Contents"></a>

 ** batchInferenceJobArn **   <a name="personalize-Type-BatchInferenceJobSummary-batchInferenceJobArn"></a>
The Amazon Resource Name (ARN) of the batch inference job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** batchInferenceJobMode **   <a name="personalize-Type-BatchInferenceJobSummary-batchInferenceJobMode"></a>
The job's mode.  
Type: String  
Valid Values: `BATCH_INFERENCE | THEME_GENERATION`   
Required: No

 ** creationDateTime **   <a name="personalize-Type-BatchInferenceJobSummary-creationDateTime"></a>
The time at which the batch inference job was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-BatchInferenceJobSummary-failureReason"></a>
If the batch inference job failed, the reason for the failure.  
Type: String  
Required: No

 ** jobName **   <a name="personalize-Type-BatchInferenceJobSummary-jobName"></a>
The name of the batch inference job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchInferenceJobSummary-lastUpdatedDateTime"></a>
The time at which the batch inference job was last updated.  
Type: Timestamp  
Required: No

 ** solutionVersionArn **   <a name="personalize-Type-BatchInferenceJobSummary-solutionVersionArn"></a>
The ARN of the solution version used by the batch inference job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-BatchInferenceJobSummary-status"></a>
The status of the batch inference job. The status is one of the following values:  
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_BatchInferenceJobSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobSummary) 

# BatchSegmentJob
<a name="API_BatchSegmentJob"></a>

Contains information on a batch segment job.

## Contents
<a name="API_BatchSegmentJob_Contents"></a>

 ** batchSegmentJobArn **   <a name="personalize-Type-BatchSegmentJob-batchSegmentJobArn"></a>
The Amazon Resource Name (ARN) of the batch segment job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** creationDateTime **   <a name="personalize-Type-BatchSegmentJob-creationDateTime"></a>
The time at which the batch segment job was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-BatchSegmentJob-failureReason"></a>
If the batch segment job failed, the reason for the failure.  
Type: String  
Required: No

 ** filterArn **   <a name="personalize-Type-BatchSegmentJob-filterArn"></a>
The ARN of the filter used on the batch segment job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** jobInput **   <a name="personalize-Type-BatchSegmentJob-jobInput"></a>
The Amazon S3 path that leads to the input data used to generate the batch segment job.  
Type: [BatchSegmentJobInput](API_BatchSegmentJobInput.md) object  
Required: No

 ** jobName **   <a name="personalize-Type-BatchSegmentJob-jobName"></a>
The name of the batch segment job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** jobOutput **   <a name="personalize-Type-BatchSegmentJob-jobOutput"></a>
The Amazon S3 bucket that contains the output data generated by the batch segment job.  
Type: [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) object  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchSegmentJob-lastUpdatedDateTime"></a>
The time at which the batch segment job last updated.  
Type: Timestamp  
Required: No

 ** numResults **   <a name="personalize-Type-BatchSegmentJob-numResults"></a>
The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.  
Type: Integer  
Required: No

 ** roleArn **   <a name="personalize-Type-BatchSegmentJob-roleArn"></a>
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: No

 ** solutionVersionArn **   <a name="personalize-Type-BatchSegmentJob-solutionVersionArn"></a>
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-BatchSegmentJob-status"></a>
The status of the batch segment job. The status is one of the following values:  
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_BatchSegmentJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJob) 

# BatchSegmentJobInput
<a name="API_BatchSegmentJobInput"></a>

The input configuration of a batch segment job.

## Contents
<a name="API_BatchSegmentJobInput_Contents"></a>

 ** s3DataSource **   <a name="personalize-Type-BatchSegmentJobInput-s3DataSource"></a>
The configuration details of an Amazon S3 input or output bucket.  
Type: [S3DataConfig](API_S3DataConfig.md) object  
Required: Yes

## See Also
<a name="API_BatchSegmentJobInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobInput) 

# BatchSegmentJobOutput
<a name="API_BatchSegmentJobOutput"></a>

The output configuration parameters of a batch segment job.

## Contents
<a name="API_BatchSegmentJobOutput_Contents"></a>

 ** s3DataDestination **   <a name="personalize-Type-BatchSegmentJobOutput-s3DataDestination"></a>
The configuration details of an Amazon S3 input or output bucket.  
Type: [S3DataConfig](API_S3DataConfig.md) object  
Required: Yes

## See Also
<a name="API_BatchSegmentJobOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobOutput) 

# BatchSegmentJobSummary
<a name="API_BatchSegmentJobSummary"></a>

A truncated version of the [BatchSegmentJob](https://docs.aws.amazon.com/personalize/latest/dg/API_BatchSegmentJob.html) datatype. [ListBatchSegmentJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html) operation returns a list of batch segment job summaries.

## Contents
<a name="API_BatchSegmentJobSummary_Contents"></a>

 ** batchSegmentJobArn **   <a name="personalize-Type-BatchSegmentJobSummary-batchSegmentJobArn"></a>
The Amazon Resource Name (ARN) of the batch segment job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** creationDateTime **   <a name="personalize-Type-BatchSegmentJobSummary-creationDateTime"></a>
The time at which the batch segment job was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-BatchSegmentJobSummary-failureReason"></a>
If the batch segment job failed, the reason for the failure.  
Type: String  
Required: No

 ** jobName **   <a name="personalize-Type-BatchSegmentJobSummary-jobName"></a>
The name of the batch segment job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchSegmentJobSummary-lastUpdatedDateTime"></a>
The time at which the batch segment job was last updated.  
Type: Timestamp  
Required: No

 ** solutionVersionArn **   <a name="personalize-Type-BatchSegmentJobSummary-solutionVersionArn"></a>
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-BatchSegmentJobSummary-status"></a>
The status of the batch segment job. The status is one of the following values:  
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_BatchSegmentJobSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobSummary) 

# Campaign
<a name="API_Campaign"></a>

An object that describes the deployment of a solution version. For more information on campaigns, see [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

## Contents
<a name="API_Campaign_Contents"></a>

 ** campaignArn **   <a name="personalize-Type-Campaign-campaignArn"></a>
The Amazon Resource Name (ARN) of the campaign.   
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** campaignConfig **   <a name="personalize-Type-Campaign-campaignConfig"></a>
The configuration details of a campaign.  
Type: [CampaignConfig](API_CampaignConfig.md) object  
Required: No

 ** creationDateTime **   <a name="personalize-Type-Campaign-creationDateTime"></a>
The date and time (in Unix format) that the campaign was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-Campaign-failureReason"></a>
If a campaign fails, the reason behind the failure.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-Campaign-lastUpdatedDateTime"></a>
The date and time (in Unix format) that the campaign was last updated.  
Type: Timestamp  
Required: No

 ** latestCampaignUpdate **   <a name="personalize-Type-Campaign-latestCampaignUpdate"></a>
Provides a summary of the properties of a campaign update. For a complete listing, call the [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) API.  
The `latestCampaignUpdate` field is only returned when the campaign has had at least one `UpdateCampaign` call. 
Type: [CampaignUpdateSummary](API_CampaignUpdateSummary.md) object  
Required: No

 ** minProvisionedTPS **   <a name="personalize-Type-Campaign-minProvisionedTPS"></a>
Specifies the requested minimum provisioned transactions (recommendations) per second. A high `minProvisionedTPS` will increase your bill. We recommend starting with 1 for `minProvisionedTPS` (the default). Track your usage using Amazon CloudWatch metrics, and increase the `minProvisionedTPS` as necessary.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** name **   <a name="personalize-Type-Campaign-name"></a>
The name of the campaign.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** solutionVersionArn **   <a name="personalize-Type-Campaign-solutionVersionArn"></a>
The Amazon Resource Name (ARN) of the solution version the campaign uses.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-Campaign-status"></a>
The status of the campaign.  
A campaign can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_Campaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Campaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Campaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Campaign) 

# CampaignConfig
<a name="API_CampaignConfig"></a>

The configuration details of a campaign.

## Contents
<a name="API_CampaignConfig_Contents"></a>

 ** enableMetadataWithRecommendations **   <a name="personalize-Type-CampaignConfig-enableMetadataWithRecommendations"></a>
Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see [Enabling metadata in recommendations for a campaign](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata).  
 If you enable metadata in recommendations, you will incur additional costs. For more information, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).   
Type: Boolean  
Required: No

 ** itemExplorationConfig **   <a name="personalize-Type-CampaignConfig-itemExplorationConfig"></a>
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](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) recipe.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Maximum length of 256.  
Value Length Constraints: Maximum length of 1000.  
Required: No

 ** rankingInfluence **   <a name="personalize-Type-CampaignConfig-rankingInfluence"></a>
A map of ranking influence values for POPULARITY and FRESHNESS. For each key, specify a numerical value between 0.0 and 1.0 that determines how much influence that ranking factor has on the final recommendations. A value closer to 1.0 gives more weight to the factor, while a value closer to 0.0 reduces its influence. If not specified, both default to 0.0.  
Type: String to double map  
Valid Keys: `POPULARITY | FRESHNESS`   
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** syncWithLatestSolutionVersion **   <a name="personalize-Type-CampaignConfig-syncWithLatestSolutionVersion"></a>
Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify `True`, you must specify the ARN of your *solution* for the `SolutionVersionArn` parameter. It must be in `SolutionArn/$LATEST` format. The default is `False` and you must manually update the campaign to deploy the latest solution version.   
 For more information about automatic campaign updates, see [Enabling automatic campaign updates](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update).   
Type: Boolean  
Required: No

## See Also
<a name="API_CampaignConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignConfig) 

# CampaignSummary
<a name="API_CampaignSummary"></a>

Provides a summary of the properties of a campaign. For a complete listing, call the [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) API.

## Contents
<a name="API_CampaignSummary_Contents"></a>

 ** campaignArn **   <a name="personalize-Type-CampaignSummary-campaignArn"></a>
The Amazon Resource Name (ARN) of the campaign.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** creationDateTime **   <a name="personalize-Type-CampaignSummary-creationDateTime"></a>
The date and time (in Unix time) that the campaign was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-CampaignSummary-failureReason"></a>
If a campaign fails, the reason behind the failure.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-CampaignSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the campaign was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-CampaignSummary-name"></a>
The name of the campaign.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** status **   <a name="personalize-Type-CampaignSummary-status"></a>
The status of the campaign.  
A campaign can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_CampaignSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignSummary) 

# CampaignUpdateSummary
<a name="API_CampaignUpdateSummary"></a>

Provides a summary of the properties of a campaign update. For a complete listing, call the [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) API.

## Contents
<a name="API_CampaignUpdateSummary_Contents"></a>

 ** campaignConfig **   <a name="personalize-Type-CampaignUpdateSummary-campaignConfig"></a>
The configuration details of a campaign.  
Type: [CampaignConfig](API_CampaignConfig.md) object  
Required: No

 ** creationDateTime **   <a name="personalize-Type-CampaignUpdateSummary-creationDateTime"></a>
The date and time (in Unix time) that the campaign update was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-CampaignUpdateSummary-failureReason"></a>
If a campaign update fails, the reason behind the failure.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-CampaignUpdateSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the campaign update was last updated.  
Type: Timestamp  
Required: No

 ** minProvisionedTPS **   <a name="personalize-Type-CampaignUpdateSummary-minProvisionedTPS"></a>
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** solutionVersionArn **   <a name="personalize-Type-CampaignUpdateSummary-solutionVersionArn"></a>
The Amazon Resource Name (ARN) of the deployed solution version.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-CampaignUpdateSummary-status"></a>
The status of the campaign update.  
A campaign update can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_CampaignUpdateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignUpdateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignUpdateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignUpdateSummary) 

# CategoricalHyperParameterRange
<a name="API_CategoricalHyperParameterRange"></a>

Provides the name and range of a categorical hyperparameter.

## Contents
<a name="API_CategoricalHyperParameterRange_Contents"></a>

 ** name **   <a name="personalize-Type-CategoricalHyperParameterRange-name"></a>
The name of the hyperparameter.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** values **   <a name="personalize-Type-CategoricalHyperParameterRange-values"></a>
A list of the categories for the hyperparameter.  
Type: Array of strings  
Array Members: Maximum number of 100 items.  
Length Constraints: Maximum length of 1000.  
Required: No

## See Also
<a name="API_CategoricalHyperParameterRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CategoricalHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CategoricalHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CategoricalHyperParameterRange) 

# ContinuousHyperParameterRange
<a name="API_ContinuousHyperParameterRange"></a>

Provides the name and range of a continuous hyperparameter.

## Contents
<a name="API_ContinuousHyperParameterRange_Contents"></a>

 ** maxValue **   <a name="personalize-Type-ContinuousHyperParameterRange-maxValue"></a>
The maximum allowable value for the hyperparameter.  
Type: Double  
Valid Range: Minimum value of -1000000.  
Required: No

 ** minValue **   <a name="personalize-Type-ContinuousHyperParameterRange-minValue"></a>
The minimum allowable value for the hyperparameter.  
Type: Double  
Valid Range: Minimum value of -1000000.  
Required: No

 ** name **   <a name="personalize-Type-ContinuousHyperParameterRange-name"></a>
The name of the hyperparameter.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_ContinuousHyperParameterRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ContinuousHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ContinuousHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ContinuousHyperParameterRange) 

# DataDeletionJob
<a name="API_DataDeletionJob"></a>

Describes a job that deletes all references to specific users from an Amazon Personalize dataset group in batches. For information about creating a data deletion job, see [Deleting users](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html).

## Contents
<a name="API_DataDeletionJob_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DataDeletionJob-creationDateTime"></a>
The creation date and time (in Unix time) of the data deletion job.  
Type: Timestamp  
Required: No

 ** dataDeletionJobArn **   <a name="personalize-Type-DataDeletionJob-dataDeletionJobArn"></a>
The Amazon Resource Name (ARN) of the data deletion job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-DataDeletionJob-datasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group the job deletes records from.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** dataSource **   <a name="personalize-Type-DataDeletionJob-dataSource"></a>
Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize.  
Type: [DataSource](API_DataSource.md) object  
Required: No

 ** failureReason **   <a name="personalize-Type-DataDeletionJob-failureReason"></a>
If a data deletion job fails, provides the reason why.  
Type: String  
Required: No

 ** jobName **   <a name="personalize-Type-DataDeletionJob-jobName"></a>
The name of the data deletion job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DataDeletionJob-lastUpdatedDateTime"></a>
The date and time (in Unix time) the data deletion job was last updated.  
Type: Timestamp  
Required: No

 ** numDeleted **   <a name="personalize-Type-DataDeletionJob-numDeleted"></a>
The number of records deleted by a COMPLETED job.  
Type: Integer  
Required: No

 ** roleArn **   <a name="personalize-Type-DataDeletionJob-roleArn"></a>
The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: No

 ** status **   <a name="personalize-Type-DataDeletionJob-status"></a>
The status of the data deletion job.  
A data deletion job can have one of the following statuses:  
+ PENDING > IN\$1PROGRESS > COMPLETED -or- FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DataDeletionJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJob) 

# DataDeletionJobSummary
<a name="API_DataDeletionJobSummary"></a>

Provides a summary of the properties of a data deletion job. For a complete listing, call the [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) API operation.

## Contents
<a name="API_DataDeletionJobSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DataDeletionJobSummary-creationDateTime"></a>
The creation date and time (in Unix time) of the data deletion job.  
Type: Timestamp  
Required: No

 ** dataDeletionJobArn **   <a name="personalize-Type-DataDeletionJobSummary-dataDeletionJobArn"></a>
The Amazon Resource Name (ARN) of the data deletion job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-DataDeletionJobSummary-datasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group the job deleted records from.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** failureReason **   <a name="personalize-Type-DataDeletionJobSummary-failureReason"></a>
If a data deletion job fails, provides the reason why.  
Type: String  
Required: No

 ** jobName **   <a name="personalize-Type-DataDeletionJobSummary-jobName"></a>
The name of the data deletion job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DataDeletionJobSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) the data deletion job was last updated.  
Type: Timestamp  
Required: No

 ** status **   <a name="personalize-Type-DataDeletionJobSummary-status"></a>
The status of the data deletion job.  
A data deletion job can have one of the following statuses:  
+ PENDING > IN\$1PROGRESS > COMPLETED -or- FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DataDeletionJobSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJobSummary) 

# Dataset
<a name="API_Dataset"></a>

Provides metadata for a dataset.

## Contents
<a name="API_Dataset_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-Dataset-creationDateTime"></a>
The creation date and time (in Unix time) of the dataset.  
Type: Timestamp  
Required: No

 ** datasetArn **   <a name="personalize-Type-Dataset-datasetArn"></a>
The Amazon Resource Name (ARN) of the dataset that you want metadata for.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-Dataset-datasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** datasetType **   <a name="personalize-Type-Dataset-datasetType"></a>
One of the following values:  
+ Interactions
+ Items
+ Users
+ Actions
+ Action\$1Interactions
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^[A-Za-z_]+$`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-Dataset-lastUpdatedDateTime"></a>
A time stamp that shows when the dataset was updated.  
Type: Timestamp  
Required: No

 ** latestDatasetUpdate **   <a name="personalize-Type-Dataset-latestDatasetUpdate"></a>
Describes the latest update to the dataset.  
Type: [DatasetUpdateSummary](API_DatasetUpdateSummary.md) object  
Required: No

 ** name **   <a name="personalize-Type-Dataset-name"></a>
The name of the dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** schemaArn **   <a name="personalize-Type-Dataset-schemaArn"></a>
The ARN of the associated schema.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-Dataset-status"></a>
The status of the dataset.  
A dataset can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** trackingId **   <a name="personalize-Type-Dataset-trackingId"></a>
The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the `PutActionInteractions` API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_Dataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Dataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Dataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Dataset) 

# DatasetExportJob
<a name="API_DatasetExportJob"></a>

Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see [CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html).

A dataset export job can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED

## Contents
<a name="API_DatasetExportJob_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetExportJob-creationDateTime"></a>
The creation date and time (in Unix time) of the dataset export job.  
Type: Timestamp  
Required: No

 ** datasetArn **   <a name="personalize-Type-DatasetExportJob-datasetArn"></a>
The Amazon Resource Name (ARN) of the dataset to export.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** datasetExportJobArn **   <a name="personalize-Type-DatasetExportJob-datasetExportJobArn"></a>
The Amazon Resource Name (ARN) of the dataset export job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** failureReason **   <a name="personalize-Type-DatasetExportJob-failureReason"></a>
If a dataset export job fails, provides the reason why.  
Type: String  
Required: No

 ** ingestionMode **   <a name="personalize-Type-DatasetExportJob-ingestionMode"></a>
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`.   
Type: String  
Valid Values: `BULK | PUT | ALL`   
Required: No

 ** jobName **   <a name="personalize-Type-DatasetExportJob-jobName"></a>
The name of the export job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** jobOutput **   <a name="personalize-Type-DatasetExportJob-jobOutput"></a>
The path to the Amazon S3 bucket where the job's output is stored. For example:  
 `s3://bucket-name/folder-name/`   
Type: [DatasetExportJobOutput](API_DatasetExportJobOutput.md) object  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetExportJob-lastUpdatedDateTime"></a>
The date and time (in Unix time) the status of the dataset export job was last updated.  
Type: Timestamp  
Required: No

 ** roleArn **   <a name="personalize-Type-DatasetExportJob-roleArn"></a>
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-DatasetExportJob-status"></a>
The status of the dataset export job.  
A dataset export job can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DatasetExportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJob) 

# DatasetExportJobOutput
<a name="API_DatasetExportJobOutput"></a>

The output configuration parameters of a dataset export job.

## Contents
<a name="API_DatasetExportJobOutput_Contents"></a>

 ** s3DataDestination **   <a name="personalize-Type-DatasetExportJobOutput-s3DataDestination"></a>
The configuration details of an Amazon S3 input or output bucket.  
Type: [S3DataConfig](API_S3DataConfig.md) object  
Required: Yes

## See Also
<a name="API_DatasetExportJobOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJobOutput) 

# DatasetExportJobSummary
<a name="API_DatasetExportJobSummary"></a>

Provides a summary of the properties of a dataset export job. For a complete listing, call the [DescribeDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html) API.

## Contents
<a name="API_DatasetExportJobSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetExportJobSummary-creationDateTime"></a>
The date and time (in Unix time) that the dataset export job was created.  
Type: Timestamp  
Required: No

 ** datasetExportJobArn **   <a name="personalize-Type-DatasetExportJobSummary-datasetExportJobArn"></a>
The Amazon Resource Name (ARN) of the dataset export job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** failureReason **   <a name="personalize-Type-DatasetExportJobSummary-failureReason"></a>
If a dataset export job fails, the reason behind the failure.  
Type: String  
Required: No

 ** jobName **   <a name="personalize-Type-DatasetExportJobSummary-jobName"></a>
The name of the dataset export job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetExportJobSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the dataset export job status was last updated.  
Type: Timestamp  
Required: No

 ** status **   <a name="personalize-Type-DatasetExportJobSummary-status"></a>
The status of the dataset export job.  
A dataset export job can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DatasetExportJobSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJobSummary) 

# DatasetGroup
<a name="API_DatasetGroup"></a>

A dataset group is a collection of related datasets (Item interactions, Users, Items, Actions, Action interactions). You create a dataset group by calling [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html). You then create a dataset and add it to a dataset group by calling [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). The dataset group is used to create and train a solution by calling [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html). A dataset group can contain only one of each type of dataset.

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group.

## Contents
<a name="API_DatasetGroup_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetGroup-creationDateTime"></a>
The creation date and time (in Unix time) of the dataset group.  
Type: Timestamp  
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-DatasetGroup-datasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** domain **   <a name="personalize-Type-DatasetGroup-domain"></a>
The domain of a Domain dataset group.  
Type: String  
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`   
Required: No

 ** failureReason **   <a name="personalize-Type-DatasetGroup-failureReason"></a>
If creating a dataset group fails, provides the reason why.  
Type: String  
Required: No

 ** kmsKeyArn **   <a name="personalize-Type-DatasetGroup-kmsKeyArn"></a>
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the datasets.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetGroup-lastUpdatedDateTime"></a>
The last update date and time (in Unix time) of the dataset group.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-DatasetGroup-name"></a>
The name of the dataset group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** roleArn **   <a name="personalize-Type-DatasetGroup-roleArn"></a>
The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: No

 ** status **   <a name="personalize-Type-DatasetGroup-status"></a>
The current status of the dataset group.  
A dataset group can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DatasetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroup) 

# DatasetGroupSummary
<a name="API_DatasetGroupSummary"></a>

Provides a summary of the properties of a dataset group. For a complete listing, call the [DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) API.

## Contents
<a name="API_DatasetGroupSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetGroupSummary-creationDateTime"></a>
The date and time (in Unix time) that the dataset group was created.  
Type: Timestamp  
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-DatasetGroupSummary-datasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** domain **   <a name="personalize-Type-DatasetGroupSummary-domain"></a>
The domain of a Domain dataset group.  
Type: String  
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`   
Required: No

 ** failureReason **   <a name="personalize-Type-DatasetGroupSummary-failureReason"></a>
If creating a dataset group fails, the reason behind the failure.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetGroupSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the dataset group was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-DatasetGroupSummary-name"></a>
The name of the dataset group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** status **   <a name="personalize-Type-DatasetGroupSummary-status"></a>
The status of the dataset group.  
A dataset group can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DatasetGroupSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetGroupSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroupSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroupSummary) 

# DatasetImportJob
<a name="API_DatasetImportJob"></a>

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html).

A dataset import job can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED

## Contents
<a name="API_DatasetImportJob_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetImportJob-creationDateTime"></a>
The creation date and time (in Unix time) of the dataset import job.  
Type: Timestamp  
Required: No

 ** datasetArn **   <a name="personalize-Type-DatasetImportJob-datasetArn"></a>
The Amazon Resource Name (ARN) of the dataset that receives the imported data.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** datasetImportJobArn **   <a name="personalize-Type-DatasetImportJob-datasetImportJobArn"></a>
The ARN of the dataset import job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** dataSource **   <a name="personalize-Type-DatasetImportJob-dataSource"></a>
The Amazon S3 bucket that contains the training data to import.  
Type: [DataSource](API_DataSource.md) object  
Required: No

 ** failureReason **   <a name="personalize-Type-DatasetImportJob-failureReason"></a>
If a dataset import job fails, provides the reason why.  
Type: String  
Required: No

 ** importMode **   <a name="personalize-Type-DatasetImportJob-importMode"></a>
The import mode used by the dataset import job to import new records.  
Type: String  
Valid Values: `FULL | INCREMENTAL`   
Required: No

 ** jobName **   <a name="personalize-Type-DatasetImportJob-jobName"></a>
The name of the import job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetImportJob-lastUpdatedDateTime"></a>
The date and time (in Unix time) the dataset was last updated.  
Type: Timestamp  
Required: No

 ** publishAttributionMetricsToS3 **   <a name="personalize-Type-DatasetImportJob-publishAttributionMetricsToS3"></a>
Whether the job publishes metrics to Amazon S3 for a metric attribution.  
Type: Boolean  
Required: No

 ** roleArn **   <a name="personalize-Type-DatasetImportJob-roleArn"></a>
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-DatasetImportJob-status"></a>
The status of the dataset import job.  
A dataset import job can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DatasetImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJob) 

# DatasetImportJobSummary
<a name="API_DatasetImportJobSummary"></a>

Provides a summary of the properties of a dataset import job. For a complete listing, call the [DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) API.

## Contents
<a name="API_DatasetImportJobSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetImportJobSummary-creationDateTime"></a>
The date and time (in Unix time) that the dataset import job was created.  
Type: Timestamp  
Required: No

 ** datasetImportJobArn **   <a name="personalize-Type-DatasetImportJobSummary-datasetImportJobArn"></a>
The Amazon Resource Name (ARN) of the dataset import job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** failureReason **   <a name="personalize-Type-DatasetImportJobSummary-failureReason"></a>
If a dataset import job fails, the reason behind the failure.  
Type: String  
Required: No

 ** importMode **   <a name="personalize-Type-DatasetImportJobSummary-importMode"></a>
The import mode the dataset import job used to update the data in the dataset. For more information see [Updating existing bulk data](https://docs.aws.amazon.com/personalize/latest/dg/updating-existing-bulk-data.html).   
Type: String  
Valid Values: `FULL | INCREMENTAL`   
Required: No

 ** jobName **   <a name="personalize-Type-DatasetImportJobSummary-jobName"></a>
The name of the dataset import job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetImportJobSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the dataset import job status was last updated.  
Type: Timestamp  
Required: No

 ** status **   <a name="personalize-Type-DatasetImportJobSummary-status"></a>
The status of the dataset import job.  
A dataset import job can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DatasetImportJobSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJobSummary) 

# DatasetSchema
<a name="API_DatasetSchema"></a>

Describes the schema for a dataset. For more information on schemas, see [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html).

## Contents
<a name="API_DatasetSchema_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetSchema-creationDateTime"></a>
The date and time (in Unix time) that the schema was created.  
Type: Timestamp  
Required: No

 ** domain **   <a name="personalize-Type-DatasetSchema-domain"></a>
The domain of a schema that you created for a dataset in a Domain dataset group.  
Type: String  
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetSchema-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the schema was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-DatasetSchema-name"></a>
The name of the schema.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** schema **   <a name="personalize-Type-DatasetSchema-schema"></a>
The schema.  
Type: String  
Length Constraints: Maximum length of 20000.  
Required: No

 ** schemaArn **   <a name="personalize-Type-DatasetSchema-schemaArn"></a>
The Amazon Resource Name (ARN) of the schema.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

## See Also
<a name="API_DatasetSchema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchema) 

# DatasetSchemaSummary
<a name="API_DatasetSchemaSummary"></a>

Provides a summary of the properties of a dataset schema. For a complete listing, call the [DescribeSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) API.

## Contents
<a name="API_DatasetSchemaSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetSchemaSummary-creationDateTime"></a>
The date and time (in Unix time) that the schema was created.  
Type: Timestamp  
Required: No

 ** domain **   <a name="personalize-Type-DatasetSchemaSummary-domain"></a>
The domain of a schema that you created for a dataset in a Domain dataset group.  
Type: String  
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetSchemaSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the schema was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-DatasetSchemaSummary-name"></a>
The name of the schema.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** schemaArn **   <a name="personalize-Type-DatasetSchemaSummary-schemaArn"></a>
The Amazon Resource Name (ARN) of the schema.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

## See Also
<a name="API_DatasetSchemaSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSchemaSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchemaSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchemaSummary) 

# DatasetSummary
<a name="API_DatasetSummary"></a>

Provides a summary of the properties of a dataset. For a complete listing, call the [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) API.

## Contents
<a name="API_DatasetSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetSummary-creationDateTime"></a>
The date and time (in Unix time) that the dataset was created.  
Type: Timestamp  
Required: No

 ** datasetArn **   <a name="personalize-Type-DatasetSummary-datasetArn"></a>
The Amazon Resource Name (ARN) of the dataset.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** datasetType **   <a name="personalize-Type-DatasetSummary-datasetType"></a>
The dataset type. One of the following values:  
+ Interactions
+ Items
+ Users
+ Event-Interactions
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^[A-Za-z_]+$`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the dataset was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-DatasetSummary-name"></a>
The name of the dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** status **   <a name="personalize-Type-DatasetSummary-status"></a>
The status of the dataset.  
A dataset can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DatasetSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSummary) 

# DatasetUpdateSummary
<a name="API_DatasetUpdateSummary"></a>

Describes an update to a dataset.

## Contents
<a name="API_DatasetUpdateSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetUpdateSummary-creationDateTime"></a>
The creation date and time (in Unix time) of the dataset update.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-DatasetUpdateSummary-failureReason"></a>
If updating a dataset fails, provides the reason why.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetUpdateSummary-lastUpdatedDateTime"></a>
The last update date and time (in Unix time) of the dataset.  
Type: Timestamp  
Required: No

 ** schemaArn **   <a name="personalize-Type-DatasetUpdateSummary-schemaArn"></a>
The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-DatasetUpdateSummary-status"></a>
The status of the dataset update.   
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DatasetUpdateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetUpdateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetUpdateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetUpdateSummary) 

# DataSource
<a name="API_DataSource"></a>

Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize.

## Contents
<a name="API_DataSource_Contents"></a>

 ** dataLocation **   <a name="personalize-Type-DataSource-dataLocation"></a>
For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete.   
 For example:   
 `s3://bucket-name/folder-name/fileName.csv`   
If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a `/` after the folder name:  
 `s3://bucket-name/folder-name/`   
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `(s3|http|https)://.+`   
Required: No

## See Also
<a name="API_DataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataSource) 

# DefaultCategoricalHyperParameterRange
<a name="API_DefaultCategoricalHyperParameterRange"></a>

Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

## Contents
<a name="API_DefaultCategoricalHyperParameterRange_Contents"></a>

 ** isTunable **   <a name="personalize-Type-DefaultCategoricalHyperParameterRange-isTunable"></a>
Whether the hyperparameter is tunable.  
Type: Boolean  
Required: No

 ** name **   <a name="personalize-Type-DefaultCategoricalHyperParameterRange-name"></a>
The name of the hyperparameter.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** values **   <a name="personalize-Type-DefaultCategoricalHyperParameterRange-values"></a>
A list of the categories for the hyperparameter.  
Type: Array of strings  
Array Members: Maximum number of 100 items.  
Length Constraints: Maximum length of 1000.  
Required: No

## See Also
<a name="API_DefaultCategoricalHyperParameterRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) 

# DefaultContinuousHyperParameterRange
<a name="API_DefaultContinuousHyperParameterRange"></a>

Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

## Contents
<a name="API_DefaultContinuousHyperParameterRange_Contents"></a>

 ** isTunable **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-isTunable"></a>
Whether the hyperparameter is tunable.  
Type: Boolean  
Required: No

 ** maxValue **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-maxValue"></a>
The maximum allowable value for the hyperparameter.  
Type: Double  
Valid Range: Minimum value of -1000000.  
Required: No

 ** minValue **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-minValue"></a>
The minimum allowable value for the hyperparameter.  
Type: Double  
Valid Range: Minimum value of -1000000.  
Required: No

 ** name **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-name"></a>
The name of the hyperparameter.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DefaultContinuousHyperParameterRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultContinuousHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultContinuousHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultContinuousHyperParameterRange) 

# DefaultHyperParameterRanges
<a name="API_DefaultHyperParameterRanges"></a>

Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.

## Contents
<a name="API_DefaultHyperParameterRanges_Contents"></a>

 ** categoricalHyperParameterRanges **   <a name="personalize-Type-DefaultHyperParameterRanges-categoricalHyperParameterRanges"></a>
The categorical hyperparameters and their default ranges.  
Type: Array of [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

 ** continuousHyperParameterRanges **   <a name="personalize-Type-DefaultHyperParameterRanges-continuousHyperParameterRanges"></a>
The continuous hyperparameters and their default ranges.  
Type: Array of [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

 ** integerHyperParameterRanges **   <a name="personalize-Type-DefaultHyperParameterRanges-integerHyperParameterRanges"></a>
The integer-valued hyperparameters and their default ranges.  
Type: Array of [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

## See Also
<a name="API_DefaultHyperParameterRanges_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultHyperParameterRanges) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultHyperParameterRanges) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultHyperParameterRanges) 

# DefaultIntegerHyperParameterRange
<a name="API_DefaultIntegerHyperParameterRange"></a>

Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

## Contents
<a name="API_DefaultIntegerHyperParameterRange_Contents"></a>

 ** isTunable **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-isTunable"></a>
Indicates whether the hyperparameter is tunable.  
Type: Boolean  
Required: No

 ** maxValue **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-maxValue"></a>
The maximum allowable value for the hyperparameter.  
Type: Integer  
Valid Range: Maximum value of 1000000.  
Required: No

 ** minValue **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-minValue"></a>
The minimum allowable value for the hyperparameter.  
Type: Integer  
Valid Range: Minimum value of -1000000.  
Required: No

 ** name **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-name"></a>
The name of the hyperparameter.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DefaultIntegerHyperParameterRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultIntegerHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultIntegerHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultIntegerHyperParameterRange) 

# EventParameters
<a name="API_EventParameters"></a>

Describes the parameters of events, which are used in solution creation.

## Contents
<a name="API_EventParameters_Contents"></a>

 ** eventType **   <a name="personalize-Type-EventParameters-eventType"></a>
The name of the event type to be considered for solution creation.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** eventValueThreshold **   <a name="personalize-Type-EventParameters-eventValueThreshold"></a>
The threshold of the event type. Only events with a value greater or equal to this threshold will be considered for solution creation.  
Type: Double  
Required: No

 ** weight **   <a name="personalize-Type-EventParameters-weight"></a>
The weight of the event type. A higher weight means higher importance of the event type for the created solution.  
Type: Double  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

## See Also
<a name="API_EventParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventParameters) 

# EventsConfig
<a name="API_EventsConfig"></a>

Describes the configuration of events, which are used in solution creation.

## Contents
<a name="API_EventsConfig_Contents"></a>

 ** eventParametersList **   <a name="personalize-Type-EventsConfig-eventParametersList"></a>
A list of event parameters, which includes event types and their event value thresholds and weights.  
Type: Array of [EventParameters](API_EventParameters.md) objects  
Array Members: Maximum number of 10 items.  
Required: No

## See Also
<a name="API_EventsConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventsConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventsConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventsConfig) 

# EventTracker
<a name="API_EventTracker"></a>

Provides information about an event tracker.

## Contents
<a name="API_EventTracker_Contents"></a>

 ** accountId **   <a name="personalize-Type-EventTracker-accountId"></a>
The AWS account that owns the event tracker.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** creationDateTime **   <a name="personalize-Type-EventTracker-creationDateTime"></a>
The date and time (in Unix format) that the event tracker was created.  
Type: Timestamp  
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-EventTracker-datasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group that receives the event data.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** eventTrackerArn **   <a name="personalize-Type-EventTracker-eventTrackerArn"></a>
The ARN of the event tracker.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-EventTracker-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the event tracker was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-EventTracker-name"></a>
The name of the event tracker.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** status **   <a name="personalize-Type-EventTracker-status"></a>
The status of the event tracker.  
An event tracker can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** trackingId **   <a name="personalize-Type-EventTracker-trackingId"></a>
The ID of the event tracker. Include this ID in requests to the [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_EventTracker_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTracker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventTracker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventTracker) 

# EventTrackerSummary
<a name="API_EventTrackerSummary"></a>

Provides a summary of the properties of an event tracker. For a complete listing, call the [DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) API.

## Contents
<a name="API_EventTrackerSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-EventTrackerSummary-creationDateTime"></a>
The date and time (in Unix time) that the event tracker was created.  
Type: Timestamp  
Required: No

 ** eventTrackerArn **   <a name="personalize-Type-EventTrackerSummary-eventTrackerArn"></a>
The Amazon Resource Name (ARN) of the event tracker.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-EventTrackerSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the event tracker was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-EventTrackerSummary-name"></a>
The name of the event tracker.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** status **   <a name="personalize-Type-EventTrackerSummary-status"></a>
The status of the event tracker.  
An event tracker can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_EventTrackerSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTrackerSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventTrackerSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventTrackerSummary) 

# FeatureTransformation
<a name="API_FeatureTransformation"></a>

Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.

## Contents
<a name="API_FeatureTransformation_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-FeatureTransformation-creationDateTime"></a>
The creation date and time (in Unix time) of the feature transformation.  
Type: Timestamp  
Required: No

 ** defaultParameters **   <a name="personalize-Type-FeatureTransformation-defaultParameters"></a>
Provides the default parameters for feature transformation.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Maximum length of 256.  
Value Length Constraints: Maximum length of 1000.  
Required: No

 ** featureTransformationArn **   <a name="personalize-Type-FeatureTransformation-featureTransformationArn"></a>
The Amazon Resource Name (ARN) of the FeatureTransformation object.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-FeatureTransformation-lastUpdatedDateTime"></a>
The last update date and time (in Unix time) of the feature transformation.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-FeatureTransformation-name"></a>
The name of the feature transformation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** status **   <a name="personalize-Type-FeatureTransformation-status"></a>
The status of the feature transformation.  
A feature transformation can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_FeatureTransformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FeatureTransformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FeatureTransformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FeatureTransformation) 

# FieldsForThemeGeneration
<a name="API_FieldsForThemeGeneration"></a>

A string to string map of the configuration details for theme generation.

## Contents
<a name="API_FieldsForThemeGeneration_Contents"></a>

 ** itemName **   <a name="personalize-Type-FieldsForThemeGeneration-itemName"></a>
The name of the Items dataset column that stores the name of each item in the dataset.  
Type: String  
Length Constraints: Maximum length of 150.  
Pattern: `[A-Za-z_][A-Za-z\d_]*`   
Required: Yes

## See Also
<a name="API_FieldsForThemeGeneration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FieldsForThemeGeneration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FieldsForThemeGeneration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FieldsForThemeGeneration) 

# Filter
<a name="API_Filter"></a>

Contains information on a recommendation filter, including its ARN, status, and filter expression.

## Contents
<a name="API_Filter_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-Filter-creationDateTime"></a>
The time at which the filter was created.  
Type: Timestamp  
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-Filter-datasetGroupArn"></a>
The ARN of the dataset group to which the filter belongs.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** failureReason **   <a name="personalize-Type-Filter-failureReason"></a>
If the filter failed, the reason for its failure.  
Type: String  
Required: No

 ** filterArn **   <a name="personalize-Type-Filter-filterArn"></a>
The ARN of the filter.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** filterExpression **   <a name="personalize-Type-Filter-filterExpression"></a>
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](https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-Filter-lastUpdatedDateTime"></a>
The time at which the filter was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-Filter-name"></a>
The name of the filter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** status **   <a name="personalize-Type-Filter-status"></a>
The status of the filter.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_Filter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Filter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Filter) 

# FilterSummary
<a name="API_FilterSummary"></a>

A short summary of a filter's attributes.

## Contents
<a name="API_FilterSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-FilterSummary-creationDateTime"></a>
The time at which the filter was created.  
Type: Timestamp  
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-FilterSummary-datasetGroupArn"></a>
The ARN of the dataset group to which the filter belongs.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** failureReason **   <a name="personalize-Type-FilterSummary-failureReason"></a>
If the filter failed, the reason for the failure.  
Type: String  
Required: No

 ** filterArn **   <a name="personalize-Type-FilterSummary-filterArn"></a>
The ARN of the filter.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-FilterSummary-lastUpdatedDateTime"></a>
The time at which the filter was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-FilterSummary-name"></a>
The name of the filter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** status **   <a name="personalize-Type-FilterSummary-status"></a>
The status of the filter.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_FilterSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FilterSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FilterSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FilterSummary) 

# HPOConfig
<a name="API_HPOConfig"></a>

Describes the properties for hyperparameter optimization (HPO).

## Contents
<a name="API_HPOConfig_Contents"></a>

 ** algorithmHyperParameterRanges **   <a name="personalize-Type-HPOConfig-algorithmHyperParameterRanges"></a>
The hyperparameters and their allowable ranges.  
Type: [HyperParameterRanges](API_HyperParameterRanges.md) object  
Required: No

 ** hpoObjective **   <a name="personalize-Type-HPOConfig-hpoObjective"></a>
The metric to optimize during HPO.  
Amazon Personalize doesn't support configuring the `hpoObjective` at this time.
Type: [HPOObjective](API_HPOObjective.md) object  
Required: No

 ** hpoResourceConfig **   <a name="personalize-Type-HPOConfig-hpoResourceConfig"></a>
Describes the resource configuration for HPO.  
Type: [HPOResourceConfig](API_HPOResourceConfig.md) object  
Required: No

## See Also
<a name="API_HPOConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOConfig) 

# HPOObjective
<a name="API_HPOObjective"></a>

The metric to optimize during hyperparameter optimization (HPO).

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

## Contents
<a name="API_HPOObjective_Contents"></a>

 ** metricName **   <a name="personalize-Type-HPOObjective-metricName"></a>
The name of the metric.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** metricRegex **   <a name="personalize-Type-HPOObjective-metricRegex"></a>
A regular expression for finding the metric in the training job logs.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** type **   <a name="personalize-Type-HPOObjective-type"></a>
The type of the metric. Valid values are `Maximize` and `Minimize`.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_HPOObjective_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOObjective) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOObjective) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOObjective) 

# HPOResourceConfig
<a name="API_HPOResourceConfig"></a>

Describes the resource configuration for hyperparameter optimization (HPO).

## Contents
<a name="API_HPOResourceConfig_Contents"></a>

 ** maxNumberOfTrainingJobs **   <a name="personalize-Type-HPOResourceConfig-maxNumberOfTrainingJobs"></a>
The maximum number of training jobs when you create a solution version. The maximum value for `maxNumberOfTrainingJobs` is `40`.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** maxParallelTrainingJobs **   <a name="personalize-Type-HPOResourceConfig-maxParallelTrainingJobs"></a>
The maximum number of parallel training jobs when you create a solution version. The maximum value for `maxParallelTrainingJobs` is `10`.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_HPOResourceConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOResourceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOResourceConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOResourceConfig) 

# HyperParameterRanges
<a name="API_HyperParameterRanges"></a>

Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.

## Contents
<a name="API_HyperParameterRanges_Contents"></a>

 ** categoricalHyperParameterRanges **   <a name="personalize-Type-HyperParameterRanges-categoricalHyperParameterRanges"></a>
The categorical hyperparameters and their ranges.  
Type: Array of [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

 ** continuousHyperParameterRanges **   <a name="personalize-Type-HyperParameterRanges-continuousHyperParameterRanges"></a>
The continuous hyperparameters and their ranges.  
Type: Array of [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

 ** integerHyperParameterRanges **   <a name="personalize-Type-HyperParameterRanges-integerHyperParameterRanges"></a>
The integer-valued hyperparameters and their ranges.  
Type: Array of [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

## See Also
<a name="API_HyperParameterRanges_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HyperParameterRanges) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HyperParameterRanges) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HyperParameterRanges) 

# IntegerHyperParameterRange
<a name="API_IntegerHyperParameterRange"></a>

Provides the name and range of an integer-valued hyperparameter.

## Contents
<a name="API_IntegerHyperParameterRange_Contents"></a>

 ** maxValue **   <a name="personalize-Type-IntegerHyperParameterRange-maxValue"></a>
The maximum allowable value for the hyperparameter.  
Type: Integer  
Valid Range: Maximum value of 1000000.  
Required: No

 ** minValue **   <a name="personalize-Type-IntegerHyperParameterRange-minValue"></a>
The minimum allowable value for the hyperparameter.  
Type: Integer  
Valid Range: Minimum value of -1000000.  
Required: No

 ** name **   <a name="personalize-Type-IntegerHyperParameterRange-name"></a>
The name of the hyperparameter.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_IntegerHyperParameterRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/IntegerHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/IntegerHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/IntegerHyperParameterRange) 

# MetricAttribute
<a name="API_MetricAttribute"></a>

Contains information on a metric that a metric attribution reports on. For more information, see [Measuring impact of recommendations](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).

## Contents
<a name="API_MetricAttribute_Contents"></a>

 ** eventType **   <a name="personalize-Type-MetricAttribute-eventType"></a>
The metric's event type.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: Yes

 ** expression **   <a name="personalize-Type-MetricAttribute-expression"></a>
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).  
Type: String  
Length Constraints: Maximum length of 256.  
Required: Yes

 ** metricName **   <a name="personalize-Type-MetricAttribute-metricName"></a>
The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: Yes

## See Also
<a name="API_MetricAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribute) 

# MetricAttribution
<a name="API_MetricAttribution"></a>

Contains information on a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you import the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see [Measuring impact of recommendations](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).

## Contents
<a name="API_MetricAttribution_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-MetricAttribution-creationDateTime"></a>
The metric attribution's creation date time.  
Type: Timestamp  
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-MetricAttribution-datasetGroupArn"></a>
The metric attribution's dataset group Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** failureReason **   <a name="personalize-Type-MetricAttribution-failureReason"></a>
The metric attribution's failure reason.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-MetricAttribution-lastUpdatedDateTime"></a>
The metric attribution's last updated date time.  
Type: Timestamp  
Required: No

 ** metricAttributionArn **   <a name="personalize-Type-MetricAttribution-metricAttributionArn"></a>
The metric attribution's Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** metricsOutputConfig **   <a name="personalize-Type-MetricAttribution-metricsOutputConfig"></a>
The metric attribution's output configuration.  
Type: [MetricAttributionOutput](API_MetricAttributionOutput.md) object  
Required: No

 ** name **   <a name="personalize-Type-MetricAttribution-name"></a>
The metric attribution's name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** status **   <a name="personalize-Type-MetricAttribution-status"></a>
The metric attribution's status.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_MetricAttribution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttribution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribution) 

# MetricAttributionOutput
<a name="API_MetricAttributionOutput"></a>

The output configuration details for a metric attribution.

## Contents
<a name="API_MetricAttributionOutput_Contents"></a>

 ** roleArn **   <a name="personalize-Type-MetricAttributionOutput-roleArn"></a>
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](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: Yes

 ** s3DataDestination **   <a name="personalize-Type-MetricAttributionOutput-s3DataDestination"></a>
The configuration details of an Amazon S3 input or output bucket.  
Type: [S3DataConfig](API_S3DataConfig.md) object  
Required: No

## See Also
<a name="API_MetricAttributionOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttributionOutput) 

# MetricAttributionSummary
<a name="API_MetricAttributionSummary"></a>

Provides a summary of the properties of a metric attribution. For a complete listing, call the [DescribeMetricAttribution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html).

## Contents
<a name="API_MetricAttributionSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-MetricAttributionSummary-creationDateTime"></a>
The metric attribution's creation date time.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-MetricAttributionSummary-failureReason"></a>
The metric attribution's failure reason.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-MetricAttributionSummary-lastUpdatedDateTime"></a>
The metric attribution's last updated date time.  
Type: Timestamp  
Required: No

 ** metricAttributionArn **   <a name="personalize-Type-MetricAttributionSummary-metricAttributionArn"></a>
The metric attribution's Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** name **   <a name="personalize-Type-MetricAttributionSummary-name"></a>
The name of the metric attribution.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** status **   <a name="personalize-Type-MetricAttributionSummary-status"></a>
The metric attribution's status.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_MetricAttributionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttributionSummary) 

# OptimizationObjective
<a name="API_OptimizationObjective"></a>

Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see [Optimizing a solution](https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html).

## Contents
<a name="API_OptimizationObjective_Contents"></a>

 ** itemAttribute **   <a name="personalize-Type-OptimizationObjective-itemAttribute"></a>
The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO\$1LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 150.  
Required: No

 ** objectiveSensitivity **   <a name="personalize-Type-OptimizationObjective-objectiveSensitivity"></a>
Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.  
Type: String  
Valid Values: `LOW | MEDIUM | HIGH | OFF`   
Required: No

## See Also
<a name="API_OptimizationObjective_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/OptimizationObjective) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/OptimizationObjective) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/OptimizationObjective) 

# Recipe
<a name="API_Recipe"></a>

Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) operation. 

## Contents
<a name="API_Recipe_Contents"></a>

 ** algorithmArn **   <a name="personalize-Type-Recipe-algorithmArn"></a>
The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** creationDateTime **   <a name="personalize-Type-Recipe-creationDateTime"></a>
The date and time (in Unix format) that the recipe was created.  
Type: Timestamp  
Required: No

 ** description **   <a name="personalize-Type-Recipe-description"></a>
The description of the recipe.  
Type: String  
Required: No

 ** featureTransformationArn **   <a name="personalize-Type-Recipe-featureTransformationArn"></a>
The ARN of the FeatureTransformation object.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-Recipe-lastUpdatedDateTime"></a>
The date and time (in Unix format) that the recipe was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-Recipe-name"></a>
The name of the recipe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** recipeArn **   <a name="personalize-Type-Recipe-recipeArn"></a>
The Amazon Resource Name (ARN) of the recipe.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** recipeType **   <a name="personalize-Type-Recipe-recipeType"></a>
One of the following values:  
+ PERSONALIZED\$1RANKING
+ RELATED\$1ITEMS
+ USER\$1PERSONALIZATION
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** status **   <a name="personalize-Type-Recipe-status"></a>
The status of the recipe.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_Recipe_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Recipe) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Recipe) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Recipe) 

# RecipeSummary
<a name="API_RecipeSummary"></a>

Provides a summary of the properties of a recipe. For a complete listing, call the [DescribeRecipe](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html) API.

## Contents
<a name="API_RecipeSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-RecipeSummary-creationDateTime"></a>
The date and time (in Unix time) that the recipe was created.  
Type: Timestamp  
Required: No

 ** domain **   <a name="personalize-Type-RecipeSummary-domain"></a>
The domain of the recipe (if the recipe is a Domain dataset group use case).  
Type: String  
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-RecipeSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the recipe was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-RecipeSummary-name"></a>
The name of the recipe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** recipeArn **   <a name="personalize-Type-RecipeSummary-recipeArn"></a>
The Amazon Resource Name (ARN) of the recipe.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-RecipeSummary-status"></a>
The status of the recipe.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_RecipeSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecipeSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecipeSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecipeSummary) 

# Recommender
<a name="API_Recommender"></a>

Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) request.

## Contents
<a name="API_Recommender_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-Recommender-creationDateTime"></a>
The date and time (in Unix format) that the recommender was created.  
Type: Timestamp  
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-Recommender-datasetGroupArn"></a>
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** failureReason **   <a name="personalize-Type-Recommender-failureReason"></a>
If a recommender fails, the reason behind the failure.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-Recommender-lastUpdatedDateTime"></a>
The date and time (in Unix format) that the recommender was last updated.  
Type: Timestamp  
Required: No

 ** latestRecommenderUpdate **   <a name="personalize-Type-Recommender-latestRecommenderUpdate"></a>
Provides a summary of the latest updates to the recommender.   
Type: [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) object  
Required: No

 ** modelMetrics **   <a name="personalize-Type-Recommender-modelMetrics"></a>
Provides evaluation metrics that help you determine the performance of a recommender. For more information, see [ Evaluating a recommender](https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html).  
Type: String to double map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Maximum length of 256.  
Required: No

 ** name **   <a name="personalize-Type-Recommender-name"></a>
The name of the recommender.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** recipeArn **   <a name="personalize-Type-Recommender-recipeArn"></a>
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.   
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** recommenderArn **   <a name="personalize-Type-Recommender-recommenderArn"></a>
The Amazon Resource Name (ARN) of the recommender.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** recommenderConfig **   <a name="personalize-Type-Recommender-recommenderConfig"></a>
The configuration details of the recommender.  
Type: [RecommenderConfig](API_RecommenderConfig.md) object  
Required: No

 ** status **   <a name="personalize-Type-Recommender-status"></a>
The status of the recommender.  
A recommender can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_Recommender_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Recommender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Recommender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Recommender) 

# RecommenderConfig
<a name="API_RecommenderConfig"></a>

The configuration details of the recommender.

## Contents
<a name="API_RecommenderConfig_Contents"></a>

 ** enableMetadataWithRecommendations **   <a name="personalize-Type-RecommenderConfig-enableMetadataWithRecommendations"></a>
Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see [Enabling metadata in recommendations for a recommender](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata).  
 If you enable metadata in recommendations, you will incur additional costs. For more information, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).   
Type: Boolean  
Required: No

 ** itemExplorationConfig **   <a name="personalize-Type-RecommenderConfig-itemExplorationConfig"></a>
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).  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Maximum length of 256.  
Value Length Constraints: Maximum length of 1000.  
Required: No

 ** minRecommendationRequestsPerSecond **   <a name="personalize-Type-RecommenderConfig-minRecommendationRequestsPerSecond"></a>
Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high `minRecommendationRequestsPerSecond` will increase your bill. We recommend starting with 1 for `minRecommendationRequestsPerSecond` (the default). Track your usage using Amazon CloudWatch metrics, and increase the `minRecommendationRequestsPerSecond` as necessary.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** trainingDataConfig **   <a name="personalize-Type-RecommenderConfig-trainingDataConfig"></a>
 Specifies the training data configuration to use when creating a domain recommender.   
Type: [TrainingDataConfig](API_TrainingDataConfig.md) object  
Required: No

## See Also
<a name="API_RecommenderConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderConfig) 

# RecommenderSummary
<a name="API_RecommenderSummary"></a>

Provides a summary of the properties of the recommender.

## Contents
<a name="API_RecommenderSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-RecommenderSummary-creationDateTime"></a>
The date and time (in Unix format) that the recommender was created.  
Type: Timestamp  
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-RecommenderSummary-datasetGroupArn"></a>
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-RecommenderSummary-lastUpdatedDateTime"></a>
The date and time (in Unix format) that the recommender was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-RecommenderSummary-name"></a>
The name of the recommender.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** recipeArn **   <a name="personalize-Type-RecommenderSummary-recipeArn"></a>
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** recommenderArn **   <a name="personalize-Type-RecommenderSummary-recommenderArn"></a>
The Amazon Resource Name (ARN) of the recommender.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** recommenderConfig **   <a name="personalize-Type-RecommenderSummary-recommenderConfig"></a>
The configuration details of the recommender.  
Type: [RecommenderConfig](API_RecommenderConfig.md) object  
Required: No

 ** status **   <a name="personalize-Type-RecommenderSummary-status"></a>
The status of the recommender. A recommender can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_RecommenderSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderSummary) 

# RecommenderUpdateSummary
<a name="API_RecommenderUpdateSummary"></a>

Provides a summary of the properties of a recommender update. For a complete listing, call the [DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) API.

## Contents
<a name="API_RecommenderUpdateSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-RecommenderUpdateSummary-creationDateTime"></a>
The date and time (in Unix format) that the recommender update was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-RecommenderUpdateSummary-failureReason"></a>
If a recommender update fails, the reason behind the failure.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-RecommenderUpdateSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the recommender update was last updated.  
Type: Timestamp  
Required: No

 ** recommenderConfig **   <a name="personalize-Type-RecommenderUpdateSummary-recommenderConfig"></a>
The configuration details of the recommender update.  
Type: [RecommenderConfig](API_RecommenderConfig.md) object  
Required: No

 ** status **   <a name="personalize-Type-RecommenderUpdateSummary-status"></a>
The status of the recommender update. A recommender update can be in one of the following states:  
CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_RecommenderUpdateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderUpdateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderUpdateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderUpdateSummary) 

# S3DataConfig
<a name="API_S3DataConfig"></a>

The configuration details of an Amazon S3 input or output bucket.

## Contents
<a name="API_S3DataConfig_Contents"></a>

 ** path **   <a name="personalize-Type-S3DataConfig-path"></a>
The file path of the Amazon S3 bucket.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `(s3|http|https)://.+`   
Required: Yes

 ** kmsKeyArn **   <a name="personalize-Type-S3DataConfig-kmsKeyArn"></a>
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`   
Required: No

## See Also
<a name="API_S3DataConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/S3DataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/S3DataConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/S3DataConfig) 

# Solution
<a name="API_Solution"></a>

**Important**  
By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can [update the solution](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html) to turn off automatic training. For information about training costs, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).

An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and trained models (Solution Versions) that Amazon Personalize uses to generate recommendations. 

After you create a solution, you can’t change its configuration. If you need to make changes, you can [clone the solution](https://docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html) with the Amazon Personalize console or create a new one.

## Contents
<a name="API_Solution_Contents"></a>

 ** autoMLResult **   <a name="personalize-Type-Solution-autoMLResult"></a>
When `performAutoML` is true, specifies the best recipe found.  
Type: [AutoMLResult](API_AutoMLResult.md) object  
Required: No

 ** creationDateTime **   <a name="personalize-Type-Solution-creationDateTime"></a>
The creation date and time (in Unix time) of the solution.  
Type: Timestamp  
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-Solution-datasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group that provides the training data.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** eventType **   <a name="personalize-Type-Solution-eventType"></a>
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.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-Solution-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the solution was last updated.  
Type: Timestamp  
Required: No

 ** latestSolutionUpdate **   <a name="personalize-Type-Solution-latestSolutionUpdate"></a>
Provides a summary of the latest updates to the solution.  
Type: [SolutionUpdateSummary](API_SolutionUpdateSummary.md) object  
Required: No

 ** latestSolutionVersion **   <a name="personalize-Type-Solution-latestSolutionVersion"></a>
Describes the latest version of the solution, including the status and the ARN.  
Type: [SolutionVersionSummary](API_SolutionVersionSummary.md) object  
Required: No

 ** name **   <a name="personalize-Type-Solution-name"></a>
The name of the solution.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** performAutoML **   <a name="personalize-Type-Solution-performAutoML"></a>
We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see [Determining your use case.](https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html) 
When true, Amazon Personalize performs a search for the best USER\$1PERSONALIZATION recipe from the list specified in the solution configuration (`recipeArn` must not be specified). When false (the default), Amazon Personalize uses `recipeArn` for training.  
Type: Boolean  
Required: No

 ** performAutoTraining **   <a name="personalize-Type-Solution-performAutoTraining"></a>
Specifies whether the solution automatically creates solution versions. The default is `True` and the solution automatically creates new solution versions every 7 days.  
For more information about auto training, see [Creating and configuring a solution](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html).  
Type: Boolean  
Required: No

 ** performHPO **   <a name="personalize-Type-Solution-performHPO"></a>
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is `false`.  
Type: Boolean  
Required: No

 ** performIncrementalUpdate **   <a name="personalize-Type-Solution-performIncrementalUpdate"></a>
A Boolean value that indicates whether incremental training updates are performed on the model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe  
Type: Boolean  
Required: No

 ** recipeArn **   <a name="personalize-Type-Solution-recipeArn"></a>
The ARN of the recipe used to create the solution. This is required when `performAutoML` is false.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** solutionArn **   <a name="personalize-Type-Solution-solutionArn"></a>
The ARN of the solution.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** solutionConfig **   <a name="personalize-Type-Solution-solutionConfig"></a>
Describes the configuration properties for the solution.  
Type: [SolutionConfig](API_SolutionConfig.md) object  
Required: No

 ** status **   <a name="personalize-Type-Solution-status"></a>
The status of the solution.  
A solution can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_Solution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Solution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Solution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Solution) 

# SolutionConfig
<a name="API_SolutionConfig"></a>

Describes the configuration properties for the solution.

## Contents
<a name="API_SolutionConfig_Contents"></a>

 ** algorithmHyperParameters **   <a name="personalize-Type-SolutionConfig-algorithmHyperParameters"></a>
Lists the algorithm hyperparameters and their values.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Maximum length of 256.  
Value Length Constraints: Maximum length of 1000.  
Required: No

 ** autoMLConfig **   <a name="personalize-Type-SolutionConfig-autoMLConfig"></a>
The [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search when AutoML is performed.  
Type: [AutoMLConfig](API_AutoMLConfig.md) object  
Required: No

 ** autoTrainingConfig **   <a name="personalize-Type-SolutionConfig-autoTrainingConfig"></a>
Specifies the automatic training configuration to use.  
Type: [AutoTrainingConfig](API_AutoTrainingConfig.md) object  
Required: No

 ** eventsConfig **   <a name="personalize-Type-SolutionConfig-eventsConfig"></a>
Describes the configuration of an event, which includes a list of event parameters. You can specify up to 10 event parameters. Events are used in solution creation.  
Type: [EventsConfig](API_EventsConfig.md) object  
Required: No

 ** eventValueThreshold **   <a name="personalize-Type-SolutionConfig-eventValueThreshold"></a>
Only events with a value greater than or equal to this threshold are used for training a model.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** featureTransformationParameters **   <a name="personalize-Type-SolutionConfig-featureTransformationParameters"></a>
Lists the feature transformation parameters.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Maximum length of 256.  
Value Length Constraints: Maximum length of 1000.  
Required: No

 ** hpoConfig **   <a name="personalize-Type-SolutionConfig-hpoConfig"></a>
Describes the properties for hyperparameter optimization (HPO).  
Type: [HPOConfig](API_HPOConfig.md) object  
Required: No

 ** optimizationObjective **   <a name="personalize-Type-SolutionConfig-optimizationObjective"></a>
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see [Optimizing a solution](https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html).  
Type: [OptimizationObjective](API_OptimizationObjective.md) object  
Required: No

 ** trainingDataConfig **   <a name="personalize-Type-SolutionConfig-trainingDataConfig"></a>
 Specifies the training data configuration to use when creating a custom solution version (trained model).   
Type: [TrainingDataConfig](API_TrainingDataConfig.md) object  
Required: No

## See Also
<a name="API_SolutionConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionConfig) 

# SolutionSummary
<a name="API_SolutionSummary"></a>

Provides a summary of the properties of a solution. For a complete listing, call the [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) API.

## Contents
<a name="API_SolutionSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionSummary-creationDateTime"></a>
The date and time (in Unix time) that the solution was created.  
Type: Timestamp  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the solution was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-SolutionSummary-name"></a>
The name of the solution.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** recipeArn **   <a name="personalize-Type-SolutionSummary-recipeArn"></a>
The Amazon Resource Name (ARN) of the recipe used by the solution.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** solutionArn **   <a name="personalize-Type-SolutionSummary-solutionArn"></a>
The Amazon Resource Name (ARN) of the solution.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-SolutionSummary-status"></a>
The status of the solution.  
A solution can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_SolutionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionSummary) 

# SolutionUpdateConfig
<a name="API_SolutionUpdateConfig"></a>

The configuration details of the solution update.

## Contents
<a name="API_SolutionUpdateConfig_Contents"></a>

 ** autoTrainingConfig **   <a name="personalize-Type-SolutionUpdateConfig-autoTrainingConfig"></a>
The automatic training configuration to use when `performAutoTraining` is true.  
Type: [AutoTrainingConfig](API_AutoTrainingConfig.md) object  
Required: No

 ** eventsConfig **   <a name="personalize-Type-SolutionUpdateConfig-eventsConfig"></a>
Describes the configuration of an event, which includes a list of event parameters. You can specify up to 10 event parameters. Events are used in solution creation.  
Type: [EventsConfig](API_EventsConfig.md) object  
Required: No

## See Also
<a name="API_SolutionUpdateConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionUpdateConfig) 

# SolutionUpdateSummary
<a name="API_SolutionUpdateSummary"></a>

Provides a summary of the properties of a solution update. For a complete listing, call the [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) API.

## Contents
<a name="API_SolutionUpdateSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionUpdateSummary-creationDateTime"></a>
The date and time (in Unix format) that the solution update was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-SolutionUpdateSummary-failureReason"></a>
If a solution update fails, the reason behind the failure.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionUpdateSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the solution update was last updated.  
Type: Timestamp  
Required: No

 ** performAutoTraining **   <a name="personalize-Type-SolutionUpdateSummary-performAutoTraining"></a>
Whether the solution automatically creates solution versions.  
Type: Boolean  
Required: No

 ** performIncrementalUpdate **   <a name="personalize-Type-SolutionUpdateSummary-performIncrementalUpdate"></a>
A Boolean value that indicates whether incremental training updates are performed on the model. When enabled, incremental training is performed for solution versions with active campaigns and allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe. The default is `true`.  
Note that certain scores and attributes (like updates to item popularity and freshness used for ranking influence with aws-semantic-similarity recipe) may not update until the next full training occurs.   
Type: Boolean  
Required: No

 ** solutionUpdateConfig **   <a name="personalize-Type-SolutionUpdateSummary-solutionUpdateConfig"></a>
The configuration details of the solution.  
Type: [SolutionUpdateConfig](API_SolutionUpdateConfig.md) object  
Required: No

 ** status **   <a name="personalize-Type-SolutionUpdateSummary-status"></a>
The status of the solution update. A solution update can be in one of the following states:  
CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_SolutionUpdateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionUpdateSummary) 

# SolutionVersion
<a name="API_SolutionVersion"></a>

An object that provides information about a specific version of a [Solution](https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html) in a Custom dataset group.

## Contents
<a name="API_SolutionVersion_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionVersion-creationDateTime"></a>
The date and time (in Unix time) that this version of the solution was created.  
Type: Timestamp  
Required: No

 ** datasetGroupArn **   <a name="personalize-Type-SolutionVersion-datasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group providing the training data.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** eventType **   <a name="personalize-Type-SolutionVersion-eventType"></a>
The event type (for example, 'click' or 'like') that is used for training the model.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** failureReason **   <a name="personalize-Type-SolutionVersion-failureReason"></a>
If training a solution version fails, the reason for the failure.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionVersion-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the solution was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="personalize-Type-SolutionVersion-name"></a>
The name of the solution version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** performAutoML **   <a name="personalize-Type-SolutionVersion-performAutoML"></a>
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses `recipeArn`.  
Type: Boolean  
Required: No

 ** performHPO **   <a name="personalize-Type-SolutionVersion-performHPO"></a>
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is `false`.  
Type: Boolean  
Required: No

 ** performIncrementalUpdate **   <a name="personalize-Type-SolutionVersion-performIncrementalUpdate"></a>
Whether the solution version should perform an incremental update. When set to true, the training will process only the data that has changed since the latest training, similar to when trainingMode is set to UPDATE. This can only be used with solution versions that use the User-Personalization recipe.  
Type: Boolean  
Required: No

 ** recipeArn **   <a name="personalize-Type-SolutionVersion-recipeArn"></a>
The ARN of the recipe used in the solution.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** solutionArn **   <a name="personalize-Type-SolutionVersion-solutionArn"></a>
The ARN of the solution.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** solutionConfig **   <a name="personalize-Type-SolutionVersion-solutionConfig"></a>
Describes the configuration properties for the solution.  
Type: [SolutionConfig](API_SolutionConfig.md) object  
Required: No

 ** solutionVersionArn **   <a name="personalize-Type-SolutionVersion-solutionVersionArn"></a>
The ARN of the solution version.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-SolutionVersion-status"></a>
The status of the solution version.  
A solution version can be in one of the following states:  
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
+ CREATE STOPPING
+ CREATE STOPPED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** trainingHours **   <a name="personalize-Type-SolutionVersion-trainingHours"></a>
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.  
Type: Double  
Valid Range: Minimum value of 0.  
Required: No

 ** trainingMode **   <a name="personalize-Type-SolutionVersion-trainingMode"></a>
The scope of training to be performed when creating the solution version. A `FULL` training considers all of the data in your dataset group. An `UPDATE` processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use `UPDATE`.   
Type: String  
Valid Values: `FULL | UPDATE | AUTOTRAIN`   
Required: No

 ** trainingType **   <a name="personalize-Type-SolutionVersion-trainingType"></a>
Whether the solution version was created automatically or manually.  
Type: String  
Valid Values: `AUTOMATIC | MANUAL`   
Required: No

 ** tunedHPOParams **   <a name="personalize-Type-SolutionVersion-tunedHPOParams"></a>
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.  
Type: [TunedHPOParams](API_TunedHPOParams.md) object  
Required: No

## See Also
<a name="API_SolutionVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersion) 

# SolutionVersionSummary
<a name="API_SolutionVersionSummary"></a>

Provides a summary of the properties of a solution version. For a complete listing, call the [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) API.

## Contents
<a name="API_SolutionVersionSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionVersionSummary-creationDateTime"></a>
The date and time (in Unix time) that this version of a solution was created.  
Type: Timestamp  
Required: No

 ** failureReason **   <a name="personalize-Type-SolutionVersionSummary-failureReason"></a>
If a solution version fails, the reason behind the failure.  
Type: String  
Required: No

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionVersionSummary-lastUpdatedDateTime"></a>
The date and time (in Unix time) that the solution version was last updated.  
Type: Timestamp  
Required: No

 ** solutionVersionArn **   <a name="personalize-Type-SolutionVersionSummary-solutionVersionArn"></a>
The Amazon Resource Name (ARN) of the solution version.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** status **   <a name="personalize-Type-SolutionVersionSummary-status"></a>
The status of the solution version.  
A solution version can be in one of the following states:  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** trainingMode **   <a name="personalize-Type-SolutionVersionSummary-trainingMode"></a>
The scope of training to be performed when creating the solution version. A `FULL` training considers all of the data in your dataset group. An `UPDATE` processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use `UPDATE`.   
Type: String  
Valid Values: `FULL | UPDATE | AUTOTRAIN`   
Required: No

 ** trainingType **   <a name="personalize-Type-SolutionVersionSummary-trainingType"></a>
Whether the solution version was created automatically or manually.  
Type: String  
Valid Values: `AUTOMATIC | MANUAL`   
Required: No

## See Also
<a name="API_SolutionVersionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionVersionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersionSummary) 

# Tag
<a name="API_Tag"></a>

The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see [Tagging Amazon Personalize resources](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html). 

## Contents
<a name="API_Tag_Contents"></a>

 ** tagKey **   <a name="personalize-Type-Tag-tagKey"></a>
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

 ** tagValue **   <a name="personalize-Type-Tag-tagValue"></a>
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Tag) 

# ThemeGenerationConfig
<a name="API_ThemeGenerationConfig"></a>

The configuration details for generating themes with a batch inference job.

## Contents
<a name="API_ThemeGenerationConfig_Contents"></a>

 ** fieldsForThemeGeneration **   <a name="personalize-Type-ThemeGenerationConfig-fieldsForThemeGeneration"></a>
Fields used to generate descriptive themes for a batch inference job.  
Type: [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) object  
Required: Yes

## See Also
<a name="API_ThemeGenerationConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ThemeGenerationConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ThemeGenerationConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ThemeGenerationConfig) 

# TrainingDataConfig
<a name="API_TrainingDataConfig"></a>

The training data configuration to use when creating a domain recommender or custom solution version (trained model).

## Contents
<a name="API_TrainingDataConfig_Contents"></a>

 ** excludedDatasetColumns **   <a name="personalize-Type-TrainingDataConfig-excludedDatasetColumns"></a>
Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.  
 For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.   
Type: String to array of strings map  
Map Entries: Maximum number of 3 items.  
Key Length Constraints: Maximum length of 256.  
Key Pattern: `^[A-Za-z_]+$`   
Array Members: Maximum number of 50 items.  
Length Constraints: Maximum length of 150.  
Pattern: `[A-Za-z_][A-Za-z\d_]*`   
Required: No

 ** includedDatasetColumns **   <a name="personalize-Type-TrainingDataConfig-includedDatasetColumns"></a>
Specifies the columns to include from training. Each key is a dataset type, and each value is a list of columns. Include columns to control what data Amazon Personalize uses to generate recommendations.  
For example, you might have multiple columns in you items dataset but want to use only title and description for training. You can include only these two columns for training and Amazon Personalize will consider only the included columns for training.  
Type: String to array of strings map  
Map Entries: Maximum number of 3 items.  
Key Length Constraints: Maximum length of 256.  
Key Pattern: `^[A-Za-z_]+$`   
Array Members: Maximum number of 50 items.  
Length Constraints: Maximum length of 150.  
Pattern: `[A-Za-z_][A-Za-z\d_]*`   
Required: No

## See Also
<a name="API_TrainingDataConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TrainingDataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TrainingDataConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TrainingDataConfig) 

# TunedHPOParams
<a name="API_TunedHPOParams"></a>

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

## Contents
<a name="API_TunedHPOParams_Contents"></a>

 ** algorithmHyperParameters **   <a name="personalize-Type-TunedHPOParams-algorithmHyperParameters"></a>
A list of the hyperparameter values of the best performing model.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Maximum length of 256.  
Value Length Constraints: Maximum length of 1000.  
Required: No

## See Also
<a name="API_TunedHPOParams_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TunedHPOParams) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TunedHPOParams) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TunedHPOParams) 

# Amazon Personalize Events
<a name="API_Types_Amazon_Personalize_Events"></a>

The following data types are supported by Amazon Personalize Events:
+  [Action](API_UBS_Action.md) 
+  [ActionInteraction](API_UBS_ActionInteraction.md) 
+  [Event](API_UBS_Event.md) 
+  [Item](API_UBS_Item.md) 
+  [MetricAttribution](API_UBS_MetricAttribution.md) 
+  [User](API_UBS_User.md) 

# Action
<a name="API_UBS_Action"></a>

Represents action metadata added to an Action dataset using the `PutActions` API. For more information see [Importing actions individually](https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html). 

## Contents
<a name="API_UBS_Action_Contents"></a>

 ** actionId **   <a name="personalize-Type-UBS_Action-actionId"></a>
The ID associated with the action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** properties **   <a name="personalize-Type-UBS_Action-properties"></a>
A string map of action-specific metadata. Each element in the map consists of a key-value pair. For example, `{"value": "100"}`.  
The keys use camel case names that match the fields in the schema for the Actions dataset. In the previous example, the `value` matches the 'VALUE' field defined in the Actions schema. For categorical string data, to include multiple categories for a single action, separate each category with a pipe separator (`|`). For example, `\"Deluxe|Premium\"`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32000.  
Required: No

## See Also
<a name="API_UBS_Action_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Action) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Action) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Action) 

# ActionInteraction
<a name="API_UBS_ActionInteraction"></a>

Represents an action interaction event sent using the `PutActionInteractions` API.

## Contents
<a name="API_UBS_ActionInteraction_Contents"></a>

 ** actionId **   <a name="personalize-Type-UBS_ActionInteraction-actionId"></a>
The ID of the action the user interacted with. This corresponds to the `ACTION_ID` field of the Action interaction schema.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** eventType **   <a name="personalize-Type-UBS_ActionInteraction-eventType"></a>
The type of action interaction event. You can specify `Viewed`, `Taken`, and `Not Taken` event types. For more information about action interaction event type data, see [Event type data](https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-event-type-data.html).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** sessionId **   <a name="personalize-Type-UBS_ActionInteraction-sessionId"></a>
The ID associated with the user's visit. Your application generates a unique `sessionId` when a user first visits your website or uses your application.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** timestamp **   <a name="personalize-Type-UBS_ActionInteraction-timestamp"></a>
The timestamp for when the action interaction event occurred. Timestamps must be in Unix epoch time format, in seconds.  
Type: Timestamp  
Required: Yes

 ** eventId **   <a name="personalize-Type-UBS_ActionInteraction-eventId"></a>
An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** impression **   <a name="personalize-Type-UBS_ActionInteraction-impression"></a>
A list of action IDs that represents the sequence of actions you have shown the user. For example, `["actionId1", "actionId2", "actionId3"]`. Amazon Personalize doesn't use impressions data from action interaction events. Instead, record multiple events for each action and use the `Viewed` event type.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** properties **   <a name="personalize-Type-UBS_ActionInteraction-properties"></a>
A string map of event-specific data that you might choose to record. For example, if a user takes an action, other than the action ID, you might also send the number of actions taken by the user.  
Each item in the map consists of a key-value pair. For example,  
 `{"numberOfActions": "12"}`   
The keys use camel case names that match the fields in the Action interactions schema. In the above example, the `numberOfActions` would match the 'NUMBER\$1OF\$1ACTIONS' field defined in the Action interactions schema.  
 The following can't be included as a keyword for properties (case insensitive).   
+  userId 
+  sessionId 
+ eventType
+ timestamp
+ recommendationId
+ impression
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** recommendationId **   <a name="personalize-Type-UBS_ActionInteraction-recommendationId"></a>
The ID of the list of recommendations that contains the action the user interacted with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 40.  
Required: No

 ** userId **   <a name="personalize-Type-UBS_ActionInteraction-userId"></a>
The ID of the user who interacted with the action. This corresponds to the `USER_ID` field of the Action interaction schema.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_UBS_ActionInteraction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/ActionInteraction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/ActionInteraction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/ActionInteraction) 

# Event
<a name="API_UBS_Event"></a>

Represents item interaction event information sent using the `PutEvents` API.

## Contents
<a name="API_UBS_Event_Contents"></a>

 ** eventType **   <a name="personalize-Type-UBS_Event-eventType"></a>
The type of event, such as click or download. This property corresponds to the `EVENT_TYPE` field of your Item interactions dataset's schema and depends on the types of events you are tracking.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** sentAt **   <a name="personalize-Type-UBS_Event-sentAt"></a>
The timestamp (in Unix time) on the client side when the event occurred.  
Type: Timestamp  
Required: Yes

 ** eventId **   <a name="personalize-Type-UBS_Event-eventId"></a>
An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** eventValue **   <a name="personalize-Type-UBS_Event-eventValue"></a>
The event value that corresponds to the `EVENT_VALUE` field of the Item interactions schema.  
Type: Float  
Required: No

 ** impression **   <a name="personalize-Type-UBS_Event-impression"></a>
A list of item IDs that represents the sequence of items you have shown the user. For example, `["itemId1", "itemId2", "itemId3"]`. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see [Recording impressions data](https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data).   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** itemId **   <a name="personalize-Type-UBS_Event-itemId"></a>
The item ID key that corresponds to the `ITEM_ID` field of the Item interactions dataset's schema.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** metricAttribution **   <a name="personalize-Type-UBS_Event-metricAttribution"></a>
Contains information about the metric attribution associated with an event. For more information about metric attributions, see [Measuring impact of recommendations](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).  
Type: [MetricAttribution](API_UBS_MetricAttribution.md) object  
Required: No

 ** properties **   <a name="personalize-Type-UBS_Event-properties"></a>
A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (`itemId`) and rating (`eventValue`) , you might also send the number of movie ratings made by the user.  
Each item in the map consists of a key-value pair. For example,  
 `{"numberOfRatings": "12"}`   
The keys use camel case names that match the fields in the Item interactions dataset's schema. In the above example, the `numberOfRatings` would match the 'NUMBER\$1OF\$1RATINGS' field defined in the Item interactions dataset's schema.  
 The following can't be included as a keyword for properties (case insensitive).   
+  userId 
+  sessionId 
+ eventType
+ timestamp
+ recommendationId
+ impression
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** recommendationId **   <a name="personalize-Type-UBS_Event-recommendationId"></a>
The ID of the list of recommendations that contains the item the user interacted with. Provide a `recommendationId` to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a `recommendationId` if you use a metric attribution to measure the impact of recommendations.   
 For more information on recording impressions data, see [Recording impressions data](https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data). For more information on creating a metric attribution see [Measuring impact of recommendations](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 40.  
Required: No

## See Also
<a name="API_UBS_Event_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Event) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Event) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Event) 

# Item
<a name="API_UBS_Item"></a>

Represents item metadata added to an Items dataset using the `PutItems` API. For more information see [Importing items individually](https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html). 

## Contents
<a name="API_UBS_Item_Contents"></a>

 ** itemId **   <a name="personalize-Type-UBS_Item-itemId"></a>
The ID associated with the item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** properties **   <a name="personalize-Type-UBS_Item-properties"></a>
A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, `{"numberOfRatings": "12"}`.  
The keys use camel case names that match the fields in the schema for the Items dataset. In the previous example, the `numberOfRatings` matches the 'NUMBER\$1OF\$1RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (`|`). For example, `\"Horror|Action\"`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32000.  
Required: No

## See Also
<a name="API_UBS_Item_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Item) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Item) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Item) 

# MetricAttribution
<a name="API_UBS_MetricAttribution"></a>

Contains information about a metric attribution associated with an event. For more information about metric attributions, see [Measuring impact of recommendations](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html).

## Contents
<a name="API_UBS_MetricAttribution_Contents"></a>

 ** eventAttributionSource **   <a name="personalize-Type-UBS_MetricAttribution-eventAttributionSource"></a>
The source of the event, such as a third party.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^[\x20-\x7E]*[\x21-\x7E]+[\x20-\x7E]*$`   
Required: Yes

## See Also
<a name="API_UBS_MetricAttribution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/MetricAttribution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/MetricAttribution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/MetricAttribution) 

# User
<a name="API_UBS_User"></a>

Represents user metadata added to a Users dataset using the `PutUsers` API. For more information see [Importing users individually](https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html).

## Contents
<a name="API_UBS_User_Contents"></a>

 ** userId **   <a name="personalize-Type-UBS_User-userId"></a>
The ID associated with the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** properties **   <a name="personalize-Type-UBS_User-properties"></a>
A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, `{"numberOfVideosWatched": "45"}`.  
The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the `numberOfVideosWatched` matches the 'NUMBER\$1OF\$1VIDEOS\$1WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (`|`). For example, `\"Member|Frequent shopper\"`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 24000.  
Required: No

## See Also
<a name="API_UBS_User_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/User) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/User) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/User) 

# Amazon Personalize Runtime
<a name="API_Types_Amazon_Personalize_Runtime"></a>

The following data types are supported by Amazon Personalize Runtime:
+  [PredictedAction](API_RS_PredictedAction.md) 
+  [PredictedItem](API_RS_PredictedItem.md) 
+  [Promotion](API_RS_Promotion.md) 

# PredictedAction
<a name="API_RS_PredictedAction"></a>

An object that identifies an action.

The [GetActionRecommendations](API_RS_GetActionRecommendations.md) API returns a list of `PredictedAction`s.

## Contents
<a name="API_RS_PredictedAction_Contents"></a>

 ** actionId **   <a name="personalize-Type-RS_PredictedAction-actionId"></a>
The ID of the recommended action.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** score **   <a name="personalize-Type-RS_PredictedAction-score"></a>
The score of the recommended action. For information about action scores, see [How action recommendation scoring works](https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html).  
Type: Double  
Required: No

## See Also
<a name="API_RS_PredictedAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedAction) 

# PredictedItem
<a name="API_RS_PredictedItem"></a>

An object that identifies an item.

The [GetRecommendations](API_RS_GetRecommendations.md) and [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) APIs return a list of `PredictedItem`s.

## Contents
<a name="API_RS_PredictedItem_Contents"></a>

 ** itemId **   <a name="personalize-Type-RS_PredictedItem-itemId"></a>
The recommended item ID.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** metadata **   <a name="personalize-Type-RS_PredictedItem-metadata"></a>
Metadata about the item from your Items dataset.  
Type: String to string map  
Key Length Constraints: Maximum length of 150.  
Value Length Constraints: Maximum length of 20000.  
Required: No

 ** promotionName **   <a name="personalize-Type-RS_PredictedItem-promotionName"></a>
The name of the promotion that included the predicted item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** reason **   <a name="personalize-Type-RS_PredictedItem-reason"></a>
If you use User-Personalization-v2, a list of reasons for why the item was included in recommendations. Possible reasons include the following:  
+ Promoted item - Indicates the item was included as part of a promotion that you applied in your recommendation request.
+ Exploration - Indicates the item was included with exploration. With exploration, recommendations include items with less interactions data or relevance for the user. For more information about exploration, see [Exploration](https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#about-exploration).
+  Popular item - Indicates the item was included as a placeholder popular item. If you use a filter, depending on how many recommendations the filter removes, Amazon Personalize might add placeholder items to meet the `numResults` for your recommendation request. These items are popular items, based on interactions data, that satisfy your filter criteria. They don't have a relevance score for the user. 
Type: Array of strings  
Length Constraints: Maximum length of 256.  
Required: No

 ** score **   <a name="personalize-Type-RS_PredictedItem-score"></a>
A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see [Recommendation scores](getting-recommendations.md#how-scores-work).  
Type: Double  
Required: No

## See Also
<a name="API_RS_PredictedItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedItem) 

# Promotion
<a name="API_RS_Promotion"></a>

Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.

## Contents
<a name="API_RS_Promotion_Contents"></a>

 ** filterArn **   <a name="personalize-Type-RS_Promotion-filterArn"></a>
The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see [Promotion filters](https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters).  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Required: No

 ** filterValues **   <a name="personalize-Type-RS_Promotion-filterValues"></a>
The values to use when promoting items. For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.   
For filter expressions that use an `INCLUDE` element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an `EXCLUDE` element to exclude items, you can omit the `filter-values`. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.  
For more information on creating filters, see [Filtering recommendations and user segments](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Type: String to string map  
Map Entries: Maximum number of 25 items.  
Key Length Constraints: Maximum length of 50.  
Key Pattern: `[A-Za-z0-9_]+`   
Value Length Constraints: Maximum length of 1000.  
Required: No

 ** name **   <a name="personalize-Type-RS_Promotion-name"></a>
The name of the promotion.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** percentPromotedItems **   <a name="personalize-Type-RS_Promotion-percentPromotedItems"></a>
The percentage of recommended items to apply the promotion to.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

## See Also
<a name="API_RS_Promotion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/Promotion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/Promotion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/Promotion)