Glue / Client / list_data_quality_evaluation_configs

list_data_quality_evaluation_configs

Glue.Client.list_data_quality_evaluation_configs(**kwargs)

Lists the data quality evaluation configurations in your account, optionally filtered by level.

See also: AWS API Documentation

Request Syntax

response = client.list_data_quality_evaluation_configs(
    Level='CATALOG'|'DATABASE'|'TABLE',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • Level (string) – Lists only the configurations that apply to this level.

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – A paginated token to offset the results. If you don’t specify a token, the operation returns results starting from the beginning of the list.

Return type:

dict

Returns:

Response Syntax

{
    'DataQualityEvaluationConfigs': [
        {
            'Name': 'string',
            'EvaluationRunMode': 'ON_DEMAND'|'EVALUATION_CONFIG',
            'CreatedOn': datetime(2015, 1, 1),
            'LastModifiedOn': datetime(2015, 1, 1),
            'Level': 'CATALOG'|'DATABASE'|'TABLE',
            'DataSource': {
                'GlueTables': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'TableNamePattern': 'string'
                }
            },
            'RulesetName': 'string',
            'ManagedRulesetName': 'SIMPLE'|'ADVANCED',
            'PauseRuns': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DataQualityEvaluationConfigs (list) –

      A list of DataQualityEvaluationConfigListDetails objects.

      • (dict) –

        Describes a data quality evaluation configuration.

        • Name (string) –

          The name of the data quality evaluation configuration.

        • EvaluationRunMode (string) –

          The evaluation run mode of the configuration’s results, which is EVALUATION_CONFIG.

        • CreatedOn (datetime) –

          The time when the configuration was created.

        • LastModifiedOn (datetime) –

          The time when the configuration was last modified.

        • Level (string) –

          The Glue Data Catalog hierarchical level that the configuration applies to.

        • DataSource (dict) –

          The catalog, database, or table that the configuration applies to.

          • GlueTables (dict) –

            The Glue Data Catalog tables that the configuration applies to.

            • CatalogId (string) –

              A unique identifier for the Glue Data Catalog.

            • DatabaseName (string) –

              A database name in the Glue Data Catalog.

            • TableNamePattern (string) –

              For the CATALOG and DATABASE levels, a glob pattern, such as orders_*, that selects tables. If you don’t specify a pattern, every table at the level is in scope. For the TABLE level, the name of the table.

        • RulesetName (string) –

          The name of the data quality ruleset that tables are evaluated with.

        • ManagedRulesetName (string) –

          The built-in ruleset that tables are evaluated with.

        • PauseRuns (boolean) –

          Specifies whether evaluations are paused.

    • NextToken (string) –

      A pagination token, if more results are available.

Exceptions