Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListRecipes

Lists all of the DataBrew recipes that are defined.

Request Syntax


GET /recipes?maxResults=MaxResults&nextToken=NextToken&recipeVersion=RecipeVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return in this request.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

The token returned by a previous call to retrieve the next set of results.

Length Constraints: Minimum length of 1. Maximum length of 2000.

RecipeVersion

Return only those recipes with a version identifier of LATEST_WORKING or LATEST_PUBLISHED. If RecipeVersion is omitted, ListRecipes returns all of the LATEST_PUBLISHED recipe versions.

Valid values: LATEST_WORKING | LATEST_PUBLISHED

Length Constraints: Minimum length of 1. Maximum length of 16.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Recipes": [ 
      { 
         "CreateDate": number,
         "CreatedBy": "string",
         "Description": "string",
         "LastModifiedBy": "string",
         "LastModifiedDate": number,
         "Name": "string",
         "ProjectName": "string",
         "PublishedBy": "string",
         "PublishedDate": number,
         "RecipeVersion": "string",
         "ResourceArn": "string",
         "Steps": [ 
            { 
               "Action": { 
                  "Operation": "string",
                  "Parameters": { 
                     "string" : "string" 
                  }
               },
               "ConditionExpressions": [ 
                  { 
                     "Condition": "string",
                     "TargetColumn": "string",
                     "Value": "string"
                  }
               ]
            }
         ],
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Recipes

A list of recipes that are defined.

Type: Array of Recipe objects

NextToken

A token that you can use in a subsequent call to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Errors

For information about the errors that are common to all actions, see Common Errors.

ValidationException

The input parameters for this request failed validation.

HTTP Status Code: 400