2026/02/11 - AWS Batch - 4 updated api methods
Changes Add support for listing jobs by share identifier and getting snapshots of active capacity utilization by job queue and share.
{'capacityUsage': [{'capacityUnit': 'string', 'quantity': 'double'}],
'scheduledAt': 'long'}
The details of a service job.
See also: AWS API Documentation
Request Syntax
client.describe_service_job(
jobId='string'
)
string
[REQUIRED]
The job ID for the service job to describe.
dict
Response Syntax
{
'attempts': [
{
'serviceResourceId': {
'name': 'TrainingJobArn',
'value': 'string'
},
'startedAt': 123,
'stoppedAt': 123,
'statusReason': 'string'
},
],
'capacityUsage': [
{
'capacityUnit': 'string',
'quantity': 123.0
},
],
'createdAt': 123,
'isTerminated': True|False,
'jobArn': 'string',
'jobId': 'string',
'jobName': 'string',
'jobQueue': 'string',
'latestAttempt': {
'serviceResourceId': {
'name': 'TrainingJobArn',
'value': 'string'
}
},
'retryStrategy': {
'attempts': 123,
'evaluateOnExit': [
{
'action': 'RETRY'|'EXIT',
'onStatusReason': 'string'
},
]
},
'scheduledAt': 123,
'schedulingPriority': 123,
'serviceRequestPayload': 'string',
'serviceJobType': 'SAGEMAKER_TRAINING',
'shareIdentifier': 'string',
'startedAt': 123,
'status': 'SUBMITTED'|'PENDING'|'RUNNABLE'|'SCHEDULED'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED',
'statusReason': 'string',
'stoppedAt': 123,
'tags': {
'string': 'string'
},
'timeoutConfig': {
'attemptDurationSeconds': 123
}
}
Response Structure
(dict) --
attempts (list) --
A list of job attempts associated with the service job.
(dict) --
Detailed information about an attempt to run a service job.
serviceResourceId (dict) --
The service resource identifier associated with the service job attempt.
name (string) --
The name of the resource identifier.
value (string) --
The value of the resource identifier.
startedAt (integer) --
The Unix timestamp (in milliseconds) for when the service job attempt was started.
stoppedAt (integer) --
The Unix timestamp (in milliseconds) for when the service job attempt stopped running.
statusReason (string) --
A string that provides additional details for the current status of the service job attempt.
capacityUsage (list) --
The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the serviceRequestPayload.InstanceCount field.
(dict) --
The capacity usage for a service job, including the unit of measure and quantity of resources being consumed.
capacityUnit (string) --
The unit of measure for the service job capacity usage. For service jobs, this is NUM_INSTANCES.
quantity (float) --
The quantity of capacity being used by the service job, measured in the units specified by capacityUnit.
createdAt (integer) --
The Unix timestamp (in milliseconds) for when the service job was created.
isTerminated (boolean) --
Indicates whether the service job has been terminated.
jobArn (string) --
The Amazon Resource Name (ARN) of the service job.
jobId (string) --
The job ID for the service job.
jobName (string) --
The name of the service job.
jobQueue (string) --
The ARN of the job queue that the service job is associated with.
latestAttempt (dict) --
The latest attempt associated with the service job.
serviceResourceId (dict) --
The service resource identifier associated with the service job attempt.
name (string) --
The name of the resource identifier.
value (string) --
The value of the resource identifier.
retryStrategy (dict) --
The retry strategy to use for failed service jobs that are submitted with this service job.
attempts (integer) --
The number of times to move a service job to RUNNABLE status. You can specify between 1 and 10 attempts.
evaluateOnExit (list) --
Array of ServiceJobEvaluateOnExit objects that specify conditions under which the service job should be retried or failed.
(dict) --
Specifies conditions for when to exit or retry a service job based on the exit status or status reason.
action (string) --
The action to take if the service job exits with the specified condition. Valid values are RETRY and EXIT.
onStatusReason (string) --
Contains a glob pattern to match against the StatusReason returned for a job. The pattern can contain up to 512 characters and can contain all printable characters. It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
scheduledAt (integer) --
The Unix timestamp (in milliseconds) for when the service job was scheduled. This represents when the service job was dispatched to SageMaker and the service job transitioned to the SCHEDULED state.
schedulingPriority (integer) --
The scheduling priority of the service job.
serviceRequestPayload (string) --
The request, in JSON, for the service that the SubmitServiceJob operation is queueing.
serviceJobType (string) --
The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.
shareIdentifier (string) --
The share identifier for the service job. This is used for fair-share scheduling.
startedAt (integer) --
The Unix timestamp (in milliseconds) for when the service job was started.
status (string) --
The current status of the service job.
statusReason (string) --
A short, human-readable string to provide more details for the current status of the service job.
stoppedAt (integer) --
The Unix timestamp (in milliseconds) for when the service job stopped running.
tags (dict) --
The tags that are associated with the service job. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
(string) --
(string) --
timeoutConfig (dict) --
The timeout configuration for the service job.
attemptDurationSeconds (integer) --
The maximum duration in seconds that a service job attempt can run. After this time is reached, Batch terminates the service job attempt.
{'queueUtilization': {'fairshareUtilization': {'activeShareCount': 'long',
'topCapacityUtilization': [{'capacityUsage': [{'capacityUnit': 'string',
'quantity': 'double'}],
'shareIdentifier': 'string'}]},
'lastUpdatedAt': 'long',
'totalCapacityUsage': [{'capacityUnit': 'string',
'quantity': 'double'}]}}
Provides a list of the first 100 RUNNABLE jobs associated to a single job queue and includes capacity utilization, including total usage and breakdown by share for fairshare scheduling job queues.
See also: AWS API Documentation
Request Syntax
client.get_job_queue_snapshot(
jobQueue='string'
)
string
[REQUIRED]
The job queue’s name or full queue Amazon Resource Name (ARN).
dict
Response Syntax
{
'frontOfQueue': {
'jobs': [
{
'jobArn': 'string',
'earliestTimeAtPosition': 123
},
],
'lastUpdatedAt': 123
},
'queueUtilization': {
'totalCapacityUsage': [
{
'capacityUnit': 'string',
'quantity': 123.0
},
],
'fairshareUtilization': {
'activeShareCount': 123,
'topCapacityUtilization': [
{
'shareIdentifier': 'string',
'capacityUsage': [
{
'capacityUnit': 'string',
'quantity': 123.0
},
]
},
]
},
'lastUpdatedAt': 123
}
}
Response Structure
(dict) --
frontOfQueue (dict) --
The list of the first 100 RUNNABLE jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.
jobs (list) --
The Amazon Resource Names (ARNs) of the first 100 RUNNABLE jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.
(dict) --
An object that represents summary details for the first 100 RUNNABLE jobs in a job queue.
jobArn (string) --
The ARN for a job in a named job queue.
earliestTimeAtPosition (integer) --
The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the job queue.
lastUpdatedAt (integer) --
The Unix timestamp (in milliseconds) for when each of the first 100 RUNNABLE jobs were last updated.
queueUtilization (dict) --
The job queue's capacity utilization, including total usage and breakdown by fairshare scheduling queue.
totalCapacityUsage (list) --
The total capacity usage for the entire job queue, for both first-in, first-out (FIFO) and fairshare scheduling job queue.
(dict) --
The configured capacity usage for a job queue snapshot, including the unit of measure and quantity of resources being used.
capacityUnit (string) --
The unit of measure for the capacity usage. For compute jobs, this is VCPU for Amazon EC2 and cpu for Amazon EKS. For service jobs, this is NUM_INSTANCES.
quantity (float) --
The quantity of capacity being used in the queue snapshot, measured in the units specified by capacityUnit.
fairshareUtilization (dict) --
The utilization information for a fairshare scheduling job queues, including active share count and top capacity utilization by share.
activeShareCount (integer) --
The total number of active shares in the fairshare scheduling job queue that are currently utilizing capacity.
topCapacityUtilization (list) --
A list of the top 20 shares with the highest capacity utilization, ordered by usage amount.
(dict) --
The capacity utilization for a specific share in a fairshare scheduling job queue, including the share identifier and its current usage.
shareIdentifier (string) --
The share identifier for the fairshare scheduling job queue.
capacityUsage (list) --
The capacity usage information for this share, including the unit of measure and quantity being used. This is VCPU for Amazon EC2 and cpu for Amazon EKS.
(dict) --
The capacity usage for a fairshare scheduling job queue.
capacityUnit (string) --
The unit of measure for the capacity usage. For compute jobs, this is VCPU for Amazon EC2 and cpu for Amazon EKS. For service jobs, this is NUM_INSTANCES.
quantity (float) --
The quantity of capacity being used, measured in the units specified by capacityUnit.
lastUpdatedAt (integer) --
The Unix timestamp (in milliseconds) for when the queue utilization information was last updated.
{'jobSummaryList': {'capacityUsage': [{'capacityUnit': 'string',
'quantity': 'double'}],
'scheduledAt': 'long',
'shareIdentifier': 'string'}}
Returns a list of Batch jobs.
You must specify only one of the following items:
A job queue ID to return a list of jobs in that job queue
A multi-node parallel job ID to return a list of nodes for that job
An array job ID to return a list of the children for that job
See also: AWS API Documentation
Request Syntax
client.list_jobs(
jobQueue='string',
arrayJobId='string',
multiNodeJobId='string',
jobStatus='SUBMITTED'|'PENDING'|'RUNNABLE'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED',
maxResults=123,
nextToken='string',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
string
The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
string
The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
string
The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.
string
The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. The exception is the SHARE_IDENTIFIER filter and jobStatus can be used together. If you don't specify a status, only RUNNING jobs are returned.
integer
The maximum number of results returned by ListJobs in a paginated output. When this parameter is used, ListJobs returns up to maxResults results in a single page and a nextToken response element, if applicable. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value.
The following outlines key parameters and limitations:
The minimum value is 1.
When --job-status is used, Batch returns up to 1000 values.
When --filters is used, Batch returns up to 100 values.
If neither parameter is used, then ListJobs returns up to 1000 results (jobs that are in the RUNNING status) and a nextToken value, if applicable.
string
The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
list
The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored with the exception that SHARE_IDENTIFIER and jobStatus can be used together. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.
JOB_DEFINITION
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.
BEFORE_CREATED_AT
The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
AFTER_CREATED_AT
The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
SHARE_IDENTIFIER
The value for the filter is the fairshare scheduling share identifier.
(dict) --
A filter name and value pair that's used to return a more specific list of results from a ListJobs or ListJobsByConsumableResource API operation.
name (string) --
The name of the filter. Filter names are case sensitive.
values (list) --
The filter values.
(string) --
dict
Response Syntax
{
'jobSummaryList': [
{
'jobArn': 'string',
'jobId': 'string',
'jobName': 'string',
'capacityUsage': [
{
'capacityUnit': 'string',
'quantity': 123.0
},
],
'createdAt': 123,
'scheduledAt': 123,
'shareIdentifier': 'string',
'status': 'SUBMITTED'|'PENDING'|'RUNNABLE'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED',
'statusReason': 'string',
'startedAt': 123,
'stoppedAt': 123,
'container': {
'exitCode': 123,
'reason': 'string'
},
'arrayProperties': {
'size': 123,
'index': 123,
'statusSummary': {
'string': 123
},
'statusSummaryLastUpdatedAt': 123
},
'nodeProperties': {
'isMainNode': True|False,
'numNodes': 123,
'nodeIndex': 123
},
'jobDefinition': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobSummaryList (list) --
A list of job summaries that match the request.
(dict) --
An object that represents summary details of a job.
jobArn (string) --
The Amazon Resource Name (ARN) of the job.
jobId (string) --
The job ID.
jobName (string) --
The job name.
capacityUsage (list) --
The configured capacity usage information for this job, including the unit of measure and quantity of resources.
(dict) --
The capacity usage for a job, including the unit of measure and quantity of resources being used.
capacityUnit (string) --
The unit of measure for the capacity usage. This is VCPU for Amazon EC2 and cpu for Amazon EKS.
quantity (float) --
The quantity of capacity being used by the job, measured in the units specified by capacityUnit.
createdAt (integer) --
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.
scheduledAt (integer) --
The Unix timestamp (in milliseconds) for when the job was scheduled for execution. For more information on job statues, see Service job status in the Batch User Guide.
shareIdentifier (string) --
The share identifier for the fairshare scheduling queue that this job is associated with.
status (string) --
The current status for the job.
statusReason (string) --
A short, human-readable string to provide more details for the current status of the job.
startedAt (integer) --
The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.
stoppedAt (integer) --
The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.
container (dict) --
An object that represents the details of the container that's associated with the job.
exitCode (integer) --
The exit code to return upon completion.
reason (string) --
A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
arrayProperties (dict) --
The array properties of the job, if it's an array job.
size (integer) --
The size of the array job. This parameter is returned for parent array jobs.
index (integer) --
The job index within the array that's associated with this job. This parameter is returned for children of array jobs.
statusSummary (dict) --
A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.
(string) --
(integer) --
statusSummaryLastUpdatedAt (integer) --
The Unix timestamp (in milliseconds) for when the statusSummary was last updated.
nodeProperties (dict) --
The node properties for a single node in a job summary list.
isMainNode (boolean) --
Specifies whether the current node is the main node for a multi-node parallel job.
numNodes (integer) --
The number of nodes that are associated with a multi-node parallel job.
nodeIndex (integer) --
The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
jobDefinition (string) --
The Amazon Resource Name (ARN) of the job definition.
nextToken (string) --
The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
{'jobSummaryList': {'capacityUsage': [{'capacityUnit': 'string',
'quantity': 'double'}],
'scheduledAt': 'long'}}
Returns a list of service jobs for a specified job queue.
See also: AWS API Documentation
Request Syntax
client.list_service_jobs(
jobQueue='string',
jobStatus='SUBMITTED'|'PENDING'|'RUNNABLE'|'SCHEDULED'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED',
maxResults=123,
nextToken='string',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
string
The name or ARN of the job queue with which to list service jobs.
string
The job status used to filter service jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. The exception is the SHARE_IDENTIFIER filter and jobStatus can be used together. If you don't specify a status, only RUNNING jobs are returned.
integer
The maximum number of results returned by ListServiceJobs in paginated output. When this parameter is used, ListServiceJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceJobs returns up to 100 results and a nextToken value if applicable.
string
The nextToken value returned from a previous paginated ListServiceJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
list
The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored with the exception that SHARE_IDENTIFIER and jobStatus can be used together. The results are sorted by the createdAt field, with the most recent jobs being first.
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.
BEFORE_CREATED_AT
The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
AFTER_CREATED_AT
The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
SHARE_IDENTIFIER
The value for the filter is the fairshare scheduling share identifier.
(dict) --
A filter name and value pair that's used to return a more specific list of results from a ListJobs or ListJobsByConsumableResource API operation.
name (string) --
The name of the filter. Filter names are case sensitive.
values (list) --
The filter values.
(string) --
dict
Response Syntax
{
'jobSummaryList': [
{
'latestAttempt': {
'serviceResourceId': {
'name': 'TrainingJobArn',
'value': 'string'
}
},
'capacityUsage': [
{
'capacityUnit': 'string',
'quantity': 123.0
},
],
'createdAt': 123,
'jobArn': 'string',
'jobId': 'string',
'jobName': 'string',
'scheduledAt': 123,
'serviceJobType': 'SAGEMAKER_TRAINING',
'shareIdentifier': 'string',
'status': 'SUBMITTED'|'PENDING'|'RUNNABLE'|'SCHEDULED'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED',
'statusReason': 'string',
'startedAt': 123,
'stoppedAt': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobSummaryList (list) --
A list of service job summaries.
(dict) --
Summary information about a service job.
latestAttempt (dict) --
Information about the latest attempt for the service job.
serviceResourceId (dict) --
The service resource identifier associated with the service job attempt.
name (string) --
The name of the resource identifier.
value (string) --
The value of the resource identifier.
capacityUsage (list) --
The capacity usage information for this service job, including the unit of measure and quantity of resources being used.
(dict) --
The capacity usage for a service job, including the unit of measure and quantity of resources being used.
capacityUnit (string) --
The unit of measure for the service job capacity usage. For service jobs, this is NUM_INSTANCES.
quantity (float) --
The quantity of capacity being used by the service job, measured in the units specified by capacityUnit.
createdAt (integer) --
The Unix timestamp (in milliseconds) for when the service job was created.
jobArn (string) --
The Amazon Resource Name (ARN) of the service job.
jobId (string) --
The job ID for the service job.
jobName (string) --
The name of the service job.
scheduledAt (integer) --
The Unix timestamp (in milliseconds) for when the service job was scheduled for execution.
serviceJobType (string) --
The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.
shareIdentifier (string) --
The share identifier for the job.
status (string) --
The current status of the service job.
statusReason (string) --
A short string to provide more details on the current status of the service job.
startedAt (integer) --
The Unix timestamp (in milliseconds) for when the service job was started.
stoppedAt (integer) --
The Unix timestamp (in milliseconds) for when the service job stopped running.
nextToken (string) --
The nextToken value to include in a future ListServiceJobs request. When the results of a ListServiceJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.