awswrangler.data_quality.update_ruleset

awswrangler.data_quality.update_ruleset(name: str, mode: Literal['overwrite', 'upsert'] = 'overwrite', df_rules: DataFrame | None = None, dqdl_rules: str | None = None, description: str = '', boto3_session: Session | None = None) → None

Update Data Quality ruleset.

Note

This function has arguments which can be configured globally through wr.config or environment variables:

Check out the Global Configurations Tutorial for details.

Parameters:

  • name (str) – Ruleset name.

  • mode (Literal['overwrite', 'upsert']) – overwrite (default) or upsert.

  • df_rules (DataFrame | None) – Data frame with rule_type, parameter, and expression columns.

  • dqdl_rules (str | None) – Data Quality Definition Language definition.

  • description (str) – Ruleset description.

  • boto3_session (Session | None) – The default boto3 session will be used if boto3_session is None.

Return type:

None

Examples

Overwrite rules in the existing ruleset. >>> wr.data_quality.update_ruleset( … name=”ruleset”, … dqdl_rules=”Rules = [ RowCount between 1 and 3 ]”, … )

Update or insert rules in the existing ruleset. >>> wr.data_quality.update_ruleset( … name=”ruleset”, … mode=”insert”, … dqdl_rules=”Rules = [ RowCount between 1 and 3 ]”, … )