Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.FraudDetector.GetRules

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified.

This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.

Synopsis

data GetRules = GetRules' {
- ruleVersion :: Maybe Text
- ruleId :: Maybe Text
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- detectorId :: Text
}
newGetRules :: Text -> GetRules
getRules_ruleVersion :: Lens' GetRules (Maybe Text)
getRules_ruleId :: Lens' GetRules (Maybe Text)
getRules_nextToken :: Lens' GetRules (Maybe Text)
getRules_maxResults :: Lens' GetRules (Maybe Natural)
getRules_detectorId :: Lens' GetRules Text
data GetRulesResponse = GetRulesResponse' {
- ruleDetails :: Maybe [RuleDetail]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetRulesResponse :: Int -> GetRulesResponse
getRulesResponse_ruleDetails :: Lens' GetRulesResponse (Maybe [RuleDetail])
getRulesResponse_nextToken :: Lens' GetRulesResponse (Maybe Text)
getRulesResponse_httpStatus :: Lens' GetRulesResponse Int

Creating a Request

data GetRules Source #

See: newGetRules smart constructor.

Constructors

GetRules'
Fields ruleVersion :: Maybe Text The rule version. ruleId :: Maybe Text The rule ID. nextToken :: Maybe Text The next page token. maxResults :: Maybe Natural The maximum number of rules to return for the request. detectorId :: Text The detector ID.

Instances

Instances details

Eq GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods (==) :: GetRules -> GetRules -> Bool # (/=) :: GetRules -> GetRules -> Bool #
Read GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods readsPrec :: Int -> ReadS GetRules # readList :: ReadS [GetRules] # readPrec :: ReadPrec GetRules # readListPrec :: ReadPrec [GetRules] #
Show GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods showsPrec :: Int -> GetRules -> ShowS # show :: GetRules -> String # showList :: [GetRules] -> ShowS #
Generic GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Associated Types type Rep GetRules :: Type -> Type # Methods from :: GetRules -> Rep GetRules x # to :: Rep GetRules x -> GetRules #
NFData GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods rnf :: GetRules -> () #
Hashable GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods hashWithSalt :: Int -> GetRules -> Int # hash :: GetRules -> Int #
ToJSON GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods toJSON :: GetRules -> Value # toEncoding :: GetRules -> Encoding # toJSONList :: [GetRules] -> Value # toEncodingList :: [GetRules] -> Encoding #
AWSRequest GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Associated Types type AWSResponse GetRules # Methods request :: GetRules -> Request GetRules # response :: MonadResource m => Logger -> Service -> Proxy GetRules -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRules))) #
ToHeaders GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods toHeaders :: GetRules -> [Header] #
ToPath GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods toPath :: GetRules -> ByteString #
ToQuery GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods toQuery :: GetRules -> QueryString #
type Rep GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules type Rep GetRules = D1 ('MetaData "GetRules" "Amazonka.FraudDetector.GetRules" "libZSservicesZSamazonka-frauddetectorZSamazonka-frauddetector" 'False) (C1 ('MetaCons "GetRules'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ruleVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse GetRules Source #
Instance details Defined in Amazonka.FraudDetector.GetRules type AWSResponse GetRules = GetRulesResponse

newGetRules Source #

Arguments

:: Text	`$sel:detectorId:GetRules'`
-> GetRules

Create a value of GetRules 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:ruleVersion:GetRules', getRules_ruleVersion - The rule version.

$sel:ruleId:GetRules', getRules_ruleId - The rule ID.

$sel:nextToken:GetRules', getRules_nextToken - The next page token.

$sel:maxResults:GetRules', getRules_maxResults - The maximum number of rules to return for the request.

$sel:detectorId:GetRules', getRules_detectorId - The detector ID.

Request Lenses

getRules_ruleVersion :: Lens' GetRules (Maybe Text) Source #

The rule version.

getRules_ruleId :: Lens' GetRules (Maybe Text) Source #

The rule ID.

getRules_nextToken :: Lens' GetRules (Maybe Text) Source #

The next page token.

getRules_maxResults :: Lens' GetRules (Maybe Natural) Source #

The maximum number of rules to return for the request.

getRules_detectorId :: Lens' GetRules Text Source #

The detector ID.

Destructuring the Response

data GetRulesResponse Source #

See: newGetRulesResponse smart constructor.

Constructors

GetRulesResponse'
Fields ruleDetails :: Maybe [RuleDetail] The details of the requested rule. nextToken :: Maybe Text The next page token to be used in subsequent requests. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetRulesResponse Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods (==) :: GetRulesResponse -> GetRulesResponse -> Bool # (/=) :: GetRulesResponse -> GetRulesResponse -> Bool #
Show GetRulesResponse Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods showsPrec :: Int -> GetRulesResponse -> ShowS # show :: GetRulesResponse -> String # showList :: [GetRulesResponse] -> ShowS #
Generic GetRulesResponse Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Associated Types type Rep GetRulesResponse :: Type -> Type # Methods from :: GetRulesResponse -> Rep GetRulesResponse x # to :: Rep GetRulesResponse x -> GetRulesResponse #
NFData GetRulesResponse Source #
Instance details Defined in Amazonka.FraudDetector.GetRules Methods rnf :: GetRulesResponse -> () #
type Rep GetRulesResponse Source #
Instance details Defined in Amazonka.FraudDetector.GetRules type Rep GetRulesResponse = D1 ('MetaData "GetRulesResponse" "Amazonka.FraudDetector.GetRules" "libZSservicesZSamazonka-frauddetectorZSamazonka-frauddetector" 'False) (C1 ('MetaCons "GetRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RuleDetail])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRulesResponse Source #

Arguments

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

Create a value of GetRulesResponse 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:ruleDetails:GetRulesResponse', getRulesResponse_ruleDetails - The details of the requested rule.

$sel:nextToken:GetRules', getRulesResponse_nextToken - The next page token to be used in subsequent requests.

$sel:httpStatus:GetRulesResponse', getRulesResponse_httpStatus - The response's http status code.

Response Lenses

getRulesResponse_ruleDetails :: Lens' GetRulesResponse (Maybe [RuleDetail]) Source #

The details of the requested rule.

getRulesResponse_nextToken :: Lens' GetRulesResponse (Maybe Text) Source #

The next page token to be used in subsequent requests.

getRulesResponse_httpStatus :: Lens' GetRulesResponse Int Source #

The response's http status code.