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

Amazonka.Glue.Types.DataQualityResult

Description

Synopsis

data DataQualityResult = DataQualityResult' {
- 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
}
newDataQualityResult :: DataQualityResult
dataQualityResult_completedOn :: Lens' DataQualityResult (Maybe UTCTime)
dataQualityResult_dataSource :: Lens' DataQualityResult (Maybe DataSource)
dataQualityResult_evaluationContext :: Lens' DataQualityResult (Maybe Text)
dataQualityResult_jobName :: Lens' DataQualityResult (Maybe Text)
dataQualityResult_jobRunId :: Lens' DataQualityResult (Maybe Text)
dataQualityResult_resultId :: Lens' DataQualityResult (Maybe Text)
dataQualityResult_ruleResults :: Lens' DataQualityResult (Maybe (NonEmpty DataQualityRuleResult))
dataQualityResult_rulesetEvaluationRunId :: Lens' DataQualityResult (Maybe Text)
dataQualityResult_rulesetName :: Lens' DataQualityResult (Maybe Text)
dataQualityResult_score :: Lens' DataQualityResult (Maybe Double)
dataQualityResult_startedOn :: Lens' DataQualityResult (Maybe UTCTime)

Documentation

data DataQualityResult Source #

Describes a data quality result.

See: newDataQualityResult smart constructor.

Constructors

DataQualityResult'

Fields

completedOn :: Maybe POSIX
The date and time when this data quality run completed.
dataSource :: Maybe DataSource
The table associated with the data quality result, if any.
evaluationContext :: Maybe Text
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.
jobName :: Maybe Text
The job name associated with the data quality result, if any.
jobRunId :: Maybe Text
The job run ID associated with the data quality result, if any.
resultId :: Maybe Text
A unique result ID for the data quality result.
ruleResults :: Maybe (NonEmpty DataQualityRuleResult)
A list of DataQualityRuleResult objects representing the results for each rule.
rulesetEvaluationRunId :: Maybe Text
The unique run ID for the ruleset evaluation for this data quality result.
rulesetName :: Maybe Text
The name of the ruleset associated with the data quality result.
score :: Maybe Double
An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
startedOn :: Maybe POSIX
The date and time when this data quality run started.

Instances

Instances details

FromJSON DataQualityResult Source #
Instance details Defined in Amazonka.Glue.Types.DataQualityResult Methods parseJSON :: Value -> Parser DataQualityResult # parseJSONList :: Value -> Parser [DataQualityResult] #
Generic DataQualityResult Source #
Instance details Defined in Amazonka.Glue.Types.DataQualityResult Associated Types type Rep DataQualityResult :: Type -> Type # Methods from :: DataQualityResult -> Rep DataQualityResult x # to :: Rep DataQualityResult x -> DataQualityResult #
Read DataQualityResult Source #
Instance details Defined in Amazonka.Glue.Types.DataQualityResult Methods readsPrec :: Int -> ReadS DataQualityResult # readList :: ReadS [DataQualityResult] # readPrec :: ReadPrec DataQualityResult # readListPrec :: ReadPrec [DataQualityResult] #
Show DataQualityResult Source #
Instance details Defined in Amazonka.Glue.Types.DataQualityResult Methods showsPrec :: Int -> DataQualityResult -> ShowS # show :: DataQualityResult -> String # showList :: [DataQualityResult] -> ShowS #
NFData DataQualityResult Source #
Instance details Defined in Amazonka.Glue.Types.DataQualityResult Methods rnf :: DataQualityResult -> () #
Eq DataQualityResult Source #
Instance details Defined in Amazonka.Glue.Types.DataQualityResult Methods (==) :: DataQualityResult -> DataQualityResult -> Bool # (/=) :: DataQualityResult -> DataQualityResult -> Bool #
Hashable DataQualityResult Source #
Instance details Defined in Amazonka.Glue.Types.DataQualityResult Methods hashWithSalt :: Int -> DataQualityResult -> Int # hash :: DataQualityResult -> Int #
type Rep DataQualityResult Source #
Instance details Defined in Amazonka.Glue.Types.DataQualityResult type Rep DataQualityResult = D1 ('MetaData "DataQualityResult" "Amazonka.Glue.Types.DataQualityResult" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "DataQualityResult'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "completedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSource))) :: (S1 ('MetaSel ('Just "evaluationContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobRunId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "resultId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ruleResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataQualityRuleResult))) :: S1 ('MetaSel ('Just "rulesetEvaluationRunId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "rulesetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "startedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newDataQualityResult :: DataQualityResult Source #

Create a value of DataQualityResult 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:

$sel:completedOn:DataQualityResult', dataQualityResult_completedOn - The date and time when this data quality run completed.

$sel:dataSource:DataQualityResult', dataQualityResult_dataSource - The table associated with the data quality result, if any.

$sel:evaluationContext:DataQualityResult', dataQualityResult_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.

$sel:jobName:DataQualityResult', dataQualityResult_jobName - The job name associated with the data quality result, if any.

$sel:jobRunId:DataQualityResult', dataQualityResult_jobRunId - The job run ID associated with the data quality result, if any.

$sel:resultId:DataQualityResult', dataQualityResult_resultId - A unique result ID for the data quality result.

$sel:ruleResults:DataQualityResult', dataQualityResult_ruleResults - A list of DataQualityRuleResult objects representing the results for each rule.

$sel:rulesetEvaluationRunId:DataQualityResult', dataQualityResult_rulesetEvaluationRunId - The unique run ID for the ruleset evaluation for this data quality result.

$sel:rulesetName:DataQualityResult', dataQualityResult_rulesetName - The name of the ruleset associated with the data quality result.

$sel:score:DataQualityResult', dataQualityResult_score - An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.

$sel:startedOn:DataQualityResult', dataQualityResult_startedOn - The date and time when this data quality run started.

dataQualityResult_completedOn :: Lens' DataQualityResult (Maybe UTCTime) Source #

The date and time when this data quality run completed.

dataQualityResult_dataSource :: Lens' DataQualityResult (Maybe DataSource) Source #

The table associated with the data quality result, if any.

dataQualityResult_evaluationContext :: Lens' DataQualityResult (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.

dataQualityResult_jobName :: Lens' DataQualityResult (Maybe Text) Source #

The job name associated with the data quality result, if any.

dataQualityResult_jobRunId :: Lens' DataQualityResult (Maybe Text) Source #

The job run ID associated with the data quality result, if any.

dataQualityResult_resultId :: Lens' DataQualityResult (Maybe Text) Source #

A unique result ID for the data quality result.

dataQualityResult_ruleResults :: Lens' DataQualityResult (Maybe (NonEmpty DataQualityRuleResult)) Source #

A list of DataQualityRuleResult objects representing the results for each rule.

dataQualityResult_rulesetEvaluationRunId :: Lens' DataQualityResult (Maybe Text) Source #

The unique run ID for the ruleset evaluation for this data quality result.

dataQualityResult_rulesetName :: Lens' DataQualityResult (Maybe Text) Source #

The name of the ruleset associated with the data quality result.

dataQualityResult_score :: Lens' DataQualityResult (Maybe Double) Source #

An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.

dataQualityResult_startedOn :: Lens' DataQualityResult (Maybe UTCTime) Source #

The date and time when this data quality run started.