AWS::Personalize::Recommender - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Personalize::Recommender

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 request.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Personalize::Recommender",
  "Properties" : {
      "DatasetGroupArn" : String,
      "Name" : String,
      "RecipeArn" : String,
      "RecommenderConfig" : RecommenderConfig,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Personalize::Recommender
Properties:
  DatasetGroupArn: String
  Name: String
  RecipeArn: String
  RecommenderConfig: 
    RecommenderConfig
  Tags: 
    - Tag

Properties

DatasetGroupArn

The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

Required: Yes

Type: String

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Maximum: 256

Update requires: Replacement

Name

The name of the recommender.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*$

Minimum: 1

Maximum: 63

Update requires: Replacement

RecipeArn

The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

Required: Yes

Type: String

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Maximum: 256

Update requires: Replacement

RecommenderConfig

The configuration details of the recommender.

Required: No

Type: RecommenderConfig

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreationDateTime

The date and time (in Unix format) that the recommender was created.

LastUpdatedDateTime

The date and time (in Unix format) that the recommender was last updated.

RecommenderArn

The Amazon Resource Name (ARN) of the recommender.

Status

The status of the recommender.

A recommender can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

  • DELETE PENDING > DELETE IN_PROGRESS