Glue / Client / create_data_quality_ruleset

create_data_quality_ruleset#

Glue.Client.create_data_quality_ruleset(**kwargs)#

Creates a data quality ruleset with DQDL rules applied to a specified Glue table.

You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.

See also: AWS API Documentation

Request Syntax

response = client.create_data_quality_ruleset(
    Name='string',
    Description='string',
    Ruleset='string',
    Tags={
        'string': 'string'
    },
    TargetTable={
        'TableName': 'string',
        'DatabaseName': 'string',
        'CatalogId': 'string'
    },
    DataQualitySecurityConfiguration='string',
    ClientToken='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    A unique name for the data quality ruleset.

  • Description (string) – A description of the data quality ruleset.

  • Ruleset (string) –

    [REQUIRED]

    A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.

  • Tags (dict) –

    A list of tags applied to the data quality ruleset.

    • (string) –

      • (string) –

  • TargetTable (dict) –

    A target table associated with the data quality ruleset.

    • TableName (string) – [REQUIRED]

      The name of the Glue table.

    • DatabaseName (string) – [REQUIRED]

      The name of the database where the Glue table exists.

    • CatalogId (string) –

      The catalog id where the Glue table exists.

  • DataQualitySecurityConfiguration (string) – The name of the security configuration created with the data quality encryption option.

  • ClientToken (string) – Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) –

    • Name (string) –

      A unique name for the data quality ruleset.

Exceptions

  • Glue.Client.exceptions.InvalidInputException

  • Glue.Client.exceptions.AlreadyExistsException

  • Glue.Client.exceptions.OperationTimeoutException

  • Glue.Client.exceptions.InternalServiceException

  • Glue.Client.exceptions.ResourceNumberLimitExceededException