Skip to content

DatasetParameter

Source code in docs_src/capo_databrew/types/dataset_parameter.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class DatasetParameter(TypedDict, closed=True):
    name: "capo_databrew.types.path_parameter_name.PathParameterName"
    """<p>The name of the parameter that is used in the dataset's Amazon S3 path.</p>"""
    type: "capo_databrew.types.parameter_type.ParameterType"
    """<p>The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.</p>"""
    datetime_options: NotRequired[
        "capo_databrew.types.datetime_options.DatetimeOptions"
    ]
    """<p>Additional parameter options such as a format and a timezone. Required for datetime parameters.</p>"""
    create_column: "capo_databrew.types.create_column.CreateColumn"
    """<p>Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.</p>"""
    filter: NotRequired["capo_databrew.types.filter_expression.FilterExpression"]
    """<p>The optional filter expression structure to apply additional matching criteria to the parameter.</p>"""

create_column instance-attribute 

create_column: CreateColumn

Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.

datetime_options instance-attribute 

datetime_options: NotRequired[DatetimeOptions]

Additional parameter options such as a format and a timezone. Required for datetime parameters.

filter instance-attribute 

filter: NotRequired[FilterExpression]

The optional filter expression structure to apply additional matching criteria to the parameter.

name instance-attribute 

name: PathParameterName

The name of the parameter that is used in the dataset's Amazon S3 path.

type instance-attribute 

type: ParameterType

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.