Amazonka.Personalize.ListRecipes

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

This operation returns paginated results.

Creating a Request

data ListRecipes

See: newListRecipes smart constructor.

Constructors

ListRecipes'

Fields

• domain :: Maybe Domain

  Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.

• maxResults :: Maybe Natural

  The maximum number of recipes to return.

• nextToken :: Maybe Text

  A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

• recipeProvider :: Maybe RecipeProvider

  The default is SERVICE.

Instances

ToJSON ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Methods

toJSON :: ListRecipes -> Value

toEncoding :: ListRecipes -> Encoding

toJSONList :: [ListRecipes] -> Value

toEncodingList :: [ListRecipes] -> Encoding

ToHeaders ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Methods

toHeaders :: ListRecipes -> [Header]

ToPath ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Methods

toPath :: ListRecipes -> ByteString

ToQuery ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Methods

toQuery :: ListRecipes -> QueryString

AWSPager ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Methods

page :: ListRecipes -> AWSResponse ListRecipes -> Maybe ListRecipes

AWSRequest ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Associated Types

type AWSResponse ListRecipes

Methods

request :: (Service -> Service) -> ListRecipes -> Request ListRecipes

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRecipes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRecipes)))

Generic ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Associated Types

type Rep ListRecipes :: Type -> Type

Methods

from :: ListRecipes -> Rep ListRecipes x

to :: Rep ListRecipes x -> ListRecipes

Read ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Methods

readsPrec :: Int -> ReadS ListRecipes

readList :: ReadS [ListRecipes]

readPrec :: ReadPrec ListRecipes

readListPrec :: ReadPrec [ListRecipes]

Show ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Methods

showsPrec :: Int -> ListRecipes -> ShowS

show :: ListRecipes -> String

showList :: [ListRecipes] -> ShowS

NFData ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Methods

rnf :: ListRecipes -> ()

Eq ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Methods

(==) :: ListRecipes -> ListRecipes -> Bool

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

Hashable ListRecipes

Defined in Amazonka.Personalize.ListRecipes

Methods

hashWithSalt :: Int -> ListRecipes -> Int

hash :: ListRecipes -> Int

type AWSResponse ListRecipes

Defined in Amazonka.Personalize.ListRecipes

type AWSResponse ListRecipes = ListRecipesResponse

type Rep ListRecipes

Defined in Amazonka.Personalize.ListRecipes

type Rep ListRecipes = D1 ('MetaData "ListRecipes" "Amazonka.Personalize.ListRecipes" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "ListRecipes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Domain)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recipeProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecipeProvider)))))

newListRecipes :: ListRecipes

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

ListRecipes, listRecipes_domain - Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.

$sel:maxResults:ListRecipes', listRecipes_maxResults - The maximum number of recipes to return.

ListRecipes, listRecipes_nextToken - A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

$sel:recipeProvider:ListRecipes', listRecipes_recipeProvider - The default is SERVICE.

Request Lenses

listRecipes_domain :: Lens' ListRecipes (Maybe Domain)

Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.

listRecipes_maxResults :: Lens' ListRecipes (Maybe Natural)

The maximum number of recipes to return.

listRecipes_nextToken :: Lens' ListRecipes (Maybe Text)

A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

listRecipes_recipeProvider :: Lens' ListRecipes (Maybe RecipeProvider)

The default is SERVICE.

Destructuring the Response

data ListRecipesResponse

See: newListRecipesResponse smart constructor.

Constructors

ListRecipesResponse'

Fields

• nextToken :: Maybe Text

  A token for getting the next set of recipes.

• recipes :: Maybe [RecipeSummary]

  The list of available recipes.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListRecipesResponse

Defined in Amazonka.Personalize.ListRecipes

Associated Types

type Rep ListRecipesResponse :: Type -> Type

Methods

from :: ListRecipesResponse -> Rep ListRecipesResponse x

to :: Rep ListRecipesResponse x -> ListRecipesResponse

Read ListRecipesResponse

Defined in Amazonka.Personalize.ListRecipes

Methods

readsPrec :: Int -> ReadS ListRecipesResponse

readList :: ReadS [ListRecipesResponse]

readPrec :: ReadPrec ListRecipesResponse

readListPrec :: ReadPrec [ListRecipesResponse]

Show ListRecipesResponse

Defined in Amazonka.Personalize.ListRecipes

Methods

showsPrec :: Int -> ListRecipesResponse -> ShowS

show :: ListRecipesResponse -> String

showList :: [ListRecipesResponse] -> ShowS

NFData ListRecipesResponse

Defined in Amazonka.Personalize.ListRecipes

Methods

rnf :: ListRecipesResponse -> ()

Eq ListRecipesResponse

Defined in Amazonka.Personalize.ListRecipes

Methods

(==) :: ListRecipesResponse -> ListRecipesResponse -> Bool

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

type Rep ListRecipesResponse

Defined in Amazonka.Personalize.ListRecipes

type Rep ListRecipesResponse = D1 ('MetaData "ListRecipesResponse" "Amazonka.Personalize.ListRecipes" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "ListRecipesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "recipes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RecipeSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRecipesResponse

Arguments

:: Int

$sel:httpStatus:ListRecipesResponse'

-> ListRecipesResponse

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

ListRecipes, listRecipesResponse_nextToken - A token for getting the next set of recipes.

$sel:recipes:ListRecipesResponse', listRecipesResponse_recipes - The list of available recipes.

$sel:httpStatus:ListRecipesResponse', listRecipesResponse_httpStatus - The response's http status code.

Response Lenses

listRecipesResponse_nextToken :: Lens' ListRecipesResponse (Maybe Text)

A token for getting the next set of recipes.

listRecipesResponse_recipes :: Lens' ListRecipesResponse (Maybe [RecipeSummary])

The list of available recipes.

listRecipesResponse_httpStatus :: Lens' ListRecipesResponse Int

The response's http status code.