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 |
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
- data GetBatchPredictionJobs = GetBatchPredictionJobs' {}
- newGetBatchPredictionJobs :: GetBatchPredictionJobs
- getBatchPredictionJobs_jobId :: Lens' GetBatchPredictionJobs (Maybe Text)
- getBatchPredictionJobs_nextToken :: Lens' GetBatchPredictionJobs (Maybe Text)
- getBatchPredictionJobs_maxResults :: Lens' GetBatchPredictionJobs (Maybe Natural)
- data GetBatchPredictionJobsResponse = GetBatchPredictionJobsResponse' {}
- newGetBatchPredictionJobsResponse :: Int -> GetBatchPredictionJobsResponse
- getBatchPredictionJobsResponse_batchPredictions :: Lens' GetBatchPredictionJobsResponse (Maybe [BatchPrediction])
- getBatchPredictionJobsResponse_nextToken :: Lens' GetBatchPredictionJobsResponse (Maybe Text)
- getBatchPredictionJobsResponse_httpStatus :: Lens' GetBatchPredictionJobsResponse Int
Creating a Request
data GetBatchPredictionJobs Source #
See: newGetBatchPredictionJobs
smart constructor.
Instances
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:
$sel:jobId:GetBatchPredictionJobs'
, getBatchPredictionJobs_jobId
- The batch prediction job for which to get the details.
$sel:nextToken:GetBatchPredictionJobs'
, getBatchPredictionJobs_nextToken
- The next token from the previous request.
$sel:maxResults:GetBatchPredictionJobs'
, getBatchPredictionJobs_maxResults
- The maximum number of objects to return for the request.
Request Lenses
getBatchPredictionJobs_jobId :: Lens' GetBatchPredictionJobs (Maybe Text) Source #
The batch prediction job for which to get the details.
getBatchPredictionJobs_nextToken :: Lens' GetBatchPredictionJobs (Maybe Text) Source #
The next token from the previous request.
getBatchPredictionJobs_maxResults :: Lens' GetBatchPredictionJobs (Maybe Natural) Source #
The maximum number of objects to return for the request.
Destructuring the Response
data GetBatchPredictionJobsResponse Source #
See: newGetBatchPredictionJobsResponse
smart constructor.
GetBatchPredictionJobsResponse' | |
|
Instances
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.
$sel:nextToken: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.