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 |
Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.
This operation returns paginated results.
Synopsis
- data ListBatchJobDefinitions = ListBatchJobDefinitions' {}
- newListBatchJobDefinitions :: Text -> ListBatchJobDefinitions
- listBatchJobDefinitions_maxResults :: Lens' ListBatchJobDefinitions (Maybe Natural)
- listBatchJobDefinitions_nextToken :: Lens' ListBatchJobDefinitions (Maybe Text)
- listBatchJobDefinitions_prefix :: Lens' ListBatchJobDefinitions (Maybe Text)
- listBatchJobDefinitions_applicationId :: Lens' ListBatchJobDefinitions Text
- data ListBatchJobDefinitionsResponse = ListBatchJobDefinitionsResponse' {}
- newListBatchJobDefinitionsResponse :: Int -> ListBatchJobDefinitionsResponse
- listBatchJobDefinitionsResponse_nextToken :: Lens' ListBatchJobDefinitionsResponse (Maybe Text)
- listBatchJobDefinitionsResponse_httpStatus :: Lens' ListBatchJobDefinitionsResponse Int
- listBatchJobDefinitionsResponse_batchJobDefinitions :: Lens' ListBatchJobDefinitionsResponse [BatchJobDefinition]
Creating a Request
data ListBatchJobDefinitions Source #
See: newListBatchJobDefinitions
smart constructor.
ListBatchJobDefinitions' | |
|
Instances
newListBatchJobDefinitions Source #
Create a value of ListBatchJobDefinitions
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:maxResults:ListBatchJobDefinitions'
, listBatchJobDefinitions_maxResults
- The maximum number of batch job definitions to return.
ListBatchJobDefinitions
, listBatchJobDefinitions_nextToken
- A pagination token returned from a previous call to this operation. This
specifies the next item to return. To return to the beginning of the
list, exclude this parameter.
$sel:prefix:ListBatchJobDefinitions'
, listBatchJobDefinitions_prefix
- If the batch job definition is a FileBatchJobDefinition, the prefix
allows you to search on the file names of FileBatchJobDefinitions.
ListBatchJobDefinitions
, listBatchJobDefinitions_applicationId
- The identifier of the application.
Request Lenses
listBatchJobDefinitions_maxResults :: Lens' ListBatchJobDefinitions (Maybe Natural) Source #
The maximum number of batch job definitions to return.
listBatchJobDefinitions_nextToken :: Lens' ListBatchJobDefinitions (Maybe Text) Source #
A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
listBatchJobDefinitions_prefix :: Lens' ListBatchJobDefinitions (Maybe Text) Source #
If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.
listBatchJobDefinitions_applicationId :: Lens' ListBatchJobDefinitions Text Source #
The identifier of the application.
Destructuring the Response
data ListBatchJobDefinitionsResponse Source #
See: newListBatchJobDefinitionsResponse
smart constructor.
ListBatchJobDefinitionsResponse' | |
|
Instances
newListBatchJobDefinitionsResponse Source #
Create a value of ListBatchJobDefinitionsResponse
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:
ListBatchJobDefinitions
, listBatchJobDefinitionsResponse_nextToken
- If there are more items to return, this contains a token that is passed
to a subsequent call to this operation to retrieve the next set of
items.
$sel:httpStatus:ListBatchJobDefinitionsResponse'
, listBatchJobDefinitionsResponse_httpStatus
- The response's http status code.
$sel:batchJobDefinitions:ListBatchJobDefinitionsResponse'
, listBatchJobDefinitionsResponse_batchJobDefinitions
- The list of batch job definitions.
Response Lenses
listBatchJobDefinitionsResponse_nextToken :: Lens' ListBatchJobDefinitionsResponse (Maybe Text) Source #
If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.
listBatchJobDefinitionsResponse_httpStatus :: Lens' ListBatchJobDefinitionsResponse Int Source #
The response's http status code.
listBatchJobDefinitionsResponse_batchJobDefinitions :: Lens' ListBatchJobDefinitionsResponse [BatchJobDefinition] Source #
The list of batch job definitions.