Glue / Client / batch_put_data_quality_statistic_annotation

batch_put_data_quality_statistic_annotation

Glue.Client.batch_put_data_quality_statistic_annotation(**kwargs)

Annotate datapoints over time for a specific data quality statistic. The API requires both profileID and statisticID as part of the InclusionAnnotation input. The API only works for a single statisticId across multiple profiles.

See also: AWS API Documentation

Request Syntax

response = client.batch_put_data_quality_statistic_annotation(
    InclusionAnnotations=[
        {
            'ProfileId': 'string',
            'StatisticId': 'string',
            'InclusionAnnotation': 'INCLUDE'|'EXCLUDE'
        },
    ],
    ClientToken='string'
)
Parameters:

  • InclusionAnnotations (list) –

    [REQUIRED]

    A list of DatapointInclusionAnnotation’s. The InclusionAnnotations must contain a profileId and statisticId. If there are multiple InclusionAnnotations, the list must refer to a single statisticId across multiple profileIds.

    • (dict) –

      An Inclusion Annotation.

      • ProfileId (string) –

        The ID of the data quality profile the statistic belongs to.

      • StatisticId (string) –

        The Statistic ID.

      • InclusionAnnotation (string) –

        The inclusion annotation value to apply to the statistic.

  • ClientToken (string) – Client Token.

Return type:

dict

Returns:

Response Syntax

{
    'FailedInclusionAnnotations': [
        {
            'ProfileId': 'string',
            'StatisticId': 'string',
            'FailureReason': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • FailedInclusionAnnotations (list) –

      A list of AnnotationError’s.

      • (dict) –

        A failed annotation.

        • ProfileId (string) –

          The Profile ID for the failed annotation.

        • StatisticId (string) –

          The Statistic ID for the failed annotation.

        • FailureReason (string) –

          The reason why the annotation failed.

Exceptions