:doc:`MainframeModernization <../../m2>` / Paginator / ListBatchJobDefinitions

***********************
ListBatchJobDefinitions
***********************



.. py:class:: MainframeModernization.Paginator.ListBatchJobDefinitions

  ::

    
    paginator = client.get_paginator('list_batch_job_definitions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`MainframeModernization.Client.list_batch_job_definitions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/m2-2021-04-28/ListBatchJobDefinitions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          applicationId='string',
          prefix='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type applicationId: string
    :param applicationId: **[REQUIRED]** 

      The identifier of the application.

      

    
    :type prefix: string
    :param prefix: 

      If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.

      

    
    :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**

      
      ::

        {
            'batchJobDefinitions': [
                {
                    'fileBatchJobDefinition': {
                        'fileName': 'string',
                        'folderPath': 'string'
                    },
                    'scriptBatchJobDefinition': {
                        'scriptName': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **batchJobDefinitions** *(list) --* 

          The list of batch job definitions.

          
          

          - *(dict) --* 

            Defines the details of a batch job.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``fileBatchJobDefinition``, ``scriptBatchJobDefinition``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

            - **fileBatchJobDefinition** *(dict) --* 

              Specifies a file containing a batch job definition.

              
              

              - **fileName** *(string) --* 

                The name of the file containing the batch job definition.

                
              

              - **folderPath** *(string) --* 

                The path to the file containing the batch job definition.

                
          
            

            - **scriptBatchJobDefinition** *(dict) --* 

              A script containing a batch job definition.

              
              

              - **scriptName** *(string) --* 

                The name of the script containing the batch job definition.

                
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    