Amazonka.Personalize.DescribeRecommender

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

See: newDescribeRecommender smart constructor.

Constructors

DescribeRecommender'

Fields

• recommenderArn :: Text

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

Instances

ToJSON DescribeRecommender

Defined in Amazonka.Personalize.DescribeRecommender

Methods

toJSON :: DescribeRecommender -> Value

toEncoding :: DescribeRecommender -> Encoding

toJSONList :: [DescribeRecommender] -> Value

toEncodingList :: [DescribeRecommender] -> Encoding

ToHeaders DescribeRecommender

Defined in Amazonka.Personalize.DescribeRecommender

Methods

toHeaders :: DescribeRecommender -> [Header]

ToPath DescribeRecommender

Defined in Amazonka.Personalize.DescribeRecommender

Methods

toPath :: DescribeRecommender -> ByteString

ToQuery DescribeRecommender

Defined in Amazonka.Personalize.DescribeRecommender

Methods

toQuery :: DescribeRecommender -> QueryString

AWSRequest DescribeRecommender

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

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

Defined in Amazonka.Personalize.DescribeRecommender

Methods

readsPrec :: Int -> ReadS DescribeRecommender

readList :: ReadS [DescribeRecommender]

readPrec :: ReadPrec DescribeRecommender

readListPrec :: ReadPrec [DescribeRecommender]

Show DescribeRecommender

Defined in Amazonka.Personalize.DescribeRecommender

Methods

showsPrec :: Int -> DescribeRecommender -> ShowS

show :: DescribeRecommender -> String

showList :: [DescribeRecommender] -> ShowS

NFData DescribeRecommender

Defined in Amazonka.Personalize.DescribeRecommender

Methods

rnf :: DescribeRecommender -> ()

Eq DescribeRecommender

Defined in Amazonka.Personalize.DescribeRecommender

Methods

(==) :: DescribeRecommender -> DescribeRecommender -> Bool

(/=) :: DescribeRecommender -> DescribeRecommender -> Bool

Hashable DescribeRecommender

Defined in Amazonka.Personalize.DescribeRecommender

Methods

hashWithSalt :: Int -> DescribeRecommender -> Int

hash :: DescribeRecommender -> Int

type AWSResponse DescribeRecommender

Defined in Amazonka.Personalize.DescribeRecommender

type AWSResponse DescribeRecommender = DescribeRecommenderResponse

type Rep DescribeRecommender

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

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

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

Destructuring the Response

data DescribeRecommenderResponse

See: newDescribeRecommenderResponse smart constructor.

Constructors

DescribeRecommenderResponse'

Fields

• recommender :: Maybe Recommender

  The properties of the recommender.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeRecommenderResponse

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

Defined in Amazonka.Personalize.DescribeRecommender

Methods

readsPrec :: Int -> ReadS DescribeRecommenderResponse

readList :: ReadS [DescribeRecommenderResponse]

readPrec :: ReadPrec DescribeRecommenderResponse

readListPrec :: ReadPrec [DescribeRecommenderResponse]

Show DescribeRecommenderResponse

Defined in Amazonka.Personalize.DescribeRecommender

Methods

showsPrec :: Int -> DescribeRecommenderResponse -> ShowS

show :: DescribeRecommenderResponse -> String

showList :: [DescribeRecommenderResponse] -> ShowS

NFData DescribeRecommenderResponse

Defined in Amazonka.Personalize.DescribeRecommender

Methods

rnf :: DescribeRecommenderResponse -> ()

Eq DescribeRecommenderResponse

Defined in Amazonka.Personalize.DescribeRecommender

Methods

(==) :: DescribeRecommenderResponse -> DescribeRecommenderResponse -> Bool

(/=) :: DescribeRecommenderResponse -> DescribeRecommenderResponse -> Bool

type Rep DescribeRecommenderResponse

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

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)

The properties of the recommender.

describeRecommenderResponse_httpStatus :: Lens' DescribeRecommenderResponse Int

The response's http status code.