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.DataBrew.CreateRuleset

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.

Synopsis

data CreateRuleset = CreateRuleset' {
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- name :: Text
- targetArn :: Text
- rules :: NonEmpty Rule
}
newCreateRuleset :: Text -> Text -> NonEmpty Rule -> CreateRuleset
createRuleset_description :: Lens' CreateRuleset (Maybe Text)
createRuleset_tags :: Lens' CreateRuleset (Maybe (HashMap Text Text))
createRuleset_name :: Lens' CreateRuleset Text
createRuleset_targetArn :: Lens' CreateRuleset Text
createRuleset_rules :: Lens' CreateRuleset (NonEmpty Rule)
data CreateRulesetResponse = CreateRulesetResponse' {
- httpStatus :: Int
- name :: Text
}
newCreateRulesetResponse :: Int -> Text -> CreateRulesetResponse
createRulesetResponse_httpStatus :: Lens' CreateRulesetResponse Int
createRulesetResponse_name :: Lens' CreateRulesetResponse Text

Creating a Request

data CreateRuleset Source #

See: newCreateRuleset smart constructor.

Constructors

CreateRuleset'

Fields

description :: Maybe Text
The description of the ruleset.
tags :: Maybe (HashMap Text Text)
Metadata tags to apply to the ruleset.
name :: Text
The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
targetArn :: Text
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
rules :: NonEmpty Rule
A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

Instances

Instances details

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

newCreateRuleset Source #

Arguments

:: Text	`CreateRuleset`
-> Text	`CreateRuleset`
-> NonEmpty Rule	`$sel:rules:CreateRuleset'`
-> CreateRuleset

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

CreateRuleset, createRuleset_description - The description of the ruleset.

CreateRuleset, createRuleset_tags - Metadata tags to apply to the ruleset.

CreateRuleset, createRuleset_name - The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

CreateRuleset, createRuleset_targetArn - The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

$sel:rules:CreateRuleset', createRuleset_rules - A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

Request Lenses

createRuleset_description :: Lens' CreateRuleset (Maybe Text) Source #

The description of the ruleset.

createRuleset_tags :: Lens' CreateRuleset (Maybe (HashMap Text Text)) Source #

Metadata tags to apply to the ruleset.

createRuleset_name :: Lens' CreateRuleset Text Source #

The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

createRuleset_targetArn :: Lens' CreateRuleset Text Source #

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

createRuleset_rules :: Lens' CreateRuleset (NonEmpty Rule) Source #

A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

Destructuring the Response

data CreateRulesetResponse Source #

See: newCreateRulesetResponse smart constructor.

Constructors

CreateRulesetResponse'
Fields httpStatus :: Int The response's http status code. name :: Text The unique name of the created ruleset.

Instances

Instances details

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

newCreateRulesetResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateRulesetResponse'`
-> Text	`CreateRuleset`
-> CreateRulesetResponse

Create a value of CreateRulesetResponse 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:httpStatus:CreateRulesetResponse', createRulesetResponse_httpStatus - The response's http status code.

CreateRuleset, createRulesetResponse_name - The unique name of the created ruleset.

Response Lenses

createRulesetResponse_httpStatus :: Lens' CreateRulesetResponse Int Source #

The response's http status code.

createRulesetResponse_name :: Lens' CreateRulesetResponse Text Source #

The unique name of the created ruleset.