parallel.cluster.generic.awsbatch.getBatchJobInfo

Get AWS Batch job information

Syntax

info = parallel.cluster.generic.awsbatch.getBatchJobInfo(job)

Description

info = parallel.cluster.generic.awsbatch.getBatchJobInfo(job) returns a table with information on each task in the MATLAB^® AWS^® Batch job.

Note

This function requires the Parallel Computing Toolbox™ plugin for MATLAB Parallel Server™ with AWS Batch. For an example of how to use the function, see the plugin scripts.

Input Arguments

collapse all

`job` — MATLAB AWS Batch job
`parallel.job.CJSIndependentJob` object

MATLAB AWS Batch job, specified as a parallel.job.CJSIndependentJob object.

Data Types: parallel.job.CJSIndependentJob

Output Arguments

collapse all

`info` — Task information
`table`

Task information, returned as a table with the following variables.

Variable	Data Type	Value
`TaskID`	`string`	The ID of the task in `job`. `getBatchJobInfo` collects information only on tasks with a `schedulerID`.
`Status`	`string`	The status for the corresponding AWS Batch job of the task, as reported by AWS Batch. If AWS Batch does not provide a state for the job, `Status` is set to `"UNKNOWN"`. Note that `"UNKNOWN"` is not a state defined by AWS.
`LogStreamName`	`string`	The log stream name in Amazon^® CloudWatch Logs for the corresponding AWS Batch job of the task. If AWS Batch does not provide a log stream name, then `LogStreamName` is `""`.

Note that AWS only returns information for AWS Batch jobs in the SUCCEEDED or FAILED state over the last 24 hours. After 24 hours elapses, Status is "UNKNOWN" and LogStreamName is "".

Data Types: table

Version History

Introduced in R2019b