solutions

Creates, updates, deletes or gets a solution resource or lists solutions in a region

Overview

Name	solutions
Type	Resource
Description	Resource schema for AWS::Personalize::Solution.
Id	aws.personalize.solutions

Fields

Name	Datatype	Description
name	string	The name for the solution
solution_arn	string	The ARN of the solution
event_type	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.
dataset_group_arn	string	The ARN of the dataset group that provides the training data.
perform_auto_ml	boolean	Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.
perform_hpo	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.
recipe_arn	string	The ARN of the recipe to use for model training. Only specified when performAutoML is false.
solution_config	object	The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, DatasetGroupArn, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all solutions in a region.

SELECT
region,
name,
solution_arn,
event_type,
dataset_group_arn,
perform_auto_ml,
perform_hpo,
recipe_arn,
solution_config
FROM aws.personalize.solutions
WHERE region = 'us-east-1';

Gets all properties from an individual solution.

SELECT
region,
name,
solution_arn,
event_type,
dataset_group_arn,
perform_auto_ml,
perform_hpo,
recipe_arn,
solution_config
FROM aws.personalize.solutions
WHERE region = 'us-east-1' AND data__Identifier = '<SolutionArn>';

INSERT example

Use the following StackQL query and manifest file to create a new solution resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.personalize.solutions (
 Name,
 DatasetGroupArn,
 region
)
SELECT 
'{{ Name }}',
 '{{ DatasetGroupArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.personalize.solutions (
 Name,
 EventType,
 DatasetGroupArn,
 PerformAutoML,
 PerformHPO,
 RecipeArn,
 SolutionConfig,
 region
)
SELECT 
 '{{ Name }}',
 '{{ EventType }}',
 '{{ DatasetGroupArn }}',
 '{{ PerformAutoML }}',
 '{{ PerformHPO }}',
 '{{ RecipeArn }}',
 '{{ SolutionConfig }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: solution
    props:
      - name: Name
        value: '{{ Name }}'
      - name: EventType
        value: '{{ EventType }}'
      - name: DatasetGroupArn
        value: '{{ DatasetGroupArn }}'
      - name: PerformAutoML
        value: '{{ PerformAutoML }}'
      - name: PerformHPO
        value: '{{ PerformHPO }}'
      - name: RecipeArn
        value: '{{ RecipeArn }}'
      - name: SolutionConfig
        value:
          AlgorithmHyperParameters: {}
          AutoMLConfig:
            MetricName: '{{ MetricName }}'
            RecipeList:
              - '{{ RecipeList[0] }}'
          EventValueThreshold: '{{ EventValueThreshold }}'
          FeatureTransformationParameters: {}
          HpoConfig:
            AlgorithmHyperParameterRanges:
              CategoricalHyperParameterRanges:
                - Name: '{{ Name }}'
                  Values:
                    - '{{ Values[0] }}'
              ContinuousHyperParameterRanges:
                - Name: '{{ Name }}'
                  MinValue: null
                  MaxValue: null
              IntegerHyperParameterRanges:
                - Name: '{{ Name }}'
                  MinValue: '{{ MinValue }}'
                  MaxValue: '{{ MaxValue }}'
            HpoObjective:
              MetricName: '{{ MetricName }}'
              Type: '{{ Type }}'
              MetricRegex: '{{ MetricRegex }}'
            HpoResourceConfig:
              MaxNumberOfTrainingJobs: '{{ MaxNumberOfTrainingJobs }}'
              MaxParallelTrainingJobs: '{{ MaxParallelTrainingJobs }}'

DELETE example

/*+ delete */
DELETE FROM aws.personalize.solutions
WHERE data__Identifier = '<SolutionArn>'
AND region = 'us-east-1';

Permissions

To operate on the solutions resource, the following permissions are required:

Create

personalize:CreateSolution,
personalize:DescribeSolution

Read

personalize:DescribeSolution

Delete

personalize:DeleteSolution,
personalize:DescribeSolution

List

personalize:ListSolutions