Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Personalize.DescribeRecipe

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a recipe.

A recipe contains three items:

An algorithm that trains a model.
Hyperparameters that govern the training.
Feature transformation information for modifying the input data before training.

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

Creating a Request

data DescribeRecipe Source #

See: newDescribeRecipe smart constructor.

Constructors

DescribeRecipe'
Fields recipeArn :: Text The Amazon Resource Name (ARN) of the recipe to describe.

Instances

Instances details

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

newDescribeRecipe Source #

Arguments

:: Text	`$sel:recipeArn:DescribeRecipe'`
-> DescribeRecipe

Create a value of DescribeRecipe 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:recipeArn:DescribeRecipe', describeRecipe_recipeArn - The Amazon Resource Name (ARN) of the recipe to describe.

Request Lenses

describeRecipe_recipeArn :: Lens' DescribeRecipe Text Source #

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

Destructuring the Response

data DescribeRecipeResponse Source #

See: newDescribeRecipeResponse smart constructor.

Constructors

DescribeRecipeResponse'
Fields recipe :: Maybe Recipe An object that describes the recipe. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeRecipeResponse Source #

Arguments

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

Create a value of DescribeRecipeResponse 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:recipe:DescribeRecipeResponse', describeRecipeResponse_recipe - An object that describes the recipe.

$sel:httpStatus:DescribeRecipeResponse', describeRecipeResponse_httpStatus - The response's http status code.

Response Lenses

describeRecipeResponse_recipe :: Lens' DescribeRecipeResponse (Maybe Recipe) Source #

An object that describes the recipe.

describeRecipeResponse_httpStatus :: Lens' DescribeRecipeResponse Int Source #

The response's http status code.