:doc:`Omics <../../omics>` / Paginator / ListRunGroups

*************
ListRunGroups
*************



.. py:class:: Omics.Paginator.ListRunGroups

  ::

    
    paginator = client.get_paginator('list_run_groups')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Omics.Client.list_run_groups`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/ListRunGroups>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          name='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type name: string
    :param name: 

      The run groups' name.

      

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

      
      ::

        {
            'items': [
                {
                    'arn': 'string',
                    'id': 'string',
                    'name': 'string',
                    'maxCpus': 123,
                    'maxRuns': 123,
                    'maxDuration': 123,
                    'creationTime': datetime(2015, 1, 1),
                    'maxGpus': 123
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          A list of groups.

          
          

          - *(dict) --* 

            A run group.

            
            

            - **arn** *(string) --* 

              The group's ARN.

              
            

            - **id** *(string) --* 

              The group's ID.

              
            

            - **name** *(string) --* 

              The group's name.

              
            

            - **maxCpus** *(integer) --* 

              The group's maximum CPU count setting.

              
            

            - **maxRuns** *(integer) --* 

              The group's maximum concurrent run setting.

              
            

            - **maxDuration** *(integer) --* 

              The group's maximum duration setting in minutes.

              
            

            - **creationTime** *(datetime) --* 

              When the group was created.

              
            

            - **maxGpus** *(integer) --* 

              The maximum GPUs that can be used by a run group.

              
        
      
        

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

          A token to resume pagination.

          
    