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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the given recommender, including its status.

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

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

The modelMetrics key is null when the recommender is being created or deleted.

For more information on recommenders, see CreateRecommender.

Creating a Request

data DescribeRecommender Source #

See: newDescribeRecommender smart constructor.

Constructors

DescribeRecommender'
Fields recommenderArn :: Text The Amazon Resource Name (ARN) of the recommender to describe.

Instances

Instances details

ToJSON DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods toJSON :: DescribeRecommender -> Value # toEncoding :: DescribeRecommender -> Encoding # toJSONList :: [DescribeRecommender] -> Value # toEncodingList :: [DescribeRecommender] -> Encoding #
ToHeaders DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods toHeaders :: DescribeRecommender -> [Header] #
ToPath DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods toPath :: DescribeRecommender -> ByteString #
ToQuery DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods toQuery :: DescribeRecommender -> QueryString #
AWSRequest DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Associated Types type AWSResponse DescribeRecommender # Methods request :: (Service -> Service) -> DescribeRecommender -> Request DescribeRecommender # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeRecommender -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRecommender))) #
Generic DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Associated Types type Rep DescribeRecommender :: Type -> Type # Methods from :: DescribeRecommender -> Rep DescribeRecommender x # to :: Rep DescribeRecommender x -> DescribeRecommender #
Read DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods readsPrec :: Int -> ReadS DescribeRecommender # readList :: ReadS [DescribeRecommender] # readPrec :: ReadPrec DescribeRecommender # readListPrec :: ReadPrec [DescribeRecommender] #
Show DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods showsPrec :: Int -> DescribeRecommender -> ShowS # show :: DescribeRecommender -> String # showList :: [DescribeRecommender] -> ShowS #
NFData DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods rnf :: DescribeRecommender -> () #
Eq DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods (==) :: DescribeRecommender -> DescribeRecommender -> Bool # (/=) :: DescribeRecommender -> DescribeRecommender -> Bool #
Hashable DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods hashWithSalt :: Int -> DescribeRecommender -> Int # hash :: DescribeRecommender -> Int #
type AWSResponse DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender type AWSResponse DescribeRecommender = DescribeRecommenderResponse
type Rep DescribeRecommender Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender type Rep DescribeRecommender = D1 ('MetaData "DescribeRecommender" "Amazonka.Personalize.DescribeRecommender" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "DescribeRecommender'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recommenderArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeRecommender Source #

Arguments

:: Text	`DescribeRecommender`
-> DescribeRecommender

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

DescribeRecommender, describeRecommender_recommenderArn - The Amazon Resource Name (ARN) of the recommender to describe.

Request Lenses

describeRecommender_recommenderArn :: Lens' DescribeRecommender Text Source #

The Amazon Resource Name (ARN) of the recommender to describe.

Destructuring the Response

data DescribeRecommenderResponse Source #

See: newDescribeRecommenderResponse smart constructor.

Constructors

DescribeRecommenderResponse'
Fields recommender :: Maybe Recommender The properties of the recommender. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeRecommenderResponse Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Associated Types type Rep DescribeRecommenderResponse :: Type -> Type # Methods from :: DescribeRecommenderResponse -> Rep DescribeRecommenderResponse x # to :: Rep DescribeRecommenderResponse x -> DescribeRecommenderResponse #
Read DescribeRecommenderResponse Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods readsPrec :: Int -> ReadS DescribeRecommenderResponse # readList :: ReadS [DescribeRecommenderResponse] # readPrec :: ReadPrec DescribeRecommenderResponse # readListPrec :: ReadPrec [DescribeRecommenderResponse] #
Show DescribeRecommenderResponse Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods showsPrec :: Int -> DescribeRecommenderResponse -> ShowS # show :: DescribeRecommenderResponse -> String # showList :: [DescribeRecommenderResponse] -> ShowS #
NFData DescribeRecommenderResponse Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods rnf :: DescribeRecommenderResponse -> () #
Eq DescribeRecommenderResponse Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender Methods (==) :: DescribeRecommenderResponse -> DescribeRecommenderResponse -> Bool # (/=) :: DescribeRecommenderResponse -> DescribeRecommenderResponse -> Bool #
type Rep DescribeRecommenderResponse Source #
Instance details Defined in Amazonka.Personalize.DescribeRecommender type Rep DescribeRecommenderResponse = D1 ('MetaData "DescribeRecommenderResponse" "Amazonka.Personalize.DescribeRecommender" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "DescribeRecommenderResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recommender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Recommender)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeRecommenderResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeRecommenderResponse'`
-> DescribeRecommenderResponse

Create a value of DescribeRecommenderResponse 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:recommender:DescribeRecommenderResponse', describeRecommenderResponse_recommender - The properties of the recommender.

$sel:httpStatus:DescribeRecommenderResponse', describeRecommenderResponse_httpStatus - The response's http status code.

Response Lenses

describeRecommenderResponse_recommender :: Lens' DescribeRecommenderResponse (Maybe Recommender) Source #

The properties of the recommender.

describeRecommenderResponse_httpStatus :: Lens' DescribeRecommenderResponse Int Source #

The response's http status code.