amazonka-frauddetector-2.0: Amazon Fraud Detector SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FraudDetector.GetBatchPredictionJobs

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

Instances

Instances details
ToJSON GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

ToHeaders GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

ToPath GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

ToQuery GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

AWSRequest GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

Associated Types

type AWSResponse GetBatchPredictionJobs #

Generic GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

Associated Types

type Rep GetBatchPredictionJobs :: Type -> Type #

Read GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

Show GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

NFData GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

Methods

rnf :: GetBatchPredictionJobs -> () #

Eq GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

Hashable GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

type AWSResponse GetBatchPredictionJobs Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

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

Instances

Instances details
Generic GetBatchPredictionJobsResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

Associated Types

type Rep GetBatchPredictionJobsResponse :: Type -> Type #

Read GetBatchPredictionJobsResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

Show GetBatchPredictionJobsResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

NFData GetBatchPredictionJobsResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

Eq GetBatchPredictionJobsResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.GetBatchPredictionJobs

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 #

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.