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 import jobs or a specific job of the specified 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
GetBatchImportJobsResponse
as part of your request. A null pagination
token fetches the records from the beginning.
Synopsis
- data GetBatchImportJobs = GetBatchImportJobs' {}
- newGetBatchImportJobs :: GetBatchImportJobs
- getBatchImportJobs_jobId :: Lens' GetBatchImportJobs (Maybe Text)
- getBatchImportJobs_nextToken :: Lens' GetBatchImportJobs (Maybe Text)
- getBatchImportJobs_maxResults :: Lens' GetBatchImportJobs (Maybe Natural)
- data GetBatchImportJobsResponse = GetBatchImportJobsResponse' {
- nextToken :: Maybe Text
- batchImports :: Maybe [BatchImport]
- httpStatus :: Int
- newGetBatchImportJobsResponse :: Int -> GetBatchImportJobsResponse
- getBatchImportJobsResponse_nextToken :: Lens' GetBatchImportJobsResponse (Maybe Text)
- getBatchImportJobsResponse_batchImports :: Lens' GetBatchImportJobsResponse (Maybe [BatchImport])
- getBatchImportJobsResponse_httpStatus :: Lens' GetBatchImportJobsResponse Int
Creating a Request
data GetBatchImportJobs Source #
See: newGetBatchImportJobs
smart constructor.
Instances
newGetBatchImportJobs :: GetBatchImportJobs Source #
Create a value of GetBatchImportJobs
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:GetBatchImportJobs'
, getBatchImportJobs_jobId
- The ID of the batch import job to get.
$sel:nextToken:GetBatchImportJobs'
, getBatchImportJobs_nextToken
- The next token from the previous request.
$sel:maxResults:GetBatchImportJobs'
, getBatchImportJobs_maxResults
- The maximum number of objects to return for request.
Request Lenses
getBatchImportJobs_jobId :: Lens' GetBatchImportJobs (Maybe Text) Source #
The ID of the batch import job to get.
getBatchImportJobs_nextToken :: Lens' GetBatchImportJobs (Maybe Text) Source #
The next token from the previous request.
getBatchImportJobs_maxResults :: Lens' GetBatchImportJobs (Maybe Natural) Source #
The maximum number of objects to return for request.
Destructuring the Response
data GetBatchImportJobsResponse Source #
See: newGetBatchImportJobsResponse
smart constructor.
GetBatchImportJobsResponse' | |
|
Instances
newGetBatchImportJobsResponse Source #
Create a value of GetBatchImportJobsResponse
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:GetBatchImportJobs'
, getBatchImportJobsResponse_nextToken
- The next token for the subsequent resquest.
$sel:batchImports:GetBatchImportJobsResponse'
, getBatchImportJobsResponse_batchImports
- An array containing the details of each batch import job.
$sel:httpStatus:GetBatchImportJobsResponse'
, getBatchImportJobsResponse_httpStatus
- The response's http status code.
Response Lenses
getBatchImportJobsResponse_nextToken :: Lens' GetBatchImportJobsResponse (Maybe Text) Source #
The next token for the subsequent resquest.
getBatchImportJobsResponse_batchImports :: Lens' GetBatchImportJobsResponse (Maybe [BatchImport]) Source #
An array containing the details of each batch import job.
getBatchImportJobsResponse_httpStatus :: Lens' GetBatchImportJobsResponse Int Source #
The response's http status code.