:doc:`DeadlineCloud <../../deadline>` / Client / create_queue_environment

************************
create_queue_environment
************************



.. py:method:: DeadlineCloud.Client.create_queue_environment(**kwargs)

  

  Creates an environment for a queue that defines how jobs in the queue run.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/CreateQueueEnvironment>`_  


  **Request Syntax**
  ::

    response = client.create_queue_environment(
        clientToken='string',
        farmId='string',
        queueId='string',
        priority=123,
        templateType='JSON'|'YAML',
        template='string'
    )
    
  :type clientToken: string
  :param clientToken: 

    The unique token which the server uses to recognize retries of the same request.

    This field is autopopulated if not provided.

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

    The farm ID of the farm to connect to the environment.

    

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

    The queue ID to connect the queue and environment.

    

  
  :type priority: integer
  :param priority: **[REQUIRED]** 

    Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority (activated first and deactivated last). If two environments share the same priority value, the environment created first takes higher priority.

    

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

    The template's file type, ``JSON`` or ``YAML``.

    

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

    The environment template to use in the queue.

    

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

    
    ::

      {
          'queueEnvironmentId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **queueEnvironmentId** *(string) --* 

        The queue environment ID.

        
  
  **Exceptions**
  
  *   :py:class:`DeadlineCloud.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.InternalServerErrorException`

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

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

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

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

  