Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Retrieves the result of a data quality rule evaluation.
Synopsis
- data GetDataQualityResult = GetDataQualityResult' {}
- newGetDataQualityResult :: Text -> GetDataQualityResult
- getDataQualityResult_resultId :: Lens' GetDataQualityResult Text
- data GetDataQualityResultResponse = GetDataQualityResultResponse' {
- completedOn :: Maybe POSIX
- dataSource :: Maybe DataSource
- evaluationContext :: Maybe Text
- jobName :: Maybe Text
- jobRunId :: Maybe Text
- resultId :: Maybe Text
- ruleResults :: Maybe (NonEmpty DataQualityRuleResult)
- rulesetEvaluationRunId :: Maybe Text
- rulesetName :: Maybe Text
- score :: Maybe Double
- startedOn :: Maybe POSIX
- httpStatus :: Int
- newGetDataQualityResultResponse :: Int -> GetDataQualityResultResponse
- getDataQualityResultResponse_completedOn :: Lens' GetDataQualityResultResponse (Maybe UTCTime)
- getDataQualityResultResponse_dataSource :: Lens' GetDataQualityResultResponse (Maybe DataSource)
- getDataQualityResultResponse_evaluationContext :: Lens' GetDataQualityResultResponse (Maybe Text)
- getDataQualityResultResponse_jobName :: Lens' GetDataQualityResultResponse (Maybe Text)
- getDataQualityResultResponse_jobRunId :: Lens' GetDataQualityResultResponse (Maybe Text)
- getDataQualityResultResponse_resultId :: Lens' GetDataQualityResultResponse (Maybe Text)
- getDataQualityResultResponse_ruleResults :: Lens' GetDataQualityResultResponse (Maybe (NonEmpty DataQualityRuleResult))
- getDataQualityResultResponse_rulesetEvaluationRunId :: Lens' GetDataQualityResultResponse (Maybe Text)
- getDataQualityResultResponse_rulesetName :: Lens' GetDataQualityResultResponse (Maybe Text)
- getDataQualityResultResponse_score :: Lens' GetDataQualityResultResponse (Maybe Double)
- getDataQualityResultResponse_startedOn :: Lens' GetDataQualityResultResponse (Maybe UTCTime)
- getDataQualityResultResponse_httpStatus :: Lens' GetDataQualityResultResponse Int
Creating a Request
data GetDataQualityResult Source #
See: newGetDataQualityResult
smart constructor.
Instances
newGetDataQualityResult Source #
Create a value of GetDataQualityResult
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDataQualityResult
, getDataQualityResult_resultId
- A unique result ID for the data quality result.
Request Lenses
getDataQualityResult_resultId :: Lens' GetDataQualityResult Text Source #
A unique result ID for the data quality result.
Destructuring the Response
data GetDataQualityResultResponse Source #
See: newGetDataQualityResultResponse
smart constructor.
GetDataQualityResultResponse' | |
|
Instances
newGetDataQualityResultResponse Source #
Create a value of GetDataQualityResultResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDataQualityResultResponse
, getDataQualityResultResponse_completedOn
- The date and time when the run for this data quality result was
completed.
GetDataQualityResultResponse
, getDataQualityResultResponse_dataSource
- The table associated with the data quality result, if any.
GetDataQualityResultResponse
, getDataQualityResultResponse_evaluationContext
- In the context of a job in Glue Studio, each node in the canvas is
typically assigned some sort of name and data quality nodes will have
names. In the case of multiple nodes, the evaluationContext
can
differentiate the nodes.
GetDataQualityResultResponse
, getDataQualityResultResponse_jobName
- The job name associated with the data quality result, if any.
GetDataQualityResultResponse
, getDataQualityResultResponse_jobRunId
- The job run ID associated with the data quality result, if any.
GetDataQualityResult
, getDataQualityResultResponse_resultId
- A unique result ID for the data quality result.
GetDataQualityResultResponse
, getDataQualityResultResponse_ruleResults
- A list of DataQualityRuleResult
objects representing the results for
each rule.
GetDataQualityResultResponse
, getDataQualityResultResponse_rulesetEvaluationRunId
- The unique run ID associated with the ruleset evaluation.
GetDataQualityResultResponse
, getDataQualityResultResponse_rulesetName
- The name of the ruleset associated with the data quality result.
GetDataQualityResultResponse
, getDataQualityResultResponse_score
- An aggregate data quality score. Represents the ratio of rules that
passed to the total number of rules.
GetDataQualityResultResponse
, getDataQualityResultResponse_startedOn
- The date and time when the run for this data quality result started.
$sel:httpStatus:GetDataQualityResultResponse'
, getDataQualityResultResponse_httpStatus
- The response's http status code.
Response Lenses
getDataQualityResultResponse_completedOn :: Lens' GetDataQualityResultResponse (Maybe UTCTime) Source #
The date and time when the run for this data quality result was completed.
getDataQualityResultResponse_dataSource :: Lens' GetDataQualityResultResponse (Maybe DataSource) Source #
The table associated with the data quality result, if any.
getDataQualityResultResponse_evaluationContext :: Lens' GetDataQualityResultResponse (Maybe Text) Source #
In the context of a job in Glue Studio, each node in the canvas is
typically assigned some sort of name and data quality nodes will have
names. In the case of multiple nodes, the evaluationContext
can
differentiate the nodes.
getDataQualityResultResponse_jobName :: Lens' GetDataQualityResultResponse (Maybe Text) Source #
The job name associated with the data quality result, if any.
getDataQualityResultResponse_jobRunId :: Lens' GetDataQualityResultResponse (Maybe Text) Source #
The job run ID associated with the data quality result, if any.
getDataQualityResultResponse_resultId :: Lens' GetDataQualityResultResponse (Maybe Text) Source #
A unique result ID for the data quality result.
getDataQualityResultResponse_ruleResults :: Lens' GetDataQualityResultResponse (Maybe (NonEmpty DataQualityRuleResult)) Source #
A list of DataQualityRuleResult
objects representing the results for
each rule.
getDataQualityResultResponse_rulesetEvaluationRunId :: Lens' GetDataQualityResultResponse (Maybe Text) Source #
The unique run ID associated with the ruleset evaluation.
getDataQualityResultResponse_rulesetName :: Lens' GetDataQualityResultResponse (Maybe Text) Source #
The name of the ruleset associated with the data quality result.
getDataQualityResultResponse_score :: Lens' GetDataQualityResultResponse (Maybe Double) Source #
An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
getDataQualityResultResponse_startedOn :: Lens' GetDataQualityResultResponse (Maybe UTCTime) Source #
The date and time when the run for this data quality result started.
getDataQualityResultResponse_httpStatus :: Lens' GetDataQualityResultResponse Int Source #
The response's http status code.