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.GetDataQualityResult

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the result of a data quality rule evaluation.

Synopsis

data GetDataQualityResult = GetDataQualityResult' {
- resultId :: Text
}
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.

Constructors

GetDataQualityResult'
Fields resultId :: Text A unique result ID for the data quality result.

Instances

Instances details

ToJSON GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods toJSON :: GetDataQualityResult -> Value # toEncoding :: GetDataQualityResult -> Encoding # toJSONList :: [GetDataQualityResult] -> Value # toEncodingList :: [GetDataQualityResult] -> Encoding #
ToHeaders GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods toHeaders :: GetDataQualityResult -> [Header] #
ToPath GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods toPath :: GetDataQualityResult -> ByteString #
ToQuery GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods toQuery :: GetDataQualityResult -> QueryString #
AWSRequest GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Associated Types type AWSResponse GetDataQualityResult # Methods request :: (Service -> Service) -> GetDataQualityResult -> Request GetDataQualityResult # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDataQualityResult -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDataQualityResult))) #
Generic GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Associated Types type Rep GetDataQualityResult :: Type -> Type # Methods from :: GetDataQualityResult -> Rep GetDataQualityResult x # to :: Rep GetDataQualityResult x -> GetDataQualityResult #
Read GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods readsPrec :: Int -> ReadS GetDataQualityResult # readList :: ReadS [GetDataQualityResult] # readPrec :: ReadPrec GetDataQualityResult # readListPrec :: ReadPrec [GetDataQualityResult] #
Show GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods showsPrec :: Int -> GetDataQualityResult -> ShowS # show :: GetDataQualityResult -> String # showList :: [GetDataQualityResult] -> ShowS #
NFData GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods rnf :: GetDataQualityResult -> () #
Eq GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods (==) :: GetDataQualityResult -> GetDataQualityResult -> Bool # (/=) :: GetDataQualityResult -> GetDataQualityResult -> Bool #
Hashable GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods hashWithSalt :: Int -> GetDataQualityResult -> Int # hash :: GetDataQualityResult -> Int #
type AWSResponse GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult type AWSResponse GetDataQualityResult = GetDataQualityResultResponse
type Rep GetDataQualityResult Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult type Rep GetDataQualityResult = D1 ('MetaData "GetDataQualityResult" "Amazonka.Glue.GetDataQualityResult" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetDataQualityResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resultId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetDataQualityResult Source #

Arguments

:: Text	`GetDataQualityResult`
-> GetDataQualityResult

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.

Constructors

GetDataQualityResultResponse'

Fields

completedOn :: Maybe POSIX
The date and time when the run for this data quality result was 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 associated with the ruleset evaluation.
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 the run for this data quality result started.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetDataQualityResultResponse Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Associated Types type Rep GetDataQualityResultResponse :: Type -> Type # Methods from :: GetDataQualityResultResponse -> Rep GetDataQualityResultResponse x # to :: Rep GetDataQualityResultResponse x -> GetDataQualityResultResponse #
Read GetDataQualityResultResponse Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods readsPrec :: Int -> ReadS GetDataQualityResultResponse # readList :: ReadS [GetDataQualityResultResponse] # readPrec :: ReadPrec GetDataQualityResultResponse # readListPrec :: ReadPrec [GetDataQualityResultResponse] #
Show GetDataQualityResultResponse Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods showsPrec :: Int -> GetDataQualityResultResponse -> ShowS # show :: GetDataQualityResultResponse -> String # showList :: [GetDataQualityResultResponse] -> ShowS #
NFData GetDataQualityResultResponse Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods rnf :: GetDataQualityResultResponse -> () #
Eq GetDataQualityResultResponse Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult Methods (==) :: GetDataQualityResultResponse -> GetDataQualityResultResponse -> Bool # (/=) :: GetDataQualityResultResponse -> GetDataQualityResultResponse -> Bool #
type Rep GetDataQualityResultResponse Source #
Instance details Defined in Amazonka.Glue.GetDataQualityResult type Rep GetDataQualityResultResponse = D1 ('MetaData "GetDataQualityResultResponse" "Amazonka.Glue.GetDataQualityResult" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetDataQualityResultResponse'" '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)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetDataQualityResultResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDataQualityResultResponse'`
-> GetDataQualityResultResponse

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.