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.FraudDetector.GetBatchPredictionJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets all batch prediction jobs or a specific job if you specify a job ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.

Synopsis

Creating a Request

data GetBatchPredictionJobs Source #

See: newGetBatchPredictionJobs smart constructor.

Constructors

GetBatchPredictionJobs'
Fields jobId :: Maybe Text The batch prediction job for which to get the details. maxResults :: Maybe Natural The maximum number of objects to return for the request. nextToken :: Maybe Text The next token from the previous request.

Instances

Instances details

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

newGetBatchPredictionJobs :: GetBatchPredictionJobs Source #

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

GetBatchPredictionJobs, getBatchPredictionJobs_jobId - The batch prediction job for which to get the details.

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

GetBatchPredictionJobs, getBatchPredictionJobs_nextToken - The next token from the previous request.

Request Lenses

getBatchPredictionJobs_jobId :: Lens' GetBatchPredictionJobs (Maybe Text) Source #

The batch prediction job for which to get the details.

getBatchPredictionJobs_maxResults :: Lens' GetBatchPredictionJobs (Maybe Natural) Source #

The maximum number of objects to return for the request.

getBatchPredictionJobs_nextToken :: Lens' GetBatchPredictionJobs (Maybe Text) Source #

The next token from the previous request.

Destructuring the Response

data GetBatchPredictionJobsResponse Source #

See: newGetBatchPredictionJobsResponse smart constructor.

Constructors

GetBatchPredictionJobsResponse'
Fields batchPredictions :: Maybe [BatchPrediction] An array containing the details of each batch prediction job. nextToken :: Maybe Text The next token for the subsequent request. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetBatchPredictionJobsResponse Source #

Arguments

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

Create a value of GetBatchPredictionJobsResponse 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:batchPredictions:GetBatchPredictionJobsResponse', getBatchPredictionJobsResponse_batchPredictions - An array containing the details of each batch prediction job.

GetBatchPredictionJobs, getBatchPredictionJobsResponse_nextToken - The next token for the subsequent request.

$sel:httpStatus:GetBatchPredictionJobsResponse', getBatchPredictionJobsResponse_httpStatus - The response's http status code.

Response Lenses

getBatchPredictionJobsResponse_batchPredictions :: Lens' GetBatchPredictionJobsResponse (Maybe [BatchPrediction]) Source #

An array containing the details of each batch prediction job.

getBatchPredictionJobsResponse_nextToken :: Lens' GetBatchPredictionJobsResponse (Maybe Text) Source #

The next token for the subsequent request.

getBatchPredictionJobsResponse_httpStatus :: Lens' GetBatchPredictionJobsResponse Int Source #

The response's http status code.