StartBatchJob
Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.
Request Syntax
POST /applications/applicationId/batch-job HTTP/1.1
Content-type: application/json
{
"authSecretsManagerArn": "string",
"batchJobIdentifier": { ... },
"jobParams": {
"string" : "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The unique identifier of the application associated with this batch job.
Pattern:
^\S{1,80}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- authSecretsManagerArn
-
The AWS Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: No
- batchJobIdentifier
-
The unique identifier of the batch job.
Type: BatchJobIdentifier object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- jobParams
-
The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL
. Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 500 items.
Key Length Constraints: Minimum length of 1. Maximum length of 32.
Key Pattern:
^[A-Za-z][A-Za-z0-9]{1,31}$Value Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"executionId": "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.
- executionId
-
The unique identifier of this execution of the batch job.
Type: String
Pattern:
^\S{1,80}$
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
- ConflictException
-
The parameters provided in the request conflict with existing resources.
HTTP Status Code: 409
- 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:
