List Recipes

personalize_list_recipes

R Documentation

Returns a list of available recipes¶

Description¶

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

Usage¶

personalize_list_recipes(recipeProvider, nextToken, maxResults, domain)

Arguments¶

recipeProvider

The default is SERVICE.

nextToken

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

maxResults

The maximum number of recipes to return.

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.

Value¶

A list with the following syntax:

list(
  recipes = list(
    list(
      name = "string",
      recipeArn = "string",
      status = "string",
      creationDateTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      ),
      domain = "ECOMMERCE"|"VIDEO_ON_DEMAND"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_recipes(
  recipeProvider = "SERVICE",
  nextToken = "string",
  maxResults = 123,
  domain = "ECOMMERCE"|"VIDEO_ON_DEMAND"
)