ListDataQualityStatisticAnnotations
Retrieve annotations for a data quality statistic.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"ProfileId": "string",
"StatisticId": "string",
"TimestampFilter": {
"RecordedAfter": number,
"RecordedBefore": number
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of results to return in this request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
A pagination token to retrieve the next set of results.
Type: String
Required: No
- ProfileId
-
The Profile ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- StatisticId
-
The Statistic ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- TimestampFilter
-
A timestamp filter.
Type: TimestampFilter object
Required: No
Response Syntax
{
"Annotations": [
{
"InclusionAnnotation": {
"LastModifiedOn": number,
"Value": "string"
},
"ProfileId": "string",
"StatisticId": "string",
"StatisticRecordedOn": number
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Annotations
-
A list of
StatisticAnnotationapplied to the StatisticType: Array of StatisticAnnotation objects
- NextToken
-
A pagination token to retrieve the next set of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
