Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Personalize.Types.Recommender

Description

Synopsis

data Recommender = Recommender' {
- creationDateTime :: Maybe POSIX
- datasetGroupArn :: Maybe Text
- failureReason :: Maybe Text
- lastUpdatedDateTime :: Maybe POSIX
- latestRecommenderUpdate :: Maybe RecommenderUpdateSummary
- modelMetrics :: Maybe (HashMap Text Double)
- name :: Maybe Text
- recipeArn :: Maybe Text
- recommenderArn :: Maybe Text
- recommenderConfig :: Maybe RecommenderConfig
- status :: Maybe Text
}
newRecommender :: Recommender
recommender_creationDateTime :: Lens' Recommender (Maybe UTCTime)
recommender_datasetGroupArn :: Lens' Recommender (Maybe Text)
recommender_failureReason :: Lens' Recommender (Maybe Text)
recommender_lastUpdatedDateTime :: Lens' Recommender (Maybe UTCTime)
recommender_latestRecommenderUpdate :: Lens' Recommender (Maybe RecommenderUpdateSummary)
recommender_modelMetrics :: Lens' Recommender (Maybe (HashMap Text Double))
recommender_name :: Lens' Recommender (Maybe Text)
recommender_recipeArn :: Lens' Recommender (Maybe Text)
recommender_recommenderArn :: Lens' Recommender (Maybe Text)
recommender_recommenderConfig :: Lens' Recommender (Maybe RecommenderConfig)
recommender_status :: Lens' Recommender (Maybe Text)

Documentation

data Recommender Source #

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.

See: newRecommender smart constructor.

Constructors

Recommender'

Fields

creationDateTime :: Maybe POSIX
The date and time (in Unix format) that the recommender was created.
datasetGroupArn :: Maybe Text
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
failureReason :: Maybe Text
If a recommender fails, the reason behind the failure.
lastUpdatedDateTime :: Maybe POSIX
The date and time (in Unix format) that the recommender was last updated.
latestRecommenderUpdate :: Maybe RecommenderUpdateSummary
Provides a summary of the latest updates to the recommender.
modelMetrics :: Maybe (HashMap Text Double)
Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.
name :: Maybe Text
The name of the recommender.
recipeArn :: Maybe Text
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
recommenderArn :: Maybe Text
The Amazon Resource Name (ARN) of the recommender.
recommenderConfig :: Maybe RecommenderConfig
The configuration details of the recommender.
status :: Maybe Text
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

Instances

Instances details

FromJSON Recommender Source #
Instance details Defined in Amazonka.Personalize.Types.Recommender Methods parseJSON :: Value -> Parser Recommender # parseJSONList :: Value -> Parser [Recommender] #
Generic Recommender Source #
Instance details Defined in Amazonka.Personalize.Types.Recommender Associated Types type Rep Recommender :: Type -> Type # Methods from :: Recommender -> Rep Recommender x # to :: Rep Recommender x -> Recommender #
Read Recommender Source #
Instance details Defined in Amazonka.Personalize.Types.Recommender Methods readsPrec :: Int -> ReadS Recommender # readList :: ReadS [Recommender] # readPrec :: ReadPrec Recommender # readListPrec :: ReadPrec [Recommender] #
Show Recommender Source #
Instance details Defined in Amazonka.Personalize.Types.Recommender Methods showsPrec :: Int -> Recommender -> ShowS # show :: Recommender -> String # showList :: [Recommender] -> ShowS #
NFData Recommender Source #
Instance details Defined in Amazonka.Personalize.Types.Recommender Methods rnf :: Recommender -> () #
Eq Recommender Source #
Instance details Defined in Amazonka.Personalize.Types.Recommender Methods (==) :: Recommender -> Recommender -> Bool # (/=) :: Recommender -> Recommender -> Bool #
Hashable Recommender Source #
Instance details Defined in Amazonka.Personalize.Types.Recommender Methods hashWithSalt :: Int -> Recommender -> Int # hash :: Recommender -> Int #
type Rep Recommender Source #
Instance details Defined in Amazonka.Personalize.Types.Recommender type Rep Recommender = D1 ('MetaData "Recommender" "Amazonka.Personalize.Types.Recommender" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "Recommender'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "latestRecommenderUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommenderUpdateSummary))))) :: ((S1 ('MetaSel ('Just "modelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Double))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "recipeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "recommenderArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "recommenderConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommenderConfig)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newRecommender :: Recommender Source #

Create a value of Recommender with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

Recommender, recommender_creationDateTime - The date and time (in Unix format) that the recommender was created.

$sel:datasetGroupArn:Recommender', recommender_datasetGroupArn - The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

Recommender, recommender_failureReason - If a recommender fails, the reason behind the failure.

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

$sel:latestRecommenderUpdate:Recommender', recommender_latestRecommenderUpdate - Provides a summary of the latest updates to the recommender.

$sel:modelMetrics:Recommender', recommender_modelMetrics - Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

$sel:name:Recommender', recommender_name - The name of the recommender.

$sel:recipeArn:Recommender', recommender_recipeArn - The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

$sel:recommenderArn:Recommender', recommender_recommenderArn - The Amazon Resource Name (ARN) of the recommender.

Recommender, recommender_recommenderConfig - The configuration details of the recommender.

Recommender, 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

recommender_creationDateTime :: Lens' Recommender (Maybe UTCTime) Source #

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

recommender_datasetGroupArn :: Lens' Recommender (Maybe Text) Source #

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

recommender_failureReason :: Lens' Recommender (Maybe Text) Source #

If a recommender fails, the reason behind the failure.

recommender_lastUpdatedDateTime :: Lens' Recommender (Maybe UTCTime) Source #

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

recommender_latestRecommenderUpdate :: Lens' Recommender (Maybe RecommenderUpdateSummary) Source #

Provides a summary of the latest updates to the recommender.

recommender_modelMetrics :: Lens' Recommender (Maybe (HashMap Text Double)) Source #

Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

recommender_name :: Lens' Recommender (Maybe Text) Source #

The name of the recommender.

recommender_recipeArn :: Lens' Recommender (Maybe Text) Source #

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

recommender_recommenderArn :: Lens' Recommender (Maybe Text) Source #

The Amazon Resource Name (ARN) of the recommender.

recommender_recommenderConfig :: Lens' Recommender (Maybe RecommenderConfig) Source #

The configuration details of the recommender.

recommender_status :: Lens' Recommender (Maybe Text) Source #

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