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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List all rulesets available in the current account or rulesets associated with a specific resource (dataset).

This operation returns paginated results.

Creating a Request

data ListRulesets Source #

See: newListRulesets smart constructor.

Constructors

ListRulesets'

Fields

maxResults :: Maybe Natural
The maximum number of results to return in this request.
nextToken :: Maybe Text
A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.
targetArn :: Maybe Text
The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter indicates to return only those rulesets that are associated with the specified resource.

Instances

Instances details

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

newListRulesets :: ListRulesets Source #

Create a value of ListRulesets 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:maxResults:ListRulesets', listRulesets_maxResults - The maximum number of results to return in this request.

ListRulesets, listRulesets_nextToken - A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

ListRulesets, listRulesets_targetArn - The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter indicates to return only those rulesets that are associated with the specified resource.

Request Lenses

listRulesets_maxResults :: Lens' ListRulesets (Maybe Natural) Source #

The maximum number of results to return in this request.

listRulesets_nextToken :: Lens' ListRulesets (Maybe Text) Source #

A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

listRulesets_targetArn :: Lens' ListRulesets (Maybe Text) Source #

The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter indicates to return only those rulesets that are associated with the specified resource.

Destructuring the Response

data ListRulesetsResponse Source #

See: newListRulesetsResponse smart constructor.

Constructors

ListRulesetsResponse'
Fields nextToken :: Maybe Text A token that you can use in a subsequent call to retrieve the next set of results. httpStatus :: Int The response's http status code. rulesets :: [RulesetItem] A list of RulesetItem. RulesetItem contains meta data of a ruleset.

Instances

Instances details

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

newListRulesetsResponse Source #

Arguments

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

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

ListRulesets, listRulesetsResponse_nextToken - A token that you can use in a subsequent call to retrieve the next set of results.

$sel:httpStatus:ListRulesetsResponse', listRulesetsResponse_httpStatus - The response's http status code.

$sel:rulesets:ListRulesetsResponse', listRulesetsResponse_rulesets - A list of RulesetItem. RulesetItem contains meta data of a ruleset.

Response Lenses

listRulesetsResponse_nextToken :: Lens' ListRulesetsResponse (Maybe Text) Source #

A token that you can use in a subsequent call to retrieve the next set of results.

listRulesetsResponse_httpStatus :: Lens' ListRulesetsResponse Int Source #

The response's http status code.

listRulesetsResponse_rulesets :: Lens' ListRulesetsResponse [RulesetItem] Source #

A list of RulesetItem. RulesetItem contains meta data of a ruleset.