list_data_quality_resultsΒΆ

list_data_quality_results(**kwargs)ΒΆ

Returns all data quality execution results for your account.

See also: AWS API Documentation

Request Syntax

response = client.list_data_quality_results(
    Filter={
        'DataSource': {
            'GlueTable': {
                'DatabaseName': 'string',
                'TableName': 'string',
                'CatalogId': 'string',
                'ConnectionName': 'string',
                'AdditionalOptions': {
                    'string': 'string'
                }
            }
        },
        'JobName': 'string',
        'JobRunId': 'string',
        'StartedAfter': datetime(2015, 1, 1),
        'StartedBefore': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)
Parameters
  • Filter (dict) --

    The filter criteria.

    • DataSource (dict) --

      Filter results by the specified data source. For example, retrieving all results for an Glue table.

      • GlueTable (dict) -- [REQUIRED]

        An Glue table.

        • DatabaseName (string) -- [REQUIRED]

          A database name in the Glue Data Catalog.

        • TableName (string) -- [REQUIRED]

          A table name in the Glue Data Catalog.

        • CatalogId (string) --

          A unique identifier for the Glue Data Catalog.

        • ConnectionName (string) --

          The name of the connection to the Glue Data Catalog.

        • AdditionalOptions (dict) --

          Additional options for the table. Currently there are two keys supported:

          • pushDownPredicate : to filter on partitions without having to list and read all the files in your dataset.
          • catalogPartitionPredicate : to use server-side partition pruning using partition indexes in the Glue Data Catalog.
          • (string) --
            • (string) --
    • JobName (string) --

      Filter results by the specified job name.

    • JobRunId (string) --

      Filter results by the specified job run ID.

    • StartedAfter (datetime) --

      Filter results by runs that started after this time.

    • StartedBefore (datetime) --

      Filter results by runs that started before this time.

  • NextToken (string) -- A paginated token to offset the results.
  • MaxResults (integer) -- The maximum number of results to return.
Return type

dict

Returns

Response Syntax

{
    'Results': [
        {
            'ResultId': 'string',
            'DataSource': {
                'GlueTable': {
                    'DatabaseName': 'string',
                    'TableName': 'string',
                    'CatalogId': 'string',
                    'ConnectionName': 'string',
                    'AdditionalOptions': {
                        'string': 'string'
                    }
                }
            },
            'JobName': 'string',
            'JobRunId': 'string',
            'StartedOn': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Results (list) --

      A list of DataQualityResultDescription objects.

      • (dict) --

        Describes a data quality result.

        • ResultId (string) --

          The unique result ID for this data quality result.

        • DataSource (dict) --

          The table name associated with the data quality result.

          • GlueTable (dict) --

            An Glue table.

            • DatabaseName (string) --

              A database name in the Glue Data Catalog.

            • TableName (string) --

              A table name in the Glue Data Catalog.

            • CatalogId (string) --

              A unique identifier for the Glue Data Catalog.

            • ConnectionName (string) --

              The name of the connection to the Glue Data Catalog.

            • AdditionalOptions (dict) --

              Additional options for the table. Currently there are two keys supported:

              • pushDownPredicate : to filter on partitions without having to list and read all the files in your dataset.
              • catalogPartitionPredicate : to use server-side partition pruning using partition indexes in the Glue Data Catalog.
              • (string) --
                • (string) --
        • JobName (string) --

          The job name associated with the data quality result.

        • JobRunId (string) --

          The job run ID associated with the data quality result.

        • StartedOn (datetime) --

          The time that the run started for this data quality result.

    • NextToken (string) --

      A pagination token, if more results are available.

Exceptions

  • Glue.Client.exceptions.InvalidInputException
  • Glue.Client.exceptions.OperationTimeoutException
  • Glue.Client.exceptions.InternalServiceException