AWS::DataBrew::Recipe RecipeParameters
Parameters that are used as inputs for various recipe actions. The parameters are specific to the context in which they're used.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "AggregateFunction" :
String
, "Base" :String
, "CaseStatement" :String
, "CategoryMap" :String
, "CharsToRemove" :String
, "CollapseConsecutiveWhitespace" :String
, "ColumnDataType" :String
, "ColumnRange" :String
, "Count" :String
, "CustomCharacters" :String
, "CustomStopWords" :String
, "CustomValue" :String
, "DatasetsColumns" :String
, "DateAddValue" :String
, "DateTimeFormat" :String
, "DateTimeParameters" :String
, "DeleteOtherRows" :String
, "Delimiter" :String
, "EndPattern" :String
, "EndPosition" :String
, "EndValue" :String
, "ExpandContractions" :String
, "Exponent" :String
, "FalseString" :String
, "GroupByAggFunctionOptions" :String
, "GroupByColumns" :String
, "HiddenColumns" :String
, "IgnoreCase" :String
, "IncludeInSplit" :String
, "Input" :Input
, "Interval" :String
, "IsText" :String
, "JoinKeys" :String
, "JoinType" :String
, "LeftColumns" :String
, "Limit" :String
, "LowerBound" :String
, "MapType" :String
, "ModeType" :String
, "MultiLine" :Boolean
, "NumRows" :String
, "NumRowsAfter" :String
, "NumRowsBefore" :String
, "OrderByColumn" :String
, "OrderByColumns" :String
, "Other" :String
, "Pattern" :String
, "PatternOption1" :String
, "PatternOption2" :String
, "PatternOptions" :String
, "Period" :String
, "Position" :String
, "RemoveAllPunctuation" :String
, "RemoveAllQuotes" :String
, "RemoveAllWhitespace" :String
, "RemoveCustomCharacters" :String
, "RemoveCustomValue" :String
, "RemoveLeadingAndTrailingPunctuation" :String
, "RemoveLeadingAndTrailingQuotes" :String
, "RemoveLeadingAndTrailingWhitespace" :String
, "RemoveLetters" :String
, "RemoveNumbers" :String
, "RemoveSourceColumn" :String
, "RemoveSpecialCharacters" :String
, "RightColumns" :String
, "SampleSize" :String
, "SampleType" :String
, "SecondaryInputs" :[ SecondaryInput, ... ]
, "SecondInput" :String
, "SheetIndexes" :[ Integer, ... ]
, "SheetNames" :[ String, ... ]
, "SourceColumn" :String
, "SourceColumn1" :String
, "SourceColumn2" :String
, "SourceColumns" :String
, "StartColumnIndex" :String
, "StartPattern" :String
, "StartPosition" :String
, "StartValue" :String
, "StemmingMode" :String
, "StepCount" :String
, "StepIndex" :String
, "StopWordsMode" :String
, "Strategy" :String
, "TargetColumn" :String
, "TargetColumnNames" :String
, "TargetDateFormat" :String
, "TargetIndex" :String
, "TimeZone" :String
, "TokenizerPattern" :String
, "TrueString" :String
, "UdfLang" :String
, "Units" :String
, "UnpivotColumn" :String
, "UpperBound" :String
, "UseNewDataFrame" :String
, "Value" :String
, "Value1" :String
, "Value2" :String
, "ValueColumn" :String
, "ViewFrame" :String
}
YAML
AggregateFunction:
String
Base:String
CaseStatement:String
CategoryMap:String
CharsToRemove:String
CollapseConsecutiveWhitespace:String
ColumnDataType:String
ColumnRange:String
Count:String
CustomCharacters:String
CustomStopWords:String
CustomValue:String
DatasetsColumns:String
DateAddValue:String
DateTimeFormat:String
DateTimeParameters:String
DeleteOtherRows:String
Delimiter:String
EndPattern:String
EndPosition:String
EndValue:String
ExpandContractions:String
Exponent:String
FalseString:String
GroupByAggFunctionOptions:String
GroupByColumns:String
HiddenColumns:String
IgnoreCase:String
IncludeInSplit:String
Input:Input
Interval:String
IsText:String
JoinKeys:String
JoinType:String
LeftColumns:String
Limit:String
LowerBound:String
MapType:String
ModeType:String
MultiLine:Boolean
NumRows:String
NumRowsAfter:String
NumRowsBefore:String
OrderByColumn:String
OrderByColumns:String
Other:String
Pattern:String
PatternOption1:String
PatternOption2:String
PatternOptions:String
Period:String
Position:String
RemoveAllPunctuation:String
RemoveAllQuotes:String
RemoveAllWhitespace:String
RemoveCustomCharacters:String
RemoveCustomValue:String
RemoveLeadingAndTrailingPunctuation:String
RemoveLeadingAndTrailingQuotes:String
RemoveLeadingAndTrailingWhitespace:String
RemoveLetters:String
RemoveNumbers:String
RemoveSourceColumn:String
RemoveSpecialCharacters:String
RightColumns:String
SampleSize:String
SampleType:String
SecondaryInputs:- SecondaryInput
SecondInput:String
SheetIndexes:- Integer
SheetNames:- String
SourceColumn:String
SourceColumn1:String
SourceColumn2:String
SourceColumns:String
StartColumnIndex:String
StartPattern:String
StartPosition:String
StartValue:String
StemmingMode:String
StepCount:String
StepIndex:String
StopWordsMode:String
Strategy:String
TargetColumn:String
TargetColumnNames:String
TargetDateFormat:String
TargetIndex:String
TimeZone:String
TokenizerPattern:String
TrueString:String
UdfLang:String
Units:String
UnpivotColumn:String
UpperBound:String
UseNewDataFrame:String
Value:String
Value1:String
Value2:String
ValueColumn:String
ViewFrame:String
Properties
AggregateFunction
-
The name of an aggregation function to apply.
Required: No
Type: String
Update requires: No interruption
Base
-
The number of digits used in a counting system.
Required: No
Type: String
Update requires: No interruption
CaseStatement
-
A case statement associated with a recipe.
Required: No
Type: String
Update requires: No interruption
CategoryMap
-
A category map used for one-hot encoding.
Required: No
Type: String
Update requires: No interruption
CharsToRemove
-
Characters to remove from a step that applies one-hot encoding or tokenization.
Required: No
Type: String
Update requires: No interruption
CollapseConsecutiveWhitespace
-
Remove any non-word non-punctuation character.
Required: No
Type: String
Update requires: No interruption
ColumnDataType
-
The data type of the column.
Required: No
Type: String
Update requires: No interruption
ColumnRange
-
A range of columns to which a step is applied.
Required: No
Type: String
Update requires: No interruption
Count
-
The number of times a string needs to be repeated.
Required: No
Type: String
Update requires: No interruption
CustomCharacters
-
One or more characters that can be substituted or removed, depending on the context.
Required: No
Type: String
Update requires: No interruption
CustomStopWords
-
A list of words to ignore in a step that applies word tokenization.
Required: No
Type: String
Update requires: No interruption
CustomValue
-
A list of custom values to use in a step that requires that you provide a value to finish the operation.
Required: No
Type: String
Update requires: No interruption
DatasetsColumns
-
A list of the dataset columns included in a project.
Required: No
Type: String
Update requires: No interruption
DateAddValue
-
A value that specifies how many units of time to add or subtract for a date math operation.
Required: No
Type: String
Update requires: No interruption
DateTimeFormat
-
A date format to apply to a date.
Required: No
Type: String
Update requires: No interruption
DateTimeParameters
-
A set of parameters associated with a datetime.
Required: No
Type: String
Update requires: No interruption
DeleteOtherRows
-
Determines whether unmapped rows in a categorical mapping should be deleted
Required: No
Type: String
Update requires: No interruption
Delimiter
-
The delimiter to use when parsing separated values in a text file.
Required: No
Type: String
Update requires: No interruption
EndPattern
-
The end pattern to locate.
Required: No
Type: String
Update requires: No interruption
EndPosition
-
The end position to locate.
Required: No
Type: String
Update requires: No interruption
EndValue
-
The end value to locate.
Required: No
Type: String
Update requires: No interruption
ExpandContractions
-
A list of word contractions and what they expand to. For eample: can't; cannot; can not.
Required: No
Type: String
Update requires: No interruption
Exponent
-
The exponent to apply in an exponential operation.
Required: No
Type: String
Update requires: No interruption
FalseString
-
A value that represents
FALSE
.Required: No
Type: String
Update requires: No interruption
GroupByAggFunctionOptions
-
Specifies options to apply to the
GROUP BY
used in an aggregation.Required: No
Type: String
Update requires: No interruption
GroupByColumns
-
The columns to use in the
GROUP BY
clause.Required: No
Type: String
Update requires: No interruption
-
A list of columns to hide.
Required: No
Type: String
Update requires: No interruption
IgnoreCase
-
Indicates that lower and upper case letters are treated equally.
Required: No
Type: String
Update requires: No interruption
IncludeInSplit
-
Indicates if this column is participating in a split transform.
Required: No
Type: String
Update requires: No interruption
Input
-
The input location to load the dataset from - Amazon S3 or Amazon Glue Data Catalog.
Required: No
Type: Input
Update requires: No interruption
Interval
-
The number of characters to split by.
Required: No
Type: String
Update requires: No interruption
IsText
-
Indicates if the content is text.
Required: No
Type: String
Update requires: No interruption
JoinKeys
-
The keys or columns involved in a join.
Required: No
Type: String
Update requires: No interruption
JoinType
-
The type of join to use, for example,
INNER JOIN
,OUTER JOIN
, and so on.Required: No
Type: String
Update requires: No interruption
LeftColumns
-
The columns on the left side of the join.
Required: No
Type: String
Update requires: No interruption
Limit
-
The number of times to perform
split
orreplaceBy
in a stringRequired: No
Type: String
Update requires: No interruption
LowerBound
-
The lower boundary for a value.
Required: No
Type: String
Update requires: No interruption
MapType
-
The type of mappings to apply to construct a new dynamic frame.
Required: No
Type: String
Update requires: No interruption
ModeType
-
Determines the manner in which mode value is calculated, in case there is more than one mode value. Valid values:
NONE
|AVERAGE
|MINIMUM
|MAXIMUM
Required: No
Type: String
Update requires: No interruption
MultiLine
-
Specifies whether JSON input contains embedded new line characters.
Required: No
Type: Boolean
Update requires: No interruption
NumRows
-
The number of rows to consider in a window.
Required: No
Type: String
Update requires: No interruption
NumRowsAfter
-
The number of rows to consider after the current row in a window
Required: No
Type: String
Update requires: No interruption
NumRowsBefore
-
The number of rows to consider before the current row in a window
Required: No
Type: String
Update requires: No interruption
OrderByColumn
-
A column to sort the results by.
Required: No
Type: String
Update requires: No interruption
OrderByColumns
-
The columns to sort the results by.
Required: No
Type: String
Update requires: No interruption
Other
-
The value to assign to unmapped cells, in categorical mapping
Required: No
Type: String
Update requires: No interruption
Pattern
-
The pattern to locate.
Required: No
Type: String
Update requires: No interruption
PatternOption1
-
The starting pattern to split between.
Required: No
Type: String
Update requires: No interruption
PatternOption2
-
The ending pattern to split between.
Required: No
Type: String
Update requires: No interruption
PatternOptions
-
For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format. For example:
[{\"pattern\":\"1\",\"includeInSplit\":true}]
Required: No
Type: String
Update requires: No interruption
Period
-
The size of the rolling window.
Required: No
Type: String
Update requires: No interruption
Position
-
The character index within a string
Required: No
Type: String
Update requires: No interruption
RemoveAllPunctuation
-
If
true
, removes all of the following characters:.
.!
.,
.?
Required: No
Type: String
Update requires: No interruption
RemoveAllQuotes
-
If
true
, removes all single quotes and double quotes.Required: No
Type: String
Update requires: No interruption
RemoveAllWhitespace
-
If
true
, removes all whitespaces from the value.Required: No
Type: String
Update requires: No interruption
RemoveCustomCharacters
-
If
true
, removes all chraracters specified byCustomCharacters
.Required: No
Type: String
Update requires: No interruption
RemoveCustomValue
-
If
true
, removes all chraracters specified byCustomValue
.Required: No
Type: String
Update requires: No interruption
RemoveLeadingAndTrailingPunctuation
-
If
true
, removes the following characters if they occur at the start or end of the value:.
!
,
?
Required: No
Type: String
Update requires: No interruption
RemoveLeadingAndTrailingQuotes
-
If
true
, removes single quotes and double quotes from the beginning and end of the value.Required: No
Type: String
Update requires: No interruption
RemoveLeadingAndTrailingWhitespace
-
If
true
, removes all whitespaces from the beginning and end of the value.Required: No
Type: String
Update requires: No interruption
RemoveLetters
-
If
true
, removes all uppercase and lowercase alphabetic characters (A through Z; a through z).Required: No
Type: String
Update requires: No interruption
RemoveNumbers
-
If
true
, removes all numeric characters (0 through 9).Required: No
Type: String
Update requires: No interruption
RemoveSourceColumn
-
If
true
, the source column will be removed after un-nesting that column. (Used with nested column types, such as Map, Struct, or Array.)Required: No
Type: String
Update requires: No interruption
RemoveSpecialCharacters
-
If
true
, removes all of the following characters:! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
Required: No
Type: String
Update requires: No interruption
RightColumns
-
The columns on the right side of a join.
Required: No
Type: String
Update requires: No interruption
SampleSize
-
The number of rows in the sample.
Required: No
Type: String
Update requires: No interruption
SampleType
-
The sampling type to apply to the dataset. Valid values:
FIRST_N
|LAST_N
|RANDOM
Required: No
Type: String
Update requires: No interruption
SecondaryInputs
-
A list of secondary inputs in a UNION transform
Required: No
Type: Array of SecondaryInput
Update requires: No interruption
SecondInput
-
A object value to indicate the second dataset used in a join.
Required: No
Type: String
Update requires: No interruption
SheetIndexes
-
One or more sheet numbers in the Excel file, which will be included in a dataset.
Required: No
Type: Array of Integer
Minimum:
1
Maximum:
1
Update requires: No interruption
SheetNames
-
Oone or more named sheets in the Excel file, which will be included in a dataset.
Required: No
Type: Array of String
Minimum:
1
Maximum:
1
Update requires: No interruption
SourceColumn
-
A source column needed for an operation, step, or transform.
Required: No
Type: String
Update requires: No interruption
SourceColumn1
-
A source column needed for an operation, step, or transform.
Required: No
Type: String
Update requires: No interruption
SourceColumn2
-
A source column needed for an operation, step, or transform.
Required: No
Type: String
Update requires: No interruption
SourceColumns
-
A list of source columns needed for an operation, step, or transform.
Required: No
Type: String
Update requires: No interruption
StartColumnIndex
-
The index number of the first column used by an operation, step, or transform.
Required: No
Type: String
Update requires: No interruption
StartPattern
-
The starting pattern to locate.
Required: No
Type: String
Update requires: No interruption
StartPosition
-
The starting position to locate.
Required: No
Type: String
Update requires: No interruption
StartValue
-
The starting value to locate.
Required: No
Type: String
Update requires: No interruption
StemmingMode
-
Indicates this operation uses stems and lemmas (base words) for word tokenization.
Required: No
Type: String
Update requires: No interruption
StepCount
-
The total number of transforms in this recipe.
Required: No
Type: String
Update requires: No interruption
StepIndex
-
The index ID of a step.
Required: No
Type: String
Update requires: No interruption
StopWordsMode
-
Indicates this operation uses stop words as part of word tokenization.
Required: No
Type: String
Update requires: No interruption
Strategy
-
The resolution strategy to apply in resolving ambiguities.
Required: No
Type: String
Update requires: No interruption
TargetColumn
-
The column targeted by this operation.
Required: No
Type: String
Update requires: No interruption
TargetColumnNames
-
The names to give columns altered by this operation.
Required: No
Type: String
Update requires: No interruption
TargetDateFormat
-
The date format to convert to.
Required: No
Type: String
Update requires: No interruption
TargetIndex
-
The index number of an object that is targeted by this operation.
Required: No
Type: String
Update requires: No interruption
TimeZone
-
The current timezone that you want to use for dates.
Required: No
Type: String
Update requires: No interruption
TokenizerPattern
-
A regex expression to use when splitting text into terms, also called words or tokens.
Required: No
Type: String
Update requires: No interruption
TrueString
-
A value to use to represent
TRUE
.Required: No
Type: String
Update requires: No interruption
UdfLang
-
The language that's used in the user-defined function.
Required: No
Type: String
Update requires: No interruption
Units
-
Specifies a unit of time. For example:
MINUTES
;SECONDS
;HOURS
; etc.Required: No
Type: String
Update requires: No interruption
UnpivotColumn
-
Cast columns as rows, so that each value is a different row in a single column.
Required: No
Type: String
Update requires: No interruption
UpperBound
-
The upper boundary for a value.
Required: No
Type: String
Update requires: No interruption
UseNewDataFrame
-
Create a new container to hold a dataset.
Required: No
Type: String
Update requires: No interruption
Value
-
A static value that can be used in a comparison, a substitution, or in another context-specific way. A
Value
can be a number, string, or other datatype, depending on the recipe action in which it's used.Required: No
Type: String
Update requires: No interruption
Value1
-
A value that's used by this operation.
Required: No
Type: String
Update requires: No interruption
Value2
-
A value that's used by this operation.
Required: No
Type: String
Update requires: No interruption
ValueColumn
-
The column that is provided as a value that's used by this operation.
Required: No
Type: String
Update requires: No interruption
ViewFrame
-
The subset of rows currently available for viewing.
Required: No
Type: String
Update requires: No interruption