Amazonka.FraudDetector.GetRules

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.

Creating a Request

data GetRules

See: newGetRules smart constructor.

Constructors

GetRules'

Fields

• maxResults :: Maybe Natural

  The maximum number of rules to return for the request.

• nextToken :: Maybe Text

  The next page token.

• ruleId :: Maybe Text

  The rule ID.

• ruleVersion :: Maybe Text

  The rule version.

• detectorId :: Text

  The detector ID.

Instances

ToJSON GetRules

Defined in Amazonka.FraudDetector.GetRules

Methods

toJSON :: GetRules -> Value

toEncoding :: GetRules -> Encoding

toJSONList :: [GetRules] -> Value

toEncodingList :: [GetRules] -> Encoding

ToHeaders GetRules

Defined in Amazonka.FraudDetector.GetRules

Methods

toHeaders :: GetRules -> [Header]

ToPath GetRules

Defined in Amazonka.FraudDetector.GetRules

Methods

toPath :: GetRules -> ByteString

ToQuery GetRules

Defined in Amazonka.FraudDetector.GetRules

Methods

toQuery :: GetRules -> QueryString

AWSRequest GetRules

Defined in Amazonka.FraudDetector.GetRules

Associated Types

type AWSResponse GetRules

Methods

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

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

Generic GetRules

Defined in Amazonka.FraudDetector.GetRules

Associated Types

type Rep GetRules :: Type -> Type

Methods

from :: GetRules -> Rep GetRules x

to :: Rep GetRules x -> GetRules

Read GetRules

Defined in Amazonka.FraudDetector.GetRules

Methods

readsPrec :: Int -> ReadS GetRules

readList :: ReadS [GetRules]

readPrec :: ReadPrec GetRules

readListPrec :: ReadPrec [GetRules]

Show GetRules

Defined in Amazonka.FraudDetector.GetRules

Methods

showsPrec :: Int -> GetRules -> ShowS

show :: GetRules -> String

showList :: [GetRules] -> ShowS

NFData GetRules

Defined in Amazonka.FraudDetector.GetRules

Methods

rnf :: GetRules -> ()

Eq GetRules

Defined in Amazonka.FraudDetector.GetRules

Methods

(==) :: GetRules -> GetRules -> Bool

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

Hashable GetRules

Defined in Amazonka.FraudDetector.GetRules

Methods

hashWithSalt :: Int -> GetRules -> Int

hash :: GetRules -> Int

type AWSResponse GetRules

Defined in Amazonka.FraudDetector.GetRules

type AWSResponse GetRules = GetRulesResponse

type Rep GetRules

Defined in Amazonka.FraudDetector.GetRules

type Rep GetRules = D1 ('MetaData "GetRules" "Amazonka.FraudDetector.GetRules" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "GetRules'" '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 "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ruleVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetRules

Arguments

:: Text

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:maxResults:GetRules', getRules_maxResults - The maximum number of rules to return for the request.

GetRules, getRules_nextToken - The next page token.

GetRules, getRules_ruleId - The rule ID.

GetRules, getRules_ruleVersion - The rule version.

GetRules, getRules_detectorId - The detector ID.

Request Lenses

getRules_maxResults :: Lens' GetRules (Maybe Natural)

The maximum number of rules to return for the request.

getRules_nextToken :: Lens' GetRules (Maybe Text)

The next page token.

getRules_ruleId :: Lens' GetRules (Maybe Text)

The rule ID.

getRules_ruleVersion :: Lens' GetRules (Maybe Text)

The rule version.

getRules_detectorId :: Lens' GetRules Text

The detector ID.

Destructuring the Response

data GetRulesResponse

See: newGetRulesResponse smart constructor.

Constructors

GetRulesResponse'

Fields

• nextToken :: Maybe Text

  The next page token to be used in subsequent requests.

• ruleDetails :: Maybe [RuleDetail]

  The details of the requested rule.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetRulesResponse

Defined in Amazonka.FraudDetector.GetRules

Associated Types

type Rep GetRulesResponse :: Type -> Type

Methods

from :: GetRulesResponse -> Rep GetRulesResponse x

to :: Rep GetRulesResponse x -> GetRulesResponse

Show GetRulesResponse

Defined in Amazonka.FraudDetector.GetRules

Methods

showsPrec :: Int -> GetRulesResponse -> ShowS

show :: GetRulesResponse -> String

showList :: [GetRulesResponse] -> ShowS

NFData GetRulesResponse

Defined in Amazonka.FraudDetector.GetRules

Methods

rnf :: GetRulesResponse -> ()

Eq GetRulesResponse

Defined in Amazonka.FraudDetector.GetRules

Methods

(==) :: GetRulesResponse -> GetRulesResponse -> Bool

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

type Rep GetRulesResponse

Defined in Amazonka.FraudDetector.GetRules

type Rep GetRulesResponse = D1 ('MetaData "GetRulesResponse" "Amazonka.FraudDetector.GetRules" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "GetRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ruleDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RuleDetail])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRulesResponse

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:

GetRules, getRulesResponse_nextToken - The next page token to be used in subsequent requests.

$sel:ruleDetails:GetRulesResponse', getRulesResponse_ruleDetails - The details of the requested rule.

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

Response Lenses

getRulesResponse_nextToken :: Lens' GetRulesResponse (Maybe Text)

The next page token to be used in subsequent requests.

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

The details of the requested rule.

getRulesResponse_httpStatus :: Lens' GetRulesResponse Int

The response's http status code.