v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1437198164.5 KB

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.

post/applications/{applicationId}/batch-job

Path parameters

applicationIdstring required

The unique identifier of the application associated with this batch job.

Request body

authSecretsManagerArnstring

The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.

jobParamsobject

Job parameters are optional. Can contain up to 500 entries.

Response

Success

executionIdstring required

The unique identifier of this execution of the batch job.