DescribeRecipe - Amazon Glue DataBrew
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeRecipe

Returns the definition of a specific DataBrew recipe corresponding to a particular version.

Request Syntax

GET /recipes/name?recipeVersion=RecipeVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of the recipe to be described.

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

Required: Yes

RecipeVersion

The recipe version identifier. If this parameter isn't specified, then the latest published version is returned.

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 { "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.

Name

The name of the recipe.

Type: String

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

CreateDate

The date and time that the recipe was created.

Type: Timestamp

CreatedBy

The identifier (user name) of the user who created the recipe.

Type: String

Description

The description of the recipe.

Type: String

Length Constraints: Maximum length of 1024.

LastModifiedBy

The identifier (user name) of the user who last modified the recipe.

Type: String

LastModifiedDate

The date and time that the recipe was last modified.

Type: Timestamp

ProjectName

The name of the project associated with this recipe.

Type: String

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

PublishedBy

The identifier (user name) of the user who last published the recipe.

Type: String

PublishedDate

The date and time when the recipe was last published.

Type: Timestamp

RecipeVersion

The recipe version identifier.

Type: String

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

ResourceArn

The ARN of the recipe.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Steps

One or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed.

Type: Array of RecipeStep objects

Tags

Metadata tags associated with this project.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Errors

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

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ValidationException

The input parameters for this request failed validation.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: