Glue / Client / list_data_quality_statistics

list_data_quality_statistics#

Glue.Client.list_data_quality_statistics(**kwargs)#

Retrieves a list of data quality statistics.

See also: AWS API Documentation

Request Syntax

response = client.list_data_quality_statistics(
    StatisticId='string',
    ProfileId='string',
    TimestampFilter={
        'RecordedBefore': datetime(2015, 1, 1),
        'RecordedAfter': datetime(2015, 1, 1)
    },
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • StatisticId (string) – The Statistic ID.

  • ProfileId (string) – The Profile ID.

  • TimestampFilter (dict) –

    A timestamp filter.

    • RecordedBefore (datetime) –

      The timestamp before which statistics should be included in the results.

    • RecordedAfter (datetime) –

      The timestamp after which statistics should be included in the results.

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

  • NextToken (string) – A pagination token to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Statistics': [
        {
            'StatisticId': 'string',
            'ProfileId': 'string',
            'RunIdentifier': {
                'RunId': 'string',
                'JobRunId': 'string'
            },
            'StatisticName': 'string',
            'DoubleValue': 123.0,
            'EvaluationLevel': 'Dataset'|'Column'|'Multicolumn',
            'ColumnsReferenced': [
                'string',
            ],
            'ReferencedDatasets': [
                'string',
            ],
            'StatisticProperties': {
                'string': 'string'
            },
            'RecordedOn': datetime(2015, 1, 1),
            'InclusionAnnotation': {
                'Value': 'INCLUDE'|'EXCLUDE',
                'LastModifiedOn': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Statistics (list) –

      A StatisticSummaryList.

      • (dict) –

        Summary information about a statistic.

        • StatisticId (string) –

          The Statistic ID.

        • ProfileId (string) –

          The Profile ID.

        • RunIdentifier (dict) –

          The Run Identifier

          • RunId (string) –

            The Run ID.

          • JobRunId (string) –

            The Job Run ID.

        • StatisticName (string) –

          The name of the statistic.

        • DoubleValue (float) –

          The value of the statistic.

        • EvaluationLevel (string) –

          The evaluation level of the statistic. Possible values: Dataset, Column, Multicolumn.

        • ColumnsReferenced (list) –

          The list of columns referenced by the statistic.

          • (string) –

        • ReferencedDatasets (list) –

          The list of datasets referenced by the statistic.

          • (string) –

        • StatisticProperties (dict) –

          A StatisticPropertiesMap, which contains a NameString and DescriptionString

          • (string) –

            • (string) –

        • RecordedOn (datetime) –

          The timestamp when the statistic was recorded.

        • InclusionAnnotation (dict) –

          The inclusion annotation for the statistic.

          • Value (string) –

            The inclusion annotation value.

          • LastModifiedOn (datetime) –

            The timestamp when the inclusion annotation was last modified.

    • NextToken (string) –

      A pagination token to request the next page of results.

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException

  • Glue.Client.exceptions.InvalidInputException

  • Glue.Client.exceptions.InternalServiceException