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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.

Synopsis

Creating a Request

data StartDataQualityRuleRecommendationRun Source #

See: newStartDataQualityRuleRecommendationRun smart constructor.

Constructors

StartDataQualityRuleRecommendationRun'

Fields

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.
createdRulesetName :: Maybe Text
A name for the ruleset.
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.

Instances

Instances details

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

newStartDataQualityRuleRecommendationRun Source #

Arguments

:: DataSource	`StartDataQualityRuleRecommendationRun`
-> Text	`StartDataQualityRuleRecommendationRun`
-> StartDataQualityRuleRecommendationRun

Create a value of StartDataQualityRuleRecommendationRun 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:clientToken:StartDataQualityRuleRecommendationRun', startDataQualityRuleRecommendationRun_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.

$sel:createdRulesetName:StartDataQualityRuleRecommendationRun', startDataQualityRuleRecommendationRun_createdRulesetName - A name for the ruleset.

StartDataQualityRuleRecommendationRun, startDataQualityRuleRecommendationRun_numberOfWorkers - The number of G.1X workers to be used in the run. The default is 5.

StartDataQualityRuleRecommendationRun, startDataQualityRuleRecommendationRun_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).

StartDataQualityRuleRecommendationRun, startDataQualityRuleRecommendationRun_dataSource - The data source (Glue table) associated with this run.

StartDataQualityRuleRecommendationRun, startDataQualityRuleRecommendationRun_role - An IAM role supplied to encrypt the results of the run.

Request Lenses

startDataQualityRuleRecommendationRun_clientToken :: Lens' StartDataQualityRuleRecommendationRun (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.

startDataQualityRuleRecommendationRun_createdRulesetName :: Lens' StartDataQualityRuleRecommendationRun (Maybe Text) Source #

A name for the ruleset.

startDataQualityRuleRecommendationRun_numberOfWorkers :: Lens' StartDataQualityRuleRecommendationRun (Maybe Int) Source #

The number of G.1X workers to be used in the run. The default is 5.

startDataQualityRuleRecommendationRun_timeout :: Lens' StartDataQualityRuleRecommendationRun (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).

startDataQualityRuleRecommendationRun_dataSource :: Lens' StartDataQualityRuleRecommendationRun DataSource Source #

The data source (Glue table) associated with this run.

startDataQualityRuleRecommendationRun_role :: Lens' StartDataQualityRuleRecommendationRun Text Source #

An IAM role supplied to encrypt the results of the run.

Destructuring the Response

data StartDataQualityRuleRecommendationRunResponse Source #

See: newStartDataQualityRuleRecommendationRunResponse smart constructor.

Constructors

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

Instances

Instances details

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

newStartDataQualityRuleRecommendationRunResponse Source #

Arguments

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

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

StartDataQualityRuleRecommendationRunResponse, startDataQualityRuleRecommendationRunResponse_runId - The unique run identifier associated with this run.

$sel:httpStatus:StartDataQualityRuleRecommendationRunResponse', startDataQualityRuleRecommendationRunResponse_httpStatus - The response's http status code.

Response Lenses

startDataQualityRuleRecommendationRunResponse_runId :: Lens' StartDataQualityRuleRecommendationRunResponse (Maybe Text) Source #

The unique run identifier associated with this run.

startDataQualityRuleRecommendationRunResponse_httpStatus :: Lens' StartDataQualityRuleRecommendationRunResponse Int Source #

The response's http status code.