Describes a list of job definitions¶
Description¶
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.
Usage¶
Arguments¶
jobDefinitions
A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}. This parameter can't be used with other parameters.
maxResults
The maximum number of results returned by describe_job_definitions in paginated output. When this parameter is used, describe_job_definitions 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 describe_job_definitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then describe_job_definitions returns up to 100 results and a nextToken value if applicable.
jobDefinitionName
The name of the job definition to describe.
status
The status used to filter job definitions.
nextToken
The nextToken value returned from a previous paginated describe_job_definitions 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.
Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
Value¶
A list with the following syntax:
list(
jobDefinitions = list(
list(
jobDefinitionName = "string",
jobDefinitionArn = "string",
revision = 123,
status = "string",
type = "string",
schedulingPriority = 123,
parameters = list(
"string"
),
retryStrategy = list(
attempts = 123,
evaluateOnExit = list(
list(
onStatusReason = "string",
onReason = "string",
onExitCode = "string",
action = "RETRY"|"EXIT"
)
)
),
containerProperties = list(
image = "string",
vcpus = 123,
memory = 123,
command = list(
"string"
),
jobRoleArn = "string",
executionRoleArn = "string",
volumes = list(
list(
host = list(
sourcePath = "string"
),
name = "string",
efsVolumeConfiguration = list(
fileSystemId = "string",
rootDirectory = "string",
transitEncryption = "ENABLED"|"DISABLED",
transitEncryptionPort = 123,
authorizationConfig = list(
accessPointId = "string",
iam = "ENABLED"|"DISABLED"
)
),
s3filesVolumeConfiguration = list(
fileSystemArn = "string",
rootDirectory = "string",
transitEncryptionPort = 123,
accessPointArn = "string"
)
)
),
environment = list(
list(
name = "string",
value = "string"
)
),
mountPoints = list(
list(
containerPath = "string",
readOnly = TRUE|FALSE,
sourceVolume = "string"
)
),
readonlyRootFilesystem = TRUE|FALSE,
privileged = TRUE|FALSE,
ulimits = list(
list(
hardLimit = 123,
name = "string",
softLimit = 123
)
),
user = "string",
instanceType = "string",
resourceRequirements = list(
list(
value = "string",
type = "GPU"|"VCPU"|"MEMORY"
)
),
linuxParameters = list(
devices = list(
list(
hostPath = "string",
containerPath = "string",
permissions = list(
"READ"|"WRITE"|"MKNOD"
)
)
),
initProcessEnabled = TRUE|FALSE,
sharedMemorySize = 123,
tmpfs = list(
list(
containerPath = "string",
size = 123,
mountOptions = list(
"string"
)
)
),
maxSwap = 123,
swappiness = 123
),
logConfiguration = list(
logDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk"|"awsfirelens",
options = list(
"string"
),
secretOptions = list(
list(
name = "string",
valueFrom = "string"
)
)
),
secrets = list(
list(
name = "string",
valueFrom = "string"
)
),
networkConfiguration = list(
assignPublicIp = "ENABLED"|"DISABLED"
),
fargatePlatformConfiguration = list(
platformVersion = "string"
),
enableExecuteCommand = TRUE|FALSE,
ephemeralStorage = list(
sizeInGiB = 123
),
runtimePlatform = list(
operatingSystemFamily = "string",
cpuArchitecture = "string"
),
repositoryCredentials = list(
credentialsParameter = "string"
)
),
timeout = list(
attemptDurationSeconds = 123
),
nodeProperties = list(
numNodes = 123,
mainNode = 123,
nodeRangeProperties = list(
list(
targetNodes = "string",
container = list(
image = "string",
vcpus = 123,
memory = 123,
command = list(
"string"
),
jobRoleArn = "string",
executionRoleArn = "string",
volumes = list(
list(
host = list(
sourcePath = "string"
),
name = "string",
efsVolumeConfiguration = list(
fileSystemId = "string",
rootDirectory = "string",
transitEncryption = "ENABLED"|"DISABLED",
transitEncryptionPort = 123,
authorizationConfig = list(
accessPointId = "string",
iam = "ENABLED"|"DISABLED"
)
),
s3filesVolumeConfiguration = list(
fileSystemArn = "string",
rootDirectory = "string",
transitEncryptionPort = 123,
accessPointArn = "string"
)
)
),
environment = list(
list(
name = "string",
value = "string"
)
),
mountPoints = list(
list(
containerPath = "string",
readOnly = TRUE|FALSE,
sourceVolume = "string"
)
),
readonlyRootFilesystem = TRUE|FALSE,
privileged = TRUE|FALSE,
ulimits = list(
list(
hardLimit = 123,
name = "string",
softLimit = 123
)
),
user = "string",
instanceType = "string",
resourceRequirements = list(
list(
value = "string",
type = "GPU"|"VCPU"|"MEMORY"
)
),
linuxParameters = list(
devices = list(
list(
hostPath = "string",
containerPath = "string",
permissions = list(
"READ"|"WRITE"|"MKNOD"
)
)
),
initProcessEnabled = TRUE|FALSE,
sharedMemorySize = 123,
tmpfs = list(
list(
containerPath = "string",
size = 123,
mountOptions = list(
"string"
)
)
),
maxSwap = 123,
swappiness = 123
),
logConfiguration = list(
logDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk"|"awsfirelens",
options = list(
"string"
),
secretOptions = list(
list(
name = "string",
valueFrom = "string"
)
)
),
secrets = list(
list(
name = "string",
valueFrom = "string"
)
),
networkConfiguration = list(
assignPublicIp = "ENABLED"|"DISABLED"
),
fargatePlatformConfiguration = list(
platformVersion = "string"
),
enableExecuteCommand = TRUE|FALSE,
ephemeralStorage = list(
sizeInGiB = 123
),
runtimePlatform = list(
operatingSystemFamily = "string",
cpuArchitecture = "string"
),
repositoryCredentials = list(
credentialsParameter = "string"
)
),
instanceTypes = list(
"string"
),
ecsProperties = list(
taskProperties = list(
list(
containers = list(
list(
command = list(
"string"
),
dependsOn = list(
list(
containerName = "string",
condition = "string"
)
),
environment = list(
list(
name = "string",
value = "string"
)
),
essential = TRUE|FALSE,
firelensConfiguration = list(
type = "fluentd"|"fluentbit",
options = list(
"string"
)
),
image = "string",
linuxParameters = list(
devices = list(
list(
hostPath = "string",
containerPath = "string",
permissions = list(
"READ"|"WRITE"|"MKNOD"
)
)
),
initProcessEnabled = TRUE|FALSE,
sharedMemorySize = 123,
tmpfs = list(
list(
containerPath = "string",
size = 123,
mountOptions = list(
"string"
)
)
),
maxSwap = 123,
swappiness = 123
),
logConfiguration = list(
logDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk"|"awsfirelens",
options = list(
"string"
),
secretOptions = list(
list(
name = "string",
valueFrom = "string"
)
)
),
mountPoints = list(
list(
containerPath = "string",
readOnly = TRUE|FALSE,
sourceVolume = "string"
)
),
name = "string",
privileged = TRUE|FALSE,
readonlyRootFilesystem = TRUE|FALSE,
repositoryCredentials = list(
credentialsParameter = "string"
),
resourceRequirements = list(
list(
value = "string",
type = "GPU"|"VCPU"|"MEMORY"
)
),
secrets = list(
list(
name = "string",
valueFrom = "string"
)
),
ulimits = list(
list(
hardLimit = 123,
name = "string",
softLimit = 123
)
),
user = "string",
startTimeout = 123,
stopTimeout = 123
)
),
ephemeralStorage = list(
sizeInGiB = 123
),
executionRoleArn = "string",
platformVersion = "string",
ipcMode = "string",
taskRoleArn = "string",
pidMode = "string",
networkConfiguration = list(
assignPublicIp = "ENABLED"|"DISABLED"
),
runtimePlatform = list(
operatingSystemFamily = "string",
cpuArchitecture = "string"
),
volumes = list(
list(
host = list(
sourcePath = "string"
),
name = "string",
efsVolumeConfiguration = list(
fileSystemId = "string",
rootDirectory = "string",
transitEncryption = "ENABLED"|"DISABLED",
transitEncryptionPort = 123,
authorizationConfig = list(
accessPointId = "string",
iam = "ENABLED"|"DISABLED"
)
),
s3filesVolumeConfiguration = list(
fileSystemArn = "string",
rootDirectory = "string",
transitEncryptionPort = 123,
accessPointArn = "string"
)
)
),
enableExecuteCommand = TRUE|FALSE,
networkMode = "string"
)
)
),
eksProperties = list(
podProperties = list(
serviceAccountName = "string",
hostNetwork = TRUE|FALSE,
dnsPolicy = "string",
imagePullSecrets = list(
list(
name = "string"
)
),
containers = list(
list(
name = "string",
image = "string",
imagePullPolicy = "string",
command = list(
"string"
),
args = list(
"string"
),
env = list(
list(
name = "string",
value = "string"
)
),
resources = list(
limits = list(
"string"
),
requests = list(
"string"
)
),
volumeMounts = list(
list(
name = "string",
mountPath = "string",
subPath = "string",
readOnly = TRUE|FALSE
)
),
securityContext = list(
runAsUser = 123,
runAsGroup = 123,
privileged = TRUE|FALSE,
allowPrivilegeEscalation = TRUE|FALSE,
readOnlyRootFilesystem = TRUE|FALSE,
runAsNonRoot = TRUE|FALSE
)
)
),
initContainers = list(
list(
name = "string",
image = "string",
imagePullPolicy = "string",
command = list(
"string"
),
args = list(
"string"
),
env = list(
list(
name = "string",
value = "string"
)
),
resources = list(
limits = list(
"string"
),
requests = list(
"string"
)
),
volumeMounts = list(
list(
name = "string",
mountPath = "string",
subPath = "string",
readOnly = TRUE|FALSE
)
),
securityContext = list(
runAsUser = 123,
runAsGroup = 123,
privileged = TRUE|FALSE,
allowPrivilegeEscalation = TRUE|FALSE,
readOnlyRootFilesystem = TRUE|FALSE,
runAsNonRoot = TRUE|FALSE
)
)
),
volumes = list(
list(
name = "string",
hostPath = list(
path = "string"
),
emptyDir = list(
medium = "string",
sizeLimit = "string"
),
secret = list(
secretName = "string",
optional = TRUE|FALSE
),
persistentVolumeClaim = list(
claimName = "string",
readOnly = TRUE|FALSE
)
)
),
metadata = list(
labels = list(
"string"
),
annotations = list(
"string"
),
namespace = "string"
),
shareProcessNamespace = TRUE|FALSE
)
),
consumableResourceProperties = list(
consumableResourceList = list(
list(
consumableResource = "string",
quantity = 123
)
)
)
)
)
),
tags = list(
"string"
),
propagateTags = TRUE|FALSE,
platformCapabilities = list(
"EC2"|"FARGATE"|"MANAGED_INSTANCES"
),
ecsProperties = list(
taskProperties = list(
list(
containers = list(
list(
command = list(
"string"
),
dependsOn = list(
list(
containerName = "string",
condition = "string"
)
),
environment = list(
list(
name = "string",
value = "string"
)
),
essential = TRUE|FALSE,
firelensConfiguration = list(
type = "fluentd"|"fluentbit",
options = list(
"string"
)
),
image = "string",
linuxParameters = list(
devices = list(
list(
hostPath = "string",
containerPath = "string",
permissions = list(
"READ"|"WRITE"|"MKNOD"
)
)
),
initProcessEnabled = TRUE|FALSE,
sharedMemorySize = 123,
tmpfs = list(
list(
containerPath = "string",
size = 123,
mountOptions = list(
"string"
)
)
),
maxSwap = 123,
swappiness = 123
),
logConfiguration = list(
logDriver = "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk"|"awsfirelens",
options = list(
"string"
),
secretOptions = list(
list(
name = "string",
valueFrom = "string"
)
)
),
mountPoints = list(
list(
containerPath = "string",
readOnly = TRUE|FALSE,
sourceVolume = "string"
)
),
name = "string",
privileged = TRUE|FALSE,
readonlyRootFilesystem = TRUE|FALSE,
repositoryCredentials = list(
credentialsParameter = "string"
),
resourceRequirements = list(
list(
value = "string",
type = "GPU"|"VCPU"|"MEMORY"
)
),
secrets = list(
list(
name = "string",
valueFrom = "string"
)
),
ulimits = list(
list(
hardLimit = 123,
name = "string",
softLimit = 123
)
),
user = "string",
startTimeout = 123,
stopTimeout = 123
)
),
ephemeralStorage = list(
sizeInGiB = 123
),
executionRoleArn = "string",
platformVersion = "string",
ipcMode = "string",
taskRoleArn = "string",
pidMode = "string",
networkConfiguration = list(
assignPublicIp = "ENABLED"|"DISABLED"
),
runtimePlatform = list(
operatingSystemFamily = "string",
cpuArchitecture = "string"
),
volumes = list(
list(
host = list(
sourcePath = "string"
),
name = "string",
efsVolumeConfiguration = list(
fileSystemId = "string",
rootDirectory = "string",
transitEncryption = "ENABLED"|"DISABLED",
transitEncryptionPort = 123,
authorizationConfig = list(
accessPointId = "string",
iam = "ENABLED"|"DISABLED"
)
),
s3filesVolumeConfiguration = list(
fileSystemArn = "string",
rootDirectory = "string",
transitEncryptionPort = 123,
accessPointArn = "string"
)
)
),
enableExecuteCommand = TRUE|FALSE,
networkMode = "string"
)
)
),
eksProperties = list(
podProperties = list(
serviceAccountName = "string",
hostNetwork = TRUE|FALSE,
dnsPolicy = "string",
imagePullSecrets = list(
list(
name = "string"
)
),
containers = list(
list(
name = "string",
image = "string",
imagePullPolicy = "string",
command = list(
"string"
),
args = list(
"string"
),
env = list(
list(
name = "string",
value = "string"
)
),
resources = list(
limits = list(
"string"
),
requests = list(
"string"
)
),
volumeMounts = list(
list(
name = "string",
mountPath = "string",
subPath = "string",
readOnly = TRUE|FALSE
)
),
securityContext = list(
runAsUser = 123,
runAsGroup = 123,
privileged = TRUE|FALSE,
allowPrivilegeEscalation = TRUE|FALSE,
readOnlyRootFilesystem = TRUE|FALSE,
runAsNonRoot = TRUE|FALSE
)
)
),
initContainers = list(
list(
name = "string",
image = "string",
imagePullPolicy = "string",
command = list(
"string"
),
args = list(
"string"
),
env = list(
list(
name = "string",
value = "string"
)
),
resources = list(
limits = list(
"string"
),
requests = list(
"string"
)
),
volumeMounts = list(
list(
name = "string",
mountPath = "string",
subPath = "string",
readOnly = TRUE|FALSE
)
),
securityContext = list(
runAsUser = 123,
runAsGroup = 123,
privileged = TRUE|FALSE,
allowPrivilegeEscalation = TRUE|FALSE,
readOnlyRootFilesystem = TRUE|FALSE,
runAsNonRoot = TRUE|FALSE
)
)
),
volumes = list(
list(
name = "string",
hostPath = list(
path = "string"
),
emptyDir = list(
medium = "string",
sizeLimit = "string"
),
secret = list(
secretName = "string",
optional = TRUE|FALSE
),
persistentVolumeClaim = list(
claimName = "string",
readOnly = TRUE|FALSE
)
)
),
metadata = list(
labels = list(
"string"
),
annotations = list(
"string"
),
namespace = "string"
),
shareProcessNamespace = TRUE|FALSE
)
),
containerOrchestrationType = "ECS"|"EKS",
consumableResourceProperties = list(
consumableResourceList = list(
list(
consumableResource = "string",
quantity = 123
)
)
)
)
),
nextToken = "string"
)
Request syntax¶
svc$describe_job_definitions(
jobDefinitions = list(
"string"
),
maxResults = 123,
jobDefinitionName = "string",
status = "string",
nextToken = "string"
)