ListBatchJobDefinitions
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.
Request Syntax
GET /applications/applicationId/batch-job-definitions?maxResults=maxResults&nextToken=nextToken&prefix=prefix HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The identifier of the application.
Pattern:
^\S{1,80}$Required: Yes
- maxResults
-
The maximum number of batch job definitions to return.
Valid Range: Minimum value of 1. Maximum value of 2000.
- 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.
Pattern:
^\S{1,2000}$ - prefix
-
If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"batchJobDefinitions": [
{ ... }
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- batchJobDefinitions
-
The list of batch job definitions.
Type: Array of BatchJobDefinition objects
- 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.
Type: String
Pattern:
^\S{1,2000}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The account or role doesn't have the right permissions to make the request.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred during the processing of the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests made exceeds the limit.
HTTP Status Code: 429
- ValidationException
-
One or more parameters provided in the request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
