:doc:`Omics <../../omics>` / Client / create_run_group

****************
create_run_group
****************



.. py:method:: Omics.Client.create_run_group(**kwargs)

  

  Creates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.

  

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


  **Request Syntax**
  ::

    response = client.create_run_group(
        name='string',
        maxCpus=123,
        maxRuns=123,
        maxDuration=123,
        tags={
            'string': 'string'
        },
        requestId='string',
        maxGpus=123
    )
    
  :type name: string
  :param name: 

    A name for the group.

    

  
  :type maxCpus: integer
  :param maxCpus: 

    The maximum number of CPUs that can run concurrently across all active runs in the run group.

    

  
  :type maxRuns: integer
  :param maxRuns: 

    The maximum number of runs that can be running at the same time.

    

  
  :type maxDuration: integer
  :param maxDuration: 

    The maximum time for each run (in minutes). If a run exceeds the maximum run time, the run fails automatically.

    

  
  :type tags: dict
  :param tags: 

    Tags for the group.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type requestId: string
  :param requestId: **[REQUIRED]** 

    To ensure that requests don't run multiple times, specify a unique ID for each request.

    This field is autopopulated if not provided.

  
  :type maxGpus: integer
  :param maxGpus: 

    The maximum number of GPUs that can run concurrently across all active runs in the run group.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'arn': 'string',
          'id': 'string',
          'tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The group's ARN.

        
      

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

        The group's ID.

        
      

      - **tags** *(dict) --* 

        Tags for the run group.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`Omics.Client.exceptions.InternalServerException`

  
  *   :py:class:`Omics.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`Omics.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Omics.Client.exceptions.ValidationException`

  
  *   :py:class:`Omics.Client.exceptions.ConflictException`

  
  *   :py:class:`Omics.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Omics.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Omics.Client.exceptions.RequestTimeoutException`

  