Skip to content

create_ruleset

create_ruleset(
    name: RulesetName,
    target_arn: Arn,
    rules: RuleList,
    *,
    config_overrides: Optional[DataBrewClientConfig] = None,
    description: Optional[RulesetDescription] = None,
    tags: Optional[TagMap] = None,
) -> CreateRulesetResponse

Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.

Parameters:

  • name (RulesetName) –

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

  • description (Optional[RulesetDescription], default: None ) –

    The description of the ruleset.

  • target_arn (Arn) –

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

  • 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 (Optional[TagMap], default: None ) –

    Metadata tags to apply to the ruleset.

Raises:

Source code in docs_src/capo_databrew/_services/data_brew.py
def create_ruleset(
    self,
    name: "capo_databrew.types.ruleset_name.RulesetName",
    target_arn: "capo_databrew.types.arn.Arn",
    rules: "capo_databrew.types.rule_list.RuleList",
    *,
    config_overrides: Optional[DataBrewClientConfig] = None,
    description: Optional[
        "capo_databrew.types.ruleset_description.RulesetDescription"
    ] = None,
    tags: Optional["capo_databrew.types.tag_map.TagMap"] = None,
) -> "capo_databrew.types.create_ruleset_response.CreateRulesetResponse":
    """<p>Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.</p>

    Args:
        name: <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: <p>The description of the ruleset.</p>
        target_arn: <p>The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.</p>
        rules: <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: <p>Metadata tags to apply to the ruleset.</p>

    Raises:
        capo_databrew.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_databrew.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>A service quota is exceeded.</p>
        capo_databrew.errors.validation_exception.ValidationException: <p>The input parameters for this request failed validation.</p>
        capo_databrew.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_databrew.types.create_ruleset_request.CreateRulesetRequest]",
    ) -> OperationResponse[
        "capo_databrew.types.create_ruleset_response.CreateRulesetResponse"
    ]:
        import capo_databrew._operations.aws_glue_data_brew.create_ruleset

        output, http_response = (
            capo_databrew._operations.aws_glue_data_brew.create_ruleset.create_ruleset(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRuleset")
    )
    input_: capo_databrew.types.create_ruleset_request.CreateRulesetRequest = {
        "name": name,
        "target_arn": target_arn,
        "rules": rules,
    }
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output