LookoutMetrics / Client / get_data_quality_metrics

get_data_quality_metrics#

LookoutMetrics.Client.get_data_quality_metrics(**kwargs)#

Returns details about the requested data quality metrics.

See also: AWS API Documentation

Request Syntax

response = client.get_data_quality_metrics(
    AnomalyDetectorArn='string',
    MetricSetArn='string'
)
Parameters:

  • AnomalyDetectorArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.

  • MetricSetArn (string) – The Amazon Resource Name (ARN) of a specific data quality metric set.

Return type:

dict

Returns:

Response Syntax

{
    'AnomalyDetectorDataQualityMetricList': [
        {
            'StartTimestamp': datetime(2015, 1, 1),
            'MetricSetDataQualityMetricList': [
                {
                    'MetricSetArn': 'string',
                    'DataQualityMetricList': [
                        {
                            'MetricType': 'COLUMN_COMPLETENESS'|'DIMENSION_UNIQUENESS'|'TIME_SERIES_COUNT'|'ROWS_PROCESSED'|'ROWS_PARTIAL_COMPLIANCE'|'INVALID_ROWS_COMPLIANCE'|'BACKTEST_TRAINING_DATA_START_TIME_STAMP'|'BACKTEST_TRAINING_DATA_END_TIME_STAMP'|'BACKTEST_INFERENCE_DATA_START_TIME_STAMP'|'BACKTEST_INFERENCE_DATA_END_TIME_STAMP',
                            'MetricDescription': 'string',
                            'RelatedColumnName': 'string',
                            'MetricValue': 123.0
                        },
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • AnomalyDetectorDataQualityMetricList (list) –

      A list of the data quality metrics for the AnomalyDetectorArn that you requested.

      • (dict) –

        Aggregated details about the data quality metrics collected for the AnomalyDetectorArn provided in the GetDataQualityMetrics object.

        • StartTimestamp (datetime) –

          The start time for the data quality metrics collection.

        • MetricSetDataQualityMetricList (list) –

          An array of DataQualityMetricList objects. Each object in the array contains information about a data quality metric.

          • (dict) –

            An array of DataQualityMetric objects that describes one or more data quality metrics.

            • MetricSetArn (string) –

              The Amazon Resource Name (ARN) of the data quality metric array.

            • DataQualityMetricList (list) –

              The array of data quality metrics contained in the data quality metric set.

              • (dict) –

                An array that describes a data quality metric. Each DataQualityMetric object contains the data quality metric name, its value, a description of the metric, and the affected column.

                • MetricType (string) –

                  The name of the data quality metric.

                • MetricDescription (string) –

                  A description of the data quality metric.

                • RelatedColumnName (string) –

                  The column that is being monitored.

                • MetricValue (float) –

                  The value of the data quality metric.

Exceptions