Glue / Client / list_data_quality_rulesets

list_data_quality_rulesets

Glue.Client.list_data_quality_rulesets(**kwargs)

Returns a paginated list of rulesets for the specified list of Glue tables.

See also: AWS API Documentation

Request Syntax

response = client.list_data_quality_rulesets(
    NextToken='string',
    MaxResults=123,
    Filter={
        'Name': 'string',
        'Description': 'string',
        'CreatedBefore': datetime(2015, 1, 1),
        'CreatedAfter': datetime(2015, 1, 1),
        'LastModifiedBefore': datetime(2015, 1, 1),
        'LastModifiedAfter': datetime(2015, 1, 1),
        'TargetTable': {
            'TableName': 'string',
            'DatabaseName': 'string',
            'CatalogId': 'string'
        }
    },
    Tags={
        'string': 'string'
    }
)

Parameters:

• NextToken (string) – A paginated token to offset the results.

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

• Filter (dict) –

  The filter criteria.

  • Name (string) –

    The name of the ruleset filter criteria.

  • Description (string) –

    The description of the ruleset filter criteria.

  • CreatedBefore (datetime) –

    Filter on rulesets created before this date.

  • CreatedAfter (datetime) –

    Filter on rulesets created after this date.

  • LastModifiedBefore (datetime) –

    Filter on rulesets last modified before this date.

  • LastModifiedAfter (datetime) –

    Filter on rulesets last modified after this date.

  • TargetTable (dict) –

    The name and database name of the target table.

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

• Tags (dict) –

  A list of key-value pair tags.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Rulesets': [
        {
            'Name': 'string',
            'Description': 'string',
            'CreatedOn': datetime(2015, 1, 1),
            'LastModifiedOn': datetime(2015, 1, 1),
            'TargetTable': {
                'TableName': 'string',
                'DatabaseName': 'string',
                'CatalogId': 'string'
            },
            'RecommendationRunId': 'string',
            'RuleCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Rulesets (list) –

    A paginated list of rulesets for the specified list of Glue tables.

    • (dict) –

      Describes a data quality ruleset returned by GetDataQualityRuleset.

      • Name (string) –

        The name of the data quality ruleset.

      • Description (string) –

        A description of the data quality ruleset.

      • CreatedOn (datetime) –

        The date and time the data quality ruleset was created.

      • LastModifiedOn (datetime) –

        The date and time the data quality ruleset was last modified.

      • TargetTable (dict) –

        An object representing an Glue table.

        • TableName (string) –

          The name of the Glue table.

        • DatabaseName (string) –

          The name of the database where the Glue table exists.

        • CatalogId (string) –

          The catalog id where the Glue table exists.

      • RecommendationRunId (string) –

        When a ruleset was created from a recommendation run, this run ID is generated to link the two together.

      • RuleCount (integer) –

        The number of rules in the ruleset.

  • NextToken (string) –

    A pagination token, if more results are available.

Exceptions

• Glue.Client.exceptions.EntityNotFoundException

• Glue.Client.exceptions.InvalidInputException

• Glue.Client.exceptions.OperationTimeoutException

• Glue.Client.exceptions.InternalServiceException