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	awscc.personalize.solutions

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
solution_arn	string	The ARN of the solution
region	string	AWS region.

For more information, see AWS::Personalize::Solution.

Methods

Name	Resource	Accessible by	Required Params
create_resource	solutions	INSERT	Name, DatasetGroupArn, region
delete_resource	solutions	DELETE	Identifier, region
list_resources	solutions_list_only	SELECT	region
get_resource	solutions	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.personalize.solutions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ solution_arn }}';

list (identifiers only)

Lists all solutions in a region.

SELECT
  region,
  solution_arn
FROM awscc.personalize.solutions_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.personalize.solutions (
  Name,
  EventType,
  DatasetGroupArn,
  PerformAutoML,
  PerformHPO,
  RecipeArn,
  SolutionConfig,
  region
)
SELECT
  '{{ name }}',
  '{{ event_type }}',
  '{{ dataset_group_arn }}',
  '{{ perform_auto_ml }}',
  '{{ perform_hpo }}',
  '{{ recipe_arn }}',
  '{{ solution_config }}',
  '{{ 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: event_type
        value: '{{ event_type }}'
      - name: dataset_group_arn
        value: '{{ dataset_group_arn }}'
      - name: perform_auto_ml
        value: '{{ perform_auto_ml }}'
      - name: perform_hpo
        value: '{{ perform_hpo }}'
      - name: recipe_arn
        value: '{{ recipe_arn }}'
      - name: solution_config
        value:
          algorithm_hyper_parameters: {}
          auto_ml_config:
            metric_name: '{{ metric_name }}'
            recipe_list:
              - '{{ recipe_list[0] }}'
          event_value_threshold: '{{ event_value_threshold }}'
          feature_transformation_parameters: {}
          hpo_config:
            algorithm_hyper_parameter_ranges:
              categorical_hyper_parameter_ranges:
                - name: '{{ name }}'
                  values:
                    - '{{ values[0] }}'
              continuous_hyper_parameter_ranges:
                - name: '{{ name }}'
                  min_value: null
                  max_value: null
              integer_hyper_parameter_ranges:
                - name: '{{ name }}'
                  min_value: '{{ min_value }}'
                  max_value: '{{ max_value }}'
            hpo_objective:
              metric_name: '{{ metric_name }}'
              type: '{{ type }}'
              metric_regex: '{{ metric_regex }}'
            hpo_resource_config:
              max_number_of_training_jobs: '{{ max_number_of_training_jobs }}'
              max_parallel_training_jobs: '{{ max_parallel_training_jobs }}'

DELETE example

/*+ delete */
DELETE FROM awscc.personalize.solutions
WHERE
  Identifier = '{{ solution_arn }}' 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