AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Personalize CreateSolution API operation.

Syntax

New-PERSSolution
-Name <String>
-SolutionConfig_AlgorithmHyperParameter <Hashtable>
-AlgorithmHyperParameterRanges_CategoricalHyperParameterRange <CategoricalHyperParameterRange[]>
-AlgorithmHyperParameterRanges_ContinuousHyperParameterRange <ContinuousHyperParameterRange[]>
-DatasetGroupArn <String>
-EventsConfig_EventParametersList <EventParameters[]>
-EventType <String>
-SolutionConfig_EventValueThreshold <String>
-TrainingDataConfig_ExcludedDatasetColumn <Hashtable>
-SolutionConfig_FeatureTransformationParameter <Hashtable>
-AlgorithmHyperParameterRanges_IntegerHyperParameterRange <IntegerHyperParameterRange[]>
-OptimizationObjective_ItemAttribute <String>
-HpoResourceConfig_MaxNumberOfTrainingJob <String>
-HpoResourceConfig_MaxParallelTrainingJob <String>
-AutoMLConfig_MetricName <String>
-HpoObjective_MetricName <String>
-HpoObjective_MetricRegex <String>
-OptimizationObjective_ObjectiveSensitivity <ObjectiveSensitivity>
-PerformAutoML <Boolean>
-PerformAutoTraining <Boolean>
-PerformHPO <Boolean>
-RecipeArn <String>
-AutoMLConfig_RecipeList <String[]>
-AutoTrainingConfig_SchedulingExpression <String>
-Tag <Tag[]>
-HpoObjective_Type <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPersonalizeConfig>

Description

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 to turn off automatic training. For information about training costs, see Amazon Personalize pricing. Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution. By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training. To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation. After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion. After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API. Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time. Status A solution can be in one of the following states:
  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion. Related APIs

Parameters

-AlgorithmHyperParameterRanges_CategoricalHyperParameterRange <CategoricalHyperParameterRange[]>
The categorical hyperparameters and their ranges. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_HpoConfig_AlgorithmHyperParameterRanges_CategoricalHyperParameterRanges
-AlgorithmHyperParameterRanges_ContinuousHyperParameterRange <ContinuousHyperParameterRange[]>
The continuous hyperparameters and their ranges. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_HpoConfig_AlgorithmHyperParameterRanges_ContinuousHyperParameterRanges
-AlgorithmHyperParameterRanges_IntegerHyperParameterRange <IntegerHyperParameterRange[]>
The integer-valued hyperparameters and their ranges. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_HpoConfig_AlgorithmHyperParameterRanges_IntegerHyperParameterRanges
-AutoMLConfig_MetricName <String>
The metric to optimize.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_AutoMLConfig_MetricName
-AutoMLConfig_RecipeList <String[]>
The list of candidate recipes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_AutoMLConfig_RecipeList
-AutoTrainingConfig_SchedulingExpression <String>
Specifies how often to automatically train new solution versions. Specify a rate expression in rate(valueunit) 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_AutoTrainingConfig_SchedulingExpression
-ClientConfig <AmazonPersonalizeConfig>
Amazon.PowerShell.Cmdlets.PERS.AmazonPersonalizeClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatasetGroupArn <String>
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EventsConfig_EventParametersList <EventParameters[]>
A list of event parameters, which includes event types and their event value thresholds and weights. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_EventsConfig_EventParametersList
-EventType <String>
When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HpoObjective_MetricName <String>
The name of the metric.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_HpoConfig_HpoObjective_MetricName
-HpoObjective_MetricRegex <String>
A regular expression for finding the metric in the training job logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_HpoConfig_HpoObjective_MetricRegex
-HpoObjective_Type <String>
The type of the metric. Valid values are Maximize and Minimize.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_HpoConfig_HpoObjective_Type
-HpoResourceConfig_MaxNumberOfTrainingJob <String>
The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_HpoConfig_HpoResourceConfig_MaxNumberOfTrainingJobs
-HpoResourceConfig_MaxParallelTrainingJob <String>
The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_HpoConfig_HpoResourceConfig_MaxParallelTrainingJobs
-Name <String>
The name for the solution.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-OptimizationObjective_ItemAttribute <String>
The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_OptimizationObjective_ItemAttribute
-OptimizationObjective_ObjectiveSensitivity <ObjectiveSensitivity>
Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_OptimizationObjective_ObjectiveSensitivity
-PerformAutoML <Boolean>
We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Choosing a recipe.Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformAutoTraining <Boolean>
Whether the solution uses automatic training to create new solution versions (trained models). The default is True and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration. For more information about automatic training, see Configuring automatic training. Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerformHPO <Boolean>
Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.When performing AutoML, this parameter is always true and you should not set it to false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecipeArn <String>
The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when performAutoML is false. For information about different Amazon Personalize recipes and their ARNs, see Choosing a recipe.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'SolutionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateSolutionResponse). Specifying the name of a property of type Amazon.Personalize.Model.CreateSolutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SolutionConfig_AlgorithmHyperParameter <Hashtable>
Lists the algorithm hyperparameters and their values. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_AlgorithmHyperParameters
-SolutionConfig_EventValueThreshold <String>
Only events with a value greater than or equal to this threshold are used for training a model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SolutionConfig_FeatureTransformationParameter <Hashtable>
Lists the feature transformation parameters. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_FeatureTransformationParameters
-Tag <Tag[]>
A list of tags to apply to the solution. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TrainingDataConfig_ExcludedDatasetColumn <Hashtable>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSolutionConfig_TrainingDataConfig_ExcludedDatasetColumns

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.Personalize.Model.CreateSolutionResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Personalize.Model.CreateSolutionResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z