Glue / Client / list_data_quality_statistic_annotations

list_data_quality_statistic_annotations#

Glue.Client.list_data_quality_statistic_annotations(**kwargs)#

Retrieve annotations for a data quality statistic.

See also: AWS API Documentation

Request Syntax

response = client.list_data_quality_statistic_annotations(
    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 retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'Annotations': [
        {
            'ProfileId': 'string',
            'StatisticId': 'string',
            'StatisticRecordedOn': datetime(2015, 1, 1),
            'InclusionAnnotation': {
                'Value': 'INCLUDE'|'EXCLUDE',
                'LastModifiedOn': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Annotations (list) –

      A list of StatisticAnnotation applied to the Statistic

      • (dict) –

        A Statistic Annotation.

        • ProfileId (string) –

          The Profile ID.

        • StatisticId (string) –

          The Statistic ID.

        • StatisticRecordedOn (datetime) –

          The timestamp when the annotated statistic was recorded.

        • InclusionAnnotation (dict) –

          The inclusion annotation applied to 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 retrieve the next set of results.

Exceptions