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 |
Once you have a ruleset definition (either recommended or your own), you
call this operation to evaluate the ruleset against a data source (Glue
table). The evaluation computes results which you can retrieve with the
GetDataQualityResult
API.
Synopsis
- data StartDataQualityRulesetEvaluationRun = StartDataQualityRulesetEvaluationRun' {}
- newStartDataQualityRulesetEvaluationRun :: DataSource -> Text -> NonEmpty Text -> StartDataQualityRulesetEvaluationRun
- startDataQualityRulesetEvaluationRun_additionalRunOptions :: Lens' StartDataQualityRulesetEvaluationRun (Maybe DataQualityEvaluationRunAdditionalRunOptions)
- startDataQualityRulesetEvaluationRun_clientToken :: Lens' StartDataQualityRulesetEvaluationRun (Maybe Text)
- startDataQualityRulesetEvaluationRun_numberOfWorkers :: Lens' StartDataQualityRulesetEvaluationRun (Maybe Int)
- startDataQualityRulesetEvaluationRun_timeout :: Lens' StartDataQualityRulesetEvaluationRun (Maybe Natural)
- startDataQualityRulesetEvaluationRun_dataSource :: Lens' StartDataQualityRulesetEvaluationRun DataSource
- startDataQualityRulesetEvaluationRun_role :: Lens' StartDataQualityRulesetEvaluationRun Text
- startDataQualityRulesetEvaluationRun_rulesetNames :: Lens' StartDataQualityRulesetEvaluationRun (NonEmpty Text)
- data StartDataQualityRulesetEvaluationRunResponse = StartDataQualityRulesetEvaluationRunResponse' {
- runId :: Maybe Text
- httpStatus :: Int
- newStartDataQualityRulesetEvaluationRunResponse :: Int -> StartDataQualityRulesetEvaluationRunResponse
- startDataQualityRulesetEvaluationRunResponse_runId :: Lens' StartDataQualityRulesetEvaluationRunResponse (Maybe Text)
- startDataQualityRulesetEvaluationRunResponse_httpStatus :: Lens' StartDataQualityRulesetEvaluationRunResponse Int
Creating a Request
data StartDataQualityRulesetEvaluationRun Source #
See: newStartDataQualityRulesetEvaluationRun
smart constructor.
StartDataQualityRulesetEvaluationRun' | |
|
Instances
newStartDataQualityRulesetEvaluationRun Source #
Create a value of StartDataQualityRulesetEvaluationRun
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:additionalRunOptions:StartDataQualityRulesetEvaluationRun'
, startDataQualityRulesetEvaluationRun_additionalRunOptions
- Additional run options you can specify for an evaluation run.
$sel:clientToken:StartDataQualityRulesetEvaluationRun'
, startDataQualityRulesetEvaluationRun_clientToken
- Used for idempotency and is recommended to be set to a random ID (such
as a UUID) to avoid creating or starting multiple instances of the same
resource.
StartDataQualityRulesetEvaluationRun
, startDataQualityRulesetEvaluationRun_numberOfWorkers
- The number of G.1X
workers to be used in the run. The default is 5.
StartDataQualityRulesetEvaluationRun
, startDataQualityRulesetEvaluationRun_timeout
- The timeout for a run in minutes. This is the maximum time that a run
can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
StartDataQualityRulesetEvaluationRun
, startDataQualityRulesetEvaluationRun_dataSource
- The data source (Glue table) associated with this run.
StartDataQualityRulesetEvaluationRun
, startDataQualityRulesetEvaluationRun_role
- An IAM role supplied to encrypt the results of the run.
$sel:rulesetNames:StartDataQualityRulesetEvaluationRun'
, startDataQualityRulesetEvaluationRun_rulesetNames
- A list of ruleset names.
Request Lenses
startDataQualityRulesetEvaluationRun_additionalRunOptions :: Lens' StartDataQualityRulesetEvaluationRun (Maybe DataQualityEvaluationRunAdditionalRunOptions) Source #
Additional run options you can specify for an evaluation run.
startDataQualityRulesetEvaluationRun_clientToken :: Lens' StartDataQualityRulesetEvaluationRun (Maybe Text) Source #
Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
startDataQualityRulesetEvaluationRun_numberOfWorkers :: Lens' StartDataQualityRulesetEvaluationRun (Maybe Int) Source #
The number of G.1X
workers to be used in the run. The default is 5.
startDataQualityRulesetEvaluationRun_timeout :: Lens' StartDataQualityRulesetEvaluationRun (Maybe Natural) Source #
The timeout for a run in minutes. This is the maximum time that a run
can consume resources before it is terminated and enters TIMEOUT
status. The default is 2,880 minutes (48 hours).
startDataQualityRulesetEvaluationRun_dataSource :: Lens' StartDataQualityRulesetEvaluationRun DataSource Source #
The data source (Glue table) associated with this run.
startDataQualityRulesetEvaluationRun_role :: Lens' StartDataQualityRulesetEvaluationRun Text Source #
An IAM role supplied to encrypt the results of the run.
startDataQualityRulesetEvaluationRun_rulesetNames :: Lens' StartDataQualityRulesetEvaluationRun (NonEmpty Text) Source #
A list of ruleset names.
Destructuring the Response
data StartDataQualityRulesetEvaluationRunResponse Source #
See: newStartDataQualityRulesetEvaluationRunResponse
smart constructor.
StartDataQualityRulesetEvaluationRunResponse' | |
|
Instances
newStartDataQualityRulesetEvaluationRunResponse Source #
:: Int |
|
-> StartDataQualityRulesetEvaluationRunResponse |
Create a value of StartDataQualityRulesetEvaluationRunResponse
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:
StartDataQualityRulesetEvaluationRunResponse
, startDataQualityRulesetEvaluationRunResponse_runId
- The unique run identifier associated with this run.
$sel:httpStatus:StartDataQualityRulesetEvaluationRunResponse'
, startDataQualityRulesetEvaluationRunResponse_httpStatus
- The response's http status code.
Response Lenses
startDataQualityRulesetEvaluationRunResponse_runId :: Lens' StartDataQualityRulesetEvaluationRunResponse (Maybe Text) Source #
The unique run identifier associated with this run.
startDataQualityRulesetEvaluationRunResponse_httpStatus :: Lens' StartDataQualityRulesetEvaluationRunResponse Int Source #
The response's http status code.