GetDataQualityMetrics - Amazon Lookout for Metrics

GetDataQualityMetrics

Returns details about the requested data quality metrics.

Request Syntax

POST /GetDataQualityMetrics HTTP/1.1 Content-type: application/json { "AnomalyDetectorArn": "string", "MetricSetArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AnomalyDetectorArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):.*:.*:.*:.+

Required: Yes

MetricSetArn

The Amazon Resource Name (ARN) of a specific data quality metric set.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):.*:.*:.*:.+

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AnomalyDetectorDataQualityMetricList": [ { "MetricSetDataQualityMetricList": [ { "DataQualityMetricList": [ { "MetricDescription": "string", "MetricType": "string", "MetricValue": number, "RelatedColumnName": "string" } ], "MetricSetArn": "string" } ], "StartTimestamp": number } ] }

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.

AnomalyDetectorDataQualityMetricList

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

Type: Array of AnomalyDetectorDataQualityMetric objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found. Check the ARN of the resource and try again.

HTTP Status Code: 400

TooManyRequestsException

The request was denied due to too many requests being submitted at the same time.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: