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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data StartDataQualityRulesetEvaluationRun Source #

See: newStartDataQualityRulesetEvaluationRun smart constructor.

Constructors

StartDataQualityRulesetEvaluationRun'

Fields

additionalRunOptions :: Maybe DataQualityEvaluationRunAdditionalRunOptions
Additional run options you can specify for an evaluation run.
clientToken :: Maybe Text
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.
numberOfWorkers :: Maybe Int
The number of G.1X workers to be used in the run. The default is 5.
timeout :: Maybe Natural
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).
dataSource :: DataSource
The data source (Glue table) associated with this run.
role' :: Text
An IAM role supplied to encrypt the results of the run.
rulesetNames :: NonEmpty Text
A list of ruleset names.

Instances

Instances details

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

newStartDataQualityRulesetEvaluationRun Source #

Arguments

:: DataSource	`StartDataQualityRulesetEvaluationRun`
-> Text	`StartDataQualityRulesetEvaluationRun`
-> NonEmpty Text	`$sel:rulesetNames:StartDataQualityRulesetEvaluationRun'`
-> StartDataQualityRulesetEvaluationRun

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.

Constructors

StartDataQualityRulesetEvaluationRunResponse'
Fields runId :: Maybe Text The unique run identifier associated with this run. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartDataQualityRulesetEvaluationRunResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartDataQualityRulesetEvaluationRunResponse'`
-> 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.