amazonka-personalize-2.0: Amazon Personalize SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Personalize.Types.RecommenderSummary

Description

 
Synopsis

Documentation

data RecommenderSummary Source #

Provides a summary of the properties of the recommender.

See: newRecommenderSummary smart constructor.

Constructors

RecommenderSummary' 

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.

  • lastUpdatedDateTime :: Maybe POSIX

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

  • 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 RecommenderSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.RecommenderSummary

Methods

parseJSON :: Value -> Parser RecommenderSummary #

parseJSONList :: Value -> Parser [RecommenderSummary] #

Generic RecommenderSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.RecommenderSummary

Associated Types

type Rep RecommenderSummary :: Type -> Type #

Methods

from :: RecommenderSummary -> Rep RecommenderSummary x #

to :: Rep RecommenderSummary x -> RecommenderSummary #

Read RecommenderSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.RecommenderSummary

Methods

readsPrec :: Int -> ReadS RecommenderSummary #

readList :: ReadS [RecommenderSummary] #

readPrec :: ReadPrec RecommenderSummary #

readListPrec :: ReadPrec [RecommenderSummary] #

Show RecommenderSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.RecommenderSummary

Methods

showsPrec :: Int -> RecommenderSummary -> ShowS #

show :: RecommenderSummary -> String #

showList :: [RecommenderSummary] -> ShowS #

NFData RecommenderSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.RecommenderSummary

Methods

rnf :: RecommenderSummary -> () #

Eq RecommenderSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.RecommenderSummary

Methods

(==) :: RecommenderSummary -> RecommenderSummary -> Bool #

(/=) :: RecommenderSummary -> RecommenderSummary -> Bool #

Hashable RecommenderSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.RecommenderSummary

Methods

hashWithSalt :: Int -> RecommenderSummary -> Int #

hash :: RecommenderSummary -> Int #

type Rep RecommenderSummary Source # 
Instance details

Defined in Amazonka.Personalize.Types.RecommenderSummary

type Rep RecommenderSummary = D1 ('MetaData "RecommenderSummary" "Amazonka.Personalize.Types.RecommenderSummary" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "RecommenderSummary'" '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 "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: 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))))))

newRecommenderSummary :: RecommenderSummary Source #

Create a value of RecommenderSummary 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:

$sel:creationDateTime:RecommenderSummary', recommenderSummary_creationDateTime - The date and time (in Unix format) that the recommender was created.

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

$sel:lastUpdatedDateTime:RecommenderSummary', recommenderSummary_lastUpdatedDateTime - The date and time (in Unix format) that the recommender was last updated.

$sel:name:RecommenderSummary', recommenderSummary_name - The name of the recommender.

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

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

$sel:recommenderConfig:RecommenderSummary', recommenderSummary_recommenderConfig - The configuration details of the recommender.

$sel:status:RecommenderSummary', recommenderSummary_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

recommenderSummary_creationDateTime :: Lens' RecommenderSummary (Maybe UTCTime) Source #

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

recommenderSummary_datasetGroupArn :: Lens' RecommenderSummary (Maybe Text) Source #

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

recommenderSummary_lastUpdatedDateTime :: Lens' RecommenderSummary (Maybe UTCTime) Source #

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

recommenderSummary_name :: Lens' RecommenderSummary (Maybe Text) Source #

The name of the recommender.

recommenderSummary_recipeArn :: Lens' RecommenderSummary (Maybe Text) Source #

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

recommenderSummary_recommenderArn :: Lens' RecommenderSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the recommender.

recommenderSummary_recommenderConfig :: Lens' RecommenderSummary (Maybe RecommenderConfig) Source #

The configuration details of the recommender.

recommenderSummary_status :: Lens' RecommenderSummary (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