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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.

Creating a Request

data GetDetectors Source #

See: newGetDetectors smart constructor.

Constructors

GetDetectors'
Fields nextToken :: Maybe Text The next token for the subsequent request. detectorId :: Maybe Text The detector ID. maxResults :: Maybe Natural The maximum number of objects to return for the request.

Instances

Instances details

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

newGetDetectors :: GetDetectors Source #

Create a value of GetDetectors 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:nextToken:GetDetectors', getDetectors_nextToken - The next token for the subsequent request.

$sel:detectorId:GetDetectors', getDetectors_detectorId - The detector ID.

$sel:maxResults:GetDetectors', getDetectors_maxResults - The maximum number of objects to return for the request.

Request Lenses

getDetectors_nextToken :: Lens' GetDetectors (Maybe Text) Source #

The next token for the subsequent request.

getDetectors_detectorId :: Lens' GetDetectors (Maybe Text) Source #

The detector ID.

getDetectors_maxResults :: Lens' GetDetectors (Maybe Natural) Source #

The maximum number of objects to return for the request.

Destructuring the Response

data GetDetectorsResponse Source #

See: newGetDetectorsResponse smart constructor.

Constructors

GetDetectorsResponse'
Fields nextToken :: Maybe Text The next page token. detectors :: Maybe [Detector] The detectors. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetDetectorsResponse Source #

Arguments

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

Create a value of GetDetectorsResponse 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:nextToken:GetDetectors', getDetectorsResponse_nextToken - The next page token.

$sel:detectors:GetDetectorsResponse', getDetectorsResponse_detectors - The detectors.

$sel:httpStatus:GetDetectorsResponse', getDetectorsResponse_httpStatus - The response's http status code.

Response Lenses

getDetectorsResponse_nextToken :: Lens' GetDetectorsResponse (Maybe Text) Source #

The next page token.

getDetectorsResponse_detectors :: Lens' GetDetectorsResponse (Maybe [Detector]) Source #

The detectors.

getDetectorsResponse_httpStatus :: Lens' GetDetectorsResponse Int Source #

The response's http status code.