DescribeJobs
Describes a list of AWS Batch jobs.
Request Syntax
POST /v1/describejobs HTTP/1.1
Content-type: application/json
{
"jobs": [ "string" ]
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- jobs
-
A list of up to 100 job IDs.
Type: Array of strings
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"jobs": [
{
"arrayProperties": {
"index": number,
"size": number,
"statusSummary": {
"string" : number
},
"statusSummaryLastUpdatedAt": number
},
"attempts": [
{
"container": {
"containerInstanceArn": "string",
"exitCode": number,
"logStreamName": "string",
"networkInterfaces": [
{
"attachmentId": "string",
"ipv6Address": "string",
"privateIpv4Address": "string"
}
],
"reason": "string",
"taskArn": "string"
},
"startedAt": number,
"statusReason": "string",
"stoppedAt": number,
"taskProperties": [
{
"containerInstanceArn": "string",
"containers": [
{
"exitCode": number,
"logStreamName": "string",
"name": "string",
"networkInterfaces": [
{
"attachmentId": "string",
"ipv6Address": "string",
"privateIpv4Address": "string"
}
],
"reason": "string"
}
],
"taskArn": "string"
}
]
}
],
"consumableResourceProperties": {
"consumableResourceList": [
{
"consumableResource": "string",
"quantity": number
}
]
},
"container": {
"command": [ "string" ],
"containerInstanceArn": "string",
"enableExecuteCommand": boolean,
"environment": [
{
"name": "string",
"value": "string"
}
],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"exitCode": number,
"fargatePlatformConfiguration": {
"platformVersion": "string"
},
"image": "string",
"instanceType": "string",
"jobRoleArn": "string",
"linuxParameters": {
"devices": [
{
"containerPath": "string",
"hostPath": "string",
"permissions": [ "string" ]
}
],
"initProcessEnabled": boolean,
"maxSwap": number,
"sharedMemorySize": number,
"swappiness": number,
"tmpfs": [
{
"containerPath": "string",
"mountOptions": [ "string" ],
"size": number
}
]
},
"logConfiguration": {
"logDriver": "string",
"options": {
"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"logStreamName": "string",
"memory": number,
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"networkConfiguration": {
"assignPublicIp": "string"
},
"networkInterfaces": [
{
"attachmentId": "string",
"ipv6Address": "string",
"privateIpv4Address": "string"
}
],
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"reason": "string",
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"taskArn": "string",
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string",
"vcpus": number,
"volumes": [
{
"efsVolumeConfiguration": {
"authorizationConfig": {
"accessPointId": "string",
"iam": "string"
},
"fileSystemId": "string",
"rootDirectory": "string",
"transitEncryption": "string",
"transitEncryptionPort": number
},
"host": {
"sourcePath": "string"
},
"name": "string",
"s3filesVolumeConfiguration": {
"accessPointArn": "string",
"fileSystemArn": "string",
"rootDirectory": "string",
"transitEncryptionPort": number
}
}
]
},
"createdAt": number,
"dependsOn": [
{
"jobId": "string",
"type": "string"
}
],
"ecsProperties": {
"taskProperties": [
{
"containerInstanceArn": "string",
"containers": [
{
"command": [ "string" ],
"dependsOn": [
{
"condition": "string",
"containerName": "string"
}
],
"environment": [
{
"name": "string",
"value": "string"
}
],
"essential": boolean,
"exitCode": number,
"firelensConfiguration": {
"options": {
"string" : "string"
},
"type": "string"
},
"image": "string",
"linuxParameters": {
"devices": [
{
"containerPath": "string",
"hostPath": "string",
"permissions": [ "string" ]
}
],
"initProcessEnabled": boolean,
"maxSwap": number,
"sharedMemorySize": number,
"swappiness": number,
"tmpfs": [
{
"containerPath": "string",
"mountOptions": [ "string" ],
"size": number
}
]
},
"logConfiguration": {
"logDriver": "string",
"options": {
"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"logStreamName": "string",
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"name": "string",
"networkInterfaces": [
{
"attachmentId": "string",
"ipv6Address": "string",
"privateIpv4Address": "