Batch / Client / describe_job_definitions
describe_job_definitions#
- Batch.Client.describe_job_definitions(**kwargs)#
Describes a list of job definitions. You can specify a
status(such asACTIVE) to only return job definitions that match that status.See also: AWS API Documentation
Request Syntax
response = client.describe_job_definitions( jobDefinitions=[ 'string', ], maxResults=123, jobDefinitionName='string', status='string', nextToken='string' )
- Parameters:
jobDefinitions (list) –
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.(string) –
maxResults (integer) – The maximum number of results returned by
DescribeJobDefinitionsin paginated output. When this parameter is used,DescribeJobDefinitionsonly returnsmaxResultsresults in a single page and anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherDescribeJobDefinitionsrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter isn’t used, thenDescribeJobDefinitionsreturns up to 100 results and anextTokenvalue if applicable.jobDefinitionName (string) – The name of the job definition to describe.
status (string) – The status used to filter job definitions.
nextToken (string) –
The
nextTokenvalue returned from a previous paginatedDescribeJobDefinitionsrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen there are no more results to return.Note
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.
- Return type:
dict
- Returns:
Response Syntax
{ 'jobDefinitions': [ { 'jobDefinitionName': 'string', 'jobDefinitionArn': 'string', 'revision': 123, 'status': 'string', 'type': 'string', 'schedulingPriority': 123, 'parameters': { 'string': 'string' }, 'retryStrategy': { 'attempts': 123, 'evaluateOnExit': [ { 'onStatusReason': 'string', 'onReason': 'string', 'onExitCode': 'string', 'action': 'RETRY'|'EXIT' }, ] }, 'containerProperties': { 'image': 'string', 'vcpus': 123, 'memory': 123, 'command': [ 'string', ], 'jobRoleArn': 'string', 'executionRoleArn': 'string', 'volumes': [ { 'host': { 'sourcePath': 'string' }, 'name': 'string', 'efsVolumeConfiguration': { 'fileSystemId': 'string', 'rootDirectory': 'string', 'transitEncryption': 'ENABLED'|'DISABLED', 'transitEncryptionPort': 123, 'authorizationConfig': { 'accessPointId': 'string', 'iam': 'ENABLED'|'DISABLED' } } }, ], 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'mountPoints': [ { 'containerPath': 'string', 'readOnly': True|False, 'sourceVolume': 'string' }, ], 'readonlyRootFilesystem': True|False, 'privileged': True|False, 'ulimits': [ { 'hardLimit': 123, 'name': 'string', 'softLimit': 123 }, ], 'user': 'string', 'instanceType': 'string', 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ], 'linuxParameters': { 'devices': [ { 'hostPath': 'string', 'containerPath': 'string', 'permissions': [ 'READ'|'WRITE'|'MKNOD', ] }, ], 'initProcessEnabled': True|False, 'sharedMemorySize': 123, 'tmpfs': [ { 'containerPath': 'string', 'size': 123, 'mountOptions': [ 'string', ] }, ], 'maxSwap': 123, 'swappiness': 123 }, 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] }, 'secrets': [ { 'name': 'string', 'valueFrom': 'string' }, ], 'networkConfiguration': { 'assignPublicIp': 'ENABLED'|'DISABLED' }, 'fargatePlatformConfiguration': { 'platformVersion': 'string' }, 'ephemeralStorage': { 'sizeInGiB': 123 }, 'runtimePlatform': { 'operatingSystemFamily': 'string', 'cpuArchitecture': 'string' }, 'repositoryCredentials': { 'credentialsParameter': 'string' } }, 'timeout': { 'attemptDurationSeconds': 123 }, 'nodeProperties': { 'numNodes': 123, 'mainNode': 123, 'nodeRangeProperties': [ { 'targetNodes': 'string', 'container': { 'image': 'string', 'vcpus': 123, 'memory': 123, 'command': [ 'string', ], 'jobRoleArn': 'string', 'executionRoleArn': 'string', 'volumes': [ { 'host': { 'sourcePath': 'string' }, 'name': 'string', 'efsVolumeConfiguration': { 'fileSystemId': 'string', 'rootDirectory': 'string', 'transitEncryption': 'ENABLED'|'DISABLED', 'transitEncryptionPort': 123, 'authorizationConfig': { 'accessPointId': 'string', 'iam': 'ENABLED'|'DISABLED' } } }, ], 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'mountPoints': [ { 'containerPath': 'string', 'readOnly': True|False, 'sourceVolume': 'string' }, ], 'readonlyRootFilesystem': True|False, 'privileged': True|False, 'ulimits': [ { 'hardLimit': 123, 'name': 'string', 'softLimit': 123 }, ], 'user': 'string', 'instanceType': 'string', 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ], 'linuxParameters': { 'devices': [ { 'hostPath': 'string', 'containerPath': 'string', 'permissions': [ 'READ'|'WRITE'|'MKNOD', ] }, ], 'initProcessEnabled': True|False, 'sharedMemorySize': 123, 'tmpfs': [ { 'containerPath': 'string', 'size': 123, 'mountOptions': [ 'string', ] }, ], 'maxSwap': 123, 'swappiness': 123 }, 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] }, 'secrets': [ { 'name': 'string', 'valueFrom': 'string' }, ], 'networkConfiguration': { 'assignPublicIp': 'ENABLED'|'DISABLED' }, 'fargatePlatformConfiguration': { 'platformVersion': 'string' }, 'ephemeralStorage': { 'sizeInGiB': 123 }, 'runtimePlatform': { 'operatingSystemFamily': 'string', 'cpuArchitecture': 'string' }, 'repositoryCredentials': { 'credentialsParameter': 'string' } }, 'instanceTypes': [ 'string', ], 'ecsProperties': { 'taskProperties': [ { 'containers': [ { 'command': [ 'string', ], 'dependsOn': [ { 'containerName': 'string', 'condition': 'string' }, ], 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'essential': True|False, 'image': 'string', 'linuxParameters': { 'devices': [ { 'hostPath': 'string', 'containerPath': 'string', 'permissions': [ 'READ'|'WRITE'|'MKNOD', ] }, ], 'initProcessEnabled': True|False, 'sharedMemorySize': 123, 'tmpfs': [ { 'containerPath': 'string', 'size': 123, 'mountOptions': [ 'string', ] }, ], 'maxSwap': 123, 'swappiness': 123 }, 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] }, 'mountPoints': [ { 'containerPath': 'string', 'readOnly': True|False, 'sourceVolume': 'string' }, ], 'name': 'string', 'privileged': True|False, 'readonlyRootFilesystem': True|False, 'repositoryCredentials': { 'credentialsParameter': 'string' }, 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ], 'secrets': [ { 'name': 'string', 'valueFrom': 'string' }, ], 'ulimits': [ { 'hardLimit': 123, 'name': 'string', 'softLimit': 123 }, ], 'user': 'string' }, ], 'ephemeralStorage': { 'sizeInGiB': 123 }, 'executionRoleArn': 'string', 'platformVersion': 'string', 'ipcMode': 'string', 'taskRoleArn': 'string', 'pidMode': 'string', 'networkConfiguration': { 'assignPublicIp': 'ENABLED'|'DISABLED' }, 'runtimePlatform': { 'operatingSystemFamily': 'string', 'cpuArchitecture': 'string' }, 'volumes': [ { 'host': { 'sourcePath': 'string' }, 'name': 'string', 'efsVolumeConfiguration': { 'fileSystemId': 'string', 'rootDirectory': 'string', 'transitEncryption': 'ENABLED'|'DISABLED', 'transitEncryptionPort': 123, 'authorizationConfig': { 'accessPointId': 'string', 'iam': 'ENABLED'|'DISABLED' } } }, ] }, ] }, 'eksProperties': { 'podProperties': { 'serviceAccountName': 'string', 'hostNetwork': True|False, 'dnsPolicy': 'string', 'imagePullSecrets': [ { 'name': 'string' }, ], 'containers': [ { 'name': 'string', 'image': 'string', 'imagePullPolicy': 'string', 'command': [ 'string', ], 'args': [ 'string', ], 'env': [ { 'name': 'string', 'value': 'string' }, ], 'resources': { 'limits': { 'string': 'string' }, 'requests': { 'string': 'string' } }, 'volumeMounts': [ { 'name': 'string', 'mountPath': 'string', 'readOnly': True|False }, ], 'securityContext': { 'runAsUser': 123, 'runAsGroup': 123, 'privileged': True|False, 'allowPrivilegeEscalation': True|False, 'readOnlyRootFilesystem': True|False, 'runAsNonRoot': True|False } }, ], 'initContainers': [ { 'name': 'string', 'image': 'string', 'imagePullPolicy': 'string', 'command': [ 'string', ], 'args': [ 'string', ], 'env': [ { 'name': 'string', 'value': 'string' }, ], 'resources': { 'limits': { 'string': 'string' }, 'requests': { 'string': 'string' } }, 'volumeMounts': [ { 'name': 'string', 'mountPath': 'string', 'readOnly': True|False }, ], 'securityContext': { 'runAsUser': 123, 'runAsGroup': 123, 'privileged': True|False, 'allowPrivilegeEscalation': True|False, 'readOnlyRootFilesystem': True|False, 'runAsNonRoot': True|False } }, ], 'volumes': [ { 'name': 'string', 'hostPath': { 'path': 'string' }, 'emptyDir': { 'medium': 'string', 'sizeLimit': 'string' }, 'secret': { 'secretName': 'string', 'optional': True|False } }, ], 'metadata': { 'labels': { 'string': 'string' } }, 'shareProcessNamespace': True|False } } }, ] }, 'tags': { 'string': 'string' }, 'propagateTags': True|False, 'platformCapabilities': [ 'EC2'|'FARGATE', ], 'ecsProperties': { 'taskProperties': [ { 'containers': [ { 'command': [ 'string', ], 'dependsOn': [ { 'containerName': 'string', 'condition': 'string' }, ], 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'essential': True|False, 'image': 'string', 'linuxParameters': { 'devices': [ { 'hostPath': 'string', 'containerPath': 'string', 'permissions': [ 'READ'|'WRITE'|'MKNOD', ] }, ], 'initProcessEnabled': True|False, 'sharedMemorySize': 123, 'tmpfs': [ { 'containerPath': 'string', 'size': 123, 'mountOptions': [ 'string', ] }, ], 'maxSwap': 123, 'swappiness': 123 }, 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] }, 'mountPoints': [ { 'containerPath': 'string', 'readOnly': True|False, 'sourceVolume': 'string' }, ], 'name': 'string', 'privileged': True|False, 'readonlyRootFilesystem': True|False, 'repositoryCredentials': { 'credentialsParameter': 'string' }, 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ], 'secrets': [ { 'name': 'string', 'valueFrom': 'string' }, ], 'ulimits': [ { 'hardLimit': 123, 'name': 'string', 'softLimit': 123 }, ], 'user': 'string' }, ], 'ephemeralStorage': { 'sizeInGiB': 123 }, 'executionRoleArn': 'string', 'platformVersion': 'string', 'ipcMode': 'string', 'taskRoleArn': 'string', 'pidMode': 'string', 'networkConfiguration': { 'assignPublicIp': 'ENABLED'|'DISABLED' }, 'runtimePlatform': { 'operatingSystemFamily': 'string', 'cpuArchitecture': 'string' }, 'volumes': [ { 'host': { 'sourcePath': 'string' }, 'name': 'string', 'efsVolumeConfiguration': { 'fileSystemId': 'string', 'rootDirectory': 'string', 'transitEncryption': 'ENABLED'|'DISABLED', 'transitEncryptionPort': 123, 'authorizationConfig': { 'accessPointId': 'string', 'iam': 'ENABLED'|'DISABLED' } } }, ] }, ] }, 'eksProperties': { 'podProperties': { 'serviceAccountName': 'string', 'hostNetwork': True|False, 'dnsPolicy': 'string', 'imagePullSecrets': [ { 'name': 'string' }, ], 'containers': [ { 'name': 'string', 'image': 'string', 'imagePullPolicy': 'string', 'command': [ 'string', ], 'args': [ 'string', ], 'env': [ { 'name': 'string', 'value': 'string' }, ], 'resources': { 'limits': { 'string': 'string' }, 'requests': { 'string': 'string' } }, 'volumeMounts': [ { 'name': 'string', 'mountPath': 'string', 'readOnly': True|False }, ], 'securityContext': { 'runAsUser': 123, 'runAsGroup': 123, 'privileged': True|False, 'allowPrivilegeEscalation': True|False, 'readOnlyRootFilesystem': True|False, 'runAsNonRoot': True|False } }, ], 'initContainers': [ { 'name': 'string', 'image': 'string', 'imagePullPolicy': 'string', 'command': [ 'string', ], 'args': [ 'string', ], 'env': [ { 'name': 'string', 'value': 'string' }, ], 'resources': { 'limits': { 'string': 'string' }, 'requests': { 'string': 'string' } }, 'volumeMounts': [ { 'name': 'string', 'mountPath': 'string', 'readOnly': True|False }, ], 'securityContext': { 'runAsUser': 123, 'runAsGroup': 123, 'privileged': True|False, 'allowPrivilegeEscalation': True|False, 'readOnlyRootFilesystem': True|False, 'runAsNonRoot': True|False } }, ], 'volumes': [ { 'name': 'string', 'hostPath': { 'path': 'string' }, 'emptyDir': { 'medium': 'string', 'sizeLimit': 'string' }, 'secret': { 'secretName': 'string', 'optional': True|False } }, ], 'metadata': { 'labels': { 'string': 'string' } }, 'shareProcessNamespace': True|False } }, 'containerOrchestrationType': 'ECS'|'EKS' }, ], 'nextToken': 'string' }
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
Exceptions
Examples
This example describes all of your active job definitions.
response = client.describe_job_definitions( status='ACTIVE', ) print(response)
Expected Output:
{ 'jobDefinitions': [ { 'type': 'container', 'containerProperties': { 'command': [ 'sleep', '60', ], 'environment': [ ], 'image': 'busybox', 'mountPoints': [ ], 'resourceRequirements': [ { 'type': 'MEMORY', 'value': '128', }, { 'type': 'VCPU', 'value': '1', }, ], 'ulimits': [ ], 'volumes': [ ], }, 'jobDefinitionArn': 'arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1', 'jobDefinitionName': 'sleep60', 'revision': 1, 'status': 'ACTIVE', }, ], 'ResponseMetadata': { '...': '...', }, }