GlueDataBrew / Client / describe_recipe

describe_recipe#

GlueDataBrew.Client.describe_recipe(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_recipe(
    Name='string',
    RecipeVersion='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the recipe to be described.

  • RecipeVersion (string) – The recipe version identifier. If this parameter isn’t specified, then the latest published version is returned.

Return type:

dict

Returns:

Response Syntax

{
    'CreatedBy': 'string',
    'CreateDate': datetime(2015, 1, 1),
    'LastModifiedBy': 'string',
    'LastModifiedDate': datetime(2015, 1, 1),
    'ProjectName': 'string',
    'PublishedBy': 'string',
    'PublishedDate': datetime(2015, 1, 1),
    'Description': 'string',
    'Name': 'string',
    'Steps': [
        {
            'Action': {
                'Operation': 'string',
                'Parameters': {
                    'string': 'string'
                }
            },
            'ConditionExpressions': [
                {
                    'Condition': 'string',
                    'Value': 'string',
                    'TargetColumn': 'string'
                },
            ]
        },
    ],
    'Tags': {
        'string': 'string'
    },
    'ResourceArn': 'string',
    'RecipeVersion': 'string'
}

Response Structure

  • (dict) –

    • CreatedBy (string) –

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

    • CreateDate (datetime) –

      The date and time that the recipe was created.

    • LastModifiedBy (string) –

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

    • LastModifiedDate (datetime) –

      The date and time that the recipe was last modified.

    • ProjectName (string) –

      The name of the project associated with this recipe.

    • PublishedBy (string) –

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

    • PublishedDate (datetime) –

      The date and time when the recipe was last published.

    • Description (string) –

      The description of the recipe.

    • Name (string) –

      The name of the recipe.

    • Steps (list) –

      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.

      • (dict) –

        Represents a single step from a DataBrew recipe to be performed.

        • Action (dict) –

          The particular action to be performed in the recipe step.

          • Operation (string) –

            The name of a valid DataBrew transformation to be performed on the data.

          • Parameters (dict) –

            Contextual parameters for the transformation.

            • (string) –

              • (string) –

        • ConditionExpressions (list) –

          One or more conditions that must be met for the recipe step to succeed.

          Note

          All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.

          • (dict) –

            Represents an individual condition that evaluates to true or false.

            Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.

            If a recipe requires more than one condition, then the recipe must specify multiple ConditionExpression elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.

            • Condition (string) –

              A specific condition to apply to a recipe action. For more information, see Recipe structure in the Glue DataBrew Developer Guide.

            • Value (string) –

              A value that the condition must evaluate to for the condition to succeed.

            • TargetColumn (string) –

              A column to apply this condition to.

    • Tags (dict) –

      Metadata tags associated with this project.

      • (string) –

        • (string) –

    • ResourceArn (string) –

      The ARN of the recipe.

    • RecipeVersion (string) –

      The recipe version identifier.

Exceptions