:doc:`Batch <../../batch>` / Paginator / DescribeJobDefinitions

**********************
DescribeJobDefinitions
**********************



.. py:class:: Batch.Paginator.DescribeJobDefinitions

  ::

    
    paginator = client.get_paginator('describe_job_definitions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Batch.Client.describe_job_definitions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          jobDefinitions=[
              'string',
          ],
          jobDefinitionName='string',
          status='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type jobDefinitions: list
    :param 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.

      

    
      - *(string) --* 

      
  
    :type jobDefinitionName: string
    :param jobDefinitionName: 

      The name of the job definition to describe.

      

    
    :type status: string
    :param status: 

      The status used to filter job definitions.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: 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'|'awsfirelens',
                            'options': {
                                'string': 'string'
                            },
                            'secretOptions': [
                                {
                                    'name': 'string',
                                    'valueFrom': 'string'
                                },
                            ]
                        },
                        'secrets': [
                            {
                                'name': 'string',
                                'valueFrom': 'string'
                            },
                        ],
                        'networkConfiguration': {
                            'assignPublicIp': 'ENABLED'|'DISABLED'
                        },
                        'fargatePlatformConfiguration': {
                            'platformVersion': 'string'
                        },
                        'enableExecuteCommand': True|False,
                        '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'|'awsfirelens',
                                        'options': {
                                            'string': 'string'
                                        },
                                        'secretOptions': [
                                            {
                                                'name': 'string',
                                                'valueFrom': 'string'
                                            },
                                        ]
                                    },
                                    'secrets': [
                                        {
                                            'name': 'string',
                                            'valueFrom': 'string'
                                        },
                                    ],
                                    'networkConfiguration': {
                                        'assignPublicIp': 'ENABLED'|'DISABLED'
                                    },
                                    'fargatePlatformConfiguration': {
                                        'platformVersion': 'string'
                                    },
                                    'enableExecuteCommand': True|False,
                                    '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,
                                                    'firelensConfiguration': {
                                                        'type': 'fluentd'|'fluentbit',
                                                        'options': {
                                                            'string': 'string'
                                                        }
                                                    },
                                                    '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'|'awsfirelens',
                                                        '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'
                                                        }
                                                    }
                                                },
                                            ],
                                            'enableExecuteCommand': True|False
                                        },
                                    ]
                                },
                                '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',
                                                        'subPath': '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',
                                                        'subPath': '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
                                                },
                                                'persistentVolumeClaim': {
                                                    'claimName': 'string',
                                                    'readOnly': True|False
                                                }
                                            },
                                        ],
                                        'metadata': {
                                            'labels': {
                                                'string': 'string'
                                            },
                                            'annotations': {
                                                'string': 'string'
                                            },
                                            'namespace': 'string'
                                        },
                                        'shareProcessNamespace': True|False
                                    }
                                },
                                'consumableResourceProperties': {
                                    'consumableResourceList': [
                                        {
                                            'consumableResource': 'string',
                                            'quantity': 123
                                        },
                                    ]
                                }
                            },
                        ]
                    },
                    '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,
                                        'firelensConfiguration': {
                                            'type': 'fluentd'|'fluentbit',
                                            'options': {
                                                'string': 'string'
                                            }
                                        },
                                        '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'|'awsfirelens',
                                            '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'
                                            }
                                        }
                                    },
                                ],
                                'enableExecuteCommand': True|False
                            },
                        ]
                    },
                    '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',
                                            'subPath': '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',
                                            'subPath': '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
                                    },
                                    'persistentVolumeClaim': {
                                        'claimName': 'string',
                                        'readOnly': True|False
                                    }
                                },
                            ],
                            'metadata': {
                                'labels': {
                                    'string': 'string'
                                },
                                'annotations': {
                                    'string': 'string'
                                },
                                'namespace': 'string'
                            },
                            'shareProcessNamespace': True|False
                        }
                    },
                    'containerOrchestrationType': 'ECS'|'EKS',
                    'consumableResourceProperties': {
                        'consumableResourceList': [
                            {
                                'consumableResource': 'string',
                                'quantity': 123
                            },
                        ]
                    }
                },
            ],
            'NextToken': 'string'
        }
        

    **Response Structure**
    ::

        # This section is too large to render.
        # Please see the AWS API Documentation linked below.

    `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions>`_


    