Skip to content

CreateRulesetRequest

Source code in docs_src/capo_databrew/types/create_ruleset_request.py
class CreateRulesetRequest(TypedDict, closed=True):
    name: "capo_databrew.types.ruleset_name.RulesetName"
    """<p>The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>"""
    description: NotRequired[
        "capo_databrew.types.ruleset_description.RulesetDescription"
    ]
    """<p>The description of the ruleset.</p>"""
    target_arn: "capo_databrew.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.</p>"""
    rules: "capo_databrew.types.rule_list.RuleList"
    """<p>A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.</p>"""
    tags: NotRequired["capo_databrew.types.tag_map.TagMap"]
    """<p>Metadata tags to apply to the ruleset.</p>"""

description instance-attribute

description: NotRequired[RulesetDescription]

The description of the ruleset.

name instance-attribute

The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

rules instance-attribute

rules: RuleList

A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

tags instance-attribute

tags: NotRequired[TagMap]

Metadata tags to apply to the ruleset.

target_arn instance-attribute

target_arn: Arn

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.