Skip to content

update_ruleset

update_ruleset(
    name: RulesetName,
    rules: RuleList,
    *,
    config_overrides: Optional[DataBrewClientConfig] = None,
    description: Optional[RulesetDescription] = None,
) -> UpdateRulesetResponse

Updates specified ruleset.

Parameters:

  • name (RulesetName) –

    The name of the ruleset to be updated.

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

    The description of the ruleset.

  • 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.

Raises:

Source code in docs_src/capo_databrew/_services/data_brew.py
def update_ruleset(
    self,
    name: "capo_databrew.types.ruleset_name.RulesetName",
    rules: "capo_databrew.types.rule_list.RuleList",
    *,
    config_overrides: Optional[DataBrewClientConfig] = None,
    description: Optional[
        "capo_databrew.types.ruleset_description.RulesetDescription"
    ] = None,
) -> "capo_databrew.types.update_ruleset_response.UpdateRulesetResponse":
    """<p>Updates specified ruleset.</p>

    Args:
        name: <p>The name of the ruleset to be updated.</p>
        description: <p>The description of the ruleset.</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>

    Raises:
        capo_databrew.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</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.update_ruleset_request.UpdateRulesetRequest]",
    ) -> OperationResponse[
        "capo_databrew.types.update_ruleset_response.UpdateRulesetResponse"
    ]:
        import capo_databrew._operations.aws_glue_data_brew.update_ruleset

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRuleset")
    )
    input_: capo_databrew.types.update_ruleset_request.UpdateRulesetRequest = {
        "name": name,
        "rules": rules,
    }
    if description is not None:
        input_["description"] = description

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