Amazonka.DataBrew.DescribeRuleset

Retrieves detailed information about the ruleset.

Creating a Request

data DescribeRuleset

See: newDescribeRuleset smart constructor.

Constructors

DescribeRuleset'

Fields

• name :: Text

  The name of the ruleset to be described.

Instances

ToHeaders DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

toHeaders :: DescribeRuleset -> [Header]

ToPath DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

toPath :: DescribeRuleset -> ByteString

ToQuery DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

toQuery :: DescribeRuleset -> QueryString

AWSRequest DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

Associated Types

type AWSResponse DescribeRuleset

Methods

request :: (Service -> Service) -> DescribeRuleset -> Request DescribeRuleset

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeRuleset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRuleset)))

Generic DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

Associated Types

type Rep DescribeRuleset :: Type -> Type

Methods

from :: DescribeRuleset -> Rep DescribeRuleset x

to :: Rep DescribeRuleset x -> DescribeRuleset

Read DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

readsPrec :: Int -> ReadS DescribeRuleset

readList :: ReadS [DescribeRuleset]

readPrec :: ReadPrec DescribeRuleset

readListPrec :: ReadPrec [DescribeRuleset]

Show DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

showsPrec :: Int -> DescribeRuleset -> ShowS

show :: DescribeRuleset -> String

showList :: [DescribeRuleset] -> ShowS

NFData DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

rnf :: DescribeRuleset -> ()

Eq DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

(==) :: DescribeRuleset -> DescribeRuleset -> Bool

(/=) :: DescribeRuleset -> DescribeRuleset -> Bool

Hashable DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

hashWithSalt :: Int -> DescribeRuleset -> Int

hash :: DescribeRuleset -> Int

type AWSResponse DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

type AWSResponse DescribeRuleset = DescribeRulesetResponse

type Rep DescribeRuleset

Defined in Amazonka.DataBrew.DescribeRuleset

type Rep DescribeRuleset = D1 ('MetaData "DescribeRuleset" "Amazonka.DataBrew.DescribeRuleset" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "DescribeRuleset'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeRuleset

Arguments

:: Text

DescribeRuleset

-> DescribeRuleset

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

DescribeRuleset, describeRuleset_name - The name of the ruleset to be described.

Request Lenses

describeRuleset_name :: Lens' DescribeRuleset Text

The name of the ruleset to be described.

Destructuring the Response

data DescribeRulesetResponse

See: newDescribeRulesetResponse smart constructor.

Constructors

DescribeRulesetResponse'

Fields

• createDate :: Maybe POSIX

  The date and time that the ruleset was created.

• createdBy :: Maybe Text

  The Amazon Resource Name (ARN) of the user who created the ruleset.

• description :: Maybe Text

  The description of the ruleset.

• lastModifiedBy :: Maybe Text

  The Amazon Resource Name (ARN) of the user who last modified the ruleset.

• lastModifiedDate :: Maybe POSIX

  The modification date and time of the ruleset.

• resourceArn :: Maybe Text

  The Amazon Resource Name (ARN) for the ruleset.

• rules :: Maybe (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.

• tags :: Maybe (HashMap Text Text)

  Metadata tags that have been applied to the ruleset.

• targetArn :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

• name :: Text

  The name of the ruleset.

Instances

Generic DescribeRulesetResponse

Defined in Amazonka.DataBrew.DescribeRuleset

Associated Types

type Rep DescribeRulesetResponse :: Type -> Type

Methods

from :: DescribeRulesetResponse -> Rep DescribeRulesetResponse x

to :: Rep DescribeRulesetResponse x -> DescribeRulesetResponse

Read DescribeRulesetResponse

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

readsPrec :: Int -> ReadS DescribeRulesetResponse

readList :: ReadS [DescribeRulesetResponse]

readPrec :: ReadPrec DescribeRulesetResponse

readListPrec :: ReadPrec [DescribeRulesetResponse]

Show DescribeRulesetResponse

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

showsPrec :: Int -> DescribeRulesetResponse -> ShowS

show :: DescribeRulesetResponse -> String

showList :: [DescribeRulesetResponse] -> ShowS

NFData DescribeRulesetResponse

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

rnf :: DescribeRulesetResponse -> ()

Eq DescribeRulesetResponse

Defined in Amazonka.DataBrew.DescribeRuleset

Methods

(==) :: DescribeRulesetResponse -> DescribeRulesetResponse -> Bool

(/=) :: DescribeRulesetResponse -> DescribeRulesetResponse -> Bool

type Rep DescribeRulesetResponse

Defined in Amazonka.DataBrew.DescribeRuleset

type Rep DescribeRulesetResponse = D1 ('MetaData "DescribeRulesetResponse" "Amazonka.DataBrew.DescribeRuleset" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "DescribeRulesetResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Rule))) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: (S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribeRulesetResponse

Arguments

:: Int

$sel:httpStatus:DescribeRulesetResponse'

-> Text

DescribeRuleset

-> DescribeRulesetResponse

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

DescribeRulesetResponse, describeRulesetResponse_createDate - The date and time that the ruleset was created.

DescribeRulesetResponse, describeRulesetResponse_createdBy - The Amazon Resource Name (ARN) of the user who created the ruleset.

DescribeRulesetResponse, describeRulesetResponse_description - The description of the ruleset.

DescribeRulesetResponse, describeRulesetResponse_lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the ruleset.

DescribeRulesetResponse, describeRulesetResponse_lastModifiedDate - The modification date and time of the ruleset.

DescribeRulesetResponse, describeRulesetResponse_resourceArn - The Amazon Resource Name (ARN) for the ruleset.

$sel:rules:DescribeRulesetResponse', describeRulesetResponse_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.

DescribeRulesetResponse, describeRulesetResponse_tags - Metadata tags that have been applied to the ruleset.

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

$sel:httpStatus:DescribeRulesetResponse', describeRulesetResponse_httpStatus - The response's http status code.

DescribeRuleset, describeRulesetResponse_name - The name of the ruleset.

Response Lenses

describeRulesetResponse_createDate :: Lens' DescribeRulesetResponse (Maybe UTCTime)

The date and time that the ruleset was created.

describeRulesetResponse_createdBy :: Lens' DescribeRulesetResponse (Maybe Text)

The Amazon Resource Name (ARN) of the user who created the ruleset.

describeRulesetResponse_description :: Lens' DescribeRulesetResponse (Maybe Text)

The description of the ruleset.

describeRulesetResponse_lastModifiedBy :: Lens' DescribeRulesetResponse (Maybe Text)

The Amazon Resource Name (ARN) of the user who last modified the ruleset.

describeRulesetResponse_lastModifiedDate :: Lens' DescribeRulesetResponse (Maybe UTCTime)

The modification date and time of the ruleset.

describeRulesetResponse_resourceArn :: Lens' DescribeRulesetResponse (Maybe Text)

The Amazon Resource Name (ARN) for the ruleset.

describeRulesetResponse_rules :: Lens' DescribeRulesetResponse (Maybe (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.

describeRulesetResponse_tags :: Lens' DescribeRulesetResponse (Maybe (HashMap Text Text))

Metadata tags that have been applied to the ruleset.

describeRulesetResponse_targetArn :: Lens' DescribeRulesetResponse (Maybe Text)

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

describeRulesetResponse_httpStatus :: Lens' DescribeRulesetResponse Int

The response's http status code.

describeRulesetResponse_name :: Lens' DescribeRulesetResponse Text

The name of the ruleset.